version: bump version number.

docs/API/api.md

@@ -10,6 +10,7 @@ All API implementations inherit from [`BaseMinerAPI`][pyasic.API.BaseMinerAPI],
 [`BaseMinerAPI`][pyasic.API.BaseMinerAPI] cannot be instantiated directly, it will raise a `TypeError`.
 Use these instead -
 
+#### [BFGMiner API][pyasic.API.bfgminer.BFGMinerAPI]
 #### [BMMiner API][pyasic.API.bmminer.BMMinerAPI]
 #### [BOSMiner API][pyasic.API.bosminer.BOSMinerAPI]
 #### [BTMiner API][pyasic.API.btminer.BTMinerAPI]

docs/API/bfgminer.md

@@ -0,0 +1,7 @@
+# pyasic
+## BFGMinerAPI
+::: pyasic.API.bfgminer.BFGMinerAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/index.md

@@ -42,21 +42,27 @@ if __name__ == "__main__":
 <br>
 
 ## Creating miners based on IP
-If you already know the IP address of your miner or miners, you can use the [`MinerFactory`][pyasic.miners.miner_factory.MinerFactory] to communicate and identify the miners.
-The function [`MinerFactory().get_miner()`][pyasic.miners.miner_factory.MinerFactory.get_miner] will return any miner it found at the IP address specified, or an `UnknownMiner` if it cannot identify the miner.
+If you already know the IP address of your miner or miners, you can use the [`MinerFactory`][pyasic.miners.miner_factory.MinerFactory] to communicate and identify the miners, or an abstraction of its functionality, [`get_miner()`][pyasic.miners.miner_factory.MinerFactory.get_miner].
+The function [`get_miner()`][pyasic.miners.miner_factory.MinerFactory.get_miner] will return any miner it found at the IP address specified, or an `UnknownMiner` if it cannot identify the miner.
 ```python
 import asyncio  # asyncio for handling the async part
-from pyasic.miners.miner_factory import MinerFactory  # miner factory handles miners creation
+from pyasic import get_miner # handles miner creation
 
 
 async def get_miners():  # define async scan function to allow awaiting
-    # get the miner with miner factory
-    # miner factory is a singleton, and will always use the same object and cache
-    # this means you can always call it as MinerFactory().get_miner()
-    miner_1 = await MinerFactory().get_miner("192.168.1.75")
-    miner_2 = await MinerFactory().get_miner("192.168.1.76")
+    # get the miner with the miner factory
+    # the miner factory is a singleton, and will always use the same object and cache
+    # this means you can always call it as MinerFactory().get_miner(), or just get_miner()
+    miner_1 = await get_miner("192.168.1.75")
+    miner_2 = await get_miner("192.168.1.76")
     print(miner_1, miner_2)
 
+    # can also gather these, since they are async
+    tasks = [get_miner("192.168.1.75"), get_miner("192.168.1.76")]
+    miners = await asyncio.gather(*tasks)
+    print(miners)
+
+
 if __name__ == "__main__":
     asyncio.run(get_miners())  # get the miners asynchronously with asyncio.run()
 ```
@@ -66,7 +72,7 @@ if __name__ == "__main__":
 ## Getting data from miners
 
 Once you have your miner(s) identified, you will likely want to get data from the miner(s).  You can do this using a built in function in each miner called `get_data()`.
-This function will return a instance of the dataclass [`MinerData`][pyasic.data.MinerData] with all data it can gather from the miner.
+This function will return an instance of the dataclass [`MinerData`][pyasic.data.MinerData] with all data it can gather from the miner.
 Each piece of data in a [`MinerData`][pyasic.data.MinerData] instance can be referenced by getting it as an attribute, such as [`MinerData().hashrate`][pyasic.data.MinerData].
 ```python
 import asyncio

docs/miners/backends/bfgminer.md

@@ -1,7 +1,7 @@
 # pyasic
 ## BFGMiner Backend
 
-::: pyasic.miners.kda._backends.bfgminer.BFGMiner
+::: pyasic.miners.backends.bfgminer.BFGMiner
     handler: python
     options:
         show_root_heading: false

mkdocs.yml

@@ -1,54 +1,54 @@
 site_name: pyasic
 repo_url: https://github.com/UpstreamData/pyasic
 nav:
-  - Introduction: "index.md"
-  - Miners:
-      - Supported Miners: "miners/supported_types.md"
-      - Miner Factory: "miners/miner_factory.md"
-      - Backends:
-          - BMMiner: "miners/backends/bmminer.md"
-          - BOSMiner: "miners/backends/bosminer.md"
-          - BFGMiner: "miners/backends/bfgminer.md"
-          - BTMiner: "miners/backends/btminer.md"
-          - CGMiner: "miners/backends/cgminer.md"
-          - Hiveon: "miners/backends/hiveon.md"
-      - Classes:
-          - Antminer X3: "miners/antminer/X3.md"
-          - Antminer X5: "miners/antminer/X5.md"
-          - Antminer X7: "miners/antminer/X7.md"
-          - Antminer X9: "miners/antminer/X9.md"
-          - Antminer X15: "miners/antminer/X15.md"
-          - Antminer X17: "miners/antminer/X17.md"
-          - Antminer X19: "miners/antminer/X19.md"
-          - Avalon 7X: "miners/avalonminer/A7X.md"
-          - Avalon 8X: "miners/avalonminer/A8X.md"
-          - Avalon 9X: "miners/avalonminer/A9X.md"
-          - Avalon 10X: "miners/avalonminer/A10X.md"
-          - Whatsminer M2X: "miners/whatsminer/M2X.md"
-          - Whatsminer M3X: "miners/whatsminer/M3X.md"
-          - Whatsminer M5X: "miners/whatsminer/M5X.md"
-          - Innosilicon T3X: "miners/innosilicon/T3X.md"
-          - Innosilicon A10X: "miners/innosilicon/A10X.md"
-          - Goldshell CKX: "miners/goldshell/CKX.md"
-          - Goldshell HSX: "miners/goldshell/HSX.md"
-          - Goldshell KDX: "miners/goldshell/KDX.md"
-  - Network:
-      - Miner Network: "network/miner_network.md"
-      - Miner Network Range: "network/miner_network_range.md"
-  - Dataclasses:
-      - Miner Data: "data/miner_data.md"
-      - Error Codes: "data/error_codes.md"
-      - Miner Config: "config/miner_config.md"
-  - Advanced:
-      - Miner APIs:
-          - Intro: "API/api.md"
-          - BMMiner: "API/bmminer.md"
-          - BOSMiner: "API/bosminer.md"
-          - BTMiner: "API/btminer.md"
-          - CGMiner: "API/cgminer.md"
-          - Unknown: "API/unknown.md"
-
-      - Base Miner: "miners/base_miner.md"
+- Introduction: "index.md"
+- Miners:
+    - Supported Miners: "miners/supported_types.md"
+    - Miner Factory: "miners/miner_factory.md"
+- Network:
+    - Miner Network: "network/miner_network.md"
+    - Miner Network Range: "network/miner_network_range.md"
+- Dataclasses:
+    - Miner Data: "data/miner_data.md"
+    - Error Codes: "data/error_codes.md"
+    - Miner Config: "config/miner_config.md"
+- Advanced:
+    - Miner APIs:
+        - Intro: "API/api.md"
+        - BFGMiner: "API/bfgminer.md"
+        - BMMiner: "API/bmminer.md"
+        - BOSMiner: "API/bosminer.md"
+        - BTMiner: "API/btminer.md"
+        - CGMiner: "API/cgminer.md"
+        - Unknown: "API/unknown.md"
+    - Backends:
+        - BMMiner: "miners/backends/bmminer.md"
+        - BOSMiner: "miners/backends/bosminer.md"
+        - BFGMiner: "miners/backends/bfgminer.md"
+        - BTMiner: "miners/backends/btminer.md"
+        - CGMiner: "miners/backends/cgminer.md"
+        - Hiveon: "miners/backends/hiveon.md"
+    - Classes:
+        - Antminer X3: "miners/antminer/X3.md"
+        - Antminer X5: "miners/antminer/X5.md"
+        - Antminer X7: "miners/antminer/X7.md"
+        - Antminer X9: "miners/antminer/X9.md"
+        - Antminer X15: "miners/antminer/X15.md"
+        - Antminer X17: "miners/antminer/X17.md"
+        - Antminer X19: "miners/antminer/X19.md"
+        - Avalon 7X: "miners/avalonminer/A7X.md"
+        - Avalon 8X: "miners/avalonminer/A8X.md"
+        - Avalon 9X: "miners/avalonminer/A9X.md"
+        - Avalon 10X: "miners/avalonminer/A10X.md"
+        - Whatsminer M2X: "miners/whatsminer/M2X.md"
+        - Whatsminer M3X: "miners/whatsminer/M3X.md"
+        - Whatsminer M5X: "miners/whatsminer/M5X.md"
+        - Innosilicon T3X: "miners/innosilicon/T3X.md"
+        - Innosilicon A10X: "miners/innosilicon/A10X.md"
+        - Goldshell CKX: "miners/goldshell/CKX.md"
+        - Goldshell HSX: "miners/goldshell/HSX.md"
+        - Goldshell KDX: "miners/goldshell/KDX.md"
+    - Base Miner: "miners/base_miner.md"
 
 
 plugins:

pyasic/data/__init__.py

@@ -116,7 +116,8 @@ class MinerData:
     api_ver: str = "Unknown"
     fw_ver: str = "Unknown"
     hostname: str = "Unknown"
-    hashrate: float = 0
+    hashrate: float = field(init=False)
+    _hashrate: float = field(init=False)
     nominal_hashrate: float = 0
     hashboards: List[HashBoard] = field(default_factory=list)
     ideal_hashboards: int = 1
@@ -213,6 +214,16 @@ class MinerData:
                 setattr(cp, key, item & other_item)
         return cp
 
+    @property
+    def hashrate(self):  # noqa - Skip PyCharm inspection
+        if len(self.hashboards) > 0:
+            return round(sum(map(lambda x: x.hashrate, self.hashboards)), 2)
+        return self._hashrate
+
+    @hashrate.setter
+    def hashrate(self, val):
+        self._hashrate = val
+
     @property
     def fan_1(self):  # noqa - Skip PyCharm inspection
         if len(self.fans) > 0:

pyasic/data/error_codes/whatsminer.py

@@ -16,7 +16,7 @@
 
 from dataclasses import asdict, dataclass, field, fields
 
-C_N_CODES = ["52", "53", "54", "55"]
+C_N_CODES = ["52", "53", "54", "55", "56"]
 
 
 @dataclass
@@ -264,6 +264,7 @@ ERROR_CODES = {
     53: {"n": {"c": "Slot {n} chip {c} too few nonce."}},
     54: {"n": {"c": "Slot {n} chip {c} temp protected."}},
     55: {"n": {"c": "Slot {n} chip {c} has been reset."}},
+    56: {"n": {"c": "Slot {n} chip {c} does not return to the nonce."}},
     80: {
         0: {0: "The tool version is too low, please update."},
         1: {0: "Low freq."},

pyasic/miners/backends/bmminer.py

@@ -28,25 +28,25 @@ from pyasic.errors import APIError
 from pyasic.miners.base import BaseMiner
 
 BMMINER_DATA_LOC = {
-    "mac": {"cmd": "mac", "kwargs": {}},
-    "model": {"cmd": "model", "kwargs": {"api_devdetails": {"api": "devdetails"}}},
-    "api_ver": {"cmd": "api_ver", "kwargs": {"api_version": {"api": "version"}}},
-    "fw_ver": {"cmd": "fw_ver", "kwargs": {"api_version": {"api": "version"}}},
-    "hostname": {"cmd": "hostname", "kwargs": {}},
-    "hashrate": {"cmd": "hashrate", "kwargs": {"api_summary": {"api": "summary"}}},
+    "mac": {"cmd": "get_mac", "kwargs": {}},
+    "model": {"cmd": "get_model", "kwargs": {}},
+    "api_ver": {"cmd": "get_api_ver", "kwargs": {"api_version": {"api": "version"}}},
+    "fw_ver": {"cmd": "get_fw_ver", "kwargs": {"api_version": {"api": "version"}}},
+    "hostname": {"cmd": "get_hostname", "kwargs": {}},
+    "hashrate": {"cmd": "get_hashrate", "kwargs": {"api_summary": {"api": "summary"}}},
     "nominal_hashrate": {
-        "cmd": "nominal_hashrate",
+        "cmd": "get_nominal_hashrate",
         "kwargs": {"api_stats": {"api": "stats"}},
     },
-    "hashboards": {"cmd": "hashboards", "kwargs": {"api_stats": {"api": "stats"}}},
-    "env_temp": {"cmd": "env_temp", "kwargs": {}},
-    "wattage": {"cmd": "wattage", "kwargs": {}},
-    "wattage_limit": {"cmd": "wattage_limit", "kwargs": {}},
-    "fans": {"cmd": "fans", "kwargs": {"api_stats": {"api": "stats"}}},
-    "fan_psu": {"cmd": "fan_psu", "kwargs": {}},
-    "errors": {"cmd": "errors", "kwargs": {}},
-    "fault_light": {"cmd": "fault_light", "kwargs": {}},
-    "pools": {"cmd": "pools", "kwargs": {"api_pools": {"api": "pools"}}},
+    "hashboards": {"cmd": "get_hashboards", "kwargs": {"api_stats": {"api": "stats"}}},
+    "env_temp": {"cmd": "get_env_temp", "kwargs": {}},
+    "wattage": {"cmd": "get_wattage", "kwargs": {}},
+    "wattage_limit": {"cmd": "get_wattage_limit", "kwargs": {}},
+    "fans": {"cmd": "get_fans", "kwargs": {"api_stats": {"api": "stats"}}},
+    "fan_psu": {"cmd": "get_fan_psu", "kwargs": {}},
+    "errors": {"cmd": "get_errors", "kwargs": {}},
+    "fault_light": {"cmd": "get_fault_light", "kwargs": {}},
+    "pools": {"cmd": "get_pools", "kwargs": {"api_pools": {"api": "pools"}}},
 }
 
 

pyasic/miners/backends/hiveon.py

@@ -14,6 +14,8 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
+from typing import Optional
+
 from pyasic.miners.backends import BMMiner
 
 
@@ -22,3 +24,6 @@ class Hiveon(BMMiner):
         super().__init__(ip, api_ver)
         # static data
         self.api_type = "Hiveon"
+
+    async def get_model(self) -> Optional[str]:
+        return self.model + " (Hiveon)"

pyasic/miners/backends/vnish.py

@@ -58,8 +58,8 @@ class VNish(BMMiner):
         # data gathering locations
         self.data_locations = VNISH_DATA_LOC
 
-    async def get_model(self, api_stats: dict = None) -> Optional[str]:
-        return self.model + "(VNISH)"
+    async def get_model(self) -> Optional[str]:
+        return self.model + " (VNISH)"
 
     async def restart_backend(self) -> bool:
         data = await self.web.restart_vnish()

pyasic/miners/btc/_types/whatsminer/M3X/M33S_Plus_Plus.py

@@ -24,10 +24,8 @@ class M33SPlusPlusVH20(WhatsMiner):  # noqa - ignore ABC method implementation
         super().__init__(ip, api_ver)
         self.ip = ip
         self.model = "M33S++ VH20"
-        self.nominal_chips = 0
-        warnings.warn(
-            "Unknown chip count for miner type M30S++ VH20, please open an issue on GitHub (https://github.com/UpstreamData/pyasic)."
-        )
+        self.ideal_hashboards = 4
+        self.nominal_chips = 112
         self.fan_count = 0
 
 
@@ -36,6 +34,7 @@ class M33SPlusPlusVH30(WhatsMiner):  # noqa - ignore ABC method implementation
         super().__init__(ip, api_ver)
         self.ip = ip
         self.model = "M33S++ VH30"
+        self.ideal_hashboards = 4
         self.nominal_chips = 0
         warnings.warn(
             "Unknown chip count for miner type M30S++ VH30, please open an issue on GitHub (https://github.com/UpstreamData/pyasic)."
@@ -48,6 +47,7 @@ class M33SPlusPlusVG40(WhatsMiner):  # noqa - ignore ABC method implementation
         super().__init__(ip, api_ver)
         self.ip = ip
         self.model = "M33S++ VG40"
+        self.ideal_hashboards = 4
         self.nominal_chips = 0
         warnings.warn(
             "Unknown chip count for miner type M30S++ VG40, please open an issue on GitHub (https://github.com/UpstreamData/pyasic)."

pyasic/miners/btc/antminer/hiveon/X9/T9.py

@@ -42,7 +42,7 @@ class HiveonT9(Hiveon, T9):
                 .upper()
             )
             return mac
-        except (TypeError, ValueError, asyncssh.Error, OSError):
+        except (TypeError, ValueError, asyncssh.Error, OSError, AttributeError):
             pass
 
     async def get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
@@ -62,13 +62,16 @@ class HiveonT9(Hiveon, T9):
                     try:
                         hashboard.board_temp = api_stats["STATS"][1][f"temp{chipset}"]
                         hashboard.chip_temp = api_stats["STATS"][1][f"temp2_{chipset}"]
-                        hashrate += api_stats["STATS"][1][f"chain_rate{chipset}"]
-                        chips += api_stats["STATS"][1][f"chain_acn{chipset}"]
                     except (KeyError, IndexError):
                         pass
                     else:
                         hashboard.missing = False
-            hashboard.hashrate = hashrate
+                try:
+                    hashrate += api_stats["STATS"][1][f"chain_rate{chipset}"]
+                    chips += api_stats["STATS"][1][f"chain_acn{chipset}"]
+                except (KeyError, IndexError):
+                    pass
+            hashboard.hashrate = round(hashrate / 1000, 2)
             hashboard.chips = chips
             hashboards.append(hashboard)
 

pyasic/miners/dsh/__init__.py

@@ -0,0 +1,16 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+from .antminer import *

pyasic/miners/dsh/_types/__init__.py

@@ -0,0 +1,16 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+from .antminer import *

pyasic/miners/dsh/_types/antminer/X3/D3.py

@@ -0,0 +1,27 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.makes import AntMiner
+
+
+class D3(AntMiner):  # noqa - ignore ABC method implementation
+    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+        super().__init__(ip, api_ver)
+        self.ip = ip
+        self.model = "D3"
+        self.nominal_chips = 60
+        self.ideal_hashboards = 3
+        self.fan_count = 2

pyasic/miners/dsh/_types/antminer/X3/__init__.py

@@ -0,0 +1,16 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+from .D3 import D3

pyasic/miners/dsh/_types/antminer/__init__.py

@@ -0,0 +1,16 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+from .X3 import *

pyasic/miners/dsh/antminer/__init__.py

@@ -0,0 +1,16 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+from .cgminer import *

pyasic/miners/dsh/antminer/cgminer/X3/D3.py

@@ -0,0 +1,24 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import AntminerOld
+from pyasic.miners.dsh._types import D3  # noqa - Ignore access to _module
+
+
+class CGMinerD3(AntminerOld, D3):
+    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+        super().__init__(ip, api_ver)
+        self.supports_shutdown = False

pyasic/miners/dsh/antminer/cgminer/X3/__init__.py

@@ -0,0 +1,16 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+from .D3 import CGMinerD3

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

@@ -0,0 +1,16 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+from .X3 import *

pyasic/miners/ltc/_types/antminer/X3/L3_Plus.py

@@ -0,0 +1,25 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+from pyasic.miners.makes import AntMiner
+
+
+class L3Plus(AntMiner):  # noqa - ignore ABC method implementation
+    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+        super().__init__(ip, api_ver)
+        self.ip = ip
+        self.model = "L3+"
+        self.nominal_chips = 72
+        self.fan_count = 2

pyasic/miners/ltc/_types/antminer/X3/__init__.py

@@ -0,0 +1,16 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+from .L3_Plus import L3Plus

pyasic/miners/ltc/_types/antminer/__init__.py

@@ -13,4 +13,5 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from .X3 import *
 from .X7 import *

pyasic/miners/ltc/antminer/__init__.py

@@ -14,3 +14,4 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 from .bmminer import *
+from .vnish import *

pyasic/miners/ltc/antminer/bmminer/X3/L3_Plus.py

@@ -0,0 +1,23 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import AntminerOld
+from pyasic.miners.ltc._types import L3Plus  # noqa - Ignore access to _module
+
+
+class BMMinerL3Plus(AntminerOld, L3Plus):
+    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+        super().__init__(ip, api_ver)

pyasic/miners/ltc/antminer/bmminer/X3/__init__.py

@@ -0,0 +1,17 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+
+from .L3_Plus import BMMinerL3Plus

pyasic/miners/ltc/antminer/bmminer/X7/L7.py

@@ -13,7 +13,6 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-
 from pyasic.miners.backends import AntminerModern
 from pyasic.miners.ltc._types import L7  # noqa - Ignore access to _module
 

pyasic/miners/ltc/antminer/bmminer/X7/__init__.py

@@ -13,5 +13,4 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-
 from .L7 import BMMinerL7

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

@@ -13,4 +13,5 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from .X3 import *
 from .X7 import *

pyasic/miners/ltc/antminer/vnish/X3/L3_Plus.py

@@ -0,0 +1,23 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import VNish
+from pyasic.miners.ltc._types import L3Plus  # noqa - Ignore access to _module
+
+
+class VnishL3Plus(VNish, L3Plus):
+    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+        super().__init__(ip, api_ver)

pyasic/miners/ltc/antminer/vnish/X3/__init__.py

@@ -0,0 +1,17 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+
+from .L3_Plus import VnishL3Plus

pyasic/miners/ltc/antminer/vnish/__init__.py

@@ -0,0 +1,16 @@
+# ------------------------------------------------------------------------------
+#  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.                                              -
+# ------------------------------------------------------------------------------
+from .X3 import *

pyasic/miners/miner_factory.py

@@ -36,6 +36,7 @@ from pyasic.miners.base import AnyMiner
 from pyasic.miners.btc import *
 from pyasic.miners.ckb import *
 from pyasic.miners.dcr import *
+from pyasic.miners.dsh import *
 from pyasic.miners.etc import *
 from pyasic.miners.hns import *
 from pyasic.miners.kda import *
@@ -50,10 +51,19 @@ MINER_CLASSES = {
         "Default": CGMinerDR5,
         "CGMiner": CGMinerDR5,
     },
+    "ANTMINER D3": {
+        "Default": CGMinerD3,
+        "CGMiner": CGMinerD3,
+    },
     "ANTMINER HS3": {
         "Default": CGMinerHS3,
         "CGMiner": CGMinerHS3,
     },
+    "ANTMINER L3+": {
+        "Default": BMMinerL3Plus,
+        "BMMiner": BMMinerL3Plus,
+        "VNish": VnishL3Plus,
+    },
     "ANTMINER L7": {
         "Default": BMMinerL7,
         "BMMiner": BMMinerL7,
@@ -560,7 +570,7 @@ MINER_CLASSES = {
 
 
 class MinerFactory(metaclass=Singleton):
-    """A factory to handle identification and selection of the proper class of miner"""
+    """A factory to handle identification and selection of the proper class of miner."""
 
     def __init__(self) -> None:
         self.miners = {}
@@ -632,9 +642,6 @@ class MinerFactory(metaclass=Singleton):
                 logging.warning(f"{ip}: Get Miner Timed Out")
         miner = self._select_miner_from_classes(ip, model, api, ver, api_ver)
 
-        # once we have the miner, get the api and firmware version
-        # await miner.get_version()
-
         # save the miner to the cache at its IP if its not unknown
         if not isinstance(miner, UnknownMiner):
             self.miners[ip] = miner
@@ -846,6 +853,12 @@ class MinerFactory(metaclass=Singleton):
                     # def antminer, get from web
                     sysinfo = await self.__get_system_info_from_web(str(ip))
                     model = sysinfo["minertype"].upper()
+                if "VNISH" in model:
+                    api = "VNish"
+                for split_point in [" BB", " XILINX", " (VNISH"]:
+                    if split_point in model:
+                        model = model.split(split_point)[0]
+
             except KeyError:
                 pass
 

pyasic/web/vnish.py

@@ -98,6 +98,8 @@ class VNishWebAPI(BaseWebAPI):
                     pass
                 except json.JSONDecodeError:
                     pass
+                except AttributeError:
+                    pass
 
     async def multicommand(
         self, *commands: str, ignore_errors: bool = False, allow_warning: bool = True

pyproject.toml

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

tests/miners_tests/__init__.py

@@ -34,7 +34,7 @@ class MinersTest(unittest.TestCase):
                     miner_model=miner_model,
                     miner_api=miner_api,
                 ):
-                    miner = MINER_CLASSES[miner_model][miner_api]("0.0.0.0")
+                    miner = MINER_CLASSES[miner_model][miner_api]("127.0.0.1")
                     self.assertTrue(
                         isinstance(miner, MINER_CLASSES[miner_model][miner_api])
                     )
@@ -53,7 +53,7 @@ class MinersTest(unittest.TestCase):
         for backend in backends:
             miner_class = backend[1]
             with self.subTest(miner_class=miner_class):
-                miner = miner_class("0.0.0.0")
+                miner = miner_class("127.0.0.1")
                 self.assertTrue(isinstance(miner, miner_class))
 
     def test_miner_type_creation_failure(self):
@@ -72,9 +72,9 @@ class MinersTest(unittest.TestCase):
             miner_class = backend[1]
             with self.subTest(miner_class=miner_class):
                 with self.assertRaises(TypeError):
-                    miner_class("0.0.0.0")
+                    miner_class("127.0.0.1")
         with self.assertRaises(TypeError):
-            BaseMiner("0.0.0.0")
+            BaseMiner("127.0.0.1")
 
     def test_miner_comparisons(self):
         miner_1 = CGMiner("1.1.1.1")
@@ -110,25 +110,25 @@ class MinerFactoryTest(unittest.TestCase):
         for miner_model in MINER_CLASSES.keys():
             with self.subTest():
                 miner = MinerFactory()._select_miner_from_classes(
-                    "0.0.0.0", miner_model, None, None
+                    "127.0.0.1", 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
+                    "127.0.0.1", 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
+                "127.0.0.1", "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"
+                "127.0.0.1", "M30S", "BTMiner", "G20"
             )
             self.assertIsInstance(miner, BaseMiner)