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

* docs: add docstring for antminer and auradine in web

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

* Remove Trailing whitespace from the docstring

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

* Remove Trailing whitespace from the docstring

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

* Remove Trailing whitespace from the docstring of the fucntion multicommand

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

---------

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

.pre-commit-config.yaml

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

README.md

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

docs/API/api.md

@@ -1,25 +0,0 @@
-# pyasic
-## Miner APIs
-Each miner has a unique API that is used to communicate with it.
-Each of these API types has commands that differ between them, and some commands have data that others do not.
-Each miner that is a subclass of [`BaseMiner`][pyasic.miners.BaseMiner] should have an API linked to it as `Miner.api`.
-
-All API implementations inherit from [`BaseMinerAPI`][pyasic.API.BaseMinerAPI], which implements the basic communications protocols.
-
-[`BaseMinerAPI`][pyasic.API.BaseMinerAPI] should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare).
-[`BaseMinerAPI`][pyasic.API.BaseMinerAPI] cannot be instantiated directly, it will raise a `TypeError`.
-Use these instead -
-
-#### [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/config/miner_config.md

@@ -6,19 +6,3 @@
     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/miner_data.md

@@ -1,6 +1,6 @@
 # pyasic
-## Miner Data
 
+## Miner Data
 ::: pyasic.data.MinerData
     handler: python
     options:
@@ -13,3 +13,10 @@
     options:
         show_root_heading: false
         heading_level: 4
+
+## Fan Data
+::: pyasic.data.Fan
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/generate_miners.py

@@ -0,0 +1,169 @@
+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"
+
+
+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,25 +1,56 @@
 # pyasic
-*A set of modules for interfacing with many common types of ASIC bitcoin miners, using both their API and SSH.*
+*A simplified and standardized interface for Bitcoin ASICs.*
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![pypi](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
-[![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)
 
+[![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)
+
+---
 ## 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.
 
-[Supported Miner Types](miners/supported_types.md)
+[Click here to view supported miner types](miners/supported_types.md)
 
-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.
+---
+## Installation
 
-<br>
+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
 
-## 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.
+```
+    poetry install
+```
+
+  - [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
+  - [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
+
+```
+    pyenv install <python version number>
+    pyenv virtualenv <python version number> <env name>
+    pyenv activate <env name>
+```
+
+  - [conda](https://docs.conda.io/en/latest/)
+
+##### Installing `pyasic`
+
+`python -m pip install .` or `poetry install`
+
+---
+## Getting started
+---
+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`][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.
 ```python
 import asyncio  # asyncio for handling the async part
 from pyasic.network import MinerNetwork  # miner network handles the scanning
@@ -28,60 +59,70 @@ from pyasic.network import MinerNetwork  # miner network handles the scanning
 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
+    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_network_for_miners()
+    miners = await network.scan()
     print(miners)
 
 if __name__ == "__main__":
     asyncio.run(scan_miners())  # 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.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.
+---
+##### 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.
 ```python
 import asyncio  # asyncio for handling the async part
-from pyasic.miners.miner_factory import MinerFactory  # miner factory handles miners creation
+from pyasic import get_miner # handles miner creation
 
 
 async def get_miners():  # define async scan function to allow awaiting
-    # get the miner with miner factory
-    # miner factory is a singleton, and will always use the same object and cache
-    # this means you can always call it as MinerFactory().get_miner()
-    miner_1 = await MinerFactory().get_miner("192.168.1.75")
-    miner_2 = await MinerFactory().get_miner("192.168.1.76")
+    # get the miner with the miner factory
+    # the miner factory is a singleton, and will always use the same object and cache
+    # this means you can always call it as MinerFactory().get_miner(), or just get_miner()
+    miner_1 = await get_miner("192.168.1.75")
+    miner_2 = await get_miner("192.168.1.76")
     print(miner_1, miner_2)
 
+    # can also gather these, since they are async
+    # gathering them will get them both at the same time
+    # this makes it much faster to get a lot of miners at a time
+    tasks = [get_miner("192.168.1.75"), get_miner("192.168.1.76")]
+    miners = await asyncio.gather(*tasks)
+    print(miners)
+
+
 if __name__ == "__main__":
     asyncio.run(get_miners())  # get the miners asynchronously with asyncio.run()
 ```
 
-<br>
-
-## 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.
+---
+## 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.
 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
-from pyasic.miners.miner_factory import MinerFactory
+from pyasic import get_miner
 
 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
+    miner = await get_miner("192.168.1.75")
+    if miner is not None:
+        miner_data = await miner.get_data()
+        print(miner_data)  # all data from the dataclass
+        print(miner_data.hashrate)  # hashrate of the miner in TH/s
 
 if __name__ == "__main__":
     asyncio.run(gather_miner_data())
 ```
-
+---
+##### Multiple miners
 You can do something similar with multiple miners, with only needing to make a small change to get all the data at once.
 ```python
 import asyncio  # asyncio for handling the async part
@@ -89,8 +130,8 @@ from pyasic.network import MinerNetwork  # miner network handles the scanning
 
 
 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()
+    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])
@@ -102,152 +143,60 @@ if __name__ == "__main__":
     asyncio.run(gather_miner_data())
 ```
 
-<br>
-
-## Controlling miners via pyasic
-Every miner class in pyasic must implement all the control functions defined in [`BaseMiner`][pyasic.miners.BaseMiner].
+---
+## Miner control
+---
+`pyasic` exposes a standard interface for each miner using control functions.
+Every miner class in `pyasic` must implement all the control functions defined in [`MinerProtocol`][pyasic.miners.base.MinerProtocol].
 
 These functions are
-[`check_light`](#check-light),
-[`fault_light_off`](#fault-light-off),
-[`fault_light_on`](#fault-light-on),
-[`get_config`](#get-config),
-[`get_data`](#get-data),
-[`get_errors`](#get-errors),
-[`get_hostname`](#get-hostname),
-[`get_model`](#get-model),
-[`reboot`](#reboot),
-[`restart_backend`](#restart-backend),
-[`stop_mining`](#stop-mining),
-[`resume_mining`](#resume-mining),
-[`send_config`](#send-config), and
-[`set_power_limit`](#set-power-limit).
+[`check_light`][pyasic.miners.base.MinerProtocol.check_light],
+[`fault_light_off`][pyasic.miners.base.MinerProtocol.fault_light_off],
+[`fault_light_on`][pyasic.miners.base.MinerProtocol.fault_light_on],
+[`get_config`][pyasic.miners.base.MinerProtocol.get_config],
+[`get_data`][pyasic.miners.base.MinerProtocol.get_data],
+[`get_errors`][pyasic.miners.base.MinerProtocol.get_errors],
+[`get_hostname`][pyasic.miners.base.MinerProtocol.get_hostname],
+[`get_model`][pyasic.miners.base.MinerProtocol.get_model],
+[`reboot`][pyasic.miners.base.MinerProtocol.reboot],
+[`restart_backend`][pyasic.miners.base.MinerProtocol.restart_backend],
+[`stop_mining`][pyasic.miners.base.MinerProtocol.stop_mining],
+[`resume_mining`][pyasic.miners.base.MinerProtocol.resume_mining],
+[`is_mining`][pyasic.miners.base.MinerProtocol.is_mining],
+[`send_config`][pyasic.miners.base.MinerProtocol.send_config], and
+[`set_power_limit`][pyasic.miners.base.MinerProtocol.set_power_limit].
 
-<br>
+##### Usage
+```python
+import asyncio
+from pyasic import get_miner
 
-### Check Light
-::: pyasic.miners.BaseMiner.check_light
-    handler: python
-    options:
-        heading_level: 4
 
-<br>
+async def set_fault_light():
+    miner = await get_miner("192.168.1.20")
 
-### Fault Light Off
-::: pyasic.miners.BaseMiner.fault_light_off
-    handler: python
-    options:
-        heading_level: 4
+    # call control function
+    await miner.fault_light_on()
 
-<br>
+if __name__ == "__main__":
+    asyncio.run(set_fault_light())
+```
 
-### Fault Light On
-::: pyasic.miners.BaseMiner.fault_light_on
-    handler: python
-    options:
-        heading_level: 4
+---
+## Helper dataclasses
+---
 
-<br>
+##### [`MinerConfig`][pyasic.config.MinerConfig] and [`MinerData`][pyasic.data.MinerData]
 
-### Get Config
-::: pyasic.miners.BaseMiner.get_config
-    handler: python
-    options:
-        heading_level: 4
+`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()`.
 
-<br>
+---
 
-### Get Data
-::: pyasic.miners.BaseMiner.get_data
-    handler: python
-    options:
-        heading_level: 4
-
-<br>
-
-### Get Errors
-::: pyasic.miners.BaseMiner.get_errors
-    handler: python
-    options:
-        heading_level: 4
-
-<br>
-
-### Get Hostname
-::: pyasic.miners.BaseMiner.get_hostname
-    handler: python
-    options:
-        heading_level: 4
-
-<br>
-
-### Get Model
-::: pyasic.miners.BaseMiner.get_model
-    handler: python
-    options:
-        heading_level: 4
-
-<br>
-
-### Reboot
-::: pyasic.miners.BaseMiner.reboot
-    handler: python
-    options:
-        heading_level: 4
-
-<br>
-
-### Restart Backend
-::: pyasic.miners.BaseMiner.restart_backend
-    handler: python
-    options:
-        heading_level: 4
-
-<br>
-
-### Stop Mining
-::: pyasic.miners.BaseMiner.stop_mining
-    handler: python
-    options:
-        heading_level: 4
-
-<br>
-
-### Resume Mining
-::: pyasic.miners.BaseMiner.resume_mining
-    handler: python
-    options:
-        heading_level: 4
-
-<br>
-
-### Send Config
-::: pyasic.miners.BaseMiner.send_config
-    handler: python
-    options:
-        heading_level: 4
-
-<br>
-
-### Set Power Limit
-::: pyasic.miners.BaseMiner.set_power_limit
-    handler: python
-    options:
-        heading_level: 4
-
-<br>
-
-## [`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()`.
-
-<br>
-
-### [`MinerData`][pyasic.data.MinerData]
+##### [`MinerData`][pyasic.data.MinerData]
 
 [`MinerData`][pyasic.data.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.asdict()`][pyasic.data.MinerData.asdict] to get the dataclass as a dictionary, and there are many other helper functions contained in the class to convert to different data formats.
+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
@@ -262,13 +211,65 @@ list_of_miner_data = [d1, d2]
 average_data = sum(list_of_miner_data, start=MinerData("0.0.0.0"))/len(list_of_miner_data)
 ```
 
+---
 
-<br>
+##### [`MinerConfig`][pyasic.config.MinerConfig]
 
-### [`MinerConfig`][pyasic.config.MinerConfig]
-
-[`MinerConfig`][pyasic.config.MinerConfig] is pyasic's way to represent a configuration file from a miner.
-It is the return from [`get_config()`](#get-config).
+[`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()`](#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()`](#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_password", "my_pwd")
+```
+
+##### Default values:
+```
+"network_ping_retries": 1,
+"network_ping_timeout": 3,
+"network_scan_threads": 300,
+"factory_get_retries": 1,
+"factory_get_timeout": 3,
+"get_data_retries": 1,
+"api_function_timeout": 5,
+"antminer_mining_mode_as_str": False,
+"default_whatsminer_password": "admin",
+"default_innosilicon_password": "admin",
+"default_antminer_password": "root",
+"default_bosminer_password": "root",
+"default_vnish_password": "admin",
+"default_goldshell_password": "123456789",
+
+# ADVANCED
+# Only use this if you know what you are doing
+"socket_linger_time": 1000,
+```

docs/miners/antminer/X15.md

@@ -0,0 +1,10 @@
+# pyasic
+## X15 Models
+
+## Z15
+::: pyasic.miners.antminer.cgminer.X15.Z15.CGMinerZ15
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/antminer/X17.md

@@ -2,7 +2,6 @@
 ## X17 Models
 
 ## S17
-
 ::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17
     handler: python
     options:
@@ -10,31 +9,27 @@
         heading_level: 4
 
 ## S17+
-
-::: pyasic.miners.antminer.bmminer.X17.S17_Plus.BMMinerS17Plus
+::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17Plus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S17 Pro
-
-::: pyasic.miners.antminer.bmminer.X17.S17_Pro.BMMinerS17Pro
+::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17Pro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S17e
-
-::: pyasic.miners.antminer.bmminer.X17.S17e.BMMinerS17e
+::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17e
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## T17
-
 ::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17
     handler: python
     options:
@@ -42,76 +37,79 @@
         heading_level: 4
 
 ## T17+
-
-::: pyasic.miners.antminer.bmminer.X17.T17_Plus.BMMinerT17Plus
+::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17Plus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-
 ## T17e
-
-::: pyasic.miners.antminer.bmminer.X17.T17e.BMMinerT17e
+::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17e
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-
-## S17 (BOS)
-
+## S17 (BOS+)
 ::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S17+ (BOS)
-
-::: pyasic.miners.antminer.bosminer.X17.S17_Plus.BOSMinerS17Plus
+## 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_Pro.BOSMinerS17Pro
+## 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.S17e.BOSMinerS17e
+## S17e (BOS+)
+::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17e
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T17 (BOS)
-
+## T17 (BOS+)
 ::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T17+ (BOS)
-
-::: pyasic.miners.antminer.bosminer.X17.T17_Plus.BOSMinerT17Plus
+## 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.T17e.BOSMinerT17e
+## 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

@@ -2,101 +2,429 @@
 ## X19 Models
 
 ## S19
-
 ::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
+## S19L
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19L
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
 ## S19 Pro
-
-::: pyasic.miners.antminer.bmminer.X19.S19_Pro.BMMinerS19Pro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19Pro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-
-## S19a
-
-::: pyasic.miners.antminer.bmminer.X19.S19a.BMMinerS19a
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-
 ## S19j
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19j
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
-::: pyasic.miners.antminer.bmminer.X19.S19j.BMMinerS19j
+## S19i
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19i
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19+
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j No PIC
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19jNoPIC
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro+
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19ProPlus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S19j Pro
-
-::: pyasic.miners.antminer.bmminer.X19.S19j_Pro.BMMinerS19jPro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19jPro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S19 XP
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19XP
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
-::: pyasic.miners.antminer.bmminer.X19.S19_XP.BMMinerS19XP
+## S19a
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19a
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19a Pro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19aPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Hydro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19Hydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro Hydro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19ProHydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro+ Hydro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19ProPlusHydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19K Pro
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19KPro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## T19
-
 ::: pyasic.miners.antminer.bmminer.X19.T19.BMMinerT19
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-
-## S19 (BOS)
-
+## S19
 ::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19 Pro (BOS)
-
-::: pyasic.miners.antminer.bosminer.X19.S19_Pro.BOSMinerS19Pro
+## S19+
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19Plus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-
-## S19j (BOS)
-
-::: pyasic.miners.antminer.bosminer.X19.S19j.BOSMinerS19j
+## S19 Pro
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19Pro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## S19j Pro (BOS)
-
-::: pyasic.miners.antminer.bosminer.X19.S19j_Pro.BOSMinerS19jPro
+## S19a
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19a
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## T19 (BOS)
+## S19a Pro
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19aPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
+## S19j
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19j
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j No PIC
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jNoPIC
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro No PIC
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProNoPIC
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro+
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro+
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro+ No PIC
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jProPlusNoPIC
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19k Pro No PIC
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19kProNoPIC
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 XP
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19XP
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T19
 ::: pyasic.miners.antminer.bosminer.X19.T19.BOSMinerT19
     handler: python
     options:
         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
+
+## 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
+
+## 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
+
+## S19 (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19jPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro+ (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19jProPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19k Pro (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19kPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 XP (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.S19.LUXMinerS19XP
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T19 (LuxOS)
+::: pyasic.miners.antminer.luxos.X19.T19.LUXMinerT19
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19j
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j No PIC (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19jNoPIC
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19jPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 XP (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19XP
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19K Pro (MaraFW)
+::: pyasic.miners.antminer.marathon.X19.S19.MaraS19KPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/antminer/X21.md

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

docs/miners/antminer/X3.md

@@ -0,0 +1,38 @@
+# pyasic
+## X3 Models
+
+## D3
+::: pyasic.miners.antminer.cgminer.X3.D3.CGMinerD3
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## HS3
+::: pyasic.miners.antminer.bmminer.X3.HS3.BMMinerHS3
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## L3+
+::: pyasic.miners.antminer.bmminer.X3.L3.BMMinerL3Plus
+    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

@@ -0,0 +1,10 @@
+# pyasic
+## X5 Models
+
+## DR5
+::: pyasic.miners.antminer.cgminer.X5.DR5.CGMinerDR5
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/antminer/X7.md

@@ -0,0 +1,17 @@
+# pyasic
+## X7 Models
+
+## L7
+::: pyasic.miners.antminer.bmminer.X7.L7.BMMinerL7
+    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,18 +1,14 @@
 # pyasic
 ## X9 Models
 
-
-## X9 (BOS)
-
-::: pyasic.miners.antminer.bosminer.X9.S9.BOSMinerS9
+## E9Pro
+::: pyasic.miners.antminer.bmminer.X9.E9.BMMinerE9Pro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-
 ## S9
-
 ::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9
     handler: python
     options:
@@ -20,17 +16,44 @@
         heading_level: 4
 
 ## S9i
+::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9i
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
-::: pyasic.miners.antminer.bmminer.X9.S9i.BMMinerS9i
+## S9j
+::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9j
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## T9
-
 ::: 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 (Hive)
+::: 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

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

docs/miners/auradine/AI.md

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

docs/miners/auradine/AT.md

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

docs/miners/avalonminer/A10X.md

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

docs/miners/avalonminer/A11X.md

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

docs/miners/avalonminer/A12X.md

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

docs/miners/avalonminer/A7X.md

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

docs/miners/avalonminer/A8X.md

@@ -1,26 +1,24 @@
 # pyasic
 ## A8X Models
 
-## A821
-
+## Avalon 821
 ::: pyasic.miners.avalonminer.cgminer.A8X.A821.CGMinerAvalon821
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## A841
-
+## Avalon 841
 ::: pyasic.miners.avalonminer.cgminer.A8X.A841.CGMinerAvalon841
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## A851
-
+## Avalon 851
 ::: 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
 
-## A921
-
+## Avalon 921
 ::: pyasic.miners.avalonminer.cgminer.A9X.A921.CGMinerAvalon921
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
+

docs/miners/backends/bfgminer.md

@@ -0,0 +1,8 @@
+# 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,7 +1,15 @@
 # pyasic
 ## BOSMiner Backend
 
-::: pyasic.miners._backends.bosminer.BOSMiner
+::: pyasic.miners.backends.braiins_os.BOSMiner
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## BOSer Backend
+
+::: pyasic.miners.backends.braiins_os.BOSer
     handler: python
     options:
         show_root_heading: false

docs/miners/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,6 +1,7 @@
 # pyasic
-## BOSMinerAPI
-::: pyasic.API.bosminer.BOSMinerAPI
+## ePIC Backend
+
+::: pyasic.miners.backends.epic.ePIC
     handler: python
     options:
         show_root_heading: false

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

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

docs/miners/backends/vnish.md

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

docs/miners/base_miner.md

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

docs/miners/functions.md

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

docs/miners/goldshell/X5.md

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

docs/miners/goldshell/XBox.md

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

docs/miners/goldshell/XMax.md

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

docs/miners/innosilicon/A10X.md

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

docs/miners/innosilicon/T3X.md

@@ -2,9 +2,9 @@
 ## T3X Models
 
 ## T3H+
-
-::: pyasic.miners.innosilicon.cgminer.T3X.T3H_Plus.CGMinerInnosiliconT3HPlus
+::: pyasic.miners.innosilicon.cgminer.T3X.T3H.InnosiliconT3HPlus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
+

docs/miners/miner_factory.md

@@ -1,7 +1,23 @@
 # pyasic
 ## Miner Factory
 
-::: pyasic.miners.miner_factory.MinerFactory
+[`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
     handler: python
     options:
         show_root_heading: false
@@ -9,12 +25,12 @@
 <br>
 
 ## AnyMiner
-::: pyasic.miners.miner_factory.AnyMiner
+::: pyasic.miners.base.AnyMiner
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-[`AnyMiner`][pyasic.miners.miner_factory.AnyMiner] is a placeholder type variable used for typing returns of functions.
-A function returning [`AnyMiner`][pyasic.miners.miner_factory.AnyMiner] will always return a subclass of [`BaseMiner`][pyasic.miners.BaseMiner],
+[`AnyMiner`][pyasic.miners.base.AnyMiner] is a placeholder type variable used for typing returns of functions.
+A function returning [`AnyMiner`][pyasic.miners.base.AnyMiner] will always return a subclass of [`BaseMiner`][pyasic.miners.base.BaseMiner],
 and is used to specify a function returning some arbitrary type of miner class instance.

docs/miners/whatsminer/M2X.md

@@ -1,90 +1,94 @@
 # pyasic
 ## M2X Models
 
-## M20V10
-
+## M20 V10
 ::: pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20V10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20SV10
-
+## M20S V10
 ::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20SV20
-
+## M20S V20
 ::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20SV30
-
+## M20S V30
 ::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20S+V30
+## M20P V10
+::: pyasic.miners.whatsminer.btminer.M2X.M20P.BTMinerM20PV10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
+## M20P V30
+::: pyasic.miners.whatsminer.btminer.M2X.M20P.BTMinerM20PV30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M20S+ V30
 ::: pyasic.miners.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlusV30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21V10
-
+## M21 V10
 ::: pyasic.miners.whatsminer.btminer.M2X.M21.BTMinerM21V10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21SV20
-
+## M21S V20
 ::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21SV60
-
+## M21S V60
 ::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV60
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21SV70
-
+## M21S V70
 ::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV70
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21S+V20
-
+## M21S+ V20
 ::: pyasic.miners.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlusV20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M29V10
-
+## M29 V10
 ::: pyasic.miners.whatsminer.btminer.M2X.M29.BTMinerM29V10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
+

docs/miners/whatsminer/M5X.md

@@ -1,242 +1,262 @@
 # pyasic
 ## M5X Models
 
-## M50VG30
+## M50 VE30
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VE30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
+## M50 VG30
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VG30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH10
-
+## M50 VH10
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH20
-
+## M50 VH20
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH30
-
+## M50 VH30
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH40
-
+## M50 VH40
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH40
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH50
-
+## M50 VH50
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH50
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH60
-
+## M50 VH60
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH60
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH70
-
+## M50 VH70
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH70
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH80
-
+## M50 VH80
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH80
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VJ10
-
+## M50 VJ10
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VJ20
-
+## M50 VJ20
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VJ30
-
+## M50 VJ30
 ::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVJ10
-
+## M50S VJ10
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVJ20
-
+## M50S VJ20
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVJ30
-
+## M50S VJ30
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVH10
-
+## M50S VH10
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVH20
-
+## M50S VH20
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVH30
-
+## M50S VH30
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVH40
-
+## M50S VH40
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH40
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVH50
-
+## M50S VH50
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH50
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50S+VH30
-
+## M50S+ VH30
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50S+VH40
-
+## M50S+ VH40
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH40
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50S+VJ30
-
+## M50S+ VJ30
 ::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVJ30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M53VH30
+## M50S+ VK20
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVK20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
+## M50S++ VK10
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus_Plus.BTMinerM50SPlusPlusVK10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M50S++ VK20
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus_Plus.BTMinerM50SPlusPlusVK20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M50S++ VK30
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus_Plus.BTMinerM50SPlusPlusVK30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M53 VH30
 ::: pyasic.miners.whatsminer.btminer.M5X.M53.BTMinerM53VH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M53SVH30
-
+## M53S VH30
 ::: pyasic.miners.whatsminer.btminer.M5X.M53S.BTMinerM53SVH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M53S+VJ30
+## M53S VJ40
+::: pyasic.miners.whatsminer.btminer.M5X.M53S.BTMinerM53SVJ40
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
+## M53S+ VJ30
 ::: pyasic.miners.whatsminer.btminer.M5X.M53S_Plus.BTMinerM53SPlusVJ30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M56VH30
+## M53S++ VK10
+::: pyasic.miners.whatsminer.btminer.M5X.M53S_Plus_Plus.BTMinerM53SPlusPlusVK10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
+## M56 VH30
 ::: pyasic.miners.whatsminer.btminer.M5X.M56.BTMinerM56VH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M56SVH30
-
+## M56S VH30
 ::: pyasic.miners.whatsminer.btminer.M5X.M56S.BTMinerM56SVH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M56S+VJ30
-
+## M56S+ VJ30
 ::: pyasic.miners.whatsminer.btminer.M5X.M56S_Plus.BTMinerM56SPlusVJ30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M59VH30
-
+## M59 VH30
 ::: pyasic.miners.whatsminer.btminer.M5X.M59.BTMinerM59VH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
+

docs/miners/whatsminer/M6X.md

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

docs/network/miner_network_range.md

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

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

docs/rpc/api.md

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

docs/rpc/bfgminer.md

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

docs/rpc/bmminer.md

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

docs/rpc/bosminer.md

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

docs/rpc/btminer.md

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

docs/rpc/cgminer.md

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

docs/rpc/luxminer.md

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

docs/rpc/unknown.md

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

docs/settings/settings.md

@@ -0,0 +1,37 @@
+# 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_password`
+- `default_innosilicon_password`
+- `default_antminer_password`
+- `default_bosminer_password`
+- `default_vnish_password`
+- `default_goldshell_password`
+- `socket_linger_time`
+
+
+### 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

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

docs/web/api.md

@@ -0,0 +1,27 @@
+# pyasic
+## Miner Web APIs
+Each miner has a unique Web API that is used to communicate with it.
+Each of these API types has commands that differ between them, and some commands have data that others do not.
+Each miner that is a subclass of [`BaseMiner`][pyasic.miners.base.BaseMiner] may have an API linked to it as `Miner.web`.
+
+All API implementations inherit from [`BaseWebAPI`][pyasic.web.BaseWebAPI], which implements the basic communications protocols.
+
+[`BaseWebAPI`][pyasic.web.BaseWebAPI] should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare).
+Use these instead -
+
+#### [AntminerModerNWebAPI][pyasic.web.antminer.AntminerModernWebAPI]
+#### [AntminerOldWebAPI][pyasic.web.antminer.AntminerOldWebAPI]
+#### [AuradineWebAPI][pyasic.web.auradine.AuradineWebAPI]
+#### [ePICWebAPI][pyasic.web.epic.ePICWebAPI]
+#### [GoldshellWebAPI][pyasic.web.goldshell.GoldshellWebAPI]
+#### [InnosiliconWebAPI][pyasic.web.innosilicon.InnosiliconWebAPI]
+#### [MaraWebAPI][pyasic.web.marathon.MaraWebAPI]
+#### [VNishWebAPI][pyasic.web.vnish.VNishWebAPI]
+
+<br>
+
+## BaseWebAPI
+::: pyasic.web.BaseWebAPI
+    handler: python
+    options:
+        heading_level: 4

docs/web/auradine.md

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

docs/web/epic.md

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

docs/web/goldshell.md

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

docs/web/innosilicon.md

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

docs/web/marathon.md

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

docs/web/vnish.md

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

mkdocs.yml

@@ -1,46 +1,76 @@
 site_name: pyasic
 repo_url: https://github.com/UpstreamData/pyasic
 nav:
-  - Introduction: "index.md"
-  - Miners:
-      - Supported Miners: "miners/supported_types.md"
-      - Miner Factory: "miners/miner_factory.md"
-      - Backends:
-          - BMMiner: "miners/backends/bmminer.md"
-          - BOSMiner: "miners/backends/bosminer.md"
-          - 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"
-          - Whatsminer M5X: "miners/whatsminer/M5X.md"
-          - Innosilicon T3X: "miners/innosilicon/T3X.md"
-  - Network:
-      - Miner Network: "network/miner_network.md"
-      - Miner Network Range: "network/miner_network_range.md"
-  - Dataclasses:
-      - Miner Data: "data/miner_data.md"
-      - Error Codes: "data/error_codes.md"
-      - Miner Config: "config/miner_config.md"
-  - Advanced:
-      - Miner APIs:
-          - Intro: "API/api.md"
-          - BMMiner: "API/bmminer.md"
-          - BOSMiner: "API/bosminer.md"
-          - BTMiner: "API/btminer.md"
-          - CGMiner: "API/cgminer.md"
-          - Unknown: "API/unknown.md"
-
-      - Base Miner: "miners/base_miner.md"
-
+- Introduction: "index.md"
+- Miners:
+    - Supported Miners: "miners/supported_types.md"
+    - 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 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"
+        - Goldshell X5: "miners/goldshell/X5.md"
+        - Goldshell XMax: "miners/goldshell/XMax.md"
+        - Goldshell XBox: "miners/goldshell/XBox.md"
+        - Auradine AD: "miners/auradine/AD.md"
+        - Auradine AI: "miners/auradine/AI.md"
+        - Auradine AT: "miners/auradine/AT.md"
+    - Base Miner: "miners/base_miner.md"
+- Settings:
+      - Settings: "settings/settings.md"
 
 plugins:
   - mkdocstrings

poetry.lock

@@ -1,971 +0,0 @@
-[[package]]
-name = "anyio"
-version = "3.6.2"
-description = "High level compatibility layer for multiple asynchronous event loop implementations"
-category = "main"
-optional = false
-python-versions = ">=3.6.2"
-
-[package.dependencies]
-idna = ">=2.8"
-sniffio = ">=1.1"
-
-[package.extras]
-doc = ["packaging", "sphinx-autodoc-typehints (>=1.2.0)", "sphinx-rtd-theme"]
-test = ["contextlib2", "coverage[toml] (>=4.5)", "hypothesis (>=4.0)", "mock (>=4)", "pytest (>=7.0)", "pytest-mock (>=3.6.1)", "trustme", "uvloop (<0.15)", "uvloop (>=0.15)"]
-trio = ["trio (>=0.16,<0.22)"]
-
-[[package]]
-name = "asyncssh"
-version = "2.13.1"
-description = "AsyncSSH: Asynchronous SSHv2 client and server library"
-category = "main"
-optional = false
-python-versions = ">= 3.6"
-
-[package.dependencies]
-cryptography = ">=3.1"
-typing-extensions = ">=3.6"
-
-[package.extras]
-bcrypt = ["bcrypt (>=3.1.3)"]
-fido2 = ["fido2 (>=0.9.2)"]
-gssapi = ["gssapi (>=1.2.0)"]
-libnacl = ["libnacl (>=1.4.2)"]
-pkcs11 = ["python-pkcs11 (>=0.7.0)"]
-pyopenssl = ["pyOpenSSL (>=17.0.0)"]
-pywin32 = ["pywin32 (>=227)"]
-
-[[package]]
-name = "certifi"
-version = "2022.12.7"
-description = "Python package for providing Mozilla's CA Bundle."
-category = "main"
-optional = false
-python-versions = ">=3.6"
-
-[[package]]
-name = "cffi"
-version = "1.15.1"
-description = "Foreign Function Interface for Python calling C code."
-category = "main"
-optional = false
-python-versions = "*"
-
-[package.dependencies]
-pycparser = "*"
-
-[[package]]
-name = "cfgv"
-version = "3.3.1"
-description = "Validate configuration and produce human readable error messages."
-category = "dev"
-optional = false
-python-versions = ">=3.6.1"
-
-[[package]]
-name = "click"
-version = "8.1.3"
-description = "Composable command line interface toolkit"
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-colorama = {version = "*", markers = "platform_system == \"Windows\""}
-
-[[package]]
-name = "colorama"
-version = "0.4.6"
-description = "Cross-platform colored terminal text."
-category = "dev"
-optional = false
-python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
-
-[[package]]
-name = "cryptography"
-version = "39.0.1"
-description = "cryptography is a package which provides cryptographic recipes and primitives to Python developers."
-category = "main"
-optional = false
-python-versions = ">=3.6"
-
-[package.dependencies]
-cffi = ">=1.12"
-
-[package.extras]
-docs = ["sphinx (>=5.3.0)", "sphinx-rtd-theme (>=1.1.1)"]
-docstest = ["pyenchant (>=1.6.11)", "sphinxcontrib-spelling (>=4.0.1)", "twine (>=1.12.0)"]
-pep8test = ["black", "check-manifest", "mypy", "ruff", "types-pytz", "types-requests"]
-sdist = ["setuptools-rust (>=0.11.4)"]
-ssh = ["bcrypt (>=3.1.5)"]
-test = ["hypothesis (>=1.11.4,!=3.79.2)", "iso8601", "pretend", "pytest (>=6.2.0)", "pytest-benchmark", "pytest-cov", "pytest-shard (>=0.1.2)", "pytest-subtests", "pytest-xdist", "pytz"]
-test-randomorder = ["pytest-randomly"]
-tox = ["tox"]
-
-[[package]]
-name = "distlib"
-version = "0.3.6"
-description = "Distribution utilities"
-category = "dev"
-optional = false
-python-versions = "*"
-
-[[package]]
-name = "filelock"
-version = "3.9.0"
-description = "A platform independent file lock."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.extras]
-docs = ["furo (>=2022.12.7)", "sphinx (>=5.3)", "sphinx-autodoc-typehints (>=1.19.5)"]
-testing = ["covdefaults (>=2.2.2)", "coverage (>=7.0.1)", "pytest (>=7.2)", "pytest-cov (>=4)", "pytest-timeout (>=2.1)"]
-
-[[package]]
-name = "ghp-import"
-version = "2.1.0"
-description = "Copy your docs directly to the gh-pages branch."
-category = "dev"
-optional = false
-python-versions = "*"
-
-[package.dependencies]
-python-dateutil = ">=2.8.1"
-
-[package.extras]
-dev = ["flake8", "markdown", "twine", "wheel"]
-
-[[package]]
-name = "griffe"
-version = "0.25.5"
-description = "Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-colorama = ">=0.4"
-
-[package.extras]
-async = ["aiofiles (>=0.7,<1.0)"]
-
-[[package]]
-name = "h11"
-version = "0.14.0"
-description = "A pure-Python, bring-your-own-I/O implementation of HTTP/1.1"
-category = "main"
-optional = false
-python-versions = ">=3.7"
-
-[[package]]
-name = "httpcore"
-version = "0.16.3"
-description = "A minimal low-level HTTP client."
-category = "main"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-anyio = ">=3.0,<5.0"
-certifi = "*"
-h11 = ">=0.13,<0.15"
-sniffio = ">=1.0.0,<2.0.0"
-
-[package.extras]
-http2 = ["h2 (>=3,<5)"]
-socks = ["socksio (>=1.0.0,<2.0.0)"]
-
-[[package]]
-name = "httpx"
-version = "0.23.3"
-description = "The next generation HTTP client."
-category = "main"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-certifi = "*"
-httpcore = ">=0.15.0,<0.17.0"
-rfc3986 = {version = ">=1.3,<2", extras = ["idna2008"]}
-sniffio = "*"
-
-[package.extras]
-brotli = ["brotli", "brotlicffi"]
-cli = ["click (>=8.0.0,<9.0.0)", "pygments (>=2.0.0,<3.0.0)", "rich (>=10,<13)"]
-http2 = ["h2 (>=3,<5)"]
-socks = ["socksio (>=1.0.0,<2.0.0)"]
-
-[[package]]
-name = "identify"
-version = "2.5.18"
-description = "File identification library for Python"
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.extras]
-license = ["ukkonen"]
-
-[[package]]
-name = "idna"
-version = "3.4"
-description = "Internationalized Domain Names in Applications (IDNA)"
-category = "main"
-optional = false
-python-versions = ">=3.5"
-
-[[package]]
-name = "importlib-metadata"
-version = "6.0.0"
-description = "Read metadata from Python packages"
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-zipp = ">=0.5"
-
-[package.extras]
-docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"]
-perf = ["ipython"]
-testing = ["flake8 (<5)", "flufl.flake8", "importlib-resources (>=1.3)", "packaging", "pyfakefs", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-flake8", "pytest-mypy (>=0.9.1)", "pytest-perf (>=0.9.2)"]
-
-[[package]]
-name = "isort"
-version = "5.12.0"
-description = "A Python utility / library to sort Python imports."
-category = "dev"
-optional = false
-python-versions = ">=3.8.0"
-
-[package.extras]
-colors = ["colorama (>=0.4.3)"]
-pipfile-deprecated-finder = ["pip-shims (>=0.5.2)", "pipreqs", "requirementslib"]
-plugins = ["setuptools"]
-requirements-deprecated-finder = ["pip-api", "pipreqs"]
-
-[[package]]
-name = "Jinja2"
-version = "3.1.2"
-description = "A very fast and expressive template engine."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-MarkupSafe = ">=2.0"
-
-[package.extras]
-i18n = ["Babel (>=2.7)"]
-
-[[package]]
-name = "Markdown"
-version = "3.3.7"
-description = "Python implementation of Markdown."
-category = "dev"
-optional = false
-python-versions = ">=3.6"
-
-[package.dependencies]
-importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""}
-
-[package.extras]
-testing = ["coverage", "pyyaml"]
-
-[[package]]
-name = "MarkupSafe"
-version = "2.1.2"
-description = "Safely add untrusted strings to HTML/XML markup."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[[package]]
-name = "mergedeep"
-version = "1.3.4"
-description = "A deep merge function for 🐍."
-category = "dev"
-optional = false
-python-versions = ">=3.6"
-
-[[package]]
-name = "mkdocs"
-version = "1.4.2"
-description = "Project documentation with Markdown."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-click = ">=7.0"
-colorama = {version = ">=0.4", markers = "platform_system == \"Windows\""}
-ghp-import = ">=1.0"
-importlib-metadata = {version = ">=4.3", markers = "python_version < \"3.10\""}
-jinja2 = ">=2.11.1"
-markdown = ">=3.2.1,<3.4"
-mergedeep = ">=1.3.4"
-packaging = ">=20.5"
-pyyaml = ">=5.1"
-pyyaml-env-tag = ">=0.1"
-watchdog = ">=2.0"
-
-[package.extras]
-i18n = ["babel (>=2.9.0)"]
-min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-import (==1.0)", "importlib-metadata (==4.3)", "jinja2 (==2.11.1)", "markdown (==3.2.1)", "markupsafe (==2.0.1)", "mergedeep (==1.3.4)", "packaging (==20.5)", "pyyaml (==5.1)", "pyyaml-env-tag (==0.1)", "typing-extensions (==3.10)", "watchdog (==2.0)"]
-
-[[package]]
-name = "mkdocs-autorefs"
-version = "0.4.1"
-description = "Automatically link across pages in MkDocs."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-Markdown = ">=3.3"
-mkdocs = ">=1.1"
-
-[[package]]
-name = "mkdocstrings"
-version = "0.20.0"
-description = "Automatic documentation from sources, for MkDocs."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-Jinja2 = ">=2.11.1"
-Markdown = ">=3.3"
-MarkupSafe = ">=1.1"
-mkdocs = ">=1.2"
-mkdocs-autorefs = ">=0.3.1"
-mkdocstrings-python = {version = ">=0.5.2", optional = true, markers = "extra == \"python\""}
-pymdown-extensions = ">=6.3"
-
-[package.extras]
-crystal = ["mkdocstrings-crystal (>=0.3.4)"]
-python = ["mkdocstrings-python (>=0.5.2)"]
-python-legacy = ["mkdocstrings-python-legacy (>=0.2.1)"]
-
-[[package]]
-name = "mkdocstrings-python"
-version = "0.8.3"
-description = "A Python handler for mkdocstrings."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-griffe = ">=0.24"
-mkdocstrings = ">=0.19"
-
-[[package]]
-name = "nodeenv"
-version = "1.7.0"
-description = "Node.js virtual environment builder"
-category = "dev"
-optional = false
-python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*"
-
-[package.dependencies]
-setuptools = "*"
-
-[[package]]
-name = "packaging"
-version = "23.0"
-description = "Core utilities for Python packages"
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[[package]]
-name = "passlib"
-version = "1.7.4"
-description = "comprehensive password hashing framework supporting over 30 schemes"
-category = "main"
-optional = false
-python-versions = "*"
-
-[package.extras]
-argon2 = ["argon2-cffi (>=18.2.0)"]
-bcrypt = ["bcrypt (>=3.1.0)"]
-build_docs = ["cloud-sptheme (>=1.10.1)", "sphinx (>=1.6)", "sphinxcontrib-fulltoc (>=1.2.0)"]
-totp = ["cryptography"]
-
-[[package]]
-name = "platformdirs"
-version = "3.0.0"
-description = "A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\"."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.extras]
-docs = ["furo (>=2022.12.7)", "proselint (>=0.13)", "sphinx (>=6.1.3)", "sphinx-autodoc-typehints (>=1.22,!=1.23.4)"]
-test = ["appdirs (==1.4.4)", "covdefaults (>=2.2.2)", "pytest (>=7.2.1)", "pytest-cov (>=4)", "pytest-mock (>=3.10)"]
-
-[[package]]
-name = "pre-commit"
-version = "3.1.0"
-description = "A framework for managing and maintaining multi-language pre-commit hooks."
-category = "dev"
-optional = false
-python-versions = ">=3.8"
-
-[package.dependencies]
-cfgv = ">=2.0.0"
-identify = ">=1.0.0"
-nodeenv = ">=0.11.1"
-pyyaml = ">=5.1"
-virtualenv = ">=20.10.0"
-
-[[package]]
-name = "pyaml"
-version = "21.10.1"
-description = "PyYAML-based module to produce pretty and readable YAML-serialized data"
-category = "main"
-optional = false
-python-versions = "*"
-
-[package.dependencies]
-PyYAML = "*"
-
-[[package]]
-name = "pycparser"
-version = "2.21"
-description = "C parser in Python"
-category = "main"
-optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
-
-[[package]]
-name = "pymdown-extensions"
-version = "9.9.2"
-description = "Extension pack for Python Markdown."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-markdown = ">=3.2"
-
-[[package]]
-name = "python-dateutil"
-version = "2.8.2"
-description = "Extensions to the standard Python datetime module"
-category = "dev"
-optional = false
-python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7"
-
-[package.dependencies]
-six = ">=1.5"
-
-[[package]]
-name = "PyYAML"
-version = "6.0"
-description = "YAML parser and emitter for Python"
-category = "main"
-optional = false
-python-versions = ">=3.6"
-
-[[package]]
-name = "pyyaml_env_tag"
-version = "0.1"
-description = "A custom YAML tag for referencing environment variables in YAML files. "
-category = "dev"
-optional = false
-python-versions = ">=3.6"
-
-[package.dependencies]
-pyyaml = "*"
-
-[[package]]
-name = "rfc3986"
-version = "1.5.0"
-description = "Validating URI References per RFC 3986"
-category = "main"
-optional = false
-python-versions = "*"
-
-[package.dependencies]
-idna = {version = "*", optional = true, markers = "extra == \"idna2008\""}
-
-[package.extras]
-idna2008 = ["idna"]
-
-[[package]]
-name = "setuptools"
-version = "67.4.0"
-description = "Easily download, build, install, upgrade, and uninstall Python packages"
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.extras]
-docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-hoverxref (<2)", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (==0.8.3)", "sphinx-reredirects", "sphinxcontrib-towncrier"]
-testing = ["build[virtualenv]", "filelock (>=3.4.0)", "flake8 (<5)", "flake8-2020", "ini2toml[lite] (>=0.9)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "pip (>=19.1)", "pip-run (>=8.8)", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-flake8", "pytest-mypy (>=0.9.1)", "pytest-perf", "pytest-timeout", "pytest-xdist", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"]
-testing-integration = ["build[virtualenv]", "filelock (>=3.4.0)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "pytest", "pytest-enabler", "pytest-xdist", "tomli", "virtualenv (>=13.0.0)", "wheel"]
-
-[[package]]
-name = "six"
-version = "1.16.0"
-description = "Python 2 and 3 compatibility utilities"
-category = "dev"
-optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*"
-
-[[package]]
-name = "sniffio"
-version = "1.3.0"
-description = "Sniff out which async library your code is running under"
-category = "main"
-optional = false
-python-versions = ">=3.7"
-
-[[package]]
-name = "toml"
-version = "0.10.2"
-description = "Python Library for Tom's Obvious, Minimal Language"
-category = "main"
-optional = false
-python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*"
-
-[[package]]
-name = "typing-extensions"
-version = "4.5.0"
-description = "Backported and Experimental Type Hints for Python 3.7+"
-category = "main"
-optional = false
-python-versions = ">=3.7"
-
-[[package]]
-name = "virtualenv"
-version = "20.19.0"
-description = "Virtual Python Environment builder"
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.dependencies]
-distlib = ">=0.3.6,<1"
-filelock = ">=3.4.1,<4"
-platformdirs = ">=2.4,<4"
-
-[package.extras]
-docs = ["furo (>=2022.12.7)", "proselint (>=0.13)", "sphinx (>=6.1.3)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=22.12)"]
-test = ["covdefaults (>=2.2.2)", "coverage (>=7.1)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23)", "pytest (>=7.2.1)", "pytest-env (>=0.8.1)", "pytest-freezegun (>=0.4.2)", "pytest-mock (>=3.10)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)"]
-
-[[package]]
-name = "watchdog"
-version = "2.2.1"
-description = "Filesystem events monitoring"
-category = "dev"
-optional = false
-python-versions = ">=3.6"
-
-[package.extras]
-watchmedo = ["PyYAML (>=3.10)"]
-
-[[package]]
-name = "zipp"
-version = "3.14.0"
-description = "Backport of pathlib-compatible object wrapper for zip files"
-category = "dev"
-optional = false
-python-versions = ">=3.7"
-
-[package.extras]
-docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"]
-testing = ["flake8 (<5)", "func-timeout", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-flake8", "pytest-mypy (>=0.9.1)"]
-
-[metadata]
-lock-version = "1.1"
-python-versions = "^3.8"
-content-hash = "44b511a675e63d02eaf82f3ec78baa2364e5116e990f9f0a6fc2cb8f21cf616f"
-
-[metadata.files]
-anyio = [
-    {file = "anyio-3.6.2-py3-none-any.whl", hash = "sha256:fbbe32bd270d2a2ef3ed1c5d45041250284e31fc0a4df4a5a6071842051a51e3"},
-    {file = "anyio-3.6.2.tar.gz", hash = "sha256:25ea0d673ae30af41a0c442f81cf3b38c7e79fdc7b60335a4c14e05eb0947421"},
-]
-asyncssh = [
-    {file = "asyncssh-2.13.1-py3-none-any.whl", hash = "sha256:c90eb5e2b4f9a7cc6e6af01fd844563d722c0d667f8c5f51fe5b3c2a79fa0575"},
-    {file = "asyncssh-2.13.1.tar.gz", hash = "sha256:ebbb83c05c0b45cf230de1ef2f06059e360f9afa5c3ddf60fc92faf7b94ff887"},
-]
-certifi = [
-    {file = "certifi-2022.12.7-py3-none-any.whl", hash = "sha256:4ad3232f5e926d6718ec31cfc1fcadfde020920e278684144551c91769c7bc18"},
-    {file = "certifi-2022.12.7.tar.gz", hash = "sha256:35824b4c3a97115964b408844d64aa14db1cc518f6562e8d7261699d1350a9e3"},
-]
-cffi = [
-    {file = "cffi-1.15.1-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:a66d3508133af6e8548451b25058d5812812ec3798c886bf38ed24a98216fab2"},
-    {file = "cffi-1.15.1-cp27-cp27m-manylinux1_i686.whl", hash = "sha256:470c103ae716238bbe698d67ad020e1db9d9dba34fa5a899b5e21577e6d52ed2"},
-    {file = "cffi-1.15.1-cp27-cp27m-manylinux1_x86_64.whl", hash = "sha256:9ad5db27f9cabae298d151c85cf2bad1d359a1b9c686a275df03385758e2f914"},
-    {file = "cffi-1.15.1-cp27-cp27m-win32.whl", hash = "sha256:b3bbeb01c2b273cca1e1e0c5df57f12dce9a4dd331b4fa1635b8bec26350bde3"},
-    {file = "cffi-1.15.1-cp27-cp27m-win_amd64.whl", hash = "sha256:e00b098126fd45523dd056d2efba6c5a63b71ffe9f2bbe1a4fe1716e1d0c331e"},
-    {file = "cffi-1.15.1-cp27-cp27mu-manylinux1_i686.whl", hash = "sha256:d61f4695e6c866a23a21acab0509af1cdfd2c013cf256bbf5b6b5e2695827162"},
-    {file = "cffi-1.15.1-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:ed9cb427ba5504c1dc15ede7d516b84757c3e3d7868ccc85121d9310d27eed0b"},
-    {file = "cffi-1.15.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:39d39875251ca8f612b6f33e6b1195af86d1b3e60086068be9cc053aa4376e21"},
-    {file = "cffi-1.15.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:285d29981935eb726a4399badae8f0ffdff4f5050eaa6d0cfc3f64b857b77185"},
-    {file = "cffi-1.15.1-cp310-cp310-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3eb6971dcff08619f8d91607cfc726518b6fa2a9eba42856be181c6d0d9515fd"},
-    {file = "cffi-1.15.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:21157295583fe8943475029ed5abdcf71eb3911894724e360acff1d61c1d54bc"},
-    {file = "cffi-1.15.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5635bd9cb9731e6d4a1132a498dd34f764034a8ce60cef4f5319c0541159392f"},
-    {file = "cffi-1.15.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2012c72d854c2d03e45d06ae57f40d78e5770d252f195b93f581acf3ba44496e"},
-    {file = "cffi-1.15.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dd86c085fae2efd48ac91dd7ccffcfc0571387fe1193d33b6394db7ef31fe2a4"},
-    {file = "cffi-1.15.1-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:fa6693661a4c91757f4412306191b6dc88c1703f780c8234035eac011922bc01"},
-    {file = "cffi-1.15.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:59c0b02d0a6c384d453fece7566d1c7e6b7bae4fc5874ef2ef46d56776d61c9e"},
-    {file = "cffi-1.15.1-cp310-cp310-win32.whl", hash = "sha256:cba9d6b9a7d64d4bd46167096fc9d2f835e25d7e4c121fb2ddfc6528fb0413b2"},
-    {file = "cffi-1.15.1-cp310-cp310-win_amd64.whl", hash = "sha256:ce4bcc037df4fc5e3d184794f27bdaab018943698f4ca31630bc7f84a7b69c6d"},
-    {file = "cffi-1.15.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:3d08afd128ddaa624a48cf2b859afef385b720bb4b43df214f85616922e6a5ac"},
-    {file = "cffi-1.15.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:3799aecf2e17cf585d977b780ce79ff0dc9b78d799fc694221ce814c2c19db83"},
-    {file = "cffi-1.15.1-cp311-cp311-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a591fe9e525846e4d154205572a029f653ada1a78b93697f3b5a8f1f2bc055b9"},
-    {file = "cffi-1.15.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3548db281cd7d2561c9ad9984681c95f7b0e38881201e157833a2342c30d5e8c"},
-    {file = "cffi-1.15.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:91fc98adde3d7881af9b59ed0294046f3806221863722ba7d8d120c575314325"},
-    {file = "cffi-1.15.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:94411f22c3985acaec6f83c6df553f2dbe17b698cc7f8ae751ff2237d96b9e3c"},
-    {file = "cffi-1.15.1-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:03425bdae262c76aad70202debd780501fabeaca237cdfddc008987c0e0f59ef"},
-    {file = "cffi-1.15.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:cc4d65aeeaa04136a12677d3dd0b1c0c94dc43abac5860ab33cceb42b801c1e8"},
-    {file = "cffi-1.15.1-cp311-cp311-win32.whl", hash = "sha256:a0f100c8912c114ff53e1202d0078b425bee3649ae34d7b070e9697f93c5d52d"},
-    {file = "cffi-1.15.1-cp311-cp311-win_amd64.whl", hash = "sha256:04ed324bda3cda42b9b695d51bb7d54b680b9719cfab04227cdd1e04e5de3104"},
-    {file = "cffi-1.15.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50a74364d85fd319352182ef59c5c790484a336f6db772c1a9231f1c3ed0cbd7"},
-    {file = "cffi-1.15.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e263d77ee3dd201c3a142934a086a4450861778baaeeb45db4591ef65550b0a6"},
-    {file = "cffi-1.15.1-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:cec7d9412a9102bdc577382c3929b337320c4c4c4849f2c5cdd14d7368c5562d"},
-    {file = "cffi-1.15.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4289fc34b2f5316fbb762d75362931e351941fa95fa18789191b33fc4cf9504a"},
-    {file = "cffi-1.15.1-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:173379135477dc8cac4bc58f45db08ab45d228b3363adb7af79436135d028405"},
-    {file = "cffi-1.15.1-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:6975a3fac6bc83c4a65c9f9fcab9e47019a11d3d2cf7f3c0d03431bf145a941e"},
-    {file = "cffi-1.15.1-cp36-cp36m-win32.whl", hash = "sha256:2470043b93ff09bf8fb1d46d1cb756ce6132c54826661a32d4e4d132e1977adf"},
-    {file = "cffi-1.15.1-cp36-cp36m-win_amd64.whl", hash = "sha256:30d78fbc8ebf9c92c9b7823ee18eb92f2e6ef79b45ac84db507f52fbe3ec4497"},
-    {file = "cffi-1.15.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:198caafb44239b60e252492445da556afafc7d1e3ab7a1fb3f0584ef6d742375"},
-    {file = "cffi-1.15.1-cp37-cp37m-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5ef34d190326c3b1f822a5b7a45f6c4535e2f47ed06fec77d3d799c450b2651e"},
-    {file = "cffi-1.15.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8102eaf27e1e448db915d08afa8b41d6c7ca7a04b7d73af6514df10a3e74bd82"},
-    {file = "cffi-1.15.1-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5df2768244d19ab7f60546d0c7c63ce1581f7af8b5de3eb3004b9b6fc8a9f84b"},
-    {file = "cffi-1.15.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a8c4917bd7ad33e8eb21e9a5bbba979b49d9a97acb3a803092cbc1133e20343c"},
-    {file = "cffi-1.15.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0e2642fe3142e4cc4af0799748233ad6da94c62a8bec3a6648bf8ee68b1c7426"},
-    {file = "cffi-1.15.1-cp37-cp37m-win32.whl", hash = "sha256:e229a521186c75c8ad9490854fd8bbdd9a0c9aa3a524326b55be83b54d4e0ad9"},
-    {file = "cffi-1.15.1-cp37-cp37m-win_amd64.whl", hash = "sha256:a0b71b1b8fbf2b96e41c4d990244165e2c9be83d54962a9a1d118fd8657d2045"},
-    {file = "cffi-1.15.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:320dab6e7cb2eacdf0e658569d2575c4dad258c0fcc794f46215e1e39f90f2c3"},
-    {file = "cffi-1.15.1-cp38-cp38-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1e74c6b51a9ed6589199c787bf5f9875612ca4a8a0785fb2d4a84429badaf22a"},
-    {file = "cffi-1.15.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a5c84c68147988265e60416b57fc83425a78058853509c1b0629c180094904a5"},
-    {file = "cffi-1.15.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3b926aa83d1edb5aa5b427b4053dc420ec295a08e40911296b9eb1b6170f6cca"},
-    {file = "cffi-1.15.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:87c450779d0914f2861b8526e035c5e6da0a3199d8f1add1a665e1cbc6fc6d02"},
-    {file = "cffi-1.15.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4f2c9f67e9821cad2e5f480bc8d83b8742896f1242dba247911072d4fa94c192"},
-    {file = "cffi-1.15.1-cp38-cp38-win32.whl", hash = "sha256:8b7ee99e510d7b66cdb6c593f21c043c248537a32e0bedf02e01e9553a172314"},
-    {file = "cffi-1.15.1-cp38-cp38-win_amd64.whl", hash = "sha256:00a9ed42e88df81ffae7a8ab6d9356b371399b91dbdf0c3cb1e84c03a13aceb5"},
-    {file = "cffi-1.15.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:54a2db7b78338edd780e7ef7f9f6c442500fb0d41a5a4ea24fff1c929d5af585"},
-    {file = "cffi-1.15.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:fcd131dd944808b5bdb38e6f5b53013c5aa4f334c5cad0c72742f6eba4b73db0"},
-    {file = "cffi-1.15.1-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7473e861101c9e72452f9bf8acb984947aa1661a7704553a9f6e4baa5ba64415"},
-    {file = "cffi-1.15.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6c9a799e985904922a4d207a94eae35c78ebae90e128f0c4e521ce339396be9d"},
-    {file = "cffi-1.15.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3bcde07039e586f91b45c88f8583ea7cf7a0770df3a1649627bf598332cb6984"},
-    {file = "cffi-1.15.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:33ab79603146aace82c2427da5ca6e58f2b3f2fb5da893ceac0c42218a40be35"},
-    {file = "cffi-1.15.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5d598b938678ebf3c67377cdd45e09d431369c3b1a5b331058c338e201f12b27"},
-    {file = "cffi-1.15.1-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:db0fbb9c62743ce59a9ff687eb5f4afbe77e5e8403d6697f7446e5f609976f76"},
-    {file = "cffi-1.15.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:98d85c6a2bef81588d9227dde12db8a7f47f639f4a17c9ae08e773aa9c697bf3"},
-    {file = "cffi-1.15.1-cp39-cp39-win32.whl", hash = "sha256:40f4774f5a9d4f5e344f31a32b5096977b5d48560c5592e2f3d2c4374bd543ee"},
-    {file = "cffi-1.15.1-cp39-cp39-win_amd64.whl", hash = "sha256:70df4e3b545a17496c9b3f41f5115e69a4f2e77e94e1d2a8e1070bc0c38c8a3c"},
-    {file = "cffi-1.15.1.tar.gz", hash = "sha256:d400bfb9a37b1351253cb402671cea7e89bdecc294e8016a707f6d1d8ac934f9"},
-]
-cfgv = [
-    {file = "cfgv-3.3.1-py2.py3-none-any.whl", hash = "sha256:c6a0883f3917a037485059700b9e75da2464e6c27051014ad85ba6aaa5884426"},
-    {file = "cfgv-3.3.1.tar.gz", hash = "sha256:f5a830efb9ce7a445376bb66ec94c638a9787422f96264c98edc6bdeed8ab736"},
-]
-click = [
-    {file = "click-8.1.3-py3-none-any.whl", hash = "sha256:bb4d8133cb15a609f44e8213d9b391b0809795062913b383c62be0ee95b1db48"},
-    {file = "click-8.1.3.tar.gz", hash = "sha256:7682dc8afb30297001674575ea00d1814d808d6a36af415a82bd481d37ba7b8e"},
-]
-colorama = [
-    {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"},
-    {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},
-]
-cryptography = [
-    {file = "cryptography-39.0.1-cp36-abi3-macosx_10_12_universal2.whl", hash = "sha256:6687ef6d0a6497e2b58e7c5b852b53f62142cfa7cd1555795758934da363a965"},
-    {file = "cryptography-39.0.1-cp36-abi3-macosx_10_12_x86_64.whl", hash = "sha256:706843b48f9a3f9b9911979761c91541e3d90db1ca905fd63fee540a217698bc"},
-    {file = "cryptography-39.0.1-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_24_aarch64.whl", hash = "sha256:5d2d8b87a490bfcd407ed9d49093793d0f75198a35e6eb1a923ce1ee86c62b41"},
-    {file = "cryptography-39.0.1-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:83e17b26de248c33f3acffb922748151d71827d6021d98c70e6c1a25ddd78505"},
-    {file = "cryptography-39.0.1-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e124352fd3db36a9d4a21c1aa27fd5d051e621845cb87fb851c08f4f75ce8be6"},
-    {file = "cryptography-39.0.1-cp36-abi3-manylinux_2_24_x86_64.whl", hash = "sha256:5aa67414fcdfa22cf052e640cb5ddc461924a045cacf325cd164e65312d99502"},
-    {file = "cryptography-39.0.1-cp36-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:35f7c7d015d474f4011e859e93e789c87d21f6f4880ebdc29896a60403328f1f"},
-    {file = "cryptography-39.0.1-cp36-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:f24077a3b5298a5a06a8e0536e3ea9ec60e4c7ac486755e5fb6e6ea9b3500106"},
-    {file = "cryptography-39.0.1-cp36-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:f0c64d1bd842ca2633e74a1a28033d139368ad959872533b1bab8c80e8240a0c"},
-    {file = "cryptography-39.0.1-cp36-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:0f8da300b5c8af9f98111ffd512910bc792b4c77392a9523624680f7956a99d4"},
-    {file = "cryptography-39.0.1-cp36-abi3-win32.whl", hash = "sha256:fe913f20024eb2cb2f323e42a64bdf2911bb9738a15dba7d3cce48151034e3a8"},
-    {file = "cryptography-39.0.1-cp36-abi3-win_amd64.whl", hash = "sha256:ced4e447ae29ca194449a3f1ce132ded8fcab06971ef5f618605aacaa612beac"},
-    {file = "cryptography-39.0.1-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:807ce09d4434881ca3a7594733669bd834f5b2c6d5c7e36f8c00f691887042ad"},
-    {file = "cryptography-39.0.1-pp38-pypy38_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:c5caeb8188c24888c90b5108a441c106f7faa4c4c075a2bcae438c6e8ca73cef"},
-    {file = "cryptography-39.0.1-pp38-pypy38_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:4789d1e3e257965e960232345002262ede4d094d1a19f4d3b52e48d4d8f3b885"},
-    {file = "cryptography-39.0.1-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:96f1157a7c08b5b189b16b47bc9db2332269d6680a196341bf30046330d15388"},
-    {file = "cryptography-39.0.1-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:e422abdec8b5fa8462aa016786680720d78bdce7a30c652b7fadf83a4ba35336"},
-    {file = "cryptography-39.0.1-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.manylinux_2_24_aarch64.whl", hash = "sha256:b0afd054cd42f3d213bf82c629efb1ee5f22eba35bf0eec88ea9ea7304f511a2"},
-    {file = "cryptography-39.0.1-pp39-pypy39_pp73-manylinux_2_24_x86_64.whl", hash = "sha256:6f8ba7f0328b79f08bdacc3e4e66fb4d7aab0c3584e0bd41328dce5262e26b2e"},
-    {file = "cryptography-39.0.1-pp39-pypy39_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:ef8b72fa70b348724ff1218267e7f7375b8de4e8194d1636ee60510aae104cd0"},
-    {file = "cryptography-39.0.1-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:aec5a6c9864be7df2240c382740fcf3b96928c46604eaa7f3091f58b878c0bb6"},
-    {file = "cryptography-39.0.1-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:fdd188c8a6ef8769f148f88f859884507b954cc64db6b52f66ef199bb9ad660a"},
-    {file = "cryptography-39.0.1.tar.gz", hash = "sha256:d1f6198ee6d9148405e49887803907fe8962a23e6c6f83ea7d98f1c0de375695"},
-]
-distlib = [
-    {file = "distlib-0.3.6-py2.py3-none-any.whl", hash = "sha256:f35c4b692542ca110de7ef0bea44d73981caeb34ca0b9b6b2e6d7790dda8f80e"},
-    {file = "distlib-0.3.6.tar.gz", hash = "sha256:14bad2d9b04d3a36127ac97f30b12a19268f211063d8f8ee4f47108896e11b46"},
-]
-filelock = [
-    {file = "filelock-3.9.0-py3-none-any.whl", hash = "sha256:f58d535af89bb9ad5cd4df046f741f8553a418c01a7856bf0d173bbc9f6bd16d"},
-    {file = "filelock-3.9.0.tar.gz", hash = "sha256:7b319f24340b51f55a2bf7a12ac0755a9b03e718311dac567a0f4f7fabd2f5de"},
-]
-ghp-import = [
-    {file = "ghp-import-2.1.0.tar.gz", hash = "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343"},
-    {file = "ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619"},
-]
-griffe = [
-    {file = "griffe-0.25.5-py3-none-any.whl", hash = "sha256:1fb9edff48e66d4873014a2ebf21aca5f271d0006a4c937826e3cf592ffb3706"},
-    {file = "griffe-0.25.5.tar.gz", hash = "sha256:11ea3403ef0560a1cbcf7f302eb5d21cf4c1d8ed3f8a16a75aa9f6f458caf3f1"},
-]
-h11 = [
-    {file = "h11-0.14.0-py3-none-any.whl", hash = "sha256:e3fe4ac4b851c468cc8363d500db52c2ead036020723024a109d37346efaa761"},
-    {file = "h11-0.14.0.tar.gz", hash = "sha256:8f19fbbe99e72420ff35c00b27a34cb9937e902a8b810e2c88300c6f0a3b699d"},
-]
-httpcore = [
-    {file = "httpcore-0.16.3-py3-none-any.whl", hash = "sha256:da1fb708784a938aa084bde4feb8317056c55037247c787bd7e19eb2c2949dc0"},
-    {file = "httpcore-0.16.3.tar.gz", hash = "sha256:c5d6f04e2fc530f39e0c077e6a30caa53f1451096120f1f38b954afd0b17c0cb"},
-]
-httpx = [
-    {file = "httpx-0.23.3-py3-none-any.whl", hash = "sha256:a211fcce9b1254ea24f0cd6af9869b3d29aba40154e947d2a07bb499b3e310d6"},
-    {file = "httpx-0.23.3.tar.gz", hash = "sha256:9818458eb565bb54898ccb9b8b251a28785dd4a55afbc23d0eb410754fe7d0f9"},
-]
-identify = [
-    {file = "identify-2.5.18-py2.py3-none-any.whl", hash = "sha256:93aac7ecf2f6abf879b8f29a8002d3c6de7086b8c28d88e1ad15045a15ab63f9"},
-    {file = "identify-2.5.18.tar.gz", hash = "sha256:89e144fa560cc4cffb6ef2ab5e9fb18ed9f9b3cb054384bab4b95c12f6c309fe"},
-]
-idna = [
-    {file = "idna-3.4-py3-none-any.whl", hash = "sha256:90b77e79eaa3eba6de819a0c442c0b4ceefc341a7a2ab77d7562bf49f425c5c2"},
-    {file = "idna-3.4.tar.gz", hash = "sha256:814f528e8dead7d329833b91c5faa87d60bf71824cd12a7530b5526063d02cb4"},
-]
-importlib-metadata = [
-    {file = "importlib_metadata-6.0.0-py3-none-any.whl", hash = "sha256:7efb448ec9a5e313a57655d35aa54cd3e01b7e1fbcf72dce1bf06119420f5bad"},
-    {file = "importlib_metadata-6.0.0.tar.gz", hash = "sha256:e354bedeb60efa6affdcc8ae121b73544a7aa74156d047311948f6d711cd378d"},
-]
-isort = [
-    {file = "isort-5.12.0-py3-none-any.whl", hash = "sha256:f84c2818376e66cf843d497486ea8fed8700b340f308f076c6fb1229dff318b6"},
-    {file = "isort-5.12.0.tar.gz", hash = "sha256:8bef7dde241278824a6d83f44a544709b065191b95b6e50894bdc722fcba0504"},
-]
-Jinja2 = [
-    {file = "Jinja2-3.1.2-py3-none-any.whl", hash = "sha256:6088930bfe239f0e6710546ab9c19c9ef35e29792895fed6e6e31a023a182a61"},
-    {file = "Jinja2-3.1.2.tar.gz", hash = "sha256:31351a702a408a9e7595a8fc6150fc3f43bb6bf7e319770cbc0db9df9437e852"},
-]
-Markdown = [
-    {file = "Markdown-3.3.7-py3-none-any.whl", hash = "sha256:f5da449a6e1c989a4cea2631aa8ee67caa5a2ef855d551c88f9e309f4634c621"},
-    {file = "Markdown-3.3.7.tar.gz", hash = "sha256:cbb516f16218e643d8e0a95b309f77eb118cb138d39a4f27851e6a63581db874"},
-]
-MarkupSafe = [
-    {file = "MarkupSafe-2.1.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:665a36ae6f8f20a4676b53224e33d456a6f5a72657d9c83c2aa00765072f31f7"},
-    {file = "MarkupSafe-2.1.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:340bea174e9761308703ae988e982005aedf427de816d1afe98147668cc03036"},
-    {file = "MarkupSafe-2.1.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22152d00bf4a9c7c83960521fc558f55a1adbc0631fbb00a9471e097b19d72e1"},
-    {file = "MarkupSafe-2.1.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:28057e985dace2f478e042eaa15606c7efccb700797660629da387eb289b9323"},
-    {file = "MarkupSafe-2.1.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ca244fa73f50a800cf8c3ebf7fd93149ec37f5cb9596aa8873ae2c1d23498601"},
-    {file = "MarkupSafe-2.1.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:d9d971ec1e79906046aa3ca266de79eac42f1dbf3612a05dc9368125952bd1a1"},
-    {file = "MarkupSafe-2.1.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:7e007132af78ea9df29495dbf7b5824cb71648d7133cf7848a2a5dd00d36f9ff"},
-    {file = "MarkupSafe-2.1.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:7313ce6a199651c4ed9d7e4cfb4aa56fe923b1adf9af3b420ee14e6d9a73df65"},
-    {file = "MarkupSafe-2.1.2-cp310-cp310-win32.whl", hash = "sha256:c4a549890a45f57f1ebf99c067a4ad0cb423a05544accaf2b065246827ed9603"},
-    {file = "MarkupSafe-2.1.2-cp310-cp310-win_amd64.whl", hash = "sha256:835fb5e38fd89328e9c81067fd642b3593c33e1e17e2fdbf77f5676abb14a156"},
-    {file = "MarkupSafe-2.1.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:2ec4f2d48ae59bbb9d1f9d7efb9236ab81429a764dedca114f5fdabbc3788013"},
-    {file = "MarkupSafe-2.1.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:608e7073dfa9e38a85d38474c082d4281f4ce276ac0010224eaba11e929dd53a"},
-    {file = "MarkupSafe-2.1.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:65608c35bfb8a76763f37036547f7adfd09270fbdbf96608be2bead319728fcd"},
-    {file = "MarkupSafe-2.1.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f2bfb563d0211ce16b63c7cb9395d2c682a23187f54c3d79bfec33e6705473c6"},
-    {file = "MarkupSafe-2.1.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:da25303d91526aac3672ee6d49a2f3db2d9502a4a60b55519feb1a4c7714e07d"},
-    {file = "MarkupSafe-2.1.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:9cad97ab29dfc3f0249b483412c85c8ef4766d96cdf9dcf5a1e3caa3f3661cf1"},
-    {file = "MarkupSafe-2.1.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:085fd3201e7b12809f9e6e9bc1e5c96a368c8523fad5afb02afe3c051ae4afcc"},
-    {file = "MarkupSafe-2.1.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:1bea30e9bf331f3fef67e0a3877b2288593c98a21ccb2cf29b74c581a4eb3af0"},
-    {file = "MarkupSafe-2.1.2-cp311-cp311-win32.whl", hash = "sha256:7df70907e00c970c60b9ef2938d894a9381f38e6b9db73c5be35e59d92e06625"},
-    {file = "MarkupSafe-2.1.2-cp311-cp311-win_amd64.whl", hash = "sha256:e55e40ff0cc8cc5c07996915ad367fa47da6b3fc091fdadca7f5403239c5fec3"},
-    {file = "MarkupSafe-2.1.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:a6e40afa7f45939ca356f348c8e23048e02cb109ced1eb8420961b2f40fb373a"},
-    {file = "MarkupSafe-2.1.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cf877ab4ed6e302ec1d04952ca358b381a882fbd9d1b07cccbfd61783561f98a"},
-    {file = "MarkupSafe-2.1.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:63ba06c9941e46fa389d389644e2d8225e0e3e5ebcc4ff1ea8506dce646f8c8a"},
-    {file = "MarkupSafe-2.1.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f1cd098434e83e656abf198f103a8207a8187c0fc110306691a2e94a78d0abb2"},
-    {file = "MarkupSafe-2.1.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:55f44b440d491028addb3b88f72207d71eeebfb7b5dbf0643f7c023ae1fba619"},
-    {file = "MarkupSafe-2.1.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:a6f2fcca746e8d5910e18782f976489939d54a91f9411c32051b4aab2bd7c513"},
-    {file = "MarkupSafe-2.1.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:0b462104ba25f1ac006fdab8b6a01ebbfbce9ed37fd37fd4acd70c67c973e460"},
-    {file = "MarkupSafe-2.1.2-cp37-cp37m-win32.whl", hash = "sha256:7668b52e102d0ed87cb082380a7e2e1e78737ddecdde129acadb0eccc5423859"},
-    {file = "MarkupSafe-2.1.2-cp37-cp37m-win_amd64.whl", hash = "sha256:6d6607f98fcf17e534162f0709aaad3ab7a96032723d8ac8750ffe17ae5a0666"},
-    {file = "MarkupSafe-2.1.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:a806db027852538d2ad7555b203300173dd1b77ba116de92da9afbc3a3be3eed"},
-    {file = "MarkupSafe-2.1.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:a4abaec6ca3ad8660690236d11bfe28dfd707778e2442b45addd2f086d6ef094"},
-    {file = "MarkupSafe-2.1.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f03a532d7dee1bed20bc4884194a16160a2de9ffc6354b3878ec9682bb623c54"},
-    {file = "MarkupSafe-2.1.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4cf06cdc1dda95223e9d2d3c58d3b178aa5dacb35ee7e3bbac10e4e1faacb419"},
-    {file = "MarkupSafe-2.1.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:22731d79ed2eb25059ae3df1dfc9cb1546691cc41f4e3130fe6bfbc3ecbbecfa"},
-    {file = "MarkupSafe-2.1.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:f8ffb705ffcf5ddd0e80b65ddf7bed7ee4f5a441ea7d3419e861a12eaf41af58"},
-    {file = "MarkupSafe-2.1.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:8db032bf0ce9022a8e41a22598eefc802314e81b879ae093f36ce9ddf39ab1ba"},
-    {file = "MarkupSafe-2.1.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:2298c859cfc5463f1b64bd55cb3e602528db6fa0f3cfd568d3605c50678f8f03"},
-    {file = "MarkupSafe-2.1.2-cp38-cp38-win32.whl", hash = "sha256:50c42830a633fa0cf9e7d27664637532791bfc31c731a87b202d2d8ac40c3ea2"},
-    {file = "MarkupSafe-2.1.2-cp38-cp38-win_amd64.whl", hash = "sha256:bb06feb762bade6bf3c8b844462274db0c76acc95c52abe8dbed28ae3d44a147"},
-    {file = "MarkupSafe-2.1.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:99625a92da8229df6d44335e6fcc558a5037dd0a760e11d84be2260e6f37002f"},
-    {file = "MarkupSafe-2.1.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:8bca7e26c1dd751236cfb0c6c72d4ad61d986e9a41bbf76cb445f69488b2a2bd"},
-    {file = "MarkupSafe-2.1.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:40627dcf047dadb22cd25ea7ecfe9cbf3bbbad0482ee5920b582f3809c97654f"},
-    {file = "MarkupSafe-2.1.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:40dfd3fefbef579ee058f139733ac336312663c6706d1163b82b3003fb1925c4"},
-    {file = "MarkupSafe-2.1.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:090376d812fb6ac5f171e5938e82e7f2d7adc2b629101cec0db8b267815c85e2"},
-    {file = "MarkupSafe-2.1.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:2e7821bffe00aa6bd07a23913b7f4e01328c3d5cc0b40b36c0bd81d362faeb65"},
-    {file = "MarkupSafe-2.1.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:c0a33bc9f02c2b17c3ea382f91b4db0e6cde90b63b296422a939886a7a80de1c"},
-    {file = "MarkupSafe-2.1.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:b8526c6d437855442cdd3d87eede9c425c4445ea011ca38d937db299382e6fa3"},
-    {file = "MarkupSafe-2.1.2-cp39-cp39-win32.whl", hash = "sha256:137678c63c977754abe9086a3ec011e8fd985ab90631145dfb9294ad09c102a7"},
-    {file = "MarkupSafe-2.1.2-cp39-cp39-win_amd64.whl", hash = "sha256:0576fe974b40a400449768941d5d0858cc624e3249dfd1e0c33674e5c7ca7aed"},
-    {file = "MarkupSafe-2.1.2.tar.gz", hash = "sha256:abcabc8c2b26036d62d4c746381a6f7cf60aafcc653198ad678306986b09450d"},
-]
-mergedeep = [
-    {file = "mergedeep-1.3.4-py3-none-any.whl", hash = "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307"},
-    {file = "mergedeep-1.3.4.tar.gz", hash = "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8"},
-]
-mkdocs = [
-    {file = "mkdocs-1.4.2-py3-none-any.whl", hash = "sha256:c8856a832c1e56702577023cd64cc5f84948280c1c0fcc6af4cd39006ea6aa8c"},
-    {file = "mkdocs-1.4.2.tar.gz", hash = "sha256:8947af423a6d0facf41ea1195b8e1e8c85ad94ac95ae307fe11232e0424b11c5"},
-]
-mkdocs-autorefs = [
-    {file = "mkdocs-autorefs-0.4.1.tar.gz", hash = "sha256:70748a7bd025f9ecd6d6feeba8ba63f8e891a1af55f48e366d6d6e78493aba84"},
-    {file = "mkdocs_autorefs-0.4.1-py3-none-any.whl", hash = "sha256:a2248a9501b29dc0cc8ba4c09f4f47ff121945f6ce33d760f145d6f89d313f5b"},
-]
-mkdocstrings = [
-    {file = "mkdocstrings-0.20.0-py3-none-any.whl", hash = "sha256:f17fc2c4f760ec302b069075ef9e31045aa6372ca91d2f35ded3adba8e25a472"},
-    {file = "mkdocstrings-0.20.0.tar.gz", hash = "sha256:c757f4f646d4f939491d6bc9256bfe33e36c5f8026392f49eaa351d241c838e5"},
-]
-mkdocstrings-python = [
-    {file = "mkdocstrings-python-0.8.3.tar.gz", hash = "sha256:9ae473f6dc599339b09eee17e4d2b05d6ac0ec29860f3fc9b7512d940fc61adf"},
-    {file = "mkdocstrings_python-0.8.3-py3-none-any.whl", hash = "sha256:4e6e1cd6f37a785de0946ced6eb846eb2f5d891ac1cc2c7b832943d3529087a7"},
-]
-nodeenv = [
-    {file = "nodeenv-1.7.0-py2.py3-none-any.whl", hash = "sha256:27083a7b96a25f2f5e1d8cb4b6317ee8aeda3bdd121394e5ac54e498028a042e"},
-    {file = "nodeenv-1.7.0.tar.gz", hash = "sha256:e0e7f7dfb85fc5394c6fe1e8fa98131a2473e04311a45afb6508f7cf1836fa2b"},
-]
-packaging = [
-    {file = "packaging-23.0-py3-none-any.whl", hash = "sha256:714ac14496c3e68c99c29b00845f7a2b85f3bb6f1078fd9f72fd20f0570002b2"},
-    {file = "packaging-23.0.tar.gz", hash = "sha256:b6ad297f8907de0fa2fe1ccbd26fdaf387f5f47c7275fedf8cce89f99446cf97"},
-]
-passlib = [
-    {file = "passlib-1.7.4-py2.py3-none-any.whl", hash = "sha256:aa6bca462b8d8bda89c70b382f0c298a20b5560af6cbfa2dce410c0a2fb669f1"},
-    {file = "passlib-1.7.4.tar.gz", hash = "sha256:defd50f72b65c5402ab2c573830a6978e5f202ad0d984793c8dde2c4152ebe04"},
-]
-platformdirs = [
-    {file = "platformdirs-3.0.0-py3-none-any.whl", hash = "sha256:b1d5eb14f221506f50d6604a561f4c5786d9e80355219694a1b244bcd96f4567"},
-    {file = "platformdirs-3.0.0.tar.gz", hash = "sha256:8a1228abb1ef82d788f74139988b137e78692984ec7b08eaa6c65f1723af28f9"},
-]
-pre-commit = [
-    {file = "pre_commit-3.1.0-py2.py3-none-any.whl", hash = "sha256:7001dfcd174540658822b1fd3630ceadf4f41375a5d1844b5c3b3830f227348c"},
-    {file = "pre_commit-3.1.0.tar.gz", hash = "sha256:61bd9f1b96d3d1e763f2a9a0f8522aed341646800642ff6803c73fac5781f5b7"},
-]
-pyaml = [
-    {file = "pyaml-21.10.1-py2.py3-none-any.whl", hash = "sha256:19985ed303c3a985de4cf8fd329b6d0a5a5b5c9035ea240eccc709ebacbaf4a0"},
-    {file = "pyaml-21.10.1.tar.gz", hash = "sha256:c6519fee13bf06e3bb3f20cacdea8eba9140385a7c2546df5dbae4887f768383"},
-]
-pycparser = [
-    {file = "pycparser-2.21-py2.py3-none-any.whl", hash = "sha256:8ee45429555515e1f6b185e78100aea234072576aa43ab53aefcae078162fca9"},
-    {file = "pycparser-2.21.tar.gz", hash = "sha256:e644fdec12f7872f86c58ff790da456218b10f863970249516d60a5eaca77206"},
-]
-pymdown-extensions = [
-    {file = "pymdown_extensions-9.9.2-py3-none-any.whl", hash = "sha256:c3d804eb4a42b85bafb5f36436342a5ad38df03878bb24db8855a4aa8b08b765"},
-    {file = "pymdown_extensions-9.9.2.tar.gz", hash = "sha256:ebb33069bafcb64d5f5988043331d4ea4929325dc678a6bcf247ddfcf96499f8"},
-]
-python-dateutil = [
-    {file = "python-dateutil-2.8.2.tar.gz", hash = "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86"},
-    {file = "python_dateutil-2.8.2-py2.py3-none-any.whl", hash = "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"},
-]
-PyYAML = [
-    {file = "PyYAML-6.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d4db7c7aef085872ef65a8fd7d6d09a14ae91f691dec3e87ee5ee0539d516f53"},
-    {file = "PyYAML-6.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9df7ed3b3d2e0ecfe09e14741b857df43adb5a3ddadc919a2d94fbdf78fea53c"},
-    {file = "PyYAML-6.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:77f396e6ef4c73fdc33a9157446466f1cff553d979bd00ecb64385760c6babdc"},
-    {file = "PyYAML-6.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a80a78046a72361de73f8f395f1f1e49f956c6be882eed58505a15f3e430962b"},
-    {file = "PyYAML-6.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:f84fbc98b019fef2ee9a1cb3ce93e3187a6df0b2538a651bfb890254ba9f90b5"},
-    {file = "PyYAML-6.0-cp310-cp310-win32.whl", hash = "sha256:2cd5df3de48857ed0544b34e2d40e9fac445930039f3cfe4bcc592a1f836d513"},
-    {file = "PyYAML-6.0-cp310-cp310-win_amd64.whl", hash = "sha256:daf496c58a8c52083df09b80c860005194014c3698698d1a57cbcfa182142a3a"},
-    {file = "PyYAML-6.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:d4b0ba9512519522b118090257be113b9468d804b19d63c71dbcf4a48fa32358"},
-    {file = "PyYAML-6.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:81957921f441d50af23654aa6c5e5eaf9b06aba7f0a19c18a538dc7ef291c5a1"},
-    {file = "PyYAML-6.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:afa17f5bc4d1b10afd4466fd3a44dc0e245382deca5b3c353d8b757f9e3ecb8d"},
-    {file = "PyYAML-6.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dbad0e9d368bb989f4515da330b88a057617d16b6a8245084f1b05400f24609f"},
-    {file = "PyYAML-6.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:432557aa2c09802be39460360ddffd48156e30721f5e8d917f01d31694216782"},
-    {file = "PyYAML-6.0-cp311-cp311-win32.whl", hash = "sha256:bfaef573a63ba8923503d27530362590ff4f576c626d86a9fed95822a8255fd7"},
-    {file = "PyYAML-6.0-cp311-cp311-win_amd64.whl", hash = "sha256:01b45c0191e6d66c470b6cf1b9531a771a83c1c4208272ead47a3ae4f2f603bf"},
-    {file = "PyYAML-6.0-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:897b80890765f037df3403d22bab41627ca8811ae55e9a722fd0392850ec4d86"},
-    {file = "PyYAML-6.0-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:50602afada6d6cbfad699b0c7bb50d5ccffa7e46a3d738092afddc1f9758427f"},
-    {file = "PyYAML-6.0-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:48c346915c114f5fdb3ead70312bd042a953a8ce5c7106d5bfb1a5254e47da92"},
-    {file = "PyYAML-6.0-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:98c4d36e99714e55cfbaaee6dd5badbc9a1ec339ebfc3b1f52e293aee6bb71a4"},
-    {file = "PyYAML-6.0-cp36-cp36m-win32.whl", hash = "sha256:0283c35a6a9fbf047493e3a0ce8d79ef5030852c51e9d911a27badfde0605293"},
-    {file = "PyYAML-6.0-cp36-cp36m-win_amd64.whl", hash = "sha256:07751360502caac1c067a8132d150cf3d61339af5691fe9e87803040dbc5db57"},
-    {file = "PyYAML-6.0-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:819b3830a1543db06c4d4b865e70ded25be52a2e0631ccd2f6a47a2822f2fd7c"},
-    {file = "PyYAML-6.0-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:473f9edb243cb1935ab5a084eb238d842fb8f404ed2193a915d1784b5a6b5fc0"},
-    {file = "PyYAML-6.0-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:0ce82d761c532fe4ec3f87fc45688bdd3a4c1dc5e0b4a19814b9009a29baefd4"},
-    {file = "PyYAML-6.0-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:231710d57adfd809ef5d34183b8ed1eeae3f76459c18fb4a0b373ad56bedcdd9"},
-    {file = "PyYAML-6.0-cp37-cp37m-win32.whl", hash = "sha256:c5687b8d43cf58545ade1fe3e055f70eac7a5a1a0bf42824308d868289a95737"},
-    {file = "PyYAML-6.0-cp37-cp37m-win_amd64.whl", hash = "sha256:d15a181d1ecd0d4270dc32edb46f7cb7733c7c508857278d3d378d14d606db2d"},
-    {file = "PyYAML-6.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:0b4624f379dab24d3725ffde76559cff63d9ec94e1736b556dacdfebe5ab6d4b"},
-    {file = "PyYAML-6.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:213c60cd50106436cc818accf5baa1aba61c0189ff610f64f4a3e8c6726218ba"},
-    {file = "PyYAML-6.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9fa600030013c4de8165339db93d182b9431076eb98eb40ee068700c9c813e34"},
-    {file = "PyYAML-6.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:277a0ef2981ca40581a47093e9e2d13b3f1fbbeffae064c1d21bfceba2030287"},
-    {file = "PyYAML-6.0-cp38-cp38-win32.whl", hash = "sha256:d4eccecf9adf6fbcc6861a38015c2a64f38b9d94838ac1810a9023a0609e1b78"},
-    {file = "PyYAML-6.0-cp38-cp38-win_amd64.whl", hash = "sha256:1e4747bc279b4f613a09eb64bba2ba602d8a6664c6ce6396a4d0cd413a50ce07"},
-    {file = "PyYAML-6.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:055d937d65826939cb044fc8c9b08889e8c743fdc6a32b33e2390f66013e449b"},
-    {file = "PyYAML-6.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:e61ceaab6f49fb8bdfaa0f92c4b57bcfbea54c09277b1b4f7ac376bfb7a7c174"},
-    {file = "PyYAML-6.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d67d839ede4ed1b28a4e8909735fc992a923cdb84e618544973d7dfc71540803"},
-    {file = "PyYAML-6.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cba8c411ef271aa037d7357a2bc8f9ee8b58b9965831d9e51baf703280dc73d3"},
-    {file = "PyYAML-6.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:40527857252b61eacd1d9af500c3337ba8deb8fc298940291486c465c8b46ec0"},
-    {file = "PyYAML-6.0-cp39-cp39-win32.whl", hash = "sha256:b5b9eccad747aabaaffbc6064800670f0c297e52c12754eb1d976c57e4f74dcb"},
-    {file = "PyYAML-6.0-cp39-cp39-win_amd64.whl", hash = "sha256:b3d267842bf12586ba6c734f89d1f5b871df0273157918b0ccefa29deb05c21c"},
-    {file = "PyYAML-6.0.tar.gz", hash = "sha256:68fb519c14306fec9720a2a5b45bc9f0c8d1b9c72adf45c37baedfcd949c35a2"},
-]
-pyyaml_env_tag = [
-    {file = "pyyaml_env_tag-0.1-py3-none-any.whl", hash = "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069"},
-    {file = "pyyaml_env_tag-0.1.tar.gz", hash = "sha256:70092675bda14fdec33b31ba77e7543de9ddc88f2e5b99160396572d11525bdb"},
-]
-rfc3986 = [
-    {file = "rfc3986-1.5.0-py2.py3-none-any.whl", hash = "sha256:a86d6e1f5b1dc238b218b012df0aa79409667bb209e58da56d0b94704e712a97"},
-    {file = "rfc3986-1.5.0.tar.gz", hash = "sha256:270aaf10d87d0d4e095063c65bf3ddbc6ee3d0b226328ce21e036f946e421835"},
-]
-setuptools = [
-    {file = "setuptools-67.4.0-py3-none-any.whl", hash = "sha256:f106dee1b506dee5102cc3f3e9e68137bbad6d47b616be7991714b0c62204251"},
-    {file = "setuptools-67.4.0.tar.gz", hash = "sha256:e5fd0a713141a4a105412233c63dc4e17ba0090c8e8334594ac790ec97792330"},
-]
-six = [
-    {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"},
-    {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"},
-]
-sniffio = [
-    {file = "sniffio-1.3.0-py3-none-any.whl", hash = "sha256:eecefdce1e5bbfb7ad2eeaabf7c1eeb404d7757c379bd1f7e5cce9d8bf425384"},
-    {file = "sniffio-1.3.0.tar.gz", hash = "sha256:e60305c5e5d314f5389259b7f22aaa33d8f7dee49763119234af3755c55b9101"},
-]
-toml = [
-    {file = "toml-0.10.2-py2.py3-none-any.whl", hash = "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b"},
-    {file = "toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"},
-]
-typing-extensions = [
-    {file = "typing_extensions-4.5.0-py3-none-any.whl", hash = "sha256:fb33085c39dd998ac16d1431ebc293a8b3eedd00fd4a32de0ff79002c19511b4"},
-    {file = "typing_extensions-4.5.0.tar.gz", hash = "sha256:5cb5f4a79139d699607b3ef622a1dedafa84e115ab0024e0d9c044a9479ca7cb"},
-]
-virtualenv = [
-    {file = "virtualenv-20.19.0-py3-none-any.whl", hash = "sha256:54eb59e7352b573aa04d53f80fc9736ed0ad5143af445a1e539aada6eb947dd1"},
-    {file = "virtualenv-20.19.0.tar.gz", hash = "sha256:37a640ba82ed40b226599c522d411e4be5edb339a0c0de030c0dc7b646d61590"},
-]
-watchdog = [
-    {file = "watchdog-2.2.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a09483249d25cbdb4c268e020cb861c51baab2d1affd9a6affc68ffe6a231260"},
-    {file = "watchdog-2.2.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:5100eae58133355d3ca6c1083a33b81355c4f452afa474c2633bd2fbbba398b3"},
-    {file = "watchdog-2.2.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:e618a4863726bc7a3c64f95c218437f3349fb9d909eb9ea3a1ed3b567417c661"},
-    {file = "watchdog-2.2.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:102a60093090fc3ff76c983367b19849b7cc24ec414a43c0333680106e62aae1"},
-    {file = "watchdog-2.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:748ca797ff59962e83cc8e4b233f87113f3cf247c23e6be58b8a2885c7337aa3"},
-    {file = "watchdog-2.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:6ccd8d84b9490a82b51b230740468116b8205822ea5fdc700a553d92661253a3"},
-    {file = "watchdog-2.2.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:6e01d699cd260d59b84da6bda019dce0a3353e3fcc774408ae767fe88ee096b7"},
-    {file = "watchdog-2.2.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:8586d98c494690482c963ffb24c49bf9c8c2fe0589cec4dc2f753b78d1ec301d"},
-    {file = "watchdog-2.2.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:adaf2ece15f3afa33a6b45f76b333a7da9256e1360003032524d61bdb4c422ae"},
-    {file = "watchdog-2.2.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:83a7cead445008e880dbde833cb9e5cc7b9a0958edb697a96b936621975f15b9"},
-    {file = "watchdog-2.2.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:f8ac23ff2c2df4471a61af6490f847633024e5aa120567e08d07af5718c9d092"},
-    {file = "watchdog-2.2.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:d0f29fd9f3f149a5277929de33b4f121a04cf84bb494634707cfa8ea8ae106a8"},
-    {file = "watchdog-2.2.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:967636031fa4c4955f0f3f22da3c5c418aa65d50908d31b73b3b3ffd66d60640"},
-    {file = "watchdog-2.2.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:96cbeb494e6cbe3ae6aacc430e678ce4b4dd3ae5125035f72b6eb4e5e9eb4f4e"},
-    {file = "watchdog-2.2.1-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:61fdb8e9c57baf625e27e1420e7ca17f7d2023929cd0065eb79c83da1dfbeacd"},
-    {file = "watchdog-2.2.1-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:4cb5ecc332112017fbdb19ede78d92e29a8165c46b68a0b8ccbd0a154f196d5e"},
-    {file = "watchdog-2.2.1-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:a480d122740debf0afac4ddd583c6c0bb519c24f817b42ed6f850e2f6f9d64a8"},
-    {file = "watchdog-2.2.1-py3-none-manylinux2014_aarch64.whl", hash = "sha256:978a1aed55de0b807913b7482d09943b23a2d634040b112bdf31811a422f6344"},
-    {file = "watchdog-2.2.1-py3-none-manylinux2014_armv7l.whl", hash = "sha256:8c28c23972ec9c524967895ccb1954bc6f6d4a557d36e681a36e84368660c4ce"},
-    {file = "watchdog-2.2.1-py3-none-manylinux2014_i686.whl", hash = "sha256:c27d8c1535fd4474e40a4b5e01f4ba6720bac58e6751c667895cbc5c8a7af33c"},
-    {file = "watchdog-2.2.1-py3-none-manylinux2014_ppc64.whl", hash = "sha256:d6b87477752bd86ac5392ecb9eeed92b416898c30bd40c7e2dd03c3146105646"},
-    {file = "watchdog-2.2.1-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:cece1aa596027ff56369f0b50a9de209920e1df9ac6d02c7f9e5d8162eb4f02b"},
-    {file = "watchdog-2.2.1-py3-none-manylinux2014_s390x.whl", hash = "sha256:8b5cde14e5c72b2df5d074774bdff69e9b55da77e102a91f36ef26ca35f9819c"},
-    {file = "watchdog-2.2.1-py3-none-manylinux2014_x86_64.whl", hash = "sha256:e038be858425c4f621900b8ff1a3a1330d9edcfeaa1c0468aeb7e330fb87693e"},
-    {file = "watchdog-2.2.1-py3-none-win32.whl", hash = "sha256:bc43c1b24d2f86b6e1cc15f68635a959388219426109233e606517ff7d0a5a73"},
-    {file = "watchdog-2.2.1-py3-none-win_amd64.whl", hash = "sha256:17f1708f7410af92ddf591e94ae71a27a13974559e72f7e9fde3ec174b26ba2e"},
-    {file = "watchdog-2.2.1-py3-none-win_ia64.whl", hash = "sha256:195ab1d9d611a4c1e5311cbf42273bc541e18ea8c32712f2fb703cfc6ff006f9"},
-    {file = "watchdog-2.2.1.tar.gz", hash = "sha256:cdcc23c9528601a8a293eb4369cbd14f6b4f34f07ae8769421252e9c22718b6f"},
-]
-zipp = [
-    {file = "zipp-3.14.0-py3-none-any.whl", hash = "sha256:188834565033387710d046e3fe96acfc9b5e86cbca7f39ff69cf21a4128198b7"},
-    {file = "zipp-3.14.0.tar.gz", hash = "sha256:9e5421e176ef5ab4c0ad896624e87a7b2f07aca746c9b2aa305952800cb8eecb"},
-]

pyasic/API/bmminer.py

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

pyasic/__init__.py

@@ -13,45 +13,12 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-from pyasic.API.bmminer import BMMinerAPI
-from pyasic.API.bosminer import BOSMinerAPI
-from pyasic.API.btminer import BTMinerAPI
-from pyasic.API.cgminer import CGMinerAPI
-from pyasic.API.unknown import UnknownAPI
+from pyasic import settings
 from pyasic.config import MinerConfig
-from pyasic.data import (
-    BraiinsOSError,
-    InnosiliconError,
-    MinerData,
-    WhatsminerError,
-    X19Error,
-)
+from pyasic.data import MinerData
 from pyasic.errors import APIError, APIWarning
-from pyasic.miners import get_miner
-from pyasic.miners.base import AnyMiner
-from pyasic.miners.miner_factory import MinerFactory
-from pyasic.miners.miner_listener import MinerListener
+from pyasic.miners import *
 from pyasic.network import MinerNetwork
-from pyasic.settings import PyasicSettings
-
-__all__ = [
-    "BMMinerAPI",
-    "BOSMinerAPI",
-    "BTMinerAPI",
-    "CGMinerAPI",
-    "UnknownAPI",
-    "MinerConfig",
-    "MinerData",
-    "BraiinsOSError",
-    "InnosiliconError",
-    "WhatsminerError",
-    "X19Error",
-    "APIError",
-    "APIWarning",
-    "get_miner",
-    "AnyMiner",
-    "MinerFactory",
-    "MinerListener",
-    "MinerNetwork",
-    "PyasicSettings",
-]
+from pyasic.rpc import *
+from pyasic.ssh import *
+from pyasic.web import *

pyasic/config/__init__.py

@@ -13,545 +13,218 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from dataclasses import asdict, dataclass, field
 
-import json
-import logging
-import random
-import string
-import time
-from dataclasses import asdict, dataclass, fields
-from typing import Dict, List, Literal
-
-import toml
-import yaml
-
-
-@dataclass
-class _Pool:
-    """A dataclass for pool information.
-
-    Attributes:
-        url: URL of the pool.
-        username: Username on the pool.
-        password: Worker password on the pool.
-    """
-
-    url: str = ""
-    username: str = ""
-    password: str = ""
-
-    @classmethod
-    def fields(cls):
-        return fields(cls)
-
-    def from_dict(self, data: dict):
-        """Convert raw pool data as a dict to usable data and save it to this class.
-
-        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:
-        """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_inno(self, user_suffix: str = None) -> dict:
-        """Convert the data in this class to a dict usable by an Innosilicon device.
-
-        Parameters:
-             user_suffix: The suffix to append to username.
-        """
-        username = self.username
-        if user_suffix:
-            username = f"{username}{user_suffix}"
-
-        pool = {
-            f"Pool": self.url,
-            f"UserName": username,
-            f"Password": 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
-
-    @classmethod
-    def fields(cls):
-        return fields(cls)
-
-    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_inno(self, user_suffix: str = None) -> dict:
-        """Convert the data in this class to a list usable by an Innosilicon device.
-
-        Parameters:
-             user_suffix: The suffix to append to username.
-        """
-        pools = {}
-        for idx, pool in enumerate(self.pools[:3]):
-            pool_data = pool.as_inno(user_suffix=user_suffix)
-            for key in pool_data:
-                pools[f"{key}{idx+1}"] = pool_data[key]
-        return pools
-
-    def as_wm(self, user_suffix: str = None) -> List[dict]:
-        """Convert the data in this class to a list usable by a 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
+from pyasic.config.fans import FanModeConfig
+from pyasic.config.mining import MiningModeConfig
+from pyasic.config.pools import PoolConfig
+from pyasic.config.power_scaling import PowerScalingConfig
+from pyasic.config.temperature import TemperatureConfig
+from pyasic.misc import merge_dicts
 
 
 @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_mode: Autotuning mode, either "wattage" or "hashrate".
-        autotuning_wattage: The wattage to use when autotuning.
-        autotuning_hashrate: The hashrate 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 = 100.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_mode: Literal["power", "hashrate"] = None
-    autotuning_wattage: int = None
-    autotuning_hashrate: int = None
-
-    dps_enabled: bool = None
-    dps_power_step: int = None
-    dps_min_power: int = None
-    dps_shutdown_enabled: bool = None
-    dps_shutdown_duration: float = None
-
-    @classmethod
-    def fields(cls):
-        return fields(cls)
+    """Represents the configuration for a miner including pool configuration, 
+    fan mode, temperature settings, mining mode, and power scaling."""
+    pools: PoolConfig = field(default_factory=PoolConfig.default)
+    fan_mode: FanModeConfig = field(default_factory=FanModeConfig.default)
+    temperature: TemperatureConfig = field(default_factory=TemperatureConfig.default)
+    mining_mode: MiningModeConfig = field(default_factory=MiningModeConfig.default)
+    power_scaling: PowerScalingConfig = field(
+        default_factory=PowerScalingConfig.default
+    )
 
     def as_dict(self) -> dict:
-        """Convert the data in this class to a dict."""
-        logging.debug(f"MinerConfig - (To Dict) - Dumping Dict config")
-        data_dict = asdict(self)
-        for key in asdict(self).keys():
-            if data_dict[key] is None:
-                del data_dict[key]
-        return data_dict
+        """Converts the MinerConfig object to a dictionary."""
+        return asdict(self)
 
-    def as_toml(self) -> str:
-        """Convert the data in this class to toml."""
-        logging.debug(f"MinerConfig - (To TOML) - Dumping TOML config")
-        return toml.dumps(self.as_dict())
-
-    def as_yaml(self) -> str:
-        """Convert the data in this class to yaml."""
-        logging.debug(f"MinerConfig - (To YAML) - Dumping YAML config")
-        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.
-        """
-        logging.debug(f"MinerConfig - (From Raw) - Loading raw config")
-        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 == "bitmain-work-mode":
-                if data[key]:
-                    if data[key] == 1:
-                        self.autotuning_wattage = 0
-            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]
-                    elif _key == "power_target":
-                        self.autotuning_wattage = data[key][_key]
-                    elif _key == "hashrate_target":
-                        self.autotuning_hashrate = data[key][_key]
-                    elif _key == "mode":
-                        self.autotuning_mode = data[key][_key].replace("_target", "")
-
-            if key in ["power_scaling", "performance_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 in ["min_psu_power_limit", "min_power_target"]:
-                        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):
-        """Convert list output from the `AnyMiner.api.pools()` command into a usable data and save it to this class.
-
-        Parameters:
-            pools: The list of pool data to convert.
-        """
-        logging.debug(f"MinerConfig - (From API) - Loading API config")
-        _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.
-        """
-        logging.debug(f"MinerConfig - (From Dict) - Loading Dict config")
-        pool_groups = []
-        for group in data["pool_groups"]:
-            pool_groups.append(_PoolGroup().from_dict(group))
-        for key in data:
-            if hasattr(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.
-        """
-        logging.debug(f"MinerConfig - (From TOML) - Loading TOML config")
-        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.
-        """
-        logging.debug(f"MinerConfig - (From YAML) - Loading YAML config")
-        return self.from_dict(yaml.load(data, Loader=yaml.SafeLoader))
-
-    def as_wm(self, user_suffix: str = None) -> Dict[str, int]:
-        """Convert the data in this class to a config usable by a Whatsminer device.
-
-        Parameters:
-            user_suffix: The suffix to append to username.
-        """
-        logging.debug(f"MinerConfig - (As Whatsminer) - Generating Whatsminer config")
+    def as_am_modern(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the format suitable for modern Antminers."""
         return {
-            "pools": self.pool_groups[0].as_wm(user_suffix=user_suffix),
-            "wattage": self.autotuning_wattage,
+            **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(),
+            **self.power_scaling.as_am_modern(),
+        }
+
+    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(),
+            **self.power_scaling.as_wm(),
+        }
+
+    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(),
+            **self.power_scaling.as_am_old(),
+        }
+
+    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(),
+            **self.power_scaling.as_goldshell(),
+        }
+
+    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(),
+            **self.power_scaling.as_avalon(),
         }
 
     def as_inno(self, user_suffix: str = None) -> dict:
-        """Convert the data in this class to a config usable by an Innosilicon device.
-
-        Parameters:
-            user_suffix: The suffix to append to username.
-        """
-        logging.debug(f"MinerConfig - (As Inno) - Generating Innosilicon config")
-        return self.pool_groups[0].as_inno(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.
-        """
-        logging.debug(f"MinerConfig - (As X19) - Generating X19 config")
-        cfg = {
-            "pools": self.pool_groups[0].as_x19(user_suffix=user_suffix),
-            "bitmain-fan-ctrl": False,
-            "bitmain-fan-pwn": 100,
-            "miner-mode": 0,  # Normal Mode
-        }
-        if self.autotuning_wattage == 0:
-            cfg["miner-mode"] = 1  # Sleep Mode
-
-        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.
-        """
-        logging.debug(f"MinerConfig - (As Avalon) - Generating AvalonMiner config")
-        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.
-        """
-        logging.debug(f"MinerConfig - (As BOS) - Generating BOSMiner config")
-        cfg = {
-            "format": {
-                "version": "1.2+",
-                "model": f"Antminer {model.replace('j', 'J')}",
-                "generator": "pyasic",
-                "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,
-            },
+        """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(),
+            **self.power_scaling.as_inno(),
         }
 
-        if self.autotuning_enabled or self.autotuning_wattage:
-            cfg["autotuning"] = {}
-            if self.autotuning_enabled:
-                cfg["autotuning"]["enabled"] = True
-            else:
-                cfg["autotuning"]["enabled"] = False
-            if self.autotuning_mode:
-                cfg["format"]["version"] = "2.0"
-                cfg["autotuning"]["mode"] = self.autotuning_mode + "_target"
-                if self.autotuning_wattage:
-                    cfg["autotuning"]["power_target"] = self.autotuning_wattage
-                elif self.autotuning_hashrate:
-                    cfg["autotuning"]["hashrate_target"] = self.autotuning_hashrate
-            else:
-                if self.autotuning_wattage:
-                    cfg["autotuning"]["psu_power_limit"] = self.autotuning_wattage
+    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),
+            **self.power_scaling.as_bosminer(),
+        }
 
-        if self.asicboost:
-            cfg["hash_chain_global"] = {}
-            cfg["hash_chain_global"]["asic_boost"] = self.asicboost
+    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),
+            **self.power_scaling.as_boser(),
+        }
 
-        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:
-                if cfg["format"]["version"] == "2.0":
-                    cfg["power_scaling"]["min_power_target"] = self.dps_min_power
-                else:
-                    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_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),
+            **self.power_scaling.as_epic(),
+        }
 
-        return toml.dumps(cfg)
+    def as_auradine(self, user_suffix: str = None) -> dict:
+        """Generates the configuration in the format suitable for Auradine miners."""
+        return {
+            **self.fan_mode.as_auradine(),
+            **self.temperature.as_auradine(),
+            **self.mining_mode.as_auradine(),
+            **self.pools.as_auradine(user_suffix=user_suffix),
+            **self.power_scaling.as_auradine(),
+        }
+
+    @classmethod
+    def from_dict(cls, dict_conf: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from a dictionary."""
+        return cls(
+            pools=PoolConfig.from_dict(dict_conf.get("pools")),
+            mining_mode=MiningModeConfig.from_dict(dict_conf.get("mining_mode")),
+            fan_mode=FanModeConfig.from_dict(dict_conf.get("fan_mode")),
+            temperature=TemperatureConfig.from_dict(dict_conf.get("temperature")),
+            power_scaling=PowerScalingConfig.from_dict(dict_conf.get("power_scaling")),
+        )
+
+    @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),
+            power_scaling=PowerScalingConfig.from_bosminer(toml_conf),
+        )
+
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from gRPC configuration for BOSer."""
+        return cls(
+            pools=PoolConfig.from_boser(grpc_miner_conf),
+            mining_mode=MiningModeConfig.from_boser(grpc_miner_conf),
+            fan_mode=FanModeConfig.from_boser(grpc_miner_conf),
+            temperature=TemperatureConfig.from_boser(grpc_miner_conf),
+            power_scaling=PowerScalingConfig.from_boser(grpc_miner_conf),
+        )
+
+    @classmethod
+    def from_epic(cls, web_conf: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from web configuration for ePIC miners."""
+        return cls(
+            pools=PoolConfig.from_epic(web_conf),
+            fan_mode=FanModeConfig.from_epic(web_conf),
+            temperature=TemperatureConfig.from_epic(web_conf),
+            mining_mode=MiningModeConfig.from_epic(web_conf),
+        )
+
+    @classmethod
+    def from_vnish(cls, web_settings: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from web settings for VNish miners."""
+        return cls(
+            pools=PoolConfig.from_vnish(web_settings),
+            fan_mode=FanModeConfig.from_vnish(web_settings),
+            temperature=TemperatureConfig.from_vnish(web_settings),
+            mining_mode=MiningModeConfig.from_vnish(web_settings),
+        )
+
+    @classmethod
+    def from_auradine(cls, web_conf: dict) -> "MinerConfig":
+        """Constructs a MinerConfig object from web configuration for Auradine miners."""
+        return cls(
+            pools=PoolConfig.from_api(web_conf["pools"]),
+            fan_mode=FanModeConfig.from_auradine(web_conf["fan"]),
+            mining_mode=MiningModeConfig.from_auradine(web_conf["mode"]),
+        )

pyasic/config/base.py

@@ -0,0 +1,108 @@
+# ------------------------------------------------------------------------------
+#  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 asdict, dataclass
+from enum import Enum
+
+
+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 __call__(self, *args, **kwargs):
+        return self.value(*args, **kwargs)
+
+    @classmethod
+    def default(cls):
+        pass
+
+
+@dataclass
+class MinerConfigValue:
+    @classmethod
+    def from_dict(cls, dict_conf: dict | None):
+        return cls()
+
+    def as_dict(self) -> dict:
+        return asdict(self)
+
+    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 {}

pyasic/config/fans.py

@@ -0,0 +1,258 @@
+# ------------------------------------------------------------------------------
+#  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, field
+
+from pyasic.config.base import MinerConfigOption, MinerConfigValue
+
+
+@dataclass
+class FanModeNormal(MinerConfigValue):
+    mode: str = field(init=False, default="normal")
+    minimum_fans: int = 1
+    minimum_speed: int = 0
+
+    @classmethod
+    def from_dict(cls, dict_conf: 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
+                    )
+                }
+            }
+        }
+
+
+@dataclass
+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}}}
+
+
+@dataclass
+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}}
+
+
+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(temperature_conf["minimumRequiredFans"])
+            return cls.normal()
+        if "manual" in keys:
+            conf = {}
+            if "fanSpeedRatio" in temperature_conf["manual"].keys():
+                conf["speed"] = int(temperature_conf["manual"]["fanSpeedRatio"])
+            if "minimumRequiredFans" in keys:
+                conf["minimum_fans"] = int(temperature_conf["minimumRequiredFans"])
+            return cls.manual(**conf)
+
+    @classmethod
+    def from_auradine(cls, web_fan: dict):
+        try:
+            fan_data = web_fan["Fan"][0]
+            fan_1_max = fan_data["Max"]
+            fan_1_target = fan_data["Target"]
+            return cls.manual(speed=round((fan_1_target / fan_1_max) * 100))
+        except LookupError:
+            return cls.default()

pyasic/config/mining.py

@@ -0,0 +1,470 @@
+# ------------------------------------------------------------------------------
+#  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, field
+
+from pyasic import settings
+from pyasic.config.base import MinerConfigOption, MinerConfigValue
+from pyasic.web.braiins_os.proto.braiins.bos.v1 import (
+    HashrateTargetMode,
+    PerformanceMode,
+    Power,
+    PowerTargetMode,
+    SaveAction,
+    SetPerformanceModeRequest,
+    TeraHashrate,
+    TunerPerformanceMode,
+)
+
+
+@dataclass
+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}}
+
+
+@dataclass
+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}}
+
+
+@dataclass
+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}}
+
+
+@dataclass
+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"}}
+
+
+@dataclass
+class StandardTuneAlgo(MinerConfigValue):
+    mode: str = field(init=False, default="standard")
+
+    def as_epic(self) -> str:
+        return VOptAlgo().as_epic()
+
+
+@dataclass
+class VOptAlgo(MinerConfigValue):
+    mode: str = field(init=False, default="voltage_optimizer")
+
+    def as_epic(self) -> str:
+        return "VoltageOptimizer"
+
+
+class ChipTuneAlgo(MinerConfigValue):
+    mode: str = field(init=False, default="chip_tune")
+
+    def as_epic(self) -> str:
+        return "ChipTune"
+
+
+@dataclass
+class TunerAlgo(MinerConfigOption):
+    standard = StandardTuneAlgo
+    voltage_optimizer = VOptAlgo
+    chip_tune = ChipTuneAlgo
+
+    @classmethod
+    def default(cls):
+        return cls.standard()
+
+    @classmethod
+    def from_dict(cls, dict_conf: dict | None):
+        mode = dict_conf.get("mode")
+        if mode is None:
+            return cls.default()
+
+        cls_attr = getattr(cls, mode)
+        if cls_attr is not None:
+            return cls_attr().from_dict(dict_conf)
+
+
+@dataclass
+class MiningModePowerTune(MinerConfigValue):
+    mode: str = field(init=False, default="power_tuning")
+    power: int = None
+    algo: TunerAlgo = field(default_factory=TunerAlgo.default)
+
+    @classmethod
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModePowerTune":
+        cls_conf = {}
+        if dict_conf.get("power"):
+            cls_conf["power"] = dict_conf["power"]
+        if dict_conf.get("algo"):
+            cls_conf["algo"] = TunerAlgo.from_dict(dict_conf["algo"])
+
+        return cls(**cls_conf)
+
+    def as_am_modern(self) -> dict:
+        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:
+        conf = {"enabled": True, "mode": "power_target"}
+        if self.power is not None:
+            conf["power_target"] = self.power
+        return {"autotuning": conf}
+
+    def as_boser(self) -> dict:
+        return {
+            "set_performance_mode": SetPerformanceModeRequest(
+                save_action=SaveAction.SAVE_ACTION_SAVE_AND_APPLY,
+                mode=PerformanceMode(
+                    tuner_mode=TunerPerformanceMode(
+                        power_target=PowerTargetMode(
+                            power_target=Power(watt=self.power)
+                        )
+                    )
+                ),
+            ),
+        }
+
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": "custom", "tune": "power", "power": self.power}}
+
+
+@dataclass
+class MiningModeHashrateTune(MinerConfigValue):
+    mode: str = field(init=False, default="hashrate_tuning")
+    hashrate: int = None
+    algo: TunerAlgo = field(default_factory=TunerAlgo.default)
+
+    @classmethod
+    def from_dict(cls, dict_conf: dict | None) -> "MiningModeHashrateTune":
+        cls_conf = {}
+        if dict_conf.get("hashrate"):
+            cls_conf["hashrate"] = dict_conf["hashrate"]
+        if dict_conf.get("algo"):
+            cls_conf["algo"] = TunerAlgo.from_dict(dict_conf["algo"])
+
+        return cls(**cls_conf)
+
+    def as_am_modern(self) -> dict:
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
+
+    def as_bosminer(self) -> dict:
+        conf = {"enabled": True, "mode": "hashrate_target"}
+        if self.hashrate is not None:
+            conf["hashrate_target"] = self.hashrate
+        return {"autotuning": conf}
+
+    def as_boser(self) -> dict:
+        return {
+            "set_performance_mode": SetPerformanceModeRequest(
+                save_action=SaveAction.SAVE_ACTION_SAVE_AND_APPLY,
+                mode=PerformanceMode(
+                    tuner_mode=TunerPerformanceMode(
+                        hashrate_target=HashrateTargetMode(
+                            hashrate_target=TeraHashrate(
+                                terahash_per_second=self.hashrate
+                            )
+                        )
+                    )
+                ),
+            )
+        }
+
+    def as_auradine(self) -> dict:
+        return {"mode": {"mode": "custom", "tune": "ths", "ths": self.hashrate}}
+
+    def as_epic(self) -> dict:
+        return {"ptune": {"algo": self.algo.as_epic(), "target": self.hashrate}}
+
+
+@dataclass
+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}
+
+
+@dataclass
+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}
+
+    @classmethod
+    def from_vnish(cls, web_overclock_settings: dict) -> "MiningModeManual":
+        # will raise KeyError if it cant find the settings, values cannot be empty
+        voltage = web_overclock_settings["globals"]["volt"]
+        freq = web_overclock_settings["globals"]["freq"]
+        boards = {
+            idx: ManualBoardSettings(
+                freq=board["freq"],
+                volt=voltage if not board["freq"] == 0 else 0,
+            )
+            for idx, board in enumerate(web_overclock_settings["chains"])
+        }
+        return cls(global_freq=freq, global_volt=voltage, boards=boards)
+
+
+class MiningModeConfig(MinerConfigOption):
+    normal = MiningModeNormal
+    low = MiningModeLPM
+    high = MiningModeHPM
+    sleep = MiningModeSleep
+    power_tuning = MiningModePowerTune
+    hashrate_tuning = MiningModeHashrateTune
+    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:
+                    return cls.hashrate_tuning(
+                        hashrate=algo_info["VoltageOptimizer"]["Target"],
+                        algo=TunerAlgo.voltage_optimizer,
+                    )
+                else:
+                    return cls.hashrate_tuning(
+                        hashrate=algo_info["ChipTune"]["Target"],
+                        algo=TunerAlgo.chip_tune,
+                    )
+            else:
+                return cls.normal()
+        except KeyError:
+            return cls.default()
+
+    @classmethod
+    def from_bosminer(cls, toml_conf: dict):
+        if toml_conf.get("autotuning") is None:
+            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(autotuning_conf["psu_power_limit"])
+        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(autotuning_conf["power_target"])
+                return cls.power_tuning()
+            if mode == "hashrate_target":
+                if autotuning_conf.get("hashrate_target") is not None:
+                    return cls.hashrate_tuning(autotuning_conf["hashrate_target"])
+                return cls.hashrate_tuning()
+
+    @classmethod
+    def from_vnish(cls, web_settings: dict):
+        try:
+            mode_settings = web_settings["miner"]["overclock"]
+        except KeyError:
+            return cls.default()
+
+        if mode_settings["preset"] == "disabled":
+            return MiningModeManual.from_vnish(mode_settings)
+        else:
+            return cls.power_tuning(int(mode_settings["preset"]))
+
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict):
+        try:
+            tuner_conf = grpc_miner_conf["tuner"]
+            if not tuner_conf.get("enabled", False):
+                return cls.default()
+        except LookupError:
+            return cls.default()
+
+        if tuner_conf.get("tunerMode") is not None:
+            if tuner_conf["tunerMode"] == 1:
+                if tuner_conf.get("powerTarget") is not None:
+                    return cls.power_tuning(tuner_conf["powerTarget"]["watt"])
+                return cls.power_tuning()
+
+            if tuner_conf["tunerMode"] == 2:
+                if tuner_conf.get("hashrateTarget") is not None:
+                    return cls.hashrate_tuning(
+                        int(tuner_conf["hashrateTarget"]["terahashPerSecond"])
+                    )
+                return cls.hashrate_tuning()
+
+        if tuner_conf.get("powerTarget") is not None:
+            return cls.power_tuning(tuner_conf["powerTarget"]["watt"])
+
+        if tuner_conf.get("hashrateTarget") is not None:
+            return cls.hashrate_tuning(
+                int(tuner_conf["hashrateTarget"]["terahashPerSecond"])
+            )
+
+    @classmethod
+    def from_auradine(cls, web_mode: dict):
+        try:
+            mode_data = web_mode["Mode"][0]
+            if mode_data.get("Sleep") == "on":
+                return cls.sleep()
+            if mode_data.get("Mode") == "normal":
+                return cls.normal()
+            if mode_data.get("Mode") == "eco":
+                return cls.low()
+            if mode_data.get("Mode") == "turbo":
+                return cls.high()
+            if mode_data.get("Ths") is not None:
+                return cls.hashrate_tuning(mode_data["Ths"])
+            if mode_data.get("Power") is not None:
+                return cls.power_tuning(mode_data["Power"])
+        except LookupError:
+            return cls.default()

pyasic/config/pools.py

@@ -0,0 +1,483 @@
+# ------------------------------------------------------------------------------
+#  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 dataclasses import dataclass, field
+from typing import List
+
+from pyasic.config.base import MinerConfigValue
+
+
+@dataclass
+class Pool(MinerConfigValue):
+    url: str
+    user: str
+    password: str
+
+    def as_am_modern(self, user_suffix: str = None) -> dict:
+        if user_suffix is not None:
+            return {
+                "url": self.url,
+                "user": f"{self.user}{user_suffix}",
+                "pass": self.password,
+            }
+        return {"url": self.url, "user": self.user, "pass": self.password}
+
+    def as_wm(self, idx: int = 1, user_suffix: str = None) -> dict:
+        if user_suffix is not None:
+            return {
+                f"pool_{idx}": self.url,
+                f"worker_{idx}": f"{self.user}{user_suffix}",
+                f"passwd_{idx}": self.password,
+            }
+        return {
+            f"pool_{idx}": self.url,
+            f"worker_{idx}": self.user,
+            f"passwd_{idx}": self.password,
+        }
+
+    def as_am_old(self, idx: int = 1, user_suffix: str = None) -> dict:
+        if user_suffix is not None:
+            return {
+                f"_ant_pool{idx}url": self.url,
+                f"_ant_pool{idx}user": f"{self.user}{user_suffix}",
+                f"_ant_pool{idx}pw": self.password,
+            }
+        return {
+            f"_ant_pool{idx}url": self.url,
+            f"_ant_pool{idx}user": self.user,
+            f"_ant_pool{idx}pw": self.password,
+        }
+
+    def as_goldshell(self, user_suffix: str = None) -> dict:
+        if user_suffix is not None:
+            return {
+                "url": self.url,
+                "user": f"{self.user}{user_suffix}",
+                "pass": self.password,
+            }
+        return {"url": self.url, "user": self.user, "pass": self.password}
+
+    def as_avalon(self, user_suffix: str = None) -> str:
+        if user_suffix is not None:
+            return ",".join([self.url, f"{self.user}{user_suffix}", self.password])
+        return ",".join([self.url, self.user, self.password])
+
+    def as_inno(self, idx: int = 1, user_suffix: str = None) -> dict:
+        if user_suffix is not None:
+            return {
+                f"Pool{idx}": self.url,
+                f"UserName{idx}": f"{self.user}{user_suffix}",
+                f"Password{idx}": self.password,
+            }
+        return {
+            f"Pool{idx}": self.url,
+            f"UserName{idx}": self.user,
+            f"Password{idx}": self.password,
+        }
+
+    def as_bosminer(self, user_suffix: str = None) -> dict:
+        if user_suffix is not None:
+            return {
+                "url": self.url,
+                "user": f"{self.user}{user_suffix}",
+                "password": self.password,
+            }
+        return {"url": self.url, "user": self.user, "password": self.password}
+
+    def as_auradine(self, user_suffix: str = None) -> dict:
+        if user_suffix is not None:
+            return {
+                "url": self.url,
+                "user": f"{self.user}{user_suffix}",
+                "pass": self.password,
+            }
+        return {"url": self.url, "user": self.user, "pass": self.password}
+
+    def as_epic(self, user_suffix: str = None):
+        if user_suffix is not None:
+            return {
+                "pool": self.url,
+                "login": f"{self.user}{user_suffix}",
+                "password": self.password,
+            }
+        return {"pool": self.url, "login": self.user, "password": self.password}
+
+    @classmethod
+    def from_dict(cls, dict_conf: 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=web_pool["url"],
+            user=web_pool["user"],
+            password=web_pool["pass"],
+        )
+
+    @classmethod
+    def from_boser(cls, grpc_pool: dict) -> "Pool":
+        return cls(
+            url=grpc_pool["url"],
+            user=grpc_pool["user"],
+            password=grpc_pool["password"],
+        )
+
+
+@dataclass
+class PoolGroup(MinerConfigValue):
+    pools: list[Pool] = field(default_factory=list)
+    quota: int = 1
+    name: str = 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) -> 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("", "", "").as_am_modern())
+            idx += 1
+        return pools
+
+    def as_wm(self, user_suffix: str = 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("", "", "").as_wm(idx=idx + 1))
+            idx += 1
+        return pools
+
+    def as_am_old(self, user_suffix: str = 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("", "", "").as_am_old(idx=idx + 1))
+            idx += 1
+        return pools
+
+    def as_goldshell(self, user_suffix: str = None) -> list:
+        return [pool.as_goldshell(user_suffix) for pool in self.pools]
+
+    def as_avalon(self, user_suffix: str = None) -> str:
+        if len(self.pools) > 0:
+            return self.pools[0].as_avalon(user_suffix=user_suffix)
+        return Pool("", "", "").as_avalon()
+
+    def as_inno(self, user_suffix: str = 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("", "", "").as_inno(idx=idx + 1))
+            idx += 1
+        return pools
+
+    def as_bosminer(self, user_suffix: str = 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) -> list:
+        return [p.as_auradine(user_suffix=user_suffix) for p in self.pools]
+
+    def as_epic(self, user_suffix: str = None) -> dict:
+        return [p.as_epic(user_suffix=user_suffix) for p in self.pools]
+
+    @classmethod
+    def from_dict(cls, dict_conf: 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([Pool.from_goldshell(p) for p in web_pools])
+
+    @classmethod
+    def from_inno(cls, web_pools: list) -> "PoolGroup":
+        return cls([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([Pool.from_vnish(p) for p in web_settings_pools])
+
+    @classmethod
+    def from_boser(cls, grpc_pool_group: dict) -> "PoolGroup":
+        try:
+            return cls(
+                pools=[Pool.from_boser(p) for p in grpc_pool_group["pools"]],
+                name=grpc_pool_group["name"],
+                quota=(
+                    grpc_pool_group["quota"]["value"]
+                    if grpc_pool_group.get("quota") is not None
+                    else 1
+                ),
+            )
+        except LookupError:
+            return cls()
+
+
+@dataclass
+class PoolConfig(MinerConfigValue):
+    groups: List[PoolGroup] = field(default_factory=list)
+
+    @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) -> 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) -> 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) -> 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) -> 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) -> 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) -> 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) -> 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) -> dict:
+        return {}
+
+    def as_auradine(self, user_suffix: str = None) -> dict:
+        if len(self.groups) > 0:
+            return {
+                "updatepools": {
+                    "pools": self.groups[0].as_auradine(user_suffix=user_suffix)
+                }
+            }
+        return {"updatepools": {"pools": PoolGroup().as_auradine()}}
+
+    def as_epic(self, user_suffix: str = None) -> dict:
+        if len(self.groups) > 0:
+            return {
+                "pools": {
+                    "coin": "Btc",
+                    "stratum_configs": self.groups[0].as_epic(user_suffix=user_suffix),
+                    "unique_id": False,
+                }
+            }
+        return {
+            "pools": {
+                "coin": "Btc",
+                "stratum_configs": [PoolGroup().as_epic()],
+                "unique_id": False,
+            }
+        }
+
+    @classmethod
+    def from_api(cls, api_pools: dict) -> "PoolConfig":
+        try:
+            pool_data = api_pools["POOLS"]
+        except KeyError:
+            return PoolConfig.default()
+        pool_data = sorted(pool_data, key=lambda x: int(x["POOL"]))
+
+        return cls([PoolGroup.from_api(pool_data)])
+
+    @classmethod
+    def from_epic(cls, web_conf: dict) -> "PoolConfig":
+        pool_data = web_conf["StratumConfigs"]
+        return cls([PoolGroup.from_epic(pool_data)])
+
+    @classmethod
+    def from_am_modern(cls, web_conf: dict) -> "PoolConfig":
+        pool_data = web_conf["pools"]
+
+        return cls([PoolGroup.from_am_modern(pool_data)])
+
+    @classmethod
+    def from_goldshell(cls, web_pools: list) -> "PoolConfig":
+        return cls([PoolGroup.from_goldshell(web_pools)])
+
+    @classmethod
+    def from_inno(cls, web_pools: list) -> "PoolConfig":
+        return cls([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([PoolGroup.from_bosminer(g) for g in toml_conf["group"]])
+
+    @classmethod
+    def from_vnish(cls, web_settings: dict) -> "PoolConfig":
+        try:
+            return cls([PoolGroup.from_vnish(web_settings["miner"]["pools"])])
+        except LookupError:
+            return cls()
+
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict) -> "PoolConfig":
+        try:
+            return cls(
+                groups=[
+                    PoolGroup.from_boser(group)
+                    for group in grpc_miner_conf["poolGroups"]
+                ]
+            )
+        except LookupError:
+            return cls()

pyasic/config/power_scaling.py

@@ -0,0 +1,221 @@
+# ------------------------------------------------------------------------------
+#  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, field
+
+from pyasic.config.base import MinerConfigOption, MinerConfigValue
+from pyasic.web.braiins_os.proto.braiins.bos.v1 import (
+    DpsPowerTarget,
+    DpsTarget,
+    Power,
+    SetDpsRequest,
+)
+
+
+@dataclass
+class PowerScalingShutdownEnabled(MinerConfigValue):
+    mode: str = field(init=False, default="enabled")
+    duration: int = None
+
+    @classmethod
+    def from_dict(cls, dict_conf: dict | None) -> "PowerScalingShutdownEnabled":
+        return cls(duration=dict_conf.get("duration"))
+
+    def as_bosminer(self) -> dict:
+        cfg = {"shutdown_enabled": True}
+
+        if self.duration is not None:
+            cfg["shutdown_duration"] = self.duration
+
+        return cfg
+
+    def as_boser(self) -> dict:
+        return {"enable_shutdown": True, "shutdown_duration": self.duration}
+
+
+@dataclass
+class PowerScalingShutdownDisabled(MinerConfigValue):
+    mode: str = field(init=False, default="disabled")
+
+    @classmethod
+    def from_dict(cls, dict_conf: dict | None) -> "PowerScalingShutdownDisabled":
+        return cls()
+
+    def as_bosminer(self) -> dict:
+        return {"shutdown_enabled": False}
+
+    def as_boser(self) -> dict:
+        return {"enable_shutdown ": False}
+
+
+class PowerScalingShutdown(MinerConfigOption):
+    enabled = PowerScalingShutdownEnabled
+    disabled = PowerScalingShutdownDisabled
+
+    @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()
+
+        clsattr = getattr(cls, mode)
+        if clsattr is not None:
+            return clsattr().from_dict(dict_conf)
+
+    @classmethod
+    def from_bosminer(cls, power_scaling_conf: dict):
+        sd_enabled = power_scaling_conf.get("shutdown_enabled")
+        if sd_enabled is not None:
+            if sd_enabled:
+                return cls.enabled(power_scaling_conf.get("shutdown_duration"))
+            else:
+                return cls.disabled()
+        return None
+
+    @classmethod
+    def from_boser(cls, power_scaling_conf: dict):
+        sd_enabled = power_scaling_conf.get("shutdownEnabled")
+        if sd_enabled is not None:
+            if sd_enabled:
+                try:
+                    return cls.enabled(power_scaling_conf["shutdownDuration"]["hours"])
+                except KeyError:
+                    return cls.enabled()
+            else:
+                return cls.disabled()
+        return None
+
+
+@dataclass
+class PowerScalingEnabled(MinerConfigValue):
+    mode: str = field(init=False, default="enabled")
+    power_step: int = None
+    minimum_power: int = None
+    shutdown_enabled: PowerScalingShutdownEnabled | PowerScalingShutdownDisabled = None
+
+    @classmethod
+    def from_bosminer(cls, power_scaling_conf: dict) -> "PowerScalingEnabled":
+        power_step = power_scaling_conf.get("power_step")
+        min_power = power_scaling_conf.get("min_psu_power_limit")
+        if min_power is None:
+            min_power = power_scaling_conf.get("min_power_target")
+        sd_mode = PowerScalingShutdown.from_bosminer(power_scaling_conf)
+
+        return cls(
+            power_step=power_step, minimum_power=min_power, shutdown_enabled=sd_mode
+        )
+
+    @classmethod
+    def from_dict(cls, dict_conf: dict | None) -> "PowerScalingEnabled":
+        cls_conf = {
+            "power_step": dict_conf.get("power_step"),
+            "minimum_power": dict_conf.get("minimum_power"),
+        }
+        shutdown_enabled = dict_conf.get("shutdown_enabled")
+        if shutdown_enabled is not None:
+            cls_conf["shutdown_enabled"] = PowerScalingShutdown.from_dict(
+                shutdown_enabled
+            )
+        return cls(**cls_conf)
+
+    def as_bosminer(self) -> dict:
+        cfg = {"enabled": True}
+        if self.power_step is not None:
+            cfg["power_step"] = self.power_step
+        if self.minimum_power is not None:
+            cfg["min_power_target"] = self.minimum_power
+
+        if self.shutdown_enabled is not None:
+            cfg = {**cfg, **self.shutdown_enabled.as_bosminer()}
+
+        return {"performance_scaling": cfg}
+
+    def as_boser(self) -> dict:
+        return {
+            "set_dps": SetDpsRequest(
+                enable=True,
+                **self.shutdown_enabled.as_boser(),
+                target=DpsTarget(
+                    power_target=DpsPowerTarget(
+                        power_step=Power(self.power_step),
+                        min_power_target=Power(self.minimum_power),
+                    )
+                ),
+            ),
+        }
+
+
+@dataclass
+class PowerScalingDisabled(MinerConfigValue):
+    mode: str = field(init=False, default="disabled")
+
+
+class PowerScalingConfig(MinerConfigOption):
+    enabled = PowerScalingEnabled
+    disabled = PowerScalingDisabled
+
+    @classmethod
+    def default(cls):
+        return cls.disabled()
+
+    @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()
+
+        clsattr = getattr(cls, mode)
+        if clsattr is not None:
+            return clsattr().from_dict(dict_conf)
+
+    @classmethod
+    def from_bosminer(cls, toml_conf: dict):
+        power_scaling = toml_conf.get("power_scaling")
+        if power_scaling is None:
+            power_scaling = toml_conf.get("performance_scaling")
+        if power_scaling is not None:
+            enabled = power_scaling.get("enabled")
+            if enabled is not None:
+                if enabled:
+                    return cls.enabled().from_bosminer(power_scaling)
+                else:
+                    return cls.disabled()
+
+        return cls.default()
+
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict):
+        try:
+            dps_conf = grpc_miner_conf["dps"]
+            if not dps_conf.get("enabled", False):
+                return cls.disabled()
+        except LookupError:
+            return cls.default()
+
+        conf = {"shutdown_enabled": PowerScalingShutdown.from_boser(dps_conf)}
+
+        if dps_conf.get("minPowerTarget") is not None:
+            conf["minimum_power"] = dps_conf["minPowerTarget"]["watt"]
+        if dps_conf.get("powerStep") is not None:
+            conf["power_step"] = dps_conf["powerStep"]["watt"]
+        return cls.enabled(**conf)

pyasic/config/temperature.py

@@ -0,0 +1,123 @@
+# ------------------------------------------------------------------------------
+#  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
+
+
+@dataclass
+class TemperatureConfig(MinerConfigValue):
+    target: int = None
+    hot: int = None
+    danger: int = 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
+        return {"temp_control": temp_cfg}
+
+    def as_epic(self) -> dict:
+        temps_config = {"temps": {}, "fans": {"Auto": {}}}
+        if self.target is not None:
+            temps_config["fans"]["Auto"]["Target Temperature"] = self.target
+        else:
+            temps_config["fans"]["Auto"]["Target Temperature"] = 60
+        if self.danger is not None:
+            temps_config["temps"]["shutdown"] = self.danger
+        return temps_config
+
+    @classmethod
+    def from_dict(cls, dict_conf: 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"),
+            )
+
+    @classmethod
+    def from_epic(cls, web_conf: dict) -> "TemperatureConfig":
+        try:
+            dangerous_temp = web_conf["Misc"]["Shutdown Temp"]
+        except KeyError:
+            dangerous_temp = None
+        # Need to do this in two blocks to avoid KeyError if one is missing
+        try:
+            target_temp = web_conf["Fans"]["Fan Mode"]["Auto"]["Target Temperature"]
+        except KeyError:
+            target_temp = None
+
+        return cls(target=target_temp, danger=dangerous_temp)
+
+    @classmethod
+    def from_vnish(cls, web_settings: dict) -> "TemperatureConfig":
+        try:
+            if web_settings["miner"]["cooling"]["mode"]["name"] == "auto":
+                return cls(target=web_settings["miner"]["cooling"]["mode"]["param"])
+        except KeyError:
+            pass
+        return cls()
+
+    @classmethod
+    def from_boser(cls, grpc_miner_conf: dict) -> "TemperatureConfig":
+        try:
+            temperature_conf = grpc_miner_conf["temperature"]
+        except KeyError:
+            return cls.default()
+
+        root_key = None
+        for key in ["auto", "manual", "disabled"]:
+            if key in temperature_conf.keys():
+                root_key = key
+                break
+        if root_key is None:
+            return cls.default()
+
+        conf = {}
+        keys = temperature_conf[root_key].keys()
+        if "targetTemperature" in keys:
+            conf["target"] = int(
+                temperature_conf[root_key]["targetTemperature"]["degreeC"]
+            )
+        if "hotTemperature" in keys:
+            conf["hot"] = int(temperature_conf[root_key]["hotTemperature"]["degreeC"])
+        if "dangerousTemperature" in keys:
+            conf["danger"] = int(
+                temperature_conf[root_key]["dangerousTemperature"]["degreeC"]
+            )
+
+            return cls(**conf)
+        return cls.default()

pyasic/data/__init__.py

@@ -16,47 +16,17 @@
 
 import copy
 import json
-import logging
 import time
 from dataclasses import asdict, dataclass, field, fields
 from datetime import datetime, timezone
-from typing import List, Union
+from typing import Any, List, Union
 
+from pyasic.config import MinerConfig
+from pyasic.config.mining import MiningModePowerTune
+
+from .boards import HashBoard
 from .error_codes import BraiinsOSError, InnosiliconError, WhatsminerError, X19Error
-
-
-@dataclass
-class HashBoard:
-    """A Dataclass to standardize hashboard data.
-
-    Attributes:
-        slot: The slot of the board as an int.
-        hashrate: The hashrate of the board in TH/s as a float.
-        temp: The temperature of the PCB as an int.
-        chip_temp: The temperature of the chips as an int.
-        chips: The chip count of the board as an int.
-        expected_chips: The ideal chip count of the board as an int.
-        missing: Whether the board is returned from the miners data as a bool.
-    """
-
-    slot: int = 0
-    hashrate: float = 0.0
-    temp: int = -1
-    chip_temp: int = -1
-    chips: int = 0
-    expected_chips: int = 0
-    missing: bool = True
-
-
-@dataclass
-class Fan:
-    """A Dataclass to standardize fan data.
-
-    Attributes:
-        speed: The speed of the fan.
-    """
-
-    speed: int = -1
+from .fans import Fan
 
 
 @dataclass
@@ -66,105 +36,97 @@ class MinerData:
     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.
         model: The model of the miner as a str.
         make: The make 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.
-        nominal_hashrate: The factory nominal 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.
+        hashrate: The hashrate of the miner in TH/s as a float.  Calculated automatically.
+        _hashrate: Backup for hashrate found via API instead of hashboards.
+        expected_hashrate: The factory nominal hashrate of the miner in TH/s as a float.
+        hashboards: A list of [`HashBoard`][pyasic.data.HashBoard]s on the miner with their statistics.
         temperature_avg: The average temperature across the boards.  Calculated automatically.
         env_temp: The environment temps as a float.
-        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.
         wattage_limit: Power limit of the miner as an int.
-        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.
+        fans: A list of fans on the miner with their speeds.
         fan_psu: The speed of the PSU on the fan if the miner collects it.
-        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.
-        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.
+        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.
-        pool_split: The pool split as a str.
-        pool_1_url: The first pool url on the miner as a str.
-        pool_1_user: The first pool user on the miner as a str.
-        pool_2_url: The second pool url on the miner as a str.
-        pool_2_user: The second pool user on the miner as a str.
+        config: The parsed config of the miner, using [`MinerConfig`][pyasic.config.MinerConfig].
         errors: A list of errors on the miner.
-        fault_light: Whether or not the fault light is on as a boolean.
+        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.
     """
 
     ip: str
     datetime: datetime = None
-    mac: str = "00:00:00:00:00:00"
-    model: str = "Unknown"
-    make: str = "Unknown"
-    api_ver: str = "Unknown"
-    fw_ver: str = "Unknown"
-    hostname: str = "Unknown"
-    hashrate: float = 0
-    nominal_hashrate: float = 0
+    uptime: int = None
+    mac: str = None
+    model: str = None
+    make: str = None
+    api_ver: str = None
+    fw_ver: str = None
+    hostname: str = None
+    hashrate: float = field(init=False)
+    _hashrate: float = field(repr=False, default=None)
+    expected_hashrate: float = None
     hashboards: List[HashBoard] = field(default_factory=list)
-    ideal_hashboards: int = 1
-    left_board_hashrate: float = field(init=False)
-    center_board_hashrate: float = field(init=False)
-    right_board_hashrate: float = field(init=False)
+    expected_hashboards: int = None
     temperature_avg: int = field(init=False)
-    env_temp: float = -1.0
-    left_board_temp: int = field(init=False)
-    left_board_chip_temp: int = field(init=False)
-    center_board_temp: int = field(init=False)
-    center_board_chip_temp: int = field(init=False)
-    right_board_temp: int = field(init=False)
-    right_board_chip_temp: int = field(init=False)
-    wattage: int = -1
-    wattage_limit: int = -1
+    env_temp: float = None
+    wattage: int = None
+    wattage_limit: int = field(init=False)
+    _wattage_limit: int = field(repr=False, default=None)
     fans: List[Fan] = field(default_factory=list)
-    fan_1: int = field(init=False)
-    fan_2: int = field(init=False)
-    fan_3: int = field(init=False)
-    fan_4: int = field(init=False)
-    fan_psu: int = -1
-    left_chips: int = field(init=False)
-    center_chips: int = field(init=False)
-    right_chips: int = field(init=False)
+    fan_psu: int = None
     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 = ""
+    expected_chips: int = None
+    percent_expected_chips: float = field(init=False)
+    percent_expected_hashrate: float = field(init=False)
+    percent_expected_wattage: float = field(init=False)
+    nominal: bool = field(init=False)
+    config: MinerConfig = None
     errors: List[
-        Union[WhatsminerError, BraiinsOSError, X19Error, InnosiliconError]
+        Union[
+            WhatsminerError,
+            BraiinsOSError,
+            X19Error,
+            InnosiliconError,
+        ]
     ] = field(default_factory=list)
     fault_light: Union[bool, None] = None
     efficiency: int = field(init=False)
+    is_mining: bool = True
 
     @classmethod
     def fields(cls):
-        return [f.name for f in fields(cls)]
+        return [f.name for f in fields(cls) if not f.name.startswith("_")]
+
+    @staticmethod
+    def dict_factory(x):
+        return {k: v for (k, v) in x if not k.startswith("_")}
 
     def __post_init__(self):
         self.datetime = datetime.now(timezone.utc).astimezone()
 
-    def __getitem__(self, item):
+    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:
@@ -214,201 +176,90 @@ class MinerData:
         return cp
 
     @property
-    def fan_1(self):  # noqa - Skip PyCharm inspection
-        if len(self.fans) > 0:
-            return self.fans[0].speed
+    def hashrate(self):  # noqa - Skip PyCharm inspection
+        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 round(sum(hr_data), 2)
+        return self._hashrate
 
-    @fan_1.setter
-    def fan_1(self, val):
-        pass
+    @hashrate.setter
+    def hashrate(self, val):
+        self._hashrate = val
 
     @property
-    def fan_2(self):  # noqa - Skip PyCharm inspection
-        if len(self.fans) > 1:
-            return self.fans[1].speed
+    def wattage_limit(self):  # noqa - Skip PyCharm inspection
+        if self.config is not None:
+            if isinstance(self.config.mining_mode, MiningModePowerTune):
+                return self.config.mining_mode.power
+        return self._wattage_limit
 
-    @fan_2.setter
-    def fan_2(self, val):
-        pass
-
-    @property
-    def fan_3(self):  # noqa - Skip PyCharm inspection
-        if len(self.fans) > 2:
-            return self.fans[2].speed
-
-    @fan_3.setter
-    def fan_3(self, val):
-        pass
-
-    @property
-    def fan_4(self):  # noqa - Skip PyCharm inspection
-        if len(self.fans) > 3:
-            return self.fans[3].speed
-
-    @fan_4.setter
-    def fan_4(self, val):
-        pass
+    @wattage_limit.setter
+    def wattage_limit(self, val: int):
+        self._wattage_limit = val
 
     @property
     def total_chips(self):  # noqa - Skip PyCharm inspection
-        return sum([hb.chips for hb in self.hashboards])
+        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
 
     @total_chips.setter
     def total_chips(self, val):
         pass
 
-    @property
-    def left_chips(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) in [2, 3]:
-            return self.hashboards[0].chips
-        return 0
-
-    @left_chips.setter
-    def left_chips(self, val):
-        pass
-
-    @property
-    def center_chips(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) == 1:
-            return self.hashboards[0].chips
-        if len(self.hashboards) == 3:
-            return self.hashboards[1].chips
-        return 0
-
-    @center_chips.setter
-    def center_chips(self, val):
-        pass
-
-    @property
-    def right_chips(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) == 2:
-            return self.hashboards[1].chips
-        if len(self.hashboards) == 3:
-            return self.hashboards[2].chips
-        return 0
-
-    @right_chips.setter
-    def right_chips(self, val):
-        pass
-
-    @property
-    def left_board_hashrate(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) in [2, 3]:
-            return self.hashboards[0].hashrate
-        return 0
-
-    @left_board_hashrate.setter
-    def left_board_hashrate(self, val):
-        pass
-
-    @property
-    def center_board_hashrate(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) == 1:
-            return self.hashboards[0].hashrate
-        if len(self.hashboards) == 3:
-            return self.hashboards[1].hashrate
-        return 0
-
-    @center_board_hashrate.setter
-    def center_board_hashrate(self, val):
-        pass
-
-    @property
-    def right_board_hashrate(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) == 2:
-            return self.hashboards[1].hashrate
-        if len(self.hashboards) == 3:
-            return self.hashboards[2].hashrate
-        return 0
-
-    @right_board_hashrate.setter
-    def right_board_hashrate(self, val):
-        pass
-
-    @property
-    def left_board_temp(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) in [2, 3]:
-            return self.hashboards[0].temp
-        return 0
-
-    @left_board_temp.setter
-    def left_board_temp(self, val):
-        pass
-
-    @property
-    def center_board_temp(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) == 1:
-            return self.hashboards[0].temp
-        if len(self.hashboards) == 3:
-            return self.hashboards[1].temp
-        return 0
-
-    @center_board_temp.setter
-    def center_board_temp(self, val):
-        pass
-
-    @property
-    def right_board_temp(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) == 2:
-            return self.hashboards[1].temp
-        if len(self.hashboards) == 3:
-            return self.hashboards[2].temp
-        return 0
-
-    @right_board_temp.setter
-    def right_board_temp(self, val):
-        pass
-
-    @property
-    def left_board_chip_temp(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) in [2, 3]:
-            return self.hashboards[0].chip_temp
-        return 0
-
-    @left_board_chip_temp.setter
-    def left_board_chip_temp(self, val):
-        pass
-
-    @property
-    def center_board_chip_temp(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) == 1:
-            return self.hashboards[0].chip_temp
-        if len(self.hashboards) == 3:
-            return self.hashboards[1].chip_temp
-        return 0
-
-    @center_board_chip_temp.setter
-    def center_board_chip_temp(self, val):
-        pass
-
-    @property
-    def right_board_chip_temp(self):  # noqa - Skip PyCharm inspection
-        if len(self.hashboards) == 2:
-            return self.hashboards[1].chip_temp
-        if len(self.hashboards) == 3:
-            return self.hashboards[2].chip_temp
-        return 0
-
-    @right_board_chip_temp.setter
-    def right_board_chip_temp(self, val):
-        pass
-
     @property
     def nominal(self):  # noqa - Skip PyCharm inspection
-        return self.ideal_chips == self.total_chips
+        if self.total_chips is None or self.expected_chips is None:
+            return None
+        return self.expected_chips == self.total_chips
 
     @nominal.setter
     def nominal(self, val):
         pass
 
     @property
-    def percent_ideal(self):  # noqa - Skip PyCharm inspection
-        if self.total_chips == 0 or self.ideal_chips == 0:
+    def percent_expected_chips(self):  # noqa - Skip PyCharm inspection
+        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.ideal_chips) * 100)
+        return round((self.total_chips / self.expected_chips) * 100)
 
-    @percent_ideal.setter
-    def percent_ideal(self, val):
+    @percent_expected_chips.setter
+    def percent_expected_chips(self, val):
+        pass
+
+    @property
+    def percent_expected_hashrate(self):  # noqa - Skip PyCharm inspection
+        if self.hashrate is None or self.expected_hashrate is None:
+            return None
+        if self.hashrate == 0 or self.expected_hashrate == 0:
+            return 0
+        return round((self.hashrate / self.expected_hashrate) * 100)
+
+    @percent_expected_hashrate.setter
+    def percent_expected_hashrate(self, val):
+        pass
+
+    @property
+    def percent_expected_wattage(self):  # noqa - Skip PyCharm inspection
+        if self.wattage_limit is None or self.wattage is None:
+            return None
+        if self.wattage_limit == 0 or self.wattage == 0:
+            return 0
+        return round((self.wattage / self.wattage_limit) * 100)
+
+    @percent_expected_wattage.setter
+    def percent_expected_wattage(self, val):
         pass
 
     @property
@@ -416,11 +267,11 @@ class MinerData:
         total_temp = 0
         temp_count = 0
         for hb in self.hashboards:
-            if hb.temp and not hb.temp == -1:
+            if hb.temp is not None:
                 total_temp += hb.temp
                 temp_count += 1
         if not temp_count > 0:
-            return 0
+            return None
         return round(total_temp / temp_count)
 
     @temperature_avg.setter
@@ -429,7 +280,9 @@ class MinerData:
 
     @property
     def efficiency(self):  # noqa - Skip PyCharm inspection
-        if self.hashrate == 0:
+        if self.hashrate is None or self.wattage is None:
+            return None
+        if self.hashrate == 0 or self.wattage == 0:
             return 0
         return round(self.wattage / self.hashrate)
 
@@ -438,13 +291,15 @@ class MinerData:
         pass
 
     def asdict(self) -> dict:
+        return asdict(self, dict_factory=self.dict_factory)
+
+    def as_dict(self) -> dict:
         """Get this dataclass as a dictionary.
 
         Returns:
             A dictionary version of this class.
         """
-        logging.debug(f"MinerData - (To Dict) - Dumping Dict data")
-        return asdict(self)
+        return self.asdict()
 
     def as_json(self) -> str:
         """Get this dataclass as JSON.
@@ -452,7 +307,6 @@ class MinerData:
         Returns:
             A JSON version of this class.
         """
-        logging.debug(f"MinerData - (To JSON) - Dumping JSON data")
         data = self.asdict()
         data["datetime"] = str(int(time.mktime(data["datetime"].timetuple())))
         return json.dumps(data)
@@ -463,7 +317,6 @@ class MinerData:
         Returns:
             A CSV version of this class with no headers.
         """
-        logging.debug(f"MinerData - (To CSV) - Dumping CSV data")
         data = self.asdict()
         data["datetime"] = str(int(time.mktime(data["datetime"].timetuple())))
         errs = []
@@ -482,34 +335,51 @@ class MinerData:
         Returns:
             A influxdb line protocol version of this class.
         """
-        logging.debug(f"MinerData - (To InfluxDB) - Dumping InfluxDB data")
         tag_data = [measurement_name]
         field_data = []
 
         tags = ["ip", "mac", "model", "hostname"]
         for attribute in self:
             if attribute in tags:
-                escaped_data = self[attribute].replace(" ", "\\ ")
+                escaped_data = self.get(attribute, "Unknown").replace(" ", "\\ ")
                 tag_data.append(f"{attribute}={escaped_data}")
                 continue
-            if isinstance(self[attribute], str):
+            elif str(attribute).startswith("_"):
+                continue
+            elif isinstance(self[attribute], str):
                 field_data.append(f'{attribute}="{self[attribute]}"')
                 continue
-            if isinstance(self[attribute], bool):
+            elif isinstance(self[attribute], bool):
                 field_data.append(f"{attribute}={str(self[attribute]).lower()}")
                 continue
-            if isinstance(self[attribute], int):
+            elif isinstance(self[attribute], int):
                 field_data.append(f"{attribute}={self[attribute]}")
                 continue
-            if isinstance(self[attribute], float):
+            elif isinstance(self[attribute], float):
                 field_data.append(f"{attribute}={self[attribute]}")
                 continue
-            if attribute == "fault_light" and not self[attribute]:
-                field_data.append(f"{attribute}=false")
-                continue
-            if attribute == "errors":
+            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)

pyasic/data/boards.py

@@ -0,0 +1,58 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from dataclasses import dataclass
+from typing import Any
+
+
+@dataclass
+class HashBoard:
+    """A Dataclass to standardize hashboard data.
+
+    Attributes:
+        slot: The slot of the board as an int.
+        hashrate: The hashrate of the board in TH/s as a float.
+        temp: The temperature of the PCB as an int.
+        chip_temp: The temperature of the chips as an int.
+        chips: The chip count of the board as an int.
+        expected_chips: The expected chip count of the board as an int.
+        serial_number: The serial number of the board.
+        missing: Whether the board is returned from the miners data as a bool.
+    """
+
+    slot: int = 0
+    hashrate: float = None
+    temp: int = None
+    chip_temp: int = None
+    chips: int = None
+    expected_chips: int = None
+    serial_number: str = None
+    missing: bool = True
+
+    def get(self, __key: str, default: Any = None):
+        try:
+            val = self.__getitem__(__key)
+            if val is None:
+                return default
+            return val
+        except KeyError:
+            return default
+
+    def __getitem__(self, item: str):
+        try:
+            return getattr(self, item)
+        except AttributeError:
+            raise KeyError(f"{item}")

pyasic/data/error_codes/whatsminer.py

@@ -16,8 +16,6 @@
 
 from dataclasses import asdict, dataclass, field, fields
 
-C_N_CODES = ["52", "53", "54", "55"]
-
 
 @dataclass
 class WhatsminerError:
@@ -37,10 +35,8 @@ class WhatsminerError:
 
     @property
     def error_message(self):  # noqa - Skip PyCharm inspection
-        if len(str(self.error_code)) > 3 and str(self.error_code)[:2] in C_N_CODES:
-            # 55 error code base has chip numbers, so the format is
-            # 55 -> board num len 1 -> chip num len 3
-            err_type = 55
+        if len(str(self.error_code)) == 6 and not str(self.error_code)[:1] == "1":
+            err_type = int(str(self.error_code)[:2])
             err_subtype = int(str(self.error_code)[2:3])
             err_value = int(str(self.error_code)[3:])
         else:
@@ -88,7 +84,9 @@ class WhatsminerError:
 
 ERROR_CODES = {
     1: {  # Fan error
-        0: {0: "Fan unknown."},
+        0: {
+            0: "Fan unknown.",
+        },
         1: {  # Fan speed error of 1000+
             0: "Intake fan speed error.",
             1: "Exhaust fan speed error.",
@@ -101,7 +99,9 @@ ERROR_CODES = {
             0: "Intake fan speed error.  Fan speed deviates by more than 3000.",
             1: "Exhaust fan speed error.  Fan speed deviates by more than 3000.",
         },
-        4: {0: "Fan speed too high."},  # High speed
+        4: {
+            0: "Fan speed too high.",
+        },  # High speed
     },
     2: {  # Power error
         0: {
@@ -126,6 +126,7 @@ ERROR_CODES = {
             6: "Power remained unchanged for a long time.",
             7: "Power set enable error.",
             8: "Power input voltage is lower than 230V for high power mode.",
+            9: "Power input current is incorrect.",
         },
         3: {
             3: "Power output high temperature protection error.",
@@ -159,6 +160,8 @@ ERROR_CODES = {
         6: {
             3: "Power communication warning.",
             4: "Power communication error.",
+            5: "Power unknown error.",
+            6: "Power unknown error.",
             7: "Power watchdog protection.",
             8: "Power output high current protection.",
             9: "Power input high current protection.",
@@ -170,57 +173,134 @@ ERROR_CODES = {
             3: "Power input too high warning.",
             4: "Power fan warning.",
             5: "Power high temperature warning.",
+            6: "Power unknown error.",
+            7: "Power unknown error.",
+            8: "Power unknown error.",
+            9: "Power unknown error.",
+        },
+        8: {
+            0: "Power unknown error.",
+            1: "Power vendor status 1 bit 0 error.",
+            2: "Power vendor status 1 bit 1 error.",
+            3: "Power vendor status 1 bit 2 error.",
+            4: "Power vendor status 1 bit 3 error.",
+            5: "Power vendor status 1 bit 4 error.",
+            6: "Power vendor status 1 bit 5 error.",
+            7: "Power vendor status 1 bit 6 error.",
+            8: "Power vendor status 1 bit 7 error.",
+            9: "Power vendor status 2 bit 0 error.",
+        },
+        9: {
+            0: "Power vendor status 2 bit 1 error.",
+            1: "Power vendor status 2 bit 2 error.",
+            2: "Power vendor status 2 bit 3 error.",
+            3: "Power vendor status 2 bit 4 error.",
+            4: "Power vendor status 2 bit 5 error.",
+            5: "Power vendor status 2 bit 6 error.",
+            6: "Power vendor status 2 bit 7 error.",
         },
     },
     3: {  # temperature error
         0: {  # sensor detection error
-            "n": "Slot {n} temperature sensor detection error."
+            "n": "Slot {n} temperature sensor detection error.",
         },
         2: {  # temperature reading error
             "n": "Slot {n} temperature reading error.",
             9: "Control board temperature sensor communication error.",
         },
-        5: {"n": "Slot {n} temperature protecting."},  # temperature protection
-        6: {0: "Hashboard high temperature error."},  # high temp
+        5: {
+            "n": "Slot {n} temperature protecting.",
+        },  # temperature protection
+        6: {
+            0: "Hashboard high temperature error.",
+            1: "Hashboard high temperature error.",
+            2: "Hashboard high temperature error.",
+            3: "Hashboard high temperature error.",
+        },  # high temp
+        7: {
+            0: "The environment temperature fluctuates too much.",
+        },  # env temp
         8: {
             0: "Humidity sensor not found.",
             1: "Humidity sensor read error.",
             2: "Humidity sensor read error.",
             3: "Humidity sensor protecting.",
-        },
+        },  # humidity
     },
     4: {  # EEPROM error
-        0: {0: "Eeprom unknown error."},
-        1: {"n": "Slot {n} eeprom detection error."},  # EEPROM detection error
-        2: {"n": "Slot {n} eeprom parsing error."},  # EEPROM parsing error
-        3: {"n": "Slot {n} chip bin type error."},  # chip bin error
-        4: {"n": "Slot {n} eeprom chip number X error."},  # EEPROM chip number error
-        5: {"n": "Slot {n} eeprom xfer error."},  # EEPROM xfer error
+        0: {
+            0: "Eeprom unknown error.",
+        },
+        1: {
+            "n": "Slot {n} eeprom detection error.",
+        },  # EEPROM detection error
+        2: {
+            "n": "Slot {n} eeprom parsing error.",
+        },  # EEPROM parsing error
+        3: {
+            "n": "Slot {n} chip bin type error.",
+        },  # chip bin error
+        4: {
+            "n": "Slot {n} eeprom chip number X error.",
+        },  # EEPROM chip number error
+        5: {
+            "n": "Slot {n} eeprom xfer error.",
+        },  # EEPROM xfer error
     },
     5: {  # hashboard error
-        0: {0: "Board unknown error."},
-        1: {"n": "Slot {n} miner type error."},  # board miner type error
-        2: {"n": "Slot {n} bin type error."},  # chip bin type error
-        3: {"n": "Slot {n} not found."},  # board not found error
-        4: {"n": "Slot {n} error reading chip id."},  # reading chip id error
-        5: {"n": "Slot {n} has bad chips."},  # board has bad chips error
-        6: {"n": "Slot {n} loss of balance error."},  # loss of balance error
-        7: {"n": "Slot {n} xfer error chip."},  # xfer error
-        8: {"n": "Slot {n} reset error."},  # reset error
-        9: {"n": "Slot {n} frequency too low."},  # freq error
+        0: {
+            0: "Board unknown error.",
+        },
+        1: {
+            "n": "Slot {n} miner type error.",
+        },  # board miner type error
+        2: {
+            "n": "Slot {n} bin type error.",
+        },  # chip bin type error
+        3: {
+            "n": "Slot {n} not found.",
+        },  # board not found error
+        4: {
+            "n": "Slot {n} error reading chip id.",
+        },  # reading chip id error
+        5: {
+            "n": "Slot {n} has bad chips.",
+        },  # board has bad chips error
+        6: {
+            "n": "Slot {n} loss of balance error.",
+        },  # loss of balance error
+        7: {
+            "n": "Slot {n} xfer error chip.",
+        },  # xfer error
+        8: {
+            "n": "Slot {n} reset error.",
+        },  # reset error
+        9: {
+            "n": "Slot {n} frequency too low.",
+        },  # freq error
     },
     6: {  # env temp error
-        0: {0: "Environment temperature is too high."},  # normal env temp error
+        0: {
+            0: "Environment temperature is too high.",
+        },  # normal env temp error
         1: {  # high power env temp error
-            0: "Environment temperature is too high for high performance mode."
+            0: "Environment temperature is too high for high performance mode.",
         },
     },
     7: {  # control board error
-        0: {0: "MAC address invalid", 1: "Control board no support chip."},
+        0: {
+            0: "MAC address invalid",
+            1: "Control board no support chip.",
+        },
         1: {
             0: "Control board rebooted as an exception.",
             1: "Control board rebooted as exception and cpufreq reduced, please upgrade the firmware",
             2: "Control board rebooted as an exception.",
+            3: "The network is unstable, change time.",
+            4: "Unknown error.",
+        },
+        2: {
+            "n": "Control board slot {n} frame error.",
         },
     },
     8: {  # checksum error
@@ -228,62 +308,152 @@ ERROR_CODES = {
             0: "CGMiner checksum error.",
             1: "System monitor checksum error.",
             2: "Remote daemon checksum error.",
-        }
+        },
+        1: {0: "Air to liquid PCB serial # does not match."},
     },
-    9: {0: {1: "Power rate error."}},  # power rate error
+    9: {
+        0: {0: "Unknown error.", 1: "Power rate error.", 2: "Unknown error."}
+    },  # power rate error
     20: {  # pool error
-        1: {0: "All pools are disabled."},  # all disabled error
-        2: {"n": "Pool {n} connection failed."},  # pool connection failed error
-        3: {0: "High rejection rate on pool."},  # rejection rate error
+        0: {
+            0: "No pool information configured.",
+        },
+        1: {
+            0: "All pools are disabled.",
+        },  # all disabled error
+        2: {
+            "n": "Pool {n} connection failed.",
+        },  # pool connection failed error
+        3: {
+            0: "High rejection rate on pool.",
+        },  # rejection rate error
         4: {  # asicboost not supported error
-            0: "The pool does not support asicboost mode."
+            0: "The pool does not support asicboost mode.",
         },
     },
-    21: {1: {"n": "Slot {n} factory test step failed."}},
+    21: {
+        1: {
+            "n": "Slot {n} factory test step failed.",
+        }
+    },
     23: {  # hashrate error
-        1: {0: "Hashrate is too low."},
-        2: {0: "Hashrate is too low."},
-        3: {0: "Hashrate loss is too high."},
-        4: {0: "Hashrate loss is too high."},
-        5: {0: "Hashrate loss."},
+        1: {
+            0: "Hashrate is too low.",
+        },
+        2: {
+            0: "Hashrate is too low.",
+        },
+        3: {
+            0: "Hashrate loss is too high.",
+        },
+        4: {
+            0: "Hashrate loss is too high.",
+        },
+        5: {
+            0: "Hashrate loss.",
+        },
     },
     50: {  # water velocity error/voltage error
-        1: {"n": "Slot {n} chip voltage too low."},
-        2: {"n": "Slot {n} chip voltage changed."},
-        3: {"n": "Slot {n} chip temperature difference is too large."},
-        4: {"n": "Slot {n} chip hottest temperature difference is too large."},
-        7: {"n": "Slot {n} water velocity is abnormal."},  # abnormal water velocity
-        8: {0: "Chip temp calibration failed, please restore factory settings."},
-        9: {"n": "Slot {n} chip temp calibration check no balance."},
+        1: {
+            "n": "Slot {n} chip voltage too low.",
+        },
+        2: {
+            "n": "Slot {n} chip voltage changed.",
+        },
+        3: {
+            "n": "Slot {n} chip temperature difference is too large.",
+        },
+        4: {
+            "n": "Slot {n} chip hottest temperature difference is too large.",
+        },
+        5: {"n": "Slot {n} stopped hashing, chips temperature protecting."},
+        7: {
+            "n": "Slot {n} water velocity is abnormal.",
+        },  # abnormal water velocity
+        8: {
+            0: "Chip temp calibration failed, please restore factory settings.",
+        },
+        9: {
+            "n": "Slot {n} chip temp calibration check no balance.",
+        },
     },
     51: {  # frequency error
-        1: {"n": "Slot {n} frequency up timeout."},  # frequency up timeout
-        7: {"n": "Slot {n} frequency up timeout."},  # frequency up timeout
+        1: {
+            "n": "Slot {n} frequency up timeout.",
+        },  # frequency up timeout
+        2: {"n": "Slot {n} too many CRC errors."},
+        3: {"n": "Slot {n} unstable."},
+        7: {
+            "n": "Slot {n} frequency up timeout.",
+        },  # frequency up timeout
+    },
+    52: {
+        "n": {
+            "c": "Slot {n} chip {c} error nonce.",
+        },
+    },
+    53: {
+        "n": {
+            "c": "Slot {n} chip {c} too few nonce.",
+        },
+    },
+    54: {
+        "n": {
+            "c": "Slot {n} chip {c} temp protected.",
+        },
+    },
+    55: {
+        "n": {
+            "c": "Slot {n} chip {c} has been reset.",
+        },
+    },
+    56: {
+        "n": {
+            "c": "Slot {n} chip {c} zero nonce.",
+        },
     },
-    52: {"n": {"c": "Slot {n} chip {c} error nonce."}},
-    53: {"n": {"c": "Slot {n} chip {c} too few nonce."}},
-    54: {"n": {"c": "Slot {n} chip {c} temp protected."}},
-    55: {"n": {"c": "Slot {n} chip {c} has been reset."}},
     80: {
-        0: {0: "The tool version is too low, please update."},
-        1: {0: "Low freq."},
-        2: {0: "Low hashrate."},
-        3: {5: "High env temp."},
+        0: {
+            0: "The tool version is too low, please update.",
+        },
+        1: {
+            0: "Low freq.",
+        },
+        2: {
+            0: "Low hashrate.",
+        },
+        3: {
+            5: "High env temp.",
+        },
     },
     81: {
-        0: {0: "Chip data error."},
+        0: {
+            0: "Chip data error.",
+        },
     },
     82: {
-        0: {0: "Power version error."},
-        1: {0: "Miner type error."},
-        2: {0: "Version info error."},
+        0: {
+            0: "Power version error.",
+        },
+        1: {
+            0: "Miner type error.",
+        },
+        2: {
+            0: "Version info error.",
+        },
     },
     83: {
-        0: {0: "Empty level error."},
+        0: {
+            0: "Empty level error.",
+        },
     },
     84: {
-        0: {0: "Old firmware."},
-        1: {0: "Software version error."},
+        0: {
+            0: "Old firmware.",
+        },
+        1: {
+            0: "Software version error.",
+        },
     },
     85: {
         "n": {
@@ -295,8 +465,12 @@ ERROR_CODES = {
         },
     },
     86: {
-        0: {0: "Missing product serial #."},
-        1: {0: "Missing product type."},
+        0: {
+            0: "Missing product serial #.",
+        },
+        1: {
+            0: "Missing product type.",
+        },
         2: {
             0: "Missing miner serial #.",
             1: "Wrong miner serial # length.",
@@ -313,12 +487,34 @@ ERROR_CODES = {
             3: "Wrong power model rate.",
             4: "Wrong power model format.",
         },
-        5: {0: "Wrong hash board struct."},
-        6: {0: "Wrong miner cooling type."},
-        7: {0: "Missing PCB serial #."},
+        5: {
+            0: "Wrong hash board struct.",
+        },
+        6: {
+            0: "Wrong miner cooling type.",
+        },
+        7: {
+            0: "Missing PCB serial #.",
+        },
+    },
+    87: {
+        0: {
+            0: "Miner power mismatch.",
+        },
+    },
+    90: {
+        0: {
+            0: "Process error, exited with signal: 3.",
+        },
+        1: {
+            0: "Process error, exited with signal: 3.",
+        },
+    },
+    99: {
+        9: {
+            9: "Miner unknown error.",
+        },
     },
-    87: {0: {0: "Miner power mismatch."}},
-    99: {9: {9: "Miner unknown error."}},
     1000: {
         0: {
             0: "Security library error, please upgrade firmware",
@@ -327,7 +523,11 @@ ERROR_CODES = {
             3: "/antiv/dig/pf_partial.dig illegal.",
         },
     },
-    1001: {0: {0: "Security BTMiner removed, please upgrade firmware."}},
+    1001: {
+        0: {
+            0: "Security BTMiner removed, please upgrade firmware.",
+        },
+    },
     1100: {
         0: {
             0: "Security illegal file, please upgrade firmware.",

pyasic/data/fans.py

@@ -14,18 +14,31 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-import warnings
-
-from pyasic.miners._types.makes import WhatsMiner
+from dataclasses import dataclass
+from typing import Any
 
 
-class M29V10(WhatsMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str):
-        super().__init__()
-        self.ip = ip
-        self.model = "M29 V10"
-        self.nominal_chips = 0
-        warnings.warn(
-            "Unknown chip count for miner type M29V10, please open an issue on GitHub (https://github.com/UpstreamData/pyasic)."
-        )
-        self.fan_count = 2
+@dataclass
+class Fan:
+    """A Dataclass to standardize fan data.
+
+    Attributes:
+        speed: The speed of the fan.
+    """
+
+    speed: int = None
+
+    def get(self, __key: str, default: Any = None):
+        try:
+            val = self.__getitem__(__key)
+            if val is None:
+                return default
+            return val
+        except KeyError:
+            return default
+
+    def __getitem__(self, item: str):
+        try:
+            return getattr(self, item)
+        except AttributeError:
+            raise KeyError(f"{item}")

pyasic/errors/__init__.py

@@ -24,6 +24,8 @@ class APIError(Exception):
 
     def __str__(self):
         if self.message:
+            if self.message == "can't access write cmd":
+                return f"{self.message}, please make sure your miner has been unlocked."
             return f"{self.message}"
         else:
             return "Incorrect API parameters."

pyasic/load/__init__.py

@@ -15,17 +15,12 @@
 # ------------------------------------------------------------------------------
 
 import asyncio
-import logging
 from typing import List, Union
 
-# from pyasic.errors import PhaseBalancingError
 from pyasic.errors import APIError
 from pyasic.miners import AnyMiner
-from pyasic.miners._backends import X19, BOSMiner, BTMiner
-from pyasic.miners._types import S9, S17, T17, S17e, S17Plus, S17Pro, T17e, T17Plus
-
-# from pprint import pprint as print
-
+from pyasic.miners.backends import AntminerModern, BOSMiner, BTMiner
+from pyasic.miners.models import S9, S17, T17, S17e, S17Plus, S17Pro, T17e, T17Plus
 
 FAN_USAGE = 50  # 50 W per fan
 
@@ -71,14 +66,14 @@ class _MinerPhaseBalancer:
             str(miner.ip): {
                 "miner": miner,
                 "set": 0,
-                "min": miner.fan_count * FAN_USAGE,
+                "min": miner.expected_fans * FAN_USAGE,
             }
             for miner in miners
         }
         for miner in miners:
             if (
                 isinstance(miner, BTMiner)
-                and not (miner.model.startswith("M2") if miner.model else True)
+                and not (miner.raw_model.startswith("M2") if miner.raw_model else True)
             ) or isinstance(miner, BOSMiner):
                 if isinstance(miner, S9):
                     self.miners[str(miner.ip)]["tune"] = True
@@ -95,7 +90,7 @@ class _MinerPhaseBalancer:
                     self.miners[str(miner.ip)]["tune"] = True
                     self.miners[str(miner.ip)]["shutdown"] = True
                     self.miners[str(miner.ip)]["max"] = 3600
-            elif isinstance(miner, X19):
+            elif isinstance(miner, AntminerModern):
                 self.miners[str(miner.ip)]["tune"] = False
                 self.miners[str(miner.ip)]["shutdown"] = True
                 self.miners[str(miner.ip)]["max"] = 3600
@@ -103,8 +98,8 @@ class _MinerPhaseBalancer:
                 self.miners[str(miner.ip)]["tune"] = False
                 self.miners[str(miner.ip)]["shutdown"] = True
                 self.miners[str(miner.ip)]["max"] = 3600
-                if miner.model:
-                    if miner.model.startswith("M2"):
+                if miner.raw_model:
+                    if miner.raw_model.startswith("M2"):
                         self.miners[str(miner.ip)]["tune"] = False
                         self.miners[str(miner.ip)]["shutdown"] = True
                         self.miners[str(miner.ip)]["max"] = 2400
@@ -135,23 +130,29 @@ class _MinerPhaseBalancer:
 
     async def get_balance_setpoints(self, wattage: int) -> dict:
         # gather data needed to optimize shutdown only miners
-        dp = ["hashrate", "wattage", "wattage_limit"]
+        dp = ["hashrate", "wattage", "wattage_limit", "hashboards"]
         data = await asyncio.gather(
             *[
                 self.miners[miner]["miner"].get_data(data_to_get=dp)
                 for miner in self.miners
             ]
         )
+        pct_expected_list = [d.percent_ideal for d in data]
+        pct_ideal = 0
+        if len(pct_expected_list) > 0:
+            pct_ideal = sum(pct_expected_list) / len(pct_expected_list)
+
+        wattage = round(wattage * 1 / (pct_ideal / 100))
 
         for data_point in data:
             if (not self.miners[data_point.ip]["tune"]) and (
                 not self.miners[data_point.ip]["shutdown"]
             ):
                 # cant do anything with it so need to find a semi-accurate power limit
-                if not data_point.wattage_limit == -1:
+                if data_point.wattage_limit is not None:
                     self.miners[data_point.ip]["max"] = int(data_point.wattage_limit)
                     self.miners[data_point.ip]["min"] = int(data_point.wattage_limit)
-                elif not data_point.wattage == -1:
+                elif data_point.wattage is not None:
                     self.miners[data_point.ip]["max"] = int(data_point.wattage)
                     self.miners[data_point.ip]["min"] = int(data_point.wattage)
 
@@ -182,13 +183,19 @@ class _MinerPhaseBalancer:
                 if (not miner["tune"]) and (miner["shutdown"])
             ]
         )
-        # min_other_wattage = sum([miner["min"] for miner in self.miners.values() if (not miner["tune"]) and (not miner["shutdown"])])
+        # min_other_wattage = sum(
+        #     [
+        #         miner["min"]
+        #         for miner in self.miners.values()
+        #         if (not miner["tune"]) and (not miner["shutdown"])
+        #     ]
+        # )
 
         # make sure wattage isnt set too high
         if wattage > (max_tune_wattage + max_shutdown_wattage + max_other_wattage):
             raise APIError(
                 f"Wattage setpoint is too high, setpoint: {wattage}W, max: {max_tune_wattage + max_shutdown_wattage + max_other_wattage}W"
-            )  # PhaseBalancingError(f"Wattage setpoint is too high, setpoint: {wattage}W, max: {max_tune_wattage + max_shutdown_wattage + max_other_wattage}W")
+            )
 
         # should now know wattage limits and which can be tuned/shutdown
         # check if 1/2 max of the miners which can be tuned is low enough

pyasic/logger/__init__.py

@@ -16,31 +16,29 @@
 
 import logging
 
-from pyasic.settings import PyasicSettings
-
 
 def init_logger():
-    if PyasicSettings().logfile:
-        logging.basicConfig(
-            filename="logfile.txt",
-            filemode="a",
-            format="%(pathname)s:%(lineno)d in %(funcName)s\n[%(levelname)s][%(asctime)s](%(name)s) - %(message)s",
-            datefmt="%x %X",
-        )
-    else:
-        logging.basicConfig(
-            format="%(pathname)s:%(lineno)d in %(funcName)s\n[%(levelname)s][%(asctime)s](%(name)s) - %(message)s",
-            datefmt="%x %X",
-        )
+    # if PyasicSettings().logfile:
+    #     logging.basicConfig(
+    #         filename="logfile.txt",
+    #         filemode="a",
+    #         format="%(pathname)s:%(lineno)d in %(funcName)s\n[%(levelname)s][%(asctime)s](%(name)s) - %(message)s",
+    #         datefmt="%x %X",
+    #     )
+    # else:
+    logging.basicConfig(
+        format="%(pathname)s:%(lineno)d in %(funcName)s\n[%(levelname)s][%(asctime)s](%(name)s) - %(message)s",
+        datefmt="%x %X",
+    )
 
     _logger = logging.getLogger()
 
-    if PyasicSettings().debug:
-        _logger.setLevel(logging.DEBUG)
-        logging.getLogger("asyncssh").setLevel(logging.DEBUG)
-    else:
-        _logger.setLevel(logging.WARNING)
-        logging.getLogger("asyncssh").setLevel(logging.WARNING)
+    # if PyasicSettings().debug:
+    #     _logger.setLevel(logging.DEBUG)
+    #     logging.getLogger("asyncssh").setLevel(logging.DEBUG)
+    # else:
+    _logger.setLevel(logging.WARNING)
+    logging.getLogger("asyncssh").setLevel(logging.WARNING)
 
     return _logger
 

pyasic/miners/__init__.py

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

pyasic/miners/_backends/X19.py

@@ -1,234 +0,0 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
-
-import asyncio
-import json
-from typing import List, Optional, Union
-
-import httpx
-
-from pyasic.API import APIError
-from pyasic.config import MinerConfig
-from pyasic.data.error_codes import MinerErrorData, X19Error
-from pyasic.miners._backends import BMMiner  # noqa - Ignore access to _module
-from pyasic.settings import PyasicSettings
-
-
-class X19(BMMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver=api_ver)
-        self.ip = ip
-        self.uname = "root"
-        self.pwd = PyasicSettings().global_x19_password
-
-    async def send_web_command(
-        self, command: str, params: dict = None
-    ) -> Optional[dict]:
-        url = f"http://{self.ip}/cgi-bin/{command}.cgi"
-        auth = httpx.DigestAuth(self.uname, self.pwd)
-        try:
-            async with httpx.AsyncClient() as client:
-                if params:
-                    data = await client.post(url, data=params, auth=auth)
-                else:
-                    data = await client.get(url, auth=auth)
-        except httpx.HTTPError:
-            pass
-        else:
-            if data.status_code == 200:
-                try:
-                    return data.json()
-                except json.decoder.JSONDecodeError:
-                    pass
-
-    async def get_config(self) -> MinerConfig:
-        data = await self.send_web_command("get_miner_conf")
-        if data:
-            self.config = MinerConfig().from_raw(data)
-        return self.config
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        self.config = config
-        conf = config.as_x19(user_suffix=user_suffix)
-        await self.send_web_command(
-            "set_miner_conf", params=conf  # noqa: ignore conf being a str
-        )
-
-        for i in range(7):
-            data = await self.get_config()
-            if data.as_x19() == conf:
-                break
-            await asyncio.sleep(1)
-
-    async def fault_light_on(self) -> bool:
-        data = await self.send_web_command(
-            "blink",
-            params=json.dumps({"blink": "true"}),  # noqa - ignore params being a str
-        )
-        if data:
-            if data.get("code") == "B000":
-                self.light = True
-        return self.light
-
-    async def fault_light_off(self) -> bool:
-        data = await self.send_web_command(
-            "blink",
-            params=json.dumps({"blink": "false"}),  # noqa - ignore params being a str
-        )
-        if data:
-            if data.get("code") == "B100":
-                self.light = True
-        return self.light
-
-    async def reboot(self) -> bool:
-        data = await self.send_web_command("reboot")
-        if data:
-            return True
-        return False
-
-    async def stop_mining(self) -> bool:
-        cfg = await self.get_config()
-        cfg.autotuning_wattage = 0
-        await self.send_config(cfg)
-        return True
-
-    async def resume_mining(self) -> bool:
-        cfg = await self.get_config()
-        cfg.autotuning_wattage = 1
-        await self.send_config(cfg)
-        return True
-
-    async def get_hostname(self) -> Union[str, None]:
-        try:
-            data = await self.send_web_command("get_system_info")
-            if data:
-                return data["hostname"]
-        except KeyError:
-            pass
-
-    async def get_mac(self) -> Union[str, None]:
-        try:
-            data = await self.send_web_command("get_system_info")
-            if data:
-                return data["macaddr"]
-        except KeyError:
-            pass
-
-        try:
-            data = await self.send_web_command("get_network_info")
-            if data:
-                return data["macaddr"]
-        except KeyError:
-            pass
-
-    async def get_errors(self) -> List[MinerErrorData]:
-        errors = []
-        data = await self.send_web_command("summary")
-        if data:
-            try:
-                for item in data["SUMMARY"][0]["status"]:
-                    try:
-                        if not item["status"] == "s":
-                            errors.append(X19Error(item["msg"]))
-                    except KeyError:
-                        continue
-            except (KeyError, IndexError):
-                pass
-        return errors
-
-    async def get_fault_light(self) -> bool:
-        if self.light:
-            return self.light
-        try:
-            data = await self.send_web_command("get_blink_status")
-            if data:
-                self.light = data["blink"]
-        except KeyError:
-            pass
-        return self.light
-
-    async def get_nominal_hashrate(self, api_stats: dict = None) -> Optional[float]:
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        if api_stats:
-            try:
-                ideal_rate = api_stats["STATS"][1]["total_rateideal"]
-                try:
-                    rate_unit = api_stats["STATS"][1]["rate_unit"]
-                except KeyError:
-                    rate_unit = "GH"
-                if rate_unit == "GH":
-                    return round(ideal_rate / 1000, 2)
-                if rate_unit == "MH":
-                    return round(ideal_rate / 1000000, 2)
-                else:
-                    return round(ideal_rate, 2)
-            except (KeyError, IndexError):
-                pass
-
-    async def set_static_ip(
-        self,
-        ip: str,
-        dns: str,
-        gateway: str,
-        subnet_mask: str = "255.255.255.0",
-        hostname: str = None,
-    ):
-        if not hostname:
-            hostname = await self.get_hostname()
-        payload = {
-            "ipAddress": ip,
-            "ipDns": dns,
-            "ipGateway": gateway,
-            "ipHost": hostname,
-            "ipPro": 2,  # static
-            "ipSub": subnet_mask,
-        }
-        await self.send_web_command("set_network_conf", params=payload)
-
-    async def set_dhcp(self, hostname: str = None):
-        if not hostname:
-            hostname = await self.get_hostname()
-        payload = {
-            "ipAddress": "",
-            "ipDns": "",
-            "ipGateway": "",
-            "ipHost": hostname,
-            "ipPro": 1,  # DHCP
-            "ipSub": "",
-        }
-        await self.send_web_command("set_network_conf", params=payload)
-
-    async def set_hostname(self, hostname: str):
-        cfg = await self.send_web_command("get_network_info")
-        dns = cfg["conf_dnsservers"]
-        gateway = cfg["conf_gateway"]
-        ip = cfg["conf_ipaddress"]
-        subnet_mask = cfg["conf_netmask"]
-        protocol = 1 if cfg["conf_nettype"] == "DHCP" else 2
-        payload = {
-            "ipAddress": ip,
-            "ipDns": dns,
-            "ipGateway": gateway,
-            "ipHost": hostname,
-            "ipPro": protocol,
-            "ipSub": subnet_mask,
-        }
-        await self.send_web_command("set_network_conf", params=payload)

pyasic/miners/_backends/bmminer.py

@@ -1,357 +0,0 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
-
-import ipaddress
-import logging
-from collections import namedtuple
-from typing import List, Optional, Tuple, Union
-
-import asyncssh
-
-from pyasic.API.bmminer import BMMinerAPI
-from pyasic.config import MinerConfig
-from pyasic.data import Fan, HashBoard, MinerData
-from pyasic.data.error_codes import MinerErrorData
-from pyasic.errors import APIError
-from pyasic.miners.base import BaseMiner
-from pyasic.settings import PyasicSettings
-
-
-class BMMiner(BaseMiner):
-    """Base handler for BMMiner based miners."""
-
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip)
-        self.ip = ipaddress.ip_address(ip)
-        self.api = BMMinerAPI(ip, api_ver)
-        self.api_type = "BMMiner"
-        self.api_ver = api_ver
-        self.uname = "root"
-        self.pwd = "admin"
-
-    async def send_ssh_command(self, cmd: str) -> Optional[str]:
-        result = None
-
-        try:
-            conn = await self._get_ssh_connection()
-        except (asyncssh.Error, OSError):
-            return None
-
-        # open an ssh connection
-        async with conn:
-            # 3 retries
-            for i in range(3):
-                try:
-                    # run the command and get the result
-                    result = await conn.run(cmd)
-                    result = result.stdout
-
-                except Exception as e:
-                    # if the command fails, log it
-                    logging.warning(f"{self} command {cmd} error: {e}")
-
-                    # on the 3rd retry, return None
-                    if i == 3:
-                        return
-                    continue
-        # return the result, either command output or None
-        return result
-
-    async def get_config(self) -> MinerConfig:
-        # get pool data
-        try:
-            pools = await self.api.pools()
-        except APIError:
-            return self.config
-
-        self.config = MinerConfig().from_api(pools["POOLS"])
-        return self.config
-
-    async def reboot(self) -> bool:
-        logging.debug(f"{self}: Sending reboot command.")
-        _ret = await self.send_ssh_command("reboot")
-        logging.debug(f"{self}: Reboot command completed.")
-        if isinstance(_ret, str):
-            return True
-        return False
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        return None
-
-    async def fault_light_off(self) -> bool:
-        return False
-
-    async def fault_light_on(self) -> bool:
-        return False
-
-    async def restart_backend(self) -> bool:
-        return False
-
-    async def stop_mining(self) -> bool:
-        return False
-
-    async def resume_mining(self) -> bool:
-        return False
-
-    async def set_power_limit(self, wattage: int) -> bool:
-        return False
-
-    ##################################################
-    ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
-    ##################################################
-
-    async def get_mac(self) -> str:
-        return "00:00:00:00:00:00"
-
-    async def get_model(self, api_devdetails: dict = None) -> Optional[str]:
-        if self.model:
-            logging.debug(f"Found model for {self.ip}: {self.model}")
-            return self.model
-
-        if not api_devdetails:
-            try:
-                api_devdetails = await self.api.devdetails()
-            except APIError:
-                pass
-
-        if api_devdetails:
-            try:
-                self.model = api_devdetails["DEVDETAILS"][0]["Model"].replace(
-                    "Antminer ", ""
-                )
-                logging.debug(f"Found model for {self.ip}: {self.model}")
-                return self.model
-            except (TypeError, IndexError, KeyError):
-                pass
-
-        logging.warning(f"Failed to get model for miner: {self}")
-        return None
-
-    async def get_api_ver(self, api_version: dict = None) -> Optional[str]:
-        # Check to see if the version info is already cached
-        if self.api_ver:
-            return self.api_ver
-
-        if not api_version:
-            try:
-                api_version = await self.api.version()
-            except APIError:
-                pass
-
-        if api_version:
-            try:
-                self.api_ver = api_version["VERSION"][0]["API"]
-            except (KeyError, IndexError):
-                pass
-
-        return self.api_ver
-
-    async def get_fw_ver(self, api_version: dict = None) -> Optional[str]:
-        # Check to see if the version info is already cached
-        if self.fw_ver:
-            return self.fw_ver
-
-        if not api_version:
-            try:
-                api_version = await self.api.version()
-            except APIError:
-                pass
-
-        if api_version:
-            try:
-                self.fw_ver = api_version["VERSION"][0]["CompileTime"]
-            except (KeyError, IndexError):
-                pass
-
-        return self.fw_ver
-
-    async def get_version(
-        self, api_version: dict = None
-    ) -> Tuple[Optional[str], Optional[str]]:
-        # check if version is cached
-        miner_version = namedtuple("MinerVersion", "api_ver fw_ver")
-        return miner_version(
-            api_ver=await self.get_api_ver(api_version),
-            fw_ver=await self.get_fw_ver(api_version=api_version),
-        )
-
-    async def get_fan_psu(self):
-        return None
-
-    async def get_hostname(self) -> Optional[str]:
-        hn = await self.send_ssh_command("cat /proc/sys/kernel/hostname")
-        if hn:
-            self.hostname = hn
-        return self.hostname
-
-    async def get_hashrate(self, api_summary: dict = None) -> Optional[float]:
-        # get hr from API
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                return round(float(api_summary["SUMMARY"][0]["GHS 5s"] / 1000), 2)
-            except (IndexError, KeyError, ValueError, TypeError):
-                pass
-
-    async def get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
-        hashboards = []
-
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        if api_stats:
-            try:
-                board_offset = -1
-                boards = api_stats["STATS"]
-                if len(boards) > 1:
-                    for board_num in range(1, 16, 5):
-                        for _b_num in range(5):
-                            b = boards[1].get(f"chain_acn{board_num + _b_num}")
-
-                            if b and not b == 0 and board_offset == -1:
-                                board_offset = board_num
-                    if board_offset == -1:
-                        board_offset = 1
-
-                    for i in range(board_offset, board_offset + self.ideal_hashboards):
-                        hashboard = HashBoard(
-                            slot=i - board_offset, expected_chips=self.nominal_chips
-                        )
-
-                        chip_temp = boards[1].get(f"temp{i}")
-                        if chip_temp:
-                            hashboard.chip_temp = round(chip_temp)
-
-                        temp = boards[1].get(f"temp2_{i}")
-                        if temp:
-                            hashboard.temp = round(temp)
-
-                        hashrate = boards[1].get(f"chain_rate{i}")
-                        if hashrate:
-                            hashboard.hashrate = round(float(hashrate) / 1000, 2)
-
-                        chips = boards[1].get(f"chain_acn{i}")
-                        if chips:
-                            hashboard.chips = chips
-                            hashboard.missing = False
-                        if (not chips) or (not chips > 0):
-                            hashboard.missing = True
-                        hashboards.append(hashboard)
-            except (IndexError, KeyError, ValueError, TypeError):
-                pass
-
-        return hashboards
-
-    async def get_env_temp(self) -> Optional[float]:
-        return None
-
-    async def get_wattage(self) -> Optional[int]:
-        return None
-
-    async def get_wattage_limit(self) -> Optional[int]:
-        return None
-
-    async def get_fans(self, api_stats: dict = None) -> List[Fan]:
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        fans_data = [None, None, None, None]
-        if api_stats:
-            try:
-                fan_offset = -1
-
-                for fan_num in range(1, 8, 4):
-                    for _f_num in range(4):
-                        f = api_stats["STATS"][1].get(f"fan{fan_num + _f_num}")
-                        if f and not f == 0 and fan_offset == -1:
-                            fan_offset = fan_num
-                if fan_offset == -1:
-                    fan_offset = 1
-
-                for fan in range(self.fan_count):
-                    fans_data[fan] = api_stats["STATS"][1].get(f"fan{fan_offset+fan}")
-            except (KeyError, IndexError):
-                pass
-        fans = [Fan(speed=d) if d else Fan() for d in fans_data]
-
-        return fans
-
-    async def get_pools(self, api_pools: dict = None) -> List[dict]:
-        groups = []
-
-        if not api_pools:
-            try:
-                api_pools = await self.api.pools()
-            except APIError:
-                pass
-
-        if api_pools:
-            try:
-                pools = {}
-                for i, pool in enumerate(api_pools["POOLS"]):
-                    pools[f"pool_{i + 1}_url"] = (
-                        pool["URL"]
-                        .replace("stratum+tcp://", "")
-                        .replace("stratum2+tcp://", "")
-                    )
-                    pools[f"pool_{i + 1}_user"] = pool["User"]
-                    pools["quota"] = pool["Quota"] if pool.get("Quota") else "0"
-
-                groups.append(pools)
-            except KeyError:
-                pass
-        return groups
-
-    async def get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def get_fault_light(self) -> bool:
-        return False
-
-    async def get_nominal_hashrate(self, api_stats: dict = None) -> Optional[float]:
-        # X19 method, not sure compatibility
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        if api_stats:
-            try:
-                ideal_rate = api_stats["STATS"][1]["total_rateideal"]
-                try:
-                    rate_unit = api_stats["STATS"][1]["rate_unit"]
-                except KeyError:
-                    rate_unit = "GH"
-                if rate_unit == "GH":
-                    return round(ideal_rate / 1000, 2)
-                if rate_unit == "MH":
-                    return round(ideal_rate / 1000000, 2)
-                else:
-                    return round(ideal_rate, 2)
-            except (KeyError, IndexError):
-                pass

pyasic/miners/_backends/bosminer.py

@@ -1,861 +0,0 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
-
-import ipaddress
-import json
-import logging
-from collections import namedtuple
-from typing import List, Optional, Tuple, Union
-
-import asyncssh
-import httpx
-import toml
-
-from pyasic.API.bosminer import BOSMinerAPI
-from pyasic.config import MinerConfig
-from pyasic.data import Fan, HashBoard, MinerData
-from pyasic.data.error_codes import BraiinsOSError, MinerErrorData
-from pyasic.errors import APIError
-from pyasic.miners.base import BaseMiner
-from pyasic.settings import PyasicSettings
-
-
-class BOSMiner(BaseMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip)
-        self.ip = ipaddress.ip_address(ip)
-        self.api = BOSMinerAPI(ip, api_ver)
-        self.api_type = "BOSMiner"
-        self.api_ver = api_ver
-        self.uname = "root"
-        self.pwd = "admin"
-        self.config = None
-
-    async def send_ssh_command(self, cmd: str) -> Optional[str]:
-        result = None
-
-        try:
-            conn = await self._get_ssh_connection()
-        except (asyncssh.Error, OSError):
-            return None
-
-        # open an ssh connection
-        async with conn:
-            # 3 retries
-            for i in range(3):
-                try:
-                    # run the command and get the result
-                    result = await conn.run(cmd)
-                    result = result.stdout
-
-                except Exception as e:
-                    # if the command fails, log it
-                    logging.warning(f"{self} command {cmd} error: {e}")
-
-                    # on the 3rd retry, return None
-                    if i == 3:
-                        return
-                    continue
-        # return the result, either command output or None
-        return result
-
-    async def send_graphql_query(self, query) -> Union[dict, None]:
-        # FW version must be equal to or greater than 21.09 to use this
-        if self.fw_ver:
-            try:
-                if not (
-                    (
-                        int(self.fw_ver.split(".")[0]) == 21
-                        and int(self.fw_ver.split(".")[1]) >= 9
-                    )
-                    or int(self.fw_ver.split(".")[0]) > 21
-                ):
-                    logging.info(f"FW version {self.fw_ver} is too low to use graphql.")
-                    return None
-            except ValueError:
-                pass
-
-        url = f"http://{self.ip}/graphql"
-        try:
-            async with httpx.AsyncClient() as client:
-                _auth = await client.post(
-                    url,
-                    json={
-                        "query": 'mutation{auth{login(username:"'
-                        + self.uname
-                        + '", password:"'
-                        + self.pwd
-                        + '"){__typename}}}'
-                    },
-                )
-                d = await client.post(url, json={"query": query})
-            if d.status_code == 200:
-                try:
-                    data = d.json()
-                except json.decoder.JSONDecodeError:
-                    raise APIError(f"GraphQL returned malformed data: {d.text}")
-                if data.get("errors"):
-                    if len(data["errors"]) > 0:
-                        raise APIError(f"GraphQL error: {data['errors'][0]['message']}")
-
-        except httpx.HTTPError:
-            return None
-        return None
-
-    async def fault_light_on(self) -> bool:
-        """Sends command to turn on fault light on the miner."""
-        logging.debug(f"{self}: Sending fault_light on command.")
-        _ret = await self.send_ssh_command("miner fault_light on")
-        logging.debug(f"{self}: fault_light on command completed.")
-        if isinstance(_ret, str):
-            self.light = True
-            return self.light
-        return False
-
-    async def fault_light_off(self) -> bool:
-        """Sends command to turn off fault light on the miner."""
-        logging.debug(f"{self}: Sending fault_light off command.")
-        self.light = False
-        _ret = await self.send_ssh_command("miner fault_light off")
-        logging.debug(f"{self}: fault_light off command completed.")
-        if isinstance(_ret, str):
-            self.light = False
-            return True
-        return False
-
-    async def restart_backend(self) -> bool:
-        """Restart bosminer hashing process.  Wraps [`restart_bosminer`][pyasic.miners._backends.bosminer.BOSMiner.restart_bosminer] to standardize."""
-        return await self.restart_bosminer()
-
-    async def restart_bosminer(self) -> bool:
-        """Restart bosminer hashing process."""
-        logging.debug(f"{self}: Sending bosminer restart command.")
-        _ret = await self.send_ssh_command("/etc/init.d/bosminer restart")
-        logging.debug(f"{self}: bosminer restart command completed.")
-        if isinstance(_ret, str):
-            return True
-        return False
-
-    async def stop_mining(self) -> bool:
-        try:
-            data = await self.api.pause()
-        except APIError:
-            return False
-        if data.get("PAUSE"):
-            if data["PAUSE"][0]:
-                return True
-        return False
-
-    async def resume_mining(self) -> bool:
-        try:
-            data = await self.api.resume()
-        except APIError:
-            return False
-        if data.get("RESUME"):
-            if data["RESUME"][0]:
-                return True
-        return False
-
-    async def reboot(self) -> bool:
-        """Reboots power to the physical miner."""
-        logging.debug(f"{self}: Sending reboot command.")
-        _ret = await self.send_ssh_command("/sbin/reboot")
-        logging.debug(f"{self}: Reboot command completed.")
-        if isinstance(_ret, str):
-            return True
-        return False
-
-    async def get_config(self) -> MinerConfig:
-        """Gets the config for the miner and sets it as `self.config`.
-
-        Returns:
-            The config from `self.config`.
-        """
-        logging.debug(f"{self}: Getting config.")
-        conn = None
-        try:
-            conn = await self._get_ssh_connection()
-        except (asyncssh.Error, OSError):
-            try:
-                pools = await self.api.pools()
-            except APIError:
-                return self.config
-            if pools:
-                self.config = MinerConfig().from_api(pools["POOLS"])
-                return self.config
-        if conn:
-            async with conn:
-                # good ol' BBB compatibility :/
-                toml_data = toml.loads(
-                    (await conn.run("cat /etc/bosminer.toml")).stdout
-                )
-            logging.debug(f"{self}: Converting config file.")
-            cfg = MinerConfig().from_raw(toml_data)
-            self.config = cfg
-        return self.config
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        """Configures miner with yaml config."""
-        logging.debug(f"{self}: Sending config.")
-        self.config = config
-        toml_conf = config.as_bos(
-            model=self.model.replace(" (BOS)", ""), user_suffix=user_suffix
-        )
-        try:
-            conn = await self._get_ssh_connection()
-        except (asyncssh.Error, OSError):
-            return None
-        async with conn:
-            # BBB check because bitmain suxx
-            bbb_check = await conn.run(
-                "if [ ! -f /etc/init.d/bosminer ]; then echo '1'; else echo '0'; fi;"
-            )
-
-            bbb = bbb_check.stdout.strip() == "1"
-
-            if not bbb:
-                await conn.run("/etc/init.d/bosminer stop")
-                logging.debug(f"{self}: Opening SFTP connection.")
-                async with conn.start_sftp_client() as sftp:
-                    logging.debug(f"{self}: Opening config file.")
-                    async with sftp.open("/etc/bosminer.toml", "w+") as file:
-                        await file.write(toml_conf)
-                logging.debug(f"{self}: Restarting BOSMiner")
-                await conn.run("/etc/init.d/bosminer start")
-
-            # I really hate BBB, please get rid of it if you have it
-            else:
-                await conn.run("/etc/init.d/S99bosminer stop")
-                logging.debug(f"{self}: BBB sending config")
-                await conn.run("echo '" + toml_conf + "' > /etc/bosminer.toml")
-                logging.debug(f"{self}: BBB restarting bosminer.")
-                await conn.run("/etc/init.d/S99bosminer start")
-
-    async def set_power_limit(self, wattage: int) -> bool:
-        try:
-            cfg = await self.get_config()
-            cfg.autotuning_wattage = wattage
-            await self.send_config(cfg)
-        except Exception as e:
-            logging.warning(f"{self} set_power_limit: {e}")
-            return False
-        else:
-            return True
-
-    ##################################################
-    ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
-    ##################################################
-
-    async def get_mac(self) -> Optional[str]:
-        try:
-            result = await self.send_ssh_command("cat /sys/class/net/eth0/address")
-            if result:
-                return result.upper().strip()
-        except (asyncssh.Error, OSError):
-            pass
-
-    async def get_model(self) -> Optional[str]:
-        # check if model is cached
-        if self.model:
-            logging.debug(f"Found model for {self.ip}: {self.model} (BOS)")
-            return self.model + " (BOS)"
-
-        # get devdetails data
-        try:
-            version_data = await self.api.devdetails()
-        except APIError as e:
-            version_data = None
-            if e.message == "Not ready":
-                cfg = json.loads(await self.send_ssh_command("bosminer config --data"))
-                model = cfg.get("data").get("format").get("model")
-                if model:
-                    model = model.replace("Antminer ", "")
-                    self.model = model
-                    return self.model + " (BOS)"
-
-        # if we get data back, parse it for model
-        if version_data:
-            if not version_data["DEVDETAILS"] == []:
-                # handle Antminer BOSMiner as a base
-                self.model = version_data["DEVDETAILS"][0]["Model"].replace(
-                    "Antminer ", ""
-                )
-                logging.debug(f"Found model for {self.ip}: {self.model} (BOS)")
-                return self.model + " (BOS)"
-
-        # if we don't get devdetails, log a failed attempt
-        logging.warning(f"Failed to get model for miner: {self}")
-        return None
-
-    async def get_version(
-        self, api_version: dict = None, graphql_version: dict = None
-    ) -> Tuple[Optional[str], Optional[str]]:
-        # check if version is cached
-        miner_version = namedtuple("MinerVersion", "api_ver fw_ver")
-        api_ver = await self.get_api_ver(api_version)
-        fw_ver = await self.get_fw_ver(graphql_version)
-        return miner_version(api_ver, fw_ver)
-
-    async def get_api_ver(self, api_version: dict = None) -> Optional[str]:
-        if not api_version:
-            try:
-                api_version = await self.api.version()
-            except APIError:
-                pass
-
-        # Now get the API version
-        if api_version:
-            try:
-                api_ver = api_version["VERSION"][0]["API"]
-            except (KeyError, IndexError):
-                api_ver = None
-            self.api_ver = api_ver
-            self.api.api_ver = self.api_ver
-
-        return self.api_ver
-
-    async def get_fw_ver(self, graphql_version: dict = None) -> Optional[str]:
-        if not graphql_version:
-            try:
-                graphql_version = await self.send_graphql_query(
-                    "{bos{info{version{full}}}}"
-                )
-            except APIError:
-                pass
-
-        fw_ver = None
-
-        if graphql_version:
-            try:
-                fw_ver = graphql_version["bos"]["info"]["version"]["full"]
-            except KeyError:
-                pass
-
-        if not fw_ver:
-            # try version data file
-            fw_ver = await self.send_ssh_command("cat /etc/bos_version")
-
-        # if we get the version data, parse it
-        if fw_ver:
-            ver = fw_ver.split("-")[5]
-            if "." in ver:
-                self.fw_ver = ver
-                logging.debug(f"Found version for {self.ip}: {self.fw_ver}")
-
-        return self.fw_ver
-
-    async def get_hostname(self, graphql_hostname: dict = None) -> Union[str, None]:
-        if self.hostname:
-            return self.hostname
-
-        if not graphql_hostname:
-            try:
-                graphql_hostname = await self.send_graphql_query("{bos {hostname}}")
-            except APIError:
-                pass
-
-        if graphql_hostname:
-            self.hostname = graphql_hostname["bos"]["hostname"]
-            return self.hostname
-
-        try:
-            async with (await self._get_ssh_connection()) as conn:
-                if conn is not None:
-                    data = await conn.run("cat /proc/sys/kernel/hostname")
-                    host = data.stdout.strip()
-                    logging.debug(f"Found hostname for {self.ip}: {host}")
-                    self.hostname = host
-                else:
-                    logging.warning(f"Failed to get hostname for miner: {self}")
-        except Exception as e:
-            logging.warning(f"Failed to get hostname for miner: {self}, {e}")
-        return self.hostname
-
-    async def get_hashrate(
-        self, api_summary: dict = None, graphql_hashrate: dict = None
-    ) -> Optional[float]:
-
-        # get hr from graphql
-        if not graphql_hashrate:
-            try:
-                graphql_hashrate = await self.send_graphql_query(
-                    "{bosminer{info{workSolver{realHashrate{mhs1M}}}}}"
-                )
-            except APIError:
-                pass
-
-        if graphql_hashrate:
-            try:
-                return round(
-                    float(
-                        graphql_hashrate["bosminer"]["info"]["workSolver"][
-                            "realHashrate"
-                        ]["mhs1M"]
-                        / 1000000
-                    ),
-                    2,
-                )
-            except (KeyError, IndexError, ValueError):
-                pass
-
-        # get hr from API
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                return round(float(api_summary["SUMMARY"][0]["MHS 1m"] / 1000000), 2)
-            except (KeyError, IndexError, ValueError, TypeError):
-                pass
-
-    async def get_hashboards(
-        self,
-        api_temps: dict = None,
-        api_devdetails: dict = None,
-        api_devs: dict = None,
-        graphql_boards: dict = None,
-    ):
-        hashboards = [
-            HashBoard(slot=i, expected_chips=self.nominal_chips)
-            for i in range(self.ideal_hashboards)
-        ]
-
-        if not graphql_boards and not (api_devs or api_temps or api_devdetails):
-            try:
-                graphql_boards = await self.send_graphql_query(
-                    "{bosminer{info{workSolver{childSolvers{name, realHashrate {mhs1M}, hwDetails {chips}, temperatures {degreesC}}}}}}"
-                )
-            except APIError:
-                pass
-
-        if graphql_boards:
-            try:
-                boards = graphql_boards["bosminer"]["info"]["workSolver"][
-                    "childSolvers"
-                ]
-            except (KeyError, IndexError):
-                boards = None
-
-            if boards:
-                offset = 6 if int(boards[0]["name"]) in [6, 7, 8] else 0
-                for hb in boards:
-                    _id = int(hb["name"]) - offset
-                    board = hashboards[_id]
-
-                    board.hashrate = round(hb["realHashrate"]["mhs1M"] / 1000000, 2)
-                    temps = hb["temperatures"]
-                    try:
-                        if len(temps) > 0:
-                            board.temp = round(hb["temperatures"][0]["degreesC"])
-                        if len(temps) > 1:
-                            board.chip_temp = round(hb["temperatures"][1]["degreesC"])
-                    except (TypeError, KeyError, ValueError, IndexError):
-                        pass
-                    details = hb.get("hwDetails")
-                    if details:
-                        if chips := details["chips"]:
-                            board.chips = chips
-                    board.missing = False
-
-                return hashboards
-
-        cmds = []
-        if not api_temps:
-            cmds.append("temps")
-        if not api_devdetails:
-            cmds.append("devdetails")
-        if not api_devs:
-            cmds.append("devs")
-        if len(cmds) > 0:
-            try:
-                d = await self.api.multicommand(*cmds)
-            except APIError:
-                d = {}
-            try:
-                api_temps = d["temps"][0]
-            except (KeyError, IndexError):
-                api_temps = None
-            try:
-                api_devdetails = d["devdetails"][0]
-            except (KeyError, IndexError):
-                api_devdetails = None
-            try:
-                api_devs = d["devs"][0]
-            except (KeyError, IndexError):
-                api_devs = None
-        if api_temps:
-            try:
-                offset = 6 if api_temps["TEMPS"][0]["ID"] in [6, 7, 8] else 1
-
-                for board in api_temps["TEMPS"]:
-                    _id = board["ID"] - offset
-                    chip_temp = round(board["Chip"])
-                    board_temp = round(board["Board"])
-                    hashboards[_id].chip_temp = chip_temp
-                    hashboards[_id].temp = board_temp
-            except (IndexError, KeyError, ValueError, TypeError):
-                pass
-
-        if api_devdetails:
-            try:
-                offset = 6 if api_devdetails["DEVDETAILS"][0]["ID"] in [6, 7, 8] else 1
-
-                for board in api_devdetails["DEVDETAILS"]:
-                    _id = board["ID"] - offset
-                    chips = board["Chips"]
-                    hashboards[_id].chips = chips
-                    hashboards[_id].missing = False
-            except (IndexError, KeyError):
-                pass
-
-        if api_devs:
-            try:
-                offset = 6 if api_devs["DEVS"][0]["ID"] in [6, 7, 8] else 1
-
-                for board in api_devs["DEVS"]:
-                    _id = board["ID"] - offset
-                    hashrate = round(float(board["MHS 1m"] / 1000000), 2)
-                    hashboards[_id].hashrate = hashrate
-            except (IndexError, KeyError):
-                pass
-
-        return hashboards
-
-    async def get_env_temp(self, *args, **kwargs) -> Optional[float]:
-        return None
-
-    async def get_wattage(
-        self, api_tunerstatus: dict = None, graphql_wattage: dict = None
-    ) -> Optional[int]:
-        if not graphql_wattage and not api_tunerstatus:
-            try:
-                graphql_wattage = await self.send_graphql_query(
-                    "{bosminer{info{workSolver{power{approxConsumptionW}}}}}"
-                )
-            except APIError:
-                pass
-
-        if graphql_wattage:
-            try:
-                return graphql_wattage["bosminer"]["info"]["workSolver"]["power"][
-                    "approxConsumptionW"
-                ]
-            except KeyError:
-                pass
-
-        if not api_tunerstatus:
-            try:
-                api_tunerstatus = await self.api.tunerstatus()
-            except APIError:
-                pass
-
-        if api_tunerstatus:
-            try:
-                return api_tunerstatus["TUNERSTATUS"][0][
-                    "ApproximateMinerPowerConsumption"
-                ]
-            except (KeyError, IndexError):
-                pass
-
-    async def get_wattage_limit(
-        self, api_tunerstatus: dict = None, graphql_wattage_limit: dict = None
-    ) -> Optional[int]:
-        if not graphql_wattage_limit and not api_tunerstatus:
-            try:
-                graphql_wattage_limit = await self.send_graphql_query(
-                    "{bosminer{info{workSolver{power{limitW}}}}}"
-                )
-            except APIError:
-                pass
-
-        if graphql_wattage_limit:
-            try:
-                return graphql_wattage_limit["bosminer"]["info"]["workSolver"]["power"][
-                    "limitW"
-                ]
-            except KeyError:
-                pass
-
-        if not api_tunerstatus:
-            try:
-                api_tunerstatus = await self.api.tunerstatus()
-            except APIError:
-                pass
-
-        if api_tunerstatus:
-            try:
-                return api_tunerstatus["TUNERSTATUS"][0]["PowerLimit"]
-            except (KeyError, IndexError):
-                pass
-
-    async def get_fans(
-        self, api_fans: dict = None, graphql_fans: dict = None
-    ) -> List[Fan]:
-        if not graphql_fans and not api_fans:
-            try:
-                graphql_fans = await self.send_graphql_query(
-                    "{bosminer{info{fans{name, rpm}}}"
-                )
-            except APIError:
-                pass
-
-        if graphql_fans:
-            fans = {"fan_1": Fan(), "fan_2": Fan(), "fan_3": Fan(), "fan_4": Fan()}
-            for n in range(self.fan_count):
-                try:
-                    fans[f"fan_{n + 1}"].speed = graphql_fans["bosminer"]["info"][
-                        "fans"
-                    ][n]["rpm"]
-                except KeyError:
-                    pass
-            return [fans["fan_1"], fans["fan_2"], fans["fan_3"], fans["fan_4"]]
-
-        if not api_fans:
-            try:
-                api_fans = await self.api.fans()
-            except APIError:
-                pass
-
-        if api_fans:
-            fans = {"fan_1": Fan(), "fan_2": Fan(), "fan_3": Fan(), "fan_4": Fan()}
-            for n in range(self.fan_count):
-                try:
-                    fans[f"fan_{n + 1}"].speed = api_fans["FANS"][n]["RPM"]
-                except KeyError:
-                    pass
-            return [fans["fan_1"], fans["fan_2"], fans["fan_3"], fans["fan_4"]]
-        return [Fan(), Fan(), Fan(), Fan()]
-
-    async def get_fan_psu(self) -> Optional[int]:
-        return None
-
-    async def get_pools(
-        self, api_pools: dict = None, graphql_pools: dict = None
-    ) -> List[dict]:
-        if not graphql_pools and not api_pools:
-            try:
-                graphql_pools = await self.send_graphql_query(
-                    "bosminer{config{... on BosminerConfig{groups{pools{urluser}strategy{... on QuotaStrategy{quota}}}}}"
-                )
-            except APIError:
-                pass
-
-        if graphql_pools:
-            groups = []
-            try:
-                g = graphql_pools["bosminer"]["config"]["groups"]
-                for group in g:
-                    pools = {"quota": group["strategy"]["quota"]}
-                    for i, pool in enumerate(group["pools"]):
-                        pools[f"pool_{i + 1}_url"] = (
-                            pool["url"]
-                            .replace("stratum+tcp://", "")
-                            .replace("stratum2+tcp://", "")
-                        )
-                        pools[f"pool_{i + 1}_user"] = pool["user"]
-                    groups.append(pools)
-                return groups
-            except KeyError:
-                pass
-
-        if not api_pools:
-            try:
-                api_pools = await self.api.pools()
-            except APIError:
-                pass
-
-        if api_pools:
-            seen = []
-            groups = [{"quota": "0"}]
-            for i, pool in enumerate(api_pools["POOLS"]):
-                if len(seen) == 0:
-                    seen.append(pool["User"])
-                if not pool["User"] in seen:
-                    # need to use get_config, as this will never read perfectly as there are some bad edge cases
-                    groups = []
-                    cfg = await self.get_config()
-                    for group in cfg.pool_groups:
-                        pools = {"quota": group.quota}
-                        for _i, _pool in enumerate(group.pools):
-                            pools[f"pool_{_i + 1}_url"] = _pool.url.replace(
-                                "stratum+tcp://", ""
-                            ).replace("stratum2+tcp://", "")
-                            pools[f"pool_{_i + 1}_user"] = _pool.username
-                        groups.append(pools)
-                    return groups
-                else:
-                    groups[0][f"pool_{i + 1}_url"] = (
-                        pool["URL"]
-                        .replace("stratum+tcp://", "")
-                        .replace("stratum2+tcp://", "")
-                    )
-                    groups[0][f"pool_{i + 1}_user"] = pool["User"]
-            return groups
-
-    async def get_errors(
-        self, api_tunerstatus: dict = None, graphql_errors: dict = None
-    ) -> List[MinerErrorData]:
-        if not graphql_errors and not api_tunerstatus:
-            try:
-                graphql_errors = await self.send_graphql_query(
-                    "{bosminer{info{workSolver{childSolvers{name, tuner{statusMessages}}}}}}"
-                )
-            except APIError:
-                pass
-
-        if graphql_errors:
-            errors = []
-            try:
-                boards = graphql_errors["bosminer"]["info"]["workSolver"][
-                    "childSolvers"
-                ]
-            except (KeyError, IndexError):
-                boards = None
-
-            if boards:
-                offset = 6 if int(boards[0]["name"]) in [6, 7, 8] else 0
-                for hb in boards:
-                    _id = int(hb["name"]) - offset
-                    tuner = hb["tuner"]
-                    if tuner:
-                        if msg := tuner.get("statusMessages"):
-                            if len(msg) > 0:
-                                if hb["tuner"]["statusMessages"][0] not in [
-                                    "Stable",
-                                    "Testing performance profile",
-                                    "Tuning individual chips",
-                                ]:
-                                    errors.append(
-                                        BraiinsOSError(
-                                            f"Slot {_id} {hb['tuner']['statusMessages'][0]}"
-                                        )
-                                    )
-
-        if not api_tunerstatus:
-            try:
-                api_tunerstatus = await self.api.tunerstatus()
-            except APIError:
-                pass
-
-        if api_tunerstatus:
-            errors = []
-            try:
-                chain_status = api_tunerstatus["TUNERSTATUS"][0]["TunerChainStatus"]
-                if chain_status and len(chain_status) > 0:
-                    offset = (
-                        6 if int(chain_status[0]["HashchainIndex"]) in [6, 7, 8] else 0
-                    )
-
-                    for board in chain_status:
-                        _id = board["HashchainIndex"] - offset
-                        if board["Status"] not in [
-                            "Stable",
-                            "Testing performance profile",
-                            "Tuning individual chips",
-                        ]:
-                            _error = board["Status"].split(" {")[0]
-                            _error = _error[0].lower() + _error[1:]
-                            errors.append(BraiinsOSError(f"Slot {_id} {_error}"))
-                return errors
-            except (KeyError, IndexError):
-                pass
-
-    async def get_fault_light(self, graphql_fault_light: dict = None) -> bool:
-        if self.light:
-            return self.light
-
-        if not graphql_fault_light:
-            if self.fw_ver:
-                # fw version has to be greater than 21.09 and not 21.09
-                if (
-                    int(self.fw_ver.split(".")[0]) == 21
-                    and int(self.fw_ver.split(".")[1]) > 9
-                ) or int(self.fw_ver.split(".")[0]) > 21:
-                    try:
-                        graphql_fault_light = await self.send_graphql_query(
-                            "{bos {faultLight}}"
-                        )
-                    except APIError:
-                        pass
-                else:
-                    logging.info(
-                        f"FW version {self.fw_ver} is too low for fault light info in graphql."
-                    )
-            else:
-                # worth trying
-                try:
-                    graphql_fault_light = await self.send_graphql_query(
-                        "{bos {faultLight}}"
-                    )
-                except APIError:
-                    logging.debug(
-                        "GraphQL fault light failed, likely due to version being too low (<=21.0.9)"
-                    )
-                if not graphql_fault_light:
-                    # also a failure
-                    logging.debug(
-                        "GraphQL fault light failed, likely due to version being too low (<=21.0.9)"
-                    )
-
-        # get light through GraphQL
-        if graphql_fault_light:
-            try:
-                self.light = graphql_fault_light["bos"]["faultLight"]
-                return self.light
-            except (TypeError, KeyError, ValueError, IndexError):
-                pass
-
-        # get light via ssh if that fails (10x slower)
-        try:
-            data = (
-                await self.send_ssh_command("cat /sys/class/leds/'Red LED'/delay_off")
-            ).strip()
-            self.light = False
-            if data == "50":
-                self.light = True
-        except Exception as e:
-            logging.debug(f"SSH command failed - Fault Light - {e}")
-        return self.light
-
-    async def get_nominal_hashrate(self, api_devs: dict = None) -> Optional[float]:
-        if not api_devs:
-            try:
-                api_devs = await self.api.devs()
-            except APIError:
-                pass
-        nom_hr = 0
-
-        if api_devs:
-            try:
-                offset = 6 if api_devs["DEVS"][0]["ID"] in [6, 7, 8] else 0
-                hr_list = []
-
-                for board in api_devs["DEVS"]:
-                    _id = board["ID"] - offset
-                    nominal_hashrate = round(float(board["Nominal MHS"] / 1000000), 2)
-                    if nominal_hashrate:
-                        hr_list.append(nominal_hashrate)
-                if len(hr_list) == 0:
-                    return 0
-                else:
-                    return round(
-                        (sum(hr_list) / len(hr_list)) * self.ideal_hashboards, 2
-                    )
-            except (IndexError, KeyError):
-                pass

pyasic/miners/_backends/bosminer_old.py

@@ -1,184 +0,0 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
-
-import ipaddress
-import logging
-from collections import namedtuple
-from typing import List, Optional, Tuple, Union
-
-import asyncssh
-
-from pyasic.API.bosminer import BOSMinerAPI
-from pyasic.config import MinerConfig
-from pyasic.data import Fan, HashBoard, MinerData
-from pyasic.data.error_codes import MinerErrorData
-from pyasic.errors import APIError
-from pyasic.miners.base import BaseMiner
-
-
-class BOSMinerOld(BaseMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip)
-        self.ip = ipaddress.ip_address(ip)
-        self.api = BOSMinerAPI(ip, api_ver)
-        self.api_type = "BOSMiner"
-        self.uname = "root"
-        self.pwd = "admin"
-
-    async def send_ssh_command(self, cmd: str) -> Optional[str]:
-        result = None
-
-        try:
-            conn = await self._get_ssh_connection()
-        except (asyncssh.Error, OSError):
-            return None
-
-        # open an ssh connection
-        async with conn:
-            # 3 retries
-            for i in range(3):
-                try:
-                    # run the command and get the result
-                    result = await conn.run(cmd)
-                    result = result.stdout
-
-                except Exception as e:
-                    # if the command fails, log it
-                    logging.warning(f"{self} command {cmd} error: {e}")
-
-                    # on the 3rd retry, return None
-                    if i == 3:
-                        return
-                    continue
-        # return the result, either command output or None
-        return result
-
-    async def update_to_plus(self):
-        result = await self.send_ssh_command("opkg update && opkg install bos_plus")
-        return result
-
-    async def check_light(self) -> bool:
-        return False
-
-    async def fault_light_on(self) -> bool:
-        return False
-
-    async def fault_light_off(self) -> bool:
-        return False
-
-    async def get_config(self) -> None:
-        return None
-
-    async def reboot(self) -> bool:
-        return False
-
-    async def restart_backend(self) -> bool:
-        return False
-
-    async def stop_mining(self) -> bool:
-        return False
-
-    async def resume_mining(self) -> bool:
-        return False
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        return None
-
-    async def set_power_limit(self, wattage: int) -> bool:
-        return False
-
-    ##################################################
-    ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
-    ##################################################
-
-    async def get_mac(self) -> Optional[str]:
-        return None
-
-    async def get_model(self) -> str:
-        return "S9"
-
-    async def get_version(self) -> Tuple[Optional[str], Optional[str]]:
-        return None, None
-
-    async def get_hostname(self) -> Optional[str]:
-        return None
-
-    async def get_hashrate(self) -> Optional[float]:
-        return None
-
-    async def get_hashboards(self) -> List[HashBoard]:
-        return []
-
-    async def get_env_temp(self) -> Optional[float]:
-        return None
-
-    async def get_wattage(self) -> Optional[int]:
-        return None
-
-    async def get_wattage_limit(self) -> Optional[int]:
-        return None
-
-    async def get_fans(
-        self,
-    ) -> List[Fan]:
-        return [Fan(), Fan(), Fan(), Fan()]
-
-    async def get_fan_psu(self) -> Optional[int]:
-        return None
-
-    async def get_api_ver(self) -> Optional[str]:
-        return None
-
-    async def get_fw_ver(self) -> Optional[str]:
-        return None
-
-    async def get_pools(self, api_pools: dict = None) -> List[dict]:
-        groups = []
-
-        if not api_pools:
-            try:
-                api_pools = await self.api.pools()
-            except APIError:
-                pass
-
-        if api_pools:
-            try:
-                pools = {}
-                for i, pool in enumerate(api_pools["POOLS"]):
-                    pools[f"pool_{i + 1}_url"] = (
-                        pool["URL"]
-                        .replace("stratum+tcp://", "")
-                        .replace("stratum2+tcp://", "")
-                    )
-                    pools[f"pool_{i + 1}_user"] = pool["User"]
-                    pools["quota"] = pool["Quota"] if pool.get("Quota") else "0"
-
-                groups.append(pools)
-            except KeyError:
-                pass
-        return groups
-
-    async def get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def get_fault_light(self) -> bool:
-        return False
-
-    async def get_nominal_hashrate(self) -> Optional[float]:
-        return None
-
-    async def get_data(self, allow_warning: bool = False) -> MinerData:
-        return MinerData(ip=str(self.ip))

pyasic/miners/_backends/btminer.py

@@ -1,578 +0,0 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
-
-import ipaddress
-import logging
-from collections import namedtuple
-from typing import List, Optional, Tuple, Union
-
-from pyasic.API.btminer import BTMinerAPI
-from pyasic.config import MinerConfig
-from pyasic.data import Fan, HashBoard, MinerData
-from pyasic.data.error_codes import MinerErrorData, WhatsminerError
-from pyasic.errors import APIError
-from pyasic.miners.base import BaseMiner
-from pyasic.settings import PyasicSettings
-
-
-class BTMiner(BaseMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip)
-        self.ip = ipaddress.ip_address(ip)
-        self.api = BTMinerAPI(ip, api_ver)
-        self.api_type = "BTMiner"
-        self.api_ver = api_ver
-
-    async def _reset_api_pwd_to_admin(self, pwd: str):
-        try:
-            data = await self.api.update_pwd(pwd, "admin")
-        except APIError:
-            return False
-        if data:
-            if "Code" in data.keys():
-                if data["Code"] == 131:
-                    return True
-        return False
-
-    async def fault_light_off(self) -> bool:
-        try:
-            data = await self.api.set_led(auto=True)
-        except APIError:
-            return False
-        if data:
-            if "Code" in data.keys():
-                if data["Code"] == 131:
-                    self.light = False
-                    return True
-        return False
-
-    async def fault_light_on(self) -> bool:
-        try:
-            data = await self.api.set_led(auto=False)
-            await self.api.set_led(
-                auto=False, color="green", start=0, period=1, duration=0
-            )
-        except APIError:
-            return False
-        if data:
-            if "Code" in data.keys():
-                if data["Code"] == 131:
-                    self.light = True
-                    return True
-        return False
-
-    async def reboot(self) -> bool:
-        try:
-            data = await self.api.reboot()
-        except APIError:
-            return False
-        if data.get("Msg"):
-            if data["Msg"] == "API command OK":
-                return True
-        return False
-
-    async def restart_backend(self) -> bool:
-        try:
-            data = await self.api.restart()
-        except APIError:
-            return False
-        if data.get("Msg"):
-            if data["Msg"] == "API command OK":
-                return True
-        return False
-
-    async def stop_mining(self) -> bool:
-        try:
-            data = await self.api.power_off(respbefore=True)
-        except APIError:
-            return False
-        if data.get("Msg"):
-            if data["Msg"] == "API command OK":
-                return True
-        return False
-
-    async def resume_mining(self) -> bool:
-        try:
-            data = await self.api.power_on()
-        except APIError:
-            return False
-        if data.get("Msg"):
-            if data["Msg"] == "API command OK":
-                return True
-        return False
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        self.config = config
-
-        conf = config.as_wm(user_suffix=user_suffix)
-        pools_conf = conf["pools"]
-
-        try:
-            await self.api.update_pools(
-                pools_conf[0]["url"],
-                pools_conf[0]["user"],
-                pools_conf[0]["pass"],
-                pools_conf[1]["url"],
-                pools_conf[1]["user"],
-                pools_conf[1]["pass"],
-                pools_conf[2]["url"],
-                pools_conf[2]["user"],
-                pools_conf[2]["pass"],
-            )
-        except APIError:
-            pass
-        try:
-            await self.api.adjust_power_limit(conf["wattage"])
-        except APIError:
-            # cannot set wattage
-            pass
-
-    async def get_config(self) -> MinerConfig:
-        pools = None
-        summary = None
-        cfg = MinerConfig()
-
-        try:
-            data = await self.api.multicommand("pools", "summary")
-            pools = data["pools"][0]
-            summary = data["summary"][0]
-        except APIError as e:
-            logging.warning(e)
-
-        if pools:
-            if "POOLS" in pools:
-                cfg = cfg.from_api(pools["POOLS"])
-        if summary:
-            if "SUMMARY" in summary:
-                if wattage := summary["SUMMARY"][0].get("Power Limit"):
-                    cfg.autotuning_wattage = wattage
-
-        self.config = cfg
-
-        return self.config
-
-    async def set_power_limit(self, wattage: int) -> bool:
-        try:
-            await self.api.adjust_power_limit(wattage)
-        except Exception as e:
-            logging.warning(f"{self} set_power_limit: {e}")
-            return False
-        else:
-            return True
-
-    ##################################################
-    ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
-    ##################################################
-
-    async def get_mac(
-        self, api_summary: dict = None, api_get_miner_info: dict = None
-    ) -> Optional[str]:
-        if not api_get_miner_info:
-            try:
-                api_get_miner_info = await self.api.get_miner_info()
-            except APIError:
-                pass
-
-        if api_get_miner_info:
-            try:
-                mac = api_get_miner_info["Msg"]["mac"]
-                return str(mac).upper()
-            except KeyError:
-                pass
-
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                mac = api_summary["SUMMARY"][0]["MAC"]
-                return str(mac).upper()
-            except (KeyError, IndexError):
-                pass
-
-    async def get_model(self, api_devdetails: dict = None) -> Optional[str]:
-        if self.model:
-            logging.debug(f"Found model for {self.ip}: {self.model}")
-            return self.model
-
-        if not api_devdetails:
-            try:
-                api_devdetails = await self.api.devdetails()
-            except APIError:
-                pass
-
-        if api_devdetails:
-            try:
-                self.model = api_devdetails["DEVDETAILS"][0]["Model"].split("V")[0]
-                logging.debug(f"Found model for {self.ip}: {self.model}")
-                return self.model
-            except (TypeError, IndexError, KeyError):
-                pass
-
-        logging.warning(f"Failed to get model for miner: {self}")
-        return None
-
-    async def get_version(
-        self, api_get_version: dict = None, api_summary: dict = None
-    ) -> Tuple[Optional[str], Optional[str]]:
-        miner_version = namedtuple("MinerVersion", "api_ver fw_ver")
-        api_ver = await self.get_api_ver(api_get_version=api_get_version)
-        fw_ver = await self.get_fw_ver(
-            api_get_version=api_get_version, api_summary=api_summary
-        )
-        return miner_version(api_ver, fw_ver)
-
-    async def get_api_ver(self, api_get_version: dict = None) -> Optional[str]:
-        # Check to see if the version info is already cached
-        if self.api_ver:
-            return self.api_ver
-
-        if not api_get_version:
-            try:
-                api_get_version = await self.api.get_version()
-            except APIError:
-                pass
-
-        if api_get_version:
-            if "Code" in api_get_version.keys():
-                if api_get_version["Code"] == 131:
-                    try:
-                        api_ver = api_get_version["Msg"]
-                        if not isinstance(api_ver, str):
-                            api_ver = api_ver["api_ver"]
-                        self.api_ver = api_ver.replace("whatsminer v", "")
-                    except (KeyError, TypeError):
-                        pass
-                    else:
-                        self.api.api_ver = self.api_ver
-                        return self.api_ver
-
-        return self.api_ver
-
-    async def get_fw_ver(
-        self, api_get_version: dict = None, api_summary: dict = None
-    ) -> Optional[str]:
-        # Check to see if the version info is already cached
-        if self.fw_ver:
-            return self.fw_ver
-
-        if not api_get_version:
-            try:
-                api_get_version = await self.api.get_version()
-            except APIError:
-                pass
-
-        if api_get_version:
-            if "Code" in api_get_version.keys():
-                if api_get_version["Code"] == 131:
-                    try:
-                        self.fw_ver = api_get_version["Msg"]["fw_ver"]
-                    except (KeyError, TypeError):
-                        pass
-                    else:
-                        return self.fw_ver
-
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                self.fw_ver = api_summary["SUMMARY"][0]["Firmware Version"].replace(
-                    "'", ""
-                )
-            except (KeyError, IndexError):
-                pass
-
-        return self.fw_ver
-
-    async def get_hostname(self, api_get_miner_info: dict = None) -> Optional[str]:
-        if self.hostname:
-            return self.hostname
-
-        if not api_get_miner_info:
-            try:
-                api_get_miner_info = await self.api.get_miner_info()
-            except APIError:
-                return None  # only one way to get this
-
-        if api_get_miner_info:
-            try:
-                self.hostname = api_get_miner_info["Msg"]["hostname"]
-            except KeyError:
-                return None
-
-        return self.hostname
-
-    async def get_hashrate(self, api_summary: dict = None) -> Optional[float]:
-        # get hr from API
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                return round(float(api_summary["SUMMARY"][0]["MHS 1m"] / 1000000), 2)
-            except (KeyError, IndexError):
-                pass
-
-    async def get_hashboards(self, api_devs: dict = None) -> List[HashBoard]:
-
-        hashboards = [
-            HashBoard(slot=i, expected_chips=self.nominal_chips)
-            for i in range(self.ideal_hashboards)
-        ]
-
-        if not api_devs:
-            try:
-                api_devs = await self.api.devs()
-            except APIError:
-                pass
-
-        if api_devs:
-            try:
-                for board in api_devs["DEVS"]:
-                    if len(hashboards) < board["ASC"] + 1:
-                        hashboards.append(
-                            HashBoard(
-                                slot=board["ASC"], expected_chips=self.nominal_chips
-                            )
-                        )
-                        self.ideal_hashboards += 1
-                    hashboards[board["ASC"]].chip_temp = round(board["Chip Temp Avg"])
-                    hashboards[board["ASC"]].temp = round(board["Temperature"])
-                    hashboards[board["ASC"]].hashrate = round(
-                        float(board["MHS 1m"] / 1000000), 2
-                    )
-                    hashboards[board["ASC"]].chips = board["Effective Chips"]
-                    hashboards[board["ASC"]].missing = False
-            except (KeyError, IndexError):
-                pass
-
-        return hashboards
-
-    async def get_env_temp(self, api_summary: dict = None) -> Optional[float]:
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                return api_summary["SUMMARY"][0]["Env Temp"]
-            except (KeyError, IndexError):
-                pass
-
-    async def get_wattage(self, api_summary: dict = None) -> Optional[int]:
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                return api_summary["SUMMARY"][0]["Power"]
-            except (KeyError, IndexError):
-                pass
-
-    async def get_wattage_limit(self, api_summary: dict = None) -> Optional[int]:
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                return api_summary["SUMMARY"][0]["Power Limit"]
-            except (KeyError, IndexError):
-                pass
-
-    async def get_fans(
-        self, api_summary: dict = None, api_get_psu: dict = None
-    ) -> List[Fan]:
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        fans = [Fan(), Fan(), Fan(), Fan()]
-        if api_summary:
-            try:
-                if self.fan_count > 0:
-                    fans = [
-                        Fan(api_summary["SUMMARY"][0]["Fan Speed In"]),
-                        Fan(api_summary["SUMMARY"][0]["Fan Speed Out"]),
-                        Fan(),
-                        Fan(),
-                    ]
-            except (KeyError, IndexError):
-                pass
-
-        return fans
-
-    async def get_fan_psu(
-        self, api_summary: dict = None, api_get_psu: dict = None
-    ) -> Optional[int]:
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                return int(api_summary["SUMMARY"][0]["Power Fanspeed"])
-            except (KeyError, IndexError):
-                pass
-
-        if not api_get_psu:
-            try:
-                api_get_psu = await self.api.get_psu()
-            except APIError:
-                pass
-
-        if api_get_psu:
-            try:
-                return int(api_get_psu["Msg"]["fan_speed"])
-            except (KeyError, TypeError):
-                pass
-
-    async def get_pools(self, api_pools: dict = None) -> List[dict]:
-        groups = []
-
-        if not api_pools:
-            try:
-                api_pools = await self.api.pools()
-            except APIError:
-                pass
-
-        if api_pools:
-            try:
-                pools = {}
-                for i, pool in enumerate(api_pools["POOLS"]):
-                    pools[f"pool_{i + 1}_url"] = (
-                        pool["URL"]
-                        .replace("stratum+tcp://", "")
-                        .replace("stratum2+tcp://", "")
-                    )
-                    pools[f"pool_{i + 1}_user"] = pool["User"]
-                    pools["quota"] = pool["Quota"] if pool.get("Quota") else "0"
-
-                groups.append(pools)
-            except KeyError:
-                pass
-        return groups
-
-    async def get_errors(
-        self, api_summary: dict = None, api_get_error_code: dict = None
-    ) -> List[MinerErrorData]:
-        errors = []
-        if not api_summary and not api_get_error_code:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                for i in range(api_summary["SUMMARY"][0]["Error Code Count"]):
-                    err = api_summary["SUMMARY"][0].get(f"Error Code {i}")
-                    if err:
-                        errors.append(WhatsminerError(error_code=err))
-            except (KeyError, IndexError, ValueError, TypeError):
-                pass
-
-        if not api_get_error_code:
-            try:
-                api_get_error_code = await self.api.get_error_code()
-            except APIError:
-                pass
-
-        if api_get_error_code:
-            for err in api_get_error_code["Msg"]["error_code"]:
-                if isinstance(err, dict):
-                    for code in err:
-                        errors.append(WhatsminerError(error_code=int(code)))
-                else:
-                    errors.append(WhatsminerError(error_code=int(err)))
-
-        return errors
-
-    async def get_nominal_hashrate(self, api_summary: dict = None):
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                nominal_hashrate = api_summary["SUMMARY"][0]["Factory GHS"]
-                if nominal_hashrate:
-                    return round(nominal_hashrate / 1000, 2)
-            except (KeyError, IndexError):
-                pass
-
-    async def get_fault_light(self, api_get_miner_info: dict = None) -> bool:
-        data = None
-
-        if not api_get_miner_info:
-            try:
-                api_get_miner_info = await self.api.get_miner_info()
-            except APIError:
-                if not self.light:
-                    self.light = False
-
-        if api_get_miner_info:
-            try:
-                self.light = not (api_get_miner_info["Msg"]["ledstat"] == "auto")
-            except KeyError:
-                pass
-
-        return self.light if self.light else False
-
-    async def set_static_ip(
-        self,
-        ip: str,
-        dns: str,
-        gateway: str,
-        subnet_mask: str = "255.255.255.0",
-        hostname: str = None,
-    ):
-        if not hostname:
-            hostname = await self.get_hostname()
-        await self.api.net_config(
-            ip=ip, mask=subnet_mask, dns=dns, gate=gateway, host=hostname, dhcp=False
-        )
-
-    async def set_dhcp(self, hostname: str = None):
-        if hostname:
-            await self.set_hostname(hostname)
-        await self.api.net_config()
-
-    async def set_hostname(self, hostname: str):
-        await self.api.set_hostname(hostname)

pyasic/miners/_backends/cgminer.py

@@ -1,402 +0,0 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
-
-import ipaddress
-import logging
-from collections import namedtuple
-from typing import List, Optional, Tuple, Union
-
-import asyncssh
-
-from pyasic.API.cgminer import CGMinerAPI
-from pyasic.config import MinerConfig
-from pyasic.data import Fan, HashBoard, MinerData
-from pyasic.data.error_codes import MinerErrorData
-from pyasic.errors import APIError
-from pyasic.miners.base import BaseMiner
-from pyasic.settings import PyasicSettings
-
-
-class CGMiner(BaseMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip)
-        self.ip = ipaddress.ip_address(ip)
-        self.api = CGMinerAPI(ip, api_ver)
-        self.api_ver = api_ver
-        self.api_type = "CGMiner"
-        self.uname = "root"
-        self.pwd = "admin"
-        self.config = None
-
-    async def send_ssh_command(self, cmd: str) -> Optional[str]:
-        result = None
-
-        try:
-            conn = await self._get_ssh_connection()
-        except (asyncssh.Error, OSError):
-            return None
-
-        # open an ssh connection
-        async with conn:
-            # 3 retries
-            for i in range(3):
-                try:
-                    # run the command and get the result
-                    result = await conn.run(cmd)
-                    result = result.stdout
-
-                except Exception as e:
-                    # if the command fails, log it
-                    logging.warning(f"{self} command {cmd} error: {e}")
-
-                    # on the 3rd retry, return None
-                    if i == 3:
-                        return
-                    continue
-        # return the result, either command output or None
-        return result
-
-    async def restart_backend(self) -> bool:
-        """Restart cgminer hashing process.  Wraps [`restart_cgminer`][pyasic.miners._backends.cgminer.CGMiner.restart_cgminer] to standardize."""
-        return await self.restart_cgminer()
-
-    async def restart_cgminer(self) -> bool:
-        """Restart cgminer hashing process."""
-        commands = ["cgminer-api restart", "/usr/bin/cgminer-monitor >/dev/null 2>&1"]
-        commands = ";".join(commands)
-        try:
-            _ret = await self.send_ssh_command(commands)
-        except (asyncssh.Error, OSError):
-            return False
-        else:
-            if isinstance(_ret, str):
-                return True
-        return False
-
-    async def reboot(self) -> bool:
-        """Reboots power to the physical miner."""
-        logging.debug(f"{self}: Sending reboot command.")
-        try:
-            _ret = await self.send_ssh_command("reboot")
-        except (asyncssh.Error, OSError):
-            return False
-        else:
-            logging.debug(f"{self}: Reboot command completed.")
-            if isinstance(_ret, str):
-                return True
-        return False
-
-    async def resume_mining(self) -> bool:
-        try:
-            commands = [
-                "mkdir -p /etc/tmp/",
-                'echo "*/3 * * * * /usr/bin/cgminer-monitor" > /etc/tmp/root',
-                "crontab -u root /etc/tmp/root",
-                "/usr/bin/cgminer-monitor >/dev/null 2>&1",
-            ]
-            commands = ";".join(commands)
-            await self.send_ssh_command(commands)
-        except (asyncssh.Error, OSError):
-            return False
-        else:
-            return True
-
-    async def stop_mining(self) -> bool:
-        try:
-            commands = [
-                "mkdir -p /etc/tmp/",
-                'echo "" > /etc/tmp/root',
-                "crontab -u root /etc/tmp/root",
-                "killall cgminer",
-            ]
-            commands = ";".join(commands)
-            await self.send_ssh_command(commands)
-        except (asyncssh.Error, OSError):
-            return False
-        else:
-            return True
-
-    async def get_config(self, api_pools: dict = None) -> MinerConfig:
-        # get pool data
-        try:
-            api_pools = await self.api.pools()
-        except APIError:
-            pass
-
-        if api_pools:
-            self.config = MinerConfig().from_api(api_pools["POOLS"])
-        return self.config
-
-    async def fault_light_off(self) -> bool:
-        return False
-
-    async def fault_light_on(self) -> bool:
-        return False
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        return None
-
-    async def set_power_limit(self, wattage: int) -> bool:
-        return False
-
-    ##################################################
-    ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
-    ##################################################
-
-    async def get_mac(self) -> Optional[str]:
-        return None
-
-    async def get_model(self, api_devdetails: dict = None) -> Optional[str]:
-        if self.model:
-            logging.debug(f"Found model for {self.ip}: {self.model}")
-            return self.model
-
-        if not api_devdetails:
-            try:
-                api_devdetails = await self.api.devdetails()
-            except APIError:
-                pass
-
-        if api_devdetails:
-            try:
-                self.model = api_devdetails["DEVDETAILS"][0]["Model"].replace(
-                    "Antminer ", ""
-                )
-                logging.debug(f"Found model for {self.ip}: {self.model}")
-                return self.model
-            except (TypeError, IndexError, KeyError):
-                pass
-
-        logging.warning(f"Failed to get model for miner: {self}")
-        return None
-
-    async def get_version(
-        self, api_version: dict = None
-    ) -> Tuple[Optional[str], Optional[str]]:
-        miner_version = namedtuple("MinerVersion", "api_ver fw_ver")
-        return miner_version(
-            api_ver=await self.get_api_ver(api_version=api_version),
-            fw_ver=await self.get_fw_ver(api_version=api_version),
-        )
-
-    async def get_api_ver(self, api_version: dict = None) -> Optional[str]:
-        if self.api_ver:
-            return self.api_ver
-
-        if not api_version:
-            try:
-                api_version = await self.api.version()
-            except APIError:
-                pass
-
-        if api_version:
-            try:
-                self.api_ver = api_version["VERSION"][0]["API"]
-            except (KeyError, IndexError):
-                pass
-
-        return self.api_ver
-
-    async def get_fw_ver(self, api_version: dict = None) -> Optional[str]:
-        if self.fw_ver:
-            return self.fw_ver
-
-        if not api_version:
-            try:
-                api_version = await self.api.version()
-            except APIError:
-                pass
-
-        if api_version:
-            try:
-                self.fw_ver = api_version["VERSION"][0]["CGMiner"]
-            except (KeyError, IndexError):
-                pass
-
-        return self.fw_ver
-
-    async def get_hostname(self) -> Optional[str]:
-        try:
-            hn = await self.send_ssh_command("cat /proc/sys/kernel/hostname")
-        except (asyncssh.Error, OSError):
-            return None
-        if hn:
-            self.hostname = hn
-        return self.hostname
-
-    async def get_hashrate(self, api_summary: dict = None) -> Optional[float]:
-        # get hr from API
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                return round(
-                    float(float(api_summary["SUMMARY"][0]["GHS 5s"]) / 1000), 2
-                )
-            except (IndexError, KeyError, ValueError, TypeError):
-                pass
-
-    async def get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
-        hashboards = []
-
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        if api_stats:
-            try:
-                board_offset = -1
-                boards = api_stats["STATS"]
-                if len(boards) > 1:
-                    for board_num in range(1, 16, 5):
-                        for _b_num in range(5):
-                            b = boards[1].get(f"chain_acn{board_num + _b_num}")
-
-                            if b and not b == 0 and board_offset == -1:
-                                board_offset = board_num
-                    if board_offset == -1:
-                        board_offset = 1
-
-                    for i in range(board_offset, board_offset + self.ideal_hashboards):
-                        hashboard = HashBoard(
-                            slot=i - board_offset, expected_chips=self.nominal_chips
-                        )
-
-                        chip_temp = boards[1].get(f"temp{i}")
-                        if chip_temp:
-                            hashboard.chip_temp = round(chip_temp)
-
-                        temp = boards[1].get(f"temp2_{i}")
-                        if temp:
-                            hashboard.temp = round(temp)
-
-                        hashrate = boards[1].get(f"chain_rate{i}")
-                        if hashrate:
-                            hashboard.hashrate = round(float(hashrate) / 1000, 2)
-
-                        chips = boards[1].get(f"chain_acn{i}")
-                        if chips:
-                            hashboard.chips = chips
-                            hashboard.missing = False
-                        if (not chips) or (not chips > 0):
-                            hashboard.missing = True
-                        hashboards.append(hashboard)
-            except (IndexError, KeyError, ValueError, TypeError):
-                pass
-
-        return hashboards
-
-    async def get_env_temp(self) -> Optional[float]:
-        return None
-
-    async def get_wattage(self) -> Optional[int]:
-        return None
-
-    async def get_wattage_limit(self) -> Optional[int]:
-        return None
-
-    async def get_fans(self, api_stats: dict = None) -> List[Fan]:
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        fans_data = [Fan(), Fan(), Fan(), Fan()]
-        if api_stats:
-            try:
-                fan_offset = -1
-
-                for fan_num in range(1, 8, 4):
-                    for _f_num in range(4):
-                        f = api_stats["STATS"][1].get(f"fan{fan_num + _f_num}")
-                        if f and not f == 0 and fan_offset == -1:
-                            fan_offset = fan_num
-                if fan_offset == -1:
-                    fan_offset = 1
-
-                for fan in range(self.fan_count):
-                    fans_data[fan] = Fan(
-                        api_stats["STATS"][1].get(f"fan{fan_offset+fan}")
-                    )
-            except (KeyError, IndexError):
-                pass
-        return fans_data
-
-    async def get_fan_psu(self) -> Optional[int]:
-        return None
-
-    async def get_pools(self, api_pools: dict = None) -> List[dict]:
-        groups = []
-
-        if not api_pools:
-            try:
-                api_pools = await self.api.pools()
-            except APIError:
-                pass
-
-        if api_pools:
-            try:
-                pools = {}
-                for i, pool in enumerate(api_pools["POOLS"]):
-                    pools[f"pool_{i + 1}_url"] = (
-                        pool["URL"]
-                        .replace("stratum+tcp://", "")
-                        .replace("stratum2+tcp://", "")
-                    )
-                    pools[f"pool_{i + 1}_user"] = pool["User"]
-                    pools["quota"] = pool["Quota"] if pool.get("Quota") else "0"
-
-                groups.append(pools)
-            except KeyError:
-                pass
-        return groups
-
-    async def get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def get_fault_light(self) -> bool:
-        return False
-
-    async def get_nominal_hashrate(self, api_stats: dict = None) -> Optional[float]:
-        # X19 method, not sure compatibility
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        if api_stats:
-            try:
-                ideal_rate = api_stats["STATS"][1]["total_rateideal"]
-                try:
-                    rate_unit = api_stats["STATS"][1]["rate_unit"]
-                except KeyError:
-                    rate_unit = "GH"
-                if rate_unit == "GH":
-                    return round(ideal_rate / 1000, 2)
-                if rate_unit == "MH":
-                    return round(ideal_rate / 1000000, 2)
-                else:
-                    return round(ideal_rate, 2)
-            except (KeyError, IndexError):
-                pass

pyasic/miners/_backends/cgminer_avalon.py

@@ -1,272 +0,0 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
-
-import ipaddress
-import logging
-import re
-from collections import namedtuple
-from typing import List, Optional, Tuple, Union
-
-from pyasic.API.cgminer import CGMinerAPI
-from pyasic.config import MinerConfig
-from pyasic.data import Fan, HashBoard, MinerData
-from pyasic.data.error_codes import MinerErrorData
-from pyasic.errors import APIError
-from pyasic.miners._backends import CGMiner
-from pyasic.miners.base import BaseMiner
-from pyasic.settings import PyasicSettings
-
-
-class CGMinerAvalon(CGMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver)
-        self.ip = ip
-
-    async def fault_light_on(self) -> bool:
-        try:
-            data = await self.api.ascset(0, "led", "1-1")
-        except APIError:
-            return False
-        if data["STATUS"][0]["Msg"] == "ASC 0 set OK":
-            return True
-        return False
-
-    async def fault_light_off(self) -> bool:
-        try:
-            data = await self.api.ascset(0, "led", "1-0")
-        except APIError:
-            return False
-        if data["STATUS"][0]["Msg"] == "ASC 0 set OK":
-            return True
-        return False
-
-    async def reboot(self) -> bool:
-        try:
-            data = await self.api.restart()
-        except APIError:
-            return False
-
-        try:
-            if data["STATUS"] == "RESTART":
-                return True
-        except KeyError:
-            return False
-        return False
-
-    async def stop_mining(self) -> bool:
-        return False
-
-    async def resume_mining(self) -> bool:
-        return False
-
-    async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
-        """Configures miner with yaml config."""
-        self.config = config
-        return None
-        logging.debug(f"{self}: Sending config.")  # noqa - This doesnt work...
-        conf = config.as_avalon(user_suffix=user_suffix)
-        try:
-            data = await self.api.ascset(
-                0, "setpool", f"root,root,{conf}"
-            )  # this should work but doesn't
-        except APIError:
-            pass
-        # return data
-
-    @staticmethod
-    def parse_stats(stats):
-        _stats_items = re.findall(".+?\[*?]", stats)
-        stats_items = []
-        stats_dict = {}
-        for item in _stats_items:
-            if ":" in item:
-                data = item.replace("]", "").split("[")
-                data_list = [i.split(": ") for i in data[1].strip().split(", ")]
-                data_dict = {}
-                for key, val in [tuple(item) for item in data_list]:
-                    data_dict[key] = val
-                raw_data = [data[0].strip(), data_dict]
-            else:
-                raw_data = [
-                    value
-                    for value in item.replace("[", " ")
-                    .replace("]", " ")
-                    .split(" ")[:-1]
-                    if value != ""
-                ]
-                if len(raw_data) == 1:
-                    raw_data.append("")
-            if raw_data[0] == "":
-                raw_data = raw_data[1:]
-
-            if len(raw_data) == 2:
-                stats_dict[raw_data[0]] = raw_data[1]
-            else:
-                stats_dict[raw_data[0]] = raw_data[1:]
-            stats_items.append(raw_data)
-
-        return stats_dict
-
-    ##################################################
-    ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
-    ##################################################
-
-    async def get_mac(self, api_version: dict = None) -> Optional[str]:
-        if not api_version:
-            try:
-                api_version = await self.api.version()
-            except APIError:
-                pass
-
-        if api_version:
-            try:
-                base_mac = api_version["VERSION"][0]["MAC"]
-                base_mac = base_mac.upper()
-                mac = ":".join(
-                    [base_mac[i : (i + 2)] for i in range(0, len(base_mac), 2)]
-                )
-                return mac
-            except (KeyError, ValueError):
-                pass
-
-    async def get_hostname(self, mac: str = None) -> Optional[str]:
-        if not mac:
-            mac = await self.get_mac()
-
-        if mac:
-            return f"Avalon{mac.replace(':', '')[-6:]}"
-
-    async def get_hashrate(self, api_summary: dict = None) -> Optional[float]:
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                return round(float(api_summary["SUMMARY"][0]["MHS 1m"] / 1000000), 2)
-            except (KeyError, IndexError, ValueError, TypeError):
-                pass
-
-    async def get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
-        hashboards = [
-            HashBoard(slot=i, expected_chips=self.nominal_chips)
-            for i in range(self.ideal_hashboards)
-        ]
-
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        if api_stats:
-            try:
-                stats_data = api_stats[0].get("STATS")
-                if stats_data:
-                    for key in stats_data[0].keys():
-                        if key.startswith("MM ID"):
-                            raw_data = self.parse_stats(stats_data[0][key])
-                            for board in range(self.ideal_hashboards):
-                                chip_temp = raw_data.get("MTmax")
-                                if chip_temp:
-                                    hashboards[board].chip_temp = chip_temp[board]
-
-                                temp = raw_data.get("MTavg")
-                                if temp:
-                                    hashboards[board].temp = temp[board]
-
-                                chips = raw_data.get(f"PVT_T{board}")
-                                if chips:
-                                    hashboards[board].chips = len(
-                                        [item for item in chips if not item == "0"]
-                                    )
-            except (IndexError, KeyError, ValueError, TypeError):
-                pass
-
-        return hashboards
-
-    async def get_env_temp(self) -> Optional[float]:
-        return None
-
-    async def get_wattage(self) -> Optional[int]:
-        return None
-
-    async def get_wattage_limit(self) -> Optional[int]:
-        return None
-
-    async def get_fans(self, api_stats: dict = None) -> List[Fan]:
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        fans_data = [Fan(), Fan(), Fan(), Fan()]
-        if api_stats:
-            try:
-                stats_data = api_stats[0].get("STATS")
-                if stats_data:
-                    for key in stats_data[0].keys():
-                        if key.startswith("MM ID"):
-                            raw_data = self.parse_stats(stats_data[0][key])
-                            for fan in range(self.fan_count):
-                                fans_data[fan] = Fan(int(raw_data[f"Fan{fan + 1}"]))
-            except (KeyError, IndexError, ValueError, TypeError):
-                pass
-
-        return fans_data
-
-    async def get_pools(self, api_pools: dict = None) -> List[dict]:
-        groups = []
-
-        if not api_pools:
-            try:
-                api_pools = await self.api.pools()
-            except APIError:
-                pass
-
-        if api_pools:
-            try:
-                pools = {}
-                for i, pool in enumerate(api_pools["POOLS"]):
-                    pools[f"pool_{i + 1}_url"] = (
-                        pool["URL"]
-                        .replace("stratum+tcp://", "")
-                        .replace("stratum2+tcp://", "")
-                    )
-                    pools[f"pool_{i + 1}_user"] = pool["User"]
-                    pools["quota"] = pool["Quota"] if pool.get("Quota") else "0"
-
-                groups.append(pools)
-            except KeyError:
-                pass
-        return groups
-
-    async def get_errors(self) -> List[MinerErrorData]:
-        return []
-
-    async def get_fault_light(self) -> bool:
-        if self.light:
-            return self.light
-        try:
-            data = await self.api.ascset(0, "led", "1-255")
-        except APIError:
-            return False
-        if data["STATUS"][0]["Msg"] == "ASC 0 set info: LED[1]":
-            return True
-        return False

pyasic/miners/_backends/vnish.py

@@ -1,218 +0,0 @@
-# ------------------------------------------------------------------------------
-#  Copyright 2022 Upstream Data Inc                                            -
-#                                                                              -
-#  Licensed under the Apache License, Version 2.0 (the "License");             -
-#  you may not use this file except in compliance with the License.            -
-#  You may obtain a copy of the License at                                     -
-#                                                                              -
-#      http://www.apache.org/licenses/LICENSE-2.0                              -
-#                                                                              -
-#  Unless required by applicable law or agreed to in writing, software         -
-#  distributed under the License is distributed on an "AS IS" BASIS,           -
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
-#  See the License for the specific language governing permissions and         -
-#  limitations under the License.                                              -
-# ------------------------------------------------------------------------------
-
-import json
-import logging
-import warnings
-from typing import Optional, Union
-
-import httpx
-
-from pyasic.errors import APIError
-from pyasic.miners._backends.bmminer import BMMiner
-from pyasic.settings import PyasicSettings
-
-
-class VNish(BMMiner):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver)
-        self.api_type = "VNish"
-        self.uname = "root"
-        self.pwd = PyasicSettings().global_vnish_password
-        self.jwt = None
-
-    async def auth(self):
-        async with httpx.AsyncClient() as client:
-            try:
-                auth = await client.post(
-                    f"http://{self.ip}/api/v1/unlock",
-                    json={"pw": self.pwd},
-                )
-            except httpx.HTTPError:
-                warnings.warn(f"Could not authenticate web token with miner: {self}")
-            else:
-                if not auth.status_code == 200:
-                    warnings.warn(
-                        f"Could not authenticate web token with miner: {self}"
-                    )
-                    return None
-                json_auth = auth.json()
-                self.jwt = json_auth["token"]
-            return self.jwt
-
-    async def send_web_command(
-        self, command: str, data: Union[dict, None] = None, method: str = "GET"
-    ):
-        if not self.jwt:
-            await self.auth()
-        if not data:
-            data = {}
-        async with httpx.AsyncClient() as client:
-            for i in range(PyasicSettings().miner_get_data_retries):
-                try:
-                    auth = self.jwt
-                    if command.startswith("system"):
-                        auth = "Bearer " + self.jwt
-                    if method == "GET":
-                        response = await client.get(
-                            f"http://{self.ip}/api/v1/{command}",
-                            headers={"Authorization": auth},
-                            timeout=5,
-                        )
-                    elif method == "POST":
-                        if data:
-                            response = await client.post(
-                                f"http://{self.ip}/api/v1/{command}",
-                                headers={"Authorization": auth},
-                                timeout=5,
-                                json=data,
-                            )
-                        else:
-                            response = await client.post(
-                                f"http://{self.ip}/api/v1/{command}",
-                                headers={"Authorization": auth},
-                                timeout=5,
-                            )
-                    else:
-                        raise APIError("Bad method type.")
-                    if not response.status_code == 200:
-                        # refresh the token, retry
-                        await self.auth()
-                        continue
-                    json_data = response.json()
-                    if json_data:
-                        return json_data
-                    return True
-                except httpx.HTTPError:
-                    pass
-                except json.JSONDecodeError:
-                    pass
-
-    async def get_model(self, api_stats: dict = None) -> Optional[str]:
-        # check if model is cached
-        if self.model:
-            logging.debug(f"Found model for {self.ip}: {self.model} (VNish)")
-            return self.model + " (VNish)"
-
-        if not api_stats:
-            try:
-                api_stats = await self.api.stats()
-            except APIError:
-                pass
-
-        if api_stats:
-            try:
-                m_type = api_stats["STATS"][0]["Type"]
-                self.model = m_type.split(" ")[1]
-                return self.model
-            except (KeyError, IndexError):
-                pass
-
-    async def restart_backend(self) -> bool:
-        data = await self.send_web_command("mining/restart", method="POST")
-        return data
-
-    async def reboot(self) -> bool:
-        data = await self.send_web_command("system/reboot", method="POST")
-        return data
-
-    async def get_mac(self, web_summary: dict = None) -> str:
-        if not web_summary:
-            web_info = await self.send_web_command("info")
-
-            if web_info:
-                try:
-                    mac = web_info["system"]["network_status"]["mac"]
-                    return mac
-                except KeyError:
-                    pass
-
-        if web_summary:
-            try:
-                mac = web_summary["system"]["network_status"]["mac"]
-                return mac
-            except KeyError:
-                pass
-
-    async def get_hostname(self, web_summary: dict = None) -> str:
-        if not web_summary:
-            web_info = await self.send_web_command("info")
-
-            if web_info:
-                try:
-                    hostname = web_info["system"]["network_status"]["hostname"]
-                    return hostname
-                except KeyError:
-                    pass
-
-        if web_summary:
-            try:
-                hostname = web_summary["system"]["network_status"]["hostname"]
-                return hostname
-            except KeyError:
-                pass
-
-    async def get_wattage(self, web_summary: dict = None) -> Optional[int]:
-        if not web_summary:
-            web_summary = await self.send_web_command("summary")
-
-        if web_summary:
-            try:
-                wattage = web_summary["miner"]["power_usage"]
-                wattage = round(wattage * 1000)
-                return wattage
-            except KeyError:
-                pass
-
-    async def get_hashrate(self, api_summary: dict = None) -> Optional[float]:
-        # get hr from API
-        if not api_summary:
-            try:
-                api_summary = await self.api.summary()
-            except APIError:
-                pass
-
-        if api_summary:
-            try:
-                return round(
-                    float(float(api_summary["SUMMARY"][0]["GHS 5s"]) / 1000), 2
-                )
-            except (IndexError, KeyError, ValueError, TypeError) as e:
-                print(e)
-                pass
-
-    async def get_wattage_limit(self, web_settings: dict = None) -> Optional[int]:
-        if not web_settings:
-            web_settings = await self.send_web_command("summary")
-
-        if web_settings:
-            try:
-                wattage_limit = web_settings["miner"]["overclock"]["preset"]
-                return int(wattage_limit)
-            except (KeyError, TypeError):
-                pass
-
-    async def get_fw_ver(self, web_summary: dict = None) -> Optional[str]:
-        if not web_summary:
-            web_summary = await self.send_web_command("summary")
-
-        if web_summary:
-            try:
-                fw_ver = web_summary["miner"]["miner_type"]
-                fw_ver = fw_ver.split("(Vnish ")[1].replace(")", "")
-                return fw_ver
-            except KeyError:
-                pass

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

@@ -1,26 +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 pyasic.miners._types.makes import AntMiner
-
-
-class S17(AntMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str):
-        super().__init__()
-        self.ip = ip
-        self.model = "S17"
-        self.nominal_chips = 48
-        self.fan_count = 4

pyasic/miners/_types/antminer/X17/S17_Plus.py

@@ -1,26 +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 pyasic.miners._types.makes import AntMiner
-
-
-class S17Plus(AntMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str):
-        super().__init__()
-        self.ip = ip
-        self.model = "S17+"
-        self.nominal_chips = 65
-        self.fan_count = 4

pyasic/miners/_types/antminer/X17/S17_Pro.py

@@ -1,26 +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 pyasic.miners._types.makes import AntMiner
-
-
-class S17Pro(AntMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str):
-        super().__init__()
-        self.ip = ip
-        self.model = "S17 Pro"
-        self.nominal_chips = 48
-        self.fan_count = 4

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

@@ -1,26 +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 pyasic.miners._types.makes import AntMiner
-
-
-class T17(AntMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str):
-        super().__init__()
-        self.ip = ip
-        self.model = "T17"
-        self.nominal_chips = 30
-        self.fan_count = 4

pyasic/miners/_types/antminer/X17/T17_Plus.py

@@ -1,26 +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 pyasic.miners._types.makes import AntMiner
-
-
-class T17Plus(AntMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str):
-        super().__init__()
-        self.ip = ip
-        self.model = "T17+"
-        self.nominal_chips = 44
-        self.fan_count = 4

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

@@ -1,26 +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 pyasic.miners._types.makes import AntMiner
-
-
-class S19(AntMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str):
-        super().__init__()
-        self.ip = ip
-        self.model = "S19"
-        self.nominal_chips = 76
-        self.fan_count = 4

pyasic/miners/_types/antminer/X19/S19_Pro.py

@@ -1,26 +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 pyasic.miners._types.makes import AntMiner
-
-
-class S19Pro(AntMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str):
-        super().__init__()
-        self.ip = ip
-        self.model = "S19 Pro"
-        self.nominal_chips = 114
-        self.fan_count = 4

pyasic/miners/_types/antminer/X19/S19_XP.py

@@ -1,26 +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 pyasic.miners._types.makes import AntMiner
-
-
-class S19XP(AntMiner):  # noqa - ignore ABC method implementation
-    def __init__(self, ip: str):
-        super().__init__()
-        self.ip = ip
-        self.model = "S19 XP"
-        self.nominal_chips = 110
-        self.fan_count = 4