bug: try to fix scan timeout with asyncio.wait_for.

* docs: add docstring for antminer and auradine in web

Signed-off-by: PAINxNAGATO <harshrawat349@gmail.com>

* Remove Trailing whitespace from the docstring

Signed-off-by: PAINxNAGATO <harshrawat349@gmail.com>

* Remove Trailing whitespace from the docstring

Signed-off-by: PAINxNAGATO <harshrawat349@gmail.com>

* Remove Trailing whitespace from the docstring of the fucntion multicommand

Signed-off-by: PAINxNAGATO <harshrawat349@gmail.com>

---------

Signed-off-by: PAINxNAGATO <harshrawat349@gmail.com>

.pre-commit-config.yaml

@@ -1,16 +1,16 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.5.0
     hooks:
     -   id: trailing-whitespace
     -   id: check-yaml
     -   id: check-added-large-files
 -   repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 24.3.0
     hooks:
     -   id: black
 -   repo: https://github.com/pycqa/isort
-    rev: 5.10.1
+    rev: 5.13.2
     hooks:
     -   id: isort
         name: isort (python)

README.md

@@ -9,7 +9,7 @@
 [![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/)
+[![Read The Docs - Docs](https://img.shields.io/readthedocs/pyasic)](https://docs.pyasic.org)
 [![License - Apache 2.0](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
 
 ---
@@ -17,7 +17,38 @@
 
 Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with ASIC miners on your network, which makes it super fast.
 
-[Click here to view supported miner types](miners/supported_types.md)
+[Click here to view supported miner types](https://docs.pyasic.org/en/latest/miners/supported_types/)
+
+---
+## Installation
+
+It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
+  - [pypoetry](https://python-poetry.org/): the reccommended way, since pyasic already uses it by default
+
+```
+    poetry install
+```
+
+  - [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
+  - [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
+
+```
+    pyenv install <python version number>
+    pyenv virtualenv <python version number> <env name>
+    pyenv activate <env name>
+```
+
+  - [conda](https://docs.conda.io/en/latest/)
+
+##### Installing `pyasic`
+
+`python -m pip install .` or `poetry install`
+
+##### Additional Developer Setup
+```
+poetry install --with dev
+pre-commit install
+```
 
 ---
 ## Getting started

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")
 
@@ -27,6 +27,8 @@ def backend_str(backend: MinerTypes) -> str:
     match backend:
         case MinerTypes.ANTMINER:
             return "Stock Firmware Antminers"
+        case MinerTypes.AURADINE:
+            return "Stock Firmware Auradine Miners"
         case MinerTypes.AVALONMINER:
             return "Stock Firmware Avalonminers"
         case MinerTypes.VNISH:
@@ -45,6 +47,8 @@ def backend_str(backend: MinerTypes) -> str:
             return "Stock Firmware Goldshells"
         case MinerTypes.LUX_OS:
             return "LuxOS Firmware Miners"
+        case MinerTypes.MARATHON:
+            return "Mara Firmware Miners"
 
 
 def create_url_str(mtype: str):

docs/index.md

@@ -18,6 +18,31 @@ Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with
 
 [Click here to view supported miner types](miners/supported_types.md)
 
+---
+## Installation
+
+It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
+  - [pypoetry](https://python-poetry.org/): the reccommended way, since pyasic already uses it by default
+
+```
+    poetry install
+```
+
+  - [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
+  - [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
+
+```
+    pyenv install <python version number>
+    pyenv virtualenv <python version number> <env name>
+    pyenv activate <env name>
+```
+
+  - [conda](https://docs.conda.io/en/latest/)
+
+##### Installing `pyasic`
+
+`python -m pip install .` or `poetry install`
+
 ---
 ## Getting started
 ---
@@ -47,7 +72,7 @@ if __name__ == "__main__":
 
 ---
 ##### Creating miners based on IP
-If you already know the IP address of your miner or miners, you can use the [`MinerFactory`][pyasic.miners.miner_factory.MinerFactory] to communicate and identify the miners, or an abstraction of its functionality, [`get_miner()`][pyasic.miners.get_miner].
+If you already know the IP address of your miner or miners, you can use the [`MinerFactory`][pyasic.miners.factory.MinerFactory] to communicate and identify the miners, or an abstraction of its functionality, [`get_miner()`][pyasic.miners.get_miner].
 The function [`get_miner()`][pyasic.miners.get_miner] will return any miner it found at the IP address specified, or an `UnknownMiner` if it cannot identify the miner.
 ```python
 import asyncio  # asyncio for handling the async part
@@ -122,24 +147,24 @@ if __name__ == "__main__":
 ## Miner control
 ---
 `pyasic` exposes a standard interface for each miner using control functions.
-Every miner class in `pyasic` must implement all the control functions defined in [`BaseMiner`][pyasic.miners.BaseMiner].
+Every miner class in `pyasic` must implement all the control functions defined in [`MinerProtocol`][pyasic.miners.base.MinerProtocol].
 
 These functions are
-[`check_light`][pyasic.miners.BaseMiner.check_light],
-[`fault_light_off`][pyasic.miners.BaseMiner.fault_light_off],
-[`fault_light_on`][pyasic.miners.BaseMiner.fault_light_on],
-[`get_config`][pyasic.miners.BaseMiner.get_config],
-[`get_data`][pyasic.miners.BaseMiner.get_data],
-[`get_errors`][pyasic.miners.BaseMiner.get_errors],
-[`get_hostname`][pyasic.miners.BaseMiner.get_hostname],
-[`get_model`][pyasic.miners.BaseMiner.get_model],
-[`reboot`][pyasic.miners.BaseMiner.reboot],
-[`restart_backend`][pyasic.miners.BaseMiner.restart_backend],
-[`stop_mining`][pyasic.miners.BaseMiner.stop_mining],
-[`resume_mining`][pyasic.miners.BaseMiner.resume_mining],
-[`is_mining`][pyasic.miners.BaseMiner.is_mining],
-[`send_config`][pyasic.miners.BaseMiner.send_config], and
-[`set_power_limit`][pyasic.miners.BaseMiner.set_power_limit].
+[`check_light`][pyasic.miners.base.MinerProtocol.check_light],
+[`fault_light_off`][pyasic.miners.base.MinerProtocol.fault_light_off],
+[`fault_light_on`][pyasic.miners.base.MinerProtocol.fault_light_on],
+[`get_config`][pyasic.miners.base.MinerProtocol.get_config],
+[`get_data`][pyasic.miners.base.MinerProtocol.get_data],
+[`get_errors`][pyasic.miners.base.MinerProtocol.get_errors],
+[`get_hostname`][pyasic.miners.base.MinerProtocol.get_hostname],
+[`get_model`][pyasic.miners.base.MinerProtocol.get_model],
+[`reboot`][pyasic.miners.base.MinerProtocol.reboot],
+[`restart_backend`][pyasic.miners.base.MinerProtocol.restart_backend],
+[`stop_mining`][pyasic.miners.base.MinerProtocol.stop_mining],
+[`resume_mining`][pyasic.miners.base.MinerProtocol.resume_mining],
+[`is_mining`][pyasic.miners.base.MinerProtocol.is_mining],
+[`send_config`][pyasic.miners.base.MinerProtocol.send_config], and
+[`set_power_limit`][pyasic.miners.base.MinerProtocol.set_power_limit].
 
 ##### Usage
 ```python
@@ -236,6 +261,7 @@ settings.update("default_antminer_password", "my_pwd")
 "factory_get_timeout": 3,
 "get_data_retries": 1,
 "api_function_timeout": 5,
+"antminer_mining_mode_as_str": False,
 "default_whatsminer_password": "admin",
 "default_innosilicon_password": "admin",
 "default_antminer_password": "root",

docs/miners/antminer/X17.md

@@ -50,49 +50,49 @@
         show_root_heading: false
         heading_level: 4
 
-## S17 (BOS)
+## S17 (BOS+)
 ::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S17+ (BOS)
+## S17+ (BOS+)
 ::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17Plus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S17 Pro (BOS)
+## S17 Pro (BOS+)
 ::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17Pro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S17e (BOS)
+## S17e (BOS+)
 ::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17e
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T17 (BOS)
+## T17 (BOS+)
 ::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T17+ (BOS)
+## T17+ (BOS+)
 ::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17Plus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T17e (BOS)
+## T17e (BOS+)
 ::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17e
     handler: python
     options:

docs/miners/antminer/X19.md

@@ -85,6 +85,34 @@
         show_root_heading: false
         heading_level: 4
 
+## S19 Hydro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19Hydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro Hydro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19ProHydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro+ Hydro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19ProPlusHydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19K Pro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19KPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
 ## T19
 ::: pyasic.miners.antminer.bmminer.X19.T19.BMMinerT19
     handler: python
@@ -92,49 +120,105 @@
         show_root_heading: false
         heading_level: 4
 
-## S19 (BOS)
+## S19
 ::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19 Pro (BOS)
+## S19+
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro
 ::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19Pro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19j (BOS)
+## S19a
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19a
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19a Pro
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19aPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j
 ::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19j
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19j No PIC (BOS)
+## S19j No PIC
 ::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jNoPIC
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19j Pro (BOS)
+## S19j Pro
 ::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jPro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19j Pro (BOS)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jPro
+## S19j Pro No PIC
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProNoPIC
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T19 (BOS)
+## S19j Pro+
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro+
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro+ No PIC
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProPlusNoPIC
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19k Pro No PIC
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19kProNoPIC
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 XP
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19XP
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T19
 ::: pyasic.miners.antminer.bosminer.X19.T19.BOSMinerT19
     handler: python
     options:
@@ -225,6 +309,20 @@
         show_root_heading: false
         heading_level: 4
 
+## S19j Pro+ (ePIC)
+::: pyasic.miners.antminer.epic.X19.S19.ePICS19jProPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19k Pro (ePIC)
+::: pyasic.miners.antminer.epic.X19.S19.ePICS19kPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
 ## S19 XP (ePIC)
 ::: pyasic.miners.antminer.epic.X19.S19.ePICS19XP
     handler: python
@@ -232,3 +330,101 @@
         show_root_heading: false
         heading_level: 4
 
+## S19 (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19jPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro+ (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19jProPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19k Pro (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19kPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 XP (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19XP
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T19 (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.T19.LUXMinerT19
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19j
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j No PIC (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19jNoPIC
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19jPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 XP (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19XP
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19K Pro (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19KPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/antminer/X21.md

@@ -0,0 +1,59 @@
+# pyasic
+## X21 Models
+
+## S21
+::: pyasic.miners.antminer.bmminer.X21.S21.BMMinerS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T21
+::: pyasic.miners.antminer.bmminer.X21.T21.BMMinerT21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S21
+::: pyasic.miners.antminer.bosminer.X21.S21.BOSMinerS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S21 (ePIC)
+::: pyasic.miners.antminer.epic.X21.S21.ePICS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T21 (ePIC)
+::: pyasic.miners.antminer.epic.X21.T21.ePICT21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S21 (LuxOS)
+::: pyasic.miners.antminer.luxos.X21.S21.LUXMinerS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S21 (MaraFW)
+::: pyasic.miners.antminer.marathon.X21.S21.MaraS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T21 (MaraFW)
+::: pyasic.miners.antminer.marathon.X21.T21.MaraT21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/antminer/X3.md

@@ -29,3 +29,10 @@
         show_root_heading: false
         heading_level: 4
 
+## L3+ (VNish)
+::: pyasic.miners.antminer.vnish.X3.L3.VnishL3Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/antminer/X7.md

@@ -8,3 +8,10 @@
         show_root_heading: false
         heading_level: 4
 
+## L7 (VNish)
+::: pyasic.miners.antminer.vnish.X7.L7.VnishL7
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/antminer/X9.md

@@ -36,14 +36,14 @@
         show_root_heading: false
         heading_level: 4
 
-## S9 (BOS)
+## S9 (BOS+)
 ::: pyasic.miners.antminer.bosminer.X9.S9.BOSMinerS9
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T9 (Hiveon)
+## T9 (Hive)
 ::: pyasic.miners.antminer.hiveon.X9.T9.HiveonT9
     handler: python
     options:

docs/miners/auradine/AD.md

@@ -0,0 +1,24 @@
+# pyasic
+## AD Models
+
+## AT1500
+::: pyasic.miners.auradine.flux.AD.AT1.AuradineFluxAT1500
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## AT2860
+::: pyasic.miners.auradine.flux.AD.AT2.AuradineFluxAT2860
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## AT2880
+::: pyasic.miners.auradine.flux.AD.AT2.AuradineFluxAT2880
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/auradine/AI.md

@@ -0,0 +1,17 @@
+# pyasic
+## AI Models
+
+## AI2500
+::: pyasic.miners.auradine.flux.AI.AI2.AuradineFluxAI2500
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## AI3680
+::: pyasic.miners.auradine.flux.AI.AI3.AuradineFluxAI3680
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/auradine/AT.md

@@ -0,0 +1,17 @@
+# pyasic
+## AT Models
+
+## AD2500
+::: pyasic.miners.auradine.flux.AT.AD2.AuradineFluxAD2500
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## AD3500
+::: pyasic.miners.auradine.flux.AT.AD3.AuradineFluxAD3500
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

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,21 +2,21 @@
 ## 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

docs/miners/goldshell/XBox.md

@@ -0,0 +1,17 @@
+# pyasic
+## XBox Models
+
+## KD Box II
+::: pyasic.miners.goldshell.bfgminer.XBox.KDBox.GoldshellKDBoxII
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## KD Box Pro
+::: pyasic.miners.goldshell.bfgminer.XBox.KDBox.GoldshellKDBoxPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/goldshell/XMax.md

@@ -2,7 +2,7 @@
 ## XMax Models
 
 ## KD Max
-::: pyasic.miners.goldshell.bfgminer.XMax.KDMax.BFGMinerKDMax
+::: pyasic.miners.goldshell.bfgminer.XMax.KDMax.GoldshellKDMax
     handler: python
     options:
         show_root_heading: false

docs/miners/innosilicon/A10X.md

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

docs/miners/innosilicon/T3X.md

@@ -2,7 +2,7 @@
 ## T3X Models
 
 ## T3H+
-::: pyasic.miners.innosilicon.cgminer.T3X.T3H.CGMinerT3HPlus
+::: pyasic.miners.innosilicon.cgminer.T3X.T3H.InnosiliconT3HPlus
     handler: python
     options:
         show_root_heading: false

docs/miners/miner_factory.md

@@ -1,15 +1,15 @@
 # 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.miners.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.
 
 The instance used for [`pyasic.get_miner()`][pyasic.get_miner] is `pyasic.miner_factory`.
 
-[`MinerFactory`][pyasic.MinerFactory] also keeps a cache, which can be cleared if needed with `pyasic.miner_factory.clear_cached_miners()`.
+[`MinerFactory`][pyasic.miners.factory.MinerFactory] also keeps a cache, which can be cleared if needed with `pyasic.miner_factory.clear_cached_miners()`.
 
 Finally, there is functionality to get multiple miners without using `asyncio.gather()` explicitly.  Use `pyasic.miner_factory.get_multiple_miners()` with a list of IPs as strings to get a list of miner instances.  You can also get multiple miners with an `AsyncGenerator` by using `pyasic.miner_factory.get_miner_generator()`.
 
-::: pyasic.miners.miner_factory.MinerFactory
+::: pyasic.miners.factory.MinerFactory
     handler: python
     options:
         show_root_heading: false
@@ -25,12 +25,12 @@ Finally, there is functionality to get multiple miners without using `asyncio.ga
 <br>
 
 ## AnyMiner
-::: pyasic.miners.miner_factory.AnyMiner
+::: pyasic.miners.base.AnyMiner
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-[`AnyMiner`][pyasic.miners.miner_factory.AnyMiner] is a placeholder type variable used for typing returns of functions.
-A function returning [`AnyMiner`][pyasic.miners.miner_factory.AnyMiner] will always return a subclass of [`BaseMiner`][pyasic.miners.BaseMiner],
+[`AnyMiner`][pyasic.miners.base.AnyMiner] is a placeholder type variable used for typing returns of functions.
+A function returning [`AnyMiner`][pyasic.miners.base.AnyMiner] will always return a subclass of [`BaseMiner`][pyasic.miners.base.BaseMiner],
 and is used to specify a function returning some arbitrary type of miner class instance.

docs/miners/supported_types.md

@@ -78,9 +78,20 @@ details {
                     <li><a href="../antminer/X19#s19-xp">S19 XP</a></li>
                     <li><a href="../antminer/X19#s19a">S19a</a></li>
                     <li><a href="../antminer/X19#s19a-pro">S19a Pro</a></li>
+                    <li><a href="../antminer/X19#s19-hydro">S19 Hydro</a></li>
+                    <li><a href="../antminer/X19#s19-pro-hydro">S19 Pro Hydro</a></li>
+                    <li><a href="../antminer/X19#s19-pro_1-hydro">S19 Pro+ Hydro</a></li>
+                    <li><a href="../antminer/X19#s19k-pro">S19K Pro</a></li>
                     <li><a href="../antminer/X19#t19">T19</a></li>
                 </ul>
         </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#s21">S21</a></li>
+                    <li><a href="../antminer/X21#t21">T21</a></li>
+                </ul>
+        </details>
     </ul>
 </details>
 <details>
@@ -286,13 +297,39 @@ details {
                     <li><a href="../whatsminer/M5X#m50s_1_1-vk30">M50S++ VK30</a></li>
                     <li><a href="../whatsminer/M5X#m53-vh30">M53 VH30</a></li>
                     <li><a href="../whatsminer/M5X#m53s-vh30">M53S VH30</a></li>
+                    <li><a href="../whatsminer/M5X#m53s-vj40">M53S VJ40</a></li>
                     <li><a href="../whatsminer/M5X#m53s_1-vj30">M53S+ VJ30</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1_1-vk10">M53S++ VK10</a></li>
                     <li><a href="../whatsminer/M5X#m56-vh30">M56 VH30</a></li>
                     <li><a href="../whatsminer/M5X#m56s-vh30">M56S VH30</a></li>
                     <li><a href="../whatsminer/M5X#m56s_1-vj30">M56S+ VJ30</a></li>
                     <li><a href="../whatsminer/M5X#m59-vh30">M59 VH30</a></li>
                 </ul>
         </details>
+        <details>
+            <summary>M6X Series:</summary>
+                <ul>
+                    <li><a href="../whatsminer/M6X#m60-vk10">M60 VK10</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vk20">M60 VK20</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vk30">M60 VK30</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vk40">M60 VK40</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vk10">M60S VK10</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vk20">M60S VK20</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vk30">M60S VK30</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vk40">M60S VK40</a></li>
+                    <li><a href="../whatsminer/M6X#m63-vk10">M63 VK10</a></li>
+                    <li><a href="../whatsminer/M6X#m63-vk20">M63 VK20</a></li>
+                    <li><a href="../whatsminer/M6X#m63-vk30">M63 VK30</a></li>
+                    <li><a href="../whatsminer/M6X#m63s-vk10">M63S VK10</a></li>
+                    <li><a href="../whatsminer/M6X#m63s-vk20">M63S VK20</a></li>
+                    <li><a href="../whatsminer/M6X#m63s-vk30">M63S VK30</a></li>
+                    <li><a href="../whatsminer/M6X#m66-vk20">M66 VK20</a></li>
+                    <li><a href="../whatsminer/M6X#m66-vk30">M66 VK30</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vk20">M66S VK20</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vk30">M66S VK30</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vk40">M66S VK40</a></li>
+                </ul>
+        </details>
     </ul>
 </details>
 <details>
@@ -376,6 +413,13 @@ details {
                     <li><a href="../goldshell/XMax#kd-max">KD Max</a></li>
                 </ul>
         </details>
+        <details>
+            <summary>XBox Series:</summary>
+                <ul>
+                    <li><a href="../goldshell/XBox#kd-box-ii">KD Box II</a></li>
+                    <li><a href="../goldshell/XBox#kd-box-pro">KD Box Pro</a></li>
+                </ul>
+        </details>
     </ul>
 </details>
 <details>
@@ -384,31 +428,45 @@ details {
         <details>
             <summary>X9 Series:</summary>
                 <ul>
-                    <li><a href="../antminer/X9#s9-bos">S9 (BOS)</a></li>
+                    <li><a href="../antminer/X9#s9-bos_1">S9 (BOS+)</a></li>
                 </ul>
         </details>
         <details>
             <summary>X17 Series:</summary>
                 <ul>
-                    <li><a href="../antminer/X17#s17-bos">S17 (BOS)</a></li>
-                    <li><a href="../antminer/X17#s17_1-bos">S17+ (BOS)</a></li>
-                    <li><a href="../antminer/X17#s17-pro-bos">S17 Pro (BOS)</a></li>
-                    <li><a href="../antminer/X17#s17e-bos">S17e (BOS)</a></li>
-                    <li><a href="../antminer/X17#t17-bos">T17 (BOS)</a></li>
-                    <li><a href="../antminer/X17#t17_1-bos">T17+ (BOS)</a></li>
-                    <li><a href="../antminer/X17#t17e-bos">T17e (BOS)</a></li>
+                    <li><a href="../antminer/X17#s17-bos_1">S17 (BOS+)</a></li>
+                    <li><a href="../antminer/X17#s17_1-bos_1">S17+ (BOS+)</a></li>
+                    <li><a href="../antminer/X17#s17-pro-bos_1">S17 Pro (BOS+)</a></li>
+                    <li><a href="../antminer/X17#s17e-bos_1">S17e (BOS+)</a></li>
+                    <li><a href="../antminer/X17#t17-bos_1">T17 (BOS+)</a></li>
+                    <li><a href="../antminer/X17#t17_1-bos_1">T17+ (BOS+)</a></li>
+                    <li><a href="../antminer/X17#t17e-bos_1">T17e (BOS+)</a></li>
                 </ul>
         </details>
         <details>
             <summary>X19 Series:</summary>
                 <ul>
-                    <li><a href="../antminer/X19#s19-bos">S19 (BOS)</a></li>
-                    <li><a href="../antminer/X19#s19-pro-bos">S19 Pro (BOS)</a></li>
-                    <li><a href="../antminer/X19#s19j-bos">S19j (BOS)</a></li>
-                    <li><a href="../antminer/X19#s19j-no-pic-bos">S19j No PIC (BOS)</a></li>
-                    <li><a href="../antminer/X19#s19j-pro-bos">S19j Pro (BOS)</a></li>
-                    <li><a href="../antminer/X19#s19j-pro-bos">S19j Pro (BOS)</a></li>
-                    <li><a href="../antminer/X19#t19-bos">T19 (BOS)</a></li>
+                    <li><a href="../antminer/X19#s19">S19</a></li>
+                    <li><a href="../antminer/X19#s19_1">S19+</a></li>
+                    <li><a href="../antminer/X19#s19-pro">S19 Pro</a></li>
+                    <li><a href="../antminer/X19#s19a">S19a</a></li>
+                    <li><a href="../antminer/X19#s19a-pro">S19a Pro</a></li>
+                    <li><a href="../antminer/X19#s19j">S19j</a></li>
+                    <li><a href="../antminer/X19#s19j-no-pic">S19j No PIC</a></li>
+                    <li><a href="../antminer/X19#s19j-pro">S19j Pro</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-no-pic">S19j Pro No PIC</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1">S19j Pro+</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1">S19j Pro+</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1-no-pic">S19j Pro+ No PIC</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-no-pic">S19k Pro No PIC</a></li>
+                    <li><a href="../antminer/X19#s19-xp">S19 XP</a></li>
+                    <li><a href="../antminer/X19#t19">T19</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#s21">S21</a></li>
                 </ul>
         </details>
     </ul>
@@ -420,6 +478,13 @@ details {
             <summary>X3 Series:</summary>
                 <ul>
                     <li><a href="../antminer/X3#l3_1-vnish">L3+ (VNish)</a></li>
+                    <li><a href="../antminer/X3#l3_1-vnish">L3+ (VNish)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X7 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X7#l7-vnish">L7 (VNish)</a></li>
                 </ul>
         </details>
         <details>
@@ -454,9 +519,25 @@ details {
                     <li><a href="../antminer/X19#s19-pro-epic">S19 Pro (ePIC)</a></li>
                     <li><a href="../antminer/X19#s19j-epic">S19j (ePIC)</a></li>
                     <li><a href="../antminer/X19#s19j-pro-epic">S19j Pro (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1-epic">S19j Pro+ (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-epic">S19k Pro (ePIC)</a></li>
                     <li><a href="../antminer/X19#s19-xp-epic">S19 XP (ePIC)</a></li>
                 </ul>
         </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#s21-epic">S21 (ePIC)</a></li>
+                    <li><a href="../antminer/X21#t21-epic">T21 (ePIC)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>blockminer Series:</summary>
+                <ul>
+                    <li><a href="../blockminer/blockminer#blockminer-520i-epic">BlockMiner 520i (ePIC)</a></li>
+                    <li><a href="../blockminer/blockminer#blockminer-720i-epic">BlockMiner 720i (ePIC)</a></li>
+                </ul>
+        </details>
     </ul>
 </details>
 <details>
@@ -465,7 +546,7 @@ details {
         <details>
             <summary>X9 Series:</summary>
                 <ul>
-                    <li><a href="../antminer/X9#t9-hiveon">T9 (Hiveon)</a></li>
+                    <li><a href="../antminer/X9#t9-hive">T9 (Hive)</a></li>
                 </ul>
         </details>
     </ul>
@@ -479,5 +560,74 @@ details {
                     <li><a href="../antminer/X9#s9-luxos">S9 (LuxOS)</a></li>
                 </ul>
         </details>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-luxos">S19 (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-luxos">S19 Pro (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-luxos">S19j Pro (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1-luxos">S19j Pro+ (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-luxos">S19k Pro (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-luxos">S19 XP (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#t19-luxos">T19 (LuxOS)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#s21-luxos">S21 (LuxOS)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware Auradine Miners:</summary>
+    <ul>
+        <details>
+            <summary>AD Series:</summary>
+                <ul>
+                    <li><a href="../auradine/AD#at1500">AT1500</a></li>
+                    <li><a href="../auradine/AD#at2860">AT2860</a></li>
+                    <li><a href="../auradine/AD#at2880">AT2880</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>AI Series:</summary>
+                <ul>
+                    <li><a href="../auradine/AI#ai2500">AI2500</a></li>
+                    <li><a href="../auradine/AI#ai3680">AI3680</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>AT Series:</summary>
+                <ul>
+                    <li><a href="../auradine/AT#ad2500">AD2500</a></li>
+                    <li><a href="../auradine/AT#ad3500">AD3500</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Mara Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-marafw">S19 (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-marafw">S19 Pro (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19j-marafw">S19j (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19j-no-pic-marafw">S19j No PIC (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-marafw">S19j Pro (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-marafw">S19 XP (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-marafw">S19K Pro (MaraFW)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#s21-marafw">S21 (MaraFW)</a></li>
+                    <li><a href="../antminer/X21#t21-marafw">T21 (MaraFW)</a></li>
+                </ul>
+        </details>
     </ul>
 </details>

docs/miners/whatsminer/M5X.md

@@ -211,6 +211,13 @@
         show_root_heading: false
         heading_level: 4
 
+## M53S VJ40
+::: pyasic.miners.whatsminer.btminer.M5X.M53S.BTMinerM53SVJ40
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
 ## M53S+ VJ30
 ::: pyasic.miners.whatsminer.btminer.M5X.M53S_Plus.BTMinerM53SPlusVJ30
     handler: python
@@ -218,6 +225,13 @@
         show_root_heading: false
         heading_level: 4
 
+## M53S++ VK10
+::: pyasic.miners.whatsminer.btminer.M5X.M53S_Plus_Plus.BTMinerM53SPlusPlusVK10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
 ## M56 VH30
 ::: pyasic.miners.whatsminer.btminer.M5X.M56.BTMinerM56VH30
     handler: python

docs/miners/whatsminer/M6X.md

@@ -0,0 +1,136 @@
+# pyasic
+## M6X Models
+
+## M60 VK10
+::: pyasic.miners.whatsminer.btminer.M6X.M60.BTMinerM60VK10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M60 VK20
+::: pyasic.miners.whatsminer.btminer.M6X.M60.BTMinerM60VK20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M60 VK30
+::: pyasic.miners.whatsminer.btminer.M6X.M60.BTMinerM60VK30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M60 VK40
+::: pyasic.miners.whatsminer.btminer.M6X.M60.BTMinerM60VK40
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M60S VK10
+::: pyasic.miners.whatsminer.btminer.M6X.M60S.BTMinerM60SVK10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M60S VK20
+::: pyasic.miners.whatsminer.btminer.M6X.M60S.BTMinerM60SVK20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M60S VK30
+::: pyasic.miners.whatsminer.btminer.M6X.M60S.BTMinerM60SVK30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M60S VK40
+::: pyasic.miners.whatsminer.btminer.M6X.M60S.BTMinerM60SVK40
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M63 VK10
+::: pyasic.miners.whatsminer.btminer.M6X.M63.BTMinerM63VK10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M63 VK20
+::: pyasic.miners.whatsminer.btminer.M6X.M63.BTMinerM63VK20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M63 VK30
+::: pyasic.miners.whatsminer.btminer.M6X.M63.BTMinerM63VK30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M63S VK10
+::: pyasic.miners.whatsminer.btminer.M6X.M63S.BTMinerM63SVK10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M63S VK20
+::: pyasic.miners.whatsminer.btminer.M6X.M63S.BTMinerM63SVK20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M63S VK30
+::: pyasic.miners.whatsminer.btminer.M6X.M63S.BTMinerM63SVK30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M66 VK20
+::: pyasic.miners.whatsminer.btminer.M6X.M66.BTMinerM66VK20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M66 VK30
+::: pyasic.miners.whatsminer.btminer.M6X.M66.BTMinerM66VK30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M66S VK20
+::: pyasic.miners.whatsminer.btminer.M6X.M66S.BTMinerM66SVK20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M66S VK30
+::: pyasic.miners.whatsminer.btminer.M6X.M66S.BTMinerM66SVK30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M66S VK40
+::: pyasic.miners.whatsminer.btminer.M6X.M66S.BTMinerM66SVK40
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

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 RPC APIs
+Each miner has a unique RPC 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.base.BaseMiner] may have an API linked to it as `Miner.rpc`.
+
+All RPC 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

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

docs/rpc/bmminer.md

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

docs/rpc/bosminer.md

@@ -0,0 +1,7 @@
+# pyasic
+## BOSMinerRPCAPI
+::: pyasic.rpc.bosminer.BOSMinerRPCAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/rpc/btminer.md

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

docs/rpc/cgminer.md

@@ -0,0 +1,7 @@
+# pyasic
+## CGMinerRPCAPI
+::: pyasic.rpc.cgminer.CGMinerRPCAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/rpc/luxminer.md

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

docs/rpc/unknown.md

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

docs/settings/settings.md

@@ -4,6 +4,7 @@
 All settings here are global settings for all of pyasic.  Set these settings with `update(key, value)`.
 
 Settings options:
+
 - `network_ping_retries`
 - `network_ping_timeout`
 - `network_scan_threads`
@@ -11,6 +12,7 @@ Settings options:
 - `factory_get_timeout`
 - `get_data_retries`
 - `api_function_timeout`
+- `antminer_mining_mode_as_str`
 - `default_whatsminer_password`
 - `default_innosilicon_password`
 - `default_antminer_password`

docs/web/antminer.md

@@ -0,0 +1,14 @@
+# pyasic
+## AntminerModernWebAPI
+::: pyasic.web.antminer.AntminerModernWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## AntminerOldWebAPI
+::: pyasic.web.antminer.AntminerOldWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/api.md

@@ -0,0 +1,27 @@
+# pyasic
+## Miner Web APIs
+Each miner has a unique Web 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.base.BaseMiner] may have an API linked to it as `Miner.web`.
+
+All API implementations inherit from [`BaseWebAPI`][pyasic.web.BaseWebAPI], which implements the basic communications protocols.
+
+[`BaseWebAPI`][pyasic.web.BaseWebAPI] should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare).
+Use these instead -
+
+#### [AntminerModerNWebAPI][pyasic.web.antminer.AntminerModernWebAPI]
+#### [AntminerOldWebAPI][pyasic.web.antminer.AntminerOldWebAPI]
+#### [AuradineWebAPI][pyasic.web.auradine.AuradineWebAPI]
+#### [ePICWebAPI][pyasic.web.epic.ePICWebAPI]
+#### [GoldshellWebAPI][pyasic.web.goldshell.GoldshellWebAPI]
+#### [InnosiliconWebAPI][pyasic.web.innosilicon.InnosiliconWebAPI]
+#### [MaraWebAPI][pyasic.web.marathon.MaraWebAPI]
+#### [VNishWebAPI][pyasic.web.vnish.VNishWebAPI]
+
+<br>
+
+## BaseWebAPI
+::: pyasic.web.BaseWebAPI
+    handler: python
+    options:
+        heading_level: 4

docs/web/auradine.md

@@ -0,0 +1,7 @@
+# pyasic
+## AuradineWebAPI
+::: pyasic.web.auradine.AuradineWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/epic.md

@@ -1,6 +1,6 @@
 # pyasic
-## BTMinerAPI
-::: pyasic.API.btminer.BTMinerAPI
+## ePICWebAPI
+::: pyasic.web.epic.ePICWebAPI
     handler: python
     options:
         show_root_heading: false

docs/web/goldshell.md

@@ -0,0 +1,7 @@
+# pyasic
+## GoldshellWebAPI
+::: pyasic.web.goldshell.GoldshellWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/innosilicon.md

@@ -0,0 +1,7 @@
+# pyasic
+## InnosiliconWebAPI
+::: pyasic.web.innosilicon.InnosiliconWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/marathon.md

@@ -1,6 +1,6 @@
 # pyasic
-## BMMinerAPI
-::: pyasic.API.bmminer.BMMinerAPI
+## MaraWebAPI
+::: pyasic.web.marathon.MaraWebAPI
     handler: python
     options:
         show_root_heading: false

docs/web/vnish.md

@@ -1,6 +1,6 @@
 # pyasic
-## CGMinerAPI
-::: pyasic.API.cgminer.CGMinerAPI
+## VNishWebAPI
+::: pyasic.web.vnish.VNishWebAPI
     handler: python
     options:
         show_root_heading: false

mkdocs.yml

@@ -13,15 +13,24 @@ nav:
     - Error Codes: "data/error_codes.md"
     - Miner Config: "config/miner_config.md"
 - Advanced:
-    - Miner APIs:
-        - Intro: "API/api.md"
-        - BFGMiner: "API/bfgminer.md"
-        - BMMiner: "API/bmminer.md"
-        - BOSMiner: "API/bosminer.md"
-        - BTMiner: "API/btminer.md"
-        - CGMiner: "API/cgminer.md"
-        - LUXMiner: "API/luxminer.md"
-        - Unknown: "API/unknown.md"
+    - RPC APIs:
+        - Intro: "rpc/api.md"
+        - BFGMiner: "rpc/bfgminer.md"
+        - BMMiner: "rpc/bmminer.md"
+        - BOSMiner: "rpc/bosminer.md"
+        - BTMiner: "rpc/btminer.md"
+        - CGMiner: "rpc/cgminer.md"
+        - LUXMiner: "rpc/luxminer.md"
+        - Unknown: "rpc/unknown.md"
+    - Web APIs:
+        - Intro: "web/api.md"
+        - Antminer: "web/antminer.md"
+        - Auradine: "web/auradine.md"
+        - ePIC: "web/epic.md"
+        - Goldshell: "web/goldshell.md"
+        - Innosilicon: "web/innosilicon.md"
+        - Marathon: "web/marathon.md"
+        - VNish: "web/vnish.md"
     - Backends:
         - BMMiner: "miners/backends/bmminer.md"
         - BOSMiner: "miners/backends/bosminer.md"
@@ -40,6 +49,7 @@ nav:
         - Antminer X15: "miners/antminer/X15.md"
         - Antminer X17: "miners/antminer/X17.md"
         - Antminer X19: "miners/antminer/X19.md"
+        - Antminer X21: "miners/antminer/X21.md"
         - Avalon 7X: "miners/avalonminer/A7X.md"
         - Avalon 8X: "miners/avalonminer/A8X.md"
         - Avalon 9X: "miners/avalonminer/A9X.md"
@@ -49,10 +59,15 @@ nav:
         - Whatsminer M2X: "miners/whatsminer/M2X.md"
         - Whatsminer M3X: "miners/whatsminer/M3X.md"
         - Whatsminer M5X: "miners/whatsminer/M5X.md"
+        - Whatsminer M6X: "miners/whatsminer/M6X.md"
         - Innosilicon T3X: "miners/innosilicon/T3X.md"
         - Innosilicon A10X: "miners/innosilicon/A10X.md"
         - Goldshell X5: "miners/goldshell/X5.md"
         - Goldshell XMax: "miners/goldshell/XMax.md"
+        - Goldshell XBox: "miners/goldshell/XBox.md"
+        - Auradine AD: "miners/auradine/AD.md"
+        - Auradine AI: "miners/auradine/AI.md"
+        - Auradine AT: "miners/auradine/AT.md"
     - Base Miner: "miners/base_miner.md"
 - Settings:
       - Settings: "settings/settings.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 (
-    BraiinsOSError,
-    InnosiliconError,
-    MinerData,
-    WhatsminerError,
-    X19Error,
-)
+from pyasic.data import MinerData
 from pyasic.errors import APIError, APIWarning
-from pyasic.miners import get_miner
-from pyasic.miners.base import AnyMiner
-from pyasic.miners.miner_factory import MinerFactory, miner_factory
-from pyasic.miners.miner_listener import MinerListener
+from pyasic.miners import *
 from pyasic.network import MinerNetwork
-
-__all__ = [
-    "BMMinerAPI",
-    "BOSMinerAPI",
-    "BTMinerAPI",
-    "CGMinerAPI",
-    "UnknownAPI",
-    "MinerConfig",
-    "MinerData",
-    "BraiinsOSError",
-    "InnosiliconError",
-    "WhatsminerError",
-    "X19Error",
-    "APIError",
-    "APIWarning",
-    "get_miner",
-    "AnyMiner",
-    "MinerFactory",
-    "miner_factory",
-    "MinerListener",
-    "MinerNetwork",
-    "settings",
-]
+from pyasic.rpc import *
+from pyasic.ssh import *
+from pyasic.web import *

pyasic/config/__init__.py

@@ -13,18 +13,20 @@
 #  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
 class MinerConfig:
+    """Represents the configuration for a miner including pool configuration, 
+    fan mode, temperature settings, mining mode, and power scaling."""
     pools: PoolConfig = field(default_factory=PoolConfig.default)
     fan_mode: FanModeConfig = field(default_factory=FanModeConfig.default)
     temperature: TemperatureConfig = field(default_factory=TemperatureConfig.default)
@@ -34,9 +36,11 @@ class MinerConfig:
     )
 
     def as_dict(self) -> dict:
+        """Converts the MinerConfig object to a dictionary."""
         return asdict(self)
 
     def as_am_modern(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the format suitable for modern Antminers."""
         return {
             **self.fan_mode.as_am_modern(),
             "freq-level": "100",
@@ -47,6 +51,7 @@ class MinerConfig:
         }
 
     def as_wm(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the format suitable for Whatsminers."""
         return {
             **self.fan_mode.as_wm(),
             **self.mining_mode.as_wm(),
@@ -56,6 +61,7 @@ class MinerConfig:
         }
 
     def as_am_old(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the format suitable for old versions of Antminers."""
         return {
             **self.fan_mode.as_am_old(),
             **self.mining_mode.as_am_old(),
@@ -65,6 +71,7 @@ class MinerConfig:
         }
 
     def as_goldshell(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the format suitable for Goldshell miners."""
         return {
             **self.fan_mode.as_goldshell(),
             **self.mining_mode.as_goldshell(),
@@ -74,6 +81,7 @@ class MinerConfig:
         }
 
     def as_avalon(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the format suitable for Avalonminers."""
         return {
             **self.fan_mode.as_avalon(),
             **self.mining_mode.as_avalon(),
@@ -83,6 +91,7 @@ class MinerConfig:
         }
 
     def as_inno(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the format suitable for Innosilicon miners."""
         return {
             **self.fan_mode.as_inno(),
             **self.mining_mode.as_inno(),
@@ -92,33 +101,46 @@ class MinerConfig:
         }
 
     def as_bosminer(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the bosminer.toml format."""
         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:
+        """"Generates the configuration in the format suitable for BOSer."""
         return {
-            **self.fan_mode.as_bos_grpc(),
-            **self.temperature.as_bos_grpc(),
-            **self.mining_mode.as_bos_grpc(),
-            **self.pools.as_bos_grpc(user_suffix=user_suffix),
-            **self.power_scaling.as_bos_grpc(),
+            **self.fan_mode.as_boser(),
+            **self.temperature.as_boser(),
+            **self.mining_mode.as_boser(),
+            **self.pools.as_boser(user_suffix=user_suffix),
+            **self.power_scaling.as_boser(),
         }
 
     def as_epic(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the format suitable for ePIC miners."""
         return {
-            **self.fan_mode.as_epic(),
-            **self.temperature.as_epic(),
+            **merge_dicts(self.fan_mode.as_epic(), self.temperature.as_epic()),
             **self.mining_mode.as_epic(),
             **self.pools.as_epic(user_suffix=user_suffix),
             **self.power_scaling.as_epic(),
         }
 
+    def as_auradine(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the format suitable for Auradine miners."""
+        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":
+        """Constructs a MinerConfig object from a dictionary."""
         return cls(
             pools=PoolConfig.from_dict(dict_conf.get("pools")),
             mining_mode=MiningModeConfig.from_dict(dict_conf.get("mining_mode")),
@@ -129,10 +151,12 @@ class MinerConfig:
 
     @classmethod
     def from_api(cls, api_pools: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from API pool data."""
         return cls(pools=PoolConfig.from_api(api_pools))
 
     @classmethod
     def from_am_modern(cls, web_conf: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from web configuration for modern Antminers."""
         return cls(
             pools=PoolConfig.from_am_modern(web_conf),
             mining_mode=MiningModeConfig.from_am_modern(web_conf),
@@ -141,18 +165,22 @@ class MinerConfig:
 
     @classmethod
     def from_am_old(cls, web_conf: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from web configuration for old versions of Antminers."""
         return cls.from_am_modern(web_conf)
 
     @classmethod
     def from_goldshell(cls, web_conf: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from web configuration for Goldshell miners."""
         return cls(pools=PoolConfig.from_am_modern(web_conf))
 
     @classmethod
     def from_inno(cls, web_pools: list) -> "MinerConfig":
+        """Constructs a MinerConfig object from web configuration for Innosilicon miners."""
         return cls(pools=PoolConfig.from_inno(web_pools))
 
     @classmethod
     def from_bosminer(cls, toml_conf: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from the bosminer.toml file, same as the `as_bosminer` dumps a dict for writing to that file as toml."""
         return cls(
             pools=PoolConfig.from_bosminer(toml_conf),
             mining_mode=MiningModeConfig.from_bosminer(toml_conf),
@@ -161,13 +189,42 @@ class MinerConfig:
             power_scaling=PowerScalingConfig.from_bosminer(toml_conf),
         )
 
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from gRPC configuration for BOSer."""
+        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:
-    result = deepcopy(a)
-    for b_key, b_val in b.items():
-        a_val = result.get(b_key)
-        if isinstance(a_val, dict) and isinstance(b_val, dict):
-            result[b_key] = merge(a_val, b_val)
-        else:
-            result[b_key] = deepcopy(b_val)
-    return result
+    @classmethod
+    def from_epic(cls, web_conf: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from web configuration for ePIC miners."""
+        return cls(
+            pools=PoolConfig.from_epic(web_conf),
+            fan_mode=FanModeConfig.from_epic(web_conf),
+            temperature=TemperatureConfig.from_epic(web_conf),
+            mining_mode=MiningModeConfig.from_epic(web_conf),
+        )
+
+    @classmethod
+    def from_vnish(cls, web_settings: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from web settings for VNish miners."""
+        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":
+        """Constructs a MinerConfig object from web configuration for Auradine miners."""
+        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:
-        return self.value.as_bos_grpc()
+    def as_boser(self) -> dict:
+        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,16 +23,53 @@ 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":
-        return cls()
+    def from_dict(cls, dict_conf: dict | None) -> "FanModeNormal":
+        cls_conf = {}
+        if dict_conf.get("minimum_fans") is not None:
+            cls_conf["minimum_fans"] = dict_conf["minimum_fans"]
+        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)
+
+    @classmethod
+    def from_bosminer(cls, toml_fan_conf: dict):
+        cls_conf = {}
+        if toml_fan_conf.get("min_fans") is not None:
+            cls_conf["minimum_fans"] = toml_fan_conf["min_fans"]
+        return cls(**cls_conf)
 
     def as_am_modern(self) -> dict:
         return {"bitmain-fan-ctrl": False, "bitmain-fan-pwn": "100"}
 
     def as_bosminer(self) -> dict:
-        return {"temp_control": {"mode": "auto"}}
+        return {
+            "temp_control": {"mode": "auto"},
+            "fan_control": {"min_fans": self.minimum_fans},
+        }
+
+    def as_epic(self) -> dict:
+        return {
+            "fans": {
+                "Auto": {
+                    "Idle Speed": (
+                        self.minimum_speed if not self.minimum_speed == 0 else 100
+                    )
+                }
+            }
+        }
 
 
 @dataclass
@@ -41,7 +79,7 @@ class FanModeManual(MinerConfigValue):
     minimum_fans: int = 1
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "FanModeManual":
+    def from_dict(cls, dict_conf: dict | None) -> "FanModeManual":
         cls_conf = {}
         if dict_conf.get("speed") is not None:
             cls_conf["speed"] = dict_conf["speed"]
@@ -58,8 +96,17 @@ 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)}
+        return {"bitmain-fan-ctrl": True, "bitmain-fan-pwm": str(self.speed)}
 
     def as_bosminer(self) -> dict:
         return {
@@ -67,20 +114,31 @@ 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:
-        return {"bitmain-fan-ctrl": True, "bitmain-fan-pwn": "0"}
+        return {"bitmain-fan-ctrl": True, "bitmain-fan-pwm": "0"}
 
     def as_bosminer(self) -> dict:
-        return {"temp_control": {"mode": "disabled"}}
+        return {
+            "fan_control": {"min_fans": 0},
+        }
+
+    def as_auradine(self) -> dict:
+        return {"fan": {"percentage": 0}}
 
 
 class FanModeConfig(MinerConfigOption):
@@ -93,7 +151,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,34 +159,100 @@ class FanModeConfig(MinerConfigOption):
         if mode is None:
             return cls.default()
 
-        clsattr = getattr(cls, mode)
-        if clsattr is not None:
-            return clsattr().from_dict(dict_conf)
+        cls_attr = getattr(cls, mode)
+        if cls_attr is not None:
+            return cls_attr().from_dict(dict_conf)
 
     @classmethod
     def from_am_modern(cls, web_conf: dict):
         if web_conf.get("bitmain-fan-ctrl") is not None:
             fan_manual = web_conf["bitmain-fan-ctrl"]
             if fan_manual:
-                return cls.manual(speed=web_conf["bitmain-fan-pwm"])
+                speed = int(web_conf["bitmain-fan-pwm"])
+                if speed == 0:
+                    return cls.immersion()
+                return cls.manual(speed=speed)
             else:
                 return cls.normal()
         else:
             return cls.default()
 
     @classmethod
-    def from_bosminer(cls, toml_conf: dict):
-        if toml_conf.get("temp_control") is None:
-            return cls.default()
-        if toml_conf["temp_control"].get("mode") is None:
+    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()
 
-        mode = toml_conf["temp_control"]["mode"]
-        if mode == "auto":
-            return cls.normal()
-        elif mode == "manual":
-            if toml_conf.get("fan_control"):
-                return cls.manual().from_bosminer(toml_conf["fan_control"])
-            return cls.manual()
-        elif mode == "disabled":
+    @classmethod
+    def from_bosminer(cls, toml_conf: dict):
+        try:
+            mode = toml_conf["temp_control"]["mode"]
+            fan_config = toml_conf.get("fan_control", {})
+            if mode == "auto":
+                return cls.normal().from_bosminer(fan_config)
+            elif mode == "manual":
+                if toml_conf.get("fan_control"):
+                    return cls.manual().from_bosminer(fan_config)
+                return cls.manual()
+            elif mode == "disabled":
+                return cls.immersion()
+        except KeyError:
+            pass
+
+        try:
+            min_fans = toml_conf["fan_control"]["min_fans"]
+        except KeyError:
+            return cls.default()
+
+        if min_fans == 0:
             return cls.immersion()
+        return cls.normal(minimum_fans=min_fans)
+
+    @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,22 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-from dataclasses import dataclass, field
-from typing import Union
+from __future__ import annotations
 
+from dataclasses import dataclass, field
+
+from pyasic import settings
 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,72 +36,160 @@ 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:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
 
     def as_wm(self) -> dict:
         return {"mode": self.mode}
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": self.mode}}
+
+    def as_epic(self) -> dict:
+        return {"ptune": {"enabled": False}}
+
+    def as_goldshell(self) -> dict:
+        return {"settings": {"level": 0}}
+
 
 @dataclass
 class MiningModeSleep(MinerConfigValue):
     mode: str = field(init=False, default="sleep")
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeSleep":
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeSleep":
         return cls()
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "1"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "1"}
+        return {"miner-mode": 1}
 
     def as_wm(self) -> dict:
         return {"mode": self.mode}
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"sleep": "on"}}
+
+    def as_epic(self) -> dict:
+        return {"ptune": {"algo": "Sleep", "target": 0}}
+
+    def as_goldshell(self) -> dict:
+        return {"settings": {"level": 3}}
+
 
 @dataclass
 class MiningModeLPM(MinerConfigValue):
     mode: str = field(init=False, default="low")
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeLPM":
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeLPM":
         return cls()
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "3"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "3"}
+        return {"miner-mode": 3}
 
     def as_wm(self) -> dict:
         return {"mode": self.mode}
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": "eco"}}
+
+    def as_goldshell(self) -> dict:
+        return {"settings": {"level": 1}}
+
 
 @dataclass
 class MiningModeHPM(MinerConfigValue):
     mode: str = field(init=False, default="high")
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeHPM":
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeHPM":
         return cls()
 
-    def as_am_modern(self):
-        return {"miner-mode": "0"}
+    def as_am_modern(self) -> dict:
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
 
     def as_wm(self) -> dict:
         return {"mode": self.mode}
 
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": "turbo"}}
+
+
+@dataclass
+class StandardTuneAlgo(MinerConfigValue):
+    mode: str = field(init=False, default="standard")
+
+    def as_epic(self) -> str:
+        return VOptAlgo().as_epic()
+
+
+@dataclass
+class VOptAlgo(MinerConfigValue):
+    mode: str = field(init=False, default="voltage_optimizer")
+
+    def as_epic(self) -> str:
+        return "VoltageOptimizer"
+
+
+class ChipTuneAlgo(MinerConfigValue):
+    mode: str = field(init=False, default="chip_tune")
+
+    def as_epic(self) -> str:
+        return "ChipTune"
+
+
+@dataclass
+class TunerAlgo(MinerConfigOption):
+    standard = StandardTuneAlgo
+    voltage_optimizer = VOptAlgo
+    chip_tune = ChipTuneAlgo
+
+    @classmethod
+    def default(cls):
+        return cls.standard()
+
+    @classmethod
+    def from_dict(cls, dict_conf: dict | None):
+        mode = dict_conf.get("mode")
+        if mode is None:
+            return cls.default()
+
+        cls_attr = getattr(cls, mode)
+        if cls_attr is not None:
+            return cls_attr().from_dict(dict_conf)
+
 
 @dataclass
 class MiningModePowerTune(MinerConfigValue):
     mode: str = field(init=False, default="power_tuning")
     power: int = None
+    algo: TunerAlgo = field(default_factory=TunerAlgo.default)
 
     @classmethod
-    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModePowerTune":
-        return cls(dict_conf.get("power"))
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModePowerTune":
+        cls_conf = {}
+        if dict_conf.get("power"):
+            cls_conf["power"] = dict_conf["power"]
+        if dict_conf.get("algo"):
+            cls_conf["algo"] = TunerAlgo.from_dict(dict_conf["algo"])
+
+        return cls(**cls_conf)
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
 
     def as_wm(self) -> dict:
         if self.power is not None:
@@ -97,20 +197,77 @@ class MiningModePowerTune(MinerConfigValue):
         return {}
 
     def as_bosminer(self) -> dict:
-        return {"autotuning": {"enabled": True, "psu_power_limit": self.power}}
+        conf = {"enabled": True, "mode": "power_target"}
+        if self.power is not None:
+            conf["power_target"] = self.power
+        return {"autotuning": conf}
+
+    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":
-        return cls(dict_conf.get("hashrate"))
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeHashrateTune":
+        cls_conf = {}
+        if dict_conf.get("hashrate"):
+            cls_conf["hashrate"] = dict_conf["hashrate"]
+        if dict_conf.get("algo"):
+            cls_conf["algo"] = TunerAlgo.from_dict(dict_conf["algo"])
+
+        return cls(**cls_conf)
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
+
+    def as_bosminer(self) -> dict:
+        conf = {"enabled": True, "mode": "hashrate_target"}
+        if self.hashrate is not None:
+            conf["hashrate_target"] = self.hashrate
+        return {"autotuning": conf}
+
+    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
@@ -119,11 +276,13 @@ 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:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
 
 
 @dataclass
@@ -135,7 +294,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"],
@@ -143,7 +302,23 @@ class MiningModeManual(MinerConfigValue):
         )
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        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):
@@ -160,7 +335,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 +343,9 @@ class MiningModeConfig(MinerConfigOption):
         if mode is None:
             return cls.default()
 
-        clsattr = getattr(cls, mode)
-        if clsattr is not None:
-            return clsattr().from_dict(dict_conf)
+        cls_attr = getattr(cls, mode)
+        if cls_attr is not None:
+            return cls_attr().from_dict(dict_conf)
 
     @classmethod
     def from_am_modern(cls, web_conf: dict):
@@ -186,6 +361,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 +407,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,43 @@ 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 +398,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 +462,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:
-        cfg = {"enable_shutdown ": True}
-
-        if self.duration is not None:
-            cfg["shutdown_duration"] = Hours(self.duration)
-
-        return cfg
+    def as_boser(self) -> dict:
+        return {"enable_shutdown": True, "shutdown_duration": self.duration}
 
 
 @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,20 +89,33 @@ 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[
-        PowerScalingShutdownEnabled, PowerScalingShutdownDisabled
-    ] = None
+    shutdown_enabled: PowerScalingShutdownEnabled | PowerScalingShutdownDisabled = None
 
     @classmethod
     def from_bosminer(cls, power_scaling_conf: dict) -> "PowerScalingEnabled":
         power_step = power_scaling_conf.get("power_step")
         min_power = power_scaling_conf.get("min_psu_power_limit")
+        if min_power is None:
+            min_power = power_scaling_conf.get("min_power_target")
         sd_mode = PowerScalingShutdown.from_bosminer(power_scaling_conf)
 
         return cls(
@@ -109,7 +123,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"),
@@ -126,27 +140,26 @@ class PowerScalingEnabled(MinerConfigValue):
         if self.power_step is not None:
             cfg["power_step"] = self.power_step
         if self.minimum_power is not None:
-            cfg["min_psu_power_limit"] = self.minimum_power
+            cfg["min_power_target"] = self.minimum_power
 
         if self.shutdown_enabled is not None:
             cfg = {**cfg, **self.shutdown_enabled.as_bosminer()}
 
-        return {"power_scaling": cfg}
+        return {"performance_scaling": cfg}
 
-    def as_bos_grpc(self) -> dict:
-        cfg = {"enable": True}
-        target_conf = {}
-        if self.power_step is not None:
-            target_conf["power_step"] = self.power_step
-        if self.minimum_power is not None:
-            target_conf["min_power_target"] = self.minimum_power
-
-        cfg["target"] = DpsTarget(power_target=DpsPowerTarget(**target_conf))
-
-        if self.shutdown_enabled is not None:
-            cfg = {**cfg, **self.shutdown_enabled.as_bos_grpc()}
-
-        return {"dps": cfg}
+    def as_boser(self) -> dict:
+        return {
+            "set_dps": SetDpsRequest(
+                enable=True,
+                **self.shutdown_enabled.as_boser(),
+                target=DpsTarget(
+                    power_target=DpsPowerTarget(
+                        power_step=Power(self.power_step),
+                        min_power_target=Power(self.minimum_power),
+                    )
+                ),
+            ),
+        }
 
 
 @dataclass
@@ -163,7 +176,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()
 
@@ -178,6 +191,8 @@ class PowerScalingConfig(MinerConfigOption):
     @classmethod
     def from_bosminer(cls, toml_conf: dict):
         power_scaling = toml_conf.get("power_scaling")
+        if power_scaling is None:
+            power_scaling = toml_conf.get("performance_scaling")
         if power_scaling is not None:
             enabled = power_scaling.get("enabled")
             if enabled is not None:
@@ -187,3 +202,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,7 +16,6 @@
 
 import copy
 import json
-import logging
 import time
 from dataclasses import asdict, dataclass, field, fields
 from datetime import datetime, timezone
@@ -25,71 +24,9 @@ from typing import Any, List, Union
 from pyasic.config import MinerConfig
 from pyasic.config.mining import MiningModePowerTune
 
+from .boards import HashBoard
 from .error_codes import BraiinsOSError, InnosiliconError, WhatsminerError, X19Error
-
-
-@dataclass
-class HashBoard:
-    """A Dataclass to standardize hashboard data.
-
-    Attributes:
-        slot: The slot of the board as an int.
-        hashrate: The hashrate of the board in TH/s as a float.
-        temp: The temperature of the PCB as an int.
-        chip_temp: The temperature of the chips as an int.
-        chips: The chip count of the board as an int.
-        expected_chips: The expected chip count of the board as an int.
-        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}")
+from .fans import Fan
 
 
 @dataclass
@@ -109,7 +46,7 @@ class MinerData:
         hashrate: The hashrate of the miner in TH/s as a float.  Calculated automatically.
         _hashrate: Backup for hashrate found via API instead of hashboards.
         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.
@@ -122,11 +59,7 @@ class MinerData:
         percent_expected_hashrate: The percent of total hashrate out of the expected hashrate.  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.
-        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.
+        config: The parsed config of the miner, using [`MinerConfig`][pyasic.config.MinerConfig].
         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.
@@ -162,7 +95,12 @@ class MinerData:
     nominal: bool = field(init=False)
     config: MinerConfig = None
     errors: List[
-        Union[WhatsminerError, BraiinsOSError, X19Error, InnosiliconError]
+        Union[
+            WhatsminerError,
+            BraiinsOSError,
+            X19Error,
+            InnosiliconError,
+        ]
     ] = field(default_factory=list)
     fault_light: Union[bool, None] = None
     efficiency: int = field(init=False)
@@ -353,7 +291,6 @@ class MinerData:
         pass
 
     def asdict(self) -> dict:
-        logging.debug(f"MinerData - (To Dict) - Dumping Dict data")
         return asdict(self, dict_factory=self.dict_factory)
 
     def as_dict(self) -> dict:
@@ -370,7 +307,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)
@@ -381,7 +317,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 = []
@@ -400,7 +335,6 @@ class MinerData:
         Returns:
             A influxdb line protocol version of this class.
         """
-        logging.debug(f"MinerData - (To InfluxDB) - Dumping InfluxDB data")
         tag_data = [measurement_name]
         field_data = []
 

pyasic/data/boards.py

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

pyasic/data/fans.py

@@ -14,24 +14,31 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-import warnings
-
-from pyasic.miners.makes import WhatsMiner
+from dataclasses import dataclass
+from typing import Any
 
 
-class M31V10(WhatsMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.ip = ip
-        self.model = "M31 V10"
-        self.expected_chips = 70
-        self.fan_count = 2
+@dataclass
+class Fan:
+    """A Dataclass to standardize fan data.
 
+    Attributes:
+        speed: The speed of the fan.
+    """
 
-class M31V20(WhatsMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str, api_ver: str = "0.0.0"):
-        super().__init__(ip, api_ver)
-        self.ip = ip
-        self.model = "M31 V20"
-        self.nominal_chips = 74
-        self.fan_count = 2
+    speed: int = None
+
+    def get(self, __key: str, default: Any = None):
+        try:
+            val = self.__getitem__(__key)
+            if val is None:
+                return default
+            return val
+        except KeyError:
+            return default
+
+    def __getitem__(self, item: str):
+        try:
+            return getattr(self, item)
+        except AttributeError:
+            raise KeyError(f"{item}")

pyasic/load/__init__.py

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

pyasic/miners/__init__.py

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

pyasic/miners/antminer/__init__.py

@@ -20,4 +20,5 @@ from .cgminer import *
 from .epic import *
 from .hiveon import *
 from .luxos import *
+from .marathon import *
 from .vnish 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,19 +15,23 @@
 # ------------------------------------------------------------------------------
 
 from pyasic.miners.backends import AntminerModern
-from pyasic.miners.types import (
+from pyasic.miners.models import (
     S19,
     S19L,
     S19XP,
     S19a,
     S19aPro,
+    S19Hydro,
     S19i,
     S19j,
     S19jNoPIC,
     S19jPro,
     S19Plus,
     S19Pro,
+    S19ProHydro,
     S19ProPlus,
+    S19ProPlusHydro,
+    S19KPro,
 )
 
 
@@ -77,3 +81,19 @@ class BMMinerS19jPro(AntminerModern, S19jPro):
 
 class BMMinerS19L(AntminerModern, S19L):
     pass
+
+
+class BMMinerS19ProHydro(AntminerModern, S19ProHydro):
+    pass
+
+
+class BMMinerS19Hydro(AntminerModern, S19Hydro):
+    pass
+
+
+class BMMinerS19ProPlusHydro(AntminerModern, S19ProPlusHydro):
+    pass
+
+
+class BMMinerS19KPro(AntminerModern, S19KPro):
+    pass

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

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

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

@@ -18,6 +18,7 @@ from .S19 import (
     BMMinerS19,
     BMMinerS19a,
     BMMinerS19aPro,
+    BMMinerS19Hydro,
     BMMinerS19i,
     BMMinerS19j,
     BMMinerS19jNoPIC,
@@ -25,7 +26,10 @@ from .S19 import (
     BMMinerS19L,
     BMMinerS19Plus,
     BMMinerS19Pro,
+    BMMinerS19ProHydro,
     BMMinerS19ProPlus,
+    BMMinerS19ProPlusHydro,
     BMMinerS19XP,
+    BMMinerS19KPro,
 )
 from .T19 import BMMinerT19

pyasic/miners/antminer/bmminer/X21/S21.py

@@ -0,0 +1,22 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import AntminerModern
+from pyasic.miners.models import S21
+
+
+class BMMinerS21(AntminerModern, S21):
+    pass

pyasic/miners/antminer/bmminer/X21/T21.py

@@ -0,0 +1,22 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import AntminerModern
+from pyasic.miners.models import T21
+
+
+class BMMinerT21(AntminerModern, T21):
+    pass

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

@@ -0,0 +1,17 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+from .S21 import BMMinerS21
+from .T21 import BMMinerT21

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

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

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

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

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

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

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

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

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

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

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

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

pyasic/miners/antminer/bmminer/__init__.py

@@ -18,3 +18,4 @@ from .X7 import *
 from .X9 import *
 from .X17 import *
 from .X19 import *
+from .X21 import *

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,8 +14,8 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.backends import BOSMiner
-from pyasic.miners.types import (
+from pyasic.miners.backends import BOSer
+from pyasic.miners.models import (
     S19,
     S19XP,
     S19a,
@@ -23,52 +23,62 @@ from pyasic.miners.types import (
     S19j,
     S19jNoPIC,
     S19jPro,
+    S19jProNoPIC,
     S19jProPlus,
+    S19jProPlusNoPIC,
     S19kProNoPIC,
     S19Plus,
     S19Pro,
 )
 
 
-class BOSMinerS19(BOSMiner, S19):
+class BOSMinerS19(BOSer, S19):
     pass
 
 
-class BOSMinerS19Plus(BOSMiner, S19Plus):
+class BOSMinerS19Plus(BOSer, S19Plus):
     pass
 
 
-class BOSMinerS19Pro(BOSMiner, S19Pro):
+class BOSMinerS19Pro(BOSer, S19Pro):
     pass
 
 
-class BOSMinerS19a(BOSMiner, S19a):
+class BOSMinerS19a(BOSer, S19a):
     pass
 
 
-class BOSMinerS19j(BOSMiner, S19j):
+class BOSMinerS19j(BOSer, S19j):
     pass
 
 
-class BOSMinerS19jNoPIC(BOSMiner, S19jNoPIC):
+class BOSMinerS19jNoPIC(BOSer, S19jNoPIC):
     pass
 
 
-class BOSMinerS19jPro(BOSMiner, S19jPro):
+class BOSMinerS19jPro(BOSer, S19jPro):
     pass
 
 
-class BOSMinerS19kProNoPIC(BOSMiner, S19kProNoPIC):
+class BOSMinerS19jProNoPIC(BOSer, S19jProNoPIC):
     pass
 
 
-class BOSMinerS19aPro(BOSMiner, S19aPro):
+class BOSMinerS19kProNoPIC(BOSer, S19kProNoPIC):
     pass
 
 
-class BOSMinerS19jProPlus(BOSMiner, S19jProPlus):
+class BOSMinerS19aPro(BOSer, S19aPro):
     pass
 
 
-class BOSMinerS19XP(BOSMiner, S19XP):
+class BOSMinerS19jProPlus(BOSer, S19jProPlus):
+    pass
+
+
+class BOSMinerS19jProPlusNoPIC(BOSer, S19jProPlusNoPIC):
+    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.types import T19
+from pyasic.miners.backends import BOSer
+from pyasic.miners.models import T19
 
 
-class BOSMinerT19(BOSMiner, T19):
+class BOSMinerT19(BOSer, T19):
     pass

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

@@ -21,7 +21,9 @@ from .S19 import (
     BOSMinerS19j,
     BOSMinerS19jNoPIC,
     BOSMinerS19jPro,
+    BOSMinerS19jProNoPIC,
     BOSMinerS19jProPlus,
+    BOSMinerS19jProPlusNoPIC,
     BOSMinerS19kProNoPIC,
     BOSMinerS19Plus,
     BOSMinerS19Pro,

pyasic/miners/antminer/bosminer/X21/S21.py

@@ -0,0 +1,22 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import BOSer
+from pyasic.miners.models import S21
+
+
+class BOSMinerS21(BOSer, S21):
+    pass

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

@@ -0,0 +1,17 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from .S21 import BOSMinerS21

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/bosminer/__init__.py

@@ -17,3 +17,4 @@
 from .X9 import *
 from .X17 import *
 from .X19 import *
+from .X21 import *

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

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

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

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

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

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

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

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

pyasic/miners/antminer/epic/X21/S21.py

@@ -0,0 +1,22 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import ePIC
+from pyasic.miners.models import S21
+
+
+class ePICS21(ePIC, S21):
+    pass

pyasic/miners/antminer/epic/X21/T21.py

@@ -0,0 +1,22 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import ePIC
+from pyasic.miners.models import T21
+
+
+class ePICT21(ePIC, T21):
+    pass

pyasic/miners/antminer/epic/X21/__init__.py

@@ -0,0 +1,23 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from .S21 import (
+    ePICS21,
+)
+
+from .T21 import (
+    ePICT21,
+)

pyasic/miners/antminer/epic/__init__.py

@@ -15,3 +15,4 @@
 # ------------------------------------------------------------------------------
 
 from .X19 import *
+from .X21 import *

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:
-        super().__init__(ip, api_ver=api_ver)
-        self.ip = ip
-        self.pwd = "admin"
+    data_locations = HIVEON_T9_DATA_LOC
 
     ##################################################
     ### 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.expected_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}"]
-                        hashboard.chip_temp = api_stats["STATS"][1][f"temp2_{chipset}"]
+                        hashboards[board].temp = rpc_stats["STATS"][1][f"temp{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}"]
-                    chips += api_stats["STATS"][1][f"chain_acn{chipset}"]
+                    hashrate += rpc_stats["STATS"][1][f"chain_rate{chipset}"]
+                    chips += rpc_stats["STATS"][1][f"chain_acn{chipset}"]
                 except (KeyError, IndexError):
                     pass
-            hashboard.hashrate = round(hashrate / 1000, 2)
-            hashboard.chips = chips
-            hashboards.append(hashboard)
+            hashboards[board].hashrate = round(hashrate / 1000, 2)
+            hashboards[board].chips = chips
 
         return hashboards
 
-    async def get_wattage(self, api_stats: dict = None) -> Optional[int]:
-        if not api_stats:
+    async def _get_wattage(self, rpc_stats: dict = None) -> Optional[int]:
+        if not rpc_stats:
             try:
-                api_stats = await self.api.stats()
+                rpc_stats = await self.rpc.stats()
             except APIError:
                 pass
 
-        if api_stats:
-            boards = api_stats.get("STATS")
+        if rpc_stats:
+            boards = rpc_stats.get("STATS")
             try:
                 wattage_raw = boards[1]["chain_power"]
             except (KeyError, IndexError):
@@ -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/X19/S19.py

@@ -0,0 +1,42 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import LUXMiner
+from pyasic.miners.models import S19, S19XP, S19jPro, S19jProPlus, S19kPro, S19Pro
+
+
+class LUXMinerS19(LUXMiner, S19):
+    pass
+
+
+class LUXMinerS19Pro(LUXMiner, S19Pro):
+    pass
+
+
+class LUXMinerS19jPro(LUXMiner, S19jPro):
+    pass
+
+
+class LUXMinerS19jProPlus(LUXMiner, S19jProPlus):
+    pass
+
+
+class LUXMinerS19kPro(LUXMiner, S19kPro):
+    pass
+
+
+class LUXMinerS19XP(LUXMiner, S19XP):
+    pass

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

@@ -0,0 +1,22 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import LUXMiner
+from pyasic.miners.models import T19
+
+
+class LUXMinerT19(LUXMiner, T19):
+    pass

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

@@ -0,0 +1,25 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from .S19 import (
+    LUXMinerS19,
+    LUXMinerS19jPro,
+    LUXMinerS19jProPlus,
+    LUXMinerS19kPro,
+    LUXMinerS19Pro,
+    LUXMinerS19XP,
+)
+from .T19 import LUXMinerT19

pyasic/miners/antminer/luxos/X21/S21.py

@@ -0,0 +1,22 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import LUXMiner
+from pyasic.miners.models import S21
+
+
+class LUXMinerS21(LUXMiner, S21):
+    pass

pyasic/miners/antminer/luxos/X21/__init__.py

@@ -0,0 +1,17 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from .S21 import LUXMinerS21