version: bump version number.

README.md

@@ -46,7 +46,7 @@ from pyasic.network import MinerNetwork
 async def scan_and_get_data():
     # Define network range to be used for scanning
     # This can take a list of IPs, a constructor string, or an IP and subnet mask
-    # The standard mask is /24, and you can pass any IP address in the subnet
+    # The standard mask is /24 (x.x.x.0-255), and you can pass any IP address in the subnet
     net = MinerNetwork("192.168.1.69", mask=24)
     # Scan the network for miners
     # This function returns a list of miners of the correct type as a class
@@ -93,6 +93,10 @@ if __name__ == "__main__":
 
 If needed, this library exposes a wrapper for the miner API that can be used for advanced data gathering.
 
+You can see more information on basic usage of the APIs past this example in the docs [here](https://pyasic.readthedocs.io/en/latest/API/api/).
+
+Please see the appropriate API documentation page (pyasic docs -> Advanced -> Miner APIs -> your API type) for a link to that specific miner's API documentation page and more information.
+
 #### List available API commands
 ```python
 import asyncio
@@ -105,7 +109,8 @@ async def get_api_commands(miner_ip: str):
     miner = await get_miner(miner_ip)
 
     # List all available commands
-    print(miner.api.get_commands())
+    # Can also be called explicitly with the function miner.api.get_commands()
+    print(miner.api.commands)
 
 
 if __name__ == "__main__":

docs/miners/supported_types.md

@@ -90,6 +90,9 @@ details {
                 </details>
                 <details>
                     <summary><a href="../whatsminer/M3X/#m31s">M31S</a></summary>
+                    <summary><a href="../whatsminer/M3X/#m31sv10">M31SV10</a></summary>
+                    <summary><a href="../whatsminer/M3X/#m31sv20">M31SV20</a></summary>
+                    <summary><a href="../whatsminer/M3X/#m31sv60">M31SV60</a></summary>
                     <summary><a href="../whatsminer/M3X/#m31sv70">M31SV70</a></summary>
                 </details>
                 <details>

docs/miners/whatsminer/M3X.md

@@ -114,9 +114,33 @@
         show_root_heading: false
         heading_level: 4
 
+## M31SV10
+
+::: pyasic.miners.whatsminer.btminer.M3X.M31S.BTMinerM31SV10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M31SV20
+
+::: pyasic.miners.whatsminer.btminer.M3X.M31S.BTMinerM31SV20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M31SV60
+
+::: pyasic.miners.whatsminer.btminer.M3X.M31S.BTMinerM31SV60
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
 ## M31SV70
 
-::: pyasic.miners.whatsminer.btminer.M3X.M31S.BTMinerM31S
+::: pyasic.miners.whatsminer.btminer.M3X.M31S.BTMinerM31SV70
     handler: python
     options:
         show_root_heading: false

pyasic/API/__init__.py

@@ -121,6 +121,7 @@ class BaseMinerAPI:
             for func in
             # each function in self
             dir(self)
+            if not func == "commands"
             if callable(getattr(self, func)) and
             # no __ or _ methods
             not func.startswith("__") and not func.startswith("_") and

pyasic/API/btminer.py

@@ -198,6 +198,8 @@ class BTMinerAPI(BaseMinerAPI):
         enc_command = create_privileged_cmd(token_data, command)
 
         data = await self._send_bytes(enc_command)
+        if not data:
+            raise APIError("No data was returned from the API.")
         data = self._load_api_data(data)
 
         try:

pyasic/miners/_backends/bosminer.py

@@ -327,7 +327,7 @@ class BOSMiner(BaseMiner):
                             if board["Status"] not in [
                                 "Stable",
                                 "Testing performance profile",
-                                "Tuning individual chips"
+                                "Tuning individual chips",
                             ]:
                                 _error = board["Status"].split(" {")[0]
                                 _error = _error[0].lower() + _error[1:]
@@ -471,6 +471,16 @@ class BOSMiner(BaseMiner):
                 data.pool_2_user = pool_2_user
 
             if quota:
+                if not quota == "0":
+                    cfg = await self.get_config()
+                    if cfg:
+                        if len(cfg.pool_groups) > 1:
+                            quota = (
+                                str(cfg.pool_groups[0].quota)
+                                + "/"
+                                + str(cfg.pool_groups[1].quota)
+                            )
+
                 data.pool_split = str(quota)
 
         if tunerstatus:
@@ -558,9 +568,13 @@ class BOSMiner(BaseMiner):
                 data.hostname = query_data["bos"]["hostname"]
 
         try:
-            if query_data["bosminer"]["info"]["workSolver"]["realHashrate"].get("mhs1M"):
+            if query_data["bosminer"]["info"]["workSolver"]["realHashrate"].get(
+                "mhs1M"
+            ):
                 data.hashrate = round(
-                    query_data["bosminer"]["info"]["workSolver"]["realHashrate"]["mhs1M"]
+                    query_data["bosminer"]["info"]["workSolver"]["realHashrate"][
+                        "mhs1M"
+                    ]
                     / 1000000,
                     2,
                 )
@@ -571,9 +585,13 @@ class BOSMiner(BaseMiner):
         if query_data.get("bosminer"):
             if query_data["bosminer"].get("info"):
                 if query_data["bosminer"]["info"].get("workSolver"):
-                    boards = query_data["bosminer"]["info"]["workSolver"].get("childSolvers")
+                    boards = query_data["bosminer"]["info"]["workSolver"].get(
+                        "childSolvers"
+                    )
         if boards:
-            offset = 6 if int(boards[0]["name"]) in [6, 7, 8] else int(boards[0]["name"])
+            offset = (
+                6 if int(boards[0]["name"]) in [6, 7, 8] else int(boards[0]["name"])
+            )
             for hb in boards:
                 _id = int(hb["name"]) - offset
 
@@ -600,24 +618,33 @@ class BOSMiner(BaseMiner):
                             if hb["tuner"]["statusMessages"][0] not in [
                                 "Stable",
                                 "Testing performance profile",
-                                "Tuning individual chips"
+                                "Tuning individual chips",
                             ]:
                                 data.errors.append(
-                                    BraiinsOSError(f"Slot {_id} {hb['tuner']['statusMessages'][0]}")
+                                    BraiinsOSError(
+                                        f"Slot {_id} {hb['tuner']['statusMessages'][0]}"
+                                    )
                                 )
         try:
-            data.wattage = query_data["bosminer"]["info"]["workSolver"]["power"]["approxConsumptionW"]
+            data.wattage = query_data["bosminer"]["info"]["workSolver"]["power"][
+                "approxConsumptionW"
+            ]
         except (TypeError, KeyError, ValueError, IndexError):
             data.wattage = 0
         try:
-            data.wattage_limit = query_data["bosminer"]["info"]["workSolver"]["power"]["limitW"]
+            data.wattage_limit = query_data["bosminer"]["info"]["workSolver"]["power"][
+                "limitW"
+            ]
         except (TypeError, KeyError, ValueError, IndexError):
             pass
 
-
         for n in range(self.fan_count):
             try:
-                setattr(data, f"fan_{n + 1}", query_data["bosminer"]["info"]["fans"][n]["rpm"])
+                setattr(
+                    data,
+                    f"fan_{n + 1}",
+                    query_data["bosminer"]["info"]["fans"][n]["rpm"],
+                )
             except (TypeError, KeyError, ValueError, IndexError):
                 pass
 
@@ -632,7 +659,11 @@ class BOSMiner(BaseMiner):
                 except (TypeError, KeyError, ValueError, IndexError):
                     pass
                 try:
-                    data.pool_1_url = groups[0]["pools"][0]["url"]
+                    data.pool_1_url = (
+                        groups[0]["pools"][0]["url"]
+                        .replace("stratum+tcp://", "")
+                        .replace("stratum2+tcp://", "")
+                    )
                 except (TypeError, KeyError, ValueError, IndexError):
                     pass
                 try:
@@ -640,7 +671,11 @@ class BOSMiner(BaseMiner):
                 except (TypeError, KeyError, ValueError, IndexError):
                     pass
                 try:
-                    data.pool_2_url = groups[0]["pools"][1]["url"]
+                    data.pool_2_url = (
+                        groups[0]["pools"][1]["url"]
+                        .replace("stratum+tcp://", "")
+                        .replace("stratum2+tcp://", "")
+                    )
                 except (TypeError, KeyError, ValueError, IndexError):
                     pass
                 data.quota = 0
@@ -650,7 +685,11 @@ class BOSMiner(BaseMiner):
                 except (TypeError, KeyError, ValueError, IndexError):
                     pass
                 try:
-                    data.pool_1_url = groups[0]["pools"][0]["url"]
+                    data.pool_1_url = (
+                        groups[0]["pools"][0]["url"]
+                        .replace("stratum+tcp://", "")
+                        .replace("stratum2+tcp://", "")
+                    )
                 except (TypeError, KeyError, ValueError, IndexError):
                     pass
                 try:
@@ -658,11 +697,19 @@ class BOSMiner(BaseMiner):
                 except (TypeError, KeyError, ValueError, IndexError):
                     pass
                 try:
-                    data.pool_2_url = groups[1]["pools"][0]["url"]
+                    data.pool_2_url = (
+                        groups[1]["pools"][0]["url"]
+                        .replace("stratum+tcp://", "")
+                        .replace("stratum2+tcp://", "")
+                    )
                 except (TypeError, KeyError, ValueError, IndexError):
                     pass
                 if groups[0]["strategy"].get("quota"):
-                    data.quota = str(groups[0]["strategy"]["quota"]) + "/" + str(groups[1]["strategy"]["quota"])
+                    data.pool_split = (
+                        str(groups[0]["strategy"]["quota"])
+                        + "/"
+                        + str(groups[1]["strategy"]["quota"])
+                    )
 
         data.fault_light = await self.check_light()
 

pyasic/miners/_backends/btminer.py

@@ -238,16 +238,24 @@ class BTMiner(BaseMiner):
 
     async def get_config(self) -> MinerConfig:
         pools = None
+        summary = None
         cfg = MinerConfig()
 
         try:
-            pools = await self.api.pools()
+            data = await self.api.multicommand("pools", "summary")
+            pools = data["pools"][0]
+            summary = data["summary"][0]
         except APIError as e:
             logging.warning(e)
 
         if pools:
-            if "POOLS" in pools.keys():
+            if "POOLS" in pools:
                 cfg = cfg.from_api(pools["POOLS"])
+        if summary:
+            if "SUMMARY" in summary:
+                if wattage := summary["SUMMARY"][0].get("Power Limit"):
+                    cfg.autotuning_wattage = wattage
+
         return cfg
 
     async def get_data(self, allow_warning: bool = True) -> MinerData:

pyasic/miners/_types/whatsminer/M3X/M31S.py

@@ -24,6 +24,31 @@ class M31S(BaseMiner):  # noqa - ignore ABC method implementation
         self.fan_count = 2
 
 
+class M31SV10(BaseMiner):  # noqa - ignore ABC method implementation
+    def __init__(self, ip: str):
+        super().__init__()
+        self.ip = ip
+        self.model = "M31S V10"
+        self.nominal_chips = 105
+        self.fan_count = 2
+
+class M31SV20(BaseMiner):  # noqa - ignore ABC method implementation
+    def __init__(self, ip: str):
+        super().__init__()
+        self.ip = ip
+        self.model = "M31S V20"
+        self.nominal_chips = 111
+        self.fan_count = 2
+
+class M31SV60(BaseMiner):  # noqa - ignore ABC method implementation
+    def __init__(self, ip: str):
+        super().__init__()
+        self.ip = ip
+        self.model = "M31S V60"
+        self.nominal_chips = 105
+        self.fan_count = 2
+
+
 class M31SV70(BaseMiner):  # noqa - ignore ABC method implementation
     def __init__(self, ip: str):
         super().__init__()

pyasic/miners/_types/whatsminer/M3X/__init__.py

@@ -20,7 +20,7 @@ from .M30S_Plus_Plus import (
     M30SPlusPlusVG40,
     M30SPlusPlusVH60,
 )
-from .M31S import M31S, M31SV70
+from .M31S import M31S, M31SV10, M31SV20, M31SV60, M31SV70
 from .M31S_Plus import (
     M31SPlus,
     M31SPlusV30,

pyasic/miners/base.py

@@ -218,6 +218,9 @@ class BaseMiner(ABC):
     async def set_power_limit(self, wattage: int) -> bool:
         """Set the power limit to be used by the miner.
 
+        Parameters:
+            wattage: The power limit to set on the miner.
+
         Returns:
             A boolean value of the success of setting the power limit.
         """

pyasic/miners/miner_factory.py

@@ -195,7 +195,10 @@ MINER_CLASSES = {
     "M31S": {
         "Default": BTMinerM31S,
         "BTMiner": BTMinerM31S,
-        "V70": BTMinerM31SV70,
+        "10": BTMinerM31SV10,
+        "20": BTMinerM31SV20,
+        "60": BTMinerM31SV60,
+        "70": BTMinerM31SV70,
     },
     "M31S+": {
         "Default": BTMinerM31SPlus,

pyasic/miners/whatsminer/btminer/M3X/M31S.py

@@ -13,7 +13,7 @@
 #  limitations under the License.
 
 from pyasic.miners._backends import BTMiner  # noqa - Ignore access to _module
-from pyasic.miners._types import M31S, M31SV70  # noqa - Ignore access to _module
+from pyasic.miners._types import M31S, M31SV10, M31SV20, M31SV60, M31SV70  # noqa - Ignore access to _module
 
 
 class BTMinerM31S(BTMiner, M31S):
@@ -21,6 +21,23 @@ class BTMinerM31S(BTMiner, M31S):
         super().__init__(ip)
         self.ip = ip
 
+class BTMinerM31SV20(BTMiner, M31SV20):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.ip = ip
+
+
+class BTMinerM31SV10(BTMiner, M31SV10):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.ip = ip
+
+
+class BTMinerM31SV60(BTMiner, M31SV60):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.ip = ip
+
 
 class BTMinerM31SV70(BTMiner, M31SV70):
     def __init__(self, ip: str) -> None:

pyasic/miners/whatsminer/btminer/M3X/__init__.py

@@ -31,7 +31,7 @@ from .M30S_Plus_Plus import (
     BTMinerM30SPlusPlusVG40,
     BTMinerM30SPlusPlusVH60,
 )
-from .M31S import BTMinerM31S, BTMinerM31SV70
+from .M31S import BTMinerM31S, BTMinerM31SV10, BTMinerM31SV20, BTMinerM31SV60, BTMinerM31SV70
 from .M31S_Plus import (
     BTMinerM31SPlus,
     BTMinerM31SPlusV30,

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyasic"
-version = "0.23.2"
+version = "0.24.3"
 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"