version: bump version number.

# Conflicts:
#	pyasic/miners/miner_factory.py
#	pyasic/miners/types/whatsminer/M6X/M60.py
#	pyasic/miners/types/whatsminer/M6X/M60S.py
#	pyasic/miners/types/whatsminer/M6X/M63.py
#	pyasic/miners/types/whatsminer/M6X/M63S.py
#	pyasic/miners/types/whatsminer/M6X/M66.py
#	pyasic/miners/types/whatsminer/M6X/M66S.py
#	pyasic/miners/types/whatsminer/M6X/__init__.py
#	pyasic/miners/whatsminer/btminer/M6X/M60.py
#	pyasic/miners/whatsminer/btminer/M6X/M60S.py
#	pyasic/miners/whatsminer/btminer/M6X/M66S.py
#	pyasic/miners/whatsminer/btminer/M6X/__init__.py
#	pyasic/miners/whatsminer/btminer/__init__.py

README.md

@@ -1,5 +1,5 @@
 # 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/)

docs/API/api.md

@@ -10,10 +10,12 @@ All API implementations inherit from [`BaseMinerAPI`][pyasic.API.BaseMinerAPI],
 [`BaseMinerAPI`][pyasic.API.BaseMinerAPI] cannot be instantiated directly, it will raise a `TypeError`.
 Use these instead -
 
+#### [BFGMiner API][pyasic.API.bfgminer.BFGMinerAPI]
 #### [BMMiner API][pyasic.API.bmminer.BMMinerAPI]
 #### [BOSMiner API][pyasic.API.bosminer.BOSMinerAPI]
 #### [BTMiner API][pyasic.API.btminer.BTMinerAPI]
 #### [CGMiner API][pyasic.API.cgminer.CGMinerAPI]
+#### [LUXMiner API][pyasic.API.luxminer.LUXMinerAPI]
 #### [Unknown API][pyasic.API.unknown.UnknownAPI]
 
 <br>

docs/API/bfgminer.md

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

docs/API/luxminer.md

@@ -0,0 +1,7 @@
+# pyasic
+## LUXMinerAPI
+::: pyasic.API.luxminer.LUXMinerAPI
+    handler: python
+    options:
+        show_root_heading: false
+        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/generate_miners.py

@@ -0,0 +1,165 @@
+import asyncio
+import importlib
+import os
+import warnings
+
+from pyasic.miners.miner_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.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"
+
+
+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

@@ -8,18 +8,21 @@
 [![GitHub](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
 [![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)
 
+---
 ## Intro
-Welcome to pyasic!  Pyasic uses an asynchronous method of communicating with asic miners on your network, which makes it super fast.
+---
+Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with ASIC miners on your network, which makes it super fast.
 
-[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.
+---
+## Getting started
+---
+Getting started with `pyasic` is easy.  First, find your miner (or miners) on the network by scanning for them or getting the correct class automatically for them if you know the IP.
 
-<br>
-
-## Scanning for miners
-To scan for miners in pyasic, we use the class [`MinerNetwork`][pyasic.network.MinerNetwork], which abstracts the search, communication, identification, setup, and return of a miner to 1 command.
-The command [`MinerNetwork().scan_network_for_miners()`][pyasic.network.MinerNetwork.scan_network_for_miners] returns a list that contains any miners found.
+##### 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 +31,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.miner_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 +102,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 +115,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 [`BaseMiner`][pyasic.miners.BaseMiner].
 
 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.BaseMiner.check_light],
+[`fault_light_off`][pyasic.miners.BaseMiner.fault_light_off],
+[`fault_light_on`][pyasic.miners.BaseMiner.fault_light_on],
+[`get_config`][pyasic.miners.BaseMiner.get_config],
+[`get_data`][pyasic.miners.BaseMiner.get_data],
+[`get_errors`][pyasic.miners.BaseMiner.get_errors],
+[`get_hostname`][pyasic.miners.BaseMiner.get_hostname],
+[`get_model`][pyasic.miners.BaseMiner.get_model],
+[`reboot`][pyasic.miners.BaseMiner.reboot],
+[`restart_backend`][pyasic.miners.BaseMiner.restart_backend],
+[`stop_mining`][pyasic.miners.BaseMiner.stop_mining],
+[`resume_mining`][pyasic.miners.BaseMiner.resume_mining],
+[`is_mining`][pyasic.miners.BaseMiner.is_mining],
+[`send_config`][pyasic.miners.BaseMiner.send_config], and
+[`set_power_limit`][pyasic.miners.BaseMiner.set_power_limit].
 
-<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 +183,64 @@ 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,
+"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

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

docs/miners/antminer/X17.md

@@ -2,116 +2,114 @@
 ## X17 Models
 
 ## S17
-
-::: pyasic.miners.btc.antminer.bmminer.X17.S17.BMMinerS17
+::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S17+
-
-::: pyasic.miners.btc.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.btc.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.btc.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.btc.antminer.bmminer.X17.T17.BMMinerT17
+::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## T17+
-
-::: pyasic.miners.btc.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.btc.antminer.bmminer.X17.T17e.BMMinerT17e
+::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17e
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-
 ## S17 (BOS)
-
-::: pyasic.miners.btc.antminer.bosminer.X17.S17.BOSMinerS17
+::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S17+ (BOS)
-
-::: pyasic.miners.btc.antminer.bosminer.X17.S17_Plus.BOSMinerS17Plus
+::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17Plus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S17 Pro (BOS)
-
-::: pyasic.miners.btc.antminer.bosminer.X17.S17_Pro.BOSMinerS17Pro
+::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17Pro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S17e (BOS)
-
-::: pyasic.miners.btc.antminer.bosminer.X17.S17e.BOSMinerS17e
+::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17e
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## T17 (BOS)
-
-::: pyasic.miners.btc.antminer.bosminer.X17.T17.BOSMinerT17
+::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## T17+ (BOS)
-
-::: pyasic.miners.btc.antminer.bosminer.X17.T17_Plus.BOSMinerT17Plus
+::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17Plus
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-
 ## T17e (BOS)
-
-::: pyasic.miners.btc.antminer.bosminer.X17.T17e.BOSMinerT17e
+::: 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,109 +2,233 @@
 ## X19 Models
 
 ## S19
-
-::: pyasic.miners.btc.antminer.bmminer.X19.S19.BMMinerS19
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S19L
-
-::: pyasic.miners.btc.antminer.bmminer.X19.S19L.BMMinerS19L
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19L
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S19 Pro
-
-::: pyasic.miners.btc.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.btc.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.btc.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.btc.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.btc.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
 
 ## T19
-
-::: pyasic.miners.btc.antminer.bmminer.X19.T19.BMMinerT19
+::: pyasic.miners.antminer.bmminer.X19.T19.BMMinerT19
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-
 ## S19 (BOS)
-
-::: pyasic.miners.btc.antminer.bosminer.X19.S19.BOSMinerS19
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S19 Pro (BOS)
-
-::: pyasic.miners.btc.antminer.bosminer.X19.S19_Pro.BOSMinerS19Pro
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19Pro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-
 ## S19j (BOS)
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19j
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
-::: pyasic.miners.btc.antminer.bosminer.X19.S19j.BOSMinerS19j
+## S19j No PIC (BOS)
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jNoPIC
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S19j Pro (BOS)
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
-::: pyasic.miners.btc.antminer.bosminer.X19.S19j_Pro.BOSMinerS19jPro
+## S19j Pro (BOS)
+::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19jPro
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## T19 (BOS)
-
-::: pyasic.miners.btc.antminer.bosminer.X19.T19.BOSMinerT19
+::: 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
+
+## S19 XP (ePIC)
+::: pyasic.miners.antminer.epic.X19.S19.ePICS19XP
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/antminer/X3.md

@@ -1,11 +1,31 @@
 # pyasic
 ## X3 Models
 
-
-## HS3
-
-::: pyasic.miners.hns.antminer.cgminer.X3.HS3.CGMinerHS3
+## 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
+

docs/miners/antminer/X5.md

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

docs/miners/antminer/X7.md

@@ -1,11 +1,10 @@
 # pyasic
 ## X7 Models
 
-
 ## L7
-
-::: pyasic.miners.ltc.antminer.bmminer.X7.L7.BMMinerL7
+::: pyasic.miners.antminer.bmminer.X7.L7.BMMinerL7
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
+

docs/miners/antminer/X9.md

@@ -1,44 +1,59 @@
 # pyasic
 ## X9 Models
 
-
-## X9 (BOS)
-
-::: pyasic.miners.btc.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.btc.antminer.bmminer.X9.S9.BMMinerS9
+::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
 ## S9i
+::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9i
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
 
-::: pyasic.miners.btc.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.btc.antminer.bmminer.X9.T9.BMMinerT9
+::: pyasic.miners.antminer.bmminer.X9.T9.BMMinerT9
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## E9 Pro
-
-::: pyasic.miners.etc.antminer.cgminer.X9.E9_Pro.CGMinerE9Pro
+## S9 (BOS)
+::: pyasic.miners.antminer.bosminer.X9.S9.BOSMinerS9
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
+
+## T9 (Hiveon)
+::: 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/avalonminer/A10X.md

@@ -1,26 +1,24 @@
 # pyasic
 ## A10X Models
 
-## A1026
-
-::: pyasic.miners.btc.avalonminer.cgminer.A10X.A1026.CGMinerAvalon1026
+## Avalon 1026
+::: pyasic.miners.avalonminer.cgminer.A10X.A1026.CGMinerAvalon1026
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## A1047
-
-::: pyasic.miners.btc.avalonminer.cgminer.A10X.A1047.CGMinerAvalon1047
+## Avalon 1047
+::: pyasic.miners.avalonminer.cgminer.A10X.A1047.CGMinerAvalon1047
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## A1066
-
-::: pyasic.miners.btc.avalonminer.cgminer.A10X.A1066.CGMinerAvalon1066
+## 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
-
-::: pyasic.miners.btc.avalonminer.cgminer.A7X.A721.CGMinerAvalon721
+## Avalon 721
+::: pyasic.miners.avalonminer.cgminer.A7X.A721.CGMinerAvalon721
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## A741
-
-::: pyasic.miners.btc.avalonminer.cgminer.A7X.A741.CGMinerAvalon741
+## Avalon 741
+::: pyasic.miners.avalonminer.cgminer.A7X.A741.CGMinerAvalon741
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## A761
-
-::: pyasic.miners.btc.avalonminer.cgminer.A7X.A761.CGMinerAvalon761
+## 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
-
-::: pyasic.miners.btc.avalonminer.cgminer.A8X.A821.CGMinerAvalon821
+## Avalon 821
+::: pyasic.miners.avalonminer.cgminer.A8X.A821.CGMinerAvalon821
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## A841
-
-::: pyasic.miners.btc.avalonminer.cgminer.A8X.A841.CGMinerAvalon841
+## Avalon 841
+::: pyasic.miners.avalonminer.cgminer.A8X.A841.CGMinerAvalon841
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## A851
-
-::: pyasic.miners.btc.avalonminer.cgminer.A8X.A851.CGMinerAvalon851
+## 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
-
-::: pyasic.miners.btc.avalonminer.cgminer.A9X.A921.CGMinerAvalon921
+## Avalon 921
+::: pyasic.miners.avalonminer.cgminer.A9X.A921.CGMinerAvalon921
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
+

docs/miners/backends/bfgminer.md

@@ -1,7 +1,7 @@
 # pyasic
 ## BFGMiner Backend
 
-::: pyasic.miners.kda._backends.bfgminer.BFGMiner
+::: pyasic.miners.backends.bfgminer.BFGMiner
     handler: python
     options:
         show_root_heading: false

docs/miners/backends/bmminer.md

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

docs/miners/backends/bosminer.md

@@ -1,7 +1,7 @@
 # pyasic
 ## BOSMiner Backend
 
-::: pyasic.miners.btc._backends.bosminer.BOSMiner
+::: pyasic.miners.backends.bosminer.BOSMiner
     handler: python
     options:
         show_root_heading: false

docs/miners/backends/btminer.md

@@ -1,7 +1,7 @@
 # pyasic
 ## BTMiner Backend
 
-::: pyasic.miners.btc._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.btc._backends.cgminer.CGMiner
+::: pyasic.miners.backends.cgminer.CGMiner
     handler: python
     options:
         show_root_heading: false

docs/miners/backends/epic.md

@@ -1,9 +1,7 @@
 # pyasic
-## CKX Models
+## ePIC Backend
 
-## CK5
-
-::: pyasic.miners.ckb.goldshell.bfgminer.CKX.CK5.BFGMinerCK5
+::: 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.btc._backends.hiveon.Hiveon
+::: pyasic.miners.backends.hiveon.Hiveon
     handler: python
     options:
         show_root_heading: false

docs/miners/backends/luxminer.md

@@ -1,9 +1,7 @@
 # pyasic
-## HSX Models
+## LUXMiner Backend
 
-## HS5
-
-::: pyasic.miners.hns.goldshell.bfgminer.HSX.HS5.BFGMinerHS5
+::: pyasic.miners.backends.luxminer.LUXMiner
     handler: python
     options:
         show_root_heading: false

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/functions.md

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

docs/miners/goldshell/KDX.md

@@ -1,19 +0,0 @@
-# pyasic
-## KDX Models
-
-## KD5
-
-::: pyasic.miners.kda.goldshell.bfgminer.KDX.KD5.BFGMinerKD5
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-
-## KD Max
-
-::: pyasic.miners.kda.goldshell.bfgminer.KDX.KDMax.BFGMinerKDMax
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4

docs/miners/goldshell/X5.md

@@ -0,0 +1,24 @@
+# pyasic
+## X5 Models
+
+## CK5
+::: pyasic.miners.goldshell.bfgminer.X5.CK5.BFGMinerCK5
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## HS5
+::: pyasic.miners.goldshell.bfgminer.X5.HS5.BFGMinerHS5
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## KD5
+::: pyasic.miners.goldshell.bfgminer.X5.KD5.BFGMinerKD5
+    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.BFGMinerKDMax
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+

docs/miners/innosilicon/A10X.md

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

docs/miners/innosilicon/T3X.md

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

docs/miners/miner_factory.md

@@ -1,6 +1,14 @@
 # pyasic
 ## Miner Factory
 
+[`MinerFactory`][pyasic.miners.miner_factory.MinerFactory] is the way to create miner types in `pyasic`.  The most important method is [`get_miner()`][pyasic.get_miner], which is mapped to [`pyasic.get_miner()`][pyasic.get_miner], and should be used from there.
+
+The instance used for [`pyasic.get_miner()`][pyasic.get_miner] is `pyasic.miner_factory`.
+
+[`MinerFactory`][pyasic.MinerFactory] also keeps a cache, which can be cleared if needed with `pyasic.miner_factory.clear_cached_miners()`.
+
+Finally, there is functionality to get multiple miners without using `asyncio.gather()` explicitly.  Use `pyasic.miner_factory.get_multiple_miners()` with a list of IPs as strings to get a list of miner instances.  You can also get multiple miners with an `AsyncGenerator` by using `pyasic.miner_factory.get_miner_generator()`.
+
 ::: pyasic.miners.miner_factory.MinerFactory
     handler: python
     options:
@@ -8,6 +16,14 @@
         heading_level: 4
 <br>
 
+## Get Miner
+::: pyasic.miners.get_miner
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+<br>
+
 ## AnyMiner
 ::: pyasic.miners.miner_factory.AnyMiner
     handler: python

docs/miners/supported_types.md

@@ -11,37 +11,74 @@ details {
     padding-bottom:0px;
 }
 </style>
-<details style="margin:0px; padding-top:0px; padding-bottom:0px;">
-<summary>Braiins OS+ Devices:</summary>
+
+<details>
+<summary>Stock Firmware Antminers:</summary>
     <ul>
         <details>
-            <summary>X19 Series:</summary>
+            <summary>X3 Series:</summary>
                 <ul>
-                    <li><a href="../antminer/X19#s19-bos">S19</a></li>
-                    <li><a href="../antminer/X19#s19-pro-bos">S19 Pro</a></li>
-                    <li><a href="../antminer/X19#s19j-bos">S19j</a></li>
-                    <li><a href="../antminer/X19#s19j-pro-bos">S19j Pro</a></li>
-                    <li><a href="../antminer/X19#t19-bos">T19</a></li>
+                    <li><a href="../antminer/X3#d3">D3</a></li>
+                    <li><a href="../antminer/X3#hs3">HS3</a></li>
+                    <li><a href="../antminer/X3#l3_1">L3+</a></li>
                 </ul>
         </details>
         <details>
-            <summary>X17 Series:</summary>
+            <summary>X5 Series:</summary>
                 <ul>
-                    <li><a href="../antminer/X17#s17-bos">S17</a></li>
-                    <li><a href="../antminer/X17#s17-plus-bos">S17+</a></li>
-                    <li><a href="../antminer/X17#s17-pro-bos">S17 Pro</a></li>
-                    <li><a href="../antminer/X17#s17e-bos">S17e</a></li>
-                    <li><a href="../antminer/X17#t17-bos">T17</a></li>
-                    <li><a href="../antminer/X17#t17-plus-bos">T17+</a></li>
-                    <li><a href="../antminer/X17#t17e-bos">T17e</a></li>
+                    <li><a href="../antminer/X5#dr5">DR5</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X7 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X7#l7">L7</a></li>
                 </ul>
         </details>
         <details>
             <summary>X9 Series:</summary>
                 <ul>
-                    <li><a href="../antminer/X9#s9-bos">S9</a></li>
-                    <li><a href="../antminer/X9#s9-bos">S9i</a></li>
-                    <li><a href="../antminer/X9#s9-bos">S9j</a></li>
+                    <li><a href="../antminer/X9#e9pro">E9Pro</a></li>
+                    <li><a href="../antminer/X9#s9">S9</a></li>
+                    <li><a href="../antminer/X9#s9i">S9i</a></li>
+                    <li><a href="../antminer/X9#s9j">S9j</a></li>
+                    <li><a href="../antminer/X9#t9">T9</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X15 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X15#z15">Z15</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X17 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X17#s17">S17</a></li>
+                    <li><a href="../antminer/X17#s17_1">S17+</a></li>
+                    <li><a href="../antminer/X17#s17-pro">S17 Pro</a></li>
+                    <li><a href="../antminer/X17#s17e">S17e</a></li>
+                    <li><a href="../antminer/X17#t17">T17</a></li>
+                    <li><a href="../antminer/X17#t17_1">T17+</a></li>
+                    <li><a href="../antminer/X17#t17e">T17e</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19">S19</a></li>
+                    <li><a href="../antminer/X19#s19l">S19L</a></li>
+                    <li><a href="../antminer/X19#s19-pro">S19 Pro</a></li>
+                    <li><a href="../antminer/X19#s19j">S19j</a></li>
+                    <li><a href="../antminer/X19#s19i">S19i</a></li>
+                    <li><a href="../antminer/X19#s19_1">S19+</a></li>
+                    <li><a href="../antminer/X19#s19j-no-pic">S19j No PIC</a></li>
+                    <li><a href="../antminer/X19#s19-pro_1">S19 Pro+</a></li>
+                    <li><a href="../antminer/X19#s19j-pro">S19j Pro</a></li>
+                    <li><a href="../antminer/X19#s19-xp">S19 XP</a></li>
+                    <li><a href="../antminer/X19#s19a">S19a</a></li>
+                    <li><a href="../antminer/X19#s19a-pro">S19a Pro</a></li>
+                    <li><a href="../antminer/X19#t19">T19</a></li>
                 </ul>
         </details>
     </ul>
@@ -51,440 +88,210 @@ details {
     <ul>
         <details>
             <summary>M2X Series:</summary>
-            <ul>
-                <details>
-                    <summary><a href='../whatsminer/M2X/#M20'>M20</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M2X/#M20V10'>M20V10</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M2X/#M20S'>M20S</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M2X/#M20SV10'>M20SV10</a></li>
-                        <li><a href='../whatsminer/M2X/#M20SV20'>M20SV20</a></li>
-                        <li><a href='../whatsminer/M2X/#M20SV30'>M20SV30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M2X/#M20S_1'>M20S+</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M2X/#M20S_1V30'>M20S+V30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M2X/#M21'>M21</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M2X/#M21V10'>M21V10</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M2X/#M21S'>M21S</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M2X/#M21SV20'>M21SV20</a></li>
-                        <li><a href='../whatsminer/M2X/#M21SV60'>M21SV60</a></li>
-                        <li><a href='../whatsminer/M2X/#M21SV70'>M21SV70</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M2X/#M21S_1'>M21S+</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M2X/#M21S_1V20'>M21S+V20</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M2X/#M29'>M29</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M2X/#M29V10'>M29V10</a></li>
-                    </ul>
-                </details>
-            </ul>
+                <ul>
+                    <li><a href="../whatsminer/M2X#m20-v10">M20 V10</a></li>
+                    <li><a href="../whatsminer/M2X#m20s-v10">M20S V10</a></li>
+                    <li><a href="../whatsminer/M2X#m20s-v20">M20S V20</a></li>
+                    <li><a href="../whatsminer/M2X#m20s-v30">M20S V30</a></li>
+                    <li><a href="../whatsminer/M2X#m20p-v10">M20P V10</a></li>
+                    <li><a href="../whatsminer/M2X#m20p-v30">M20P V30</a></li>
+                    <li><a href="../whatsminer/M2X#m20s_1-v30">M20S+ V30</a></li>
+                    <li><a href="../whatsminer/M2X#m21-v10">M21 V10</a></li>
+                    <li><a href="../whatsminer/M2X#m21s-v20">M21S V20</a></li>
+                    <li><a href="../whatsminer/M2X#m21s-v60">M21S V60</a></li>
+                    <li><a href="../whatsminer/M2X#m21s-v70">M21S V70</a></li>
+                    <li><a href="../whatsminer/M2X#m21s_1-v20">M21S+ V20</a></li>
+                    <li><a href="../whatsminer/M2X#m29-v10">M29 V10</a></li>
+                </ul>
         </details>
         <details>
             <summary>M3X Series:</summary>
-            <ul>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M30'>M30</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M30V10'>M30V10</a></li>
-                        <li><a href='../whatsminer/M3X/#M30V20'>M30V20</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M30S'>M30S</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M30SV10'>M30SV10</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SV20'>M30SV20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SV30'>M30SV30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SV40'>M30SV40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SV50'>M30SV50</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SV60'>M30SV60</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SV70'>M30SV70</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SV80'>M30SV80</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVE10'>M30SVE10</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVE20'>M30SVE20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVE30'>M30SVE30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVE40'>M30SVE40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVE50'>M30SVE50</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVE60'>M30SVE60</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVE70'>M30SVE70</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVF10'>M30SVF10</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVF20'>M30SVF20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVF30'>M30SVF30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVG10'>M30SVG10</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVG20'>M30SVG20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVG30'>M30SVG30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVG40'>M30SVG40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVH10'>M30SVH10</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVH20'>M30SVH20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVH30'>M30SVH30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVH40'>M30SVH40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVH50'>M30SVH50</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVH60'>M30SVH60</a></li>
-                        <li><a href='../whatsminer/M3X/#M30SVI20'>M30SVI20</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M30S_1'>M30S+</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M30S_1V10'>M30S+V10</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1V20'>M30S+V20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1V30'>M30S+V30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1V40'>M30S+V40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1V50'>M30S+V50</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1V60'>M30S+V60</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1V70'>M30S+V70</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1V80'>M30S+V80</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1V90'>M30S+V90</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1V100'>M30S+V100</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VE30'>M30S+VE30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VE40'>M30S+VE40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VE50'>M30S+VE50</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VE60'>M30S+VE60</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VE70'>M30S+VE70</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VE80'>M30S+VE80</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VE90'>M30S+VE90</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VE100'>M30S+VE100</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VF20'>M30S+VF20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VF30'>M30S+VF30</a></li>
-                        <li><a href='../whatsminer/M3X/#M36S_1VG30'>M36S+VG30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VG30'>M30S+VG30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VG40'>M30S+VG40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VG50'>M30S+VG50</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VG60'>M30S+VG60</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VH10'>M30S+VH10</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VH20'>M30S+VH20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VH30'>M30S+VH30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VH40'>M30S+VH40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VH50'>M30S+VH50</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_1VH60'>M30S+VH60</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M30S_2'>M30S++</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M30S_2V10'>M30S++V10</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2V20'>M30S++V20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VE30'>M30S++VE30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VE40'>M30S++VE40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VE50'>M30S++VE50</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VF40'>M30S++VF40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VG30'>M30S++VG30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VG40'>M30S++VG40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VG50'>M30S++VG50</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VH10'>M30S++VH10</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VH20'>M30S++VH20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VH30'>M30S++VH30</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VH40'>M30S++VH40</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VH50'>M30S++VH50</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VH60'>M30S++VH60</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VH70'>M30S++VH70</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VH80'>M30S++VH80</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VH90'>M30S++VH90</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VH100'>M30S++VH100</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VJ20'>M30S++VJ20</a></li>
-                        <li><a href='../whatsminer/M3X/#M30S_2VJ30'>M30S++VJ30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M31'>M31</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M31V10'>M31V10</a></li>
-                        <li><a href='../whatsminer/M3X/#M31V20'>M31V20</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M31S'>M31S</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M31SV10'>M31SV10</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SV20'>M31SV20</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SV30'>M31SV30</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SV40'>M31SV40</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SV50'>M31SV50</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SV60'>M31SV60</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SV70'>M31SV70</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SV80'>M31SV80</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SV90'>M31SV90</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SVE10'>M31SVE10</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SVE20'>M31SVE20</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SVE30'>M31SVE30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M31SE'>M31SE</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M31SEV10'>M31SEV10</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SEV20'>M31SEV20</a></li>
-                        <li><a href='../whatsminer/M3X/#M31SEV30'>M31SEV30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M31H'>M31H</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M31HV40'>M31HV40</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M31S_1'>M31S+</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M31S_1V10'>M31S+V10</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1V20'>M31S+V20</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1V30'>M31S+V30</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1V40'>M31S+V40</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1V50'>M31S+V50</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1V60'>M31S+V60</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1V80'>M31S+V80</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1V90'>M31S+V90</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1V100'>M31S+V100</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VE10'>M31S+VE10</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VE20'>M31S+VE20</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VE30'>M31S+VE30</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VE40'>M31S+VE40</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VE50'>M31S+VE50</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VE60'>M31S+VE60</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VE80'>M31S+VE80</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VF20'>M31S+VF20</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VF30'>M31S+VF30</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VG20'>M31S+VG20</a></li>
-                        <li><a href='../whatsminer/M3X/#M31S_1VG30'>M31S+VG30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M32'>M32</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M32V10'>M32V10</a></li>
-                        <li><a href='../whatsminer/M3X/#M32V20'>M32V20</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M33'>M33</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M33V10'>M33V10</a></li>
-                        <li><a href='../whatsminer/M3X/#M33V20'>M33V20</a></li>
-                        <li><a href='../whatsminer/M3X/#M33V30'>M33V30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M33S'>M33S</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M33SVG30'>M33SVG30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M33S_1'>M33S+</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M33S_1VH20'>M33S+VH20</a></li>
-                        <li><a href='../whatsminer/M3X/#M33S_1VH30'>M33S+VH30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M33S_2'>M33S++</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M33S_2VH20'>M33S++VH20</a></li>
-                        <li><a href='../whatsminer/M3X/#M33S_2VH30'>M33S++VH30</a></li>
-                        <li><a href='../whatsminer/M3X/#M33S_2VG40'>M33S++VG40</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M34S_1'>M34S+</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M34S_1VE10'>M34S+VE10</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M36S'>M36S</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M36SVE10'>M36SVE10</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M36S_1'>M36S+</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M36S_1VG30'>M36S+VG30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M36S_2'>M36S++</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M36S_2VH30'>M36S++VH30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M3X/#M39'>M39</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M3X/#M39V20'>M39V20</a></li>
-                    </ul>
-                </details>
-            </ul>
+                <ul>
+                    <li><a href="../whatsminer/M3X#m30-v10">M30 V10</a></li>
+                    <li><a href="../whatsminer/M3X#m30-v20">M30 V20</a></li>
+                    <li><a href="../whatsminer/M3X#m30k-v10">M30K V10</a></li>
+                    <li><a href="../whatsminer/M3X#m30l-v10">M30L V10</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v10">M30S V10</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v20">M30S V20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v30">M30S V30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v40">M30S V40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v50">M30S V50</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v60">M30S V60</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v70">M30S V70</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v80">M30S V80</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve10">M30S VE10</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve20">M30S VE20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve30">M30S VE30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve40">M30S VE40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve50">M30S VE50</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve60">M30S VE60</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve70">M30S VE70</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vf10">M30S VF10</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vf20">M30S VF20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vf30">M30S VF30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vg10">M30S VG10</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vg20">M30S VG20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vg30">M30S VG30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vg40">M30S VG40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh10">M30S VH10</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh20">M30S VH20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh30">M30S VH30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh40">M30S VH40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh50">M30S VH50</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh60">M30S VH60</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vi20">M30S VI20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v10">M30S+ V10</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v20">M30S+ V20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v30">M30S+ V30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v40">M30S+ V40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v50">M30S+ V50</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v60">M30S+ V60</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v70">M30S+ V70</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v80">M30S+ V80</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v90">M30S+ V90</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v100">M30S+ V100</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve30">M30S+ VE30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve40">M30S+ VE40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve50">M30S+ VE50</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve60">M30S+ VE60</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve70">M30S+ VE70</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve80">M30S+ VE80</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve90">M30S+ VE90</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve100">M30S+ VE100</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vf20">M30S+ VF20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vf30">M30S+ VF30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vg20">M30S+ VG20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vg30">M30S+ VG30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vg40">M30S+ VG40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vg50">M30S+ VG50</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vg60">M30S+ VG60</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh10">M30S+ VH10</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh20">M30S+ VH20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh30">M30S+ VH30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh40">M30S+ VH40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh50">M30S+ VH50</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh60">M30S+ VH60</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-v10">M30S++ V10</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-v20">M30S++ V20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-ve30">M30S++ VE30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-ve40">M30S++ VE40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-ve50">M30S++ VE50</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vf40">M30S++ VF40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vg30">M30S++ VG30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vg40">M30S++ VG40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vg50">M30S++ VG50</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh10">M30S++ VH10</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh20">M30S++ VH20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh30">M30S++ VH30</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh40">M30S++ VH40</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh50">M30S++ VH50</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh60">M30S++ VH60</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh70">M30S++ VH70</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh80">M30S++ VH80</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh90">M30S++ VH90</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh100">M30S++ VH100</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vj20">M30S++ VJ20</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vj30">M30S++ VJ30</a></li>
+                    <li><a href="../whatsminer/M3X#m31-v10">M31 V10</a></li>
+                    <li><a href="../whatsminer/M3X#m31-v20">M31 V20</a></li>
+                    <li><a href="../whatsminer/M3X#m31h-v10">M31H V10</a></li>
+                    <li><a href="../whatsminer/M3X#m31h-v40">M31H V40</a></li>
+                    <li><a href="../whatsminer/M3X#m30l-v10">M30L V10</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v10">M31S V10</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v20">M31S V20</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v30">M31S V30</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v40">M31S V40</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v50">M31S V50</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v60">M31S V60</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v70">M31S V70</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v80">M31S V80</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v90">M31S V90</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-ve10">M31S VE10</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-ve20">M31S VE20</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-ve30">M31S VE30</a></li>
+                    <li><a href="../whatsminer/M3X#m31se-v10">M31SE V10</a></li>
+                    <li><a href="../whatsminer/M3X#m31se-v20">M31SE V20</a></li>
+                    <li><a href="../whatsminer/M3X#m31se-v30">M31SE V30</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v10">M31S+ V10</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v20">M31S+ V20</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v30">M31S+ V30</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v40">M31S+ V40</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v50">M31S+ V50</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v60">M31S+ V60</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v80">M31S+ V80</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v90">M31S+ V90</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v100">M31S+ V100</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve10">M31S+ VE10</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve20">M31S+ VE20</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve30">M31S+ VE30</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve40">M31S+ VE40</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve50">M31S+ VE50</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve60">M31S+ VE60</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve80">M31S+ VE80</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-vf20">M31S+ VF20</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-vf30">M31S+ VF30</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-vg20">M31S+ VG20</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-vg30">M31S+ VG30</a></li>
+                    <li><a href="../whatsminer/M3X#m32-v10">M32 V10</a></li>
+                    <li><a href="../whatsminer/M3X#m32-v20">M32 V20</a></li>
+                    <li><a href="../whatsminer/M3X#m33-v10">M33 V10</a></li>
+                    <li><a href="../whatsminer/M3X#m33-v20">M33 V20</a></li>
+                    <li><a href="../whatsminer/M3X#m33-v30">M33 V30</a></li>
+                    <li><a href="../whatsminer/M3X#m33s-vg30">M33S VG30</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1-vg20">M33S+ VG20</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1-vh20">M33S+ VH20</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1-vh30">M33S+ VH30</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1_1-vh20">M33S++ VH20</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1_1-vh30">M33S++ VH30</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1_1-vg40">M33S++ VG40</a></li>
+                    <li><a href="../whatsminer/M3X#m34s_1-ve10">M34S+ VE10</a></li>
+                    <li><a href="../whatsminer/M3X#m36s-ve10">M36S VE10</a></li>
+                    <li><a href="../whatsminer/M3X#m36s_1-vg30">M36S+ VG30</a></li>
+                    <li><a href="../whatsminer/M3X#m36s_1_1-vh30">M36S++ VH30</a></li>
+                    <li><a href="../whatsminer/M3X#m39-v10">M39 V10</a></li>
+                    <li><a href="../whatsminer/M3X#m39-v20">M39 V20</a></li>
+                    <li><a href="../whatsminer/M3X#m39-v30">M39 V30</a></li>
+                </ul>
         </details>
         <details>
             <summary>M5X Series:</summary>
-            <ul>
-                <details>
-                    <summary><a href='../whatsminer/M5X/#M50'>M50</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M5X/#M50VG30'>M50VG30</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VH10'>M50VH10</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VH20'>M50VH20</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VH30'>M50VH30</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VH40'>M50VH40</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VH50'>M50VH50</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VH60'>M50VH60</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VH70'>M50VH70</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VH80'>M50VH80</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VJ10'>M50VJ10</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VJ20'>M50VJ20</a></li>
-                        <li><a href='../whatsminer/M5X/#M50VJ30'>M50VJ30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M5X/#M50S'>M50S</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M5X/#M50SVJ10'>M50SVJ10</a></li>
-                        <li><a href='../whatsminer/M5X/#M50SVJ20'>M50SVJ20</a></li>
-                        <li><a href='../whatsminer/M5X/#M50SVJ30'>M50SVJ30</a></li>
-                        <li><a href='../whatsminer/M5X/#M50SVH10'>M50SVH10</a></li>
-                        <li><a href='../whatsminer/M5X/#M50SVH20'>M50SVH20</a></li>
-                        <li><a href='../whatsminer/M5X/#M50SVH30'>M50SVH30</a></li>
-                        <li><a href='../whatsminer/M5X/#M50SVH40'>M50SVH40</a></li>
-                        <li><a href='../whatsminer/M5X/#M50SVH50'>M50SVH50</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M5X/#M50S_1'>M50S+</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M5X/#M50S_1VH30'>M50S+VH30</a></li>
-                        <li><a href='../whatsminer/M5X/#M50S_1VH40'>M50S+VH40</a></li>
-                        <li><a href='../whatsminer/M5X/#M50S_1VJ30'>M50S+VJ30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M5X/#M53'>M53</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M5X/#M53VH30'>M53VH30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M5X/#M53S'>M53S</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M5X/#M53SVH30'>M53SVH30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M5X/#M53S_1'>M53S+</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M5X/#M53S_1VJ30'>M53S+VJ30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M5X/#M56'>M56</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M5X/#M56VH30'>M56VH30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M5X/#M56S'>M56S</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M5X/#M56SVH30'>M56SVH30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M5X/#M56S_1'>M56S+</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M5X/#M56S_1VJ30'>M56S+VJ30</a></li>
-                    </ul>
-                </details>
-                <details>
-                    <summary><a href='../whatsminer/M5X/#M59'>M59</a></summary>
-                    <ul>
-                        <li><a href='../whatsminer/M5X/#M59VH30'>M59VH30</a></li>
-                    </ul>
-                </details>
-            </ul>
-        </details>
-    </ul>
-</details>
-
-<details>
-<summary>Stock Firmware Antminers:</summary>
-    <ul>
-        <details>
-        <summary>X19 Series:</summary>
-            <ul>
-                <li><a href="../antminer/X19/#s19">S19</a></li>
-                <li><a href="../antminer/X19/#s19l">S19L</a></li>
-                <li><a href="../antminer/X19/#s19-pro">S19 Pro</a></li>
-                <li><a href="../antminer/X19/#s19a">S19a</a></li>
-                <li><a href="../antminer/X19/#s19j">S19j</a></li>
-                <li><a href="../antminer/X19/#s19j-pro">S19j Pro</a></li>
-                <li><a href="../antminer/X19/#s19-xp">S19 XP</a></li>
-                <li><a href="../antminer/X19/#t19">T19</a></li>
-            </ul>
-        </details>
-        <details>
-        <summary>X17 Series:</summary>
-            <ul>
-                <li><a href="../antminer/X17/#s17">S17</a></li>
-                <li><a href="../antminer/X17/#s17_1">S17+</a></li>
-                <li><a href="../antminer/X17/#s17-pro">S17 Pro</a></li>
-                <li><a href="../antminer/X17/#s17e">S17e</a></li>
-                <li><a href="../antminer/X17/#t17">T17</a></li>
-                <li><a href="../antminer/X17/#t17_1">T17+</a></li>
-                <li><a href="../antminer/X17/#t17e">T17e</a></li>
-            </ul>
-        </details>
-        <details>
-        <summary>X15 Series:</summary>
-            <ul>
-                <li><a href="../antminer/X15/#z15">Z15</a></li>
-            </ul>
-        </details>
-        <details>
-        <summary>X9 Series:</summary>
-            <ul>
-                <li><a href="../antminer/X9/#s9">S9</a></li>
-                <li><a href="../antminer/X9/#s9i">S9i</a></li>
-                <li><a href="../antminer/X9/#t9">T9</a></li>
-                <li><a href="../antminer/X9/#e9-pro">E9 Pro</a></li>
-            </ul>
-        </details>
-        <details>
-        <summary>X7 Series:</summary>
-            <ul>
-                <li><a href="../antminer/X7/#l7">L7</a></li>
-            </ul>
-        </details>
-        <details>
-        <summary>X5 Series:</summary>
-            <ul>
-                <li><a href="../antminer/X5/#dr5">DR5</a></li>
-            </ul>
-        </details>
-        <details>
-        <summary>X3 Series:</summary>
-            <ul>
-                <li><a href="../antminer/X3/#hs3">HS3</a></li>
-            </ul>
+                <ul>
+                    <li><a href="../whatsminer/M5X#m50-ve30">M50 VE30</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vg30">M50 VG30</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh10">M50 VH10</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh20">M50 VH20</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh30">M50 VH30</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh40">M50 VH40</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh50">M50 VH50</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh60">M50 VH60</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh70">M50 VH70</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh80">M50 VH80</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vj10">M50 VJ10</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vj20">M50 VJ20</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vj30">M50 VJ30</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vj10">M50S VJ10</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vj20">M50S VJ20</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vj30">M50S VJ30</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vh10">M50S VH10</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vh20">M50S VH20</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vh30">M50S VH30</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vh40">M50S VH40</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vh50">M50S VH50</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vh30">M50S+ VH30</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vh40">M50S+ VH40</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vj30">M50S+ VJ30</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vk20">M50S+ VK20</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vk10">M50S++ VK10</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vk20">M50S++ VK20</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vk30">M50S++ VK30</a></li>
+                    <li><a href="../whatsminer/M5X#m53-vh30">M53 VH30</a></li>
+                    <li><a href="../whatsminer/M5X#m53s-vh30">M53S VH30</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1-vj30">M53S+ VJ30</a></li>
+                    <li><a href="../whatsminer/M5X#m56-vh30">M56 VH30</a></li>
+                    <li><a href="../whatsminer/M5X#m56s-vh30">M56S VH30</a></li>
+                    <li><a href="../whatsminer/M5X#m56s_1-vj30">M56S+ VJ30</a></li>
+                    <li><a href="../whatsminer/M5X#m59-vh30">M59 VH30</a></li>
+                </ul>
         </details>
     </ul>
 </details>
@@ -492,75 +299,185 @@ details {
 <summary>Stock Firmware Avalonminers:</summary>
     <ul>
         <details>
-        <summary>A7X Series:</summary>
-            <ul>
-                <li><a href="../avalonminer/A7X/#a721">A721</a></li>
-                <li><a href="../avalonminer/A7X/#a741">A741</a></li>
-                <li><a href="../avalonminer/A7X/#a761">A761</a></li>
-            </ul>
+            <summary>A7X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A7X#avalon-721">Avalon 721</a></li>
+                    <li><a href="../avalonminer/A7X#avalon-741">Avalon 741</a></li>
+                    <li><a href="../avalonminer/A7X#avalon-761">Avalon 761</a></li>
+                </ul>
         </details>
         <details>
-        <summary>A8X Series:</summary>
-            <ul>
-                <li><a href="../avalonminer/A8X/#a821">A821</a></li>
-                <li><a href="../avalonminer/A8X/#a841">A841</a></li>
-                <li><a href="../avalonminer/A8X/#a851">A851</a></li>
-            </ul>
+            <summary>A8X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A8X#avalon-821">Avalon 821</a></li>
+                    <li><a href="../avalonminer/A8X#avalon-841">Avalon 841</a></li>
+                    <li><a href="../avalonminer/A8X#avalon-851">Avalon 851</a></li>
+                </ul>
         </details>
         <details>
-        <summary>A9X Series:</summary>
-            <ul>
-                <li><a href="../avalonminer/A9X/#a921">A921</a></li>
-            </ul>
+            <summary>A9X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A9X#avalon-921">Avalon 921</a></li>
+                </ul>
         </details>
         <details>
-        <summary>A10X Series:</summary>
-            <ul>
-                <li><a href="../avalonminer/A10X/#a1026">A1026</a></li>
-                <li><a href="../avalonminer/A10X/#a1047">A1047</a></li>
-                <li><a href="../avalonminer/A10X/#a1066">A1066</a></li>
-            </ul>
+            <summary>A10X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A10X#avalon-1026">Avalon 1026</a></li>
+                    <li><a href="../avalonminer/A10X#avalon-1047">Avalon 1047</a></li>
+                    <li><a href="../avalonminer/A10X#avalon-1066">Avalon 1066</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>A11X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A11X#avalon-1166-pro">Avalon 1166 Pro</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>A12X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A12X#avalon-1246">Avalon 1246</a></li>
+                </ul>
         </details>
     </ul>
 </details>
 <details>
-<summary>Stock Firmware Innosilicon Miners:</summary>
+<summary>Stock Firmware Innosilicons:</summary>
     <ul>
         <details>
-        <summary>T3X Series:</summary>
-            <ul>
-                <li><a href="../innosilicon/T3X/#t3h">T3H+</a></li>
-            </ul>
+            <summary>T3X Series:</summary>
+                <ul>
+                    <li><a href="../innosilicon/T3X#t3h_1">T3H+</a></li>
+                </ul>
         </details>
         <details>
-        <summary>A10X Series:</summary>
-            <ul>
-                <li><a href="../innosilicon/A10X/#a10x">A10X</a></li>
-            </ul>
+            <summary>A10X Series:</summary>
+                <ul>
+                    <li><a href="../innosilicon/A10X#a10x">A10X</a></li>
+                </ul>
         </details>
     </ul>
 </details>
 <details>
-<summary>Stock Firmware Goldshell Miners:</summary>
+<summary>Stock Firmware Goldshells:</summary>
     <ul>
         <details>
-        <summary>CKX Series:</summary>
-            <ul>
-                <li><a href="../goldshell/CKX/#ck5">CK5</a></li>
-            </ul>
+            <summary>X5 Series:</summary>
+                <ul>
+                    <li><a href="../goldshell/X5#ck5">CK5</a></li>
+                    <li><a href="../goldshell/X5#hs5">HS5</a></li>
+                    <li><a href="../goldshell/X5#kd5">KD5</a></li>
+                </ul>
         </details>
         <details>
-        <summary>HSX Series:</summary>
-            <ul>
-                <li><a href="../goldshell/HSX/#hs5">HS5</a></li>
-            </ul>
-        </details>
-        <details>
-        <summary>KDX Series:</summary>
-            <ul>
-                <li><a href="../goldshell/KDX/#kd5">KD5</a></li>
-                <li><a href="../goldshell/KDX/#kd-max">KD Max</a></li>
-            </ul>
+            <summary>XMax Series:</summary>
+                <ul>
+                    <li><a href="../goldshell/XMax#kd-max">KD Max</a></li>
+                </ul>
         </details>
     </ul>
 </details>
+<details>
+<summary>BOS+ Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X9 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X9#s9-bos">S9 (BOS)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X17 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X17#s17-bos">S17 (BOS)</a></li>
+                    <li><a href="../antminer/X17#s17_1-bos">S17+ (BOS)</a></li>
+                    <li><a href="../antminer/X17#s17-pro-bos">S17 Pro (BOS)</a></li>
+                    <li><a href="../antminer/X17#s17e-bos">S17e (BOS)</a></li>
+                    <li><a href="../antminer/X17#t17-bos">T17 (BOS)</a></li>
+                    <li><a href="../antminer/X17#t17_1-bos">T17+ (BOS)</a></li>
+                    <li><a href="../antminer/X17#t17e-bos">T17e (BOS)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-bos">S19 (BOS)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-bos">S19 Pro (BOS)</a></li>
+                    <li><a href="../antminer/X19#s19j-bos">S19j (BOS)</a></li>
+                    <li><a href="../antminer/X19#s19j-no-pic-bos">S19j No PIC (BOS)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-bos">S19j Pro (BOS)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-bos">S19j Pro (BOS)</a></li>
+                    <li><a href="../antminer/X19#t19-bos">T19 (BOS)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Vnish Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X3 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X3#l3_1-vnish">L3+ (VNish)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X17 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X17#s17_1-vnish">S17+ (VNish)</a></li>
+                    <li><a href="../antminer/X17#s17-pro-vnish">S17 Pro (VNish)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-vnish">S19 (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19-no-pic-vnish">S19 No PIC (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-vnish">S19 Pro (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19j-vnish">S19j (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-vnish">S19j Pro (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19a-vnish">S19a (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19a-pro-vnish">S19a Pro (VNish)</a></li>
+                    <li><a href="../antminer/X19#t19-vnish">T19 (VNish)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>ePIC Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-epic">S19 (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-epic">S19 Pro (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19j-epic">S19j (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-epic">S19j Pro (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-epic">S19 XP (ePIC)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>HiveOS Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X9 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X9#t9-hiveon">T9 (Hiveon)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>LuxOS Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X9 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X9#s9-luxos">S9 (LuxOS)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>

docs/miners/whatsminer/M2X.md

@@ -1,90 +1,94 @@
 # pyasic
 ## M2X Models
 
-## M20V10
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M20.BTMinerM20V10
+## M20 V10
+::: pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20V10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20SV10
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M20S.BTMinerM20SV10
+## M20S V10
+::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20SV20
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M20S.BTMinerM20SV20
+## M20S V20
+::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20SV30
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M20S.BTMinerM20SV30
+## M20S V30
+::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M20S+V30
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlusV30
+## M20P V10
+::: pyasic.miners.whatsminer.btminer.M2X.M20P.BTMinerM20PV10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21V10
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M21.BTMinerM21V10
+## M20P V30
+::: pyasic.miners.whatsminer.btminer.M2X.M20P.BTMinerM20PV30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21SV20
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M21S.BTMinerM21SV20
+## M20S+ V30
+::: pyasic.miners.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlusV30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21SV60
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M21S.BTMinerM21SV60
+## M21 V10
+::: pyasic.miners.whatsminer.btminer.M2X.M21.BTMinerM21V10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21SV70
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M21S.BTMinerM21SV70
+## M21S V20
+::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M21S+V20
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlusV20
+## M21S V60
+::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV60
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M29V10
-
-::: pyasic.miners.btc.whatsminer.btminer.M2X.M29.BTMinerM29V10
+## M21S V70
+::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV70
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
+
+## M21S+ V20
+::: pyasic.miners.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlusV20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## 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,248 @@
 # pyasic
 ## M5X Models
 
-## M50VG30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VG30
+## M50 VE30
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VE30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH10
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH10
+## M50 VG30
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VG30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH20
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH20
+## M50 VH10
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH30
+## M50 VH20
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH40
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH40
+## M50 VH30
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH50
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH50
+## M50 VH40
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH40
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH60
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH60
+## M50 VH50
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH50
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH70
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH70
+## M50 VH60
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH60
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VH80
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH80
+## M50 VH70
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH70
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VJ10
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VJ10
+## M50 VH80
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH80
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VJ20
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VJ20
+## M50 VJ10
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50VJ30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VJ30
+## M50 VJ20
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVJ10
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ10
+## M50 VJ30
+::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVJ20
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ20
+## M50S VJ10
+::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVJ30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ30
+## M50S VJ20
+::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVH10
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVH10
+## M50S VJ30
+::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVH20
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVH20
+## M50S VH10
+::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVH30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVH30
+## M50S VH20
+::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVH40
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVH40
+## M50S VH30
+::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50SVH50
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVH50
+## M50S VH40
+::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH40
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50S+VH30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH30
+## M50S VH50
+::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH50
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50S+VH40
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH40
+## M50S+ VH30
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M50S+VJ30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVJ30
+## M50S+ VH40
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH40
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M53VH30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M53.BTMinerM53VH30
+## M50S+ VJ30
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVJ30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M53SVH30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M53S.BTMinerM53SVH30
+## M50S+ VK20
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVK20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M53S+VJ30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M53S_Plus.BTMinerM53SPlusVJ30
+## M50S++ VK10
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus_Plus.BTMinerM50SPlusPlusVK10
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M56VH30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M56.BTMinerM56VH30
+## M50S++ VK20
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus_Plus.BTMinerM50SPlusPlusVK20
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M56SVH30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M56S.BTMinerM56SVH30
+## M50S++ VK30
+::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus_Plus.BTMinerM50SPlusPlusVK30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M56S+VJ30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M56S_Plus.BTMinerM56SPlusVJ30
+## M53 VH30
+::: pyasic.miners.whatsminer.btminer.M5X.M53.BTMinerM53VH30
     handler: python
     options:
         show_root_heading: false
         heading_level: 4
 
-## M59VH30
-
-::: pyasic.miners.btc.whatsminer.btminer.M5X.M59.BTMinerM59VH30
+## M53S VH30
+::: pyasic.miners.whatsminer.btminer.M5X.M53S.BTMinerM53SVH30
     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
+
+## M56 VH30
+::: pyasic.miners.whatsminer.btminer.M5X.M56.BTMinerM56VH30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M56S VH30
+::: pyasic.miners.whatsminer.btminer.M5X.M56S.BTMinerM56SVH30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M56S+ VJ30
+::: pyasic.miners.whatsminer.btminer.M5X.M56S_Plus.BTMinerM56SPlusVJ30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M59 VH30
+::: pyasic.miners.whatsminer.btminer.M5X.M59.BTMinerM59VH30
+    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/settings/settings.md

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

mkdocs.yml

@@ -1,55 +1,61 @@
 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"
-          - BFGMiner: "miners/backends/bfgminer.md"
-          - BTMiner: "miners/backends/btminer.md"
-          - CGMiner: "miners/backends/cgminer.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"
-          - 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"
-          - Innosilicon A10X: "miners/innosilicon/A10X.md"
-          - Goldshell CKX: "miners/goldshell/CKX.md"
-          - Goldshell HSX: "miners/goldshell/HSX.md"
-          - Goldshell KDX: "miners/goldshell/KDX.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:
+    - Miner APIs:
+        - Intro: "API/api.md"
+        - BFGMiner: "API/bfgminer.md"
+        - BMMiner: "API/bmminer.md"
+        - BOSMiner: "API/bosminer.md"
+        - BTMiner: "API/btminer.md"
+        - CGMiner: "API/cgminer.md"
+        - LUXMiner: "API/luxminer.md"
+        - Unknown: "API/unknown.md"
+    - 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"
+        - 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"
+        - Innosilicon T3X: "miners/innosilicon/T3X.md"
+        - Innosilicon A10X: "miners/innosilicon/A10X.md"
+        - Goldshell X5: "miners/goldshell/X5.md"
+        - Goldshell XMax: "miners/goldshell/XMax.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/__init__.py

@@ -32,6 +32,8 @@ class BaseMinerAPI:
         # ip address of the miner
         self.ip = ipaddress.ip_address(ip)
 
+        self.pwd = "admin"
+
     def __new__(cls, *args, **kwargs):
         if cls is BaseMinerAPI:
             raise TypeError(f"Only children of '{cls.__name__}' may be instantiated")
@@ -46,6 +48,7 @@ class BaseMinerAPI:
         parameters: Union[str, int, bool] = None,
         ignore_errors: bool = False,
         allow_warning: bool = True,
+        **kwargs,
     ) -> dict:
         """Send an API command to the miner and return the result.
 
@@ -65,25 +68,30 @@ class BaseMinerAPI:
             else ""
         )
         # create the command
-        cmd = {"command": command}
+        cmd = {"command": command, **kwargs}
         if parameters:
             cmd["parameter"] = parameters
 
         # send the command
         data = await self._send_bytes(json.dumps(cmd).encode("utf-8"))
 
+        if data == b"Socket connect failed: Connection refused\n":
+            if not ignore_errors:
+                raise APIError(data.decode("utf-8"))
+            return {}
+
         data = self._load_api_data(data)
 
         # check for if the user wants to allow errors to return
-        if not ignore_errors:
-            # validate the command succeeded
-            validation = self._validate_command_output(data)
-            if not validation[0]:
-                if allow_warning:
-                    logging.warning(
-                        f"{self.ip}: API Command Error: {command}: {validation[1]}"
-                    )
+        validation = self._validate_command_output(data)
+        if not validation[0]:
+            if not ignore_errors:
+                # validate the command succeeded
                 raise APIError(validation[1])
+            if allow_warning:
+                logging.warning(
+                    f"{self.ip}: API Command Error: {command}: {validation[1]}"
+                )
 
         logging.debug(f"{self} - (Send Command) - Received data.")
         return data
@@ -92,30 +100,46 @@ class BaseMinerAPI:
     async def send_privileged_command(self, *args, **kwargs) -> dict:
         return await self.send_command(*args, **kwargs)
 
-    async def multicommand(
-        self, *commands: str, ignore_errors: bool = False, allow_warning: bool = True
-    ) -> dict:
+    async def multicommand(self, *commands: str, allow_warning: bool = True) -> dict:
         """Creates and sends multiple commands as one command to the miner.
 
         Parameters:
             *commands: The commands to send as a multicommand to the miner.
-            ignore_errors: Whether to raise APIError when the command returns an error.
             allow_warning: A boolean to supress APIWarnings.
 
         """
-        # make sure we can actually run each command, otherwise they will fail
-        commands = self._check_commands(*commands)
-        # standard multicommand format is "command1+command2"
-        # standard format doesn't work for X19
-        command = "+".join(commands)
+        while True:
+            # make sure we can actually run each command, otherwise they will fail
+            commands = self._check_commands(*commands)
+            # standard multicommand format is "command1+command2"
+            # standard format doesn't work for X19
+            command = "+".join(commands)
+            try:
+                data = await self.send_command(command, allow_warning=allow_warning)
+            except APIError as e:
+                # try to identify the error
+                if e.message is not None:
+                    if ":" in e.message:
+                        err_command = e.message.split(":")[0]
+                        if err_command in commands:
+                            commands.remove(err_command)
+                            continue
+                return {command: [{}] for command in commands}
+            logging.debug(f"{self} - (Multicommand) - Received data")
+            data["multicommand"] = True
+            return data
+
+    async def _handle_multicommand(self, command: str, allow_warning: bool = True):
         try:
-            data = await self.send_command(
-                command, allow_warning=allow_warning, ignore_errors=ignore_errors
-            )
+            data = await self.send_command(command, allow_warning=allow_warning)
+            if not "+" in command:
+                return {command: [data]}
+            return data
+
         except APIError:
-            return {command: [{}] for command in commands}
-        logging.debug(f"{self} - (Multicommand) - Received data")
-        return data
+            if "+" in command:
+                return {command: [{}] for command in command.split("+")}
+            return {command: [{}]}
 
     @property
     def commands(self) -> list:
@@ -160,7 +184,11 @@ If you are sure you want to use this command please use API.send_command("{comma
                 )
         return return_commands
 
-    async def _send_bytes(self, data: bytes, timeout: int = 100) -> bytes:
+    async def _send_bytes(
+        self,
+        data: bytes,
+        timeout: int = 100,
+    ) -> bytes:
         logging.debug(f"{self} - ([Hidden] Send Bytes) - Sending")
         try:
             # get reader and writer streams
@@ -178,14 +206,19 @@ If you are sure you want to use this command please use API.send_command("{comma
         writer.write(data)
         logging.debug(f"{self} - ([Hidden] Send Bytes) - Draining")
         await writer.drain()
-        ret_data = await asyncio.wait_for(reader.read(4096), timeout=timeout)
         try:
+            # TO address a situation where a whatsminer has an unknown PW -AND-
             # Fix for stupid whatsminer bug, reboot/restart seem to not load properly in the loop
             # have to receive, save the data, check if there is more data by reading with a short timeout
             # append that data if there is more, and then onto the main loop.
-            ret_data += await asyncio.wait_for(reader.read(1), timeout=1)
+            # the password timeout might need to be longer than 1, but it seems to work for now.
+            ret_data = await asyncio.wait_for(reader.read(1), timeout=1)
         except asyncio.TimeoutError:
-            return ret_data
+            return b"{}"
+        try:
+            ret_data += await asyncio.wait_for(reader.read(4096), timeout=timeout)
+        except ConnectionAbortedError:
+            return b"{}"
 
         # loop to receive all the data
         logging.debug(f"{self} - ([Hidden] Send Bytes) - Receiving")
@@ -224,13 +257,22 @@ If you are sure you want to use this command please use API.send_command("{comma
                             # this is an error
                             return False, f"{key}: " + data[key][0]["STATUS"][0]["Msg"]
         elif "id" not in data.keys():
+            if isinstance(data["STATUS"], list):
+                if data["STATUS"][0].get("STATUS", None) in ["S", "I"]:
+                    return True, None
+                else:
+                    return False, data["STATUS"][0]["Msg"]
+
             if data["STATUS"] not in ["S", "I"]:
                 return False, data["Msg"]
         else:
             # make sure the command succeeded
-            if type(data["STATUS"]) == str:
+            if isinstance(data["STATUS"], str):
                 if data["STATUS"] in ["RESTART"]:
                     return True, None
+            elif isinstance(data["STATUS"], dict):
+                if data["STATUS"].get("STATUS") in ["S", "I"]:
+                    return True, None
             elif data["STATUS"][0]["STATUS"] not in ("S", "I"):
                 # this is an error
                 if data["STATUS"][0]["STATUS"] not in ("S", "I"):

pyasic/API/bfgminer.py

@@ -13,7 +13,7 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-
+import asyncio
 import logging
 
 from pyasic.API import APIError, BaseMinerAPI
@@ -52,22 +52,23 @@ class BFGMinerAPI(BaseMinerAPI):
         except APIError:
             logging.debug(f"{self} - (Multicommand) - Handling X19 multicommand.")
             data = await self._x19_multicommand(*command.split("+"))
+        data["multicommand"] = True
         return data
 
-    async def _x19_multicommand(self, *commands):
-        data = None
-        try:
-            data = {}
-            # send all commands individually
-            for cmd in commands:
-                data[cmd] = []
-                data[cmd].append(await self.send_command(cmd, allow_warning=True))
-        except APIError:
-            pass
-        except Exception as e:
-            logging.warning(
-                f"{self} - ([Hidden] X19 Multicommand) - API Command Error {e}"
+    async def _x19_multicommand(self, *commands) -> dict:
+        tasks = []
+        # send all commands individually
+        for cmd in commands:
+            tasks.append(
+                asyncio.create_task(self._handle_multicommand(cmd, allow_warning=True))
             )
+
+        all_data = await asyncio.gather(*tasks)
+
+        data = {}
+        for item in all_data:
+            data.update(item)
+
         return data
 
     async def version(self) -> dict:

pyasic/API/bmminer.py

@@ -13,6 +13,7 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+import asyncio
 import logging
 
 from pyasic.API import APIError, BaseMinerAPI
@@ -53,24 +54,23 @@ class BMMinerAPI(BaseMinerAPI):
             data = await self._x19_multicommand(
                 *command.split("+"), allow_warning=allow_warning
             )
+        data["multicommand"] = True
         return data
 
-    async def _x19_multicommand(self, *commands, allow_warning: bool = True):
-        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}"
+    async def _x19_multicommand(self, *commands, allow_warning: bool = True) -> dict:
+        tasks = []
+        # send all commands individually
+        for cmd in commands:
+            tasks.append(
+                asyncio.create_task(self._handle_multicommand(cmd, allow_warning=True))
             )
+
+        all_data = await asyncio.gather(*tasks)
+
+        data = {}
+        for item in all_data:
+            data.update(item)
+
         return data
 
     async def version(self) -> dict:

pyasic/API/btminer.py

@@ -22,15 +22,15 @@ import hashlib
 import json
 import logging
 import re
-from typing import Union
+from typing import Literal, Union
 
 from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
 from passlib.handlers.md5_crypt import md5_crypt
 
+from pyasic import settings
 from pyasic.API import BaseMinerAPI
 from pyasic.errors import APIError
 from pyasic.misc import api_min_version
-from pyasic.settings import PyasicSettings
 
 ### IMPORTANT ###
 # you need to change the password of the miners using the Whatsminer
@@ -40,6 +40,12 @@ from pyasic.settings import PyasicSettings
 # you change the password, you can pass that to this class as pwd,
 # or add it as the Whatsminer_pwd in the settings.toml file.
 
+PrePowerOnMessage = Union[
+    Literal["wait for adjust temp"],
+    Literal["adjust complete"],
+    Literal["adjust continue"],
+]
+
 
 def _crypt(word: str, salt: str) -> str:
     """Encrypts a word with a salt, using a standard salt format.
@@ -186,7 +192,7 @@ class BTMinerAPI(BaseMinerAPI):
         ip: str,
         api_ver: str = "0.0.0",
         port: int = 4028,
-        pwd: str = PyasicSettings().global_whatsminer_password,
+        pwd: str = settings.get("default_whatsminer_password", "admin"),
     ):
         super().__init__(ip, port)
         self.pwd = pwd
@@ -203,27 +209,36 @@ class BTMinerAPI(BaseMinerAPI):
         # make sure we can actually run each command, otherwise they will fail
         commands = self._check_commands(*commands)
         # standard multicommand format is "command1+command2"
-        # commands starting with "get_" aren't supported, but we can fake that
-        get_commands_data = {}
+        # commands starting with "get_" and the "status" command aren't supported, but we can fake that
+
+        tasks = []
+
         for command in list(commands):
-            if command.startswith("get_"):
+            if command.startswith("get_") or command == "status":
                 commands.remove(command)
                 # send seperately and append later
-                try:
-                    get_commands_data[command] = [
-                        await self.send_command(command, allow_warning=allow_warning)
-                    ]
-                except APIError:
-                    get_commands_data[command] = [{}]
+                tasks.append(
+                    asyncio.create_task(
+                        self._handle_multicommand(command, allow_warning=allow_warning)
+                    )
+                )
 
         command = "+".join(commands)
-        try:
-            main_data = await self.send_command(command, allow_warning=allow_warning)
-        except APIError:
-            main_data = {command: [{}] for command in commands}
+        tasks.append(
+            asyncio.create_task(
+                self._handle_multicommand(command, allow_warning=allow_warning)
+            )
+        )
+
+        all_data = await asyncio.gather(*tasks)
+
         logging.debug(f"{self} - (Multicommand) - Received data")
 
-        data = dict(**main_data, **get_commands_data)
+        data = {}
+        for item in all_data:
+            data.update(item)
+
+        data["multicommand"] = True
         return data
 
     async def send_privileged_command(
@@ -472,6 +487,34 @@ class BTMinerAPI(BaseMinerAPI):
         """
         return await self.send_privileged_command("set_low_power")
 
+    async def set_high_power(self) -> dict:
+        """Set low power mode on the miner using the API.
+        <details>
+            <summary>Expand</summary>
+
+        Set low power mode on the miner using the API, only works after
+        changing the password of the miner using the Whatsminer tool.
+
+        Returns:
+            A reply informing of the status of setting low power mode.
+        </details>
+        """
+        return await self.send_privileged_command("set_high_power")
+
+    async def set_normal_power(self) -> dict:
+        """Set low power mode on the miner using the API.
+        <details>
+            <summary>Expand</summary>
+
+        Set low power mode on the miner using the API, only works after
+        changing the password of the miner using the Whatsminer tool.
+
+        Returns:
+            A reply informing of the status of setting low power mode.
+        </details>
+        """
+        return await self.send_privileged_command("set_normal_power")
+
     async def update_firmware(self):  # noqa - static
         """Not implemented."""
         # to be determined if this will be added later
@@ -684,7 +727,7 @@ class BTMinerAPI(BaseMinerAPI):
             )
         return await self.send_privileged_command("set_power_pct", percent=str(percent))
 
-    async def pre_power_on(self, complete: bool, msg: str) -> dict:
+    async def pre_power_on(self, complete: bool, msg: PrePowerOnMessage) -> dict:
         """Configure or check status of pre power on.
 
         <details>
@@ -704,7 +747,7 @@ class BTMinerAPI(BaseMinerAPI):
         </details>
         """
 
-        if not msg == "wait for adjust temp" or "adjust complete" or "adjust continue":
+        if msg not in ("wait for adjust temp", "adjust complete", "adjust continue"):
             raise APIError(
                 "Message is incorrect, please choose one of "
                 '["wait for adjust temp", '
@@ -720,6 +763,34 @@ class BTMinerAPI(BaseMinerAPI):
         )
 
     ### ADDED IN V2.0.5 Whatsminer API ###
+
+    @api_min_version("2.0.5")
+    async def set_power_pct_v2(self, percent: int) -> dict:
+        """Set the power percentage of the miner based on current power.  Used for temporary adjustment.  Added in API v2.0.5.
+
+        <details>
+            <summary>Expand</summary>
+
+        Set the power percentage of the miner, only works after changing
+        the password of the miner using the Whatsminer tool.
+
+        Parameters:
+            percent: The power percentage to set.
+        Returns:
+            A reply informing of the status of setting the power percentage.
+        </details>
+        """
+
+        if not 0 < percent < 100:
+            raise APIError(
+                f"Power PCT % is outside of the allowed "
+                f"range.  Please set a % between 0 and "
+                f"100"
+            )
+        return await self.send_privileged_command(
+            "set_power_pct_v2", percent=str(percent)
+        )
+
     @api_min_version("2.0.5")
     async def set_temp_offset(self, temp_offset: int) -> dict:
         """Set the offset of miner hash board target temperature.

pyasic/API/cgminer.py

@@ -13,7 +13,7 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-
+import asyncio
 import logging
 
 from pyasic.API import APIError, BaseMinerAPI
@@ -52,22 +52,23 @@ class CGMinerAPI(BaseMinerAPI):
         except APIError:
             logging.debug(f"{self} - (Multicommand) - Handling X19 multicommand.")
             data = await self._x19_multicommand(*command.split("+"))
+        data["multicommand"] = True
         return data
 
-    async def _x19_multicommand(self, *commands):
-        data = None
-        try:
-            data = {}
-            # send all commands individually
-            for cmd in commands:
-                data[cmd] = []
-                data[cmd].append(await self.send_command(cmd, allow_warning=True))
-        except APIError:
-            pass
-        except Exception as e:
-            logging.warning(
-                f"{self} - ([Hidden] X19 Multicommand) - API Command Error {e}"
+    async def _x19_multicommand(self, *commands) -> dict:
+        tasks = []
+        # send all commands individually
+        for cmd in commands:
+            tasks.append(
+                asyncio.create_task(self._handle_multicommand(cmd, allow_warning=True))
             )
+
+        all_data = await asyncio.gather(*tasks)
+
+        data = {}
+        for item in all_data:
+            data.update(item)
+
         return data
 
     async def version(self) -> dict:

pyasic/API/luxminer.py

@@ -0,0 +1,759 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+from typing import Literal
+
+from pyasic.API import BaseMinerAPI
+
+
+class LUXMinerAPI(BaseMinerAPI):
+    """An abstraction of the LUXMiner API.
+
+    Each method corresponds to an API command in LUXMiner.
+
+    [LUXMiner API documentation](https://docs.firmware.luxor.tech/API/intro)
+
+    This class abstracts use of the LUXMiner 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 addgroup(self, name: str, quota: int) -> dict:
+        """Add a pool group.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            name: The group name.
+            quota: The group quota.
+
+        Returns:
+            Confirmation of adding a pool group.
+        </details>
+        """
+        return await self.send_command("addgroup", parameters=f"{name},{quota}")
+
+    async def addpool(
+        self, url: str, user: str, pwd: str = "", group_id: str = None
+    ) -> dict:
+        """Add a pool.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            url: The pool url.
+            user: The pool username.
+            pwd: The pool password.
+            group_id: The group ID to use.
+
+        Returns:
+            Confirmation of adding a pool.
+        </details>
+        """
+        pool_data = [url, user, pwd]
+        if group_id is not None:
+            pool_data.append(group_id)
+        return await self.send_command("addpool", parameters=",".join(pool_data))
+
+    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 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 check(self, command: str) -> dict:
+        """Check if the command `command` exists in LUXMiner.
+        <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 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 config(self) -> dict:
+        """Get some basic configuration info.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            Miner configuration information.
+        </details>
+        """
+        return await self.send_command("config")
+
+    async def curtail(self, session_id: str) -> dict:
+        """Put the miner into sleep mode.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+
+        Returns:
+            A confirmation of putting the miner to sleep.
+        </details>
+        """
+        return await self.send_command("curtail", parameters=session_id)
+
+    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 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 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 edevs(self) -> dict:
+        """Alias for devs"""
+        return await self.devs()
+
+    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 estats(self) -> dict:
+        """Alias for stats"""
+        return await self.stats()
+
+    async def fans(self) -> dict:
+        """Get fan data.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            Data on the fans of the miner.
+        </details>
+        """
+        return await self.send_command("fans")
+
+    async def fanset(self, session_id: str, speed: int, min_fans: int = None) -> dict:
+        """Set fan control.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+            speed: The fan speed to set.  Use -1 to set automatically.
+            min_fans: The minimum number of fans to use. Optional.
+
+        Returns:
+            A confirmation of setting fan control values.
+        </details>
+        """
+        fanset_data = [str(session_id), str(speed)]
+        if min_fans is not None:
+            fanset_data.append(str(min_fans))
+        return await self.send_command("fanset", parameters=",".join(fanset_data))
+
+    async def frequencyget(self, board_n: int, chip_n: int = None) -> dict:
+        """Get frequency data for a board and chips.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            board_n: The board number to get frequency info from.
+            chip_n: The chip number to get frequency info from.  Optional.
+
+        Returns:
+            Board and/or chip frequency values.
+        </details>
+        """
+        frequencyget_data = [str(board_n)]
+        if chip_n is not None:
+            frequencyget_data.append(str(chip_n))
+        return await self.send_command(
+            "frequencyget", parameters=",".join(frequencyget_data)
+        )
+
+    async def frequencyset(self, session_id: str, board_n: int, freq: int) -> dict:
+        """Set frequency.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+            board_n: The board number to set frequency on.
+            freq: The frequency to set.
+
+        Returns:
+            A confirmation of setting frequency values.
+        </details>
+        """
+        return await self.send_command(
+            "frequencyset", parameters=f"{session_id},{board_n},{freq}"
+        )
+
+    async def frequencystop(self, session_id: str, board_n: int) -> dict:
+        """Stop set frequency.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+            board_n: The board number to set frequency on.
+
+        Returns:
+            A confirmation of stopping frequencyset value.
+        </details>
+        """
+        return await self.send_command(
+            "frequencystop", parameters=f"{session_id},{board_n}"
+        )
+
+    async def groupquota(self, group_n: int, quota: int) -> dict:
+        """Set a group's quota.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            group_n: The group number to set quota on.
+            quota: The quota to use.
+
+        Returns:
+            A confirmation of setting quota value.
+        </details>
+        """
+        return await self.send_command("groupquota", parameters=f"{group_n},{quota}")
+
+    async def groups(self) -> dict:
+        """Get pool group data.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            Data on the pool groups on the miner.
+        </details>
+        """
+        return await self.send_command("groups")
+
+    async def healthchipget(self, board_n: int, chip_n: int = None) -> dict:
+        """Get chip health.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            board_n: The board number to get chip health of.
+            chip_n: The chip number to get chip health of.  Optional.
+
+        Returns:
+            Chip health data.
+        </details>
+        """
+        healthchipget_data = [str(board_n)]
+        if chip_n is not None:
+            healthchipget_data.append(str(chip_n))
+        return await self.send_command(
+            "healthchipget", parameters=",".join(healthchipget_data)
+        )
+
+    async def healthchipset(
+        self, session_id: str, board_n: int, chip_n: int = None
+    ) -> dict:
+        """Select the next chip to have its health checked.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+            board_n: The board number to next get chip health of.
+            chip_n: The chip number to next get chip health of.  Optional.
+
+        Returns:
+            Confirmation of selecting the next health check chip.
+        </details>
+        """
+        healthchipset_data = [session_id, str(board_n)]
+        if chip_n is not None:
+            healthchipset_data.append(str(chip_n))
+        return await self.send_command(
+            "healthchipset", parameters=",".join(healthchipset_data)
+        )
+
+    async def healthctrl(self) -> dict:
+        """Get health check config.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            Health check config.
+        </details>
+        """
+        return await self.send_command("healthctrl")
+
+    async def healthctrlset(
+        self, session_id: str, num_readings: int, amplified_factor: float
+    ) -> dict:
+        """Set health control config.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+            num_readings: The minimum number of readings for evaluation.
+            amplified_factor: Performance factor of the evaluation.
+
+        Returns:
+            A confirmation of setting health control config.
+        </details>
+        """
+        return await self.send_command(
+            "healthctrlset",
+            parameters=f"{session_id},{num_readings},{amplified_factor}",
+        )
+
+    async def kill(self) -> dict:
+        """Forced session kill.  Use logoff instead.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            A confirmation of killing the active session.
+        </details>
+        """
+        return await self.send_command("kill")
+
+    async def lcd(self) -> dict:
+        """Get a general all-in-one status summary of the miner.  Always zeros on LUXMiner.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            An all-in-one status summary of the miner.
+        </details>
+        """
+        return await self.send_command("lcd")
+
+    async def ledset(
+        self,
+        session_id: str,
+        color: Literal["red"],
+        state: Literal["on", "off", "blink"],
+    ) -> dict:
+        """Set led.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+            color: The color LED to set.  Can be "red".
+            state: The state to set the LED to.  Can be "on", "off", or "blink".
+
+        Returns:
+            A confirmation of setting LED.
+        </details>
+        """
+        return await self.send_command(
+            "ledset", parameters=f"{session_id},{color},{state}"
+        )
+
+    async def limits(self) -> dict:
+        """Get max and min values of config parameters.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            Data on max and min values of config parameters.
+        </details>
+        """
+        return await self.send_command("limits")
+
+    async def logoff(self, session_id: str) -> dict:
+        """Log off of a session.  Requires a session id from an active session.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+
+        Returns:
+            Confirmation of logging off a session.
+        </details>
+        """
+        return await self.send_command("logoff", parameters=session_id)
+
+    async def logon(self) -> dict:
+        """Get or create a session.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            The Session ID to be used.
+        </details>
+        """
+        return await self.send_command("logon")
+
+    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 power(self) -> dict:
+        """Get the estimated power usage in watts.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            Estimated power usage in watts.
+        </details>
+        """
+        return await self.send_command("power")
+
+    async def profiles(self) -> dict:
+        """Get the available profiles.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            Data on available profiles.
+        </details>
+        """
+        return await self.send_command("profiles")
+
+    async def profileset(self, session_id: str, board_n: int, profile: str) -> dict:
+        """Set active profile for a board.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+            board_n: The board to set the profile on.
+            profile: The profile name to use.
+
+        Returns:
+            A confirmation of setting the profile on board_n.
+        </details>
+        """
+        return await self.send_command(
+            "profileset", parameters=f"{session_id},{board_n},{profile}"
+        )
+
+    async def reboot(self, session_id: str, board_n: int, delay_s: int = None) -> dict:
+        """Reboot a board.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+            board_n: The board to reboot.
+            delay_s: The number of seconds to delay until startup.  If it is 0, the board will just stop.  Optional.
+
+        Returns:
+            A confirmation of rebooting board_n.
+        </details>
+        """
+        reboot_data = [session_id, str(board_n)]
+        if delay_s is not None:
+            reboot_data.append(str(delay_s))
+        return await self.send_command("reboot", parameters=",".join(reboot_data))
+
+    async def rebootdevice(self, session_id: str) -> dict:
+        """Reboot the miner.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+
+        Returns:
+            A confirmation of rebooting the miner.
+        </details>
+        """
+        return await self.send_command("rebootdevice", parameters=session_id)
+
+    async def removegroup(self, group_id: str) -> dict:
+        """Remove a pool group.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            group_id: Group id to remove.
+
+        Returns:
+            A confirmation of removing the pool group.
+        </details>
+        """
+        return await self.send_command("removegroup", parameters=group_id)
+
+    async def resetminer(self, session_id: str) -> dict:
+        """Restart the mining process.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+
+        Returns:
+            A confirmation of restarting the mining process.
+        </details>
+        """
+        return await self.send_command("resetminer", parameters=session_id)
+
+    async def removepool(self, pool_id: int) -> dict:
+        """Remove a pool.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            pool_id: Pool to remove.
+
+        Returns:
+            A confirmation of removing the pool.
+        </details>
+        """
+        return await self.send_command("removepool", parameters=str(pool_id))
+
+    async def session(self) -> dict:
+        """Get the current session.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            Data on the current session.
+        </details>
+        """
+        return await self.send_command("session")
+
+    async def tempctrlset(self, target: int, hot: int, dangerous: int) -> dict:
+        """Set temp control values.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            target: Target temp.
+            hot: Hot temp.
+            dangerous: Dangerous temp.
+
+        Returns:
+            A confirmation of setting the temp control config.
+        </details>
+        """
+        return await self.send_command(
+            "tempctrlset", parameters=f"{target},{hot},{dangerous}"
+        )
+
+    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 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 switchpool(self, pool_id: int) -> dict:
+        """Switch to a pool.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            pool_id: Pool to switch to.
+
+        Returns:
+            A confirmation of switching to the pool.
+        </details>
+        """
+        return await self.send_command("switchpool", parameters=str(pool_id))
+
+    async def tempctrl(self) -> dict:
+        """Get temperature control data.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            Data about the temp control settings of the miner.
+        </details>
+        """
+        return await self.send_command("tempctrl")
+
+    async def temps(self) -> dict:
+        """Get temperature data.
+        <details>
+            <summary>Expand</summary>
+
+        Returns:
+            Data on the temps of the miner.
+        </details>
+        """
+        return await self.send_command("temps")
+
+    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 voltageget(self, board_n: int) -> dict:
+        """Get voltage data for a board.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            board_n: The board number to get voltage info from.
+
+        Returns:
+            Board voltage values.
+        </details>
+        """
+        return await self.send_command("frequencyget", parameters=str(board_n))
+
+    async def voltageset(self, session_id: str, board_n: int, voltage: float) -> dict:
+        """Set voltage values.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+            board_n: The board to set the voltage on.
+            voltage: The voltage to use.
+
+        Returns:
+            A confirmation of setting the voltage.
+        </details>
+        """
+        return await self.send_command(
+            "voltageset", parameters=f"{session_id},{board_n},{voltage}"
+        )
+
+    async def wakeup(self, session_id: str) -> dict:
+        """Take the miner out of sleep mode.  Requires a session_id from logon.
+        <details>
+            <summary>Expand</summary>
+
+        Parameters:
+            session_id: Session id from the logon command.
+
+        Returns:
+            A confirmation of resuming mining.
+        </details>
+        """
+        return await self.send_command("wakeup", parameters=session_id)

pyasic/__init__.py

@@ -13,6 +13,7 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from pyasic import settings
 from pyasic.API.bmminer import BMMinerAPI
 from pyasic.API.bosminer import BOSMinerAPI
 from pyasic.API.btminer import BTMinerAPI
@@ -29,10 +30,9 @@ from pyasic.data import (
 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_factory import MinerFactory, miner_factory
 from pyasic.miners.miner_listener import MinerListener
 from pyasic.network import MinerNetwork
-from pyasic.settings import PyasicSettings
 
 __all__ = [
     "BMMinerAPI",
@@ -51,7 +51,8 @@ __all__ = [
     "get_miner",
     "AnyMiner",
     "MinerFactory",
+    "miner_factory",
     "MinerListener",
     "MinerNetwork",
-    "PyasicSettings",
+    "settings",
 ]

pyasic/config/__init__.py

@@ -13,655 +13,161 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from copy import deepcopy
+from dataclasses import asdict, dataclass, field
 
-import logging
-import random
-import string
-import time
-from dataclasses import asdict, dataclass, fields
-from enum import IntEnum
-from typing import List, Literal
-
-import toml
-import yaml
-
-
-class X19PowerMode(IntEnum):
-    Normal = 0
-    Sleep = 1
-    LPM = 3
-
-
-@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_x17(self, user_suffix: str = None) -> dict:
-        """Convert the data in this class to a dict usable by an X5 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_goldshell(self, user_suffix: str = None) -> dict:
-        """Convert the data in this class to a dict usable by a goldshell 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_x17(self, user_suffix: str = None) -> dict:
-        """Convert the data in this class to a list usable by an X5 device.
-
-        Parameters:
-             user_suffix: The suffix to append to username.
-        """
-        pools = {
-            "_ant_pool1url": "",
-            "_ant_pool1user": "",
-            "_ant_pool1pw": "",
-            "_ant_pool2url": "",
-            "_ant_pool2user": "",
-            "_ant_pool2pw": "",
-            "_ant_pool3url": "",
-            "_ant_pool3user": "",
-            "_ant_pool3pw": "",
-        }
-        for idx, pool in enumerate(self.pools[:3]):
-            pools[f"_ant_pool{idx+1}url"] = pool.as_x17(user_suffix=user_suffix)["url"]
-            pools[f"_ant_pool{idx+1}user"] = pool.as_x17(user_suffix=user_suffix)["user"]
-            pools[f"_ant_pool{idx+1}pw"] = pool.as_x17(user_suffix=user_suffix)["pass"]
-
-        return pools
-
-    def as_goldshell(self, user_suffix: str = None) -> list:
-        """Convert the data in this class to a list usable by a goldshell device.
-
-        Parameters:
-             user_suffix: The suffix to append to username.
-        """
-        return [pool.as_goldshell(user_suffix=user_suffix) for pool in self.pools[:3]]
-
-    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 = {
-            "Pool1": None,
-            "UserName1": None,
-            "Password1": None,
-            "Pool2": None,
-            "UserName2": None,
-            "Password2": None,
-            "Pool3": None,
-            "UserName3": None,
-            "Password3": None,
-        }
-        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) -> 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 i in range(1, 4):
-            if i <= len(self.pools):
-                pool_wm = self.pools[i - 1].as_wm(user_suffix)
-                pools[f"pool_{i}"] = pool_wm["url"]
-                pools[f"worker_{i}"] = pool_wm["user"]
-                pools[f"passwd_{i}"] = pool_wm["pass"]
-            else:
-                pools[f"pool_{i}"] = ""
-                pools[f"worker_{i}"] = ""
-                pools[f"passwd_{i}"] = ""
-        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, PowerScalingShutdown
+from pyasic.config.temperature import TemperatureConfig
 
 
 @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
-
-    miner_mode: IntEnum = X19PowerMode.Normal
-    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)
+    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 isinstance(data_dict[key], IntEnum):
-                data_dict[key] = data_dict[key].value
-            if data_dict[key] is None:
-                del data_dict[key]
-        return data_dict
+        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 = []
-        if isinstance(data, list):
-            # goldshell config list
-            data = {"pools": data}
-        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]:
-                    self.miner_mode = X19PowerMode(int(data[key]))
-            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"
-                and not key == "miner_mode"
-            ):
-                setattr(self, key, data[key])
-            if key == "miner_mode":
-                self.miner_mode = X19PowerMode(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_am_modern(self, user_suffix: str = None) -> dict:
+        return {
+            **self.fan_mode.as_am_modern(),
+            "freq-level": "100",
+            **self.mining_mode.as_am_modern(),
+            **self.pools.as_am_modern(user_suffix=user_suffix),
+            **self.temperature.as_am_modern(),
+            **self.power_scaling.as_am_modern(),
+        }
 
     def as_wm(self, user_suffix: str = None) -> dict:
-        """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")
         return {
-            "pools": self.pool_groups[0].as_wm(user_suffix=user_suffix),
-            "wattage": self.autotuning_wattage,
+            **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:
+        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:
+        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:
+        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) -> dict:
-        """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": self.miner_mode.value,
+        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 not self.temp_mode == "auto":
-            cfg["bitmain-fan-ctrl"] = True
-
-        if self.fan_speed:
-            cfg["bitmain-fan-ctrl"] = str(self.fan_speed)
-
-        return cfg
-
-    def as_x17(self, user_suffix: str = None) -> dict:
-        """Convert the data in this class to a config usable by an X5 device.
-
-        Parameters:
-            user_suffix: The suffix to append to username.
-        """
-        cfg = self.pool_groups[0].as_x17(user_suffix=user_suffix)
-
-        return cfg
-
-    def as_goldshell(self, user_suffix: str = None) -> list:
-        """Convert the data in this class to a config usable by a goldshell device.
-
-        Parameters:
-            user_suffix: The suffix to append to username.
-        """
-        cfg = self.pool_groups[0].as_goldshell(user_suffix=user_suffix)
-
-        return 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,
-            },
+    def as_bosminer(self, user_suffix: str = None) -> dict:
+        return {
+            **merge(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.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_bos_grpc(self, user_suffix: str = None) -> dict:
+        return {
+            **self.fan_mode.as_bos_grpc(),
+            **self.temperature.as_bos_grpc(),
+            **self.mining_mode.as_bos_grpc(),
+            **self.pools.as_bos_grpc(user_suffix=user_suffix),
+            **self.power_scaling.as_bos_grpc(),
+        }
 
-        if self.asicboost:
-            cfg["hash_chain_global"] = {}
-            cfg["hash_chain_global"]["asic_boost"] = self.asicboost
+    def as_epic(self, user_suffix: str = None) -> dict:
+        return {
+            **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(),
+        }
 
-        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
+    @classmethod
+    def from_dict(cls, dict_conf: dict) -> "MinerConfig":
+        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")),
+        )
 
-        return toml.dumps(cfg)
+    @classmethod
+    def from_api(cls, api_pools: dict) -> "MinerConfig":
+        return cls(pools=PoolConfig.from_api(api_pools))
+
+    @classmethod
+    def from_am_modern(cls, web_conf: dict) -> "MinerConfig":
+        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":
+        return cls.from_am_modern(web_conf)
+
+    @classmethod
+    def from_goldshell(cls, web_conf: dict) -> "MinerConfig":
+        return cls(pools=PoolConfig.from_am_modern(web_conf))
+
+    @classmethod
+    def from_inno(cls, web_pools: list) -> "MinerConfig":
+        return cls(pools=PoolConfig.from_inno(web_pools))
+
+    @classmethod
+    def from_bosminer(cls, toml_conf: dict) -> "MinerConfig":
+        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),
+        )
+
+
+def merge(a: dict, b: dict) -> dict:
+    result = deepcopy(a)
+    for b_key, b_val in b.items():
+        a_val = result.get(b_key)
+        if isinstance(a_val, dict) and isinstance(b_val, dict):
+            result[b_key] = merge(a_val, b_val)
+        else:
+            result[b_key] = deepcopy(b_val)
+    return result

pyasic/config/base.py

@@ -0,0 +1,95 @@
+# ------------------------------------------------------------------------------
+#  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 asdict, dataclass
+from enum import Enum
+from typing import Union
+
+
+class MinerConfigOption(Enum):
+    @classmethod
+    def from_dict(cls, dict_conf: Union[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_bos_grpc(self) -> dict:
+        return self.value.as_bos_grpc()
+
+    def as_epic(self) -> dict:
+        return self.value.as_epic()
+
+    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: Union[dict, None]):
+        return cls()
+
+    def as_dict(self):
+        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_bos_grpc(self) -> dict:
+        return {}
+
+    def as_epic(self) -> dict:
+        return {}

pyasic/config/fans.py

@@ -0,0 +1,134 @@
+# ------------------------------------------------------------------------------
+#  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, field
+from typing import Union
+
+from pyasic.config.base import MinerConfigOption, MinerConfigValue
+
+
+@dataclass
+class FanModeNormal(MinerConfigValue):
+    mode: str = field(init=False, default="normal")
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "FanModeNormal":
+        return cls()
+
+    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"}}
+
+
+@dataclass
+class FanModeManual(MinerConfigValue):
+    mode: str = field(init=False, default="manual")
+    minimum_fans: int = 1
+    speed: int = 100
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "FanModeManual":
+        cls_conf = {}
+        if dict_conf.get("min_fans") is not None:
+            cls_conf["minimum_fans"] = dict_conf["minimum_fans"]
+        if dict_conf.get("speed") is not None:
+            cls_conf["speed"] = dict_conf["speed"]
+        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)
+
+    def as_am_modern(self) -> dict:
+        return {"bitmain-fan-ctrl": True, "bitmain-fan-pwn": str(self.speed)}
+
+    def as_bosminer(self) -> dict:
+        return {
+            "temp_control": {"mode": "manual"},
+            "fan_control": {"min_fans": self.minimum_fans, "speed": self.speed},
+        }
+
+
+@dataclass
+class FanModeImmersion(MinerConfigValue):
+    mode: str = field(init=False, default="immersion")
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "FanModeImmersion":
+        return cls()
+
+    def as_am_modern(self) -> dict:
+        return {"bitmain-fan-ctrl": True, "bitmain-fan-pwn": "0"}
+
+    def as_bosminer(self) -> dict:
+        return {"temp_control": {"mode": "disabled"}}
+
+
+class FanModeConfig(MinerConfigOption):
+    normal = FanModeNormal
+    manual = FanModeManual
+    immersion = FanModeImmersion
+
+    @classmethod
+    def default(cls):
+        return cls.normal()
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[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_am_modern(cls, web_conf: dict):
+        if web_conf.get("bitmain-fan-ctrl") is not None:
+            fan_manual = web_conf["bitmain-fan-ctrl"]
+            if fan_manual:
+                return cls.manual(speed=web_conf["bitmain-fan-pwm"])
+            else:
+                return cls.normal()
+        else:
+            return cls.default()
+
+    @classmethod
+    def from_bosminer(cls, toml_conf: dict):
+        if toml_conf.get("temp_control") is None:
+            return cls.default()
+        if toml_conf["temp_control"].get("mode") is None:
+            return cls.default()
+
+        mode = toml_conf["temp_control"]["mode"]
+        if mode == "auto":
+            return cls.normal()
+        elif mode == "manual":
+            if toml_conf.get("fan_control"):
+                return cls.manual().from_bosminer(toml_conf["fan_control"])
+            return cls.manual()
+        elif mode == "disabled":
+            return cls.immersion()

pyasic/config/mining.py

@@ -0,0 +1,213 @@
+# ------------------------------------------------------------------------------
+#  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, field
+from typing import Union
+
+from pyasic.config.base import MinerConfigOption, MinerConfigValue
+
+
+@dataclass
+class MiningModeNormal(MinerConfigValue):
+    mode: str = field(init=False, default="normal")
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeNormal":
+        return cls()
+
+    def as_am_modern(self) -> dict:
+        return {"miner-mode": "0"}
+
+    def as_wm(self) -> dict:
+        return {"mode": self.mode}
+
+
+@dataclass
+class MiningModeSleep(MinerConfigValue):
+    mode: str = field(init=False, default="sleep")
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeSleep":
+        return cls()
+
+    def as_am_modern(self) -> dict:
+        return {"miner-mode": "1"}
+
+    def as_wm(self) -> dict:
+        return {"mode": self.mode}
+
+
+@dataclass
+class MiningModeLPM(MinerConfigValue):
+    mode: str = field(init=False, default="low")
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeLPM":
+        return cls()
+
+    def as_am_modern(self) -> dict:
+        return {"miner-mode": "3"}
+
+    def as_wm(self) -> dict:
+        return {"mode": self.mode}
+
+
+@dataclass
+class MiningModeHPM(MinerConfigValue):
+    mode: str = field(init=False, default="high")
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeHPM":
+        return cls()
+
+    def as_am_modern(self):
+        return {"miner-mode": "0"}
+
+    def as_wm(self) -> dict:
+        return {"mode": self.mode}
+
+
+@dataclass
+class MiningModePowerTune(MinerConfigValue):
+    mode: str = field(init=False, default="power_tuning")
+    power: int = None
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModePowerTune":
+        return cls(dict_conf.get("power"))
+
+    def as_am_modern(self) -> dict:
+        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:
+        return {"autotuning": {"enabled": True, "psu_power_limit": self.power}}
+
+
+@dataclass
+class MiningModeHashrateTune(MinerConfigValue):
+    mode: str = field(init=False, default="hashrate_tuning")
+    hashrate: int = None
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "MiningModeHashrateTune":
+        return cls(dict_conf.get("hashrate"))
+
+    def as_am_modern(self) -> dict:
+        return {"miner-mode": "0"}
+
+
+@dataclass
+class ManualBoardSettings(MinerConfigValue):
+    freq: float
+    volt: float
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "ManualBoardSettings":
+        return cls(freq=dict_conf["freq"], volt=dict_conf["volt"])
+
+    def as_am_modern(self) -> dict:
+        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: Union[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:
+        return {"miner-mode": "0"}
+
+
+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: Union[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_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_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()

pyasic/config/pools.py

@@ -0,0 +1,356 @@
+# ------------------------------------------------------------------------------
+#  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 random
+import string
+from dataclasses import dataclass, field
+from typing import Union
+
+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):
+        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, user_suffix: str = None):
+        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, user_suffix: str = None):
+        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):
+        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):
+        if user_suffix is not None:
+            return ",".join([self.url, f"{self.user}{user_suffix}", self.password])
+        return ",".join([self.url, self.user, self.password])
+
+    def as_inno(self, idx: int, user_suffix: str = None):
+        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):
+        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}
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[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_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"],
+        )
+
+
+@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) -> dict:
+        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": []}
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[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_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()
+
+
+@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: Union[dict, None]) -> "PoolConfig":
+        if dict_conf is None:
+            return cls.default()
+
+        return cls(groups=[PoolGroup.from_dict(g) for g in dict_conf["groups"]])
+
+    @classmethod
+    def simple(cls, pools: list[Union[Pool, dict[str, str]]]) -> "PoolConfig":
+        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_bos_grpc(self, user_suffix: str = None) -> dict:
+        return {}
+
+    @classmethod
+    def from_api(cls, api_pools: dict) -> "PoolConfig":
+        pool_data = api_pools["POOLS"]
+        pool_data = sorted(pool_data, key=lambda x: int(x["POOL"]))
+
+        return cls([PoolGroup.from_api(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"]])

pyasic/config/power_scaling.py

@@ -0,0 +1,189 @@
+# ------------------------------------------------------------------------------
+#  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, field
+from typing import Union
+
+from pyasic.config.base import MinerConfigOption, MinerConfigValue
+from pyasic.web.bosminer.proto.braiins.bos.v1 import DpsPowerTarget, DpsTarget, Hours
+
+
+@dataclass
+class PowerScalingShutdownEnabled(MinerConfigValue):
+    mode: str = field(init=False, default="enabled")
+    duration: int = None
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[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_bos_grpc(self) -> dict:
+        cfg = {"enable_shutdown ": True}
+
+        if self.duration is not None:
+            cfg["shutdown_duration"] = Hours(self.duration)
+
+        return cfg
+
+
+@dataclass
+class PowerScalingShutdownDisabled(MinerConfigValue):
+    mode: str = field(init=False, default="disabled")
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[dict, None]) -> "PowerScalingShutdownDisabled":
+        return cls()
+
+    def as_bosminer(self) -> dict:
+        return {"shutdown_enabled": False}
+
+    def as_bos_grpc(self) -> dict:
+        return {"enable_shutdown ": False}
+
+
+class PowerScalingShutdown(MinerConfigOption):
+    enabled = PowerScalingShutdownEnabled
+    disabled = PowerScalingShutdownDisabled
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[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
+
+
+@dataclass
+class PowerScalingEnabled(MinerConfigValue):
+    mode: str = field(init=False, default="enabled")
+    power_step: int = None
+    minimum_power: int = None
+    shutdown_enabled: Union[
+        PowerScalingShutdownEnabled, PowerScalingShutdownDisabled
+    ] = None
+
+    @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")
+        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: Union[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_psu_power_limit"] = self.minimum_power
+
+        if self.shutdown_enabled is not None:
+            cfg = {**cfg, **self.shutdown_enabled.as_bosminer()}
+
+        return {"power_scaling": cfg}
+
+    def as_bos_grpc(self) -> dict:
+        cfg = {"enable": True}
+        target_conf = {}
+        if self.power_step is not None:
+            target_conf["power_step"] = self.power_step
+        if self.minimum_power is not None:
+            target_conf["min_power_target"] = self.minimum_power
+
+        cfg["target"] = DpsTarget(power_target=DpsPowerTarget(**target_conf))
+
+        if self.shutdown_enabled is not None:
+            cfg = {**cfg, **self.shutdown_enabled.as_bos_grpc()}
+
+        return {"dps": cfg}
+
+
+@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: Union[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 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()

pyasic/config/temperature.py

@@ -13,31 +13,46 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-
+from dataclasses import dataclass
 from typing import Union
 
-from pyasic.miners.btc._backends import BMMiner  # noqa - Ignore access to _module
-from pyasic.miners.btc._types import S9  # noqa - Ignore access to _module
-from pyasic.web.S9 import S9WebAPI
+from pyasic.config.base import MinerConfigValue
 
 
-class BMMinerS9(BMMiner, S9):
-    def __init__(self, ip: str, api_ver: str = "0.0.0") -> None:
-        super().__init__(ip, api_ver=api_ver)
-        self.ip = ip
-        self.web = S9WebAPI(ip)
+@dataclass
+class TemperatureConfig(MinerConfigValue):
+    target: int = None
+    hot: int = None
+    danger: int = None
 
-    async def get_mac(self) -> Union[str, None]:
-        try:
-            data = await self.web.get_system_info()
-            if data:
-                return data["macaddr"]
-        except KeyError:
-            pass
+    @classmethod
+    def default(cls):
+        return cls()
 
-        try:
-            data = await self.web.get_network_info()
-            if data:
-                return data["macaddr"]
-        except KeyError:
-            pass
+    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}
+
+    @classmethod
+    def from_dict(cls, dict_conf: Union[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"),
+            )

pyasic/data/__init__.py

@@ -20,7 +20,7 @@ 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 .error_codes import BraiinsOSError, InnosiliconError, WhatsminerError, X19Error
 
@@ -40,13 +40,28 @@ class HashBoard:
     """
 
     slot: int = 0
-    hashrate: float = 0.0
-    temp: int = -1
-    chip_temp: int = -1
-    chips: int = 0
-    expected_chips: int = 0
+    hashrate: float = None
+    temp: int = None
+    chip_temp: int = None
+    chips: int = None
+    expected_chips: int = None
     missing: bool = True
 
+    def get(self, __key: str, default: Any = None):
+        try:
+            val = self.__getitem__(__key)
+            if val is None:
+                return default
+            return val
+        except KeyError:
+            return default
+
+    def __getitem__(self, item: str):
+        try:
+            return getattr(self, item)
+        except AttributeError:
+            raise KeyError(f"{item}")
+
 
 @dataclass
 class Fan:
@@ -56,7 +71,22 @@ class Fan:
         speed: The speed of the fan.
     """
 
-    speed: int = -1
+    speed: int = None
+
+    def get(self, __key: str, default: Any = None):
+        try:
+            val = self.__getitem__(__key)
+            if val is None:
+                return default
+            return val
+        except KeyError:
+            return default
+
+    def __getitem__(self, item: str):
+        try:
+            return getattr(self, item)
+        except AttributeError:
+            raise KeyError(f"{item}")
 
 
 @dataclass
@@ -66,37 +96,28 @@ 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.
+        hashrate: The hashrate of the miner in TH/s as a float.  Calculated automatically.
+        _hashrate: Backup for hashrate found via API instead of hashboards.
         nominal_hashrate: The factory nominal hashrate of the miner in TH/s as a float.
-        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.
+        hashboards: A list of hashboards 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.
+        percent_ideal_chips: The percent of total chips out of the ideal count.  Calculated automatically.
+        percent_ideal_hashrate: The percent of total hashrate out of the ideal hashrate.  Calculated automatically.
+        percent_ideal_wattage: The percent of total wattage out of the ideal 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.
@@ -104,48 +125,37 @@ class MinerData:
         pool_2_url: The second pool url on the miner as a str.
         pool_2_user: The second pool user on the miner as a str.
         errors: A list of errors on the miner.
-        fault_light: Whether 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 = None
+    nominal_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)
+    ideal_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 = 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)
+    ideal_chips: int = None
+    percent_ideal_chips: float = field(init=False)
+    percent_ideal_hashrate: float = field(init=False)
+    percent_ideal_wattage: float = field(init=False)
+    nominal: bool = field(init=False)
     pool_split: str = "0"
     pool_1_url: str = "Unknown"
     pool_1_user: str = "Unknown"
@@ -156,6 +166,7 @@ class MinerData:
     ] = field(default_factory=list)
     fault_light: Union[bool, None] = None
     efficiency: int = field(init=False)
+    is_mining: bool = True
 
     @classmethod
     def fields(cls):
@@ -164,7 +175,16 @@ class MinerData:
     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,196 +234,39 @@ 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
-
-    @property
-    def fan_2(self):  # noqa - Skip PyCharm inspection
-        if len(self.fans) > 1:
-            return self.fans[1].speed
-
-    @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
+    @hashrate.setter
+    def hashrate(self, val):
+        self._hashrate = 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, 4]:
-            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) in [2, 3, 4]:
-            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
-        if len(self.hashboards) > 3:
-            return self.hashboards[-1:][0].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, 4]:
-            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) in [2, 3, 4]:
-            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
-        if len(self.hashboards) > 3:
-            return self.hashboards[-1:][0].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, 4]:
-            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) in [2, 3, 4]:
-            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
-        if len(self.hashboards) > 3:
-            return self.hashboards[-1:][0].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, 4]:
-            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) in [2, 3, 4]:
-            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
-        if len(self.hashboards) > 3:
-            return self.hashboards[-1:][0].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
+        if self.total_chips is None or self.ideal_chips is None:
+            return None
         return self.ideal_chips == self.total_chips
 
     @nominal.setter
@@ -411,13 +274,39 @@ class MinerData:
         pass
 
     @property
-    def percent_ideal(self):  # noqa - Skip PyCharm inspection
+    def percent_ideal_chips(self):  # noqa - Skip PyCharm inspection
+        if self.total_chips is None or self.ideal_chips is None:
+            return None
         if self.total_chips == 0 or self.ideal_chips == 0:
             return 0
         return round((self.total_chips / self.ideal_chips) * 100)
 
-    @percent_ideal.setter
-    def percent_ideal(self, val):
+    @percent_ideal_chips.setter
+    def percent_ideal_chips(self, val):
+        pass
+
+    @property
+    def percent_ideal_hashrate(self):  # noqa - Skip PyCharm inspection
+        if self.hashrate is None or self.nominal_hashrate is None:
+            return None
+        if self.hashrate == 0 or self.nominal_hashrate == 0:
+            return 0
+        return round((self.hashrate / self.nominal_hashrate) * 100)
+
+    @percent_ideal_hashrate.setter
+    def percent_ideal_hashrate(self, val):
+        pass
+
+    @property
+    def percent_ideal_wattage(self):  # noqa - Skip PyCharm inspection
+        if self.wattage_limit is None or self.wattage is None:
+            return None
+        if self.wattage_limit == 0 or self.wattage == 0:
+            return 0
+        return round((self.wattage / self.wattage_limit) * 100)
+
+    @percent_ideal_wattage.setter
+    def percent_ideal_wattage(self, val):
         pass
 
     @property
@@ -425,11 +314,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
@@ -438,7 +327,9 @@ class MinerData:
 
     @property
     def efficiency(self):  # noqa - Skip PyCharm inspection
-        if self.hashrate == 0 or self.wattage == -1:
+        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)
 
@@ -447,13 +338,16 @@ class MinerData:
         pass
 
     def asdict(self) -> dict:
+        logging.debug(f"MinerData - (To Dict) - Dumping Dict data")
+        return asdict(self)
+
+    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.
@@ -498,27 +392,45 @@ class MinerData:
         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/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/load/__init__.py

@@ -19,21 +19,8 @@ from typing import List, Union
 
 from pyasic.errors import APIError
 from pyasic.miners import AnyMiner
-from pyasic.miners.btc._backends import (  # noqa - Ignore access to _module
-    X19,
-    BOSMiner,
-    BTMiner,
-)
-from pyasic.miners.btc._types import (  # noqa - Ignore access to _module
-    S9,
-    S17,
-    T17,
-    S17e,
-    S17Plus,
-    S17Pro,
-    T17e,
-    T17Plus,
-)
+from pyasic.miners.backends import AntminerModern, BOSMiner, BTMiner
+from pyasic.miners.types import S9, S17, T17, S17e, S17Plus, S17Pro, T17e, T17Plus
 
 FAN_USAGE = 50  # 50 W per fan
 
@@ -103,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
@@ -162,10 +149,10 @@ class _MinerPhaseBalancer:
                 not self.miners[data_point.ip]["shutdown"]
             ):
                 # cant do anything with it so need to find a semi-accurate power limit
-                if not data_point.wattage_limit == -1:
+                if not data_point.wattage_limit == 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 not data_point.wattage == None:
                     self.miners[data_point.ip]["max"] = int(data_point.wattage)
                     self.miners[data_point.ip]["min"] = int(data_point.wattage)
 

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

@@ -18,9 +18,9 @@ import ipaddress
 from typing import Union
 
 from pyasic.miners.base import AnyMiner, BaseMiner
-from pyasic.miners.miner_factory import MinerFactory
+from pyasic.miners.miner_factory import miner_factory
 
 
 # abstracted version of get miner that is easier to access
 async def get_miner(ip: Union[ipaddress.ip_address, str]) -> AnyMiner:
-    return await MinerFactory().get_miner(ip)
+    return await miner_factory.get_miner(ip)

pyasic/miners/antminer/__init__.py

@@ -18,4 +18,6 @@ from .bmminer import *
 from .bosminer import *
 from .cgminer import *
 from .hiveon import *
+from .luxos import *
 from .vnish import *
+from .epic import *

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

@@ -14,13 +14,21 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.btc._backends import BTMiner  # noqa - Ignore access to _module
-from pyasic.miners.btc._types import M31V10, M31V20  # noqa - Ignore access to _module
+from pyasic.miners.backends import AntminerOld
+from pyasic.miners.types import S17, S17e, S17Plus, S17Pro
 
 
-class BTMinerM31V10(BTMiner, M31V10):
+class BMMinerS17(AntminerOld, S17):
     pass
 
 
-class BTMinerM31V20(BTMiner, M31V20):
+class BMMinerS17Plus(AntminerOld, S17Plus):
+    pass
+
+
+class BMMinerS17Pro(AntminerOld, S17Pro):
+    pass
+
+
+class BMMinerS17e(AntminerOld, S17e):
     pass

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

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

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

@@ -0,0 +1,18 @@
+# ------------------------------------------------------------------------------
+#  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 .S17 import BMMinerS17, BMMinerS17e, BMMinerS17Plus, BMMinerS17Pro
+from .T17 import BMMinerT17, BMMinerT17e, BMMinerT17Plus

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

@@ -0,0 +1,79 @@
+# ------------------------------------------------------------------------------
+#  Copyright 2022 Upstream Data Inc                                            -
+#                                                                              -
+#  Licensed under the Apache License, Version 2.0 (the "License");             -
+#  you may not use this file except in compliance with the License.            -
+#  You may obtain a copy of the License at                                     -
+#                                                                              -
+#      http://www.apache.org/licenses/LICENSE-2.0                              -
+#                                                                              -
+#  Unless required by applicable law or agreed to in writing, software         -
+#  distributed under the License is distributed on an "AS IS" BASIS,           -
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    -
+#  See the License for the specific language governing permissions and         -
+#  limitations under the License.                                              -
+# ------------------------------------------------------------------------------
+
+from pyasic.miners.backends import AntminerModern
+from pyasic.miners.types import (
+    S19,
+    S19L,
+    S19XP,
+    S19a,
+    S19aPro,
+    S19i,
+    S19j,
+    S19jNoPIC,
+    S19jPro,
+    S19Plus,
+    S19Pro,
+    S19ProPlus,
+)
+
+
+class BMMinerS19(AntminerModern, S19):
+    pass
+
+
+class BMMinerS19Plus(AntminerModern, S19Plus):
+    pass
+
+
+class BMMinerS19i(AntminerModern, S19i):
+    pass
+
+
+class BMMinerS19Pro(AntminerModern, S19Pro):
+    pass
+
+
+class BMMinerS19ProPlus(AntminerModern, S19ProPlus):
+    pass
+
+
+class BMMinerS19XP(AntminerModern, S19XP):
+    pass
+
+
+class BMMinerS19a(AntminerModern, S19a):
+    pass
+
+
+class BMMinerS19aPro(AntminerModern, S19aPro):
+    pass
+
+
+class BMMinerS19j(AntminerModern, S19j):
+    pass
+
+
+class BMMinerS19jNoPIC(AntminerModern, S19jNoPIC):
+    pass
+
+
+class BMMinerS19jPro(AntminerModern, S19jPro):
+    pass
+
+
+class BMMinerS19L(AntminerModern, S19L):
+    pass

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

@@ -14,10 +14,11 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.btc._types import S17Pro  # noqa - Ignore access to _module
+from pyasic.miners.backends import AntminerModern
+from pyasic.miners.types import T19
 
-from .X17 import BMMinerX17
+# noqa - Ignore access to _module
 
 
-class BMMinerS17Pro(BMMinerX17, S17Pro):
+class BMMinerT19(AntminerModern, T19):
     pass

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

@@ -14,12 +14,18 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from .S19 import BMMinerS19
-from .S19_Pro import BMMinerS19Pro
-from .S19_XP import BMMinerS19XP
-from .S19a import BMMinerS19a
-from .S19a_Pro import BMMinerS19aPro
-from .S19j import BMMinerS19j
-from .S19j_Pro import BMMinerS19jPro
-from .S19L import BMMinerS19L
+from .S19 import (
+    BMMinerS19,
+    BMMinerS19a,
+    BMMinerS19aPro,
+    BMMinerS19i,
+    BMMinerS19j,
+    BMMinerS19jNoPIC,
+    BMMinerS19jPro,
+    BMMinerS19L,
+    BMMinerS19Plus,
+    BMMinerS19Pro,
+    BMMinerS19ProPlus,
+    BMMinerS19XP,
+)
 from .T19 import BMMinerT19

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

@@ -14,9 +14,11 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.hns._backends import X3  # noqa - Ignore access to _module
-from pyasic.miners.hns._types import HS3  # noqa - Ignore access to _module
+from pyasic.miners.backends import AntminerModern
+from pyasic.miners.types import HS3
 
 
-class CGMinerHS3(X3, HS3):
-    pass
+class BMMinerHS3(AntminerModern, HS3):
+    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+        super().__init__(ip, api_ver)
+        self.supports_shutdown = False

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

@@ -14,10 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.btc._types import T17  # noqa - Ignore access to _module
-
-from .X17 import BMMinerX17
+from pyasic.miners.backends import AntminerOld
+from pyasic.miners.types import L3Plus
 
 
-class BMMinerT17(BMMinerX17, T17):
+class BMMinerL3Plus(AntminerOld, L3Plus):
     pass

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

@@ -13,6 +13,5 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-from .X9 import *
-from .X17 import *
-from .X19 import *
+from .HS3 import BMMinerHS3
+from .L3 import BMMinerL3Plus

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

@@ -13,12 +13,11 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-
-from pyasic.miners.ltc._backends import X7  # noqa - Ignore access to _module
-from pyasic.miners.ltc._types import L7  # noqa - Ignore access to _module
-
-# noqa - Ignore access to _module
+from pyasic.miners.backends import AntminerModern
+from pyasic.miners.types import L7
 
 
-class BMMinerL7(X7, L7):
-    pass
+class BMMinerL7(AntminerModern, L7):
+    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+        super().__init__(ip, api_ver)
+        self.supports_shutdown = False

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

@@ -13,5 +13,4 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
-
 from .L7 import BMMinerL7

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

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

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

@@ -14,9 +14,17 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.btc._backends import BMMiner  # noqa - Ignore access to _module
-from pyasic.miners.btc._types import S9i  # noqa - Ignore access to _module
+from pyasic.miners.backends import BMMiner
+from pyasic.miners.types import S9, S9i, S9j
+
+
+class BMMinerS9(BMMiner, S9):
+    pass
 
 
 class BMMinerS9i(BMMiner, S9i):
     pass
+
+
+class BMMinerS9j(BMMiner, S9j):
+    pass

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

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

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

@@ -14,6 +14,6 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from .S9 import BMMinerS9
-from .S9i import BMMinerS9i
+from .E9 import BMMinerE9Pro
+from .S9 import BMMinerS9, BMMinerS9i, BMMinerS9j
 from .T9 import BMMinerT9

pyasic/miners/antminer/bmminer/__init__.py

@@ -13,6 +13,8 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from .X3 import *
+from .X7 import *
 from .X9 import *
 from .X17 import *
 from .X19 import *

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

@@ -14,9 +14,21 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.btc._backends import BOSMiner  # noqa - Ignore access to _module
-from pyasic.miners.btc._types import S17Plus  # noqa - Ignore access to _module
+from pyasic.miners.backends import BOSMiner
+from pyasic.miners.types import S17, S17e, S17Plus, S17Pro
+
+
+class BOSMinerS17(BOSMiner, S17):
+    pass
 
 
 class BOSMinerS17Plus(BOSMiner, S17Plus):
     pass
+
+
+class BOSMinerS17Pro(BOSMiner, S17Pro):
+    pass
+
+
+class BOSMinerS17e(BOSMiner, S17e):
+    pass

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

@@ -14,9 +14,17 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.btc._backends import BOSMiner  # noqa - Ignore access to _module
-from pyasic.miners.btc._types import T17Plus  # noqa - Ignore access to _module
+from pyasic.miners.backends import BOSMiner
+from pyasic.miners.types import T17, T17e, T17Plus
+
+
+class BOSMinerT17(BOSMiner, T17):
+    pass
 
 
 class BOSMinerT17Plus(BOSMiner, T17Plus):
     pass
+
+
+class BOSMinerT17e(BOSMiner, T17e):
+    pass

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

@@ -0,0 +1,18 @@
+# ------------------------------------------------------------------------------
+#  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 .S17 import BOSMinerS17, BOSMinerS17e, BOSMinerS17Plus, BOSMinerS17Pro
+from .T17 import BOSMinerT17, BOSMinerT17e, BOSMinerT17Plus

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

@@ -14,9 +14,29 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.btc._backends import BOSMiner  # noqa - Ignore access to _module
-from pyasic.miners.btc._types import S19jPro  # noqa - Ignore access to _module
+from pyasic.miners.backends import BOSMiner
+from pyasic.miners.types import S19, S19j, S19jNoPIC, S19jPro, S19kProNoPIC, S19Pro
+
+
+class BOSMinerS19(BOSMiner, S19):
+    pass
+
+
+class BOSMinerS19Pro(BOSMiner, S19Pro):
+    pass
+
+
+class BOSMinerS19j(BOSMiner, S19j):
+    pass
+
+
+class BOSMinerS19jNoPIC(BOSMiner, S19jNoPIC):
+    pass
 
 
 class BOSMinerS19jPro(BOSMiner, S19jPro):
     pass
+
+
+class BOSMinerS19kProNoPIC(BOSMiner, S19kProNoPIC):
+    pass

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

@@ -14,8 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.btc._backends import CGMinerAvalon  # noqa - Ignore access to _module
+from pyasic.miners.backends import BOSMiner
+from pyasic.miners.types import T19
 
 
-class CGMinerA7X(CGMinerAvalon):
+class BOSMinerT19(BOSMiner, T19):
     pass

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

@@ -14,8 +14,12 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from .S19 import BOSMinerS19
-from .S19_Pro import BOSMinerS19Pro
-from .S19j import BOSMinerS19j
-from .S19j_Pro import BOSMinerS19jPro
+from .S19 import (
+    BOSMinerS19,
+    BOSMinerS19j,
+    BOSMinerS19jNoPIC,
+    BOSMinerS19jPro,
+    BOSMinerS19kProNoPIC,
+    BOSMinerS19Pro,
+)
 from .T19 import BOSMinerT19

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

@@ -14,8 +14,9 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.btc._backends import CGMinerAvalon  # noqa - Ignore access to _module
+from pyasic.miners.backends import BOSMiner
+from pyasic.miners.types import S9
 
 
-class CGMinerA8X(CGMinerAvalon):
+class BOSMinerS9(BOSMiner, S9):
     pass

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

@@ -14,9 +14,11 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.zec._backends import X15  # noqa - Ignore access to _module
-from pyasic.miners.zec._types import Z15  # noqa - Ignore access to _module
+from pyasic.miners.backends import AntminerOld
+from pyasic.miners.types import Z15
 
 
-class CGMinerZ15(X15, Z15):
-    pass
+class CGMinerZ15(AntminerOld, Z15):
+    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+        super().__init__(ip, api_ver)
+        self.supports_shutdown = False

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

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

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

@@ -14,4 +14,4 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from .A10X import A10X
+from .D3 import CGMinerD3

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

@@ -14,9 +14,11 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.dcr._backends import X5  # noqa - Ignore access to _module
-from pyasic.miners.dcr._types import DR5  # noqa - Ignore access to _module
+from pyasic.miners.backends import AntminerOld
+from pyasic.miners.types import DR5
 
 
-class CGMinerDR5(X5, DR5):
-    pass
+class CGMinerDR5(AntminerOld, DR5):
+    def __init__(self, ip: str, api_ver: str = "0.0.0"):
+        super().__init__(ip, api_ver)
+        self.supports_shutdown = False

pyasic/miners/antminer/cgminer/__init__.py

@@ -13,4 +13,7 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+
+from .X3 import *
+from .X5 import *
 from .X15 import *

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

@@ -14,21 +14,33 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
-from pyasic.miners.btc._backends import BTMiner  # noqa - Ignore access to _module
-from pyasic.miners.btc._types import (  # noqa - Ignore access to _module
-    M31SEV10,
-    M31SEV20,
-    M31SEV30,
-)
+from pyasic.miners.backends import ePIC
+from pyasic.miners.types import S19, S19XP, S19j, S19jPro, S19jProPlus, S19kPro, S19Pro
 
 
-class BTMinerM31SEV10(BTMiner, M31SEV10):
+class ePICS19(ePIC, S19):
     pass
 
 
-class BTMinerM31SEV20(BTMiner, M31SEV20):
+class ePICS19Pro(ePIC, S19Pro):
     pass
 
 
-class BTMinerM31SEV30(BTMiner, M31SEV30):
+class ePICS19j(ePIC, S19j):
+    pass
+
+
+class ePICS19jPro(ePIC, S19jPro):
+    pass
+
+
+class ePICS19jProPlus(ePIC, S19jProPlus):
+    pass
+
+
+class ePICS19kPro(ePIC, S19kPro):
+    pass
+
+
+class ePICS19XP(ePIC, S19XP):
     pass

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

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

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

@@ -20,8 +20,8 @@ import asyncssh
 
 from pyasic.data import HashBoard
 from pyasic.errors import APIError
-from pyasic.miners.btc._backends import Hiveon  # noqa - Ignore access to _module
-from pyasic.miners.btc._types import T9  # noqa - Ignore access to _module
+from pyasic.miners.backends import Hiveon
+from pyasic.miners.types import T9
 
 
 class HiveonT9(Hiveon, T9):
@@ -42,7 +42,7 @@ class HiveonT9(Hiveon, T9):
                 .upper()
             )
             return mac
-        except (TypeError, ValueError, asyncssh.Error, OSError):
+        except (TypeError, ValueError, asyncssh.Error, OSError, AttributeError):
             pass
 
     async def get_hashboards(self, api_stats: dict = None) -> List[HashBoard]:
@@ -58,17 +58,20 @@ class HiveonT9(Hiveon, T9):
             hashrate = 0
             chips = 0
             for chipset in board_map[board]:
-                if hashboard.chip_temp == -1:
+                if hashboard.chip_temp == None:
                     try:
                         hashboard.board_temp = api_stats["STATS"][1][f"temp{chipset}"]
                         hashboard.chip_temp = api_stats["STATS"][1][f"temp2_{chipset}"]
-                        hashrate += api_stats["STATS"][1][f"chain_rate{chipset}"]
-                        chips += api_stats["STATS"][1][f"chain_acn{chipset}"]
                     except (KeyError, IndexError):
                         pass
                     else:
                         hashboard.missing = False
-            hashboard.hashrate = hashrate
+                try:
+                    hashrate += api_stats["STATS"][1][f"chain_rate{chipset}"]
+                    chips += api_stats["STATS"][1][f"chain_acn{chipset}"]
+                except (KeyError, IndexError):
+                    pass
+            hashboard.hashrate = round(hashrate / 1000, 2)
             hashboard.chips = chips
             hashboards.append(hashboard)