version: bump version number.

fix send_config for ePIC

docs/API/api.md

@@ -1,27 +0,0 @@
-# pyasic
-## Miner APIs
-Each miner has a unique API that is used to communicate with it.
-Each of these API types has commands that differ between them, and some commands have data that others do not.
-Each miner that is a subclass of [`BaseMiner`][pyasic.miners.BaseMiner] should have an API linked to it as `Miner.api`.
-
-All API implementations inherit from [`BaseMinerAPI`][pyasic.API.BaseMinerAPI], which implements the basic communications protocols.
-
-[`BaseMinerAPI`][pyasic.API.BaseMinerAPI] should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare).
-[`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]
-#### [CGMiner API][pyasic.API.cgminer.CGMinerAPI]
-#### [LUXMiner API][pyasic.API.luxminer.LUXMinerAPI]
-#### [Unknown API][pyasic.API.unknown.UnknownAPI]
-
-<br>
-
-## BaseMinerAPI
-::: pyasic.API.BaseMinerAPI
-    handler: python
-    options:
-        heading_level: 4

docs/generate_miners.py

@@ -3,7 +3,7 @@ import importlib
 import os
 import warnings
 
-from pyasic.miners.miner_factory import MINER_CLASSES, MinerTypes
+from pyasic.miners.factory import MINER_CLASSES, MinerTypes
 
 warnings.filterwarnings("ignore")
 

docs/index.md

@@ -47,7 +47,7 @@ if __name__ == "__main__":
 
 ---
 ##### 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, or an abstraction of its functionality, [`get_miner()`][pyasic.miners.get_miner].
+If you already know the IP address of your miner or miners, you can use the [`MinerFactory`][pyasic.miners.factory.MinerFactory] to communicate and identify the miners, or an abstraction of its functionality, [`get_miner()`][pyasic.miners.get_miner].
 The function [`get_miner()`][pyasic.miners.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
@@ -122,24 +122,24 @@ if __name__ == "__main__":
 ## Miner control
 ---
 `pyasic` exposes a standard interface for each miner using control functions.
-Every miner class in `pyasic` must implement all the control functions defined in [`BaseMiner`][pyasic.miners.BaseMiner].
+Every miner class in `pyasic` must implement all the control functions defined in [`MinerProtocol`][pyasic.miners.base.MinerProtocol].
 
 These functions are
-[`check_light`][pyasic.miners.BaseMiner.check_light],
-[`fault_light_off`][pyasic.miners.BaseMiner.fault_light_off],
-[`fault_light_on`][pyasic.miners.BaseMiner.fault_light_on],
-[`get_config`][pyasic.miners.BaseMiner.get_config],
-[`get_data`][pyasic.miners.BaseMiner.get_data],
-[`get_errors`][pyasic.miners.BaseMiner.get_errors],
-[`get_hostname`][pyasic.miners.BaseMiner.get_hostname],
-[`get_model`][pyasic.miners.BaseMiner.get_model],
-[`reboot`][pyasic.miners.BaseMiner.reboot],
-[`restart_backend`][pyasic.miners.BaseMiner.restart_backend],
-[`stop_mining`][pyasic.miners.BaseMiner.stop_mining],
-[`resume_mining`][pyasic.miners.BaseMiner.resume_mining],
-[`is_mining`][pyasic.miners.BaseMiner.is_mining],
-[`send_config`][pyasic.miners.BaseMiner.send_config], and
-[`set_power_limit`][pyasic.miners.BaseMiner.set_power_limit].
+[`check_light`][pyasic.miners.base.MinerProtocol.check_light],
+[`fault_light_off`][pyasic.miners.base.MinerProtocol.fault_light_off],
+[`fault_light_on`][pyasic.miners.base.MinerProtocol.fault_light_on],
+[`get_config`][pyasic.miners.base.MinerProtocol.get_config],
+[`get_data`][pyasic.miners.base.MinerProtocol.get_data],
+[`get_errors`][pyasic.miners.base.MinerProtocol.get_errors],
+[`get_hostname`][pyasic.miners.base.MinerProtocol.get_hostname],
+[`get_model`][pyasic.miners.base.MinerProtocol.get_model],
+[`reboot`][pyasic.miners.base.MinerProtocol.reboot],
+[`restart_backend`][pyasic.miners.base.MinerProtocol.restart_backend],
+[`stop_mining`][pyasic.miners.base.MinerProtocol.stop_mining],
+[`resume_mining`][pyasic.miners.base.MinerProtocol.resume_mining],
+[`is_mining`][pyasic.miners.base.MinerProtocol.is_mining],
+[`send_config`][pyasic.miners.base.MinerProtocol.send_config], and
+[`set_power_limit`][pyasic.miners.base.MinerProtocol.set_power_limit].
 
 ##### Usage
 ```python

docs/miners/backends/bosminer.md

@@ -1,7 +1,15 @@
 # pyasic
 ## BOSMiner Backend
 
-::: pyasic.miners.backends.bosminer.BOSMiner
+::: pyasic.miners.backends.braiins_os.BOSMiner
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## BOSer Backend
+
+::: pyasic.miners.backends.braiins_os.BOSer
     handler: python
     options:
         show_root_heading: false

docs/miners/base_miner.md

@@ -1,10 +1,17 @@
 # pyasic
 ## Base Miner
-[`BaseMiner`][pyasic.miners.BaseMiner] is the basis for all miner classes, they all subclass (usually indirectly) from this class.
+[`BaseMiner`][pyasic.miners.base.BaseMiner] is the basis for all miner classes, they all subclass (usually indirectly) from this class.
 
-You may not instantiate this class on its own, only subclass from it.  Trying to instantiate an instance of this class will raise `TypeError`.
+This class inherits from the [`MinerProtocol`][pyasic.miners.base.MinerProtocol], which outlines functionality for miners.
 
-::: pyasic.miners.BaseMiner
+You may not instantiate this class on its own, only subclass from it.
+
+::: pyasic.miners.base.BaseMiner
+    handler: python
+    options:
+        heading_level: 4
+
+::: pyasic.miners.base.MinerProtocol
     handler: python
     options:
         heading_level: 4

docs/miners/functions.md

@@ -1,91 +1,91 @@
 ## Control functionality
 
 ### Check Light
-::: pyasic.miners.BaseMiner.check_light
+::: pyasic.miners.base.MinerProtocol.check_light
     handler: python
     options:
         heading_level: 4
 
 ### Fault Light Off
-::: pyasic.miners.BaseMiner.fault_light_off
+::: pyasic.miners.base.MinerProtocol.fault_light_off
     handler: python
     options:
         heading_level: 4
 
 ### Fault Light On
-::: pyasic.miners.BaseMiner.fault_light_on
+::: pyasic.miners.base.MinerProtocol.fault_light_on
     handler: python
     options:
         heading_level: 4
 
 ### Get Config
-::: pyasic.miners.BaseMiner.get_config
+::: pyasic.miners.base.MinerProtocol.get_config
     handler: python
     options:
         heading_level: 4
 
 ### Get Data
-::: pyasic.miners.BaseMiner.get_data
+::: pyasic.miners.base.MinerProtocol.get_data
     handler: python
     options:
         heading_level: 4
 
 ### Get Errors
-::: pyasic.miners.BaseMiner.get_errors
+::: pyasic.miners.base.MinerProtocol.get_errors
     handler: python
     options:
         heading_level: 4
 
 ### Get Hostname
-::: pyasic.miners.BaseMiner.get_hostname
+::: pyasic.miners.base.MinerProtocol.get_hostname
     handler: python
     options:
         heading_level: 4
 
 ### Get Model
-::: pyasic.miners.BaseMiner.get_model
+::: pyasic.miners.base.MinerProtocol.get_model
     handler: python
     options:
         heading_level: 4
 
 ### Reboot
-::: pyasic.miners.BaseMiner.reboot
+::: pyasic.miners.base.MinerProtocol.reboot
     handler: python
     options:
         heading_level: 4
 
 ### Restart Backend
-::: pyasic.miners.BaseMiner.restart_backend
+::: pyasic.miners.base.MinerProtocol.restart_backend
     handler: python
     options:
         heading_level: 4
 
 ### Stop Mining
-::: pyasic.miners.BaseMiner.stop_mining
+::: pyasic.miners.base.MinerProtocol.stop_mining
     handler: python
     options:
         heading_level: 4
 
 ### Resume Mining
-::: pyasic.miners.BaseMiner.resume_mining
+::: pyasic.miners.base.MinerProtocol.resume_mining
     handler: python
     options:
         heading_level: 4
 
 ### Is Mining
-::: pyasic.miners.BaseMiner.is_mining
+::: pyasic.miners.base.MinerProtocol.is_mining
     handler: python
     options:
         heading_level: 4
 
 ### Send Config
-::: pyasic.miners.BaseMiner.send_config
+::: pyasic.miners.base.MinerProtocol.send_config
     handler: python
     options:
         heading_level: 4
 
 ### Set Power Limit
-::: pyasic.miners.BaseMiner.set_power_limit
+::: pyasic.miners.base.MinerProtocol.set_power_limit
     handler: python
     options:
         heading_level: 4

docs/miners/goldshell/X5.md

@@ -2,23 +2,22 @@
 ## X5 Models
 
 ## CK5
-::: pyasic.miners.goldshell.bfgminer.X5.CK5.BFGMinerCK5
+::: pyasic.miners.goldshell.bfgminer.X5.CK5.GoldshellCK5
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## HS5
-::: pyasic.miners.goldshell.bfgminer.X5.HS5.BFGMinerHS5
+::: pyasic.miners.goldshell.bfgminer.X5.HS5.GoldshellHS5
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## KD5
-::: pyasic.miners.goldshell.bfgminer.X5.KD5.BFGMinerKD5
+::: pyasic.miners.goldshell.bfgminer.X5.KD5.GoldshellKD5
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-

docs/miners/goldshell/XMax.md

@@ -2,9 +2,8 @@
 ## XMax Models
 
 ## KD Max
-::: pyasic.miners.goldshell.bfgminer.XMax.KDMax.BFGMinerKDMax
+::: pyasic.miners.goldshell.bfgminer.XMax.KDMax.KDMax
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-

docs/miners/miner_factory.md

@@ -1,7 +1,7 @@
 # pyasic
 ## Miner Factory
 
-[`MinerFactory`][pyasic.miners.miner_factory.MinerFactory] is the way to create miner types in `pyasic`.  The most important method is [`get_miner()`][pyasic.get_miner], which is mapped to [`pyasic.get_miner()`][pyasic.get_miner], and should be used from there.
+[`MinerFactory`][pyasic.MinerFactory] is the way to create miner types in `pyasic`.  The most important method is [`get_miner()`][pyasic.get_miner], which is mapped to [`pyasic.get_miner()`][pyasic.get_miner], and should be used from there.
 
 The instance used for [`pyasic.get_miner()`][pyasic.get_miner] is `pyasic.miner_factory`.
 
@@ -9,7 +9,7 @@ The instance used for [`pyasic.get_miner()`][pyasic.get_miner] is `pyasic.miner_
 
 Finally, there is functionality to get multiple miners without using `asyncio.gather()` explicitly.  Use `pyasic.miner_factory.get_multiple_miners()` with a list of IPs as strings to get a list of miner instances.  You can also get multiple miners with an `AsyncGenerator` by using `pyasic.miner_factory.get_miner_generator()`.
 
-::: pyasic.miners.miner_factory.MinerFactory
+::: pyasic.miners.factory.MinerFactory
     handler: python
     options:
         show_root_heading: false
@@ -25,12 +25,12 @@ Finally, there is functionality to get multiple miners without using `asyncio.ga
 <br>
 
 ## AnyMiner
-::: pyasic.miners.miner_factory.AnyMiner
+::: pyasic.miners.base.AnyMiner
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-[`AnyMiner`][pyasic.miners.miner_factory.AnyMiner] is a placeholder type variable used for typing returns of functions.
-A function returning [`AnyMiner`][pyasic.miners.miner_factory.AnyMiner] will always return a subclass of [`BaseMiner`][pyasic.miners.BaseMiner],
+[`AnyMiner`][pyasic.miners.base.AnyMiner] is a placeholder type variable used for typing returns of functions.
+A function returning [`AnyMiner`][pyasic.miners.base.AnyMiner] will always return a subclass of [`BaseMiner`][pyasic.miners.BaseMiner],
 and is used to specify a function returning some arbitrary type of miner class instance.

docs/rpc/api.md

@@ -0,0 +1,27 @@
+# pyasic
+## Miner APIs
+Each miner has a unique API that is used to communicate with it.
+Each of these API types has commands that differ between them, and some commands have data that others do not.
+Each miner that is a subclass of [`BaseMiner`][pyasic.miners.BaseMiner] should have an API linked to it as `Miner.api`.
+
+All API implementations inherit from [`BaseMinerRPCAPI`][pyasic.rpc.base.BaseMinerRPCAPI], which implements the basic communications protocols.
+
+[`BaseMinerRPCAPI`][pyasic.rpc.base.BaseMinerRPCAPI] should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare).
+[`BaseMinerRPCAPI`][pyasic.rpc.base.BaseMinerRPCAPI] cannot be instantiated directly, it will raise a `TypeError`.
+Use these instead -
+
+#### [BFGMiner API][pyasic.rpc.bfgminer.BFGMinerRPCAPI]
+#### [BMMiner API][pyasic.rpc.bmminer.BMMinerRPCAPI]
+#### [BOSMiner API][pyasic.rpc.bosminer.BOSMinerRPCAPI]
+#### [BTMiner API][pyasic.rpc.btminer.BTMinerRPCAPI]
+#### [CGMiner API][pyasic.rpc.cgminer.CGMinerRPCAPI]
+#### [LUXMiner API][pyasic.rpc.luxminer.LUXMinerRPCAPI]
+#### [Unknown API][pyasic.rpc.unknown.UnknownRPCAPI]
+
+<br>
+
+## BaseMinerRPCAPI
+::: pyasic.rpc.base.BaseMinerRPCAPI
+    handler: python
+    options:
+        heading_level: 4

docs/rpc/bfgminer.md

@@ -1,6 +1,6 @@
 # pyasic
-## BFGMinerAPI
-::: pyasic.API.bfgminer.BFGMinerAPI
+## BFGMinerRPCAPI
+::: pyasic.rpc.bfgminer.BFGMinerRPCAPI
     handler: python
     options:
         show_root_heading: false

docs/rpc/bmminer.md

@@ -1,6 +1,6 @@
 # pyasic
-## BMMinerAPI
-::: pyasic.API.bmminer.BMMinerAPI
+## BMMinerRPCAPI
+::: pyasic.rpc.bmminer.BMMinerRPCAPI
     handler: python
     options:
         show_root_heading: false

docs/rpc/bosminer.md

@@ -1,6 +1,6 @@
 # pyasic
-## BOSMinerAPI
-::: pyasic.API.bosminer.BOSMinerAPI
+## BOSMinerRPCAPI
+::: pyasic.rpc.bosminer.BOSMinerRPCAPI
     handler: python
     options:
         show_root_heading: false

docs/rpc/btminer.md

@@ -1,6 +1,6 @@
 # pyasic
-## BTMinerAPI
-::: pyasic.API.btminer.BTMinerAPI
+## BTMinerRPCAPI
+::: pyasic.rpc.btminer.BTMinerRPCAPI
     handler: python
     options:
         show_root_heading: false

docs/rpc/cgminer.md

@@ -1,6 +1,6 @@
 # pyasic
-## CGMinerAPI
-::: pyasic.API.cgminer.CGMinerAPI
+## CGMinerRPCAPI
+::: pyasic.rpc.cgminer.CGMinerRPCAPI
     handler: python
     options:
         show_root_heading: false

docs/rpc/luxminer.md

@@ -1,6 +1,6 @@
 # pyasic
-## LUXMinerAPI
-::: pyasic.API.luxminer.LUXMinerAPI
+## LUXMinerRPCAPI
+::: pyasic.rpc.luxminer.LUXMinerRPCAPI
     handler: python
     options:
         show_root_heading: false

docs/rpc/unknown.md

@@ -1,6 +1,6 @@
 # pyasic
-## UnknownAPI
-::: pyasic.API.unknown.UnknownAPI
+## UnknownRPCAPI
+::: pyasic.rpc.unknown.UnknownRPCAPI
     handler: python
     options:
         show_root_heading: false

docs/settings/settings.md

@@ -4,6 +4,7 @@
 All settings here are global settings for all of pyasic.  Set these settings with `update(key, value)`.
 
 Settings options:
+
 - `network_ping_retries`
 - `network_ping_timeout`
 - `network_scan_threads`

mkdocs.yml

@@ -13,15 +13,15 @@ nav:
     - 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"
-        - LUXMiner: "API/luxminer.md"
-        - Unknown: "API/unknown.md"
+    - RPC APIs:
+        - Intro: "rpc/api.md"
+        - BFGMiner: "rpc/bfgminer.md"
+        - BMMiner: "rpc/bmminer.md"
+        - BOSMiner: "rpc/bosminer.md"
+        - BTMiner: "rpc/btminer.md"
+        - CGMiner: "rpc/cgminer.md"
+        - LUXMiner: "rpc/luxminer.md"
+        - Unknown: "rpc/unknown.md"
     - Backends:
         - BMMiner: "miners/backends/bmminer.md"
         - BOSMiner: "miners/backends/bosminer.md"

pyasic/API/bfgminer.py

@@ -1,674 +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 asyncio
-import logging
-
-from pyasic.API import APIError, BaseMinerAPI
-
-
-class BFGMinerAPI(BaseMinerAPI):
-    """An abstraction of the BFGMiner API.
-
-    Each method corresponds to an API command in BFGMiner.
-
-    [BFGMiner API documentation](https://github.com/luke-jr/bfgminer/blob/bfgminer/README.RPC)
-
-    This class abstracts use of the BFGMiner API, as well as the
-    methods for sending commands to it.  The self.send_command()
-    function handles sending a command to the miner asynchronously, and
-    as such is the base for many of the functions in this class, which
-    rely on it to send the command for them.
-
-    Parameters:
-        ip: The IP of the miner to reference the API on.
-        port: The port to reference the API on.  Default is 4028.
-    """
-
-    def __init__(self, ip: str, api_ver: str = "0.0.0", port: int = 4028):
-        super().__init__(ip, port)
-        self.api_ver = api_ver
-
-    async def multicommand(self, *commands: str, allow_warning: bool = True) -> dict:
-        # make sure we can actually run each command, otherwise they will fail
-        commands = self._check_commands(*commands)
-        # standard multicommand format is "command1+command2"
-        # doesn't work for S19 which uses the backup _x19_multicommand
-        command = "+".join(commands)
-        try:
-            data = await self.send_command(command, allow_warning=allow_warning)
-        except APIError:
-            logging.debug(f"{self} - (Multicommand) - Handling X19 multicommand.")
-            data = await self._x19_multicommand(*command.split("+"))
-        data["multicommand"] = True
-        return data
-
-    async def _x19_multicommand(self, *commands) -> dict:
-        tasks = []
-        # send all commands individually
-        for cmd in commands:
-            tasks.append(
-                asyncio.create_task(self._handle_multicommand(cmd, allow_warning=True))
-            )
-
-        all_data = await asyncio.gather(*tasks)
-
-        data = {}
-        for item in all_data:
-            data.update(item)
-
-        return data
-
-    async def version(self) -> dict:
-        """Get miner version info.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Miner version information.
-        </details>
-        """
-        return await self.send_command("version")
-
-    async def config(self) -> dict:
-        """Get some basic configuration info.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            ## Some miner configuration information:
-                * ASC Count <- the number of ASCs
-                * PGA Count <- the number of PGAs
-                * Pool Count <- the number of Pools
-                * Strategy <- the current pool strategy
-                * Log Interval <- the interval of logging
-                * Device Code <- list of compiled device drivers
-                * OS <- the current operating system
-                * Failover-Only <- failover-only setting
-                * Scan Time <- scan-time setting
-                * Queue <- queue setting
-                * Expiry <- expiry setting
-        </details>
-        """
-        return await self.send_command("config")
-
-    async def summary(self) -> dict:
-        """Get the status summary of the miner.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            The status summary of the miner.
-        </details>
-        """
-        return await self.send_command("summary")
-
-    async def pools(self) -> dict:
-        """Get pool information.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Miner pool information.
-        </details>
-        """
-        return await self.send_command("pools")
-
-    async def devs(self) -> dict:
-        """Get data on each PGA/ASC with their details.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Data on each PGA/ASC with their details.
-        </details>
-        """
-        return await self.send_command("devs")
-
-    async def procs(self) -> dict:
-        """Get data on each processor with their details.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Data on each processor with their details.
-        </details>
-        """
-        return await self.send_command("procs")
-
-    async def devscan(self, info: str = "") -> dict:
-        """Get data on each processor with their details.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            info: Info to scan for device by.
-
-        Returns:
-            Data on each processor with their details.
-        </details>
-        """
-        return await self.send_command("devscan", parameters=info)
-
-    async def pga(self, n: int) -> dict:
-        """Get data from PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The PGA number to get data from.
-
-        Returns:
-            Data on the PGA n.
-        </details>
-        """
-        return await self.send_command("pga", parameters=n)
-
-    async def proc(self, n: int = 0) -> dict:
-        """Get data processor n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The processor to get data on.
-
-        Returns:
-            Data on processor n.
-        </details>
-        """
-        return await self.send_command("proc", parameters=n)
-
-    async def pgacount(self) -> dict:
-        """Get data fon all PGAs.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Data on the PGAs connected.
-        </details>
-        """
-        return await self.send_command("pgacount")
-
-    async def proccount(self) -> dict:
-        """Get data fon all processors.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Data on the processors connected.
-        </details>
-        """
-        return await self.send_command("proccount")
-
-    async def switchpool(self, n: int) -> dict:
-        """Switch pools to pool n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The pool to switch to.
-
-        Returns:
-            A confirmation of switching to pool n.
-        </details>
-        """
-        return await self.send_command("switchpool", parameters=n)
-
-    async def enablepool(self, n: int) -> dict:
-        """Enable pool n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The pool to enable.
-
-        Returns:
-            A confirmation of enabling pool n.
-        </details>
-        """
-        return await self.send_command("enablepool", parameters=n)
-
-    async def addpool(self, url: str, username: str, password: str) -> dict:
-        """Add a pool to the miner.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            url: The URL of the new pool to add.
-            username: The users username on the new pool.
-            password: The worker password on the new pool.
-
-        Returns:
-            A confirmation of adding the pool.
-        </details>
-        """
-        return await self.send_command(
-            "addpool", parameters=f"{url},{username},{password}"
-        )
-
-    async def poolpriority(self, *n: int) -> dict:
-        """Set pool priority.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            *n: Pools in order of priority.
-
-        Returns:
-            A confirmation of setting pool priority.
-        </details>
-        """
-        pools = f"{','.join([str(item) for item in n])}"
-        return await self.send_command("poolpriority", parameters=pools)
-
-    async def poolquota(self, n: int, q: int) -> dict:
-        """Set pool quota.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: Pool number to set quota on.
-            q: Quota to set the pool to.
-
-        Returns:
-            A confirmation of setting pool quota.
-        </details>
-        """
-        return await self.send_command("poolquota", parameters=f"{n},{q}")
-
-    async def disablepool(self, n: int) -> dict:
-        """Disable a pool.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: Pool to disable.
-
-        Returns:
-            A confirmation of diabling the pool.
-        </details>
-        """
-        return await self.send_command("disablepool", parameters=n)
-
-    async def removepool(self, n: int) -> dict:
-        """Remove a pool.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: Pool to remove.
-
-        Returns:
-            A confirmation of removing the pool.
-        </details>
-        """
-        return await self.send_command("removepool", parameters=n)
-
-    async def save(self, filename: str = None) -> dict:
-        """Save the config.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            filename: Filename to save the config as.
-
-        Returns:
-            A confirmation of saving the config.
-        </details>
-        """
-        if filename:
-            return await self.send_command("save", parameters=filename)
-        else:
-            return await self.send_command("save")
-
-    async def quit(self) -> dict:
-        """Quit CGMiner.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            A single "BYE" before CGMiner quits.
-        </details>
-        """
-        return await self.send_command("quit")
-
-    async def notify(self) -> dict:
-        """Notify the user of past errors.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            The last status and count of each devices problem(s).
-        </details>
-        """
-        return await self.send_command("notify")
-
-    async def privileged(self) -> dict:
-        """Check if you have privileged access.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            The STATUS section with an error if you have no privileged access, or success if you have privileged access.
-        </details>
-        """
-        return await self.send_command("privileged")
-
-    async def pgaenable(self, n: int) -> dict:
-        """Enable PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The PGA to enable.
-
-        Returns:
-            A confirmation of enabling PGA n.
-        </details>
-        """
-        return await self.send_command("pgaenable", parameters=n)
-
-    async def pgadisable(self, n: int) -> dict:
-        """Disable PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The PGA to disable.
-
-        Returns:
-            A confirmation of disabling PGA n.
-        </details>
-        """
-        return await self.send_command("pgadisable", parameters=n)
-
-    async def pgarestart(self, n: int) -> dict:
-        """Restart PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The PGA to restart.
-
-        Returns:
-            A confirmation of restarting PGA n.
-        </details>
-        """
-        return await self.send_command("pgadisable", parameters=n)
-
-    async def pgaidentify(self, n: int) -> dict:
-        """Identify PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The PGA to identify.
-
-        Returns:
-            A confirmation of identifying PGA n.
-        </details>
-        """
-        return await self.send_command("pgaidentify", parameters=n)
-
-    async def procenable(self, n: int) -> dict:
-        """Enable processor n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The processor to enable.
-
-        Returns:
-            A confirmation of enabling processor n.
-        </details>
-        """
-        return await self.send_command("procenable", parameters=n)
-
-    async def procdisable(self, n: int) -> dict:
-        """Disable processor n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The processor to disable.
-
-        Returns:
-            A confirmation of disabling processor n.
-        </details>
-        """
-        return await self.send_command("procdisable", parameters=n)
-
-    async def procrestart(self, n: int) -> dict:
-        """Restart processor n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The processor to restart.
-
-        Returns:
-            A confirmation of restarting processor n.
-        </details>
-        """
-        return await self.send_command("procdisable", parameters=n)
-
-    async def procidentify(self, n: int) -> dict:
-        """Identify processor n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The processor to identify.
-
-        Returns:
-            A confirmation of identifying processor n.
-        </details>
-        """
-        return await self.send_command("procidentify", parameters=n)
-
-    async def devdetails(self) -> dict:
-        """Get data on all devices with their static details.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Data on all devices with their static details.
-        </details>
-        """
-        return await self.send_command("devdetails")
-
-    async def restart(self) -> dict:
-        """Restart CGMiner using the API.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            A reply informing of the restart.
-        </details>
-        """
-        return await self.send_command("restart")
-
-    async def stats(self) -> dict:
-        """Get stats of each device/pool with more than 1 getwork.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Stats of each device/pool with more than 1 getwork.
-        </details>
-        """
-        return await self.send_command("stats")
-
-    async def check(self, command: str) -> dict:
-        """Check if the command command exists in CGMiner.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            command: The command to check.
-
-        Returns:
-            ## Information about a command:
-                * Exists (Y/N) <- the command exists in this version
-                * Access (Y/N) <- you have access to use the command
-        </details>
-        """
-        return await self.send_command("check", parameters=command)
-
-    async def failover_only(self, failover: bool) -> dict:
-        """Set failover-only.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            failover: What to set failover-only to.
-
-        Returns:
-            Confirmation of setting failover-only.
-        </details>
-        """
-        return await self.send_command("failover-only", parameters=failover)
-
-    async def coin(self) -> dict:
-        """Get information on the current coin.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            ## Information about the current coin being mined:
-                * Hash Method <- the hashing algorithm
-                * Current Block Time <- blocktime as a float, 0 means none
-                * Current Block Hash <- the hash of the current block, blank means none
-                * LP <- whether LP is in use on at least 1 pool
-                * Network Difficulty: the current network difficulty
-        </details>
-        """
-        return await self.send_command("coin")
-
-    async def debug(self, setting: str) -> dict:
-        """Set a debug setting.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            setting: Which setting to switch to.
-                ## Options are:
-                    * Silent
-                    * Quiet
-                    * Verbose
-                    * Debug
-                    * RPCProto
-                    * PerDevice
-                    * WorkTime
-                    * Normal
-
-        Returns:
-            Data on which debug setting was enabled or disabled.
-        </details>
-        """
-        return await self.send_command("debug", parameters=setting)
-
-    async def setconfig(self, name: str, n: int) -> dict:
-        """Set config of name to value n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            name: The name of the config setting to set.
-                ## Options are:
-                    * queue
-                    * scantime
-                    * expiry
-            n: The value to set the 'name' setting to.
-
-        Returns:
-            The results of setting config of name to n.
-        </details>
-        """
-        return await self.send_command("setconfig", parameters=f"{name},{n}")
-
-    async def pgaset(self, n: int, opt: str, val: int = None) -> dict:
-        """Set PGA option opt to val on PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Options:
-        ```
-            MMQ -
-                opt: clock
-                val: 2 - 250 (multiple of 2)
-            XBS -
-                opt: clock
-                val: 2 - 250 (multiple of 2)
-        ```
-
-        Parameters:
-            n: The PGA to set the options on.
-            opt: The option to set. Setting this to 'help' returns a help message.
-            val: The value to set the option to.
-
-        Returns:
-            Confirmation of setting PGA n with opt[,val].
-        </details>
-        """
-        if val:
-            return await self.send_command("pgaset", parameters=f"{n},{opt},{val}")
-        else:
-            return await self.send_command("pgaset", parameters=f"{n},{opt}")
-
-    async def pprocset(self, n: int, opt: str, val: int = None) -> dict:
-        """Set processor option opt to val on processor n.
-        <details>
-            <summary>Expand</summary>
-
-        Options:
-        ```
-            MMQ -
-                opt: clock
-                val: 2 - 250 (multiple of 2)
-            XBS -
-                opt: clock
-                val: 2 - 250 (multiple of 2)
-        ```
-
-        Parameters:
-            n: The PGA to set the options on.
-            opt: The option to set. Setting this to 'help' returns a help message.
-            val: The value to set the option to.
-
-        Returns:
-            Confirmation of setting PGA n with opt[,val].
-        </details>
-        """
-        if val:
-            return await self.send_command("pgaset", parameters=f"{n},{opt},{val}")
-        else:
-            return await self.send_command("pgaset", parameters=f"{n},{opt}")
-
-    async def zero(self, which: str, summary: bool) -> dict:
-        """Zero a device.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            which: Which device to zero. Setting this to 'all' zeros all devices. Setting this to 'bestshare' zeros only the bestshare values for each pool and global.
-            summary: Whether or not to show a full summary.
-
-
-        Returns:
-            the STATUS section with info on the zero and optional summary.
-        </details>
-        """
-        return await self.send_command("zero", parameters=f"{which},{summary}")

pyasic/API/bmminer.py

@@ -1,731 +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 asyncio
-import logging
-
-from pyasic.API import APIError, BaseMinerAPI
-
-
-class BMMinerAPI(BaseMinerAPI):
-    """An abstraction of the BMMiner API.
-
-    Each method corresponds to an API command in BMMiner.
-
-    [BMMiner API documentation](https://github.com/jameshilliard/bmminer/blob/master/API-README)
-
-    This class abstracts use of the BMMiner API, as well as the
-    methods for sending commands to it.  The `self.send_command()`
-    function handles sending a command to the miner asynchronously, and
-    as such is the base for many of the functions in this class, which
-    rely on it to send the command for them.
-
-    Parameters:
-        ip: The IP of the miner to reference the API on.
-        port: The port to reference the API on.  Default is 4028.
-    """
-
-    def __init__(self, ip: str, api_ver: str = "0.0.0", port: int = 4028) -> None:
-        super().__init__(ip, port=port)
-        self.api_ver = api_ver
-
-    async def multicommand(self, *commands: str, allow_warning: bool = True) -> dict:
-        # make sure we can actually run each command, otherwise they will fail
-        commands = self._check_commands(*commands)
-        # standard multicommand format is "command1+command2"
-        # doesn't work for S19 which uses the backup _x19_multicommand
-        command = "+".join(commands)
-        try:
-            data = await self.send_command(command, allow_warning=allow_warning)
-        except APIError:
-            logging.debug(f"{self} - (Multicommand) - Handling X19 multicommand.")
-            data = await self._x19_multicommand(
-                *command.split("+"), allow_warning=allow_warning
-            )
-        data["multicommand"] = True
-        return data
-
-    async def _x19_multicommand(self, *commands, allow_warning: bool = True) -> dict:
-        tasks = []
-        # send all commands individually
-        for cmd in commands:
-            tasks.append(
-                asyncio.create_task(self._handle_multicommand(cmd, allow_warning=True))
-            )
-
-        all_data = await asyncio.gather(*tasks)
-
-        data = {}
-        for item in all_data:
-            data.update(item)
-
-        return data
-
-    async def version(self) -> dict:
-        """Get miner version info.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Miner version information.
-        </details>
-        """
-        return await self.send_command("version")
-
-    async def config(self) -> dict:
-        """Get some basic configuration info.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            ## Some miner configuration information:
-                * ASC Count <- the number of ASCs
-                * PGA Count <- the number of PGAs
-                * Pool Count <- the number of Pools
-                * Strategy <- the current pool strategy
-                * Log Interval <- the interval of logging
-                * Device Code <- list of compiled device drivers
-                * OS <- the current operating system
-                * Failover-Only <- failover-only setting
-                * Scan Time <- scan-time setting
-                * Queue <- queue setting
-                * Expiry <- expiry setting
-        </details>
-        """
-        return await self.send_command("config")
-
-    async def summary(self) -> dict:
-        """Get the status summary of the miner.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            The status summary of the miner.
-        </details>
-        """
-        return await self.send_command("summary")
-
-    async def pools(self) -> dict:
-        """Get pool information.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Miner pool information.
-        </details>
-        """
-        return await self.send_command("pools")
-
-    async def devs(self) -> dict:
-        """Get data on each PGA/ASC with their details.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Data on each PGA/ASC with their details.
-        </details>
-        """
-        return await self.send_command("devs")
-
-    async def edevs(self, old: bool = False) -> dict:
-        """Get data on each PGA/ASC with their details, ignoring blacklisted and zombie devices.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            old: Include zombie devices that became zombies less than 'old' seconds ago
-
-        Returns:
-            Data on each PGA/ASC with their details.
-        </details>
-        """
-        if old:
-            return await self.send_command("edevs", parameters=old)
-        else:
-            return await self.send_command("edevs")
-
-    async def pga(self, n: int) -> dict:
-        """Get data from PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The PGA number to get data from.
-
-        Returns:
-            Data on the PGA n.
-        </details>
-        """
-        return await self.send_command("pga", parameters=n)
-
-    async def pgacount(self) -> dict:
-        """Get data fon all PGAs.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Data on the PGAs connected.
-        </details>
-        """
-        return await self.send_command("pgacount")
-
-    async def switchpool(self, n: int) -> dict:
-        """Switch pools to pool n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The pool to switch to.
-
-        Returns:
-            A confirmation of switching to pool n.
-        </details>
-        """
-        return await self.send_command("switchpool", parameters=n)
-
-    async def enablepool(self, n: int) -> dict:
-        """Enable pool n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The pool to enable.
-
-        Returns:
-            A confirmation of enabling pool n.
-        </details>
-        """
-        return await self.send_command("enablepool", parameters=n)
-
-    async def addpool(self, url: str, username: str, password: str) -> dict:
-        """Add a pool to the miner.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            url: The URL of the new pool to add.
-            username: The users username on the new pool.
-            password: The worker password on the new pool.
-
-        Returns:
-            A confirmation of adding the pool.
-        </details>
-        """
-        return await self.send_command(
-            "addpool", parameters=f"{url},{username},{password}"
-        )
-
-    async def poolpriority(self, *n: int) -> dict:
-        """Set pool priority.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            *n: Pools in order of priority.
-
-        Returns:
-            A confirmation of setting pool priority.
-        </details>
-        """
-        pools = f"{','.join([str(item) for item in n])}"
-        return await self.send_command("poolpriority", parameters=pools)
-
-    async def poolquota(self, n: int, q: int) -> dict:
-        """Set pool quota.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: Pool number to set quota on.
-            q: Quota to set the pool to.
-
-        Returns:
-            A confirmation of setting pool quota.
-        </details>
-        """
-        return await self.send_command("poolquota", parameters=f"{n},{q}")
-
-    async def disablepool(self, n: int) -> dict:
-        """Disable a pool.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: Pool to disable.
-
-        Returns:
-            A confirmation of diabling the pool.
-        </details>
-        """
-        return await self.send_command("disablepool", parameters=n)
-
-    async def removepool(self, n: int) -> dict:
-        """Remove a pool.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: Pool to remove.
-
-        Returns:
-            A confirmation of removing the pool.
-        </details>
-        """
-        return await self.send_command("removepool", parameters=n)
-
-    async def save(self, filename: str = None) -> dict:
-        """Save the config.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            filename: Filename to save the config as.
-
-        Returns:
-            A confirmation of saving the config.
-        </details>
-        """
-        if filename:
-            return await self.send_command("save", parameters=filename)
-        else:
-            return await self.send_command("save")
-
-    async def quit(self) -> dict:
-        """Quit BMMiner.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            A single "BYE" before BMMiner quits.
-        </details>
-        """
-        return await self.send_command("quit")
-
-    async def notify(self) -> dict:
-        """Notify the user of past errors.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            The last status and count of each devices problem(s).
-        </details>
-        """
-        return await self.send_command("notify")
-
-    async def privileged(self) -> dict:
-        """Check if you have privileged access.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            The STATUS section with an error if you have no privileged access, or success if you have privileged access.
-        </details>
-        """
-        return await self.send_command("privileged")
-
-    async def pgaenable(self, n: int) -> dict:
-        """Enable PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The PGA to enable.
-
-        Returns:
-            A confirmation of enabling PGA n.
-        </details>
-        """
-        return await self.send_command("pgaenable", parameters=n)
-
-    async def pgadisable(self, n: int) -> dict:
-        """Disable PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The PGA to disable.
-
-        Returns:
-            A confirmation of disabling PGA n.
-        </details>
-        """
-        return await self.send_command("pgadisable", parameters=n)
-
-    async def pgaidentify(self, n: int) -> dict:
-        """Identify PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The PGA to identify.
-
-        Returns:
-            A confirmation of identifying PGA n.
-        </details>
-        """
-        return await self.send_command("pgaidentify", parameters=n)
-
-    async def devdetails(self) -> dict:
-        """Get data on all devices with their static details.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Data on all devices with their static details.
-        </details>
-        """
-        return await self.send_command("devdetails")
-
-    async def restart(self) -> dict:
-        """Restart BMMiner using the API.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            A reply informing of the restart.
-        </details>
-        """
-        return await self.send_command("restart")
-
-    async def stats(self) -> dict:
-        """Get stats of each device/pool with more than 1 getwork.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Stats of each device/pool with more than 1 getwork.
-        </details>
-        """
-        return await self.send_command("stats")
-
-    async def estats(self, old: bool = False) -> dict:
-        """Get stats of each device/pool with more than 1 getwork, ignoring zombie devices.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            old: Include zombie devices that became zombies less than 'old' seconds ago.
-
-        Returns:
-            Stats of each device/pool with more than 1 getwork, ignoring zombie devices.
-        </details>
-        """
-        if old:
-            return await self.send_command("estats", parameters=old)
-        else:
-            return await self.send_command("estats")
-
-    async def check(self, command: str) -> dict:
-        """Check if the command command exists in BMMiner.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            command: The command to check.
-
-        Returns:
-            ## Information about a command:
-                * Exists (Y/N) <- the command exists in this version
-                * Access (Y/N) <- you have access to use the command
-        </details>
-        """
-        return await self.send_command("check", parameters=command)
-
-    async def failover_only(self, failover: bool) -> dict:
-        """Set failover-only.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            failover: What to set failover-only to.
-
-        Returns:
-            Confirmation of setting failover-only.
-        </details>
-        """
-        return await self.send_command("failover-only", parameters=failover)
-
-    async def coin(self) -> dict:
-        """Get information on the current coin.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            ## Information about the current coin being mined:
-                * Hash Method <- the hashing algorithm
-                * Current Block Time <- blocktime as a float, 0 means none
-                * Current Block Hash <- the hash of the current block, blank means none
-                * LP <- whether LP is in use on at least 1 pool
-                * Network Difficulty: the current network difficulty
-        </details>
-        """
-        return await self.send_command("coin")
-
-    async def debug(self, setting: str) -> dict:
-        """Set a debug setting.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            setting: Which setting to switch to.
-                ## Options are:
-                    * Silent
-                    * Quiet
-                    * Verbose
-                    * Debug
-                    * RPCProto
-                    * PerDevice
-                    * WorkTime
-                    * Normal
-
-        Returns:
-            Data on which debug setting was enabled or disabled.
-        </details>
-        """
-        return await self.send_command("debug", parameters=setting)
-
-    async def setconfig(self, name: str, n: int) -> dict:
-        """Set config of name to value n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            name: The name of the config setting to set.
-                ## Options are:
-                    * queue
-                    * scantime
-                    * expiry
-            n: The value to set the 'name' setting to.
-
-        Returns:
-            The results of setting config of name to n.
-        </details>
-        """
-        return await self.send_command("setconfig", parameters=f"{name},{n}")
-
-    async def usbstats(self) -> dict:
-        """Get stats of all USB devices except ztex.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            The stats of all USB devices except ztex.
-        </details>
-        """
-        return await self.send_command("usbstats")
-
-    async def pgaset(self, n: int, opt: str, val: int = None) -> dict:
-        """Set PGA option opt to val on PGA n.
-        <details>
-            <summary>Expand</summary>
-
-        Options:
-        ```
-            MMQ -
-                opt: clock
-                val: 160 - 230 (multiple of 2)
-            CMR -
-                opt: clock
-                val: 100 - 220
-        ```
-
-        Parameters:
-            n: The PGA to set the options on.
-            opt: The option to set. Setting this to 'help' returns a help message.
-            val: The value to set the option to.
-
-        Returns:
-            Confirmation of setting PGA n with opt[,val].
-        </details>
-        """
-        if val:
-            return await self.send_command("pgaset", parameters=f"{n},{opt},{val}")
-        else:
-            return await self.send_command("pgaset", parameters=f"{n},{opt}")
-
-    async def zero(self, which: str, summary: bool) -> dict:
-        """Zero a device.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            which: Which device to zero. Setting this to 'all' zeros all devices. Setting this to 'bestshare' zeros only the bestshare values for each pool and global.
-            summary: Whether or not to show a full summary.
-
-
-        Returns:
-            the STATUS section with info on the zero and optional summary.
-        </details>
-        """
-        return await self.send_command("zero", parameters=f"{which},{summary}")
-
-    async def hotplug(self, n: int) -> dict:
-        """Enable hotplug.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The device number to set hotplug on.
-
-        Returns:
-            Information on hotplug status.
-        </details>
-        """
-        return await self.send_command("hotplug", parameters=n)
-
-    async def asc(self, n: int) -> dict:
-        """Get data for ASC device n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The device to get data for.
-
-        Returns:
-            The data for ASC device n.
-        </details>
-        """
-        return await self.send_command("asc", parameters=n)
-
-    async def ascenable(self, n: int) -> dict:
-        """Enable ASC device n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The device to enable.
-
-        Returns:
-            Confirmation of enabling ASC device n.
-        </details>
-        """
-        return await self.send_command("ascenable", parameters=n)
-
-    async def ascdisable(self, n: int) -> dict:
-        """Disable ASC device n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The device to disable.
-
-        Returns:
-            Confirmation of disabling ASC device n.
-        </details>
-        """
-        return await self.send_command("ascdisable", parameters=n)
-
-    async def ascidentify(self, n: int) -> dict:
-        """Identify ASC device n.
-        <details>
-            <summary>Expand</summary>
-
-        Parameters:
-            n: The device to identify.
-
-        Returns:
-            Confirmation of identifying ASC device n.
-        </details>
-        """
-        return await self.send_command("ascidentify", parameters=n)
-
-    async def asccount(self) -> dict:
-        """Get data on the number of ASC devices and their info.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            Data on all ASC devices.
-        </details>
-        """
-        return await self.send_command("asccount")
-
-    async def ascset(self, n: int, opt: str, val: int = None) -> dict:
-        """Set ASC n option opt to value val.
-        <details>
-            <summary>Expand</summary>
-
-        Sets an option on the ASC n to a value.  Allowed options are:
-        ```
-            AVA+BTB -
-                opt: freq
-                val: 256 - 1024 (chip frequency)
-            BTB -
-                opt: millivolts
-                val: 1000 - 1400 (core voltage)
-            MBA -
-                opt: reset
-                val: 0 - # of chips (reset a chip)
-
-                opt: freq
-                val: 0 - # of chips, 100 - 1400 (chip frequency)
-
-                opt: ledcount
-                val: 0 - 100 (chip count for LED)
-
-                opt: ledlimit
-                val: 0 - 200 (LED off below GH/s)
-
-                opt: spidelay
-                val: 0 - 9999 (SPI per I/O delay)
-
-                opt: spireset
-                val: i or s, 0 - 9999 (SPI regular reset)
-
-                opt: spisleep
-                val: 0 - 9999 (SPI reset sleep in ms)
-            BMA -
-                opt: volt
-                val: 0 - 9
-
-                opt: clock
-                val: 0 - 15
-        ```
-
-        Parameters:
-            n: The ASC to set the options on.
-            opt: The option to set. Setting this to 'help' returns a help message.
-            val: The value to set the option to.
-
-        Returns:
-            Confirmation of setting option opt to value val.
-        </details>
-        """
-        if val:
-            return await self.send_command("ascset", parameters=f"{n},{opt},{val}")
-        else:
-            return await self.send_command("ascset", parameters=f"{n},{opt}")
-
-    async def lcd(self) -> dict:
-        """Get a general all-in-one status summary of the miner.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            An all-in-one status summary of the miner.
-        </details>
-        """
-        return await self.send_command("lcd")
-
-    async def lockstats(self) -> dict:
-        """Write lockstats to STDERR.
-        <details>
-            <summary>Expand</summary>
-
-        Returns:
-            The result of writing the lock stats to STDERR.
-        </details>
-        """
-        return await self.send_command("lockstats")

pyasic/__init__.py

@@ -14,46 +14,11 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 from pyasic import settings
-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 (
-    BraiinsOSError,
-    InnosiliconError,
-    MinerData,
-    WhatsminerError,
-    X19Error,
-)
+from pyasic.data import MinerData
 from pyasic.errors import APIError, APIWarning
-from pyasic.miners import get_miner
-from pyasic.miners.base import AnyMiner, DataOptions
-from pyasic.miners.miner_factory import MinerFactory, miner_factory
-from pyasic.miners.miner_listener import MinerListener
+from pyasic.miners import *
 from pyasic.network import MinerNetwork
-
-__all__ = [
-    "BMMinerAPI",
-    "BOSMinerAPI",
-    "BTMinerAPI",
-    "CGMinerAPI",
-    "UnknownAPI",
-    "MinerConfig",
-    "MinerData",
-    "BraiinsOSError",
-    "InnosiliconError",
-    "WhatsminerError",
-    "X19Error",
-    "APIError",
-    "APIWarning",
-    "get_miner",
-    "AnyMiner",
-    "DataOptions",
-    "MinerFactory",
-    "miner_factory",
-    "MinerListener",
-    "MinerNetwork",
-    "settings",
-]
+from pyasic.rpc import *
+from pyasic.ssh import *
+from pyasic.web import *

pyasic/config/__init__.py

@@ -13,14 +13,14 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-from copy import deepcopy
 from dataclasses import asdict, dataclass, field
 
 from pyasic.config.fans import FanModeConfig
 from pyasic.config.mining import MiningModeConfig
 from pyasic.config.pools import PoolConfig
-from pyasic.config.power_scaling import PowerScalingConfig, PowerScalingShutdown
+from pyasic.config.power_scaling import PowerScalingConfig
 from pyasic.config.temperature import TemperatureConfig
+from pyasic.misc import merge_dicts
 
 
 @dataclass
@@ -93,7 +93,7 @@ class MinerConfig:
 
     def as_bosminer(self, user_suffix: str = None) -> dict:
         return {
-            **merge(self.fan_mode.as_bosminer(), self.temperature.as_bosminer()),
+            **merge_dicts(self.fan_mode.as_bosminer(), self.temperature.as_bosminer()),
             **self.mining_mode.as_bosminer(),
             **self.pools.as_bosminer(user_suffix=user_suffix),
             **self.power_scaling.as_bosminer(),
@@ -110,13 +110,21 @@ class MinerConfig:
 
     def as_epic(self, user_suffix: str = None) -> dict:
         return {
-            **self.fan_mode.as_epic(),
-            **self.temperature.as_epic(),
+            **merge_dicts(self.fan_mode.as_epic(), self.temperature.as_epic()),
             **self.mining_mode.as_epic(),
             **self.pools.as_epic(user_suffix=user_suffix),
             **self.power_scaling.as_epic(),
         }
 
+    def as_auradine(self, user_suffix: str = None) -> dict:
+        return {
+            **self.fan_mode.as_auradine(),
+            **self.temperature.as_auradine(),
+            **self.mining_mode.as_auradine(),
+            **self.pools.as_auradine(user_suffix=user_suffix),
+            **self.power_scaling.as_auradine(),
+        }
+
     @classmethod
     def from_dict(cls, dict_conf: dict) -> "MinerConfig":
         return cls(
@@ -189,13 +197,10 @@ class MinerConfig:
             mining_mode=MiningModeConfig.from_vnish(web_settings),
         )
 
-
-def merge(a: dict, b: dict) -> dict:
-    result = deepcopy(a)
-    for b_key, b_val in b.items():
-        a_val = result.get(b_key)
-        if isinstance(a_val, dict) and isinstance(b_val, dict):
-            result[b_key] = merge(a_val, b_val)
-        else:
-            result[b_key] = deepcopy(b_val)
-    return result
+    @classmethod
+    def from_auradine(cls, web_conf: dict) -> "MinerConfig":
+        return cls(
+            pools=PoolConfig.from_api(web_conf["pools"]),
+            fan_mode=FanModeConfig.from_auradine(web_conf["fan"]),
+            mining_mode=MiningModeConfig.from_auradine(web_conf["mode"]),
+        )

pyasic/config/base.py

@@ -13,14 +13,15 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from __future__ import annotations
+
 from dataclasses import asdict, dataclass
 from enum import Enum
-from typing import Union
 
 
 class MinerConfigOption(Enum):
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]):
+    def from_dict(cls, dict_conf: dict | None):
         return cls.default()
 
     def as_am_modern(self) -> dict:
@@ -53,6 +54,9 @@ class MinerConfigOption(Enum):
     def as_vnish(self) -> dict:
         return self.value.as_vnish()
 
+    def as_auradine(self) -> dict:
+        return self.value.as_auradine()
+
     def __call__(self, *args, **kwargs):
         return self.value(*args, **kwargs)
 
@@ -64,10 +68,10 @@ class MinerConfigOption(Enum):
 @dataclass
 class MinerConfigValue:
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]):
+    def from_dict(cls, dict_conf: dict | None):
         return cls()
 
-    def as_dict(self):
+    def as_dict(self) -> dict:
         return asdict(self)
 
     def as_am_modern(self) -> dict:
@@ -99,3 +103,6 @@ class MinerConfigValue:
 
     def as_vnish(self) -> dict:
         return {}
+
+    def as_auradine(self) -> dict:
+        return {}

pyasic/config/fans.py

@@ -13,8 +13,9 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from __future__ import annotations
+
 from dataclasses import dataclass, field
-from typing import Union
 
 from pyasic.config.base import MinerConfigOption, MinerConfigValue
 
@@ -26,7 +27,7 @@ class FanModeNormal(MinerConfigValue):
     minimum_speed: int = 0
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "FanModeNormal":
+    def from_dict(cls, dict_conf: dict | None) -> "FanModeNormal":
         cls_conf = {}
         if dict_conf.get("minimum_fans") is not None:
             cls_conf["minimum_fans"] = dict_conf["minimum_fans"]
@@ -35,7 +36,7 @@ class FanModeNormal(MinerConfigValue):
         return cls(**cls_conf)
 
     @classmethod
-    def from_vnish(cls, web_cooling_settings: dict):
+    def from_vnish(cls, web_cooling_settings: dict) -> "FanModeNormal":
         cls_conf = {}
         if web_cooling_settings.get("fan_min_count") is not None:
             cls_conf["minimum_fans"] = web_cooling_settings["fan_min_count"]
@@ -49,6 +50,17 @@ class FanModeNormal(MinerConfigValue):
     def as_bosminer(self) -> dict:
         return {"temp_control": {"mode": "auto"}}
 
+    def as_epic(self) -> dict:
+        return {
+            "fans": {
+                "Auto": {
+                    "Idle Speed": self.minimum_speed
+                    if not self.minimum_speed == 0
+                    else 100
+                }
+            }
+        }
+
 
 @dataclass
 class FanModeManual(MinerConfigValue):
@@ -57,7 +69,7 @@ class FanModeManual(MinerConfigValue):
     minimum_fans: int = 1
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "FanModeManual":
+    def from_dict(cls, dict_conf: dict | None) -> "FanModeManual":
         cls_conf = {}
         if dict_conf.get("speed") is not None:
             cls_conf["speed"] = dict_conf["speed"]
@@ -92,13 +104,19 @@ class FanModeManual(MinerConfigValue):
             "fan_control": {"min_fans": self.minimum_fans, "speed": self.speed},
         }
 
+    def as_auradine(self) -> dict:
+        return {"fan": {"percentage": self.speed}}
+
+    def as_epic(self) -> dict:
+        return {"fans": {"Manual": {"speed": self.speed}}}
+
 
 @dataclass
 class FanModeImmersion(MinerConfigValue):
     mode: str = field(init=False, default="immersion")
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "FanModeImmersion":
+    def from_dict(cls, dict_conf: dict | None) -> "FanModeImmersion":
         return cls()
 
     def as_am_modern(self) -> dict:
@@ -107,6 +125,9 @@ class FanModeImmersion(MinerConfigValue):
     def as_bosminer(self) -> dict:
         return {"temp_control": {"mode": "disabled"}}
 
+    def as_auradine(self) -> dict:
+        return {"fan": {"percentage": 0}}
+
 
 class FanModeConfig(MinerConfigOption):
     normal = FanModeNormal
@@ -118,7 +139,7 @@ class FanModeConfig(MinerConfigOption):
         return cls.normal()
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]):
+    def from_dict(cls, dict_conf: dict | None):
         if dict_conf is None:
             return cls.default()
 
@@ -126,9 +147,9 @@ class FanModeConfig(MinerConfigOption):
         if mode is None:
             return cls.default()
 
-        clsattr = getattr(cls, mode)
-        if clsattr is not None:
-            return clsattr().from_dict(dict_conf)
+        cls_attr = getattr(cls, mode)
+        if cls_attr is not None:
+            return cls_attr().from_dict(dict_conf)
 
     @classmethod
     def from_am_modern(cls, web_conf: dict):
@@ -202,3 +223,13 @@ class FanModeConfig(MinerConfigOption):
             if "minimumRequiredFans" in keys:
                 conf["minimum_fans"] = int(temperature_conf["minimumRequiredFans"])
             return cls.manual(**conf)
+
+    @classmethod
+    def from_auradine(cls, web_fan: dict):
+        try:
+            fan_data = web_fan["Fan"][0]
+            fan_1_max = fan_data["Max"]
+            fan_1_target = fan_data["Target"]
+            return cls.manual(speed=round((fan_1_target / fan_1_max) * 100))
+        except LookupError:
+            return cls.default()

pyasic/config/mining.py

@@ -13,8 +13,9 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from __future__ import annotations
+
 from dataclasses import dataclass, field
-from typing import Dict, Union
 
 from pyasic.config.base import MinerConfigOption, MinerConfigValue
 from pyasic.web.braiins_os.proto.braiins.bos.v1 import (
@@ -34,7 +35,7 @@ class MiningModeNormal(MinerConfigValue):
     mode: str = field(init=False, default="normal")
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeNormal":
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeNormal":
         return cls()
 
     def as_am_modern(self) -> dict:
@@ -43,13 +44,22 @@ class MiningModeNormal(MinerConfigValue):
     def as_wm(self) -> dict:
         return {"mode": self.mode}
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": self.mode}}
+
+    def as_epic(self) -> dict:
+        return {"ptune": {"enabled": False}}
+
+    def as_goldshell(self) -> dict:
+        return {"settings": {"level": 0}}
+
 
 @dataclass
 class MiningModeSleep(MinerConfigValue):
     mode: str = field(init=False, default="sleep")
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeSleep":
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeSleep":
         return cls()
 
     def as_am_modern(self) -> dict:
@@ -58,13 +68,22 @@ class MiningModeSleep(MinerConfigValue):
     def as_wm(self) -> dict:
         return {"mode": self.mode}
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"sleep": "on"}}
+
+    def as_epic(self) -> dict:
+        return {"ptune": {"algo": "Sleep", "target": 0}}
+
+    def as_goldshell(self) -> dict:
+        return {"settings": {"level": 3}}
+
 
 @dataclass
 class MiningModeLPM(MinerConfigValue):
     mode: str = field(init=False, default="low")
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeLPM":
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeLPM":
         return cls()
 
     def as_am_modern(self) -> dict:
@@ -73,30 +92,77 @@ class MiningModeLPM(MinerConfigValue):
     def as_wm(self) -> dict:
         return {"mode": self.mode}
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": "eco"}}
+
+    def as_goldshell(self) -> dict:
+        return {"settings": {"level": 1}}
+
 
 @dataclass
 class MiningModeHPM(MinerConfigValue):
     mode: str = field(init=False, default="high")
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeHPM":
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeHPM":
         return cls()
 
-    def as_am_modern(self):
+    def as_am_modern(self) -> dict:
         return {"miner-mode": "0"}
 
     def as_wm(self) -> dict:
         return {"mode": self.mode}
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": "turbo"}}
+
+
+class StandardTuneAlgo(MinerConfigValue):
+    mode: str = field(init=False, default="standard")
+
+    def as_epic(self) -> str:
+        return VOptAlgo().as_epic()
+
+
+class VOptAlgo(MinerConfigValue):
+    mode: str = field(init=False, default="standard")
+
+    def as_epic(self) -> str:
+        return "VoltageOptimizer"
+
+
+class ChipTuneAlgo(MinerConfigValue):
+    mode: str = field(init=False, default="standard")
+
+    def as_epic(self) -> str:
+        return "ChipTune"
+
+
+class TunerAlgo(MinerConfigOption):
+    standard = StandardTuneAlgo
+    voltage_optimizer = VOptAlgo
+    chip_tune = ChipTuneAlgo
+
+    @classmethod
+    def default(cls):
+        return cls.standard()
+
 
 @dataclass
 class MiningModePowerTune(MinerConfigValue):
     mode: str = field(init=False, default="power_tuning")
     power: int = None
+    algo: TunerAlgo = field(default_factory=TunerAlgo.default)
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModePowerTune":
-        return cls(dict_conf.get("power"))
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModePowerTune":
+        cls_conf = {}
+        if dict_conf.get("power"):
+            cls_conf["power"] = dict_conf["power"]
+        if dict_conf.get("algo"):
+            cls_conf["algo"] = dict_conf["algo"]
+
+        return cls(**cls_conf)
 
     def as_am_modern(self) -> dict:
         return {"miner-mode": "0"}
@@ -123,14 +189,18 @@ class MiningModePowerTune(MinerConfigValue):
             ),
         }
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": "custom", "tune": "power", "power": self.power}}
+
 
 @dataclass
 class MiningModeHashrateTune(MinerConfigValue):
     mode: str = field(init=False, default="hashrate_tuning")
     hashrate: int = None
+    algo: TunerAlgo = field(default_factory=TunerAlgo.default)
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeHashrateTune":
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeHashrateTune":
         return cls(dict_conf.get("hashrate"))
 
     def as_am_modern(self) -> dict:
@@ -152,6 +222,12 @@ class MiningModeHashrateTune(MinerConfigValue):
             )
         }
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": "custom", "tune": "ths", "ths": self.hashrate}}
+
+    def as_epic(self) -> dict:
+        return {"ptune": {"algo": self.algo.as_epic(), "target": self.hashrate}}
+
 
 @dataclass
 class ManualBoardSettings(MinerConfigValue):
@@ -159,7 +235,7 @@ class ManualBoardSettings(MinerConfigValue):
     volt: float
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "ManualBoardSettings":
+    def from_dict(cls, dict_conf: dict | None) -> "ManualBoardSettings":
         return cls(freq=dict_conf["freq"], volt=dict_conf["volt"])
 
     def as_am_modern(self) -> dict:
@@ -172,10 +248,10 @@ class MiningModeManual(MinerConfigValue):
 
     global_freq: float
     global_volt: float
-    boards: Dict[int, ManualBoardSettings] = field(default_factory=dict)
+    boards: dict[int, ManualBoardSettings] = field(default_factory=dict)
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeManual":
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeManual":
         return cls(
             global_freq=dict_conf["global_freq"],
             global_volt=dict_conf["global_volt"],
@@ -214,7 +290,7 @@ class MiningModeConfig(MinerConfigOption):
         return cls.normal()
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]):
+    def from_dict(cls, dict_conf: dict | None):
         if dict_conf is None:
             return cls.default()
 
@@ -222,9 +298,9 @@ class MiningModeConfig(MinerConfigOption):
         if mode is None:
             return cls.default()
 
-        clsattr = getattr(cls, mode)
-        if clsattr is not None:
-            return clsattr().from_dict(dict_conf)
+        cls_attr = getattr(cls, mode)
+        if cls_attr is not None:
+            return cls_attr().from_dict(dict_conf)
 
     @classmethod
     def from_am_modern(cls, web_conf: dict):
@@ -243,20 +319,18 @@ class MiningModeConfig(MinerConfigOption):
     @classmethod
     def from_epic(cls, web_conf: dict):
         try:
-            work_mode = web_conf["PerpetualTune"]["Running"]
-            if work_mode:
-                if (
-                    web_conf["PerpetualTune"]["Algorithm"].get("VoltageOptimizer")
-                    is not None
-                ):
+            tuner_running = web_conf["PerpetualTune"]["Running"]
+            if tuner_running:
+                algo_info = web_conf["PerpetualTune"]["Algorithm"]
+                if algo_info.get("VoltageOptimizer") is not None:
                     return cls.hashrate_tuning(
-                        web_conf["PerpetualTune"]["Algorithm"]["VoltageOptimizer"][
-                            "Target"
-                        ]
+                        hashrate=algo_info["VoltageOptimizer"]["Target"],
+                        algo=TunerAlgo.voltage_optimizer,
                     )
                 else:
                     return cls.hashrate_tuning(
-                        web_conf["PerpetualTune"]["Algorithm"]["ChipTune"]["Target"]
+                        hashrate=algo_info["ChipTune"]["Target"],
+                        algo=TunerAlgo.chip_tune,
                     )
             else:
                 return cls.normal()
@@ -330,3 +404,22 @@ class MiningModeConfig(MinerConfigOption):
             return cls.hashrate_tuning(
                 int(tuner_conf["hashrateTarget"]["terahashPerSecond"])
             )
+
+    @classmethod
+    def from_auradine(cls, web_mode: dict):
+        try:
+            mode_data = web_mode["Mode"][0]
+            if mode_data.get("Sleep") == "on":
+                return cls.sleep()
+            if mode_data.get("Mode") == "normal":
+                return cls.normal()
+            if mode_data.get("Mode") == "eco":
+                return cls.low()
+            if mode_data.get("Mode") == "turbo":
+                return cls.high()
+            if mode_data.get("Ths") is not None:
+                return cls.hashrate_tuning(mode_data["Ths"])
+            if mode_data.get("Power") is not None:
+                return cls.power_tuning(mode_data["Power"])
+        except LookupError:
+            return cls.default()

pyasic/config/pools.py

@@ -13,10 +13,12 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from __future__ import annotations
+
 import random
 import string
 from dataclasses import dataclass, field
-from typing import Dict, List, Union
+from typing import List
 
 from pyasic.config.base import MinerConfigValue
 
@@ -27,7 +29,7 @@ class Pool(MinerConfigValue):
     user: str
     password: str
 
-    def as_am_modern(self, user_suffix: str = None):
+    def as_am_modern(self, user_suffix: str = None) -> dict:
         if user_suffix is not None:
             return {
                 "url": self.url,
@@ -36,7 +38,7 @@ class Pool(MinerConfigValue):
             }
         return {"url": self.url, "user": self.user, "pass": self.password}
 
-    def as_wm(self, idx: int, user_suffix: str = None):
+    def as_wm(self, idx: int = 1, user_suffix: str = None) -> dict:
         if user_suffix is not None:
             return {
                 f"pool_{idx}": self.url,
@@ -49,7 +51,7 @@ class Pool(MinerConfigValue):
             f"passwd_{idx}": self.password,
         }
 
-    def as_am_old(self, idx: int, user_suffix: str = None):
+    def as_am_old(self, idx: int = 1, user_suffix: str = None) -> dict:
         if user_suffix is not None:
             return {
                 f"_ant_pool{idx}url": self.url,
@@ -62,7 +64,7 @@ class Pool(MinerConfigValue):
             f"_ant_pool{idx}pw": self.password,
         }
 
-    def as_goldshell(self, user_suffix: str = None):
+    def as_goldshell(self, user_suffix: str = None) -> dict:
         if user_suffix is not None:
             return {
                 "url": self.url,
@@ -71,12 +73,12 @@ class Pool(MinerConfigValue):
             }
         return {"url": self.url, "user": self.user, "pass": self.password}
 
-    def as_avalon(self, user_suffix: str = None):
+    def as_avalon(self, user_suffix: str = None) -> str:
         if user_suffix is not None:
             return ",".join([self.url, f"{self.user}{user_suffix}", self.password])
         return ",".join([self.url, self.user, self.password])
 
-    def as_inno(self, idx: int, user_suffix: str = None):
+    def as_inno(self, idx: int = 1, user_suffix: str = None) -> dict:
         if user_suffix is not None:
             return {
                 f"Pool{idx}": self.url,
@@ -89,7 +91,7 @@ class Pool(MinerConfigValue):
             f"Password{idx}": self.password,
         }
 
-    def as_bosminer(self, user_suffix: str = None):
+    def as_bosminer(self, user_suffix: str = None) -> dict:
         if user_suffix is not None:
             return {
                 "url": self.url,
@@ -98,8 +100,26 @@ class Pool(MinerConfigValue):
             }
         return {"url": self.url, "user": self.user, "password": self.password}
 
+    def as_auradine(self, user_suffix: str = None) -> dict:
+        if user_suffix is not None:
+            return {
+                "url": self.url,
+                "user": f"{self.user}{user_suffix}",
+                "pass": self.password,
+            }
+        return {"url": self.url, "user": self.user, "pass": self.password}
+
+    def as_epic(self, user_suffix: str = None):
+        if user_suffix is not None:
+            return {
+                "pool": self.url,
+                "login": f"{self.user}{user_suffix}",
+                "password": self.password,
+            }
+        return {"pool": self.url, "login": self.user, "password": self.password}
+
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "Pool":
+    def from_dict(cls, dict_conf: dict | None) -> "Pool":
         return cls(
             url=dict_conf["url"], user=dict_conf["user"], password=dict_conf["password"]
         )
@@ -160,7 +180,7 @@ class Pool(MinerConfigValue):
 
 @dataclass
 class PoolGroup(MinerConfigValue):
-    pools: List[Pool] = field(default_factory=list)
+    pools: list[Pool] = field(default_factory=list)
     quota: int = 1
     name: str = None
 
@@ -210,7 +230,7 @@ class PoolGroup(MinerConfigValue):
     def as_goldshell(self, user_suffix: str = None) -> list:
         return [pool.as_goldshell(user_suffix) for pool in self.pools]
 
-    def as_avalon(self, user_suffix: str = None) -> dict:
+    def as_avalon(self, user_suffix: str = None) -> str:
         if len(self.pools) > 0:
             return self.pools[0].as_avalon(user_suffix=user_suffix)
         return Pool("", "", "").as_avalon()
@@ -241,8 +261,14 @@ class PoolGroup(MinerConfigValue):
             return conf
         return {"name": "Group", "pool": []}
 
+    def as_auradine(self, user_suffix: str = None) -> list:
+        return [p.as_auradine(user_suffix=user_suffix) for p in self.pools]
+
+    def as_epic(self, user_suffix: str = None) -> dict:
+        return [p.as_epic(user_suffix=user_suffix) for p in self.pools]
+
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "PoolGroup":
+    def from_dict(cls, dict_conf: dict | None) -> "PoolGroup":
         cls_conf = {}
 
         if dict_conf.get("quota") is not None:
@@ -296,7 +322,7 @@ class PoolGroup(MinerConfigValue):
         return cls([Pool.from_vnish(p) for p in web_settings_pools])
 
     @classmethod
-    def from_boser(cls, grpc_pool_group: dict):
+    def from_boser(cls, grpc_pool_group: dict) -> "PoolGroup":
         try:
             return cls(
                 pools=[Pool.from_boser(p) for p in grpc_pool_group["pools"]],
@@ -318,14 +344,14 @@ class PoolConfig(MinerConfigValue):
         return cls()
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "PoolConfig":
+    def from_dict(cls, dict_conf: dict | None) -> "PoolConfig":
         if dict_conf is None:
             return cls.default()
 
         return cls(groups=[PoolGroup.from_dict(g) for g in dict_conf["groups"]])
 
     @classmethod
-    def simple(cls, pools: List[Union[Pool, Dict[str, str]]]) -> "PoolConfig":
+    def simple(cls, pools: list[Pool | dict[str, str]]) -> "PoolConfig":
         group_pools = []
         for pool in pools:
             if isinstance(pool, dict):
@@ -373,6 +399,32 @@ class PoolConfig(MinerConfigValue):
     def as_boser(self, user_suffix: str = None) -> dict:
         return {}
 
+    def as_auradine(self, user_suffix: str = None) -> dict:
+        if len(self.groups) > 0:
+            return {
+                "updatepools": {
+                    "pools": self.groups[0].as_auradine(user_suffix=user_suffix)
+                }
+            }
+        return {"updatepools": {"pools": PoolGroup().as_auradine()}}
+
+    def as_epic(self, user_suffix: str = None) -> dict:
+        if len(self.groups) > 0:
+            return {
+                "pools": {
+                    "coin": "Btc",
+                    "stratum_configs": self.groups[0].as_epic(user_suffix=user_suffix),
+                    "unique_id": False,
+                }
+            }
+        return {
+            "pools": {
+                "coin": "Btc",
+                "stratum_configs": [PoolGroup().as_epic()],
+                "unique_id": False,
+            }
+        }
+
     @classmethod
     def from_api(cls, api_pools: dict) -> "PoolConfig":
         try:
@@ -417,7 +469,7 @@ class PoolConfig(MinerConfigValue):
             return cls()
 
     @classmethod
-    def from_boser(cls, grpc_miner_conf: dict):
+    def from_boser(cls, grpc_miner_conf: dict) -> "PoolConfig":
         try:
             return cls(
                 groups=[

pyasic/config/power_scaling.py

@@ -13,8 +13,9 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from __future__ import annotations
+
 from dataclasses import dataclass, field
-from typing import Union
 
 from pyasic.config.base import MinerConfigOption, MinerConfigValue
 from pyasic.web.braiins_os.proto.braiins.bos.v1 import (
@@ -31,7 +32,7 @@ class PowerScalingShutdownEnabled(MinerConfigValue):
     duration: int = None
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "PowerScalingShutdownEnabled":
+    def from_dict(cls, dict_conf: dict | None) -> "PowerScalingShutdownEnabled":
         return cls(duration=dict_conf.get("duration"))
 
     def as_bosminer(self) -> dict:
@@ -51,7 +52,7 @@ class PowerScalingShutdownDisabled(MinerConfigValue):
     mode: str = field(init=False, default="disabled")
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "PowerScalingShutdownDisabled":
+    def from_dict(cls, dict_conf: dict | None) -> "PowerScalingShutdownDisabled":
         return cls()
 
     def as_bosminer(self) -> dict:
@@ -66,7 +67,7 @@ class PowerScalingShutdown(MinerConfigOption):
     disabled = PowerScalingShutdownDisabled
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]):
+    def from_dict(cls, dict_conf: dict | None):
         if dict_conf is None:
             return cls.default()
 
@@ -107,9 +108,7 @@ class PowerScalingEnabled(MinerConfigValue):
     mode: str = field(init=False, default="enabled")
     power_step: int = None
     minimum_power: int = None
-    shutdown_enabled: Union[
-        PowerScalingShutdownEnabled, PowerScalingShutdownDisabled
-    ] = None
+    shutdown_enabled: PowerScalingShutdownEnabled | PowerScalingShutdownDisabled = None
 
     @classmethod
     def from_bosminer(cls, power_scaling_conf: dict) -> "PowerScalingEnabled":
@@ -122,7 +121,7 @@ class PowerScalingEnabled(MinerConfigValue):
         )
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "PowerScalingEnabled":
+    def from_dict(cls, dict_conf: dict | None) -> "PowerScalingEnabled":
         cls_conf = {
             "power_step": dict_conf.get("power_step"),
             "minimum_power": dict_conf.get("minimum_power"),
@@ -175,7 +174,7 @@ class PowerScalingConfig(MinerConfigOption):
         return cls.disabled()
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]):
+    def from_dict(cls, dict_conf: dict | None):
         if dict_conf is None:
             return cls.default()
 

pyasic/config/temperature.py

@@ -13,8 +13,9 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from __future__ import annotations
+
 from dataclasses import dataclass
-from typing import Union
 
 from pyasic.config.base import MinerConfigValue
 
@@ -39,8 +40,18 @@ class TemperatureConfig(MinerConfigValue):
             temp_cfg["dangerous_temp"] = self.danger
         return {"temp_control": temp_cfg}
 
+    def as_epic(self) -> dict:
+        temps_config = {"temps": {}, "fans": {"Auto": {}}}
+        if self.target is not None:
+            temps_config["fans"]["Auto"]["Target Temperature"] = self.target
+        else:
+            temps_config["fans"]["Auto"]["Target Temperature"] = 60
+        if self.danger is not None:
+            temps_config["temps"]["shutdown"] = self.danger
+        return temps_config
+
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "TemperatureConfig":
+    def from_dict(cls, dict_conf: dict | None) -> "TemperatureConfig":
         return cls(
             target=dict_conf.get("target"),
             hot=dict_conf.get("hot"),
@@ -59,21 +70,20 @@ class TemperatureConfig(MinerConfigValue):
 
     @classmethod
     def from_epic(cls, web_conf: dict) -> "TemperatureConfig":
-        dangerous_temp = None
         try:
-            hot_temp = web_conf["Misc"]["Shutdown Temp"]
+            dangerous_temp = web_conf["Misc"]["Shutdown Temp"]
         except KeyError:
-            hot_temp = None
+            dangerous_temp = None
         # Need to do this in two blocks to avoid KeyError if one is missing
         try:
             target_temp = web_conf["Fans"]["Fan Mode"]["Auto"]["Target Temperature"]
         except KeyError:
             target_temp = None
 
-        return cls(target=target_temp, hot=hot_temp, danger=dangerous_temp)
+        return cls(target=target_temp, danger=dangerous_temp)
 
     @classmethod
-    def from_vnish(cls, web_settings: dict):
+    def from_vnish(cls, web_settings: dict) -> "TemperatureConfig":
         try:
             if web_settings["miner"]["cooling"]["mode"]["name"] == "auto":
                 return cls(target=web_settings["miner"]["cooling"]["mode"]["param"])
@@ -82,7 +92,7 @@ class TemperatureConfig(MinerConfigValue):
         return cls()
 
     @classmethod
-    def from_boser(cls, grpc_miner_conf: dict):
+    def from_boser(cls, grpc_miner_conf: dict) -> "TemperatureConfig":
         try:
             temperature_conf = grpc_miner_conf["temperature"]
         except KeyError:

pyasic/data/__init__.py

@@ -16,7 +16,6 @@
 
 import copy
 import json
-import logging
 import time
 from dataclasses import asdict, dataclass, field, fields
 from datetime import datetime, timezone
@@ -25,73 +24,9 @@ from typing import Any, List, Union
 from pyasic.config import MinerConfig
 from pyasic.config.mining import MiningModePowerTune
 
+from .boards import HashBoard
 from .error_codes import BraiinsOSError, InnosiliconError, WhatsminerError, X19Error
-
-
-@dataclass
-class HashBoard:
-    """A Dataclass to standardize hashboard data.
-
-    Attributes:
-        slot: The slot of the board as an int.
-        hashrate: The hashrate of the board in TH/s as a float.
-        temp: The temperature of the PCB as an int.
-        chip_temp: The temperature of the chips as an int.
-        chips: The chip count of the board as an int.
-        expected_chips: The expected chip count of the board as an int.
-        serial_number: The serial number of the board.
-        missing: Whether the board is returned from the miners data as a bool.
-    """
-
-    slot: int = 0
-    hashrate: float = None
-    temp: int = None
-    chip_temp: int = None
-    chips: int = None
-    expected_chips: int = None
-    serial_number: str = None
-    missing: bool = True
-
-    def get(self, __key: str, default: Any = None):
-        try:
-            val = self.__getitem__(__key)
-            if val is None:
-                return default
-            return val
-        except KeyError:
-            return default
-
-    def __getitem__(self, item: str):
-        try:
-            return getattr(self, item)
-        except AttributeError:
-            raise KeyError(f"{item}")
-
-
-@dataclass
-class Fan:
-    """A Dataclass to standardize fan data.
-
-    Attributes:
-        speed: The speed of the fan.
-    """
-
-    speed: int = None
-
-    def get(self, __key: str, default: Any = None):
-        try:
-            val = self.__getitem__(__key)
-            if val is None:
-                return default
-            return val
-        except KeyError:
-            return default
-
-    def __getitem__(self, item: str):
-        try:
-            return getattr(self, item)
-        except AttributeError:
-            raise KeyError(f"{item}")
+from .fans import Fan
 
 
 @dataclass
@@ -351,7 +286,6 @@ class MinerData:
         pass
 
     def asdict(self) -> dict:
-        logging.debug(f"MinerData - (To Dict) - Dumping Dict data")
         return asdict(self, dict_factory=self.dict_factory)
 
     def as_dict(self) -> dict:
@@ -368,7 +302,6 @@ class MinerData:
         Returns:
             A JSON version of this class.
         """
-        logging.debug(f"MinerData - (To JSON) - Dumping JSON data")
         data = self.asdict()
         data["datetime"] = str(int(time.mktime(data["datetime"].timetuple())))
         return json.dumps(data)
@@ -379,7 +312,6 @@ class MinerData:
         Returns:
             A CSV version of this class with no headers.
         """
-        logging.debug(f"MinerData - (To CSV) - Dumping CSV data")
         data = self.asdict()
         data["datetime"] = str(int(time.mktime(data["datetime"].timetuple())))
         errs = []
@@ -398,7 +330,6 @@ class MinerData:
         Returns:
             A influxdb line protocol version of this class.
         """
-        logging.debug(f"MinerData - (To InfluxDB) - Dumping InfluxDB data")
         tag_data = [measurement_name]
         field_data = []
 

pyasic/data/boards.py

@@ -14,39 +14,45 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-import warnings
-
-from pyasic.miners.makes import WhatsMiner
+from dataclasses import dataclass
+from typing import Any
 
 
-class M33SPlusVG20(WhatsMiner):  # 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.raw_model = "M33S+ VG20"
-        self.expected_hashboards = 4
-        self.expected_chips = 112
-        self.fan_count = 0
+@dataclass
+class HashBoard:
+    """A Dataclass to standardize hashboard data.
 
+    Attributes:
+        slot: The slot of the board as an int.
+        hashrate: The hashrate of the board in TH/s as a float.
+        temp: The temperature of the PCB as an int.
+        chip_temp: The temperature of the chips as an int.
+        chips: The chip count of the board as an int.
+        expected_chips: The expected chip count of the board as an int.
+        serial_number: The serial number of the board.
+        missing: Whether the board is returned from the miners data as a bool.
+    """
 
-class M33SPlusVH20(WhatsMiner):  # 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.raw_model = "M33S+ VH20"
-        self.expected_hashboards = 4
-        self.expected_chips = 100
-        self.fan_count = 0
+    slot: int = 0
+    hashrate: float = None
+    temp: int = None
+    chip_temp: int = None
+    chips: int = None
+    expected_chips: int = None
+    serial_number: str = None
+    missing: bool = True
 
+    def get(self, __key: str, default: Any = None):
+        try:
+            val = self.__getitem__(__key)
+            if val is None:
+                return default
+            return val
+        except KeyError:
+            return default
 
-class M33SPlusVH30(WhatsMiner):  # 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.raw_model = "M33S+ VH30"
-        self.expected_hashboards = 4
-        self.expected_chips = 0  # slot1 116, slot2 106, slot3 116, slot4 106
-        warnings.warn(
-            "Unknown chip count for miner type M30S+ VH30, please open an issue on GitHub (https://github.com/UpstreamData/pyasic)."
-        )
-        self.fan_count = 0
+    def __getitem__(self, item: str):
+        try:
+            return getattr(self, item)
+        except AttributeError:
+            raise KeyError(f"{item}")

pyasic/data/fans.py

@@ -14,22 +14,31 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.makes import WhatsMiner
+from dataclasses import dataclass
+from typing import Any
 
 
-class M31V10(WhatsMiner):  # 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.raw_model = "M31 V10"
-        self.expected_chips = 70
-        self.fan_count = 2
+@dataclass
+class Fan:
+    """A Dataclass to standardize fan data.
 
+    Attributes:
+        speed: The speed of the fan.
+    """
 
-class M31V20(WhatsMiner):  # 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.raw_model = "M31 V20"
-        self.expected_chips = 74
-        self.fan_count = 2
+    speed: int = None
+
+    def get(self, __key: str, default: Any = None):
+        try:
+            val = self.__getitem__(__key)
+            if val is None:
+                return default
+            return val
+        except KeyError:
+            return default
+
+    def __getitem__(self, item: str):
+        try:
+            return getattr(self, item)
+        except AttributeError:
+            raise KeyError(f"{item}")

pyasic/load/__init__.py

@@ -20,7 +20,7 @@ from typing import List, Union
 from pyasic.errors import APIError
 from pyasic.miners import AnyMiner
 from pyasic.miners.backends import AntminerModern, BOSMiner, BTMiner
-from pyasic.miners.types import S9, S17, T17, S17e, S17Plus, S17Pro, T17e, T17Plus
+from pyasic.miners.models import S9, S17, T17, S17e, S17Plus, S17Pro, T17e, T17Plus
 
 FAN_USAGE = 50  # 50 W per fan
 
@@ -149,10 +149,10 @@ class _MinerPhaseBalancer:
                 not self.miners[data_point.ip]["shutdown"]
             ):
                 # cant do anything with it so need to find a semi-accurate power limit
-                if not data_point.wattage_limit == None:
+                if data_point.wattage_limit is not None:
                     self.miners[data_point.ip]["max"] = int(data_point.wattage_limit)
                     self.miners[data_point.ip]["min"] = int(data_point.wattage_limit)
-                elif not data_point.wattage == None:
+                elif data_point.wattage is not None:
                     self.miners[data_point.ip]["max"] = int(data_point.wattage)
                     self.miners[data_point.ip]["min"] = int(data_point.wattage)
 
@@ -183,13 +183,19 @@ class _MinerPhaseBalancer:
                 if (not miner["tune"]) and (miner["shutdown"])
             ]
         )
-        # min_other_wattage = sum([miner["min"] for miner in self.miners.values() if (not miner["tune"]) and (not miner["shutdown"])])
+        # min_other_wattage = sum(
+        #     [
+        #         miner["min"]
+        #         for miner in self.miners.values()
+        #         if (not miner["tune"]) and (not miner["shutdown"])
+        #     ]
+        # )
 
         # make sure wattage isnt set too high
         if wattage > (max_tune_wattage + max_shutdown_wattage + max_other_wattage):
             raise APIError(
                 f"Wattage setpoint is too high, setpoint: {wattage}W, max: {max_tune_wattage + max_shutdown_wattage + max_other_wattage}W"
-            )  # PhaseBalancingError(f"Wattage setpoint is too high, setpoint: {wattage}W, max: {max_tune_wattage + max_shutdown_wattage + max_other_wattage}W")
+            )
 
         # should now know wattage limits and which can be tuned/shutdown
         # check if 1/2 max of the miners which can be tuned is low enough

pyasic/miners/__init__.py

@@ -14,13 +14,7 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-import ipaddress
-from typing import Union
-
-from pyasic.miners.base import AnyMiner, BaseMiner
-from pyasic.miners.miner_factory import miner_factory
-
-
-# abstracted version of get miner that is easier to access
-async def get_miner(ip: Union[ipaddress.ip_address, str]) -> AnyMiner:
-    return await miner_factory.get_miner(ip)
+from .base import AnyMiner
+from .data import DataOptions
+from .factory import get_miner, miner_factory
+from .listener import MinerListener

pyasic/miners/antminer/bmminer/X17/S17.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerOld
-from pyasic.miners.types import S17, S17e, S17Plus, S17Pro
+from pyasic.miners.models import S17, S17e, S17Plus, S17Pro
 
 
 class BMMinerS17(AntminerOld, S17):

pyasic/miners/antminer/bmminer/X17/T17.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerOld
-from pyasic.miners.types import T17, T17e, T17Plus
+from pyasic.miners.models import T17, T17e, T17Plus
 
 
 class BMMinerT17(AntminerOld, T17):

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

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerModern
-from pyasic.miners.types import (
+from pyasic.miners.models import (
     S19,
     S19L,
     S19XP,

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

@@ -15,9 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerModern
-from pyasic.miners.types import T19
-
-# noqa - Ignore access to _module
+from pyasic.miners.models import T19
 
 
 class BMMinerT19(AntminerModern, T19):

pyasic/miners/antminer/bmminer/X3/HS3.py

@@ -15,10 +15,8 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerModern
-from pyasic.miners.types import HS3
+from pyasic.miners.models import HS3
 
 
 class BMMinerHS3(AntminerModern, HS3):
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.supports_shutdown = False
+    supports_shutdown = False

pyasic/miners/antminer/bmminer/X3/L3.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerOld
-from pyasic.miners.types import L3Plus
+from pyasic.miners.models import L3Plus
 
 
 class BMMinerL3Plus(AntminerOld, L3Plus):

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

@@ -14,10 +14,8 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 from pyasic.miners.backends import AntminerModern
-from pyasic.miners.types import L7
+from pyasic.miners.models import L7
 
 
 class BMMinerL7(AntminerModern, L7):
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.supports_shutdown = False
+    supports_shutdown = False

pyasic/miners/antminer/bmminer/X9/E9.py

@@ -15,10 +15,8 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerModern
-from pyasic.miners.types import E9Pro
+from pyasic.miners.models import E9Pro
 
 
 class BMMinerE9Pro(AntminerModern, E9Pro):
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.supports_shutdown = False
+    supports_shutdown = False

pyasic/miners/antminer/bmminer/X9/S9.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import BMMiner
-from pyasic.miners.types import S9, S9i, S9j
+from pyasic.miners.models import S9, S9i, S9j
 
 
 class BMMinerS9(BMMiner, S9):

pyasic/miners/antminer/bmminer/X9/T9.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import BMMiner
-from pyasic.miners.types import T9
+from pyasic.miners.models import T9
 
 
 class BMMinerT9(BMMiner, T9):

pyasic/miners/antminer/bosminer/X17/S17.py

@@ -14,21 +14,21 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import BOSer
-from pyasic.miners.types import S17, S17e, S17Plus, S17Pro
+from pyasic.miners.backends import BOSMiner
+from pyasic.miners.models import S17, S17e, S17Plus, S17Pro
 
 
-class BOSMinerS17(BOSer, S17):
+class BOSMinerS17(BOSMiner, S17):
     pass
 
 
-class BOSMinerS17Plus(BOSer, S17Plus):
+class BOSMinerS17Plus(BOSMiner, S17Plus):
     pass
 
 
-class BOSMinerS17Pro(BOSer, S17Pro):
+class BOSMinerS17Pro(BOSMiner, S17Pro):
     pass
 
 
-class BOSMinerS17e(BOSer, S17e):
+class BOSMinerS17e(BOSMiner, S17e):
     pass

pyasic/miners/antminer/bosminer/X17/T17.py

@@ -14,17 +14,17 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import BOSer
-from pyasic.miners.types import T17, T17e, T17Plus
+from pyasic.miners.backends import BOSMiner
+from pyasic.miners.models import T17, T17e, T17Plus
 
 
-class BOSMinerT17(BOSer, T17):
+class BOSMinerT17(BOSMiner, T17):
     pass
 
 
-class BOSMinerT17Plus(BOSer, T17Plus):
+class BOSMinerT17Plus(BOSMiner, T17Plus):
     pass
 
 
-class BOSMinerT17e(BOSer, T17e):
+class BOSMinerT17e(BOSMiner, T17e):
     pass

pyasic/miners/antminer/bosminer/X19/S19.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import BOSer
-from pyasic.miners.types import (
+from pyasic.miners.models import (
     S19,
     S19XP,
     S19a,

pyasic/miners/antminer/bosminer/X19/T19.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import BOSer
-from pyasic.miners.types import T19
+from pyasic.miners.models import T19
 
 
 class BOSMinerT19(BOSer, T19):

pyasic/miners/antminer/bosminer/X9/S9.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import BOSMiner
-from pyasic.miners.types import S9
+from pyasic.miners.models import S9
 
 
 class BOSMinerS9(BOSMiner, S9):

pyasic/miners/antminer/cgminer/X15/Z15.py

@@ -15,10 +15,8 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerOld
-from pyasic.miners.types import Z15
+from pyasic.miners.models import Z15
 
 
 class CGMinerZ15(AntminerOld, Z15):
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.supports_shutdown = False
+    supports_shutdown = False

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

@@ -14,10 +14,8 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 from pyasic.miners.backends import AntminerOld
-from pyasic.miners.types import D3
+from pyasic.miners.models import D3
 
 
 class CGMinerD3(AntminerOld, D3):
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.supports_shutdown = False
+    supports_shutdown = False

pyasic/miners/antminer/cgminer/X5/DR5.py

@@ -15,10 +15,8 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerOld
-from pyasic.miners.types import DR5
+from pyasic.miners.models import DR5
 
 
 class CGMinerDR5(AntminerOld, DR5):
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.supports_shutdown = False
+    supports_shutdown = False

pyasic/miners/antminer/epic/X19/S19.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import ePIC
-from pyasic.miners.types import S19, S19XP, S19j, S19jPro, S19jProPlus, S19kPro, S19Pro
+from pyasic.miners.models import S19, S19XP, S19j, S19jPro, S19jProPlus, S19kPro, S19Pro
 
 
 class ePICS19(ePIC, S19):

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

@@ -21,10 +21,53 @@ import asyncssh
 from pyasic.data import HashBoard
 from pyasic.errors import APIError
 from pyasic.miners.backends import Hiveon
-from pyasic.miners.types import T9
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
+from pyasic.miners.models import T9
+
+HIVEON_T9_DATA_LOC = DataLocations(
+    **{
+        str(DataOptions.API_VERSION): DataFunction(
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
+        ),
+        str(DataOptions.FW_VERSION): DataFunction(
+            "_get_fw_ver",
+            [RPCAPICommand("rpc_version", "version")],
+        ),
+        str(DataOptions.HASHRATE): DataFunction(
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
+        ),
+        str(DataOptions.EXPECTED_HASHRATE): DataFunction(
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.HASHBOARDS): DataFunction(
+            "_get_hashboards",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.ENVIRONMENT_TEMP): DataFunction(
+            "_get_env_temp",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.WATTAGE): DataFunction(
+            "_get_wattage",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.FANS): DataFunction(
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.UPTIME): DataFunction(
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+    }
+)
 
 
 class HiveonT9(Hiveon, T9):
+    data_locations = HIVEON_T9_DATA_LOC
 
     ##################################################
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
@@ -41,15 +84,15 @@ class HiveonT9(Hiveon, T9):
         except (TypeError, ValueError, asyncssh.Error, OSError, AttributeError):
             pass
 
-    async def _get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
+    async def _get_hashboards(self, rpc_stats: dict = None) -> List[HashBoard]:
         hashboards = [
             HashBoard(slot=board, expected_chips=self.expected_chips)
             for board in range(self.expected_hashboards)
         ]
 
-        if api_stats is None:
+        if rpc_stats is None:
             try:
-                api_stats = self.api.stats()
+                rpc_stats = self.rpc.stats()
             except APIError:
                 return []
 
@@ -65,8 +108,8 @@ class HiveonT9(Hiveon, T9):
             for chipset in board_map[board]:
                 if hashboards[board].chip_temp is None:
                     try:
-                        hashboards[board].temp = api_stats["STATS"][1][f"temp{chipset}"]
-                        hashboards[board].chip_temp = api_stats["STATS"][1][
+                        hashboards[board].temp = rpc_stats["STATS"][1][f"temp{chipset}"]
+                        hashboards[board].chip_temp = rpc_stats["STATS"][1][
                             f"temp2_{chipset}"
                         ]
                     except (KeyError, IndexError):
@@ -74,8 +117,8 @@ class HiveonT9(Hiveon, T9):
                     else:
                         hashboards[board].missing = False
                 try:
-                    hashrate += api_stats["STATS"][1][f"chain_rate{chipset}"]
-                    chips += api_stats["STATS"][1][f"chain_acn{chipset}"]
+                    hashrate += rpc_stats["STATS"][1][f"chain_rate{chipset}"]
+                    chips += rpc_stats["STATS"][1][f"chain_acn{chipset}"]
                 except (KeyError, IndexError):
                     pass
             hashboards[board].hashrate = round(hashrate / 1000, 2)
@@ -83,15 +126,15 @@ class HiveonT9(Hiveon, T9):
 
         return hashboards
 
-    async def _get_wattage(self, api_stats: dict = None) -> Optional[int]:
-        if not api_stats:
+    async def _get_wattage(self, rpc_stats: dict = None) -> Optional[int]:
+        if not rpc_stats:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
-            boards = api_stats.get("STATS")
+        if rpc_stats:
+            boards = rpc_stats.get("STATS")
             try:
                 wattage_raw = boards[1]["chain_power"]
             except (KeyError, IndexError):
@@ -100,23 +143,23 @@ class HiveonT9(Hiveon, T9):
                 # parse wattage position out of raw data
                 return round(float(wattage_raw.split(" ")[0]))
 
-    async def _get_env_temp(self, api_stats: dict = None) -> Optional[float]:
+    async def _get_env_temp(self, rpc_stats: dict = None) -> Optional[float]:
         env_temp_list = []
         board_map = {
             0: [2, 9, 10],
             1: [3, 11, 12],
             2: [4, 13, 14],
         }
-        if not api_stats:
+        if not rpc_stats:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
-        if api_stats:
+        if rpc_stats:
             for board in board_map.values():
                 for chipset in board:
                     try:
-                        env_temp = api_stats["STATS"][1][f"temp3_{chipset}"]
+                        env_temp = rpc_stats["STATS"][1][f"temp3_{chipset}"]
                         if not env_temp == 0:
                             env_temp_list.append(int(env_temp))
                     except (KeyError, IndexError):

pyasic/miners/antminer/luxos/X9/S9.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import LUXMiner
-from pyasic.miners.types import S9
+from pyasic.miners.models import S9
 
 
 class LUXMinerS9(LUXMiner, S9):

pyasic/miners/antminer/vnish/X17/S17.py

@@ -14,7 +14,7 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 from pyasic.miners.backends import VNish
-from pyasic.miners.types import S17Plus, S17Pro
+from pyasic.miners.models import S17Plus, S17Pro
 
 
 class VNishS17Plus(VNish, S17Plus):

pyasic/miners/antminer/vnish/X19/S19.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import VNish
-from pyasic.miners.types import (
+from pyasic.miners.models import (
     S19,
     S19XP,
     S19a,

pyasic/miners/antminer/vnish/X19/T19.py

@@ -15,7 +15,7 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import VNish
-from pyasic.miners.types import T19
+from pyasic.miners.models import T19
 
 
 class VNishT19(VNish, T19):

pyasic/miners/antminer/vnish/X3/L3.py

@@ -15,9 +15,8 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import VNish
-from pyasic.miners.types import L3Plus
+from pyasic.miners.models import L3Plus
 
 
 class VnishL3Plus(VNish, L3Plus):
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
+    pass

pyasic/miners/auradine/__init__.py

@@ -0,0 +1 @@
+from .flux import *

pyasic/miners/auradine/flux/AD/AT1.py

@@ -0,0 +1,6 @@
+from pyasic.miners.backends import Auradine
+from pyasic.miners.models import AuradineAT1500
+
+
+class AuradineFluxAT1500(AuradineAT1500, Auradine):
+    pass

pyasic/miners/auradine/flux/AD/AT2.py

@@ -0,0 +1,10 @@
+from pyasic.miners.backends import Auradine
+from pyasic.miners.models import AuradineAT2860, AuradineAT2880
+
+
+class AuradineFluxAT2860(AuradineAT2860, Auradine):
+    pass
+
+
+class AuradineFluxAT2880(AuradineAT2880, Auradine):
+    pass

pyasic/miners/auradine/flux/AD/__init__.py

@@ -0,0 +1,2 @@
+from .AT1 import AuradineFluxAT1500
+from .AT2 import AuradineFluxAT2860, AuradineFluxAT2880

pyasic/miners/auradine/flux/AI/AI2.py

@@ -0,0 +1,6 @@
+from pyasic.miners.backends import Auradine
+from pyasic.miners.models import AuradineAI2500
+
+
+class AuradineFluxAI2500(AuradineAI2500, Auradine):
+    pass

pyasic/miners/auradine/flux/AI/AI3.py

@@ -0,0 +1,6 @@
+from pyasic.miners.backends import Auradine
+from pyasic.miners.models import AuradineAI3680
+
+
+class AuradineFluxAI3680(AuradineAI3680, Auradine):
+    pass

pyasic/miners/auradine/flux/AI/__init__.py

@@ -0,0 +1,2 @@
+from .AI2 import AuradineFluxAI2500
+from .AI3 import AuradineFluxAI3680

pyasic/miners/auradine/flux/AT/AD2.py

@@ -0,0 +1,6 @@
+from pyasic.miners.backends import Auradine
+from pyasic.miners.models import AuradineAD2500
+
+
+class AuradineFluxAD2500(AuradineAD2500, Auradine):
+    pass

pyasic/miners/auradine/flux/AT/AD3.py

@@ -0,0 +1,6 @@
+from pyasic.miners.backends import Auradine
+from pyasic.miners.models import AuradineAD3500
+
+
+class AuradineFluxAD3500(AuradineAD3500, Auradine):
+    pass

pyasic/miners/auradine/flux/AT/__init__.py

@@ -0,0 +1,2 @@
+from .AD2 import AuradineFluxAD2500
+from .AD3 import AuradineFluxAD3500

pyasic/miners/auradine/flux/__init__.py

@@ -0,0 +1,3 @@
+from .AD import *
+from .AI import *
+from .AT import *

pyasic/miners/avalonminer/cgminer/A10X/A1026.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon1026
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon1026
 
 
-class CGMinerAvalon1026(CGMinerAvalon, Avalon1026):
+class CGMinerAvalon1026(AvalonMiner, Avalon1026):
     pass

pyasic/miners/avalonminer/cgminer/A10X/A1047.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon1047
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon1047
 
 
-class CGMinerAvalon1047(CGMinerAvalon, Avalon1047):
+class CGMinerAvalon1047(AvalonMiner, Avalon1047):
     pass

pyasic/miners/avalonminer/cgminer/A10X/A1066.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon1066
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon1066
 
 
-class CGMinerAvalon1066(CGMinerAvalon, Avalon1066):
+class CGMinerAvalon1066(AvalonMiner, Avalon1066):
     pass

pyasic/miners/avalonminer/cgminer/A11X/A1166.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon1166Pro
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon1166Pro
 
 
-class CGMinerAvalon1166Pro(CGMinerAvalon, Avalon1166Pro):
+class CGMinerAvalon1166Pro(AvalonMiner, Avalon1166Pro):
     pass

pyasic/miners/avalonminer/cgminer/A12X/A1246.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon1246
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon1246
 
 
-class CGMinerAvalon1246(CGMinerAvalon, Avalon1246):
+class CGMinerAvalon1246(AvalonMiner, Avalon1246):
     pass

pyasic/miners/avalonminer/cgminer/A7X/A721.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon721
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon721
 
 
-class CGMinerAvalon721(CGMinerAvalon, Avalon721):
+class CGMinerAvalon721(AvalonMiner, Avalon721):
     pass

pyasic/miners/avalonminer/cgminer/A7X/A741.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon741
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon741
 
 
-class CGMinerAvalon741(CGMinerAvalon, Avalon741):
+class CGMinerAvalon741(AvalonMiner, Avalon741):
     pass

pyasic/miners/avalonminer/cgminer/A7X/A761.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon761
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon761
 
 
-class CGMinerAvalon761(CGMinerAvalon, Avalon761):
+class CGMinerAvalon761(AvalonMiner, Avalon761):
     pass

pyasic/miners/avalonminer/cgminer/A8X/A821.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon821
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon821
 
 
-class CGMinerAvalon821(CGMinerAvalon, Avalon821):
+class CGMinerAvalon821(AvalonMiner, Avalon821):
     pass

pyasic/miners/avalonminer/cgminer/A8X/A841.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon841
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon841
 
 
-class CGMinerAvalon841(CGMinerAvalon, Avalon841):
+class CGMinerAvalon841(AvalonMiner, Avalon841):
     pass

pyasic/miners/avalonminer/cgminer/A8X/A851.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon851
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon851
 
 
-class CGMinerAvalon851(CGMinerAvalon, Avalon851):
+class CGMinerAvalon851(AvalonMiner, Avalon851):
     pass

pyasic/miners/avalonminer/cgminer/A9X/A921.py

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import CGMinerAvalon
-from pyasic.miners.types import Avalon921
+from pyasic.miners.backends import AvalonMiner
+from pyasic.miners.models import Avalon921
 
 
-class CGMinerAvalon921(CGMinerAvalon, Avalon921):
+class CGMinerAvalon921(AvalonMiner, Avalon921):
     pass

pyasic/miners/backends/__init__.py

@@ -14,15 +14,17 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 from .antminer import AntminerModern, AntminerOld
+from .auradine import Auradine
+from .avalonminer import AvalonMiner
 from .bfgminer import BFGMiner
-from .bfgminer_goldshell import BFGMinerGoldshell
 from .bmminer import BMMiner
 from .braiins_os import BOSer, BOSMiner
 from .btminer import BTMiner
 from .cgminer import CGMiner
-from .cgminer_avalon import CGMinerAvalon
 from .epic import ePIC
+from .goldshell import GoldshellMiner
 from .hiveon import Hiveon
+from .innosilicon import Innosilicon
 from .luxminer import LUXMiner
 from .vnish import VNish
 from .whatsminer import M2X, M3X, M5X, M6X

pyasic/miners/backends/antminer.py

@@ -16,78 +16,84 @@
 
 from typing import List, Optional, Union
 
-from pyasic.API import APIError
 from pyasic.config import MinerConfig, MiningModeConfig
 from pyasic.data import Fan, HashBoard
 from pyasic.data.error_codes import MinerErrorData, X19Error
+from pyasic.errors import APIError
 from pyasic.miners.backends.bmminer import BMMiner
 from pyasic.miners.backends.cgminer import CGMiner
-from pyasic.miners.base import (
+from pyasic.miners.data import (
     DataFunction,
     DataLocations,
     DataOptions,
     RPCAPICommand,
     WebAPICommand,
 )
+from pyasic.ssh.antminer import AntminerModernSSH
 from pyasic.web.antminer import AntminerModernWebAPI, AntminerOldWebAPI
 
 ANTMINER_MODERN_DATA_LOC = DataLocations(
     **{
         str(DataOptions.MAC): DataFunction(
-            "_get_mac", [WebAPICommand("web_get_system_info", "get_system_info")]
+            "_get_mac",
+            [WebAPICommand("web_get_system_info", "get_system_info")],
         ),
         str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_version", "version")]
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [RPCAPICommand("api_version", "version")]
+            "_get_fw_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.HOSTNAME): DataFunction(
-            "_get_hostname", [WebAPICommand("web_get_system_info", "get_system_info")]
+            "_get_hostname",
+            [WebAPICommand("web_get_system_info", "get_system_info")],
         ),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_summary", "summary")]
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_stats", "stats")]
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.HASHBOARDS): DataFunction("_get_hashboards"),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction("_get_env_temp"),
-        str(DataOptions.WATTAGE): DataFunction("_get_wattage"),
-        str(DataOptions.WATTAGE_LIMIT): DataFunction("_get_wattage_limit"),
         str(DataOptions.FANS): DataFunction(
-            "_get_fans", [RPCAPICommand("api_stats", "stats")]
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
         str(DataOptions.ERRORS): DataFunction(
-            "_get_errors", [WebAPICommand("web_summary", "summary")]
+            "_get_errors",
+            [WebAPICommand("web_summary", "summary")],
         ),
         str(DataOptions.FAULT_LIGHT): DataFunction(
             "_get_fault_light",
             [WebAPICommand("web_get_blink_status", "get_blink_status")],
         ),
         str(DataOptions.IS_MINING): DataFunction(
-            "_is_mining", [WebAPICommand("web_get_conf", "get_miner_conf")]
+            "_is_mining",
+            [WebAPICommand("web_get_conf", "get_miner_conf")],
         ),
         str(DataOptions.UPTIME): DataFunction(
-            "_get_uptime", [RPCAPICommand("api_stats", "stats")]
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
 
 class AntminerModern(BMMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver)
-        # interfaces
-        self.web = AntminerModernWebAPI(ip)
+    """Handler for AntMiners with the modern web interface, such as S19"""
 
-        # static data
-        # data gathering locations
-        self.data_locations = ANTMINER_MODERN_DATA_LOC
-        # autotuning/shutdown support
-        self.supports_shutdown = True
+    _web_cls = AntminerModernWebAPI
+    web: AntminerModernWebAPI
+
+    _ssh_cls = AntminerModernSSH
+    ssh: AntminerModernSSH
+
+    data_locations = ANTMINER_MODERN_DATA_LOC
+
+    supports_shutdown = True
 
     async def get_config(self) -> MinerConfig:
         data = await self.web.get_miner_conf()
@@ -141,26 +147,26 @@ class AntminerModern(BMMiner):
         return True
 
     async def _get_hostname(self, web_get_system_info: dict = None) -> Union[str, None]:
-        if not web_get_system_info:
+        if web_get_system_info is None:
             try:
                 web_get_system_info = await self.web.get_system_info()
             except APIError:
                 pass
 
-        if web_get_system_info:
+        if web_get_system_info is not None:
             try:
                 return web_get_system_info["hostname"]
             except KeyError:
                 pass
 
     async def _get_mac(self, web_get_system_info: dict = None) -> Union[str, None]:
-        if not web_get_system_info:
+        if web_get_system_info is None:
             try:
                 web_get_system_info = await self.web.get_system_info()
             except APIError:
                 pass
 
-        if web_get_system_info:
+        if web_get_system_info is not None:
             try:
                 return web_get_system_info["macaddr"]
             except KeyError:
@@ -174,14 +180,14 @@ class AntminerModern(BMMiner):
             pass
 
     async def _get_errors(self, web_summary: dict = None) -> List[MinerErrorData]:
-        if not web_summary:
+        if web_summary is None:
             try:
                 web_summary = await self.web.summary()
             except APIError:
                 pass
 
         errors = []
-        if web_summary:
+        if web_summary is not None:
             try:
                 for item in web_summary["SUMMARY"][0]["status"]:
                     try:
@@ -200,13 +206,13 @@ class AntminerModern(BMMiner):
         ]
 
         try:
-            api_stats = await self.api.send_command("stats", new_api=True)
+            rpc_stats = await self.rpc.send_command("stats", new_api=True)
         except APIError:
             return hashboards
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                for board in api_stats["STATS"][0]["chain"]:
+                for board in rpc_stats["STATS"][0]["chain"]:
                     hashboards[board["index"]].hashrate = round(
                         board["rate_real"] / 1000, 2
                     )
@@ -229,35 +235,37 @@ class AntminerModern(BMMiner):
                 pass
         return hashboards
 
-    async def _get_fault_light(self, web_get_blink_status: dict = None) -> bool:
+    async def _get_fault_light(
+        self, web_get_blink_status: dict = None
+    ) -> Optional[bool]:
         if self.light:
             return self.light
 
-        if not web_get_blink_status:
+        if web_get_blink_status is None:
             try:
                 web_get_blink_status = await self.web.get_blink_status()
             except APIError:
                 pass
 
-        if web_get_blink_status:
+        if web_get_blink_status is not None:
             try:
                 self.light = web_get_blink_status["blink"]
             except KeyError:
                 pass
         return self.light
 
-    async def _get_expected_hashrate(self, api_stats: dict = None) -> Optional[float]:
-        if not api_stats:
+    async def _get_expected_hashrate(self, rpc_stats: dict = None) -> Optional[float]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                expected_rate = api_stats["STATS"][1]["total_rateideal"]
+                expected_rate = rpc_stats["STATS"][1]["total_rateideal"]
                 try:
-                    rate_unit = api_stats["STATS"][1]["rate_unit"]
+                    rate_unit = rpc_stats["STATS"][1]["rate_unit"]
                 except KeyError:
                     rate_unit = "GH"
                 if rate_unit == "GH":
@@ -312,13 +320,13 @@ class AntminerModern(BMMiner):
         )
 
     async def _is_mining(self, web_get_conf: dict = None) -> Optional[bool]:
-        if not web_get_conf:
+        if web_get_conf is None:
             try:
                 web_get_conf = await self.web.get_miner_conf()
             except APIError:
                 pass
 
-        if web_get_conf:
+        if web_get_conf is not None:
             try:
                 if web_get_conf["bitmain-work-mode"].isdigit():
                     return (
@@ -328,73 +336,69 @@ class AntminerModern(BMMiner):
             except LookupError:
                 pass
 
-    async def _get_uptime(self, api_stats: dict = None) -> Optional[int]:
-        if not api_stats:
+    async def _get_uptime(self, rpc_stats: dict = None) -> Optional[int]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                return int(api_stats["STATS"][1]["Elapsed"])
+                return int(rpc_stats["STATS"][1]["Elapsed"])
             except LookupError:
                 pass
 
 
 ANTMINER_OLD_DATA_LOC = DataLocations(
     **{
-        str(DataOptions.MAC): DataFunction("_get_mac"),
         str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_version", "version")]
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [RPCAPICommand("api_version", "version")]
+            "_get_fw_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.HOSTNAME): DataFunction(
-            "_get_hostname", [WebAPICommand("web_get_system_info", "get_system_info")]
+            "_get_hostname",
+            [WebAPICommand("web_get_system_info", "get_system_info")],
         ),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_summary", "summary")]
-        ),
-        str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_stats", "stats")]
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.HASHBOARDS): DataFunction(
-            "_get_hashboards", [RPCAPICommand("api_stats", "stats")]
+            "_get_hashboards",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction("_get_env_temp"),
-        str(DataOptions.WATTAGE): DataFunction("_get_wattage"),
-        str(DataOptions.WATTAGE_LIMIT): DataFunction("_get_wattage_limit"),
         str(DataOptions.FANS): DataFunction(
-            "_get_fans", [RPCAPICommand("api_stats", "stats")]
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
-        str(DataOptions.ERRORS): DataFunction("_get_errors"),
         str(DataOptions.FAULT_LIGHT): DataFunction(
             "_get_fault_light",
             [WebAPICommand("web_get_blink_status", "get_blink_status")],
         ),
         str(DataOptions.IS_MINING): DataFunction(
-            "_is_mining", [WebAPICommand("web_get_conf", "get_miner_conf")]
+            "_is_mining",
+            [WebAPICommand("web_get_conf", "get_miner_conf")],
         ),
         str(DataOptions.UPTIME): DataFunction(
-            "_get_uptime", [RPCAPICommand("api_stats", "stats")]
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
 
 class AntminerOld(CGMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver)
-        # interfaces
-        self.web = AntminerOldWebAPI(ip)
+    """Handler for AntMiners with the old web interface, such as S17"""
 
-        # static data
-        # data gathering locations
-        self.data_locations = ANTMINER_OLD_DATA_LOC
+    _web_cls = AntminerOldWebAPI
+    web: AntminerOldWebAPI
+
+    data_locations = ANTMINER_OLD_DATA_LOC
 
     async def get_config(self) -> MinerConfig:
         data = await self.web.get_miner_conf()
@@ -443,17 +447,19 @@ class AntminerOld(CGMiner):
             return True
         return False
 
-    async def _get_fault_light(self, web_get_blink_status: dict = None) -> bool:
+    async def _get_fault_light(
+        self, web_get_blink_status: dict = None
+    ) -> Optional[bool]:
         if self.light:
             return self.light
 
-        if not web_get_blink_status:
+        if web_get_blink_status is None:
             try:
                 web_get_blink_status = await self.web.get_blink_status()
             except APIError:
                 pass
 
-        if web_get_blink_status:
+        if web_get_blink_status is not None:
             try:
                 self.light = web_get_blink_status["isBlinking"]
             except KeyError:
@@ -461,59 +467,59 @@ class AntminerOld(CGMiner):
         return self.light
 
     async def _get_hostname(self, web_get_system_info: dict = None) -> Optional[str]:
-        if not web_get_system_info:
+        if web_get_system_info is None:
             try:
                 web_get_system_info = await self.web.get_system_info()
             except APIError:
                 pass
 
-        if web_get_system_info:
+        if web_get_system_info is not None:
             try:
                 return web_get_system_info["hostname"]
             except KeyError:
                 pass
 
-    async def _get_fans(self, api_stats: dict = None) -> List[Fan]:
-        if not api_stats:
+    async def _get_fans(self, rpc_stats: dict = None) -> List[Fan]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
         fans_data = [Fan() for _ in range(self.expected_fans)]
-        if api_stats:
+        if rpc_stats is not None:
             try:
                 fan_offset = -1
 
                 for fan_num in range(1, 8, 4):
                     for _f_num in range(4):
-                        f = api_stats["STATS"][1].get(f"fan{fan_num + _f_num}")
+                        f = rpc_stats["STATS"][1].get(f"fan{fan_num + _f_num}")
                         if f and not f == 0 and fan_offset == -1:
                             fan_offset = fan_num + 2
                 if fan_offset == -1:
                     fan_offset = 3
 
                 for fan in range(self.expected_fans):
-                    fans_data[fan].speed = api_stats["STATS"][1].get(
+                    fans_data[fan].speed = rpc_stats["STATS"][1].get(
                         f"fan{fan_offset+fan}", 0
                     )
             except LookupError:
                 pass
         return fans_data
 
-    async def _get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
+    async def _get_hashboards(self, rpc_stats: dict = None) -> List[HashBoard]:
         hashboards = []
 
-        if not api_stats:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
                 board_offset = -1
-                boards = api_stats["STATS"]
+                boards = rpc_stats["STATS"]
                 if len(boards) > 1:
                     for board_num in range(1, 16, 5):
                         for _b_num in range(5):
@@ -556,39 +562,39 @@ class AntminerOld(CGMiner):
         return hashboards
 
     async def _is_mining(self, web_get_conf: dict = None) -> Optional[bool]:
-        if not web_get_conf:
+        if web_get_conf is None:
             try:
                 web_get_conf = await self.web.get_miner_conf()
             except APIError:
                 pass
 
-        if web_get_conf:
+        if web_get_conf is not None:
             try:
                 return False if int(web_get_conf["bitmain-work-mode"]) == 1 else True
             except LookupError:
                 pass
 
-        api_summary = None
+        rpc_summary = None
         try:
-            api_summary = await self.api.summary()
+            rpc_summary = await self.rpc.summary()
         except APIError:
             pass
 
-        if api_summary is not None:
-            if not api_summary == {}:
+        if rpc_summary is not None:
+            if not rpc_summary == {}:
                 return True
             else:
                 return False
 
-    async def _get_uptime(self, api_stats: dict = None) -> Optional[int]:
-        if not api_stats:
+    async def _get_uptime(self, rpc_stats: dict = None) -> Optional[int]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                return int(api_stats["STATS"][1]["Elapsed"])
+                return int(rpc_stats["STATS"][1]["Elapsed"])
             except LookupError:
                 pass

pyasic/miners/backends/auradine.py

@@ -0,0 +1,387 @@
+# ------------------------------------------------------------------------------
+#  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 logging
+from enum import Enum
+from typing import List, Optional
+
+from pyasic.config import MinerConfig
+from pyasic.data import Fan, HashBoard
+from pyasic.errors import APIError
+from pyasic.miners.base import BaseMiner
+from pyasic.miners.data import (
+    DataFunction,
+    DataLocations,
+    DataOptions,
+    RPCAPICommand,
+    WebAPICommand,
+)
+from pyasic.rpc.gcminer import GCMinerRPCAPI
+from pyasic.web.auradine import AuradineWebAPI
+
+AURADINE_DATA_LOC = DataLocations(
+    **{
+        str(DataOptions.MAC): DataFunction(
+            "_get_mac",
+            [WebAPICommand("web_ipreport", "ipreport")],
+        ),
+        str(DataOptions.FW_VERSION): DataFunction(
+            "_get_fw_ver",
+            [WebAPICommand("web_ipreport", "ipreport")],
+        ),
+        str(DataOptions.HOSTNAME): DataFunction(
+            "_get_hostname",
+            [WebAPICommand("web_ipreport", "ipreport")],
+        ),
+        str(DataOptions.HASHRATE): DataFunction(
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
+        ),
+        str(DataOptions.HASHBOARDS): DataFunction(
+            "_get_hashboards",
+            [
+                RPCAPICommand("rpc_devs", "devs"),
+                WebAPICommand("web_ipreport", "ipreport"),
+            ],
+        ),
+        str(DataOptions.WATTAGE): DataFunction(
+            "_get_wattage",
+            [WebAPICommand("web_psu", "psu")],
+        ),
+        str(DataOptions.WATTAGE_LIMIT): DataFunction(
+            "_get_wattage_limit",
+            [WebAPICommand("web_mode", "mode"), WebAPICommand("web_psu", "psu")],
+        ),
+        str(DataOptions.FANS): DataFunction(
+            "_get_fans",
+            [WebAPICommand("web_fan", "fan")],
+        ),
+        str(DataOptions.FAULT_LIGHT): DataFunction(
+            "_get_fault_light",
+            [WebAPICommand("web_led", "led")],
+        ),
+        str(DataOptions.IS_MINING): DataFunction(
+            "_is_mining",
+            [WebAPICommand("web_mode", "mode")],
+        ),
+        str(DataOptions.UPTIME): DataFunction(
+            "_get_uptime",
+            [RPCAPICommand("rpc_summary", "summary")],
+        ),
+    }
+)
+
+
+class AuradineLEDColors(Enum):
+    OFF = 0
+    GREEN = 1
+    RED = 2
+    YELLOW = 3
+    GREEN_FLASHING = 4
+    RED_FLASHING = 5
+    YELLOW_FLASHING = 6
+
+    def __int__(self):
+        return self.value
+
+
+class AuradineLEDCodes(Enum):
+    NO_POWER = 1
+    NORMAL = 2
+    LOCATE_MINER = 3
+    TEMPERATURE = 4
+    POOL_CONFIG = 5
+    NETWORK = 6
+    CONTROL_BOARD = 7
+    HASH_RATE_LOW = 8
+    CUSTOM1 = 101
+    CUSTOM2 = 102
+
+    def __int__(self):
+        return self.value
+
+
+class Auradine(BaseMiner):
+    """Base handler for Auradine miners"""
+
+    _rpc_cls = GCMinerRPCAPI
+    rpc: GCMinerRPCAPI
+    _web_cls = AuradineWebAPI
+    web: AuradineWebAPI
+
+    data_locations = AURADINE_DATA_LOC
+
+    supports_shutdown = True
+    supports_autotuning = True
+
+    async def fault_light_on(self) -> bool:
+        try:
+            await self.web.set_led(code=int(AuradineLEDCodes.LOCATE_MINER))
+            return True
+        except APIError:
+            return False
+
+    async def fault_light_off(self) -> bool:
+        try:
+            await self.web.set_led(code=int(AuradineLEDCodes.NORMAL))
+            return True
+        except APIError:
+            return False
+
+    async def reboot(self) -> bool:
+        try:
+            await self.web.reboot()
+        except APIError:
+            return False
+        return True
+
+    async def restart_backend(self) -> bool:
+        try:
+            await self.web.restart_gcminer()
+        except APIError:
+            return False
+        return True
+
+    async def stop_mining(self) -> bool:
+        try:
+            await self.web.set_mode(sleep="on")
+        except APIError:
+            return False
+        return True
+
+    async def resume_mining(self) -> bool:
+        try:
+            await self.web.set_mode(sleep="off")
+        except APIError:
+            return False
+        return True
+
+    async def set_power_limit(self, wattage: int) -> bool:
+        try:
+            await self.web.set_mode(mode="custom", tune="power", power=wattage)
+        except APIError:
+            return False
+        return True
+
+    async def get_config(self) -> MinerConfig:
+        try:
+            web_conf = await self.web.multicommand("pools", "mode", "fan")
+            return MinerConfig.from_auradine(web_conf=web_conf)
+        except APIError as e:
+            logging.warning(e)
+        except LookupError:
+            pass
+        return MinerConfig()
+
+    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
+        self.config = config
+
+        conf = config.as_auradine(user_suffix=user_suffix)
+        for key in conf.keys():
+            await self.web.send_command(command=key, **conf[key])
+
+    ##################################################
+    ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
+    ##################################################
+
+    async def _get_mac(self, web_ipreport: dict = None) -> Optional[str]:
+        if web_ipreport is None:
+            try:
+                web_ipreport = await self.web.ipreport()
+            except APIError:
+                pass
+
+        if web_ipreport is not None:
+            try:
+                return web_ipreport["IPReport"][0]["mac"].upper()
+            except (LookupError, AttributeError):
+                pass
+
+    async def _get_fw_ver(self, web_ipreport: dict = None) -> Optional[str]:
+        if web_ipreport is None:
+            try:
+                web_ipreport = await self.web.ipreport()
+            except APIError:
+                pass
+
+        if web_ipreport is not None:
+            try:
+                return web_ipreport["IPReport"][0]["version"]
+            except LookupError:
+                pass
+
+    async def _get_hostname(self, web_ipreport: dict = None) -> Optional[str]:
+        if web_ipreport is None:
+            try:
+                web_ipreport = await self.web.ipreport()
+            except APIError:
+                pass
+
+        if web_ipreport is not None:
+            try:
+                return web_ipreport["IPReport"][0]["hostname"]
+            except LookupError:
+                pass
+
+    async def _get_hashrate(self, rpc_summary: dict = None) -> Optional[float]:
+        if rpc_summary is None:
+            try:
+                rpc_summary = await self.rpc.summary()
+            except APIError:
+                pass
+
+        if rpc_summary is not None:
+            try:
+                return round(
+                    float(float(rpc_summary["SUMMARY"][0]["MHS 5s"]) / 1000000), 2
+                )
+            except (LookupError, ValueError, TypeError):
+                pass
+
+    async def _get_hashboards(
+        self, rpc_devs: dict = None, web_ipreport: dict = None
+    ) -> List[HashBoard]:
+        hashboards = [
+            HashBoard(slot=i, expected_chips=self.expected_chips)
+            for i in range(self.expected_hashboards)
+        ]
+
+        if rpc_devs is None:
+            try:
+                rpc_devs = await self.rpc.devs()
+            except APIError:
+                pass
+        if web_ipreport is None:
+            try:
+                web_ipreport = await self.web.ipreport()
+            except APIError:
+                pass
+
+        if rpc_devs is not None:
+            try:
+                for board in rpc_devs["DEVS"]:
+                    b_id = board["ID"] - 1
+                    hashboards[b_id].hashrate = round(
+                        float(float(board["MHS 5s"]) / 1000000), 2
+                    )
+                    hashboards[b_id].temp = round(float(float(board["Temperature"])), 2)
+                    hashboards[b_id].missing = False
+            except LookupError:
+                pass
+
+        if web_ipreport is not None:
+            try:
+                for board, sn in enumerate(web_ipreport["IPReport"][0]["HBSerialNo"]):
+                    hashboards[board].serial_number = sn
+                    hashboards[board].missing = False
+            except LookupError:
+                pass
+
+        return hashboards
+
+    async def _get_wattage(self, web_psu: dict = None) -> Optional[int]:
+        if web_psu is None:
+            try:
+                web_psu = await self.web.get_psu()
+            except APIError:
+                pass
+
+        if web_psu is not None:
+            try:
+                return int(float(web_psu["PSU"][0]["PowerIn"].replace("W", "")))
+            except (LookupError, TypeError, ValueError):
+                pass
+
+    async def _get_wattage_limit(
+        self, web_mode: dict = None, web_psu: dict = None
+    ) -> Optional[int]:
+        if web_mode is None:
+            try:
+                web_mode = await self.web.get_mode()
+            except APIError:
+                pass
+
+        if web_mode is not None:
+            try:
+                return web_mode["Mode"][0]["Power"]
+            except (LookupError, TypeError, ValueError):
+                pass
+
+        if web_psu is None:
+            try:
+                web_psu = await self.web.get_psu()
+            except APIError:
+                pass
+
+        if web_psu is not None:
+            try:
+                return int(float(web_psu["PSU"][0]["PoutMax"].replace("W", "")))
+            except (LookupError, TypeError, ValueError):
+                pass
+
+    async def _get_fans(self, web_fan: dict = None) -> List[Fan]:
+        if web_fan is None:
+            try:
+                web_fan = await self.web.get_fan()
+            except APIError:
+                pass
+
+        fans = []
+        if web_fan is not None:
+            try:
+                for fan in web_fan["Fan"]:
+                    fans.append(Fan(round(fan["Speed"])))
+            except LookupError:
+                pass
+        return fans
+
+    async def _get_fault_light(self, web_led: dict = None) -> Optional[bool]:
+        if web_led is None:
+            try:
+                web_led = await self.web.get_led()
+            except APIError:
+                pass
+
+        if web_led is not None:
+            try:
+                return web_led["LED"][0]["Code"] == int(AuradineLEDCodes.LOCATE_MINER)
+            except LookupError:
+                pass
+
+    async def _is_mining(self, web_mode: dict = None) -> Optional[bool]:
+        if web_mode is None:
+            try:
+                web_mode = await self.web.get_mode()
+            except APIError:
+                pass
+
+        if web_mode is not None:
+            try:
+                return web_mode["Mode"][0]["Sleep"] == "off"
+            except (LookupError, TypeError, ValueError):
+                pass
+
+    async def _get_uptime(self, rpc_summary: dict = None) -> Optional[int]:
+        if rpc_summary is None:
+            try:
+                rpc_summary = await self.rpc.summary()
+            except APIError:
+                pass
+
+        if rpc_summary is not None:
+            try:
+                return rpc_summary["SUMMARY"][0]["Elapsed"]
+            except LookupError:
+                pass

pyasic/miners/backends/avalonminer.py

@@ -17,66 +17,69 @@
 import re
 from typing import List, Optional
 
-from pyasic.config import MinerConfig
 from pyasic.data import Fan, HashBoard
-from pyasic.data.error_codes import MinerErrorData
 from pyasic.errors import APIError
-from pyasic.miners.backends import CGMiner
-from pyasic.miners.base import DataFunction, DataLocations, DataOptions, RPCAPICommand
+from pyasic.miners.backends.cgminer import CGMiner
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
 
 AVALON_DATA_LOC = DataLocations(
     **{
         str(DataOptions.MAC): DataFunction(
-            "_get_mac", [RPCAPICommand("api_version", "version")]
+            "_get_mac",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_version", "version")]
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [RPCAPICommand("api_version", "version")]
+            "_get_fw_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
-        str(DataOptions.HOSTNAME): DataFunction("_get_hostname"),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_devs", "devs")]
+            "_get_hashrate",
+            [RPCAPICommand("rpc_devs", "devs")],
         ),
         str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_stats", "stats")]
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
         str(DataOptions.HASHBOARDS): DataFunction(
-            "_get_hashboards", [RPCAPICommand("api_stats", "stats")]
+            "_get_hashboards",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
         str(DataOptions.ENVIRONMENT_TEMP): DataFunction(
-            "_get_env_temp", [RPCAPICommand("api_stats", "stats")]
+            "_get_env_temp",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.WATTAGE): DataFunction("_get_wattage"),
         str(DataOptions.WATTAGE_LIMIT): DataFunction(
-            "_get_wattage_limit", [RPCAPICommand("api_stats", "stats")]
+            "_get_wattage_limit",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
         str(DataOptions.FANS): DataFunction(
-            "_get_fans", [RPCAPICommand("api_stats", "stats")]
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
-        str(DataOptions.ERRORS): DataFunction("_get_errors"),
         str(DataOptions.FAULT_LIGHT): DataFunction(
-            "_get_fault_light", [RPCAPICommand("api_stats", "stats")]
+            "_get_fault_light",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.UPTIME): DataFunction(
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.IS_MINING): DataFunction("_is_mining"),
-        str(DataOptions.UPTIME): DataFunction("_get_uptime"),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
 
-class CGMinerAvalon(CGMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver)
+class AvalonMiner(CGMiner):
+    """Handler for Avalon Miners"""
 
-        # data gathering locations
-        self.data_locations = AVALON_DATA_LOC
+    data_locations = AVALON_DATA_LOC
 
     async def fault_light_on(self) -> bool:
         try:
-            data = await self.api.ascset(0, "led", "1-1")
+            data = await self.rpc.ascset(0, "led", "1-1")
         except APIError:
             return False
         if data["STATUS"][0]["Msg"] == "ASC 0 set OK":
@@ -85,7 +88,7 @@ class CGMinerAvalon(CGMiner):
 
     async def fault_light_off(self) -> bool:
         try:
-            data = await self.api.ascset(0, "led", "1-0")
+            data = await self.rpc.ascset(0, "led", "1-0")
         except APIError:
             return False
         if data["STATUS"][0]["Msg"] == "ASC 0 set OK":
@@ -94,7 +97,7 @@ class CGMinerAvalon(CGMiner):
 
     async def reboot(self) -> bool:
         try:
-            data = await self.api.restart()
+            data = await self.rpc.restart()
         except APIError:
             return False
 
@@ -105,26 +108,6 @@ class CGMinerAvalon(CGMiner):
             return False
         return False
 
-    async def stop_mining(self) -> bool:
-        return False
-
-    async def resume_mining(self) -> bool:
-        return False
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        pass
-        # self.config = config
-        # return None
-        # logging.debug(f"{self}: Sending config.")  # noqa - This doesnt work...
-        # conf = config.as_avalon(user_suffix=user_suffix)
-        # try:
-        #     data = await self.api.ascset(  # noqa
-        #         0, "setpool", f"root,root,{conf}"
-        #     )  # this should work but doesn't
-        # except APIError:
-        #     pass
-        # return data
-
     @staticmethod
     def parse_stats(stats):
         _stats_items = re.findall(".+?\\[*?]", stats)
@@ -142,9 +125,9 @@ class CGMinerAvalon(CGMiner):
                     # --avalon args
                     for arg_item in data_list:
                         item_data = arg_item[0].split(" ")
-                        for idx in range(len(item_data)):
+                        for idx, val in enumerate(item_data):
                             if idx % 2 == 0 or idx == 0:
-                                data_dict[item_data[idx]] = item_data[idx + 1]
+                                data_dict[val] = item_data[idx + 1]
 
                 raw_data = [data[0].strip(), data_dict]
             else:
@@ -172,16 +155,16 @@ class CGMinerAvalon(CGMiner):
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
     ##################################################
 
-    async def _get_mac(self, api_version: dict = None) -> Optional[str]:
-        if not api_version:
+    async def _get_mac(self, rpc_version: dict = None) -> Optional[str]:
+        if rpc_version is None:
             try:
-                api_version = await self.api.version()
+                rpc_version = await self.rpc.version()
             except APIError:
                 pass
 
-        if api_version:
+        if rpc_version is not None:
             try:
-                base_mac = api_version["VERSION"][0]["MAC"]
+                base_mac = rpc_version["VERSION"][0]["MAC"]
                 base_mac = base_mac.upper()
                 mac = ":".join(
                     [base_mac[i : (i + 2)] for i in range(0, len(base_mac), 2)]
@@ -190,42 +173,34 @@ class CGMinerAvalon(CGMiner):
             except (KeyError, ValueError):
                 pass
 
-    async def _get_hostname(self) -> Optional[str]:
-        return None
-        # if not mac:
-        #     mac = await self.get_mac()
-        #
-        # if mac:
-        #     return f"Avalon{mac.replace(':', '')[-6:]}"
-
-    async def _get_hashrate(self, api_devs: dict = None) -> Optional[float]:
-        if not api_devs:
+    async def _get_hashrate(self, rpc_devs: dict = None) -> Optional[float]:
+        if rpc_devs is None:
             try:
-                api_devs = await self.api.devs()
+                rpc_devs = await self.rpc.devs()
             except APIError:
                 pass
 
-        if api_devs:
+        if rpc_devs is not None:
             try:
-                return round(float(api_devs["DEVS"][0]["MHS 1m"] / 1000000), 2)
+                return round(float(rpc_devs["DEVS"][0]["MHS 1m"] / 1000000), 2)
             except (KeyError, IndexError, ValueError, TypeError):
                 pass
 
-    async def _get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
+    async def _get_hashboards(self, rpc_stats: dict = None) -> List[HashBoard]:
         hashboards = [
             HashBoard(slot=i, expected_chips=self.expected_chips)
             for i in range(self.expected_hashboards)
         ]
 
-        if not api_stats:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                unparsed_stats = api_stats["STATS"][0]["MM ID0"]
+                unparsed_stats = rpc_stats["STATS"][0]["MM ID0"]
                 parsed_stats = self.parse_stats(unparsed_stats)
             except (IndexError, KeyError, ValueError, TypeError):
                 return hashboards
@@ -259,65 +234,62 @@ class CGMinerAvalon(CGMiner):
 
         return hashboards
 
-    async def _get_expected_hashrate(self, api_stats: dict = None) -> Optional[float]:
-        if not api_stats:
+    async def _get_expected_hashrate(self, rpc_stats: dict = None) -> Optional[float]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                unparsed_stats = api_stats["STATS"][0]["MM ID0"]
+                unparsed_stats = rpc_stats["STATS"][0]["MM ID0"]
                 parsed_stats = self.parse_stats(unparsed_stats)
                 return round(float(parsed_stats["GHSmm"]) / 1000, 2)
             except (IndexError, KeyError, ValueError, TypeError):
                 pass
 
-    async def _get_env_temp(self, api_stats: dict = None) -> Optional[float]:
-        if not api_stats:
+    async def _get_env_temp(self, rpc_stats: dict = None) -> Optional[float]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                unparsed_stats = api_stats["STATS"][0]["MM ID0"]
+                unparsed_stats = rpc_stats["STATS"][0]["MM ID0"]
                 parsed_stats = self.parse_stats(unparsed_stats)
                 return float(parsed_stats["Temp"])
             except (IndexError, KeyError, ValueError, TypeError):
                 pass
 
-    async def _get_wattage(self) -> Optional[int]:
-        return None
-
-    async def _get_wattage_limit(self, api_stats: dict = None) -> Optional[int]:
-        if not api_stats:
+    async def _get_wattage_limit(self, rpc_stats: dict = None) -> Optional[int]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                unparsed_stats = api_stats["STATS"][0]["MM ID0"]
+                unparsed_stats = rpc_stats["STATS"][0]["MM ID0"]
                 parsed_stats = self.parse_stats(unparsed_stats)
                 return int(parsed_stats["MPO"])
             except (IndexError, KeyError, ValueError, TypeError):
                 pass
 
-    async def _get_fans(self, api_stats: dict = None) -> List[Fan]:
-        if not api_stats:
+    async def _get_fans(self, rpc_stats: dict = None) -> List[Fan]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
         fans_data = [Fan() for _ in range(self.expected_fans)]
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                unparsed_stats = api_stats["STATS"][0]["MM ID0"]
+                unparsed_stats = rpc_stats["STATS"][0]["MM ID0"]
                 parsed_stats = self.parse_stats(unparsed_stats)
             except LookupError:
                 return fans_data
@@ -329,21 +301,18 @@ class CGMinerAvalon(CGMiner):
                     pass
         return fans_data
 
-    async def _get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def _get_fault_light(self, api_stats: dict = None) -> bool:  # noqa
+    async def _get_fault_light(self, rpc_stats: dict = None) -> Optional[bool]:
         if self.light:
             return self.light
-        if not api_stats:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                unparsed_stats = api_stats["STATS"][0]["MM ID0"]
+                unparsed_stats = rpc_stats["STATS"][0]["MM ID0"]
                 parsed_stats = self.parse_stats(unparsed_stats)
                 led = int(parsed_stats["Led"])
                 return True if led == 1 else False
@@ -351,7 +320,7 @@ class CGMinerAvalon(CGMiner):
                 pass
 
         try:
-            data = await self.api.ascset(0, "led", "1-255")
+            data = await self.rpc.ascset(0, "led", "1-255")
         except APIError:
             return False
         try:
@@ -360,9 +329,3 @@ class CGMinerAvalon(CGMiner):
         except LookupError:
             pass
         return False
-
-    async def _is_mining(self, *args, **kwargs) -> Optional[bool]:
-        return None
-
-    async def _get_uptime(self) -> Optional[int]:
-        return None

pyasic/miners/backends/bfgminer.py

@@ -16,50 +16,39 @@
 
 from typing import List, Optional
 
-from pyasic.API.bfgminer import BFGMinerAPI
 from pyasic.config import MinerConfig
 from pyasic.data import Fan, HashBoard
-from pyasic.data.error_codes import MinerErrorData
 from pyasic.errors import APIError
-from pyasic.miners.base import (
-    BaseMiner,
-    DataFunction,
-    DataLocations,
-    DataOptions,
-    RPCAPICommand,
-)
+from pyasic.miners.base import BaseMiner
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
+from pyasic.rpc.bfgminer import BFGMinerRPCAPI
 
 BFGMINER_DATA_LOC = DataLocations(
     **{
-        str(DataOptions.MAC): DataFunction("_get_mac"),
         str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_version", "version")]
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [RPCAPICommand("api_version", "version")]
+            "_get_fw_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
-        str(DataOptions.HOSTNAME): DataFunction("_get_hostname"),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_summary", "summary")]
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_stats", "stats")]
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
         str(DataOptions.HASHBOARDS): DataFunction(
-            "_get_hashboards", [RPCAPICommand("api_stats", "stats")]
+            "_get_hashboards",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction("_get_env_temp"),
-        str(DataOptions.WATTAGE): DataFunction("_get_wattage"),
-        str(DataOptions.WATTAGE_LIMIT): DataFunction("_get_wattage_limit"),
         str(DataOptions.FANS): DataFunction(
-            "_get_fans", [RPCAPICommand("api_stats", "stats")]
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
-        str(DataOptions.ERRORS): DataFunction("_get_errors"),
-        str(DataOptions.FAULT_LIGHT): DataFunction("_get_fault_light"),
-        str(DataOptions.IS_MINING): DataFunction("_is_mining"),
-        str(DataOptions.UPTIME): DataFunction("_get_uptime"),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
@@ -67,123 +56,82 @@ BFGMINER_DATA_LOC = DataLocations(
 class BFGMiner(BaseMiner):
     """Base handler for BFGMiner based miners."""
 
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip)
-        # interfaces
-        self.api = BFGMinerAPI(ip, api_ver)
+    _rpc_cls = BFGMinerRPCAPI
+    rpc: BFGMinerRPCAPI
 
-        # static data
-        self.api_type = "BFGMiner"
-        # data gathering locations
-        self.data_locations = BFGMINER_DATA_LOC
-
-        # data storage
-        self.api_ver = api_ver
+    data_locations = BFGMINER_DATA_LOC
 
     async def get_config(self) -> MinerConfig:
         # get pool data
         try:
-            pools = await self.api.pools()
+            pools = await self.rpc.pools()
         except APIError:
             return self.config
 
         self.config = MinerConfig.from_api(pools)
         return self.config
 
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        return None
-
-    async def fault_light_off(self) -> bool:
-        return False
-
-    async def fault_light_on(self) -> bool:
-        return False
-
-    async def restart_backend(self) -> bool:
-        return False
-
-    async def stop_mining(self) -> bool:
-        return False
-
-    async def resume_mining(self) -> bool:
-        return False
-
-    async def set_power_limit(self, wattage: int) -> bool:
-        return False
-
     ##################################################
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
     ##################################################
 
-    async def _get_mac(self) -> Optional[str]:
-        return None
-
-    async def _get_api_ver(self, api_version: dict = None) -> Optional[str]:
-        if not api_version:
+    async def _get_api_ver(self, rpc_version: dict = None) -> Optional[str]:
+        if rpc_version is None:
             try:
-                api_version = await self.api.version()
+                rpc_version = await self.rpc.version()
             except APIError:
                 pass
 
-        if api_version:
+        if rpc_version is not None:
             try:
-                self.api_ver = api_version["VERSION"][0]["API"]
+                self.api_ver = rpc_version["VERSION"][0]["API"]
             except LookupError:
                 pass
 
         return self.api_ver
 
-    async def _get_fw_ver(self, api_version: dict = None) -> Optional[str]:
-        if not api_version:
+    async def _get_fw_ver(self, rpc_version: dict = None) -> Optional[str]:
+        if rpc_version is None:
             try:
-                api_version = await self.api.version()
+                rpc_version = await self.rpc.version()
             except APIError:
                 pass
 
-        if api_version:
+        if rpc_version is not None:
             try:
-                self.fw_ver = api_version["VERSION"][0]["CompileTime"]
+                self.fw_ver = rpc_version["VERSION"][0]["CompileTime"]
             except LookupError:
                 pass
 
         return self.fw_ver
 
-    async def reboot(self) -> bool:
-        return False
-
-    async def _get_fan_psu(self):
-        return None
-
-    async def _get_hostname(self) -> Optional[str]:
-        return None
-
-    async def _get_hashrate(self, api_summary: dict = None) -> Optional[float]:
+    async def _get_hashrate(self, rpc_summary: dict = None) -> Optional[float]:
         # get hr from API
-        if not api_summary:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                return round(float(api_summary["SUMMARY"][0]["MHS 20s"] / 1000000), 2)
+                return round(float(rpc_summary["SUMMARY"][0]["MHS 20s"] / 1000000), 2)
             except (LookupError, ValueError, TypeError):
                 pass
 
-    async def _get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
+    async def _get_hashboards(self, rpc_stats: dict = None) -> List[HashBoard]:
         hashboards = []
 
-        if not api_stats:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
                 board_offset = -1
-                boards = api_stats["STATS"]
+                boards = rpc_stats["STATS"]
                 if len(boards) > 1:
                     for board_num in range(1, 16, 5):
                         for _b_num in range(5):
@@ -225,37 +173,28 @@ class BFGMiner(BaseMiner):
 
         return hashboards
 
-    async def _get_env_temp(self) -> Optional[float]:
-        return None
-
-    async def _get_wattage(self) -> Optional[int]:
-        return None
-
-    async def _get_wattage_limit(self) -> Optional[int]:
-        return None
-
-    async def _get_fans(self, api_stats: dict = None) -> List[Fan]:
-        if not api_stats:
+    async def _get_fans(self, rpc_stats: dict = None) -> List[Fan]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
         fans_data = [None, None, None, None]
-        if api_stats:
+        if rpc_stats is not None:
             try:
                 fan_offset = -1
 
                 for fan_num in range(0, 8, 4):
                     for _f_num in range(4):
-                        f = api_stats["STATS"][1].get(f"fan{fan_num + _f_num}", 0)
+                        f = rpc_stats["STATS"][1].get(f"fan{fan_num + _f_num}", 0)
                         if not f == 0 and fan_offset == -1:
                             fan_offset = fan_num
                 if fan_offset == -1:
                     fan_offset = 1
 
                 for fan in range(self.expected_fans):
-                    fans_data[fan] = api_stats["STATS"][1].get(
+                    fans_data[fan] = rpc_stats["STATS"][1].get(
                         f"fan{fan_offset+fan}", 0
                     )
             except LookupError:
@@ -264,25 +203,19 @@ class BFGMiner(BaseMiner):
 
         return fans
 
-    async def _get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def _get_fault_light(self) -> bool:
-        return False
-
-    async def _get_expected_hashrate(self, api_stats: dict = None) -> Optional[float]:
+    async def _get_expected_hashrate(self, rpc_stats: dict = None) -> Optional[float]:
         # X19 method, not sure compatibility
-        if not api_stats:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                expected_rate = api_stats["STATS"][1]["total_rateideal"]
+                expected_rate = rpc_stats["STATS"][1]["total_rateideal"]
                 try:
-                    rate_unit = api_stats["STATS"][1]["rate_unit"]
+                    rate_unit = rpc_stats["STATS"][1]["rate_unit"]
                 except KeyError:
                     rate_unit = "GH"
                 if rate_unit == "GH":
@@ -293,9 +226,3 @@ class BFGMiner(BaseMiner):
                     return round(expected_rate, 2)
             except LookupError:
                 pass
-
-    async def _is_mining(self, *args, **kwargs) -> Optional[bool]:
-        return None
-
-    async def _get_uptime(self, *args, **kwargs) -> Optional[int]:
-        return None

pyasic/miners/backends/bmminer.py

@@ -14,55 +14,45 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-import logging
 from typing import List, Optional
 
-from pyasic.API.bmminer import BMMinerAPI
 from pyasic.config import MinerConfig
 from pyasic.data import Fan, HashBoard
-from pyasic.data.error_codes import MinerErrorData
 from pyasic.errors import APIError
-from pyasic.miners.base import (
-    BaseMiner,
-    DataFunction,
-    DataLocations,
-    DataOptions,
-    RPCAPICommand,
-)
+from pyasic.miners.base import BaseMiner
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
+from pyasic.rpc.bmminer import BMMinerRPCAPI
 
 BMMINER_DATA_LOC = DataLocations(
     **{
-        str(DataOptions.MAC): DataFunction("_get_mac"),
         str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_version", "version")]
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [RPCAPICommand("api_version", "version")]
+            "_get_fw_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
-        str(DataOptions.HOSTNAME): DataFunction("_get_hostname"),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_summary", "summary")]
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_stats", "stats")]
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
         str(DataOptions.HASHBOARDS): DataFunction(
-            "_get_hashboards", [RPCAPICommand("api_stats", "stats")]
+            "_get_hashboards",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction("_get_env_temp"),
-        str(DataOptions.WATTAGE): DataFunction("_get_wattage"),
-        str(DataOptions.WATTAGE_LIMIT): DataFunction("_get_wattage_limit"),
         str(DataOptions.FANS): DataFunction(
-            "_get_fans", [RPCAPICommand("api_stats", "stats")]
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
-        str(DataOptions.ERRORS): DataFunction("_get_errors"),
-        str(DataOptions.FAULT_LIGHT): DataFunction("_get_fault_light"),
-        str(DataOptions.IS_MINING): DataFunction("_is_mining"),
         str(DataOptions.UPTIME): DataFunction(
-            "_get_uptime", [RPCAPICommand("api_stats", "stats")]
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
@@ -70,157 +60,82 @@ BMMINER_DATA_LOC = DataLocations(
 class BMMiner(BaseMiner):
     """Base handler for BMMiner based miners."""
 
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip)
-        # interfaces
-        self.api = BMMinerAPI(ip, api_ver)
+    _rpc_cls = BMMinerRPCAPI
+    rpc: BMMinerRPCAPI
 
-        # static data
-        self.api_type = "BMMiner"
-        # data gathering locations
-        self.data_locations = BMMINER_DATA_LOC
-
-        # data storage
-        self.api_ver = api_ver
-
-    async def send_ssh_command(self, cmd: str) -> Optional[str]:
-        result = None
-
-        try:
-            conn = await self._get_ssh_connection()
-        except ConnectionError:
-            return None
-
-        # open an ssh connection
-        async with conn:
-            # 3 retries
-            for i in range(3):
-                try:
-                    # run the command and get the result
-                    result = await conn.run(cmd)
-                    result = result.stdout
-
-                except Exception as e:
-                    # if the command fails, log it
-                    logging.warning(f"{self} command {cmd} error: {e}")
-
-                    # on the 3rd retry, return None
-                    if i == 3:
-                        return
-                    continue
-        # return the result, either command output or None
-        return result
+    data_locations = BMMINER_DATA_LOC
 
     async def get_config(self) -> MinerConfig:
         # get pool data
         try:
-            pools = await self.api.pools()
+            pools = await self.rpc.pools()
         except APIError:
             return self.config
 
         self.config = MinerConfig.from_api(pools)
         return self.config
 
-    async def reboot(self) -> bool:
-        logging.debug(f"{self}: Sending reboot command.")
-        ret = await self.send_ssh_command("reboot")
-        logging.debug(f"{self}: Reboot command completed.")
-        if ret is None:
-            return False
-        return True
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        return None
-
-    async def fault_light_off(self) -> bool:
-        return False
-
-    async def fault_light_on(self) -> bool:
-        return False
-
-    async def restart_backend(self) -> bool:
-        return False
-
-    async def stop_mining(self) -> bool:
-        return False
-
-    async def resume_mining(self) -> bool:
-        return False
-
-    async def set_power_limit(self, wattage: int) -> bool:
-        return False
-
     ##################################################
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
     ##################################################
 
-    async def _get_mac(self) -> Optional[str]:
-        return None
-
-    async def _get_api_ver(self, api_version: dict = None) -> Optional[str]:
-        if not api_version:
+    async def _get_api_ver(self, rpc_version: dict = None) -> Optional[str]:
+        if rpc_version is None:
             try:
-                api_version = await self.api.version()
+                rpc_version = await self.rpc.version()
             except APIError:
                 pass
 
-        if api_version:
+        if rpc_version is not None:
             try:
-                self.api_ver = api_version["VERSION"][0]["API"]
+                self.api_ver = rpc_version["VERSION"][0]["API"]
             except LookupError:
                 pass
 
         return self.api_ver
 
-    async def _get_fw_ver(self, api_version: dict = None) -> Optional[str]:
-        if not api_version:
+    async def _get_fw_ver(self, rpc_version: dict = None) -> Optional[str]:
+        if rpc_version is None:
             try:
-                api_version = await self.api.version()
+                rpc_version = await self.rpc.version()
             except APIError:
                 pass
 
-        if api_version:
+        if rpc_version is not None:
             try:
-                self.fw_ver = api_version["VERSION"][0]["CompileTime"]
+                self.fw_ver = rpc_version["VERSION"][0]["CompileTime"]
             except LookupError:
                 pass
 
         return self.fw_ver
 
-    async def _get_fan_psu(self):
-        return None
-
-    async def _get_hostname(self) -> Optional[str]:
-        hn = await self.send_ssh_command("cat /proc/sys/kernel/hostname")
-        return hn
-
-    async def _get_hashrate(self, api_summary: dict = None) -> Optional[float]:
+    async def _get_hashrate(self, rpc_summary: dict = None) -> Optional[float]:
         # get hr from API
-        if not api_summary:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                return round(float(api_summary["SUMMARY"][0]["GHS 5s"] / 1000), 2)
+                return round(float(rpc_summary["SUMMARY"][0]["GHS 5s"] / 1000), 2)
             except (LookupError, ValueError, TypeError):
                 pass
 
-    async def _get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
+    async def _get_hashboards(self, rpc_stats: dict = None) -> List[HashBoard]:
         hashboards = []
 
-        if not api_stats:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
                 board_offset = -1
-                boards = api_stats["STATS"]
+                boards = rpc_stats["STATS"]
                 if len(boards) > 1:
                     for board_num in range(1, 16, 5):
                         for _b_num in range(5):
@@ -275,37 +190,28 @@ class BMMiner(BaseMiner):
 
         return hashboards
 
-    async def _get_env_temp(self) -> Optional[float]:
-        return None
-
-    async def _get_wattage(self) -> Optional[int]:
-        return None
-
-    async def _get_wattage_limit(self) -> Optional[int]:
-        return None
-
-    async def _get_fans(self, api_stats: dict = None) -> List[Fan]:
-        if not api_stats:
+    async def _get_fans(self, rpc_stats: dict = None) -> List[Fan]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
         fans = [Fan() for _ in range(self.expected_fans)]
-        if api_stats:
+        if rpc_stats is not None:
             try:
                 fan_offset = -1
 
                 for fan_num in range(1, 8, 4):
                     for _f_num in range(4):
-                        f = api_stats["STATS"][1].get(f"fan{fan_num + _f_num}", 0)
+                        f = rpc_stats["STATS"][1].get(f"fan{fan_num + _f_num}", 0)
                         if f and not f == 0 and fan_offset == -1:
                             fan_offset = fan_num
                 if fan_offset == -1:
                     fan_offset = 1
 
                 for fan in range(self.expected_fans):
-                    fans[fan].speed = api_stats["STATS"][1].get(
+                    fans[fan].speed = rpc_stats["STATS"][1].get(
                         f"fan{fan_offset+fan}", 0
                     )
             except LookupError:
@@ -313,25 +219,19 @@ class BMMiner(BaseMiner):
 
         return fans
 
-    async def _get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def _get_fault_light(self) -> bool:
-        return False
-
-    async def _get_expected_hashrate(self, api_stats: dict = None) -> Optional[float]:
+    async def _get_expected_hashrate(self, rpc_stats: dict = None) -> Optional[float]:
         # X19 method, not sure compatibility
-        if not api_stats:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                expected_rate = api_stats["STATS"][1]["total_rateideal"]
+                expected_rate = rpc_stats["STATS"][1]["total_rateideal"]
                 try:
-                    rate_unit = api_stats["STATS"][1]["rate_unit"]
+                    rate_unit = rpc_stats["STATS"][1]["rate_unit"]
                 except KeyError:
                     rate_unit = "GH"
                 if rate_unit == "GH":
@@ -343,18 +243,15 @@ class BMMiner(BaseMiner):
             except LookupError:
                 pass
 
-    async def _is_mining(self, *args, **kwargs) -> Optional[bool]:
-        return None
-
-    async def _get_uptime(self, api_stats: dict = None) -> Optional[int]:
-        if not api_stats:
+    async def _get_uptime(self, rpc_stats: dict = None) -> Optional[int]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                return int(api_stats["STATS"][1]["Elapsed"])
+                return int(rpc_stats["STATS"][1]["Elapsed"])
             except LookupError:
                 pass

pyasic/miners/backends/btminer.py

@@ -17,114 +17,112 @@
 import logging
 from typing import List, Optional
 
-from pyasic.API.btminer import BTMinerAPI
 from pyasic.config import MinerConfig, MiningModeConfig
 from pyasic.data import Fan, HashBoard
 from pyasic.data.error_codes import MinerErrorData, WhatsminerError
 from pyasic.errors import APIError
-from pyasic.miners.base import (
-    BaseMiner,
-    DataFunction,
-    DataLocations,
-    DataOptions,
-    RPCAPICommand,
-)
+from pyasic.miners.base import BaseMiner
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
+from pyasic.rpc.btminer import BTMinerRPCAPI
 
 BTMINER_DATA_LOC = DataLocations(
     **{
         str(DataOptions.MAC): DataFunction(
             "_get_mac",
             [
-                RPCAPICommand("api_summary", "summary"),
-                RPCAPICommand("api_get_miner_info", "get_miner_info"),
+                RPCAPICommand("rpc_summary", "summary"),
+                RPCAPICommand("rpc_get_miner_info", "get_miner_info"),
             ],
         ),
         str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_get_version", "get_version")]
+            "_get_api_ver",
+            [RPCAPICommand("rpc_get_version", "get_version")],
         ),
         str(DataOptions.FW_VERSION): DataFunction(
             "_get_fw_ver",
             [
-                RPCAPICommand("api_get_version", "get_version"),
-                RPCAPICommand("api_summary", "summary"),
+                RPCAPICommand("rpc_get_version", "get_version"),
+                RPCAPICommand("rpc_summary", "summary"),
             ],
         ),
         str(DataOptions.HOSTNAME): DataFunction(
-            "_get_hostname", [RPCAPICommand("api_get_miner_info", "get_miner_info")]
+            "_get_hostname",
+            [RPCAPICommand("rpc_get_miner_info", "get_miner_info")],
         ),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_summary", "summary")]
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_summary", "summary")]
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.HASHBOARDS): DataFunction(
-            "_get_hashboards", [RPCAPICommand("api_devs", "devs")]
+            "_get_hashboards",
+            [RPCAPICommand("rpc_devs", "devs")],
         ),
         str(DataOptions.ENVIRONMENT_TEMP): DataFunction(
-            "_get_env_temp", [RPCAPICommand("api_summary", "summary")]
+            "_get_env_temp",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.WATTAGE): DataFunction(
-            "_get_wattage", [RPCAPICommand("api_summary", "summary")]
+            "_get_wattage",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.WATTAGE_LIMIT): DataFunction(
-            "_get_wattage_limit", [RPCAPICommand("api_summary", "summary")]
+            "_get_wattage_limit",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.FANS): DataFunction(
             "_get_fans",
             [
-                RPCAPICommand("api_summary", "summary"),
-                RPCAPICommand("api_get_psu", "get_psu"),
+                RPCAPICommand("rpc_summary", "summary"),
+                RPCAPICommand("rpc_get_psu", "get_psu"),
             ],
         ),
         str(DataOptions.FAN_PSU): DataFunction(
             "_get_fan_psu",
             [
-                RPCAPICommand("api_summary", "summary"),
-                RPCAPICommand("api_get_psu", "get_psu"),
+                RPCAPICommand("rpc_summary", "summary"),
+                RPCAPICommand("rpc_get_psu", "get_psu"),
             ],
         ),
         str(DataOptions.ERRORS): DataFunction(
             "_get_errors",
             [
-                RPCAPICommand("api_get_error_code", "get_error_code"),
-                RPCAPICommand("api_summary", "summary"),
+                RPCAPICommand("rpc_get_error_code", "get_error_code"),
+                RPCAPICommand("rpc_summary", "summary"),
             ],
         ),
         str(DataOptions.FAULT_LIGHT): DataFunction(
             "_get_fault_light",
-            [RPCAPICommand("api_get_miner_info", "get_miner_info")],
+            [RPCAPICommand("rpc_get_miner_info", "get_miner_info")],
         ),
         str(DataOptions.IS_MINING): DataFunction(
-            "_is_mining", [RPCAPICommand("api_status", "status")]
+            "_is_mining",
+            [RPCAPICommand("rpc_status", "status")],
         ),
         str(DataOptions.UPTIME): DataFunction(
-            "_get_uptime", [RPCAPICommand("api_summary", "summary")]
+            "_get_uptime",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
 
 class BTMiner(BaseMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip)
-        # interfaces
-        self.api = BTMinerAPI(ip, api_ver)
+    """Base handler for BTMiner based miners."""
 
-        # static data
-        self.api_type = "BTMiner"
-        # data gathering locations
-        self.data_locations = BTMINER_DATA_LOC
-        # autotuning/shutdown support
-        self.supports_shutdown = True
+    _rpc_cls = BTMinerRPCAPI
+    rpc: BTMinerRPCAPI
 
-        # data storage
-        self.api_ver = api_ver
+    data_locations = BTMINER_DATA_LOC
 
-    async def _reset_api_pwd_to_admin(self, pwd: str):
+    supports_shutdown = True
+
+    async def _reset_rpc_pwd_to_admin(self, pwd: str):
         try:
-            data = await self.api.update_pwd(pwd, "admin")
+            data = await self.rpc.update_pwd(pwd, "admin")
         except APIError:
             return False
         if data:
@@ -135,7 +133,7 @@ class BTMiner(BaseMiner):
 
     async def fault_light_off(self) -> bool:
         try:
-            data = await self.api.set_led(auto=True)
+            data = await self.rpc.set_led(auto=True)
         except APIError:
             return False
         if data:
@@ -147,8 +145,8 @@ class BTMiner(BaseMiner):
 
     async def fault_light_on(self) -> bool:
         try:
-            data = await self.api.set_led(auto=False)
-            await self.api.set_led(
+            data = await self.rpc.set_led(auto=False)
+            await self.rpc.set_led(
                 auto=False, color="green", start=0, period=1, duration=0
             )
         except APIError:
@@ -162,7 +160,7 @@ class BTMiner(BaseMiner):
 
     async def reboot(self) -> bool:
         try:
-            data = await self.api.reboot()
+            data = await self.rpc.reboot()
         except APIError:
             return False
         if data.get("Msg"):
@@ -172,7 +170,7 @@ class BTMiner(BaseMiner):
 
     async def restart_backend(self) -> bool:
         try:
-            data = await self.api.restart()
+            data = await self.rpc.restart()
         except APIError:
             return False
         if data.get("Msg"):
@@ -182,7 +180,7 @@ class BTMiner(BaseMiner):
 
     async def stop_mining(self) -> bool:
         try:
-            data = await self.api.power_off(respbefore=True)
+            data = await self.rpc.power_off(respbefore=True)
         except APIError:
             return False
         if data.get("Msg"):
@@ -192,7 +190,7 @@ class BTMiner(BaseMiner):
 
     async def resume_mining(self) -> bool:
         try:
-            data = await self.api.power_on()
+            data = await self.rpc.power_on()
         except APIError:
             return False
         if data.get("Msg"):
@@ -207,16 +205,16 @@ class BTMiner(BaseMiner):
         pools_conf = conf["pools"]
 
         try:
-            await self.api.update_pools(**pools_conf)
+            await self.rpc.update_pools(**pools_conf)
 
             if conf["mode"] == "normal":
-                await self.api.set_normal_power()
+                await self.rpc.set_normal_power()
             elif conf["mode"] == "high":
-                await self.api.set_high_power()
+                await self.rpc.set_high_power()
             elif conf["mode"] == "low":
-                await self.api.set_low_power()
+                await self.rpc.set_low_power()
             elif conf["mode"] == "power_tuning":
-                await self.api.adjust_power_limit(conf["power_tuning"]["wattage"])
+                await self.rpc.adjust_power_limit(conf["power_tuning"]["wattage"])
         except APIError:
             # cannot update, no API access usually
             pass
@@ -226,7 +224,7 @@ class BTMiner(BaseMiner):
         summary = None
         status = None
         try:
-            data = await self.api.multicommand("pools", "summary", "status")
+            data = await self.rpc.multicommand("pools", "summary", "status")
             pools = data["pools"][0]
             summary = data["summary"][0]
             status = data["status"][0]
@@ -273,7 +271,7 @@ class BTMiner(BaseMiner):
 
     async def set_power_limit(self, wattage: int) -> bool:
         try:
-            await self.api.adjust_power_limit(wattage)
+            await self.rpc.adjust_power_limit(wattage)
         except Exception as e:
             logging.warning(f"{self} set_power_limit: {e}")
             return False
@@ -285,85 +283,85 @@ class BTMiner(BaseMiner):
     ##################################################
 
     async def _get_mac(
-        self, api_summary: dict = None, api_get_miner_info: dict = None
+        self, rpc_summary: dict = None, rpc_get_miner_info: dict = None
     ) -> Optional[str]:
-        if not api_get_miner_info:
+        if rpc_get_miner_info is None:
             try:
-                api_get_miner_info = await self.api.get_miner_info()
+                rpc_get_miner_info = await self.rpc.get_miner_info()
             except APIError:
                 pass
 
-        if api_get_miner_info:
+        if rpc_get_miner_info is not None:
             try:
-                mac = api_get_miner_info["Msg"]["mac"]
+                mac = rpc_get_miner_info["Msg"]["mac"]
                 return str(mac).upper()
             except KeyError:
                 pass
 
-        if not api_summary:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                mac = api_summary["SUMMARY"][0]["MAC"]
+                mac = rpc_summary["SUMMARY"][0]["MAC"]
                 return str(mac).upper()
             except LookupError:
                 pass
 
-    async def _get_api_ver(self, api_get_version: dict = None) -> Optional[str]:
-        if not api_get_version:
+    async def _get_api_ver(self, rpc_get_version: dict = None) -> Optional[str]:
+        if rpc_get_version is None:
             try:
-                api_get_version = await self.api.get_version()
+                rpc_get_version = await self.rpc.get_version()
             except APIError:
                 pass
 
-        if api_get_version:
-            if "Code" in api_get_version.keys():
-                if api_get_version["Code"] == 131:
+        if rpc_get_version is not None:
+            if "Code" in rpc_get_version.keys():
+                if rpc_get_version["Code"] == 131:
                     try:
-                        api_ver = api_get_version["Msg"]
-                        if not isinstance(api_ver, str):
-                            api_ver = api_ver["api_ver"]
-                        self.api_ver = api_ver.replace("whatsminer v", "")
+                        rpc_ver = rpc_get_version["Msg"]
+                        if not isinstance(rpc_ver, str):
+                            rpc_ver = rpc_ver["rpc_ver"]
+                        self.api_ver = rpc_ver.replace("whatsminer v", "")
                     except (KeyError, TypeError):
                         pass
                     else:
-                        self.api.api_ver = self.api_ver
+                        self.rpc.rpc_ver = self.api_ver
                         return self.api_ver
 
         return self.api_ver
 
     async def _get_fw_ver(
-        self, api_get_version: dict = None, api_summary: dict = None
+        self, rpc_get_version: dict = None, rpc_summary: dict = None
     ) -> Optional[str]:
-        if not api_get_version:
+        if rpc_get_version is None:
             try:
-                api_get_version = await self.api.get_version()
+                rpc_get_version = await self.rpc.get_version()
             except APIError:
                 pass
 
-        if api_get_version:
-            if "Code" in api_get_version.keys():
-                if api_get_version["Code"] == 131:
+        if rpc_get_version is not None:
+            if "Code" in rpc_get_version.keys():
+                if rpc_get_version["Code"] == 131:
                     try:
-                        self.fw_ver = api_get_version["Msg"]["fw_ver"]
+                        self.fw_ver = rpc_get_version["Msg"]["fw_ver"]
                     except (KeyError, TypeError):
                         pass
                     else:
                         return self.fw_ver
 
-        if not api_summary:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary:
             try:
-                self.fw_ver = api_summary["SUMMARY"][0]["Firmware Version"].replace(
+                self.fw_ver = rpc_summary["SUMMARY"][0]["Firmware Version"].replace(
                     "'", ""
                 )
             except LookupError:
@@ -371,51 +369,50 @@ class BTMiner(BaseMiner):
 
         return self.fw_ver
 
-    async def _get_hostname(self, api_get_miner_info: dict = None) -> Optional[str]:
+    async def _get_hostname(self, rpc_get_miner_info: dict = None) -> Optional[str]:
         hostname = None
-        if not api_get_miner_info:
+        if rpc_get_miner_info is None:
             try:
-                api_get_miner_info = await self.api.get_miner_info()
+                rpc_get_miner_info = await self.rpc.get_miner_info()
             except APIError:
                 return None  # only one way to get this
 
-        if api_get_miner_info:
+        if rpc_get_miner_info is not None:
             try:
-                hostname = api_get_miner_info["Msg"]["hostname"]
+                hostname = rpc_get_miner_info["Msg"]["hostname"]
             except KeyError:
                 return None
 
         return hostname
 
-    async def _get_hashrate(self, api_summary: dict = None) -> Optional[float]:
-        # get hr from API
-        if not api_summary:
+    async def _get_hashrate(self, rpc_summary: dict = None) -> Optional[float]:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                return round(float(api_summary["SUMMARY"][0]["MHS 1m"] / 1000000), 2)
+                return round(float(rpc_summary["SUMMARY"][0]["MHS 1m"] / 1000000), 2)
             except LookupError:
                 pass
 
-    async def _get_hashboards(self, api_devs: dict = None) -> List[HashBoard]:
+    async def _get_hashboards(self, rpc_devs: dict = None) -> List[HashBoard]:
         hashboards = [
             HashBoard(slot=i, expected_chips=self.expected_chips)
             for i in range(self.expected_hashboards)
         ]
 
-        if not api_devs:
+        if rpc_devs is None:
             try:
-                api_devs = await self.api.devs()
+                rpc_devs = await self.rpc.devs()
             except APIError:
                 pass
 
-        if api_devs:
+        if rpc_devs is not None:
             try:
-                for board in api_devs["DEVS"]:
+                for board in rpc_devs["DEVS"]:
                     if len(hashboards) < board["ASC"] + 1:
                         hashboards.append(
                             HashBoard(
@@ -436,62 +433,62 @@ class BTMiner(BaseMiner):
 
         return hashboards
 
-    async def _get_env_temp(self, api_summary: dict = None) -> Optional[float]:
-        if not api_summary:
+    async def _get_env_temp(self, rpc_summary: dict = None) -> Optional[float]:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                return api_summary["SUMMARY"][0]["Env Temp"]
+                return rpc_summary["SUMMARY"][0]["Env Temp"]
             except LookupError:
                 pass
 
-    async def _get_wattage(self, api_summary: dict = None) -> Optional[int]:
-        if not api_summary:
+    async def _get_wattage(self, rpc_summary: dict = None) -> Optional[int]:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                wattage = api_summary["SUMMARY"][0]["Power"]
+                wattage = rpc_summary["SUMMARY"][0]["Power"]
                 return wattage if not wattage == -1 else None
             except LookupError:
                 pass
 
-    async def _get_wattage_limit(self, api_summary: dict = None) -> Optional[int]:
-        if not api_summary:
+    async def _get_wattage_limit(self, rpc_summary: dict = None) -> Optional[int]:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                return api_summary["SUMMARY"][0]["Power Limit"]
+                return rpc_summary["SUMMARY"][0]["Power Limit"]
             except LookupError:
                 pass
 
     async def _get_fans(
-        self, api_summary: dict = None, api_get_psu: dict = None
+        self, rpc_summary: dict = None, rpc_get_psu: dict = None
     ) -> List[Fan]:
-        if not api_summary:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
         fans = [Fan() for _ in range(self.expected_fans)]
-        if api_summary:
+        if rpc_summary is not None:
             try:
                 if self.expected_fans > 0:
                     fans = [
-                        Fan(api_summary["SUMMARY"][0].get("Fan Speed In", 0)),
-                        Fan(api_summary["SUMMARY"][0].get("Fan Speed Out", 0)),
+                        Fan(rpc_summary["SUMMARY"][0].get("Fan Speed In", 0)),
+                        Fan(rpc_summary["SUMMARY"][0].get("Fan Speed Out", 0)),
                     ]
             except LookupError:
                 pass
@@ -499,92 +496,95 @@ class BTMiner(BaseMiner):
         return fans
 
     async def _get_fan_psu(
-        self, api_summary: dict = None, api_get_psu: dict = None
+        self, rpc_summary: dict = None, rpc_get_psu: dict = None
     ) -> Optional[int]:
-        if not api_summary:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                return int(api_summary["SUMMARY"][0]["Power Fanspeed"])
+                return int(rpc_summary["SUMMARY"][0]["Power Fanspeed"])
             except LookupError:
                 pass
 
-        if not api_get_psu:
+        if rpc_get_psu is None:
             try:
-                api_get_psu = await self.api.get_psu()
+                rpc_get_psu = await self.rpc.get_psu()
             except APIError:
                 pass
 
-        if api_get_psu:
+        if rpc_get_psu is not None:
             try:
-                return int(api_get_psu["Msg"]["fan_speed"])
+                return int(rpc_get_psu["Msg"]["fan_speed"])
             except (KeyError, TypeError):
                 pass
 
     async def _get_errors(
-        self, api_summary: dict = None, api_get_error_code: dict = None
+        self, rpc_summary: dict = None, rpc_get_error_code: dict = None
     ) -> List[MinerErrorData]:
         errors = []
-        if not api_get_error_code and not api_summary:
+        if rpc_get_error_code is None and rpc_summary is None:
             try:
-                api_get_error_code = await self.api.get_error_code()
+                rpc_get_error_code = await self.rpc.get_error_code()
             except APIError:
                 pass
 
-        if api_get_error_code:
-            for err in api_get_error_code["Msg"]["error_code"]:
-                if isinstance(err, dict):
-                    for code in err:
-                        errors.append(WhatsminerError(error_code=int(code)))
-                else:
-                    errors.append(WhatsminerError(error_code=int(err)))
-
-        if not api_summary:
+        if rpc_get_error_code is not None:
             try:
-                api_summary = await self.api.summary()
+                for err in rpc_get_error_code["Msg"]["error_code"]:
+                    if isinstance(err, dict):
+                        for code in err:
+                            errors.append(WhatsminerError(error_code=int(code)))
+                    else:
+                        errors.append(WhatsminerError(error_code=int(err)))
+            except KeyError:
+                pass
+
+        if rpc_summary is None:
+            try:
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                for i in range(api_summary["SUMMARY"][0]["Error Code Count"]):
-                    err = api_summary["SUMMARY"][0].get(f"Error Code {i}")
+                for i in range(rpc_summary["SUMMARY"][0]["Error Code Count"]):
+                    err = rpc_summary["SUMMARY"][0].get(f"Error Code {i}")
                     if err:
                         errors.append(WhatsminerError(error_code=err))
             except (LookupError, ValueError, TypeError):
                 pass
         return errors
 
-    async def _get_expected_hashrate(self, api_summary: dict = None):
-        if not api_summary:
+    async def _get_expected_hashrate(self, rpc_summary: dict = None) -> Optional[float]:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                expected_hashrate = api_summary["SUMMARY"][0]["Factory GHS"]
+                expected_hashrate = rpc_summary["SUMMARY"][0]["Factory GHS"]
                 if expected_hashrate:
                     return round(expected_hashrate / 1000, 2)
             except LookupError:
                 pass
 
-    async def _get_fault_light(self, api_get_miner_info: dict = None) -> bool:
-        if not api_get_miner_info:
+    async def _get_fault_light(self, rpc_get_miner_info: dict = None) -> Optional[bool]:
+        if rpc_get_miner_info is None:
             try:
-                api_get_miner_info = await self.api.get_miner_info()
+                rpc_get_miner_info = await self.rpc.get_miner_info()
             except APIError:
                 if not self.light:
                     self.light = False
 
-        if api_get_miner_info:
+        if rpc_get_miner_info is not None:
             try:
-                self.light = not (api_get_miner_info["Msg"]["ledstat"] == "auto")
+                self.light = not (rpc_get_miner_info["Msg"]["ledstat"] == "auto")
             except KeyError:
                 pass
 
@@ -600,46 +600,46 @@ class BTMiner(BaseMiner):
     ):
         if not hostname:
             hostname = await self.get_hostname()
-        await self.api.net_config(
+        await self.rpc.net_config(
             ip=ip, mask=subnet_mask, dns=dns, gate=gateway, host=hostname, dhcp=False
         )
 
     async def set_dhcp(self, hostname: str = None):
         if hostname:
             await self.set_hostname(hostname)
-        await self.api.net_config()
+        await self.rpc.net_config()
 
     async def set_hostname(self, hostname: str):
-        await self.api.set_hostname(hostname)
+        await self.rpc.set_hostname(hostname)
 
-    async def _is_mining(self, api_status: dict = None) -> Optional[bool]:
-        if not api_status:
+    async def _is_mining(self, rpc_status: dict = None) -> Optional[bool]:
+        if rpc_status is None:
             try:
-                api_status = await self.api.status()
+                rpc_status = await self.rpc.status()
             except APIError:
                 pass
 
-        if api_status:
+        if rpc_status is not None:
             try:
-                if api_status["Msg"].get("btmineroff"):
+                if rpc_status["Msg"].get("btmineroff"):
                     try:
-                        await self.api.devdetails()
+                        await self.rpc.devdetails()
                     except APIError:
                         return False
                     return True
-                return True if api_status["Msg"]["mineroff"] == "false" else False
+                return True if rpc_status["Msg"]["mineroff"] == "false" else False
             except LookupError:
                 pass
 
-    async def _get_uptime(self, api_summary: dict = None) -> Optional[int]:
-        if not api_summary:
+    async def _get_uptime(self, rpc_summary: dict = None) -> Optional[int]:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                return int(api_summary["SUMMARY"][0]["Elapsed"])
+                return int(rpc_summary["SUMMARY"][0]["Elapsed"])
             except LookupError:
                 pass

pyasic/miners/backends/cgminer.py

@@ -14,360 +14,124 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-import logging
-from typing import List, Optional
+from typing import Optional
 
-from pyasic.API.cgminer import CGMinerAPI
 from pyasic.config import MinerConfig
-from pyasic.data import Fan, HashBoard
-from pyasic.data.error_codes import MinerErrorData
 from pyasic.errors import APIError
-from pyasic.miners.base import (
-    BaseMiner,
-    DataFunction,
-    DataLocations,
-    DataOptions,
-    RPCAPICommand,
-)
+from pyasic.miners.base import BaseMiner
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
+from pyasic.rpc.cgminer import CGMinerRPCAPI
 
 CGMINER_DATA_LOC = DataLocations(
     **{
-        str(DataOptions.MAC): DataFunction("_get_mac"),
         str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_version", "version")]
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [RPCAPICommand("api_version", "version")]
+            "_get_fw_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
-        str(DataOptions.HOSTNAME): DataFunction("_get_hostname"),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_summary", "summary")]
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_stats", "stats")]
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
         str(DataOptions.HASHBOARDS): DataFunction(
-            "_get_hashboards", [RPCAPICommand("api_stats", "stats")]
+            "_get_hashboards",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction("_get_env_temp"),
-        str(DataOptions.WATTAGE): DataFunction("_get_wattage"),
-        str(DataOptions.WATTAGE_LIMIT): DataFunction("_get_wattage_limit"),
         str(DataOptions.FANS): DataFunction(
-            "_get_fans", [RPCAPICommand("api_stats", "stats")]
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
-        str(DataOptions.ERRORS): DataFunction("_get_errors"),
-        str(DataOptions.FAULT_LIGHT): DataFunction("_get_fault_light"),
-        str(DataOptions.IS_MINING): DataFunction("_is_mining"),
         str(DataOptions.UPTIME): DataFunction(
-            "_get_uptime", [RPCAPICommand("api_stats", "stats")]
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
 
 class CGMiner(BaseMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip)
-        # interfaces
-        self.api = CGMinerAPI(ip, api_ver)
+    """Base handler for CGMiner based miners"""
 
-        # static data
-        self.api_type = "CGMiner"
-        # data gathering locations
-        self.data_locations = CGMINER_DATA_LOC
+    _rpc_cls = CGMinerRPCAPI
+    rpc: CGMinerRPCAPI
 
-        # data storage
-        self.api_ver = api_ver
-
-    async def send_ssh_command(self, cmd: str) -> Optional[str]:
-        result = None
-
-        try:
-            conn = await self._get_ssh_connection()
-        except ConnectionError:
-            return None
-
-        # open an ssh connection
-        async with conn:
-            # 3 retries
-            for i in range(3):
-                try:
-                    # run the command and get the result
-                    result = await conn.run(cmd)
-                    result = result.stdout
-
-                except Exception as e:
-                    # if the command fails, log it
-                    logging.warning(f"{self} command {cmd} error: {e}")
-
-                    # on the 3rd retry, return None
-                    if i == 3:
-                        return
-                    continue
-        # return the result, either command output or None
-        return result
-
-    async def restart_backend(self) -> bool:
-        return await self.restart_cgminer()
-
-    async def restart_cgminer(self) -> bool:
-        commands = ["cgminer-api restart", "/usr/bin/cgminer-monitor >/dev/null 2>&1"]
-        commands = ";".join(commands)
-        ret = await self.send_ssh_command(commands)
-        if ret is None:
-            return False
-        return True
-
-    async def reboot(self) -> bool:
-        logging.debug(f"{self}: Sending reboot command.")
-        ret = await self.send_ssh_command("reboot")
-        if ret is None:
-            return False
-        return True
-
-    async def resume_mining(self) -> bool:
-        commands = [
-            "mkdir -p /etc/tmp/",
-            'echo "*/3 * * * * /usr/bin/cgminer-monitor" > /etc/tmp/root',
-            "crontab -u root /etc/tmp/root",
-            "/usr/bin/cgminer-monitor >/dev/null 2>&1",
-        ]
-        commands = ";".join(commands)
-        ret = await self.send_ssh_command(commands)
-        if ret is None:
-            return False
-        return True
-
-    async def stop_mining(self) -> bool:
-        commands = [
-            "mkdir -p /etc/tmp/",
-            'echo "" > /etc/tmp/root',
-            "crontab -u root /etc/tmp/root",
-            "killall cgminer",
-        ]
-        commands = ";".join(commands)
-        ret = await self.send_ssh_command(commands)
-        if ret is None:
-            return False
-        return True
+    data_locations = CGMINER_DATA_LOC
 
     async def get_config(self) -> MinerConfig:
         # get pool data
         try:
-            pools = await self.api.pools()
+            pools = await self.rpc.pools()
         except APIError:
             return self.config
 
         self.config = MinerConfig.from_api(pools)
         return self.config
 
-    async def fault_light_off(self) -> bool:
-        return False
-
-    async def fault_light_on(self) -> bool:
-        return False
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        return None
-
-    async def set_power_limit(self, wattage: int) -> bool:
-        return False
-
     ##################################################
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
     ##################################################
 
-    async def _get_mac(self) -> Optional[str]:
-        return None
-
-    async def _get_api_ver(self, api_version: dict = None) -> Optional[str]:
-        if not api_version:
+    async def _get_api_ver(self, rpc_version: dict = None) -> Optional[str]:
+        if rpc_version is None:
             try:
-                api_version = await self.api.version()
+                rpc_version = await self.rpc.version()
             except APIError:
                 pass
 
-        if api_version:
+        if rpc_version is not None:
             try:
-                self.api_ver = api_version["VERSION"][0]["API"]
+                self.api_ver = rpc_version["VERSION"][0]["API"]
             except LookupError:
                 pass
 
         return self.api_ver
 
-    async def _get_fw_ver(self, api_version: dict = None) -> Optional[str]:
-        if not api_version:
+    async def _get_fw_ver(self, rpc_version: dict = None) -> Optional[str]:
+        if rpc_version is None:
             try:
-                api_version = await self.api.version()
+                rpc_version = await self.rpc.version()
             except APIError:
                 pass
 
-        if api_version:
+        if rpc_version is not None:
             try:
-                self.fw_ver = api_version["VERSION"][0]["CGMiner"]
+                self.fw_ver = rpc_version["VERSION"][0]["CGMiner"]
             except LookupError:
                 pass
 
         return self.fw_ver
 
-    async def _get_hostname(self) -> Optional[str]:
-        hn = await self.send_ssh_command("cat /proc/sys/kernel/hostname")
-        return hn
-
-    async def _get_hashrate(self, api_summary: dict = None) -> Optional[float]:
-        # get hr from API
-        if not api_summary:
+    async def _get_hashrate(self, rpc_summary: dict = None) -> Optional[float]:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
                 return round(
-                    float(float(api_summary["SUMMARY"][0]["GHS 5s"]) / 1000), 2
+                    float(float(rpc_summary["SUMMARY"][0]["GHS 5s"]) / 1000), 2
                 )
             except (LookupError, ValueError, TypeError):
                 pass
 
-    async def _get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
-        hashboards = []
-
-        if not api_stats:
+    async def _get_uptime(self, rpc_stats: dict = None) -> Optional[int]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                board_offset = -1
-                boards = api_stats["STATS"]
-                if len(boards) > 1:
-                    for board_num in range(1, 16, 5):
-                        for _b_num in range(5):
-                            b = boards[1].get(f"chain_acn{board_num + _b_num}")
-
-                            if b and not b == 0 and board_offset == -1:
-                                board_offset = board_num
-                    if board_offset == -1:
-                        board_offset = 1
-
-                    for i in range(
-                        board_offset, board_offset + self.expected_hashboards
-                    ):
-                        hashboard = HashBoard(
-                            slot=i - board_offset, expected_chips=self.expected_chips
-                        )
-
-                        chip_temp = boards[1].get(f"temp{i}")
-                        if chip_temp:
-                            hashboard.chip_temp = round(chip_temp)
-
-                        temp = boards[1].get(f"temp2_{i}")
-                        if temp:
-                            hashboard.temp = round(temp)
-
-                        hashrate = boards[1].get(f"chain_rate{i}")
-                        if hashrate:
-                            hashboard.hashrate = round(float(hashrate) / 1000, 2)
-
-                        chips = boards[1].get(f"chain_acn{i}")
-                        if chips:
-                            hashboard.chips = chips
-                            hashboard.missing = False
-                        if (not chips) or (not chips > 0):
-                            hashboard.missing = True
-                        hashboards.append(hashboard)
-            except (LookupError, ValueError, TypeError):
-                pass
-
-        return hashboards
-
-    async def _get_env_temp(self) -> Optional[float]:
-        return None
-
-    async def _get_wattage(self) -> Optional[int]:
-        return None
-
-    async def _get_wattage_limit(self) -> Optional[int]:
-        return None
-
-    async def _get_fans(self, api_stats: dict = None) -> List[Fan]:
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        fans = [Fan() for _ in range(self.expected_fans)]
-        if api_stats:
-            try:
-                fan_offset = -1
-
-                for fan_num in range(1, 8, 4):
-                    for _f_num in range(4):
-                        f = api_stats["STATS"][1].get(f"fan{fan_num + _f_num}")
-                        if f and not f == 0 and fan_offset == -1:
-                            fan_offset = fan_num
-                if fan_offset == -1:
-                    fan_offset = 1
-
-                for fan in range(self.expected_fans):
-                    fans[fan].speed = api_stats["STATS"][1].get(
-                        f"fan{fan_offset+fan}", 0
-                    )
-            except LookupError:
-                pass
-        return fans
-
-    async def _get_fan_psu(self) -> Optional[int]:
-        return None
-
-    async def _get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def _get_fault_light(self) -> bool:
-        return False
-
-    async def _get_expected_hashrate(self, api_stats: dict = None) -> Optional[float]:
-        # X19 method, not sure compatibility
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        if api_stats:
-            try:
-                expected_rate = api_stats["STATS"][1]["total_rateideal"]
-                try:
-                    rate_unit = api_stats["STATS"][1]["rate_unit"]
-                except KeyError:
-                    rate_unit = "GH"
-                if rate_unit == "GH":
-                    return round(expected_rate / 1000, 2)
-                if rate_unit == "MH":
-                    return round(expected_rate / 1000000, 2)
-                else:
-                    return round(expected_rate, 2)
-            except LookupError:
-                pass
-
-    async def _is_mining(self, *args, **kwargs) -> Optional[bool]:
-        return None
-
-    async def _get_uptime(self, api_stats: dict = None) -> Optional[int]:
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        if api_stats:
-            try:
-                return int(api_stats["STATS"][1]["Elapsed"])
+                return int(rpc_stats["STATS"][1]["Elapsed"])
             except LookupError:
                 pass

pyasic/miners/backends/epic.py

@@ -21,32 +21,31 @@ from pyasic.data import Fan, HashBoard
 from pyasic.data.error_codes import MinerErrorData, X19Error
 from pyasic.errors import APIError
 from pyasic.logger import logger
-from pyasic.miners.base import (
-    BaseMiner,
-    DataFunction,
-    DataLocations,
-    DataOptions,
-    WebAPICommand,
-)
+from pyasic.miners.base import BaseMiner
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, WebAPICommand
 from pyasic.web.epic import ePICWebAPI
 
 EPIC_DATA_LOC = DataLocations(
     **{
         str(DataOptions.MAC): DataFunction(
-            "_get_mac", [WebAPICommand("web_network", "network")]
+            "_get_mac",
+            [WebAPICommand("web_network", "network")],
         ),
-        str(DataOptions.API_VERSION): DataFunction("_get_api_ver"),
         str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [WebAPICommand("web_summary", "summary")]
+            "_get_fw_ver",
+            [WebAPICommand("web_summary", "summary")],
         ),
         str(DataOptions.HOSTNAME): DataFunction(
-            "_get_hostname", [WebAPICommand("web_summary", "summary")]
+            "_get_hostname",
+            [WebAPICommand("web_summary", "summary")],
         ),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [WebAPICommand("web_summary", "summary")]
+            "_get_hashrate",
+            [WebAPICommand("web_summary", "summary")],
         ),
         str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [WebAPICommand("web_summary", "summary")]
+            "_get_expected_hashrate",
+            [WebAPICommand("web_summary", "summary")],
         ),
         str(DataOptions.HASHBOARDS): DataFunction(
             "_get_hashboards",
@@ -55,41 +54,41 @@ EPIC_DATA_LOC = DataLocations(
                 WebAPICommand("web_hashrate", "hashrate"),
             ],
         ),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction("_get_env_temp"),
         str(DataOptions.WATTAGE): DataFunction(
-            "_get_wattage", [WebAPICommand("web_summary", "summary")]
+            "_get_wattage",
+            [WebAPICommand("web_summary", "summary")],
         ),
-        str(DataOptions.WATTAGE_LIMIT): DataFunction("_get_wattage_limit"),
         str(DataOptions.FANS): DataFunction(
-            "_get_fans", [WebAPICommand("web_summary", "summary")]
+            "_get_fans",
+            [WebAPICommand("web_summary", "summary")],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
         str(DataOptions.ERRORS): DataFunction(
-            "_get_errors", [WebAPICommand("web_summary", "summary")]
+            "_get_errors",
+            [WebAPICommand("web_summary", "summary")],
         ),
         str(DataOptions.FAULT_LIGHT): DataFunction(
-            "_get_fault_light", [WebAPICommand("web_summary", "summary")]
+            "_get_fault_light",
+            [WebAPICommand("web_summary", "summary")],
         ),
-        str(DataOptions.IS_MINING): DataFunction("_is_mining"),
         str(DataOptions.UPTIME): DataFunction(
-            "_get_uptime", [WebAPICommand("web_summary", "summary")]
+            "_get_uptime",
+            [WebAPICommand("web_summary", "summary")],
         ),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
 
 class ePIC(BaseMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver)
-        # interfaces
-        self.web = ePICWebAPI(ip)
+    """Handler for miners with the ePIC board"""
 
-        # static data
-        self.api_type = "ePIC"
-        self.fw_str = "ePIC"
-        # data gathering locations
-        self.data_locations = EPIC_DATA_LOC
+    _web_cls = ePICWebAPI
+    web: ePICWebAPI
+
+    firmware = "ePIC"
+
+    data_locations = EPIC_DATA_LOC
+
+    supports_shutdown = True
 
     async def get_config(self) -> MinerConfig:
         summary = None
@@ -108,6 +107,31 @@ class ePIC(BaseMiner):
         self.config = cfg
         return self.config
 
+    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
+        self.config = config
+        conf = self.config.as_epic(user_suffix=user_suffix)
+
+        try:
+            # Temps
+            if not conf.get("temps", {}) == {}:
+                await self.web.set_shutdown_temp(conf["temps"]["shutdown"])
+            # Fans
+            # set with sub-keys instead of conf["fans"] because sometimes both can be set
+            if not conf["fans"].get("Manual", {}) == {}:
+                await self.web.set_fan({"Manual": conf["fans"]["Manual"]})
+            elif not conf["fans"].get("Auto", {}) == {}:
+                await self.web.set_fan({"Auto": conf["fans"]["Auto"]})
+
+            # Mining Mode -- Need to handle that you may not be able to change while miner is tuning
+            if conf["ptune"].get("enabled", True):
+                await self.web.set_ptune_enable(True)
+                await self.web.set_ptune_algo(**conf["ptune"])
+
+            ## Pools
+            await self.web.set_pools(conf["pools"])
+        except APIError:
+            pass
+
     async def restart_backend(self) -> bool:
         data = await self.web.restart_epic()
         if data:
@@ -144,10 +168,14 @@ class ePIC(BaseMiner):
                 pass
         return False
 
-    async def _get_mac(self, web_network: dict = None) -> str:
-        if not web_network:
-            web_network = await self.web.network()
-        if web_network:
+    async def _get_mac(self, web_network: dict = None) -> Optional[str]:
+        if web_network is None:
+            try:
+                web_network = await self.web.network()
+            except APIError:
+                pass
+
+        if web_network is not None:
             try:
                 for network in web_network:
                     mac = web_network[network]["mac_address"]
@@ -155,10 +183,14 @@ class ePIC(BaseMiner):
             except KeyError:
                 pass
 
-    async def _get_hostname(self, web_summary: dict = None) -> str:
-        if not web_summary:
-            web_summary = await self.web.summary()
-        if web_summary:
+    async def _get_hostname(self, web_summary: dict = None) -> Optional[str]:
+        if web_summary is None:
+            try:
+                web_summary = await self.web.summary()
+            except APIError:
+                pass
+
+        if web_summary is not None:
             try:
                 hostname = web_summary["Hostname"]
                 return hostname
@@ -166,10 +198,13 @@ class ePIC(BaseMiner):
                 pass
 
     async def _get_wattage(self, web_summary: dict = None) -> Optional[int]:
-        if not web_summary:
-            web_summary = await self.web.summary()
+        if web_summary is None:
+            try:
+                web_summary = await self.web.summary()
+            except APIError:
+                pass
 
-        if web_summary:
+        if web_summary is not None:
             try:
                 wattage = web_summary["Power Supply Stats"]["Input Power"]
                 wattage = round(wattage)
@@ -178,14 +213,13 @@ class ePIC(BaseMiner):
                 pass
 
     async def _get_hashrate(self, web_summary: dict = None) -> Optional[float]:
-        # get hr from API
-        if not web_summary:
+        if web_summary is None:
             try:
                 web_summary = await self.web.summary()
             except APIError:
                 pass
 
-        if web_summary:
+        if web_summary is not None:
             try:
                 hashrate = 0
                 if web_summary["HBs"] is not None:
@@ -196,14 +230,13 @@ class ePIC(BaseMiner):
                 pass
 
     async def _get_expected_hashrate(self, web_summary: dict = None) -> Optional[float]:
-        # get hr from API
-        if not web_summary:
+        if web_summary is None:
             try:
                 web_summary = await self.web.summary()
             except APIError:
                 pass
 
-        if web_summary:
+        if web_summary is not None:
             try:
                 hashrate = 0
                 if web_summary.get("HBs") is not None:
@@ -219,10 +252,13 @@ class ePIC(BaseMiner):
                 pass
 
     async def _get_fw_ver(self, web_summary: dict = None) -> Optional[str]:
-        if not web_summary:
-            web_summary = await self.web.summary()
+        if web_summary is None:
+            try:
+                web_summary = await self.web.summary()
+            except APIError:
+                pass
 
-        if web_summary:
+        if web_summary is not None:
             try:
                 fw_ver = web_summary["Software"]
                 fw_ver = fw_ver.split(" ")[1].replace("v", "")
@@ -231,7 +267,7 @@ class ePIC(BaseMiner):
                 pass
 
     async def _get_fans(self, web_summary: dict = None) -> List[Fan]:
-        if not web_summary:
+        if web_summary is None:
             try:
                 web_summary = await self.web.summary()
             except APIError:
@@ -239,7 +275,7 @@ class ePIC(BaseMiner):
 
         fans = []
 
-        if web_summary:
+        if web_summary is not None:
             for fan in web_summary["Fans Rpm"]:
                 try:
                     fans.append(Fan(web_summary["Fans Rpm"][fan]))
@@ -250,12 +286,13 @@ class ePIC(BaseMiner):
     async def _get_hashboards(
         self, web_summary: dict = None, web_hashrate: dict = None
     ) -> List[HashBoard]:
-        if not web_summary:
+        if web_summary is None:
             try:
                 web_summary = await self.web.summary()
             except APIError:
                 pass
-        if not web_hashrate:
+
+        if web_hashrate is not None:
             try:
                 web_hashrate = await self.web.hashrate()
             except APIError:
@@ -283,9 +320,13 @@ class ePIC(BaseMiner):
         return None
 
     async def _get_uptime(self, web_summary: dict = None) -> Optional[int]:
-        if not web_summary:
-            web_summary = await self.web.summary()
-        if web_summary:
+        if web_summary is None:
+            try:
+                web_summary = await self.web.summary()
+            except APIError:
+                pass
+
+        if web_summary is not None:
             try:
                 uptime = web_summary["Session"]["Uptime"]
                 return uptime
@@ -293,10 +334,14 @@ class ePIC(BaseMiner):
                 pass
         return None
 
-    async def _get_fault_light(self, web_summary: dict = None) -> bool:
-        if not web_summary:
-            web_summary = await self.web.summary()
-        if web_summary:
+    async def _get_fault_light(self, web_summary: dict = None) -> Optional[bool]:
+        if web_summary is None:
+            try:
+                web_summary = await self.web.summary()
+            except APIError:
+                pass
+
+        if web_summary is not None:
             try:
                 light = web_summary["Misc"]["Locate Miner State"]
                 return light
@@ -306,9 +351,13 @@ class ePIC(BaseMiner):
 
     async def _get_errors(self, web_summary: dict = None) -> List[MinerErrorData]:
         if not web_summary:
-            web_summary = await self.web.summary()
+            try:
+                web_summary = await self.web.summary()
+            except APIError:
+                pass
+
         errors = []
-        if web_summary:
+        if web_summary is not None:
             try:
                 error = web_summary["Status"]["Last Error"]
                 if error is not None:
@@ -317,27 +366,3 @@ class ePIC(BaseMiner):
             except KeyError:
                 pass
         return errors
-
-    async def fault_light_off(self) -> bool:
-        return False
-
-    async def fault_light_on(self) -> bool:
-        return False
-
-    async def _get_api_ver(self, *args, **kwargs) -> Optional[str]:
-        pass
-
-    async def _get_env_temp(self, *args, **kwargs) -> Optional[float]:
-        pass
-
-    async def _get_fan_psu(self, *args, **kwargs) -> Optional[int]:
-        pass
-
-    async def _get_wattage_limit(self, *args, **kwargs) -> Optional[int]:
-        pass
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        pass
-
-    async def set_power_limit(self, wattage: int) -> bool:
-        return False

pyasic/miners/backends/goldshell.py

@@ -13,14 +13,14 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-from typing import List, Optional
+from typing import List
 
-from pyasic.config import MinerConfig
+from pyasic.config import MinerConfig, MiningModeConfig
 from pyasic.data import HashBoard
 from pyasic.errors import APIError
 from pyasic.logger import logger
 from pyasic.miners.backends import BFGMiner
-from pyasic.miners.base import (
+from pyasic.miners.data import (
     DataFunction,
     DataLocations,
     DataOptions,
@@ -32,53 +32,49 @@ from pyasic.web.goldshell import GoldshellWebAPI
 GOLDSHELL_DATA_LOC = DataLocations(
     **{
         str(DataOptions.MAC): DataFunction(
-            "_get_mac", [WebAPICommand("web_setting", "setting")]
+            "_get_mac",
+            [WebAPICommand("web_setting", "setting")],
         ),
         str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_version", "version")]
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [WebAPICommand("web_status", "status")]
+            "_get_fw_ver",
+            [WebAPICommand("web_status", "status")],
         ),
-        str(DataOptions.HOSTNAME): DataFunction("_get_hostname"),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_summary", "summary")]
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_stats", "stats")]
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
         str(DataOptions.HASHBOARDS): DataFunction(
             "_get_hashboards",
             [
-                RPCAPICommand("api_devs", "devs"),
-                RPCAPICommand("api_devdetails", "devdetails"),
+                RPCAPICommand("rpc_devs", "devs"),
+                RPCAPICommand("rpc_devdetails", "devdetails"),
             ],
         ),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction("_get_env_temp"),
-        str(DataOptions.WATTAGE): DataFunction("_get_wattage"),
-        str(DataOptions.WATTAGE_LIMIT): DataFunction("_get_wattage_limit"),
         str(DataOptions.FANS): DataFunction(
-            "_get_fans", [RPCAPICommand("api_stats", "stats")]
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
-        str(DataOptions.ERRORS): DataFunction("_get_errors"),
-        str(DataOptions.FAULT_LIGHT): DataFunction("_get_fault_light"),
-        str(DataOptions.IS_MINING): DataFunction("_is_mining"),
-        str(DataOptions.UPTIME): DataFunction("_get_uptime"),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
 
-class BFGMinerGoldshell(BFGMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver)
-        # interfaces
-        self.web = GoldshellWebAPI(ip)
+class GoldshellMiner(BFGMiner):
+    """Handler for goldshell miners"""
 
-        # static data
-        # data gathering locations
-        self.data_locations = GOLDSHELL_DATA_LOC
+    _web_cls = GoldshellWebAPI
+    web: GoldshellWebAPI
+
+    data_locations = GOLDSHELL_DATA_LOC
+
+    supports_shutdown = True
 
     async def get_config(self) -> MinerConfig:
         # get pool data
@@ -102,45 +98,51 @@ class BFGMinerGoldshell(BFGMiner):
             )
 
         self.config = config
-
+        cfg = config.as_goldshell(user_suffix=user_suffix)
         # send them back 1 at a time
-        for pool in config.as_goldshell(user_suffix=user_suffix)["pools"]:
+        for pool in cfg["pools"]:
             await self.web.newpool(
                 url=pool["url"], user=pool["user"], password=pool["pass"]
             )
 
+        settings = await self.web.setting()
+        for idx, plan in settings["powerplans"]:
+            if plan["level"] == cfg["settings"]["level"]:
+                settings["select"] = idx
+        await self.web.set_setting(settings)
+
     async def _get_mac(self, web_setting: dict = None) -> str:
-        if not web_setting:
+        if web_setting is None:
             try:
                 web_setting = await self.web.setting()
             except APIError:
                 pass
 
-        if web_setting:
+        if web_setting is not None:
             try:
                 return web_setting["name"]
             except KeyError:
                 pass
 
     async def _get_fw_ver(self, web_status: dict = None) -> str:
-        if not web_status:
+        if web_status is None:
             try:
                 web_status = await self.web.setting()
             except APIError:
                 pass
 
-        if web_status:
+        if web_status is not None:
             try:
                 return web_status["firmware"]
             except KeyError:
                 pass
 
     async def _get_hashboards(
-        self, api_devs: dict = None, api_devdetails: dict = None
+        self, rpc_devs: dict = None, rpc_devdetails: dict = None
     ) -> List[HashBoard]:
-        if not api_devs:
+        if rpc_devs is None:
             try:
-                api_devs = await self.api.devs()
+                rpc_devs = await self.rpc.devs()
             except APIError:
                 pass
 
@@ -149,9 +151,9 @@ class BFGMinerGoldshell(BFGMiner):
             for i in range(self.expected_hashboards)
         ]
 
-        if api_devs:
-            if api_devs.get("DEVS"):
-                for board in api_devs["DEVS"]:
+        if rpc_devs is not None:
+            if rpc_devs.get("DEVS"):
+                for board in rpc_devs["DEVS"]:
                     if board.get("ID") is not None:
                         try:
                             b_id = board["ID"]
@@ -163,17 +165,17 @@ class BFGMinerGoldshell(BFGMiner):
                         except KeyError:
                             pass
             else:
-                logger.error(self, api_devs)
+                logger.error(self, rpc_devs)
 
-        if not api_devdetails:
+        if rpc_devdetails is None:
             try:
-                api_devdetails = await self.api.devdetails()
+                rpc_devdetails = await self.rpc.devdetails()
             except APIError:
                 pass
 
-        if api_devdetails:
-            if api_devdetails.get("DEVS"):
-                for board in api_devdetails["DEVS"]:
+        if rpc_devdetails is not None:
+            if rpc_devdetails.get("DEVS"):
+                for board in rpc_devdetails["DEVS"]:
                     if board.get("ID") is not None:
                         try:
                             b_id = board["ID"]
@@ -181,12 +183,28 @@ class BFGMinerGoldshell(BFGMiner):
                         except KeyError:
                             pass
             else:
-                logger.error(self, api_devdetails)
+                logger.error(self, rpc_devdetails)
 
         return hashboards
 
-    async def _is_mining(self, *args, **kwargs) -> Optional[bool]:
-        return None
+    async def stop_mining(self) -> bool:
+        settings = await self.web.setting()
+        mode = MiningModeConfig.sleep()
+        cfg = mode.as_goldshell()
+        level = cfg["settings"]["level"]
+        for idx, plan in settings["powerplans"]:
+            if plan["level"] == level:
+                settings["select"] = idx
+        await self.web.set_setting(settings)
+        return True
 
-    async def _get_uptime(self, *args, **kwargs) -> Optional[int]:
-        return None
+    async def resume_mining(self) -> bool:
+        settings = await self.web.setting()
+        mode = MiningModeConfig.normal()
+        cfg = mode.as_goldshell()
+        level = cfg["settings"]["level"]
+        for idx, plan in settings["powerplans"]:
+            if plan["level"] == level:
+                settings["select"] = idx
+        await self.web.set_setting(settings)
+        return True

pyasic/miners/backends/hiveon.py

@@ -14,67 +14,8 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from typing import List, Optional
-
-from pyasic.data import HashBoard
 from pyasic.miners.backends import BMMiner
-from pyasic.miners.base import DataFunction, DataLocations, DataOptions, RPCAPICommand
-
-HIVEON_DATA_LOC = DataLocations(
-    **{
-        str(DataOptions.MAC): DataFunction("get_mac"),
-        str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_version", "version")]
-        ),
-        str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [RPCAPICommand("api_version", "version")]
-        ),
-        str(DataOptions.HOSTNAME): DataFunction("_get_hostname"),
-        str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_summary", "summary")]
-        ),
-        str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_stats", "stats")]
-        ),
-        str(DataOptions.HASHBOARDS): DataFunction(
-            "_get_hashboards", [RPCAPICommand("api_stats", "stats")]
-        ),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction(
-            "_get_env_temp", [RPCAPICommand("api_stats", "stats")]
-        ),
-        str(DataOptions.WATTAGE): DataFunction(
-            "_get_wattage", [RPCAPICommand("api_stats", "stats")]
-        ),
-        str(DataOptions.WATTAGE_LIMIT): DataFunction("get_wattage_limit"),
-        str(DataOptions.FANS): DataFunction(
-            "_get_fans", [RPCAPICommand("api_stats", "stats")]
-        ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
-        str(DataOptions.ERRORS): DataFunction("_get_errors"),
-        str(DataOptions.FAULT_LIGHT): DataFunction("_get_fault_light"),
-        str(DataOptions.IS_MINING): DataFunction("_is_mining"),
-        str(DataOptions.UPTIME): DataFunction(
-            "_get_uptime", [RPCAPICommand("api_stats", "stats")]
-        ),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
-    }
-)
 
 
 class Hiveon(BMMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver)
-        self.pwd = "admin"
-        # static data
-        self.api_type = "Hiveon"
-        # data gathering locations
-        self.data_locations = HIVEON_DATA_LOC
-
-    async def _get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
-        pass
-
-    async def _get_wattage(self, api_stats: dict = None) -> Optional[int]:
-        pass
-
-    async def _get_env_temp(self, api_stats: dict = None) -> Optional[float]:
-        pass
+    firmware = "Hive"

pyasic/miners/backends/innosilicon.py

@@ -21,7 +21,7 @@ from pyasic.data.error_codes import MinerErrorData
 from pyasic.data.error_codes.innosilicon import InnosiliconError
 from pyasic.errors import APIError
 from pyasic.miners.backends import CGMiner
-from pyasic.miners.base import (
+from pyasic.miners.data import (
     DataFunction,
     DataLocations,
     DataOptions,
@@ -40,35 +40,32 @@ INNOSILICON_DATA_LOC = DataLocations(
             ],
         ),
         str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_version", "version")]
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [RPCAPICommand("api_version", "version")]
+            "_get_fw_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
-        str(DataOptions.HOSTNAME): DataFunction("_get_hostname"),
         str(DataOptions.HASHRATE): DataFunction(
             "_get_hashrate",
             [
-                RPCAPICommand("api_summary", "summary"),
+                RPCAPICommand("rpc_summary", "summary"),
                 WebAPICommand("web_get_all", "getAll"),
             ],
         ),
-        str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate",
-        ),
         str(DataOptions.HASHBOARDS): DataFunction(
             "_get_hashboards",
             [
-                RPCAPICommand("api_stats", "stats"),
+                RPCAPICommand("rpc_stats", "stats"),
                 WebAPICommand("web_get_all", "getAll"),
             ],
         ),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction("_get_env_temp"),
         str(DataOptions.WATTAGE): DataFunction(
             "_get_wattage",
             [
                 WebAPICommand("web_get_all", "getAll"),
-                RPCAPICommand("api_stats", "stats"),
+                RPCAPICommand("rpc_stats", "stats"),
             ],
         ),
         str(DataOptions.WATTAGE_LIMIT): DataFunction(
@@ -83,43 +80,29 @@ INNOSILICON_DATA_LOC = DataLocations(
                 WebAPICommand("web_get_all", "getAll"),
             ],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
         str(DataOptions.ERRORS): DataFunction(
             "_get_errors",
             [
                 WebAPICommand("web_get_error_detail", "getErrorDetail"),
             ],
         ),
-        str(DataOptions.FAULT_LIGHT): DataFunction("_get_fault_light"),
-        str(DataOptions.IS_MINING): DataFunction("_is_mining"),
         str(DataOptions.UPTIME): DataFunction(
-            "_get_uptime", [RPCAPICommand("api_stats", "stats")]
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
 
 class Innosilicon(CGMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver=api_ver)
-        # interfaces
-        self.web = InnosiliconWebAPI(ip)
+    """Base handler for Innosilicon miners"""
 
-        # static data
-        # data gathering locations
-        self.data_locations = INNOSILICON_DATA_LOC
-        # autotuning/shutdown support
-        self.supports_shutdown = True
+    _web_cls = InnosiliconWebAPI
+    web: InnosiliconWebAPI
 
-        # data storage
-        self.api_ver = api_ver
+    data_locations = INNOSILICON_DATA_LOC
 
-    async def fault_light_on(self) -> bool:
-        return False
-
-    async def fault_light_off(self) -> bool:
-        return False
+    supports_shutdown = True
 
     async def get_config(self) -> MinerConfig:
         # get pool data
@@ -150,23 +133,6 @@ class Innosilicon(CGMiner):
     async def restart_backend(self) -> bool:
         return await self.restart_cgminer()
 
-    async def stop_mining(self) -> bool:
-        return False
-        # data = await self.web.poweroff()
-        # try:
-        #     return data["success"]
-        # except KeyError:
-        #     return False
-
-    async def resume_mining(self) -> bool:
-        return False
-        # data = await self.web.restart_cgminer()
-        # print(data)
-        # try:
-        #     return data["success"]
-        # except KeyError:
-        #     return False
-
     async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
         self.config = config
         await self.web.update_pools(config.as_inno(user_suffix=user_suffix))
@@ -181,20 +147,20 @@ class Innosilicon(CGMiner):
         if web_get_all:
             web_get_all = web_get_all["all"]
 
-        if not web_get_all and not web_overview:
+        if web_get_all is None and web_overview is None:
             try:
                 web_overview = await self.web.overview()
             except APIError:
                 pass
 
-        if web_get_all:
+        if web_get_all is not None:
             try:
                 mac = web_get_all["mac"]
                 return mac.upper()
             except KeyError:
                 pass
 
-        if web_overview:
+        if web_overview is not None:
             try:
                 mac = web_overview["version"]["ethaddr"]
                 return mac.upper()
@@ -202,18 +168,18 @@ class Innosilicon(CGMiner):
                 pass
 
     async def _get_hashrate(
-        self, api_summary: dict = None, web_get_all: dict = None
+        self, rpc_summary: dict = None, web_get_all: dict = None
     ) -> Optional[float]:
         if web_get_all:
             web_get_all = web_get_all["all"]
 
-        if not api_summary and not web_get_all:
+        if rpc_summary is None and web_get_all is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if web_get_all:
+        if web_get_all is not None:
             try:
                 if "Hash Rate H" in web_get_all["total_hash"].keys():
                     return round(
@@ -227,14 +193,14 @@ class Innosilicon(CGMiner):
             except KeyError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                return round(float(api_summary["SUMMARY"][0]["MHS 1m"] / 1000000), 2)
+                return round(float(rpc_summary["SUMMARY"][0]["MHS 1m"] / 1000000), 2)
             except (KeyError, IndexError):
                 pass
 
     async def _get_hashboards(
-        self, api_stats: dict = None, web_get_all: dict = None
+        self, rpc_stats: dict = None, web_get_all: dict = None
     ) -> List[HashBoard]:
         if web_get_all:
             web_get_all = web_get_all["all"]
@@ -244,13 +210,13 @@ class Innosilicon(CGMiner):
             for i in range(self.expected_hashboards)
         ]
 
-        if not api_stats:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if not web_get_all:
+        if web_get_all is None:
             try:
                 web_get_all = await self.web.get_all()
             except APIError:
@@ -258,9 +224,9 @@ class Innosilicon(CGMiner):
             else:
                 web_get_all = web_get_all["all"]
 
-        if api_stats:
-            if api_stats.get("STATS"):
-                for board in api_stats["STATS"]:
+        if rpc_stats is not None:
+            if rpc_stats.get("STATS"):
+                for board in rpc_stats["STATS"]:
                     try:
                         idx = board["Chain ID"]
                         chips = board["Num active chips"]
@@ -270,7 +236,7 @@ class Innosilicon(CGMiner):
                         hashboards[idx].chips = chips
                         hashboards[idx].missing = False
 
-        if web_get_all:
+        if web_get_all is not None:
             if web_get_all.get("chain"):
                 for board in web_get_all["chain"]:
                     idx = board.get("ASC")
@@ -292,12 +258,12 @@ class Innosilicon(CGMiner):
         return hashboards
 
     async def _get_wattage(
-        self, web_get_all: dict = None, api_stats: dict = None
+        self, web_get_all: dict = None, rpc_stats: dict = None
     ) -> Optional[int]:
         if web_get_all:
             web_get_all = web_get_all["all"]
 
-        if not web_get_all:
+        if web_get_all is None:
             try:
                 web_get_all = await self.web.get_all()
             except APIError:
@@ -305,21 +271,21 @@ class Innosilicon(CGMiner):
             else:
                 web_get_all = web_get_all["all"]
 
-        if web_get_all:
+        if web_get_all is not None:
             try:
                 return web_get_all["power"]
             except KeyError:
                 pass
 
-        if not api_stats:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
-            if api_stats.get("STATS"):
-                for board in api_stats["STATS"]:
+        if rpc_stats is not None:
+            if rpc_stats.get("STATS"):
+                for board in rpc_stats["STATS"]:
                     try:
                         wattage = board["power"]
                     except KeyError:
@@ -332,7 +298,7 @@ class Innosilicon(CGMiner):
         if web_get_all:
             web_get_all = web_get_all["all"]
 
-        if not web_get_all:
+        if web_get_all is None:
             try:
                 web_get_all = await self.web.get_all()
             except APIError:
@@ -341,7 +307,7 @@ class Innosilicon(CGMiner):
                 web_get_all = web_get_all["all"]
 
         fans = [Fan() for _ in range(self.expected_fans)]
-        if web_get_all:
+        if web_get_all is not None:
             try:
                 spd = web_get_all["fansSpeed"]
             except KeyError:
@@ -357,13 +323,13 @@ class Innosilicon(CGMiner):
         self, web_get_error_detail: dict = None
     ) -> List[MinerErrorData]:
         errors = []
-        if not web_get_error_detail:
+        if web_get_error_detail is None:
             try:
                 web_get_error_detail = await self.web.get_error_detail()
             except APIError:
                 pass
 
-        if web_get_error_detail:
+        if web_get_error_detail is not None:
             try:
                 # only 1 error?
                 # TODO: check if this should be a loop, can't remember.
@@ -380,7 +346,7 @@ class Innosilicon(CGMiner):
         if web_get_all:
             web_get_all = web_get_all["all"]
 
-        if not web_get_all:
+        if web_get_all is None:
             try:
                 web_get_all = await self.web.get_all()
             except APIError:
@@ -388,7 +354,7 @@ class Innosilicon(CGMiner):
             else:
                 web_get_all = web_get_all["all"]
 
-        if web_get_all:
+        if web_get_all is not None:
             try:
                 level = web_get_all["running_mode"]["level"]
             except KeyError:
@@ -398,6 +364,3 @@ class Innosilicon(CGMiner):
                 level = int(level)
                 limit = 1250 + (250 * level)
                 return limit
-
-    async def _get_expected_hashrate(self) -> Optional[float]:
-        pass

pyasic/miners/backends/luxminer.py

@@ -13,87 +13,68 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-from typing import List, Optional, Tuple, Union
+from typing import List, Optional
 
-from pyasic.API.luxminer import LUXMinerAPI
 from pyasic.config import MinerConfig
 from pyasic.data import Fan, HashBoard
-from pyasic.data.error_codes import MinerErrorData
 from pyasic.errors import APIError
-from pyasic.miners.base import (
-    BaseMiner,
-    DataFunction,
-    DataLocations,
-    DataOptions,
-    RPCAPICommand,
-)
+from pyasic.miners.base import BaseMiner
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
+from pyasic.rpc.luxminer import LUXMinerRPCAPI
 
 LUXMINER_DATA_LOC = DataLocations(
     **{
         str(DataOptions.MAC): DataFunction(
-            "_get_mac", [RPCAPICommand("api_config", "config")]
+            "_get_mac",
+            [RPCAPICommand("rpc_config", "config")],
         ),
-        str(DataOptions.API_VERSION): DataFunction("_get_api_ver"),
-        str(DataOptions.FW_VERSION): DataFunction("_get_fw_ver"),
-        str(DataOptions.HOSTNAME): DataFunction("_get_hostname"),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_summary", "summary")]
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_stats", "stats")]
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
         str(DataOptions.HASHBOARDS): DataFunction(
-            "_get_hashboards", [RPCAPICommand("api_stats", "stats")]
+            "_get_hashboards",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction("_get_env_temp"),
         str(DataOptions.WATTAGE): DataFunction(
-            "_get_wattage", [RPCAPICommand("api_power", "power")]
+            "_get_wattage",
+            [RPCAPICommand("rpc_power", "power")],
         ),
-        str(DataOptions.WATTAGE_LIMIT): DataFunction("_get_wattage_limit"),
         str(DataOptions.FANS): DataFunction(
-            "_get_fans", [RPCAPICommand("api_fans", "fans")]
+            "_get_fans",
+            [RPCAPICommand("rpc_fans", "fans")],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
-        str(DataOptions.ERRORS): DataFunction("_get_errors"),
-        str(DataOptions.FAULT_LIGHT): DataFunction("_get_fault_light"),
-        str(DataOptions.IS_MINING): DataFunction("_is_mining"),
         str(DataOptions.UPTIME): DataFunction(
-            "_get_uptime", [RPCAPICommand("api_stats", "stats")]
+            "_get_uptime", [RPCAPICommand("rpc_stats", "stats")]
         ),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
 
 class LUXMiner(BaseMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip)
-        # interfaces
-        self.api = LUXMinerAPI(ip, api_ver)
-        # self.web = BOSMinerWebAPI(ip)
+    """Handler for LuxOS miners"""
 
-        # static data
-        self.api_type = "LUXMiner"
-        self.fw_str = "LuxOS"
-        # data gathering locations
-        self.data_locations = LUXMINER_DATA_LOC
-        # autotuning/shutdown support
-        # self.supports_autotuning = True
-        # self.supports_shutdown = True
+    _rpc_cls = LUXMinerRPCAPI
+    rpc: LUXMinerRPCAPI
 
-        # data storage
-        self.api_ver = api_ver
+    firmware = "LuxOS"
+
+    data_locations = LUXMINER_DATA_LOC
 
     async def _get_session(self) -> Optional[str]:
         try:
-            data = await self.api.session()
+            data = await self.rpc.session()
             if not data["SESSION"][0]["SessionID"] == "":
                 return data["SESSION"][0]["SessionID"]
         except APIError:
             pass
 
         try:
-            data = await self.api.logon()
+            data = await self.rpc.logon()
             return data["SESSION"][0]["SessionID"]
         except (LookupError, APIError):
             return
@@ -102,7 +83,7 @@ class LUXMiner(BaseMiner):
         try:
             session_id = await self._get_session()
             if session_id:
-                await self.api.ledset(session_id, "red", "blink")
+                await self.rpc.ledset(session_id, "red", "blink")
             return True
         except (APIError, LookupError):
             pass
@@ -112,7 +93,7 @@ class LUXMiner(BaseMiner):
         try:
             session_id = await self._get_session()
             if session_id:
-                await self.api.ledset(session_id, "red", "off")
+                await self.rpc.ledset(session_id, "red", "off")
             return True
         except (APIError, LookupError):
             pass
@@ -125,7 +106,7 @@ class LUXMiner(BaseMiner):
         try:
             session_id = await self._get_session()
             if session_id:
-                await self.api.resetminer(session_id)
+                await self.rpc.resetminer(session_id)
             return True
         except (APIError, LookupError):
             pass
@@ -135,7 +116,7 @@ class LUXMiner(BaseMiner):
         try:
             session_id = await self._get_session()
             if session_id:
-                await self.api.curtail(session_id)
+                await self.rpc.curtail(session_id)
             return True
         except (APIError, LookupError):
             pass
@@ -145,7 +126,7 @@ class LUXMiner(BaseMiner):
         try:
             session_id = await self._get_session()
             if session_id:
-                await self.api.wakeup(session_id)
+                await self.rpc.wakeup(session_id)
             return True
         except (APIError, LookupError):
             pass
@@ -154,7 +135,7 @@ class LUXMiner(BaseMiner):
         try:
             session_id = await self._get_session()
             if session_id:
-                await self.api.rebootdevice(session_id)
+                await self.rpc.rebootdevice(session_id)
             return True
         except (APIError, LookupError):
             pass
@@ -163,70 +144,52 @@ class LUXMiner(BaseMiner):
     async def get_config(self) -> MinerConfig:
         return self.config
 
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        pass
-
-    async def set_power_limit(self, wattage: int) -> bool:
-        return False
-
     ##################################################
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
     ##################################################
 
-    async def _get_mac(self, api_config: dict = None) -> Optional[str]:
+    async def _get_mac(self, rpc_config: dict = None) -> Optional[str]:
         mac = None
-        if not api_config:
+        if rpc_config is None:
             try:
-                api_config = await self.api.config()
+                rpc_config = await self.rpc.config()
             except APIError:
                 return None
 
-        if api_config:
+        if rpc_config is not None:
             try:
-                mac = api_config["CONFIG"][0]["MACAddr"]
+                mac = rpc_config["CONFIG"][0]["MACAddr"]
             except KeyError:
                 return None
 
         return mac
 
-    async def get_version(self) -> Tuple[Optional[str], Optional[str]]:
-        pass
-
-    async def _get_api_ver(self) -> Optional[str]:
-        pass
-
-    async def _get_fw_ver(self) -> Optional[str]:
-        pass
-
-    async def _get_hostname(self) -> Union[str, None]:
-        pass
-
-    async def _get_hashrate(self, api_summary: dict = None) -> Optional[float]:
-        if not api_summary:
+    async def _get_hashrate(self, rpc_summary: dict = None) -> Optional[float]:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
-                return round(float(api_summary["SUMMARY"][0]["GHS 5s"] / 1000), 2)
+                return round(float(rpc_summary["SUMMARY"][0]["GHS 5s"] / 1000), 2)
             except (LookupError, ValueError, TypeError):
                 pass
 
-    async def _get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
+    async def _get_hashboards(self, rpc_stats: dict = None) -> List[HashBoard]:
         hashboards = []
 
-        if not api_stats:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
                 board_offset = -1
-                boards = api_stats["STATS"]
+                boards = rpc_stats["STATS"]
                 if len(boards) > 1:
                     for board_num in range(1, 16, 5):
                         for _b_num in range(5):
@@ -268,63 +231,48 @@ class LUXMiner(BaseMiner):
 
         return hashboards
 
-    async def _get_env_temp(self) -> Optional[float]:
-        return None
-
-    async def _get_wattage(self, api_power: dict) -> Optional[int]:
-        if not api_power:
+    async def _get_wattage(self, rpc_power: dict = None) -> Optional[int]:
+        if rpc_power is None:
             try:
-                api_power = await self.api.power()
+                rpc_power = await self.rpc.power()
             except APIError:
                 pass
 
-        if api_power:
+        if rpc_power is not None:
             try:
-                return api_power["POWER"][0]["Watts"]
+                return rpc_power["POWER"][0]["Watts"]
             except (LookupError, ValueError, TypeError):
                 pass
 
-    async def _get_wattage_limit(self) -> Optional[int]:
-        return None
-
-    async def _get_fans(self, api_fans: dict = None) -> List[Fan]:
-        if not api_fans:
+    async def _get_fans(self, rpc_fans: dict = None) -> List[Fan]:
+        if rpc_fans is None:
             try:
-                api_fans = await self.api.fans()
+                rpc_fans = await self.rpc.fans()
             except APIError:
                 pass
 
         fans = []
 
-        if api_fans:
+        if rpc_fans is not None:
             for fan in range(self.expected_fans):
                 try:
-                    fans.append(Fan(api_fans["FANS"][fan]["RPM"]))
+                    fans.append(Fan(rpc_fans["FANS"][fan]["RPM"]))
                 except (LookupError, ValueError, TypeError):
                     fans.append(Fan())
         return fans
 
-    async def _get_fan_psu(self) -> Optional[int]:
-        return None
-
-    async def _get_errors(self) -> List[MinerErrorData]:
-        pass
-
-    async def _get_fault_light(self) -> bool:
-        pass
-
-    async def _get_expected_hashrate(self, api_stats: dict = None) -> Optional[float]:
-        if not api_stats:
+    async def _get_expected_hashrate(self, rpc_stats: dict = None) -> Optional[float]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                expected_rate = api_stats["STATS"][1]["total_rateideal"]
+                expected_rate = rpc_stats["STATS"][1]["total_rateideal"]
                 try:
-                    rate_unit = api_stats["STATS"][1]["rate_unit"]
+                    rate_unit = rpc_stats["STATS"][1]["rate_unit"]
                 except KeyError:
                     rate_unit = "GH"
                 if rate_unit == "GH":
@@ -336,18 +284,15 @@ class LUXMiner(BaseMiner):
             except LookupError:
                 pass
 
-    async def _is_mining(self) -> Optional[bool]:
-        pass
-
-    async def _get_uptime(self, api_stats: dict = None) -> Optional[int]:
-        if not api_stats:
+    async def _get_uptime(self, rpc_stats: dict = None) -> Optional[int]:
+        if rpc_stats is None:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
+        if rpc_stats is not None:
             try:
-                return int(api_stats["STATS"][1]["Elapsed"])
+                return int(rpc_stats["STATS"][1]["Elapsed"])
             except LookupError:
                 pass

pyasic/miners/backends/unknown.py

@@ -1,26 +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.                                              -
-# ------------------------------------------------------------------------------
+#  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 typing import List, Optional, Tuple
 
-from pyasic.API.unknown import UnknownAPI
 from pyasic.config import MinerConfig
-from pyasic.data import Fan, HashBoard, MinerData
+from pyasic.data import Fan, HashBoard
 from pyasic.data.error_codes import MinerErrorData
 from pyasic.miners.base import BaseMiner
+from pyasic.rpc.unknown import UnknownRPCAPI
 
 
 class UnknownMiner(BaseMiner):
@@ -32,7 +30,7 @@ class UnknownMiner(BaseMiner):
     ) -> None:
         super().__init__(ip)
         self.ip = ip
-        self.api = UnknownAPI(ip)
+        self.rpc = UnknownRPCAPI(ip)
 
     def __repr__(self) -> str:
         return f"Unknown: {str(self.ip)}"
@@ -73,60 +71,53 @@ class UnknownMiner(BaseMiner):
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
     ##################################################
 
-    async def get_mac(self) -> Optional[str]:
+    async def _get_mac(self) -> Optional[str]:
         return None
 
-    async def get_version(self) -> Tuple[Optional[str], Optional[str]]:
+    async def _get_version(self) -> Tuple[Optional[str], Optional[str]]:
         return None, None
 
-    async def get_hostname(self) -> Optional[str]:
+    async def _get_hostname(self) -> Optional[str]:
         return None
 
-    async def get_hashrate(self) -> Optional[float]:
+    async def _get_hashrate(self) -> Optional[float]:
         return None
 
-    async def get_hashboards(self) -> List[HashBoard]:
+    async def _get_hashboards(self) -> List[HashBoard]:
         return []
 
-    async def get_env_temp(self) -> Optional[float]:
+    async def _get_env_temp(self) -> Optional[float]:
         return None
 
-    async def get_wattage(self) -> Optional[int]:
+    async def _get_wattage(self) -> Optional[int]:
         return None
 
-    async def get_wattage_limit(self) -> Optional[int]:
+    async def _get_wattage_limit(self) -> Optional[int]:
         return None
 
-    async def get_fans(
-        self,
-    ) -> List[Fan]:
+    async def _get_fans(self) -> List[Fan]:
         return [Fan(), Fan(), Fan(), Fan()]
 
-    async def get_fan_psu(self) -> Optional[int]:
+    async def _get_fan_psu(self) -> Optional[int]:
         return None
 
-    async def get_api_ver(self) -> Optional[str]:
+    async def _get_api_ver(self) -> Optional[str]:
         return None
 
-    async def get_fw_ver(self) -> Optional[str]:
+    async def _get_fw_ver(self) -> Optional[str]:
         return None
 
-    async def get_errors(self) -> List[MinerErrorData]:
+    async def _get_errors(self) -> List[MinerErrorData]:
         return []
 
-    async def get_fault_light(self) -> bool:
+    async def _get_fault_light(self) -> bool:
         return False
 
-    async def get_expected_hashrate(self) -> Optional[float]:
+    async def _get_expected_hashrate(self) -> Optional[float]:
         return None
 
-    async def is_mining(self, *args, **kwargs) -> Optional[bool]:
+    async def _is_mining(self, *args, **kwargs) -> Optional[bool]:
         return None
 
-    async def get_uptime(self, *args, **kwargs) -> Optional[int]:
+    async def _get_uptime(self, *args, **kwargs) -> Optional[int]:
         return None
-
-    async def get_data(
-        self, allow_warning: bool = False, data_to_get: list = None, **kwargs
-    ) -> MinerData:
-        return MinerData(ip=str(self.ip))

pyasic/miners/backends/vnish.py

@@ -18,9 +18,8 @@ from typing import Optional
 
 from pyasic import MinerConfig
 from pyasic.errors import APIError
-from pyasic.logger import logger
 from pyasic.miners.backends.bmminer import BMMiner
-from pyasic.miners.base import (
+from pyasic.miners.data import (
     DataFunction,
     DataLocations,
     DataOptions,
@@ -32,57 +31,62 @@ from pyasic.web.vnish import VNishWebAPI
 VNISH_DATA_LOC = DataLocations(
     **{
         str(DataOptions.MAC): DataFunction(
-            "_get_mac", [WebAPICommand("web_summary", "summary")]
+            "_get_mac",
+            [WebAPICommand("web_summary", "summary")],
         ),
         str(DataOptions.API_VERSION): DataFunction(
-            "_get_api_ver", [RPCAPICommand("api_version", "version")]
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
         ),
         str(DataOptions.FW_VERSION): DataFunction(
-            "_get_fw_ver", [WebAPICommand("web_summary", "summary")]
+            "_get_fw_ver",
+            [WebAPICommand("web_summary", "summary")],
         ),
         str(DataOptions.HOSTNAME): DataFunction(
-            "_get_hostname", [WebAPICommand("web_summary", "summary")]
+            "_get_hostname",
+            [WebAPICommand("web_summary", "summary")],
         ),
         str(DataOptions.HASHRATE): DataFunction(
-            "_get_hashrate", [RPCAPICommand("api_summary", "summary")]
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
         ),
         str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-            "_get_expected_hashrate", [RPCAPICommand("api_stats", "stats")]
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
         str(DataOptions.HASHBOARDS): DataFunction(
-            "_get_hashboards", [RPCAPICommand("api_stats", "stats")]
+            "_get_hashboards",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.ENVIRONMENT_TEMP): DataFunction("_get_env_temp"),
         str(DataOptions.WATTAGE): DataFunction(
-            "_get_wattage", [WebAPICommand("web_summary", "summary")]
+            "_get_wattage",
+            [WebAPICommand("web_summary", "summary")],
         ),
         str(DataOptions.WATTAGE_LIMIT): DataFunction(
-            "_get_wattage_limit", [WebAPICommand("web_settings", "settings")]
+            "_get_wattage_limit",
+            [WebAPICommand("web_settings", "settings")],
         ),
         str(DataOptions.FANS): DataFunction(
-            "_get_fans", [RPCAPICommand("api_stats", "stats")]
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.UPTIME): DataFunction(
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
         ),
-        str(DataOptions.FAN_PSU): DataFunction("_get_fan_psu"),
-        str(DataOptions.ERRORS): DataFunction("_get_errors"),
-        str(DataOptions.FAULT_LIGHT): DataFunction("_get_fault_light"),
-        str(DataOptions.IS_MINING): DataFunction("_is_mining"),
-        str(DataOptions.UPTIME): DataFunction("_get_uptime"),
-        str(DataOptions.CONFIG): DataFunction("get_config"),
     }
 )
 
 
 class VNish(BMMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver)
-        # interfaces
-        self.web = VNishWebAPI(ip)
+    """Handler for VNish miners"""
 
-        # static data
-        self.api_type = "VNish"
-        self.fw_str = "VNish"
-        # data gathering locations
-        self.data_locations = VNISH_DATA_LOC
+    _web_cls = VNishWebAPI
+    web: VNishWebAPI
+
+    firmware = "VNish"
+
+    data_locations = VNISH_DATA_LOC
 
     async def restart_backend(self) -> bool:
         data = await self.web.restart_vnish()
@@ -121,17 +125,17 @@ class VNish(BMMiner):
         return False
 
     async def _get_mac(self, web_summary: dict = None) -> str:
-        if not web_summary:
+        if web_summary is None:
             web_info = await self.web.info()
 
-            if web_info:
+            if web_info is not None:
                 try:
                     mac = web_info["system"]["network_status"]["mac"]
                     return mac
                 except KeyError:
                     pass
 
-        if web_summary:
+        if web_summary is not None:
             try:
                 mac = web_summary["system"]["network_status"]["mac"]
                 return mac
@@ -139,17 +143,17 @@ class VNish(BMMiner):
                 pass
 
     async def _get_hostname(self, web_summary: dict = None) -> str:
-        if not web_summary:
+        if web_summary is None:
             web_info = await self.web.info()
 
-            if web_info:
+            if web_info is not None:
                 try:
                     hostname = web_info["system"]["network_status"]["hostname"]
                     return hostname
                 except KeyError:
                     pass
 
-        if web_summary:
+        if web_summary is not None:
             try:
                 hostname = web_summary["system"]["network_status"]["hostname"]
                 return hostname
@@ -157,39 +161,38 @@ class VNish(BMMiner):
                 pass
 
     async def _get_wattage(self, web_summary: dict = None) -> Optional[int]:
-        if not web_summary:
+        if web_summary is None:
             web_summary = await self.web.summary()
 
-        if web_summary:
+        if web_summary is not None:
             try:
                 wattage = web_summary["miner"]["power_usage"]
-                wattage = round(wattage * 1000)
+                wattage = round(wattage)
                 return wattage
             except KeyError:
                 pass
 
-    async def _get_hashrate(self, api_summary: dict = None) -> Optional[float]:
+    async def _get_hashrate(self, rpc_summary: dict = None) -> Optional[float]:
         # get hr from API
-        if not api_summary:
+        if rpc_summary is None:
             try:
-                api_summary = await self.api.summary()
+                rpc_summary = await self.rpc.summary()
             except APIError:
                 pass
 
-        if api_summary:
+        if rpc_summary is not None:
             try:
                 return round(
-                    float(float(api_summary["SUMMARY"][0]["GHS 5s"]) / 1000), 2
+                    float(float(rpc_summary["SUMMARY"][0]["GHS 5s"]) / 1000), 2
                 )
-            except (LookupError, ValueError, TypeError) as e:
-                logger.error(e)
+            except (LookupError, ValueError, TypeError):
                 pass
 
     async def _get_wattage_limit(self, web_settings: dict = None) -> Optional[int]:
-        if not web_settings:
+        if web_settings is None:
             web_settings = await self.web.summary()
 
-        if web_settings:
+        if web_settings is not None:
             try:
                 wattage_limit = web_settings["miner"]["overclock"]["preset"]
                 if wattage_limit == "disabled":
@@ -199,22 +202,17 @@ class VNish(BMMiner):
                 pass
 
     async def _get_fw_ver(self, web_summary: dict = None) -> Optional[str]:
-        if not web_summary:
+        if web_summary is None:
             web_summary = await self.web.summary()
 
-        if web_summary:
+        fw_ver = None
+        if web_summary is not None:
             try:
                 fw_ver = web_summary["miner"]["miner_type"]
                 fw_ver = fw_ver.split("(Vnish ")[1].replace(")", "")
                 return fw_ver
-            except KeyError:
-                pass
-
-    async def _is_mining(self, *args, **kwargs) -> Optional[bool]:
-        return None
-
-    async def _get_uptime(self, *args, **kwargs) -> Optional[int]:
-        return None
+            except LookupError:
+                return fw_ver
 
     async def get_config(self) -> MinerConfig:
         try:

pyasic/miners/backends/whatsminer.py

@@ -17,21 +17,15 @@ from pyasic.miners.backends.btminer import BTMiner
 
 
 class M6X(BTMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.supports_autotuning = True
+    supports_autotuning = True
 
 
 class M5X(BTMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.supports_autotuning = True
+    supports_autotuning = True
 
 
 class M3X(BTMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.supports_autotuning = True
+    supports_autotuning = True
 
 
 class M2X(BTMiner):

pyasic/miners/base.py

@@ -15,119 +15,44 @@
 # ------------------------------------------------------------------------------
 import asyncio
 import ipaddress
-import logging
-from abc import ABC, abstractmethod
-from dataclasses import dataclass, field, make_dataclass
-from enum import Enum
-from typing import List, Optional, Tuple, TypeVar, Union
-
-import asyncssh
+import warnings
+from typing import List, Optional, Protocol, Tuple, Type, TypeVar, Union
 
 from pyasic.config import MinerConfig
 from pyasic.data import Fan, HashBoard, MinerData
 from pyasic.data.error_codes import MinerErrorData
 from pyasic.errors import APIError
 from pyasic.logger import logger
+from pyasic.miners.data import DataLocations, DataOptions, RPCAPICommand, WebAPICommand
 
 
-class DataOptions(Enum):
-    MAC = "mac"
-    API_VERSION = "api_ver"
-    FW_VERSION = "fw_ver"
-    HOSTNAME = "hostname"
-    HASHRATE = "hashrate"
-    EXPECTED_HASHRATE = "expected_hashrate"
-    HASHBOARDS = "hashboards"
-    ENVIRONMENT_TEMP = "env_temp"
-    WATTAGE = "wattage"
-    WATTAGE_LIMIT = "wattage_limit"
-    FANS = "fans"
-    FAN_PSU = "fan_psu"
-    ERRORS = "errors"
-    FAULT_LIGHT = "fault_light"
-    IS_MINING = "is_mining"
-    UPTIME = "uptime"
-    CONFIG = "config"
+class MinerProtocol(Protocol):
+    _rpc_cls: Type = None
+    _web_cls: Type = None
+    _ssh_cls: Type = None
 
-    def __str__(self):
-        return self.value
+    ip: str = None
+    rpc: _rpc_cls = None
+    web: _web_cls = None
+    ssh: _ssh_cls = None
 
+    make: str = None
+    raw_model: str = None
+    firmware: str = None
 
-@dataclass
-class RPCAPICommand:
-    name: str
-    cmd: str
+    expected_hashboards: int = 3
+    expected_chips: int = None
+    expected_fans: int = 2
 
+    data_locations: DataLocations = None
 
-@dataclass
-class WebAPICommand:
-    name: str
-    cmd: str
+    supports_shutdown: bool = False
+    supports_autotuning: bool = False
 
-
-@dataclass
-class GRPCCommand(WebAPICommand):
-    name: str
-    cmd: str
-
-
-@dataclass
-class GraphQLCommand(WebAPICommand):
-    name: str
-    cmd: dict
-
-
-@dataclass
-class DataFunction:
-    cmd: str
-    kwargs: list[
-        Union[RPCAPICommand, WebAPICommand, GRPCCommand, GraphQLCommand]
-    ] = field(default_factory=list)
-
-
-DataLocations = make_dataclass(
-    "DataLocations",
-    [(enum_value.value, str) for enum_value in DataOptions],
-)
-# add default value with
-# [(enum_value.value, str, , DataFunction(enum_value.value)) for enum_value in DataOptions],
-
-
-class BaseMiner(ABC):
-    def __init__(self, ip: str, *args, **kwargs) -> None:
-        # interfaces
-        self.api = None
-        self.web = None
-
-        self.ssh_pwd = "root"
-
-        # static data
-        self.ip = ip
-        self.api_type = None
-        # type
-        self.make = None
-        self.raw_model = None
-        self.fw_str = None
-        # physical attributes
-        self.expected_hashboards = 3
-        self.expected_chips = 0
-        self.expected_fans = 2
-        # data gathering locations
-        self.data_locations: DataLocations = None
-        # autotuning/shutdown support
-        self.supports_autotuning = False
-        self.supports_shutdown = False
-
-        # data storage
-        self.api_ver = None
-        self.fw_ver = None
-        self.light = None
-        self.config = None
-
-    def __new__(cls, *args, **kwargs):
-        if cls is BaseMiner:
-            raise TypeError(f"Only children of '{cls.__name__}' may be instantiated")
-        return object.__new__(cls)
+    api_ver: str = None
+    fw_ver: str = None
+    light: bool = None
+    config: MinerConfig = None
 
     def __repr__(self):
         return f"{self.model}: {str(self.ip)}"
@@ -142,110 +67,35 @@ class BaseMiner(ABC):
         return ipaddress.ip_address(self.ip) == ipaddress.ip_address(other.ip)
 
     @property
-    def model(self):
+    def model(self) -> str:
         model_data = [self.raw_model if self.raw_model is not None else "Unknown"]
-        if self.fw_str is not None:
-            model_data.append(f"({self.fw_str})")
+        if self.firmware is not None:
+            model_data.append(f"({self.firmware})")
         return " ".join(model_data)
 
     @property
-    def pwd(self):  # noqa - Skip PyCharm inspection
-        data = []
-        try:
-            if self.web is not None:
-                data.append(f"web={self.web.pwd}")
-        except TypeError:
-            pass
-        try:
-            if self.api is not None:
-                data.append(f"api={self.api.pwd}")
-        except TypeError:
-            pass
-        return ",".join(data)
-
-    @pwd.setter
-    def pwd(self, val):
-        self.ssh_pwd = val
-        try:
-            if self.web is not None:
-                self.web.pwd = val
-        except TypeError:
-            pass
-        try:
-            if self.api is not None:
-                self.api.pwd = val
-        except TypeError:
-            pass
-
-    @property
-    def username(self):  # noqa - Skip PyCharm inspection
-        data = []
-        try:
-            if self.web is not None:
-                data.append(f"web={self.web.username}")
-        except TypeError:
-            pass
-        return ",".join(data)
-
-    @username.setter
-    def username(self, val):
-        try:
-            if self.web is not None:
-                self.web.username = val
-        except TypeError:
-            pass
-
-    async def _get_ssh_connection(self) -> asyncssh.connect:
-        """Create a new asyncssh connection"""
-        try:
-            conn = await asyncssh.connect(
-                str(self.ip),
-                known_hosts=None,
-                username="root",
-                password=self.ssh_pwd,
-                server_host_key_algs=["ssh-rsa"],
-            )
-            return conn
-        except asyncssh.misc.PermissionDenied:
-            try:
-                conn = await asyncssh.connect(
-                    str(self.ip),
-                    known_hosts=None,
-                    username="root",
-                    password="admin",
-                    server_host_key_algs=["ssh-rsa"],
-                )
-                return conn
-            except Exception as e:
-                raise ConnectionError from e
-        except OSError as e:
-            logging.warning(f"Connection refused: {self}")
-            raise ConnectionError from e
-        except Exception as e:
-            raise ConnectionError from e
+    def api(self):
+        return self.rpc
 
     async def check_light(self) -> bool:
         return await self.get_fault_light()
 
-    @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
+        return False
 
-    @abstractmethod
     async def fault_light_off(self) -> bool:
         """Turn the fault light of the miner off and return success as a boolean.
 
         Returns:
             A boolean value of the success of turning the light off.
         """
-        pass
+        return False
 
-    @abstractmethod
     async def get_config(self) -> MinerConfig:
         # Not a data gathering function, since this is used for configuration
         """Get the mining configuration of the miner and return it as a [`MinerConfig`][pyasic.config.MinerConfig].
@@ -253,27 +103,24 @@ class BaseMiner(ABC):
         Returns:
             A [`MinerConfig`][pyasic.config.MinerConfig] containing the pool information and mining configuration.
         """
-        pass
+        return MinerConfig()
 
-    @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
+        return False
 
-    @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
+        return False
 
-    @abstractmethod
     async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
         """Set the mining configuration of the miner.
 
@@ -283,25 +130,22 @@ class BaseMiner(ABC):
         """
         return None
 
-    @abstractmethod
     async def stop_mining(self) -> bool:
         """Stop the mining process of the miner.
 
         Returns:
             A boolean value of the success of stopping the mining process.
         """
-        pass
+        return False
 
-    @abstractmethod
     async def resume_mining(self) -> bool:
         """Resume the mining process of the miner.
 
         Returns:
             A boolean value of the success of resuming the mining process.
         """
-        pass
+        return False
 
-    @abstractmethod
     async def set_power_limit(self, wattage: int) -> bool:
         """Set the power limit to be used by the miner.
 
@@ -311,7 +155,7 @@ class BaseMiner(ABC):
         Returns:
             A boolean value of the success of setting the power limit.
         """
-        pass
+        return False
 
     ##################################################
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
@@ -463,68 +307,52 @@ class BaseMiner(ABC):
         """
         return await self._get_uptime()
 
-    @abstractmethod
-    async def _get_mac(self, *args, **kwargs) -> Optional[str]:
+    async def _get_mac(self) -> Optional[str]:
         pass
 
-    @abstractmethod
-    async def _get_api_ver(self, *args, **kwargs) -> Optional[str]:
+    async def _get_api_ver(self) -> Optional[str]:
         pass
 
-    @abstractmethod
-    async def _get_fw_ver(self, *args, **kwargs) -> Optional[str]:
+    async def _get_fw_ver(self) -> Optional[str]:
         pass
 
-    @abstractmethod
-    async def _get_hostname(self, *args, **kwargs) -> Optional[str]:
+    async def _get_hostname(self) -> Optional[str]:
         pass
 
-    @abstractmethod
-    async def _get_hashrate(self, *args, **kwargs) -> Optional[float]:
+    async def _get_hashrate(self) -> Optional[float]:
         pass
 
-    @abstractmethod
-    async def _get_hashboards(self, *args, **kwargs) -> List[HashBoard]:
+    async def _get_hashboards(self) -> List[HashBoard]:
+        return []
+
+    async def _get_env_temp(self) -> Optional[float]:
         pass
 
-    @abstractmethod
-    async def _get_env_temp(self, *args, **kwargs) -> Optional[float]:
+    async def _get_wattage(self) -> Optional[int]:
         pass
 
-    @abstractmethod
-    async def _get_wattage(self, *args, **kwargs) -> Optional[int]:
+    async def _get_wattage_limit(self) -> Optional[int]:
         pass
 
-    @abstractmethod
-    async def _get_wattage_limit(self, *args, **kwargs) -> Optional[int]:
+    async def _get_fans(self) -> List[Fan]:
+        return []
+
+    async def _get_fan_psu(self) -> Optional[int]:
         pass
 
-    @abstractmethod
-    async def _get_fans(self, *args, **kwargs) -> List[Fan]:
+    async def _get_errors(self) -> List[MinerErrorData]:
+        return []
+
+    async def _get_fault_light(self) -> Optional[bool]:
         pass
 
-    @abstractmethod
-    async def _get_fan_psu(self, *args, **kwargs) -> Optional[int]:
+    async def _get_expected_hashrate(self) -> Optional[float]:
         pass
 
-    @abstractmethod
-    async def _get_errors(self, *args, **kwargs) -> List[MinerErrorData]:
+    async def _is_mining(self) -> Optional[bool]:
         pass
 
-    @abstractmethod
-    async def _get_fault_light(self, *args, **kwargs) -> bool:
-        pass
-
-    @abstractmethod
-    async def _get_expected_hashrate(self, *args, **kwargs) -> Optional[float]:
-        pass
-
-    @abstractmethod
-    async def _is_mining(self, *args, **kwargs) -> Optional[bool]:
-        pass
-
-    @abstractmethod
-    async def _get_uptime(self, *args, **kwargs) -> Optional[int]:
+    async def _get_uptime(self) -> Optional[int]:
         pass
 
     async def _get_data(
@@ -633,7 +461,9 @@ class BaseMiner(ABC):
             ip=str(self.ip),
             make=self.make,
             model=self.model,
-            expected_chips=self.expected_chips * self.expected_hashboards,
+            expected_chips=self.expected_chips * self.expected_hashboards
+            if self.expected_chips is not None
+            else 0,
             expected_hashboards=self.expected_hashboards,
             hashboards=[
                 HashBoard(slot=i, expected_chips=self.expected_chips)
@@ -651,4 +481,23 @@ class BaseMiner(ABC):
         return data
 
 
+class BaseMiner(MinerProtocol):
+    def __init__(self, ip: str) -> None:
+        self.ip = ip
+
+        if self.expected_chips is None and self.raw_model is not None:
+            warnings.warn(
+                f"Unknown chip count for miner type {self.raw_model}, "
+                f"please open an issue on GitHub (https://github.com/UpstreamData/pyasic)."
+            )
+
+        # interfaces
+        if self._rpc_cls is not None:
+            self.rpc = self._rpc_cls(ip)
+        if self._web_cls is not None:
+            self.web = self._web_cls(ip)
+        if self._ssh_cls is not None:
+            self.ssh = self._ssh_cls(ip)
+
+
 AnyMiner = TypeVar("AnyMiner", bound=BaseMiner)