version: bump version number.

fix send_config for ePIC

README.md

@@ -1,142 +1,249 @@
 # pyasic
 *A simplified and standardized interface for Bitcoin ASICs.*
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![PyPI - Version](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
-[![pypi](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyasic)](https://pypi.org/project/pyasic/)
-[![python](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
-[![Read the Docs](https://img.shields.io/readthedocs/pyasic)](https://pyasic.readthedocs.io/en/latest/)
-[![GitHub](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
-[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)
-## Documentation and Supported Miners
-Documentation is located on Read the Docs as [pyasic](https://pyasic.readthedocs.io/en/latest/).
 
-Supported miners are listed in the docs, [here](https://pyasic.readthedocs.io/en/latest/miners/supported_types/).
+[![Python - Supported Versions](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![CodeFactor - Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)
+[![Commit Activity - master](https://img.shields.io/github/commit-activity/y/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/commits/master/)
 
-## Installation
+[![Code Style - Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-You can install pyasic directly from pip with the command `pip install pyasic`.
+[![Read The Docs - Docs](https://img.shields.io/readthedocs/pyasic)](https://pyasic.readthedocs.io/en/latest/)
+[![License - Apache 2.0](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
 
-For those of you who aren't comfortable with code and developer tools, there are windows builds of GUI applications that use this library [here](https://drive.google.com/drive/folders/1DjR8UOS_g0ehfiJcgmrV0FFoqFvE9akW?usp=sharing).
+---
+## Intro
 
-## Developer Setup
+Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with ASIC miners on your network, which makes it super fast.
-It is highly reccommended that you contribute to this project through [`pyasic-super`](https://github.com/UpstreamData/pyasic-super) using its submodules.  This allows testing in conjunction with other `pyasic` related programs.
 
-<br>
+[Click here to view supported miner types](miners/supported_types.md)
 
-This repo uses poetry for dependencies, which can be installed by following the guide on their website [here](https://python-poetry.org/docs/#installation).
+---
+## Getting started
 
-After you have poetry installed, run `poetry install --with dev`, or `poetry install --with dev,docs` if you want to include packages required for documentation.
+Getting started with `pyasic` is easy.  First, find your miner (or miners) on the network by scanning for them or getting the correct class automatically for them if you know the IP.
 
-Finally, initialize pre-commit hooks with `poetry run pre-commit install`.
+##### Scanning for miners
-
+To scan for miners in `pyasic`, we use the class `MinerNetwork`, which abstracts the search, communication, identification, setup, and return of a miner to 1 command.
-### Documentation Testing
+The command `MinerNetwork.scan()` returns a list that contains any miners found.
-Testing the documentation can be done by running `poetry run mkdocs serve`, whcih will serve the documentation locally on port 8000.
-
-## Interfacing with miners programmatically
-
-There are 2 main ways to get a miner (and the functions attached to it), via scanning or via the `MinerFactory()`.
-
-#### Scanning for miners
 ```python
-import asyncio
+import asyncio  # asyncio for handling the async part
-
+from pyasic.network import MinerNetwork  # miner network handles the scanning
-from pyasic.network import MinerNetwork
 
 
-# define asynchronous function to scan for miners
+async def scan_miners():  # define async scan function to allow awaiting
-async def scan_and_get_data():
+    # create a miner network
-    # Define network range to be used for scanning
+    # you can pass in any IP and it will use that in a subnet with a /24 mask (255 IPs).
-    # This can take a list of IPs, a constructor string, or an IP and subnet mask
+    network = MinerNetwork.from_subnet("192.168.1.50/24")  # this uses the 192.168.1.0-255 network
-    # The standard mask is /24 (x.x.x.0-255), and you can pass any IP address in the subnet
-    net = MinerNetwork("192.168.1.69", mask=24)
-    # Scan the network for miners
-    # This function returns a list of miners of the correct type as a class
-    miners: list = await net.scan_network_for_miners()
 
-    # We can now get data from any of these miners
+    # scan for miners asynchronously
-    # To do them all we have to create a list of tasks and gather them
+    # this will return the correct type of miners if they are supported with all functionality.
-    tasks = [miner.get_data() for miner in miners]
+    miners = await network.scan()
-    # Gather all tasks asynchronously and run them
+    print(miners)
-    data = await asyncio.gather(*tasks)
-
-    # Data is now a list of MinerData, and we can reference any part of that
-    # Print out all data for now
-    for item in data:
-        print(item)
 
 if __name__ == "__main__":
-    asyncio.run(scan_and_get_data())
+    asyncio.run(scan_miners())  # run the scan asynchronously with asyncio.run()
 ```
 
+---
+##### Creating miners based on IP
+If you already know the IP address of your miner or miners, you can use the `MinerFactory` to communicate and identify the miners, or an abstraction of its functionality, `get_miner()`.
+The function `get_miner()` will return any miner it found at the IP address specified, or an `UnknownMiner` if it cannot identify the miner.
+```python
+import asyncio  # asyncio for handling the async part
+from pyasic import get_miner # handles miner creation
 
-#### Getting a miner if you know the IP
+
+async def get_miners():  # define async scan function to allow awaiting
+    # get the miner with the miner factory
+    # the miner factory is a singleton, and will always use the same object and cache
+    # this means you can always call it as MinerFactory().get_miner(), or just get_miner()
+    miner_1 = await get_miner("192.168.1.75")
+    miner_2 = await get_miner("192.168.1.76")
+    print(miner_1, miner_2)
+
+    # can also gather these, since they are async
+    # gathering them will get them both at the same time
+    # this makes it much faster to get a lot of miners at a time
+    tasks = [get_miner("192.168.1.75"), get_miner("192.168.1.76")]
+    miners = await asyncio.gather(*tasks)
+    print(miners)
+
+
+if __name__ == "__main__":
+    asyncio.run(get_miners())  # get the miners asynchronously with asyncio.run()
+```
+
+---
+## Data gathering
+
+Once you have your miner(s) identified, you will likely want to get data from the miner(s).  You can do this using a built-in function in each miner called `get_data()`.
+This function will return an instance of the dataclass `MinerData` with all data it can gather from the miner.
+Each piece of data in a `MinerData` instance can be referenced by getting it as an attribute, such as `MinerData().hashrate`.
+
+##### One miner
 ```python
 import asyncio
+from pyasic import get_miner
 
+async def gather_miner_data():
+    miner = await get_miner("192.168.1.75")
+    if miner is not None:
+        miner_data = await miner.get_data()
+        print(miner_data)  # all data from the dataclass
+        print(miner_data.hashrate)  # hashrate of the miner in TH/s
+
+if __name__ == "__main__":
+    asyncio.run(gather_miner_data())
+```
+---
+##### Multiple miners
+You can do something similar with multiple miners, with only needing to make a small change to get all the data at once.
+```python
+import asyncio  # asyncio for handling the async part
+from pyasic.network import MinerNetwork  # miner network handles the scanning
+
+
+async def gather_miner_data():  # define async scan function to allow awaiting
+    network = MinerNetwork.from_subnet("192.168.1.50/24")
+    miners = await network.scan()
+
+    # we need to asyncio.gather() all the miners get_data() functions to make them run together
+    all_miner_data = await asyncio.gather(*[miner.get_data() for miner in miners])
+
+    for miner_data in all_miner_data:
+        print(miner_data)    # print out all the data one by one
+
+if __name__ == "__main__":
+    asyncio.run(gather_miner_data())
+```
+
+---
+## 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`.
+
+These functions are
+`check_light`,
+`fault_light_off`,
+`fault_light_on`,
+`get_config`,
+`get_data`,
+`get_errors`,
+`get_hostname`,
+`get_model`,
+`reboot`,
+`restart_backend`,
+`stop_mining`,
+`resume_mining`,
+`is_mining`,
+`send_config`, and
+`set_power_limit`.
+
+##### Usage
+```python
+import asyncio
 from pyasic import get_miner
 
 
-# define asynchronous function to get miner and data
+async def set_fault_light():
-async def get_miner_data(miner_ip: str):
+    miner = await get_miner("192.168.1.20")
-    # Use MinerFactory to get miner
-    # MinerFactory is a singleton, so we can just get the instance in place
-    miner = await get_miner(miner_ip)
 
-    # Get data from the miner
+    # call control function
-    data = await miner.get_data()
+    await miner.fault_light_on()
-    print(data)
 
 if __name__ == "__main__":
-    asyncio.run(get_miner_data("192.168.1.69"))
+    asyncio.run(set_fault_light())
 ```
 
-### Advanced data gathering
+---
+## Helper dataclasses
 
-If needed, this library exposes a wrapper for the miner API that can be used for advanced data gathering.
+##### `MinerConfig` and `MinerData`
 
-You can see more information on basic usage of the APIs past this example in the docs [here](https://pyasic.readthedocs.io/en/latest/API/api/).
+`pyasic` implements a few dataclasses as helpers to make data return types consistent across different miners and miner APIs.  The different fields of these dataclasses can all be viewed with the classmethod `cls.fields()`.
 
-Please see the appropriate API documentation page (pyasic docs -> Advanced -> Miner APIs -> your API type) for a link to that specific miner's API documentation page and more information.
+---
 
-#### List available API commands
+##### MinerData
+
+`MinerData` is a return from the [`get_data()`](#get-data) function, and is used to have a consistent dataset across all returns.
+
+You can call `MinerData.as_dict()` to get the dataclass as a dictionary, and there are many other helper functions contained in the class to convert to different data formats.
+
+`MinerData` instances can also be added to each other to combine their data and can be divided by a number to divide all their data, allowing you to get average data from many miners by doing -
+```python
+from pyasic import MinerData
+
+# examples of miner data
+d1 = MinerData("192.168.1.1")
+d2 = MinerData("192.168.1.2")
+
+list_of_miner_data = [d1, d2]
+
+average_data = sum(list_of_miner_data, start=MinerData("0.0.0.0"))/len(list_of_miner_data)
+```
+
+---
+
+##### MinerConfig
+
+`MinerConfig` is `pyasic`'s way to represent a configuration file from a miner.
+It is designed to unionize the configuration of all supported miner types, and is the return from [`get_config()`](#get-config).
+
+Each miner has a unique way to convert the `MinerConfig` to their specific type, there are helper functions in the class.
+In most cases these helper functions should not be used, as [`send_config()`](#send-config) takes a [`MinerConfig` and will do the conversion to the right type for you.
+
+You can use the `MinerConfig` as follows:
 ```python
 import asyncio
-
 from pyasic import get_miner
 
 
-async def get_api_commands(miner_ip: str):
+async def set_fault_light():
-    # Get the miner
+    miner = await get_miner("192.168.1.20")
-    miner = await get_miner(miner_ip)
 
-    # List all available commands
+    # get config
-    # Can also be called explicitly with the function miner.api.get_commands()
+    cfg = await miner.get_config()
-    print(miner.api.commands)
 
+    # send config
+    await miner.send_config(cfg)
 
 if __name__ == "__main__":
-    asyncio.run(get_api_commands("192.168.1.69"))
+    asyncio.run(set_fault_light())
+
 ```
 
-#### Use miner API commands to gather data
+---
+## Settings
 
-The miner API commands will raise an `APIError` if they fail with a bad status code, to bypass this you must send them manually by using `miner.api.send_command(command, ignore_errors=True)`
+`pyasic` has settings designed to make using large groups of miners easier.  You can set the default password for all types of miners using the `pyasic.settings` module, used as follows:
 
 ```python
-import asyncio
+from pyasic import settings
 
-from pyasic import get_miner
+settings.update("default_antminer_password", "my_pwd")
-
+```
-
+
-async def get_api_commands(miner_ip: str):
+##### Default values:
-    # Get the miner
+```
-    miner = await get_miner(miner_ip)
+"network_ping_retries": 1,
-
+"network_ping_timeout": 3,
-    # Run the devdetails command
+"network_scan_threads": 300,
-    # This is equivalent to await miner.api.send_command("devdetails")
+"factory_get_retries": 1,
-    devdetails: dict = await miner.api.devdetails()
+"factory_get_timeout": 3,
-    print(devdetails)
+"get_data_retries": 1,
-
+"api_function_timeout": 5,
-
+"default_whatsminer_password": "admin",
-if __name__ == "__main__":
+"default_innosilicon_password": "admin",
-    asyncio.run(get_api_commands("192.168.1.69"))
+"default_antminer_password": "root",
+"default_bosminer_password": "root",
+"default_vnish_password": "admin",
+"default_goldshell_password": "123456789",
+
+# ADVANCED
+# Only use this if you know what you are doing
+"socket_linger_time": 1000,
 ```

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/data/miner_data.md

@@ -1,6 +1,6 @@
 # pyasic
-## Miner Data
 
+## Miner Data
 ::: pyasic.data.MinerData
     handler: python
     options:
@@ -13,3 +13,10 @@
     options:
         show_root_heading: false
         heading_level: 4
+
+## Fan Data
+::: pyasic.data.Fan
+    handler: python
+    options:
+        show_root_heading: false
+        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

@@ -1,12 +1,15 @@
 # pyasic
-*A set of modules for interfacing with many common types of ASIC bitcoin miners, using both their API and SSH.*
+*A simplified and standardized interface for Bitcoin ASICs.*
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
-[![pypi](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![PyPI - Version](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
-[![python](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyasic)](https://pypi.org/project/pyasic/)
-[![Read the Docs](https://img.shields.io/readthedocs/pyasic)](https://pyasic.readthedocs.io/en/latest/)
+[![Python - Supported Versions](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
-[![GitHub](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
+[![CodeFactor - Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)
-[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)
+[![Commit Activity - master](https://img.shields.io/github/commit-activity/y/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/commits/master/)
+[![Code Style - Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Read The Docs - Docs](https://img.shields.io/readthedocs/pyasic)](https://pyasic.readthedocs.io/en/latest/)
+[![License - Apache 2.0](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
 
 ---
 ## Intro
@@ -44,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
@@ -119,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],
+[`check_light`][pyasic.miners.base.MinerProtocol.check_light],
-[`fault_light_off`][pyasic.miners.BaseMiner.fault_light_off],
+[`fault_light_off`][pyasic.miners.base.MinerProtocol.fault_light_off],
-[`fault_light_on`][pyasic.miners.BaseMiner.fault_light_on],
+[`fault_light_on`][pyasic.miners.base.MinerProtocol.fault_light_on],
-[`get_config`][pyasic.miners.BaseMiner.get_config],
+[`get_config`][pyasic.miners.base.MinerProtocol.get_config],
-[`get_data`][pyasic.miners.BaseMiner.get_data],
+[`get_data`][pyasic.miners.base.MinerProtocol.get_data],
-[`get_errors`][pyasic.miners.BaseMiner.get_errors],
+[`get_errors`][pyasic.miners.base.MinerProtocol.get_errors],
-[`get_hostname`][pyasic.miners.BaseMiner.get_hostname],
+[`get_hostname`][pyasic.miners.base.MinerProtocol.get_hostname],
-[`get_model`][pyasic.miners.BaseMiner.get_model],
+[`get_model`][pyasic.miners.base.MinerProtocol.get_model],
-[`reboot`][pyasic.miners.BaseMiner.reboot],
+[`reboot`][pyasic.miners.base.MinerProtocol.reboot],
-[`restart_backend`][pyasic.miners.BaseMiner.restart_backend],
+[`restart_backend`][pyasic.miners.base.MinerProtocol.restart_backend],
-[`stop_mining`][pyasic.miners.BaseMiner.stop_mining],
+[`stop_mining`][pyasic.miners.base.MinerProtocol.stop_mining],
-[`resume_mining`][pyasic.miners.BaseMiner.resume_mining],
+[`resume_mining`][pyasic.miners.base.MinerProtocol.resume_mining],
-[`is_mining`][pyasic.miners.BaseMiner.is_mining],
+[`is_mining`][pyasic.miners.base.MinerProtocol.is_mining],
-[`send_config`][pyasic.miners.BaseMiner.send_config], and
+[`send_config`][pyasic.miners.base.MinerProtocol.send_config], and
-[`set_power_limit`][pyasic.miners.BaseMiner.set_power_limit].
+[`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/innosilicon/A10X.md

@@ -2,9 +2,8 @@
 ## A10X Models
 
 ## A10X
-::: pyasic.miners.innosilicon.cgminer.A10X.A10X.CGMinerA10X
+::: pyasic.miners.innosilicon.cgminer.A10X.A10X.InnosiliconA10X
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-

docs/miners/innosilicon/T3X.md

@@ -2,9 +2,8 @@
 ## T3X Models
 
 ## T3H+
-::: pyasic.miners.innosilicon.cgminer.T3X.T3H.CGMinerT3HPlus
+::: pyasic.miners.innosilicon.cgminer.T3X.T3H.InnosiliconT3HPlus
     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.
+[`AnyMiner`][pyasic.miners.base.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],
+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/requirements.txt

@@ -1,3 +1,3 @@
-jinja2<3.1.0
+jinja2<3.1.3
 mkdocs
 mkdocstrings[python]

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
+## BFGMinerRPCAPI
-::: pyasic.API.bfgminer.BFGMinerAPI
+::: pyasic.rpc.bfgminer.BFGMinerRPCAPI
     handler: python
     options:
         show_root_heading: false

docs/rpc/bmminer.md

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

docs/rpc/bosminer.md

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

docs/rpc/btminer.md

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

docs/rpc/cgminer.md

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

docs/rpc/luxminer.md

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

docs/rpc/unknown.md

@@ -1,6 +1,6 @@
 # pyasic
-## UnknownAPI
+## UnknownRPCAPI
-::: pyasic.API.unknown.UnknownAPI
+::: 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:
+    - RPC APIs:
-        - Intro: "API/api.md"
+        - Intro: "rpc/api.md"
-        - BFGMiner: "API/bfgminer.md"
+        - BFGMiner: "rpc/bfgminer.md"
-        - BMMiner: "API/bmminer.md"
+        - BMMiner: "rpc/bmminer.md"
-        - BOSMiner: "API/bosminer.md"
+        - BOSMiner: "rpc/bosminer.md"
-        - BTMiner: "API/btminer.md"
+        - BTMiner: "rpc/btminer.md"
-        - CGMiner: "API/cgminer.md"
+        - CGMiner: "rpc/cgminer.md"
-        - LUXMiner: "API/luxminer.md"
+        - LUXMiner: "rpc/luxminer.md"
-        - Unknown: "API/unknown.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,45 +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 (
+from pyasic.data import MinerData
-    BraiinsOSError,
-    InnosiliconError,
-    MinerData,
-    WhatsminerError,
-    X19Error,
-)
 from pyasic.errors import APIError, APIWarning
-from pyasic.miners import get_miner
+from pyasic.miners import *
-from pyasic.miners.base import AnyMiner
-from pyasic.miners.miner_factory import MinerFactory, miner_factory
-from pyasic.miners.miner_listener import MinerListener
 from pyasic.network import MinerNetwork
-
+from pyasic.rpc import *
-__all__ = [
+from pyasic.ssh import *
-    "BMMinerAPI",
+from pyasic.web import *
-    "BOSMinerAPI",
-    "BTMinerAPI",
-    "CGMinerAPI",
-    "UnknownAPI",
-    "MinerConfig",
-    "MinerData",
-    "BraiinsOSError",
-    "InnosiliconError",
-    "WhatsminerError",
-    "X19Error",
-    "APIError",
-    "APIWarning",
-    "get_miner",
-    "AnyMiner",
-    "MinerFactory",
-    "miner_factory",
-    "MinerListener",
-    "MinerNetwork",
-    "settings",
-]

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,30 +93,38 @@ 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(),
         }
 
-    def as_bos_grpc(self, user_suffix: str = None) -> dict:
+    def as_boser(self, user_suffix: str = None) -> dict:
         return {
-            **self.fan_mode.as_bos_grpc(),
+            **self.fan_mode.as_boser(),
-            **self.temperature.as_bos_grpc(),
+            **self.temperature.as_boser(),
-            **self.mining_mode.as_bos_grpc(),
+            **self.mining_mode.as_boser(),
-            **self.pools.as_bos_grpc(user_suffix=user_suffix),
+            **self.pools.as_boser(user_suffix=user_suffix),
-            **self.power_scaling.as_bos_grpc(),
+            **self.power_scaling.as_boser(),
         }
 
     def as_epic(self, user_suffix: str = None) -> dict:
         return {
-            **self.fan_mode.as_epic(),
+            **merge_dicts(self.fan_mode.as_epic(), self.temperature.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(
@@ -161,13 +169,38 @@ class MinerConfig:
             power_scaling=PowerScalingConfig.from_bosminer(toml_conf),
         )
 
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict) -> "MinerConfig":
+        return cls(
+            pools=PoolConfig.from_boser(grpc_miner_conf),
+            mining_mode=MiningModeConfig.from_boser(grpc_miner_conf),
+            fan_mode=FanModeConfig.from_boser(grpc_miner_conf),
+            temperature=TemperatureConfig.from_boser(grpc_miner_conf),
+            power_scaling=PowerScalingConfig.from_boser(grpc_miner_conf),
+        )
 
-def merge(a: dict, b: dict) -> dict:
+    @classmethod
-    result = deepcopy(a)
+    def from_epic(cls, web_conf: dict) -> "MinerConfig":
-    for b_key, b_val in b.items():
+        return cls(
-        a_val = result.get(b_key)
+            pools=PoolConfig.from_epic(web_conf),
-        if isinstance(a_val, dict) and isinstance(b_val, dict):
+            fan_mode=FanModeConfig.from_epic(web_conf),
-            result[b_key] = merge(a_val, b_val)
+            temperature=TemperatureConfig.from_epic(web_conf),
-        else:
+            mining_mode=MiningModeConfig.from_epic(web_conf),
-            result[b_key] = deepcopy(b_val)
+        )
-    return result
+
+    @classmethod
+    def from_vnish(cls, web_settings: dict) -> "MinerConfig":
+        return cls(
+            pools=PoolConfig.from_vnish(web_settings),
+            fan_mode=FanModeConfig.from_vnish(web_settings),
+            temperature=TemperatureConfig.from_vnish(web_settings),
+            mining_mode=MiningModeConfig.from_vnish(web_settings),
+        )
+
+    @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:
@@ -44,12 +45,18 @@ class MinerConfigOption(Enum):
     def as_bosminer(self) -> dict:
         return self.value.as_bosminer()
 
-    def as_bos_grpc(self) -> dict:
+    def as_boser(self) -> dict:
-        return self.value.as_bos_grpc()
+        return self.value.as_boser()
 
     def as_epic(self) -> dict:
         return self.value.as_epic()
 
+    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)
 
@@ -61,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:
@@ -88,8 +95,14 @@ class MinerConfigValue:
     def as_bosminer(self) -> dict:
         return {}
 
-    def as_bos_grpc(self) -> dict:
+    def as_boser(self) -> dict:
         return {}
 
     def as_epic(self) -> dict:
         return {}
+
+    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
 
@@ -22,10 +23,26 @@ from pyasic.config.base import MinerConfigOption, MinerConfigValue
 @dataclass
 class FanModeNormal(MinerConfigValue):
     mode: str = field(init=False, default="normal")
+    minimum_fans: int = 1
+    minimum_speed: int = 0
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "FanModeNormal":
+    def from_dict(cls, dict_conf: dict | None) -> "FanModeNormal":
-        return cls()
+        cls_conf = {}
+        if dict_conf.get("minimum_fans") is not None:
+            cls_conf["minimum_fans"] = dict_conf["minimum_fans"]
+        if dict_conf.get("minimum_speed") is not None:
+            cls_conf["minimum_speed"] = dict_conf["minimum_speed"]
+        return cls(**cls_conf)
+
+    @classmethod
+    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"]
+        if web_cooling_settings.get("fan_min_duty") is not None:
+            cls_conf["minimum_speed"] = web_cooling_settings["fan_min_duty"]
+        return cls(**cls_conf)
 
     def as_am_modern(self) -> dict:
         return {"bitmain-fan-ctrl": False, "bitmain-fan-pwn": "100"}
@@ -33,20 +50,31 @@ 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):
     mode: str = field(init=False, default="manual")
-    minimum_fans: int = 1
     speed: int = 100
+    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("min_fans") is not None:
-            cls_conf["minimum_fans"] = dict_conf["minimum_fans"]
         if dict_conf.get("speed") is not None:
             cls_conf["speed"] = dict_conf["speed"]
+        if dict_conf.get("minimum_fans") is not None:
+            cls_conf["minimum_fans"] = dict_conf["minimum_fans"]
         return cls(**cls_conf)
 
     @classmethod
@@ -58,6 +86,15 @@ class FanModeManual(MinerConfigValue):
             cls_conf["speed"] = toml_fan_conf["speed"]
         return cls(**cls_conf)
 
+    @classmethod
+    def from_vnish(cls, web_cooling_settings: dict) -> "FanModeManual":
+        cls_conf = {}
+        if web_cooling_settings.get("fan_min_count") is not None:
+            cls_conf["minimum_fans"] = web_cooling_settings["fan_min_count"]
+        if web_cooling_settings["mode"].get("param") is not None:
+            cls_conf["speed"] = web_cooling_settings["mode"]["param"]
+        return cls(**cls_conf)
+
     def as_am_modern(self) -> dict:
         return {"bitmain-fan-ctrl": True, "bitmain-fan-pwn": str(self.speed)}
 
@@ -67,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:
@@ -82,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
@@ -93,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()
 
@@ -101,9 +147,9 @@ class FanModeConfig(MinerConfigOption):
         if mode is None:
             return cls.default()
 
-        clsattr = getattr(cls, mode)
+        cls_attr = getattr(cls, mode)
-        if clsattr is not None:
+        if cls_attr is not None:
-            return clsattr().from_dict(dict_conf)
+            return cls_attr().from_dict(dict_conf)
 
     @classmethod
     def from_am_modern(cls, web_conf: dict):
@@ -116,6 +162,17 @@ class FanModeConfig(MinerConfigOption):
         else:
             return cls.default()
 
+    @classmethod
+    def from_epic(cls, web_conf: dict):
+        try:
+            fan_mode = web_conf["Fans"]["Fan Mode"]
+            if fan_mode.get("Manual") is not None:
+                return cls.manual(speed=fan_mode.get("Manual"))
+            else:
+                return cls.normal()
+        except KeyError:
+            return cls.default()
+
     @classmethod
     def from_bosminer(cls, toml_conf: dict):
         if toml_conf.get("temp_control") is None:
@@ -132,3 +189,47 @@ class FanModeConfig(MinerConfigOption):
             return cls.manual()
         elif mode == "disabled":
             return cls.immersion()
+
+    @classmethod
+    def from_vnish(cls, web_settings: dict):
+        try:
+            mode = web_settings["miner"]["cooling"]["mode"]["name"]
+        except LookupError:
+            return cls.default()
+
+        if mode == "auto":
+            return cls.normal().from_vnish(web_settings["miner"]["cooling"])
+        elif mode == "manual":
+            return cls.manual().from_vnish(web_settings["miner"]["cooling"])
+        elif mode == "immers":
+            return cls.immersion()
+
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict):
+        try:
+            temperature_conf = grpc_miner_conf["temperature"]
+        except LookupError:
+            return cls.default()
+
+        keys = temperature_conf.keys()
+        if "auto" in keys:
+            if "minimumRequiredFans" in keys:
+                return cls.normal(temperature_conf["minimumRequiredFans"])
+            return cls.normal()
+        if "manual" in keys:
+            conf = {}
+            if "fanSpeedRatio" in temperature_conf["manual"].keys():
+                conf["speed"] = int(temperature_conf["manual"]["fanSpeedRatio"])
+            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,10 +13,21 @@
 #  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 (
+    HashrateTargetMode,
+    PerformanceMode,
+    Power,
+    PowerTargetMode,
+    SaveAction,
+    SetPerformanceModeRequest,
+    TeraHashrate,
+    TunerPerformanceMode,
+)
 
 
 @dataclass
@@ -24,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:
@@ -33,13 +44,19 @@ 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}}
+
 
 @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:
@@ -48,13 +65,19 @@ 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}}
+
 
 @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:
@@ -63,30 +86,74 @@ class MiningModeLPM(MinerConfigValue):
     def as_wm(self) -> dict:
         return {"mode": self.mode}
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": "eco"}}
+
 
 @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":
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModePowerTune":
-        return cls(dict_conf.get("power"))
+        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"}
@@ -99,19 +166,59 @@ class MiningModePowerTune(MinerConfigValue):
     def as_bosminer(self) -> dict:
         return {"autotuning": {"enabled": True, "psu_power_limit": self.power}}
 
+    def as_boser(self) -> dict:
+        return {
+            "set_performance_mode": SetPerformanceModeRequest(
+                save_action=SaveAction.SAVE_ACTION_SAVE_AND_APPLY,
+                mode=PerformanceMode(
+                    tuner_mode=TunerPerformanceMode(
+                        power_target=PowerTargetMode(
+                            power_target=Power(watt=self.power)
+                        )
+                    )
+                ),
+            ),
+        }
+
+    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:
         return {"miner-mode": "0"}
 
+    def as_boser(self) -> dict:
+        return {
+            "set_performance_mode": SetPerformanceModeRequest(
+                save_action=SaveAction.SAVE_ACTION_SAVE_AND_APPLY,
+                mode=PerformanceMode(
+                    tuner_mode=TunerPerformanceMode(
+                        hashrate_target=HashrateTargetMode(
+                            hashrate_target=TeraHashrate(
+                                terahash_per_second=self.hashrate
+                            )
+                        )
+                    )
+                ),
+            )
+        }
+
+    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):
@@ -119,7 +226,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:
@@ -135,7 +242,7 @@ class MiningModeManual(MinerConfigValue):
     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"],
@@ -145,6 +252,20 @@ class MiningModeManual(MinerConfigValue):
     def as_am_modern(self) -> dict:
         return {"miner-mode": "0"}
 
+    @classmethod
+    def from_vnish(cls, web_overclock_settings: dict) -> "MiningModeManual":
+        # will raise KeyError if it cant find the settings, values cannot be empty
+        voltage = web_overclock_settings["globals"]["volt"]
+        freq = web_overclock_settings["globals"]["freq"]
+        boards = {
+            idx: ManualBoardSettings(
+                freq=board["freq"],
+                volt=voltage if not board["freq"] == 0 else 0,
+            )
+            for idx, board in enumerate(web_overclock_settings["chains"])
+        }
+        return cls(global_freq=freq, global_volt=voltage, boards=boards)
+
 
 class MiningModeConfig(MinerConfigOption):
     normal = MiningModeNormal
@@ -160,7 +281,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()
 
@@ -168,9 +289,9 @@ class MiningModeConfig(MinerConfigOption):
         if mode is None:
             return cls.default()
 
-        clsattr = getattr(cls, mode)
+        cls_attr = getattr(cls, mode)
-        if clsattr is not None:
+        if cls_attr is not None:
-            return clsattr().from_dict(dict_conf)
+            return cls_attr().from_dict(dict_conf)
 
     @classmethod
     def from_am_modern(cls, web_conf: dict):
@@ -186,6 +307,27 @@ class MiningModeConfig(MinerConfigOption):
                 return cls.low()
         return cls.default()
 
+    @classmethod
+    def from_epic(cls, web_conf: dict):
+        try:
+            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(
+                        hashrate=algo_info["VoltageOptimizer"]["Target"],
+                        algo=TunerAlgo.voltage_optimizer,
+                    )
+                else:
+                    return cls.hashrate_tuning(
+                        hashrate=algo_info["ChipTune"]["Target"],
+                        algo=TunerAlgo.chip_tune,
+                    )
+            else:
+                return cls.normal()
+        except KeyError:
+            return cls.default()
+
     @classmethod
     def from_bosminer(cls, toml_conf: dict):
         if toml_conf.get("autotuning") is None:
@@ -211,3 +353,64 @@ class MiningModeConfig(MinerConfigOption):
                 if autotuning_conf.get("hashrate_target") is not None:
                     return cls.hashrate_tuning(autotuning_conf["hashrate_target"])
                 return cls.hashrate_tuning()
+
+    @classmethod
+    def from_vnish(cls, web_settings: dict):
+        try:
+            mode_settings = web_settings["miner"]["overclock"]
+        except KeyError:
+            return cls.default()
+
+        if mode_settings["preset"] == "disabled":
+            return MiningModeManual.from_vnish(mode_settings)
+        else:
+            return cls.power_tuning(int(mode_settings["preset"]))
+
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict):
+        try:
+            tuner_conf = grpc_miner_conf["tuner"]
+            if not tuner_conf.get("enabled", False):
+                return cls.default()
+        except LookupError:
+            return cls.default()
+
+        if tuner_conf.get("tunerMode") is not None:
+            if tuner_conf["tunerMode"] == 1:
+                if tuner_conf.get("powerTarget") is not None:
+                    return cls.power_tuning(tuner_conf["powerTarget"]["watt"])
+                return cls.power_tuning()
+
+            if tuner_conf["tunerMode"] == 2:
+                if tuner_conf.get("hashrateTarget") is not None:
+                    return cls.hashrate_tuning(
+                        int(tuner_conf["hashrateTarget"]["terahashPerSecond"])
+                    )
+                return cls.hashrate_tuning()
+
+        if tuner_conf.get("powerTarget") is not None:
+            return cls.power_tuning(tuner_conf["powerTarget"]["watt"])
+
+        if tuner_conf.get("hashrateTarget") is not None:
+            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 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"]
         )
@@ -108,6 +128,12 @@ class Pool(MinerConfigValue):
     def from_api(cls, api_pool: dict) -> "Pool":
         return cls(url=api_pool["URL"], user=api_pool["User"], password="x")
 
+    @classmethod
+    def from_epic(cls, api_pool: dict) -> "Pool":
+        return cls(
+            url=api_pool["pool"], user=api_pool["login"], password=api_pool["password"]
+        )
+
     @classmethod
     def from_am_modern(cls, web_pool: dict) -> "Pool":
         return cls(
@@ -135,6 +161,22 @@ class Pool(MinerConfigValue):
             password=toml_pool_conf["password"],
         )
 
+    @classmethod
+    def from_vnish(cls, web_pool: dict) -> "Pool":
+        return cls(
+            url=web_pool["url"],
+            user=web_pool["user"],
+            password=web_pool["pass"],
+        )
+
+    @classmethod
+    def from_boser(cls, grpc_pool: dict) -> "Pool":
+        return cls(
+            url=grpc_pool["url"],
+            user=grpc_pool["user"],
+            password=grpc_pool["password"],
+        )
+
 
 @dataclass
 class PoolGroup(MinerConfigValue):
@@ -188,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()
@@ -219,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:
@@ -237,6 +285,13 @@ class PoolGroup(MinerConfigValue):
             pools.append(Pool.from_api(pool))
         return cls(pools=pools)
 
+    @classmethod
+    def from_epic(cls, api_pool_list: list) -> "PoolGroup":
+        pools = []
+        for pool in api_pool_list:
+            pools.append(Pool.from_epic(pool))
+        return cls(pools=pools)
+
     @classmethod
     def from_am_modern(cls, web_pool_list: list) -> "PoolGroup":
         pools = []
@@ -262,24 +317,41 @@ class PoolGroup(MinerConfigValue):
             )
         return cls()
 
+    @classmethod
+    def from_vnish(cls, web_settings_pools: dict) -> "PoolGroup":
+        return cls([Pool.from_vnish(p) for p in web_settings_pools])
+
+    @classmethod
+    def from_boser(cls, grpc_pool_group: dict) -> "PoolGroup":
+        try:
+            return cls(
+                pools=[Pool.from_boser(p) for p in grpc_pool_group["pools"]],
+                name=grpc_pool_group["name"],
+                quota=grpc_pool_group["quota"]["value"]
+                if grpc_pool_group.get("quota") is not None
+                else 1,
+            )
+        except LookupError:
+            return cls()
+
 
 @dataclass
 class PoolConfig(MinerConfigValue):
-    groups: list[PoolGroup] = field(default_factory=list)
+    groups: List[PoolGroup] = field(default_factory=list)
 
     @classmethod
     def default(cls) -> "PoolConfig":
         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):
@@ -324,16 +396,50 @@ class PoolConfig(MinerConfigValue):
             }
         return {"group": [PoolGroup().as_bosminer()]}
 
-    def as_bos_grpc(self, user_suffix: str = None) -> dict:
+    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":
-        pool_data = api_pools["POOLS"]
+        try:
+            pool_data = api_pools["POOLS"]
+        except KeyError:
+            return PoolConfig.default()
         pool_data = sorted(pool_data, key=lambda x: int(x["POOL"]))
 
         return cls([PoolGroup.from_api(pool_data)])
 
+    @classmethod
+    def from_epic(cls, web_conf: dict) -> "PoolConfig":
+        pool_data = web_conf["StratumConfigs"]
+        return cls([PoolGroup.from_epic(pool_data)])
+
     @classmethod
     def from_am_modern(cls, web_conf: dict) -> "PoolConfig":
         pool_data = web_conf["pools"]
@@ -354,3 +460,22 @@ class PoolConfig(MinerConfigValue):
             return cls()
 
         return cls([PoolGroup.from_bosminer(g) for g in toml_conf["group"]])
+
+    @classmethod
+    def from_vnish(cls, web_settings: dict) -> "PoolConfig":
+        try:
+            return cls([PoolGroup.from_vnish(web_settings["miner"]["pools"])])
+        except LookupError:
+            return cls()
+
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict) -> "PoolConfig":
+        try:
+            return cls(
+                groups=[
+                    PoolGroup.from_boser(group)
+                    for group in grpc_miner_conf["poolGroups"]
+                ]
+            )
+        except LookupError:
+            return cls()

pyasic/config/power_scaling.py

@@ -13,11 +13,17 @@
 #  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.bosminer.proto.braiins.bos.v1 import DpsPowerTarget, DpsTarget, Hours
+from pyasic.web.braiins_os.proto.braiins.bos.v1 import (
+    DpsPowerTarget,
+    DpsTarget,
+    Power,
+    SetDpsRequest,
+)
 
 
 @dataclass
@@ -26,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:
@@ -37,13 +43,8 @@ class PowerScalingShutdownEnabled(MinerConfigValue):
 
         return cfg
 
-    def as_bos_grpc(self) -> dict:
+    def as_boser(self) -> dict:
-        cfg = {"enable_shutdown ": True}
+        return {"enable_shutdown": True, "shutdown_duration": self.duration}
-
-        if self.duration is not None:
-            cfg["shutdown_duration"] = Hours(self.duration)
-
-        return cfg
 
 
 @dataclass
@@ -51,13 +52,13 @@ 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:
         return {"shutdown_enabled": False}
 
-    def as_bos_grpc(self) -> dict:
+    def as_boser(self) -> dict:
         return {"enable_shutdown ": False}
 
 
@@ -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()
 
@@ -88,15 +89,26 @@ class PowerScalingShutdown(MinerConfigOption):
                 return cls.disabled()
         return None
 
+    @classmethod
+    def from_boser(cls, power_scaling_conf: dict):
+        sd_enabled = power_scaling_conf.get("shutdownEnabled")
+        if sd_enabled is not None:
+            if sd_enabled:
+                try:
+                    return cls.enabled(power_scaling_conf["shutdownDuration"]["hours"])
+                except KeyError:
+                    return cls.enabled()
+            else:
+                return cls.disabled()
+        return None
+
 
 @dataclass
 class PowerScalingEnabled(MinerConfigValue):
     mode: str = field(init=False, default="enabled")
     power_step: int = None
     minimum_power: int = None
-    shutdown_enabled: Union[
+    shutdown_enabled: PowerScalingShutdownEnabled | PowerScalingShutdownDisabled = None
-        PowerScalingShutdownEnabled, PowerScalingShutdownDisabled
-    ] = None
 
     @classmethod
     def from_bosminer(cls, power_scaling_conf: dict) -> "PowerScalingEnabled":
@@ -109,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"),
@@ -133,20 +145,19 @@ class PowerScalingEnabled(MinerConfigValue):
 
         return {"power_scaling": cfg}
 
-    def as_bos_grpc(self) -> dict:
+    def as_boser(self) -> dict:
-        cfg = {"enable": True}
+        return {
-        target_conf = {}
+            "set_dps": SetDpsRequest(
-        if self.power_step is not None:
+                enable=True,
-            target_conf["power_step"] = self.power_step
+                **self.shutdown_enabled.as_boser(),
-        if self.minimum_power is not None:
+                target=DpsTarget(
-            target_conf["min_power_target"] = self.minimum_power
+                    power_target=DpsPowerTarget(
-
+                        power_step=Power(self.power_step),
-        cfg["target"] = DpsTarget(power_target=DpsPowerTarget(**target_conf))
+                        min_power_target=Power(self.minimum_power),
-
+                    )
-        if self.shutdown_enabled is not None:
+                ),
-            cfg = {**cfg, **self.shutdown_enabled.as_bos_grpc()}
+            ),
-
+        }
-        return {"dps": cfg}
 
 
 @dataclass
@@ -163,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()
 
@@ -187,3 +198,20 @@ class PowerScalingConfig(MinerConfigOption):
                     return cls.disabled()
 
         return cls.default()
+
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict):
+        try:
+            dps_conf = grpc_miner_conf["dps"]
+            if not dps_conf.get("enabled", False):
+                return cls.disabled()
+        except LookupError:
+            return cls.default()
+
+        conf = {"shutdown_enabled": PowerScalingShutdown.from_boser(dps_conf)}
+
+        if dps_conf.get("minPowerTarget") is not None:
+            conf["minimum_power"] = dps_conf["minPowerTarget"]["watt"]
+        if dps_conf.get("powerStep") is not None:
+            conf["power_step"] = dps_conf["powerStep"]["watt"]
+        return cls.enabled(**conf)

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"),
@@ -56,3 +67,57 @@ class TemperatureConfig(MinerConfigValue):
                 hot=temp_control.get("hot_temp"),
                 danger=temp_control.get("dangerous_temp"),
             )
+
+    @classmethod
+    def from_epic(cls, web_conf: dict) -> "TemperatureConfig":
+        try:
+            dangerous_temp = web_conf["Misc"]["Shutdown Temp"]
+        except KeyError:
+            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, danger=dangerous_temp)
+
+    @classmethod
+    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"])
+        except KeyError:
+            pass
+        return cls()
+
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict) -> "TemperatureConfig":
+        try:
+            temperature_conf = grpc_miner_conf["temperature"]
+        except KeyError:
+            return cls.default()
+
+        root_key = None
+        for key in ["auto", "manual", "disabled"]:
+            if key in temperature_conf.keys():
+                root_key = key
+                break
+        if root_key is None:
+            return cls.default()
+
+        conf = {}
+        keys = temperature_conf[root_key].keys()
+        if "targetTemperature" in keys:
+            conf["target"] = int(
+                temperature_conf[root_key]["targetTemperature"]["degreeC"]
+            )
+        if "hotTemperature" in keys:
+            conf["hot"] = int(temperature_conf[root_key]["hotTemperature"]["degreeC"])
+        if "dangerousTemperature" in keys:
+            conf["danger"] = int(
+                temperature_conf[root_key]["dangerousTemperature"]["degreeC"]
+            )
+
+            return cls(**conf)
+        return cls.default()

pyasic/data/__init__.py

@@ -16,77 +16,17 @@
 
 import copy
 import json
-import logging
 import time
 from dataclasses import asdict, dataclass, field, fields
 from datetime import datetime, timezone
 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
-
+from .fans import Fan
-
-@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 ideal chip count of the board as an int.
-        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
-    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}")
 
 
 @dataclass
@@ -105,8 +45,8 @@ class MinerData:
         hostname: The network hostname of the miner as a str.
         hashrate: The hashrate of the miner in TH/s as a float.  Calculated automatically.
         _hashrate: Backup for hashrate found via API instead of hashboards.
-        nominal_hashrate: The factory nominal hashrate of the miner in TH/s as a float.
+        expected_hashrate: The factory nominal hashrate of the miner in TH/s as a float.
-        hashboards: A list of hashboards on the miner with their statistics.
+        hashboards: A list of [`HashBoard`][pyasic.data.HashBoard]s on the miner with their statistics.
         temperature_avg: The average temperature across the boards.  Calculated automatically.
         env_temp: The environment temps as a float.
         wattage: Current power draw of the miner as an int.
@@ -114,16 +54,12 @@ class MinerData:
         fans: A list of fans on the miner with their speeds.
         fan_psu: The speed of the PSU on the fan if the miner collects it.
         total_chips: The total number of chips on all boards.  Calculated automatically.
-        ideal_chips: The ideal number of chips in the miner as an int.
+        expected_chips: The expected number of chips in the miner as an int.
-        percent_ideal_chips: The percent of total chips out of the ideal count.  Calculated automatically.
+        percent_expected_chips: The percent of total chips out of the expected count.  Calculated automatically.
-        percent_ideal_hashrate: The percent of total hashrate out of the ideal hashrate.  Calculated automatically.
+        percent_expected_hashrate: The percent of total hashrate out of the expected hashrate.  Calculated automatically.
-        percent_ideal_wattage: The percent of total wattage out of the ideal wattage.  Calculated automatically.
+        percent_expected_wattage: The percent of total wattage out of the expected wattage.  Calculated automatically.
         nominal: Whether the number of chips in the miner is nominal.  Calculated automatically.
-        pool_split: The pool split as a str.
+        config: The parsed config of the miner, using [`MinerConfig`][pyasic.config.MinerConfig].
-        pool_1_url: The first pool url on the miner as a str.
-        pool_1_user: The first pool user on the miner as a str.
-        pool_2_url: The second pool url on the miner as a str.
-        pool_2_user: The second pool user on the miner as a str.
         errors: A list of errors on the miner.
         fault_light: Whether the fault light is on as a boolean.
         efficiency: Efficiency of the miner in J/TH (Watts per TH/s).  Calculated automatically.
@@ -140,27 +76,24 @@ class MinerData:
     fw_ver: str = None
     hostname: str = None
     hashrate: float = field(init=False)
-    _hashrate: float = None
+    _hashrate: float = field(repr=False, default=None)
-    nominal_hashrate: float = None
+    expected_hashrate: float = None
     hashboards: List[HashBoard] = field(default_factory=list)
-    ideal_hashboards: int = None
+    expected_hashboards: int = None
     temperature_avg: int = field(init=False)
     env_temp: float = None
     wattage: int = None
-    wattage_limit: int = None
+    wattage_limit: int = field(init=False)
+    _wattage_limit: int = field(repr=False, default=None)
     fans: List[Fan] = field(default_factory=list)
     fan_psu: int = None
     total_chips: int = field(init=False)
-    ideal_chips: int = None
+    expected_chips: int = None
-    percent_ideal_chips: float = field(init=False)
+    percent_expected_chips: float = field(init=False)
-    percent_ideal_hashrate: float = field(init=False)
+    percent_expected_hashrate: float = field(init=False)
-    percent_ideal_wattage: float = field(init=False)
+    percent_expected_wattage: float = field(init=False)
     nominal: bool = field(init=False)
-    pool_split: str = "0"
+    config: MinerConfig = None
-    pool_1_url: str = "Unknown"
-    pool_1_user: str = "Unknown"
-    pool_2_url: str = ""
-    pool_2_user: str = ""
     errors: List[
         Union[WhatsminerError, BraiinsOSError, X19Error, InnosiliconError]
     ] = field(default_factory=list)
@@ -170,7 +103,11 @@ class MinerData:
 
     @classmethod
     def fields(cls):
-        return [f.name for f in fields(cls)]
+        return [f.name for f in fields(cls) if not f.name.startswith("_")]
+
+    @staticmethod
+    def dict_factory(x):
+        return {k: v for (k, v) in x if not k.startswith("_")}
 
     def __post_init__(self):
         self.datetime = datetime.now(timezone.utc).astimezone()
@@ -248,6 +185,17 @@ class MinerData:
     def hashrate(self, val):
         self._hashrate = val
 
+    @property
+    def wattage_limit(self):  # noqa - Skip PyCharm inspection
+        if self.config is not None:
+            if isinstance(self.config.mining_mode, MiningModePowerTune):
+                return self.config.mining_mode.power
+        return self._wattage_limit
+
+    @wattage_limit.setter
+    def wattage_limit(self, val: int):
+        self._wattage_limit = val
+
     @property
     def total_chips(self):  # noqa - Skip PyCharm inspection
         if len(self.hashboards) > 0:
@@ -265,48 +213,48 @@ class MinerData:
 
     @property
     def nominal(self):  # noqa - Skip PyCharm inspection
-        if self.total_chips is None or self.ideal_chips is None:
+        if self.total_chips is None or self.expected_chips is None:
             return None
-        return self.ideal_chips == self.total_chips
+        return self.expected_chips == self.total_chips
 
     @nominal.setter
     def nominal(self, val):
         pass
 
     @property
-    def percent_ideal_chips(self):  # noqa - Skip PyCharm inspection
+    def percent_expected_chips(self):  # noqa - Skip PyCharm inspection
-        if self.total_chips is None or self.ideal_chips is None:
+        if self.total_chips is None or self.expected_chips is None:
             return None
-        if self.total_chips == 0 or self.ideal_chips == 0:
+        if self.total_chips == 0 or self.expected_chips == 0:
             return 0
-        return round((self.total_chips / self.ideal_chips) * 100)
+        return round((self.total_chips / self.expected_chips) * 100)
 
-    @percent_ideal_chips.setter
+    @percent_expected_chips.setter
-    def percent_ideal_chips(self, val):
+    def percent_expected_chips(self, val):
         pass
 
     @property
-    def percent_ideal_hashrate(self):  # noqa - Skip PyCharm inspection
+    def percent_expected_hashrate(self):  # noqa - Skip PyCharm inspection
-        if self.hashrate is None or self.nominal_hashrate is None:
+        if self.hashrate is None or self.expected_hashrate is None:
             return None
-        if self.hashrate == 0 or self.nominal_hashrate == 0:
+        if self.hashrate == 0 or self.expected_hashrate == 0:
             return 0
-        return round((self.hashrate / self.nominal_hashrate) * 100)
+        return round((self.hashrate / self.expected_hashrate) * 100)
 
-    @percent_ideal_hashrate.setter
+    @percent_expected_hashrate.setter
-    def percent_ideal_hashrate(self, val):
+    def percent_expected_hashrate(self, val):
         pass
 
     @property
-    def percent_ideal_wattage(self):  # noqa - Skip PyCharm inspection
+    def percent_expected_wattage(self):  # noqa - Skip PyCharm inspection
         if self.wattage_limit is None or self.wattage is None:
             return None
         if self.wattage_limit == 0 or self.wattage == 0:
             return 0
         return round((self.wattage / self.wattage_limit) * 100)
 
-    @percent_ideal_wattage.setter
+    @percent_expected_wattage.setter
-    def percent_ideal_wattage(self, val):
+    def percent_expected_wattage(self, val):
         pass
 
     @property
@@ -338,8 +286,7 @@ class MinerData:
         pass
 
     def asdict(self) -> dict:
-        logging.debug(f"MinerData - (To Dict) - Dumping Dict data")
+        return asdict(self, dict_factory=self.dict_factory)
-        return asdict(self)
 
     def as_dict(self) -> dict:
         """Get this dataclass as a dictionary.
@@ -355,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)
@@ -366,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 = []
@@ -385,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

@@ -0,0 +1,58 @@
+# ------------------------------------------------------------------------------
+#  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 dataclasses import dataclass
+from typing import Any
+
+
+@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}")

pyasic/data/fans.py

@@ -14,24 +14,31 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-import warnings
+from dataclasses import dataclass
-
+from typing import Any
-from pyasic.miners.makes import WhatsMiner
 
 
-class M32V10(WhatsMiner):  # noqa - ignore ABC method implementation
+@dataclass
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+class Fan:
-        super().__init__(ip, api_ver)
+    """A Dataclass to standardize fan data.
-        self.ip = ip
-        self.model = "M32 V10"
-        self.nominal_chips = 78
-        self.fan_count = 2
 
+    Attributes:
+        speed: The speed of the fan.
+    """
 
-class M32V20(WhatsMiner):  # noqa - ignore ABC method implementation
+    speed: int = None
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+
-        super().__init__(ip, api_ver)
+    def get(self, __key: str, default: Any = None):
-        self.ip = ip
+        try:
-        self.model = "M32 V20"
+            val = self.__getitem__(__key)
-        self.nominal_chips = 74
+            if val is None:
-        self.fan_count = 2
+                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
 
@@ -66,14 +66,14 @@ class _MinerPhaseBalancer:
             str(miner.ip): {
                 "miner": miner,
                 "set": 0,
-                "min": miner.fan_count * FAN_USAGE,
+                "min": miner.expected_fans * FAN_USAGE,
             }
             for miner in miners
         }
         for miner in miners:
             if (
                 isinstance(miner, BTMiner)
-                and not (miner.model.startswith("M2") if miner.model else True)
+                and not (miner.raw_model.startswith("M2") if miner.raw_model else True)
             ) or isinstance(miner, BOSMiner):
                 if isinstance(miner, S9):
                     self.miners[str(miner.ip)]["tune"] = True
@@ -98,8 +98,8 @@ class _MinerPhaseBalancer:
                 self.miners[str(miner.ip)]["tune"] = False
                 self.miners[str(miner.ip)]["shutdown"] = True
                 self.miners[str(miner.ip)]["max"] = 3600
-                if miner.model:
+                if miner.raw_model:
-                    if miner.model.startswith("M2"):
+                    if miner.raw_model.startswith("M2"):
                         self.miners[str(miner.ip)]["tune"] = False
                         self.miners[str(miner.ip)]["shutdown"] = True
                         self.miners[str(miner.ip)]["max"] = 2400
@@ -137,10 +137,10 @@ class _MinerPhaseBalancer:
                 for miner in self.miners
             ]
         )
-        pct_ideal_list = [d.percent_ideal for d in data]
+        pct_expected_list = [d.percent_ideal for d in data]
         pct_ideal = 0
-        if len(pct_ideal_list) > 0:
+        if len(pct_expected_list) > 0:
-            pct_ideal = sum(pct_ideal_list) / len(pct_ideal_list)
+            pct_ideal = sum(pct_expected_list) / len(pct_expected_list)
 
         wattage = round(wattage * 1 / (pct_ideal / 100))
 
@@ -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 .base import AnyMiner
-from typing import Union
+from .data import DataOptions
-
+from .factory import get_miner, miner_factory
-from pyasic.miners.base import AnyMiner, BaseMiner
+from .listener import MinerListener
-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)

pyasic/miners/antminer/__init__.py

@@ -17,7 +17,7 @@
 from .bmminer import *
 from .bosminer import *
 from .cgminer import *
+from .epic import *
 from .hiveon import *
 from .luxos import *
 from .vnish import *
-from .epic import *

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,
@@ -27,6 +27,7 @@ from pyasic.miners.types import (
     S19jPro,
     S19Plus,
     S19Pro,
+    S19ProHydro,
     S19ProPlus,
 )
 
@@ -77,3 +78,7 @@ class BMMinerS19jPro(AntminerModern, S19jPro):
 
 class BMMinerS19L(AntminerModern, S19L):
     pass
+
+
+class BMMinerS19ProHydro(AntminerModern, S19ProHydro):
+    pass

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

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

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

@@ -25,6 +25,7 @@ from .S19 import (
     BMMinerS19L,
     BMMinerS19Plus,
     BMMinerS19Pro,
+    BMMinerS19ProHydro,
     BMMinerS19ProPlus,
     BMMinerS19XP,
 )

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"):
+    supports_shutdown = False
-        super().__init__(ip, api_ver)
-        self.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"):
+    supports_shutdown = False
-        super().__init__(ip, api_ver)
-        self.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"):
+    supports_shutdown = False
-        super().__init__(ip, api_ver)
-        self.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

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

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

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

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

@@ -14,29 +14,61 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import BOSMiner
+from pyasic.miners.backends import BOSer
-from pyasic.miners.types import S19, S19j, S19jNoPIC, S19jPro, S19kProNoPIC, S19Pro
+from pyasic.miners.models import (
+    S19,
+    S19XP,
+    S19a,
+    S19aPro,
+    S19j,
+    S19jNoPIC,
+    S19jPro,
+    S19jProPlus,
+    S19kProNoPIC,
+    S19Plus,
+    S19Pro,
+)
 
 
-class BOSMinerS19(BOSMiner, S19):
+class BOSMinerS19(BOSer, S19):
     pass
 
 
-class BOSMinerS19Pro(BOSMiner, S19Pro):
+class BOSMinerS19Plus(BOSer, S19Plus):
     pass
 
 
-class BOSMinerS19j(BOSMiner, S19j):
+class BOSMinerS19Pro(BOSer, S19Pro):
     pass
 
 
-class BOSMinerS19jNoPIC(BOSMiner, S19jNoPIC):
+class BOSMinerS19a(BOSer, S19a):
     pass
 
 
-class BOSMinerS19jPro(BOSMiner, S19jPro):
+class BOSMinerS19j(BOSer, S19j):
     pass
 
 
-class BOSMinerS19kProNoPIC(BOSMiner, S19kProNoPIC):
+class BOSMinerS19jNoPIC(BOSer, S19jNoPIC):
+    pass
+
+
+class BOSMinerS19jPro(BOSer, S19jPro):
+    pass
+
+
+class BOSMinerS19kProNoPIC(BOSer, S19kProNoPIC):
+    pass
+
+
+class BOSMinerS19aPro(BOSer, S19aPro):
+    pass
+
+
+class BOSMinerS19jProPlus(BOSer, S19jProPlus):
+    pass
+
+
+class BOSMinerS19XP(BOSer, S19XP):
     pass

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

@@ -14,9 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import BOSMiner
+from pyasic.miners.backends import BOSer
-from pyasic.miners.types import T19
+from pyasic.miners.models import T19
 
 
-class BOSMinerT19(BOSMiner, T19):
+class BOSMinerT19(BOSer, T19):
     pass

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

@@ -16,10 +16,15 @@
 
 from .S19 import (
     BOSMinerS19,
+    BOSMinerS19a,
+    BOSMinerS19aPro,
     BOSMinerS19j,
     BOSMinerS19jNoPIC,
     BOSMinerS19jPro,
+    BOSMinerS19jProPlus,
     BOSMinerS19kProNoPIC,
+    BOSMinerS19Plus,
     BOSMinerS19Pro,
+    BOSMinerS19XP,
 )
 from .T19 import BOSMinerT19

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"):
+    supports_shutdown = False
-        super().__init__(ip, api_ver)
-        self.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"):
+    supports_shutdown = False
-        super().__init__(ip, api_ver)
-        self.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"):
+    supports_shutdown = False
-        super().__init__(ip, api_ver)
-        self.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/epic/X19/__init__.py

@@ -16,10 +16,10 @@
 
 from .S19 import (
     ePICS19,
-    ePICS19Pro,
     ePICS19j,
     ePICS19jPro,
     ePICS19jProPlus,
     ePICS19kPro,
+    ePICS19Pro,
     ePICS19XP,
 )

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

@@ -21,14 +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):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
+    data_locations = HIVEON_T9_DATA_LOC
-        super().__init__(ip, api_ver=api_ver)
-        self.ip = ip
-        self.pwd = "admin"
 
     ##################################################
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
@@ -45,47 +84,57 @@ 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 rpc_stats is None:
+            try:
+                rpc_stats = self.rpc.stats()
+            except APIError:
+                return []
+
         board_map = {
             0: [2, 9, 10],
             1: [3, 11, 12],
             2: [4, 13, 14],
         }
-        hashboards = []
 
         for board in board_map:
-            hashboard = HashBoard(slot=board, expected_chips=self.nominal_chips)
             hashrate = 0
             chips = 0
             for chipset in board_map[board]:
-                if hashboard.chip_temp == None:
+                if hashboards[board].chip_temp is None:
                     try:
-                        hashboard.board_temp = api_stats["STATS"][1][f"temp{chipset}"]
+                        hashboards[board].temp = rpc_stats["STATS"][1][f"temp{chipset}"]
-                        hashboard.chip_temp = api_stats["STATS"][1][f"temp2_{chipset}"]
+                        hashboards[board].chip_temp = rpc_stats["STATS"][1][
+                            f"temp2_{chipset}"
+                        ]
                     except (KeyError, IndexError):
                         pass
                     else:
-                        hashboard.missing = False
+                        hashboards[board].missing = False
                 try:
-                    hashrate += api_stats["STATS"][1][f"chain_rate{chipset}"]
+                    hashrate += rpc_stats["STATS"][1][f"chain_rate{chipset}"]
-                    chips += api_stats["STATS"][1][f"chain_acn{chipset}"]
+                    chips += rpc_stats["STATS"][1][f"chain_acn{chipset}"]
                 except (KeyError, IndexError):
                     pass
-            hashboard.hashrate = round(hashrate / 1000, 2)
+            hashboards[board].hashrate = round(hashrate / 1000, 2)
-            hashboard.chips = chips
+            hashboards[board].chips = chips
-            hashboards.append(hashboard)
 
         return hashboards
 
-    async def get_wattage(self, api_stats: dict = None) -> Optional[int]:
+    async def _get_wattage(self, rpc_stats: dict = None) -> Optional[int]:
-        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:
-            boards = api_stats.get("STATS")
+            boards = rpc_stats.get("STATS")
             try:
                 wattage_raw = boards[1]["chain_power"]
             except (KeyError, IndexError):
@@ -94,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"):
+    pass
-        super().__init__(ip, api_ver)

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.backends import AvalonMiner
-from pyasic.miners.types import Avalon1026
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon1047
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon1066
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon1166Pro
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon1246
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon721
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon741
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon761
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon821
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon841
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon851
+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.backends import AvalonMiner
-from pyasic.miners.types import Avalon921
+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 .bosminer import BOSMiner
+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 .epic import ePIC
 from .whatsminer import M2X, M3X, M5X, M6X

pyasic/miners/backends/antminer.py

@@ -14,68 +14,86 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-import asyncio
 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.data import (
+    DataFunction,
+    DataLocations,
+    DataOptions,
+    RPCAPICommand,
+    WebAPICommand,
+)
+from pyasic.ssh.antminer import AntminerModernSSH
 from pyasic.web.antminer import AntminerModernWebAPI, AntminerOldWebAPI
 
-ANTMINER_MODERN_DATA_LOC = {
+ANTMINER_MODERN_DATA_LOC = DataLocations(
-    "mac": {
+    **{
-        "cmd": "get_mac",
+        str(DataOptions.MAC): DataFunction(
-        "kwargs": {"web_get_system_info": {"web": "get_system_info"}},
+            "_get_mac",
-    },
+            [WebAPICommand("web_get_system_info", "get_system_info")],
-    "model": {"cmd": "get_model", "kwargs": {}},
+        ),
-    "api_ver": {"cmd": "get_api_ver", "kwargs": {"api_version": {"api": "version"}}},
+        str(DataOptions.API_VERSION): DataFunction(
-    "fw_ver": {"cmd": "get_fw_ver", "kwargs": {"api_version": {"api": "version"}}},
+            "_get_api_ver",
-    "hostname": {
+            [RPCAPICommand("rpc_version", "version")],
-        "cmd": "get_hostname",
+        ),
-        "kwargs": {"web_get_system_info": {"web": "get_system_info"}},
+        str(DataOptions.FW_VERSION): DataFunction(
-    },
+            "_get_fw_ver",
-    "hashrate": {"cmd": "get_hashrate", "kwargs": {"api_summary": {"api": "summary"}}},
+            [RPCAPICommand("rpc_version", "version")],
-    "nominal_hashrate": {
+        ),
-        "cmd": "get_nominal_hashrate",
+        str(DataOptions.HOSTNAME): DataFunction(
-        "kwargs": {"api_stats": {"api": "stats"}},
+            "_get_hostname",
-    },
+            [WebAPICommand("web_get_system_info", "get_system_info")],
-    "hashboards": {"cmd": "get_hashboards", "kwargs": {"api_stats": {"api": "stats"}}},
+        ),
-    "env_temp": {"cmd": "get_env_temp", "kwargs": {}},
+        str(DataOptions.HASHRATE): DataFunction(
-    "wattage": {"cmd": "get_wattage", "kwargs": {}},
+            "_get_hashrate",
-    "wattage_limit": {"cmd": "get_wattage_limit", "kwargs": {}},
+            [RPCAPICommand("rpc_summary", "summary")],
-    "fans": {"cmd": "get_fans", "kwargs": {"api_stats": {"api": "stats"}}},
+        ),
-    "fan_psu": {"cmd": "get_fan_psu", "kwargs": {}},
+        str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-    "errors": {"cmd": "get_errors", "kwargs": {"web_summary": {"web": "summary"}}},
+            "_get_expected_hashrate",
-    "fault_light": {
+            [RPCAPICommand("rpc_stats", "stats")],
-        "cmd": "get_fault_light",
+        ),
-        "kwargs": {"web_get_blink_status": {"web": "get_blink_status"}},
+        str(DataOptions.FANS): DataFunction(
-    },
+            "_get_fans",
-    "pools": {"cmd": "get_pools", "kwargs": {"api_pools": {"api": "pools"}}},
+            [RPCAPICommand("rpc_stats", "stats")],
-    "is_mining": {
+        ),
-        "cmd": "is_mining",
+        str(DataOptions.ERRORS): DataFunction(
-        "kwargs": {"web_get_conf": {"web": "get_miner_conf"}},
+            "_get_errors",
-    },
+            [WebAPICommand("web_summary", "summary")],
-    "uptime": {
+        ),
-        "cmd": "get_uptime",
+        str(DataOptions.FAULT_LIGHT): DataFunction(
-        "kwargs": {"api_stats": {"api": "stats"}},
+            "_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")],
+        ),
+        str(DataOptions.UPTIME): DataFunction(
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+    }
+)
 
 
 class AntminerModern(BMMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
+    """Handler for AntMiners with the modern web interface, such as S19"""
-        super().__init__(ip, api_ver)
-        # interfaces
-        self.web = AntminerModernWebAPI(ip)
 
-        # static data
+    _web_cls = AntminerModernWebAPI
-        # data gathering locations
+    web: AntminerModernWebAPI
-        self.data_locations = ANTMINER_MODERN_DATA_LOC
+
-        # autotuning/shutdown support
+    _ssh_cls = AntminerModernSSH
-        self.supports_shutdown = True
+    ssh: AntminerModernSSH
+
+    data_locations = ANTMINER_MODERN_DATA_LOC
+
+    supports_shutdown = True
 
     async def get_config(self) -> MinerConfig:
         data = await self.web.get_miner_conf()
@@ -128,27 +146,27 @@ class AntminerModern(BMMiner):
         await self.send_config(cfg)
         return True
 
-    async def get_hostname(self, web_get_system_info: dict = None) -> Union[str, None]:
+    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]:
+    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:
@@ -161,15 +179,15 @@ class AntminerModern(BMMiner):
         except KeyError:
             pass
 
-    async def get_errors(self, web_summary: dict = None) -> List[MinerErrorData]:
+    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:
@@ -177,48 +195,86 @@ class AntminerModern(BMMiner):
                             errors.append(X19Error(item["msg"]))
                     except KeyError:
                         continue
-            except (KeyError, IndexError):
+            except LookupError:
                 pass
         return errors
 
-    async def get_fault_light(self, web_get_blink_status: dict = None) -> bool:
+    async def _get_hashboards(self) -> List[HashBoard]:
+        hashboards = [
+            HashBoard(idx, expected_chips=self.expected_chips)
+            for idx in range(self.expected_hashboards)
+        ]
+
+        try:
+            rpc_stats = await self.rpc.send_command("stats", new_rpc=True)
+        except APIError:
+            return hashboards
+
+        if rpc_stats is not None:
+            try:
+                for board in rpc_stats["STATS"][0]["chain"]:
+                    hashboards[board["index"]].hashrate = round(
+                        board["rate_real"] / 1000, 2
+                    )
+                    hashboards[board["index"]].chips = board["asic_num"]
+                    board_temp_data = list(
+                        filter(lambda x: not x == 0, board["temp_pcb"])
+                    )
+                    hashboards[board["index"]].temp = sum(board_temp_data) / len(
+                        board_temp_data
+                    )
+                    chip_temp_data = list(
+                        filter(lambda x: not x == 0, board["temp_chip"])
+                    )
+                    hashboards[board["index"]].chip_temp = sum(chip_temp_data) / len(
+                        chip_temp_data
+                    )
+                    hashboards[board["index"]].serial_number = board["sn"]
+                    hashboards[board["index"]].missing = False
+            except LookupError:
+                pass
+        return hashboards
+
+    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_nominal_hashrate(self, api_stats: dict = None) -> Optional[float]:
+    async def _get_expected_hashrate(self, rpc_stats: dict = None) -> Optional[float]:
-        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:
-                ideal_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":
-                    return round(ideal_rate / 1000, 2)
+                    return round(expected_rate / 1000, 2)
                 if rate_unit == "MH":
-                    return round(ideal_rate / 1000000, 2)
+                    return round(expected_rate / 1000000, 2)
                 else:
-                    return round(ideal_rate, 2)
+                    return round(expected_rate, 2)
-            except (KeyError, IndexError):
+            except LookupError:
                 pass
 
     async def set_static_ip(
@@ -263,14 +319,14 @@ class AntminerModern(BMMiner):
             protocol=protocol,
         )
 
-    async def is_mining(self, web_get_conf: dict = None) -> Optional[bool]:
+    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 (
@@ -280,69 +336,69 @@ class AntminerModern(BMMiner):
             except LookupError:
                 pass
 
-    async def get_uptime(self, api_stats: dict = None) -> Optional[int]:
+    async def _get_uptime(self, rpc_stats: dict = None) -> Optional[int]:
-        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:
-                return int(api_stats["STATS"][1]["Elapsed"])
+                return int(rpc_stats["STATS"][1]["Elapsed"])
             except LookupError:
                 pass
 
 
-ANTMINER_OLD_DATA_LOC = {
+ANTMINER_OLD_DATA_LOC = DataLocations(
-    "mac": {"cmd": "get_mac", "kwargs": {}},
+    **{
-    "model": {
+        str(DataOptions.API_VERSION): DataFunction(
-        "cmd": "get_model",
+            "_get_api_ver",
-        "kwargs": {},
+            [RPCAPICommand("rpc_version", "version")],
-    },
+        ),
-    "api_ver": {"cmd": "get_api_ver", "kwargs": {"api_version": {"api": "version"}}},
+        str(DataOptions.FW_VERSION): DataFunction(
-    "fw_ver": {"cmd": "get_fw_ver", "kwargs": {"api_version": {"api": "version"}}},
+            "_get_fw_ver",
-    "hostname": {
+            [RPCAPICommand("rpc_version", "version")],
-        "cmd": "get_hostname",
+        ),
-        "kwargs": {"web_get_system_info": {"web": "get_system_info"}},
+        str(DataOptions.HOSTNAME): DataFunction(
-    },
+            "_get_hostname",
-    "hashrate": {"cmd": "get_hashrate", "kwargs": {"api_summary": {"api": "summary"}}},
+            [WebAPICommand("web_get_system_info", "get_system_info")],
-    "nominal_hashrate": {
+        ),
-        "cmd": "get_nominal_hashrate",
+        str(DataOptions.HASHRATE): DataFunction(
-        "kwargs": {"api_stats": {"api": "stats"}},
+            "_get_hashrate",
-    },
+            [RPCAPICommand("rpc_summary", "summary")],
-    "hashboards": {"cmd": "get_hashboards", "kwargs": {"api_stats": {"api": "stats"}}},
+        ),
-    "env_temp": {"cmd": "get_env_temp", "kwargs": {}},
+        str(DataOptions.HASHBOARDS): DataFunction(
-    "wattage": {"cmd": "get_wattage", "kwargs": {}},
+            "_get_hashboards",
-    "wattage_limit": {"cmd": "get_wattage_limit", "kwargs": {}},
+            [RPCAPICommand("rpc_stats", "stats")],
-    "fans": {"cmd": "get_fans", "kwargs": {"api_stats": {"api": "stats"}}},
+        ),
-    "fan_psu": {"cmd": "get_fan_psu", "kwargs": {}},
+        str(DataOptions.FANS): DataFunction(
-    "errors": {"cmd": "get_errors", "kwargs": {}},
+            "_get_fans",
-    "fault_light": {
+            [RPCAPICommand("rpc_stats", "stats")],
-        "cmd": "get_fault_light",
+        ),
-        "kwargs": {"web_get_blink_status": {"web": "get_blink_status"}},
+        str(DataOptions.FAULT_LIGHT): DataFunction(
-    },
+            "_get_fault_light",
-    "pools": {"cmd": "get_pools", "kwargs": {"api_pools": {"api": "pools"}}},
+            [WebAPICommand("web_get_blink_status", "get_blink_status")],
-    "is_mining": {
+        ),
-        "cmd": "is_mining",
+        str(DataOptions.IS_MINING): DataFunction(
-        "kwargs": {"web_get_conf": {"web": "get_miner_conf"}},
+            "_is_mining",
-    },
+            [WebAPICommand("web_get_conf", "get_miner_conf")],
-    "uptime": {
+        ),
-        "cmd": "get_uptime",
+        str(DataOptions.UPTIME): DataFunction(
-        "kwargs": {"api_stats": {"api": "stats"}},
+            "_get_uptime",
-    },
+            [RPCAPICommand("rpc_stats", "stats")],
-}
+        ),
+    }
+)
 
 
 class AntminerOld(CGMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
+    """Handler for AntMiners with the old web interface, such as S17"""
-        super().__init__(ip, api_ver)
-        # interfaces
-        self.web = AntminerOldWebAPI(ip)
 
-        # static data
+    _web_cls = AntminerOldWebAPI
-        # data gathering locations
+    web: AntminerOldWebAPI
-        self.data_locations = ANTMINER_OLD_DATA_LOC
+
+    data_locations = ANTMINER_OLD_DATA_LOC
 
     async def get_config(self) -> MinerConfig:
         data = await self.web.get_miner_conf()
@@ -354,7 +410,7 @@ class AntminerOld(CGMiner):
         self.config = config
         await self.web.set_miner_conf(config.as_am_old(user_suffix=user_suffix))
 
-    async def get_mac(self) -> Union[str, None]:
+    async def _get_mac(self) -> Union[str, None]:
         try:
             data = await self.web.get_system_info()
             if data:
@@ -391,77 +447,79 @@ 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:
                 pass
         return self.light
 
-    async def get_hostname(self, web_get_system_info: dict = None) -> Optional[str]:
+    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]:
+    async def _get_fans(self, rpc_stats: dict = None) -> List[Fan]:
-        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
 
-        fans_data = [Fan() for _ in range(self.fan_count)]
+        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.fan_count):
+                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 (KeyError, IndexError):
+            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):
@@ -472,9 +530,11 @@ class AntminerOld(CGMiner):
                     if board_offset == -1:
                         board_offset = 1
 
-                    for i in range(board_offset, board_offset + self.ideal_hashboards):
+                    for i in range(
+                        board_offset, board_offset + self.expected_hashboards
+                    ):
                         hashboard = HashBoard(
-                            slot=i - board_offset, expected_chips=self.nominal_chips
+                            slot=i - board_offset, expected_chips=self.expected_chips
                         )
 
                         chip_temp = boards[1].get(f"temp{i}")
@@ -496,45 +556,45 @@ class AntminerOld(CGMiner):
                         if (not chips) or (not chips > 0):
                             hashboard.missing = True
                         hashboards.append(hashboard)
-            except (IndexError, KeyError, ValueError, TypeError):
+            except (LookupError, ValueError, TypeError):
                 pass
 
         return hashboards
 
-    async def is_mining(self, web_get_conf: dict = None) -> Optional[bool]:
+    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 rpc_summary is not None:
-            if not api_summary == {}:
+            if not rpc_summary == {}:
                 return True
             else:
                 return False
 
-    async def get_uptime(self, api_stats: dict = None) -> Optional[int]:
+    async def _get_uptime(self, rpc_stats: dict = None) -> Optional[int]:
-        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:
-                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

@@ -14,57 +14,72 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-import logging
 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.backends.cgminer import CGMiner
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
 
-AVALON_DATA_LOC = {
+AVALON_DATA_LOC = DataLocations(
-    "mac": {"cmd": "get_mac", "kwargs": {"api_version": {"api": "version"}}},
+    **{
-    "model": {"cmd": "get_model", "kwargs": {}},
+        str(DataOptions.MAC): DataFunction(
-    "api_ver": {"cmd": "get_api_ver", "kwargs": {"api_version": {"api": "version"}}},
+            "_get_mac",
-    "fw_ver": {"cmd": "get_fw_ver", "kwargs": {"api_version": {"api": "version"}}},
+            [RPCAPICommand("rpc_version", "version")],
-    "hostname": {"cmd": "get_hostname", "kwargs": {"mac": {"api": "version"}}},
+        ),
-    "hashrate": {"cmd": "get_hashrate", "kwargs": {"api_devs": {"api": "devs"}}},
+        str(DataOptions.API_VERSION): DataFunction(
-    "nominal_hashrate": {
+            "_get_api_ver",
-        "cmd": "get_nominal_hashrate",
+            [RPCAPICommand("rpc_version", "version")],
-        "kwargs": {"api_stats": {"api": "stats"}},
+        ),
-    },
+        str(DataOptions.FW_VERSION): DataFunction(
-    "hashboards": {"cmd": "get_hashboards", "kwargs": {"api_stats": {"api": "stats"}}},
+            "_get_fw_ver",
-    "env_temp": {"cmd": "get_env_temp", "kwargs": {"api_stats": {"api": "stats"}}},
+            [RPCAPICommand("rpc_version", "version")],
-    "wattage": {"cmd": "get_wattage", "kwargs": {}},
+        ),
-    "wattage_limit": {
+        str(DataOptions.HASHRATE): DataFunction(
-        "cmd": "get_wattage_limit",
+            "_get_hashrate",
-        "kwargs": {"api_stats": {"api": "stats"}},
+            [RPCAPICommand("rpc_devs", "devs")],
-    },
+        ),
-    "fans": {"cmd": "get_fans", "kwargs": {"api_stats": {"api": "stats"}}},
+        str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-    "fan_psu": {"cmd": "get_fan_psu", "kwargs": {}},
+            "_get_expected_hashrate",
-    "errors": {"cmd": "get_errors", "kwargs": {}},
+            [RPCAPICommand("rpc_stats", "stats")],
-    "fault_light": {
+        ),
-        "cmd": "get_fault_light",
+        str(DataOptions.HASHBOARDS): DataFunction(
-        "kwargs": {"api_stats": {"api": "stats"}},
+            "_get_hashboards",
-    },
+            [RPCAPICommand("rpc_stats", "stats")],
-    "pools": {"cmd": "get_pools", "kwargs": {"api_pools": {"api": "pools"}}},
+        ),
-    "is_mining": {"cmd": "is_mining", "kwargs": {}},
+        str(DataOptions.ENVIRONMENT_TEMP): DataFunction(
-    "uptime": {"cmd": "get_uptime", "kwargs": {}},
+            "_get_env_temp",
-}
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.WATTAGE_LIMIT): DataFunction(
+            "_get_wattage_limit",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.FANS): DataFunction(
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.FAULT_LIGHT): DataFunction(
+            "_get_fault_light",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+        str(DataOptions.UPTIME): DataFunction(
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+    }
+)
 
 
-class CGMinerAvalon(CGMiner):
+class AvalonMiner(CGMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
+    """Handler for Avalon Miners"""
-        super().__init__(ip, api_ver)
 
-        # data gathering locations
+    data_locations = AVALON_DATA_LOC
-        self.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":
@@ -73,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":
@@ -82,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
 
@@ -93,29 +108,9 @@ 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)
+        _stats_items = re.findall(".+?\\[*?]", stats)
         stats_items = []
         stats_dict = {}
         for item in _stats_items:
@@ -130,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:
@@ -160,16 +155,16 @@ class CGMinerAvalon(CGMiner):
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
     ##################################################
 
-    async def get_mac(self, api_version: dict = None) -> Optional[str]:
+    async def _get_mac(self, rpc_version: dict = None) -> Optional[str]:
-        if not api_version:
+        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)]
@@ -178,47 +173,39 @@ class CGMinerAvalon(CGMiner):
             except (KeyError, ValueError):
                 pass
 
-    async def get_hostname(self, mac: str = None) -> Optional[str]:
+    async def _get_hashrate(self, rpc_devs: dict = None) -> Optional[float]:
-        return None
+        if rpc_devs is 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:
             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.nominal_chips)
+            HashBoard(slot=i, expected_chips=self.expected_chips)
-            for i in range(self.ideal_hashboards)
+            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
 
-            for board in range(self.ideal_hashboards):
+            for board in range(self.expected_hashboards):
                 try:
                     hashboards[board].chip_temp = int(parsed_stats["MTmax"][board])
                 except LookupError:
@@ -247,117 +234,85 @@ class CGMinerAvalon(CGMiner):
 
         return hashboards
 
-    async def get_nominal_hashrate(self, api_stats: dict = None) -> Optional[float]:
+    async def _get_expected_hashrate(self, rpc_stats: dict = None) -> Optional[float]:
-        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)
                 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]:
+    async def _get_env_temp(self, rpc_stats: dict = None) -> Optional[float]:
-        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)
                 return float(parsed_stats["Temp"])
             except (IndexError, KeyError, ValueError, TypeError):
                 pass
 
-    async def get_wattage(self) -> Optional[int]:
+    async def _get_wattage_limit(self, rpc_stats: dict = None) -> Optional[int]:
-        return None
+        if rpc_stats is None:
-
-    async def get_wattage_limit(self, api_stats: dict = None) -> Optional[int]:
-        if not api_stats:
             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]:
+    async def _get_fans(self, rpc_stats: dict = None) -> List[Fan]:
-        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
 
-        fans_data = [Fan() for _ in range(self.fan_count)]
+        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
 
-            for fan in range(self.fan_count):
+            for fan in range(self.expected_fans):
                 try:
                     fans_data[fan].speed = int(parsed_stats[f"Fan{fan + 1}"])
                 except (IndexError, KeyError, ValueError, TypeError):
                     pass
         return fans_data
 
-    async def get_pools(self, api_pools: dict = None) -> List[dict]:
+    async def _get_fault_light(self, rpc_stats: dict = None) -> Optional[bool]:
-        groups = []
-
-        if not api_pools:
-            try:
-                api_pools = await self.api.pools()
-            except APIError:
-                pass
-
-        if api_pools:
-            try:
-                pools = {}
-                for i, pool in enumerate(api_pools["POOLS"]):
-                    pools[f"pool_{i + 1}_url"] = (
-                        pool["URL"]
-                        .replace("stratum+tcp://", "")
-                        .replace("stratum2+tcp://", "")
-                    )
-                    pools[f"pool_{i + 1}_user"] = pool["User"]
-                    pools["quota"] = pool["Quota"] if pool.get("Quota") else "0"
-
-                groups.append(pools)
-            except KeyError:
-                pass
-        return groups
-
-    async def get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def get_fault_light(self, api_stats: dict = None) -> bool:  # noqa
         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
@@ -365,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:
@@ -374,6 +329,3 @@ class CGMinerAvalon(CGMiner):
         except LookupError:
             pass
         return False
-
-    async def is_mining(self, *args, **kwargs) -> Optional[bool]:
-        return None

pyasic/miners/backends/bfgminer.py

@@ -14,179 +14,124 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from collections import namedtuple
+from typing import List, Optional
-from typing import List, Optional, Tuple
 
-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
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
+from pyasic.rpc.bfgminer import BFGMinerRPCAPI
 
-BFGMINER_DATA_LOC = {
+BFGMINER_DATA_LOC = DataLocations(
-    "mac": {"cmd": "get_mac", "kwargs": {}},
+    **{
-    "model": {"cmd": "get_model", "kwargs": {}},
+        str(DataOptions.API_VERSION): DataFunction(
-    "api_ver": {"cmd": "get_api_ver", "kwargs": {"api_version": {"api": "version"}}},
+            "_get_api_ver",
-    "fw_ver": {"cmd": "get_fw_ver", "kwargs": {"api_version": {"api": "version"}}},
+            [RPCAPICommand("rpc_version", "version")],
-    "hostname": {"cmd": "get_hostname", "kwargs": {}},
+        ),
-    "hashrate": {"cmd": "get_hashrate", "kwargs": {"api_summary": {"api": "summary"}}},
+        str(DataOptions.FW_VERSION): DataFunction(
-    "nominal_hashrate": {
+            "_get_fw_ver",
-        "cmd": "get_nominal_hashrate",
+            [RPCAPICommand("rpc_version", "version")],
-        "kwargs": {"api_stats": {"api": "stats"}},
+        ),
-    },
+        str(DataOptions.HASHRATE): DataFunction(
-    "hashboards": {"cmd": "get_hashboards", "kwargs": {"api_stats": {"api": "stats"}}},
+            "_get_hashrate",
-    "env_temp": {"cmd": "get_env_temp", "kwargs": {}},
+            [RPCAPICommand("rpc_summary", "summary")],
-    "wattage": {"cmd": "get_wattage", "kwargs": {}},
+        ),
-    "wattage_limit": {"cmd": "get_wattage_limit", "kwargs": {}},
+        str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-    "fans": {"cmd": "get_fans", "kwargs": {"api_stats": {"api": "stats"}}},
+            "_get_expected_hashrate",
-    "fan_psu": {"cmd": "get_fan_psu", "kwargs": {}},
+            [RPCAPICommand("rpc_stats", "stats")],
-    "errors": {"cmd": "get_errors", "kwargs": {}},
+        ),
-    "fault_light": {"cmd": "get_fault_light", "kwargs": {}},
+        str(DataOptions.HASHBOARDS): DataFunction(
-    "pools": {"cmd": "get_pools", "kwargs": {"api_pools": {"api": "pools"}}},
+            "_get_hashboards",
-    "is_mining": {"cmd": "is_mining", "kwargs": {}},
+            [RPCAPICommand("rpc_stats", "stats")],
-    "uptime": {"cmd": "get_uptime", "kwargs": {}},
+        ),
-}
+        str(DataOptions.FANS): DataFunction(
+            "_get_fans",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+    }
+)
 
 
 class BFGMiner(BaseMiner):
     """Base handler for BFGMiner based miners."""
 
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
+    _rpc_cls = BFGMinerRPCAPI
-        super().__init__(ip)
+    rpc: BFGMinerRPCAPI
-        # interfaces
-        self.api = BFGMinerAPI(ip, api_ver)
 
-        # static data
+    data_locations = BFGMINER_DATA_LOC
-        self.api_type = "BFGMiner"
-        # data gathering locations
-        self.data_locations = BFGMINER_DATA_LOC
-
-        # data storage
-        self.api_ver = api_ver
 
     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) -> str:
+    async def _get_api_ver(self, rpc_version: dict = None) -> Optional[str]:
-        return "00:00:00:00:00:00"
+        if rpc_version is None:
-
-    async def get_api_ver(self, api_version: dict = None) -> Optional[str]:
-        # Check to see if the version info is already cached
-        if self.api_ver:
-            return self.api_ver
-
-        if not api_version:
             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 (KeyError, IndexError):
+            except LookupError:
                 pass
 
         return self.api_ver
 
-    async def get_fw_ver(self, api_version: dict = None) -> Optional[str]:
+    async def _get_fw_ver(self, rpc_version: dict = None) -> Optional[str]:
-        # Check to see if the version info is already cached
+        if rpc_version is None:
-        if self.fw_ver:
-            return self.fw_ver
-
-        if not api_version:
             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 (KeyError, IndexError):
+            except LookupError:
                 pass
 
         return self.fw_ver
 
-    async def get_version(
+    async def _get_hashrate(self, rpc_summary: dict = None) -> Optional[float]:
-        self, api_version: dict = None
-    ) -> Tuple[Optional[str], Optional[str]]:
-        # check if version is cached
-        miner_version = namedtuple("MinerVersion", "api_ver fw_ver")
-        return miner_version(
-            api_ver=await self.get_api_ver(api_version),
-            fw_ver=await self.get_fw_ver(api_version=api_version),
-        )
-
-    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]:
         # 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 (IndexError, KeyError, ValueError, TypeError):
+            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):
@@ -197,9 +142,11 @@ class BFGMiner(BaseMiner):
                     if board_offset == -1:
                         board_offset = 1
 
-                    for i in range(board_offset, board_offset + self.ideal_hashboards):
+                    for i in range(
+                        board_offset, board_offset + self.expected_hashboards
+                    ):
                         hashboard = HashBoard(
-                            slot=i - board_offset, expected_chips=self.nominal_chips
+                            slot=i - board_offset, expected_chips=self.expected_chips
                         )
 
                         chip_temp = boards[1].get(f"temp{i}")
@@ -221,108 +168,61 @@ class BFGMiner(BaseMiner):
                         if (not chips) or (not chips > 0):
                             hashboard.missing = True
                         hashboards.append(hashboard)
-            except (IndexError, KeyError, ValueError, TypeError):
+            except (LookupError, ValueError, TypeError):
                 pass
 
         return hashboards
 
-    async def get_env_temp(self) -> Optional[float]:
+    async def _get_fans(self, rpc_stats: dict = None) -> List[Fan]:
-        return None
+        if rpc_stats is 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()
+                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.fan_count):
+                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 (KeyError, IndexError):
+            except LookupError:
                 pass
         fans = [Fan(speed=d) if d else Fan() for d in fans_data]
 
         return fans
 
-    async def get_pools(self, api_pools: dict = None) -> List[dict]:
+    async def _get_expected_hashrate(self, rpc_stats: dict = None) -> Optional[float]:
-        groups = []
-
-        if not api_pools:
-            try:
-                api_pools = await self.api.pools()
-            except APIError:
-                pass
-
-        if api_pools:
-            try:
-                pools = {}
-                for i, pool in enumerate(api_pools["POOLS"]):
-                    pools[f"pool_{i + 1}_url"] = (
-                        pool["URL"]
-                        .replace("stratum+tcp://", "")
-                        .replace("stratum2+tcp://", "")
-                    )
-                    pools[f"pool_{i + 1}_user"] = pool["User"]
-                    pools["quota"] = pool["Quota"] if pool.get("Quota") else "0"
-
-                groups.append(pools)
-            except KeyError:
-                pass
-        return groups
-
-    async def get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def get_fault_light(self) -> bool:
-        return False
-
-    async def get_nominal_hashrate(self, api_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:
-                ideal_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":
-                    return round(ideal_rate / 1000, 2)
+                    return round(expected_rate / 1000, 2)
                 if rate_unit == "MH":
-                    return round(ideal_rate / 1000000, 2)
+                    return round(expected_rate / 1000000, 2)
                 else:
-                    return round(ideal_rate, 2)
+                    return round(expected_rate, 2)
-            except (KeyError, IndexError):
+            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,217 +14,128 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-import logging
+from typing import List, Optional
-from collections import namedtuple
-from typing import List, Optional, Tuple
 
-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
+from pyasic.miners.data import DataFunction, DataLocations, DataOptions, RPCAPICommand
+from pyasic.rpc.bmminer import BMMinerRPCAPI
 
-BMMINER_DATA_LOC = {
+BMMINER_DATA_LOC = DataLocations(
-    "mac": {"cmd": "get_mac", "kwargs": {}},
+    **{
-    "model": {"cmd": "get_model", "kwargs": {}},
+        str(DataOptions.API_VERSION): DataFunction(
-    "api_ver": {"cmd": "get_api_ver", "kwargs": {"api_version": {"api": "version"}}},
+            "_get_api_ver",
-    "fw_ver": {"cmd": "get_fw_ver", "kwargs": {"api_version": {"api": "version"}}},
+            [RPCAPICommand("rpc_version", "version")],
-    "hostname": {"cmd": "get_hostname", "kwargs": {}},
+        ),
-    "hashrate": {"cmd": "get_hashrate", "kwargs": {"api_summary": {"api": "summary"}}},
+        str(DataOptions.FW_VERSION): DataFunction(
-    "nominal_hashrate": {
+            "_get_fw_ver",
-        "cmd": "get_nominal_hashrate",
+            [RPCAPICommand("rpc_version", "version")],
-        "kwargs": {"api_stats": {"api": "stats"}},
+        ),
-    },
+        str(DataOptions.HASHRATE): DataFunction(
-    "hashboards": {"cmd": "get_hashboards", "kwargs": {"api_stats": {"api": "stats"}}},
+            "_get_hashrate",
-    "env_temp": {"cmd": "get_env_temp", "kwargs": {}},
+            [RPCAPICommand("rpc_summary", "summary")],
-    "wattage": {"cmd": "get_wattage", "kwargs": {}},
+        ),
-    "wattage_limit": {"cmd": "get_wattage_limit", "kwargs": {}},
+        str(DataOptions.EXPECTED_HASHRATE): DataFunction(
-    "fans": {"cmd": "get_fans", "kwargs": {"api_stats": {"api": "stats"}}},
+            "_get_expected_hashrate",
-    "fan_psu": {"cmd": "get_fan_psu", "kwargs": {}},
+            [RPCAPICommand("rpc_stats", "stats")],
-    "errors": {"cmd": "get_errors", "kwargs": {}},
+        ),
-    "fault_light": {"cmd": "get_fault_light", "kwargs": {}},
+        str(DataOptions.HASHBOARDS): DataFunction(
-    "pools": {"cmd": "get_pools", "kwargs": {"api_pools": {"api": "pools"}}},
+            "_get_hashboards",
-    "is_mining": {"cmd": "is_mining", "kwargs": {}},
+            [RPCAPICommand("rpc_stats", "stats")],
-    "uptime": {
+        ),
-        "cmd": "get_uptime",
+        str(DataOptions.FANS): DataFunction(
-        "kwargs": {"api_stats": {"api": "stats"}},
+            "_get_fans",
-    },
+            [RPCAPICommand("rpc_stats", "stats")],
-}
+        ),
+        str(DataOptions.UPTIME): DataFunction(
+            "_get_uptime",
+            [RPCAPICommand("rpc_stats", "stats")],
+        ),
+    }
+)
 
 
 class BMMiner(BaseMiner):
     """Base handler for BMMiner based miners."""
 
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
+    _rpc_cls = BMMinerRPCAPI
-        super().__init__(ip)
+    rpc: BMMinerRPCAPI
-        # interfaces
-        self.api = BMMinerAPI(ip, api_ver)
 
-        # static data
+    data_locations = BMMINER_DATA_LOC
-        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
 
     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) -> str:
+    async def _get_api_ver(self, rpc_version: dict = None) -> Optional[str]:
-        return "00:00:00:00:00:00"
+        if rpc_version is None:
-
-    async def get_api_ver(self, api_version: dict = None) -> Optional[str]:
-        # Check to see if the version info is already cached
-        if self.api_ver:
-            return self.api_ver
-
-        if not api_version:
             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 (KeyError, IndexError):
+            except LookupError:
                 pass
 
         return self.api_ver
 
-    async def get_fw_ver(self, api_version: dict = None) -> Optional[str]:
+    async def _get_fw_ver(self, rpc_version: dict = None) -> Optional[str]:
-        # Check to see if the version info is already cached
+        if rpc_version is None:
-        if self.fw_ver:
-            return self.fw_ver
-
-        if not api_version:
             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 (KeyError, IndexError):
+            except LookupError:
                 pass
 
         return self.fw_ver
 
-    async def get_version(
+    async def _get_hashrate(self, rpc_summary: dict = None) -> Optional[float]:
-        self, api_version: dict = None
-    ) -> Tuple[Optional[str], Optional[str]]:
-        # check if version is cached
-        miner_version = namedtuple("MinerVersion", "api_ver fw_ver")
-        return miner_version(
-            api_ver=await self.get_api_ver(api_version),
-            fw_ver=await self.get_fw_ver(api_version=api_version),
-        )
-
-    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]:
         # 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 (IndexError, KeyError, ValueError, TypeError):
+            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):
@@ -247,12 +158,12 @@ class BMMiner(BaseMiner):
 
                     if len(real_slots) < 3:
                         real_slots = list(
-                            range(board_offset, board_offset + self.ideal_hashboards)
+                            range(board_offset, board_offset + self.expected_hashboards)
                         )
 
                     for i in real_slots:
                         hashboard = HashBoard(
-                            slot=i - board_offset, expected_chips=self.nominal_chips
+                            slot=i - board_offset, expected_chips=self.expected_chips
                         )
 
                         chip_temp = boards[1].get(f"temp{i}")
@@ -279,112 +190,68 @@ class BMMiner(BaseMiner):
 
         return hashboards
 
-    async def get_env_temp(self) -> Optional[float]:
+    async def _get_fans(self, rpc_stats: dict = None) -> List[Fan]:
-        return None
+        if rpc_stats is 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()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        fans = [Fan() for _ in range(self.fan_count)]
+        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.fan_count):
+                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 (KeyError, IndexError):
+            except LookupError:
                 pass
 
         return fans
 
-    async def get_pools(self, api_pools: dict = None) -> List[dict]:
+    async def _get_expected_hashrate(self, rpc_stats: dict = None) -> Optional[float]:
-        groups = []
-
-        if not api_pools:
-            try:
-                api_pools = await self.api.pools()
-            except APIError:
-                pass
-
-        if api_pools:
-            try:
-                pools = {}
-                for i, pool in enumerate(api_pools["POOLS"]):
-                    pools[f"pool_{i + 1}_url"] = (
-                        pool["URL"]
-                        .replace("stratum+tcp://", "")
-                        .replace("stratum2+tcp://", "")
-                    )
-                    pools[f"pool_{i + 1}_user"] = pool["User"]
-                    pools["quota"] = pool["Quota"] if pool.get("Quota") else "0"
-
-                groups.append(pools)
-            except KeyError:
-                pass
-        return groups
-
-    async def get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def get_fault_light(self) -> bool:
-        return False
-
-    async def get_nominal_hashrate(self, api_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:
-                ideal_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":
-                    return round(ideal_rate / 1000, 2)
+                    return round(expected_rate / 1000, 2)
                 if rate_unit == "MH":
-                    return round(ideal_rate / 1000000, 2)
+                    return round(expected_rate / 1000000, 2)
                 else:
-                    return round(ideal_rate, 2)
+                    return round(expected_rate, 2)
-            except (KeyError, IndexError):
+            except LookupError:
                 pass
 
-    async def is_mining(self, *args, **kwargs) -> Optional[bool]:
+    async def _get_uptime(self, rpc_stats: dict = None) -> Optional[int]:
-        return None
+        if rpc_stats is None:
-
-    async def get_uptime(self, api_stats: dict = None) -> Optional[int]:
-        if not api_stats:
             try:
-                api_stats = await self.web.get_miner_conf()
+                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/bosminer_old.py

@@ -1,158 +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 logging
-from typing import List, Optional, Tuple
-
-from pyasic.config import MinerConfig
-from pyasic.data import Fan, HashBoard, MinerData
-from pyasic.data.error_codes import MinerErrorData
-from pyasic.miners.backends import BOSMiner
-
-
-class BOSMinerOld(BOSMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, 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 update_to_plus(self):
-        result = await self.send_ssh_command("opkg update && opkg install bos_plus")
-        return result
-
-    async def check_light(self) -> bool:
-        return False
-
-    async def fault_light_on(self) -> bool:
-        return False
-
-    async def fault_light_off(self) -> bool:
-        return False
-
-    async def get_config(self) -> None:
-        return None
-
-    async def reboot(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 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, *args, **kwargs) -> Optional[str]:
-        return None
-
-    async def get_model(self, *args, **kwargs) -> str:
-        return "S9"
-
-    async def get_version(self, *args, **kwargs) -> Tuple[Optional[str], Optional[str]]:
-        return None, None
-
-    async def get_hostname(self, *args, **kwargs) -> Optional[str]:
-        return None
-
-    async def get_hashrate(self, *args, **kwargs) -> Optional[float]:
-        return None
-
-    async def get_hashboards(self, *args, **kwargs) -> List[HashBoard]:
-        return []
-
-    async def get_env_temp(self, *args, **kwargs) -> Optional[float]:
-        return None
-
-    async def get_wattage(self, *args, **kwargs) -> Optional[int]:
-        return None
-
-    async def get_wattage_limit(self, *args, **kwargs) -> Optional[int]:
-        return None
-
-    async def get_fans(
-        self,
-        *args,
-        **kwargs,
-    ) -> List[Fan]:
-        return [Fan(), Fan(), Fan(), Fan()]
-
-    async def get_fan_psu(self, *args, **kwargs) -> Optional[int]:
-        return None
-
-    async def get_api_ver(self, *args, **kwargs) -> Optional[str]:
-        return None
-
-    async def get_fw_ver(self, *args, **kwargs) -> Optional[str]:
-        return None
-
-    async def get_pools(self, *args, **kwargs) -> List[dict]:
-        return []
-
-    async def get_errors(self, *args, **kwargs) -> List[MinerErrorData]:
-        return []
-
-    async def get_fault_light(self, *args, **kwargs) -> bool:
-        return False
-
-    async def get_nominal_hashrate(self, *args, **kwargs) -> Optional[float]:
-        return None
-
-    async def get_data(self, allow_warning: bool = False, **kwargs) -> MinerData:
-        return MinerData(ip=str(self.ip))
-
-    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/braiins_os.py

@@ -0,0 +1,960 @@
+# ------------------------------------------------------------------------------
+#  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
+import time
+from typing import List, Optional, Union
+
+import toml
+
+from pyasic.config import MinerConfig
+from pyasic.config.mining import MiningModePowerTune
+from pyasic.data import Fan, HashBoard
+from pyasic.data.error_codes import BraiinsOSError, MinerErrorData
+from pyasic.errors import APIError
+from pyasic.miners.base import BaseMiner
+from pyasic.miners.data import (
+    DataFunction,
+    DataLocations,
+    DataOptions,
+    RPCAPICommand,
+    WebAPICommand,
+)
+from pyasic.rpc.bosminer import BOSMinerRPCAPI
+from pyasic.ssh.braiins_os import BOSMinerSSH
+from pyasic.web.braiins_os import BOSerWebAPI, BOSMinerWebAPI
+
+BOSMINER_DATA_LOC = DataLocations(
+    **{
+        str(DataOptions.MAC): DataFunction(
+            "_get_mac",
+            [WebAPICommand("web_net_conf", "admin/network/iface_status/lan")],
+        ),
+        str(DataOptions.API_VERSION): DataFunction(
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
+        ),
+        str(DataOptions.FW_VERSION): DataFunction(
+            "_get_fw_ver",
+            [WebAPICommand("web_bos_info", "bos/info")],
+        ),
+        str(DataOptions.HASHRATE): DataFunction(
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
+        ),
+        str(DataOptions.EXPECTED_HASHRATE): DataFunction(
+            "_get_expected_hashrate",
+            [RPCAPICommand("rpc_devs", "devs")],
+        ),
+        str(DataOptions.HASHBOARDS): DataFunction(
+            "_get_hashboards",
+            [
+                RPCAPICommand("rpc_temps", "temps"),
+                RPCAPICommand("rpc_devdetails", "devdetails"),
+                RPCAPICommand("rpc_devs", "devs"),
+            ],
+        ),
+        str(DataOptions.WATTAGE): DataFunction(
+            "_get_wattage",
+            [RPCAPICommand("rpc_tunerstatus", "tunerstatus")],
+        ),
+        str(DataOptions.WATTAGE_LIMIT): DataFunction(
+            "_get_wattage_limit",
+            [RPCAPICommand("rpc_tunerstatus", "tunerstatus")],
+        ),
+        str(DataOptions.FANS): DataFunction(
+            "_get_fans",
+            [RPCAPICommand("rpc_fans", "fans")],
+        ),
+        str(DataOptions.ERRORS): DataFunction(
+            "_get_errors",
+            [RPCAPICommand("rpc_tunerstatus", "tunerstatus")],
+        ),
+        str(DataOptions.IS_MINING): DataFunction(
+            "_is_mining",
+            [RPCAPICommand("rpc_devdetails", "devdetails")],
+        ),
+        str(DataOptions.UPTIME): DataFunction(
+            "_get_uptime",
+            [RPCAPICommand("rpc_summary", "summary")],
+        ),
+    }
+)
+
+
+class BOSMiner(BaseMiner):
+    """Handler for old versions of BraiinsOS+ (pre-gRPC)"""
+
+    _rpc_cls = BOSMinerRPCAPI
+    rpc: BOSMinerRPCAPI
+    _web_cls = BOSMinerWebAPI
+    web: BOSMinerWebAPI
+    _ssh_cls = BOSMinerSSH
+    ssh: BOSMinerSSH
+
+    firmware = "BOS+"
+
+    data_locations = BOSMINER_DATA_LOC
+
+    supports_shutdown = True
+    supports_autotuning = True
+
+    async def fault_light_on(self) -> bool:
+        ret = await self.ssh.fault_light_on()
+
+        if isinstance(ret, str):
+            self.light = True
+            return self.light
+        return False
+
+    async def fault_light_off(self) -> bool:
+        ret = await self.ssh.fault_light_off()
+
+        if isinstance(ret, str):
+            self.light = False
+            return True
+        return False
+
+    async def restart_backend(self) -> bool:
+        return await self.restart_bosminer()
+
+    async def restart_bosminer(self) -> bool:
+        ret = await self.ssh.restart_bosminer()
+
+        if isinstance(ret, str):
+            return True
+        return False
+
+    async def stop_mining(self) -> bool:
+        try:
+            data = await self.rpc.pause()
+        except APIError:
+            return False
+
+        if data.get("PAUSE"):
+            if data["PAUSE"][0]:
+                return True
+        return False
+
+    async def resume_mining(self) -> bool:
+        try:
+            data = await self.rpc.resume()
+        except APIError:
+            return False
+
+        if data.get("RESUME"):
+            if data["RESUME"][0]:
+                return True
+        return False
+
+    async def reboot(self) -> bool:
+        ret = await self.ssh.reboot()
+
+        if isinstance(ret, str):
+            return True
+        return False
+
+    async def get_config(self) -> MinerConfig:
+        raw_data = await self.ssh.get_config_file()
+
+        try:
+            toml_data = toml.loads(raw_data)
+            cfg = MinerConfig.from_bosminer(toml_data)
+            self.config = cfg
+        except toml.TomlDecodeError as e:
+            raise APIError("Failed to decode toml when getting config.") from e
+
+        return self.config
+
+    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
+        self.config = config
+
+        toml_conf = toml.dumps(
+            {
+                "format": {
+                    "version": "1.2+",
+                    "generator": "pyasic",
+                    "model": f"{self.make.replace('Miner', 'miner')} {self.raw_model.replace('j', 'J')}",
+                    "timestamp": int(time.time()),
+                },
+                **config.as_bosminer(user_suffix=user_suffix),
+            }
+        )
+        try:
+            conn = await self.ssh._get_connection()
+        except ConnectionError as e:
+            raise APIError("SSH connection failed when sending config.") from e
+
+        async with conn:
+            await conn.run("/etc/init.d/bosminer stop")
+            async with conn.start_sftp_client() as sftp:
+                async with sftp.open("/etc/bosminer.toml", "w+") as file:
+                    await file.write(toml_conf)
+            await conn.run("/etc/init.d/bosminer start")
+
+    async def set_power_limit(self, wattage: int) -> bool:
+        try:
+            cfg = await self.get_config()
+            if cfg is None:
+                return False
+            cfg.mining_mode = MiningModePowerTune(wattage)
+            await self.send_config(cfg)
+        except APIError:
+            raise
+        except Exception as e:
+            logging.warning(f"{self} - Failed to set power limit: {e}")
+            return False
+        else:
+            return True
+
+    async def set_static_ip(
+        self,
+        ip: str,
+        dns: str,
+        gateway: str,
+        subnet_mask: str = "255.255.255.0",
+    ):
+        cfg_data_lan = "\n\t".join(
+            [
+                "config interface 'lan'",
+                "option type 'bridge'",
+                "option ifname 'eth0'",
+                "option proto 'static'",
+                f"option ipaddr '{ip}'",
+                f"option netmask '{subnet_mask}'",
+                f"option gateway '{gateway}'",
+                f"option dns '{dns}'",
+            ]
+        )
+        data = await self.ssh.get_network_config()
+
+        split_data = data.split("\n\n")
+        for idx, val in enumerate(split_data):
+            if "config interface 'lan'" in val:
+                split_data[idx] = cfg_data_lan
+        config = "\n\n".join(split_data)
+
+        await self.ssh.send_command("echo '" + config + "' > /etc/config/network")
+
+    async def set_dhcp(self):
+        cfg_data_lan = "\n\t".join(
+            [
+                "config interface 'lan'",
+                "option type 'bridge'",
+                "option ifname 'eth0'",
+                "option proto 'dhcp'",
+            ]
+        )
+        data = await self.ssh.get_network_config()
+
+        split_data = data.split("\n\n")
+        for idx, val in enumerate(split_data):
+            if "config interface 'lan'" in val:
+                split_data[idx] = cfg_data_lan
+        config = "\n\n".join(split_data)
+
+        await self.ssh.send_command("echo '" + config + "' > /etc/config/network")
+
+    ##################################################
+    ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
+    ##################################################
+
+    async def _get_mac(self, web_net_conf: Union[dict, list] = None) -> Optional[str]:
+        if web_net_conf is None:
+            try:
+                web_net_conf = await self.web.get_net_conf()
+            except APIError:
+                pass
+
+        if isinstance(web_net_conf, dict):
+            if "admin/network/iface_status/lan" in web_net_conf.keys():
+                web_net_conf = web_net_conf["admin/network/iface_status/lan"]
+
+        if web_net_conf is not None:
+            try:
+                return web_net_conf[0]["macaddr"]
+            except LookupError:
+                pass
+        # could use ssh, but its slow and buggy
+        # result = await self.send_ssh_command("cat /sys/class/net/eth0/address")
+        # if result:
+        #     return result.upper().strip()
+
+    async def _get_api_ver(self, rpc_version: dict = None) -> Optional[str]:
+        if rpc_version is None:
+            try:
+                rpc_version = await self.rpc.version()
+            except APIError:
+                pass
+
+        # Now get the API version
+        if rpc_version is not None:
+            try:
+                rpc_ver = rpc_version["VERSION"][0]["API"]
+            except LookupError:
+                rpc_ver = None
+            self.api_ver = rpc_ver
+            self.rpc.rpc_ver = self.api_ver
+
+        return self.api_ver
+
+    async def _get_fw_ver(self, web_bos_info: dict = None) -> Optional[str]:
+        if web_bos_info is None:
+            try:
+                web_bos_info = await self.web.get_bos_info()
+            except APIError:
+                return None
+
+        if isinstance(web_bos_info, dict):
+            if "bos/info" in web_bos_info.keys():
+                web_bos_info = web_bos_info["bos/info"]
+
+        try:
+            ver = web_bos_info["version"].split("-")[5]
+            if "." in ver:
+                self.fw_ver = ver
+        except (LookupError, AttributeError):
+            return None
+
+        return self.fw_ver
+
+    async def _get_hostname(self) -> Union[str, None]:
+        try:
+            hostname = (await self.ssh.get_hostname()).strip()
+        except AttributeError:
+            return None
+        except Exception as e:
+            logging.error(f"{self} - Getting hostname failed: {e}")
+            return None
+        return hostname
+
+    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(rpc_summary["SUMMARY"][0]["MHS 1m"] / 1000000), 2)
+            except (KeyError, IndexError, ValueError, TypeError):
+                pass
+
+    async def _get_hashboards(
+        self,
+        rpc_temps: dict = None,
+        rpc_devdetails: dict = None,
+        rpc_devs: dict = None,
+    ) -> List[HashBoard]:
+        hashboards = [
+            HashBoard(slot=i, expected_chips=self.expected_chips)
+            for i in range(self.expected_hashboards)
+        ]
+
+        cmds = []
+        if rpc_temps is None:
+            cmds.append("temps")
+        if rpc_devdetails is None:
+            cmds.append("devdetails")
+        if rpc_devs is None:
+            cmds.append("devs")
+        if len(cmds) > 0:
+            try:
+                d = await self.rpc.multicommand(*cmds)
+            except APIError:
+                d = {}
+            try:
+                rpc_temps = d["temps"][0]
+            except LookupError:
+                rpc_temps = None
+            try:
+                rpc_devdetails = d["devdetails"][0]
+            except (KeyError, IndexError):
+                rpc_devdetails = None
+            try:
+                rpc_devs = d["devs"][0]
+            except LookupError:
+                rpc_devs = None
+        if rpc_temps is not None:
+            try:
+                offset = 6 if rpc_temps["TEMPS"][0]["ID"] in [6, 7, 8] else 1
+
+                for board in rpc_temps["TEMPS"]:
+                    _id = board["ID"] - offset
+                    chip_temp = round(board["Chip"])
+                    board_temp = round(board["Board"])
+                    hashboards[_id].chip_temp = chip_temp
+                    hashboards[_id].temp = board_temp
+            except (IndexError, KeyError, ValueError, TypeError):
+                pass
+
+        if rpc_devdetails is not None:
+            try:
+                offset = 6 if rpc_devdetails["DEVDETAILS"][0]["ID"] in [6, 7, 8] else 1
+
+                for board in rpc_devdetails["DEVDETAILS"]:
+                    _id = board["ID"] - offset
+                    chips = board["Chips"]
+                    hashboards[_id].chips = chips
+                    hashboards[_id].missing = False
+            except (IndexError, KeyError):
+                pass
+
+        if rpc_devs is not None:
+            try:
+                offset = 6 if rpc_devs["DEVS"][0]["ID"] in [6, 7, 8] else 1
+
+                for board in rpc_devs["DEVS"]:
+                    _id = board["ID"] - offset
+                    hashrate = round(float(board["MHS 1m"] / 1000000), 2)
+                    hashboards[_id].hashrate = hashrate
+            except (IndexError, KeyError):
+                pass
+
+        return hashboards
+
+    async def _get_wattage(self, rpc_tunerstatus: dict = None) -> Optional[int]:
+        if rpc_tunerstatus is None:
+            try:
+                rpc_tunerstatus = await self.rpc.tunerstatus()
+            except APIError:
+                pass
+
+        if rpc_tunerstatus is not None:
+            try:
+                return rpc_tunerstatus["TUNERSTATUS"][0][
+                    "ApproximateMinerPowerConsumption"
+                ]
+            except LookupError:
+                pass
+
+    async def _get_wattage_limit(self, rpc_tunerstatus: dict = None) -> Optional[int]:
+        if rpc_tunerstatus is None:
+            try:
+                rpc_tunerstatus = await self.rpc.tunerstatus()
+            except APIError:
+                pass
+
+        if rpc_tunerstatus is not None:
+            try:
+                return rpc_tunerstatus["TUNERSTATUS"][0]["PowerLimit"]
+            except LookupError:
+                pass
+
+    async def _get_fans(self, rpc_fans: dict = None) -> List[Fan]:
+        if rpc_fans is None:
+            try:
+                rpc_fans = await self.rpc.fans()
+            except APIError:
+                pass
+
+        if rpc_fans is not None:
+            fans = []
+            for n in range(self.expected_fans):
+                try:
+                    fans.append(Fan(rpc_fans["FANS"][n]["RPM"]))
+                except (IndexError, KeyError):
+                    pass
+            return fans
+        return [Fan() for _ in range(self.expected_fans)]
+
+    async def _get_errors(self, rpc_tunerstatus: dict = None) -> List[MinerErrorData]:
+        if rpc_tunerstatus is None:
+            try:
+                rpc_tunerstatus = await self.rpc.tunerstatus()
+            except APIError:
+                pass
+
+        if rpc_tunerstatus is not None:
+            errors = []
+            try:
+                chain_status = rpc_tunerstatus["TUNERSTATUS"][0]["TunerChainStatus"]
+                if chain_status and len(chain_status) > 0:
+                    offset = (
+                        6 if int(chain_status[0]["HashchainIndex"]) in [6, 7, 8] else 0
+                    )
+
+                    for board in chain_status:
+                        _id = board["HashchainIndex"] - offset
+                        if board["Status"] not in [
+                            "Stable",
+                            "Testing performance profile",
+                            "Tuning individual chips",
+                        ]:
+                            _error = board["Status"].split(" {")[0]
+                            _error = _error[0].lower() + _error[1:]
+                            errors.append(BraiinsOSError(f"Slot {_id} {_error}"))
+                return errors
+            except (KeyError, IndexError):
+                pass
+
+    async def _get_fault_light(self) -> bool:
+        if self.light:
+            return self.light
+        try:
+            data = (await self.ssh.get_led_status()).strip()
+            self.light = False
+            if data == "50":
+                self.light = True
+            return self.light
+        except (TypeError, AttributeError):
+            return self.light
+
+    async def _get_expected_hashrate(self, rpc_devs: dict = None) -> Optional[float]:
+        if rpc_devs is None:
+            try:
+                rpc_devs = await self.rpc.devs()
+            except APIError:
+                pass
+
+        if rpc_devs is not None:
+            try:
+                hr_list = []
+
+                for board in rpc_devs["DEVS"]:
+                    expected_hashrate = round(float(board["Nominal MHS"] / 1000000), 2)
+                    if expected_hashrate:
+                        hr_list.append(expected_hashrate)
+                if len(hr_list) == 0:
+                    return 0
+                else:
+                    return round(
+                        (sum(hr_list) / len(hr_list)) * self.expected_hashboards, 2
+                    )
+            except (IndexError, KeyError):
+                pass
+
+    async def _is_mining(self, rpc_devdetails: dict = None) -> Optional[bool]:
+        if rpc_devdetails is None:
+            try:
+                rpc_devdetails = await self.rpc.send_command(
+                    "devdetails", ignore_errors=True, allow_warning=False
+                )
+            except APIError:
+                pass
+
+        if rpc_devdetails is not None:
+            try:
+                return not rpc_devdetails["STATUS"][0]["Msg"] == "Unavailable"
+            except LookupError:
+                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 int(rpc_summary["SUMMARY"][0]["Elapsed"])
+            except LookupError:
+                pass
+
+
+BOSER_DATA_LOC = DataLocations(
+    **{
+        str(DataOptions.MAC): DataFunction(
+            "_get_mac",
+            [WebAPICommand("grpc_miner_details", "get_miner_details")],
+        ),
+        str(DataOptions.API_VERSION): DataFunction(
+            "_get_api_ver",
+            [RPCAPICommand("rpc_version", "version")],
+        ),
+        str(DataOptions.FW_VERSION): DataFunction(
+            "_get_fw_ver",
+            [WebAPICommand("grpc_miner_details", "get_miner_details")],
+        ),
+        str(DataOptions.HOSTNAME): DataFunction(
+            "_get_hostname",
+            [WebAPICommand("grpc_miner_details", "get_miner_details")],
+        ),
+        str(DataOptions.HASHRATE): DataFunction(
+            "_get_hashrate",
+            [RPCAPICommand("rpc_summary", "summary")],
+        ),
+        str(DataOptions.EXPECTED_HASHRATE): DataFunction(
+            "_get_expected_hashrate",
+            [WebAPICommand("grpc_miner_details", "get_miner_details")],
+        ),
+        str(DataOptions.HASHBOARDS): DataFunction(
+            "_get_hashboards",
+            [WebAPICommand("grpc_hashboards", "get_hashboards")],
+        ),
+        str(DataOptions.WATTAGE): DataFunction(
+            "_get_wattage",
+            [WebAPICommand("grpc_miner_stats", "get_miner_stats")],
+        ),
+        str(DataOptions.WATTAGE_LIMIT): DataFunction(
+            "_get_wattage_limit",
+            [
+                WebAPICommand(
+                    "grpc_active_performance_mode", "get_active_performance_mode"
+                )
+            ],
+        ),
+        str(DataOptions.FANS): DataFunction(
+            "_get_fans",
+            [WebAPICommand("grpc_cooling_state", "get_cooling_state")],
+        ),
+        str(DataOptions.ERRORS): DataFunction(
+            "_get_errors",
+            [RPCAPICommand("rpc_tunerstatus", "tunerstatus")],
+        ),
+        str(DataOptions.FAULT_LIGHT): DataFunction(
+            "_get_fault_light",
+            [WebAPICommand("grpc_locate_device_status", "get_locate_device_status")],
+        ),
+        str(DataOptions.IS_MINING): DataFunction(
+            "_is_mining",
+            [RPCAPICommand("rpc_devdetails", "devdetails")],
+        ),
+        str(DataOptions.UPTIME): DataFunction(
+            "_get_uptime",
+            [RPCAPICommand("rpc_summary", "summary")],
+        ),
+    }
+)
+
+
+class BOSer(BaseMiner):
+    """Handler for new versions of BraiinsOS+ (post-gRPC)"""
+
+    _rpc_cls = BOSMinerRPCAPI
+    web: BOSMinerRPCAPI
+    _web_cls = BOSerWebAPI
+    web: BOSerWebAPI
+
+    data_locations = BOSER_DATA_LOC
+
+    supports_autotuning = True
+    supports_shutdown = True
+
+    async def fault_light_on(self) -> bool:
+        resp = await self.web.set_locate_device_status(True)
+        if resp.get("enabled", False):
+            return True
+        return False
+
+    async def fault_light_off(self) -> bool:
+        resp = await self.web.set_locate_device_status(False)
+        if resp == {}:
+            return True
+        return False
+
+    async def restart_backend(self) -> bool:
+        return await self.restart_boser()
+
+    async def restart_boser(self) -> bool:
+        await self.web.restart()
+        return True
+
+    async def stop_mining(self) -> bool:
+        try:
+            await self.web.pause_mining()
+        except APIError:
+            return False
+        return True
+
+    async def resume_mining(self) -> bool:
+        try:
+            await self.web.resume_mining()
+        except APIError:
+            return False
+        return True
+
+    async def reboot(self) -> bool:
+        ret = await self.web.reboot()
+        if ret == {}:
+            return True
+        return False
+
+    async def get_config(self) -> MinerConfig:
+        grpc_conf = await self.web.get_miner_configuration()
+
+        return MinerConfig.from_boser(grpc_conf)
+
+    async def set_power_limit(self, wattage: int) -> bool:
+        try:
+            result = await self.web.set_power_target(wattage)
+        except APIError:
+            return False
+
+        try:
+            if result["powerTarget"]["watt"] == wattage:
+                return True
+        except KeyError:
+            pass
+        return False
+
+    ##################################################
+    ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
+    ##################################################
+
+    async def _get_mac(self, grpc_miner_details: dict = None) -> Optional[str]:
+        if grpc_miner_details is None:
+            try:
+                grpc_miner_details = await self.web.get_miner_details()
+            except APIError:
+                pass
+
+        if grpc_miner_details is not None:
+            try:
+                return grpc_miner_details["macAddress"].upper()
+            except (LookupError, TypeError):
+                pass
+
+    async def _get_api_ver(self, rpc_version: dict = None) -> Optional[str]:
+        if rpc_version is None:
+            try:
+                rpc_version = await self.rpc.version()
+            except APIError:
+                pass
+
+        if rpc_version is not None:
+            try:
+                rpc_ver = rpc_version["VERSION"][0]["API"]
+            except LookupError:
+                rpc_ver = None
+            self.api_ver = rpc_ver
+            self.rpc.rpc_ver = self.api_ver
+
+        return self.api_ver
+
+    async def _get_fw_ver(self, grpc_miner_details: dict = None) -> Optional[str]:
+        if grpc_miner_details is None:
+            try:
+                grpc_miner_details = await self.web.get_miner_details()
+            except APIError:
+                pass
+
+        fw_ver = None
+
+        if grpc_miner_details is not None:
+            try:
+                fw_ver = grpc_miner_details["bosVersion"]["current"]
+            except (KeyError, TypeError):
+                pass
+
+        # if we get the version data, parse it
+        if fw_ver is not None:
+            ver = fw_ver.split("-")[5]
+            if "." in ver:
+                self.fw_ver = ver
+
+        return self.fw_ver
+
+    async def _get_hostname(self, grpc_miner_details: dict = None) -> Optional[str]:
+        if grpc_miner_details is None:
+            try:
+                grpc_miner_details = await self.web.get_miner_details()
+            except APIError:
+                pass
+
+        if grpc_miner_details is not None:
+            try:
+                return grpc_miner_details["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(rpc_summary["SUMMARY"][0]["MHS 1m"] / 1000000), 2)
+            except (KeyError, IndexError, ValueError, TypeError):
+                pass
+
+    async def _get_expected_hashrate(
+        self, grpc_miner_details: dict = None
+    ) -> Optional[float]:
+        if grpc_miner_details is None:
+            try:
+                grpc_miner_details = await self.web.get_miner_details()
+            except APIError:
+                pass
+
+        if grpc_miner_details is not None:
+            try:
+                return grpc_miner_details["stickerHashrate"]["gigahashPerSecond"] / 1000
+            except LookupError:
+                pass
+
+    async def _get_hashboards(self, grpc_hashboards: dict = None) -> List[HashBoard]:
+        hashboards = [
+            HashBoard(slot=i, expected_chips=self.expected_chips)
+            for i in range(self.expected_hashboards)
+        ]
+
+        if grpc_hashboards is None:
+            try:
+                grpc_hashboards = await self.web.get_hashboards()
+            except APIError:
+                pass
+
+        if grpc_hashboards is not None:
+            for board in grpc_hashboards["hashboards"]:
+                idx = int(board["id"]) - 1
+                if board.get("chipsCount") is not None:
+                    hashboards[idx].chips = board["chipsCount"]
+                if board.get("boardTemp") is not None:
+                    hashboards[idx].temp = board["boardTemp"]["degreeC"]
+                if board.get("highestChipTemp") is not None:
+                    hashboards[idx].chip_temp = board["highestChipTemp"]["temperature"][
+                        "degreeC"
+                    ]
+                if board.get("stats") is not None:
+                    if not board["stats"]["realHashrate"]["last5S"] == {}:
+                        hashboards[idx].hashrate = round(
+                            board["stats"]["realHashrate"]["last5S"][
+                                "gigahashPerSecond"
+                            ]
+                            / 1000,
+                            2,
+                        )
+                hashboards[idx].missing = False
+
+        return hashboards
+
+    async def _get_wattage(self, grpc_miner_stats: dict = None) -> Optional[int]:
+        if grpc_miner_stats is None:
+            try:
+                grpc_miner_stats = self.web.get_miner_stats()
+            except APIError:
+                pass
+
+        if grpc_miner_stats is not None:
+            try:
+                return grpc_miner_stats["powerStats"]["approximatedConsumption"]["watt"]
+            except KeyError:
+                pass
+
+    async def _get_wattage_limit(
+        self, grpc_active_performance_mode: dict = None
+    ) -> Optional[int]:
+        if grpc_active_performance_mode is None:
+            try:
+                grpc_active_performance_mode = self.web.get_active_performance_mode()
+            except APIError:
+                pass
+
+        if grpc_active_performance_mode is not None:
+            try:
+                return grpc_active_performance_mode["tunerMode"]["powerTarget"][
+                    "powerTarget"
+                ]["watt"]
+            except KeyError:
+                pass
+
+    async def _get_fans(self, grpc_cooling_state: dict = None) -> List[Fan]:
+        if grpc_cooling_state is None:
+            try:
+                grpc_cooling_state = self.web.get_cooling_state()
+            except APIError:
+                pass
+
+        if grpc_cooling_state is not None:
+            fans = []
+            for n in range(self.expected_fans):
+                try:
+                    fans.append(Fan(grpc_cooling_state["fans"][n]["rpm"]))
+                except (IndexError, KeyError):
+                    pass
+            return fans
+        return [Fan() for _ in range(self.expected_fans)]
+
+    async def _get_errors(self, rpc_tunerstatus: dict = None) -> List[MinerErrorData]:
+        if rpc_tunerstatus is None:
+            try:
+                rpc_tunerstatus = await self.rpc.tunerstatus()
+            except APIError:
+                pass
+
+        if rpc_tunerstatus is not None:
+            errors = []
+            try:
+                chain_status = rpc_tunerstatus["TUNERSTATUS"][0]["TunerChainStatus"]
+                if chain_status and len(chain_status) > 0:
+                    offset = (
+                        6 if int(chain_status[0]["HashchainIndex"]) in [6, 7, 8] else 0
+                    )
+
+                    for board in chain_status:
+                        _id = board["HashchainIndex"] - offset
+                        if board["Status"] not in [
+                            "Stable",
+                            "Testing performance profile",
+                            "Tuning individual chips",
+                        ]:
+                            _error = board["Status"].split(" {")[0]
+                            _error = _error[0].lower() + _error[1:]
+                            errors.append(BraiinsOSError(f"Slot {_id} {_error}"))
+                return errors
+            except LookupError:
+                pass
+
+    async def _get_fault_light(self, grpc_locate_device_status: dict = None) -> bool:
+        if self.light is not None:
+            return self.light
+
+        if grpc_locate_device_status is None:
+            try:
+                grpc_locate_device_status = await self.web.get_locate_device_status()
+            except APIError:
+                pass
+
+        if grpc_locate_device_status is not None:
+            if grpc_locate_device_status == {}:
+                return False
+            try:
+                return grpc_locate_device_status["enabled"]
+            except LookupError:
+                pass
+
+    async def _is_mining(self, rpc_devdetails: dict = None) -> Optional[bool]:
+        if rpc_devdetails is None:
+            try:
+                rpc_devdetails = await self.rpc.send_command(
+                    "devdetails", ignore_errors=True, allow_warning=False
+                )
+            except APIError:
+                pass
+
+        if rpc_devdetails is not None:
+            try:
+                return not rpc_devdetails["STATUS"][0]["Msg"] == "Unavailable"
+            except LookupError:
+                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 int(rpc_summary["SUMMARY"][0]["Elapsed"])
+            except LookupError:
+                pass