bump version number

.coveragerc

@@ -0,0 +1,17 @@
+[report]
+exclude_lines =
+    # Skip @abstractmethod
+    @abstractmethod
+    @abc.abstractmethod
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+    if self\.debug
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+    if __name__ == .__main__.:

docs/data/error_codes.md

@@ -23,3 +23,11 @@
     options:
         show_root_heading: false
         heading_level: 4
+<br>
+
+## Innosilicon Error Codes
+::: pyasic.data.error_codes.InnosiliconError
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/index.md

@@ -101,3 +101,133 @@ async def gather_miner_data():  # define async scan function to allow awaiting
 if __name__ == "__main__":
     asyncio.run(gather_miner_data())
 ```
+
+<br>
+
+## Controlling miners via pyasic
+Every miner class in pyasic must implement all the control functions defined in [`BaseMiner`][pyasic.miners.BaseMiner].
+
+These functions are
+[`check_light`](#check-light),
+[`fault_light_off`](#fault-light-off),
+[`fault_light_on`](#fault-light-on),
+[`get_config`](#get-config),
+[`get_data`](#get-data),
+[`get_errors`](#get-errors),
+[`get_hostname`](#get-hostname),
+[`get_model`](#get-model),
+[`reboot`](#reboot),
+[`restart_backend`](#restart-backend), and
+[`send_config`](#send-config).
+
+<br>
+
+### Check Light
+::: pyasic.miners.BaseMiner.check_light
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+### Fault Light Off
+::: pyasic.miners.BaseMiner.fault_light_off
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+### Fault Light On
+::: pyasic.miners.BaseMiner.fault_light_on
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+### Get Config
+::: pyasic.miners.BaseMiner.get_config
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+### Get Data
+::: pyasic.miners.BaseMiner.get_data
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+### Get Errors
+::: pyasic.miners.BaseMiner.get_errors
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+### Get Hostname
+::: pyasic.miners.BaseMiner.get_hostname
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+### Get Model
+::: pyasic.miners.BaseMiner.get_model
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+### Reboot
+::: pyasic.miners.BaseMiner.reboot
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+### Restart Backend
+::: pyasic.miners.BaseMiner.restart_backend
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+### Send Config
+::: pyasic.miners.BaseMiner.send_config
+    handler: python
+    options:
+        heading_level: 4
+
+<br>
+
+## [`MinerConfig`][pyasic.config.MinerConfig] and [`MinerData`][pyasic.data.MinerData]
+
+Pyasic implements a few dataclasses as helpers to make data return types consistent across different miners and miner APIs.
+
+<br>
+
+### [`MinerData`][pyasic.data.MinerData]
+
+[`MinerData`][pyasic.data.MinerData] is a return from the [`get_data()`](#get-data) function, and is used to have a consistent dataset across all returns.
+
+You can call [`MinerData.asdict()`][pyasic.data.MinerData.asdict] to get the dataclass as a dictionary, and there are many other helper functions contained in the class to convert to different data formats.
+
+<br>
+
+### [`MinerConfig`][pyasic.config.MinerConfig]
+
+[`MinerConfig`][pyasic.config.MinerConfig] is pyasic's way to represent a configuration file from a miner.
+It is the return from [`get_config()`](#get-config).
+
+Each miner has a unique way to convert the [`MinerConfig`][pyasic.config.MinerConfig] to their specific type, there are helper functions in the class.
+In most cases these helper functions should not be used, as [`send_config()`](#send-config) takes a [`MinerConfig`][pyasic.config.MinerConfig] and will do the conversion to the right type for you.

mkdocs.yml

@@ -11,7 +11,6 @@ nav:
           - BTMiner: "miners/backends/btminer.md"
           - CGMiner: "miners/backends/cgminer.md"
           - Hiveon: "miners/backends/hiveon.md"
-
       - Classes:
           - Antminer X9: "miners/antminer/X9.md"
           - Antminer X17: "miners/antminer/X17.md"
@@ -23,14 +22,12 @@ nav:
           - Whatsminer M2X: "miners/whatsminer/M2X.md"
           - Whatsminer M3X: "miners/whatsminer/M3X.md"
           - Innosilicon T3X: "miners/innosilicon/T3X.md"
-
   - Network:
       - Miner Network: "network/miner_network.md"
       - Miner Network Range: "network/miner_network_range.md"
-  - Data:
+  - Dataclasses:
       - Miner Data: "data/miner_data.md"
       - Error Codes: "data/error_codes.md"
-  - Config:
       - Miner Config: "config/miner_config.md"
   - Advanced:
       - Miner APIs:

pyasic/API/__init__.py

@@ -19,33 +19,7 @@ import warnings
 import logging
 from typing import Union
 
-
-class APIError(Exception):
-    def __init__(self, *args):
-        if args:
-            self.message = args[0]
-        else:
-            self.message = None
-
-    def __str__(self):
-        if self.message:
-            return f"{self.message}"
-        else:
-            return "Incorrect API parameters."
-
-
-class APIWarning(Warning):
-    def __init__(self, *args):
-        if args:
-            self.message = args[0]
-        else:
-            self.message = None
-
-    def __str__(self):
-        if self.message:
-            return f"{self.message}"
-        else:
-            return "Incorrect API parameters."
+from pyasic.errors import APIError, APIWarning
 
 
 class BaseMinerAPI:

pyasic/API/btminer.py

@@ -24,7 +24,8 @@ from typing import Union
 from passlib.handlers.md5_crypt import md5_crypt
 from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
 
-from pyasic.API import BaseMinerAPI, APIError
+from pyasic.errors import APIError
+from pyasic.API import BaseMinerAPI
 from pyasic.settings import PyasicSettings
 
 

pyasic/__init__.py

@@ -11,3 +11,51 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
+from pyasic.API.bmminer import BMMinerAPI
+from pyasic.API.bosminer import BOSMinerAPI
+from pyasic.API.btminer import BTMinerAPI
+from pyasic.API.cgminer import CGMinerAPI
+from pyasic.API.unknown import UnknownAPI
+
+from pyasic.config import MinerConfig
+
+from pyasic.data import (
+    MinerData,
+    BraiinsOSError,
+    InnosiliconError,
+    WhatsminerError,
+    X19Error,
+)
+
+from pyasic.errors import APIError, APIWarning
+
+from pyasic.miners import get_miner
+from pyasic.miners.base import AnyMiner
+from pyasic.miners.miner_factory import MinerFactory
+from pyasic.miners.miner_listener import MinerListener
+
+from pyasic.network import MinerNetwork
+
+from pyasic.settings import PyasicSettings
+
+__all__ = [
+    "BMMinerAPI",
+    "BOSMinerAPI",
+    "BTMinerAPI",
+    "CGMinerAPI",
+    "UnknownAPI",
+    "MinerConfig",
+    "MinerData",
+    "BraiinsOSError",
+    "InnosiliconError",
+    "WhatsminerError",
+    "X19Error",
+    "APIError",
+    "APIWarning",
+    "get_miner",
+    "AnyMiner",
+    "MinerFactory",
+    "MinerListener",
+    "MinerNetwork",
+    "PyasicSettings",
+]

pyasic/config/__init__.py

@@ -247,7 +247,7 @@ class MinerConfig:
     temp_mode: Literal["auto", "manual", "disabled"] = "auto"
     temp_target: float = 70.0
     temp_hot: float = 80.0
-    temp_dangerous: float = 10.0
+    temp_dangerous: float = 100.0
 
     minimum_fans: int = None
     fan_speed: Literal[tuple(range(101))] = None  # noqa - Ignore weird Literal usage
@@ -299,6 +299,10 @@ class MinerConfig:
                     self.temp_mode = "manual"
                     if data.get("bitmain-fan-pwm"):
                         self.fan_speed = int(data["bitmain-fan-pwm"])
+            elif key == "bitmain-work-mode":
+                if data[key]:
+                    if data[key] == 1:
+                        self.autotuning_wattage = 0
             elif key == "fan_control":
                 for _key in data[key].keys():
                     if _key == "min_fans":
@@ -409,7 +413,10 @@ class MinerConfig:
             "pools": self.pool_groups[0].as_x19(user_suffix=user_suffix),
             "bitmain-fan-ctrl": False,
             "bitmain-fan-pwn": 100,
+            "miner-mode": 0,  # Normal Mode
         }
+        if self.autotuning_wattage == 0:
+            cfg["miner-mode"] = 1  # Sleep Mode
 
         if not self.temp_mode == "auto":
             cfg["bitmain-fan-ctrl"] = True

pyasic/data/__init__.py

@@ -175,15 +175,33 @@ class MinerData:
     def efficiency(self, val):
         pass
 
-    def asdict(self):
+    def asdict(self) -> dict:
+        """Get this dataclass as a dictionary.
+
+        Returns:
+            A dictionary version of this class.
+        """
         return asdict(self)
 
-    def as_json(self):
+    def as_json(self) -> str:
+        """Get this dataclass as JSON.
+
+        Returns:
+            A JSON version of this class.
+        """
         data = self.asdict()
         data["datetime"] = str(int(time.mktime(data["datetime"].timetuple())))
         return json.dumps(data)
 
-    def as_influxdb(self, measurement_name: str = "miner_data"):
+    def as_influxdb(self, measurement_name: str = "miner_data") -> str:
+        """Get this dataclass as [influxdb line protocol](https://docs.influxdata.com/influxdb/v2.4/reference/syntax/line-protocol/).
+
+        Parameters:
+            measurement_name: The name of the measurement to insert into in influxdb.
+
+        Returns:
+            A influxdb line protocol version of this class.
+        """
         tag_data = [measurement_name]
         field_data = []
 

pyasic/errors/__init__.py

@@ -0,0 +1,41 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+class APIError(Exception):
+    def __init__(self, *args):
+        if args:
+            self.message = args[0]
+        else:
+            self.message = None
+
+    def __str__(self):
+        if self.message:
+            return f"{self.message}"
+        else:
+            return "Incorrect API parameters."
+
+
+class APIWarning(Warning):
+    def __init__(self, *args):
+        if args:
+            self.message = args[0]
+        else:
+            self.message = None
+
+    def __str__(self):
+        if self.message:
+            return f"{self.message}"
+        else:
+            return "Incorrect API parameters."

pyasic/miners/_backends/bosminer.py

@@ -22,7 +22,7 @@ import toml
 
 from pyasic.miners.base import BaseMiner
 from pyasic.API.bosminer import BOSMinerAPI
-from pyasic.API import APIError
+from pyasic.errors import APIError
 
 from pyasic.data.error_codes import BraiinsOSError
 from pyasic.data import MinerData
@@ -234,9 +234,11 @@ class BOSMiner(BaseMiner):
     async def check_light(self) -> bool:
         if self.light:
             return self.light
-        data = await self.send_ssh_command("ls /sys/class/leds/'Red LED'/")
+        data = (
+            await self.send_ssh_command("cat /sys/class/leds/'Red LED'/delay_off")
+        ).strip()
         self.light = False
-        if "delay_on" in data:
+        if data == "50":
             self.light = True
         return self.light
 

pyasic/miners/_backends/bosminer_old.py

@@ -20,6 +20,7 @@ from typing import Union
 from pyasic.API.bosminer import BOSMinerAPI
 from pyasic.miners.base import BaseMiner
 from pyasic.config import MinerConfig
+from pyasic.data import MinerData
 
 
 class BOSMinerOld(BaseMiner):
@@ -96,3 +97,6 @@ class BOSMinerOld(BaseMiner):
 
     async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
         return None
+
+    async def get_data(self) -> MinerData:
+        return MinerData(ip=str(self.ip))

pyasic/miners/_backends/btminer.py

@@ -19,7 +19,7 @@ from typing import Union
 
 from pyasic.API.btminer import BTMinerAPI
 from pyasic.miners.base import BaseMiner
-from pyasic.API import APIError
+from pyasic.errors import APIError
 
 from pyasic.data import MinerData
 from pyasic.data.error_codes import WhatsminerError

pyasic/miners/_backends/cgminer.py

@@ -19,7 +19,7 @@ from typing import Union
 
 from pyasic.API.cgminer import CGMinerAPI
 from pyasic.miners.base import BaseMiner
-from pyasic.API import APIError
+from pyasic.errors import APIError
 from pyasic.config import MinerConfig
 
 from pyasic.data import MinerData

pyasic/miners/antminer/bmminer/X19/X19.py

@@ -146,3 +146,13 @@ class BMMinerX19(BMMiner):
                         if not item["status"] == "s":
                             errors.append(X19Error(item["msg"]))
         return errors
+
+    async def stop_mining(self) -> None:
+        cfg = await self.get_config()
+        cfg.autotuning_wattage = 0
+        await self.send_config(cfg)
+
+    async def resume_mining(self):
+        cfg = await self.get_config()
+        cfg.autotuning_wattage = 1
+        await self.send_config(cfg)

pyasic/miners/antminer/cgminer/X9/__init__.py

@@ -13,3 +13,4 @@
 #  limitations under the License.
 
 from .S9 import CGMinerS9
+from .T9 import CGMinerT9

pyasic/miners/base.py

@@ -16,10 +16,16 @@ import asyncssh
 import logging
 import ipaddress
 from abc import ABC, abstractmethod
-from typing import TypeVar
+from typing import TypeVar, List, Union
 
 from pyasic.data import MinerData
 from pyasic.config import MinerConfig
+from pyasic.data.error_codes import (
+    WhatsminerError,
+    BraiinsOSError,
+    InnosiliconError,
+    X19Error,
+)
 
 
 class BaseMiner(ABC):
@@ -85,57 +91,113 @@ class BaseMiner(ABC):
 
     @abstractmethod
     async def fault_light_on(self) -> bool:
+        """Turn the fault light of the miner on and return success as a boolean.
+
+        Returns:
+            A boolean value of the success of turning the light on.
+        """
         pass
 
     @abstractmethod
     async def fault_light_off(self) -> bool:
-        pass
+        """Turn the fault light of the miner off and return success as a boolean.
 
-    # async def send_file(self, src, dest):
-    #     async with (await self._get_ssh_connection()) as conn:
-    #         await asyncssh.scp(src, (conn, dest))
+        Returns:
+            A boolean value of the success of turning the light off.
+        """
+        pass
 
     @abstractmethod
     async def check_light(self) -> bool:
-        pass
+        """Check the status and return on or off as a boolean.
 
-    # @abstractmethod
-    async def get_board_info(self):
-        return None
+        Returns:
+            A boolean value where `True` represents on and `False` represents off.
+        """
+        pass
 
     @abstractmethod
     async def get_config(self) -> MinerConfig:
+        """Get the mining configuration of the miner and return it as a [`MinerConfig`][pyasic.config.MinerConfig].
+
+        Returns:
+            A [`MinerConfig`][pyasic.config.MinerConfig] containing the pool information and mining configuration.
+        """
         pass
 
     @abstractmethod
     async def get_hostname(self) -> str:
+        """Get the hostname of the miner and return it as a string.
+
+        Returns:
+            A string representing the hostname of the miner.
+        """
         pass
 
     @abstractmethod
     async def get_model(self) -> str:
+        """Get the model of the miner and return it as a string.
+
+        Returns:
+            A string representing the model of the miner.
+        """
         pass
 
     @abstractmethod
     async def reboot(self) -> bool:
+        """Reboot the miner and return success as a boolean.
+
+        Returns:
+            A boolean value of the success of rebooting the miner.
+        """
         pass
 
     @abstractmethod
     async def restart_backend(self) -> bool:
+        """Restart the mining process of the miner (bosminer, bmminer, cgminer, etc) and return success as a boolean.
+
+        Returns:
+            A boolean value of the success of restarting the mining process.
+        """
         pass
 
     @abstractmethod
     async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
+        """Set the mining configuration of the miner.
+
+        Parameters:
+            config: A [`MinerConfig`][pyasic.config.MinerConfig] containing the mining config you want to switch the miner to.
+            user_suffix: A suffix to append to the username when sending to the miner.
+        """
         return None
 
     @abstractmethod
     async def get_mac(self) -> str:
+        """Get the MAC address of the miner and return it as a string.
+
+        Returns:
+            A string representing the MAC address of the miner.
+        """
         pass
 
     @abstractmethod
-    async def get_errors(self) -> list:
+    async def get_errors(
+        self,
+    ) -> List[Union[WhatsminerError, BraiinsOSError, InnosiliconError, X19Error]]:
+        """Get a list of the errors the miner is experiencing.
+
+        Returns:
+            A list of error classes representing different errors.
+        """
         pass
 
+    @abstractmethod
     async def get_data(self) -> MinerData:
+        """Get data from the miner in the form of [`MinerData`][pyasic.data.MinerData].
+
+        Returns:
+            A [`MinerData`][pyasic.data.MinerData] instance containing data from the miner.
+        """
         return MinerData(ip=str(self.ip))
 
 

pyasic/miners/innosilicon/cgminer/T3X/T3H_Plus.py

@@ -18,7 +18,7 @@ from pyasic.data import MinerData
 from pyasic.data.error_codes import InnosiliconError
 from pyasic.settings import PyasicSettings
 from pyasic.config import MinerConfig
-from pyasic.API import APIError
+from pyasic.errors import APIError
 
 import httpx
 import warnings
@@ -31,7 +31,7 @@ class CGMinerInnosiliconT3HPlus(CGMiner, InnosiliconT3HPlus):
         super().__init__(ip)
         self.ip = ip
         self.uname = "admin"
-        self.pwd = "admin"
+        self.pwd = PyasicSettings().global_innosilicon_password
         self.jwt = None
 
     async def auth(self):

pyasic/miners/miner_factory.py

@@ -32,7 +32,9 @@ from pyasic.miners._backends.bosminer_old import (  # noqa - Ignore _module impo
 
 from pyasic.miners.unknown import UnknownMiner
 
-from pyasic.API import APIError
+from pyasic.errors import APIError
+
+from pyasic.misc import Singleton
 
 import asyncio
 import ipaddress
@@ -59,6 +61,7 @@ MINER_CLASSES = {
         "Default": BMMinerT9,
         "BMMiner": BMMinerT9,
         "Hiveon": HiveonT9,
+        "CGMiner": CGMinerT9,
     },
     "ANTMINER S17": {
         "Default": BMMinerS17,
@@ -252,15 +255,6 @@ MINER_CLASSES = {
 }
 
 
-class Singleton(type):
-    _instances = {}
-
-    def __call__(cls, *args, **kwargs):
-        if cls not in cls._instances:
-            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
-        return cls._instances[cls]
-
-
 class MinerFactory(metaclass=Singleton):
     """A factory to handle identification and selection of the proper class of miner"""
 
@@ -637,9 +631,7 @@ class MinerFactory(metaclass=Singleton):
         else:
             # make sure the command succeeded
             if data["STATUS"][0]["STATUS"] not in ("S", "I"):
-                # this is an error
-                if data["STATUS"][0]["STATUS"] not in ("S", "I"):
-                    return False, data["STATUS"][0]["Msg"]
+                return False, data["STATUS"][0]["Msg"]
         return True, None
 
     @staticmethod

pyasic/miners/miner_listener.py

@@ -14,14 +14,7 @@
 
 import asyncio
 
-
-class Singleton(type):
-    _instances = {}
-
-    def __call__(cls, *args, **kwargs):
-        if cls not in cls._instances:
-            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
-        return cls._instances[cls]
+from pyasic.misc import Singleton
 
 
 class _MinerListener:

pyasic/miners/unknown.py

@@ -15,6 +15,7 @@
 from pyasic.API.unknown import UnknownAPI
 from pyasic.miners.base import BaseMiner
 from pyasic.config import MinerConfig
+from pyasic.data import MinerData
 
 
 class UnknownMiner(BaseMiner):
@@ -61,3 +62,6 @@ class UnknownMiner(BaseMiner):
 
     async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
         return None
+
+    async def get_data(self) -> MinerData:
+        return MinerData(ip=str(self.ip))

pyasic/misc/__init__.py

@@ -0,0 +1,22 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+class Singleton(type):
+    _instances = {}
+
+    def __call__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
+        return cls._instances[cls]

pyasic/network/__init__.py

@@ -37,7 +37,9 @@ class MinerNetwork:
     """
 
     def __init__(
-        self, ip_addr: Union[str, None] = None, mask: Union[str, int, None] = None
+        self,
+        ip_addr: Union[str, List[str], None] = None,
+        mask: Union[str, int, None] = None,
     ) -> None:
         self.network = None
         self.ip_addr = ip_addr
@@ -63,18 +65,14 @@ class MinerNetwork:
         if self.network:
             return self.network
 
+            # if there is no IP address passed, default to 192.168.1.0
+        if not self.ip_addr:
+            self.ip_addr = "192.168.1.0"
         if "-" in self.ip_addr:
             self.network = MinerNetworkRange(self.ip_addr)
         elif isinstance(self.ip_addr, list):
             self.network = MinerNetworkRange(self.ip_addr)
         else:
-            # if there is no IP address passed, default to 192.168.1.0
-            if not self.ip_addr:
-                default_gateway = "192.168.1.0"
-            # if we do have an IP address passed, use that
-            else:
-                default_gateway = self.ip_addr
-
             # if there is no subnet mask passed, default to /24
             if not self.mask:
                 subnet_mask = "24"
@@ -84,7 +82,7 @@ class MinerNetwork:
 
             # save the network and return it
             self.network = ipaddress.ip_network(
-                f"{default_gateway}/{subnet_mask}", strict=False
+                f"{self.ip_addr}/{subnet_mask}", strict=False
             )
 
         logging.debug(f"Setting MinerNetwork: {self.network}")

pyasic/settings/__init__.py

@@ -14,14 +14,7 @@
 
 from dataclasses import dataclass
 
-
-class Singleton(type):
-    _instances = {}
-
-    def __call__(cls, *args, **kwargs):
-        if cls not in cls._instances:
-            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
-        return cls._instances[cls]
+from pyasic.misc import Singleton
 
 
 @dataclass
@@ -35,6 +28,7 @@ class PyasicSettings(metaclass=Singleton):
     miner_get_data_retries: int = 1
 
     global_whatsminer_password = "admin"
+    global_innosilicon_password = "admin"
     global_x19_password = "root"
     global_x17_password = "root"
 

pyasic/tests/miners_tests/__init__.py

@@ -1,54 +0,0 @@
-#  Copyright 2022 Upstream Data Inc
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-import unittest
-
-from pyasic.miners.miner_factory import MINER_CLASSES
-
-import inspect
-import sys
-
-
-class MinersTest(unittest.TestCase):
-    def test_miner_model_creation(self):
-        for miner_model in MINER_CLASSES.keys():
-            for miner_api in MINER_CLASSES[miner_model].keys():
-                with self.subTest(miner_model=miner_model, miner_api=miner_api):
-                    miner = MINER_CLASSES[miner_model][miner_api]("0.0.0.0")
-                    self.assertTrue(
-                        isinstance(miner, MINER_CLASSES[miner_model][miner_api])
-                    )
-
-    def test_miner_backend_backup_creation(self):
-        backends = inspect.getmembers(
-            sys.modules["pyasic.miners._backends"], inspect.isclass
-        )
-        for backend in backends:
-            miner_class = backend[1]
-            with self.subTest(miner_class=miner_class):
-                miner = miner_class("0.0.0.0")
-                self.assertTrue(isinstance(miner, miner_class))
-
-    def test_miner_type_creation_failure(self):
-        backends = inspect.getmembers(
-            sys.modules["pyasic.miners._types"], inspect.isclass
-        )
-        for backend in backends:
-            miner_class = backend[1]
-            with self.subTest(miner_class=miner_class):
-                with self.assertRaises(TypeError):
-                    miner_class("0.0.0.0")
-
-
-if __name__ == "__main__":
-    unittest.main()

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyasic"
-version = "0.17.0"
+version = "0.17.5"
 description = "A set of modules for interfacing with many common types of ASIC bitcoin miners, using both their API and SSH."
 authors = ["UpstreamData <brett@upstreamdata.ca>"]
 repository = "https://github.com/UpstreamData/pyasic"

tests/__init__.py

@@ -13,8 +13,10 @@
 #  limitations under the License.
 
 import unittest
-from pyasic.tests.miners_tests import MinersTest
-from pyasic.tests.network_tests import NetworkTest
+from tests.miners_tests import MinersTest, MinerFactoryTest
+from tests.network_tests import NetworkTest
+from tests.config_tests import ConfigTest
 
 if __name__ == "__main__":
+    # `coverage run --source pyasic -m unittest discover` will give code coverage data
     unittest.main()

tests/config_tests/__init__.py

@@ -0,0 +1,111 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+import unittest
+
+from pyasic.config import MinerConfig, _PoolGroup, _Pool  # noqa
+from tests.test_data import (
+    bosminer_api_pools,
+    x19_api_pools,
+    x19_web_pools,
+    bosminer_config_pools,
+)
+
+
+class ConfigTest(unittest.TestCase):
+    def setUp(self) -> None:
+        self.test_config = MinerConfig(
+            pool_groups=[
+                _PoolGroup(
+                    quota=1,
+                    group_name="TEST",
+                    pools=[
+                        _Pool(
+                            url="stratum+tcp://pyasic.testpool_1.pool:3333",
+                            username="pyasic.test",
+                            password="123",
+                        ),
+                        _Pool(
+                            url="stratum+tcp://pyasic.testpool_2.pool:3333",
+                            username="pyasic.test",
+                            password="123",
+                        ),
+                    ],
+                )
+            ],
+            temp_mode="auto",
+            temp_target=70.0,
+            temp_hot=80.0,
+            temp_dangerous=100.0,
+            fan_speed=None,
+            autotuning_enabled=True,
+            autotuning_wattage=900,
+        )
+
+    def test_config_from_raw(self):
+        bos_config = MinerConfig().from_raw(bosminer_config_pools)
+        bos_config.pool_groups[0].group_name = "TEST"
+
+        with self.subTest(
+            msg="Testing BOSMiner config file config.", bos_config=bos_config
+        ):
+            self.assertEqual(bos_config, self.test_config)
+
+        x19_cfg = MinerConfig().from_raw(x19_web_pools)
+        x19_cfg.pool_groups[0].group_name = "TEST"
+
+        with self.subTest(msg="Testing X19 API config.", x19_cfg=x19_cfg):
+            self.assertEqual(x19_cfg, self.test_config)
+
+    def test_config_from_api(self):
+        bos_cfg = MinerConfig().from_api(bosminer_api_pools["POOLS"])
+        bos_cfg.pool_groups[0].group_name = "TEST"
+
+        with self.subTest(msg="Testing BOSMiner API config.", bos_cfg=bos_cfg):
+            self.assertEqual(bos_cfg, self.test_config)
+
+        x19_cfg = MinerConfig().from_api(x19_api_pools["POOLS"])
+        x19_cfg.pool_groups[0].group_name = "TEST"
+
+        with self.subTest(msg="Testing X19 API config.", x19_cfg=x19_cfg):
+            self.assertEqual(x19_cfg, self.test_config)
+
+    def test_config_as_types(self):
+        cfg = MinerConfig().from_api(bosminer_api_pools["POOLS"])
+        cfg.pool_groups[0].group_name = "TEST"
+
+        commands = [
+            func
+            for func in
+            # each function in self
+            dir(cfg)
+            if callable(getattr(cfg, func)) and
+            # no __ methods
+            not func.startswith("__")
+        ]
+
+        for command in [cmd for cmd in commands if cmd.startswith("as_")]:
+            with self.subTest():
+                output = getattr(cfg, command)()
+                self.assertEqual(output, getattr(self.test_config, command)())
+                if f"from_{command.split('as_')[1]}" in commands:
+                    self.assertEqual(
+                        getattr(MinerConfig(), f"from_{command.split('as_')[1]}")(
+                            output
+                        ),
+                        self.test_config,
+                    )
+
+
+if __name__ == "__main__":
+    unittest.main()

tests/miners_tests/__init__.py

@@ -0,0 +1,162 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+import unittest
+
+from pyasic.miners.miner_factory import MINER_CLASSES
+from pyasic.miners.base import BaseMiner
+from pyasic.miners._backends import CGMiner
+from pyasic.miners.miner_factory import MinerFactory
+from pyasic.miners.miner_listener import MinerListener
+
+import asyncio
+
+import inspect
+import sys
+
+
+class MinersTest(unittest.TestCase):
+    def test_miner_model_creation(self):
+        for miner_model in MINER_CLASSES.keys():
+            for miner_api in MINER_CLASSES[miner_model].keys():
+                with self.subTest(
+                    msg=f"Creation of miner using model={miner_model}, api={miner_api}",
+                    miner_model=miner_model,
+                    miner_api=miner_api,
+                ):
+                    miner = MINER_CLASSES[miner_model][miner_api]("0.0.0.0")
+                    self.assertTrue(
+                        isinstance(miner, MINER_CLASSES[miner_model][miner_api])
+                    )
+
+    def test_miner_backend_backup_creation(self):
+        backends = inspect.getmembers(
+            sys.modules["pyasic.miners._backends"], inspect.isclass
+        )
+        for backend in backends:
+            miner_class = backend[1]
+            with self.subTest(miner_class=miner_class):
+                miner = miner_class("0.0.0.0")
+                self.assertTrue(isinstance(miner, miner_class))
+
+    def test_miner_type_creation_failure(self):
+        backends = inspect.getmembers(
+            sys.modules["pyasic.miners._types"], inspect.isclass
+        )
+        for backend in backends:
+            miner_class = backend[1]
+            with self.subTest(miner_class=miner_class):
+                with self.assertRaises(TypeError):
+                    miner_class("0.0.0.0")
+        with self.assertRaises(TypeError):
+            BaseMiner("0.0.0.0")
+
+    def test_miner_comparisons(self):
+        miner_1 = CGMiner("1.1.1.1")
+        miner_2 = CGMiner("2.2.2.2")
+        miner_3 = CGMiner("1.1.1.1")
+        self.assertEqual(miner_1, miner_3)
+        self.assertGreater(miner_2, miner_1)
+        self.assertLess(miner_3, miner_2)
+
+
+class MinerFactoryTest(unittest.TestCase):
+    def test_miner_factory_creation(self):
+        self.assertDictEqual(MinerFactory().miners, {})
+        miner_factory = MinerFactory()
+        self.assertIs(MinerFactory(), miner_factory)
+
+    def test_get_miner_generator(self):
+        async def _coro():
+            gen = MinerFactory().get_miner_generator([])
+            miners = []
+            async for miner in gen:
+                miners.append(miner)
+            return miners
+
+        _miners = asyncio.run(_coro())
+        self.assertListEqual(_miners, [])
+
+    def test_miner_selection(self):
+        for miner_model in MINER_CLASSES.keys():
+            with self.subTest():
+                miner = MinerFactory()._select_miner_from_classes(
+                    "0.0.0.0", miner_model, None, None
+                )
+                self.assertIsInstance(miner, BaseMiner)
+        for api in ["BOSMiner+", "BOSMiner", "CGMiner", "BTMiner", "BMMiner"]:
+            with self.subTest():
+                miner = MinerFactory()._select_miner_from_classes(
+                    "0.0.0.0", None, api, None
+                )
+                self.assertIsInstance(miner, BaseMiner)
+
+        with self.subTest():
+            miner = MinerFactory()._select_miner_from_classes(
+                "0.0.0.0", "ANTMINER S17+", "Fake API", None
+            )
+            self.assertIsInstance(miner, BaseMiner)
+
+        with self.subTest():
+            miner = MinerFactory()._select_miner_from_classes(
+                "0.0.0.0", "M30S", "BTMiner", "G20"
+            )
+            self.assertIsInstance(miner, BaseMiner)
+
+    def test_validate_command(self):
+        bad_test_data_returns = [
+            {},
+            {
+                "cmd": [
+                    {
+                        "STATUS": [
+                            {"STATUS": "E", "Msg": "Command failed for some reason."}
+                        ]
+                    }
+                ]
+            },
+            {"STATUS": "E", "Msg": "Command failed for some reason."},
+            {
+                "STATUS": [{"STATUS": "E", "Msg": "Command failed for some reason."}],
+                "id": 1,
+            },
+        ]
+        for data in bad_test_data_returns:
+            with self.subTest():
+
+                async def _coro(miner_ret):
+                    _data = await MinerFactory()._validate_command(miner_ret)
+                    return _data
+
+                ret = asyncio.run(_coro(data))
+                self.assertFalse(ret[0])
+
+        good_test_data_returns = [
+            {
+                "STATUS": [{"STATUS": "S", "Msg": "Yay! Command succeeded."}],
+                "id": 1,
+            },
+        ]
+        for data in good_test_data_returns:
+            with self.subTest():
+
+                async def _coro(miner_ret):
+                    _data = await MinerFactory()._validate_command(miner_ret)
+                    return _data
+
+                ret = asyncio.run(_coro(data))
+                self.assertTrue(ret[0])
+
+
+if __name__ == "__main__":
+    unittest.main()

tests/network_tests/__init__.py

@@ -31,8 +31,8 @@ class NetworkTest(unittest.TestCase):
             "192.168.1.60",
         ]
 
-        net_1 = list(MinerNetworkRange(net_range_str).hosts())
-        net_2 = list(MinerNetworkRange(net_range_list).hosts())
+        net_1 = list(MinerNetwork(net_range_str).get_network().hosts())
+        net_2 = list(MinerNetwork(net_range_list).get_network().hosts())
 
         correct_net = [
             ipaddress.IPv4Address("192.168.1.29"),
@@ -48,7 +48,7 @@ class NetworkTest(unittest.TestCase):
 
     def test_net(self):
         net_1_str = "192.168.1.0"
-        net_1_mask = 29
+        net_1_mask = "/29"
 
         net_1 = list(MinerNetwork(net_1_str, mask=net_1_mask).get_network().hosts())
 
@@ -68,6 +68,20 @@ class NetworkTest(unittest.TestCase):
         self.assertTrue(net_1 == correct_net)
         self.assertTrue(net_2 == correct_net)
 
+    def test_net_len(self):
+        net = MinerNetwork("192.168.1.0", mask=32)
+        self.assertEqual(len(net), 1)
+
+        net2 = MinerNetwork("192.168.1.0", mask=31)
+        self.assertEqual(len(net2), 2)
+
+    def test_net_defaults(self):
+        net = MinerNetwork()
+        net_obj = net.get_network()
+        self.assertEqual(net_obj, MinerNetwork("192.168.1.0", mask=24).get_network())
+
+        self.assertEqual(net_obj, net.get_network())
+
 
 if __name__ == "__main__":
     unittest.main()

tests/test_data.py

@@ -0,0 +1,128 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+bosminer_api_pools = {
+    "STATUS": [
+        {
+            "STATUS": "S",
+            "Msg": "2 Pool(s)",
+            "Description": "",
+        }
+    ],
+    "POOLS": [
+        {
+            "POOL": 0,
+            "URL": "stratum+tcp://pyasic.testpool_1.pool:3333",
+            "Status": "Alive",
+            "Quota": 1,
+            "User": "pyasic.test",
+            "Stratum URL": "pyasic.testpool_1.pool:3333",
+            "AsicBoost": True,
+        },
+        {
+            "POOL": 1,
+            "URL": "stratum+tcp://pyasic.testpool_2.pool:3333",
+            "Status": "Alive",
+            "Quota": 1,
+            "User": "pyasic.test",
+            "Stratum URL": "pyasic.testpool_2.pool:3333",
+            "AsicBoost": True,
+        },
+    ],
+    "id": 1,
+}
+
+x19_api_pools = {
+    "STATUS": [
+        {
+            "STATUS": "S",
+            "Msg": "2 Pool(s)",
+            "Description": "",
+        }
+    ],
+    "POOLS": [
+        {
+            "POOL": 0,
+            "URL": "stratum+tcp://pyasic.testpool_1.pool:3333",
+            "Status": "Alive",
+            "Quota": 1,
+            "User": "pyasic.test",
+            "Stratum URL": "pyasic.testpool_1.pool:3333",
+        },
+        {
+            "POOL": 1,
+            "URL": "stratum+tcp://pyasic.testpool_2.pool:3333",
+            "Status": "Alive",
+            "Quota": 1,
+            "User": "pyasic.test",
+            "Stratum URL": "pyasic.testpool_2.pool:3333",
+        },
+    ],
+    "id": 1,
+}
+
+x19_web_pools = {
+    "pools": [
+        {
+            "url": "stratum+tcp://pyasic.testpool_1.pool:3333",
+            "user": "pyasic.test",
+            "pass": "123",
+        },
+        {
+            "url": "stratum+tcp://pyasic.testpool_2.pool:3333",
+            "user": "pyasic.test",
+            "pass": "123",
+        },
+    ],
+    "api-listen": True,
+    "api-network": True,
+    "api-groups": "A:stats:pools:devs:summary:version",
+    "api-allow": "A:0/0,W:*",
+    "bitmain-fan-ctrl": False,
+    "bitmain-fan-pwm": "100",
+    "bitmain-use-vil": True,
+    "bitmain-freq": "675",
+    "bitmain-voltage": "1400",
+    "bitmain-ccdelay": "0",
+    "bitmain-pwth": "0",
+    "bitmain-work-mode": "0",
+    "bitmain-freq-level": "100",
+}
+
+bosminer_config_pools = {
+    "format": {
+        "version": "1.2+",
+        "model": "Antminer S9",
+        "generator": "pyasic",
+    },
+    "group": [
+        {
+            "name": "TEST",
+            "quota": 1,
+            "pool": [
+                {
+                    "enabled": True,
+                    "url": "stratum+tcp://pyasic.testpool_1.pool:3333",
+                    "user": "pyasic.test",
+                    "password": "123",
+                },
+                {
+                    "enabled": True,
+                    "url": "stratum+tcp://pyasic.testpool_2.pool:3333",
+                    "user": "pyasic.test",
+                    "password": "123",
+                },
+            ],
+        },
+    ],
+}