improve how the fault light looks on whatsminers

.coveragerc

@@ -1,17 +0,0 @@
-[report]
-exclude_lines =
-    # Skip @abstractmethod
-    @abstractmethod
-    @abc.abstractmethod
-
-    # Don't complain if tests don't hit defensive assertion code:
-    raise AssertionError
-    raise NotImplementedError
-
-    # Don't complain about missing debug-only code:
-    def __repr__
-    if self\.debug
-
-    # Don't complain if non-runnable code isn't run:
-    if 0:
-    if __name__ == .__main__.:

.gitignore

@@ -6,4 +6,3 @@ pyvenv.cfg
 .env/
 bin/
 lib/
-.idea/

.pre-commit-config.yaml

@@ -1,29 +1,15 @@
-ci:
-  skip:
-    - unittest
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v4.3.0
     hooks:
     -   id: trailing-whitespace
+    -   id: end-of-file-fixer
     -   id: check-yaml
-        name: check-yaml for mkdocs.yml
-        files: ^mkdocs\.yml$
-        args: [--unsafe]
-    -   id: check-yaml
-        name: check-yaml for other YAML files
-        exclude: ^mkdocs\.yml$
     -   id: check-added-large-files
 -   repo: https://github.com/psf/black
-    rev: 24.10.0
+    rev: 22.6.0
     hooks:
     -   id: black
--   repo: https://github.com/pycqa/isort
-    rev: 5.13.2
-    hooks:
-    -   id: isort
-        name: isort (python)
-
 -   repo: local
     hooks:
     -   id: unittest
@@ -33,3 +19,4 @@ repos:
         'types': [python]
         args: ["-p '*test.py'"] # Probably this option is absolutely not needed.
         pass_filenames: false
+        stages: [commit]

.readthedocs.yaml

@@ -1,18 +1,20 @@
 # .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
 version: 2
 
 # Set the version of Python and other tools you might need
 build:
   os: ubuntu-20.04
-  tools: { python: "3.11" }
-  jobs:
-    pre_create_environment:
-      - asdf plugin add poetry
-      - asdf install poetry latest
-      - asdf global poetry latest
-      - poetry config virtualenvs.create false
-    post_install:
-      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --only docs
+  tools:
+    python: "3.9"
 
 mkdocs:
-  configuration: mkdocs.yml
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt

README.md

@@ -1,286 +1,173 @@
 # pyasic
-*A simplified and standardized interface for Bitcoin ASICs.*
+*A set of modules for interfacing with many common types of ASIC bitcoin miners, using both their API and SSH.*
 
-[![PyPI - Version](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyasic)](https://pypi.org/project/pyasic/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![pypi](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![python](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![Read the Docs](https://img.shields.io/readthedocs/pyasic)](https://pyasic.readthedocs.io/en/latest/)
+[![GitHub](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
+[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)
+## Documentation
+Documentation is located on Read the Docs as [pyasic](https://pyasic.readthedocs.io/en/latest/)
 
-[![Python - Supported Versions](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
-[![CodeFactor - Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)
-[![Commit Activity - master](https://img.shields.io/github/commit-activity/y/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/commits/master/)
+## Usage
 
-[![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://docs.pyasic.org)
-[![License - Apache 2.0](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
+### Standard Usage
+You can install pyasic directly from pip with the command `pip install pyasic`
 
----
-## Intro
+For those of you who aren't comfortable with code and developer tools, there are windows builds of GUI applications that use this library here -> (https://drive.google.com/drive/folders/1DjR8UOS_g0ehfiJcgmrV0FFoqFvE9akW?usp=sharing)
 
-Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with ASIC miners on your network, which makes it super fast.
+### Developers
+To use this repo, first download it, create a virtual environment, enter the virtual environment, and install relevant packages by navigating to this directory and running ```pip install -r requirements-dev.txt``` on Windows or ```pip3 install -r requirements-dev.txt``` on Mac or UNIX if the first command fails.
 
-[Click here to view supported miner types](https://docs.pyasic.org/en/latest/miners/supported_types/)
+You can also use poetry by initializing and running ```poetry install```, and you will have to install `pre-commit` (`pip install pre-commit`).
 
----
-## Installation
+Finally, initialize pre-commit hooks with `pre-commit install`
 
-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
+### Interfacing with miners programmatically
 
-```
-    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 pyasic` or `poetry install`
-
-##### Additional Developer Setup
-```
-poetry install --with dev
-pre-commit install
-```
-
----
-## Getting started
-
-Getting started with `pyasic` is easy.  First, find your miner (or miners) on the network by scanning for them or getting the correct class automatically for them if you know the IP.
-
-##### Scanning for miners
-To scan for miners in `pyasic`, we use the class `MinerNetwork`, which abstracts the search, communication, identification, setup, and return of a miner to 1 command.
-The command `MinerNetwork.scan()` returns a list that contains any miners found.
+##### Note: If you are trying to interface with Whatsminers, there is a bug in the way they are interacted with on Windows, so to fix that you need to change the event loop policy using this code:
 ```python
-import asyncio  # asyncio for handling the async part
-from pyasic.network import MinerNetwork  # miner network handles the scanning
+# need to import these 2 libraries, you need asyncio anyway so make sure you have sys imported
+import sys
+import asyncio
 
-
-async def scan_miners():  # define async scan function to allow awaiting
-    # create a miner network
-    # you can pass in any IP and it will use that in a subnet with a /24 mask (255 IPs).
-    network = MinerNetwork.from_subnet("192.168.1.50/24")  # this uses the 192.168.1.0-255 network
-
-    # scan for miners asynchronously
-    # this will return the correct type of miners if they are supported with all functionality.
-    miners = await network.scan()
-    print(miners)
-
-if __name__ == "__main__":
-    asyncio.run(scan_miners())  # run the scan asynchronously with asyncio.run()
+# if the computer is windows, set the event loop policy to a WindowsSelector policy
+if sys.version_info[0] == 3 and sys.version_info[1] >= 8 and sys.platform.startswith('win'):
+    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
 ```
 
----
-##### Creating miners based on IP
-If you already know the IP address of your miner or miners, you can use the `MinerFactory` to communicate and identify the miners, or an abstraction of its functionality, `get_miner()`.
-The function `get_miner()` will return any miner it found at the IP address specified, or an `UnknownMiner` if it cannot identify the miner.
-```python
-import asyncio  # asyncio for handling the async part
-from pyasic import get_miner # handles miner creation
+##### It is likely a good idea to use this code in your program anyway to be preventative.
+<br>
 
+To write your own custom programs with this repo, you have many options.
 
-async def get_miners():  # define async scan function to allow awaiting
-    # get the miner with the miner factory
-    # the miner factory is a singleton, and will always use the same object and cache
-    # this means you can always call it as MinerFactory().get_miner(), or just get_miner()
-    miner_1 = await get_miner("192.168.1.75")
-    miner_2 = await get_miner("192.168.1.76")
-    print(miner_1, miner_2)
+It is recommended that you explore the files in this repo to familiarize yourself with them, try starting with the miners module and going from there.
 
-    # can also gather these, since they are async
-    # gathering them will get them both at the same time
-    # this makes it much faster to get a lot of miners at a time
-    tasks = [get_miner("192.168.1.75"), get_miner("192.168.1.76")]
-    miners = await asyncio.gather(*tasks)
-    print(miners)
+There are 2 main ways to get a miner and it's functions via scanning or via the MinerFactory.
 
-
-if __name__ == "__main__":
-    asyncio.run(get_miners())  # get the miners asynchronously with asyncio.run()
-```
-
----
-## Data gathering
-
-Once you have your miner(s) identified, you will likely want to get data from the miner(s).  You can do this using a built-in function in each miner called `get_data()`.
-This function will return an instance of the dataclass `MinerData` with all data it can gather from the miner.
-Each piece of data in a `MinerData` instance can be referenced by getting it as an attribute, such as `MinerData().hashrate`.
-
-##### One miner
+#### Scanning for miners
 ```python
 import asyncio
-from pyasic import get_miner
+import sys
 
-async def gather_miner_data():
-    miner = await get_miner("192.168.1.75")
-    if miner is not None:
-        miner_data = await miner.get_data()
-        print(miner_data)  # all data from the dataclass
-        print(miner_data.hashrate)  # hashrate of the miner in TH/s
+from pyasic.network import MinerNetwork
+
+# Fix whatsminer bug
+# if the computer is windows, set the event loop policy to a WindowsSelector policy
+if sys.version_info[0] == 3 and sys.version_info[1] >= 8 and sys.platform.startswith('win'):
+    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
+
+
+# define asynchronous function to scan for miners
+async def scan_and_get_data():
+    # Define network range to be used for scanning
+    # This can take a list of IPs, a constructor string, or an IP and subnet mask
+    # The standard mask is /24, and you can pass any IP address in the subnet
+    net = MinerNetwork("192.168.1.69", mask=24)
+    # Scan the network for miners
+    # This function returns a list of miners of the correct type as a class
+    miners: list = await net.scan_network_for_miners()
+
+    # We can now get data from any of these miners
+    # To do them all we have to create a list of tasks and gather them
+    tasks = [miner.get_data() for miner in miners]
+    # Gather all tasks asynchronously and run them
+    data = await asyncio.gather(*tasks)
+
+    # Data is now a list of MinerData, and we can reference any part of that
+    # Print out all data for now
+    for item in data:
+        print(item)
 
 if __name__ == "__main__":
-    asyncio.run(gather_miner_data())
-```
----
-##### Multiple miners
-You can do something similar with multiple miners, with only needing to make a small change to get all the data at once.
-```python
-import asyncio  # asyncio for handling the async part
-from pyasic.network import MinerNetwork  # miner network handles the scanning
-
-
-async def gather_miner_data():  # define async scan function to allow awaiting
-    network = MinerNetwork.from_subnet("192.168.1.50/24")
-    miners = await network.scan()
-
-    # we need to asyncio.gather() all the miners get_data() functions to make them run together
-    all_miner_data = await asyncio.gather(*[miner.get_data() for miner in miners])
-
-    for miner_data in all_miner_data:
-        print(miner_data)    # print out all the data one by one
-
-if __name__ == "__main__":
-    asyncio.run(gather_miner_data())
+    asyncio.run(scan_and_get_data())
 ```
 
----
-## Miner control
+</br>
 
-`pyasic` exposes a standard interface for each miner using control functions.
-Every miner class in `pyasic` must implement all the control functions defined in `BaseMiner`.
-
-These functions are
-`check_light`,
-`fault_light_off`,
-`fault_light_on`,
-`get_config`,
-`get_data`,
-`get_errors`,
-`get_hostname`,
-`get_model`,
-`reboot`,
-`restart_backend`,
-`stop_mining`,
-`resume_mining`,
-`is_mining`,
-`send_config`, and
-`set_power_limit`.
-
-##### Usage
+#### Getting a miner if you know the IP
 ```python
 import asyncio
-from pyasic import get_miner
+import sys
+
+from pyasic.miners.miner_factory import MinerFactory
+
+# Fix whatsminer bug
+# if the computer is windows, set the event loop policy to a WindowsSelector policy
+if sys.version_info[0] == 3 and sys.version_info[1] >= 8 and sys.platform.startswith('win'):
+    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
 
 
-async def set_fault_light():
-    miner = await get_miner("192.168.1.20")
+# define asynchronous function to get miner and data
+async def get_miner_data(miner_ip: str):
+    # Use MinerFactory to get miner
+    # MinerFactory is a singleton, so we can just get the instance in place
+    miner = await MinerFactory().get_miner(miner_ip)
 
-    # call control function
-    await miner.fault_light_on()
+    # Get data from the miner
+    data = await miner.get_data()
+    print(data)
 
 if __name__ == "__main__":
-    asyncio.run(set_fault_light())
+    asyncio.run(get_miner_data("192.168.1.69"))
 ```
 
----
-## Helper dataclasses
+### Advanced data gathering
 
-##### `MinerConfig` and `MinerData`
+If needed, this library exposes a wrapper for the miner API that can be used for advanced data gathering.
 
-`pyasic` implements a few dataclasses as helpers to make data return types consistent across different miners and miner APIs.  The different fields of these dataclasses can all be viewed with the classmethod `cls.fields()`.
-
----
-
-##### MinerData
-
-`MinerData` is a return from the [`get_data()`](#get-data) function, and is used to have a consistent dataset across all returns.
-
-You can call `MinerData.as_dict()` to get the dataclass as a dictionary, and there are many other helper functions contained in the class to convert to different data formats.
-
-`MinerData` instances can also be added to each other to combine their data and can be divided by a number to divide all their data, allowing you to get average data from many miners by doing -
-```python
-from pyasic import MinerData
-
-# examples of miner data
-d1 = MinerData("192.168.1.1")
-d2 = MinerData("192.168.1.2")
-
-list_of_miner_data = [d1, d2]
-
-average_data = sum(list_of_miner_data, start=MinerData("0.0.0.0"))/len(list_of_miner_data)
-```
-
----
-
-##### MinerConfig
-
-`MinerConfig` is `pyasic`'s way to represent a configuration file from a miner.
-It is designed to unionize the configuration of all supported miner types, and is the return from [`get_config()`](#get-config).
-
-Each miner has a unique way to convert the `MinerConfig` to their specific type, there are helper functions in the class.
-In most cases these helper functions should not be used, as [`send_config()`](#send-config) takes a [`MinerConfig` and will do the conversion to the right type for you.
-
-You can use the `MinerConfig` as follows:
+#### List available API commands
 ```python
 import asyncio
-from pyasic import get_miner
+import sys
+
+from pyasic.miners.miner_factory import MinerFactory
+
+# Fix whatsminer bug
+# if the computer is windows, set the event loop policy to a WindowsSelector policy
+if sys.version_info[0] == 3 and sys.version_info[1] >= 8 and sys.platform.startswith('win'):
+    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
 
 
-async def set_fault_light():
-    miner = await get_miner("192.168.1.20")
+async def get_api_commands(miner_ip: str):
+    # Get the miner
+    miner = await MinerFactory().get_miner(miner_ip)
 
-    # get config
-    cfg = await miner.get_config()
+    # List all available commands
+    print(miner.api.get_commands())
 
-    # send config
-    await miner.send_config(cfg)
 
 if __name__ == "__main__":
-    asyncio.run(set_fault_light())
-
+    asyncio.run(get_api_commands("192.168.1.69"))
 ```
 
----
-## Settings
+#### Use miner API commands to gather data
 
-`pyasic` has settings designed to make using large groups of miners easier.  You can set the default password for all types of miners using the `pyasic.settings` module, used as follows:
+The miner API commands will raise an `APIError` if they fail with a bad status code, to bypass this you must send them manually by using `miner.api.send_command(command, ignore_errors=True)`
 
 ```python
-from pyasic import settings
+import asyncio
+import sys
 
-settings.update("default_antminer_web_password", "my_pwd")
-```
+from pyasic.miners.miner_factory import MinerFactory
 
-##### Default values:
-```
-"network_ping_retries": 1,
-"network_ping_timeout": 3,
-"network_scan_semaphore": None,
-"factory_get_retries": 1,
-"factory_get_timeout": 3,
-"get_data_retries": 1,
-"api_function_timeout": 5,
-"antminer_mining_mode_as_str": False,
-"default_whatsminer_rpc_password": "admin",
-"default_innosilicon_web_password": "admin",
-"default_antminer_web_password": "root",
-"default_bosminer_web_password": "root",
-"default_vnish_web_password": "admin",
-"default_goldshell_web_password": "123456789",
-"default_auradine_web_password": "admin",
-"default_epic_web_password": "letmein",
-"default_hive_web_password": "admin",
-"default_antminer_ssh_password": "miner",
-"default_bosminer_ssh_password": "root",
+# Fix whatsminer bug
+# if the computer is windows, set the event loop policy to a WindowsSelector policy
+if sys.version_info[0] == 3 and sys.version_info[1] >= 8 and sys.platform.startswith('win'):
+    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
 
-# ADVANCED
-# Only use this if you know what you are doing
-"socket_linger_time": 1000,
+
+async def get_api_commands(miner_ip: str):
+    # Get the miner
+    miner = await MinerFactory().get_miner(miner_ip)
+
+    # Run the devdetails command
+    # This is equivalent to await miner.api.send_command("devdetails")
+    devdetails: dict = await miner.api.devdetails()
+    print(devdetails)
+
+
+if __name__ == "__main__":
+    asyncio.run(get_api_commands("192.168.1.69"))
 ```

docs/API/api.md

@@ -0,0 +1,25 @@
+# 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 -
+
+#### [BMMiner API][pyasic.API.bmminer.BMMinerAPI]
+#### [BOSMiner API][pyasic.API.bosminer.BOSMinerAPI]
+#### [BTMiner API][pyasic.API.btminer.BTMinerAPI]
+#### [CGMiner API][pyasic.API.cgminer.CGMinerAPI]
+#### [Unknown API][pyasic.API.unknown.UnknownAPI]
+
+<br>
+
+## BaseMinerAPI
+::: pyasic.API.BaseMinerAPI
+    handler: python
+    options:
+        heading_level: 4

docs/API/bmminer.md

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

docs/API/bosminer.md

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

docs/API/btminer.md

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

docs/API/cgminer.md

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

docs/API/unknown.md

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

docs/config/miner_config.md

@@ -6,3 +6,19 @@
     options:
         show_root_heading: false
         heading_level: 4
+
+## Pool Groups
+
+::: pyasic.config._PoolGroup
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## Pools
+
+::: pyasic.config._Pool
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/data/error_codes.md

@@ -23,11 +23,3 @@
     options:
         show_root_heading: false
         heading_level: 4
-<br>
-
-## Innosilicon Error Codes
-::: pyasic.data.error_codes.InnosiliconError
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4

docs/data/miner_data.md

@@ -1,22 +1,8 @@
 # pyasic
-
 ## Miner Data
+
 ::: pyasic.data.MinerData
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-
-## HashBoard Data
-::: pyasic.data.HashBoard
-    handler: python
-    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

@@ -1,175 +0,0 @@
-import asyncio
-import importlib
-import os
-import warnings
-
-from pyasic.miners.factory import MINER_CLASSES, MinerTypes
-
-warnings.filterwarnings("ignore")
-
-
-def path(cls):
-    module = importlib.import_module(cls.__module__)
-    return module.__name__ + "." + cls.__name__
-
-
-def make(cls):
-    p = path(cls)
-    return p.split(".")[2]
-
-
-def model_type(cls):
-    p = path(cls)
-    return p.split(".")[4]
-
-
-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:
-            return "Vnish Firmware Miners"
-        case MinerTypes.EPIC:
-            return "ePIC Firmware Miners"
-        case MinerTypes.BRAIINS_OS:
-            return "BOS+ Firmware Miners"
-        case MinerTypes.HIVEON:
-            return "HiveOS Firmware Miners"
-        case MinerTypes.INNOSILICON:
-            return "Stock Firmware Innosilicons"
-        case MinerTypes.WHATSMINER:
-            return "Stock Firmware Whatsminers"
-        case MinerTypes.GOLDSHELL:
-            return "Stock Firmware Goldshells"
-        case MinerTypes.LUX_OS:
-            return "LuxOS Firmware Miners"
-        case MinerTypes.MARATHON:
-            return "Mara Firmware Miners"
-        case MinerTypes.BITAXE:
-            return "Stock Firmware BitAxe Miners"
-        case MinerTypes.ICERIVER:
-            return "Stock Firmware IceRiver Miners"
-        case MinerTypes.HAMMER:
-            return "Stock Firmware Hammer Miners"
-
-
-def create_url_str(mtype: str):
-    return (
-        mtype.lower()
-        .replace(" ", "-")
-        .replace("(", "")
-        .replace(")", "")
-        .replace("+", "_1")
-    )
-
-
-HEADER_FORMAT = "# pyasic\n## {} Models\n\n"
-MINER_HEADER_FORMAT = "## {}\n"
-DATA_FORMAT = """::: {}
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-"""
-SUPPORTED_TYPES_HEADER = """# pyasic
-## Supported Miners
-
-Supported miner types are here on this list.  If your miner (or miner version) is not on this list, please feel free to [open an issue on GitHub](https://github.com/UpstreamData/pyasic/issues) to get it added.
-
-##### pyasic currently supports the following miners and subtypes:
-<style>
-details {
-    margin:0px;
-    padding-top:0px;
-    padding-bottom:0px;
-}
-</style>
-"""
-BACKEND_TYPE_HEADER = """
-<details>
-<summary>{}:</summary>
-    <ul>"""
-
-MINER_TYPE_HEADER = """
-        <details>
-            <summary>{} Series:</summary>
-                <ul>"""
-
-MINER_DETAILS = """
-                    <li><a href="../{}/{}#{}">{}</a></li>"""
-
-MINER_TYPE_CLOSER = """
-                </ul>
-        </details>"""
-BACKEND_TYPE_CLOSER = """
-    </ul>
-</details>"""
-
-m_data = {}
-
-
-for m in MINER_CLASSES:
-    for t in MINER_CLASSES[m]:
-        if t is not None:
-            miner = MINER_CLASSES[m][t]
-            if make(miner) not in m_data:
-                m_data[make(miner)] = {}
-            if model_type(miner) not in m_data[make(miner)]:
-                m_data[make(miner)][model_type(miner)] = []
-            m_data[make(miner)][model_type(miner)].append(miner)
-
-
-async def create_directory_structure(directory, data):
-    if not os.path.exists(directory):
-        os.makedirs(directory)
-
-    for key, value in data.items():
-        subdirectory = os.path.join(directory, key)
-        if isinstance(value, dict):
-            await create_directory_structure(subdirectory, value)
-        elif isinstance(value, list):
-            file_path = os.path.join(subdirectory + ".md")
-
-            with open(file_path, "w") as file:
-                file.write(HEADER_FORMAT.format(key))
-                for item in value:
-                    header = await item("1.1.1.1").get_model()
-                    file.write(MINER_HEADER_FORMAT.format(header))
-                    file.write(DATA_FORMAT.format(path(item)))
-
-
-async def create_supported_types(directory):
-    with open(os.path.join(directory, "supported_types.md"), "w") as file:
-        file.write(SUPPORTED_TYPES_HEADER)
-        for mback in MINER_CLASSES:
-            backend_types = {}
-            file.write(BACKEND_TYPE_HEADER.format(backend_str(mback)))
-            for mtype in MINER_CLASSES[mback]:
-                if mtype is None:
-                    continue
-                m = MINER_CLASSES[mback][mtype]
-                if model_type(m) not in backend_types:
-                    backend_types[model_type(m)] = []
-                backend_types[model_type(m)].append(m)
-
-            for mtype in backend_types:
-                file.write(MINER_TYPE_HEADER.format(mtype))
-                for minstance in backend_types[mtype]:
-                    model = await minstance("1.1.1.1").get_model()
-                    file.write(
-                        MINER_DETAILS.format(
-                            make(minstance), mtype, create_url_str(model), model
-                        )
-                    )
-                file.write(MINER_TYPE_CLOSER)
-            file.write(BACKEND_TYPE_CLOSER)
-
-
-root_directory = os.path.join(os.getcwd(), "miners")
-asyncio.run(create_directory_structure(root_directory, m_data))
-asyncio.run(create_supported_types(root_directory))

docs/index.md

@@ -1,289 +1,103 @@
 # pyasic
-*A simplified and standardized interface for Bitcoin ASICs.*
+*A set of modules for interfacing with many common types of ASIC bitcoin miners, using both their API and SSH.*
 
-
-[![PyPI - Version](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyasic)](https://pypi.org/project/pyasic/)
-[![Python - Supported Versions](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
-[![CodeFactor - Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)
-[![Commit Activity - master](https://img.shields.io/github/commit-activity/y/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/commits/master/)
-[![Code Style - Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Read The Docs - Docs](https://img.shields.io/readthedocs/pyasic)](https://pyasic.readthedocs.io/en/latest/)
-[![License - Apache 2.0](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![pypi](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![python](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![Read the Docs](https://img.shields.io/readthedocs/pyasic)](https://pyasic.readthedocs.io/en/latest/)
+[![GitHub](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
+[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)
 
 ## Intro
----
-Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with ASIC miners on your network, which makes it super fast.
+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)
+[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.
-`pyasic` can be installed directly from pip, either with `pip install pyasic`, or a different command if using a tool like `pypoetry`.
+Getting started with pyasic is easy.  First, find your miner (or miners) on the network by scanning for them or getting the correct class automatically for them if you know the IP.
 
-## Getting started
----
-Getting started with `pyasic` is easy.  First, find your miner (or miners) on the network by scanning for them or getting the correct class automatically for them if you know the IP.
+<br>
 
-### Scanning for miners
-To scan for miners in `pyasic`, we use the class [`MinerNetwork`][pyasic.network.MinerNetwork], which abstracts the search, communication, identification, setup, and return of a miner to 1 command.
-The command [`MinerNetwork.scan()`][pyasic.network.MinerNetwork.scan] returns a list that contains any miners found.
-```python3
-import asyncio# (1)!
-from pyasic.network import MinerNetwork# (2)!
+## Scanning for miners
+To scan for miners in pyasic, we use the class [`MinerNetwork`][pyasic.network.MinerNetwork], which abstracts the search, communication, identification, setup, and return of a miner to 1 command.
+The command [`MinerNetwork().scan_network_for_miners()`][pyasic.network.MinerNetwork.scan_network_for_miners] returns a list that contains any miners found.
+```python
+import asyncio  # asyncio for handling the async part
+from pyasic.network import MinerNetwork  # miner network handles the scanning
 
 
-async def scan_miners():# (3)!
-    network = MinerNetwork.from_subnet("192.168.1.50/24")# (4)!
+async def scan_miners():  # define async scan function to allow awaiting
+    # create a miner network
+    # you can pass in any IP and it will use that in a subnet with a /24 mask (255 IPs).
+    network = MinerNetwork("192.168.1.50")  # this uses the 192.168.1.0-255 network
 
-    miners = await network.scan()# (5)!
+    # scan for miners asynchronously
+    # this will return the correct type of miners if they are supported with all functionality.
+    miners = await network.scan_network_for_miners()
     print(miners)
 
 if __name__ == "__main__":
-    asyncio.run(scan_miners())# (6)!
+    asyncio.run(scan_miners())  # run the scan asynchronously with asyncio.run()
 ```
 
-1. `asyncio` for handling the async part.
-2. `MinerNetwork` handles the scanning.
-3. Define an async function to allow awaiting.
-4. Create a miner network.
-You can pass in any IP and it will use that in a subnet with a /24 mask (255 IPs).
-This uses the 192.168.1.0-255 network.
-5. Scan for miners asynchronously.
-This will return the correct type of miners (if they are supported) with all functionality.
-6. Run the scan asynchronously with asyncio.run().
+<br>
 
----
-### Creating miners based on IP
-If you already know the IP address of your miner or miners, you can use the [`MinerFactory`][pyasic.miners.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.
+## Creating miners based on IP
+If you already know the IP address of your miner or miners, you can use the [`MinerFactory`][pyasic.miners.miner_factory.MinerFactory] to communicate and identify the miners.
+The function [`MinerFactory().get_miner()`][pyasic.miners.miner_factory.MinerFactory.get_miner] will return any miner it found at the IP address specified, or an `UnknownMiner` if it cannot identify the miner.
 ```python
-import asyncio# (1)!
-from pyasic import get_miner# (2)!
+import asyncio  # asyncio for handling the async part
+from pyasic.miners.miner_factory import MinerFactory  # miner factory handles miners creation
 
 
-async def get_miners():# (3)!
-    miner_1 = await get_miner("192.168.1.75")# (4)!
-    miner_2 = await get_miner("192.168.1.76")
+async def get_miners():  # define async scan function to allow awaiting
+    # get the miner with miner factory
+    # miner factory is a singleton, and will always use the same object and cache
+    # this means you can always call it as MinerFactory().get_miner()
+    miner_1 = await MinerFactory().get_miner("192.168.1.75")
+    miner_2 = await MinerFactory().get_miner("192.168.1.76")
     print(miner_1, miner_2)
 
-    tasks = [get_miner("192.168.1.75"), get_miner("192.168.1.76")]
-    miners = await asyncio.gather(*tasks)# (5)!
-    print(miners)
-
-
 if __name__ == "__main__":
-    asyncio.run(get_miners())# (6)!
+    asyncio.run(get_miners())  # get the miners asynchronously with asyncio.run()
 ```
 
-1. `asyncio` for handling the async part.
-2. `get_miner` handles the miner type selection.
-3. Define an async function to allow awaiting.
-4. Get the miner.
-5. Can also gather these, since they are async.
-Gathering them will get them both at the same time.
-This makes it much faster to get a lot of miners at a time.
-6. Get the miners asynchronously with asyncio.run().
+<br>
 
-## Data gathering
----
-Once you have your miner(s) identified, you will likely want to get data from the miner(s).  You can do this using a built-in function in each miner called `get_data()`.
-This function will return an instance of the dataclass [`MinerData`][pyasic.data.MinerData] with all data it can gather from the miner.
+## Getting data from miners
+
+Once you have your miner(s) identified, you will likely want to get data from the miner(s).  You can do this using a built in function in each miner called `get_data()`.
+This function will return a instance of the dataclass [`MinerData`][pyasic.data.MinerData] with all data it can gather from the miner.
 Each piece of data in a [`MinerData`][pyasic.data.MinerData] instance can be referenced by getting it as an attribute, such as [`MinerData().hashrate`][pyasic.data.MinerData].
-
-### One miner
 ```python
-import asyncio# (1)!
-from pyasic import get_miner# (2)!
+import asyncio
+from pyasic.miners.miner_factory import MinerFactory
 
-
-async def gather_miner_data():# (3)!
-    miner = await get_miner("192.168.1.75")# (4)!
-    if miner is not None:# (5)!
-        miner_data = await miner.get_data()# (6)!
-        print(miner_data)# (7)!
-        print(miner_data.hashrate)  # hashrate of the miner in TH/s
+async def gather_miner_data():
+    miner = await MinerFactory().get_miner("192.168.1.75")
+    miner_data = await miner.get_data()
+    print(miner_data)  # all data from the dataclass
+    print(miner_data.hashrate)  # hashrate of the miner in TH/s
 
 if __name__ == "__main__":
-    asyncio.run(gather_miner_data())# (9)!
+    asyncio.run(gather_miner_data())
 ```
 
-1. `asyncio` for handling the async part.
-2. `get_miner` handles the miner type selection.
-3. Define an async function to allow awaiting.
-4. Get the miner.
-5. Make sure the miner exists.
-If this result is `None`, the miner may be offline.
-6. Get data from the miner.
-7. All the data from the dataclass.
-8. Hashrate of the miner, with unit information.
-9. Get the miner data asynchronously with asyncio.run().
-
-### Multiple miners
 You can do something similar with multiple miners, with only needing to make a small change to get all the data at once.
 ```python
-import asyncio# (1)!
-from pyasic.network import MinerNetwork# (2)!
+import asyncio  # asyncio for handling the async part
+from pyasic.network import MinerNetwork  # miner network handles the scanning
 
 
-async def gather_miner_data():# (3)!
-    network = MinerNetwork.from_subnet("192.168.1.50/24")# (4)!
-    miners = await network.scan()# (5)!
+async def gather_miner_data():  # define async scan function to allow awaiting
+    network = MinerNetwork("192.168.1.50")
+    miners = await network.scan_network_for_miners()
 
+    # we need to asyncio.gather() all the miners get_data() functions to make them run together
     all_miner_data = await asyncio.gather(*[miner.get_data() for miner in miners])
 
     for miner_data in all_miner_data:
-        print(miner_data)# (7)!
+        print(miner_data)    # print out all the data one by one
 
 if __name__ == "__main__":
-    asyncio.run(gather_miner_data())# (8)!
-```
-
-1. `asyncio` for handling the async part.
-2. `MinerNetwork` handles the scanning.
-3. Define an async function to allow awaiting.
-4. Create a miner network.
-5. Scan for miners asynchronously.
-6. Use `asyncio.gather()` with all the miners' `get_data()` functions to make them run together.
-7. Print out the data one at a time.
-8. Get the miner data asynchronously with asyncio.run().
-
-## Miner control
----
-`pyasic` exposes a standard interface for each miner using control functions.
-Every miner class in `pyasic` must implement all the following control functions.
-
-[`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
-import asyncio# (1)!
-from pyasic import get_miner# (2)!
-
-
-async def set_fault_light():# (3)!
-    miner = await get_miner("192.168.1.20")# (4)!
-
-    await miner.fault_light_on()# (5)!
-
-if __name__ == "__main__":
-    asyncio.run(set_fault_light())# (6)!
-```
-
-1. `asyncio` for handling the async part.
-2. `get_miner` handles the miner type selection.
-3. Define an async function to allow awaiting.
-4. Get the miner.
-5. Call the miner control function.
-6. Call the control function asynchronously with asyncio.run().
-
-
-## Helper dataclasses
----
-
-### [`MinerConfig`][pyasic.config.MinerConfig] and [`MinerData`][pyasic.data.MinerData]
-
-`pyasic` implements a few dataclasses as helpers to make data return types consistent across different miners and miner APIs.  The different fields of these dataclasses can all be viewed with the classmethod `cls.fields()`.
-
----
-
-### [`MinerData`][pyasic.data.MinerData]
-
-[`MinerData`][pyasic.data.MinerData] is a return from the [`get_data()`][pyasic.miners.base.MinerProtocol.get_data] function, and is used to have a consistent dataset across all returns.
-
-You can call [`MinerData.as_dict()`][pyasic.data.MinerData.as_dict] to get the dataclass as a dictionary, and there are many other helper functions contained in the class to convert to different data formats.
-
-[`MinerData`][pyasic.data.MinerData] instances can also be added to each other to combine their data and can be divided by a number to divide all their data, allowing you to get average data from many miners by doing -
-```python
-from pyasic import MinerData
-
-# examples of miner data
-d1 = MinerData("192.168.1.1")
-d2 = MinerData("192.168.1.2")
-
-list_of_miner_data = [d1, d2]
-
-average_data = sum(list_of_miner_data, start=MinerData("0.0.0.0"))/len(list_of_miner_data)
-```
-
----
-
-### [`MinerConfig`][pyasic.config.MinerConfig]
-
-[`MinerConfig`][pyasic.config.MinerConfig] is `pyasic`'s way to represent a configuration file from a miner.
-It is designed to unionize the configuration of all supported miner types, and is the return from [`get_config()`][pyasic.miners.base.MinerProtocol.get_config].
-
-Each miner has a unique way to convert the [`MinerConfig`][pyasic.config.MinerConfig] to their specific type, there are helper functions in the class.
-In most cases these helper functions should not be used, as [`send_config()`][pyasic.miners.base.MinerProtocol.send_config] takes a [`MinerConfig`][pyasic.config.MinerConfig] and will do the conversion to the right type for you.
-
-You can use the [`MinerConfig`][pyasic.config.MinerConfig] as follows:
-```python
-import asyncio
-from pyasic import get_miner
-
-
-async def set_fault_light():
-    miner = await get_miner("192.168.1.20")
-
-    # get config
-    cfg = await miner.get_config()
-
-    # send config
-    await miner.send_config(cfg)
-
-if __name__ == "__main__":
-    asyncio.run(set_fault_light())
-
-```
-
-## Settings
----
-`pyasic` has settings designed to make using large groups of miners easier.  You can set the default password for all types of miners using the `pyasic.settings` module, used as follows:
-
-```python
-from pyasic import settings
-
-settings.update("default_antminer_web_password", "my_pwd")
-```
-
-### Default values:
-```
-"network_ping_retries": 1,
-"network_ping_timeout": 3,
-"network_scan_semaphore": None,
-"factory_get_retries": 1,
-"factory_get_timeout": 3,
-"get_data_retries": 1,
-"api_function_timeout": 5,
-"antminer_mining_mode_as_str": False,
-"default_whatsminer_rpc_password": "admin",
-"default_innosilicon_web_password": "admin",
-"default_antminer_web_password": "root",
-"default_bosminer_web_password": "root",
-"default_vnish_web_password": "admin",
-"default_goldshell_web_password": "123456789",
-"default_auradine_web_password": "admin",
-"default_epic_web_password": "letmein",
-"default_hive_web_password": "admin",
-"default_antminer_ssh_password": "miner",
-"default_bosminer_ssh_password": "root",
-
-# ADVANCED
-# Only use this if you know what you are doing
-"socket_linger_time": 1000,
+    asyncio.run(gather_miner_data())
 ```

docs/miners/antminer/X15.md

@@ -1,17 +0,0 @@
-# pyasic
-## X15 Models
-
-## Z15 (Stock)
-::: pyasic.miners.antminer.cgminer.X15.Z15.CGMinerZ15
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## Z15 Pro (Stock)
-::: pyasic.miners.antminer.bmminer.X15.Z15.BMMinerZ15Pro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/antminer/X17.md

@@ -1,115 +1,59 @@
 # pyasic
 ## X17 Models
 
-## S17 (Stock)
+## S17
+
 ::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S17+ (Stock)
-::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17Plus
+## S17+
+
+::: pyasic.miners.antminer.bmminer.X17.S17_Plus.BMMinerS17Plus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S17 Pro (Stock)
-::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17Pro
+## S17 Pro
+
+::: pyasic.miners.antminer.bmminer.X17.S17_Pro.BMMinerS17Pro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S17e (Stock)
-::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17e
+## S17e
+
+::: pyasic.miners.antminer.bmminer.X17.S17e.BMMinerS17e
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T17 (Stock)
+## T17
+
 ::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T17+ (Stock)
-::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17Plus
+## T17+
+
+::: pyasic.miners.antminer.bmminer.X17.T17_Plus.BMMinerT17Plus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T17e (Stock)
-::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17e
+
+## T17e
+
+::: pyasic.miners.antminer.bmminer.X17.T17e.BMMinerT17e
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-
-## S17 (BOS+)
-::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S17+ (BOS+)
-::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17Plus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S17 Pro (BOS+)
-::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17Pro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S17e (BOS+)
-::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17e
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## T17 (BOS+)
-::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## T17+ (BOS+)
-::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17Plus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## T17e (BOS+)
-::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17e
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S17+ (VNish)
-::: pyasic.miners.antminer.vnish.X17.S17.VNishS17Plus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S17 Pro (VNish)
-::: pyasic.miners.antminer.vnish.X17.S17.VNishS17Pro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/antminer/X19.md

@@ -1,465 +1,52 @@
 # pyasic
 ## X19 Models
 
-## S19 (Stock)
+## S19
+
 ::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19L (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19L
+## S19 Pro
+
+::: pyasic.miners.antminer.bmminer.X19.S19_Pro.BMMinerS19Pro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19 Pro (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19Pro
+
+## S19a
+
+::: pyasic.miners.antminer.bmminer.X19.S19a.BMMinerS19a
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19j (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19j
+
+## S19j
+
+::: pyasic.miners.antminer.bmminer.X19.S19j.BMMinerS19j
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19i (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19i
+## S19j Pro
+
+::: pyasic.miners.antminer.bmminer.X19.S19j_Pro.BMMinerS19jPro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19+ (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19Plus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
+## T19
 
-## S19j No PIC (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19jNoPIC
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 Pro+ (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19ProPlus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j Pro (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19jPro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 XP (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19XP
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19a (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19a
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19a Pro (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19aPro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 Hydro (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19Hydro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 Pro Hydro (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19ProHydro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 Pro+ Hydro (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19ProPlusHydro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19K Pro (Stock)
-::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19KPro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## T19 (Stock)
 ::: pyasic.miners.antminer.bmminer.X19.T19.BMMinerT19
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-
-## S19 (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19+ (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19Plus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 Pro (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19Pro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19a (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19a
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19a Pro (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19aPro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19j
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j No PIC (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jNoPIC
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j Pro (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jPro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j Pro No PIC (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProNoPIC
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j Pro+ (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProPlus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j Pro+ (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProPlus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j Pro+ No PIC (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProPlusNoPIC
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19k Pro No PIC (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19kProNoPIC
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19k Pro No PIC (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19kProNoPIC
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 XP (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19XP
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 Pro+ Hydro (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19ProPlusHydro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## T19 (BOS+)
-::: pyasic.miners.antminer.bosminer.X19.T19.BOSMinerT19
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 (VNish)
-::: pyasic.miners.antminer.vnish.X19.S19.VNishS19
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 No PIC (VNish)
-::: pyasic.miners.antminer.vnish.X19.S19.VNishS19NoPIC
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 Pro (VNish)
-::: pyasic.miners.antminer.vnish.X19.S19.VNishS19Pro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j (VNish)
-::: pyasic.miners.antminer.vnish.X19.S19.VNishS19j
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j Pro (VNish)
-::: pyasic.miners.antminer.vnish.X19.S19.VNishS19jPro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j Pro (VNish)
-::: pyasic.miners.antminer.vnish.X19.S19.VNishS19jPro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19a (VNish)
-::: pyasic.miners.antminer.vnish.X19.S19.VNishS19a
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19a Pro (VNish)
-::: pyasic.miners.antminer.vnish.X19.S19.VNishS19aPro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 Pro Hydro (VNish)
-::: pyasic.miners.antminer.vnish.X19.S19.VNishS19ProHydro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## T19 (VNish)
-::: pyasic.miners.antminer.vnish.X19.T19.VNishT19
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 (ePIC)
-::: pyasic.miners.antminer.epic.X19.S19.ePICS19
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19 Pro (ePIC)
-::: pyasic.miners.antminer.epic.X19.S19.ePICS19Pro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j (ePIC)
-::: pyasic.miners.antminer.epic.X19.S19.ePICS19j
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j Pro (ePIC)
-::: pyasic.miners.antminer.epic.X19.S19.ePICS19jPro
-    handler: python
-    options:
-        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
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S19j Pro (Stock)
-::: pyasic.miners.antminer.hiveon.X19.S19.HiveonS19jPro
-    handler: python
-    options:
-        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

@@ -1,87 +0,0 @@
-# pyasic
-## X21 Models
-
-## S21 (Stock)
-::: pyasic.miners.antminer.bmminer.X21.S21.BMMinerS21
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S21 Pro (Stock)
-::: pyasic.miners.antminer.bmminer.X21.S21.BMMinerS21Pro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## T21 (Stock)
-::: pyasic.miners.antminer.bmminer.X21.T21.BMMinerT21
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S21 (BOS+)
-::: pyasic.miners.antminer.bosminer.X21.S21.BOSMinerS21
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## T21 (BOS+)
-::: pyasic.miners.antminer.bosminer.X21.T21.BOSMinerT21
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S21 (VNish)
-::: pyasic.miners.antminer.vnish.X21.S21.VNishS21
-    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
-
-## S21 Pro (ePIC)
-::: pyasic.miners.antminer.epic.X21.S21.ePICS21Pro
-    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

@@ -1,52 +0,0 @@
-# pyasic
-## X3 Models
-
-## D3 (Stock)
-::: pyasic.miners.antminer.cgminer.X3.D3.CGMinerD3
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## HS3 (Stock)
-::: pyasic.miners.antminer.bmminer.X3.HS3.BMMinerHS3
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## L3+ (Stock)
-::: pyasic.miners.antminer.bmminer.X3.L3.BMMinerL3Plus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KA3 (Stock)
-::: pyasic.miners.antminer.bmminer.X3.KA3.BMMinerKA3
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KS3 (Stock)
-::: pyasic.miners.antminer.bmminer.X3.KS3.BMMinerKS3
-    handler: python
-    options:
-        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
-
-## L3+ (VNish)
-::: pyasic.miners.antminer.vnish.X3.L3.VnishL3Plus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/antminer/X5.md

@@ -1,17 +0,0 @@
-# pyasic
-## X5 Models
-
-## DR5 (Stock)
-::: pyasic.miners.antminer.cgminer.X5.DR5.CGMinerDR5
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KS5 (Stock)
-::: pyasic.miners.antminer.bmminer.X5.KS5.BMMinerKS5
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/antminer/X7.md

@@ -1,31 +0,0 @@
-# pyasic
-## X7 Models
-
-## L7 (Stock)
-::: pyasic.miners.antminer.bmminer.X7.L7.BMMinerL7
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## K7 (Stock)
-::: pyasic.miners.antminer.bmminer.X7.K7.BMMinerK7
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## D7 (Stock)
-::: pyasic.miners.antminer.bmminer.X7.D7.BMMinerD7
-    handler: python
-    options:
-        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

@@ -1,66 +1,26 @@
 # pyasic
 ## X9 Models
 
-## E9Pro (Stock)
-::: pyasic.miners.antminer.bmminer.X9.E9.BMMinerE9Pro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
+## S9
 
-## D9 (Stock)
-::: pyasic.miners.antminer.bmminer.X9.D9.BMMinerD9
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S9 (Stock)
 ::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S9i (Stock)
-::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9i
+## S9i
+
+::: pyasic.miners.antminer.bmminer.X9.S9i.BMMinerS9i
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S9j (Stock)
-::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9j
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
+## T9
 
-## T9 (Stock)
 ::: pyasic.miners.antminer.bmminer.X9.T9.BMMinerT9
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-
-## S9 (BOS+)
-::: pyasic.miners.antminer.bosminer.X9.S9.BOSMinerS9
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## T9 (Stock)
-::: pyasic.miners.antminer.hiveon.X9.T9.HiveonT9
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## S9 (LuxOS)
-::: pyasic.miners.antminer.luxos.X9.S9.LUXMinerS9
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/auradine/AD.md

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

docs/miners/auradine/AI.md

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

docs/miners/auradine/AT.md

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

docs/miners/avalonminer/A10X.md

@@ -1,24 +1,26 @@
 # pyasic
 ## A10X Models
 
-## Avalon 1026 (Stock)
+## A1026
+
 ::: pyasic.miners.avalonminer.cgminer.A10X.A1026.CGMinerAvalon1026
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## Avalon 1047 (Stock)
+## A1047
+
 ::: pyasic.miners.avalonminer.cgminer.A10X.A1047.CGMinerAvalon1047
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## Avalon 1066 (Stock)
+## A1066
+
 ::: pyasic.miners.avalonminer.cgminer.A10X.A1066.CGMinerAvalon1066
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-

docs/miners/avalonminer/A11X.md

@@ -1,10 +0,0 @@
-# pyasic
-## A11X Models
-
-## Avalon 1166 Pro (Stock)
-::: pyasic.miners.avalonminer.cgminer.A11X.A1166.CGMinerAvalon1166Pro
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/avalonminer/A12X.md

@@ -1,10 +0,0 @@
-# pyasic
-## A12X Models
-
-## Avalon 1246 (Stock)
-::: pyasic.miners.avalonminer.cgminer.A12X.A1246.CGMinerAvalon1246
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/avalonminer/A7X.md

@@ -1,24 +1,26 @@
 # pyasic
 ## A7X Models
 
-## Avalon 721 (Stock)
+## A721
+
 ::: pyasic.miners.avalonminer.cgminer.A7X.A721.CGMinerAvalon721
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## Avalon 741 (Stock)
+## A741
+
 ::: pyasic.miners.avalonminer.cgminer.A7X.A741.CGMinerAvalon741
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## Avalon 761 (Stock)
+## A761
+
 ::: pyasic.miners.avalonminer.cgminer.A7X.A761.CGMinerAvalon761
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-

docs/miners/avalonminer/A8X.md

@@ -1,24 +1,26 @@
 # pyasic
 ## A8X Models
 
-## Avalon 821 (Stock)
+## A821
+
 ::: pyasic.miners.avalonminer.cgminer.A8X.A821.CGMinerAvalon821
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## Avalon 841 (Stock)
+## A841
+
 ::: pyasic.miners.avalonminer.cgminer.A8X.A841.CGMinerAvalon841
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## Avalon 851 (Stock)
+## A851
+
 ::: pyasic.miners.avalonminer.cgminer.A8X.A851.CGMinerAvalon851
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-

docs/miners/avalonminer/A9X.md

@@ -1,10 +1,10 @@
 # pyasic
 ## A9X Models
 
-## Avalon 921 (Stock)
+## A921
+
 ::: pyasic.miners.avalonminer.cgminer.A9X.A921.CGMinerAvalon921
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-

docs/miners/avalonminer/nano.md

@@ -1,10 +0,0 @@
-# pyasic
-## nano Models
-
-## Avalon Nano 3 (Stock)
-::: pyasic.miners.avalonminer.cgminer.nano.nano3.CGMinerAvalonNano3
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/backends/bfgminer.md

@@ -1,8 +0,0 @@
-# pyasic
-## BFGMiner Backend
-
-::: pyasic.miners.backends.bfgminer.BFGMiner
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4

docs/miners/backends/bmminer.md

@@ -1,7 +1,7 @@
 # pyasic
 ## BMMiner Backend
 
-::: pyasic.miners.backends.bmminer.BMMiner
+::: pyasic.miners._backends.bmminer.BMMiner
     handler: python
     options:
         show_root_heading: false

docs/miners/backends/bosminer.md

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

docs/miners/backends/btminer.md

@@ -1,7 +1,7 @@
 # pyasic
 ## BTMiner Backend
 
-::: pyasic.miners.backends.btminer.BTMiner
+::: pyasic.miners._backends.btminer.BTMiner
     handler: python
     options:
         show_root_heading: false

docs/miners/backends/cgminer.md

@@ -1,7 +1,7 @@
 # pyasic
 ## CGMiner Backend
 
-::: pyasic.miners.backends.cgminer.CGMiner
+::: pyasic.miners._backends.cgminer.CGMiner
     handler: python
     options:
         show_root_heading: false

docs/miners/backends/epic.md

@@ -1,8 +0,0 @@
-# pyasic
-## ePIC Backend
-
-::: pyasic.miners.backends.epic.ePIC
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4

docs/miners/backends/hiveon.md

@@ -1,7 +1,7 @@
 # pyasic
 ## Hiveon Backend
 
-::: pyasic.miners.backends.hiveon.Hiveon
+::: pyasic.miners._backends.hiveon.Hiveon
     handler: python
     options:
         show_root_heading: false

docs/miners/backends/luxminer.md

@@ -1,8 +0,0 @@
-# pyasic
-## LUXMiner Backend
-
-::: pyasic.miners.backends.luxminer.LUXMiner
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4

docs/miners/backends/vnish.md

@@ -1,8 +0,0 @@
-# pyasic
-## VNish Backend
-
-::: pyasic.miners.backends.vnish.VNish
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4

docs/miners/base_miner.md

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

docs/miners/bitaxe/BM.md

@@ -1,31 +0,0 @@
-# pyasic
-## BM Models
-
-## Supra (Stock)
-::: pyasic.miners.bitaxe.espminer.BM.BM1368.BitAxeSupra
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## Ultra (Stock)
-::: pyasic.miners.bitaxe.espminer.BM.BM1366.BitAxeUltra
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## Max (Stock)
-::: pyasic.miners.bitaxe.espminer.BM.BM1397.BitAxeMax
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## Gamma (Stock)
-::: pyasic.miners.bitaxe.espminer.BM.BM1370.BitAxeGamma
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/blockminer/blockminer.md

@@ -1,17 +0,0 @@
-# pyasic
-## blockminer Models
-
-## BlockMiner 520i (ePIC)
-::: pyasic.miners.blockminer.epic.blockminer.blockminer.ePICBlockMiner520i
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## BlockMiner 720i (ePIC)
-::: pyasic.miners.blockminer.epic.blockminer.blockminer.ePICBlockMiner720i
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/functions.md

@@ -1,10 +0,0 @@
-## Control functionality
-
-All control functionality is outlined by the [`MinerProtocol`][pyasic.miners.base.MinerProtocol] class.
-
-## Miner Protocol
-
-::: pyasic.miners.base.MinerProtocol
-    handler: python
-    options:
-        heading_level: 4

docs/miners/goldshell/X5.md

@@ -1,24 +0,0 @@
-# pyasic
-## X5 Models
-
-## CK5 (Stock)
-::: pyasic.miners.goldshell.bfgminer.X5.CK5.GoldshellCK5
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## HS5 (Stock)
-::: pyasic.miners.goldshell.bfgminer.X5.HS5.GoldshellHS5
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KD5 (Stock)
-::: pyasic.miners.goldshell.bfgminer.X5.KD5.GoldshellKD5
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/goldshell/XBox.md

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

docs/miners/goldshell/XMax.md

@@ -1,10 +0,0 @@
-# pyasic
-## XMax Models
-
-## KD Max (Stock)
-::: pyasic.miners.goldshell.bfgminer.XMax.KDMax.GoldshellKDMax
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/hammer/DX.md

@@ -1,10 +0,0 @@
-# pyasic
-## DX Models
-
-## D10 (Stock)
-::: pyasic.miners.hammer.blackminer.DX.D10.HammerD10
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/iceriver/KSX.md

@@ -1,66 +0,0 @@
-# pyasic
-## KSX Models
-
-## KS0 (Stock)
-::: pyasic.miners.iceriver.iceminer.KSX.KS0.IceRiverKS0
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KS1 (Stock)
-::: pyasic.miners.iceriver.iceminer.KSX.KS1.IceRiverKS1
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KS2 (Stock)
-::: pyasic.miners.iceriver.iceminer.KSX.KS2.IceRiverKS2
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KS3 (Stock)
-::: pyasic.miners.iceriver.iceminer.KSX.KS3.IceRiverKS3
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KS3L (Stock)
-::: pyasic.miners.iceriver.iceminer.KSX.KS3.IceRiverKS3L
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KS3M (Stock)
-::: pyasic.miners.iceriver.iceminer.KSX.KS3.IceRiverKS3M
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KS5 (Stock)
-::: pyasic.miners.iceriver.iceminer.KSX.KS5.IceRiverKS5
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KS5L (Stock)
-::: pyasic.miners.iceriver.iceminer.KSX.KS5.IceRiverKS5L
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## KS5M (Stock)
-::: pyasic.miners.iceriver.iceminer.KSX.KS5.IceRiverKS5M
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/innosilicon/A10X.md

@@ -1,10 +0,0 @@
-# pyasic
-## A10X Models
-
-## A10X (Stock)
-::: pyasic.miners.innosilicon.cgminer.A10X.A10X.InnosiliconA10X
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/innosilicon/A11X.md

@@ -1,17 +0,0 @@
-# pyasic
-## A11X Models
-
-## A11 (Stock)
-::: pyasic.miners.innosilicon.cgminer.A11X.A11.InnosiliconA11
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## A11MX (Stock)
-::: pyasic.miners.innosilicon.cgminer.A11X.A11M.InnosiliconA11MX
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/innosilicon/T3X.md

@@ -1,10 +0,0 @@
-# pyasic
-## T3X Models
-
-## T3H+ (Stock)
-::: pyasic.miners.innosilicon.cgminer.T3X.T3H.InnosiliconT3HPlus
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/miner_factory.md

@@ -1,23 +1,7 @@
 # pyasic
 ## Miner Factory
 
-[`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.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.factory.MinerFactory
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-<br>
-
-## Get Miner
-::: pyasic.miners.get_miner
+::: pyasic.miners.miner_factory.MinerFactory
     handler: python
     options:
         show_root_heading: false
@@ -25,12 +9,12 @@ Finally, there is functionality to get multiple miners without using `asyncio.ga
 <br>
 
 ## AnyMiner
-::: pyasic.miners.base.AnyMiner
+::: pyasic.miners.miner_factory.AnyMiner
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-[`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],
+[`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],
 and is used to specify a function returning some arbitrary type of miner class instance.

docs/miners/supported_types.md

@@ -4,714 +4,70 @@
 Supported miner types are here on this list.  If your miner (or miner version) is not on this list, please feel free to [open an issue on GitHub](https://github.com/UpstreamData/pyasic/issues) to get it added.
 
 ##### pyasic currently supports the following miners and subtypes:
-<style>
-details {
-    margin:0px;
-    padding-top:0px;
-    padding-bottom:0px;
-}
-</style>
-
-<details>
-<summary>Stock Firmware Antminers:</summary>
-    <ul>
-        <details>
-            <summary>X3 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X3#d3-stock">D3 (Stock)</a></li>
-                    <li><a href="../antminer/X3#hs3-stock">HS3 (Stock)</a></li>
-                    <li><a href="../antminer/X3#l3_1-stock">L3+ (Stock)</a></li>
-                    <li><a href="../antminer/X3#ka3-stock">KA3 (Stock)</a></li>
-                    <li><a href="../antminer/X3#ks3-stock">KS3 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X5 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X5#dr5-stock">DR5 (Stock)</a></li>
-                    <li><a href="../antminer/X5#ks5-stock">KS5 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X7 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X7#l7-stock">L7 (Stock)</a></li>
-                    <li><a href="../antminer/X7#k7-stock">K7 (Stock)</a></li>
-                    <li><a href="../antminer/X7#d7-stock">D7 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X9 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X9#e9pro-stock">E9Pro (Stock)</a></li>
-                    <li><a href="../antminer/X9#d9-stock">D9 (Stock)</a></li>
-                    <li><a href="../antminer/X9#s9-stock">S9 (Stock)</a></li>
-                    <li><a href="../antminer/X9#s9i-stock">S9i (Stock)</a></li>
-                    <li><a href="../antminer/X9#s9j-stock">S9j (Stock)</a></li>
-                    <li><a href="../antminer/X9#t9-stock">T9 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X15 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X15#z15-stock">Z15 (Stock)</a></li>
-                    <li><a href="../antminer/X15#z15-pro-stock">Z15 Pro (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X17 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X17#s17-stock">S17 (Stock)</a></li>
-                    <li><a href="../antminer/X17#s17_1-stock">S17+ (Stock)</a></li>
-                    <li><a href="../antminer/X17#s17-pro-stock">S17 Pro (Stock)</a></li>
-                    <li><a href="../antminer/X17#s17e-stock">S17e (Stock)</a></li>
-                    <li><a href="../antminer/X17#t17-stock">T17 (Stock)</a></li>
-                    <li><a href="../antminer/X17#t17_1-stock">T17+ (Stock)</a></li>
-                    <li><a href="../antminer/X17#t17e-stock">T17e (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X19 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X19#s19-stock">S19 (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19l-stock">S19L (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19-pro-stock">S19 Pro (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19j-stock">S19j (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19i-stock">S19i (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19_1-stock">S19+ (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19j-no-pic-stock">S19j No PIC (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19-pro_1-stock">S19 Pro+ (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19j-pro-stock">S19j Pro (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19-xp-stock">S19 XP (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19a-stock">S19a (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19a-pro-stock">S19a Pro (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19-hydro-stock">S19 Hydro (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19-pro-hydro-stock">S19 Pro Hydro (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19-pro_1-hydro-stock">S19 Pro+ Hydro (Stock)</a></li>
-                    <li><a href="../antminer/X19#s19k-pro-stock">S19K Pro (Stock)</a></li>
-                    <li><a href="../antminer/X19#t19-stock">T19 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X21 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X21#s21-stock">S21 (Stock)</a></li>
-                    <li><a href="../antminer/X21#s21-pro-stock">S21 Pro (Stock)</a></li>
-                    <li><a href="../antminer/X21#t21-stock">T21 (Stock)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
-<details>
-<summary>Stock Firmware Whatsminers:</summary>
-    <ul>
-        <details>
-            <summary>M2X Series:</summary>
-                <ul>
-                    <li><a href="../whatsminer/M2X#m20-v10-stock">M20 V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m20s-v10-stock">M20S V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m20s-v20-stock">M20S V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m20s-v30-stock">M20S V30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m20p-v10-stock">M20P V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m20p-v30-stock">M20P V30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m20s_1-v30-stock">M20S+ V30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m21-v10-stock">M21 V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m21s-v20-stock">M21S V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m21s-v60-stock">M21S V60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m21s-v70-stock">M21S V70 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m21s_1-v20-stock">M21S+ V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M2X#m29-v10-stock">M29 V10 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>M3X Series:</summary>
-                <ul>
-                    <li><a href="../whatsminer/M3X#m30-v10-stock">M30 V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30-v20-stock">M30 V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30k-v10-stock">M30K V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30l-v10-stock">M30L V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-v10-stock">M30S V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-v20-stock">M30S V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-v30-stock">M30S V30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-v40-stock">M30S V40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-v50-stock">M30S V50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-v60-stock">M30S V60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-v70-stock">M30S V70 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-v80-stock">M30S V80 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-ve10-stock">M30S VE10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-ve20-stock">M30S VE20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-ve30-stock">M30S VE30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-ve40-stock">M30S VE40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-ve50-stock">M30S VE50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-ve60-stock">M30S VE60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-ve70-stock">M30S VE70 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vf10-stock">M30S VF10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vf20-stock">M30S VF20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vf30-stock">M30S VF30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vg10-stock">M30S VG10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vg20-stock">M30S VG20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vg30-stock">M30S VG30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vg40-stock">M30S VG40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vh10-stock">M30S VH10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vh20-stock">M30S VH20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vh30-stock">M30S VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vh40-stock">M30S VH40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vh50-stock">M30S VH50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vh60-stock">M30S VH60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s-vi20-stock">M30S VI20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-v10-stock">M30S+ V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-v20-stock">M30S+ V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-v30-stock">M30S+ V30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-v40-stock">M30S+ V40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-v50-stock">M30S+ V50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-v60-stock">M30S+ V60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-v70-stock">M30S+ V70 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-v80-stock">M30S+ V80 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-v90-stock">M30S+ V90 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-v100-stock">M30S+ V100 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-ve30-stock">M30S+ VE30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-ve40-stock">M30S+ VE40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-ve50-stock">M30S+ VE50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-ve60-stock">M30S+ VE60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-ve70-stock">M30S+ VE70 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-ve80-stock">M30S+ VE80 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-ve90-stock">M30S+ VE90 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-ve100-stock">M30S+ VE100 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vf20-stock">M30S+ VF20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vf30-stock">M30S+ VF30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vg20-stock">M30S+ VG20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vg30-stock">M30S+ VG30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vg40-stock">M30S+ VG40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vg50-stock">M30S+ VG50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vg60-stock">M30S+ VG60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vh10-stock">M30S+ VH10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vh20-stock">M30S+ VH20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vh30-stock">M30S+ VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vh40-stock">M30S+ VH40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vh50-stock">M30S+ VH50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1-vh60-stock">M30S+ VH60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-v10-stock">M30S++ V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-v20-stock">M30S++ V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-ve30-stock">M30S++ VE30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-ve40-stock">M30S++ VE40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-ve50-stock">M30S++ VE50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vf40-stock">M30S++ VF40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vg30-stock">M30S++ VG30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vg40-stock">M30S++ VG40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vg50-stock">M30S++ VG50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vh10-stock">M30S++ VH10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vh20-stock">M30S++ VH20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vh30-stock">M30S++ VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vh40-stock">M30S++ VH40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vh50-stock">M30S++ VH50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vh60-stock">M30S++ VH60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vh70-stock">M30S++ VH70 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vh80-stock">M30S++ VH80 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vh90-stock">M30S++ VH90 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vh100-stock">M30S++ VH100 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vj20-stock">M30S++ VJ20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30s_1_1-vj30-stock">M30S++ VJ30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31-v10-stock">M31 V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31-v20-stock">M31 V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31h-v10-stock">M31H V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31h-v40-stock">M31H V40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m30l-v10-stock">M30L V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-v10-stock">M31S V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-v20-stock">M31S V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-v30-stock">M31S V30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-v40-stock">M31S V40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-v50-stock">M31S V50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-v60-stock">M31S V60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-v70-stock">M31S V70 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-v80-stock">M31S V80 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-v90-stock">M31S V90 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-ve10-stock">M31S VE10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-ve20-stock">M31S VE20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s-ve30-stock">M31S VE30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31se-v10-stock">M31SE V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31se-v20-stock">M31SE V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31se-v30-stock">M31SE V30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-v10-stock">M31S+ V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-v20-stock">M31S+ V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-v30-stock">M31S+ V30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-v40-stock">M31S+ V40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-v50-stock">M31S+ V50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-v60-stock">M31S+ V60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-v80-stock">M31S+ V80 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-v90-stock">M31S+ V90 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-v100-stock">M31S+ V100 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-ve10-stock">M31S+ VE10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-ve20-stock">M31S+ VE20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-ve30-stock">M31S+ VE30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-ve40-stock">M31S+ VE40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-ve50-stock">M31S+ VE50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-ve60-stock">M31S+ VE60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-ve80-stock">M31S+ VE80 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-vf20-stock">M31S+ VF20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-vf30-stock">M31S+ VF30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-vg20-stock">M31S+ VG20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m31s_1-vg30-stock">M31S+ VG30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m32-v10-stock">M32 V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m32-v20-stock">M32 V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m33-v10-stock">M33 V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m33-v20-stock">M33 V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m33-v30-stock">M33 V30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m33s-vg30-stock">M33S VG30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m33s_1-vg20-stock">M33S+ VG20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m33s_1-vh20-stock">M33S+ VH20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m33s_1-vh30-stock">M33S+ VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m33s_1_1-vh20-stock">M33S++ VH20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m33s_1_1-vh30-stock">M33S++ VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m33s_1_1-vg40-stock">M33S++ VG40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m34s_1-ve10-stock">M34S+ VE10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m36s-ve10-stock">M36S VE10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m36s_1-vg30-stock">M36S+ VG30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m36s_1_1-vh30-stock">M36S++ VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m39-v10-stock">M39 V10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m39-v20-stock">M39 V20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M3X#m39-v30-stock">M39 V30 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>M5X Series:</summary>
-                <ul>
-                    <li><a href="../whatsminer/M5X#m50-ve30-stock">M50 VE30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vg30-stock">M50 VG30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vh10-stock">M50 VH10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vh20-stock">M50 VH20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vh30-stock">M50 VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vh40-stock">M50 VH40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vh50-stock">M50 VH50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vh60-stock">M50 VH60 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vh70-stock">M50 VH70 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vh80-stock">M50 VH80 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vh90-stock">M50 VH90 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vj10-stock">M50 VJ10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vj20-stock">M50 VJ20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50-vj30-stock">M50 VJ30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s-vj10-stock">M50S VJ10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s-vj20-stock">M50S VJ20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s-vj30-stock">M50S VJ30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s-vh10-stock">M50S VH10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s-vh20-stock">M50S VH20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s-vh30-stock">M50S VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s-vh40-stock">M50S VH40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s-vh50-stock">M50S VH50 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s_1-vh30-stock">M50S+ VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s_1-vh40-stock">M50S+ VH40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s_1-vj30-stock">M50S+ VJ30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s_1-vk20-stock">M50S+ VK20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s_1_1-vk10-stock">M50S++ VK10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s_1_1-vk20-stock">M50S++ VK20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m50s_1_1-vk30-stock">M50S++ VK30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m53-vh30-stock">M53 VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m53s-vh30-stock">M53S VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m53s-vj40-stock">M53S VJ40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m53s_1-vj30-stock">M53S+ VJ30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m53s_1_1-vk10-stock">M53S++ VK10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m56-vh30-stock">M56 VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m56s-vh30-stock">M56S VH30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m56s_1-vj30-stock">M56S+ VJ30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M5X#m59-vh30-stock">M59 VH30 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>M6X Series:</summary>
-                <ul>
-                    <li><a href="../whatsminer/M6X#m60-vk10-stock">M60 VK10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m60-vk20-stock">M60 VK20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m60-vk30-stock">M60 VK30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m60-vk40-stock">M60 VK40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m60s-vk10-stock">M60S VK10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m60s-vk20-stock">M60S VK20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m60s-vk30-stock">M60S VK30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m60s-vk40-stock">M60S VK40 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m63-vk10-stock">M63 VK10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m63-vk20-stock">M63 VK20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m63-vk30-stock">M63 VK30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m63s-vk10-stock">M63S VK10 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m63s-vk20-stock">M63S VK20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m63s-vk30-stock">M63S VK30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m66-vk20-stock">M66 VK20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m66-vk30-stock">M66 VK30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m66s-vk20-stock">M66S VK20 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m66s-vk30-stock">M66S VK30 (Stock)</a></li>
-                    <li><a href="../whatsminer/M6X#m66s-vk40-stock">M66S VK40 (Stock)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
-<details>
-<summary>Stock Firmware Avalonminers:</summary>
-    <ul>
-        <details>
-            <summary>A7X Series:</summary>
-                <ul>
-                    <li><a href="../avalonminer/A7X#avalon-721-stock">Avalon 721 (Stock)</a></li>
-                    <li><a href="../avalonminer/A7X#avalon-741-stock">Avalon 741 (Stock)</a></li>
-                    <li><a href="../avalonminer/A7X#avalon-761-stock">Avalon 761 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>A8X Series:</summary>
-                <ul>
-                    <li><a href="../avalonminer/A8X#avalon-821-stock">Avalon 821 (Stock)</a></li>
-                    <li><a href="../avalonminer/A8X#avalon-841-stock">Avalon 841 (Stock)</a></li>
-                    <li><a href="../avalonminer/A8X#avalon-851-stock">Avalon 851 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>A9X Series:</summary>
-                <ul>
-                    <li><a href="../avalonminer/A9X#avalon-921-stock">Avalon 921 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>A10X Series:</summary>
-                <ul>
-                    <li><a href="../avalonminer/A10X#avalon-1026-stock">Avalon 1026 (Stock)</a></li>
-                    <li><a href="../avalonminer/A10X#avalon-1047-stock">Avalon 1047 (Stock)</a></li>
-                    <li><a href="../avalonminer/A10X#avalon-1066-stock">Avalon 1066 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>A11X Series:</summary>
-                <ul>
-                    <li><a href="../avalonminer/A11X#avalon-1166-pro-stock">Avalon 1166 Pro (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>A12X Series:</summary>
-                <ul>
-                    <li><a href="../avalonminer/A12X#avalon-1246-stock">Avalon 1246 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>nano Series:</summary>
-                <ul>
-                    <li><a href="../avalonminer/nano#avalon-nano-3-stock">Avalon Nano 3 (Stock)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
-<details>
-<summary>Stock Firmware Innosilicons:</summary>
-    <ul>
-        <details>
-            <summary>T3X Series:</summary>
-                <ul>
-                    <li><a href="../innosilicon/T3X#t3h_1-stock">T3H+ (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>A10X Series:</summary>
-                <ul>
-                    <li><a href="../innosilicon/A10X#a10x-stock">A10X (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>A11X Series:</summary>
-                <ul>
-                    <li><a href="../innosilicon/A11X#a11-stock">A11 (Stock)</a></li>
-                    <li><a href="../innosilicon/A11X#a11mx-stock">A11MX (Stock)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
-<details>
-<summary>Stock Firmware Goldshells:</summary>
-    <ul>
-        <details>
-            <summary>X5 Series:</summary>
-                <ul>
-                    <li><a href="../goldshell/X5#ck5-stock">CK5 (Stock)</a></li>
-                    <li><a href="../goldshell/X5#hs5-stock">HS5 (Stock)</a></li>
-                    <li><a href="../goldshell/X5#kd5-stock">KD5 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>XMax Series:</summary>
-                <ul>
-                    <li><a href="../goldshell/XMax#kd-max-stock">KD Max (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>XBox Series:</summary>
-                <ul>
-                    <li><a href="../goldshell/XBox#kd-box-ii-stock">KD Box II (Stock)</a></li>
-                    <li><a href="../goldshell/XBox#kd-box-pro-stock">KD Box Pro (Stock)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
-<details>
-<summary>BOS+ Firmware Miners:</summary>
-    <ul>
-        <details>
-            <summary>X9 Series:</summary>
-                <ul>
-                    <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_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_1">S19 (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19_1-bos_1">S19+ (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19-pro-bos_1">S19 Pro (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19a-bos_1">S19a (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19a-pro-bos_1">S19a Pro (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19j-bos_1">S19j (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19j-no-pic-bos_1">S19j No PIC (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19j-pro-bos_1">S19j Pro (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19j-pro-no-pic-bos_1">S19j Pro No PIC (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19j-pro_1-bos_1">S19j Pro+ (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19j-pro_1-bos_1">S19j Pro+ (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19j-pro_1-no-pic-bos_1">S19j Pro+ No PIC (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19k-pro-no-pic-bos_1">S19k Pro No PIC (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19k-pro-no-pic-bos_1">S19k Pro No PIC (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19-xp-bos_1">S19 XP (BOS+)</a></li>
-                    <li><a href="../antminer/X19#s19-pro_1-hydro-bos_1">S19 Pro+ Hydro (BOS+)</a></li>
-                    <li><a href="../antminer/X19#t19-bos_1">T19 (BOS+)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X21 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X21#s21-bos_1">S21 (BOS+)</a></li>
-                    <li><a href="../antminer/X21#t21-bos_1">T21 (BOS+)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
-<details>
-<summary>Vnish Firmware Miners:</summary>
-    <ul>
-        <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>
-            <summary>X17 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X17#s17_1-vnish">S17+ (VNish)</a></li>
-                    <li><a href="../antminer/X17#s17-pro-vnish">S17 Pro (VNish)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X19 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X19#s19-vnish">S19 (VNish)</a></li>
-                    <li><a href="../antminer/X19#s19-no-pic-vnish">S19 No PIC (VNish)</a></li>
-                    <li><a href="../antminer/X19#s19-pro-vnish">S19 Pro (VNish)</a></li>
-                    <li><a href="../antminer/X19#s19j-vnish">S19j (VNish)</a></li>
-                    <li><a href="../antminer/X19#s19j-pro-vnish">S19j Pro (VNish)</a></li>
-                    <li><a href="../antminer/X19#s19j-pro-vnish">S19j Pro (VNish)</a></li>
-                    <li><a href="../antminer/X19#s19a-vnish">S19a (VNish)</a></li>
-                    <li><a href="../antminer/X19#s19a-pro-vnish">S19a Pro (VNish)</a></li>
-                    <li><a href="../antminer/X19#s19-pro-hydro-vnish">S19 Pro Hydro (VNish)</a></li>
-                    <li><a href="../antminer/X19#t19-vnish">T19 (VNish)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X21 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X21#s21-vnish">S21 (VNish)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
-<details>
-<summary>ePIC Firmware Miners:</summary>
-    <ul>
-        <details>
-            <summary>X19 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X19#s19-epic">S19 (ePIC)</a></li>
-                    <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#s21-pro-epic">S21 Pro (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>
-<summary>HiveOS Firmware Miners:</summary>
-    <ul>
-        <details>
-            <summary>X9 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X9#t9-stock">T9 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>X19 Series:</summary>
-                <ul>
-                    <li><a href="../antminer/X19#s19j-pro-stock">S19j Pro (Stock)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
-<details>
-<summary>LuxOS Firmware Miners:</summary>
-    <ul>
-        <details>
-            <summary>X9 Series:</summary>
-                <ul>
-                    <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-stock">AT1500 (Stock)</a></li>
-                    <li><a href="../auradine/AD#at2860-stock">AT2860 (Stock)</a></li>
-                    <li><a href="../auradine/AD#at2880-stock">AT2880 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>AI Series:</summary>
-                <ul>
-                    <li><a href="../auradine/AI#ai2500-stock">AI2500 (Stock)</a></li>
-                    <li><a href="../auradine/AI#ai3680-stock">AI3680 (Stock)</a></li>
-                </ul>
-        </details>
-        <details>
-            <summary>AT Series:</summary>
-                <ul>
-                    <li><a href="../auradine/AT#ad2500-stock">AD2500 (Stock)</a></li>
-                    <li><a href="../auradine/AT#ad3500-stock">AD3500 (Stock)</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>
-<details>
-<summary>Stock Firmware BitAxe Miners:</summary>
-    <ul>
-        <details>
-            <summary>BM Series:</summary>
-                <ul>
-                    <li><a href="../bitaxe/BM#supra-stock">Supra (Stock)</a></li>
-                    <li><a href="../bitaxe/BM#ultra-stock">Ultra (Stock)</a></li>
-                    <li><a href="../bitaxe/BM#max-stock">Max (Stock)</a></li>
-                    <li><a href="../bitaxe/BM#gamma-stock">Gamma (Stock)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
-<details>
-<summary>Stock Firmware IceRiver Miners:</summary>
-    <ul>
-        <details>
-            <summary>KSX Series:</summary>
-                <ul>
-                    <li><a href="../iceriver/KSX#ks0-stock">KS0 (Stock)</a></li>
-                    <li><a href="../iceriver/KSX#ks1-stock">KS1 (Stock)</a></li>
-                    <li><a href="../iceriver/KSX#ks2-stock">KS2 (Stock)</a></li>
-                    <li><a href="../iceriver/KSX#ks3-stock">KS3 (Stock)</a></li>
-                    <li><a href="../iceriver/KSX#ks3l-stock">KS3L (Stock)</a></li>
-                    <li><a href="../iceriver/KSX#ks3m-stock">KS3M (Stock)</a></li>
-                    <li><a href="../iceriver/KSX#ks5-stock">KS5 (Stock)</a></li>
-                    <li><a href="../iceriver/KSX#ks5l-stock">KS5L (Stock)</a></li>
-                    <li><a href="../iceriver/KSX#ks5m-stock">KS5M (Stock)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
-<details>
-<summary>Stock Firmware Hammer Miners:</summary>
-    <ul>
-        <details>
-            <summary>DX Series:</summary>
-                <ul>
-                    <li><a href="../hammer/DX#d10-stock">D10 (Stock)</a></li>
-                </ul>
-        </details>
-    </ul>
-</details>
+* Braiins OS+ Devices:
+    * All devices supported by BraiinsOS+ are supported here.
+* Stock Firmware Whatsminers:
+    * M3X Series:
+        * [M30S][pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30S]:
+            * [VE10][pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SVE10]
+            * [VG20][pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SVG20]
+            * [VE20][pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SVE20]
+            * [V50][pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SV50]
+        * [M30S+][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlus]:
+            * [VF20][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlusVF20]
+            * [VE40][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlusVE40]
+            * [VG60][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlusVG60]
+        * [M30S++][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus_Plus.BTMinerM30SPlusPlus]:
+            * [VG30][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus_Plus.BTMinerM30SPlusPlusVG30]
+            * [VG40][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus_Plus.BTMinerM30SPlusPlusVG40]
+        * [M31S][pyasic.miners.whatsminer.btminer.M3X.M31S.BTMinerM31S]
+        * [M31S+][pyasic.miners.whatsminer.btminer.M3X.M31S_Plus.BTMinerM31SPlus]:
+            * [VE20][pyasic.miners.whatsminer.btminer.M3X.M31S_Plus.BTMinerM31SPlusVE20]
+        * [M32S][pyasic.miners.whatsminer.btminer.M3X.M32S.BTMinerM32S]
+    * M2X Series:
+        * [M20][pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20]:
+            * [V10][pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20V10]
+        * [M20S][pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20S]:
+            * [V10][pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV10]
+            * [V20][pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV20]
+        * [M20S+][pyasic.miners.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlus]
+        * [M21][pyasic.miners.whatsminer.btminer.M2X.M21.BTMinerM21]
+        * [M21S][pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21S]:
+            * [V20][pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV20]
+            * [V60][pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV60]
+        * [M21S+][pyasic.miners.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlus]
+* Stock Firmware Antminers:
+    * X19 Series:
+        * [S19][pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19]
+        * [S19 Pro][pyasic.miners.antminer.bmminer.X19.S19_Pro.BMMinerS19Pro]
+        * [S19a][pyasic.miners.antminer.bmminer.X19.S19a.BMMinerS19a]
+        * [S19j][pyasic.miners.antminer.bmminer.X19.S19j.BMMinerS19j]
+        * [S19j Pro][pyasic.miners.antminer.bmminer.X19.S19j_Pro.BMMinerS19jPro]
+        * [T19][pyasic.miners.antminer.bmminer.X19.T19.BMMinerT19]
+    * X17 Series:
+        * [S17][pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17]
+        * [S17+][pyasic.miners.antminer.bmminer.X17.S17_Plus.BMMinerS17Plus]
+        * [S17 Pro][pyasic.miners.antminer.bmminer.X17.S17_Pro.BMMinerS17Pro]
+        * [S17e][pyasic.miners.antminer.bmminer.X17.S17e.BMMinerS17e]
+        * [T17][pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17]
+        * [T17+][pyasic.miners.antminer.bmminer.X17.T17_Plus.BMMinerT17Plus]
+        * [T17e][pyasic.miners.antminer.bmminer.X17.T17e.BMMinerT17e]
+    * X9 Series:
+        * [S9][pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9]
+        * [S9i][pyasic.miners.antminer.bmminer.X9.S9i.BMMinerS9i]
+        * [T9][pyasic.miners.antminer.bmminer.X9.T9.BMMinerT9]
+* Stock Firmware Avalonminers:
+    * A7X Series:
+        * [A721][pyasic.miners.avalonminer.cgminer.A7X.A721.CGMinerAvalon721]
+        * [A741][pyasic.miners.avalonminer.cgminer.A7X.A741.CGMinerAvalon741]
+        * [A761][pyasic.miners.avalonminer.cgminer.A7X.A761.CGMinerAvalon761]
+    * A8X Series:
+        * [A821][pyasic.miners.avalonminer.cgminer.A8X.A821.CGMinerAvalon821]
+        * [A841][pyasic.miners.avalonminer.cgminer.A8X.A841.CGMinerAvalon841]
+        * [A851][pyasic.miners.avalonminer.cgminer.A8X.A851.CGMinerAvalon851]
+    * A9X Series:
+        * [A921][pyasic.miners.avalonminer.cgminer.A9X.A921.CGMinerAvalon921]
+    * A10X Series:
+        * [A1026][pyasic.miners.avalonminer.cgminer.A10X.A1026.CGMinerAvalon1026]
+        * [A1047][pyasic.miners.avalonminer.cgminer.A10X.A1047.CGMinerAvalon1047]
+        * [A1066][pyasic.miners.avalonminer.cgminer.A10X.A1066.CGMinerAvalon1066]

docs/miners/whatsminer/M2X.md

@@ -1,94 +1,91 @@
 # pyasic
 ## M2X Models
 
-## M20 V10 (Stock)
+## M20
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M20V10
+
 ::: pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20V10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20S V10 (Stock)
+## M20S
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20S
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M20SV10
+
 ::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20S V20 (Stock)
+## M20SV20
+
 ::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20S V30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV30
+## M20S+
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20P V10 (Stock)
-::: pyasic.miners.whatsminer.btminer.M2X.M20P.BTMinerM20PV10
+## M21
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21.BTMinerM21
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20P V30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M2X.M20P.BTMinerM20PV30
+
+## M21S
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21S
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20S+ V30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlusV30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
+## M21SV20
 
-## M21 V10 (Stock)
-::: pyasic.miners.whatsminer.btminer.M2X.M21.BTMinerM21V10
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M21S V20 (Stock)
 ::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21S V60 (Stock)
+## M21SV60
+
 ::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV60
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21S V70 (Stock)
-::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV70
+## M21S+
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
-
-## M21S+ V20 (Stock)
-::: pyasic.miners.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlusV20
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M29 V10 (Stock)
-::: pyasic.miners.whatsminer.btminer.M2X.M29.BTMinerM29V10
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/whatsminer/M5X.md

@@ -1,269 +0,0 @@
-# pyasic
-## M5X Models
-
-## M50 VE30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VE30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VG30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VG30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VH10 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH10
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VH20 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH20
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VH30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VH40 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH40
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VH50 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH50
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VH60 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH60
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VH70 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH70
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VH80 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH80
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VH90 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH90
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VJ10 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ10
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VJ20 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ20
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50 VJ30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S VJ10 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ10
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S VJ20 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ20
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S VJ30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S VH10 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH10
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S VH20 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH20
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S VH30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S VH40 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH40
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S VH50 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH50
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S+ VH30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S+ VH40 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH40
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S+ VJ30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVJ30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S+ VK20 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVK20
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S++ VK10 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus_Plus.BTMinerM50SPlusPlusVK10
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S++ VK20 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus_Plus.BTMinerM50SPlusPlusVK20
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M50S++ VK30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus_Plus.BTMinerM50SPlusPlusVK30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M53 VH30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M53.BTMinerM53VH30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M53S VH30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M53S.BTMinerM53SVH30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M53S VJ40 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M53S.BTMinerM53SVJ40
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M53S+ VJ30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M53S_Plus.BTMinerM53SPlusVJ30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M53S++ VK10 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M53S_Plus_Plus.BTMinerM53SPlusPlusVK10
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M56 VH30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M56.BTMinerM56VH30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M56S VH30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M56S.BTMinerM56SVH30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M56S+ VJ30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M56S_Plus.BTMinerM56SPlusVJ30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## M59 VH30 (Stock)
-::: pyasic.miners.whatsminer.btminer.M5X.M59.BTMinerM59VH30
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-

docs/miners/whatsminer/M6X.md

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

docs/network/miner_network_range.md

@@ -0,0 +1,12 @@
+# pyasic
+## Miner Network Range
+
+[`MinerNetworkRange`][pyasic.network.net_range.MinerNetworkRange] is a class used by [`MinerNetwork`][pyasic.network.MinerNetwork] to handle any constructor stings.
+The goal is to emulate what is produced by `ipaddress.ip_network` by allowing [`MinerNetwork`][pyasic.network.MinerNetwork] to get a list of hosts.
+This allows this class to be the [`MinerNetwork.network`][pyasic.network.MinerNetwork] and hence be used for scanning.
+
+::: pyasic.network.net_range.MinerNetworkRange
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/requirements.txt

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

docs/rpc/api.md

@@ -1,27 +0,0 @@
-# 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

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

docs/rpc/bosminer.md

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

docs/rpc/btminer.md

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

docs/rpc/cgminer.md

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

docs/rpc/luxminer.md

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

docs/settings/settings.md

@@ -1,41 +0,0 @@
-# pyasic
-## settings
-
-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`
-- `factory_get_retries`
-- `factory_get_timeout`
-- `get_data_retries`
-- `api_function_timeout`
-- `antminer_mining_mode_as_str`
-- `default_whatsminer_rpc_password`
-- `default_innosilicon_web_password`
-- `default_antminer_web_password`
-- `default_bosminer_web_password`
-- `default_vnish_web_password`
-- `default_goldshell_web_password`
-- `default_auradine_web_password`
-- `default_epic_web_password`
-- `default_hive_web_password`
-- `default_antminer_ssh_password`
-- `default_bosminer_ssh_password`
-
-
-### get
-::: pyasic.settings.get
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-### update
-::: pyasic.settings.update
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4

docs/web/antminer.md

@@ -1,14 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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

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

docs/web/goldshell.md

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

docs/web/innosilicon.md

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

mkdocs.yml

@@ -1,111 +1,47 @@
 site_name: pyasic
 repo_url: https://github.com/UpstreamData/pyasic
-site_url: !ENV SITE_URL
-theme:
-  name: material
-  features:
-    - content.code.copy
-    - content.code.annotate
-  palette:
-    - media: "(prefers-color-scheme)"
-      toggle:
-        icon: material/brightness-auto
-        name: Switch to light mode
-    - media: "(prefers-color-scheme: light)"
-      scheme: default
-      toggle:
-        icon: material/weather-night
-        name: Switch to dark mode
-    - media: "(prefers-color-scheme: dark)"
-      scheme: slate
-      toggle:
-        icon: material/weather-sunny
-        name: Switch to auto mode
-markdown_extensions:
-  - pymdownx.highlight:
-      anchor_linenums: true
-      line_spans: __span
-      pygments_lang_class: true
-  - pymdownx.inlinehilite
-  - pymdownx.snippets
-  - pymdownx.superfences
 nav:
-- Introduction: "index.md"
-- Miners:
-    - Supported Miners: "miners/supported_types.md"
-    - Standard Functionality: "miners/functions.md"
-    - Miner Factory: "miners/miner_factory.md"
-- Network:
-    - Miner Network: "network/miner_network.md"
-- Dataclasses:
-    - Miner Data: "data/miner_data.md"
-    - Error Codes: "data/error_codes.md"
-    - Miner Config: "config/miner_config.md"
-- Advanced:
-    - 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"
-        - BFGMiner: "miners/backends/bfgminer.md"
-        - BTMiner: "miners/backends/btminer.md"
-        - CGMiner: "miners/backends/cgminer.md"
-        - LUXMiner: "miners/backends/luxminer.md"
-        - VNish: "miners/backends/vnish.md"
-        - ePIC: "miners/backends/epic.md"
-        - Hiveon: "miners/backends/hiveon.md"
-    - Classes:
-        - Antminer X3: "miners/antminer/X3.md"
-        - Antminer X5: "miners/antminer/X5.md"
-        - Antminer X7: "miners/antminer/X7.md"
-        - Antminer X9: "miners/antminer/X9.md"
-        - Antminer X15: "miners/antminer/X15.md"
-        - Antminer X17: "miners/antminer/X17.md"
-        - Antminer X19: "miners/antminer/X19.md"
-        - Antminer X21: "miners/antminer/X21.md"
-        - Avalon Nano: "miners/avalonminer/nano.md"
-        - Avalon 7X: "miners/avalonminer/A7X.md"
-        - Avalon 8X: "miners/avalonminer/A8X.md"
-        - Avalon 9X: "miners/avalonminer/A9X.md"
-        - Avalon 10X: "miners/avalonminer/A10X.md"
-        - Avalon 11X: "miners/avalonminer/A11X.md"
-        - Avalon 12X: "miners/avalonminer/A12X.md"
-        - 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"
-        - Innosilicon A11X: "miners/innosilicon/A11X.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"
-        - Blockminer: "miners/blockminer/blockminer.md"
-        - BitAxe BM: "miners/bitaxe/BM.md"
-        - Hammer DX: "miners/hammer/DX.md"
-        - Iceriver KSX: "miners/iceriver/KSX.md"
-    - Base Miner: "miners/base_miner.md"
-- Settings:
-      - Settings: "settings/settings.md"
+  - Introduction: "index.md"
+  - Miners:
+      - Supported Miners: "miners/supported_types.md"
+      - Miner Factory: "miners/miner_factory.md"
+      - Backends:
+          - BMMiner: "miners/backends/bmminer.md"
+          - BOSMiner: "miners/backends/bosminer.md"
+          - BTMiner: "miners/backends/btminer.md"
+          - CGMiner: "miners/backends/cgminer.md"
+          - Hiveon: "miners/backends/hiveon.md"
+
+      - Classes:
+          - Antminer X9: "miners/antminer/X9.md"
+          - Antminer X17: "miners/antminer/X17.md"
+          - Antminer X19: "miners/antminer/X19.md"
+          - Avalon 7X: "miners/avalonminer/A7X.md"
+          - Avalon 8X: "miners/avalonminer/A8X.md"
+          - Avalon 9X: "miners/avalonminer/A9X.md"
+          - Avalon 10X: "miners/avalonminer/A10X.md"
+          - Whatsminer M2X: "miners/whatsminer/M2X.md"
+          - Whatsminer M3X: "miners/whatsminer/M3X.md"
+
+  - Network:
+      - Miner Network: "network/miner_network.md"
+      - Miner Network Range: "network/miner_network_range.md"
+  - Data:
+      - Miner Data: "data/miner_data.md"
+      - Error Codes: "data/error_codes.md"
+  - Config:
+      - Miner Config: "config/miner_config.md"
+  - Advanced:
+      - Miner APIs:
+          - Intro: "API/api.md"
+          - BMMiner: "API/bmminer.md"
+          - BOSMiner: "API/bosminer.md"
+          - BTMiner: "API/btminer.md"
+          - CGMiner: "API/cgminer.md"
+          - Unknown: "API/unknown.md"
+
+      - Base Miner: "miners/base_miner.md"
+
 
 plugins:
   - mkdocstrings

pyasic/API/__init__.py

@@ -0,0 +1,260 @@
+#  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 json
+import ipaddress
+import warnings
+import logging
+from typing import Union
+
+
+class APIError(Exception):
+    def __init__(self, *args):
+        if args:
+            self.message = args[0]
+        else:
+            self.message = None
+
+    def __str__(self):
+        if self.message:
+            return f"{self.message}"
+        else:
+            return "Incorrect API parameters."
+
+
+class APIWarning(Warning):
+    def __init__(self, *args):
+        if args:
+            self.message = args[0]
+        else:
+            self.message = None
+
+    def __str__(self):
+        if self.message:
+            return f"{self.message}"
+        else:
+            return "Incorrect API parameters."
+
+
+class BaseMinerAPI:
+    def __init__(self, ip: str, port: int = 4028) -> None:
+        # api port, should be 4028
+        self.port = port
+        # ip address of the miner
+        self.ip = ipaddress.ip_address(ip)
+
+    def __new__(cls, *args, **kwargs):
+        if cls is BaseMinerAPI:
+            raise TypeError(f"Only children of '{cls.__name__}' may be instantiated")
+        return object.__new__(cls)
+
+    def get_commands(self) -> list:
+        """Get a list of command accessible to a specific type of API on the miner.
+
+        Returns:
+            A list of all API commands that the miner supports.
+        """
+        return [
+            func
+            for func in
+            # each function in self
+            dir(self)
+            if callable(getattr(self, func)) and
+            # no __ methods
+            not func.startswith("__") and
+            # remove all functions that are in this base class
+            func
+            not in [
+                func
+                for func in dir(BaseMinerAPI)
+                if callable(getattr(BaseMinerAPI, func))
+            ]
+        ]
+
+    def _check_commands(self, *commands):
+        allowed_commands = self.get_commands()
+        return_commands = []
+        for command in [*commands]:
+            if command in allowed_commands:
+                return_commands.append(command)
+            else:
+                warnings.warn(
+                    f"""Removing incorrect command: {command}
+If you are sure you want to use this command please use API.send_command("{command}", ignore_errors=True) instead.""",
+                    APIWarning,
+                )
+        return return_commands
+
+    async def multicommand(
+        self, *commands: str, ignore_x19_error: bool = False
+    ) -> dict:
+        """Creates and sends multiple commands as one command to the miner.
+
+        Parameters:
+            *commands: The commands to send as a multicommand to the miner.
+            ignore_x19_error: Whether or not to ignore errors raised by x19 miners when using the "+" delimited style.
+        """
+        logging.debug(f"{self.ip}: Sending multicommand: {[*commands]}")
+        # make sure we can actually run each command, otherwise they will fail
+        commands = self._check_commands(*commands)
+        # standard multicommand format is "command1+command2"
+        # doesnt work for S19 which uses the backup _x19_multicommand
+        command = "+".join(commands)
+        try:
+            data = await self.send_command(command, x19_command=ignore_x19_error)
+        except APIError:
+            logging.debug(f"{self.ip}: Handling X19 multicommand.")
+            data = await self._x19_multicommand(*command.split("+"))
+        logging.debug(f"{self.ip}: Received multicommand data.")
+        return data
+
+    async def _x19_multicommand(self, *commands):
+        data = None
+        try:
+            data = {}
+            # send all commands individually
+            for cmd in commands:
+                data[cmd] = []
+                data[cmd].append(await self.send_command(cmd, x19_command=True))
+        except APIError as e:
+            raise APIError(e)
+        except Exception as e:
+            logging.warning(f"{self.ip}: API Multicommand Error: {e}")
+        return data
+
+    async def send_command(
+        self,
+        command: Union[str, bytes],
+        parameters: Union[str, int, bool] = None,
+        ignore_errors: bool = False,
+        x19_command: bool = False,
+    ) -> dict:
+        """Send an API command to the miner and return the result.
+
+        Parameters:
+            command: The command to sent to the miner.
+            parameters: Any additional parameters to be sent with the command.
+            ignore_errors: Whether or not to raise APIError when the command returns an error.
+            x19_command: Whether this is a command for an x19 that may be an issue (such as a "+" delimited multicommand)
+
+        Returns:
+            The return data from the API command parsed from JSON into a dict.
+        """
+        try:
+            # get reader and writer streams
+            reader, writer = await asyncio.open_connection(str(self.ip), self.port)
+        # handle OSError 121
+        except OSError as e:
+            if e.winerror == "121":
+                logging.warning("Semaphore Timeout has Expired.")
+            return {}
+
+        # create the command
+        cmd = {"command": command}
+        if parameters:
+            cmd["parameter"] = parameters
+
+        # send the command
+        writer.write(json.dumps(cmd).encode("utf-8"))
+        await writer.drain()
+
+        # instantiate data
+        data = b""
+
+        # loop to receive all the data
+        try:
+            while True:
+                d = await reader.read(4096)
+                if not d:
+                    break
+                data += d
+        except Exception as e:
+            logging.warning(f"{self.ip}: API Command Error: - {e}")
+
+        data = self._load_api_data(data)
+
+        # close the connection
+        writer.close()
+        await writer.wait_closed()
+
+        # check for if the user wants to allow errors to return
+        if not ignore_errors:
+            # validate the command succeeded
+            validation = self._validate_command_output(data)
+            if not validation[0]:
+                if not x19_command:
+                    logging.warning(f"{self.ip}: API Command Error: {validation[1]}")
+                raise APIError(validation[1])
+
+        return data
+
+    @staticmethod
+    def _validate_command_output(data: dict) -> tuple:
+        # check if the data returned is correct or an error
+        # if status isn't a key, it is a multicommand
+        if "STATUS" not in data.keys():
+            for key in data.keys():
+                # make sure not to try to turn id into a dict
+                if not key == "id":
+                    # make sure they succeeded
+                    if "STATUS" in data[key][0].keys():
+                        if data[key][0]["STATUS"][0]["STATUS"] not in ["S", "I"]:
+                            # this is an error
+                            return False, f"{key}: " + data[key][0]["STATUS"][0]["Msg"]
+        elif "id" not in data.keys():
+            if data["STATUS"] not in ["S", "I"]:
+                return False, data["Msg"]
+        else:
+            # make sure the command succeeded
+            if type(data["STATUS"]) == str:
+                if data["STATUS"] in ["RESTART"]:
+                    return True, None
+            elif data["STATUS"][0]["STATUS"] not in ("S", "I"):
+                # this is an error
+                if data["STATUS"][0]["STATUS"] not in ("S", "I"):
+                    return False, data["STATUS"][0]["Msg"]
+        return True, None
+
+    @staticmethod
+    def _load_api_data(data: bytes) -> dict:
+        str_data = None
+        try:
+            # some json from the API returns with a null byte (\x00) on the end
+            if data.endswith(b"\x00"):
+                # handle the null byte
+                str_data = data.decode("utf-8")[:-1]
+            else:
+                # no null byte
+                str_data = data.decode("utf-8")
+            # fix an error with a btminer return having an extra comma that breaks json.loads()
+            str_data = str_data.replace(",}", "}")
+            # fix an error with a btminer return having a newline that breaks json.loads()
+            str_data = str_data.replace("\n", "")
+            # fix an error with a bmminer return not having a specific comma that breaks json.loads()
+            str_data = str_data.replace("}{", "},{")
+            # fix an error with a bmminer return  having a specific comma that breaks json.loads()
+            str_data = str_data.replace("[,{", "[{")
+            # fix an error with Avalonminers returning inf and nan
+            str_data = str_data.replace("inf", "0")
+            str_data = str_data.replace("nan", "0")
+            # fix whatever this garbage from avalonminers is `,"id":1}`
+            if str_data.startswith(","):
+                str_data = f"{{{str_data[1:]}"
+            # parse the json
+            parsed_data = json.loads(str_data)
+        # handle bad json
+        except json.decoder.JSONDecodeError as e:
+            raise APIError(f"Decode Error {e}: {str_data}")
+        return parsed_data

pyasic/API/bmminer.py

@@ -0,0 +1,694 @@
+#  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.API import 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, port: int = 4028) -> None:
+        super().__init__(ip, port)
+
+    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/API/bosminer.py

@@ -1,23 +1,21 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
 
-from pyasic.rpc.base import BaseMinerRPCAPI
+from pyasic.API import BaseMinerAPI
 
 
-class BOSMinerRPCAPI(BaseMinerRPCAPI):
+class BOSMinerAPI(BaseMinerAPI):
     """An abstraction of the BOSMiner API.
 
     Each method corresponds to an API command in BOSMiner.
@@ -29,8 +27,15 @@ class BOSMinerRPCAPI(BaseMinerRPCAPI):
     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, port: int = 4028):
+        super().__init__(ip, port)
+
     async def asccount(self) -> dict:
         """Get data on the number of ASC devices and their info.
         <details>
@@ -161,7 +166,7 @@ class BOSMinerRPCAPI(BaseMinerRPCAPI):
             return await self.send_command("estats")
 
     async def check(self, command: str) -> dict:
-        """Check if the command `command` exists in BOSMiner.
+        """Check if the command command exists in BOSMiner.
         <details>
             <summary>Expand</summary>
 

pyasic/API/cgminer.py

@@ -1,23 +1,21 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
 
-from pyasic.rpc.base import BaseMinerRPCAPI
+from pyasic.API import BaseMinerAPI
 
 
-class CGMinerRPCAPI(BaseMinerRPCAPI):
+class CGMinerAPI(BaseMinerAPI):
     """An abstraction of the CGMiner API.
 
     Each method corresponds to an API command in GGMiner.
@@ -29,8 +27,15 @@ class CGMinerRPCAPI(BaseMinerRPCAPI):
     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, port: int = 4028):
+        super().__init__(ip, port)
+
     async def version(self) -> dict:
         """Get miner version info.
         <details>
@@ -519,8 +524,7 @@ class CGMinerRPCAPI(BaseMinerRPCAPI):
             <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.
+            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.
 
 

pyasic/API/unknown.py

@@ -1,30 +1,73 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
 
-from pyasic.rpc.cgminer import CGMinerRPCAPI
+from pyasic.API import BaseMinerAPI
 
 
-class UnknownRPCAPI(CGMinerRPCAPI):
+class UnknownAPI(BaseMinerAPI):
     """An abstraction of an API for a miner which is unknown.
 
-    This class is designed to try to be an intersection of as many miner APIs
+    This class is designed to try to be a intersection of as many miner APIs
     and API commands as possible (API ⋂ API), to ensure that it can be used
     with as many APIs as possible.
     """
 
+    def __init__(self, ip, port=4028):
+        super().__init__(ip, port)
+
+    async def asccount(self) -> dict:
+        return await self.send_command("asccount")
+
+    async def asc(self, n: int) -> dict:
+        return await self.send_command("asc", parameters=n)
+
+    async def devdetails(self) -> dict:
+        return await self.send_command("devdetails")
+
+    async def devs(self) -> dict:
+        return await self.send_command("devs")
+
+    async def edevs(self, old: bool = False) -> dict:
+        if old:
+            return await self.send_command("edevs", parameters="old")
+        else:
+            return await self.send_command("edevs")
+
+    async def pools(self) -> dict:
+        return await self.send_command("pools")
+
+    async def summary(self) -> dict:
+        return await self.send_command("summary")
+
+    async def stats(self) -> dict:
+        return await self.send_command("stats")
+
+    async def version(self) -> dict:
+        return await self.send_command("version")
+
+    async def estats(self) -> dict:
+        return await self.send_command("estats")
+
+    async def check(self) -> dict:
+        return await self.send_command("check")
+
+    async def coin(self) -> dict:
+        return await self.send_command("coin")
+
+    async def lcd(self) -> dict:
+        return await self.send_command("lcd")
+
     async def switchpool(self, n: int) -> dict:
         # BOS has not implemented this yet, they will in the future
         raise NotImplementedError

pyasic/__init__.py

@@ -1,24 +1,13 @@
-# ------------------------------------------------------------------------------
-#  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 import settings
-from pyasic.config import MinerConfig
-from pyasic.data import MinerData
-from pyasic.errors import APIError, APIWarning
-from pyasic.miners import *
-from pyasic.network import MinerNetwork
-from pyasic.rpc import *
-from pyasic.ssh import *
-from pyasic.web import *
+#  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.

pyasic/config/__init__.py

@@ -1,305 +1,453 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
 
-from pydantic import BaseModel, Field
+from dataclasses import dataclass, asdict
+from typing import Literal, List
+import random
+import string
 
-from pyasic.config.fans import FanMode, FanModeConfig, FanModeNormal
-from pyasic.config.mining import MiningMode, MiningModeConfig
-from pyasic.config.mining.scaling import ScalingConfig
-from pyasic.config.pools import PoolConfig
-from pyasic.config.temperature import TemperatureConfig
-from pyasic.misc import merge_dicts
+import toml
+import yaml
+import json
+import time
 
 
-class MinerConfig(BaseModel):
-    """Represents the configuration for a miner including pool configuration,
-    fan mode, temperature settings, mining mode, and power scaling."""
+@dataclass
+class _Pool:
+    """A dataclass for pool information.
 
-    class Config:
-        arbitrary_types_allowed = True
+    Attributes:
+        url: URL of the pool.
+        username: Username on the pool.
+        password: Worker password on the pool.
+    """
 
-    pools: PoolConfig = Field(default_factory=PoolConfig.default)
-    fan_mode: FanMode = Field(default_factory=FanModeConfig.default)
-    temperature: TemperatureConfig = Field(default_factory=TemperatureConfig.default)
-    mining_mode: MiningMode = Field(default_factory=MiningModeConfig.default)
+    url: str = ""
+    username: str = ""
+    password: str = ""
 
-    def __getitem__(self, item):
-        try:
-            return getattr(self, item)
-        except AttributeError:
-            raise KeyError
+    def from_dict(self, data: dict):
+        """Convert raw pool data as a dict to usable data and save it to this class.
 
-    def as_dict(self) -> dict:
-        """Converts the MinerConfig object to a dictionary."""
-        return self.model_dump()
-
-    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",
-            **self.mining_mode.as_am_modern(),
-            **self.pools.as_am_modern(user_suffix=user_suffix),
-            **self.temperature.as_am_modern(),
-        }
+        Parameters:
+             data: The raw config data to convert.
+        """
+        for key in data.keys():
+            if key == "url":
+                self.url = data[key]
+            if key in ["user", "username"]:
+                self.username = data[key]
+            if key in ["pass", "password"]:
+                self.password = data[key]
+        return self
 
     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(),
-            **self.pools.as_wm(user_suffix=user_suffix),
-            **self.temperature.as_wm(),
+        """Convert the data in this class to a dict usable by an Whatsminer device.
+
+        Parameters:
+             user_suffix: The suffix to append to username.
+        """
+        username = self.username
+        if user_suffix:
+            username = f"{username}{user_suffix}"
+
+        pool = {"url": self.url, "user": username, "pass": self.password}
+        return pool
+
+    def as_x19(self, user_suffix: str = None) -> dict:
+        """Convert the data in this class to a dict usable by an X19 device.
+
+        Parameters:
+             user_suffix: The suffix to append to username.
+        """
+        username = self.username
+        if user_suffix:
+            username = f"{username}{user_suffix}"
+
+        pool = {"url": self.url, "user": username, "pass": self.password}
+        return pool
+
+    def as_avalon(self, user_suffix: str = None) -> str:
+        """Convert the data in this class to a string usable by an Avalonminer device.
+
+        Parameters:
+             user_suffix: The suffix to append to username.
+        """
+        username = self.username
+        if user_suffix:
+            username = f"{username}{user_suffix}"
+
+        pool = ",".join([self.url, username, self.password])
+        return pool
+
+    def as_bos(self, user_suffix: str = None) -> dict:
+        """Convert the data in this class to a dict usable by an BOSMiner device.
+
+        Parameters:
+            user_suffix: The suffix to append to username.
+        """
+        username = self.username
+        if user_suffix:
+            username = f"{username}{user_suffix}"
+
+        pool = {"url": self.url, "user": username, "password": self.password}
+        return pool
+
+
+@dataclass
+class _PoolGroup:
+    """A dataclass for pool group information.
+
+    Attributes:
+        quota: The group quota.
+        group_name: The name of the pool group.
+        pools: A list of pools in this group.
+    """
+
+    quota: int = 1
+    group_name: str = None
+    pools: List[_Pool] = None
+
+    def __post_init__(self):
+        if not self.group_name:
+            self.group_name = "".join(
+                random.choice(string.ascii_uppercase + string.digits) for _ in range(6)
+            )  # generate random pool group name in case it isn't set
+
+    def from_dict(self, data: dict):
+        """Convert raw pool group data as a dict to usable data and save it to this class.
+
+        Parameters:
+             data: The raw config data to convert.
+        """
+        pools = []
+        for key in data.keys():
+            if key in ["name", "group_name"]:
+                self.group_name = data[key]
+            if key == "quota":
+                self.quota = data[key]
+            if key in ["pools", "pool"]:
+                for pool in data[key]:
+                    pools.append(_Pool().from_dict(pool))
+        self.pools = pools
+        return self
+
+    def as_x19(self, user_suffix: str = None) -> List[dict]:
+        """Convert the data in this class to a list usable by an X19 device.
+
+        Parameters:
+             user_suffix: The suffix to append to username.
+        """
+        pools = []
+        for pool in self.pools[:3]:
+            pools.append(pool.as_x19(user_suffix=user_suffix))
+        return pools
+
+    def as_wm(self, user_suffix: str = None) -> List[dict]:
+        """Convert the data in this class to a list usable by an Whatsminer device.
+
+        Parameters:
+             user_suffix: The suffix to append to username.
+        """
+        pools = []
+        for pool in self.pools[:3]:
+            pools.append(pool.as_wm(user_suffix=user_suffix))
+        while len(pools) < 3:
+            pools.append({"url": None, "user": None, "pass": None})
+        return pools
+
+    def as_avalon(self, user_suffix: str = None) -> str:
+        """Convert the data in this class to a dict usable by an Avalonminer device.
+
+        Parameters:
+             user_suffix: The suffix to append to username.
+        """
+        pool = self.pools[0].as_avalon(user_suffix=user_suffix)
+        return pool
+
+    def as_bos(self, user_suffix: str = None) -> dict:
+        """Convert the data in this class to a dict usable by an BOSMiner device.
+
+        Parameters:
+             user_suffix: The suffix to append to username.
+        """
+        group = {
+            "name": self.group_name,
+            "quota": self.quota,
+            "pool": [pool.as_bos(user_suffix=user_suffix) for pool in self.pools],
+        }
+        return group
+
+
+@dataclass
+class MinerConfig:
+    """A dataclass for miner configuration information.
+
+    Attributes:
+        pool_groups: A list of pool groups in this config.
+        temp_mode: The temperature control mode.
+        temp_target: The target temp.
+        temp_hot: The hot temp (100% fans).
+        temp_dangerous: The dangerous temp (shutdown).
+        minimum_fans: The minimum numbers of fans to run the miner.
+        fan_speed: Manual fan speed to run the fan at (only if temp_mode == "manual").
+        asicboost: Whether or not to enable asicboost.
+        autotuning_enabled: Whether or not to enable autotuning.
+        autotuning_wattage: The wattage to use when autotuning.
+        dps_enabled: Whether or not to enable dynamic power scaling.
+        dps_power_step: The amount of power to reduce autotuning by when the miner reaches dangerous temp.
+        dps_min_power: The minimum power to reduce autotuning to.
+        dps_shutdown_enabled: Whether or not to shutdown the miner when `dps_min_power` is reached.
+        dps_shutdown_duration: The amount of time to shutdown for (in hours).
+    """
+
+    pool_groups: List[_PoolGroup] = None
+
+    temp_mode: Literal["auto", "manual", "disabled"] = "auto"
+    temp_target: float = 70.0
+    temp_hot: float = 80.0
+    temp_dangerous: float = 10.0
+
+    minimum_fans: int = None
+    fan_speed: Literal[tuple(range(101))] = None  # noqa - Ignore weird Literal usage
+
+    asicboost: bool = None
+
+    autotuning_enabled: bool = True
+    autotuning_wattage: int = 900
+
+    dps_enabled: bool = None
+    dps_power_step: int = None
+    dps_min_power: int = None
+    dps_shutdown_enabled: bool = None
+    dps_shutdown_duration: float = None
+
+    def as_dict(self) -> dict:
+        """Convert the data in this class to a dict."""
+        data_dict = asdict(self)
+        for key in asdict(self).keys():
+            if data_dict[key] is None:
+                del data_dict[key]
+        return data_dict
+
+    def as_toml(self) -> str:
+        """Convert the data in this class to toml."""
+        return toml.dumps(self.as_dict())
+
+    def as_yaml(self) -> str:
+        """Convert the data in this class to yaml."""
+        return yaml.dump(self.as_dict(), sort_keys=False)
+
+    def from_raw(self, data: dict):
+        """Convert raw config data as a dict to usable data and save it to this class.
+        This should be able to handle any raw config file from any miner supported by pyasic.
+
+        Parameters:
+             data: The raw config data to convert.
+        """
+        pool_groups = []
+        for key in data.keys():
+            if key == "pools":
+                pool_groups.append(_PoolGroup().from_dict({"pools": data[key]}))
+            elif key == "group":
+                for group in data[key]:
+                    pool_groups.append(_PoolGroup().from_dict(group))
+
+            if key == "bitmain-fan-ctrl":
+                if data[key]:
+                    self.temp_mode = "manual"
+                    if data.get("bitmain-fan-pwm"):
+                        self.fan_speed = int(data["bitmain-fan-pwm"])
+            elif key == "fan_control":
+                for _key in data[key].keys():
+                    if _key == "min_fans":
+                        self.minimum_fans = data[key][_key]
+                    elif _key == "speed":
+                        self.fan_speed = data[key][_key]
+            elif key == "temp_control":
+                for _key in data[key].keys():
+                    if _key == "mode":
+                        self.temp_mode = data[key][_key]
+                    elif _key == "target_temp":
+                        self.temp_target = data[key][_key]
+                    elif _key == "hot_temp":
+                        self.temp_hot = data[key][_key]
+                    elif _key == "dangerous_temp":
+                        self.temp_dangerous = data[key][_key]
+
+            if key == "hash_chain_global":
+                if data[key].get("asic_boost"):
+                    self.asicboost = data[key]["asic_boost"]
+
+            if key == "autotuning":
+                for _key in data[key].keys():
+                    if _key == "enabled":
+                        self.autotuning_enabled = data[key][_key]
+                    elif _key == "psu_power_limit":
+                        self.autotuning_wattage = data[key][_key]
+
+            if key == "power_scaling":
+                for _key in data[key].keys():
+                    if _key == "enabled":
+                        self.dps_enabled = data[key][_key]
+                    elif _key == "power_step":
+                        self.dps_power_step = data[key][_key]
+                    elif _key == "min_psu_power_limit":
+                        self.dps_min_power = data[key][_key]
+                    elif _key == "shutdown_enabled":
+                        self.dps_shutdown_enabled = data[key][_key]
+                    elif _key == "shutdown_duration":
+                        self.dps_shutdown_duration = data[key][_key]
+
+        self.pool_groups = pool_groups
+        return self
+
+    def from_api(self, pools: list):
+        _pools = []
+        for pool in pools:
+            url = pool.get("URL")
+            user = pool.get("User")
+            _pools.append({"url": url, "user": user, "pass": "123"})
+        self.pool_groups = [_PoolGroup().from_dict({"pools": _pools})]
+        return self
+
+    def from_dict(self, data: dict):
+        """Convert an output dict of this class back into usable data and save it to this class.
+
+        Parameters:
+            data: The dict config data to convert.
+        """
+        pool_groups = []
+        for group in data["pool_groups"]:
+            pool_groups.append(_PoolGroup().from_dict(group))
+        for key in data.keys():
+            if getattr(self, key) and not key == "pool_groups":
+                setattr(self, key, data[key])
+        self.pool_groups = pool_groups
+        return self
+
+    def from_toml(self, data: str):
+        """Convert output toml of this class back into usable data and save it to this class.
+
+        Parameters:
+            data: The toml config data to convert.
+        """
+        return self.from_dict(toml.loads(data))
+
+    def from_yaml(self, data: str):
+        """Convert output yaml of this class back into usable data and save it to this class.
+
+        Parameters:
+            data: The yaml config data to convert.
+        """
+        return self.from_dict(yaml.load(data, Loader=yaml.SafeLoader))
+
+    def as_wm(self, user_suffix: str = None) -> List[dict]:
+        """Convert the data in this class to a config usable by an Whatsminer device.
+
+        Parameters:
+            user_suffix: The suffix to append to username.
+        """
+        return self.pool_groups[0].as_x19(user_suffix=user_suffix)
+
+    def as_x19(self, user_suffix: str = None) -> str:
+        """Convert the data in this class to a config usable by an X19 device.
+
+        Parameters:
+            user_suffix: The suffix to append to username.
+        """
+        cfg = {
+            "pools": self.pool_groups[0].as_x19(user_suffix=user_suffix),
+            "bitmain-fan-ctrl": False,
+            "bitmain-fan-pwn": 100,
         }
 
-    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(),
-            **self.pools.as_am_old(user_suffix=user_suffix),
-            **self.temperature.as_am_old(),
+        if not self.temp_mode == "auto":
+            cfg["bitmain-fan-ctrl"] = True
+
+        if self.fan_speed:
+            cfg["bitmain-fan-ctrl"] = str(self.fan_speed)
+
+        return json.dumps(cfg)
+
+    def as_avalon(self, user_suffix: str = None) -> str:
+        """Convert the data in this class to a config usable by an Avalonminer device.
+
+        Parameters:
+            user_suffix: The suffix to append to username.
+        """
+        cfg = self.pool_groups[0].as_avalon(user_suffix=user_suffix)
+        return cfg
+
+    def as_bos(self, model: str = "S9", user_suffix: str = None) -> str:
+        """Convert the data in this class to a config usable by an BOSMiner device.
+
+        Parameters:
+            model: The model of the miner to be used in the format portion of the config.
+            user_suffix: The suffix to append to username.
+        """
+        cfg = {
+            "format": {
+                "version": "1.2+",
+                "model": f"Antminer {model}",
+                "generator": "Upstream Config Utility",
+                "timestamp": int(time.time()),
+            },
+            "group": [
+                group.as_bos(user_suffix=user_suffix) for group in self.pool_groups
+            ],
+            "temp_control": {
+                "mode": self.temp_mode,
+                "target_temp": self.temp_target,
+                "hot_temp": self.temp_hot,
+                "dangerous_temp": self.temp_dangerous,
+            },
         }
 
-    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(),
-            **self.pools.as_goldshell(user_suffix=user_suffix),
-            **self.temperature.as_goldshell(),
-        }
+        if self.autotuning_enabled or self.autotuning_wattage:
+            cfg["autotuning"] = {}
+            if self.autotuning_enabled:
+                cfg["autotuning"]["enabled"] = self.autotuning_enabled
+            if self.autotuning_wattage:
+                cfg["autotuning"]["psu_power_limit"] = self.autotuning_wattage
 
-    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(),
-            **self.pools.as_avalon(user_suffix=user_suffix),
-            **self.temperature.as_avalon(),
-        }
+        if self.asicboost:
+            cfg["hash_chain_global"] = {}
+            cfg["hash_chain_global"]["asic_boost"] = self.asicboost
 
-    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(),
-            **self.pools.as_inno(user_suffix=user_suffix),
-            **self.temperature.as_inno(),
-        }
+        if any(
+            [
+                getattr(self, item)
+                for item in [
+                    "dps_enabled",
+                    "dps_power_step",
+                    "dps_min_power",
+                    "dps_shutdown_enabled",
+                    "dps_shutdown_duration",
+                ]
+            ]
+        ):
+            cfg["power_scaling"] = {}
+            if self.dps_enabled:
+                cfg["power_scaling"]["enabled"] = self.dps_enabled
+            if self.dps_power_step:
+                cfg["power_scaling"]["power_step"] = self.dps_power_step
+            if self.dps_min_power:
+                cfg["power_scaling"]["min_psu_power_limit"] = self.dps_min_power
+            if self.dps_shutdown_enabled:
+                cfg["power_scaling"]["shutdown_enabled"] = self.dps_shutdown_enabled
+            if self.dps_shutdown_duration:
+                cfg["power_scaling"]["shutdown_duration"] = self.dps_shutdown_duration
 
-    def as_bosminer(self, user_suffix: str = None) -> dict:
-        """Generates the configuration in the bosminer.toml format."""
-        return {
-            **merge_dicts(self.fan_mode.as_bosminer(), self.temperature.as_bosminer()),
-            **self.mining_mode.as_bosminer(),
-            **self.pools.as_bosminer(user_suffix=user_suffix),
-        }
-
-    def as_boser(self, user_suffix: str = None) -> dict:
-        """Generates the configuration in the format suitable for BOSer."""
-        return {
-            **self.fan_mode.as_boser(),
-            **self.temperature.as_boser(),
-            **self.mining_mode.as_boser(),
-            **self.pools.as_boser(user_suffix=user_suffix),
-        }
-
-    def as_epic(self, user_suffix: str = None) -> dict:
-        """Generates the configuration in the format suitable for ePIC miners."""
-        return {
-            **merge_dicts(self.fan_mode.as_epic(), self.temperature.as_epic()),
-            **self.mining_mode.as_epic(),
-            **self.pools.as_epic(user_suffix=user_suffix),
-        }
-
-    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),
-        }
-
-    def as_mara(self, user_suffix: str = None) -> dict:
-        return {
-            **self.fan_mode.as_mara(),
-            **self.temperature.as_mara(),
-            **self.mining_mode.as_mara(),
-            **self.pools.as_mara(user_suffix=user_suffix),
-        }
-
-    def as_bitaxe(self, user_suffix: str = None) -> dict:
-        return {
-            **self.fan_mode.as_bitaxe(),
-            **self.temperature.as_bitaxe(),
-            **self.mining_mode.as_bitaxe(),
-            **self.pools.as_bitaxe(user_suffix=user_suffix),
-        }
-
-    def as_luxos(self, user_suffix: str = None) -> dict:
-        return {
-            **self.fan_mode.as_luxos(),
-            **self.temperature.as_luxos(),
-            **self.mining_mode.as_luxos(),
-            **self.pools.as_luxos(user_suffix=user_suffix),
-        }
-
-    def as_vnish(self, user_suffix: str = None) -> dict:
-        main_cfg = {
-            "miner": {
-                **self.fan_mode.as_vnish(),
-                **self.temperature.as_vnish(),
-                **self.mining_mode.as_vnish(),
-                **self.pools.as_vnish(user_suffix=user_suffix),
-            }
-        }
-        if isinstance(self.fan_mode, FanModeNormal):
-            main_cfg["miner"]["cooling"]["mode"]["param"] = self.temperature.target
-        return main_cfg
-
-    def as_hammer(self, *args, **kwargs) -> dict:
-        return self.as_am_modern(*args, **kwargs)
-
-    @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")),
-            fan_mode=FanModeConfig.from_dict(dict_conf.get("fan_mode")),
-            temperature=TemperatureConfig.from_dict(dict_conf.get("temperature")),
-        )
-
-    @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),
-            fan_mode=FanModeConfig.from_am_modern(web_conf),
-        )
-
-    @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),
-            fan_mode=FanModeConfig.from_bosminer(toml_conf),
-            temperature=TemperatureConfig.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),
-        )
-
-    @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, web_presets: list[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, web_presets),
-        )
-
-    @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"]),
-        )
-
-    @classmethod
-    def from_mara(cls, web_miner_config: dict) -> "MinerConfig":
-        return cls(
-            pools=PoolConfig.from_mara(web_miner_config),
-            fan_mode=FanModeConfig.from_mara(web_miner_config),
-            mining_mode=MiningModeConfig.from_mara(web_miner_config),
-        )
-
-    @classmethod
-    def from_bitaxe(cls, web_system_info: dict) -> "MinerConfig":
-        return cls(
-            pools=PoolConfig.from_bitaxe(web_system_info),
-            fan_mode=FanModeConfig.from_bitaxe(web_system_info),
-        )
-
-    @classmethod
-    def from_iceriver(cls, web_userpanel: dict) -> "MinerConfig":
-        return cls(
-            pools=PoolConfig.from_iceriver(web_userpanel),
-        )
-
-    @classmethod
-    def from_luxos(
-        cls, rpc_tempctrl: dict, rpc_fans: dict, rpc_pools: dict, rpc_groups: dict
-    ) -> "MinerConfig":
-        return cls(
-            temperature=TemperatureConfig.from_luxos(rpc_tempctrl=rpc_tempctrl),
-            fan_mode=FanModeConfig.from_luxos(
-                rpc_tempctrl=rpc_tempctrl, rpc_fans=rpc_fans
-            ),
-            pools=PoolConfig.from_luxos(rpc_pools=rpc_pools, rpc_groups=rpc_groups),
-        )
-
-    @classmethod
-    def from_hammer(cls, *args, **kwargs) -> "MinerConfig":
-        return cls.from_am_modern(*args, **kwargs)
-
-    @classmethod
-    def from_hiveon_modern(cls, web_conf: dict) -> "MinerConfig":
-        return cls.from_am_modern(web_conf)
+        return toml.dumps(cfg)

pyasic/config/base.py

@@ -1,138 +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.                                              -
-# ------------------------------------------------------------------------------
-from __future__ import annotations
-
-from enum import Enum
-
-from pydantic import BaseModel
-
-
-class MinerConfigOption(Enum):
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None):
-        return cls.default()
-
-    def as_am_modern(self) -> dict:
-        return self.value.as_am_modern()
-
-    def as_am_old(self) -> dict:
-        return self.value.as_am_old()
-
-    def as_wm(self) -> dict:
-        return self.value.as_wm()
-
-    def as_inno(self) -> dict:
-        return self.value.as_inno()
-
-    def as_goldshell(self) -> dict:
-        return self.value.as_goldshell()
-
-    def as_avalon(self) -> dict:
-        return self.value.as_avalon()
-
-    def as_bosminer(self) -> dict:
-        return self.value.as_bosminer()
-
-    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 as_mara(self) -> dict:
-        return self.value.as_mara()
-
-    def as_bitaxe(self) -> dict:
-        return self.value.as_bitaxe()
-
-    def as_luxos(self) -> dict:
-        return self.value.as_luxos()
-
-    def __call__(self, *args, **kwargs):
-        return self.value(*args, **kwargs)
-
-    @classmethod
-    def default(cls):
-        pass
-
-    def __getitem__(self, item):
-        try:
-            return getattr(self, item)
-        except AttributeError:
-            raise KeyError
-
-
-class MinerConfigValue(BaseModel):
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None):
-        return cls()
-
-    def as_dict(self) -> dict:
-        return self.model_dump()
-
-    def as_am_modern(self) -> dict:
-        return {}
-
-    def as_am_old(self) -> dict:
-        return {}
-
-    def as_wm(self) -> dict:
-        return {}
-
-    def as_inno(self) -> dict:
-        return {}
-
-    def as_goldshell(self) -> dict:
-        return {}
-
-    def as_avalon(self) -> dict:
-        return {}
-
-    def as_bosminer(self) -> dict:
-        return {}
-
-    def as_boser(self) -> dict:
-        return {}
-
-    def as_epic(self) -> dict:
-        return {}
-
-    def as_vnish(self) -> dict:
-        return {}
-
-    def as_auradine(self) -> dict:
-        return {}
-
-    def as_mara(self) -> dict:
-        return {}
-
-    def as_bitaxe(self) -> dict:
-        return {}
-
-    def as_luxos(self) -> dict:
-        return {}
-
-    def __getitem__(self, item):
-        try:
-            return getattr(self, item)
-        except AttributeError:
-            raise KeyError

pyasic/config/fans.py

@@ -1,369 +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.                                              -
-# ------------------------------------------------------------------------------
-from __future__ import annotations
-
-from typing import TypeVar, Union
-
-from pydantic import Field
-
-from pyasic.config.base import MinerConfigOption, MinerConfigValue
-
-
-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: 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"},
-            "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
-                    )
-                }
-            }
-        }
-
-    def as_mara(self) -> dict:
-        return {
-            "general-config": {"environment-profile": "AirCooling"},
-            "advance-config": {
-                "override-fan-control": False,
-                "fan-fixed-percent": 0,
-            },
-        }
-
-    def as_bitaxe(self) -> dict:
-        return {"autoFanspeed": 1}
-
-    def as_luxos(self) -> dict:
-        return {"fanset": {"speed": -1, "min_fans": self.minimum_fans}}
-
-    def as_vnish(self) -> dict:
-        return {
-            "cooling": {
-                "fan_min_count": self.minimum_fans,
-                "fan_min_duty": self.minimum_speed,
-                "mode": {
-                    "name": "auto",
-                    "param": None,  # Target temp, must be set later...
-                },
-            }
-        }
-
-
-class FanModeManual(MinerConfigValue):
-    mode: str = Field(init=False, default="manual")
-    speed: int = 100
-    minimum_fans: int = 1
-
-    @classmethod
-    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"]
-        if dict_conf.get("minimum_fans") is not None:
-            cls_conf["minimum_fans"] = dict_conf["minimum_fans"]
-        return cls(**cls_conf)
-
-    @classmethod
-    def from_bosminer(cls, toml_fan_conf: dict) -> "FanModeManual":
-        cls_conf = {}
-        if toml_fan_conf.get("min_fans") is not None:
-            cls_conf["minimum_fans"] = toml_fan_conf["min_fans"]
-        if toml_fan_conf.get("speed") is not None:
-            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-pwm": str(self.speed)}
-
-    def as_bosminer(self) -> dict:
-        return {
-            "temp_control": {"mode": "manual"},
-            "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}}}
-
-    def as_mara(self) -> dict:
-        return {
-            "general-config": {"environment-profile": "AirCooling"},
-            "advance-config": {
-                "override-fan-control": True,
-                "fan-fixed-percent": self.speed,
-            },
-        }
-
-    def as_bitaxe(self) -> dict:
-        return {"autoFanspeed": 0, "fanspeed": self.speed}
-
-    def as_luxos(self) -> dict:
-        return {"fanset": {"speed": self.speed, "min_fans": self.minimum_fans}}
-
-    def as_vnish(self) -> dict:
-        return {
-            "cooling": {
-                "fan_min_count": self.minimum_fans,
-                "fan_min_duty": self.speed,
-                "mode": {
-                    "name": "manual",
-                    "param": self.speed,  # Speed value
-                },
-            }
-        }
-
-
-class FanModeImmersion(MinerConfigValue):
-    mode: str = Field(init=False, default="immersion")
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "FanModeImmersion":
-        return cls()
-
-    def as_am_modern(self) -> dict:
-        return {"bitmain-fan-ctrl": True, "bitmain-fan-pwm": "0"}
-
-    def as_bosminer(self) -> dict:
-        return {
-            "fan_control": {"min_fans": 0},
-        }
-
-    def as_auradine(self) -> dict:
-        return {"fan": {"percentage": 0}}
-
-    def as_mara(self) -> dict:
-        return {"general-config": {"environment-profile": "OilImmersionCooling"}}
-
-    def as_luxos(self) -> dict:
-        return {"fanset": {"speed": 0, "min_fans": 0}}
-
-    def as_vnish(self) -> dict:
-        return {"cooling": {"mode": {"name": "immers"}}}
-
-
-class FanModeConfig(MinerConfigOption):
-    normal = FanModeNormal
-    manual = FanModeManual
-    immersion = FanModeImmersion
-
-    @classmethod
-    def default(cls):
-        return cls.normal()
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None):
-        if dict_conf is None:
-            return cls.default()
-
-        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)
-
-    @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:
-                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_epic(cls, web_conf: dict):
-        try:
-            fan_mode = web_conf["Fans"]["Fan Mode"]
-            if fan_mode.get("Manual") is not None:
-                return cls.manual(speed=fan_mode.get("Manual"))
-            else:
-                return cls.normal()
-        except KeyError:
-            return cls.default()
-
-    @classmethod
-    def from_bosminer(cls, toml_conf: dict):
-        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(minimum_fans=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:
-            pass
-        return cls.default()
-
-    @classmethod
-    def from_mara(cls, web_config: dict):
-        try:
-            mode = web_config["general-config"]["environment-profile"]
-            if mode == "AirCooling":
-                if web_config["advance-config"]["override-fan-control"]:
-                    return cls.manual(
-                        speed=web_config["advance-config"]["fan-fixed-percent"]
-                    )
-                return cls.normal()
-            return cls.immersion()
-        except LookupError:
-            pass
-        return cls.default()
-
-    @classmethod
-    def from_bitaxe(cls, web_system_info: dict):
-        if web_system_info["autofanspeed"] == 1:
-            return cls.normal()
-        else:
-            return cls.manual(speed=web_system_info["fanspeed"])
-
-    @classmethod
-    def from_luxos(cls, rpc_fans: dict, rpc_tempctrl: dict):
-        try:
-            mode = rpc_tempctrl["TEMPCTRL"][0]["Mode"]
-            if mode == "Manual":
-                speed = rpc_fans["FANS"][0]["Speed"]
-                min_fans = rpc_fans["FANCTRL"][0]["MinFans"]
-                if min_fans == 0 and speed == 0:
-                    return cls.immersion()
-                return cls.manual(
-                    speed=speed,
-                    minimum_fans=min_fans,
-                )
-            return cls.normal(
-                minimum_fans=rpc_fans["FANCTRL"][0]["MinFans"],
-            )
-        except LookupError:
-            pass
-        return cls.default()
-
-
-FanMode = TypeVar(
-    "FanMode",
-    bound=Union[FanModeNormal, FanModeManual, FanModeImmersion],
-)

pyasic/config/mining/__init__.py

@@ -1,703 +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.                                              -
-# ------------------------------------------------------------------------------
-from __future__ import annotations
-
-from dataclasses import field
-from typing import TypeVar, Union
-
-from pyasic import settings
-from pyasic.config.base import MinerConfigOption, MinerConfigValue
-from pyasic.web.braiins_os.proto.braiins.bos.v1 import (
-    DpsHashrateTarget,
-    DpsPowerTarget,
-    DpsTarget,
-    HashrateTargetMode,
-    PerformanceMode,
-    Power,
-    PowerTargetMode,
-    SaveAction,
-    SetDpsRequest,
-    SetPerformanceModeRequest,
-    TeraHashrate,
-    TunerPerformanceMode,
-)
-
-from .algo import TunerAlgo, TunerAlgoType
-from .presets import MiningPreset
-from .scaling import ScalingConfig
-
-
-class MiningModeNormal(MinerConfigValue):
-    mode: str = field(init=False, default="normal")
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "MiningModeNormal":
-        return cls()
-
-    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": self.mode}}
-
-    def as_epic(self) -> dict:
-        return {"ptune": {"enabled": False}}
-
-    def as_goldshell(self) -> dict:
-        return {"settings": {"level": 0}}
-
-    def as_mara(self) -> dict:
-        return {
-            "mode": {
-                "work-mode-selector": "Stock",
-            }
-        }
-
-    def as_luxos(self) -> dict:
-        return {"autotunerset": {"enabled": False}}
-
-
-class MiningModeSleep(MinerConfigValue):
-    mode: str = field(init=False, default="sleep")
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "MiningModeSleep":
-        return cls()
-
-    def as_am_modern(self) -> dict:
-        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}}
-
-    def as_mara(self) -> dict:
-        return {
-            "mode": {
-                "work-mode-selector": "Sleep",
-            }
-        }
-
-
-class MiningModeLPM(MinerConfigValue):
-    mode: str = field(init=False, default="low")
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "MiningModeLPM":
-        return cls()
-
-    def as_am_modern(self) -> dict:
-        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}}
-
-
-class MiningModeHPM(MinerConfigValue):
-    mode: str = field(init=False, default="high")
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "MiningModeHPM":
-        return cls()
-
-    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"}}
-
-
-class MiningModePowerTune(MinerConfigValue):
-    class Config:
-        arbitrary_types_allowed = True
-
-    mode: str = field(init=False, default="power_tuning")
-    power: int | None = None
-    algo: TunerAlgoType = field(default_factory=TunerAlgo.default)
-    scaling: ScalingConfig | None = None
-
-    @classmethod
-    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"])
-        if dict_conf.get("scaling"):
-            cls_conf["scaling"] = ScalingConfig.from_dict(dict_conf["scaling"])
-
-        return cls(**cls_conf)
-
-    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:
-        if self.power is not None:
-            return {"mode": self.mode, self.mode: {"wattage": self.power}}
-        return {}
-
-    def as_bosminer(self) -> dict:
-        tuning_cfg = {"enabled": True, "mode": "power_target"}
-        if self.power is not None:
-            tuning_cfg["power_target"] = self.power
-
-        cfg = {"autotuning": tuning_cfg}
-
-        if self.scaling is not None:
-            scaling_cfg = {"enabled": True}
-            if self.scaling.step is not None:
-                scaling_cfg["power_step"] = self.scaling.step
-            if self.scaling.minimum is not None:
-                scaling_cfg["min_power_target"] = self.scaling.minimum
-            if self.scaling.shutdown is not None:
-                scaling_cfg = {**scaling_cfg, **self.scaling.shutdown.as_bosminer()}
-            cfg["performance_scaling"] = scaling_cfg
-
-        return cfg
-
-    def as_boser(self) -> dict:
-        cfg = {
-            "set_performance_mode": SetPerformanceModeRequest(
-                save_action=SaveAction.SAVE_AND_APPLY,
-                mode=PerformanceMode(
-                    tuner_mode=TunerPerformanceMode(
-                        power_target=PowerTargetMode(
-                            power_target=Power(watt=self.power)
-                        )
-                    )
-                ),
-            ),
-        }
-        if self.scaling is not None:
-            sd_cfg = {}
-            if self.scaling.shutdown is not None:
-                sd_cfg = self.scaling.shutdown.as_boser()
-            cfg["set_dps"] = (
-                SetDpsRequest(
-                    enable=True,
-                    **sd_cfg,
-                    target=DpsTarget(
-                        power_target=DpsPowerTarget(
-                            power_step=Power(self.scaling.step),
-                            min_power_target=Power(self.scaling.minimum),
-                        )
-                    ),
-                ),
-            )
-        return cfg
-
-    def as_auradine(self) -> dict:
-        return {"mode": {"mode": "custom", "tune": "power", "power": self.power}}
-
-    def as_mara(self) -> dict:
-        return {
-            "mode": {
-                "work-mode-selector": "Auto",
-                "concorde": {
-                    "mode-select": "PowerTarget",
-                    "power-target": self.power,
-                },
-            }
-        }
-
-    def as_luxos(self) -> dict:
-        return {"autotunerset": {"enabled": True}}
-
-
-class MiningModeHashrateTune(MinerConfigValue):
-    class Config:
-        arbitrary_types_allowed = True
-
-    mode: str = field(init=False, default="hashrate_tuning")
-    hashrate: int | None = None
-    algo: TunerAlgoType = field(default_factory=TunerAlgo.default)
-    scaling: ScalingConfig | None = None
-
-    @classmethod
-    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"])
-        if dict_conf.get("scaling"):
-            cls_conf["scaling"] = ScalingConfig.from_dict(dict_conf["scaling"])
-
-        return cls(**cls_conf)
-
-    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_bosminer(self) -> dict:
-        conf = {"enabled": True, "mode": "hashrate_target"}
-        if self.hashrate is not None:
-            conf["hashrate_target"] = self.hashrate
-        return {"autotuning": conf}
-
-    @property
-    def as_boser(self) -> dict:
-        cfg = {
-            "set_performance_mode": SetPerformanceModeRequest(
-                save_action=SaveAction.SAVE_AND_APPLY,
-                mode=PerformanceMode(
-                    tuner_mode=TunerPerformanceMode(
-                        hashrate_target=HashrateTargetMode(
-                            hashrate_target=TeraHashrate(
-                                terahash_per_second=self.hashrate
-                            )
-                        )
-                    )
-                ),
-            )
-        }
-        if self.scaling is not None:
-            sd_cfg = {}
-            if self.scaling.shutdown is not None:
-                sd_cfg = self.scaling.shutdown.as_boser()
-            cfg["set_dps"] = (
-                SetDpsRequest(
-                    enable=True,
-                    **sd_cfg,
-                    target=DpsTarget(
-                        hashrate_target=DpsHashrateTarget(
-                            hashrate_step=TeraHashrate(self.scaling.step),
-                            min_hashrate_target=TeraHashrate(self.scaling.minimum),
-                        )
-                    ),
-                ),
-            )
-        return cfg
-
-    def as_auradine(self) -> dict:
-        return {"mode": {"mode": "custom", "tune": "ths", "ths": self.hashrate}}
-
-    def as_epic(self) -> dict:
-        mode = {
-            "ptune": {
-                "algo": self.algo.as_epic(),
-                "target": self.hashrate,
-            }
-        }
-        if self.scaling is not None:
-            if self.scaling.minimum is not None:
-                mode["ptune"]["min_throttle"] = self.scaling.minimum
-            if self.scaling.step is not None:
-                mode["ptune"]["throttle_step"] = self.scaling.step
-        return mode
-
-    def as_mara(self) -> dict:
-        return {
-            "mode": {
-                "work-mode-selector": "Auto",
-                "concorde": {
-                    "mode-select": "Hashrate",
-                    "hash-target": self.hashrate,
-                },
-            }
-        }
-
-    def as_luxos(self) -> dict:
-        return {"autotunerset": {"enabled": True}}
-
-
-class MiningModePreset(MinerConfigValue):
-    mode: str = field(init=False, default="preset")
-
-    active_preset: MiningPreset
-    available_presets: list[MiningPreset] = field(default_factory=list)
-
-    def as_vnish(self) -> dict:
-        return {"overclock": {**self.active_preset.as_vnish()}}
-
-    @classmethod
-    def from_vnish(
-        cls, web_overclock_settings: dict, web_presets: list[dict]
-    ) -> "MiningModePreset":
-        active_preset = None
-        for preset in web_presets:
-            if preset["name"] == web_overclock_settings["preset"]:
-                active_preset = preset
-        return cls(
-            active_preset=MiningPreset.from_vnish(active_preset),
-            available_presets=[MiningPreset.from_vnish(p) for p in web_presets],
-        )
-
-
-class ManualBoardSettings(MinerConfigValue):
-    freq: float
-    volt: float
-
-    @classmethod
-    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:
-        if settings.get("antminer_mining_mode_as_str", False):
-            return {"miner-mode": "0"}
-        return {"miner-mode": 0}
-
-    def as_vnish(self) -> dict:
-        return {"freq": self.freq}
-
-
-class MiningModeManual(MinerConfigValue):
-    mode: str = field(init=False, default="manual")
-
-    global_freq: float
-    global_volt: float
-    boards: dict[int, ManualBoardSettings] = field(default_factory=dict)
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "MiningModeManual":
-        return cls(
-            global_freq=dict_conf["global_freq"],
-            global_volt=dict_conf["global_volt"],
-            boards={i: ManualBoardSettings.from_dict(dict_conf[i]) for i in dict_conf},
-        )
-
-    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_vnish(self) -> dict:
-        chains = [b.as_vnish() for b in self.boards.values() if b.freq != 0]
-        return {
-            "overclock": {
-                "chains": chains if chains != [] else None,
-                "globals": {
-                    "freq": int(self.global_freq),
-                    "volt": int(self.global_volt),
-                },
-            }
-        }
-
-    @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)
-
-    @classmethod
-    def from_epic(cls, epic_conf: dict) -> "MiningModeManual":
-        voltage = 0
-        freq = 0
-        if epic_conf.get("HwConfig") is not None:
-            freq = epic_conf["HwConfig"]["Boards Target Clock"][0]["Data"]
-        if epic_conf.get("Power Supply Stats") is not None:
-            voltage = epic_conf["Power Supply Stats"]["Target Voltage"]
-        boards = {}
-        if epic_conf.get("HBs") is not None:
-            boards = {
-                board["Index"]: ManualBoardSettings(
-                    freq=board["Core Clock Avg"], volt=board["Input Voltage"]
-                )
-                for board in epic_conf["HBs"]
-            }
-        return cls(global_freq=freq, global_volt=voltage, boards=boards)
-
-    def as_mara(self) -> dict:
-        return {
-            "mode": {
-                "work-mode-selector": "Fixed",
-                "fixed": {
-                    "frequency": str(self.global_freq),
-                    "voltage": self.global_volt,
-                },
-            }
-        }
-
-
-class MiningModeConfig(MinerConfigOption):
-    normal = MiningModeNormal
-    low = MiningModeLPM
-    high = MiningModeHPM
-    sleep = MiningModeSleep
-    power_tuning = MiningModePowerTune
-    hashrate_tuning = MiningModeHashrateTune
-    preset = MiningModePreset
-    manual = MiningModeManual
-
-    @classmethod
-    def default(cls):
-        return cls.normal()
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None):
-        if dict_conf is None:
-            return cls.default()
-
-        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)
-
-    @classmethod
-    def from_am_modern(cls, web_conf: dict):
-        if web_conf.get("bitmain-work-mode") is not None:
-            work_mode = web_conf["bitmain-work-mode"]
-            if work_mode == "":
-                return cls.default()
-            if int(work_mode) == 0:
-                return cls.normal()
-            elif int(work_mode) == 1:
-                return cls.sleep()
-            elif int(work_mode) == 3:
-                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:
-                    scaling_cfg = None
-                    if "Throttle Step" in algo_info["VoltageOptimizer"]:
-                        scaling_cfg = ScalingConfig(
-                            minimum=algo_info["VoltageOptimizer"].get(
-                                "Min Throttle Target"
-                            ),
-                            step=algo_info["VoltageOptimizer"].get("Throttle Step"),
-                        )
-
-                    return cls.hashrate_tuning(
-                        hashrate=algo_info["VoltageOptimizer"].get("Target"),
-                        algo=TunerAlgo.voltage_optimizer(),
-                        scaling=scaling_cfg,
-                    )
-                elif algo_info.get("BoardTune") is not None:
-                    scaling_cfg = None
-                    if "Throttle Step" in algo_info["BoardTune"]:
-                        scaling_cfg = ScalingConfig(
-                            minimum=algo_info["BoardTune"].get("Min Throttle Target"),
-                            step=algo_info["BoardTune"].get("Throttle Step"),
-                        )
-
-                    return cls.hashrate_tuning(
-                        hashrate=algo_info["BoardTune"].get("Target"),
-                        algo=TunerAlgo.board_tune(),
-                        scaling=scaling_cfg,
-                    )
-                else:
-                    return cls.hashrate_tuning(
-                        hashrate=algo_info["ChipTune"].get("Target"),
-                        algo=TunerAlgo.chip_tune(),
-                    )
-            else:
-                return MiningModeManual.from_epic(web_conf)
-        except KeyError:
-            return cls.default()
-
-    @classmethod
-    def from_bosminer(cls, toml_conf: dict):
-        if toml_conf.get("autotuning") is None:
-            return cls.default()
-        autotuning_conf = toml_conf["autotuning"]
-
-        if autotuning_conf.get("enabled") is None:
-            return cls.default()
-        if not autotuning_conf["enabled"]:
-            return cls.default()
-
-        if autotuning_conf.get("psu_power_limit") is not None:
-            # old autotuning conf
-            return cls.power_tuning(
-                power=autotuning_conf["psu_power_limit"],
-                scaling=ScalingConfig.from_bosminer(toml_conf, mode="power"),
-            )
-        if autotuning_conf.get("mode") is not None:
-            # new autotuning conf
-            mode = autotuning_conf["mode"]
-            if mode == "power_target":
-                if autotuning_conf.get("power_target") is not None:
-                    return cls.power_tuning(
-                        power=autotuning_conf["power_target"],
-                        scaling=ScalingConfig.from_bosminer(toml_conf, mode="power"),
-                    )
-                return cls.power_tuning(
-                    scaling=ScalingConfig.from_bosminer(toml_conf, mode="power"),
-                )
-            if mode == "hashrate_target":
-                if autotuning_conf.get("hashrate_target") is not None:
-                    return cls.hashrate_tuning(
-                        hashrate=autotuning_conf["hashrate_target"],
-                        scaling=ScalingConfig.from_bosminer(toml_conf, mode="hashrate"),
-                    )
-                return cls.hashrate_tuning(
-                    scaling=ScalingConfig.from_bosminer(toml_conf, mode="hashrate"),
-                )
-
-    @classmethod
-    def from_vnish(cls, web_settings: dict, web_presets: list[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 MiningModePreset.from_vnish(mode_settings, web_presets)
-
-    @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(
-                        power=tuner_conf["powerTarget"]["watt"],
-                        scaling=ScalingConfig.from_boser(grpc_miner_conf, mode="power"),
-                    )
-                return cls.power_tuning(
-                    scaling=ScalingConfig.from_boser(grpc_miner_conf, mode="power")
-                )
-
-            if tuner_conf["tunerMode"] == 2:
-                if tuner_conf.get("hashrateTarget") is not None:
-                    return cls.hashrate_tuning(
-                        hashrate=int(tuner_conf["hashrateTarget"]["terahashPerSecond"]),
-                        scaling=ScalingConfig.from_boser(
-                            grpc_miner_conf, mode="hashrate"
-                        ),
-                    )
-                return cls.hashrate_tuning(
-                    scaling=ScalingConfig.from_boser(grpc_miner_conf, mode="hashrate"),
-                )
-
-        if tuner_conf.get("powerTarget") is not None:
-            return cls.power_tuning(
-                power=tuner_conf["powerTarget"]["watt"],
-                scaling=ScalingConfig.from_boser(grpc_miner_conf, mode="power"),
-            )
-
-        if tuner_conf.get("hashrateTarget") is not None:
-            return cls.hashrate_tuning(
-                hashrate=int(tuner_conf["hashrateTarget"]["terahashPerSecond"]),
-                scaling=ScalingConfig.from_boser(grpc_miner_conf, mode="hashrate"),
-            )
-
-        return cls.default()
-
-    @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(hashrate=mode_data["Ths"])
-            if mode_data.get("Power") is not None:
-                return cls.power_tuning(power=mode_data["Power"])
-        except LookupError:
-            return cls.default()
-
-    @classmethod
-    def from_mara(cls, web_config: dict):
-        try:
-            mode = web_config["mode"]["work-mode-selector"]
-            if mode == "Fixed":
-                fixed_conf = web_config["mode"]["fixed"]
-                return cls.manual(
-                    global_freq=int(fixed_conf["frequency"]),
-                    global_volt=fixed_conf["voltage"],
-                )
-            elif mode == "Stock":
-                return cls.normal()
-            elif mode == "Sleep":
-                return cls.sleep()
-            elif mode == "Auto":
-                auto_conf = web_config["mode"]["concorde"]
-                auto_mode = auto_conf["mode-select"]
-                if auto_mode == "Hashrate":
-                    return cls.hashrate_tuning(hashrate=auto_conf["hash-target"])
-                elif auto_mode == "PowerTarget":
-                    return cls.power_tuning(power=auto_conf["power-target"])
-        except LookupError:
-            pass
-        return cls.default()
-
-
-MiningMode = TypeVar(
-    "MiningMode",
-    bound=Union[
-        MiningModeNormal,
-        MiningModeHPM,
-        MiningModeLPM,
-        MiningModeSleep,
-        MiningModeManual,
-        MiningModePowerTune,
-        MiningModeHashrateTune,
-        MiningModePreset,
-    ],
-)

pyasic/config/mining/algo.py

@@ -1,66 +0,0 @@
-from __future__ import annotations
-
-from dataclasses import dataclass, field
-from typing import TypeVar, Union
-
-from pyasic.config.base import MinerConfigOption, MinerConfigValue
-
-
-class StandardTuneAlgo(MinerConfigValue):
-    mode: str = field(init=False, default="standard")
-
-    def as_epic(self) -> str:
-        return VOptAlgo().as_epic()
-
-
-class VOptAlgo(MinerConfigValue):
-    mode: str = field(init=False, default="voltage_optimizer")
-
-    def as_epic(self) -> str:
-        return "VoltageOptimizer"
-
-
-class BoardTuneAlgo(MinerConfigValue):
-    mode: str = field(init=False, default="board_tune")
-
-    def as_epic(self) -> str:
-        return "BoardTune"
-
-
-class ChipTuneAlgo(MinerConfigValue):
-    mode: str = field(init=False, default="chip_tune")
-
-    def as_epic(self) -> str:
-        return "ChipTune"
-
-
-class TunerAlgo(MinerConfigOption):
-    standard = StandardTuneAlgo
-    voltage_optimizer = VOptAlgo
-    board_tune = BoardTuneAlgo
-    chip_tune = ChipTuneAlgo
-
-    @classmethod
-    def default(cls) -> TunerAlgoType:
-        return cls.standard()
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> TunerAlgoType:
-        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)
-
-
-TunerAlgoType = TypeVar(
-    "TunerAlgoType",
-    bound=Union[
-        StandardTuneAlgo,
-        VOptAlgo,
-        BoardTuneAlgo,
-        ChipTuneAlgo,
-    ],
-)

pyasic/config/mining/presets.py

@@ -1,34 +0,0 @@
-from pyasic.config.base import MinerConfigValue
-
-
-class MiningPreset(MinerConfigValue):
-    name: str | None = None
-    power: int | None = None
-    hashrate: int | None = None
-    tuned: bool | None = None
-    modded_psu: bool = False
-
-    def as_vnish(self) -> dict:
-        if self.name is not None:
-            return {"preset": self.name}
-        return {}
-
-    @classmethod
-    def from_vnish(cls, web_preset: dict):
-        name = web_preset["name"]
-        hr_power_split = web_preset["pretty"].split("~")
-        if len(hr_power_split) == 1:
-            power = None
-            hashrate = None
-        else:
-            power = hr_power_split[0].replace("watt", "").strip()
-            hashrate = hr_power_split[1].replace("TH", "").strip()
-        tuned = web_preset["status"] == "tuned"
-        modded_psu = web_preset["modded_psu_required"]
-        return cls(
-            name=name,
-            power=power,
-            hashrate=hashrate,
-            tuned=tuned,
-            modded_psu=modded_psu,
-        )

pyasic/config/mining/scaling.py

@@ -1,131 +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.                                              -
-# ------------------------------------------------------------------------------
-from __future__ import annotations
-
-from dataclasses import dataclass
-
-from pyasic.config.base import MinerConfigValue
-
-
-class ScalingShutdown(MinerConfigValue):
-    enabled: bool = False
-    duration: int = None
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "ScalingShutdown":
-        return cls(
-            enabled=dict_conf.get("enabled", False), duration=dict_conf.get("duration")
-        )
-
-    @classmethod
-    def from_bosminer(cls, power_scaling_conf: dict):
-        sd_enabled = power_scaling_conf.get("shutdown_enabled")
-        if sd_enabled is not None:
-            return cls(
-                enabled=sd_enabled, duration=power_scaling_conf.get("shutdown_duration")
-            )
-        return None
-
-    @classmethod
-    def from_boser(cls, power_scaling_conf: dict):
-        sd_enabled = power_scaling_conf.get("shutdownEnabled")
-        if sd_enabled is not None:
-            try:
-                return cls(
-                    enabled=sd_enabled,
-                    duration=power_scaling_conf["shutdownDuration"]["hours"],
-                )
-            except KeyError:
-                return cls(enabled=sd_enabled)
-        return None
-
-    def as_bosminer(self) -> dict:
-        cfg = {"shutdown_enabled": self.enabled}
-
-        if self.duration is not None:
-            cfg["shutdown_duration"] = self.duration
-
-        return cfg
-
-    def as_boser(self) -> dict:
-        return {"enable_shutdown": self.enabled, "shutdown_duration": self.duration}
-
-
-class ScalingConfig(MinerConfigValue):
-    step: int = None
-    minimum: int = None
-    shutdown: ScalingShutdown = None
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "ScalingConfig":
-        cls_conf = {
-            "step": dict_conf.get("step"),
-            "minimum": dict_conf.get("minimum"),
-        }
-        shutdown = dict_conf.get("shutdown")
-        if shutdown is not None:
-            cls_conf["shutdown"] = ScalingShutdown.from_dict(shutdown)
-        return cls(**cls_conf)
-
-    @classmethod
-    def from_bosminer(cls, toml_conf: dict, mode: str = None):
-        if mode == "power":
-            return cls._from_bosminer_power(toml_conf)
-        if mode == "hashrate":
-            # not implemented yet
-            pass
-
-    @classmethod
-    def _from_bosminer_power(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 not enabled:
-                return None
-            power_step = power_scaling.get("power_step")
-            min_power = power_scaling.get("min_psu_power_limit")
-            if min_power is None:
-                min_power = power_scaling.get("min_power_target")
-            sd_mode = ScalingShutdown.from_bosminer(power_scaling)
-
-            return cls(step=power_step, minimum=min_power, shutdown=sd_mode)
-
-    @classmethod
-    def from_boser(cls, grpc_miner_conf: dict, mode: str = None):
-        if mode == "power":
-            return cls._from_boser_power(grpc_miner_conf)
-        if mode == "hashrate":
-            # not implemented yet
-            pass
-
-    @classmethod
-    def _from_boser_power(cls, grpc_miner_conf: dict):
-        try:
-            dps_conf = grpc_miner_conf["dps"]
-            if not dps_conf.get("enabled", False):
-                return None
-        except LookupError:
-            return None
-
-        conf = {"shutdown": ScalingShutdown.from_boser(dps_conf)}
-
-        if dps_conf.get("minPowerTarget") is not None:
-            conf["minimum"] = dps_conf["minPowerTarget"]["watt"]
-        if dps_conf.get("powerStep") is not None:
-            conf["step"] = dps_conf["powerStep"]["watt"]
-        return cls(**conf)

pyasic/config/pools.py

@@ -1,601 +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.                                              -
-# ------------------------------------------------------------------------------
-from __future__ import annotations
-
-import random
-import string
-from typing import List
-
-from pydantic import Field
-
-from pyasic.config.base import MinerConfigValue
-from pyasic.web.braiins_os.proto.braiins.bos.v1 import (
-    PoolConfiguration,
-    PoolGroupConfiguration,
-    Quota,
-    SaveAction,
-    SetPoolGroupsRequest,
-)
-
-
-class Pool(MinerConfigValue):
-    url: str
-    user: str
-    password: str
-
-    def as_am_modern(self, user_suffix: str | None = None) -> dict:
-        return {
-            "url": self.url,
-            "user": f"{self.user}{user_suffix or ''}",
-            "pass": self.password,
-        }
-
-    def as_wm(self, idx: int = 1, user_suffix: str | None = None) -> dict:
-        return {
-            f"pool_{idx}": self.url,
-            f"worker_{idx}": f"{self.user}{user_suffix or ''}",
-            f"passwd_{idx}": self.password,
-        }
-
-    def as_am_old(self, idx: int = 1, user_suffix: str | None = None) -> dict:
-        return {
-            f"_ant_pool{idx}url": self.url,
-            f"_ant_pool{idx}user": f"{self.user}{user_suffix or ''}",
-            f"_ant_pool{idx}pw": self.password,
-        }
-
-    def as_goldshell(self, user_suffix: str | None = None) -> dict:
-        return {
-            "url": self.url,
-            "user": f"{self.user}{user_suffix or ''}",
-            "pass": self.password,
-        }
-
-    def as_avalon(self, user_suffix: str | None = None) -> str:
-        return ",".join([self.url, f"{self.user}{user_suffix or ''}", self.password])
-
-    def as_inno(self, idx: int = 1, user_suffix: str | None = None) -> dict:
-        return {
-            f"Pool{idx}": self.url,
-            f"UserName{idx}": f"{self.user}{user_suffix or ''}",
-            f"Password{idx}": self.password,
-        }
-
-    def as_bosminer(self, user_suffix: str | None = None) -> dict:
-        return {
-            "url": self.url,
-            "user": f"{self.user}{user_suffix or ''}",
-            "password": self.password,
-        }
-
-    def as_auradine(self, user_suffix: str | None = None) -> dict:
-        return {
-            "url": self.url,
-            "user": f"{self.user}{user_suffix or ''}",
-            "pass": self.password,
-        }
-
-    def as_epic(self, user_suffix: str | None = None):
-        return {
-            "pool": self.url,
-            "login": f"{self.user}{user_suffix or ''}",
-            "password": self.password,
-        }
-
-    def as_mara(self, user_suffix: str | None = None) -> dict:
-        return {
-            "url": self.url,
-            "user": f"{self.user}{user_suffix or ''}",
-            "pass": self.password,
-        }
-
-    def as_bitaxe(self, user_suffix: str | None = None) -> dict:
-        return {
-            "stratumURL": self.url,
-            "stratumUser": f"{self.user}{user_suffix or ''}",
-            "stratumPassword": self.password,
-        }
-
-    def as_boser(self, user_suffix: str | None = None) -> PoolConfiguration:
-        return PoolConfiguration(
-            url=self.url,
-            user=f"{self.user}{user_suffix or ''}",
-            password=self.password,
-            enabled=True,
-        )
-
-    def as_vnish(self, user_suffix: str | None = None) -> dict:
-        return {
-            "url": self.url,
-            "user": f"{self.user}{user_suffix or ''}",
-            "pass": self.password,
-        }
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "Pool":
-        return cls(
-            url=dict_conf["url"], user=dict_conf["user"], password=dict_conf["password"]
-        )
-
-    @classmethod
-    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(
-            url=web_pool["url"], user=web_pool["user"], password=web_pool["pass"]
-        )
-
-    # TODO: check if this is accurate, user/username, pass/password
-    @classmethod
-    def from_goldshell(cls, web_pool: dict) -> "Pool":
-        return cls(
-            url=web_pool["url"], user=web_pool["user"], password=web_pool["pass"]
-        )
-
-    @classmethod
-    def from_inno(cls, web_pool: dict) -> "Pool":
-        return cls(
-            url=web_pool["url"], user=web_pool["user"], password=web_pool["pass"]
-        )
-
-    @classmethod
-    def from_bosminer(cls, toml_pool_conf: dict) -> "Pool":
-        return cls(
-            url=toml_pool_conf["url"],
-            user=toml_pool_conf["user"],
-            password=toml_pool_conf["password"],
-        )
-
-    @classmethod
-    def from_vnish(cls, web_pool: dict) -> "Pool":
-        return cls(
-            url="stratum+tcp://" + 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"],
-        )
-
-    @classmethod
-    def from_mara(cls, web_pool: dict) -> "Pool":
-        return cls(
-            url=web_pool["url"],
-            user=web_pool["user"],
-            password=web_pool["pass"],
-        )
-
-    @classmethod
-    def from_bitaxe(cls, web_system_info: dict) -> "Pool":
-        url = f"stratum+tcp://{web_system_info['stratumURL']}:{web_system_info['stratumPort']}"
-        return cls(
-            url=url,
-            user=web_system_info["stratumUser"],
-            password=web_system_info.get("stratumPassword", ""),
-        )
-
-    @classmethod
-    def from_luxos(cls, rpc_pools: dict) -> "Pool":
-        return cls.from_api(rpc_pools)
-
-    @classmethod
-    def from_iceriver(cls, web_pool: dict) -> "Pool":
-        return cls(
-            url=web_pool["addr"],
-            user=web_pool["user"],
-            password=web_pool["pass"],
-        )
-
-
-class PoolGroup(MinerConfigValue):
-    pools: list[Pool] = Field(default_factory=list)
-    quota: int = 1
-    name: str | None = None
-
-    def __post_init__(self):
-        if self.name is None:
-            self.name = "".join(
-                random.choice(string.ascii_uppercase + string.digits) for _ in range(6)
-            )  # generate random pool group name in case it isn't set
-
-    def as_am_modern(self, user_suffix: str | None = None) -> list:
-        pools = []
-        idx = 0
-        while idx < 3:
-            if len(self.pools) > idx:
-                pools.append(self.pools[idx].as_am_modern(user_suffix=user_suffix))
-            else:
-                pools.append(Pool(url="", user="", password="").as_am_modern())
-            idx += 1
-        return pools
-
-    def as_wm(self, user_suffix: str | None = None) -> dict:
-        pools = {}
-        idx = 0
-        while idx < 3:
-            if len(self.pools) > idx:
-                pools.update(
-                    **self.pools[idx].as_wm(idx=idx + 1, user_suffix=user_suffix)
-                )
-            else:
-                pools.update(**Pool(url="", user="", password="").as_wm(idx=idx + 1))
-            idx += 1
-        return pools
-
-    def as_am_old(self, user_suffix: str | None = None) -> dict:
-        pools = {}
-        idx = 0
-        while idx < 3:
-            if len(self.pools) > idx:
-                pools.update(
-                    **self.pools[idx].as_am_old(idx=idx + 1, user_suffix=user_suffix)
-                )
-            else:
-                pools.update(
-                    **Pool(url="", user="", password="").as_am_old(idx=idx + 1)
-                )
-            idx += 1
-        return pools
-
-    def as_goldshell(self, user_suffix: str | None = None) -> list:
-        return [pool.as_goldshell(user_suffix) for pool in self.pools]
-
-    def as_avalon(self, user_suffix: str | None = None) -> str:
-        if len(self.pools) > 0:
-            return self.pools[0].as_avalon(user_suffix=user_suffix)
-        return Pool(url="", user="", password="").as_avalon()
-
-    def as_inno(self, user_suffix: str | None = None) -> dict:
-        pools = {}
-        idx = 0
-        while idx < 3:
-            if len(self.pools) > idx:
-                pools.update(
-                    **self.pools[idx].as_inno(idx=idx + 1, user_suffix=user_suffix)
-                )
-            else:
-                pools.update(**Pool(url="", user="", password="").as_inno(idx=idx + 1))
-            idx += 1
-        return pools
-
-    def as_bosminer(self, user_suffix: str | None = None) -> dict:
-        if len(self.pools) > 0:
-            conf = {
-                "name": self.name,
-                "pool": [
-                    pool.as_bosminer(user_suffix=user_suffix) for pool in self.pools
-                ],
-            }
-            if self.quota is not None:
-                conf["quota"] = self.quota
-            return conf
-        return {"name": "Group", "pool": []}
-
-    def as_auradine(self, user_suffix: str | None = None) -> list:
-        return [p.as_auradine(user_suffix=user_suffix) for p in self.pools]
-
-    def as_epic(self, user_suffix: str | None = None) -> list:
-        return [p.as_epic(user_suffix=user_suffix) for p in self.pools]
-
-    def as_mara(self, user_suffix: str | None = None) -> list:
-        return [p.as_mara(user_suffix=user_suffix) for p in self.pools]
-
-    def as_bitaxe(self, user_suffix: str | None = None) -> dict:
-        return self.pools[0].as_bitaxe(user_suffix=user_suffix)
-
-    def as_boser(self, user_suffix: str | None = None) -> PoolGroupConfiguration:
-        return PoolGroupConfiguration(
-            name=self.name,
-            quota=Quota(value=self.quota),
-            pools=[p.as_boser() for p in self.pools],
-        )
-
-    def as_vnish(self, user_suffix: str | None = None) -> dict:
-        return {"pools": [p.as_vnish(user_suffix=user_suffix) for p in self.pools]}
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "PoolGroup":
-        cls_conf = {}
-
-        if dict_conf.get("quota") is not None:
-            cls_conf["quota"] = dict_conf["quota"]
-        if dict_conf.get("name") is not None:
-            cls_conf["name"] = dict_conf["name"]
-        cls_conf["pools"] = [Pool.from_dict(p) for p in dict_conf["pools"]]
-        return cls(**cls_conf)
-
-    @classmethod
-    def from_api(cls, api_pool_list: list) -> "PoolGroup":
-        pools = []
-        for pool in api_pool_list:
-            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 = []
-        for pool in web_pool_list:
-            pools.append(Pool.from_am_modern(pool))
-        return cls(pools=pools)
-
-    @classmethod
-    def from_goldshell(cls, web_pools: list) -> "PoolGroup":
-        return cls(pools=[Pool.from_goldshell(p) for p in web_pools])
-
-    @classmethod
-    def from_inno(cls, web_pools: list) -> "PoolGroup":
-        return cls(pools=[Pool.from_inno(p) for p in web_pools])
-
-    @classmethod
-    def from_bosminer(cls, toml_group_conf: dict) -> "PoolGroup":
-        if toml_group_conf.get("pool") is not None:
-            return cls(
-                name=toml_group_conf["name"],
-                quota=toml_group_conf.get("quota"),
-                pools=[Pool.from_bosminer(p) for p in toml_group_conf["pool"]],
-            )
-        return cls()
-
-    @classmethod
-    def from_vnish(cls, web_settings_pools: dict) -> "PoolGroup":
-        return cls(
-            pools=[Pool.from_vnish(p) for p in web_settings_pools if p["url"] != ""]
-        )
-
-    @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()
-
-    @classmethod
-    def from_mara(cls, web_config_pools: dict) -> "PoolGroup":
-        return cls(pools=[Pool.from_mara(pool_conf) for pool_conf in web_config_pools])
-
-    @classmethod
-    def from_bitaxe(cls, web_system_info: dict) -> "PoolGroup":
-        return cls(pools=[Pool.from_bitaxe(web_system_info)])
-
-    @classmethod
-    def from_iceriver(cls, web_userpanel: dict) -> "PoolGroup":
-        return cls(
-            pools=[
-                Pool.from_iceriver(web_pool)
-                for web_pool in web_userpanel["data"]["pools"]
-            ]
-        )
-
-
-class PoolConfig(MinerConfigValue):
-    groups: List[PoolGroup] = Field(default_factory=list)
-
-    @classmethod
-    def default(cls) -> "PoolConfig":
-        return cls()
-
-    @classmethod
-    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[Pool | dict[str, str]]) -> "PoolConfig":
-        group_pools = []
-        for pool in pools:
-            if isinstance(pool, dict):
-                pool = Pool(**pool)
-            group_pools.append(pool)
-        return cls(groups=[PoolGroup(pools=group_pools)])
-
-    def as_am_modern(self, user_suffix: str | None = None) -> dict:
-        if len(self.groups) > 0:
-            return {"pools": self.groups[0].as_am_modern(user_suffix=user_suffix)}
-        return {"pools": PoolGroup().as_am_modern()}
-
-    def as_wm(self, user_suffix: str | None = None) -> dict:
-        if len(self.groups) > 0:
-            return {"pools": self.groups[0].as_wm(user_suffix=user_suffix)}
-        return {"pools": PoolGroup().as_wm()}
-
-    def as_am_old(self, user_suffix: str | None = None) -> dict:
-        if len(self.groups) > 0:
-            return self.groups[0].as_am_old(user_suffix=user_suffix)
-        return PoolGroup().as_am_old()
-
-    def as_goldshell(self, user_suffix: str | None = None) -> dict:
-        if len(self.groups) > 0:
-            return {"pools": self.groups[0].as_goldshell(user_suffix=user_suffix)}
-        return {"pools": PoolGroup().as_goldshell()}
-
-    def as_avalon(self, user_suffix: str | None = None) -> dict:
-        if len(self.groups) > 0:
-            return {"pools": self.groups[0].as_avalon(user_suffix=user_suffix)}
-        return {"pools": PoolGroup().as_avalon()}
-
-    def as_inno(self, user_suffix: str | None = None) -> dict:
-        if len(self.groups) > 0:
-            return self.groups[0].as_inno(user_suffix=user_suffix)
-        return PoolGroup().as_inno()
-
-    def as_bosminer(self, user_suffix: str | None = None) -> dict:
-        if len(self.groups) > 0:
-            return {
-                "group": [g.as_bosminer(user_suffix=user_suffix) for g in self.groups]
-            }
-        return {"group": [PoolGroup().as_bosminer()]}
-
-    def as_boser(self, user_suffix: str | None = None) -> dict:
-        return {
-            "set_pool_groups": SetPoolGroupsRequest(
-                save_action=SaveAction.SAVE_AND_APPLY,
-                pool_groups=[g.as_boser(user_suffix=user_suffix) for g in self.groups],
-            )
-        }
-
-    def as_auradine(self, user_suffix: str | None = 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 = 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,
-            }
-        }
-
-    def as_mara(self, user_suffix: str | None = None) -> dict:
-        if len(self.groups) > 0:
-            return {"pools": self.groups[0].as_mara(user_suffix=user_suffix)}
-        return {"pools": []}
-
-    def as_bitaxe(self, user_suffix: str | None = None) -> dict:
-        return self.groups[0].as_bitaxe(user_suffix=user_suffix)
-
-    def as_luxos(self, user_suffix: str | None = None) -> dict:
-        return {}
-
-    def as_vnish(self, user_suffix: str | None = None) -> dict:
-        return self.groups[0].as_vnish(user_suffix=user_suffix)
-
-    @classmethod
-    def from_api(cls, api_pools: dict) -> "PoolConfig":
-        try:
-            pool_data = api_pools["POOLS"]
-        except KeyError:
-            return PoolConfig.default()
-        pool_data = sorted(pool_data, key=lambda x: int(x["POOL"]))
-
-        return cls(groups=[PoolGroup.from_api(pool_data)])
-
-    @classmethod
-    def from_epic(cls, web_conf: dict) -> "PoolConfig":
-        pool_data = web_conf["StratumConfigs"]
-        return cls(groups=[PoolGroup.from_epic(pool_data)])
-
-    @classmethod
-    def from_am_modern(cls, web_conf: dict) -> "PoolConfig":
-        pool_data = web_conf["pools"]
-
-        return cls(groups=[PoolGroup.from_am_modern(pool_data)])
-
-    @classmethod
-    def from_goldshell(cls, web_pools: list) -> "PoolConfig":
-        return cls(groups=[PoolGroup.from_goldshell(web_pools)])
-
-    @classmethod
-    def from_inno(cls, web_pools: list) -> "PoolConfig":
-        return cls(groups=[PoolGroup.from_inno(web_pools)])
-
-    @classmethod
-    def from_bosminer(cls, toml_conf: dict) -> "PoolConfig":
-        if toml_conf.get("group") is None:
-            return cls()
-
-        return cls(groups=[PoolGroup.from_bosminer(g) for g in toml_conf["group"]])
-
-    @classmethod
-    def from_vnish(cls, web_settings: dict) -> "PoolConfig":
-        try:
-            return cls(groups=[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()
-
-    @classmethod
-    def from_mara(cls, web_config: dict) -> "PoolConfig":
-        return cls(groups=[PoolGroup.from_mara(web_config["pools"])])
-
-    @classmethod
-    def from_bitaxe(cls, web_system_info: dict) -> "PoolConfig":
-        return cls(groups=[PoolGroup.from_bitaxe(web_system_info)])
-
-    @classmethod
-    def from_iceriver(cls, web_userpanel: dict) -> "PoolConfig":
-        return cls(groups=[PoolGroup.from_iceriver(web_userpanel)])
-
-    @classmethod
-    def from_luxos(cls, rpc_groups: dict, rpc_pools: dict) -> "PoolConfig":
-        return cls(
-            groups=[
-                PoolGroup(
-                    pools=[
-                        Pool.from_luxos(pool)
-                        for pool in rpc_pools["POOLS"]
-                        if pool["GROUP"] == group["GROUP"]
-                    ],
-                    name=group["Name"],
-                    quota=group["Quota"],
-                )
-                for group in rpc_groups["GROUPS"]
-            ]
-        )

pyasic/config/temperature.py

@@ -1,157 +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.                                              -
-# ------------------------------------------------------------------------------
-from __future__ import annotations
-
-from dataclasses import dataclass
-
-from pyasic.config.base import MinerConfigValue
-
-
-class TemperatureConfig(MinerConfigValue):
-    target: int | None = None
-    hot: int | None = None
-    danger: int | None = None
-
-    @classmethod
-    def default(cls):
-        return cls()
-
-    def as_bosminer(self) -> dict:
-        temp_cfg = {}
-        if self.target is not None:
-            temp_cfg["target_temp"] = self.target
-        if self.hot is not None:
-            temp_cfg["hot_temp"] = self.hot
-        if self.danger is not None:
-            temp_cfg["dangerous_temp"] = self.danger
-        if len(temp_cfg) == 0:
-            return {}
-        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"]["critical"] = self.danger
-        if self.hot is not None:
-            temps_config["temps"]["shutdown"] = self.hot
-        return temps_config
-
-    def as_luxos(self) -> dict:
-        return {"tempctrlset": [self.target or "", self.hot or "", self.danger or ""]}
-
-    def as_vnish(self) -> dict:
-        return {"misc": {"restart_temp": self.danger}}
-
-    @classmethod
-    def from_dict(cls, dict_conf: dict | None) -> "TemperatureConfig":
-        return cls(
-            target=dict_conf.get("target"),
-            hot=dict_conf.get("hot"),
-            danger=dict_conf.get("danger"),
-        )
-
-    @classmethod
-    def from_bosminer(cls, toml_conf: dict) -> "TemperatureConfig":
-        temp_control = toml_conf.get("temp_control")
-        if temp_control is not None:
-            return cls(
-                target=temp_control.get("target_temp"),
-                hot=temp_control.get("hot_temp"),
-                danger=temp_control.get("dangerous_temp"),
-            )
-        return cls()
-
-    @classmethod
-    def from_epic(cls, web_conf: dict) -> "TemperatureConfig":
-        try:
-            dangerous_temp = web_conf["Misc"]["Critical Temp"]
-        except KeyError:
-            dangerous_temp = None
-        try:
-            hot_temp = web_conf["Misc"]["Shutdown Temp"]
-        except KeyError:
-            hot_temp = None
-        # Need to do this in two blocks to avoid KeyError if one is missing
-        try:
-            target_temp = web_conf["Fans"]["Fan Mode"]["Auto"]["Target Temperature"]
-        except KeyError:
-            target_temp = None
-
-        return cls(target=target_temp, hot=hot_temp, danger=dangerous_temp)
-
-    @classmethod
-    def from_vnish(cls, web_settings: dict) -> "TemperatureConfig":
-        try:
-            dangerous_temp = web_settings["misc"]["restart_temp"]
-        except KeyError:
-            dangerous_temp = None
-        try:
-            if web_settings["miner"]["cooling"]["mode"]["name"] == "auto":
-                return cls(
-                    target=web_settings["miner"]["cooling"]["mode"]["param"],
-                    danger=dangerous_temp,
-                )
-        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()
-
-    @classmethod
-    def from_luxos(cls, rpc_tempctrl: dict) -> "TemperatureConfig":
-        try:
-            tempctrl_config = rpc_tempctrl["TEMPCTRL"][0]
-            return cls(
-                target=tempctrl_config.get("Target"),
-                hot=tempctrl_config.get("Hot"),
-                danger=tempctrl_config.get("Dangerous"),
-            )
-        except LookupError:
-            pass
-        return cls.default()

pyasic/data/__init__.py

@@ -1,439 +1,153 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
 
-import copy
-import time
-from datetime import datetime, timezone
-from typing import Any, List, Union
+from typing import Union, List
+from dataclasses import dataclass, field, asdict
+from datetime import datetime
 
-from pydantic import BaseModel, Field, computed_field, field_serializer
-
-from pyasic.config import MinerConfig
-from pyasic.config.mining import MiningModePowerTune
-from pyasic.data.pools import PoolMetrics, Scheme
-from pyasic.device.algorithm.hashrate import AlgoHashRateType
-
-from .boards import HashBoard
-from .device import DeviceInfo
-from .error_codes import BraiinsOSError, InnosiliconError, WhatsminerError, X19Error
-from .fans import Fan
+from .error_codes import X19Error, WhatsminerError, BraiinsOSError
 
 
-class MinerData(BaseModel):
+@dataclass
+class MinerData:
     """A Dataclass to standardize data returned from miners (specifically `AnyMiner().get_data()`)
 
     Attributes:
         ip: The IP of the miner as a str.
         datetime: The time and date this data was generated.
-        uptime: The uptime of the miner in seconds.
-        mac: The MAC address of the miner as a str.
-        device_info: Info about the device, such as model, make, and firmware.
         model: The model of the miner as a str.
-        make: The make of the miner as a str.
-        firmware: The firmware on the miner as a str.
-        algo: The mining algorithm of the miner as a str.
-        api_ver: The current api version on the miner as a str.
-        fw_ver: The current firmware version on the miner as a str.
         hostname: The network hostname of the miner as a str.
-        hashrate: The hashrate of the miner in TH/s as a float.  Calculated automatically.
-        expected_hashrate: The factory nominal hashrate of the miner in TH/s as a float.
-        hashboards: A list of [`HashBoard`][pyasic.data.HashBoard]s on the miner with their statistics.
+        hashrate: The hashrate of the miner in TH/s as a float.
+        left_board_hashrate: The hashrate of the left board of the miner in TH/s as a float.
+        center_board_hashrate: The hashrate of the center board of the miner in TH/s as a float.
+        right_board_hashrate: The hashrate of the right board of the miner in TH/s as a float.
         temperature_avg: The average temperature across the boards.  Calculated automatically.
         env_temp: The environment temps as a float.
+        left_board_temp: The temp of the left PCB as an int.
+        left_board_chip_temp: The temp of the left board chips as an int.
+        center_board_temp: The temp of the center PCB as an int.
+        center_board_chip_temp: The temp of the center board chips as an int.
+        right_board_temp: The temp of the right PCB as an int.
+        right_board_chip_temp: The temp of the right board chips as an int.
         wattage: Current power draw of the miner as an int.
-        voltage: Current output voltage of the PSU as an float.
         wattage_limit: Power limit of the miner as an int.
-        fans: A list of fans on the miner with their speeds.
-        expected_fans: The number of fans expected on a miner.
-        fan_psu: The speed of the PSU on the fan if the miner collects it.
+        fan_1: The speed of the first fan as an int.
+        fan_2: The speed of the second fan as an int.
+        fan_3: The speed of the third fan as an int.
+        fan_4: The speed of the fourth fan as an int.
+        left_chips: The number of chips online in the left board as an int.
+        center_chips: The number of chips online in the left board as an int.
+        right_chips: The number of chips online in the left board as an int.
         total_chips: The total number of chips on all boards.  Calculated automatically.
-        expected_chips: The expected number of chips in the miner as an int.
-        percent_expected_chips: The percent of total chips out of the expected count.  Calculated automatically.
-        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.
-        config: The parsed config of the miner, using [`MinerConfig`][pyasic.config.MinerConfig].
+        ideal_chips: The ideal number of chips in the miner as an int.
+        percent_ideal: The percent of total chips out of the ideal count.  Calculated automatically.
+        nominal: The nominal amount of chips in the miner.  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.
         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.
-        is_mining: Whether the miner is mining.
-        pools: A list of PoolMetrics instances, each representing metrics for a pool.
+        fault_light: Whether or not the fault light is on as a boolean.
     """
 
-    # general
     ip: str
-    raw_datetime: datetime = Field(
-        exclude=True, default_factory=datetime.now(timezone.utc).astimezone, repr=False
+    datetime: datetime = None
+    mac: str = "00:00:00:00:00:00"
+    model: str = "Unknown"
+    hostname: str = "Unknown"
+    hashrate: float = 0
+    left_board_hashrate: float = 0
+    center_board_hashrate: float = 0
+    right_board_hashrate: float = 0
+    temperature_avg: int = field(init=False)
+    env_temp: float = 0
+    left_board_temp: int = 0
+    left_board_chip_temp: int = 0
+    center_board_temp: int = 0
+    center_board_chip_temp: int = 0
+    right_board_temp: int = 0
+    right_board_chip_temp: int = 0
+    wattage: int = 0
+    wattage_limit: int = 0
+    fan_1: int = -1
+    fan_2: int = -1
+    fan_3: int = -1
+    fan_4: int = -1
+    left_chips: int = 0
+    center_chips: int = 0
+    right_chips: int = 0
+    total_chips: int = field(init=False)
+    ideal_chips: int = 1
+    percent_ideal: float = field(init=False)
+    nominal: int = field(init=False)
+    pool_split: str = "0"
+    pool_1_url: str = "Unknown"
+    pool_1_user: str = "Unknown"
+    pool_2_url: str = ""
+    pool_2_user: str = ""
+    errors: List[Union[WhatsminerError, BraiinsOSError, X19Error]] = field(
+        default_factory=list
     )
-
-    # about
-    device_info: DeviceInfo | None = None
-    mac: str | None = None
-    api_ver: str | None = None
-    fw_ver: str | None = None
-    hostname: str | None = None
-
-    # hashrate
-    raw_hashrate: AlgoHashRateType = Field(exclude=True, default=None, repr=False)
-
-    # expected
-    expected_hashrate: AlgoHashRateType | None = None
-    expected_hashboards: int | None = None
-    expected_chips: int | None = None
-    expected_fans: int | None = None
-
-    # temperature
-    env_temp: int | None = None
-
-    # power
-    wattage: int | None = None
-    voltage: float | None = None
-    raw_wattage_limit: int | None = Field(exclude=True, default=None, repr=False)
-
-    # fans
-    fans: List[Fan] = Field(default_factory=list)
-    fan_psu: int | None = None
-
-    # boards
-    hashboards: List[HashBoard] = Field(default_factory=list)
-
-    # config
-    config: MinerConfig | None = None
-    fault_light: bool | None = None
-
-    # errors
-    errors: List[
-        Union[
-            WhatsminerError,
-            BraiinsOSError,
-            X19Error,
-            InnosiliconError,
-        ]
-    ] = Field(default_factory=list)
-
-    # mining state
-    is_mining: bool = True
-    uptime: int | None = None
-
-    # pools
-    pools: list[PoolMetrics] = Field(default_factory=list)
-
-    @classmethod
-    def fields(cls):
-        return list(cls.model_fields.keys())
+    fault_light: Union[bool, None] = None
 
     def __post_init__(self):
-        self.raw_datetime = datetime.now(timezone.utc).astimezone()
+        self.datetime = datetime.now()
 
-    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}")
-
-    def __setitem__(self, key, value):
-        return setattr(self, key, value)
-
-    def __iter__(self):
-        return iter([item for item in self.asdict()])
-
-    def __truediv__(self, other):
-        return self // other
-
-    def __floordiv__(self, other):
-        cp = copy.deepcopy(self)
-        for key in self.fields():
-            item = getattr(self, key)
-            if isinstance(item, int):
-                setattr(cp, key, item // other)
-            if isinstance(item, float):
-                setattr(cp, key, item / other)
-        return cp
-
-    def __add__(self, other):
-        if not isinstance(other, MinerData):
-            raise TypeError("Cannot add MinerData to non MinerData type.")
-        cp = copy.deepcopy(self)
-        for key in self.fields():
-            item = getattr(self, key)
-            other_item = getattr(other, key)
-            if item is None:
-                item = 0
-            if other_item is None:
-                other_item = 0
-
-            if isinstance(item, int):
-                setattr(cp, key, item + other_item)
-            if isinstance(item, float):
-                setattr(cp, key, item + other_item)
-            if isinstance(item, str):
-                setattr(cp, key, "")
-            if isinstance(item, list):
-                setattr(cp, key, item + other_item)
-            if isinstance(item, bool):
-                setattr(cp, key, item & other_item)
-        return cp
-
-    @computed_field  # type: ignore[misc]
     @property
-    def hashrate(self) -> AlgoHashRateType:
-        if len(self.hashboards) > 0:
-            hr_data = []
-            for item in self.hashboards:
-                if item.hashrate is not None:
-                    hr_data.append(item.hashrate)
-            if len(hr_data) > 0:
-                return sum(hr_data, start=type(hr_data[0])(rate=0))
-        return self.raw_hashrate
+    def total_chips(self):  # noqa - Skip PyCharm inspection
+        return self.right_chips + self.center_chips + self.left_chips
 
-    @field_serializer("hashrate")
-    def serialize_hashrate(self, hashrate: AlgoHashRateType | None) -> float:
-        if hashrate is not None:
-            return float(hashrate)
+    @total_chips.setter
+    def total_chips(self, val):
+        pass
 
-    @field_serializer("expected_hashrate")
-    def serialize_expected_hashrate(
-        self, expected_hashrate: AlgoHashRateType | None, _info
-    ) -> float:
-        if expected_hashrate is not None:
-            return float(expected_hashrate)
-
-    @hashrate.setter
-    def hashrate(self, val):
-        self.raw_hashrate = val
-
-    @computed_field  # type: ignore[misc]
     @property
-    def wattage_limit(self) -> int:
-        if self.config is not None:
-            if isinstance(self.config.mining_mode, MiningModePowerTune):
-                return self.config.mining_mode.power
-        return self.raw_wattage_limit
+    def nominal(self):  # noqa - Skip PyCharm inspection
+        return self.ideal_chips == self.total_chips
 
-    @wattage_limit.setter
-    def wattage_limit(self, val: int):
-        self.raw_wattage_limit = val
+    @nominal.setter
+    def nominal(self, val):
+        pass
 
-    @computed_field  # type: ignore[misc]
     @property
-    def total_chips(self) -> int | None:
-        if len(self.hashboards) > 0:
-            chip_data = []
-            for item in self.hashboards:
-                if item.chips is not None:
-                    chip_data.append(item.chips)
-            if len(chip_data) > 0:
-                return sum(chip_data)
-            return None
+    def percent_ideal(self):  # noqa - Skip PyCharm inspection
+        return round((self.total_chips / self.ideal_chips) * 100)
 
-    @computed_field  # type: ignore[misc]
-    @property
-    def nominal(self) -> bool | None:
-        if self.total_chips is None or self.expected_chips is None:
-            return None
-        return self.expected_chips == self.total_chips
+    @percent_ideal.setter
+    def percent_ideal(self, val):
+        pass
 
-    @computed_field  # type: ignore[misc]
     @property
-    def percent_expected_chips(self) -> int | None:
-        if self.total_chips is None or self.expected_chips is None:
-            return None
-        if self.total_chips == 0 or self.expected_chips == 0:
-            return 0
-        return round((self.total_chips / self.expected_chips) * 100)
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def percent_expected_hashrate(self) -> int | None:
-        if self.hashrate is None or self.expected_hashrate is None:
-            return None
-        try:
-            return round((self.hashrate / self.expected_hashrate) * 100)
-        except ZeroDivisionError:
-            return 0
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def percent_expected_wattage(self) -> int | None:
-        if self.wattage_limit is None or self.wattage is None:
-            return None
-        try:
-            return round((self.wattage / self.wattage_limit) * 100)
-        except ZeroDivisionError:
-            return 0
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def temperature_avg(self) -> int | None:
+    def temperature_avg(self):  # noqa - Skip PyCharm inspection
         total_temp = 0
         temp_count = 0
-        for hb in self.hashboards:
-            if hb.temp is not None:
-                total_temp += hb.temp
+        for temp in [
+            self.left_board_chip_temp,
+            self.center_board_chip_temp,
+            self.right_board_chip_temp,
+        ]:
+            if temp and not temp == 0:
+                total_temp += temp
                 temp_count += 1
         if not temp_count > 0:
-            return None
+            return 0
         return round(total_temp / temp_count)
 
-    @computed_field  # type: ignore[misc]
-    @property
-    def efficiency(self) -> int | None:
-        if self.hashrate is None or self.wattage is None:
-            return None
-        try:
-            return round(self.wattage / float(self.hashrate))
-        except ZeroDivisionError:
-            return 0
+    @temperature_avg.setter
+    def temperature_avg(self, val):
+        pass
 
-    @computed_field  # type: ignore[misc]
-    @property
-    def datetime(self) -> str:
-        return self.raw_datetime.isoformat()
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def timestamp(self) -> int:
-        return int(time.mktime(self.raw_datetime.timetuple()))
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def make(self) -> str:
-        if self.device_info.make is not None:
-            return str(self.device_info.make)
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def model(self) -> str:
-        if self.device_info.model is not None:
-            return str(self.device_info.model)
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def firmware(self) -> str:
-        if self.device_info.firmware is not None:
-            return str(self.device_info.firmware)
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def algo(self) -> str:
-        if self.device_info.algo is not None:
-            return str(self.device_info.algo)
-
-    def keys(self) -> list:
-        return list(self.model_fields.keys())
-
-    def asdict(self) -> dict:
-        return self.model_dump()
-
-    def as_dict(self) -> dict:
-        """Get this dataclass as a dictionary.
-
-        Returns:
-            A dictionary version of this class.
-        """
-        return self.asdict()
-
-    def as_json(self) -> str:
-        """Get this dataclass as JSON.
-
-        Returns:
-            A JSON version of this class.
-        """
-        return self.model_dump_json()
-
-    def as_csv(self) -> str:
-        """Get this dataclass as CSV.
-
-        Returns:
-            A CSV version of this class with no headers.
-        """
-        data = self.asdict()
-        errs = []
-        for error in data["errors"]:
-            errs.append(error["error_message"])
-        data["errors"] = "; ".join(errs)
-        data_list = [str(data[item]) for item in data]
-        return ",".join(data_list)
-
-    def as_influxdb(self, measurement_name: str = "miner_data") -> str:
-        """Get this dataclass as [influxdb line protocol](https://docs.influxdata.com/influxdb/v2.4/reference/syntax/line-protocol/).
-
-        Parameters:
-            measurement_name: The name of the measurement to insert into in influxdb.
-
-        Returns:
-            A influxdb line protocol version of this class.
-        """
-        tag_data = [measurement_name]
-        field_data = []
-
-        tags = ["ip", "mac", "model", "hostname"]
-        for attribute in self.fields():
-            if attribute in tags:
-                escaped_data = self.get(attribute, "Unknown").replace(" ", "\\ ")
-                tag_data.append(f"{attribute}={escaped_data}")
-                continue
-            elif str(attribute).startswith("_"):
-                continue
-            elif isinstance(self[attribute], str):
-                field_data.append(f'{attribute}="{self[attribute]}"')
-                continue
-            elif isinstance(self[attribute], bool):
-                field_data.append(f"{attribute}={str(self[attribute]).lower()}")
-                continue
-            elif isinstance(self[attribute], int):
-                field_data.append(f"{attribute}={self[attribute]}")
-                continue
-            elif isinstance(self[attribute], float):
-                field_data.append(f"{attribute}={self[attribute]}")
-                continue
-            elif attribute == "errors":
-                for idx, item in enumerate(self[attribute]):
-                    field_data.append(f'error_{idx+1}="{item.error_message}"')
-            elif attribute == "hashboards":
-                for idx, item in enumerate(self[attribute]):
-                    field_data.append(
-                        f"hashboard_{idx+1}_hashrate={item.get('hashrate', 0.0)}"
-                    )
-                    field_data.append(
-                        f"hashboard_{idx+1}_temperature={item.get('temp', 0)}"
-                    )
-                    field_data.append(
-                        f"hashboard_{idx+1}_chip_temperature={item.get('chip_temp', 0)}"
-                    )
-                    field_data.append(f"hashboard_{idx+1}_chips={item.get('chips', 0)}")
-                    field_data.append(
-                        f"hashboard_{idx+1}_expected_chips={item.get('expected_chips', 0)}"
-                    )
-            elif attribute == "fans":
-                for idx, item in enumerate(self[attribute]):
-                    if item.speed is not None:
-                        field_data.append(f"fan_{idx+1}={item.speed}")
-
-        tags_str = ",".join(tag_data)
-        field_str = ",".join(field_data)
-        timestamp = str(self.timestamp * 1e9)
-
-        return " ".join([tags_str, field_str, timestamp])
+    def asdict(self):
+        return asdict(self)

pyasic/data/boards.py

@@ -1,72 +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.                                              -
-# ------------------------------------------------------------------------------
-from __future__ import annotations
-
-from typing import Any
-
-from pydantic import BaseModel, field_serializer
-
-from pyasic.device.algorithm.hashrate import AlgoHashRateType
-
-
-class HashBoard(BaseModel):
-    """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.
-        tuned: Whether the board is tuned as a bool.
-        active: Whether the board is currently tuning as a bool.
-        voltage: Current input voltage of the board as a float.
-    """
-
-    slot: int = 0
-    hashrate: AlgoHashRateType | None = None
-    temp: float | None = None
-    chip_temp: float | None = None
-    chips: int | None = None
-    expected_chips: int | None = None
-    serial_number: str | None = None
-    missing: bool = True
-    tuned: bool | None = None
-    active: bool | None = None
-    voltage: float | None = None
-
-    @field_serializer("hashrate")
-    def serialize_hashrate(self, hashrate: AlgoHashRateType | None) -> float:
-        if hashrate is not None:
-            return float(hashrate)
-
-    def get(self, __key: str, default: Any = None):
-        try:
-            val = self.__getitem__(__key)
-            if val is None:
-                return default
-            return val
-        except KeyError:
-            return default
-
-    def __getitem__(self, item: str):
-        try:
-            return getattr(self, item)
-        except AttributeError:
-            raise KeyError(f"{item}")

pyasic/data/device.py

@@ -1,31 +0,0 @@
-from pydantic import BaseModel, ConfigDict, field_serializer
-
-from pyasic.device.algorithm import MinerAlgoType
-from pyasic.device.firmware import MinerFirmware
-from pyasic.device.makes import MinerMake
-from pyasic.device.models import MinerModelType
-
-
-class DeviceInfo(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True)
-
-    make: MinerMake | None = None
-    model: MinerModelType | None = None
-    firmware: MinerFirmware | None = None
-    algo: type[MinerAlgoType] | None = None
-
-    @field_serializer("make")
-    def serialize_make(self, make: MinerMake, _info):
-        return str(make)
-
-    @field_serializer("model")
-    def serialize_model(self, model: MinerModelType, _info):
-        return str(model)
-
-    @field_serializer("firmware")
-    def serialize_firmware(self, firmware: MinerFirmware, _info):
-        return str(firmware)
-
-    @field_serializer("algo")
-    def serialize_algo(self, algo: MinerAlgoType, _info):
-        return str(algo)

pyasic/data/error_codes/X19.py

@@ -1,28 +1,29 @@
-# ------------------------------------------------------------------------------
-#  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.data.error_codes.base import BaseMinerError
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from dataclasses import dataclass, asdict
 
 
-class X19Error(BaseMinerError):
+@dataclass
+class X19Error:
     """A Dataclass to handle error codes of X19 miners.
 
     Attributes:
         error_message: The error message as a string.
-        error_code: The error code as an int.  0 if the message is not assigned a code.
     """
 
     error_message: str
-    error_code: int = 0
+
+    def asdict(self):
+        return asdict(self)

pyasic/data/error_codes/__init__.py

@@ -1,26 +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.                                              -
-# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
 
-from typing import TypeVar
-
-from .bos import BraiinsOSError
-from .innosilicon import InnosiliconError
 from .whatsminer import WhatsminerError
+from .bos import BraiinsOSError
 from .X19 import X19Error
-
-MinerErrorData = TypeVar(
-    "MinerErrorData", WhatsminerError, BraiinsOSError, X19Error, InnosiliconError
-)

pyasic/data/error_codes/base.py

@@ -1,18 +0,0 @@
-from pydantic import BaseModel
-
-
-class BaseMinerError(BaseModel):
-    @classmethod
-    def fields(cls):
-        return list(cls.model_fields.keys())
-
-    def asdict(self) -> dict:
-        return self.model_dump()
-
-    def as_dict(self) -> dict:
-        """Get this dataclass as a dictionary.
-
-        Returns:
-            A dictionary version of this class.
-        """
-        return self.asdict()

pyasic/data/error_codes/bos.py

@@ -1,29 +1,29 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
 
-from pyasic.data.error_codes.base import BaseMinerError
+from dataclasses import dataclass, asdict
 
 
-class BraiinsOSError(BaseMinerError):
+@dataclass
+class BraiinsOSError:
     """A Dataclass to handle error codes of BraiinsOS+ miners.
 
     Attributes:
         error_message: The error message as a string.
-        error_code: The error code as an int.  0 if the message is not assigned a code.
     """
 
     error_message: str
-    error_code: int = 0
+
+    def asdict(self):
+        return asdict(self)