version: bump version number

Fixes: #311

.coveragerc

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

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Version [e.g. 22]
+
+**Miner Information (If applicable):**
+ - Manufacturer: [e.g. Bitmain, MicroBT]
+ - Type: [e.g. S9, M20]
+ - Firmware Type: [e.g. Stock, BraiinsOS]
+ - Firmware Version:
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/python-publish.yml

@@ -0,0 +1,22 @@
+name: PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+      - 'docsrc/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.2.2
+      - name: Publish GH release
+        uses: softprops/action-gh-release@v2.1.0
+      - name: Build using poetry and publish to PyPi
+        uses: JRubics/poetry-publish@v2.0
+        with:
+          pypi_token: ${{ secrets.PYPI_API_KEY }}

.gitignore

@@ -0,0 +1,10 @@
+venv/
+build/
+dist/
+__pycache__/
+pyvenv.cfg
+.env/
+bin/
+lib/
+.idea/
+.vs/

.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+ci:
+  skip:
+    - poetry-lock
+    - unittest
+    - generate-docs
+repos:
+-   repo: https://github.com/python-poetry/poetry
+    rev: 2.1.2
+    hooks:
+      - id: poetry-check
+      - id: poetry-lock
+      - id: poetry-install
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: check-yaml
+        name: check-yaml for mkdocs.yml
+        files: ^mkdocs\.yml$
+        args: [--unsafe]
+    -   id: check-yaml
+        name: check-yaml for other YAML files
+        exclude: ^mkdocs\.yml$
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/pycqa/isort
+    rev: 6.0.1
+    hooks:
+    -   id: isort
+        name: isort (python)
+
+-   repo: local
+    hooks:
+    -   id: unittest
+        name: unittest
+        entry: python -m unittest discover
+        language: system
+        types: [ python ]
+        args: ["-p '*test.py'"] # Probably this option is absolutely not needed.
+        pass_filenames: false
+    -   id: generate-docs
+        name: generate-docs
+        entry: python docs/generate_miners.py
+        language: system
+        types: [ python ]
+        pass_filenames: false

.readthedocs.yaml

@@ -0,0 +1,18 @@
+# .readthedocs.yaml
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools: { python: "3.11" }
+  jobs:
+    pre_create_environment:
+      - asdf plugin add poetry
+      - asdf install poetry latest
+      - asdf global poetry latest
+      - poetry config virtualenvs.create false
+    post_install:
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --only docs
+
+mkdocs:
+  configuration: mkdocs.yml

API/__init__.py

@@ -1,166 +0,0 @@
-import asyncio
-import json
-import ipaddress
-
-
-class APIError(Exception):
-    def __init__(self, *args):
-        if args:
-            self.message = args[0]
-        else:
-            self.message = None
-
-    def __str__(self):
-        if self.message:
-            return f"{self.message}"
-        else:
-            return "Incorrect API parameters."
-
-
-class BaseMinerAPI:
-    def __init__(self, ip: str, port: int = 4028) -> None:
-        # api port, should be 4028
-        self.port = port
-        # ip address of the miner
-        self.ip = ipaddress.ip_address(ip)
-
-    def get_commands(self) -> list:
-        """Get a list of command accessible to a specific type of API on the miner."""
-        return [func for func in
-                # each function in self
-                dir(self) if callable(getattr(self, func)) and
-                # no __ methods
-                not func.startswith("__") and
-                # remove all functions that are in this base class
-                func not in
-                [func for func in
-                 dir(BaseMinerAPI) if callable(getattr(BaseMinerAPI, func))
-                 ]
-                ]
-
-    async def multicommand(self, *commands: str) -> dict:
-        """Creates and sends multiple commands as one command to the miner."""
-        # split the commands into a proper list
-        commands = [*commands]
-
-        for item in commands:
-            # make sure we can actually run the command, otherwise it will fail
-            if item not in self.get_commands():
-                # if the command isnt allowed, remove it
-                print(f"Removing incorrect command: {item}")
-                commands.remove(item)
-
-        # standard multicommand format is "command1+command2"
-        # doesnt work for S19 which is dealt with in the send command function
-        command = "+".join(commands)
-        data = None
-        try:
-            data = await self.send_command(command)
-        except APIError:
-            try:
-                data = {}
-                # S19 handler, try again
-                for cmd in command.split("+"):
-                    data[cmd] = []
-                    data[cmd].append(await self.send_command(cmd))
-            except APIError as e:
-                raise APIError(e)
-            except Exception as e:
-                print(e)
-        if data:
-            return data
-
-    async def send_command(self, command: str, parameters: str or int or bool = None) -> dict:
-        """Send an API command to the miner and return the result."""
-        try:
-            # get reader and writer streams
-            reader, writer = await asyncio.open_connection(str(self.ip), self.port)
-        # handle OSError 121
-        except OSError as e:
-            if e.winerror == "121":
-                print("Semaphore Timeout has Expired.")
-            return {}
-
-        # create the command
-        cmd = {"command": command}
-        if parameters is not None:
-            cmd["parameter"] = parameters
-
-        # send the command
-        writer.write(json.dumps(cmd).encode('utf-8'))
-        await writer.drain()
-
-        # instantiate data
-        data = b""
-
-        # loop to receive all the data
-        try:
-            while True:
-                d = await reader.read(4096)
-                if not d:
-                    break
-                data += d
-        except Exception as e:
-            print(e)
-
-        data = self.load_api_data(data)
-
-        # close the connection
-        writer.close()
-        await writer.wait_closed()
-
-        # validate the command suceeded
-        if not self.validate_command_output(data):
-            raise APIError(data["STATUS"][0]["Msg"])
-
-        return data
-
-    @staticmethod
-    def validate_command_output(data: dict) -> bool:
-        """Check if the returned command output is correctly formatted."""
-        # check if the data returned is correct or an error
-        # if status isn't a key, it is a multicommand
-        if "STATUS" not in data.keys():
-            for key in data.keys():
-                # make sure not to try to turn id into a dict
-                if not key == "id":
-                    # make sure they succeeded
-                    if "STATUS" in data.keys():
-                        if data[key][0]["STATUS"][0]["STATUS"] not in ["S", "I"]:
-                            # this is an error
-                            return False
-        elif "id" not in data.keys():
-            if data["STATUS"] not in ["S", "I"]:
-                return False
-        else:
-            # make sure the command succeeded
-            if data["STATUS"][0]["STATUS"] not in ("S", "I"):
-                # this is an error
-                if data["STATUS"][0]["STATUS"] not in ("S", "I"):
-                    return False
-        return True
-
-    @staticmethod
-    def load_api_data(data: bytes) -> dict:
-        """Convert API data from JSON to dict"""
-        try:
-            # some json from the API returns with a null byte (\x00) on the end
-            if data.endswith(b"\x00"):
-                # handle the null byte
-                str_data = data.decode('utf-8')[:-1]
-            else:
-                # no null byte
-                str_data = data.decode('utf-8')
-            # fix an error with a btminer return having an extra comma that breaks json.loads()
-            str_data = str_data.replace(",}", "}")
-            # fix an error with a btminer return having a newline that breaks json.loads()
-            str_data = str_data.replace("\n", "")
-            # fix an error with a bmminer return not having a specific comma that breaks json.loads()
-            str_data = str_data.replace("}{", "},{")
-            # parse the json
-            parsed_data = json.loads(str_data)
-        # handle bad json
-        except json.decoder.JSONDecodeError as e:
-            print(e)
-            raise APIError(f"Decode Error: {data}")
-        return parsed_data

API/bmminer.py

@@ -1,536 +0,0 @@
-from API import BaseMinerAPI
-
-
-class BMMinerAPI(BaseMinerAPI):
-    """
-    A class that abstracts the BMMiner API in the miners.
-
-    Each method corresponds to an API command in BMMiner.
-
-    BMMiner API documentation:
-        https://github.com/jameshilliard/bmminer/blob/master/API-README
-
-    Parameters:
-        ip: the IP address of the miner.
-        port (optional): the port of the API on the miner (standard is 4028)
-    """
-    def __init__(self, ip: str, port: int = 4028) -> None:
-        super().__init__(ip, port)
-
-    async def version(self) -> dict:
-        """
-        API 'version' command.
-
-        Returns a dict containing version information.
-        """
-        return await self.send_command("version")
-
-    async def config(self) -> dict:
-        """
-        API 'config' command.
-
-        Returns a dict containing some miner configuration information:
-            ASC Count <- the number of ASCs
-            PGA Count <- the number of PGAs
-            Pool Count <- the number of Pools
-            Strategy <- the current pool strategy
-            Log Interval <- the interval of logging
-            Device Code <- list of compiled device drivers
-            OS <- the current operating system
-            Failover-Only <- failover-only setting
-            Scan Time <- scan-time setting
-            Queue <- queue setting
-            Expiry <- expiry setting
-        """
-        return await self.send_command("config")
-
-    async def summary(self) -> dict:
-        """
-        API 'summary' command.
-
-        Returns a dict containing the status summary of the miner.
-        """
-        return await self.send_command("summary")
-
-    async def pools(self) -> dict:
-        """
-        API 'pools' command.
-
-        Returns a dict containing the status of each pool.
-        """
-        return await self.send_command("pools")
-
-    async def devs(self) -> dict:
-        """
-        API 'devs' command.
-
-        Returns a dict containing each PGA/ASC with their details.
-        """
-        return await self.send_command("devs")
-
-    async def edevs(self, old: bool = False) -> dict:
-        """
-        API 'edevs' command.
-
-        Returns a dict containing each PGA/ASC with their details,
-        ignoring blacklisted devices and zombie devices.
-
-        Parameters:
-            old (optional): include zombie devices that became zombies less than 'old' seconds ago
-        """
-        if old:
-            return await self.send_command("edevs", parameters="old")
-        else:
-            return await self.send_command("edevs")
-
-    async def pga(self, n: int) -> dict:
-        """
-        API 'pga' command.
-
-        Returns a dict containing the details of a single PGA of number N.
-
-        Parameters:
-            n: the number of the PGA to get details of.
-        """
-        return await self.send_command("pga", parameters=n)
-
-    async def pgacount(self) -> dict:
-        """
-        API 'pgacount' command.
-
-        Returns a dict containing the number of PGA devices.
-        """
-        return await self.send_command("pgacount")
-
-    async def switchpool(self, n: int) -> dict:
-        """
-        API 'switchpool' command.
-
-        Returns the STATUS section with the results of switching pools.
-
-        Parameters:
-            n: the number of the pool to switch to.
-        """
-        return await self.send_command("switchpool", parameters=n)
-
-    async def enablepool(self, n: int) -> dict:
-        """
-        API 'enablepool' command.
-
-        Returns the STATUS section with the results of enabling the pool.
-
-        Parameters:
-            n: the number of the pool to enable.
-        """
-        return await self.send_command("enablepool", parameters=n)
-
-    async def addpool(self, url: str, username: str, password: str) -> dict:
-        """
-        API 'addpool' command.
-
-        Returns the STATUS section with the results of adding the pool.
-
-        Parameters:
-            url: the URL of the new pool to add.
-            username: the users username on the new pool.
-            password: the worker password on the new pool.
-        """
-        return await self.send_command("addpool", parameters=f"{url}, {username}, {password}")
-
-    async def poolpriority(self, *n: int) -> dict:
-        """
-        API 'poolpriority' command.
-
-        Returns the STATUS section with the results of setting pool priority.
-
-        Parameters:
-            n: pool numbers in order of priority.
-        """
-        return await self.send_command("poolpriority", parameters=f"{','.join([str(item) for item in n])}")
-
-    async def poolquota(self, n: int, q: int) -> dict:
-        """
-        API 'poolquota' command.
-
-        Returns the STATUS section with the results of setting pool quota.
-
-        Parameters:
-            n: pool number to set quota on.
-            q: quota to set the pool to.
-        """
-        return await self.send_command("poolquota", parameters=f"{n}, {q}")
-
-    async def disablepool(self, n: int) -> dict:
-        """
-        API 'disablepool' command.
-
-        Returns the STATUS section with the results of disabling the pool.
-
-        Parameters:
-            n: the number of the pool to disable.
-        """
-        return await self.send_command("disablepool", parameters=n)
-
-    async def removepool(self, n: int) -> dict:
-        """
-        API 'removepool' command.
-
-        Returns the STATUS section with the results of removing the pool.
-
-        Parameters:
-            n: the number of the pool to remove.
-        """
-        return await self.send_command("removepool", parameters=n)
-
-    async def save(self, filename: str = None) -> dict:
-        """
-        API 'save' command.
-
-        Returns the STATUS section with the results of saving the config file..
-
-        Parameters:
-            filename (optional): the filename to save the config as.
-        """
-        if filename:
-            return await self.send_command("save", parameters=filename)
-        else:
-            return await self.send_command("save")
-
-    async def quit(self) -> dict:
-        """
-        API 'quit' command.
-
-        Returns a single "BYE" before BMMiner quits.
-        """
-        return await self.send_command("quit")
-
-    async def notify(self) -> dict:
-        """
-        API 'notify' command.
-
-        Returns a dict containing the last status and count of each devices problem(s).
-        """
-        return await self.send_command("notify")
-
-    async def privileged(self) -> dict:
-        """
-        API 'privileged' command.
-
-        Returns the STATUS section with an error if you have no privileged access.
-        """
-        return await self.send_command("privileged")
-
-    async def pgaenable(self, n: int) -> dict:
-        """
-        API 'pgaenable' command.
-
-        Returns the STATUS section with the results of enabling the PGA device N.
-
-        Parameters:
-            n: the number of the PGA to enable.
-        """
-        return await self.send_command("pgaenable", parameters=n)
-
-    async def pgadisable(self, n: int) -> dict:
-        """
-        API 'pgadisable' command.
-
-        Returns the STATUS section with the results of disabling the PGA device N.
-
-        Parameters:
-            n: the number of the PGA to disable.
-        """
-        return await self.send_command("pgadisable", parameters=n)
-
-    async def pgaidentify(self, n: int) -> dict:
-        """
-        API 'pgaidentify' command.
-
-        Returns the STATUS section with the results of identifying the PGA device N.
-
-        Parameters:
-            n: the number of the PGA to identify.
-        """
-        return await self.send_command("pgaidentify", parameters=n)
-
-    async def devdetails(self) -> dict:
-        """
-        API 'devdetails' command.
-
-        Returns a dict containing all devices with their static details.
-        """
-        return await self.send_command("devdetails")
-
-    async def restart(self) -> dict:
-        """
-        API 'restart' command.
-
-        Returns a single "RESTART" before BMMiner restarts.
-        """
-        return await self.send_command("restart")
-
-    async def stats(self) -> dict:
-        """
-        API 'stats' command.
-
-        Returns a dict containing stats for all device/pool with more than 1 getwork.
-        """
-        return await self.send_command("stats")
-
-    async def estats(self, old: bool = False) -> dict:
-        """
-        API 'estats' command.
-
-        Returns a dict containing stats for all device/pool with more than 1 getwork,
-        ignoring zombie devices.
-
-        Parameters:
-            old (optional): include zombie devices that became zombies less than 'old' seconds ago.
-        """
-        if old:
-            return await self.send_command("estats", parameters="old")
-        else:
-            return await self.send_command("estats")
-
-    async def check(self, command: str) -> dict:
-        """
-        API 'check' command.
-
-        Returns information about a command:
-            Exists (Y/N) <- the command exists in this version
-            Access (Y/N) <- you have access to use the command
-
-        Parameters:
-            command: the command to get information about.
-        """
-        return await self.send_command("check", parameters=command)
-
-    async def failover_only(self, failover: bool) -> dict:
-        """
-        API 'failover-only' command.
-
-        Returns the STATUS section with what failover-only was set to.
-
-        Parameters:
-            failover: what to set failover-only to.
-        """
-        return await self.send_command("failover-only", parameters=failover)
-
-    async def coin(self) -> dict:
-        """
-        API 'coin' command.
-
-        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
-        """
-        return await self.send_command("coin")
-
-    async def debug(self, setting: str) -> dict:
-        """
-        API 'debug' command.
-
-        Returns which debug setting was enabled or disabled.
-
-        Parameters:
-            setting: which setting to switch to. Options are:
-                Silent,
-                Quiet,
-                Verbose,
-                Debug,
-                RPCProto,
-                PerDevice,
-                WorkTime,
-                Normal.
-        """
-        return await self.send_command("debug", parameters=setting)
-
-    async def setconfig(self, name: str, n: int) -> dict:
-        """
-        API 'setconfig' command.
-
-        Returns the STATUS section with the results of setting 'name' to N.
-
-        Parameters:
-            name: name of the config setting to set. Options are:
-                queue,
-                scantime,
-                expiry.
-            n: the value to set the 'name' setting to.
-        """
-        return await self.send_command("setconfig", parameters=f"{name}, {n}")
-
-    async def usbstats(self) -> dict:
-        """
-        API 'usbstats' command.
-
-        Returns a dict containing the stats of all USB devices except ztex.
-        """
-        return await self.send_command("usbstats")
-
-    async def pgaset(self, n: int, opt: str, val: int = None) -> dict:
-        """
-        API 'pgaset' command.
-
-        Returns the STATUS section with the results of setting PGA N with opt[,val].
-
-        Parameters:
-            n: the PGA to set the options on.
-            opt: the option to set. Setting this to 'help' returns a help message.
-            val: the value to set the option to.
-
-        Options:
-            MMQ -
-                opt: clock
-                val: 160 - 230 (multiple of 2)
-            CMR -
-                opt: clock
-                val: 100 - 220
-        """
-        if val:
-            return await self.send_command("pgaset", parameters=f"{n}, {opt}, {val}")
-        else:
-            return await self.send_command("pgaset", parameters=f"{n}, {opt}")
-
-    async def zero(self, which: str, summary: bool) -> dict:
-        """
-        API 'zero' command.
-
-        Returns the STATUS section with info on the zero and optional summary.
-
-        Parameters:
-            which: which device to zero.
-                Setting this to 'all' zeros all devices.
-                Setting this to 'bestshare' zeros only the bestshare  values for each pool and global.
-            summary: whether or not to show a full summary.
-        """
-        return await self.send_command("zero", parameters=f"{which}, {summary}")
-
-    async def hotplug(self, n: int) -> dict:
-        """
-        API 'hotplug' command.
-
-        Returns the STATUS section with whether or not hotplug was enabled.
-        """
-        return await self.send_command("hotplug", parameters=n)
-
-    async def asc(self, n: int) -> dict:
-        """
-        API 'asc' command.
-
-        Returns a dict containing the details of a single ASC of number N.
-
-        n: the ASC device to get details of.
-        """
-        return await self.send_command("asc", parameters=n)
-
-    async def ascenable(self, n: int) -> dict:
-        """
-        API 'ascenable' command.
-
-        Returns the STATUS section with the results of enabling the ASC device N.
-
-        Parameters:
-            n: the number of the ASC to enable.
-        """
-        return await self.send_command("ascenable", parameters=n)
-
-    async def ascdisable(self, n: int) -> dict:
-        """
-        API 'ascdisable' command.
-
-        Returns the STATUS section with the results of disabling the ASC device N.
-
-        Parameters:
-            n: the number of the ASC to disable.
-        """
-        return await self.send_command("ascdisable", parameters=n)
-
-    async def ascidentify(self, n: int) -> dict:
-        """
-        API 'ascidentify' command.
-
-        Returns the STATUS section with the results of identifying the ASC device N.
-
-        Parameters:
-            n: the number of the PGA to identify.
-        """
-        return await self.send_command("ascidentify", parameters=n)
-
-    async def asccount(self) -> dict:
-        """
-        API 'asccount' command.
-
-        Returns a dict containing the number of ASC devices.
-        """
-        return await self.send_command("asccount")
-
-    async def ascset(self, n: int, opt: str, val: int = None) -> dict:
-        """
-        API 'ascset' command.
-
-        Returns the STATUS section with the results of setting ASC N with opt[,val].
-
-        Parameters:
-            n: the ASC to set the options on.
-            opt: the option to set. Setting this to 'help' returns a help message.
-            val: the value to set the option to.
-
-        Options:
-            AVA+BTB -
-                opt: freq
-                val: 256 - 1024 (chip frequency)
-            BTB -
-                opt: millivolts
-                val: 1000 - 1400 (core voltage)
-            MBA -
-                opt: reset
-                val: 0 - # of chips (reset a chip)
-
-                opt: freq
-                val: 0 - # of chips, 100 - 1400 (chip frequency)
-
-                opt: ledcount
-                val: 0 - 100 (chip count for LED)
-
-                opt: ledlimit
-                val: 0 - 200 (LED off below GH/s)
-
-                opt: spidelay
-                val: 0 - 9999 (SPI per I/O delay)
-
-                opt: spireset
-                val: i or s, 0 - 9999 (SPI regular reset)
-
-                opt: spisleep
-                val: 0 - 9999 (SPI reset sleep in ms)
-            BMA -
-                opt: volt
-                val: 0 - 9
-
-                opt: clock
-                val: 0 - 15
-        """
-        if val:
-            return await self.send_command("ascset", parameters=f"{n}, {opt}, {val}")
-        else:
-            return await self.send_command("ascset", parameters=f"{n}, {opt}")
-
-    async def lcd(self) -> dict:
-        """
-        API 'lcd' command.
-
-        Returns a dict containing an all in one status summary of the miner.
-        """
-        return await self.send_command("lcd")
-
-    async def lockstats(self) -> dict:
-        """
-        API 'lockstats' command.
-
-        Returns the STATUS section with the result of writing the lock stats to STDERR.
-        """
-        return await self.send_command("lockstats")

API/bosminer.py

@@ -1,222 +0,0 @@
-from API import BaseMinerAPI
-
-
-class BOSMinerAPI(BaseMinerAPI):
-    """
-    A class that abstracts the BOSMiner API in the miners.
-
-    Each method corresponds to an API command in BOSMiner.
-
-    BOSMiner API documentation:
-        https://docs.braiins.com/os/plus-en/Development/1_api.html
-
-    Parameters:
-        ip: the IP address of the miner.
-        port (optional): the port of the API on the miner (standard is 4028)
-    """
-    def __init__(self, ip, port=4028):
-        super().__init__(ip, port)
-
-    async def asccount(self) -> dict:
-        """
-        API 'asccount' command.
-
-        Returns a dict containing the number of ASC devices.
-        """
-        return await self.send_command("asccount")
-
-    async def asc(self, n: int) -> dict:
-        """
-        API 'asc' command.
-
-        Returns a dict containing the details of a single ASC of number N.
-
-        n: the ASC device to get details of.
-        """
-        return await self.send_command("asc", parameters=n)
-
-    async def devdetails(self) -> dict:
-        """
-        API 'devdetails' command.
-
-        Returns a dict containing all devices with their static details.
-        """
-        return await self.send_command("devdetails")
-
-    async def devs(self) -> dict:
-        """
-        API 'devs' command.
-
-        Returns a dict containing each PGA/ASC with their details.
-        """
-        return await self.send_command("devs")
-
-    async def edevs(self, old: bool = False) -> dict:
-        """
-        API 'edevs' command.
-
-        Returns a dict containing each PGA/ASC with their details,
-        ignoring blacklisted devices and zombie devices.
-
-        Parameters:
-            old (optional): include zombie devices that became zombies less than 'old' seconds ago
-        """
-        if old:
-            return await self.send_command("edevs", parameters="old")
-        else:
-            return await self.send_command("edevs")
-
-    async def pools(self) -> dict:
-        """
-        API 'pools' command.
-
-        Returns a dict containing the status of each pool.
-        """
-        return await self.send_command("pools")
-
-    async def summary(self) -> dict:
-        """
-        API 'summary' command.
-
-        Returns a dict containing the status summary of the miner.
-        """
-        return await self.send_command("summary")
-
-    async def stats(self) -> dict:
-        """
-        API 'stats' command.
-
-        Returns a dict containing stats for all device/pool with more than 1 getwork.
-        """
-        return await self.send_command("stats")
-
-    async def version(self) -> dict:
-        """
-        API 'version' command.
-
-        Returns a dict containing version information.
-        """
-        return await self.send_command("version")
-
-    async def estats(self) -> dict:
-        """
-        API 'estats' command.
-
-        Returns a dict containing stats for all device/pool with more than 1 getwork,
-        ignoring zombie devices.
-
-        Parameters:
-            old (optional): include zombie devices that became zombies less than 'old' seconds ago.
-        """
-        return await self.send_command("estats")
-
-    async def check(self, command: str) -> dict:
-        """
-        API 'check' command.
-
-        Returns information about a command:
-            Exists (Y/N) <- the command exists in this version
-            Access (Y/N) <- you have access to use the command
-
-        Parameters:
-            command: the command to get information about.
-        """
-        return await self.send_command("check", parameters=command)
-
-    async def coin(self) -> dict:
-        """
-        API 'coin' command.
-
-        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
-        """
-        return await self.send_command("coin")
-
-    async def lcd(self) -> dict:
-        """
-        API 'lcd' command.
-
-        Returns a dict containing an all in one status summary of the miner.
-        """
-        return await self.send_command("lcd")
-
-    async def switchpool(self, n: int) -> dict:
-        # BOS has not implemented this yet, they will in the future
-        raise NotImplementedError
-        # return await self.send_command("switchpool", parameters=n)
-
-    async def enablepool(self, n: int) -> dict:
-        # BOS has not implemented this yet, they will in the future
-        raise NotImplementedError
-        # return await self.send_command("enablepool", parameters=n)
-
-    async def disablepool(self, n: int) -> dict:
-        # BOS has not implemented this yet, they will in the future
-        raise NotImplementedError
-        # return await self.send_command("disablepool", parameters=n)
-
-    async def addpool(self, url: str, username: str, password: str) -> dict:
-        # BOS has not implemented this yet, they will in the future
-        raise NotImplementedError
-        # return await self.send_command("addpool", parameters=f"{url}, {username}, {password}")
-
-    async def removepool(self, n: int) -> dict:
-        # BOS has not implemented this yet, they will in the future
-        raise NotImplementedError
-        # return await self.send_command("removepool", parameters=n)
-
-    async def fans(self) -> dict:
-        """
-        API 'fans' command.
-
-        Returns a dict containing information on fans and fan speeds.
-        """
-        return await self.send_command("fans")
-
-    async def tempctrl(self) -> dict:
-        """
-        API 'tempctrl' command.
-
-        Returns a dict containing temp control configuration.
-        """
-        return await self.send_command("tempctrl")
-
-    async def temps(self) -> dict:
-        """
-        API 'temps' command.
-
-        Returns a dict containing temperature information.
-        """
-        return await self.send_command("temps")
-
-    async def tunerstatus(self) -> dict:
-        """
-        API 'tunerstatus' command.
-
-        Returns a dict containing tuning stats.
-        """
-        return await self.send_command("tunerstatus")
-
-    async def pause(self) -> dict:
-        """
-        API 'pause' command.
-
-        Pauses mining and stops power consumption and waits for resume command.
-
-        Returns a dict stating that the miner paused mining.
-        """
-        return await self.send_command("pause")
-
-    async def resume(self) -> dict:
-        """
-        API 'pause' command.
-
-        Resumes mining on the miner.
-
-        Returns a dict stating that the miner resumed mining.
-        """
-        return await self.send_command("resume")

API/btminer.py

@@ -1,548 +0,0 @@
-from API import BaseMinerAPI, APIError
-
-from passlib.handlers import md5_crypt
-import asyncio
-import re
-import json
-import hashlib
-import binascii
-from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
-import base64
-
-
-### IMPORTANT ###
-# you need to change the password of the miners using
-# the whatsminer tool, then you can set them back to
-# admin with this tool, but they must be changed to
-# something else and set back to admin with this or
-# the privileged API will not work using admin as
-# the password.
-
-
-def _crypt(word: str, salt: str) -> str:
-    # compile a standard format for the salt
-    standard_salt = re.compile('\s*\$(\d+)\$([\w\./]*)\$')
-    # check if the salt matches
-    match = standard_salt.match(salt)
-    # if the matching fails, the salt is incorrect
-    if not match:
-        raise ValueError("salt format is not correct")
-    # save the matched salt in a new variable
-    new_salt = match.group(2)
-    # encrypt the word with the salt using md5
-    result = md5_crypt.hash(word, salt=new_salt)
-    return result
-
-
-def _add_to_16(s: str) -> bytes:
-    """Add null bytes to a string until the length is 16"""
-    while len(s) % 16 != 0:
-        s += '\0'
-    return str.encode(s)  # return bytes
-
-
-def parse_btminer_priviledge_data(token_data, data):
-    # get the encoded data from the dict
-    enc_data = data['enc']
-    # get the aes key from the token data
-    aeskey = hashlib.sha256(token_data['host_passwd_md5'].encode()).hexdigest()
-    # unhexlify the aes key
-    aeskey = binascii.unhexlify(aeskey.encode())
-    # create the required decryptor
-    aes = Cipher(algorithms.AES(aeskey), modes.ECB())
-    decryptor = aes.decryptor()
-    # decode the message with the decryptor
-    ret_msg = json.loads(decryptor.update(
-        base64.decodebytes(bytes(enc_data, encoding='utf8'))
-    ).rstrip(b'\0').decode("utf8"))
-    return ret_msg
-
-
-def create_privileged_cmd(token_data: dict, command: dict) -> bytes:
-    # add token to command
-    command['token'] = token_data['host_sign']
-    # encode host_passwd data and get hexdigest
-    aeskey = hashlib.sha256(token_data['host_passwd_md5'].encode()).hexdigest()
-    # unhexlify the encoded host_passwd
-    aeskey = binascii.unhexlify(aeskey.encode())
-    # create a new AES key
-    aes = Cipher(algorithms.AES(aeskey), modes.ECB())
-    encryptor = aes.encryptor()
-    # dump the command to json
-    api_json_str = json.dumps(command)
-    # encode the json command with the aes key
-    api_json_str_enc = base64.encodebytes(encryptor.update(_add_to_16(api_json_str))).decode("utf-8").replace("\n", "")
-    # label the data as being encoded
-    data_enc = {'enc': 1, 'data': api_json_str_enc}
-    # dump the labeled data to json
-    api_packet_str = json.dumps(data_enc)
-    return api_packet_str.encode('utf-8')
-
-
-class BTMinerAPI(BaseMinerAPI):
-    def __init__(self, ip, port=4028, pwd: str = "admin"):
-        super().__init__(ip, port)
-        self.admin_pwd = pwd
-        self.current_token = None
-
-    async def send_command(self, command: str | bytes, **kwargs) -> dict:
-        """Send an API command to the miner and return the result."""
-        # check if command is a string, if its bytes its encoded and needs to be send raw
-        if isinstance(command, str):
-            # if it is a string, put it into the standard command format
-            command = json.dumps({"command": command}).encode("utf-8")
-        try:
-            # get reader and writer streams
-            reader, writer = await asyncio.open_connection(str(self.ip), self.port)
-        # handle OSError 121
-        except OSError as e:
-            if e.winerror == "121":
-                print("Semaphore Timeout has Expired.")
-            return {}
-
-        # send the command
-        writer.write(command)
-        await writer.drain()
-
-        # instantiate data
-        data = b""
-
-        # loop to receive all the data
-        try:
-            while True:
-                d = await reader.read(4096)
-                if not d:
-                    break
-                data += d
-        except Exception as e:
-            print(e)
-
-        data = self.load_api_data(data)
-
-        # close the connection
-        writer.close()
-        await writer.wait_closed()
-
-        # check if th returned data is encoded
-        if 'enc' in data.keys():
-            # try to parse the encoded data
-            try:
-                data = parse_btminer_priviledge_data(self.current_token, data)
-            except Exception as e:
-                print(e)
-
-        # if it fails to validate, it is likely an error
-        if not self.validate_command_output(data):
-            raise APIError(data["Msg"])
-
-        # return the parsed json as a dict
-        return data
-
-    async def get_token(self):
-        """
-        API 'get_token' command.
-
-        Returns an encoded token and md5 password, which are used for the privileged API.
-        """
-        data = await self.send_command("get_token")
-        pwd = _crypt(self.admin_pwd, "$1$" + data["Msg"]["salt"] + '$')
-        pwd = pwd.split('$')
-        host_passwd_md5 = pwd[3]
-        tmp = _crypt(pwd[3] + data["Msg"]["time"], "$1$" + data["Msg"]["newsalt"] + '$')
-        tmp = tmp.split('$')
-        host_sign = tmp[3]
-        self.current_token = {'host_sign': host_sign, 'host_passwd_md5': host_passwd_md5}
-        return {'host_sign': host_sign, 'host_passwd_md5': host_passwd_md5}
-
-    #### PRIVILEGED COMMANDS ####
-    # Please read the top of this file to learn
-    # how to configure the whatsminer API to
-    # use these commands.
-
-    async def update_pools(self,
-                           pool_1: str, worker_1: str, passwd_1: str,
-                           pool_2: str = None, worker_2: str = None, passwd_2: str = None,
-                           pool_3: str = None, worker_3: str = None, passwd_3: str = None):
-        # get the token and password from the miner
-        token_data = await self.get_token()
-
-        # parse pool data
-        if not pool_1:
-            raise APIError("No pools set.")
-        elif pool_2 and pool_3:
-            command = {
-                "cmd": "update_pools",
-                "pool1": pool_1, "worker1": worker_1, "passwd1": passwd_1,
-                "pool2": pool_2, "worker2": worker_2, "passwd2": passwd_2,
-                "pool3": pool_3, "worker3": worker_3, "passwd3": passwd_3,
-            }
-        elif pool_2:
-            command = {
-                "cmd": "update_pools",
-                "pool1": pool_1, "worker1": worker_1, "passwd1": passwd_1,
-                "pool2": pool_2, "worker2": worker_2, "passwd2": passwd_2
-            }
-        else:
-            command = {
-                "cmd": "update_pools",
-                "pool1": pool_1, "worker1": worker_1, "passwd1": passwd_1,
-            }
-        # encode the command with the token data
-        enc_command = create_privileged_cmd(token_data, command)
-        # send the command
-        return await self.send_command(enc_command)
-
-    async def restart(self):
-        """
-        API 'restart_btminer' command
-
-        Returns a reply informing of the restart and restarts BTMiner.
-        """
-        command = {"cmd": "restart_btminer"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def power_off(self, respbefore: bool = True):
-        """
-        API 'power_off' command.
-
-        Powers off the mining of the miner.
-
-        Returns info on the power off.
-
-        Parameters:
-            respbefore (optional): respond before powering off.
-        """
-        if respbefore:
-            command = {"cmd": "power_off", "respbefore": "true"}
-        else:
-            command = {"cmd": "power_off", "respbefore": "false"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def power_on(self):
-        """
-        API 'power_on' command.
-
-        Powers on the mining of the miner.
-
-        Returns info on the power on.
-        """
-        command = {"cmd": "power_on"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def reset_led(self):
-        """
-        API 'reset_led' command.
-
-        Resets the LED flashing to normal.
-
-        Returns a confirmation of resetting the LED.
-        """
-        command = {"cmd": "set_led", "param": "auto"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def set_led(self, color: str = "red", period: int = 2000, duration: int = 1000, start: int = 0):
-        """
-        API 'set_led' command.
-
-        Sets the LED to do some pattern set with parameters.
-
-        Returns a confirmation of setting the LED.
-        
-        Parameters:
-            color: 'red' or 'green'
-            period: flash cycle in ms
-            duration: led on time in the cycle in ms
-            start: led on time offset in the cycle in ms
-        """
-        command = {"cmd": "set_led", "color": color, "period": period, "duration": duration, "start": start}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def set_low_power(self):
-        """
-        API 'set_low_power' command.
-        
-        Sets the miner to low power mode.
-        
-        Returns the status of setting the miner to low power mode.
-        """
-        command = {"cmd": "set_low_power"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def update_firmware(self):
-        # to be determined if this will be added later
-        # requires a file stream in bytes
-        return NotImplementedError
-
-    async def reboot(self):
-        """
-        API 'reboot' command.
-        
-        Reboots the miner.
-        
-        Returns the status of the command then reboots.        
-        """
-        command = {"cmd": "reboot"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def factory_reset(self):
-        """
-        API 'factory_reset' command.
-
-        Resets the miner to factory defaults.
-
-        Returns the status of the command then resets.        
-        """
-        command = {"cmd": "factory_reset"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def update_pwd(self, old_pwd: str, new_pwd: str):
-        """
-        API 'update_pwd' command.
-
-        Updates the admin user's password.
-        
-        Returns the status of setting the password to the new password.
-        
-        Parameters:
-              old_pwd: the old admin password.
-              new_pwd: the new password to set. Max length of 8 bytes, using letters, numbers, and underscores.   
-        """
-        # check if password length is greater than 8 bytes
-        if len(new_pwd.encode('utf-8')) > 8:
-            return APIError(
-                f"New password too long, the max length is 8.  Password size: {len(new_pwd.encode('utf-8'))}")
-        command = {"cmd": "update_pwd", "old": old_pwd, "new": new_pwd}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def set_target_freq(self, percent: int):
-        """
-        API 'set_target_freq' command.
-
-        Sets the frequency for the miner ot use.
-
-        Returns the status of setting the frequency.       
-        """
-        if not -10 < percent < 100:
-            return APIError(f"Frequency % is outside of the allowed range.  Please set a % between -10 and 100")
-        command = {"cmd": "set_target_freq", "percent": str(percent)}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def enable_fast_boot(self):
-        """
-        API 'enable_fast_boot' command.
-
-        Turns on the fast boot feature on the miner.
-
-        Returns the status of setting the fast boot to on.        
-        """
-        command = {"cmd": "enable_btminer_fast_boot"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def disable_fast_boot(self):
-        """
-        API 'disable'_fast_boot' command.
-
-        Turns off the fast boot feature on the miner.
-
-        Returns the status of setting the fast boot to off.        
-        """
-        command = {"cmd": "disable_btminer_fast_boot"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def enable_web_pools(self):
-        """
-        API 'enable_web_pools' command.
-
-        Turns on the ability to change the pools through the web interface.
-
-        Returns the status of setting the web pools to enabled.        
-        """
-        command = {"cmd": "enable_web_pools"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def disable_web_pools(self):
-        """
-        API 'disable_web_pools' command.
-
-        Turns off the ability to change the pools through the web interface.
-
-        Returns the status of setting the web pools to disabled.        
-        """
-        command = {"cmd": "disable_web_pools"}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def set_hostname(self, hostname: str):
-        """
-        API 'set_hostname' command.
-
-        Sets the hostname of the miner.
-
-        Returns the status of setting the hostname.        
-        """
-        command = {"cmd": "set_hostname", "hostname": hostname}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def set_power_pct(self, percent: int):
-        """
-        API 'set_power_pct' command.
-
-        Sets the percent of power the miner should use.
-
-        Returns the status of setting the power usage to this percent.
-
-        Parameters:
-            percent: the percent to set the power usage to, between 0 and 100.
-        """
-
-        if not 0 < percent < 100:
-            return APIError(f"Power PCT % is outside of the allowed range.  Please set a % between 0 and 100")
-        command = {"cmd": "set_power_pct", "percent": str(percent)}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    async def pre_power_on(self, complete: bool, msg: str):
-        """
-        API 'pre_power_on' command.
-
-        Preheats the miner for the 'power_on' command. Can also be used to query the status of pre powering on.
-
-        Returns status of pre powering on.
-
-        Parameters:
-              complete: check whether or not it is complete.
-              msg: the message to check. "wait for adjust temp" or "adjust complete" or "adjust continue"
-        """
-
-        if not msg == "wait for adjust temp" or "adjust complete" or "adjust continue":
-            return APIError(
-                'Message is incorrect, please choose one of '
-                '["wait for adjust temp", "adjust complete", "adjust continue"]'
-            )
-        if complete:
-            complete = "true"
-        else:
-            complete = "false"
-        command = {"cmd": "pre_power_on", "complete": complete, "msg": msg}
-        token_data = await self.get_token()
-        enc_command = create_privileged_cmd(token_data, command)
-        return await self.send_command(enc_command)
-
-    #### END privileged COMMANDS ####
-
-    async def summary(self):
-        """
-        API 'summary' command.
-
-        Returns a dict containing the status summary of the miner.
-        """
-        return await self.send_command("summary")
-
-    async def pools(self):
-        """
-        API 'pools' command.
-
-        Returns a dict containing the status of each pool.
-        """
-        return await self.send_command("pools")
-
-    async def devs(self):
-        """
-        API 'devs' command.
-
-        Returns a dict containing each PGA/ASC with their details.
-        """
-        return await self.send_command("devs")
-
-    async def edevs(self):
-        """
-        API 'edevs' command.
-
-        Returns a dict containing each PGA/ASC with their details,
-        ignoring blacklisted devices and zombie devices.
-        """
-        return await self.send_command("edevs")
-
-    async def devdetails(self):
-        """
-        API 'devdetails' command.
-
-        Returns a dict containing all devices with their static details.
-        """
-        return await self.send_command("devdetails")
-
-    async def get_psu(self):
-        """
-        API 'get_psu' command.
-
-        Returns a dict containing PSU and power information.
-        """
-        return await self.send_command("get_psu")
-
-    async def version(self):
-        """
-        API 'get_version' command.
-
-        Returns a dict containing version information.
-        """
-        return await self.send_command("get_version")
-
-    async def status(self):
-        """
-        API 'status' command.
-
-        Returns a dict containing BTMiner status and firmware version.
-        """
-        return await self.send_command("status")
-
-    async def get_miner_info(self, info: str | list):
-        """
-        API 'get_miner_info' command.
-
-        Returns a dict containing requested information.
-
-        Parameters:
-            info: the info that you want to get.
-                "ip",
-                "proto",
-                "netmask",
-                "gateway",
-                "dns",
-                "hostname",
-                "mac",
-                "ledstat".
-        """
-        if isinstance(info, str):
-            return await self.send_command("get_miner_info", parameters=info)
-        else:
-            return await self.send_command("get_miner_info", parameters=f"{','.join([str(item) for item in info])}")

API/cgminer.py

@@ -1,532 +0,0 @@
-from API import BaseMinerAPI
-
-
-class CGMinerAPI(BaseMinerAPI):
-    """
-    A class that abstracts the CGMiner API in the miners.
-
-    Each method corresponds to an API command in CGMiner.
-
-    CGMiner API documentation:
-        https://github.com/ckolivas/cgminer/blob/master/API-README
-
-    Parameters:
-        ip: the IP address of the miner.
-        port (optional): the port of the API on the miner (standard is 4028)
-    """
-    def __init__(self, ip, port=4028):
-        super().__init__(ip, port)
-
-    async def version(self) -> dict:
-        """
-        API 'version' command.
-
-        Returns a dict containing version information.
-        """
-        return await self.send_command("version")
-
-    async def config(self) -> dict:
-        """
-        API 'config' command.
-
-        Returns a dict containing some miner configuration information:
-            ASC Count <- the number of ASCs
-            PGA Count <- the number of PGAs
-            Pool Count <- the number of Pools
-            Strategy <- the current pool strategy
-            Log Interval <- the interval of logging
-            Device Code <- list of compiled device drivers
-            OS <- the current operating system
-        """
-        return await self.send_command("config")
-
-    async def summary(self) -> dict:
-        """
-        API 'summary' command.
-
-        Returns a dict containing the status summary of the miner.
-        """
-        return await self.send_command("summary")
-
-    async def pools(self) -> dict:
-        """
-        API 'pools' command.
-
-        Returns a dict containing the status of each pool.
-        """
-        return await self.send_command("pools")
-
-    async def devs(self) -> dict:
-        """
-        API 'devs' command.
-
-        Returns a dict containing each PGA/ASC with their details.
-        """
-        return await self.send_command("devs")
-
-    async def edevs(self, old: bool = False) -> dict:
-        """
-        API 'edevs' command.
-
-        Returns a dict containing each PGA/ASC with their details,
-        ignoring blacklisted devices and zombie devices.
-
-        Parameters:
-            old (optional): include zombie devices that became zombies less than 'old' seconds ago
-        """
-        if old:
-            return await self.send_command("edevs", parameters="old")
-        else:
-            return await self.send_command("edevs")
-
-    async def pga(self, n: int) -> dict:
-        """
-        API 'pga' command.
-
-        Returns a dict containing the details of a single PGA of number N.
-
-        Parameters:
-            n: the number of the PGA to get details of.
-        """
-        return await self.send_command("pga", parameters=n)
-
-    async def pgacount(self) -> dict:
-        """
-        API 'pgacount' command.
-
-        Returns a dict containing the number of PGA devices.
-        """
-        return await self.send_command("pgacount")
-
-    async def switchpool(self, n: int) -> dict:
-        """
-        API 'switchpool' command.
-
-        Returns the STATUS section with the results of switching pools.
-
-        Parameters:
-            n: the number of the pool to switch to.
-        """
-        return await self.send_command("switchpool", parameters=n)
-
-    async def enablepool(self, n: int) -> dict:
-        """
-        API 'enablepool' command.
-
-        Returns the STATUS section with the results of enabling the pool.
-
-        Parameters:
-            n: the number of the pool to enable.
-        """
-        return await self.send_command("enablepool", parameters=n)
-
-    async def addpool(self, url: str, username: str, password: str) -> dict:
-        """
-        API 'addpool' command.
-
-        Returns the STATUS section with the results of adding the pool.
-
-        Parameters:
-            url: the URL of the new pool to add.
-            username: the users username on the new pool.
-            password: the worker password on the new pool.
-        """
-        return await self.send_command("addpool", parameters=f"{url}, {username}, {password}")
-
-    async def poolpriority(self, *n: int) -> dict:
-        """
-        API 'poolpriority' command.
-
-        Returns the STATUS section with the results of setting pool priority.
-
-        Parameters:
-            n: pool numbers in order of priority.
-        """
-        return await self.send_command("poolpriority", parameters=f"{','.join([str(item) for item in n])}")
-
-    async def poolquota(self, n: int, q: int) -> dict:
-        """
-        API 'poolquota' command.
-
-        Returns the STATUS section with the results of setting pool quota.
-
-        Parameters:
-            n: pool number to set quota on.
-            q: quota to set the pool to.
-        """
-        return await self.send_command("poolquota", parameters=f"{n}, {q}")
-
-    async def disablepool(self, n: int) -> dict:
-        """
-        API 'disablepool' command.
-
-        Returns the STATUS section with the results of disabling the pool.
-
-        Parameters:
-            n: the number of the pool to disable.
-        """
-        return await self.send_command("disablepool", parameters=n)
-
-    async def removepool(self, n: int) -> dict:
-        """
-        API 'removepool' command.
-
-        Returns the STATUS section with the results of removing the pool.
-
-        Parameters:
-            n: the number of the pool to remove.
-        """
-        return await self.send_command("removepool", parameters=n)
-
-    async def save(self, filename: str = None) -> dict:
-        """
-        API 'save' command.
-
-        Returns the STATUS section with the results of saving the config file..
-
-        Parameters:
-            filename (optional): the filename to save the config as.
-        """
-        if filename:
-            return await self.send_command("save", parameters=filename)
-        else:
-            return await self.send_command("save")
-
-    async def quit(self) -> dict:
-        """
-        API 'quit' command.
-
-        Returns a single "BYE" before CGMiner quits.
-        """
-        return await self.send_command("quit")
-
-    async def notify(self) -> dict:
-        """
-        API 'notify' command.
-
-        Returns a dict containing the last status and count of each devices problem(s).
-        """
-        return await self.send_command("notify")
-
-    async def privileged(self) -> dict:
-        """
-        API 'privileged' command.
-
-        Returns the STATUS section with an error if you have no privileged access.
-        """
-        return await self.send_command("privileged")
-
-    async def pgaenable(self, n: int) -> dict:
-        """
-        API 'pgaenable' command.
-
-        Returns the STATUS section with the results of enabling the PGA device N.
-
-        Parameters:
-            n: the number of the PGA to enable.
-        """
-        return await self.send_command("pgaenable", parameters=n)
-
-    async def pgadisable(self, n: int) -> dict:
-        """
-        API 'pgadisable' command.
-
-        Returns the STATUS section with the results of disabling the PGA device N.
-
-        Parameters:
-            n: the number of the PGA to disable.
-        """
-        return await self.send_command("pgadisable", parameters=n)
-
-    async def pgaidentify(self, n: int) -> dict:
-        """
-        API 'pgaidentify' command.
-
-        Returns the STATUS section with the results of identifying the PGA device N.
-
-        Parameters:
-            n: the number of the PGA to identify.
-        """
-        return await self.send_command("pgaidentify", parameters=n)
-
-    async def devdetails(self) -> dict:
-        """
-        API 'devdetails' command.
-
-        Returns a dict containing all devices with their static details.
-        """
-        return await self.send_command("devdetails")
-
-    async def restart(self) -> dict:
-        """
-        API 'restart' command.
-
-        Returns a single "RESTART" before CGMiner restarts.
-        """
-        return await self.send_command("restart")
-
-    async def stats(self) -> dict:
-        """
-        API 'stats' command.
-
-        Returns a dict containing stats for all device/pool with more than 1 getwork.
-        """
-        return await self.send_command("stats")
-
-    async def estats(self, old: bool = False) -> dict:
-        """
-        API 'estats' command.
-
-        Returns a dict containing stats for all device/pool with more than 1 getwork,
-        ignoring zombie devices.
-
-        Parameters:
-            old (optional): include zombie devices that became zombies less than 'old' seconds ago.
-        """
-        if old:
-            return await self.send_command("estats", parameters="old")
-        else:
-            return await self.send_command("estats")
-
-    async def check(self, command) -> dict:
-        """
-        API 'check' command.
-
-        Returns information about a command:
-            Exists (Y/N) <- the command exists in this version
-            Access (Y/N) <- you have access to use the command
-
-        Parameters:
-            command: the command to get information about.
-        """
-        return await self.send_command("check", parameters=command)
-
-    async def failover_only(self, failover: bool) -> dict:
-        """
-        API 'failover-only' command.
-
-        Returns the STATUS section with what failover-only was set to.
-
-        Parameters:
-            failover: what to set failover-only to.
-        """
-        return await self.send_command("failover-only", parameters=failover)
-
-    async def coin(self) -> dict:
-        """
-        API 'coin' command.
-
-        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
-        """
-        return await self.send_command("coin")
-
-    async def debug(self, setting: str) -> dict:
-        """
-        API 'debug' command.
-
-        Returns which debug setting was enabled or disabled.
-
-        Parameters:
-            setting: which setting to switch to. Options are:
-                Silent,
-                Quiet,
-                Verbose,
-                Debug,
-                RPCProto,
-                PerDevice,
-                WorkTime,
-                Normal.
-        """
-        return await self.send_command("debug", parameters=setting)
-
-    async def setconfig(self, name: str, n: int) -> dict:
-        """
-        API 'setconfig' command.
-
-        Returns the STATUS section with the results of setting 'name' to N.
-
-        Parameters:
-            name: name of the config setting to set. Options are:
-                queue,
-                scantime,
-                expiry.
-            n: the value to set the 'name' setting to.
-        """
-        return await self.send_command("setconfig", parameters=f"{name}, {n}")
-
-    async def usbstats(self) -> dict:
-        """
-        API 'usbstats' command.
-
-        Returns a dict containing the stats of all USB devices except ztex.
-        """
-        return await self.send_command("usbstats")
-
-    async def pgaset(self, n: int, opt: str, val: int = None) -> dict:
-        """
-        API 'pgaset' command.
-
-        Returns the STATUS section with the results of setting PGA N with opt[,val].
-
-        Parameters:
-            n: the PGA to set the options on.
-            opt: the option to set. Setting this to 'help' returns a help message.
-            val: the value to set the option to.
-
-        Options:
-            MMQ -
-                opt: clock
-                val: 160 - 230 (multiple of 2)
-            CMR -
-                opt: clock
-                val: 100 - 220
-        """
-        if val:
-            return await self.send_command("pgaset", parameters=f"{n}, {opt}, {val}")
-        else:
-            return await self.send_command("pgaset", parameters=f"{n}, {opt}")
-
-    async def zero(self, which: str, summary: bool) -> dict:
-        """
-        API 'zero' command.
-
-        Returns the STATUS section with info on the zero and optional summary.
-
-        Parameters:
-            which: which device to zero.
-                Setting this to 'all' zeros all devices.
-                Setting this to 'bestshare' zeros only the bestshare  values for each pool and global.
-            summary: whether or not to show a full summary.
-        """
-        return await self.send_command("zero", parameters=f"{which}, {summary}")
-
-    async def hotplug(self, n: int) -> dict:
-        """
-        API 'hotplug' command.
-
-        Returns the STATUS section with whether or not hotplug was enabled.
-        """
-        return await self.send_command("hotplug", parameters=n)
-
-    async def asc(self, n: int) -> dict:
-        """
-        API 'asc' command.
-
-        Returns a dict containing the details of a single ASC of number N.
-
-        n: the ASC device to get details of.
-        """
-        return await self.send_command("asc", parameters=n)
-
-    async def ascenable(self, n: int) -> dict:
-        """
-        API 'ascenable' command.
-
-        Returns the STATUS section with the results of enabling the ASC device N.
-
-        Parameters:
-            n: the number of the ASC to enable.
-        """
-        return await self.send_command("ascenable", parameters=n)
-
-    async def ascdisable(self, n: int) -> dict:
-        """
-        API 'ascdisable' command.
-
-        Returns the STATUS section with the results of disabling the ASC device N.
-
-        Parameters:
-            n: the number of the ASC to disable.
-        """
-        return await self.send_command("ascdisable", parameters=n)
-
-    async def ascidentify(self, n: int) -> dict:
-        """
-        API 'ascidentify' command.
-
-        Returns the STATUS section with the results of identifying the ASC device N.
-
-        Parameters:
-            n: the number of the PGA to identify.
-        """
-        return await self.send_command("ascidentify", parameters=n)
-
-    async def asccount(self) -> dict:
-        """
-        API 'asccount' command.
-
-        Returns a dict containing the number of ASC devices.
-        """
-        return await self.send_command("asccount")
-
-    async def ascset(self, n: int, opt: str, val: int = None) -> dict:
-        """
-        API 'ascset' command.
-
-        Returns the STATUS section with the results of setting ASC N with opt[,val].
-
-        Parameters:
-            n: the ASC to set the options on.
-            opt: the option to set. Setting this to 'help' returns a help message.
-            val: the value to set the option to.
-
-        Options:
-            AVA+BTB -
-                opt: freq
-                val: 256 - 1024 (chip frequency)
-            BTB -
-                opt: millivolts
-                val: 1000 - 1400 (core voltage)
-            MBA -
-                opt: reset
-                val: 0 - # of chips (reset a chip)
-
-                opt: freq
-                val: 0 - # of chips, 100 - 1400 (chip frequency)
-
-                opt: ledcount
-                val: 0 - 100 (chip count for LED)
-
-                opt: ledlimit
-                val: 0 - 200 (LED off below GH/s)
-
-                opt: spidelay
-                val: 0 - 9999 (SPI per I/O delay)
-
-                opt: spireset
-                val: i or s, 0 - 9999 (SPI regular reset)
-
-                opt: spisleep
-                val: 0 - 9999 (SPI reset sleep in ms)
-            BMA -
-                opt: volt
-                val: 0 - 9
-
-                opt: clock
-                val: 0 - 15
-        """
-        if val:
-            return await self.send_command("ascset", parameters=f"{n}, {opt}, {val}")
-        else:
-            return await self.send_command("ascset", parameters=f"{n}, {opt}")
-
-    async def lcd(self) -> dict:
-        """
-        API 'lcd' command.
-
-        Returns a dict containing an all in one status summary of the miner.
-        """
-        return await self.send_command("lcd")
-
-    async def lockstats(self) -> dict:
-        """
-        API 'lockstats' command.
-
-        Returns the STATUS section with the result of writing the lock stats to STDERR.
-        """
-        return await self.send_command("lockstats")

API/unknown.py

@@ -1,73 +0,0 @@
-from API import BaseMinerAPI
-
-
-class UnknownAPI(BaseMinerAPI):
-    def __init__(self, ip, port=4028):
-        super().__init__(ip, port)
-
-    async def asccount(self) -> dict:
-        return await self.send_command("asccount")
-
-    async def asc(self, n: int) -> dict:
-        return await self.send_command("asc", parameters=n)
-
-    async def devdetails(self) -> dict:
-        return await self.send_command("devdetails")
-
-    async def devs(self) -> dict:
-        return await self.send_command("devs")
-
-    async def edevs(self, old: bool = False) -> dict:
-        if old:
-            return await self.send_command("edevs", parameters="old")
-        else:
-            return await self.send_command("edevs")
-
-    async def pools(self) -> dict:
-        return await self.send_command("pools")
-
-    async def summary(self) -> dict:
-        return await self.send_command("summary")
-
-    async def stats(self) -> dict:
-        return await self.send_command("stats")
-
-    async def version(self) -> dict:
-        return await self.send_command("version")
-
-    async def estats(self) -> dict:
-        return await self.send_command("estats")
-
-    async def check(self) -> dict:
-        return await self.send_command("check")
-
-    async def coin(self) -> dict:
-        return await self.send_command("coin")
-
-    async def lcd(self) -> dict:
-        return await self.send_command("lcd")
-
-    async def switchpool(self, n: int) -> dict:
-        # BOS has not implemented this yet, they will in the future
-        raise NotImplementedError
-        # return await self.send_command("switchpool", parameters=n)
-
-    async def enablepool(self, n: int) -> dict:
-        # BOS has not implemented this yet, they will in the future
-        raise NotImplementedError
-        # return await self.send_command("enablepool", parameters=n)
-
-    async def disablepool(self, n: int) -> dict:
-        # BOS has not implemented this yet, they will in the future
-        raise NotImplementedError
-        # return await self.send_command("disablepool", parameters=n)
-
-    async def addpool(self, url: str, username: str, password: str) -> dict:
-        # BOS has not implemented this yet, they will in the future
-        raise NotImplementedError
-        # return await self.send_command("addpool", parameters=f"{url}, {username}, {password}")
-
-    async def removepool(self, n: int) -> dict:
-        # BOS has not implemented this yet, they will in the future
-        raise NotImplementedError
-        # return await self.send_command("removepool", parameters=n)

CFG-Util-README.md

@@ -1,44 +0,0 @@
-# CFG-Util
-
-## Interact with bitcoin mining ASICs using a simple GUI.
-
----
-## Input Fields
-### Network IP:
-* Defaults to 192.168.1.0/24 (192.168.1.0 - 192.168.1.255)
-* Enter any IP on your local network and it will automatically load your entire network with a /24 subnet (255 IP addresses)
-* You can also add a subnet mask by adding a / after the IP and entering the subnet mask
-* Press Scan to scan the selected network for miners
-
-### IP List File:
-* Use the Browse button to select a file
-* Use the Import button to import all IP addresses from a file, regardless of where they are located in the file
-* Use the Export button to export all IP addresses (or all selected IP addresses if you select some) to a file, with each seperated by a new line
-
-### Config File:
-* Use the Browse button to select a file
-* Use the Import button to import the config file (only toml format is implemented right now)
-* Use the Export button to export the config file in toml format
-
-
----
-## Data Fields
-### IP List:
-* This field contains all the IP addresses of miners that were either imported from a file or scanned
-* Select one by clicking, mutiple by holding CTRL and clicking, and select all between 2 chosen miners by holding SHIFT as you select them
-* Use the ALL button to select all IP addresses in the field, or unselect all if they are selected
-
-### Data:
-* This field contains all data that is collected by selecting IP addresses and hitting GET
-* The GET button gets data on all selected IP addresses
-* The SORT IP button sorts the data list by IP address, as well as the IP List
-* The SORT HR button sorts the data list by hashrate, as well as the IP List
-* The SORT USER button sorts the data list by pool username, as well as the IP List
-* The SORT W button sorts the data list by wattage, as well as the IP List
-
-### Config:
-* This field contains the configuration file either imported from a miner or from a file
-* The IMPORT button imports the configuration file from any 1 selected miner to the config textbox
-* The CONFIG button configures all selected miners with the config in the config textbox
-* The LIGHT button turns on the fault light/locator light on miners that support it (Only BraiinsOS for now)
-* The GENERATE button generates a new basic config in the config textbox

LICENSE.txt

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

README.md

@@ -1,146 +1,293 @@
-# minerInterface
-*A set of modules for interfacing with many common types of ASIC bitcoin miners, using both their API and SSH.*
-## Usage
-To use this repo, first download it, create a virtual environment, enter the virtual environment, and install relevant packages by navigating to this directory and running ```pip install -r requirements.txt``` on Windows or ```pip3 install -r requirements.txt``` on Mac or UNIX if the first command fails.
+# pyasic
+*A simplified and standardized interface for Bitcoin ASICs.*
 
-### CFG Util
-*CFG Util is a GUI for interfacing with the miners easily, it is mostly self-explanatory.*
+[![PyPI - Version](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyasic)](https://pypi.org/project/pyasic/)
 
-To use CFG Util you have 2 options -
-1. Run it directly with the file ```config_tool.py``` or import it with ```from cfg_util import main```, then run the ```main()``` function in an asyncio event loop like -
+[![Python - Supported Versions](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
+[![CodeFactor - Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)
+[![Commit Activity - master](https://img.shields.io/github/commit-activity/y/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/commits/master/)
 
-```python
-from cfg_util import main
+[![Code Style - Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Read The Docs - Docs](https://img.shields.io/readthedocs/pyasic)](https://docs.pyasic.org)
+[![License - Apache 2.0](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
+
+---
+## Intro
+
+Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with ASIC miners on your network, which makes it super fast.
+
+[Click here to view supported miner types](https://docs.pyasic.org/en/latest/miners/supported_types/)
+
+---
+## Installation
+
+It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
+  - [pypoetry](https://python-poetry.org/): the reccommended way, since pyasic already uses it by default. Use version 2.0+
 
-if __name__ == '__main__':
-    main()
 ```
-2. Make a build of the CFG Util for your system using cx_freeze and ```make_cfg_tool_exe.py```
-(Alternatively, you can get a build made by me here -> https://drive.google.com/drive/folders/1nzojuGRu0IszIGpwx7SvG5RlJ2_KXIOv)
-   1. Open either Command Prompt on Windows or Terminal on Mac or UNIX.
-   2. Navigate to this directory, and run ```make_cfg_tool_exe.py build``` on Windows or ```python3 make_cfg_tool_exe.py``` on Mac or UNIX.
-
-### Interfacing with miners programmatically
-<br>
-
-##### Note: If you are trying to interface with Whatsminers, there is a bug in the way they are interacted with on Windows, so to fix that you need to change the event loop policy using this code: 
-```python
-# need to import these 2 libraries, you need asyncio anyway so make sure you have sys imported
-import sys
-import asyncio
-
-# if the computer is windows, set the event loop policy to a WindowsSelector policy
-if sys.version_info[0] == 3 and sys.version_info[1] >= 8 and sys.platform.startswith('win'):
-    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
+    poetry install
 ```
 
-##### It is likely a good idea to use this code in your program anyway to be preventative.
-<br>
+  - [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
+  - [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
 
-To write your own custom programs with this repo, you have many options.
+```
+    pyenv install <python version number>
+    pyenv virtualenv <python version number> <env name>
+    pyenv activate <env name>
+```
 
-It is recommended that you explore the files in this repo to familiarize yourself with them, try starting with the miners module and going from there.
+  - [conda](https://docs.conda.io/en/latest/)
 
-A basic script to find all miners on the network and get the hashrate from them looks like this -
+##### Installing `pyasic`
 
+`python -m pip install pyasic` or `poetry install`
+
+##### Additional Developer Setup
+```
+poetry install --with dev
+pre-commit install
+```
+
+##### Building Documentation Locally
+```
+poetry install --with docs
+python docs/generate_miners.py
+poetry run mkdocs serve
+```
+
+---
+## Getting started
+
+Getting started with `pyasic` is easy.  First, find your miner (or miners) on the network by scanning for them or getting the correct class automatically for them if you know the IP.
+
+##### Scanning for miners
+To scan for miners in `pyasic`, we use the class `MinerNetwork`, which abstracts the search, communication, identification, setup, and return of a miner to 1 command.
+The command `MinerNetwork.scan()` returns a list that contains any miners found.
+```python
+import asyncio  # asyncio for handling the async part
+from pyasic.network import MinerNetwork  # miner network handles the scanning
+
+
+async def scan_miners():  # define async scan function to allow awaiting
+    # create a miner network
+    # you can pass in any IP and it will use that in a subnet with a /24 mask (255 IPs).
+    network = MinerNetwork.from_subnet("192.168.1.50/24")  # this uses the 192.168.1.0-255 network
+
+    # scan for miners asynchronously
+    # this will return the correct type of miners if they are supported with all functionality.
+    miners = await network.scan()
+    print(miners)
+
+if __name__ == "__main__":
+    asyncio.run(scan_miners())  # run the scan asynchronously with asyncio.run()
+```
+
+---
+##### Creating miners based on IP
+If you already know the IP address of your miner or miners, you can use the `MinerFactory` to communicate and identify the miners, or an abstraction of its functionality, `get_miner()`.
+The function `get_miner()` will return any miner it found at the IP address specified, or an `UnknownMiner` if it cannot identify the miner.
+```python
+import asyncio  # asyncio for handling the async part
+from pyasic import get_miner # handles miner creation
+
+
+async def get_miners():  # define async scan function to allow awaiting
+    # get the miner with the miner factory
+    # the miner factory is a singleton, and will always use the same object and cache
+    # this means you can always call it as MinerFactory().get_miner(), or just get_miner()
+    miner_1 = await get_miner("192.168.1.75")
+    miner_2 = await get_miner("192.168.1.76")
+    print(miner_1, miner_2)
+
+    # can also gather these, since they are async
+    # gathering them will get them both at the same time
+    # this makes it much faster to get a lot of miners at a time
+    tasks = [get_miner("192.168.1.75"), get_miner("192.168.1.76")]
+    miners = await asyncio.gather(*tasks)
+    print(miners)
+
+
+if __name__ == "__main__":
+    asyncio.run(get_miners())  # get the miners asynchronously with asyncio.run()
+```
+
+---
+## Data gathering
+
+Once you have your miner(s) identified, you will likely want to get data from the miner(s).  You can do this using a built-in function in each miner called `get_data()`.
+This function will return an instance of the dataclass `MinerData` with all data it can gather from the miner.
+Each piece of data in a `MinerData` instance can be referenced by getting it as an attribute, such as `MinerData().hashrate`.
+
+##### One miner
 ```python
 import asyncio
-from network import MinerNetwork
-from cfg_util.func import safe_parse_api_data
+from pyasic import get_miner
 
-async def get_hashrate():
-    # Miner Network class allows for easy scanning of a network
-    # Give it any IP on a network and it will find the whole subnet
-    # It can also be passed a subnet mask:
-        # miner_network = MinerNetwork('192.168.1.55', mask=23)
-    miner_network = MinerNetwork('192.168.1.1')
-    # Miner Network scan function returns Miner classes for all miners found
-    miners = await miner_network.scan_network_for_miners()
-    # Each miner will return with its own set of functions, and an API class instance
-    tasks = [miner.api.summary() for miner in miners]
-    # Gather all tasks asynchronously and run them
-    data = await asyncio.gather(*tasks)
-    parse_tasks = []
-    for item in data:
-        # safe_parse_api_data parses the data from a miner API
-        # It will raise an APIError (from API import APIError) if there is a problem
-        parse_tasks.append(safe_parse_api_data(item, 'SUMMARY', 0, 'MHS 5s'))
-    # Gather all tasks asynchronously and run them
-    data = await asyncio.gather(*parse_tasks)
-    # Print a list of all the hashrates
-    print(data)
+async def gather_miner_data():
+    miner = await get_miner("192.168.1.75")
+    if miner is not None:
+        miner_data = await miner.get_data()
+        print(miner_data)  # all data from the dataclass
+        print(miner_data.hashrate)  # hashrate of the miner in TH/s
 
-if __name__ == '__main__':
-    asyncio.new_event_loop().run_until_complete(get_hashrate())
+if __name__ == "__main__":
+    asyncio.run(gather_miner_data())
 ```
-<br>
-You can also create your own miner without scanning if you know the IP:
+---
+##### Multiple miners
+You can do something similar with multiple miners, with only needing to make a small change to get all the data at once.
+```python
+import asyncio  # asyncio for handling the async part
+from pyasic.network import MinerNetwork  # miner network handles the scanning
 
+
+async def gather_miner_data():  # define async scan function to allow awaiting
+    network = MinerNetwork.from_subnet("192.168.1.50/24")
+    miners = await network.scan()
+
+    # we need to asyncio.gather() all the miners get_data() functions to make them run together
+    all_miner_data = await asyncio.gather(*[miner.get_data() for miner in miners])
+
+    for miner_data in all_miner_data:
+        print(miner_data)    # print out all the data one by one
+
+if __name__ == "__main__":
+    asyncio.run(gather_miner_data())
+```
+
+---
+## Miner control
+
+`pyasic` exposes a standard interface for each miner using control functions.
+Every miner class in `pyasic` must implement all the control functions defined in `BaseMiner`.
+
+These functions are
+`check_light`,
+`fault_light_off`,
+`fault_light_on`,
+`get_config`,
+`get_data`,
+`get_errors`,
+`get_hostname`,
+`get_model`,
+`reboot`,
+`restart_backend`,
+`stop_mining`,
+`resume_mining`,
+`is_mining`,
+`send_config`, and
+`set_power_limit`.
+
+##### Usage
 ```python
 import asyncio
-import ipaddress
-from miners.miner_factory import MinerFactory
-from cfg_util.func import safe_parse_api_data
+from pyasic import get_miner
 
-async def get_miner_hashrate(ip: str):
-    # Instantiate a Miner Factory to generate miners from their IP
-    miner_factory = MinerFactory()
-    # Make the string IP into an IP address
-    miner_ip = ipaddress.ip_address(ip)
-    # Wait for the factory to return the miner
-    miner = await miner_factory.get_miner(miner_ip)
-    # Get the API data
-    summary = await miner.api.summary()
-    # safe_parse_api_data parses the data from a miner API
-    # It will raise an APIError (from API import APIError) if there is a problem
-    data = await safe_parse_api_data(summary, 'SUMMARY', 0, 'MHS 5s')
-    print(data)
 
-if __name__ == '__main__':
-    asyncio.new_event_loop().run_until_complete(get_miner_hashrate(str("192.168.1.69")))
+async def set_fault_light():
+    miner = await get_miner("192.168.1.20")
+
+    # call control function
+    await miner.fault_light_on()
+
+if __name__ == "__main__":
+    asyncio.run(set_fault_light())
 ```
 
-<br>
-Or generate a miner directly without the factory:
+---
+## Helper dataclasses
 
+##### `MinerConfig` and `MinerData`
+
+`pyasic` implements a few dataclasses as helpers to make data return types consistent across different miners and miner APIs.  The different fields of these dataclasses can all be viewed with the classmethod `cls.fields()`.
+
+---
+
+##### MinerData
+
+`MinerData` is a return from the [`get_data()`](#get-data) function, and is used to have a consistent dataset across all returns.
+
+You can call `MinerData.as_dict()` to get the dataclass as a dictionary, and there are many other helper functions contained in the class to convert to different data formats.
+
+`MinerData` instances can also be added to each other to combine their data and can be divided by a number to divide all their data, allowing you to get average data from many miners by doing -
+```python
+from pyasic import MinerData
+
+# examples of miner data
+d1 = MinerData("192.168.1.1")
+d2 = MinerData("192.168.1.2")
+
+list_of_miner_data = [d1, d2]
+
+average_data = sum(list_of_miner_data, start=MinerData("0.0.0.0"))/len(list_of_miner_data)
+```
+
+---
+
+##### MinerConfig
+
+`MinerConfig` is `pyasic`'s way to represent a configuration file from a miner.
+It is designed to unionize the configuration of all supported miner types, and is the return from [`get_config()`](#get-config).
+
+Each miner has a unique way to convert the `MinerConfig` to their specific type, there are helper functions in the class.
+In most cases these helper functions should not be used, as [`send_config()`](#send-config) takes a [`MinerConfig` and will do the conversion to the right type for you.
+
+You can use the `MinerConfig` as follows:
 ```python
 import asyncio
-from miners.bosminer import BOSminer
-from cfg_util.func import safe_parse_api_data
+from pyasic import get_miner
 
-async def get_miner_hashrate(ip: str):
-    # Create a BOSminer miner object
-    miner = BOSminer(ip)
-    # Get the API data
-    summary = await miner.api.summary()
-    # safe_parse_api_data parses the data from a miner API
-    # It will raise an APIError (from API import APIError) if there is a problem
-    data = await safe_parse_api_data(summary, 'SUMMARY', 0, 'MHS 5s')
-    print(data)
 
-if __name__ == '__main__':
-    asyncio.new_event_loop().run_until_complete(get_miner_hashrate(str("192.168.1.69")))
+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())
+
 ```
 
-<br>
-Or finally, just get the API directly:
+---
+## 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
-import asyncio
-from API.bosminer import BOSMinerAPI
-from cfg_util.func import safe_parse_api_data
+from pyasic import settings
 
-async def get_miner_hashrate(ip: str):
-    # Create a BOSminerAPI object
-    # Port can be declared manually, if not it defaults to 4028
-    api = BOSMinerAPI(ip, port=4028)
-    # Get the API data
-    summary = await api.summary()
-    # safe_parse_api_data parses the data from a miner API
-    # It will raise an APIError (from API import APIError) if there is a problem
-    data = await safe_parse_api_data(summary, 'SUMMARY', 0, 'MHS 5s')
-    print(data)
-
-if __name__ == '__main__':
-    asyncio.new_event_loop().run_until_complete(get_miner_hashrate(str("192.168.1.69")))
+settings.update("default_antminer_web_password", "my_pwd")
+```
+
+##### Default values:
+```
+"network_ping_retries": 1,
+"network_ping_timeout": 3,
+"network_scan_semaphore": None,
+"factory_get_retries": 1,
+"factory_get_timeout": 3,
+"get_data_retries": 1,
+"api_function_timeout": 5,
+"antminer_mining_mode_as_str": False,
+"default_whatsminer_rpc_password": "admin",
+"default_innosilicon_web_password": "admin",
+"default_antminer_web_password": "root",
+"default_bosminer_web_password": "root",
+"default_vnish_web_password": "admin",
+"default_goldshell_web_password": "123456789",
+"default_auradine_web_password": "admin",
+"default_epic_web_password": "letmein",
+"default_hive_web_password": "admin",
+"default_antminer_ssh_password": "miner",
+"default_bosminer_ssh_password": "root",
+
+# ADVANCED
+# Only use this if you know what you are doing
+"socket_linger_time": 1000,
 ```

cfg_util/__init__.py

@@ -1,15 +0,0 @@
-from cfg_util.miner_factory import miner_factory
-from cfg_util.layout import window
-from cfg_util.ui import ui
-
-import asyncio
-import sys
-
-# Fix bug with some whatsminers and asyncio because of a socket not being shut down:
-if sys.version_info[0] == 3 and sys.version_info[1] >= 8 and sys.platform.startswith('win'):
-    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
-
-
-def main():
-    loop = asyncio.new_event_loop()
-    loop.run_until_complete(ui())

cfg_util/func/__init__.py

@@ -1,324 +0,0 @@
-import asyncio
-import ipaddress
-import os
-import re
-import time
-
-import aiofiles
-import toml
-
-from API import APIError
-from cfg_util.func.data import safe_parse_api_data
-from cfg_util.layout import window
-from cfg_util.miner_factory import miner_factory
-from config.bos import bos_config_convert, general_config_convert_bos
-from settings import CFG_UTIL_CONFIG_THREADS as CONFIG_THREADS
-
-
-async def update_ui_with_data(key, message, append=False):
-    if append:
-        message = window[key].get_text() + message
-    window[key].update(message)
-
-
-async def update_prog_bar(amount):
-    window["progress"].Update(amount)
-    percent_done = 100 * (amount / window['progress'].maxlen)
-    window["progress_percent"].Update(f"{round(percent_done, 2)} %")
-    if percent_done == 100:
-        window["progress_percent"].Update("")
-
-
-async def set_progress_bar_len(amount):
-    window["progress"].Update(0, max=amount)
-    window["progress"].maxlen = amount
-    window["progress_percent"].Update("0.0 %")
-
-
-async def scan_network(network):
-    await update_ui_with_data("status", "Scanning")
-    await update_ui_with_data("hr_total", "")
-    network_size = len(network)
-    miner_generator = network.scan_network_generator()
-    await set_progress_bar_len(2 * network_size)
-    progress_bar_len = 0
-    miners = []
-    async for miner in miner_generator:
-        if miner:
-            miners.append(miner)
-            # can output "Identifying" for each found item, but it gets a bit cluttered
-            # and could possibly be confusing for the end user because of timing on
-            # adding the IPs
-            # window["ip_table"].update([["Identifying...", "", "", "", ""] for miner in miners])
-        progress_bar_len += 1
-        asyncio.create_task(update_prog_bar(progress_bar_len))
-    progress_bar_len += network_size - len(miners)
-    asyncio.create_task(update_prog_bar(progress_bar_len))
-    get_miner_genenerator = miner_factory.get_miner_generator(miners)
-    all_miners = []
-    async for found_miner in get_miner_genenerator:
-        all_miners.append(found_miner)
-        all_miners.sort(key=lambda x: x.ip)
-        window["ip_table"].update([[str(miner.ip), "", "", "", ""] for miner in all_miners])
-        progress_bar_len += 1
-        asyncio.create_task(update_prog_bar(progress_bar_len))
-    await update_ui_with_data("ip_count", str(len(all_miners)))
-    await update_ui_with_data("status", "")
-
-
-async def miner_light(ips: list):
-    await asyncio.gather(*[flip_light(ip) for ip in ips])
-
-
-async def flip_light(ip):
-    ip_list = window['ip_table'].Widget
-    miner = await miner_factory.get_miner(ip)
-    index = [item[0] for item in window["ip_table"].Values].index(ip)
-    index_tags = ip_list.item(index)['tags']
-    if "light" not in index_tags:
-        ip_list.item(index, tags=([*index_tags, "light"]))
-        window['ip_table'].update(row_colors=[(index, "white", "red")])
-        await miner.fault_light_on()
-    else:
-        index_tags.remove("light")
-        ip_list.item(index, tags=index_tags)
-        window['ip_table'].update(row_colors=[(index, "black", "white")])
-        await miner.fault_light_off()
-
-
-async def import_config(idx):
-    await update_ui_with_data("status", "Importing")
-    miner = await miner_factory.get_miner(ipaddress.ip_address(window["ip_table"].Values[idx[0]][0]))
-    await miner.get_config()
-    config = miner.config
-    await update_ui_with_data("config", str(config))
-    await update_ui_with_data("status", "")
-
-
-async def import_iplist(file_location):
-    await update_ui_with_data("status", "Importing")
-    if not os.path.exists(file_location):
-        return
-    else:
-        ip_list = []
-        async with aiofiles.open(file_location, mode='r') as file:
-            async for line in file:
-                ips = [x.group() for x in re.finditer(
-                    "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)", line)]
-                for ip in ips:
-                    if ip not in ip_list:
-                        ip_list.append(ipaddress.ip_address(ip))
-    ip_list.sort()
-    window["ip_table"].update([[str(ip), "", "", "", ""] for ip in ip_list])
-    await update_ui_with_data("ip_count", str(len(ip_list)))
-    await update_ui_with_data("status", "")
-
-
-async def export_iplist(file_location, ip_list_selected):
-    await update_ui_with_data("status", "Exporting")
-    if not os.path.exists(file_location):
-        return
-    else:
-        if ip_list_selected is not None and not ip_list_selected == []:
-            async with aiofiles.open(file_location, mode='w') as file:
-                for item in ip_list_selected:
-                    await file.write(str(item) + "\n")
-        else:
-            async with aiofiles.open(file_location, mode='w') as file:
-                for item in window['ip_table'].Values:
-                    await file.write(str(item[0]) + "\n")
-    await update_ui_with_data("status", "")
-
-
-async def send_config_generator(miners: list, config):
-    loop = asyncio.get_event_loop()
-    config_tasks = []
-    for miner in miners:
-        if len(config_tasks) >= CONFIG_THREADS:
-            configured = asyncio.as_completed(config_tasks)
-            config_tasks = []
-            for sent_config in configured:
-                yield await sent_config
-        config_tasks.append(loop.create_task(miner.send_config(config)))
-    configured = asyncio.as_completed(config_tasks)
-    for sent_config in configured:
-        yield await sent_config
-
-
-async def send_config(ips: list, config):
-    await update_ui_with_data("status", "Configuring")
-    await set_progress_bar_len(2 * len(ips))
-    progress_bar_len = 0
-    get_miner_genenerator = miner_factory.get_miner_generator(ips)
-    all_miners = []
-    async for miner in get_miner_genenerator:
-        all_miners.append(miner)
-        progress_bar_len += 1
-        asyncio.create_task(update_prog_bar(progress_bar_len))
-
-    config_sender_generator = send_config_generator(all_miners, config)
-    async for _config_sender in config_sender_generator:
-        progress_bar_len += 1
-        asyncio.create_task(update_prog_bar(progress_bar_len))
-    await update_ui_with_data("status", "")
-
-
-async def import_config_file(file_location):
-    await update_ui_with_data("status", "Importing")
-    if not os.path.exists(file_location):
-        return
-    else:
-        async with aiofiles.open(file_location, mode='r') as file:
-            config = await file.read()
-    await update_ui_with_data("config", await bos_config_convert(toml.loads(config)))
-    await update_ui_with_data("status", "")
-
-
-async def export_config_file(file_location, config):
-    await update_ui_with_data("status", "Exporting")
-    config = toml.loads(config)
-    config['format']['generator'] = 'upstream_config_util'
-    config['format']['timestamp'] = int(time.time())
-    config = toml.dumps(config)
-    async with aiofiles.open(file_location, mode='w+') as file:
-        await file.write(await general_config_convert_bos(config))
-    await update_ui_with_data("status", "")
-
-
-async def get_data(ip_list: list):
-    await update_ui_with_data("status", "Getting Data")
-    ips = [ipaddress.ip_address(ip) for ip in ip_list]
-    if len(ips) == 0:
-        ips = [ipaddress.ip_address(ip) for ip in [item[0] for item in window["ip_table"].Values]]
-    await set_progress_bar_len(len(ips))
-    progress_bar_len = 0
-    data_gen = asyncio.as_completed([get_formatted_data(miner) for miner in ips])
-    ip_table_data = window["ip_table"].Values
-    ordered_all_ips = [item[0] for item in ip_table_data]
-    for all_data in data_gen:
-        data_point = await all_data
-        if data_point["IP"] in ordered_all_ips:
-            ip_table_index = ordered_all_ips.index(data_point["IP"])
-            ip_table_data[ip_table_index] = [
-                data_point["IP"], data_point["host"], str(data_point['TH/s']) + " TH/s", data_point['user'], str(data_point['wattage']) + " W"
-            ]
-            window["ip_table"].update(ip_table_data)
-        progress_bar_len += 1
-        asyncio.create_task(update_prog_bar(progress_bar_len))
-
-    hashrate_list = [float(item[2].replace(" TH/s", "")) for item in window["ip_table"].Values]
-    total_hr = round(sum(hashrate_list), 2)
-    window["hr_total"].update(f"{total_hr} TH/s")
-
-    await update_ui_with_data("status", "")
-
-
-async def get_formatted_data(ip: ipaddress.ip_address):
-    miner = await miner_factory.get_miner(ip)
-    try:
-        miner_data = await miner.api.multicommand("summary", "pools", "tunerstatus")
-    except APIError:
-        return {'TH/s': "Unknown", 'IP': str(miner.ip), 'host': "Unknown", 'user': "Unknown", 'wattage': 0}
-    host = await miner.get_hostname()
-    if "tunerstatus" in miner_data.keys():
-        wattage = await safe_parse_api_data(miner_data, "tunerstatus", 0, 'TUNERSTATUS', 0, "PowerLimit")
-        # data['tunerstatus'][0]['TUNERSTATUS'][0]['PowerLimit']
-    else:
-        wattage = 0
-    if "summary" in miner_data.keys():
-        if 'MHS 5s' in miner_data['summary'][0]['SUMMARY'][0].keys():
-            th5s = round(await safe_parse_api_data(miner_data, 'summary', 0, 'SUMMARY', 0, 'MHS 5s') / 1000000, 2)
-        elif 'GHS 5s' in miner_data['summary'][0]['SUMMARY'][0].keys():
-            if not miner_data['summary'][0]['SUMMARY'][0]['GHS 5s'] == "":
-                th5s = round(float(await safe_parse_api_data(miner_data, 'summary', 0, 'SUMMARY', 0, 'GHS 5s')) / 1000,
-                             2)
-            else:
-                th5s = 0
-        else:
-            th5s = 0
-    else:
-        th5s = 0
-    if "pools" not in miner_data.keys():
-        user = "?"
-    elif not miner_data['pools'][0]['POOLS'] == []:
-        user = await safe_parse_api_data(miner_data, 'pools', 0, 'POOLS', 0, 'User')
-    else:
-        user = "Blank"
-    return {'TH/s': th5s, 'IP': str(miner.ip), 'host': host, 'user': user, 'wattage': wattage}
-
-
-async def generate_config(username, workername, v2_allowed):
-    if username and workername:
-        user = f"{username}.{workername}"
-    elif username and not workername:
-        user = username
-    else:
-        return
-
-    if v2_allowed:
-        url_1 = 'stratum2+tcp://v2.us-east.stratum.slushpool.com/u95GEReVMjK6k5YqiSFNqqTnKU4ypU2Wm8awa6tmbmDmk1bWt'
-        url_2 = 'stratum2+tcp://v2.stratum.slushpool.com/u95GEReVMjK6k5YqiSFNqqTnKU4ypU2Wm8awa6tmbmDmk1bWt'
-        url_3 = 'stratum+tcp://stratum.slushpool.com:3333'
-    else:
-        url_1 = 'stratum+tcp://ca.stratum.slushpool.com:3333'
-        url_2 = 'stratum+tcp://us-east.stratum.slushpool.com:3333'
-        url_3 = 'stratum+tcp://stratum.slushpool.com:3333'
-
-    config = {'group': [{
-        'name': 'group',
-        'quota': 1,
-        'pool': [{
-            'url': url_1,
-            'user': user,
-            'password': '123'
-        }, {
-            'url': url_2,
-            'user': user,
-            'password': '123'
-        }, {
-            'url': url_3,
-            'user': user,
-            'password': '123'
-        }]
-    }],
-        'format': {
-            'version': '1.2+',
-            'model': 'Antminer S9',
-            'generator': 'upstream_config_util',
-            'timestamp': int(time.time())
-        },
-        'temp_control': {
-            'target_temp': 80.0,
-            'hot_temp': 90.0,
-            'dangerous_temp': 120.0
-        },
-        'autotuning': {
-            'enabled': True,
-            'psu_power_limit': 900
-        }
-    }
-    window['config'].update(await bos_config_convert(config))
-
-
-async def sort_data(index: int or str):
-    await update_ui_with_data("status", "Sorting Data")
-    data_list = window['ip_table'].Values
-
-    # wattage
-    if re.match("[0-9]* W", data_list[0][index]):
-        new_list = sorted(data_list, key=lambda x: int(x[index].replace(" W", "")))
-
-    # hashrate
-    elif re.match("[0-9]*\.?[0-9]* TH\/s", data_list[0][index]):
-        new_list = sorted(data_list, key=lambda x: float(x[index].replace(" TH/s", "")))
-
-    # ip addresses
-    elif re.match("^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)",
-                  data_list[0][index]):
-        new_list = sorted(data_list, key=lambda x: ipaddress.ip_address(x[index]))
-
-    # everything else, hostname and user
-    else:
-        new_list = sorted(data_list, key=lambda x: x[index])
-    await update_ui_with_data("ip_table", new_list)
-    await update_ui_with_data("status", "")

cfg_util/func/data.py

@@ -1,47 +0,0 @@
-from API import APIError
-
-
-async def safe_parse_api_data(data: dict or list, *path: str or int, idx: int = 0):
-    path = [*path]
-    if len(path) == idx+1:
-        if isinstance(path[idx], str):
-            if isinstance(data, dict):
-                if path[idx] in data.keys():
-                    return data[path[idx]]
-        elif isinstance(path[idx], int):
-            if isinstance(data, list):
-                if len(data) > path[idx]:
-                    return data[path[idx]]
-    else:
-        if isinstance(path[idx], str):
-            if isinstance(data, dict):
-                if path[idx] in data.keys():
-                    parsed_data = await safe_parse_api_data(data[path[idx]], idx=idx+1, *path)
-                    # has to be == None, or else it fails on 0.0 hashrates
-                    if parsed_data == None:
-                        raise APIError(f"Data parsing failed on path index {idx} - \nKey: {path[idx]} \nData: {data}")
-                    return parsed_data
-                else:
-                    if idx == 0:
-                        raise APIError(f"Data parsing failed on path index {idx} - \nKey: {path[idx]} \nData: {data}")
-                    return False
-            else:
-                if idx == 0:
-                    raise APIError(f"Data parsing failed on path index {idx} - \nKey: {path[idx]} \nData: {data}")
-                return False
-        elif isinstance(path[idx], int):
-            if isinstance(data, list):
-                if len(data) > path[idx]:
-                    parsed_data = await safe_parse_api_data(data[path[idx]], idx=idx+1, *path)
-                    # has to be == None, or else it fails on 0.0 hashrates
-                    if parsed_data == None:
-                        raise APIError(f"Data parsing failed on path index {idx} - \nKey: {path[idx]} \nData: {data}")
-                    return parsed_data
-                else:
-                    if idx == 0:
-                        raise APIError(f"Data parsing failed on path index {idx} - \nKey: {path[idx]} \nData: {data}")
-                    return False
-            else:
-                if idx == 0:
-                    raise APIError(f"Data parsing failed on path index {idx} - \nKey: {path[idx]} \nData: {data}")
-                return False

cfg_util/miner_factory.py

@@ -1,7 +0,0 @@
-"""
-This file stores the MinerFactory instance used by the ConfigUtility for use in other files.
-"""
-
-from miners.miner_factory import MinerFactory
-
-miner_factory = MinerFactory()

cfg_util/ui.py

@@ -1,72 +0,0 @@
-import asyncio
-import sys
-import PySimpleGUI as sg
-
-from cfg_util.layout import window, generate_config_layout
-from cfg_util.func import scan_network, sort_data, send_config, miner_light, get_data, export_config_file, \
-    generate_config, import_config, import_iplist, import_config_file, export_iplist
-
-from network import MinerNetwork
-
-
-async def ui():
-    while True:
-        event, value = window.read(timeout=10)
-        if event in (None, 'Close', sg.WIN_CLOSED):
-            sys.exit()
-        if event == 'scan':
-            if len(value['miner_network'].split("/")) > 1:
-                network = value['miner_network'].split("/")
-                miner_network = MinerNetwork(ip_addr=network[0], mask=network[1])
-            else:
-                miner_network = MinerNetwork(value['miner_network'])
-            asyncio.create_task(scan_network(miner_network))
-        if event == 'select_all_ips':
-            if len(value["ip_table"]) == len(window["ip_table"].Values):
-                window["ip_table"].update(select_rows=())
-            else:
-                window["ip_table"].update(select_rows=([row for row in range(len(window["ip_table"].Values))]))
-        if event == 'import_config':
-            if 2 > len(value['ip_table']) > 0:
-                asyncio.create_task(import_config(value['ip_table']))
-        if event == 'light':
-            asyncio.create_task(miner_light([window['ip_table'].Values[item][0] for item in value['ip_table']]))
-        if event == "import_iplist":
-            asyncio.create_task(import_iplist(value["file_iplist"]))
-        if event == "export_iplist":
-            asyncio.create_task(export_iplist(value["file_iplist"], [window['ip_table'].Values[item][0] for item in value['ip_table']]))
-        if event == "send_config":
-            asyncio.create_task(send_config([window['ip_table'].Values[item][0] for item in value['ip_table']], value['config']))
-        if event == "import_file_config":
-            asyncio.create_task(import_config_file(value['file_config']))
-        if event == "export_file_config":
-            asyncio.create_task(export_config_file(value['file_config'], value["config"]))
-        if event == "get_data":
-            asyncio.create_task(get_data([window["ip_table"].Values[item][0] for item in value["ip_table"]]))
-        if event == "generate_config":
-            await generate_config_ui()
-        if event == "sort_data_ip":
-            asyncio.create_task(sort_data(0))  # ip index in table
-        if event == "sort_data_hr":
-            asyncio.create_task(sort_data(2))  # HR index in table
-        if event == "sort_data_user":
-            asyncio.create_task(sort_data(3))  # user index in table
-        if event == "sort_data_w":
-            asyncio.create_task(sort_data(4))  # wattage index in table
-        if event == "__TIMEOUT__":
-            await asyncio.sleep(0)
-
-
-async def generate_config_ui():
-    generate_config_window = sg.Window("Generate Config", generate_config_layout(), modal=True)
-    while True:
-        event, values = generate_config_window.read()
-        if event in (None, 'Close', sg.WIN_CLOSED):
-            break
-        if event == "generate_config_window_generate":
-            if values['generate_config_window_username']:
-                await generate_config(values['generate_config_window_username'],
-                                      values['generate_config_window_workername'],
-                                      values['generate_config_window_allow_v2'])
-                generate_config_window.close()
-                break

config/__init__.py

@@ -1,78 +0,0 @@
-"""
-SAMPLE CONFIG
--------------------
-{
-    "format": {
-        "version": "1.2+", # -> (default = "1.2+", str, (bos: format.version))
-        "model": "Antminer S9", # -> (default = "Antminer S9", str, (bos: format.model))
-        "generator": "upstream_config_util", # -> (hidden, always = "upstream_config_util", str, (bos: format.generator))
-        "timestamp": 1606842000, # -> (hidden, always = int(time.time()) (current unix time), int, (bos: format.timestamp))
-    },
-    "temperature": {
-        "mode": "auto", # -> (default = "auto", str["auto", "manual", "disabled"], (bos: temp_control.mode))
-        "target": 70.0, # -> (default = 70.0, float, (bos: temp_control.target_temp))
-        "hot": 80.0, # -> (default = 80.0, float, (bos: temp_control.hot_temp))
-        "danger": 90.0, # -> (default = 90.0, float, (bos: temp_control.dangerous_temp))
-    },
-    "fans": { # -> (optional, required if temperature["mode"] == "disabled", (bos: fan_control))
-        "min_fans": 1, # -> (default = 1, int, (bos: fan_control.min_fans))
-        "speed": 100, # -> (default = 100, 0 < int < 100, (bos: fan_control.speed))
-    },
-    "asicboost": True, # -> (default = True, bool, (bos : hash_chain_global.asic_boost))
-    "pool_groups": [
-        {
-            "group_name": "Upstream", # -> (default = "group_{index}" (group_0), str, (bos: group.[index].name))
-            "quota": 1, # -> (default = 1, int, (bos: group.[index].quota))
-            "pools": [
-                {
-                    "url": "stratum+tcp://stratum.slushpool.com:3333", # -> (str, (bos: group.[index].pool.[index].url))
-                    "username": "UpstreamDataInc.test", # -> (str, (bos: group.[index].pool.[index].user))
-                    "password": "123", # -> (str, (bos: group.[index].pool.[index].password))
-                },
-                {
-                    "url": "stratum+tcp://us-east.stratum.slushpool.com:3333", # -> (str, (bos: group.[index].pool.[index].url))
-                    "username": "UpstreamDataInc.test", # -> (str, (bos: group.[index].pool.[index].user))
-                    "password": "123", # -> (str, (bos: group.[index].pool.[index].password))
-                },
-                {
-                    "url": "stratum+tcp://ca.stratum.slushpool.com:3333", # -> (str, (bos: group.[index].pool.[index].url))
-                    "username": "UpstreamDataInc.test", # -> (str, (bos: group.[index].pool.[index].user))
-                    "password": "123", # -> (str, (bos: group.[index].pool.[index].password))
-                },
-            ]
-        },
-        {
-            "group_name": "Upstream2", # -> (default = "group_{index}" (group_1), str, (bos: group.[index].name))
-            "quota": 4, # -> (default = 1, int, (bos: group.[index].quota))
-            "pools": [
-                {
-                    "url": "stratum+tcp://stratum.slushpool.com:3333", # -> (str, (bos: group.[index].pool.[index].url))
-                    "username": "UpstreamDataTesting.test", # -> (str, (bos: group.[index].pool.[index].user))
-                    "password": "123", # -> (str, (bos: group.[index].pool.[index].password))
-                },
-                {
-                    "url": "stratum+tcp://us-east.stratum.slushpool.com:3333", # -> (str, (bos: group.[index].pool.[index].url))
-                    "username": "UpstreamDataTesting.test", # -> (str, (bos: group.[index].pool.[index].user))
-                    "password": "123", # -> (str, (bos: group.[index].pool.[index].password))
-                },
-                {
-                    "url": "stratum+tcp://ca.stratum.slushpool.com:3333", # -> (str, (bos: group.[index].pool.[index].url))
-                    "username": "UpstreamDataTesting.test", # -> (str, (bos: group.[index].pool.[index].user))
-                    "password": "123", # -> (str, (bos: group.[index].pool.[index].password))
-                },
-            ]
-        },
-    ],
-    "autotuning": {
-        "enabled": True, # -> (default = True, bool), (bos: autotuning.enabled)
-        "wattage": 900, # -> (default = 900, int, (bos: autotuning.psu_power_limit))
-    },
-    "power_scaling": {
-        "enabled": False, # -> (default = False, bool, (bos: power_scaling.enabled))
-        "power_step": 100, # -> (default = 100, int, (bos: power_scaling.power_step))
-        "min_psu_power_limit": 800, # -> (default = 800, int, (bos: power_scaling.min_psu_power_limit))
-        "shutdown_enabled": True, # -> (default = False, bool, (bos: power_scaling.shutdown_enabled))
-        "shutdown_duration": 3.0, # -> (default = 3.0, float, (bos: power_scaling.shutdown_duration))
-    }
-}
-"""

config/bos.py

@@ -1,188 +0,0 @@
-import time
-import yaml
-import toml
-
-
-async def bos_config_convert(config: dict):
-    out_config = {}
-    for opt in config:
-        if opt == "format":
-            out_config["format"] = config[opt]
-            out_config["format"]["generator"] = 'upstream_config_util'
-            out_config["format"]["timestamp"] = int(time.time())
-        elif opt == "temp_control":
-            out_config["temperature"] = {}
-            if "mode" in config[opt].keys():
-                out_config["temperature"]["mode"] = config[opt]["mode"]
-            else:
-                out_config["temperature"]["mode"] = "auto"
-
-            if "target_temp" in config[opt].keys():
-                out_config["temperature"]["target"] = config[opt]["target_temp"]
-            else:
-                out_config["temperature"]["target"] = 70.0
-
-            if "hot_temp" in config[opt].keys():
-                out_config["temperature"]["hot"] = config[opt]["hot_temp"]
-            else:
-                out_config["temperature"]["hot"] = 80.0
-
-            if "dangerous_temp" in config[opt].keys():
-                out_config["temperature"]["danger"] = config[opt]["dangerous_temp"]
-            else:
-                out_config["temperature"]["danger"] = 90.0
-        elif opt == "fan_control":
-            out_config["fans"] = {}
-            if "min_fans" in config[opt].keys():
-                out_config["fans"]["min_fans"] = config[opt]["min_fans"]
-            else:
-                out_config["fans"]["min_fans"] = 1
-            if "speed" in config[opt].keys():
-                out_config["fans"]["speed"] = config[opt]["speed"]
-            else:
-                out_config["fans"]["speed"] = 100
-        elif opt == "group":
-            out_config["pool_groups"] = [{} for _item in range(len(config[opt]))]
-            for idx in range(len(config[opt])):
-                out_config["pool_groups"][idx]["pools"] = []
-                out_config["pool_groups"][idx] = {}
-                if "name" in config[opt][idx].keys():
-                    out_config["pool_groups"][idx]["group_name"] = config[opt][idx]["name"]
-                else:
-                    out_config["pool_groups"][idx]["group_name"] = f"group_{idx}"
-                if "quota" in config[opt][idx].keys():
-                    out_config["pool_groups"][idx]["quota"] = config[opt][idx]["quota"]
-                else:
-                    out_config["pool_groups"][idx]["quota"] = 1
-                out_config["pool_groups"][idx]["pools"] = [{} for _item in range(len(config[opt][idx]["pool"]))]
-                for pool_idx in range(len(config[opt][idx]["pool"])):
-                    out_config["pool_groups"][idx]["pools"][pool_idx]["url"] = config[opt][idx]["pool"][pool_idx]["url"]
-                    out_config["pool_groups"][idx]["pools"][pool_idx]["username"] = config[opt][idx]["pool"][pool_idx][
-                        "user"]
-                    out_config["pool_groups"][idx]["pools"][pool_idx]["password"] = config[opt][idx]["pool"][pool_idx][
-                        "password"]
-        elif opt == "autotuning":
-            out_config["autotuning"] = {}
-            if "enabled" in config[opt].keys():
-                out_config["autotuning"]["enabled"] = config[opt]["enabled"]
-            else:
-                out_config["autotuning"]["enabled"] = True
-            if "psu_power_limit" in config[opt].keys():
-                out_config["autotuning"]["wattage"] = config[opt]["psu_power_limit"]
-            else:
-                out_config["autotuning"]["wattage"] = 900
-        elif opt == "power_scaling":
-            out_config["power_scaling"] = {}
-            if "enabled" in config[opt].keys():
-                out_config["power_scaling"]["enabled"] = config[opt]["enabled"]
-            else:
-                out_config["power_scaling"]["enabled"] = False
-            if "power_step" in config[opt].keys():
-                out_config["power_scaling"]["power_step"] = config[opt]["power_step"]
-            else:
-                out_config["power_scaling"]["power_step"] = 100
-            if "min_psu_power_limit" in config[opt].keys():
-                out_config["power_scaling"]["min_psu_power_limit"] = config[opt]["min_psu_power_limit"]
-            else:
-                out_config["power_scaling"]["min_psu_power_limit"] = 800
-            if "shutdown_enabled" in config[opt].keys():
-                out_config["power_scaling"]["shutdown_enabled"] = config[opt]["shutdown_enabled"]
-            else:
-                out_config["power_scaling"]["shutdown_enabled"] = False
-            if "shutdown_duration" in config[opt].keys():
-                out_config["power_scaling"]["shutdown_duration"] = config[opt]["shutdown_duration"]
-            else:
-                out_config["power_scaling"]["shutdown_duration"] = 3.0
-    return yaml.dump(out_config, sort_keys=False)
-
-
-async def general_config_convert_bos(yaml_config):
-    config = yaml.load(yaml_config, Loader=yaml.SafeLoader)
-    out_config = {}
-    for opt in config:
-        if opt == "format":
-            out_config["format"] = config[opt]
-            out_config["format"]["generator"] = 'upstream_config_util'
-            out_config["format"]["timestamp"] = int(time.time())
-        elif opt == "temperature":
-            out_config["temp_control"] = {}
-            if "mode" in config[opt].keys():
-                out_config["temp_control"]["mode"] = config[opt]["mode"]
-            else:
-                out_config["temp_control"]["mode"] = "auto"
-
-            if "target" in config[opt].keys():
-                out_config["temp_control"]["target_temp"] = config[opt]["target"]
-            else:
-                out_config["temp_control"]["target_temp"] = 70.0
-
-            if "hot" in config[opt].keys():
-                out_config["temp_control"]["hot_temp"] = config[opt]["hot"]
-            else:
-                out_config["temp_control"]["hot_temp"] = 80.0
-
-            if "danger" in config[opt].keys():
-                out_config["temp_control"]["dangerous_temp"] = config[opt]["danger"]
-            else:
-                out_config["temp_control"]["dangerous_temp"] = 90.0
-        elif opt == "fans":
-            out_config["fan_control"] = {}
-            if "min_fans" in config[opt].keys():
-                out_config["fan_control"]["min_fans"] = config[opt]["min_fans"]
-            else:
-                out_config["fan_control"]["min_fans"] = 1
-            if "speed" in config[opt].keys():
-                out_config["fan_control"]["speed"] = config[opt]["speed"]
-            else:
-                out_config["fan_control"]["speed"] = 100
-        elif opt == "pool_groups":
-            out_config["group"] = [{} for _item in range(len(config[opt]))]
-            for idx in range(len(config[opt])):
-                out_config["group"][idx]["pools"] = []
-                out_config["group"][idx] = {}
-                if "group_name" in config[opt][idx].keys():
-                    out_config["group"][idx]["name"] = config[opt][idx]["group_name"]
-                else:
-                    out_config["group"][idx]["name"] = f"group_{idx}"
-                if "quota" in config[opt][idx].keys():
-                    out_config["group"][idx]["quota"] = config[opt][idx]["quota"]
-                else:
-                    out_config["group"][idx]["quota"] = 1
-                out_config["group"][idx]["pool"] = [{} for _item in range(len(config[opt][idx]["pools"]))]
-                for pool_idx in range(len(config[opt][idx]["pools"])):
-                    out_config["group"][idx]["pool"][pool_idx]["url"] = config[opt][idx]["pools"][pool_idx]["url"]
-                    out_config["group"][idx]["pool"][pool_idx]["user"] = config[opt][idx]["pools"][pool_idx]["username"]
-                    out_config["group"][idx]["pool"][pool_idx]["password"] = config[opt][idx]["pools"][pool_idx]["password"]
-        elif opt == "autotuning":
-            out_config["autotuning"] = {}
-            if "enabled" in config[opt].keys():
-                out_config["autotuning"]["enabled"] = config[opt]["enabled"]
-            else:
-                out_config["autotuning"]["enabled"] = True
-            if "wattage" in config[opt].keys():
-                out_config["autotuning"]["psu_power_limit"] = config[opt]["wattage"]
-            else:
-                out_config["autotuning"]["psu_power_limit"] = 900
-        elif opt == "power_scaling":
-            out_config["power_scaling"] = {}
-            if "enabled" in config[opt].keys():
-                out_config["power_scaling"]["enabled"] = config[opt]["enabled"]
-            else:
-                out_config["power_scaling"]["enabled"] = False
-            if "power_step" in config[opt].keys():
-                out_config["power_scaling"]["power_step"] = config[opt]["power_step"]
-            else:
-                out_config["power_scaling"]["power_step"] = 100
-            if "min_psu_power_limit" in config[opt].keys():
-                out_config["power_scaling"]["min_psu_power_limit"] = config[opt]["min_psu_power_limit"]
-            else:
-                out_config["power_scaling"]["min_psu_power_limit"] = 800
-            if "shutdown_enabled" in config[opt].keys():
-                out_config["power_scaling"]["shutdown_enabled"] = config[opt]["shutdown_enabled"]
-            else:
-                out_config["power_scaling"]["shutdown_enabled"] = False
-            if "shutdown_duration" in config[opt].keys():
-                out_config["power_scaling"]["shutdown_duration"] = config[opt]["shutdown_duration"]
-            else:
-                out_config["power_scaling"]["shutdown_duration"] = 3.0
-    return toml.dumps(out_config)

config/sample_config_cgminer

@@ -1,17 +0,0 @@
-
-config cgminer 'default'
-	option pool1pw 'x'
-	option pool2pw 'x'
-	option pool3pw 'x'
-	option voltage_level_offset '0'
-	option fan '10'
-	option api_allow 'W:0/0'
-	option power_mode 'balance'
-	option pool1url 'stratum+tcp://ca.stratum.slushpool.com:3333'
-	option pool1user 'poolacct.worker1'
-	option pool2url 'stratum+tcp://ca.stratum.slushpool.com:3333'
-	option pool2user 'poolacct.worker2'
-	option pool3url 'stratum+tcp://ca.stratum.slushpool.com:3333'
-	option pool3user 'poolacct.worker3'
-	option ntp_enable 'openwrt'
-

config_tool.py

@@ -1,4 +0,0 @@
-from cfg_util import main
-
-if __name__ == '__main__':
-    main()

docs/config/miner_config.md

@@ -0,0 +1,8 @@
+# pyasic
+## Miner Config
+
+::: pyasic.config.MinerConfig
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/data/error_codes.md

@@ -0,0 +1,33 @@
+# pyasic
+<br>
+
+## Whatsminer Error Codes
+::: pyasic.data.error_codes.WhatsminerError
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+<br>
+
+## Braiins OS Error Codes
+::: pyasic.data.error_codes.BraiinsOSError
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+<br>
+
+## X19 Error Codes
+::: pyasic.data.error_codes.X19Error
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+<br>
+
+## Innosilicon Error Codes
+::: pyasic.data.error_codes.InnosiliconError
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/data/miner_data.md

@@ -0,0 +1,22 @@
+# pyasic
+
+## Miner Data
+::: pyasic.data.MinerData
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## HashBoard Data
+::: pyasic.data.HashBoard
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## Fan Data
+::: pyasic.data.Fan
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/generate_miners.py

@@ -0,0 +1,204 @@
+import asyncio
+import importlib
+import os
+import warnings
+from pathlib import Path
+
+from pyasic.miners.factory import MINER_CLASSES, MinerTypes
+
+warnings.filterwarnings("ignore")
+
+
+def path(cls):
+    module = importlib.import_module(cls.__module__)
+    return module.__name__ + "." + cls.__name__
+
+
+def make(cls):
+    p = path(cls)
+    return p.split(".")[2]
+
+
+def model_type(cls):
+    p = path(cls)
+    return p.split(".")[4]
+
+
+def backend_str(backend: MinerTypes) -> str:
+    match backend:
+        case MinerTypes.ANTMINER:
+            return "Stock Firmware Antminers"
+        case MinerTypes.AURADINE:
+            return "Stock Firmware Auradine Miners"
+        case MinerTypes.AVALONMINER:
+            return "Stock Firmware Avalonminers"
+        case MinerTypes.VNISH:
+            return "Vnish Firmware Miners"
+        case MinerTypes.EPIC:
+            return "ePIC Firmware Miners"
+        case MinerTypes.BRAIINS_OS:
+            return "BOS+ Firmware Miners"
+        case MinerTypes.HIVEON:
+            return "HiveOS Firmware Miners"
+        case MinerTypes.INNOSILICON:
+            return "Stock Firmware Innosilicons"
+        case MinerTypes.WHATSMINER:
+            return "Stock Firmware Whatsminers"
+        case MinerTypes.GOLDSHELL:
+            return "Stock Firmware Goldshells"
+        case MinerTypes.LUX_OS:
+            return "LuxOS Firmware Miners"
+        case MinerTypes.MARATHON:
+            return "Mara Firmware Miners"
+        case MinerTypes.BITAXE:
+            return "Stock Firmware BitAxe Miners"
+        case MinerTypes.LUCKYMINER:
+            return "Stock Firmware Lucky Miners"
+        case MinerTypes.ICERIVER:
+            return "Stock Firmware IceRiver Miners"
+        case MinerTypes.HAMMER:
+            return "Stock Firmware Hammer Miners"
+        case MinerTypes.VOLCMINER:
+            return "Stock Firmware Volcminers"
+        case MinerTypes.ELPHAPEX:
+            return "Stock Firmware Elphapex Miners"
+        case MinerTypes.MSKMINER:
+            return "MSKMiner Firmware Miners"
+    raise TypeError("Unknown miner backend, cannot generate docs")
+
+
+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 = """
+- [{}] Shutdowns
+- [{}] Power Modes
+- [{}] Setpoints
+- [{}] Presets
+
+::: {}
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+"""
+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.
+
+Keep in mind that some functionality is only supported for specific miners or firmwares, please check the page for your miner to make sure the functionality you need is supported.
+
+##### 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 = {}
+done = []
+
+for m in MINER_CLASSES:
+    for t in sorted(MINER_CLASSES[m], key=lambda x: x or ""):
+        if t is not None and MINER_CLASSES[m][t] not in done:
+            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)
+            done.append(miner)
+
+
+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):
+            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:
+                    obj = item("1.1.1.1")
+                    header = obj.model
+                    file.write(MINER_HEADER_FORMAT.format(header))
+                    file.write(
+                        DATA_FORMAT.format(
+                            "x" if obj.supports_shutdown else " ",
+                            "x" if obj.supports_power_modes else " ",
+                            "x" if obj.supports_autotuning else " ",
+                            "x" if obj.supports_presets else " ",
+                            path(item),
+                        )
+                    )
+
+
+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 = minstance("1.1.1.1").model
+                    file.write(
+                        MINER_DETAILS.format(
+                            make(minstance), mtype, create_url_str(model), model
+                        )
+                    )
+                file.write(MINER_TYPE_CLOSER)
+            file.write(BACKEND_TYPE_CLOSER)
+
+
+if __name__ == "__main__":
+    root_directory = Path(__file__).parent.joinpath("miners")
+    create_directory_structure(root_directory, m_data)
+    create_supported_types(root_directory)

docs/index.md

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

docs/miners/antminer/X15.md

@@ -0,0 +1,29 @@
+# pyasic
+## X15 Models
+
+## Z15 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.cgminer.X15.Z15.CGMinerZ15
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Z15 Pro (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X15.Z15.BMMinerZ15Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/antminer/X17.md

@@ -0,0 +1,211 @@
+# pyasic
+## X17 Models
+
+## S17 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S17 Pro (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S17+ (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S17e (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17e
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T17 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T17+ (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T17e (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17e
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S17 (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S17 Pro (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S17+ (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S17e (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17e
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T17 (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T17+ (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T17e (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17e
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S17 Pro (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X17.S17.VNishS17Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S17+ (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X17.S17.VNishS17Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/antminer/X21.md

@@ -0,0 +1,328 @@
+# pyasic
+## X21 Models
+
+## S21 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X21.S21.BMMinerS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 Hydro (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X21.S21.BMMinerS21Hydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 Pro (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X21.S21.BMMinerS21Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21+ (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X21.S21.BMMinerS21Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21+ Hydro (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X21.S21.BMMinerS21PlusHydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T21 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X21.T21.BMMinerT21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X21.S21.BOSMinerS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 Hydro (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X21.S21.BOSMinerS21Hydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 Pro (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X21.S21.BOSMinerS21Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21+ (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X21.S21.BOSMinerS21Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21+ Hydro (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X21.S21.BOSMinerS21PlusHydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T21 (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X21.T21.BOSMinerT21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X21.S21.VNishS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 Hydro (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X21.S21.VNishS21Hydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 Pro (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X21.S21.VNishS21Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21+ (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X21.S21.VNishS21Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21+ Hydro (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X21.S21.VNishS21PlusHydro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T21 (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X21.T21.VNishT21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 (ePIC)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.epic.X21.S21.ePICS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 Pro (ePIC)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.epic.X21.S21.ePICS21Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T21 (ePIC)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.epic.X21.T21.ePICT21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 (LuxOS)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.luxos.X21.S21.LUXMinerS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T21 (LuxOS)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.luxos.X21.T21.LUXMinerT21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S21 (MaraFW)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.marathon.X21.S21.MaraS21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T21 (MaraFW)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.marathon.X21.T21.MaraT21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/antminer/X3.md

@@ -0,0 +1,81 @@
+# pyasic
+## X3 Models
+
+## D3 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.cgminer.X3.D3.CGMinerD3
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## HS3 (Stock)
+
+- [ ] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X3.HS3.BMMinerHS3
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## KA3 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X3.KA3.BMMinerKA3
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## KS3 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X3.KS3.BMMinerKS3
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## L3+ (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X3.L3.BMMinerL3Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## L3+ (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X3.L3.VNishL3Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/antminer/X5.md

@@ -0,0 +1,42 @@
+# pyasic
+## X5 Models
+
+## DR5 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.cgminer.X5.DR5.CGMinerDR5
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## KS5 (Stock)
+
+- [ ] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X5.KS5.BMMinerKS5
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## KS5 (Stock)
+
+- [ ] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X5.KS5.BMMinerKS5Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/antminer/X7.md

@@ -0,0 +1,55 @@
+# pyasic
+## X7 Models
+
+## D7 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X7.D7.BMMinerD7
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## K7 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X7.K7.BMMinerK7
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## L7 (Stock)
+
+- [ ] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X7.L7.BMMinerL7
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## L7 (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X7.L7.VNishL7
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/antminer/X9.md

@@ -0,0 +1,146 @@
+# pyasic
+## X9 Models
+
+## D9 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X9.D9.BMMinerD9
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## E9Pro (Stock)
+
+- [ ] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X9.E9.BMMinerE9Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## L9 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X9.L9.BMMinerL9
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S9 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S9i (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9i
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S9j (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9j
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T9 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bmminer.X9.T9.BMMinerT9
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S9 (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.bosminer.X9.S9.BOSMinerS9
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## L9 (VNish)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.vnish.X9.L9.VNishL9
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## T9 (Hive)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.antminer.hiveon.X9.T9.HiveonT9
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## S9 (LuxOS)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [x] Presets
+
+::: pyasic.miners.antminer.luxos.X9.S9.LUXMinerS9
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/auradine/AD.md

@@ -0,0 +1,42 @@
+# pyasic
+## AD Models
+
+## AT1500 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.auradine.flux.AD.AT1.AuradineFluxAT1500
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## AT2860 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.auradine.flux.AD.AT2.AuradineFluxAT2860
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## AT2880 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.auradine.flux.AD.AT2.AuradineFluxAT2880
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/auradine/AI.md

@@ -0,0 +1,29 @@
+# pyasic
+## AI Models
+
+## AI2500 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.auradine.flux.AI.AI2.AuradineFluxAI2500
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## AI3680 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.auradine.flux.AI.AI3.AuradineFluxAI3680
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/auradine/AT.md

@@ -0,0 +1,29 @@
+# pyasic
+## AT Models
+
+## AD2500 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.auradine.flux.AT.AD2.AuradineFluxAD2500
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## AD3500 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.auradine.flux.AT.AD3.AuradineFluxAD3500
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/avalonminer/A10X.md

@@ -0,0 +1,42 @@
+# pyasic
+## A10X Models
+
+## Avalon 1026 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A10X.A1026.CGMinerAvalon1026
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Avalon 1047 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A10X.A1047.CGMinerAvalon1047
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Avalon 1066 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A10X.A1066.CGMinerAvalon1066
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/avalonminer/A11X.md

@@ -0,0 +1,29 @@
+# pyasic
+## A11X Models
+
+## Avalon 1126 Pro (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A11X.A1126.CGMinerAvalon1126Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Avalon 1166 Pro (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A11X.A1166.CGMinerAvalon1166Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/avalonminer/A12X.md

@@ -0,0 +1,16 @@
+# pyasic
+## A12X Models
+
+## Avalon 1246 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A12X.A1246.CGMinerAvalon1246
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/avalonminer/A15X.md

@@ -0,0 +1,16 @@
+# pyasic
+## A15X Models
+
+## Avalon 1566 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A15X.A1566.CGMinerAvalon1566
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/avalonminer/A7X.md

@@ -0,0 +1,42 @@
+# pyasic
+## A7X Models
+
+## Avalon 721 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A7X.A721.CGMinerAvalon721
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Avalon 741 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A7X.A741.CGMinerAvalon741
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Avalon 761 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A7X.A761.CGMinerAvalon761
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/avalonminer/A8X.md

@@ -0,0 +1,42 @@
+# pyasic
+## A8X Models
+
+## Avalon 821 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A8X.A821.CGMinerAvalon821
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Avalon 841 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A8X.A841.CGMinerAvalon841
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Avalon 851 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A8X.A851.CGMinerAvalon851
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/avalonminer/A9X.md

@@ -0,0 +1,16 @@
+# pyasic
+## A9X Models
+
+## Avalon 921 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.A9X.A921.CGMinerAvalon921
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/avalonminer/nano.md

@@ -0,0 +1,29 @@
+# pyasic
+## nano Models
+
+## Avalon Nano 3s (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.nano.nano3.CGMinerAvalonNano3s
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Avalon Nano 3 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.avalonminer.cgminer.nano.nano3.CGMinerAvalonNano3
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/backends/bfgminer.md

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

docs/miners/backends/bmminer.md

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

docs/miners/backends/bosminer.md

@@ -0,0 +1,16 @@
+# pyasic
+## BOSMiner Backend
+
+::: pyasic.miners.backends.braiins_os.BOSMiner
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## BOSer Backend
+
+::: pyasic.miners.backends.braiins_os.BOSer
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/miners/backends/btminer.md

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

docs/miners/backends/cgminer.md

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

docs/miners/backends/epic.md

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

docs/miners/backends/hiveon.md

@@ -0,0 +1,15 @@
+# pyasic
+## Modern Hiveon Backend
+
+::: pyasic.miners.backends.hiveon.HiveonModern
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## Old Hiveon Backend
+::: pyasic.miners.backends.hiveon.HiveonOld
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/miners/backends/luxminer.md

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

docs/miners/backends/vnish.md

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

docs/miners/base_miner.md

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

docs/miners/bitaxe/BM.md

@@ -0,0 +1,55 @@
+# pyasic
+## BM Models
+
+## Ultra (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.bitaxe.espminer.BM.BM1366.BitAxeUltra
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Supra (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.bitaxe.espminer.BM.BM1368.BitAxeSupra
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Gamma (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.bitaxe.espminer.BM.BM1370.BitAxeGamma
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## Max (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.bitaxe.espminer.BM.BM1397.BitAxeMax
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/blockminer/blockminer.md

@@ -0,0 +1,42 @@
+# pyasic
+## blockminer Models
+
+## BlockMiner 520i (ePIC)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.blockminer.epic.blockminer.blockminer.ePICBlockMiner520i
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## BlockMiner 720i (ePIC)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.blockminer.epic.blockminer.blockminer.ePICBlockMiner720i
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## BlockMiner eLITE 1.0 (ePIC)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.blockminer.epic.blockminer.blockminer.ePICBlockMinerELITE1
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/braiins/BMM.md

@@ -0,0 +1,29 @@
+# pyasic
+## BMM Models
+
+## BMM100 (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.braiins.braiins.BMM.BMM.BraiinsBMM100
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## BMM101 (BOS+)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.braiins.braiins.BMM.BMM.BraiinsBMM101
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/elphapex/DGX.md

@@ -0,0 +1,42 @@
+# pyasic
+## DGX Models
+
+## DG1 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.elphapex.daoge.DGX.DG1.ElphapexDG1
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## DG1+ (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.elphapex.daoge.DGX.DG1.ElphapexDG1Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## DG1Home (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.elphapex.daoge.DGX.DG1.ElphapexDG1Home
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/functions.md

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

docs/miners/goldshell/Byte.md

@@ -0,0 +1,16 @@
+# pyasic
+## Byte Models
+
+## Byte (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.goldshell.bfgminer.Byte.Byte.GoldshellByte
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/goldshell/X5.md

@@ -0,0 +1,42 @@
+# pyasic
+## X5 Models
+
+## CK5 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.goldshell.bfgminer.X5.CK5.GoldshellCK5
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## HS5 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.goldshell.bfgminer.X5.HS5.GoldshellHS5
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## KD5 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.goldshell.bfgminer.X5.KD5.GoldshellKD5
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/goldshell/XBox.md

@@ -0,0 +1,29 @@
+# pyasic
+## XBox Models
+
+## KD Box II (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.goldshell.bfgminer.XBox.KDBox.GoldshellKDBoxII
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## KD Box Pro (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.goldshell.bfgminer.XBox.KDBox.GoldshellKDBoxPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/goldshell/XMax.md

@@ -0,0 +1,16 @@
+# pyasic
+## XMax Models
+
+## KD Max (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.goldshell.bfgminer.XMax.KDMax.GoldshellKDMax
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/hammer/DX.md

@@ -0,0 +1,16 @@
+# pyasic
+## DX Models
+
+## D10 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.hammer.blackminer.DX.D10.HammerD10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/iceriver/KSX.md

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

docs/miners/innosilicon/A10X.md

@@ -0,0 +1,16 @@
+# pyasic
+## A10X Models
+
+## A10X (Stock)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.innosilicon.cgminer.A10X.A10X.InnosiliconA10X
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/innosilicon/A11X.md

@@ -0,0 +1,29 @@
+# pyasic
+## A11X Models
+
+## A11 (Stock)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.innosilicon.cgminer.A11X.A11.InnosiliconA11
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## A11MX (Stock)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.innosilicon.cgminer.A11X.A11M.InnosiliconA11MX
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/innosilicon/T3X.md

@@ -0,0 +1,16 @@
+# pyasic
+## T3X Models
+
+## T3H+ (Stock)
+
+- [x] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.innosilicon.cgminer.T3X.T3H.InnosiliconT3HPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/luckyminer/LV.md

@@ -0,0 +1,29 @@
+# pyasic
+## LV Models
+
+## LV07 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.luckyminer.espminer.LV.LV07.LuckyMinerLV07
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## LV08 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.luckyminer.espminer.LV.LV08.LuckyMinerLV08
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/miner_factory.md

@@ -0,0 +1,36 @@
+# pyasic
+## Miner Factory
+
+[`MinerFactory`][pyasic.miners.factory.MinerFactory] is the way to create miner types in `pyasic`.  The most important method is [`get_miner()`][pyasic.get_miner], which is mapped to [`pyasic.get_miner()`][pyasic.get_miner], and should be used from there.
+
+The instance used for [`pyasic.get_miner()`][pyasic.get_miner] is `pyasic.miner_factory`.
+
+[`MinerFactory`][pyasic.miners.factory.MinerFactory] also keeps a cache, which can be cleared if needed with `pyasic.miner_factory.clear_cached_miners()`.
+
+Finally, there is functionality to get multiple miners without using `asyncio.gather()` explicitly.  Use `pyasic.miner_factory.get_multiple_miners()` with a list of IPs as strings to get a list of miner instances.  You can also get multiple miners with an `AsyncGenerator` by using `pyasic.miner_factory.get_miner_generator()`.
+
+::: pyasic.miners.factory.MinerFactory
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+<br>
+
+## Get Miner
+::: pyasic.miners.get_miner
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+<br>
+
+## AnyMiner
+::: pyasic.miners.base.AnyMiner
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+[`AnyMiner`][pyasic.miners.base.AnyMiner] is a placeholder type variable used for typing returns of functions.
+A function returning [`AnyMiner`][pyasic.miners.base.AnyMiner] will always return a subclass of [`BaseMiner`][pyasic.miners.base.BaseMiner],
+and is used to specify a function returning some arbitrary type of miner class instance.

docs/miners/supported_types.md

@@ -0,0 +1,993 @@
+# 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.
+
+Keep in mind that some functionality is only supported for specific miners or firmwares, please check the page for your miner to make sure the functionality you need is supported.
+
+##### pyasic currently supports the following miners and subtypes:
+<style>
+details {
+    margin:0px;
+    padding-top:0px;
+    padding-bottom:0px;
+}
+</style>
+
+<details>
+<summary>Stock Firmware Antminers:</summary>
+    <ul>
+        <details>
+            <summary>X3 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X3#d3-stock">D3 (Stock)</a></li>
+                    <li><a href="../antminer/X3#hs3-stock">HS3 (Stock)</a></li>
+                    <li><a href="../antminer/X3#l3_1-stock">L3+ (Stock)</a></li>
+                    <li><a href="../antminer/X3#ka3-stock">KA3 (Stock)</a></li>
+                    <li><a href="../antminer/X3#ks3-stock">KS3 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X5 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X5#dr5-stock">DR5 (Stock)</a></li>
+                    <li><a href="../antminer/X5#ks5-stock">KS5 (Stock)</a></li>
+                    <li><a href="../antminer/X5#ks5-stock">KS5 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X7 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X7#l7-stock">L7 (Stock)</a></li>
+                    <li><a href="../antminer/X7#k7-stock">K7 (Stock)</a></li>
+                    <li><a href="../antminer/X7#d7-stock">D7 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X9 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X9#e9pro-stock">E9Pro (Stock)</a></li>
+                    <li><a href="../antminer/X9#d9-stock">D9 (Stock)</a></li>
+                    <li><a href="../antminer/X9#s9-stock">S9 (Stock)</a></li>
+                    <li><a href="../antminer/X9#s9i-stock">S9i (Stock)</a></li>
+                    <li><a href="../antminer/X9#s9j-stock">S9j (Stock)</a></li>
+                    <li><a href="../antminer/X9#t9-stock">T9 (Stock)</a></li>
+                    <li><a href="../antminer/X9#l9-stock">L9 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X15 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X15#z15-stock">Z15 (Stock)</a></li>
+                    <li><a href="../antminer/X15#z15-pro-stock">Z15 Pro (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X17 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X17#s17-stock">S17 (Stock)</a></li>
+                    <li><a href="../antminer/X17#s17_1-stock">S17+ (Stock)</a></li>
+                    <li><a href="../antminer/X17#s17-pro-stock">S17 Pro (Stock)</a></li>
+                    <li><a href="../antminer/X17#s17e-stock">S17e (Stock)</a></li>
+                    <li><a href="../antminer/X17#t17-stock">T17 (Stock)</a></li>
+                    <li><a href="../antminer/X17#t17_1-stock">T17+ (Stock)</a></li>
+                    <li><a href="../antminer/X17#t17e-stock">T17e (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-stock">S19 (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19l-stock">S19L (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-stock">S19 Pro (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19j-stock">S19j (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19i-stock">S19i (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19_1-stock">S19+ (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19j-no-pic-stock">S19j No PIC (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19-pro_1-stock">S19 Pro+ (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-stock">S19j Pro (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19j_1-stock">S19j+ (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1-stock">S19j Pro+ (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-stock">S19 XP (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19a-stock">S19a (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19a-pro-stock">S19a Pro (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19-hydro-stock">S19 Hydro (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-hydro-stock">S19 Pro Hydro (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19-pro_1-hydro-stock">S19 Pro+ Hydro (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-stock">S19K Pro (Stock)</a></li>
+                    <li><a href="../antminer/X19#s19j-xp-stock">S19j XP (Stock)</a></li>
+                    <li><a href="../antminer/X19#t19-stock">T19 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#s21-stock">S21 (Stock)</a></li>
+                    <li><a href="../antminer/X21#s21-stock">S21 (Stock)</a></li>
+                    <li><a href="../antminer/X21#s21-stock">S21 (Stock)</a></li>
+                    <li><a href="../antminer/X21#s21_1-stock">S21+ (Stock)</a></li>
+                    <li><a href="../antminer/X21#s21_1-hydro-stock">S21+ Hydro (Stock)</a></li>
+                    <li><a href="../antminer/X21#s21_1-hydro-stock">S21+ Hydro (Stock)</a></li>
+                    <li><a href="../antminer/X21#s21-pro-stock">S21 Pro (Stock)</a></li>
+                    <li><a href="../antminer/X21#t21-stock">T21 (Stock)</a></li>
+                    <li><a href="../antminer/X21#s21-hydro-stock">S21 Hydro (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware Whatsminers:</summary>
+    <ul>
+        <details>
+            <summary>M2X Series:</summary>
+                <ul>
+                    <li><a href="../whatsminer/M2X#m20p-v10-stock">M20P V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m20p-v30-stock">M20P V30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m20s_1-v30-stock">M20S+ V30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m20s-v10-stock">M20S V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m20s-v20-stock">M20S V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m20s-v30-stock">M20S V30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m20-v10-stock">M20 V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m21s_1-v20-stock">M21S+ V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m21s-v20-stock">M21S V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m21s-v60-stock">M21S V60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m21s-v70-stock">M21S V70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m21-v10-stock">M21 V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M2X#m29-v10-stock">M29 V10 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>M3X Series:</summary>
+                <ul>
+                    <li><a href="../whatsminer/M3X#m30k-v10-stock">M30K V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30l-v10-stock">M30L V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-v10-stock">M30S++ V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-v20-stock">M30S++ V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-ve30-stock">M30S++ VE30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-ve40-stock">M30S++ VE40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-ve50-stock">M30S++ VE50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vf40-stock">M30S++ VF40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vg30-stock">M30S++ VG30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vg40-stock">M30S++ VG40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vg50-stock">M30S++ VG50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh10-stock">M30S++ VH10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh100-stock">M30S++ VH100 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh110-stock">M30S++ VH110 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh20-stock">M30S++ VH20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh30-stock">M30S++ VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh40-stock">M30S++ VH40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh50-stock">M30S++ VH50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh60-stock">M30S++ VH60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh70-stock">M30S++ VH70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh80-stock">M30S++ VH80 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vh90-stock">M30S++ VH90 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vi30-stock">M30S++ VI30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vj20-stock">M30S++ VJ20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vj30-stock">M30S++ VJ30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vj50-stock">M30S++ VJ50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vj60-stock">M30S++ VJ60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vj70-stock">M30S++ VJ70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vk30-stock">M30S++ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1_1-vk40-stock">M30S++ VK40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v10-stock">M30S+ V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v100-stock">M30S+ V100 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v20-stock">M30S+ V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v30-stock">M30S+ V30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v40-stock">M30S+ V40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v50-stock">M30S+ V50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v60-stock">M30S+ V60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v70-stock">M30S+ V70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v80-stock">M30S+ V80 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-v90-stock">M30S+ V90 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve100-stock">M30S+ VE100 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve30-stock">M30S+ VE30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve40-stock">M30S+ VE40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve50-stock">M30S+ VE50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve60-stock">M30S+ VE60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve70-stock">M30S+ VE70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve80-stock">M30S+ VE80 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-ve90-stock">M30S+ VE90 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vf20-stock">M30S+ VF20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vf30-stock">M30S+ VF30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vg20-stock">M30S+ VG20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vg30-stock">M30S+ VG30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vg40-stock">M30S+ VG40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vg50-stock">M30S+ VG50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vg60-stock">M30S+ VG60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh10-stock">M30S+ VH10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh20-stock">M30S+ VH20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh30-stock">M30S+ VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh40-stock">M30S+ VH40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh50-stock">M30S+ VH50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh60-stock">M30S+ VH60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vh70-stock">M30S+ VH70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vi30-stock">M30S+ VI30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vj30-stock">M30S+ VJ30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s_1-vj40-stock">M30S+ VJ40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v10-stock">M30S V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v20-stock">M30S V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v30-stock">M30S V30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v40-stock">M30S V40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v50-stock">M30S V50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v60-stock">M30S V60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v70-stock">M30S V70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-v80-stock">M30S V80 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve10-stock">M30S VE10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve20-stock">M30S VE20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve30-stock">M30S VE30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve40-stock">M30S VE40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve50-stock">M30S VE50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve60-stock">M30S VE60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-ve70-stock">M30S VE70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vf10-stock">M30S VF10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vf20-stock">M30S VF20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vf30-stock">M30S VF30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vg10-stock">M30S VG10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vg20-stock">M30S VG20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vg30-stock">M30S VG30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vg40-stock">M30S VG40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh10-stock">M30S VH10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh20-stock">M30S VH20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh30-stock">M30S VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh40-stock">M30S VH40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh50-stock">M30S VH50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vh60-stock">M30S VH60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vi20-stock">M30S VI20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30s-vj30-stock">M30S VJ30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30-v10-stock">M30 V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m30-v20-stock">M30 V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31h-v10-stock">M31H V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31h-v40-stock">M31H V40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31l-v10-stock">M31L V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v10-stock">M31S+ V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v100-stock">M31S+ V100 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v20-stock">M31S+ V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v30-stock">M31S+ V30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v40-stock">M31S+ V40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v50-stock">M31S+ V50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v60-stock">M31S+ V60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v80-stock">M31S+ V80 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-v90-stock">M31S+ V90 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve10-stock">M31S+ VE10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve20-stock">M31S+ VE20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve30-stock">M31S+ VE30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve40-stock">M31S+ VE40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve50-stock">M31S+ VE50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve60-stock">M31S+ VE60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-ve80-stock">M31S+ VE80 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-vf20-stock">M31S+ VF20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-vf30-stock">M31S+ VF30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-vg20-stock">M31S+ VG20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s_1-vg30-stock">M31S+ VG30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31se-v10-stock">M31SE V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31se-v20-stock">M31SE V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31se-v30-stock">M31SE V30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v10-stock">M31S V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v20-stock">M31S V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v30-stock">M31S V30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v40-stock">M31S V40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v50-stock">M31S V50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v60-stock">M31S V60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v70-stock">M31S V70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v80-stock">M31S V80 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-v90-stock">M31S V90 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-ve10-stock">M31S VE10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-ve20-stock">M31S VE20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31s-ve30-stock">M31S VE30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31-v10-stock">M31 V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m31-v20-stock">M31 V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m32-v10-stock">M32 V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m32-v20-stock">M32 V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1_1-vg40-stock">M33S++ VG40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1_1-vh20-stock">M33S++ VH20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1_1-vh30-stock">M33S++ VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1-vg20-stock">M33S+ VG20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1-vg30-stock">M33S+ VG30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1-vh20-stock">M33S+ VH20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33s_1-vh30-stock">M33S+ VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33s-vg30-stock">M33S VG30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33-v10-stock">M33 V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33-v20-stock">M33 V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m33-v30-stock">M33 V30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m34s_1-ve10-stock">M34S+ VE10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m36s_1_1-vh30-stock">M36S++ VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m36s_1-vg30-stock">M36S+ VG30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m36s-ve10-stock">M36S VE10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m39-v10-stock">M39 V10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m39-v20-stock">M39 V20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M3X#m39-v30-stock">M39 V30 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>M5X Series:</summary>
+                <ul>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vk10-stock">M50S++ VK10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vk20-stock">M50S++ VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vk30-stock">M50S++ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vk40-stock">M50S++ VK40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vk50-stock">M50S++ VK50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vk60-stock">M50S++ VK60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vl20-stock">M50S++ VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vl30-stock">M50S++ VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vl40-stock">M50S++ VL40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vl50-stock">M50S++ VL50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1_1-vl60-stock">M50S++ VL60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vh30-stock">M50S+ VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vh40-stock">M50S+ VH40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vj30-stock">M50S+ VJ30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vj40-stock">M50S+ VJ40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vj60-stock">M50S+ VJ60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vk10-stock">M50S+ VK10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vk20-stock">M50S+ VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vk30-stock">M50S+ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vl10-stock">M50S+ VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vl20-stock">M50S+ VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s_1-vl30-stock">M50S+ VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vh10-stock">M50S VH10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vh20-stock">M50S VH20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vh30-stock">M50S VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vh40-stock">M50S VH40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vh50-stock">M50S VH50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vj10-stock">M50S VJ10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vj20-stock">M50S VJ20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vj30-stock">M50S VJ30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vj40-stock">M50S VJ40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vj50-stock">M50S VJ50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vk10-stock">M50S VK10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vk20-stock">M50S VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vk30-stock">M50S VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vk50-stock">M50S VK50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vk60-stock">M50S VK60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vk70-stock">M50S VK70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vk80-stock">M50S VK80 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vl20-stock">M50S VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50s-vl30-stock">M50S VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-ve30-stock">M50 VE30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vg30-stock">M50 VG30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh10-stock">M50 VH10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh20-stock">M50 VH20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh30-stock">M50 VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh40-stock">M50 VH40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh50-stock">M50 VH50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh60-stock">M50 VH60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh70-stock">M50 VH70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh80-stock">M50 VH80 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vh90-stock">M50 VH90 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vj10-stock">M50 VJ10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vj20-stock">M50 VJ20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vj30-stock">M50 VJ30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vj40-stock">M50 VJ40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vj60-stock">M50 VJ60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vk40-stock">M50 VK40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m50-vk50-stock">M50 VK50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m52s_1_1-vl10-stock">M52S++ VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m52s-vk30-stock">M52S VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53h-vh10-stock">M53H VH10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1_1-vk10-stock">M53S++ VK10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1_1-vk20-stock">M53S++ VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1_1-vk30-stock">M53S++ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1_1-vk50-stock">M53S++ VK50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1_1-vl10-stock">M53S++ VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1_1-vl30-stock">M53S++ VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1-vj30-stock">M53S+ VJ30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1-vj40-stock">M53S+ VJ40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1-vj50-stock">M53S+ VJ50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s_1-vk30-stock">M53S+ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s-vh20-stock">M53S VH20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s-vh30-stock">M53S VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s-vj30-stock">M53S VJ30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s-vj40-stock">M53S VJ40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53s-vk30-stock">M53S VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53-vh30-stock">M53 VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53-vh40-stock">M53 VH40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53-vh50-stock">M53 VH50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53-vk30-stock">M53 VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m53-vk60-stock">M53 VK60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m54s_1_1-vk30-stock">M54S++ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m54s_1_1-vl30-stock">M54S++ VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m54s_1_1-vl40-stock">M54S++ VL40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s_1_1-vk10-stock">M56S++ VK10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s_1_1-vk30-stock">M56S++ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s_1_1-vk40-stock">M56S++ VK40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s_1_1-vk50-stock">M56S++ VK50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s_1-vj30-stock">M56S+ VJ30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s_1-vk30-stock">M56S+ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s_1-vk40-stock">M56S+ VK40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s_1-vk50-stock">M56S+ VK50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s-vh30-stock">M56S VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s-vj30-stock">M56S VJ30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56s-vj40-stock">M56S VJ40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m56-vh30-stock">M56 VH30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M5X#m59-vh30-stock">M59 VH30 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>M6X Series:</summary>
+                <ul>
+                    <li><a href="../whatsminer/M6X#m60s_1_1-vl30-stock">M60S++ VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1_1-vl40-stock">M60S++ VL40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1-vk30-stock">M60S+ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1-vk40-stock">M60S+ VK40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1-vk50-stock">M60S+ VK50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1-vk60-stock">M60S+ VK60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1-vk70-stock">M60S+ VK70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1-vl10-stock">M60S+ VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1-vl30-stock">M60S+ VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1-vl40-stock">M60S+ VL40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1-vl50-stock">M60S+ VL50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s_1-vl60-stock">M60S+ VL60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vk10-stock">M60S VK10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vk20-stock">M60S VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vk30-stock">M60S VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vk40-stock">M60S VK40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vl10-stock">M60S VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vl20-stock">M60S VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vl30-stock">M60S VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vl40-stock">M60S VL40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vl50-stock">M60S VL50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vl60-stock">M60S VL60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60s-vl70-stock">M60S VL70 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vk10-stock">M60 VK10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vk20-stock">M60 VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vk30-stock">M60 VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vk40-stock">M60 VK40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vk6a-stock">M60 VK6A (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vl10-stock">M60 VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vl20-stock">M60 VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vl30-stock">M60 VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vl40-stock">M60 VL40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m60-vl50-stock">M60 VL50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61s_1-vl30-stock">M61S+ VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61s-vl10-stock">M61S VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61s-vl20-stock">M61S VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61s-vl30-stock">M61S VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61-vk10-stock">M61 VK10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61-vk20-stock">M61 VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61-vk30-stock">M61 VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61-vk40-stock">M61 VK40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61-vl10-stock">M61 VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61-vl30-stock">M61 VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61-vl40-stock">M61 VL40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61-vl50-stock">M61 VL50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m61-vl60-stock">M61 VL60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m62s_1-vk30-stock">M62S+ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s_1_1-vl20-stock">M63S++ VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s_1-vk30-stock">M63S+ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s_1-vl10-stock">M63S+ VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s_1-vl20-stock">M63S+ VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s_1-vl30-stock">M63S+ VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s_1-vl50-stock">M63S+ VL50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s-vk10-stock">M63S VK10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s-vk20-stock">M63S VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s-vk30-stock">M63S VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s-vk60-stock">M63S VK60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s-vl10-stock">M63S VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s-vl50-stock">M63S VL50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63s-vl60-stock">M63S VL60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63-vk10-stock">M63 VK10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63-vk20-stock">M63 VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63-vk30-stock">M63 VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63-vl10-stock">M63 VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m63-vl30-stock">M63 VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m64s-vl30-stock">M64S VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m64-vl30-stock">M64 VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m64-vl40-stock">M64 VL40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m65s_1-vk30-stock">M65S+ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m65s-vk20-stock">M65S VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m65s-vl60-stock">M65S VL60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s_1_1-vl20-stock">M66S++ VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s_1-vk30-stock">M66S+ VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s_1-vl10-stock">M66S+ VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s_1-vl20-stock">M66S+ VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s_1-vl30-stock">M66S+ VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s_1-vl40-stock">M66S+ VL40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s_1-vl60-stock">M66S+ VL60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vk20-stock">M66S VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vk30-stock">M66S VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vk40-stock">M66S VK40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vk50-stock">M66S VK50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vk60-stock">M66S VK60 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vl10-stock">M66S VL10 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vl20-stock">M66S VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vl30-stock">M66S VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vl40-stock">M66S VL40 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66s-vl50-stock">M66S VL50 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66-vk20-stock">M66 VK20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66-vk30-stock">M66 VK30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66-vl20-stock">M66 VL20 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m66-vl30-stock">M66 VL30 (Stock)</a></li>
+                    <li><a href="../whatsminer/M6X#m67s-vk30-stock">M67S VK30 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>M7X Series:</summary>
+                <ul>
+                    <li><a href="../whatsminer/M7X#m70-vm30-stock">M70 VM30 (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware Avalonminers:</summary>
+    <ul>
+        <details>
+            <summary>A7X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A7X#avalon-721-stock">Avalon 721 (Stock)</a></li>
+                    <li><a href="../avalonminer/A7X#avalon-741-stock">Avalon 741 (Stock)</a></li>
+                    <li><a href="../avalonminer/A7X#avalon-761-stock">Avalon 761 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>A8X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A8X#avalon-821-stock">Avalon 821 (Stock)</a></li>
+                    <li><a href="../avalonminer/A8X#avalon-841-stock">Avalon 841 (Stock)</a></li>
+                    <li><a href="../avalonminer/A8X#avalon-851-stock">Avalon 851 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>A9X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A9X#avalon-921-stock">Avalon 921 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>A10X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A10X#avalon-1026-stock">Avalon 1026 (Stock)</a></li>
+                    <li><a href="../avalonminer/A10X#avalon-1047-stock">Avalon 1047 (Stock)</a></li>
+                    <li><a href="../avalonminer/A10X#avalon-1066-stock">Avalon 1066 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>A11X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A11X#avalon-1126-pro-stock">Avalon 1126 Pro (Stock)</a></li>
+                    <li><a href="../avalonminer/A11X#avalon-1166-pro-stock">Avalon 1166 Pro (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>A12X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A12X#avalon-1246-stock">Avalon 1246 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>nano Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/nano#avalon-nano-3-stock">Avalon Nano 3 (Stock)</a></li>
+                    <li><a href="../avalonminer/nano#avalon-nano-3s-stock">Avalon Nano 3s (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>A15X Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/A15X#avalon-1566-stock">Avalon 1566 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>Q Series:</summary>
+                <ul>
+                    <li><a href="../avalonminer/Q#avalon-q-home-stock">Avalon Q Home (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware Innosilicons:</summary>
+    <ul>
+        <details>
+            <summary>T3X Series:</summary>
+                <ul>
+                    <li><a href="../innosilicon/T3X#t3h_1-stock">T3H+ (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>A10X Series:</summary>
+                <ul>
+                    <li><a href="../innosilicon/A10X#a10x-stock">A10X (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>A11X Series:</summary>
+                <ul>
+                    <li><a href="../innosilicon/A11X#a11-stock">A11 (Stock)</a></li>
+                    <li><a href="../innosilicon/A11X#a11mx-stock">A11MX (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware Goldshells:</summary>
+    <ul>
+        <details>
+            <summary>X5 Series:</summary>
+                <ul>
+                    <li><a href="../goldshell/X5#ck5-stock">CK5 (Stock)</a></li>
+                    <li><a href="../goldshell/X5#hs5-stock">HS5 (Stock)</a></li>
+                    <li><a href="../goldshell/X5#kd5-stock">KD5 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>XMax Series:</summary>
+                <ul>
+                    <li><a href="../goldshell/XMax#kd-max-stock">KD Max (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>XBox Series:</summary>
+                <ul>
+                    <li><a href="../goldshell/XBox#kd-box-ii-stock">KD Box II (Stock)</a></li>
+                    <li><a href="../goldshell/XBox#kd-box-pro-stock">KD Box Pro (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>Byte Series:</summary>
+                <ul>
+                    <li><a href="../goldshell/Byte#byte-stock">Byte (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>BOS+ Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X9 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X9#s9-bos_1">S9 (BOS+)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X17 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X17#s17-bos_1">S17 (BOS+)</a></li>
+                    <li><a href="../antminer/X17#s17_1-bos_1">S17+ (BOS+)</a></li>
+                    <li><a href="../antminer/X17#s17-pro-bos_1">S17 Pro (BOS+)</a></li>
+                    <li><a href="../antminer/X17#s17e-bos_1">S17e (BOS+)</a></li>
+                    <li><a href="../antminer/X17#t17-bos_1">T17 (BOS+)</a></li>
+                    <li><a href="../antminer/X17#t17_1-bos_1">T17+ (BOS+)</a></li>
+                    <li><a href="../antminer/X17#t17e-bos_1">T17e (BOS+)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-bos_1">S19 (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19_1-bos_1">S19+ (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-bos_1">S19 Pro (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19a-bos_1">S19a (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19a-pro-bos_1">S19a Pro (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19j-bos_1">S19j (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19j-no-pic-bos_1">S19j No PIC (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-bos_1">S19j Pro (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-no-pic-bos_1">S19j Pro No PIC (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1-bos_1">S19j Pro+ (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1-bos_1">S19j Pro+ (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1-no-pic-bos_1">S19j Pro+ No PIC (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-no-pic-bos_1">S19k Pro No PIC (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-no-pic-bos_1">S19k Pro No PIC (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-bos_1">S19 XP (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19-pro_1-hydro-bos_1">S19 Pro+ Hydro (BOS+)</a></li>
+                    <li><a href="../antminer/X19#t19-bos_1">T19 (BOS+)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-hydro-bos_1">S19 XP Hydro (BOS+)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#s21-bos_1">S21 (BOS+)</a></li>
+                    <li><a href="../antminer/X21#s21-pro-bos_1">S21 Pro (BOS+)</a></li>
+                    <li><a href="../antminer/X21#s21_1-bos_1">S21+ (BOS+)</a></li>
+                    <li><a href="../antminer/X21#s21_1-hydro-bos_1">S21+ Hydro (BOS+)</a></li>
+                    <li><a href="../antminer/X21#s21-hydro-bos_1">S21 Hydro (BOS+)</a></li>
+                    <li><a href="../antminer/X21#t21-bos_1">T21 (BOS+)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>BMM Series:</summary>
+                <ul>
+                    <li><a href="../braiins/BMM#bmm100-bos_1">BMM100 (BOS+)</a></li>
+                    <li><a href="../braiins/BMM#bmm101-bos_1">BMM101 (BOS+)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Vnish Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X3 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X3#l3_1-vnish">L3+ (VNish)</a></li>
+                    <li><a href="../antminer/X3#l3_1-vnish">L3+ (VNish)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X7 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X7#l7-vnish">L7 (VNish)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X9 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X9#l9-vnish">L9 (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#s19i-vnish">S19i (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-vnish">S19 XP (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-hydro-vnish">S19 XP Hydro (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-vnish">S19j Pro (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-vnish">S19j Pro (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-vnish">S19j Pro (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19a-vnish">S19a (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19-hydro-vnish">S19 Hydro (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19a-pro-vnish">S19a Pro (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-a-vnish">S19 Pro A (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-hydro-vnish">S19 Pro Hydro (VNish)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-vnish">S19k Pro (VNish)</a></li>
+                    <li><a href="../antminer/X19#t19-vnish">T19 (VNish)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#t21-vnish">T21 (VNish)</a></li>
+                    <li><a href="../antminer/X21#s21-vnish">S21 (VNish)</a></li>
+                    <li><a href="../antminer/X21#s21_1-vnish">S21+ (VNish)</a></li>
+                    <li><a href="../antminer/X21#s21_1-hydro-vnish">S21+ Hydro (VNish)</a></li>
+                    <li><a href="../antminer/X21#s21-pro-vnish">S21 Pro (VNish)</a></li>
+                    <li><a href="../antminer/X21#s21-hydro-vnish">S21 Hydro (VNish)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>ePIC Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-epic">S19 (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-epic">S19 Pro (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19j-epic">S19j (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-epic">S19j Pro (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1-epic">S19j Pro+ (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-epic">S19k Pro (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-epic">S19 XP (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-dual-epic">S19j Pro Dual (ePIC)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-dual-epic">S19k Pro Dual (ePIC)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#s21-epic">S21 (ePIC)</a></li>
+                    <li><a href="../antminer/X21#s21-pro-epic">S21 Pro (ePIC)</a></li>
+                    <li><a href="../antminer/X21#t21-epic">T21 (ePIC)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>blockminer Series:</summary>
+                <ul>
+                    <li><a href="../blockminer/blockminer#blockminer-520i-epic">BlockMiner 520i (ePIC)</a></li>
+                    <li><a href="../blockminer/blockminer#blockminer-720i-epic">BlockMiner 720i (ePIC)</a></li>
+                    <li><a href="../blockminer/blockminer#blockminer-elite-1.0-epic">BlockMiner eLITE 1.0 (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-hive">T9 (Hive)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19j-pro-hive">S19j Pro (Hive)</a></li>
+                    <li><a href="../antminer/X19#s19-hive">S19 (Hive)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-hive">S19K Pro (Hive)</a></li>
+                    <li><a href="../antminer/X19#s19-no-pic-hive">S19 No PIC (Hive)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>MSKMiner Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-no-pic-stock">S19 No PIC (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>LuxOS Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X9 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X9#s9-luxos">S9 (LuxOS)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-luxos">S19 (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-luxos">S19 Pro (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-luxos">S19j Pro (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro_1-luxos">S19j Pro+ (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-luxos">S19k Pro (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-luxos">S19 XP (LuxOS)</a></li>
+                    <li><a href="../antminer/X19#t19-luxos">T19 (LuxOS)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#s21-luxos">S21 (LuxOS)</a></li>
+                    <li><a href="../antminer/X21#t21-luxos">T21 (LuxOS)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware Auradine Miners:</summary>
+    <ul>
+        <details>
+            <summary>AD Series:</summary>
+                <ul>
+                    <li><a href="../auradine/AD#at1500-stock">AT1500 (Stock)</a></li>
+                    <li><a href="../auradine/AD#at2860-stock">AT2860 (Stock)</a></li>
+                    <li><a href="../auradine/AD#at2880-stock">AT2880 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>AI Series:</summary>
+                <ul>
+                    <li><a href="../auradine/AI#ai2500-stock">AI2500 (Stock)</a></li>
+                    <li><a href="../auradine/AI#ai3680-stock">AI3680 (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>AT Series:</summary>
+                <ul>
+                    <li><a href="../auradine/AT#ad2500-stock">AD2500 (Stock)</a></li>
+                    <li><a href="../auradine/AT#ad3500-stock">AD3500 (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Mara Firmware Miners:</summary>
+    <ul>
+        <details>
+            <summary>X19 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X19#s19-marafw">S19 (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19-pro-marafw">S19 Pro (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19j-marafw">S19j (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19j-no-pic-marafw">S19j No PIC (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19j-pro-marafw">S19j Pro (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19-xp-marafw">S19 XP (MaraFW)</a></li>
+                    <li><a href="../antminer/X19#s19k-pro-marafw">S19K Pro (MaraFW)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>X21 Series:</summary>
+                <ul>
+                    <li><a href="../antminer/X21#s21-marafw">S21 (MaraFW)</a></li>
+                    <li><a href="../antminer/X21#t21-marafw">T21 (MaraFW)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware BitAxe Miners:</summary>
+    <ul>
+        <details>
+            <summary>BM Series:</summary>
+                <ul>
+                    <li><a href="../bitaxe/BM#supra-stock">Supra (Stock)</a></li>
+                    <li><a href="../bitaxe/BM#ultra-stock">Ultra (Stock)</a></li>
+                    <li><a href="../bitaxe/BM#max-stock">Max (Stock)</a></li>
+                    <li><a href="../bitaxe/BM#gamma-stock">Gamma (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware Lucky Miners:</summary>
+    <ul>
+        <details>
+            <summary>LV Series:</summary>
+                <ul>
+                    <li><a href="../luckyminer/LV#lv08-stock">LV08 (Stock)</a></li>
+                    <li><a href="../luckyminer/LV#lv07-stock">LV07 (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware IceRiver Miners:</summary>
+    <ul>
+        <details>
+            <summary>KSX Series:</summary>
+                <ul>
+                    <li><a href="../iceriver/KSX#ks0-stock">KS0 (Stock)</a></li>
+                    <li><a href="../iceriver/KSX#ks1-stock">KS1 (Stock)</a></li>
+                    <li><a href="../iceriver/KSX#ks2-stock">KS2 (Stock)</a></li>
+                    <li><a href="../iceriver/KSX#ks3-stock">KS3 (Stock)</a></li>
+                    <li><a href="../iceriver/KSX#ks3l-stock">KS3L (Stock)</a></li>
+                    <li><a href="../iceriver/KSX#ks3m-stock">KS3M (Stock)</a></li>
+                    <li><a href="../iceriver/KSX#ks5-stock">KS5 (Stock)</a></li>
+                    <li><a href="../iceriver/KSX#ks5l-stock">KS5L (Stock)</a></li>
+                    <li><a href="../iceriver/KSX#ks5m-stock">KS5M (Stock)</a></li>
+                </ul>
+        </details>
+        <details>
+            <summary>ALX Series:</summary>
+                <ul>
+                    <li><a href="../iceriver/ALX#al3-stock">AL3 (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware Hammer Miners:</summary>
+    <ul>
+        <details>
+            <summary>DX Series:</summary>
+                <ul>
+                    <li><a href="../hammer/DX#d10-stock">D10 (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware Volcminers:</summary>
+    <ul>
+        <details>
+            <summary>DX Series:</summary>
+                <ul>
+                    <li><a href="../volcminer/DX#d1-stock">D1 (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>
+<details>
+<summary>Stock Firmware Elphapex Miners:</summary>
+    <ul>
+        <details>
+            <summary>DGX Series:</summary>
+                <ul>
+                    <li><a href="../elphapex/DGX#dg1_1-stock">DG1+ (Stock)</a></li>
+                    <li><a href="../elphapex/DGX#dg1-stock">DG1 (Stock)</a></li>
+                    <li><a href="../elphapex/DGX#dg1home-stock">DG1Home (Stock)</a></li>
+                </ul>
+        </details>
+    </ul>
+</details>

docs/miners/volcminer/DX.md

@@ -0,0 +1,16 @@
+# pyasic
+## DX Models
+
+## D1 (Stock)
+
+- [ ] Shutdowns
+- [ ] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.volcminer.blackminer.DX.D1.VolcMinerD1
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/whatsminer/M2X.md

@@ -0,0 +1,172 @@
+# pyasic
+## M2X Models
+
+## M20P V10 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20P.BTMinerM20PV10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M20P V30 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20P.BTMinerM20PV30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M20S+ V30 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlusV30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M20S V10 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M20S V20 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M20S V30 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M20 V10 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20V10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M21S+ V20 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlusV20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M21S V20 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M21S V60 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV60
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M21S V70 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV70
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M21 V10 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21.BTMinerM21V10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+
+## M29 V10 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [ ] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M2X.M29.BTMinerM29V10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/miners/whatsminer/M7X.md

@@ -0,0 +1,16 @@
+# pyasic
+## M7X Models
+
+## M70 VM30 (Stock)
+
+- [x] Shutdowns
+- [x] Power Modes
+- [x] Setpoints
+- [ ] Presets
+
+::: pyasic.miners.whatsminer.btminer.M7X.M70.BTMinerM70VM30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 0
+

docs/network/miner_network.md

@@ -0,0 +1,8 @@
+# pyasic
+## Miner Network
+
+::: pyasic.network.MinerNetwork
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/rpc/api.md

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

docs/rpc/bfgminer.md

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

docs/rpc/bmminer.md

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

docs/rpc/bosminer.md

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

docs/rpc/btminer.md

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

docs/rpc/cgminer.md

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

docs/rpc/luxminer.md

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

docs/rpc/unknown.md

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

docs/settings/settings.md

@@ -0,0 +1,41 @@
+# pyasic
+## settings
+
+All settings here are global settings for all of pyasic.  Set these settings with `update(key, value)`.
+
+Settings options:
+
+- `network_ping_retries`
+- `network_ping_timeout`
+- `network_scan_threads`
+- `factory_get_retries`
+- `factory_get_timeout`
+- `get_data_retries`
+- `api_function_timeout`
+- `antminer_mining_mode_as_str`
+- `default_whatsminer_rpc_password`
+- `default_innosilicon_web_password`
+- `default_antminer_web_password`
+- `default_bosminer_web_password`
+- `default_vnish_web_password`
+- `default_goldshell_web_password`
+- `default_auradine_web_password`
+- `default_epic_web_password`
+- `default_hive_web_password`
+- `default_antminer_ssh_password`
+- `default_bosminer_ssh_password`
+
+
+### get
+::: pyasic.settings.get
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+### update
+::: pyasic.settings.update
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/antminer.md

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

docs/web/api.md

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

docs/web/auradine.md

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

docs/web/epic.md

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

docs/web/goldshell.md

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

docs/web/innosilicon.md

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

docs/web/marathon.md

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