version: bump version number.

fix typo

pyasic/config/mining.py

@@ -444,7 +444,7 @@ class MiningModeConfig(MinerConfigOption):
                     )
                 else:
                     return cls.hashrate_tuning(
-                        hashrate=algo_info["ChipTune"]["Target"],
+                        hashrate=algo_info["ChipTune"].get("Target"),
                         algo=TunerAlgo.chip_tune(),
                     )
             else:

pyasic/data/pools.py

@@ -0,0 +1,59 @@
+from dataclasses import dataclass, field
+
+
+@dataclass
+class PoolMetrics:
+    """A dataclass to standardize pool metrics returned from miners.
+    Attributes:
+
+    accepted: Number of accepted shares.
+    rejected: Number of rejected shares.
+    get_failures: Number of failures in obtaining work from the pool.
+    remote_failures: Number of failures communicating with the pool server.
+    active: Indicates if the miner is connected to the stratum server.
+    Alive : Indicates if a pool is alive.
+    url: URL of the pool.
+    index: Index of the pool.
+    user: Username for the pool.
+    pool_rejected_percent: Percentage of rejected shares by the pool.
+    pool_stale_percent: Percentage of stale shares by the pool.
+    """
+
+    accepted: int = None
+    rejected: int = None
+    get_failures: int = None
+    remote_failures: int = None
+    active: bool = None
+    alive: bool = None
+    url: str = None
+    index: int = None
+    user: str = None
+    pool_rejected_percent: float = field(init=False)
+    pool_stale_percent: float = field(init=False)
+
+    @property
+    def pool_rejected_percent(self) -> float:  # noqa - Skip PyCharm inspection
+        """Calculate and return the percentage of rejected shares"""
+        return self._calculate_percentage(self.rejected, self.accepted + self.rejected)
+
+    @pool_rejected_percent.setter
+    def pool_rejected_percent(self, val):
+        pass
+
+    @property
+    def pool_stale_percent(self) -> float:  # noqa - Skip PyCharm inspection
+        """Calculate and return the percentage of stale shares."""
+        return self._calculate_percentage(
+            self.get_failures, self.accepted + self.rejected
+        )
+
+    @pool_stale_percent.setter
+    def pool_stale_percent(self, val):
+        pass
+
+    @staticmethod
+    def _calculate_percentage(value: int, total: int) -> float:
+        """Calculate the percentage."""
+        if total == 0:
+            return 0
+        return (value / total) * 100

pyasic/device/firmware.py

@@ -14,10 +14,10 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from enum import StrEnum
+from enum import Enum
 
 
-class MinerFirmware(StrEnum):
+class MinerFirmware(str, Enum):
     STOCK = "Stock"
     BRAIINS_OS = "BOS+"
     VNISH = "VNish"
@@ -25,3 +25,6 @@ class MinerFirmware(StrEnum):
     HIVEON = "Hive"
     LUXOS = "LuxOS"
     MARATHON = "MaraFW"
+
+    def __str__(self):
+        return self.value

pyasic/device/makes.py

@@ -14,10 +14,10 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from enum import StrEnum
+from enum import Enum
 
 
-class MinerMake(StrEnum):
+class MinerMake(str, Enum):
     WHATSMINER = "WhatsMiner"
     ANTMINER = "AntMiner"
     AVALONMINER = "AvalonMiner"
@@ -25,3 +25,6 @@ class MinerMake(StrEnum):
     GOLDSHELL = "Goldshell"
     AURADINE = "Auradine"
     EPIC = "ePIC"
+
+    def __str__(self):
+        return self.value

pyasic/device/models.py

@@ -1,7 +1,7 @@
-from enum import StrEnum
+from enum import Enum
 
 
-class AntminerModels(StrEnum):
+class AntminerModels(str, Enum):
     D3 = "D3"
     HS3 = "HS3"
     L3Plus = "L3+"
@@ -46,8 +46,11 @@ class AntminerModels(StrEnum):
     S21 = "S21"
     T21 = "T21"
 
+    def __str__(self):
+        return self.value
 
-class WhatsminerModels(StrEnum):
+
+class WhatsminerModels(str, Enum):
     M20V10 = "M20 V10"
     M20SV10 = "M20S V10"
     M20SV20 = "M20S V20"
@@ -263,8 +266,11 @@ class WhatsminerModels(StrEnum):
     M66SVK30 = "M66S VK30"
     M66SVK40 = "M66S VK40"
 
+    def __str__(self):
+        return self.value
 
-class AvalonminerModels(StrEnum):
+
+class AvalonminerModels(str, Enum):
     Avalon721 = "Avalon 721"
     Avalon741 = "Avalon 741"
     Avalon761 = "Avalon 761"
@@ -278,13 +284,19 @@ class AvalonminerModels(StrEnum):
     Avalon1166Pro = "Avalon 1166 Pro"
     Avalon1246 = "Avalon 1246"
 
+    def __str__(self):
+        return self.value
 
-class InnosiliconModels(StrEnum):
+
+class InnosiliconModels(str, Enum):
     T3HPlus = "T3H+"
     A10X = "A10X"
 
+    def __str__(self):
+        return self.value
 
-class GoldshellModels(StrEnum):
+
+class GoldshellModels(str, Enum):
     CK5 = "CK5"
     HS5 = "HS5"
     KD5 = "KD5"
@@ -292,13 +304,19 @@ class GoldshellModels(StrEnum):
     KDBoxII = "KD Box II"
     KDBoxPro = "KD Box Pro"
 
+    def __str__(self):
+        return self.value
 
-class ePICModels(StrEnum):
+
+class ePICModels(str, Enum):
     BM520i = "BlockMiner 520i"
     BM720i = "BlockMiner 720i"
 
+    def __str__(self):
+        return self.value
 
-class AuradineModels(StrEnum):
+
+class AuradineModels(str, Enum):
     AT1500 = "AT1500"
     AT2860 = "AT2860"
     AT2880 = "AT2880"
@@ -307,6 +325,9 @@ class AuradineModels(StrEnum):
     AD2500 = "AD2500"
     AD3500 = "AD3500"
 
+    def __str__(self):
+        return self.value
+
 
 class MinerModel:
     ANTMINER = AntminerModels

pyasic/miners/backends/braiins_os.py

@@ -865,7 +865,9 @@ class BOSer(BraiinsOSFirmware):
     ) -> Optional[int]:
         if grpc_active_performance_mode is None:
             try:
-                grpc_active_performance_mode = self.web.get_active_performance_mode()
+                grpc_active_performance_mode = (
+                    await self.web.get_active_performance_mode()
+                )
             except APIError:
                 pass
 

pyasic/miners/backends/epic.py

@@ -270,7 +270,7 @@ class ePIC(ePICFirmware):
                             ideal = hb["Hashrate"][1] / 100
 
                         hashrate += hb["Hashrate"][0] / ideal
-                    return AlgoHashRate.SHA256(hashrate, HashUnit.SHA256.GH).int(
+                    return AlgoHashRate.SHA256(hashrate, HashUnit.SHA256.MH).into(
                         self.algo.unit.default
                     )
             except (LookupError, ValueError, TypeError):
@@ -317,7 +317,7 @@ class ePIC(ePICFirmware):
             except APIError:
                 pass
 
-        if web_capabilities is not None:
+        if web_capabilities is None:
             try:
                 web_capabilities = await self.web.capabilities()
             except APIError:

pyasic/web/braiins_os/boser.py

@@ -78,13 +78,16 @@ class BOSerWebAPI(BaseWebAPI):
         for command in commands:
             try:
                 tasks[command] = asyncio.create_task(getattr(self, command)())
-            except (APIError, AttributeError):
-                result["command"] = {}
+            except AttributeError:
+                pass
 
-        await asyncio.gather(*list(tasks.values()))
+        await asyncio.gather(*[t for t in tasks.values()], return_exceptions=True)
 
         for cmd in tasks:
-            result[cmd] = tasks[cmd].result()
+            try:
+                result[cmd] = await tasks[cmd]
+            except (GRPCError, APIError):
+                pass
 
         return result
 
@@ -149,42 +152,55 @@ class BOSerWebAPI(BaseWebAPI):
         )
 
     async def start(self) -> dict:
-        return await self.send_command("start", message=StartRequest())
+        return await self.send_command("start", message=StartRequest(), privileged=True)
 
     async def stop(self) -> dict:
-        return await self.send_command("stop", message=StopRequest())
+        return await self.send_command("stop", message=StopRequest(), privileged=True)
 
     async def pause_mining(self) -> dict:
-        return await self.send_command("pause_mining", message=PauseMiningRequest())
+        return await self.send_command(
+            "pause_mining", message=PauseMiningRequest(), privileged=True
+        )
 
     async def resume_mining(self) -> dict:
-        return await self.send_command("resume_mining", message=ResumeMiningRequest())
+        return await self.send_command(
+            "resume_mining", message=ResumeMiningRequest(), privileged=True
+        )
 
     async def restart(self) -> dict:
-        return await self.send_command("restart", message=RestartRequest())
+        return await self.send_command(
+            "restart", message=RestartRequest(), privileged=True
+        )
 
     async def reboot(self) -> dict:
-        return await self.send_command("reboot", message=RebootRequest())
+        return await self.send_command(
+            "reboot", message=RebootRequest(), privileged=True
+        )
 
     async def set_locate_device_status(self, enable: bool) -> dict:
         return await self.send_command(
             "set_locate_device_status",
             message=SetLocateDeviceStatusRequest(enable=enable),
+            privileged=True,
         )
 
     async def get_locate_device_status(self) -> dict:
         return await self.send_command(
-            "get_locate_device_status", message=GetLocateDeviceStatusRequest()
+            "get_locate_device_status",
+            message=GetLocateDeviceStatusRequest(),
+            privileged=True,
         )
 
     async def set_password(self, password: str = None) -> dict:
         return await self.send_command(
-            "set_password", message=SetPasswordRequest(password=password)
+            "set_password",
+            message=SetPasswordRequest(password=password),
+            privileged=True,
         )
 
     async def get_cooling_state(self) -> dict:
         return await self.send_command(
-            "get_cooling_state", message=GetCoolingStateRequest()
+            "get_cooling_state", message=GetCoolingStateRequest(), privileged=True
         )
 
     async def set_immersion_mode(
@@ -197,16 +213,17 @@ class BOSerWebAPI(BaseWebAPI):
             message=SetImmersionModeRequest(
                 enable_immersion_mode=enable, save_action=save_action
             ),
+            privileged=True,
         )
 
     async def get_tuner_state(self) -> dict:
         return await self.send_command(
-            "get_tuner_state", message=GetTunerStateRequest()
+            "get_tuner_state", message=GetTunerStateRequest(), privileged=True
         )
 
     async def list_target_profiles(self) -> dict:
         return await self.send_command(
-            "list_target_profiles", message=ListTargetProfilesRequest()
+            "list_target_profiles", message=ListTargetProfilesRequest(), privileged=True
         )
 
     async def set_default_power_target(
@@ -215,6 +232,7 @@ class BOSerWebAPI(BaseWebAPI):
         return await self.send_command(
             "set_default_power_target",
             message=SetDefaultPowerTargetRequest(save_action=save_action),
+            privileged=True,
         )
 
     async def set_power_target(
@@ -227,6 +245,7 @@ class BOSerWebAPI(BaseWebAPI):
             message=SetPowerTargetRequest(
                 power_target=Power(watt=power_target), save_action=save_action
             ),
+            privileged=True,
         )
 
     async def increment_power_target(
@@ -240,6 +259,7 @@ class BOSerWebAPI(BaseWebAPI):
                 power_target_increment=Power(watt=power_target_increment),
                 save_action=save_action,
             ),
+            privileged=True,
         )
 
     async def decrement_power_target(
@@ -253,6 +273,7 @@ class BOSerWebAPI(BaseWebAPI):
                 power_target_decrement=Power(watt=power_target_decrement),
                 save_action=save_action,
             ),
+            privileged=True,
         )
 
     async def set_default_hashrate_target(
@@ -261,6 +282,7 @@ class BOSerWebAPI(BaseWebAPI):
         return await self.send_command(
             "set_default_hashrate_target",
             message=SetDefaultHashrateTargetRequest(save_action=save_action),
+            privileged=True,
         )
 
     async def set_hashrate_target(
@@ -274,6 +296,7 @@ class BOSerWebAPI(BaseWebAPI):
                 hashrate_target=TeraHashrate(terahash_per_second=hashrate_target),
                 save_action=save_action,
             ),
+            privileged=True,
         )
 
     async def increment_hashrate_target(
@@ -289,6 +312,7 @@ class BOSerWebAPI(BaseWebAPI):
                 ),
                 save_action=save_action,
             ),
+            privileged=True,
         )
 
     async def decrement_hashrate_target(
@@ -304,6 +328,7 @@ class BOSerWebAPI(BaseWebAPI):
                 ),
                 save_action=save_action,
             ),
+            privileged=True,
         )
 
     async def set_dps(
@@ -327,6 +352,7 @@ class BOSerWebAPI(BaseWebAPI):
                     )
                 ),
             ),
+            privileged=True,
         )
 
     async def set_performance_mode(
@@ -356,6 +382,7 @@ class BOSerWebAPI(BaseWebAPI):
                         )
                     ),
                 ),
+                privileged=True,
             )
         if hashrate_target is not None:
             return await self.send_command(
@@ -372,16 +399,19 @@ class BOSerWebAPI(BaseWebAPI):
                         )
                     ),
                 ),
+                privileged=True,
             )
 
     async def get_active_performance_mode(self) -> dict:
         return await self.send_command(
-            "get_active_performance_mode", message=GetPerformanceModeRequest()
+            "get_active_performance_mode",
+            message=GetPerformanceModeRequest(),
+            privileged=True,
         )
 
     async def get_pool_groups(self) -> dict:
         return await self.send_command(
-            "get_pool_groups", message=GetPoolGroupsRequest()
+            "get_pool_groups", message=GetPoolGroupsRequest(), privileged=True
         )
 
     async def create_pool_group(self) -> dict:
@@ -395,40 +425,44 @@ class BOSerWebAPI(BaseWebAPI):
 
     async def get_miner_configuration(self) -> dict:
         return await self.send_command(
-            "get_miner_configuration", message=GetMinerConfigurationRequest()
+            "get_miner_configuration",
+            message=GetMinerConfigurationRequest(),
+            privileged=True,
         )
 
     async def get_constraints(self) -> dict:
         return await self.send_command(
-            "get_constraints", message=GetConstraintsRequest()
+            "get_constraints", message=GetConstraintsRequest(), privileged=True
         )
 
     async def get_license_state(self) -> dict:
         return await self.send_command(
-            "get_license_state", message=GetLicenseStateRequest()
+            "get_license_state", message=GetLicenseStateRequest(), privileged=True
         )
 
     async def get_miner_status(self) -> dict:
         return await self.send_command(
-            "get_miner_status", message=GetMinerStatusRequest()
+            "get_miner_status", message=GetMinerStatusRequest(), privileged=True
         )
 
     async def get_miner_details(self) -> dict:
         return await self.send_command(
-            "get_miner_details", message=GetMinerDetailsRequest()
+            "get_miner_details", message=GetMinerDetailsRequest(), privileged=True
         )
 
     async def get_miner_stats(self) -> dict:
         return await self.send_command(
-            "get_miner_stats", message=GetMinerStatsRequest()
+            "get_miner_stats", message=GetMinerStatsRequest(), privileged=True
         )
 
     async def get_hashboards(self) -> dict:
-        return await self.send_command("get_hashboards", message=GetHashboardsRequest())
+        return await self.send_command(
+            "get_hashboards", message=GetHashboardsRequest(), privileged=True
+        )
 
     async def get_support_archive(self) -> dict:
         return await self.send_command(
-            "get_support_archive", message=GetSupportArchiveRequest()
+            "get_support_archive", message=GetSupportArchiveRequest(), privileged=True
         )
 
     async def enable_hashboards(
@@ -441,6 +475,7 @@ class BOSerWebAPI(BaseWebAPI):
             message=EnableHashboardsRequest(
                 hashboard_ids=hashboard_ids, save_action=save_action
             ),
+            privileged=True,
         )
 
     async def disable_hashboards(
@@ -453,4 +488,5 @@ class BOSerWebAPI(BaseWebAPI):
             message=DisableHashboardsRequest(
                 hashboard_ids=hashboard_ids, save_action=save_action
             ),
+            privileged=True,
         )

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyasic"
-version = "0.57.0"
+version = "0.57.4"
 description = "A simplified and standardized interface for Bitcoin ASICs."
 authors = ["UpstreamData <brett@upstreamdata.ca>"]
 repository = "https://github.com/UpstreamData/pyasic"