version: bump version number.

feat: Add _get_pools method for CGMiner (StockFirmware)

docs/settings/settings.md

@@ -24,7 +24,6 @@ Settings options:
 - `default_hive_web_password`
 - `default_antminer_ssh_password`
 - `default_bosminer_ssh_password`
-- `socket_linger_time`
 
 
 ### get

poetry.lock

@@ -1067,14 +1067,25 @@ files = [
 ]
 
 [[package]]
-name = "toml"
-version = "0.10.2"
-description = "Python Library for Tom's Obvious, Minimal Language"
+name = "tomli"
+version = "2.0.1"
+description = "A lil' TOML parser"
 optional = false
-python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*"
+python-versions = ">=3.7"
 files = [
-    {file = "toml-0.10.2-py2.py3-none-any.whl", hash = "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b"},
-    {file = "toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"},
+    {file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"},
+    {file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"},
+]
+
+[[package]]
+name = "tomli-w"
+version = "1.0.0"
+description = "A lil' TOML writer"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "tomli_w-1.0.0-py3-none-any.whl", hash = "sha256:9f2a07e8be30a0729e533ec968016807069991ae2fd921a78d42f429ae5f4463"},
+    {file = "tomli_w-1.0.0.tar.gz", hash = "sha256:f463434305e0336248cac9c2dc8076b707d8a12d019dd349f5c1e382dd1ae1b9"},
 ]
 
 [[package]]
@@ -1184,4 +1195,4 @@ test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools",
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.8"
-content-hash = "be96d28fb2d257294061aa04fa3046c5e2a7c672275f819cb253b366b52554b3"
+content-hash = "05cf32d9e1c66d2090f3506be3e5065f810c1761ce69d2bc6956db1ba8f30548"

pyasic/device/models.py

@@ -44,6 +44,7 @@ class AntminerModels(str, Enum):
     S19kProNoPIC = "S19k Pro No PIC"
     T19 = "T19"
     S21 = "S21"
+    S21Pro = "S21 Pro"
     T21 = "T21"
 
     def __str__(self):

pyasic/miners/antminer/bmminer/X21/S21.py

@@ -15,8 +15,12 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerModern
-from pyasic.miners.device.models import S21
+from pyasic.miners.device.models import S21, S21Pro
 
 
 class BMMinerS21(AntminerModern, S21):
     pass
+
+
+class BMMinerS21Pro(AntminerModern, S21Pro):
+    pass

pyasic/miners/antminer/bmminer/X21/__init__.py

@@ -13,5 +13,5 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-from .S21 import BMMinerS21
+from .S21 import BMMinerS21, BMMinerS21Pro
 from .T21 import BMMinerT21

pyasic/miners/antminer/epic/X21/S21.py

@@ -15,8 +15,12 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import ePIC
-from pyasic.miners.device.models import S21
+from pyasic.miners.device.models import S21, S21Pro
 
 
 class ePICS21(ePIC, S21):
     pass
+
+
+class ePICS21Pro(ePIC, S21Pro):
+    pass

pyasic/miners/antminer/epic/X21/__init__.py

@@ -14,9 +14,7 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from .S21 import (
-    ePICS21,
-)
+from .S21 import ePICS21, ePICS21Pro
 
 from .T21 import (
     ePICT21,

pyasic/miners/backends/antminer.py

@@ -427,6 +427,10 @@ ANTMINER_OLD_DATA_LOC = DataLocations(
             "_get_uptime",
             [RPCAPICommand("rpc_stats", "stats")],
         ),
+        str(DataOptions.POOLS): DataFunction(
+            "_get_pools",
+            [RPCAPICommand("rpc_pools", "pools")],
+        ),
     }
 )
 

pyasic/miners/backends/auradine.py

@@ -193,6 +193,40 @@ class Auradine(StockFirmware):
         for key in conf.keys():
             await self.web.send_command(command=key, **conf[key])
 
+    async def upgrade_firmware(self, *, url: str = None, version: str = "latest", keep_settings: bool = False, **kwargs) -> bool:
+        """
+        Upgrade the firmware of the Auradine device.
+
+        Args:
+            url (str): The URL to download the firmware from.
+            version (str): The version of the firmware to upgrade to.
+            keep_settings (bool): Whether to keep the current settings during the upgrade.
+
+        Returns:
+            bool: True if the firmware upgrade was successful, False otherwise.
+        """
+        try:
+            logging.info("Starting firmware upgrade process.")
+
+            if not url and not version:
+                raise ValueError("Either URL or version must be provided for firmware upgrade.")
+
+            if url:
+                result = await self.web.firmware_upgrade(url=url)
+            else:
+                result = await self.web.firmware_upgrade(version=version)
+
+            if result.get("STATUS", [{}])[0].get("STATUS") == "S":
+                logging.info("Firmware upgrade process completed successfully.")
+                return True
+            else:
+                logging.error(f"Firmware upgrade failed: {result.get('error', 'Unknown error')}")
+                return False
+
+        except Exception as e:
+            logging.error(f"An error occurred during the firmware upgrade process: {str(e)}")
+            return False
+
     ##################################################
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
     ##################################################

pyasic/miners/backends/avalonminer.py

@@ -68,6 +68,10 @@ AVALON_DATA_LOC = DataLocations(
             "_get_uptime",
             [RPCAPICommand("rpc_stats", "stats")],
         ),
+        str(DataOptions.POOLS): DataFunction(
+            "_get_pools",
+            [RPCAPICommand("rpc_pools", "pools")],
+        ),
     }
 )
 

pyasic/miners/backends/bfgminer.py

@@ -228,4 +228,4 @@ class BFGMiner(StockFirmware):
                     expected_rate, HashUnit.SHA256.from_str(rate_unit)
                 ).into(self.algo.unit.default)
             except LookupError:
-                pass
+                pass

pyasic/miners/backends/braiins_os.py

@@ -20,7 +20,11 @@ from pathlib import Path
 from typing import List, Optional, Union
 
 import aiofiles
-import toml
+import tomli_w
+try:
+    import tomllib
+except ImportError:
+    import tomli as tomllib
 
 from pyasic.config import MinerConfig
 from pyasic.config.mining import MiningModePowerTune
@@ -177,10 +181,10 @@ class BOSMiner(BraiinsOSFirmware):
         raw_data = await self.ssh.get_config_file()
 
         try:
-            toml_data = toml.loads(raw_data)
+            toml_data = tomllib.loads(raw_data)
             cfg = MinerConfig.from_bosminer(toml_data)
             self.config = cfg
-        except toml.TomlDecodeError as e:
+        except tomllib.TOMLDecodeError as e:
             raise APIError("Failed to decode toml when getting config.") from e
         except TypeError as e:
             raise APIError("Failed to decode toml when getting config.") from e
@@ -191,7 +195,7 @@ class BOSMiner(BraiinsOSFirmware):
         self.config = config
         parsed_cfg = config.as_bosminer(user_suffix=user_suffix)
 
-        toml_conf = toml.dumps(
+        toml_conf = tomli_w.dumps(
             {
                 "format": {
                     "version": "2.0",

pyasic/miners/backends/cgminer.py

@@ -14,7 +14,7 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from typing import Optional
+from typing import Optional, List
 
 from pyasic.config import MinerConfig
 from pyasic.data import AlgoHashRate, HashUnit
@@ -22,6 +22,7 @@ from pyasic.errors import APIError
 from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
 from pyasic.miners.device.firmware import StockFirmware
 from pyasic.rpc.cgminer import CGMinerRPCAPI
+from pyasic.data.pools import PoolMetrics, PoolUrl
 
 CGMINER_DATA_LOC = DataLocations(
     **{
@@ -53,6 +54,10 @@ CGMINER_DATA_LOC = DataLocations(
             "_get_uptime",
             [RPCAPICommand("rpc_stats", "stats")],
         ),
+        str(DataOptions.POOLS): DataFunction(
+            "_get_pools",
+            [RPCAPICommand("rpc_pools", "pools")],
+        ),
     }
 )
 
@@ -136,3 +141,33 @@ class CGMiner(StockFirmware):
                 return int(rpc_stats["STATS"][1]["Elapsed"])
             except LookupError:
                 pass
+
+    async def _get_pools(self, rpc_pools: dict = None) -> List[PoolMetrics]:
+        if rpc_pools is None:
+            try:
+                rpc_pools = await self.rpc.pools()
+            except APIError:
+                pass
+
+        pools_data = []
+        if rpc_pools is not None:
+            try:
+                pools = rpc_pools.get("POOLS", [])
+                for pool_info in pools:
+                    url = pool_info.get("URL")
+                    pool_url = PoolUrl.from_str(url) if url else None
+                    pool_data = PoolMetrics(
+                        accepted=pool_info.get("Accepted"),
+                        rejected=pool_info.get("Rejected"),
+                        get_failures=pool_info.get("Get Failures"),
+                        remote_failures=pool_info.get("Remote Failures"),
+                        active=pool_info.get("Stratum Active"),
+                        alive=pool_info.get("Status") == "Alive",
+                        url=pool_url,
+                        user=pool_info.get("User"),
+                        index=pool_info.get("POOL"),
+                    )
+                    pools_data.append(pool_data)
+            except LookupError:
+                pass
+        return pools_data

pyasic/miners/backends/marathon.py

@@ -7,6 +7,7 @@ from pyasic.errors import APIError
 from pyasic.miners.data import DataFunction, DataLocations, DataOptions, WebAPICommand
 from pyasic.miners.device.firmware import MaraFirmware
 from pyasic.misc import merge_dicts
+from pyasic.rpc.marathon import MaraRPCAPI
 from pyasic.web.marathon import MaraWebAPI
 
 MARA_DATA_LOC = DataLocations(
@@ -64,6 +65,8 @@ MARA_DATA_LOC = DataLocations(
 
 
 class MaraMiner(MaraFirmware):
+    _rpc_cls = MaraRPCAPI
+    rpc: MaraRPCAPI
     _web_cls = MaraWebAPI
     web: MaraWebAPI
 

pyasic/miners/base.py

@@ -560,5 +560,18 @@ class BaseMiner(MinerProtocol):
         if self._ssh_cls is not None:
             self.ssh = self._ssh_cls(ip)
 
+    async def upgrade_firmware(self, *, file: str = None, url: str = None, version: str = None, keep_settings: bool = True) -> bool:
+        """Upgrade the firmware of the miner.
+
+        Parameters:
+            file (str, optional): The file path to the firmware to upgrade from. Must be a valid file path if provided.
+            url (str, optional): The URL to download the firmware from. Must be a valid URL if provided.
+            version (str, optional): The version of the firmware to upgrade to. If None, the version will be inferred from the file or URL.
+            keep_settings (bool, optional): Whether to keep the current settings during the upgrade. Defaults to True.
+
+        Returns:
+            A boolean value of the success of the firmware upgrade.
+        """
+        return False
 
 AnyMiner = TypeVar("AnyMiner", bound=BaseMiner)

pyasic/miners/device/firmware.py

@@ -43,4 +43,4 @@ class LuxOSFirmware(BaseMiner):
 
 
 class MaraFirmware(BaseMiner):
-    firmware = MinerFirmware.MARATHON
+    firmware = MinerFirmware.MARATHON

pyasic/miners/device/models/antminer/X21/S21.py

@@ -22,3 +22,10 @@ class S21(AntMinerMake):
 
     expected_chips = 108
     expected_fans = 4
+
+
+class S21Pro(AntMinerMake):
+    raw_model = MinerModel.ANTMINER.S21Pro
+
+    expected_chips = 65
+    expected_fans = 4

pyasic/miners/device/models/antminer/X21/__init__.py

@@ -14,5 +14,5 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from .S21 import S21
+from .S21 import S21, S21Pro
 from .T21 import T21

pyasic/miners/factory.py

@@ -97,6 +97,7 @@ MINER_CLASSES = {
         "ANTMINER S19K PRO": BMMinerS19KPro,
         "ANTMINER T19": BMMinerT19,
         "ANTMINER S21": BMMinerS21,
+        "ANTMINER S21 PRO": BMMinerS21Pro,
         "ANTMINER T21": BMMinerT21,
     },
     MinerTypes.WHATSMINER: {
@@ -401,6 +402,7 @@ MINER_CLASSES = {
         "ANTMINER S19K PRO": ePICS19kPro,
         "ANTMINER S19 XP": ePICS19XP,
         "ANTMINER S21": ePICS21,
+        "ANTMINER S21 PRO": ePICS21Pro,
         "ANTMINER T21": ePICT21,
         "BLOCKMINER 520I": ePICBlockMiner520i,
         "BLOCKMINER 720I": ePICBlockMiner720i,

pyasic/network/__init__.py

@@ -144,12 +144,9 @@ class MinerNetwork:
         Returns:
              An asynchronous generator containing found miners.
         """
-        # get the current event loop
-        loop = asyncio.get_event_loop()
-
         # create a list of scan tasks
         miners = asyncio.as_completed(
-            [loop.create_task(self.ping_and_get_miner(host)) for host in self.hosts]
+            [asyncio.create_task(self.ping_and_get_miner(host)) for host in self.hosts]
         )
         for miner in miners:
             try:

pyasic/rpc/base.py

@@ -215,14 +215,18 @@ If you are sure you want to use this command please use API.send_command("{comma
             return b"{}"
 
         # send the command
-        data_task = asyncio.create_task(self._read_bytes(reader, timeout=timeout))
-        logging.debug(f"{self} - ([Hidden] Send Bytes) - Writing")
-        writer.write(data)
-        logging.debug(f"{self} - ([Hidden] Send Bytes) - Draining")
-        await writer.drain()
+        try:
+            data_task = asyncio.create_task(self._read_bytes(reader, timeout=timeout))
+            logging.debug(f"{self} - ([Hidden] Send Bytes) - Writing")
+            writer.write(data)
+            logging.debug(f"{self} - ([Hidden] Send Bytes) - Draining")
+            await writer.drain()
 
-        await data_task
-        ret_data = data_task.result()
+            await data_task
+            ret_data = data_task.result()
+        except TimeoutError:
+            logging.warning(f"{self} - ([Hidden] Send Bytes) - Read timeout expired.")
+            return b"{}"
 
         # close the connection
         logging.debug(f"{self} - ([Hidden] Send Bytes) - Closing")

pyasic/rpc/marathon.py

@@ -0,0 +1,33 @@
+from pyasic.rpc.base import BaseMinerRPCAPI
+
+
+class MaraRPCAPI(BaseMinerRPCAPI):
+    """An abstraction of the MaraFW API.
+
+    Each method corresponds to an API command in MaraFW.
+
+    No documentation for this API is currently publicly available.
+
+    Additionally, every command not included here just returns the result of the `summary` command.
+
+    This class abstracts use of the MaraFW API, as well as the
+    methods for sending commands to it.  The `self.send_command()`
+    function handles sending a command to the miner asynchronously, and
+    as such is the base for many of the functions in this class, which
+    rely on it to send the command for them.
+    """
+
+    async def summary(self):
+        return await self.send_command("summary")
+
+    async def devs(self):
+        return await self.send_command("devs")
+
+    async def pools(self):
+        return await self.send_command("pools")
+
+    async def stats(self):
+        return await self.send_command("stats")
+
+    async def version(self):
+        return await self.send_command("version")

pyasic/settings/__init__.py

@@ -13,8 +13,6 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-import socket
-import struct
 from ssl import SSLContext
 from typing import Any, Union
 
@@ -41,23 +39,16 @@ _settings = {  # defaults
     "default_hive_web_password": "admin",
     "default_antminer_ssh_password": "miner",
     "default_bosminer_ssh_password": "root",
-    "socket_linger_time": 1000,
 }
 
 
 ssl_cxt = httpx.create_ssl_context()
 
 
-# this function configures socket options like SO_LINGER and returns an AsyncHTTPTransport instance to perform asynchronous HTTP requests
+# this function returns an AsyncHTTPTransport instance to perform asynchronous HTTP requests
 # using those options.
-# SO_LINGER controls what happens when you close a socket with unsent data - it allows specifying linger time for the data to be sent.
 def transport(verify: Union[str, bool, SSLContext] = ssl_cxt):
-    l_onoff = 1
-    l_linger = get("so_linger_time", 1000)
-
-    opts = [(socket.SOL_SOCKET, socket.SO_LINGER, struct.pack("ii", l_onoff, l_linger))]
-
-    return AsyncHTTPTransport(socket_options=opts, verify=verify)
+    return AsyncHTTPTransport(verify=verify)
 
 
 def get(key: str, other: Any = None) -> Any:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyasic"
-version = "0.59.2"
+version = "0.59.5"
 description = "A simplified and standardized interface for Bitcoin ASICs."
 authors = ["UpstreamData <brett@upstreamdata.ca>"]
 repository = "https://github.com/UpstreamData/pyasic"
@@ -13,7 +13,8 @@ httpx = ">=0.26.0"
 asyncssh = ">=2.14.2"
 passlib = ">=1.7.4"
 pyaml = ">=23.12.0"
-toml = ">=0.10.2"
+tomli = { version = ">=2.0.1", python = "<3.11" }
+tomli-w = "1.0.0"
 betterproto = ">=2.0.0b6"
 aiofiles = ">=23.2.1"