Merge remote-tracking branch 'origin/master'

.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.

API/__init__.py

@@ -1,6 +1,7 @@
 import asyncio
 import json
 import ipaddress
+import warnings
 
 
 class APIError(Exception):
@@ -17,6 +18,20 @@ class APIError(Exception):
             return "Incorrect API parameters."
 
 
+class APIWarning(Warning):
+    def __init__(self, *args):
+        if args:
+            self.message = args[0]
+        else:
+            self.message = None
+
+    def __str__(self):
+        if self.message:
+            return f"{self.message}"
+        else:
+            return "Incorrect API parameters."
+
+
 class BaseMinerAPI:
     def __init__(self, ip: str, port: int = 4028) -> None:
         # api port, should be 4028
@@ -41,21 +56,35 @@ class BaseMinerAPI:
     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)
-
+        user_commands = [*commands]
+        allowed_commands = self.get_commands()
+        # make sure we can actually run the command, otherwise it will fail
+        commands = [command for command in user_commands if command in allowed_commands]
+        for item in list(set(user_commands) - set(commands)):
+            warnings.warn(f"""Removing incorrect command: {item}
+If you are sure you want to use this command please use API.send_command("{item}", ignore_errors=True) instead.""",
+                          APIWarning)
         # standard multicommand format is "command1+command2"
         # doesnt work for S19 which is dealt with in the send command function
         command = "+".join(commands)
-        return await self.send_command(command)
+        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:
+    async def send_command(self, command: str, parameters: str or int or bool = None, ignore_errors: bool = False) -> dict:
         """Send an API command to the miner and return the result."""
         try:
             # get reader and writer streams
@@ -94,26 +123,17 @@ class BaseMinerAPI:
         writer.close()
         await writer.wait_closed()
 
-        # validate the command suceeded
-        # also handle for S19 not liking "command1+command2" format
-        if not self.validate_command_output(data):
-            try:
-                data = {}
-                # S19 handler, try again
-                for cmd in command.split("+"):
-                    data[cmd] = []
-                    data[cmd].append(await self.send_command(cmd))
-            except Exception as e:
-                print(e)
-
-        # check again after second try
-        if not self.validate_command_output(data):
-            raise APIError(data["STATUS"][0]["Msg"])
+        # check for if the user wants to allow errors to return
+        if not ignore_errors:
+            # validate the command succeeded
+            validation = self.validate_command_output(data)
+            if not validation[0]:
+                raise APIError(validation[1])
 
         return data
 
     @staticmethod
-    def validate_command_output(data: dict) -> bool:
+    def validate_command_output(data: dict) -> tuple[bool, str | None]:
         """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
@@ -122,20 +142,20 @@ class BaseMinerAPI:
                 # 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 "STATUS" in data[key][0].keys():
                         if data[key][0]["STATUS"][0]["STATUS"] not in ["S", "I"]:
                             # this is an error
-                            return False
+                            return False, f"{key}: " + data[key][0]["STATUS"][0]["Msg"]
         elif "id" not in data.keys():
             if data["STATUS"] not in ["S", "I"]:
-                return False
+                return False, data["Msg"]
         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
+                    return False, data["STATUS"][0]["Msg"]
+        return True, None
 
     @staticmethod
     def load_api_data(data: bytes) -> dict:
@@ -154,10 +174,12 @@ class BaseMinerAPI:
             str_data = str_data.replace("\n", "")
             # fix an error with a bmminer return not having a specific comma that breaks json.loads()
             str_data = str_data.replace("}{", "},{")
+            # fix an error with a bmminer return  having a specific comma that breaks json.loads()
+            str_data = str_data.replace("[,{", "[{")
             # 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}")
+            raise APIError(f"Decode Error: {str_data}")
         return parsed_data

API/bmminer.py

@@ -2,34 +2,36 @@ from API import BaseMinerAPI
 
 
 class BMMinerAPI(BaseMinerAPI):
-    """
-    A class that abstracts the BMMiner API in the miners.
+    """An abstraction of the BMMiner API.
 
     Each method corresponds to an API command in BMMiner.
 
     BMMiner API documentation:
         https://github.com/jameshilliard/bmminer/blob/master/API-README
 
-    Parameters:
-        ip: the IP address of the miner.
-        port (optional): the port of the API on the miner (standard is 4028)
+    This class abstracts use of the BMMiner API, as well as the
+    methods for sending commands to it.  The self.send_command()
+    function handles sending a command to the miner asynchronously, and
+    as such is the base for many of the functions in this class, which
+    rely on it to send the command for them.
+
+    :param ip: The IP of the miner to reference the API on.
+    :param port: The port to reference the API on.  Default is 4028.
     """
     def __init__(self, ip: str, port: int = 4028) -> None:
         super().__init__(ip, port)
 
     async def version(self) -> dict:
-        """
-        API 'version' command.
+        """Get miner version info.
 
-        Returns a dict containing version information.
+        :return: Miner version information.
         """
         return await self.send_command("version")
 
     async def config(self) -> dict:
-        """
-        API 'config' command.
+        """Get some basic configuration info.
 
-        Returns some miner configuration information:
+        :return: Some miner configuration information:
             ASC Count <- the number of ASCs
             PGA Count <- the number of PGAs
             Pool Count <- the number of Pools
@@ -45,151 +47,141 @@ class BMMinerAPI(BaseMinerAPI):
         return await self.send_command("config")
 
     async def summary(self) -> dict:
-        """
-        API 'summary' command.
+        """Get the status summary of the miner.
 
-        Returns a dict containing the status summary of the miner.
+        :return: The status summary of the miner.
         """
         return await self.send_command("summary")
 
     async def pools(self) -> dict:
-        """
-        API 'pools' command.
+        """Get pool information.
 
-        Returns a dict containing the status of each pool.
+        :return: Miner pool information.
         """
         return await self.send_command("pools")
 
     async def devs(self) -> dict:
-        """
-        API 'devs' command.
+        """Get data on each PGA/ASC with their details.
 
-        Returns a dict containing each PGA/ASC with their details.
+        :return: Data on each PGA/ASC with their details.
         """
         return await self.send_command("devs")
 
     async def edevs(self, old: bool = False) -> dict:
-        """
-        API 'edevs' command.
+        """Get data on each PGA/ASC with their details, ignoring
+         blacklisted and zombie devices.
 
-        Returns a dict containing each PGA/ASC with their details,
-        ignoring blacklisted devices and zombie devices.
+        :param old: Include zombie devices that became zombies less
+        than 'old' seconds ago
 
-        Parameters:
-            old (optional): include zombie devices that became zombies less than 'old' seconds ago
+        :return: Data on each PGA/ASC with their details.
         """
         if old:
-            return await self.send_command("edevs", parameters="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.
+        """Get data from PGA n.
 
-        Returns a dict containing the details of a single PGA of number N.
+        :param n: The PGA number to get data from.
 
-        Parameters:
-            n: the number of the PGA to get details of.
+        :return: Data on the PGA n.
         """
         return await self.send_command("pga", parameters=n)
 
     async def pgacount(self) -> dict:
-        """
-        API 'pgacount' command.
+        """Get data fon all PGAs.
 
-        Returns a dict containing the number of PGA devices.
+        :return: Data on the PGAs connected.
         """
         return await self.send_command("pgacount")
 
     async def switchpool(self, n: int) -> dict:
-        """
-        API 'switchpool' command.
+        """Switch pools to pool n.
 
-        Returns the STATUS section with the results of switching pools.
+        :param n: The pool to switch to.
 
-        Parameters:
-            n: the number of the pool to switch to.
+        :return: A confirmation of switching to pool n.
         """
         return await self.send_command("switchpool", parameters=n)
 
     async def enablepool(self, n: int) -> dict:
-        """
-        API 'enablepool' command.
+        """Enable pool n.
 
-        Returns the STATUS section with the results of enabling the pool.
+        :param n: The pool to enable.
 
-        Parameters:
-            n: the number of the pool to enable.
+        :return: A confirmation of enabling pool n.
         """
         return await self.send_command("enablepool", parameters=n)
 
-    async def addpool(self, url: str, username: str, password: str) -> dict:
-        """
-        API 'addpool' command.
+    async def addpool(self,
+                      url: str,
+                      username: str,
+                      password: str
+                      ) -> dict:
+        """Add a pool to the miner.
 
-        Returns the STATUS section with the results of adding the pool.
+        :param url: The URL of the new pool to add.
+        :param username: The users username on the new pool.
+        :param password: The worker password on the new 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: A confirmation of adding the pool.
         """
-        return await self.send_command("addpool", parameters=f"{url}, {username}, {password}")
+        return await self.send_command("addpool",
+                                       parameters=f"{url}, "
+                                                  f"{username}, "
+                                                  f"{password}"
+                                       )
 
     async def poolpriority(self, *n: int) -> dict:
-        """
-        API 'poolpriority' command.
+        """Set pool priority.
 
-        Returns the STATUS section with the results of setting pool priority.
+        :param n: Pools in order of priority.
 
-        Parameters:
-            n: pool numbers in order of priority.
+        :return: A confirmation of setting pool priority.
         """
-        return await self.send_command("poolpriority", parameters=f"{','.join([str(item) for item in n])}")
+        pools = f"{','.join([str(item) for item in n])}"
+        return await self.send_command("poolpriority",
+                                       parameters=pools)
 
     async def poolquota(self, n: int, q: int) -> dict:
-        """
-        API 'poolquota' command.
+        """Set pool quota.
 
-        Returns the STATUS section with the results of setting pool quota.
+        :param n: Pool number to set quota on.
+        :param q: Quota to set the pool to.
 
-        Parameters:
-            n: pool number to set quota on.
-            q: quota to set the pool to.
+        :return: A confirmation of setting pool quota.
         """
-        return await self.send_command("poolquota", parameters=f"{n}, {q}")
+        return await self.send_command("poolquota",
+                                       parameters=f"{n}, "
+                                                  f"{q}"
+                                       )
 
     async def disablepool(self, n: int) -> dict:
-        """
-        API 'disablepool' command.
+        """Disable a pool.
 
-        Returns the STATUS section with the results of disabling the pool.
+        :param n: Pool to disable.
 
-        Parameters:
-            n: the number of the pool to disable.
+        :return: A confirmation of diabling the pool.
         """
         return await self.send_command("disablepool", parameters=n)
 
     async def removepool(self, n: int) -> dict:
-        """
-        API 'removepool' command.
+        """Remove a pool.
 
-        Returns the STATUS section with the results of removing the pool.
+        :param n: Pool to remove.
 
-        Parameters:
-            n: the number of the pool to remove.
+        :return: A confirmation of removing the pool.
         """
         return await self.send_command("removepool", parameters=n)
 
     async def save(self, filename: str = None) -> dict:
-        """
-        API 'save' command.
+        """Save the config.
 
-        Returns the STATUS section with the results of saving the config file..
+        :param filename: Filename to save the config as.
 
-        Parameters:
-            filename (optional): the filename to save the config as.
+        :return: A confirmation of saving the config.
         """
         if filename:
             return await self.send_command("save", parameters=filename)
@@ -197,146 +189,130 @@ class BMMinerAPI(BaseMinerAPI):
             return await self.send_command("save")
 
     async def quit(self) -> dict:
-        """
-        API 'quit' command.
+        """Quit BMMiner.
 
-        Returns a single "BYE" before BMMiner quits.
+        :return: A single "BYE" before BMMiner quits.
         """
         return await self.send_command("quit")
 
     async def notify(self) -> dict:
-        """
-        API 'notify' command.
+        """Notify the user of past errors.
 
-        Returns a dict containing the last status and count of each devices problem(s).
+        :return: The last status and count of each devices problem(s).
         """
         return await self.send_command("notify")
 
     async def privileged(self) -> dict:
-        """
-        API 'privileged' command.
+        """Check if you have privileged access.
 
-        Returns the STATUS section with an error if you have no privileged access.
+        :return: The STATUS section with an error if you have no
+        privileged access, or success if you have privileged access.
         """
         return await self.send_command("privileged")
 
     async def pgaenable(self, n: int) -> dict:
-        """
-        API 'pgaenable' command.
+        """Enable PGA n.
 
-        Returns the STATUS section with the results of enabling the PGA device N.
+        :param n: The PGA to enable.
 
-        Parameters:
-            n: the number of the PGA to enable.
+        :return: A confirmation of enabling PGA n.
         """
         return await self.send_command("pgaenable", parameters=n)
 
     async def pgadisable(self, n: int) -> dict:
-        """
-        API 'pgadisable' command.
+        """Disable PGA n.
 
-        Returns the STATUS section with the results of disabling the PGA device N.
+        :param n: The PGA to disable.
 
-        Parameters:
-            n: the number of the PGA to disable.
+        :return: A confirmation of disabling PGA n.
         """
         return await self.send_command("pgadisable", parameters=n)
 
     async def pgaidentify(self, n: int) -> dict:
-        """
-        API 'pgaidentify' command.
+        """Identify PGA n.
 
-        Returns the STATUS section with the results of identifying the PGA device N.
+        :param n: The PGA to identify.
 
-        Parameters:
-            n: the number of the PGA to identify.
+        :return: A confirmation of identifying PGA n.
         """
         return await self.send_command("pgaidentify", parameters=n)
 
     async def devdetails(self) -> dict:
-        """
-        API 'devdetails' command.
+        """Get data on all devices with their static details.
 
-        Returns a dict containing all devices with their static details.
+        :return: Data on all devices with their static details.
         """
         return await self.send_command("devdetails")
 
     async def restart(self) -> dict:
-        """
-        API 'restart' command.
+        """Restart BMMiner using the API.
 
-        Returns a single "RESTART" before BMMiner restarts.
+        :return: A reply informing of the restart.
         """
         return await self.send_command("restart")
 
     async def stats(self) -> dict:
-        """
-        API 'stats' command.
+        """Get stats of each device/pool with more than 1 getwork.
 
-        Returns a dict containing stats for all device/pool with more than 1 getwork.
+        :return: Stats of each 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,
+        """Get stats of each device/pool with more than 1 getwork,
         ignoring zombie devices.
 
-        Parameters:
-            old (optional): include zombie devices that became zombies less than 'old' seconds ago.
+        :param old: Include zombie devices that became zombies less
+        than 'old' seconds ago.
+
+        :return: Stats of each device/pool with more than 1 getwork,
+        ignoring zombie devices.
         """
         if old:
-            return await self.send_command("estats", parameters="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.
+        """Check if the command command exists in BMMiner.
 
-        Returns information about a command:
+        :param command: The command to check.
+
+        :return: 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.
+        """Set failover-only.
 
-        Returns the STATUS section with what failover-only was set to.
 
-        Parameters:
-            failover: what to set failover-only to.
+        :param failover: What to set failover-only to.
+
+        :return: Confirmation of setting failover-only.
         """
-        return await self.send_command("failover-only", parameters=failover)
+        return await self.send_command("failover-only",
+                                       parameters=failover
+                                       )
 
     async def coin(self) -> dict:
-        """
-        API 'coin' command.
+        """Get information on the current coin.
 
-        Returns information about the current coin being mined:
+        :return: 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
+            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.
+        """Set a debug setting.
 
-        Returns which debug setting was enabled or disabled.
-
-        Parameters:
-            setting: which setting to switch to. Options are:
+        :param setting: Which setting to switch to. Options are:
                 Silent,
                 Quiet,
                 Verbose,
@@ -345,42 +321,36 @@ class BMMinerAPI(BaseMinerAPI):
                 PerDevice,
                 WorkTime,
                 Normal.
+
+        :return: Data on which debug setting was enabled or disabled.
         """
         return await self.send_command("debug", parameters=setting)
 
     async def setconfig(self, name: str, n: int) -> dict:
-        """
-        API 'setconfig' command.
+        """Set config of name to value n.
 
-        Returns the STATUS section with the results of setting 'name' to N.
-
-        Parameters:
-            name: name of the config setting to set. Options are:
+        :param name: The name of the config setting to set. Options are:
                 queue,
                 scantime,
                 expiry.
-            n: the value to set the 'name' setting to.
+        :param n: The value to set the 'name' setting to.
+
+        :return: The results of setting config of name to n.
         """
-        return await self.send_command("setconfig", parameters=f"{name}, {n}")
+        return await self.send_command("setconfig",
+                                       parameters=f"{name}, "
+                                                  f"{n}"
+                                       )
 
     async def usbstats(self) -> dict:
-        """
-        API 'usbstats' command.
+        """Get stats of all USB devices except ztex.
 
-        Returns a dict containing the stats of all USB devices except ztex.
+        :return: 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.
+        """Set PGA option opt to val on PGA n.
 
         Options:
             MMQ -
@@ -389,98 +359,96 @@ class BMMinerAPI(BaseMinerAPI):
             CMR -
                 opt: clock
                 val: 100 - 220
+
+        :param n: The PGA to set the options on.
+        :param opt: The option to set. Setting this to 'help'
+        returns a help message.
+        :param val: The value to set the option to.
+
+        :return: Confirmation of setting PGA n with opt[,val].
         """
         if val:
-            return await self.send_command("pgaset", parameters=f"{n}, {opt}, {val}")
+            return await self.send_command("pgaset",
+                                           parameters=f"{n}, "
+                                                      f"{opt}, "
+                                                      f"{val}"
+                                           )
         else:
-            return await self.send_command("pgaset", parameters=f"{n}, {opt}")
+            return await self.send_command("pgaset",
+                                           parameters=f"{n}, "
+                                                      f"{opt}")
 
     async def zero(self, which: str, summary: bool) -> dict:
-        """
-        API 'zero' command.
+        """Zero a device.
 
-        Returns the STATUS section with info on the zero and optional summary.
+        :param 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.
+        :param summary: Whether or not to show a full 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: the STATUS section with info on the zero and optional
+        summary.
         """
         return await self.send_command("zero", parameters=f"{which}, {summary}")
 
     async def hotplug(self, n: int) -> dict:
-        """
-        API 'hotplug' command.
+        """Enable hotplug.
 
-        Returns the STATUS section with whether or not hotplug was enabled.
+        :param n: The device number to set hotplug on.
+
+        :return: Information on hotplug status.
         """
         return await self.send_command("hotplug", parameters=n)
 
     async def asc(self, n: int) -> dict:
-        """
-        API 'asc' command.
+        """Get data for ASC device n.
 
-        Returns a dict containing the details of a single ASC of number N.
+        :param n: The device to get data for.
 
-        n: the ASC device to get details of.
+        :return: The data for ASC device n.
         """
         return await self.send_command("asc", parameters=n)
 
     async def ascenable(self, n: int) -> dict:
-        """
-        API 'ascenable' command.
+        """Enable ASC device n.
 
-        Returns the STATUS section with the results of enabling the ASC device N.
+        :param n: The device to enable.
 
-        Parameters:
-            n: the number of the ASC to enable.
+        :return: Confirmation of enabling ASC device n.
         """
         return await self.send_command("ascenable", parameters=n)
 
     async def ascdisable(self, n: int) -> dict:
-        """
-        API 'ascdisable' command.
+        """Disable ASC device n.
 
-        Returns the STATUS section with the results of disabling the ASC device N.
-
-        Parameters:
-            n: the number of the ASC to disable.
+        :param n: The device to disable.
 
+        :return: Confirmation of disabling ASC device n.
         """
         return await self.send_command("ascdisable", parameters=n)
 
     async def ascidentify(self, n: int) -> dict:
-        """
-        API 'ascidentify' command.
+        """Identify ASC device n.
 
-        Returns the STATUS section with the results of identifying the ASC device N.
+        :param n: The device to identify.
 
-        Parameters:
-            n: the number of the PGA to identify.
+        :return: Confirmation of identifying ASC device n.
         """
         return await self.send_command("ascidentify", parameters=n)
 
     async def asccount(self) -> dict:
-        """
-        API 'asccount' command.
+        """Get data on the number of ASC devices and their info.
 
-        Returns a dict containing the number of ASC devices.
+        :return: Data on all ASC devices.
         """
         return await self.send_command("asccount")
 
     async def ascset(self, n: int, opt: str, val: int = None) -> dict:
-        """
-        API 'ascset' command.
+        """Set ASC n option opt to value val.
 
-        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:
+        Sets an option on the ASC n to a value.  Allowed options are:
             AVA+BTB -
                 opt: freq
                 val: 256 - 1024 (chip frequency)
@@ -514,6 +482,14 @@ class BMMinerAPI(BaseMinerAPI):
 
                 opt: clock
                 val: 0 - 15
+
+
+        :param n: The ASC to set the options on.
+        :param opt: The option to set. Setting this to 'help' returns a
+        help message.
+        :param val: The value to set the option to.
+
+        :return: Confirmation of setting option opt to value val.
         """
         if val:
             return await self.send_command("ascset", parameters=f"{n}, {opt}, {val}")
@@ -521,17 +497,15 @@ class BMMinerAPI(BaseMinerAPI):
             return await self.send_command("ascset", parameters=f"{n}, {opt}")
 
     async def lcd(self) -> dict:
-        """
-        API 'lcd' command.
+        """Get a general all-in-one status summary of the miner.
 
-        Returns a dict containing an all in one status summary of the miner.
+        :return: An all-in-one status summary of the miner.
         """
         return await self.send_command("lcd")
 
     async def lockstats(self) -> dict:
-        """
-        API 'lockstats' command.
+        """Write lockstats to STDERR.
 
-        Returns the STATUS section with the result of writing the lock stats to STDERR.
+        :return: The result of writing the lock stats to STDERR.
         """
         return await self.send_command("lockstats")

API/bosminer.py

@@ -2,49 +2,143 @@ 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.
+        """
         return await self.send_command("estats")
 
-    async def check(self) -> dict:
-        return await self.send_command("check")
+    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:
@@ -73,19 +167,53 @@ class BOSMinerAPI(BaseMinerAPI):
         # 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,32 +1,46 @@
-from API import BaseMinerAPI, APIError
-
-from passlib.hash import md5_crypt
 import asyncio
 import re
 import json
 import hashlib
 import binascii
-from Crypto.Cipher import AES
 import base64
 
+from passlib.handlers.md5_crypt import md5_crypt
+from cryptography.hazmat.primitives.ciphers import \
+    Cipher, algorithms, modes
+
+from API import BaseMinerAPI, APIError
+from settings import WHATSMINER_PWD
+
+
 
 ### 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.
+# 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.  If
+# you change the password, you can pass that to the this class as pwd,
+# or add it as the Whatsminer_pwd in the settings.toml file.
 
 
 def _crypt(word: str, salt: str) -> str:
+    """Encrypts a word with a salt, using a standard salt format.
+
+    Encrypts a word using a salt with the format
+    '\s*\$(\d+)\$([\w\./]*)\$'.  If this format is not used, a
+    ValueError is raised.
+
+    :param word: The word to be encrypted.
+    :param salt: The salt to encrypt the word.
+    :return: An MD5 hash of the word with the salt.
+    """
     # 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")
+        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
@@ -34,39 +48,82 @@ def _crypt(word: str, salt: str) -> str:
     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 _add_to_16(string: str) -> bytes:
+    """Add null bytes to a string until the length is a multiple 16
+
+    :param string: The string to lengthen to a multiple of 16 and
+    encode.
+
+    :return: The input string as bytes with a multiple of 16 as the
+    length.
+    """
+    while len(string) % 16 != 0:
+        string += '\0'
+    return str.encode(string)  # return bytes
 
 
-def parse_btminer_priviledge_data(token_data, data):
+def parse_btminer_priviledge_data(token_data: dict, data: dict):
+    """Parses data returned from the BTMiner privileged API.
+
+    Parses data from the BTMiner privileged API using the the token
+    from the API in an AES format.
+
+    :param token_data: The token information from self.get_token().
+    :param data: The data to parse, returned from the API.
+
+    :return: A decoded dict version of the privileged command output.
+    """
+    # get the encoded data from the dict
     enc_data = data['enc']
-    aeskey = hashlib.sha256(token_data['host_passwd_md5'].encode()).hexdigest()
+    # 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())
-    aes = AES.new(aeskey, AES.MODE_ECB)
-    ret_msg = json.loads(str(
-        aes.decrypt(base64.decodebytes(bytes(
-            enc_data, encoding='utf8'))).rstrip(b'\0').decode("utf8")))
+    # 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:
+    """Create a privileged command to send to the BTMiner API.
+
+    Creates a privileged command using the token from the API and the
+    command as a dict of {'command': cmd}, with cmd being any command
+    that the miner API accepts.
+
+    :param token_data: The token information from self.get_token().
+    :param command: The command to turn into a privileged command.
+
+    :return: The encrypted privileged command to be sent to the miner.
+    """
     # 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()
+    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 = AES.new(aeskey, AES.MODE_ECB)
+    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 = str(base64.encodebytes(
-        aes.encrypt(_add_to_16(api_json_str))),
-        encoding='utf8').replace('\n', '')
+    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
@@ -75,18 +132,65 @@ def create_privileged_cmd(token_data: dict, command: dict) -> bytes:
 
 
 class BTMinerAPI(BaseMinerAPI):
-    def __init__(self, ip, port=4028, pwd: str = "admin"):
+    """An abstraction of the API for MicroBT Whatsminers, BTMiner.
+
+    Each method corresponds to an API command in BMMiner.
+
+    This class abstracts use of the BTMiner API, as well as the
+    methods for sending commands to it.  The self.send_command()
+    function handles sending a command to the miner asynchronously, and
+    as such is the base for many of the functions in this class, which
+    rely on it to send the command for them.
+
+    All privileged commands for BTMiner's API require that you change
+    the password of the miners using the Whatsminer tool, and it can be
+    changed back to admin with this tool after.  Set the new password
+    either by passing it to the __init__ method, or changing it in
+    settings.toml.
+
+    Additionally, the API commands for the privileged API must be
+    encoded using a token from the miner, all privileged commands do
+    this automatically for you and will decode the output to look like
+    a normal output from a miner API.
+
+    :param ip: The IP of the miner to reference the API on.
+    :param port: The port to reference the API on.  Default is 4028.
+    :param pwd: The admin password of the miner.  Default is admin.
+    """
+    def __init__(self, ip, port=4028, pwd: str = WHATSMINER_PWD):
         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."""
+    async def send_command(self,
+                           command: str | bytes,
+                           parameters: str or int or bool = None,
+                           ignore_errors: bool = False
+                           ) -> dict:
+        """Send a command to the miner API.
+
+        Send a command using an asynchronous connection, load the data,
+        parse encoded data if needed, and return the result.
+
+        :param command: The command to send to the miner.
+        :param parameters: Parameters to pass to the command.
+        :param ignore_errors: Ignore the E (Error) status code from the
+        API.
+
+        :return: The data received from the API after sending the
+        command.
+        """
+        # check if command is a string
+        # if its bytes its encoded and needs to be sent 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)
+            reader, writer = await asyncio.open_connection(
+                str(self.ip),
+                self.port
+            )
         # handle OSError 121
         except OSError as e:
             if e.winerror == "121":
@@ -116,66 +220,158 @@ class BTMinerAPI(BaseMinerAPI):
         writer.close()
         await writer.wait_closed()
 
+        # check if the 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)
+                data = parse_btminer_priviledge_data(
+                    self.current_token,
+                    data
+                )
             except Exception as e:
                 print(e)
 
-        if not self.validate_command_output(data):
-            raise APIError(data["Msg"])
+        if not ignore_errors:
+            # if it fails to validate, it is likely an error
+            validation = self.validate_command_output(data)
+            if not validation[0]:
+                raise APIError(validation[1])
 
+        # return the parsed json as a dict
         return data
 
     async def get_token(self):
+        """Gets token information from the API.
+
+        :return: An encoded token and md5 password, which are used
+        for the privileged API.
+        """
+        # get the token
         data = await self.send_command("get_token")
+
+        # encrypt the admin password with the salt
         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 ####
+        # take the 4th item from the pwd split
+        host_passwd_md5 = pwd[3]
+
+        # encrypt the pwd with the time and new salt
+        tmp = _crypt(pwd[3] + data["Msg"]["time"],
+                     "$1$" + data["Msg"]["newsalt"] + '$'
+                     )
+        tmp = tmp.split('$')
+
+        # take the 4th item from the encrypted pwd split
+        host_sign = tmp[3]
+
+        # set the current token
+        self.current_token = {'host_sign': host_sign,
+                              'host_passwd_md5': host_passwd_md5
+                              }
+        return self.current_token
+
+    #### PRIVILEGED COMMANDS ####
     # Please read the top of this file to learn
-    # how to configure the whatsminer API to
+    # 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):
+                           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
+                           ):
+        """Update the pools of the miner using the API.
+
+        Update the pools of the miner using the API, only works after
+        changing the password of the miner using the Whatsminer tool.
+
+        :param pool_1: The URL to update pool 1 to.
+        :param worker_1: The worker name for pool 1 to update to.
+        :param passwd_1: The password for pool 1 to update to.
+        :param pool_2: The URL to update pool 2 to.
+        :param worker_2: The worker name for pool 2 to update to.
+        :param passwd_2: The password for pool 2 to update to.
+        :param pool_3: The URL to update pool 3 to.
+        :param worker_3: The worker name for pool 3 to update to.
+        :param passwd_3: The password for pool 3 to update to.
+        :return: A dict from the API to confirm the pools were updated.
+        """
+        # get the token and password from the miner
         token_data = await self.get_token()
-        if pool_2 and pool_3:
+
+        # 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,
+
+                "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
+                "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,
+                "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_btminer(self):
+    async def restart(self):
+        """Restart BTMiner using the API.
+
+        Restart BTMiner using the API, only works after changing
+        the password of the miner using the Whatsminer tool.
+
+        :return: A reply informing of the restart.
+        """
         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):
+        """Power off the miner using the API.
+
+        Power off the miner using the API, only works after changing
+        the password of the miner using the Whatsminer tool.
+
+        :param respbefore: Whether to respond before powering off.
+        :return: A reply informing of the status of powering off.
+        """
         if respbefore:
             command = {"cmd": "power_off", "respbefore": "true"}
         else:
@@ -185,24 +381,67 @@ class BTMinerAPI(BaseMinerAPI):
         return await self.send_command(enc_command)
 
     async def power_on(self):
+        """Power on the miner using the API.
+
+        Power on the miner using the API, only works after changing
+        the password of the miner using the Whatsminer tool.
+
+        :return: A reply informing of the status of powering 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):
+        """Reset the LED on the miner using the API.
+
+        Reset the LED on the miner using the API, only works after
+        changing the password of the miner using the Whatsminer tool.
+
+        :return: A reply informing of the status 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):
-        command = {"cmd": "set_led", "color": color, "period": period, "duration": duration, "start": start}
+    async def set_led(self,
+                      color: str = "red",
+                      period: int = 2000,
+                      duration: int = 1000,
+                      start: int = 0
+                      ):
+        """Set the LED on the miner using the API.
+
+        Set the LED on the miner using the API, only works after
+        changing the password of the miner using the Whatsminer tool.
+
+        :param color: The LED color to set, either 'red' or 'green'.
+        :param period: The flash cycle in ms.
+        :param duration: LED on time in the cycle in ms.
+        :param start: LED on time offset in the cycle in ms.
+        :return: A reply informing of the status of setting the LED.
+        """
+        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):
+        """Set low power mode on the miner using the API.
+
+        Set low power mode on the miner using the API, only works after
+        changing the password of the miner using the Whatsminer tool.
+
+        :return: A reply informing of the status of setting low power
+        mode.
+        """
         command = {"cmd": "set_low_power"}
         token_data = await self.get_token()
         enc_command = create_privileged_cmd(token_data, command)
@@ -214,84 +453,189 @@ class BTMinerAPI(BaseMinerAPI):
         return NotImplementedError
 
     async def reboot(self):
+        """Reboot the miner using the API.
+
+        :return: A reply informing of the status of the reboot.
+        """
         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):
+        """Reset the miner to factory defaults.
+
+        :return: A reply informing of the status of the reset.
+        """
         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):
+        """Update the admin user's password.
+
+        Update the admin user's password, only works after changing the
+        password of the miner using the Whatsminer tool.  New password
+        has a max length of 8 bytes, using letters, numbers, and
+        underscores.
+
+        :param old_pwd: The old admin password.
+        :param new_pwd: The new password to set.
+        :return: A reply informing of the status of setting the
+        password.
+        """
         # 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'))}")
+                f"New password too long, the max length is 8.  "
+                f"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):
+        """Update the target frequency.
+
+        Update the target frequency, only works after changing the
+        password of the miner using the Whatsminer tool. The new
+        frequency must be between -10% and 100%.
+
+        :param percent: The frequency % to set.
+        :return: A reply informing of 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")
+            return APIError(f"Frequency % is outside of the allowed "
+                            f"range.  Please set a % between -10 and "
+                            f"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):
+        """Turn on fast boot.
+
+        Turn on fast boot, only works after changing the password of
+        the miner using the Whatsminer tool.
+
+        :return: A reply informing of the status of enabling fast boot.
+        """
         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):
+        """Turn off fast boot.
+
+        Turn off fast boot, only works after changing the password of
+        the miner using the Whatsminer tool.
+
+        :return: A reply informing of the status of disabling fast boot.
+        """
         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):
+        """Turn on web pool updates.
+
+        Turn on web pool updates, only works after changing the
+        password of the miner using the Whatsminer tool.
+
+        :return: A reply informing of the status of enabling web pools.
+        """
         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):
+        """Turn off web pool updates.
+
+        Turn off web pool updates, only works after changing the
+        password of the miner using the Whatsminer tool.
+
+        :return: A reply informing of the status of disabling web
+        pools.
+        """
         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):
+        """Set the hostname of the miner.
+
+        Set the hostname of the miner, only works after changing the
+        password of the miner using the Whatsminer tool.
+
+
+        :param hostname: The new hostname to use.
+        :return: A reply informing of 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):
+        """Set the power percentage of the miner.
+
+        Set the power percentage of the miner, only works after changing
+        the password of the miner using the Whatsminer tool.
+
+        :param percent: The power percentage to set.
+        :return: A reply informing of the status of setting the
+        power percentage.
+        """
+
         if not 0 < percent < 100:
-            return APIError(f"Power PCT % is outside of the allowed range.  Please set a % between 0 and 100")
+            return APIError(f"Power PCT % is outside of the allowed "
+                            f"range.  Please set a % between 0 and "
+                            f"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):
-        if not msg == "wait for adjust temp" or "adjust complete" or "adjust continue":
+        """Configure or check status of pre power on.
+
+        Configure or check status of pre power on, only works after
+        changing the password of the miner using the Whatsminer tool.
+
+        :param complete: check whether pre power on is complete.
+        :param msg: the message to check.
+        "wait for adjust temp" or
+        "adjust complete" or
+        "adjust continue"
+        :return: A reply informing of the status of pre power on.
+        """
+
+        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"]'
+                '["wait for adjust temp", '
+                '"adjust complete", '
+                '"adjust continue"]'
             )
         if complete:
             complete = "true"
         else:
             complete = "false"
-        command = {"cmd": "pre_power_on", "complete": complete, "msg": msg}
+        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)
@@ -299,28 +643,76 @@ class BTMinerAPI(BaseMinerAPI):
     #### END privileged COMMANDS ####
 
     async def summary(self):
+        """Get the summary status from the miner.
+
+        :return: Summary status of the miner.
+        """
         return await self.send_command("summary")
 
     async def pools(self):
+        """Get the pool status from the miner.
+
+        :return: Pool status of the miner.
+        """
         return await self.send_command("pools")
 
     async def devs(self):
+        """Get data on each PGA/ASC with their details.
+
+        :return: Data on each PGA/ASC with their details.
+        """
         return await self.send_command("devs")
 
     async def edevs(self):
+        """Get data on each PGA/ASC with their details, ignoring
+         blacklisted and zombie devices.
+
+        :return: Data on each PGA/ASC with their details.
+        """
         return await self.send_command("edevs")
 
     async def devdetails(self):
+        """Get data on all devices with their static details.
+
+        :return: Data on all devices with their static details.
+        """
         return await self.send_command("devdetails")
 
     async def get_psu(self):
+        """Get data on the PSU and power information.
+
+        :return: Data on the PSU and power information.
+        """
         return await self.send_command("get_psu")
 
     async def version(self):
+        """Get version data for the miner.
+
+        Get version data for the miner.  This calls another function,
+        self.get_version(), but is named version to stay consistent
+        with the other miner APIs.
+
+        :return: Version data for the miner.
+        """
+        return await self.get_version()
+
+    async def get_version(self):
+        """Get version data for the miner.
+
+        :return: Version data for the miner.
+        """
         return await self.send_command("get_version")
 
     async def status(self):
+        """Get BTMiner status and firmware version.
+
+        :return: BTMiner status and firmware version.
+        """
         return await self.send_command("status")
 
     async def get_miner_info(self):
+        """Get general miner info.
+
+        :return: General miner info.
+        """
         return await self.send_command("get_miner_info")

API/cgminer.py

@@ -2,22 +2,36 @@ from API import BaseMinerAPI
 
 
 class CGMinerAPI(BaseMinerAPI):
+    """An abstraction of the BMMiner API.
+
+    Each method corresponds to an API command in BMMiner.
+
+    CGMiner API documentation:
+        https://github.com/ckolivas/cgminer/blob/master/API-README
+
+    This class abstracts use of the BMMiner API, as well as the
+    methods for sending commands to it.  The self.send_command()
+    function handles sending a command to the miner asynchronously, and
+    as such is the base for many of the functions in this class, which
+    rely on it to send the command for them.
+
+    :param ip: The IP of the miner to reference the API on.
+    :param port: The port to reference the API on.  Default is 4028.
+    """
     def __init__(self, ip, port=4028):
         super().__init__(ip, port)
 
     async def version(self) -> dict:
-        """
-        API 'version' command.
+        """Get miner version info.
 
-        Returns a dict containing version information.
+        :return: Miner version information.
         """
         return await self.send_command("version")
 
     async def config(self) -> dict:
-        """
-        API 'config' command.
+        """Get some basic configuration info.
 
-        Returns a dict containing some miner configuration information:
+        :return: Some miner configuration information:
             ASC Count <- the number of ASCs
             PGA Count <- the number of PGAs
             Pool Count <- the number of Pools
@@ -29,139 +43,459 @@ class CGMinerAPI(BaseMinerAPI):
         return await self.send_command("config")
 
     async def summary(self) -> dict:
+        """Get the status summary of the miner.
+
+        :return: The status summary of the miner.
+        """
         return await self.send_command("summary")
 
     async def pools(self) -> dict:
+        """Get pool information.
+
+        :return: Miner pool information.
+        """
         return await self.send_command("pools")
 
     async def devs(self) -> dict:
+        """Get data on each PGA/ASC with their details.
+
+        :return: Data on each PGA/ASC with their details.
+        """
         return await self.send_command("devs")
 
     async def edevs(self, old: bool = False) -> dict:
+        """Get data on each PGA/ASC with their details, ignoring
+         blacklisted and zombie devices.
+
+        :param old: Include zombie devices that became zombies less
+        than 'old' seconds ago
+
+        :return: Data on each PGA/ASC with their details.
+        """
         if old:
             return await self.send_command("edevs", parameters="old")
         else:
             return await self.send_command("edevs")
 
     async def pga(self, n: int) -> dict:
+        """Get data from PGA n.
+
+        :param n: The PGA number to get data from.
+
+        :return: Data on the PGA n.
+        """
         return await self.send_command("pga", parameters=n)
 
     async def pgacount(self) -> dict:
+        """Get data fon all PGAs.
+
+        :return: Data on the PGAs connected.
+        """
         return await self.send_command("pgacount")
 
     async def switchpool(self, n: int) -> dict:
+        """Switch pools to pool n.
+
+        :param n: The pool to switch to.
+
+        :return: A confirmation of switching to pool n.
+        """
         return await self.send_command("switchpool", parameters=n)
 
     async def enablepool(self, n: int) -> dict:
+        """Enable pool n.
+
+        :param n: The pool to enable.
+
+        :return: A confirmation of enabling pool n.
+        """
         return await self.send_command("enablepool", parameters=n)
 
-    async def addpool(self, url: str, username: str, password: str) -> dict:
-        return await self.send_command("addpool", parameters=f"{url}, {username}, {password}")
+    async def addpool(self,
+                      url: str,
+                      username: str,
+                      password: str
+                      ) -> dict:
+        """Add a pool to the miner.
+
+        :param url: The URL of the new pool to add.
+        :param username: The users username on the new pool.
+        :param password: The worker password on the new pool.
+
+        :return: A confirmation of adding the pool.
+        """
+        return await self.send_command("addpool",
+                                       parameters=f"{url}, "
+                                                  f"{username}, "
+                                                  f"{password}"
+                                       )
 
     async def poolpriority(self, *n: int) -> dict:
-        return await self.send_command("poolpriority", parameters=f"{','.join([str(item) for item in n])}")
+        """Set pool priority.
+
+        :param n: Pools in order of priority.
+
+        :return: A confirmation of setting pool priority.
+        """
+        pools = f"{','.join([str(item) for item in n])}"
+        return await self.send_command("poolpriority",
+                                       parameters=pools)
 
     async def poolquota(self, n: int, q: int) -> dict:
-        return await self.send_command("poolquota", parameters=f"{n}, {q}")
+        """Set pool quota.
+
+        :param n: Pool number to set quota on.
+        :param q: Quota to set the pool to.
+
+        :return: A confirmation of setting pool quota.
+        """
+        return await self.send_command("poolquota",
+                                       parameters=f"{n}, "
+                                                  f"{q}"
+                                       )
 
     async def disablepool(self, n: int) -> dict:
+        """Disable a pool.
+
+        :param n: Pool to disable.
+
+        :return: A confirmation of diabling the pool.
+        """
         return await self.send_command("disablepool", parameters=n)
 
     async def removepool(self, n: int) -> dict:
+        """Remove a pool.
+
+        :param n: Pool to remove.
+
+        :return: A confirmation of removing the pool.
+        """
         return await self.send_command("removepool", parameters=n)
 
     async def save(self, filename: str = None) -> dict:
+        """Save the config.
+
+        :param filename: Filename to save the config as.
+
+        :return: A confirmation of saving the config.
+        """
         if filename:
             return await self.send_command("save", parameters=filename)
         else:
             return await self.send_command("save")
 
     async def quit(self) -> dict:
+        """Quit BMMiner.
+
+        :return: A single "BYE" before CGMiner quits.
+        """
         return await self.send_command("quit")
 
     async def notify(self) -> dict:
+        """Notify the user of past errors.
+
+        :return: The last status and count of each devices problem(s).
+        """
         return await self.send_command("notify")
 
     async def privileged(self) -> dict:
+        """Check if you have privileged access.
+
+        :return: The STATUS section with an error if you have no
+        privileged access, or success if you have privileged access.
+        """
         return await self.send_command("privileged")
 
     async def pgaenable(self, n: int) -> dict:
+        """Enable PGA n.
+
+        :param n: The PGA to enable.
+
+        :return: A confirmation of enabling PGA n.
+        """
         return await self.send_command("pgaenable", parameters=n)
 
     async def pgadisable(self, n: int) -> dict:
+        """Disable PGA n.
+
+        :param n: The PGA to disable.
+
+        :return: A confirmation of disabling PGA n.
+        """
         return await self.send_command("pgadisable", parameters=n)
 
     async def pgaidentify(self, n: int) -> dict:
+        """Identify PGA n.
+
+        :param n: The PGA to identify.
+
+        :return: A confirmation of identifying PGA n.
+        """
         return await self.send_command("pgaidentify", parameters=n)
 
     async def devdetails(self) -> dict:
+        """Get data on all devices with their static details.
+
+        :return: Data on all devices with their static details.
+        """
         return await self.send_command("devdetails")
 
     async def restart(self) -> dict:
+        """Restart CGMiner using the API.
+
+        :return: A reply informing of the restart.
+        """
         return await self.send_command("restart")
 
     async def stats(self) -> dict:
+        """Get stats of each device/pool with more than 1 getwork.
+
+        :return: Stats of each device/pool with more than 1 getwork.
+        """
         return await self.send_command("stats")
 
     async def estats(self, old: bool = False) -> dict:
+        """Get stats of each device/pool with more than 1 getwork,
+        ignoring zombie devices.
+
+        :param old: Include zombie devices that became zombies less
+        than 'old' seconds ago.
+
+        :return: Stats of each device/pool with more than 1 getwork,
+        ignoring zombie devices.
+        """
         if old:
-            return await self.send_command("estats", parameters="old")
+            return await self.send_command("estats", parameters=old)
         else:
             return await self.send_command("estats")
 
-    async def check(self, command) -> dict:
+    async def check(self, command: str) -> dict:
+        """Check if the command command exists in BMMiner.
+
+        :param command: The command to check.
+
+        :return: Information about a command:
+            Exists (Y/N) <- the command exists in this version
+            Access (Y/N) <- you have access to use the command
+        """
         return await self.send_command("check", parameters=command)
 
     async def failover_only(self, failover: bool) -> dict:
-        return await self.send_command("failover-only", parameters=failover)
+        """Set failover-only.
+
+
+        :param failover: What to set failover-only to.
+
+        :return: Confirmation of setting failover-only.
+        """
+        return await self.send_command("failover-only",
+                                       parameters=failover
+                                       )
 
     async def coin(self) -> dict:
+        """Get information on the current coin.
+
+        :return: 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:
+        """Set a debug setting.
+
+        :param setting: Which setting to switch to. Options are:
+                Silent,
+                Quiet,
+                Verbose,
+                Debug,
+                RPCProto,
+                PerDevice,
+                WorkTime,
+                Normal.
+
+        :return: Data on which debug setting was enabled or disabled.
+        """
         return await self.send_command("debug", parameters=setting)
 
     async def setconfig(self, name: str, n: int) -> dict:
-        return await self.send_command("setconfig", parameters=f"{name}, {n}")
+        """Set config of name to value n.
+
+        :param name: The name of the config setting to set. Options are:
+                queue,
+                scantime,
+                expiry.
+        :param n: The value to set the 'name' setting to.
+
+        :return: The results of setting config of name to n.
+        """
+        return await self.send_command("setconfig",
+                                       parameters=f"{name}, "
+                                                  f"{n}"
+                                       )
 
     async def usbstats(self) -> dict:
+        """Get stats of all USB devices except ztex.
+
+        :return: 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:
+        """Set PGA option opt to val on PGA n.
+
+        Options:
+            MMQ -
+                opt: clock
+                val: 160 - 230 (multiple of 2)
+            CMR -
+                opt: clock
+                val: 100 - 220
+
+        :param n: The PGA to set the options on.
+        :param opt: The option to set. Setting this to 'help'
+        returns a help message.
+        :param val: The value to set the option to.
+
+        :return: Confirmation of setting PGA n with opt[,val].
+        """
         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, value: bool) -> dict:
-        return await self.send_command("zero", parameters=f"{which}, {value}")
+    async def zero(self, which: str, summary: bool) -> dict:
+        """Zero a device.
+
+        :param 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.
+        :param summary: Whether or not to show a full summary.
+
+
+        :return: the STATUS section with info on the zero and optional
+        summary.
+        """
+        return await self.send_command("zero", parameters=f"{which}, {summary}")
 
     async def hotplug(self, n: int) -> dict:
+        """Enable hotplug.
+
+        :param n: The device number to set hotplug on.
+
+        :return: Information on hotplug status.
+        """
         return await self.send_command("hotplug", parameters=n)
 
     async def asc(self, n: int) -> dict:
+        """Get data for ASC device n.
+
+        :param n: The device to get data for.
+
+        :return: The data for ASC device n.
+        """
         return await self.send_command("asc", parameters=n)
 
     async def ascenable(self, n: int) -> dict:
+        """Enable ASC device n.
+
+        :param n: The device to enable.
+
+        :return: Confirmation of enabling ASC device n.
+        """
         return await self.send_command("ascenable", parameters=n)
 
     async def ascdisable(self, n: int) -> dict:
+        """Disable ASC device n.
+
+        :param n: The device to disable.
+
+        :return: Confirmation of disabling ASC device n.
+        """
         return await self.send_command("ascdisable", parameters=n)
 
     async def ascidentify(self, n: int) -> dict:
+        """Identify ASC device n.
+
+        :param n: The device to identify.
+
+        :return: Confirmation of identifying ASC device n.
+        """
         return await self.send_command("ascidentify", parameters=n)
 
     async def asccount(self) -> dict:
+        """Get data on the number of ASC devices and their info.
+
+        :return: Data on all ASC devices.
+        """
         return await self.send_command("asccount")
 
     async def ascset(self, n: int, opt: str, val: int = None) -> dict:
+        """Set ASC n option opt to value val.
+
+        Sets an option on the ASC n to a value.  Allowed options are:
+            AVA+BTB -
+                opt: freq
+                val: 256 - 1024 (chip frequency)
+            BTB -
+                opt: millivolts
+                val: 1000 - 1400 (core voltage)
+            MBA -
+                opt: reset
+                val: 0 - # of chips (reset a chip)
+
+                opt: freq
+                val: 0 - # of chips, 100 - 1400 (chip frequency)
+
+                opt: ledcount
+                val: 0 - 100 (chip count for LED)
+
+                opt: ledlimit
+                val: 0 - 200 (LED off below GH/s)
+
+                opt: spidelay
+                val: 0 - 9999 (SPI per I/O delay)
+
+                opt: spireset
+                val: i or s, 0 - 9999 (SPI regular reset)
+
+                opt: spisleep
+                val: 0 - 9999 (SPI reset sleep in ms)
+            BMA -
+                opt: volt
+                val: 0 - 9
+
+                opt: clock
+                val: 0 - 15
+
+
+        :param n: The ASC to set the options on.
+        :param opt: The option to set. Setting this to 'help' returns a
+        help message.
+        :param val: The value to set the option to.
+
+        :return: Confirmation of setting option opt to value val.
+        """
         if val:
             return await self.send_command("ascset", parameters=f"{n}, {opt}, {val}")
         else:
             return await self.send_command("ascset", parameters=f"{n}, {opt}")
 
     async def lcd(self) -> dict:
+        """Get a general all-in-one status summary of the miner.
+
+        :return: An all-in-one status summary of the miner.
+        """
         return await self.send_command("lcd")
 
     async def lockstats(self) -> dict:
+        """Write lockstats to STDERR.
+
+        :return: The result of writing the lock stats to STDERR.
+        """
         return await self.send_command("lockstats")

README.md

@@ -3,6 +3,8 @@
 ## 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.
 
+For those of you who aren't comfortable with code and developer tools, there are windows builds of the GUI applications here -> (https://drive.google.com/drive/folders/1DjR8UOS_g0ehfiJcgmrV0FFoqFvE9akW?usp=sharing)
+
 ### CFG Util
 *CFG Util is a GUI for interfacing with the miners easily, it is mostly self-explanatory.*
 
@@ -10,7 +12,7 @@ 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
-from cfg_util import main
+from tools.cfg_util import main
 
 if __name__ == '__main__':
     main()
@@ -21,6 +23,21 @@ if __name__ == '__main__':
    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())
+```
+
+##### It is likely a good idea to use this code in your program anyway to be preventative.
+<br>
 
 To write your own custom programs with this repo, you have many options.
 
@@ -31,13 +48,14 @@ A basic script to find all miners on the network and get the hashrate from them
 ```python
 import asyncio
 from network import MinerNetwork
-from cfg_util.func import safe_parse_api_data
+from tools.cfg_util.func.parse_data import safe_parse_api_data
+
 
 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.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()
@@ -55,6 +73,7 @@ async def get_hashrate():
     # Print a list of all the hashrates
     print(data)
 
+
 if __name__ == '__main__':
     asyncio.new_event_loop().run_until_complete(get_hashrate())
 ```
@@ -65,7 +84,8 @@ You can also create your own miner without scanning if you know the IP:
 import asyncio
 import ipaddress
 from miners.miner_factory import MinerFactory
-from cfg_util.func import safe_parse_api_data
+from tools.cfg_util.func.parse_data import safe_parse_api_data
+
 
 async def get_miner_hashrate(ip: str):
     # Instantiate a Miner Factory to generate miners from their IP
@@ -81,6 +101,7 @@ async def get_miner_hashrate(ip: str):
     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")))
 ```
@@ -90,12 +111,13 @@ Or generate a miner directly without the factory:
 
 ```python
 import asyncio
-from miners.bosminer import BOSminer
-from cfg_util.func import safe_parse_api_data
+from miners.bosminer import BOSMiner
+from tools.cfg_util.func.parse_data import safe_parse_api_data
+
 
 async def get_miner_hashrate(ip: str):
     # Create a BOSminer miner object
-    miner = BOSminer(ip)
+    miner = BOSMiner(ip)
     # Get the API data
     summary = await miner.api.summary()
     # safe_parse_api_data parses the data from a miner API
@@ -103,6 +125,7 @@ async def get_miner_hashrate(ip: str):
     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")))
 ```
@@ -113,7 +136,8 @@ Or finally, just get the API directly:
 ```python
 import asyncio
 from API.bosminer import BOSMinerAPI
-from cfg_util.func import safe_parse_api_data
+from tools.cfg_util.func.parse_data import safe_parse_api_data
+
 
 async def get_miner_hashrate(ip: str):
     # Create a BOSminerAPI object
@@ -126,6 +150,151 @@ async def get_miner_hashrate(ip: str):
     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")))
 ```
+
+
+Now that you know that, lets move on to some common API functions that you might want to use.
+
+### Common commands:
+* Getting pool data:
+
+```python
+import asyncio
+import ipaddress
+from miners.miner_factory import MinerFactory
+from tools.cfg_util.func.parse_data import safe_parse_api_data
+
+
+async def get_miner_pool_data(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
+    pools = await miner.api.pools()
+    # 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(pools, 'POOLS')
+    # parse further from here to get all the pool info you want.
+    # each pool is on a different index eg:
+    # data[0] is pool 1
+    # data[1] is pool 2
+    # etc
+    print(data)
+
+
+if __name__ == '__main__':
+    asyncio.new_event_loop().run_until_complete(get_miner_pool_data(str("192.168.1.69")))
+```
+
+* Getting temperature data:
+
+This one is a bit tougher, lots of miners do this a different way, you might need to experiment a bit to find what works for you.
+BraiinsOS uses the "temps" command, Whatsminers has it in "devs", Avalonminers put it in "stats" as well as some other miners,
+but the spot I like to try first is in "summary".
+
+A pretty good example of really trying to make this robust is in ```cfg_util.func.miners``` in the ```get_formatted_data()``` function.
+
+```python
+import asyncio
+import ipaddress
+from miners.miner_factory import MinerFactory
+from tools.cfg_util.func.parse_data import safe_parse_api_data
+
+
+async def get_miner_temperature_data(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, "Temperature")
+    print(data)
+
+
+if __name__ == '__main__':
+    asyncio.new_event_loop().run_until_complete(get_miner_temperature_data(str("192.168.1.69")))
+```
+
+* Getting power data:
+
+How about data on the power usage of the miner?  This one only works for Whatsminers and BraiinsOS for now, and the Braiins one just uses the tuning setting, but its good enough for basic uses.
+
+```python
+import asyncio
+import ipaddress
+from miners.miner_factory import MinerFactory
+from tools.cfg_util.func.parse_data import safe_parse_api_data
+
+
+async def get_miner_power_data(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)
+    # check if this can be sent the "tunerstatus" command, BraiinsOS only
+    if "tunerstatus" in miner.api.get_commands():
+        # send the command
+        tunerstatus = await miner.api.tunerstatus()
+        # parse the return
+        data = await safe_parse_api_data(tunerstatus, 'TUNERSTATUS', 0, "PowerLimit")
+    else:
+        # send the command
+        # whatsminers have the power info in summary
+        summary = await miner.api.summary()
+        # parse the return
+        data = await safe_parse_api_data(summary, 'SUMMARY', 0, "Power")
+
+    print(data)
+
+
+if __name__ == '__main__':
+    asyncio.new_event_loop().run_until_complete(get_miner_power_data(str("192.168.1.69")))
+```
+
+* Multicommands:
+
+Multicommands make it much easier to get many types of data all at once.  The multicommand function will also remove any commands that your API can't handle automatically.
+How about we get the current pool user and hashrate in 1 command?
+
+```python
+import asyncio
+import ipaddress
+from miners.miner_factory import MinerFactory
+from tools.cfg_util.func.parse_data import safe_parse_api_data
+
+
+async def get_miner_hashrate_and_pool(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
+    api_data = await miner.api.multicommand("pools", "summary")
+    if "pools" in api_data.keys():
+        user = await safe_parse_api_data(api_data, "pools", 0, "POOLS", 0, "User")
+        print(user)
+    if "summary" in api_data.keys():
+        hashrate = await safe_parse_api_data(api_data, "summary", 0, "SUMMARY", 0, "MHS av")
+        print(hashrate)
+
+
+if __name__ == '__main__':
+    asyncio.new_event_loop().run_until_complete(get_miner_hashrate_and_pool(str("192.168.1.9")))
+```
+
+

board_util.py

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

cfg_util/func/__init__.py

@@ -1,323 +0,0 @@
-import ipaddress
-import os
-import re
-import time
-from operator import itemgetter
-import asyncio
-
-import aiofiles
-import toml
-
-from cfg_util.miner_factory import miner_factory
-from cfg_util.layout import window
-from cfg_util.func.data import safe_parse_api_data
-
-from config.bos import bos_config_convert, general_config_convert_bos
-
-from API import APIError
-
-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
-
-
-async def scan_network(network):
-    await update_ui_with_data("status", "Scanning")
-    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)
-        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)
-        progress_bar_len += 1
-        asyncio.create_task(update_prog_bar(progress_bar_len))
-    all_miners.sort(key=lambda x: x.ip)
-    window["ip_list"].update([str(miner.ip) for miner in all_miners])
-    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):
-    listbox = window['ip_list'].Widget
-    miner = await miner_factory.get_miner(ip)
-    if ip in window["ip_list"].Values:
-        index = window["ip_list"].Values.index(ip)
-        if listbox.itemcget(index, "background") == 'red':
-            listbox.itemconfigure(index, bg='#f0f3f7', fg='#000000')
-            await miner.fault_light_off()
-        else:
-            listbox.itemconfigure(index, bg='red', fg='white')
-            await miner.fault_light_on()
-
-
-async def import_config(ip):
-    await update_ui_with_data("status", "Importing")
-    miner = await miner_factory.get_miner(ipaddress.ip_address(*ip))
-    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_list"].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_list'].Values:
-                    await file.write(str(item) + "\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]
-    await set_progress_bar_len(len(ips))
-    progress_bar_len = 0
-    data_gen = asyncio.as_completed([get_formatted_data(miner) for miner in ips])
-    miner_data = []
-    for all_data in data_gen:
-        miner_data.append(await all_data)
-        progress_bar_len += 1
-        asyncio.create_task(update_prog_bar(progress_bar_len))
-
-    miner_data.sort(key=lambda x: ipaddress.ip_address(x['IP']))
-
-    total_hr = round(sum(d.get('TH/s', 0) for d in miner_data), 2)
-    window["hr_total"].update(f"{total_hr} TH/s")
-    window["hr_list"].update(disabled=False)
-    window["hr_list"].update([item['IP'] + " | "
-                              + item['host'] + " | "
-                              + str(item['TH/s']) + " TH/s | "
-                              + item['user'] + " | "
-                              + str(item['wattage']) + " W"
-                              for item in miner_data])
-    window["hr_list"].update(disabled=True)
-    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():
-    config = {'group': [{
-        'name': 'group',
-        'quota': 1,
-        'pool': [{
-            'url': 'stratum2+tcp://us-east.stratum.slushpool.com/u95GEReVMjK6k5YqiSFNqqTnKU4ypU2Wm8awa6tmbmDmk1bWt',
-            'user': 'UpstreamDataInc.test',
-            'password': '123'
-        }, {
-            'url': 'stratum2+tcp://stratum.slushpool.com/u95GEReVMjK6k5YqiSFNqqTnKU4ypU2Wm8awa6tmbmDmk1bWt',
-            'user': 'UpstreamDataInc.test',
-            'password': '123'
-        }, {
-            'url': 'stratum+tcp://stratum.slushpool.com:3333',
-            'user': 'UpstreamDataInc.test',
-            '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['hr_list'].Values
-    new_list = []
-    indexes = {}
-    for item in data_list:
-        item_data = [part.strip() for part in item.split("|")]
-        for idx, part in enumerate(item_data):
-            if re.match("[0-9]* W", part):
-                item_data[idx] = item_data[idx].replace(" W", "")
-                indexes['wattage'] = idx
-            elif re.match("[0-9]*\.?[0-9]* TH\/s", part):
-                item_data[idx] = item_data[idx].replace(" TH/s", "")
-                indexes['hr'] = idx
-            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]?)", part):
-                item_data[idx] = ipaddress.ip_address(item_data[idx])
-                indexes['ip'] = idx
-        new_list.append(item_data)
-    if not isinstance(index, str):
-        if index == indexes['hr']:
-            new_data_list = sorted(new_list, key=lambda x: float(x[index]))
-        else:
-            new_data_list = sorted(new_list, key=itemgetter(index))
-    else:
-        if index.lower() not in indexes.keys():
-            return
-        elif index.lower() == 'hr':
-            new_data_list = sorted(new_list, key=lambda x: float(x[indexes[index]]))
-        else:
-            new_data_list = sorted(new_list, key=itemgetter(indexes[index]))
-    new_ip_list = []
-    for item in new_data_list:
-        new_ip_list.append(item[indexes['ip']])
-    new_data_list = [str(item[indexes['ip']]) + " | "
-                     + item[1] + " | "
-                     + item[indexes['hr']] + " TH/s | "
-                     + item[3] + " | "
-                     + str(item[indexes['wattage']]) + " W"
-                     for item in new_data_list]
-    window["hr_list"].update(disabled=False)
-    window["hr_list"].update(new_data_list)
-    window['ip_list'].update(new_ip_list)
-    window["hr_list"].update(disabled=True)
-    await update_ui_with_data("status", "")

cfg_util/miner_factory.py

@@ -1,3 +0,0 @@
-from miners.miner_factory import MinerFactory
-
-miner_factory = MinerFactory()

cfg_util/ui.py

@@ -1,56 +0,0 @@
-import asyncio
-import sys
-
-from cfg_util.layout import window
-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'):
-            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 value['ip_list'] == window['ip_list'].Values:
-                window['ip_list'].set_value([])
-            else:
-                window['ip_list'].set_value(window['ip_list'].Values)
-        if event == 'import_config':
-            if 2 > len(value['ip_list']) > 0:
-                asyncio.create_task(import_config(value['ip_list']))
-        if event == 'light':
-            asyncio.create_task(miner_light(value['ip_list']))
-        if event == "import_iplist":
-            asyncio.create_task(import_iplist(value["file_iplist"]))
-        if event == "export_iplist":
-            asyncio.create_task(export_iplist(value["file_iplist"], value['ip_list']))
-        if event == "send_config":
-            asyncio.create_task(send_config(value['ip_list'], 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(value['ip_list']))
-        if event == "generate_config":
-            asyncio.create_task(generate_config())
-        if event == "sort_data_ip":
-            asyncio.create_task(sort_data('ip'))
-        if event == "sort_data_hr":
-            asyncio.create_task(sort_data('hr'))
-        if event == "sort_data_user":
-            asyncio.create_task(sort_data(3))
-        if event == "sort_data_w":
-            asyncio.create_task(sort_data('wattage'))
-        if event == "__TIMEOUT__":
-            await asyncio.sleep(0)

config_tool.py

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

make_board_tool_exe.py

@@ -0,0 +1,29 @@
+"""
+Make a build of the board tool.
+
+Usage: make_board_tool_exe.py build
+
+The build will show up in the build directory.
+"""
+import datetime
+import sys
+import os
+from cx_Freeze import setup, Executable
+
+base = None
+if sys.platform == "win32":
+    base = "Win32GUI"
+
+version = datetime.datetime.now()
+version = version.strftime("%y.%m.%d")
+print(version)
+
+
+setup(name="UpstreamBoardUtil.exe",
+      version=version,
+      description="Upstream Data Board Utility Build",
+      options={"build_exe": {"build_exe": f"{os.getcwd()}\\build\\board_util\\UpstreamBoardUtil-{version}-{sys.platform}\\"
+                             },
+               },
+      executables=[Executable("board_util.py", base=base, icon="icon.ico", target_name="UpstreamBoardUtil.exe")]
+      )

make_cfg_tool_exe.py

@@ -8,7 +8,6 @@ The build will show up in the build directory.
 import datetime
 import sys
 import os
-
 from cx_Freeze import setup, Executable
 
 base = None
@@ -18,9 +17,15 @@ if sys.platform == "win32":
 version = datetime.datetime.now()
 version = version.strftime("%y.%m.%d")
 print(version)
+
+
 setup(name="UpstreamCFGUtil.exe",
       version=version,
       description="Upstream Data Config Utility Build",
-      options={"build_exe": {"build_exe": f"{os.getcwd()}\\build\\UpstreamCFGUtil-{version}-{sys.platform}\\"}},
+      options={"build_exe": {"build_exe": f"{os.getcwd()}\\build\\UpstreamCFGUtil-{version}-{sys.platform}\\",
+                             "include_files": [os.path.join(os.getcwd(), "settings/settings.toml"),
+                                               os.path.join(os.getcwd(), "static/CFG-Util-README.md")],
+                             },
+               },
       executables=[Executable("config_tool.py", base=base, icon="icon.ico", target_name="UpstreamCFGUtil.exe")]
       )

miners/__init__.py

@@ -10,3 +10,30 @@ class BaseMiner:
     def __init__(self, ip: str, api: BMMinerAPI | BOSMinerAPI | CGMinerAPI | BTMinerAPI | UnknownAPI) -> None:
         self.ip = ipaddress.ip_address(ip)
         self.api = api
+        self.api_type = None
+        self.model = None
+
+    async def get_board_info(self):
+        return None
+
+    async def get_config(self):
+        return None
+
+    async def get_hostname(self):
+        return None
+
+    async def get_model(self):
+        return None
+
+    async def reboot(self):
+        return None
+
+    async def restart_backend(self):
+        return None
+
+    async def send_config(self, yaml_config):
+        return None
+
+
+
+

miners/antminer/S9/bmminer.py

@@ -0,0 +1,11 @@
+from miners.bmminer import BMMiner
+
+
+class BMMinerS9(BMMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.model = "S9"
+        self.api_type = "BMMiner"
+
+    def __repr__(self) -> str:
+        return f"BMMinerS9: {str(self.ip)}"

miners/antminer/S9/bos.py

@@ -1,118 +0,0 @@
-from miners import BaseMiner
-from API.bosminer import BOSMinerAPI
-import asyncssh
-import toml
-from config.bos import bos_config_convert, general_config_convert_bos
-
-
-class BOSMinerS9(BaseMiner):
-    def __init__(self, ip: str) -> None:
-        api = BOSMinerAPI(ip)
-        super().__init__(ip, api)
-        self.config = None
-        self.uname = 'root'
-        self.pwd = 'admin'
-
-    def __repr__(self) -> str:
-        return f"S9 - BOSminer: {str(self.ip)}"
-
-    async def _get_ssh_connection(self) -> asyncssh.connect:
-        """Create a new asyncssh connection"""
-        conn = await asyncssh.connect(str(self.ip), known_hosts=None, username=self.uname, password=self.pwd,
-                                      server_host_key_algs=['ssh-rsa'])
-        # return created connection
-        return conn
-
-    async def send_ssh_command(self, cmd: str) -> None:
-        """Sends SSH command to miner."""
-        # creates result variable
-        result = None
-
-        # runs the command on the miner
-        async with (await self._get_ssh_connection()) as conn:
-            # attempt to run command up to 3 times
-            for i in range(3):
-                try:
-                    # save result of the command
-                    result = await conn.run(cmd)
-                except Exception as e:
-                    print(f"{cmd} error: {e}")
-                    if i == 3:
-                        return
-                    continue
-
-        # let the user know the result of the command
-        if result is not None:
-            if result.stdout != "":
-                print(result.stdout)
-                if result.stderr != "":
-                    print("ERROR: " + result.stderr)
-            elif result.stderr != "":
-                print("ERROR: " + result.stderr)
-            else:
-                print(cmd)
-
-    async def fault_light_on(self) -> None:
-        """Sends command to turn on fault light on the miner."""
-        await self.send_ssh_command('miner fault_light on')
-
-    async def fault_light_off(self) -> None:
-        """Sends command to turn off fault light on the miner."""
-        await self.send_ssh_command('miner fault_light off')
-
-    async def restart_backend(self) -> None:
-        """Restart bosminer hashing process."""
-        await self.send_ssh_command('/etc/init.d/bosminer restart')
-
-    async def reboot(self) -> None:
-        """Reboots power to the physical miner."""
-        await self.send_ssh_command('/sbin/reboot')
-
-    async def get_config(self) -> None:
-        async with (await self._get_ssh_connection()) as conn:
-            async with conn.start_sftp_client() as sftp:
-                async with sftp.open('/etc/bosminer.toml') as file:
-                    toml_data = toml.loads(await file.read())
-        cfg = await bos_config_convert(toml_data)
-        self.config = cfg
-
-    async def get_hostname(self) -> str:
-        """Attempts to get hostname from miner."""
-        try:
-            async with (await self._get_ssh_connection()) as conn:
-                data = await conn.run('cat /proc/sys/kernel/hostname')
-            return data.stdout.strip()
-        except Exception as e:
-            print(self.ip, e)
-            return "BOSMiner Unknown"
-
-    async def send_config(self, yaml_config) -> None:
-        """Configures miner with yaml config."""
-        toml_conf = await general_config_convert_bos(yaml_config)
-        async with (await self._get_ssh_connection()) as conn:
-            async with conn.start_sftp_client() as sftp:
-                async with sftp.open('/etc/bosminer.toml', 'w+') as file:
-                    await file.write(toml_conf)
-            await conn.run("/etc/init.d/bosminer restart")
-
-    async def get_bad_boards(self) -> list:
-        """Checks for and provides list of non working boards."""
-        devs = await self.api.devdetails()
-        bad = 0
-        chains = devs['DEVDETAILS']
-        for chain in chains:
-            if chain['Chips'] == 0:
-                bad += 1
-        if bad > 0:
-            return [str(self.ip), bad]
-
-    async def check_good_boards(self) -> str:
-        """Checks for and provides list for working boards."""
-        devs = await self.api.devdetails()
-        bad = 0
-        chains = devs['DEVDETAILS']
-        for chain in chains:
-            if chain['Chips'] == 0:
-                bad += 1
-        if not bad > 0:
-            return str(self.ip)

miners/antminer/S9/bosminer.py

@@ -0,0 +1,11 @@
+from miners.bosminer import BOSMiner
+
+
+class BOSMinerS9(BOSMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.model = "S9"
+        self.api_type = "BOSMiner"
+
+    def __repr__(self) -> str:
+        return f"BOSminerS9: {str(self.ip)}"

miners/antminer/S9/cgminer.py

@@ -0,0 +1,11 @@
+from miners.cgminer import CGMiner
+
+
+class CGMinerS9(CGMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.model = "S9"
+        self.api_type = "CGMiner"
+
+    def __repr__(self) -> str:
+        return f"CGMinerS9: {str(self.ip)}"

miners/antminer/T9/bmminer.py

@@ -0,0 +1,11 @@
+from miners.bmminer import BMMiner
+
+
+class BMMinerT9(BMMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.model = "T9"
+        self.api_type = "BMMiner"
+
+    def __repr__(self) -> str:
+        return f"BMMinerT9: {str(self.ip)}"

miners/antminer/T9/cgminer.py

@@ -0,0 +1,11 @@
+from miners.cgminer import CGMiner
+
+
+class CGMinerT9(CGMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.model = "T9"
+        self.api_type = "CGMiner"
+
+    def __repr__(self) -> str:
+        return f"CGMinerT9: {str(self.ip)}"

miners/antminer/T9/hive.py

@@ -0,0 +1,46 @@
+from miners.bmminer import BMMiner
+
+
+class HiveonT9(BMMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.model = "T9"
+        self.api_type = "Hiveon"
+
+    def __repr__(self) -> str:
+        return f"HiveonT9: {str(self.ip)}"
+
+    async def get_board_info(self) -> dict:
+        """Gets data on each board and chain in the miner."""
+        board_stats = await self.api.stats()
+        stats = board_stats['STATS'][1]
+        boards = {}
+        board_chains = {0: [2, 9, 10], 1: [3, 11, 12], 2: [4, 13, 14]}
+        for idx, board in enumerate(board_chains):
+            boards[board] = []
+            for chain in board_chains[board]:
+                count = stats[f"chain_acn{chain}"]
+                chips = stats[f"chain_acs{chain}"].replace(" ", "")
+                if not count == 18 or "x" in chips:
+                    nominal = False
+                else:
+                    nominal = True
+                boards[board].append({
+                    "chain": chain,
+                    "chip_count": count,
+                    "chip_status": chips,
+                    "nominal": nominal
+                })
+        return boards
+
+    async def get_bad_boards(self) -> dict:
+        """Checks for and provides list of non working boards."""
+        boards = await self.get_board_info()
+        bad_boards = {}
+        for board in boards.keys():
+            for chain in boards[board]:
+                if not chain["chip_count"] == 18 or "x" in chain["chip_status"]:
+                    if board not in bad_boards.keys():
+                        bad_boards[board] = []
+                    bad_boards[board].append(chain)
+        return bad_boards

miners/antminer/X17/bmminer.py

@@ -0,0 +1,9 @@
+from miners.bmminer import BMMiner
+
+
+class BMMinerX17(BMMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+
+    def __repr__(self) -> str:
+        return f"BMMinerX17: {str(self.ip)}"

miners/antminer/X17/bos.py

@@ -1,118 +0,0 @@
-from miners import BaseMiner
-from API.bosminer import BOSMinerAPI
-import asyncssh
-import toml
-from config.bos import bos_config_convert, general_config_convert_bos
-
-
-class BOSminerX17(BaseMiner):
-    def __init__(self, ip: str) -> None:
-        api = BOSMinerAPI(ip)
-        super().__init__(ip, api)
-        self.config = None
-        self.uname = 'root'
-        self.pwd = 'admin'
-
-    def __repr__(self) -> str:
-        return f"X17 - BOSminer: {str(self.ip)}"
-
-    async def _get_ssh_connection(self) -> asyncssh.connect:
-        """Create a new asyncssh connection"""
-        conn = await asyncssh.connect(str(self.ip), known_hosts=None, username=self.uname, password=self.pwd,
-                                      server_host_key_algs=['ssh-rsa'])
-        # return created connection
-        return conn
-
-    async def send_ssh_command(self, cmd: str) -> None:
-        """Sends SSH command to miner."""
-        # creates result variable
-        result = None
-
-        # runs the command on the miner
-        async with (await self._get_ssh_connection()) as conn:
-            # attempt to run command up to 3 times
-            for i in range(3):
-                try:
-                    # save result of the command
-                    result = await conn.run(cmd)
-                except Exception as e:
-                    print(f"{cmd} error: {e}")
-                    if i == 3:
-                        return
-                    continue
-
-        # let the user know the result of the command
-        if result is not None:
-            if result.stdout != "":
-                print(result.stdout)
-                if result.stderr != "":
-                    print("ERROR: " + result.stderr)
-            elif result.stderr != "":
-                print("ERROR: " + result.stderr)
-            else:
-                print(cmd)
-
-    async def fault_light_on(self) -> None:
-        """Sends command to turn on fault light on the miner."""
-        await self.send_ssh_command('miner fault_light on')
-
-    async def fault_light_off(self) -> None:
-        """Sends command to turn off fault light on the miner."""
-        await self.send_ssh_command('miner fault_light off')
-
-    async def restart_backend(self) -> None:
-        """Restart bosminer hashing process."""
-        await self.send_ssh_command('/etc/init.d/bosminer restart')
-
-    async def reboot(self) -> None:
-        """Reboots power to the physical miner."""
-        await self.send_ssh_command('/sbin/reboot')
-
-    async def get_config(self) -> None:
-        async with (await self._get_ssh_connection()) as conn:
-            async with conn.start_sftp_client() as sftp:
-                async with sftp.open('/etc/bosminer.toml') as file:
-                    toml_data = toml.loads(await file.read())
-        cfg = await bos_config_convert(toml_data)
-        self.config = cfg
-
-    async def get_hostname(self) -> str:
-        """Attempts to get hostname from miner."""
-        try:
-            async with (await self._get_ssh_connection()) as conn:
-                data = await conn.run('cat /proc/sys/kernel/hostname')
-            return data.stdout.strip()
-        except Exception as e:
-            print(self.ip, e)
-            return "BOSMiner Unknown"
-
-    async def send_config(self, yaml_config) -> None:
-        """Configures miner with yaml config."""
-        toml_conf = await general_config_convert_bos(yaml_config)
-        async with (await self._get_ssh_connection()) as conn:
-            async with conn.start_sftp_client() as sftp:
-                async with sftp.open('/etc/bosminer.toml', 'w+') as file:
-                    await file.write(toml_conf)
-            await conn.run("/etc/init.d/bosminer restart")
-
-    async def get_bad_boards(self) -> list:
-        """Checks for and provides list of non working boards."""
-        devs = await self.api.devdetails()
-        bad = 0
-        chains = devs['DEVDETAILS']
-        for chain in chains:
-            if chain['Chips'] == 0:
-                bad += 1
-        if bad > 0:
-            return [str(self.ip), bad]
-
-    async def check_good_boards(self) -> str:
-        """Checks for and provides list for working boards."""
-        devs = await self.api.devdetails()
-        bad = 0
-        chains = devs['DEVDETAILS']
-        for chain in chains:
-            if chain['Chips'] == 0:
-                bad += 1
-        if not bad > 0:
-            return str(self.ip)

miners/antminer/X17/bosminer.py

@@ -0,0 +1,11 @@
+from miners.bosminer import BOSMiner
+
+
+class BOSMinerX17(BOSMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.api_type = "BOSMiner"
+        self.nominal_chips = 65
+
+    def __repr__(self) -> str:
+        return f"BOSminerX17: {str(self.ip)}"

miners/antminer/X17/cgminer.py

@@ -0,0 +1,10 @@
+from miners.cgminer import CGMiner
+
+
+class CGMinerX17(CGMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.api_type = "CGMiner"
+
+    def __repr__(self) -> str:
+        return f"CGMinerX17: {str(self.ip)}"

miners/antminer/X19/bmminer.py

@@ -0,0 +1,18 @@
+from miners.bmminer import BMMiner
+
+
+class BMMinerX19(BMMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+
+    def __repr__(self) -> str:
+        return f"BMMinerX19: {str(self.ip)}"
+
+    async def get_model(self):
+        if self.model:
+            return self.model
+        version_data = await self.api.version()
+        if version_data:
+            self.model = version_data["VERSION"][0]["Type"].replace("Antminer ", "")
+            return self.model
+        return None

miners/antminer/X19/cgminer.py

@@ -0,0 +1,19 @@
+from miners.cgminer import CGMiner
+
+
+class CGMinerX19(CGMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.api_type = "CGMiner"
+
+    def __repr__(self) -> str:
+        return f"CGMinerX19: {str(self.ip)}"
+
+    async def get_model(self):
+        if self.model:
+            return self.model
+        version_data = await self.api.version()
+        if version_data:
+            self.model = version_data["VERSION"][0]["Type"].replace("Antminer ", "")
+            return self.model
+        return None

miners/avalonminer/Avalon8/__init__.py

@@ -0,0 +1,175 @@
+from miners.cgminer import CGMiner
+import re
+
+
+class CGMinerAvalon(CGMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.model = "Avalon"
+        self.api_type = "CGMiner"
+        self.pattern = re.compile(r'Ver\[(?P<Ver>[-0-9A-Fa-f+]+)\]\s'
+                                   'DNA\[(?P<DNA>[0-9A-Fa-f]+)\]\s'
+                                   'Elapsed\[(?P<Elapsed>[-0-9]+)\]\s'
+                                   'MW\[(?P<MW>[-\s0-9]+)\]\s'
+                                   'LW\[(?P<LW>[-0-9]+)\]\s'
+                                   'MH\[(?P<MH>[-\s0-9]+)\]\s'
+                                   'HW\[(?P<HW>[-0-9]+)\]\s'
+                                   'Temp\[(?P<Temp>[0-9]+)\]\s'
+                                   'TMax\[(?P<TMax>[0-9]+)\]\s'
+                                   'Fan\[(?P<Fan>[0-9]+)\]\s'
+                                   'FanR\[(?P<FanR>[0-9]+)%\]\s'
+                                   'Vi\[(?P<Vi>[-\s0-9]+)\]\s'
+                                   'Vo\[(?P<Vo>[-\s0-9]+)\]\s'
+                                   '('
+                                   'PLL0\[(?P<PLL0>[-\s0-9]+)\]\s'
+                                   'PLL1\[(?P<PLL1>[-\s0-9]+)\]\s'
+                                   'PLL2\[(?P<PLL2>[-\s0-9]+)\]\s'
+                                   'PLL3\[(?P<PLL3>[-\s0-9]+)\]\s'
+                                   ')?'
+                                   'GHSmm\[(?P<GHSmm>[-.0-9]+)\]\s'
+                                   'WU\[(?P<WU>[-.0-9]+)\]\s'
+                                   'Freq\[(?P<Freq>[.0-9]+)\]\s'
+                                   'PG\[(?P<PG>[0-9]+)\]\s'
+                                   'Led\[(?P<LED>0|1)\]\s'
+                                   'MW0\[(?P<MW0>[0-9\s]+)\]\s'
+                                   'MW1\[(?P<MW1>[0-9\s]+)\]\s'
+                                   'MW2\[(?P<MW2>[0-9\s]+)\]\s'
+                                   'MW3\[(?P<MW3>[0-9\s]+)\]\s'
+                                   'TA\[(?P<TA>[0-9]+)\]\s'
+                                   'ECHU\[(?P<ECHU>[0-9\s]+)\]\s'
+                                   'ECMM\[(?P<ECMM>[0-9]+)\]\s.*'
+                                   'FAC0\[(?P<FAC0>[-0-9]+)\]\s'
+                                   'OC\[(?P<OC>[0-9]+)\]\s'
+                                   'SF0\[(?P<SF0>[-\s0-9]+)\]\s'
+                                   'SF1\[(?P<SF1>[-\s0-9]+)\]\s'
+                                   'SF2\[(?P<SF2>[-\s0-9]+)\]\s'
+                                   'SF3\[(?P<SF3>[-\s0-9]+)\]\s'
+                                   'PMUV\[(?P<PMUV>[-\s\S*]+)\]\s'
+                                   'PVT_T0\[(?P<PVT_T0>[-0-9\s]+)\]\s'
+                                   'PVT_T1\[(?P<PVT_T1>[-0-9\s]+)\]\s'
+                                   'PVT_T2\[(?P<PVT_T2>[-0-9\s]+)\]\s'
+                                   'PVT_T3\[(?P<PVT_T3>[-0-9\s]+)\]\s'
+                                   'PVT_V0_0\[(?P<PVT_V0_0>[-0-9\s]+)\]\s'
+                                   'PVT_V0_1\[(?P<PVT_V0_1>[-0-9\s]+)\]\s'
+                                   'PVT_V0_2\[(?P<PVT_V0_2>[-0-9\s]+)\]\s'
+                                   'PVT_V0_3\[(?P<PVT_V0_3>[-0-9\s]+)\]\s'
+                                   'PVT_V0_4\[(?P<PVT_V0_4>[-0-9\s]+)\]\s'
+                                   'PVT_V0_5\[(?P<PVT_V0_5>[-0-9\s]+)\]\s'
+                                   'PVT_V0_6\[(?P<PVT_V0_6>[-0-9\s]+)\]\s'
+                                   'PVT_V0_7\[(?P<PVT_V0_7>[-0-9\s]+)\]\s'
+                                   'PVT_V0_8\[(?P<PVT_V0_8>[-0-9\s]+)\]\s'
+                                   'PVT_V0_9\[(?P<PVT_V0_9>[-0-9\s]+)\]\s'
+                                   'PVT_V0_10\[(?P<PVT_V0_10>[-0-9\s]+)\]\s'
+                                   'PVT_V0_11\[(?P<PVT_V0_11>[-0-9\s]+)\]\s'
+                                   'PVT_V0_12\[(?P<PVT_V0_12>[-0-9\s]+)\]\s'
+                                   'PVT_V0_13\[(?P<PVT_V0_13>[-0-9\s]+)\]\s'
+                                   'PVT_V0_14\[(?P<PVT_V0_14>[-0-9\s]+)\]\s'
+                                   'PVT_V0_15\[(?P<PVT_V0_15>[-0-9\s]+)\]\s'
+                                   'PVT_V0_16\[(?P<PVT_V0_16>[-0-9\s]+)\]\s'
+                                   'PVT_V0_17\[(?P<PVT_V0_17>[-0-9\s]+)\]\s'
+                                   'PVT_V0_18\[(?P<PVT_V0_18>[-0-9\s]+)\]\s'
+                                   'PVT_V0_19\[(?P<PVT_V0_19>[-0-9\s]+)\]\s'
+                                   'PVT_V0_20\[(?P<PVT_V0_20>[-0-9\s]+)\]\s'
+                                   'PVT_V0_21\[(?P<PVT_V0_21>[-0-9\s]+)\]\s'
+                                   'PVT_V0_22\[(?P<PVT_V0_22>[-0-9\s]+)\]\s'
+                                   'PVT_V0_23\[(?P<PVT_V0_23>[-0-9\s]+)\]\s'
+                                   'PVT_V0_24\[(?P<PVT_V0_24>[-0-9\s]+)\]\s'
+                                   'PVT_V0_25\[(?P<PVT_V0_25>[-0-9\s]+)\]\s'
+                                   'PVT_V1_0\[(?P<PVT_V1_0>[-0-9\s]+)\]\s'
+                                   'PVT_V1_1\[(?P<PVT_V1_1>[-0-9\s]+)\]\s'
+                                   'PVT_V1_2\[(?P<PVT_V1_2>[-0-9\s]+)\]\s'
+                                   'PVT_V1_3\[(?P<PVT_V1_3>[-0-9\s]+)\]\s'
+                                   'PVT_V1_4\[(?P<PVT_V1_4>[-0-9\s]+)\]\s'
+                                   'PVT_V1_5\[(?P<PVT_V1_5>[-0-9\s]+)\]\s'
+                                   'PVT_V1_6\[(?P<PVT_V1_6>[-0-9\s]+)\]\s'
+                                   'PVT_V1_7\[(?P<PVT_V1_7>[-0-9\s]+)\]\s'
+                                   'PVT_V1_8\[(?P<PVT_V1_8>[-0-9\s]+)\]\s'
+                                   'PVT_V1_9\[(?P<PVT_V1_9>[-0-9\s]+)\]\s'
+                                   'PVT_V1_10\[(?P<PVT_V1_10>[-0-9\s]+)\]\s'
+                                   'PVT_V1_11\[(?P<PVT_V1_11>[-0-9\s]+)\]\s'
+                                   'PVT_V1_12\[(?P<PVT_V1_12>[-0-9\s]+)\]\s'
+                                   'PVT_V1_13\[(?P<PVT_V1_13>[-0-9\s]+)\]\s'
+                                   'PVT_V1_14\[(?P<PVT_V1_14>[-0-9\s]+)\]\s'
+                                   'PVT_V1_15\[(?P<PVT_V1_15>[-0-9\s]+)\]\s'
+                                   'PVT_V1_16\[(?P<PVT_V1_16>[-0-9\s]+)\]\s'
+                                   'PVT_V1_17\[(?P<PVT_V1_17>[-0-9\s]+)\]\s'
+                                   'PVT_V1_18\[(?P<PVT_V1_18>[-0-9\s]+)\]\s'
+                                   'PVT_V1_19\[(?P<PVT_V1_19>[-0-9\s]+)\]\s'
+                                   'PVT_V1_20\[(?P<PVT_V1_20>[-0-9\s]+)\]\s'
+                                   'PVT_V1_21\[(?P<PVT_V1_21>[-0-9\s]+)\]\s'
+                                   'PVT_V1_22\[(?P<PVT_V1_22>[-0-9\s]+)\]\s'
+                                   'PVT_V1_23\[(?P<PVT_V1_23>[-0-9\s]+)\]\s'
+                                   'PVT_V1_24\[(?P<PVT_V1_24>[-0-9\s]+)\]\s'
+                                   'PVT_V1_25\[(?P<PVT_V1_25>[-0-9\s]+)\]\s'
+                                   'PVT_V2_0\[(?P<PVT_V2_0>[-0-9\s]+)\]\s'
+                                   'PVT_V2_1\[(?P<PVT_V2_1>[-0-9\s]+)\]\s'
+                                   'PVT_V2_2\[(?P<PVT_V2_2>[-0-9\s]+)\]\s'
+                                   'PVT_V2_3\[(?P<PVT_V2_3>[-0-9\s]+)\]\s'
+                                   'PVT_V2_4\[(?P<PVT_V2_4>[-0-9\s]+)\]\s'
+                                   'PVT_V2_5\[(?P<PVT_V2_5>[-0-9\s]+)\]\s'
+                                   'PVT_V2_6\[(?P<PVT_V2_6>[-0-9\s]+)\]\s'
+                                   'PVT_V2_7\[(?P<PVT_V2_7>[-0-9\s]+)\]\s'
+                                   'PVT_V2_8\[(?P<PVT_V2_8>[-0-9\s]+)\]\s'
+                                   'PVT_V2_9\[(?P<PVT_V2_9>[-0-9\s]+)\]\s'
+                                   'PVT_V2_10\[(?P<PVT_V2_10>[-0-9\s]+)\]\s'
+                                   'PVT_V2_11\[(?P<PVT_V2_11>[-0-9\s]+)\]\s'
+                                   'PVT_V2_12\[(?P<PVT_V2_12>[-0-9\s]+)\]\s'
+                                   'PVT_V2_13\[(?P<PVT_V2_13>[-0-9\s]+)\]\s'
+                                   'PVT_V2_14\[(?P<PVT_V2_14>[-0-9\s]+)\]\s'
+                                   'PVT_V2_15\[(?P<PVT_V2_15>[-0-9\s]+)\]\s'
+                                   'PVT_V2_16\[(?P<PVT_V2_16>[-0-9\s]+)\]\s'
+                                   'PVT_V2_17\[(?P<PVT_V2_17>[-0-9\s]+)\]\s'
+                                   'PVT_V2_18\[(?P<PVT_V2_18>[-0-9\s]+)\]\s'
+                                   'PVT_V2_19\[(?P<PVT_V2_19>[-0-9\s]+)\]\s'
+                                   'PVT_V2_20\[(?P<PVT_V2_20>[-0-9\s]+)\]\s'
+                                   'PVT_V2_21\[(?P<PVT_V2_21>[-0-9\s]+)\]\s'
+                                   'PVT_V2_22\[(?P<PVT_V2_22>[-0-9\s]+)\]\s'
+                                   'PVT_V2_23\[(?P<PVT_V2_23>[-0-9\s]+)\]\s'
+                                   'PVT_V2_24\[(?P<PVT_V2_24>[-0-9\s]+)\]\s'
+                                   'PVT_V2_25\[(?P<PVT_V2_25>[-0-9\s]+)\]\s'
+                                   'PVT_V3_0\[(?P<PVT_V3_0>[-0-9\s]+)\]\s'
+                                   'PVT_V3_1\[(?P<PVT_V3_1>[-0-9\s]+)\]\s'
+                                   'PVT_V3_2\[(?P<PVT_V3_2>[-0-9\s]+)\]\s'
+                                   'PVT_V3_3\[(?P<PVT_V3_3>[-0-9\s]+)\]\s'
+                                   'PVT_V3_4\[(?P<PVT_V3_4>[-0-9\s]+)\]\s'
+                                   'PVT_V3_5\[(?P<PVT_V3_5>[-0-9\s]+)\]\s'
+                                   'PVT_V3_6\[(?P<PVT_V3_6>[-0-9\s]+)\]\s'
+                                   'PVT_V3_7\[(?P<PVT_V3_7>[-0-9\s]+)\]\s'
+                                   'PVT_V3_8\[(?P<PVT_V3_8>[-0-9\s]+)\]\s'
+                                   'PVT_V3_9\[(?P<PVT_V3_9>[-0-9\s]+)\]\s'
+                                   'PVT_V3_10\[(?P<PVT_V3_10>[-0-9\s]+)\]\s'
+                                   'PVT_V3_11\[(?P<PVT_V3_11>[-0-9\s]+)\]\s'
+                                   'PVT_V3_12\[(?P<PVT_V3_12>[-0-9\s]+)\]\s'
+                                   'PVT_V3_13\[(?P<PVT_V3_13>[-0-9\s]+)\]\s'
+                                   'PVT_V3_14\[(?P<PVT_V3_14>[-0-9\s]+)\]\s'
+                                   'PVT_V3_15\[(?P<PVT_V3_15>[-0-9\s]+)\]\s'
+                                   'PVT_V3_16\[(?P<PVT_V3_16>[-0-9\s]+)\]\s'
+                                   'PVT_V3_17\[(?P<PVT_V3_17>[-0-9\s]+)\]\s'
+                                   'PVT_V3_18\[(?P<PVT_V3_18>[-0-9\s]+)\]\s'
+                                   'PVT_V3_19\[(?P<PVT_V3_19>[-0-9\s]+)\]\s'
+                                   'PVT_V3_20\[(?P<PVT_V3_20>[-0-9\s]+)\]\s'
+                                   'PVT_V3_21\[(?P<PVT_V3_21>[-0-9\s]+)\]\s'
+                                   'PVT_V3_22\[(?P<PVT_V3_22>[-0-9\s]+)\]\s'
+                                   'PVT_V3_23\[(?P<PVT_V3_23>[-0-9\s]+)\]\s'
+                                   'PVT_V3_24\[(?P<PVT_V3_24>[-0-9\s]+)\]\s'
+                                   'PVT_V3_25\[(?P<PVT_V3_25>[-0-9\s]+)\]\s'
+                                   'FM\[(?P<FM>[0-9]+)\]\s'
+                                   'CRC\[(?P<CRC>[0-9\s]+)\]', re.X
+                                   )
+
+    def __repr__(self) -> str:
+        return f"CGMinerAvalon: {str(self.ip)}"
+
+    def parse_estats(self, estats):
+        for estat in estats:
+            for key in estat:
+                if key[:5] == 'MM ID':
+                    self._parse_estat(estat, key)
+
+    def _parse_estat(self, estat, key):
+        module = estat[key]
+        module_info = re.match(self.pattern, module)
+        if not module_info:
+            return None
+        module_info = module_info.groupdict()
+        print(module_info)

miners/avalonminer/__init__.py

@@ -0,0 +1,11 @@
+from miners.cgminer import CGMiner
+
+
+class CGMinerAvalon(CGMiner):
+    def __init__(self, ip: str) -> None:
+        super().__init__(ip)
+        self.model = "Avalon"
+        self.api_type = "CGMiner"
+
+    def __repr__(self) -> str:
+        return f"CGMinerAvalon: {str(self.ip)}"

miners/bmminer.py

@@ -1,26 +1,74 @@
 from API.bmminer import BMMinerAPI
 from miners import BaseMiner
+import asyncssh
 
 
 class BMMiner(BaseMiner):
     def __init__(self, ip: str) -> None:
         api = BMMinerAPI(ip)
         super().__init__(ip, api)
+        self.model = None
+        self.config = None
+        self.uname = 'root'
+        self.pwd = 'admin'
 
     def __repr__(self) -> str:
         return f"BMMiner: {str(self.ip)}"
 
+    async def get_model(self):
+        if self.model:
+            return self.model
+        version_data = await self.api.devdetails()
+        if version_data:
+            self.model = version_data["DEVDETAILS"][0]["Model"].replace("Antminer ", "")
+            return self.model
+        return None
+
     async def get_hostname(self) -> str:
-        return "BMMiner Unknown"
+        try:
+            async with (await self._get_ssh_connection()) as conn:
+                if conn is not None:
+                    data = await conn.run('cat /proc/sys/kernel/hostname')
+                    return data.stdout.strip()
+                else:
+                    return "?"
+        except Exception:
+            return "?"
 
-    async def send_config(self, _):
-        return None  # ignore for now
+    async def _get_ssh_connection(self) -> asyncssh.connect:
+        try:
+            conn = await asyncssh.connect(str(self.ip),
+                                          known_hosts=None,
+                                          username=self.uname,
+                                          password=self.pwd,
+                                          server_host_key_algs=['ssh-rsa'])
+            return conn
+        except asyncssh.misc.PermissionDenied:
+            try:
+                conn = await asyncssh.connect(str(self.ip),
+                                              known_hosts=None,
+                                              username="admin",
+                                              password="admin",
+                                              server_host_key_algs=['ssh-rsa'])
+                return conn
+            except Exception as e:
+                print(e)
+        except OSError:
+            print(str(self.ip) + ": Connection refused.")
+            return None
 
-    async def restart_backend(self) -> None:
-        return None  # Murray
+    async def send_ssh_command(self, cmd):
+        result = None
+        async with (await self._get_ssh_connection()) as conn:
+            for i in range(3):
+                try:
+                    result = await conn.run(cmd)
+                except Exception as e:
+                    print(f"{cmd} error: {e}")
+                    if i == 3:
+                        return
+                    continue
+        return result
 
     async def reboot(self) -> None:
-        return None  # Murray
-
-    async def get_config(self) -> None:
-        return None  # Murray
+        await self.send_ssh_command("reboot")

miners/bosminer.py

@@ -5,13 +5,15 @@ import toml
 from config.bos import bos_config_convert, general_config_convert_bos
 
 
-class BOSminer(BaseMiner):
+class BOSMiner(BaseMiner):
     def __init__(self, ip: str) -> None:
         api = BOSMinerAPI(ip)
         super().__init__(ip, api)
+        self.model = None
         self.config = None
         self.uname = 'root'
         self.pwd = 'admin'
+        self.nominal_chips = 63
 
     def __repr__(self) -> str:
         return f"BOSminer: {str(self.ip)}"
@@ -60,7 +62,10 @@ class BOSminer(BaseMiner):
         """Sends command to turn off fault light on the miner."""
         await self.send_ssh_command('miner fault_light off')
 
-    async def restart_backend(self) -> None:
+    async def restart_backend(self):
+        await self.restart_bosminer()
+
+    async def restart_bosminer(self) -> None:
         """Restart bosminer hashing process."""
         await self.send_ssh_command('/etc/init.d/bosminer restart')
 
@@ -86,6 +91,16 @@ class BOSminer(BaseMiner):
             print(self.ip, e)
             return "BOSMiner Unknown"
 
+    async def get_model(self):
+        if self.model:
+            return self.model + " (BOS)"
+        version_data = await self.api.devdetails()
+        if version_data:
+            if not version_data["DEVDETAILS"] == []:
+                self.model = version_data["DEVDETAILS"][0]["Model"].replace("Antminer ", "")
+                return self.model + " (BOS)"
+        return None
+
     async def send_config(self, yaml_config) -> None:
         """Configures miner with yaml config."""
         toml_conf = await general_config_convert_bos(yaml_config)
@@ -95,16 +110,41 @@ class BOSminer(BaseMiner):
                     await file.write(toml_conf)
             await conn.run("/etc/init.d/bosminer restart")
 
-    async def get_bad_boards(self) -> list:
+    async def get_board_info(self) -> dict:
+        """Gets data on each board and chain in the miner."""
+        devdetails = await self.api.devdetails()
+        if not devdetails.get("DEVDETAILS"):
+            print("devdetails error", devdetails)
+            return {0: [], 1: [], 2: []}
+        devs = devdetails['DEVDETAILS']
+        boards = {}
+        offset = devs[0]["ID"]
+        for board in devs:
+            boards[board["ID"] - offset] = []
+            if not board['Chips'] == self.nominal_chips:
+                nominal = False
+            else:
+                nominal = True
+            boards[board["ID"] - offset].append({
+                "chain": board["ID"] - offset,
+                "chip_count": board['Chips'],
+                "chip_status": "o" * board['Chips'],
+                "nominal": nominal
+            })
+        return boards
+
+    async def get_bad_boards(self) -> dict:
         """Checks for and provides list of non working boards."""
-        devs = await self.api.devdetails()
-        bad = 0
-        chains = devs['DEVDETAILS']
-        for chain in chains:
-            if chain['Chips'] == 0:
-                bad += 1
-        if bad > 0:
-            return [str(self.ip), bad]
+        boards = await self.get_board_info()
+        bad_boards = {}
+        for board in boards.keys():
+            for chain in boards[board]:
+                if not chain["chip_count"] == 63:
+                    if board not in bad_boards.keys():
+                        bad_boards[board] = []
+                    bad_boards[board].append(chain)
+        return bad_boards
+
 
     async def check_good_boards(self) -> str:
         """Checks for and provides list for working boards."""

miners/btminer.py

@@ -1,26 +1,59 @@
 from API.btminer import BTMinerAPI
 from miners import BaseMiner
+from API import APIError
 
 
 class BTMiner(BaseMiner):
     def __init__(self, ip: str) -> None:
         api = BTMinerAPI(ip)
+        self.model = None
         super().__init__(ip, api)
+        self.nominal_chips = 66
 
     def __repr__(self) -> str:
         return f"BTMiner: {str(self.ip)}"
 
+    async def get_model(self):
+        if self.model:
+            return self.model
+        version_data = await self.api.devdetails()
+        if version_data:
+            self.model = version_data["DEVDETAILS"][0]["Model"].split("V")[0]
+            return self.model
+        return None
+
     async def get_hostname(self) -> str:
-        return "BTMiner Unknown"
+        try:
+            host_data = await self.api.get_miner_info()
+            if host_data:
+                return host_data["Msg"]["hostname"]
+        except APIError:
+            return "?"
 
-    async def send_config(self, _):
-        return None  # ignore for now
 
-    async def restart_backend(self) -> None:
-        return None
+    async def get_board_info(self) -> dict:
+        """Gets data on each board and chain in the miner."""
+        devs = await self.api.devs()
+        if not devs.get("DEVS"):
+            print("devs error", devs)
+            return {0: [], 1: [], 2: []}
+        devs = devs["DEVS"]
+        boards = {}
+        offset = devs[0]["ID"]
+        for board in devs:
+            boards[board["ID"] - offset] = []
+            if "Effective Chips" in board.keys():
+                if not board['Effective Chips'] in self.nominal_chips:
+                    nominal = False
+                else:
+                    nominal = True
+                boards[board["ID"] - offset].append({
+                    "chain": board["ID"] - offset,
+                    "chip_count": board['Effective Chips'],
+                    "chip_status": "o" * board['Effective Chips'],
+                    "nominal": nominal
+                })
+            else:
+                print(board)
+        return boards
 
-    async def reboot(self) -> None:
-        return None
-
-    async def get_config(self) -> None:
-        return None

miners/cgminer.py

@@ -1,5 +1,6 @@
 from miners import BaseMiner
 from API.cgminer import CGMinerAPI
+from API import APIError
 import asyncssh
 
 
@@ -7,6 +8,7 @@ class CGMiner(BaseMiner):
     def __init__(self, ip: str) -> None:
         api = CGMinerAPI(ip)
         super().__init__(ip, api)
+        self.model = None
         self.config = None
         self.uname = 'root'
         self.pwd = 'admin'
@@ -14,6 +16,18 @@ class CGMiner(BaseMiner):
     def __repr__(self) -> str:
         return f"CGMiner: {str(self.ip)}"
 
+    async def get_model(self):
+        if self.model:
+            return self.model
+        try:
+            version_data = await self.api.devdetails()
+        except APIError:
+            return None
+        if version_data:
+            self.model = version_data["DEVDETAILS"][0]["Model"].replace("Antminer ", "")
+            return self.model
+        return None
+
     async def get_hostname(self) -> str:
         try:
             async with (await self._get_ssh_connection()) as conn:
@@ -21,12 +35,9 @@ class CGMiner(BaseMiner):
                     data = await conn.run('cat /proc/sys/kernel/hostname')
                     return data.stdout.strip()
                 else:
-                    return "CGMiner Unknown"
+                    return "?"
         except Exception:
-            return "CGMiner Unknown"
-
-    async def send_config(self, _):
-        return None  # ignore for now
+            return "?"
 
     async def _get_ssh_connection(self) -> asyncssh.connect:
         try:
@@ -67,10 +78,15 @@ class CGMiner(BaseMiner):
     @staticmethod
     def _result_handler(result: asyncssh.process.SSHCompletedProcess) -> None:
         if result is not None:
+            # noinspection PyUnresolvedReferences
             if len(result.stdout) > 0:
+                # noinspection PyUnresolvedReferences
                 print("ssh stdout: \n" + result.stdout)
+            # noinspection PyUnresolvedReferences
             if len(result.stderr) > 0:
+                # noinspection PyUnresolvedReferences
                 print("ssh stderr: \n" + result.stderrr)
+            # noinspection PyUnresolvedReferences
             if len(result.stdout) <= 0 and len(result.stderr) <= 0:
                 print("ssh stdout stderr empty")
             # if result.stdout != "":
@@ -82,6 +98,9 @@ class CGMiner(BaseMiner):
             # else:
             #     print(cmd)
 
+    async def restart_backend(self) -> None:
+        await self.restart_cgminer()
+
     async def restart_cgminer(self) -> None:
         commands = ['cgminer-api restart',
                     '/usr/bin/cgminer-monitor >/dev/null 2>&1']
@@ -89,9 +108,7 @@ class CGMiner(BaseMiner):
         await self.send_ssh_command(commands)
 
     async def reboot(self) -> None:
-        commands = ['reboot']
-        commands = ';'.join(commands)
-        await self.send_ssh_command(commands)
+        await self.send_ssh_command("reboot")
 
     async def start_cgminer(self) -> None:
         commands = ['mkdir -p /etc/tmp/',
@@ -116,3 +133,4 @@ class CGMiner(BaseMiner):
             self._result_handler(result)
             self.config = result.stdout
             print(str(self.config))
+

miners/miner_factory.py

@@ -1,9 +1,34 @@
-from miners.bosminer import BOSminer
-from miners.bmminer import BMMiner
+from miners.antminer.S9.bosminer import BOSMinerS9
+from miners.antminer.S9.bmminer import BMMinerS9
+from miners.antminer.S9.cgminer import CGMinerS9
+
+from miners.antminer.T9.hive import HiveonT9
+from miners.antminer.T9.cgminer import CGMinerT9
+from miners.antminer.T9.bmminer import BMMinerT9
+
+from miners.antminer.X17.bosminer import BOSMinerX17
+from miners.antminer.X17.bmminer import BMMinerX17
+from miners.antminer.X17.cgminer import CGMinerX17
+
+from miners.antminer.X19.bmminer import BMMinerX19
+from miners.antminer.X19.cgminer import CGMinerX19
+
+from miners.whatsminer.M20 import BTMinerM20
+from miners.whatsminer.M21 import BTMinerM21
+from miners.whatsminer.M30 import BTMinerM30
+from miners.whatsminer.M31 import BTMinerM31
+from miners.whatsminer.M32 import BTMinerM32
+
+from miners.avalonminer import CGMinerAvalon
+
 from miners.cgminer import CGMiner
-from miners.btminer import BTMiner
+from miners.bmminer import BMMiner
+from miners.bosminer import BOSMiner
+
 from miners.unknown import UnknownMiner
+
 from API import APIError
+
 import asyncio
 import ipaddress
 import json
@@ -16,147 +41,299 @@ class MinerFactory:
         self.miners = {}
 
     async def get_miner_generator(self, ips: list):
+        """
+        Get Miner objects from ip addresses using an async generator.
+
+        Returns an asynchronous generator containing Miners.
+
+        Parameters:
+            ips: a list of ip addresses to get miners for.
+        """
+        # get the event loop
         loop = asyncio.get_event_loop()
+        # create a list of tasks
         scan_tasks = []
+        # for each miner IP that was passed in, add a task to get its class
         for miner in ips:
             scan_tasks.append(loop.create_task(self.get_miner(miner)))
+        # asynchronously run the tasks and return them as they complete
         scanned = asyncio.as_completed(scan_tasks)
+        # loop through and yield the miners as they complete
         for miner in scanned:
             yield await miner
 
-    async def get_miner(self, ip: ipaddress.ip_address) -> BOSminer or CGMiner or BMMiner or UnknownMiner:
+    async def get_miner(self, ip: ipaddress.ip_address):
         """Decide a miner type using the IP address of the miner."""
         # check if the miner already exists in cache
         if ip in self.miners:
             return self.miners[ip]
-        # get the version data
-        version = None
+        # if everything fails, the miner is already set to unknown
+        miner = UnknownMiner(str(ip))
+        api = None
+        model = None
+
+        # try to get the API multiple times based on retries
         for i in range(GET_VERSION_RETRIES):
-            version_data = await self._get_version_data(ip)
-            if version_data:
-                # if we got version data, get a list of the keys so we can check type of miner
-                version = list(version_data['VERSION'][0].keys())
+            # get the API type, should be BOSMiner, CGMiner, BMMiner, BTMiner, or None
+            api = await self._get_api_type(ip)
+            # if we find the API type, dont need to loop anymore
+            if api:
                 break
-        if version:
-            # check version against different return miner types
-            if "BOSminer" in version or "BOSminer+" in version:
-                miner = BOSminer(str(ip))
-            elif "CGMiner" in version:
-                miner = CGMiner(str(ip))
-            elif "BMMiner" in version:
-                miner = BMMiner(str(ip))
-            elif "BTMiner" in version:
-                miner = BTMiner(str(ip))
-            else:
-                print(f"Bad API response: {version}")
-                miner = UnknownMiner(str(ip))
+
+        # try to get the model multiple times based on retries
+        for i in range(GET_VERSION_RETRIES):
+            # get the model, should return some miner model type, e.g. Antminer S9
+            model = await self._get_miner_model(ip)
+            # if we find the model type, dont need to loop anymore
+            if model:
+                break
+        # make sure we have model information
+        if model:
+
+            # check if the miner is an Antminer
+            if "Antminer" in model:
+
+                # S9 logic
+                if "Antminer S9" in model:
+
+                    # handle the different API types
+                    if not api:
+                        print(ip)
+                        miner = BOSMinerS9(str(ip))
+                    elif "BOSMiner" in api:
+                        miner = BOSMinerS9(str(ip))
+                    elif "CGMiner" in api:
+                        miner = CGMinerS9(str(ip))
+                    elif "BMMiner" in api:
+                        miner = BMMinerS9(str(ip))
+                
+                elif "Antminer T9" in model:
+                    if "BMMiner" in api:
+                        if "Hiveon" in model:
+                            # hiveOS, return T9 Hive
+                            miner = HiveonT9(str(ip))
+                        else:
+                            miner = BMMinerT9(str(ip))
+                    elif "CGMiner" in api:
+                        miner = CGMinerT9(str(ip))
+
+                # X17 model logic
+                elif "17" in model:
+
+                    # handle the different API types
+                    if "BOSMiner" in api:
+                        miner = BOSMinerX17(str(ip))
+                    elif "CGMiner" in api:
+                        miner = CGMinerX17(str(ip))
+                    elif "BMMiner" in api:
+                        miner = BMMinerX17(str(ip))
+
+                # X19 logic
+                elif "19" in model:
+
+                    # handle the different API types
+                    if "CGMiner" in api:
+                        miner = CGMinerX19(str(ip))
+                    elif "BMMiner" in api:
+                        miner = BMMinerX19(str(ip))
+
+            # Avalonminer V8
+            elif "avalon" in model:
+                miner = CGMinerAvalon(str(ip))
+
+            # Whatsminers
+            elif "M20" in model:
+                miner = BTMinerM20(str(ip))
+            elif "M21" in model:
+                miner = BTMinerM21(str(ip))
+            elif "M30" in model:
+                miner = BTMinerM30(str(ip))
+            elif "M31" in model:
+                miner = BTMinerM31(str(ip))
+            elif "M32" in model:
+                miner = BTMinerM32(str(ip))
+
+        # if we cant find a model, check if we found the API
         else:
-            # if we don't get version, miner type is unknown
-            print(f"No API response: {str(ip)}")
-            miner = UnknownMiner(str(ip))
-        # save the miner in cache
+
+            # return the miner base class with some API if we found it
+            if api:
+                if "BOSMiner" in api:
+                    miner = BOSMiner(str(ip))
+                elif "CGMiner" in api:
+                    miner = CGMiner(str(ip))
+                elif "BMMiner" in api:
+                    miner = BMMiner(str(ip))
+
+        # save the miner to the cache at its IP
         self.miners[ip] = miner
+
+        # return the miner
         return miner
 
     def clear_cached_miners(self):
         """Clear the miner factory cache."""
+        # empty out self.miners
         self.miners = {}
 
-    @staticmethod
-    async def _get_version_data(ip: ipaddress.ip_address) -> dict or None:
-        """Get data on the version of the miner to return the right miner."""
-        for i in range(3):
-            try:
-                # open a connection to the miner
-                fut = asyncio.open_connection(str(ip), 4028)
-                # get reader and writer streams
-                try:
-                    reader, writer = await asyncio.wait_for(fut, timeout=7)
-                except asyncio.exceptions.TimeoutError:
-                    return None
+    async def _get_miner_model(self, ip: ipaddress.ip_address or str) -> str or None:
+        # instantiate model as being nothing if getting it fails
+        model = None
 
-                # create the command
-                cmd = {"command": "version"}
+        # try block in case of APIError or OSError 121 (Semaphore timeout)
+        try:
 
-                # send the command
-                writer.write(json.dumps(cmd).encode('utf-8'))
-                await writer.drain()
+            # send the devdetails command to the miner (will fail with no boards/devices)
+            data = await self._send_api_command(str(ip), "devdetails")
+            # sometimes data is b'', check for that
+            if data:
+                # status check, make sure the command succeeded
+                if data.get("STATUS"):
+                    if not isinstance(data["STATUS"], str):
+                        # if status is E, its an error
+                        if data["STATUS"][0].get("STATUS") not in ["I", "S"]:
 
-                # instantiate data
-                data = b""
+                            # try an alternate method if devdetails fails
+                            data = await self._send_api_command(str(ip), "version")
 
-                # loop to receive all the data
-                while True:
-                    d = await reader.read(4096)
-                    if not d:
-                        break
-                    data += d
-
-                if data.endswith(b"\x00"):
-                    data = json.loads(data.decode('utf-8')[:-1])
-                else:
-                    # some stupid whatsminers need a different command
-                    fut = asyncio.open_connection(str(ip), 4028)
-                    # get reader and writer streams
-                    try:
-                        reader, writer = await asyncio.wait_for(fut, timeout=7)
-                    except asyncio.exceptions.TimeoutError:
-                        return None
-
-                    # create the command
-                    cmd = {"command": "get_version"}
-
-                    # send the command
-                    writer.write(json.dumps(cmd).encode('utf-8'))
-                    await writer.drain()
-
-                    # instantiate data
-                    data = b""
-
-                    # loop to receive all the data
-                    while True:
-                        d = await reader.read(4096)
-                        if not d:
-                            break
-                        data += d
-
-                    data = data.decode('utf-8').replace("\n", "")
-                    data = json.loads(data)
-
-                # close the connection
-                writer.close()
-                await writer.wait_closed()
-                # 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 data[key][0]["STATUS"][0]["STATUS"] not in ["S", "I"]:
-                                # this is an error
-                                raise APIError(data["STATUS"][0]["Msg"])
-                else:
-                    # check for stupid whatsminer formatting
-                    if not isinstance(data["STATUS"], list):
-                        if data["STATUS"] not in ("S", "I"):
-                            raise APIError(data["Msg"])
+                            # make sure we have data
+                            if data:
+                                # check the keys are there to get the version
+                                if data.get("VERSION"):
+                                    if data["VERSION"][0].get("Type"):
+                                        # save the model to be returned later
+                                        model = data["VERSION"][0]["Type"]
                         else:
-                            if "whatsminer" in data["Description"]:
-                                return {"VERSION": [{"BTMiner": data["Description"]}]}
-                    # make sure the command succeeded
-                    elif data["STATUS"][0]["STATUS"] not in ("S", "I"):
-                        # this is an error
-                        raise APIError(data["STATUS"][0]["Msg"])
-                # return the data
-                return data
-            except OSError as e:
-                if e.winerror == 121:
-                    return None
-                else:
-                    print(ip, e)
-            # except json.decoder.JSONDecodeError:
-                # print("Decode Error @ " + str(ip) + str(data))
-            # except Exception as e:
-                # print(ip, e)
+                            # make sure devdetails actually contains data, if its empty, there are no devices
+                            if "DEVDETAILS" in data.keys() and not data["DEVDETAILS"] == []:
+
+                                # check for model, for most miners
+                                if not data["DEVDETAILS"][0]["Model"] == "":
+                                    # model of most miners
+                                    model = data["DEVDETAILS"][0]["Model"]
+
+                                # if model fails, try driver
+                                else:
+                                    # some avalonminers have model in driver
+                                    model = data["DEVDETAILS"][0]["Driver"]
+                    else:
+                        # if all that fails, try just version
+                        data = await self._send_api_command(str(ip), "version")
+                        if "VERSION" in data.keys():
+                            model = data["VERSION"][0]["Type"]
+                        else:
+                            print(data)
+
+            return model
+
+        # if there are errors, we just return None
+        except APIError:
+            return model
+        except OSError as e:
+            if e.winerror == 121:
+                print(e)
+                return model
+            else:
+                print(ip, e)
+        return model
+
+    async def _send_api_command(self, ip: ipaddress.ip_address or str, command: str):
+        try:
+            # get reader and writer streams
+            reader, writer = await asyncio.open_connection(str(ip), 4028)
+        # handle OSError 121
+        except OSError as e:
+            if e.winerror == "121":
+                print("Semaphore Timeout has Expired.")
+            return {}
+
+        # create the command
+        cmd = {"command": command}
+
+        # 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)
+
+        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
+            data = json.loads(str_data)
+        # handle bad json
+        except json.decoder.JSONDecodeError as e:
+            # raise APIError(f"Decode Error: {data}")
+            data = None
+
+        # close the connection
+        writer.close()
+        await writer.wait_closed()
+
+        return data
+
+    async def _get_api_type(self, ip: ipaddress.ip_address or str) -> dict or None:
+        """Get data on the version of the miner to return the right miner."""
+        # instantiate API as None in case something fails
+        api = None
+
+        # try block to handle OSError 121 (Semaphore timeout)
+        try:
+            # try the version command,works on most miners
+            data = await self._send_api_command(str(ip), "version")
+
+            # if we got data back, try to parse it
+            if data:
+                # make sure the command succeeded
+                if data.get("STATUS") and not data.get("STATUS") == "E":
+                    if data["STATUS"][0].get("STATUS") in ["I", "S"]:
+
+                        # check if there are any BMMiner strings in any of the dict keys
+                        if any("BMMiner" in string for string in data["VERSION"][0].keys()):
+                            api = "BMMiner"
+
+                        # check if there are any CGMiner strings in any of the dict keys
+                        elif any("CGMiner" in string for string in data["VERSION"][0].keys()):
+                            api = "CGMiner"
+
+                        # check if there are any BOSMiner strings in any of the dict keys
+                        elif any("BOSminer" in string for string in data["VERSION"][0].keys()):
+                            api = "BOSMiner"
+
+                # if all that fails, check the Description to see if it is a whatsminer
+                elif data.get("Description") and "whatsminer" in data.get("Description"):
+                    api = "BTMiner"
+
+            # return the API if we found it
+            if api:
+                return api
+
+        # if there are errors, return None
+        except OSError as e:
+            if e.winerror == 121:
+                return None
+            else:
+                print(ip, e)
         return None

miners/unknown.py

@@ -10,8 +10,8 @@ class UnknownMiner(BaseMiner):
     def __repr__(self) -> str:
         return f"Unknown: {str(self.ip)}"
 
-    async def send_config(self, _):
-        return None
+    async def get_model(self):
+        return "Unknown"
 
     async def get_hostname(self):
         return "Unknown"

miners/whatsminer/M20.py

@@ -1,26 +1,9 @@
-from API.btminer import BTMinerAPI
-from miners import BaseMiner
+from miners.btminer import BTMiner
 
 
-class BTMinerM20(BaseMiner):
+class BTMinerM20(BTMiner):
     def __init__(self, ip: str) -> None:
-        api = BTMinerAPI(ip)
-        super().__init__(ip, api)
+        super().__init__(ip)
 
     def __repr__(self) -> str:
         return f"M20 - BTMiner: {str(self.ip)}"
-
-    async def get_hostname(self) -> str:
-        return "BTMiner Unknown"
-
-    async def send_config(self):
-        return None  # ignore for now
-
-    async def restart_backend(self) -> None:
-        return None
-
-    async def reboot(self) -> None:
-        return None
-
-    async def get_config(self) -> None:
-        return None

miners/whatsminer/M21.py

@@ -1,26 +1,10 @@
-from API.btminer import BTMinerAPI
-from miners import BaseMiner
+from miners.btminer import BTMiner
 
 
-class BTMinerM21(BaseMiner):
+class BTMinerM21(BTMiner):
     def __init__(self, ip: str) -> None:
-        api = BTMinerAPI(ip)
-        super().__init__(ip, api)
+        super().__init__(ip)
+        self.nominal_chips = [105, 66]
 
     def __repr__(self) -> str:
         return f"M21 - BTMiner: {str(self.ip)}"
-
-    async def get_hostname(self) -> str:
-        return "BTMiner Unknown"
-
-    async def send_config(self):
-        return None  # ignore for now
-
-    async def restart_backend(self) -> None:
-        return None
-
-    async def reboot(self) -> None:
-        return None
-
-    async def get_config(self) -> None:
-        return None

miners/whatsminer/M30.py

@@ -1,26 +1,9 @@
-from API.btminer import BTMinerAPI
-from miners import BaseMiner
+from miners.btminer import BTMiner
 
 
-class BTMinerM30(BaseMiner):
+class BTMinerM30(BTMiner):
     def __init__(self, ip: str) -> None:
-        api = BTMinerAPI(ip)
-        super().__init__(ip, api)
+        super().__init__(ip)
 
     def __repr__(self) -> str:
-        return f"M30 - BTMiner: {str(self.ip)}"
-
-    async def get_hostname(self) -> str:
-        return "BTMiner Unknown"
-
-    async def send_config(self):
-        return None  # ignore for now
-
-    async def restart_backend(self) -> None:
-        return None
-
-    async def reboot(self) -> None:
-        return None
-
-    async def get_config(self) -> None:
-        return None
+        return f"M30- BTMiner: {str(self.ip)}"

miners/whatsminer/M31.py

@@ -1,26 +1,10 @@
-from API.btminer import BTMinerAPI
-from miners import BaseMiner
+from miners.btminer import BTMiner
 
 
-class BTMinerM31(BaseMiner):
+class BTMinerM31(BTMiner):
     def __init__(self, ip: str) -> None:
-        api = BTMinerAPI(ip)
-        super().__init__(ip, api)
+        super().__init__(ip)
+        self.nominal_chips = [78]
 
     def __repr__(self) -> str:
         return f"M31 - BTMiner: {str(self.ip)}"
-
-    async def get_hostname(self) -> str:
-        return "BTMiner Unknown"
-
-    async def send_config(self):
-        return None  # ignore for now
-
-    async def restart_backend(self) -> None:
-        return None
-
-    async def reboot(self) -> None:
-        return None
-
-    async def get_config(self) -> None:
-        return None

miners/whatsminer/M32.py

@@ -1,26 +1,9 @@
-from API.btminer import BTMinerAPI
-from miners import BaseMiner
+from miners.btminer import BTMiner
 
 
-class BTMinerM32(BaseMiner):
+class BTMinerM32(BTMiner):
     def __init__(self, ip: str) -> None:
-        api = BTMinerAPI(ip)
-        super().__init__(ip, api)
+        super().__init__(ip)
 
     def __repr__(self) -> str:
         return f"M32 - BTMiner: {str(self.ip)}"
-
-    async def get_hostname(self) -> str:
-        return "BTMiner Unknown"
-
-    async def send_config(self):
-        return None  # ignore for now
-
-    async def restart_backend(self) -> None:
-        return None
-
-    async def reboot(self) -> None:
-        return None
-
-    async def get_config(self) -> None:
-        return None

misc/bos.py

@@ -0,0 +1,58 @@
+import asyncio
+from network import MinerNetwork
+from miners.bosminer import BOSMiner
+
+
+async def get_bos_bad_tuners(ip: str = "192.168.1.0", mask: int = 24):
+    # create a miner network
+    miner_network = MinerNetwork(ip, mask=mask)
+
+    # scan for miners
+    miners = await miner_network.scan_network_for_miners()
+
+    # create an empty list of tasks
+    tuner_tasks = []
+
+    # loop checks if the miner is a BOSMiner
+    for miner in miners:
+        # can only do this if its a subclass of BOSMiner
+        if BOSMiner in type(miner).__bases__:
+            tuner_tasks.append(_get_tuner_status(miner))
+
+    # run all the tuner status commands
+    tuner_status = await asyncio.gather(*tuner_tasks)
+
+    # create a list of all miners with bad board tuner status'
+    bad_tuner_miners = []
+    for item in tuner_status:
+        # loop through and get each miners' bad board count
+        bad_boards = []
+        for board in item["tuner_status"]:
+            # if its not stable or still testing, its bad
+            if board["status"] not in ["Stable", "Testing performance profile", "Tuning individual chips"]:
+                # remove the part about the board refusing to start
+                bad_boards.append({"board": board["board"],
+                                   "error": board["status"].replace("Hashchain refused to start: ", "")})
+
+        # if this miner has bad boards, add it to the list of bad board miners
+        if len(bad_boards) > 0:
+            bad_tuner_miners.append({"ip": item["ip"], "boards": bad_boards})
+
+    # return the list of bad board miners
+    return bad_tuner_miners
+
+
+async def _get_tuner_status(miner):
+    # run the tunerstatus command, since the miner will always be BOSMiner
+    tuner_status = await miner.api.tunerstatus()
+
+    # create a list to add the tuner data to
+    tuner_data = []
+
+    # if we have data, loop through to get the hashchain status
+    if tuner_status:
+        for board in tuner_status["TUNERSTATUS"][0]["TunerChainStatus"]:
+            tuner_data.append({"board": board["HashchainIndex"], "status": board["Status"]})
+
+    # return the data along with the IP or later tracking
+    return {"ip": str(miner.ip), "tuner_status": tuner_data}

network/__init__.py

@@ -18,53 +18,109 @@ class MinerNetwork:
 
     def get_network(self) -> ipaddress.ip_network:
         """Get the network using the information passed to the MinerNetwork or from cache."""
+        # if we have a network cached already, use that
         if self.network:
             return self.network
+
+        # if there is no IP address passed, default to 192.168.1.0
         if not self.ip_addr:
             default_gateway = "192.168.1.0"
+        # if we do have an IP address passed, use that
         else:
             default_gateway = self.ip_addr
-        if self.mask:
-            subnet_mask = str(self.mask)
-        else:
+
+        # if there is no subnet mask passed, default to /24
+        if not self.mask:
             subnet_mask = "24"
-        return ipaddress.ip_network(f"{default_gateway}/{subnet_mask}", strict=False)
+        # if we do have a mask passed, use that
+        else:
+            subnet_mask = str(self.mask)
+
+        # save the network and return it
+        self.network = ipaddress.ip_network(f"{default_gateway}/{subnet_mask}", strict=False)
+        return self.network
 
     async def scan_network_for_miners(self) -> None or list:
-        """Scan the network for miners, and """
+        """Scan the network for miners, and return found miners as a list."""
+        # get the network
         local_network = self.get_network()
         print(f"Scanning {local_network} for miners...")
+
+        # create a list of tasks and miner IPs
         scan_tasks = []
         miner_ips = []
+
+        # for each IP in the network
         for host in local_network.hosts():
+
+            # make sure we don't exceed the allowed async tasks
             if len(scan_tasks) < SCAN_THREADS:
+                # add the task to the list
                 scan_tasks.append(self.ping_miner(host))
             else:
+                # run the scan tasks
                 miner_ips_scan = await asyncio.gather(*scan_tasks)
+                # add scanned miners to the list of found miners
                 miner_ips.extend(miner_ips_scan)
+                # empty the task list
                 scan_tasks = []
+        # do a final scan to empty out the list
         miner_ips_scan = await asyncio.gather(*scan_tasks)
         miner_ips.extend(miner_ips_scan)
+
+        # remove all None from the miner list
         miner_ips = list(filter(None, miner_ips))
         print(f"Found {len(miner_ips)} connected miners...")
+
+        # create a list of tasks to get miners
         create_miners_tasks = []
+
+        # clear cached miners
         self.miner_factory.clear_cached_miners()
+
+        # try to get each miner found
         for miner_ip in miner_ips:
+            # append to the list of tasks
             create_miners_tasks.append(self.miner_factory.get_miner(miner_ip))
+
+        # get all miners in the list
         miners = await asyncio.gather(*create_miners_tasks)
+
+        # return the miner objects
         return miners
 
     async def scan_network_generator(self):
+        """
+        Scan the network for miners using an async generator.
+
+        Returns an asynchronous generator containing found miners.
+        """
+        # get the current event loop
         loop = asyncio.get_event_loop()
+
+        # get the network
         local_network = self.get_network()
+
+        # create a list of scan tasks
         scan_tasks = []
+
+        # for each ip on the network, loop through and scan it
         for host in local_network.hosts():
+            # make sure we don't exceed the allowed async tasks
             if len(scan_tasks) >= SCAN_THREADS:
+                # scanned is a loopable list of awaitables
                 scanned = asyncio.as_completed(scan_tasks)
+                # when we scan, empty the scan tasks
                 scan_tasks = []
+
+                # yield miners as they are scanned
                 for miner in scanned:
                     yield await miner
+
+            # add the ping to the list of tasks if we dont scan
             scan_tasks.append(loop.create_task(self.ping_miner(host)))
+
+        # do one last scan at the end to close out the list
         scanned = asyncio.as_completed(scan_tasks)
         for miner in scanned:
             yield await miner

settings.toml

@@ -1,5 +0,0 @@
-get_version_retries = 3
-ping_retries = 3
-ping_timeout = 5
-scan_threads = 300
-config_threads = 300

settings/__init__.py

@@ -8,14 +8,20 @@ try:
     NETWORK_PING_TIMEOUT: int = settings["ping_timeout"]
     NETWORK_SCAN_THREADS: int = settings["scan_threads"]
 
+    CFG_UTIL_REBOOT_THREADS: int = settings["reboot_threads"]
     CFG_UTIL_CONFIG_THREADS: int = settings["config_threads"]
 
     MINER_FACTORY_GET_VERSION_RETRIES: int = settings["get_version_retries"]
+
+    WHATSMINER_PWD: str = settings["whatsminer_pwd"]
 except:
     NETWORK_PING_RETRIES: int = 3
     NETWORK_PING_TIMEOUT: int = 5
     NETWORK_SCAN_THREADS: int = 300
 
+    CFG_UTIL_REBOOT_THREADS: int = 300
     CFG_UTIL_CONFIG_THREADS: int = 300
 
     MINER_FACTORY_GET_VERSION_RETRIES: int = 3
+
+    WHATSMINER_PWD = "admin"

settings/settings.toml

@@ -0,0 +1,14 @@
+get_version_retries = 3
+ping_retries = 3
+ping_timeout = 5
+scan_threads = 300
+config_threads = 300
+reboot_threads = 300
+
+
+### IMPORTANT ###
+# You need to change the password of the miners using the whatsminer
+# tool or the privileged API will not work using admin as the password.
+# If you change the password, you can pass that password here.
+
+whatsminer_pwd = "admin"

static/CFG-Util-README.md

@@ -0,0 +1,72 @@
+
+
+
+[//]: # (If you can read this, you are viewing this document incorrectly.)
+[//]: # (This is a Markdown document.  Use an online Markdown viewer to)
+[//]: # (view this file, such as https://dillinger.io/)
+
+
+
+# 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, and get data on them.
+
+### 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 separated 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
+### Buttons:
+* ALL: Selects all miners in the table, or deselects all if they are already all selected.
+* REFRESH DATA: Refreshes data for the currently selected miners, or all miners if none are selected.
+* OPEN IN WEB: Opens all currently selected miners web interfaces in your default browser.
+
+### Table:
+* Click any header in the table to sort that row.
+  * You can copy (CTRL + C) a list of IP's directly from the rows selected in the table.
+
+* #### IP:
+  * Contains all the IP's scanned.
+
+* #### Model:
+  * The model of the miners scanned.
+
+* #### Hostname:
+  * The hostname of the miners scanned.
+  * ? will be displayed if the tool is unable to get it.
+
+* #### Hashrate:
+  * The hashrate of the miners scanned.
+
+* #### Temperature:
+  * The average board temperature of the miners scanned.
+
+* #### Current User:
+  * The current first pool user of the miners scanned.
+
+* #### Wattage
+  * The current wattage of the miners scanned.
+  * 0 W will be displayed if it is unknown.
+
+### 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.

tools/bad_board_util/__init__.py

@@ -0,0 +1,18 @@
+from tools.bad_board_util.miner_factory import miner_factory
+from tools.bad_board_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())
+
+
+if __name__ == '__main__':
+    main()

tools/bad_board_util/func/files.py

@@ -0,0 +1,43 @@
+import ipaddress
+import os
+import re
+
+import aiofiles
+
+from tools.bad_board_util.func.ui import update_ui_with_data
+from tools.bad_board_util.layout import window
+
+
+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", "")

tools/bad_board_util/func/miners.py

@@ -0,0 +1,197 @@
+import asyncio
+import ipaddress
+import warnings
+
+from tools.bad_board_util.func.ui import update_ui_with_data, update_prog_bar, set_progress_bar_len
+from tools.bad_board_util.layout import window
+from tools.bad_board_util.miner_factory import miner_factory
+
+
+async def scan_network(network):
+    await update_ui_with_data("status", "Scanning")
+    await update_ui_with_data("ip_count", "")
+    window["ip_table"].update([])
+    network_size = len(network)
+    miner_generator = network.scan_network_generator()
+    await set_progress_bar_len(2 * network_size)
+    progress_bar_len = 0
+    asyncio.create_task(update_prog_bar(progress_bar_len))
+    miners = []
+    async for miner in miner_generator:
+        if miner:
+            miners.append(miner)
+        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 refresh_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
+    asyncio.create_task(update_prog_bar(progress_bar_len))
+    reset_table_values = []
+    for item in window["ip_table"].Values:
+        if item[0] in ip_list:
+            reset_table_values.append([item[0]])
+        else:
+            reset_table_values.append(item)
+    window["ip_table"].update(reset_table_values)
+    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]
+    row_colors = []
+    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"])
+            board_left = ""
+            board_center = ""
+            board_right = ""
+            if data_point["data"]:
+                if 0 in data_point["data"].keys():
+                    board_left = " ".join([chain["chip_status"] for chain in data_point["data"][0]]).replace("o", "•")
+                else:
+                    row_colors.append((ip_table_index, "white", "red"))
+                if 1 in data_point["data"].keys():
+                    board_center = " ".join([chain["chip_status"] for chain in data_point["data"][1]]).replace("o", "•")
+                else:
+                    row_colors.append((ip_table_index, "white", "red"))
+                if 2 in data_point["data"].keys():
+                    board_right = " ".join([chain["chip_status"] for chain in data_point["data"][2]]).replace("o", "•")
+                else:
+                    row_colors.append((ip_table_index, "white", "red"))
+                if False in [chain["nominal"] for chain in [data_point["data"][key] for key in data_point["data"].keys()][0]]:
+                    row_colors.append((ip_table_index, "white", "red"))
+            else:
+                row_colors.append((ip_table_index, "white", "red"))
+
+            data = [
+                data_point["IP"],
+                data_point["model"],
+                len(board_left),
+                board_left,
+                len(board_center),
+                board_center,
+                len(board_right),
+                board_right
+            ]
+            ip_table_data[ip_table_index] = data
+            window["ip_table"].update(ip_table_data, row_colors=row_colors)
+        progress_bar_len += 1
+        asyncio.create_task(update_prog_bar(progress_bar_len))
+    await update_ui_with_data("status", "")
+
+
+async def scan_and_get_data(network):
+    await update_ui_with_data("status", "Scanning")
+    await update_ui_with_data("ip_count", "")
+    await update_ui_with_data("ip_table", [])
+    network_size = len(network)
+    miner_generator = network.scan_network_generator()
+    await set_progress_bar_len(3 * 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)))
+    data_gen = asyncio.as_completed([get_formatted_data(miner) for miner in miners])
+    ip_table_data = window["ip_table"].Values
+    ordered_all_ips = [item[0] for item in ip_table_data]
+    progress_bar_len += (network_size - len(miners))
+    asyncio.create_task(update_prog_bar(progress_bar_len))
+    await update_ui_with_data("status", "Getting Data")
+    row_colors = []
+    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"])
+            board_left = ""
+            board_center = ""
+            board_right = ""
+            if data_point["data"]:
+                if 0 in data_point["data"].keys():
+                    board_left = " ".join([chain["chip_status"] for chain in data_point["data"][0]]).replace("o", "•")
+                else:
+                    row_colors.append((ip_table_index, "bad"))
+                if 1 in data_point["data"].keys():
+                    board_center = " ".join([chain["chip_status"] for chain in data_point["data"][1]]).replace("o", "•")
+                else:
+                    row_colors.append((ip_table_index, "bad"))
+                if 2 in data_point["data"].keys():
+                    board_right = " ".join([chain["chip_status"] for chain in data_point["data"][2]]).replace("o", "•")
+                else:
+                    row_colors.append((ip_table_index, "bad"))
+                if False in [chain["nominal"] for board in [data_point["data"][key] for key in data_point["data"].keys()] for chain in board]:
+                    row_colors.append((ip_table_index, "bad"))
+            else:
+                row_colors.append((ip_table_index, "bad"))
+            board_left_chips = "\n".join(split_chips(board_left, 3))
+            board_center_chips = "\n".join(split_chips(board_center, 3))
+            board_right_chips = "\n".join(split_chips(board_right, 3))
+
+            data = [
+                data_point["IP"],
+                data_point["model"],
+                len(board_left),
+                board_left_chips,
+                len(board_center),
+                board_center_chips,
+                len(board_right),
+                board_right_chips
+            ]
+            ip_table_data[ip_table_index] = data
+            window["ip_table"].update(ip_table_data)
+            table = window["ip_table"].Widget
+            table.tag_configure("bad", foreground="white", background="red")
+            for row in row_colors:
+                table.item(row[0] + 1, tags=row[1])
+        progress_bar_len += 1
+        asyncio.create_task(update_prog_bar(progress_bar_len))
+    await update_ui_with_data("status", "")
+
+
+def split_chips(string, number_of_splits):
+    k, m = divmod(len(string), number_of_splits)
+    return (string[i*k+min(i, m):(i+1)*k+min(i+1, m)] for i in range(number_of_splits))
+
+
+async def get_formatted_data(ip: ipaddress.ip_address):
+    miner = await miner_factory.get_miner(ip)
+    model = await miner.get_model()
+    warnings.filterwarnings('ignore')
+    board_data = await miner.get_board_info()
+    data = {"IP": str(ip), "model": str(model), "data": board_data}
+    return data

tools/bad_board_util/func/ui.py

@@ -0,0 +1,79 @@
+import ipaddress
+import re
+
+from tools.bad_board_util.layout import window
+
+import pyperclip
+
+
+def copy_from_table(table):
+    selection = table.selection()
+    copy_values = []
+    for each in selection:
+        try:
+            # value = table.item(each)["values"][0]
+            table_values = table.item(each)["values"]
+            ip = table_values[0]
+            model = table_values[1]
+            l_brd_chips = str(table_values[2])
+            c_brd_chips = str(table_values[4])
+            r_brd_chips = str(table_values[6])
+            all_values = [ip, model, l_brd_chips, c_brd_chips, r_brd_chips]
+            value = ", ".join(all_values)
+
+            copy_values.append(str(value))
+        except Exception as e:
+            print("Copy Error:", e)
+    copy_string = "\n".join(copy_values)
+    pyperclip.copy(copy_string)
+
+
+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 sort_data(index: int or str):
+    await update_ui_with_data("status", "Sorting Data")
+    data_list = window['ip_table'].Values
+    table = window["ip_table"].Widget
+    all_data = []
+    for idx, item in enumerate(data_list):
+        all_data.append({"data": item, "tags": table.item(int(idx) + 1)["tags"]})
+    # ip addresses
+    if 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]?)",
+                  str(all_data[0]["data"][index])):
+        new_list = sorted(all_data, key=lambda x: ipaddress.ip_address(x["data"][index]))
+        if all_data == new_list:
+            new_list = sorted(all_data, reverse=True, key=lambda x: ipaddress.ip_address(x["data"][index]))
+
+    # everything else, model, chips
+    else:
+        new_list = sorted(all_data, key=lambda x: x["data"][index])
+        if all_data == new_list:
+            new_list = sorted(all_data, reverse=True, key=lambda x: x["data"][index])
+
+    new_data = []
+    for item in new_list:
+        new_data.append(item["data"])
+
+    await update_ui_with_data("ip_table", new_data)
+    for idx, item in enumerate(new_list):
+        table.item(idx + 1, tags=item["tags"])
+
+    await update_ui_with_data("status", "")

tools/bad_board_util/miner_factory.py

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

tools/bad_board_util/ui.py

@@ -0,0 +1,50 @@
+import asyncio
+import sys
+import PySimpleGUI as sg
+
+from tools.bad_board_util.layout import window
+from tools.bad_board_util.func.miners import refresh_data, scan_and_get_data
+from tools.bad_board_util.func.files import import_iplist, export_iplist
+from tools.bad_board_util.func.ui import sort_data, copy_from_table
+
+from network import MinerNetwork
+
+import webbrowser
+
+
+async def ui():
+    window.read(timeout=0)
+    table = window["ip_table"].Widget
+    table.bind("<Control-Key-c>", lambda x: copy_from_table(table))
+    while True:
+        event, value = window.read(timeout=0)
+        if event in (None, 'Close', sg.WIN_CLOSED):
+            sys.exit()
+        if isinstance(event, tuple):
+            if len(window["ip_table"].Values) > 0:
+                if event[0] == 'ip_table':
+                    if event[2][0] == -1:
+                        await sort_data(event[2][1])
+        if event == 'open_in_web':
+            for row in value["ip_table"]:
+                webbrowser.open("http://" + window["ip_table"].Values[row][0])
+        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_and_get_data(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_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 == "refresh_data":
+            asyncio.create_task(refresh_data([window["ip_table"].Values[item][0] for item in value["ip_table"]]))
+        if event == "__TIMEOUT__":
+            await asyncio.sleep(0)

tools/cfg_util/__init__.py

@@ -0,0 +1 @@
+from tools.cfg_util.cfg_util_sg import main

tools/cfg_util/cfg_util_sg/__init__.py

@@ -1,6 +1,4 @@
-from cfg_util.miner_factory import miner_factory
-from cfg_util.layout import window
-from cfg_util.ui import ui
+from tools.cfg_util.cfg_util_sg.ui import ui
 
 import asyncio
 import sys

tools/cfg_util/cfg_util_sg/func/files.py

@@ -0,0 +1,90 @@
+import ipaddress
+import os
+import re
+import time
+
+import aiofiles
+import toml
+
+from tools.cfg_util.cfg_util_sg.func.ui import update_ui_with_data
+from tools.cfg_util.cfg_util_sg.layout import window
+from config.bos import bos_config_convert, general_config_convert_bos
+
+
+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_csv(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(
+                        ", ".join([str(part) for part in item])
+                    ) + "\n")
+        else:
+            async with aiofiles.open(file_location, mode='w') as file:
+                for item in window['ip_table'].Values:
+                    await file.write(str(
+                        ", ".join([str(part) for part in item])
+                    ) + "\n")
+    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 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 = await general_config_convert_bos(config)
+    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(config)
+    await update_ui_with_data("status", "")

tools/cfg_util/cfg_util_sg/func/miners.py

@@ -0,0 +1,427 @@
+import asyncio
+import ipaddress
+import time
+import warnings
+
+from API import APIError
+from tools.cfg_util.cfg_util_sg.func.parse_data import safe_parse_api_data
+from tools.cfg_util.cfg_util_sg.func.ui import update_ui_with_data, update_prog_bar, set_progress_bar_len
+from tools.cfg_util.cfg_util_sg.layout import window
+from tools.cfg_util.cfg_util_sg.miner_factory import miner_factory
+from config.bos import bos_config_convert
+from settings import CFG_UTIL_CONFIG_THREADS as CONFIG_THREADS, CFG_UTIL_REBOOT_THREADS as REBOOT_THREADS
+
+
+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 scan_network(network):
+    await update_ui_with_data("status", "Scanning")
+    await update_ui_with_data("ip_count", "")
+    await update_ui_with_data("hr_total", "")
+    window["ip_table"].update([])
+    network_size = len(network)
+    miner_generator = network.scan_network_generator()
+    await set_progress_bar_len(2 * network_size)
+    progress_bar_len = 0
+    asyncio.create_task(update_prog_bar(progress_bar_len))
+    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 reboot_generator(miners: list):
+    loop = asyncio.get_event_loop()
+    reboot_tasks = []
+    for miner in miners:
+        if len(reboot_tasks) >= REBOOT_THREADS:
+            rebooted = asyncio.as_completed(reboot_tasks)
+            reboot_tasks = []
+            for done in rebooted:
+                yield await done
+        reboot_tasks.append(loop.create_task(miner.reboot()))
+    rebooted = asyncio.as_completed(reboot_tasks)
+    for done in rebooted:
+        yield await done
+
+
+async def reboot_miners(ips: list):
+    await update_ui_with_data("status", "Rebooting")
+    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))
+
+    reboot_miners_generator = reboot_generator(all_miners)
+    async for _rebooter in reboot_miners_generator:
+        progress_bar_len += 1
+        asyncio.create_task(update_prog_bar(progress_bar_len))
+    await update_ui_with_data("status", "")
+
+
+async def restart_backend_generator(miners: list):
+    loop = asyncio.get_event_loop()
+    reboot_tasks = []
+    for miner in miners:
+        if len(reboot_tasks) >= REBOOT_THREADS:
+            rebooted = asyncio.as_completed(reboot_tasks)
+            reboot_tasks = []
+            for done in rebooted:
+                yield await done
+        reboot_tasks.append(loop.create_task(miner.restart_backend()))
+    rebooted = asyncio.as_completed(reboot_tasks)
+    for done in rebooted:
+        yield await done
+
+
+async def restart_miners_backend(ips: list):
+    await update_ui_with_data("status", "Restarting Backends")
+    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))
+
+    reboot_miners_generator = reboot_generator(all_miners)
+    async for _rebooter in reboot_miners_generator:
+        progress_bar_len += 1
+        asyncio.create_task(update_prog_bar(progress_bar_len))
+    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
+    asyncio.create_task(update_prog_bar(progress_bar_len))
+    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", "Getting Data")
+    await asyncio.sleep(3)
+    await refresh_data(ips)
+
+
+async def refresh_data(ip_list: list):
+    await update_ui_with_data("status", "Getting Data")
+    await update_ui_with_data("hr_total", "")
+    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
+    asyncio.create_task(update_prog_bar(progress_bar_len))
+    reset_table_values = []
+    for item in window["ip_table"].Values:
+        if item[0] in ip_list:
+            reset_table_values.append([item[0]])
+        else:
+            reset_table_values.append(item)
+    window["ip_table"].update(reset_table_values)
+    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["model"], data_point["host"], str(data_point['TH/s']) + " TH/s",
+                data_point["temp"],
+                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 = []
+    hr_idx = 3
+    for item, _ in enumerate(window["ip_table"].Values):
+        if len(window["ip_table"].Values[item]) > hr_idx:
+            if not window["ip_table"].Values[item][hr_idx] == '':
+                hashrate_list.append(float(window["ip_table"].Values[item][hr_idx].replace(" TH/s", "")))
+            else:
+                hashrate_list.append(0)
+        else:
+            hashrate_list.append(0)
+
+    total_hr = round(sum(hashrate_list), 2)
+    window["hr_total"].update(f"{total_hr} TH/s")
+
+    await update_ui_with_data("status", "")
+
+
+async def scan_and_get_data(network):
+    await update_ui_with_data("status", "Scanning")
+    await update_ui_with_data("hr_total", "")
+    await update_ui_with_data("ip_count", "")
+    await update_ui_with_data("ip_table", [])
+    network_size = len(network)
+    miner_generator = network.scan_network_generator()
+    await set_progress_bar_len(3 * 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)))
+    data_gen = asyncio.as_completed([get_formatted_data(miner) for miner in miners])
+    ip_table_data = window["ip_table"].Values
+    ordered_all_ips = [item[0] for item in ip_table_data]
+    progress_bar_len += (network_size - len(miners))
+    asyncio.create_task(update_prog_bar(progress_bar_len))
+    await update_ui_with_data("status", "Getting 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["model"], data_point["host"], str(data_point['TH/s']) + " TH/s",
+                data_point["temp"],
+                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[3].replace(" TH/s", "")) for item in window["ip_table"].Values if not item[3] == '']
+    total_hr = round(sum(hashrate_list), 2)
+    await update_ui_with_data("hr_total", 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)
+    warnings.filterwarnings('ignore')
+    miner_data = None
+    host = await miner.get_hostname()
+    try:
+        model = await miner.get_model()
+    except APIError:
+        model = "?"
+    if not model:
+        model = "?"
+    temps = 0
+    th5s = 0
+    wattage = 0
+    user = "?"
+
+    try:
+        miner_data = await miner.api.multicommand("summary", "devs", "temps", "tunerstatus", "pools", "stats")
+    except APIError:
+        try:
+            # no devs command, it will fail in this case
+            miner_data = await miner.api.multicommand("summary", "temps", "tunerstatus", "pools", "stats")
+        except APIError as e:
+            print(e)
+            return {'TH/s': 0, 'IP': str(miner.ip), 'model': 'Unknown', 'temp': 0, 'host': 'Unknown', 'user': 'Unknown',
+                    'wattage': 0}
+    if miner_data:
+        # get all data from summary
+        if "summary" in miner_data.keys():
+            if not miner_data["summary"][0].get("SUMMARY") == []:
+                # temperature data, this is the idea spot to get this
+                if "Temperature" in miner_data['summary'][0]['SUMMARY'][0].keys():
+                    if not round(miner_data['summary'][0]['SUMMARY'][0]["Temperature"]) == 0:
+                        temps = miner_data['summary'][0]['SUMMARY'][0]["Temperature"]
+                # hashrate data, this is the only place to get this for most miners as far as I know
+                if 'MHS av' in miner_data['summary'][0]['SUMMARY'][0].keys():
+                    th5s = round(await safe_parse_api_data(miner_data, 'summary', 0, 'SUMMARY', 0, 'MHS av') / 1000000, 2)
+                elif 'GHS av' in miner_data['summary'][0]['SUMMARY'][0].keys():
+                    if not miner_data['summary'][0]['SUMMARY'][0]['GHS av'] == "":
+                        th5s = round(
+                            float(await safe_parse_api_data(miner_data, 'summary', 0, 'SUMMARY', 0, 'GHS av')) / 1000,
+                            2)
+
+        # alternate temperature data, for BraiinsOS
+        if "temps" in miner_data.keys():
+            if not miner_data["temps"][0]['TEMPS'] == []:
+                if "Chip" in miner_data["temps"][0]['TEMPS'][0].keys():
+                    for board in miner_data["temps"][0]['TEMPS']:
+                        if board["Chip"] is not None and not board["Chip"] == 0.0:
+                            temps = board["Chip"]
+        # alternate temperature data, for Whatsminers
+        if "devs" in miner_data.keys():
+            if not miner_data["devs"][0].get('DEVS') == []:
+                if "Chip Temp Avg" in miner_data["devs"][0]['DEVS'][0].keys():
+                    for board in miner_data["devs"][0]['DEVS']:
+                        if board['Chip Temp Avg'] is not None and not board['Chip Temp Avg'] == 0.0:
+                            temps = board['Chip Temp Avg']
+        # alternate temperature data
+        if "stats" in miner_data.keys():
+            if not miner_data["stats"][0]['STATS'] == []:
+                for temp in ["temp2", "temp1", "temp3"]:
+                    if temp in miner_data["stats"][0]['STATS'][1].keys():
+                        if miner_data["stats"][0]['STATS'][1][temp] is not None and not miner_data["stats"][0]['STATS'][1][temp] == 0.0:
+                            temps = miner_data["stats"][0]['STATS'][1][temp]
+            # alternate temperature data, for Avalonminers
+            miner_data["stats"][0]['STATS'][0].keys()
+            if any("MM ID" in string for string in miner_data["stats"][0]['STATS'][0].keys()):
+                temp_all = []
+                for key in [string for string in miner_data["stats"][0]['STATS'][0].keys() if "MM ID" in string]:
+                    for value in [string for string in miner_data["stats"][0]['STATS'][0][key].split(" ") if
+                                  "TMax" in string]:
+                        temp_all.append(int(value.split("[")[1].replace("]", "")))
+                temps = round(sum(temp_all) / len(temp_all))
+
+        # pool information
+        if "pools" in miner_data.keys():
+            if not miner_data['pools'][0].get('POOLS') == []:
+                user = await safe_parse_api_data(miner_data, 'pools', 0, 'POOLS', 0, 'User')
+            else:
+                print(miner_data['pools'][0])
+                user = "Blank"
+
+        # braiins tuner status / wattage
+        if "tunerstatus" in miner_data.keys():
+            wattage = await safe_parse_api_data(miner_data, "tunerstatus", 0, 'TUNERSTATUS', 0, "PowerLimit")
+        elif "Power" in miner_data["summary"][0]["SUMMARY"][0].keys():
+            wattage = await safe_parse_api_data(miner_data, "summary", 0, 'SUMMARY', 0, "Power")
+
+    return {'TH/s': th5s, 'IP': str(miner.ip), 'model': model,
+            'temp': round(temps), '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))

tools/cfg_util/cfg_util_sg/func/parse_data.py

@@ -1,6 +1,7 @@
 from API import APIError
 
 
+# noinspection PyPep8
 async def safe_parse_api_data(data: dict or list, *path: str or int, idx: int = 0):
     path = [*path]
     if len(path) == idx+1:
@@ -18,6 +19,7 @@ async def safe_parse_api_data(data: dict or list, *path: str or int, idx: int =
                 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
+                    # noinspection PyPep8
                     if parsed_data == None:
                         raise APIError(f"Data parsing failed on path index {idx} - \nKey: {path[idx]} \nData: {data}")
                     return parsed_data
@@ -34,6 +36,7 @@ async def safe_parse_api_data(data: dict or list, *path: str or int, idx: int =
                 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
+                    # noinspection PyPep8
                     if parsed_data == None:
                         raise APIError(f"Data parsing failed on path index {idx} - \nKey: {path[idx]} \nData: {data}")
                     return parsed_data

tools/cfg_util/cfg_util_sg/func/ui.py

@@ -0,0 +1,72 @@
+import ipaddress
+import re
+
+from tools.cfg_util.cfg_util_sg.layout import window
+
+import pyperclip
+
+
+def copy_from_table(table):
+    selection = table.selection()
+    copy_values = []
+    for each in selection:
+        try:
+            value = table.item(each)["values"][0]
+            copy_values.append(str(value))
+        except:
+            pass
+    copy_string = "\n".join(copy_values)
+    pyperclip.copy(copy_string)
+
+
+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 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", str(data_list[0][index])):
+        new_list = sorted(data_list, key=lambda x: int(x[index].replace(" W", "")))
+        if data_list == new_list:
+            new_list = sorted(data_list, reverse=True, key=lambda x: int(x[index].replace(" W", "")))
+
+    # hashrate
+    elif re.match("[0-9]*\.?[0-9]* TH\/s", str(data_list[0][index])):
+        new_list = sorted(data_list, key=lambda x: float(x[index].replace(" TH/s", "")))
+        if data_list == new_list:
+            new_list = sorted(data_list, reverse=True, 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]?)",
+                  str(data_list[0][index])):
+        new_list = sorted(data_list, key=lambda x: ipaddress.ip_address(x[index]))
+        if data_list == new_list:
+            new_list = sorted(data_list, reverse=True, key=lambda x: ipaddress.ip_address(x[index]))
+
+    # everything else, hostname, temp, and user
+    else:
+        new_list = sorted(data_list, key=lambda x: x[index])
+        if data_list == new_list:
+            new_list = sorted(data_list, reverse=True, key=lambda x: x[index])
+
+    await update_ui_with_data("ip_table", new_list)
+    await update_ui_with_data("status", "")

tools/cfg_util/cfg_util_sg/miner_factory.py

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

tools/cfg_util/cfg_util_sg/ui.py

@@ -0,0 +1,86 @@
+import asyncio
+import sys
+import PySimpleGUI as sg
+
+from tools.cfg_util.cfg_util_sg.layout import window, generate_config_layout
+from tools.cfg_util.cfg_util_sg.func.miners import send_config, miner_light, refresh_data, generate_config, import_config, \
+    scan_and_get_data, restart_miners_backend, reboot_miners
+from tools.cfg_util.cfg_util_sg.func.files import import_iplist, \
+    import_config_file, export_iplist, export_config_file, export_csv
+from tools.cfg_util.cfg_util_sg.func.ui import sort_data, copy_from_table
+
+from network import MinerNetwork
+
+import webbrowser
+
+
+async def ui():
+    window.read(timeout=0)
+    table = window["ip_table"].Widget
+    table.bind("<Control-Key-c>", lambda x: copy_from_table(table))
+    while True:
+        event, value = window.read(timeout=10)
+        if event in (None, 'Close', sg.WIN_CLOSED):
+            sys.exit()
+        if isinstance(event, tuple):
+            if len(window["ip_table"].Values) > 0:
+                if event[0] == 'ip_table':
+                    if event[2][0] == -1:
+                        await sort_data(event[2][1])
+        if event == 'open_in_web':
+            for row in value["ip_table"]:
+                webbrowser.open("http://" + window["ip_table"].Values[row][0])
+        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_and_get_data(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 == "restart_miner_backend":
+            asyncio.create_task(restart_miners_backend([window['ip_table'].Values[item][0] for item in value['ip_table']]))
+        if event == "reboot_miners":
+            asyncio.create_task(reboot_miners([window['ip_table'].Values[item][0] for item in 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 == "export_csv":
+            asyncio.create_task(export_csv(value["file_iplist"], [window['ip_table'].Values[item] 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 == "refresh_data":
+            asyncio.create_task(refresh_data([window["ip_table"].Values[item][0] for item in value["ip_table"]]))
+        if event == "generate_config":
+            await generate_config_ui()
+        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

tools/cfg_util/func/parse_data.py

@@ -0,0 +1,50 @@
+from API import APIError
+
+
+# noinspection PyPep8
+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
+                    # noinspection PyPep8
+                    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
+                    # noinspection PyPep8
+                    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