bump version number

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

--- a/docs/API/api.md
+++ b/docs/API/api.md
@@ -2,11 +2,12 @@
 ## Miner APIs
 Each miner has a unique API that is used to communicate with it.
 Each of these API types has commands that differ between them, and some commands have data that others do not.
-Each miner that is a subclass of `BaseMiner` should have an API linked to it as `Miner.api`.
+Each miner that is a subclass of [`BaseMiner`][pyasic.miners.BaseMiner] should have an API linked to it as `Miner.api`.

 All API implementations inherit from [`BaseMinerAPI`][pyasic.API.BaseMinerAPI], which implements the basic communications protocols.

-BaseMinerAPI should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare).
+[`BaseMinerAPI`][pyasic.API.BaseMinerAPI] should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare).
+[`BaseMinerAPI`][pyasic.API.BaseMinerAPI] cannot be instantiated directly, it will raise a `TypeError`.
 Use these instead -

 #### [BMMiner API][pyasic.API.bmminer.BMMinerAPI]
--- a/docs/data/error_codes.md
+++ b/docs/data/error_codes.md
@@ -0,0 +1,25 @@
+# pyasic
+<br>
+
+## Whatsminer Error Codes
+::: pyasic.data.error_codes.WhatsminerError
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+<br>
+
+## Braiins OS Error Codes
+::: pyasic.data.error_codes.BraiinsOSError
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+<br>
+
+## X19 Error Codes
+::: pyasic.data.error_codes.X19Error
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
--- a/docs/index.md
+++ b/docs/index.md
@@ -5,6 +5,8 @@
 [![pypi](https://img.shields.io/pypi/v/pyasic.svg)](https://pypi.org/project/pyasic/)
 [![python](https://img.shields.io/pypi/pyversions/pyasic.svg)](https://pypi.org/project/pyasic/)
 [![Read the Docs](https://img.shields.io/readthedocs/pyasic)](https://pyasic.readthedocs.io/en/latest/)
+[![GitHub](https://img.shields.io/github/license/UpstreamData/pyasic)](https://github.com/UpstreamData/pyasic/blob/master/LICENSE.txt)
+[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/UpstreamData/pyasic)](https://www.codefactor.io/repository/github/upstreamdata/pyasic)

 ## Intro
 Welcome to pyasic!  Pyasic uses an asynchronous method of communicating with asic miners on your network, which makes it super fast.
--- a/docs/miners/base_miner.md
+++ b/docs/miners/base_miner.md
@@ -0,0 +1,10 @@
+# pyasic
+## Base Miner
+[`BaseMiner`][pyasic.miners.BaseMiner] is the basis for all miner classes, they all subclass (usually indirectly) from this class.
+
+You may not instantiate this class on its own, only subclass from it.  Trying to instantiate an instance of this class will raise `TypeError`.
+
+::: pyasic.miners.BaseMiner
+    handler: python
+    options:
+        heading_level: 4
--- a/docs/miners/miner_factory.md
+++ b/docs/miners/miner_factory.md
@@ -6,3 +6,15 @@
    options:
        show_root_heading: false
        heading_level: 4
+<br>
+
+## AnyMiner
+::: pyasic.miners.miner_factory.AnyMiner
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+[`AnyMiner`][pyasic.miners.miner_factory.AnyMiner] is a placeholder type variable used for typing returns of functions.
+A function returning [`AnyMiner`][pyasic.miners.miner_factory.AnyMiner] will always return a subclass of [`BaseMiner`][pyasic.miners.BaseMiner],
+and is used to specify a function returning some arbitrary type of miner class instance.
--- a/docs/miners/supported_types.md
+++ b/docs/miners/supported_types.md
@@ -3,8 +3,6 @@

 Supported miner types are here on this list.  If your miner (or miner version) is not on this list, please feel free to [open an issue on GitHub](https://github.com/UpstreamData/pyasic/issues) to get it added.

-## Miner List
-
 ##### pyasic currently supports the following miners and subtypes:
 * Braiins OS+ Devices:
    * All devices supported by BraiinsOS+ are supported here.
@@ -27,6 +25,8 @@ Supported miner types are here on this list.  If your miner (or miner version) i
            * [VE20][pyasic.miners.whatsminer.btminer.M3X.M31S_Plus.BTMinerM31SPlusVE20]
        * [M32S][pyasic.miners.whatsminer.btminer.M3X.M32S.BTMinerM32S]
    * M2X Series:
+        * [M20][pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20]:
+            * [V10][pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20V10]
        * [M20S][pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20S]:
            * [V10][pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV10]
            * [V20][pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV20]
--- a/docs/miners/whatsminer/M2X.md
+++ b/docs/miners/whatsminer/M2X.md
@@ -1,6 +1,22 @@
 # pyasic
 ## M2X Models

+## M20
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M20V10
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20V10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
 ## M20S

 ::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20S
--- a/docs/network/miner_network_range.md
+++ b/docs/network/miner_network_range.md
@@ -1,7 +1,7 @@
 # pyasic
 ## Miner Network Range

-`MinerNetworkRange` is a class used by [`MinerNetwork`][pyasic.network.MinerNetwork] to handle any constructor stings.
+[`MinerNetworkRange`][pyasic.network.net_range.MinerNetworkRange] is a class used by [`MinerNetwork`][pyasic.network.MinerNetwork] to handle any constructor stings.
 The goal is to emulate what is produced by `ipaddress.ip_network` by allowing [`MinerNetwork`][pyasic.network.MinerNetwork] to get a list of hosts.
 This allows this class to be the [`MinerNetwork.network`][pyasic.network.MinerNetwork] and hence be used for scanning.

--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -28,17 +28,21 @@ nav:
      - Miner Network Range: "network/miner_network_range.md"
  - Data:
      - Miner Data: "data/miner_data.md"
+      - Error Codes: "data/error_codes.md"
  - Config:
      - Miner Config: "config/miner_config.md"
  - Advanced:
      - Miner APIs:
-          - Base: "API/api.md"
+          - Intro: "API/api.md"
          - BMMiner: "API/bmminer.md"
          - BOSMiner: "API/bosminer.md"
          - BTMiner: "API/btminer.md"
          - CGMiner: "API/cgminer.md"
          - Unknown: "API/unknown.md"

+      - Base Miner: "miners/base_miner.md"
+
+
 plugins:
  - mkdocstrings
  - search
--- a/pyasic/API/init.py
+++ b/pyasic/API/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 import asyncio
 import json
 import ipaddress
@@ -41,8 +55,17 @@ class BaseMinerAPI:
        # ip address of the miner
        self.ip = ipaddress.ip_address(ip)

+    def __new__(cls, *args, **kwargs):
+        if cls is BaseMinerAPI:
+            raise TypeError(f"Only children of '{cls.__name__}' may be instantiated")
+        return object.__new__(cls)
+
    def get_commands(self) -> list:
-        """Get a list of command accessible to a specific type of API on the miner."""
+        """Get a list of command accessible to a specific type of API on the miner.
+
+        Returns:
+            A list of all API commands that the miner supports.
+        """
        return [
            func
            for func in
@@ -60,42 +83,56 @@ class BaseMinerAPI:
            ]
        ]

+    def _check_commands(self, *commands):
+        allowed_commands = self.get_commands()
+        return_commands = []
+        for command in [*commands]:
+            if command in allowed_commands:
+                return_commands.append(command)
+            else:
+                warnings.warn(
+                    f"""Removing incorrect command: {command}
+If you are sure you want to use this command please use API.send_command("{command}", ignore_errors=True) instead.""",
+                    APIWarning,
+                )
+        return return_commands
+
    async def multicommand(
        self, *commands: str, ignore_x19_error: bool = False
    ) -> dict:
-        """Creates and sends multiple commands as one command to the miner."""
+        """Creates and sends multiple commands as one command to the miner.
+
+        Parameters:
+            *commands: The commands to send as a multicommand to the miner.
+            ignore_x19_error: Whether or not to ignore errors raised by x19 miners when using the "+" delimited style.
+        """
        logging.debug(f"{self.ip}: Sending multicommand: {[*commands]}")
-        # split the commands into a proper list
-        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,
-            )
+        # make sure we can actually run each command, otherwise they will fail
+        commands = self._check_commands(*commands)
        # standard multicommand format is "command1+command2"
-        # doesnt work for S19 which is dealt with in the send command function
+        # doesnt work for S19 which uses the backup _x19_multicommand
        command = "+".join(commands)
-        data = None
        try:
            data = await self.send_command(command, x19_command=ignore_x19_error)
        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:
-                logging.warning(f"{self.ip}: API Multicommand Error: {e}")
-        if data:
-            logging.debug(f"{self.ip}: Received multicommand data.")
-            return data
+            logging.debug(f"{self.ip}: Handling X19 multicommand.")
+            data = await self._x19_multicommand(*command.split("+"))
+        logging.debug(f"{self.ip}: Received multicommand data.")
+        return data
+
+    async def _x19_multicommand(self, *commands):
+        data = None
+        try:
+            data = {}
+            # send all commands individually
+            for cmd in commands:
+                data[cmd] = []
+                data[cmd].append(await self.send_command(cmd, x19_command=True))
+        except APIError as e:
+            raise APIError(e)
+        except Exception as e:
+            logging.warning(f"{self.ip}: API Multicommand Error: {e}")
+        return data

    async def send_command(
        self,
@@ -104,7 +141,17 @@ If you are sure you want to use this command please use API.send_command("{item}
        ignore_errors: bool = False,
        x19_command: bool = False,
    ) -> dict:
-        """Send an API command to the miner and return the result."""
+        """Send an API command to the miner and return the result.
+
+        Parameters:
+            command: The command to sent to the miner.
+            parameters: Any additional parameters to be sent with the command.
+            ignore_errors: Whether or not to raise APIError when the command returns an error.
+            x19_command: Whether this is a command for an x19 that may be an issue (such as a "+" delimited multicommand)
+
+        Returns:
+            The return data from the API command parsed from JSON into a dict.
+        """
        try:
            # get reader and writer streams
            reader, writer = await asyncio.open_connection(str(self.ip), self.port)
@@ -116,7 +163,7 @@ If you are sure you want to use this command please use API.send_command("{item}

        # create the command
        cmd = {"command": command}
-        if parameters is not None:
+        if parameters:
            cmd["parameter"] = parameters

        # send the command
@@ -134,9 +181,9 @@ If you are sure you want to use this command please use API.send_command("{item}
                    break
                data += d
        except Exception as e:
-            logging.warning(f"{self.ip}: API Command Error: {e}")
+            logging.warning(f"{self.ip}: API Command Error: - {e}")

-        data = self.load_api_data(data)
+        data = self._load_api_data(data)

        # close the connection
        writer.close()
@@ -145,7 +192,7 @@ If you are sure you want to use this command please use API.send_command("{item}
        # 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)
+            validation = self._validate_command_output(data)
            if not validation[0]:
                if not x19_command:
                    logging.warning(f"{self.ip}: API Command Error: {validation[1]}")
@@ -154,8 +201,7 @@ If you are sure you want to use this command please use API.send_command("{item}
        return data

    @staticmethod
-    def validate_command_output(data: dict) -> tuple:
-        """Check if the returned command output is correctly formatted."""
+    def _validate_command_output(data: dict) -> tuple:
        # check if the data returned is correct or an error
        # if status isn't a key, it is a multicommand
        if "STATUS" not in data.keys():
@@ -182,8 +228,7 @@ If you are sure you want to use this command please use API.send_command("{item}
        return True, None

    @staticmethod
-    def load_api_data(data: bytes) -> dict:
-        """Convert API data from JSON to dict"""
+    def _load_api_data(data: bytes) -> dict:
        str_data = None
        try:
            # some json from the API returns with a null byte (\x00) on the end
--- a/pyasic/API/bmminer.py
+++ b/pyasic/API/bmminer.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from pyasic.API import BaseMinerAPI


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


--- a/pyasic/API/btminer.py
+++ b/pyasic/API/btminer.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 import asyncio
 import re
 import json
@@ -5,12 +19,13 @@ import hashlib
 import binascii
 import base64
 import logging
+from typing import Union

 from passlib.handlers.md5_crypt import md5_crypt
 from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes

 from pyasic.API import BaseMinerAPI, APIError
-from pyasic.settings import WHATSMINER_PWD
+from pyasic.settings import PyasicSettings


 ### IMPORTANT ###
@@ -161,15 +176,20 @@ class BTMinerAPI(BaseMinerAPI):
        pwd: The admin password of the miner.  Default is admin.
    """

-    def __init__(self, ip: str, port: int = 4028, pwd: str = WHATSMINER_PWD):
+    def __init__(
+        self,
+        ip: str,
+        port: int = 4028,
+        pwd: str = PyasicSettings().global_whatsminer_password,
+    ):
        super().__init__(ip, port)
        self.admin_pwd = pwd
        self.current_token = None

    async def send_command(
        self,
-        command: str or bytes,
-        parameters: str or int or bool = None,
+        command: Union[str, bytes],
+        parameters: Union[str, int, bool] = None,
        ignore_errors: bool = False,
        **kwargs,
    ) -> dict:
@@ -204,7 +224,7 @@ class BTMinerAPI(BaseMinerAPI):
        except Exception as e:
            logging.info(f"{str(self.ip)}: {e}")

-        data = self.load_api_data(data)
+        data = self._load_api_data(data)

        # close the connection
        writer.close()
@@ -220,7 +240,7 @@ class BTMinerAPI(BaseMinerAPI):

        if not ignore_errors:
            # if it fails to validate, it is likely an error
-            validation = self.validate_command_output(data)
+            validation = self._validate_command_output(data)
            if not validation[0]:
                raise APIError(validation[1])

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


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


--- a/pyasic/init.py
+++ b/pyasic/init.py
@@ -0,0 +1,13 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
--- a/pyasic/config/init.py
+++ b/pyasic/config/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from dataclasses import dataclass, asdict
 from typing import Literal, List
 import random
@@ -273,6 +287,15 @@ class MinerConfig:
        self.pool_groups = pool_groups
        return self

+    def from_api(self, pools: list):
+        _pools = []
+        for pool in pools:
+            url = pool.get("URL")
+            user = pool.get("User")
+            _pools.append({"url": url, "user": user, "pass": "123"})
+        self.pool_groups = [_PoolGroup().from_dict({"pools": _pools})]
+        return self
+
    def from_dict(self, data: dict):
        """Convert an output dict of this class back into usable data and save it to this class.

--- a/pyasic/data/init.py
+++ b/pyasic/data/init.py
@@ -1,6 +1,23 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from typing import Union, List
 from dataclasses import dataclass, field, asdict
 from datetime import datetime

+from .error_codes import X19Error, WhatsminerError, BraiinsOSError
+

@dataclass
 class MinerData:
@@ -34,7 +51,7 @@ class MinerData:
        right_chips: The number of chips online in the left board as an int.
        total_chips: The total number of chips on all boards.  Calculated automatically.
        ideal_chips: The ideal number of chips in the miner as an int.
-        perecent_ideal: The percent of total chips out of the ideal count.  Calculated automatically.
+        percent_ideal: The percent of total chips out of the ideal count.  Calculated automatically.
        nominal: The nominal amount of chips in the miner.  Calculated automatically.
        pool_split: The pool split as a str.
        pool_1_url: The first pool url on the miner as a str.
@@ -42,6 +59,7 @@ class MinerData:
        pool_2_url: The second pool url on the miner as a str.
        pool_2_user: The second pool user on the miner as a str.
        errors: A list of errors on the miner.
+        fault_light: Whether or not the fault light is on as a boolean.
    """

    ip: str
@@ -79,7 +97,10 @@ class MinerData:
    pool_1_user: str = "Unknown"
    pool_2_url: str = ""
    pool_2_user: str = ""
-    errors: list = field(default_factory=list)
+    errors: List[Union[WhatsminerError, BraiinsOSError, X19Error]] = field(
+        default_factory=list
+    )
+    fault_light: Union[bool, None] = None

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


@dataclass
 class BraiinsOSError:
-    """A Dataclass to handle error codes of BraiinsOS+ miners."""
+    """A Dataclass to handle error codes of BraiinsOS+ miners.
+
+    Attributes:
+        error_message: The error message as a string.
+    """

    error_message: str

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


@dataclass
 class WhatsminerError:
-    """A Dataclass to handle error codes of Whatsminers."""
+    """A Dataclass to handle error codes of Whatsminers.
+
+    Attributes:
+        error_code: The error code as an int.
+        error_message: The error message as a string.  Automatically found from the error code.
+    """

    error_code: int
    error_message: str = field(init=False)
--- a/pyasic/logger/init.py
+++ b/pyasic/logger/init.py
@@ -1,9 +1,23 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 import logging
-from pyasic.settings import DEBUG, LOGFILE
+from pyasic.settings import PyasicSettings


 def init_logger():
-    if LOGFILE:
+    if PyasicSettings().logfile:
        logging.basicConfig(
            filename="logfile.txt",
            filemode="a",
@@ -18,7 +32,7 @@ def init_logger():

    _logger = logging.getLogger()

-    if DEBUG:
+    if PyasicSettings().debug:
        _logger.setLevel(logging.DEBUG)
        logging.getLogger("asyncssh").setLevel(logging.DEBUG)
    else:
--- a/pyasic/miners/init.py
+++ b/pyasic/miners/init.py
@@ -1,11 +1,27 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 import asyncssh
 import logging
 import ipaddress
+from abc import ABC, abstractmethod

 from pyasic.data import MinerData
+from pyasic.config import MinerConfig


-class BaseMiner:
+class BaseMiner(ABC):
    def __init__(self, *args) -> None:
        self.ip = None
        self.uname = "root"
@@ -20,6 +36,11 @@ class BaseMiner:
        self.fan_count = 2
        self.config = None

+    def __new__(cls, *args, **kwargs):
+        if cls is BaseMiner:
+            raise TypeError(f"Only children of '{cls.__name__}' may be instantiated")
+        return object.__new__(cls)
+
    def __repr__(self):
        return f"{'' if not self.api_type else self.api_type} {'' if not self.model else self.model}: {str(self.ip)}"

@@ -54,51 +75,63 @@ class BaseMiner:
                )
                return conn
            except Exception as e:
-                # logging.warning(f"{self} raised an exception: {e}")
                raise e
        except OSError as e:
            logging.warning(f"Connection refused: {self}")
            raise e
        except Exception as e:
-            # logging.warning(f"{self} raised an exception: {e}")
            raise e

+    @abstractmethod
    async def fault_light_on(self) -> bool:
-        return False
+        pass

+    @abstractmethod
    async def fault_light_off(self) -> bool:
-        return False
+        pass

-    async def send_file(self, src, dest):
-        async with (await self._get_ssh_connection()) as conn:
-            await asyncssh.scp(src, (conn, dest))
+    # async def send_file(self, src, dest):
+    #     async with (await self._get_ssh_connection()) as conn:
+    #         await asyncssh.scp(src, (conn, dest))

-    async def check_light(self):
-        return self.light
+    @abstractmethod
+    async def check_light(self) -> bool:
+        pass

+    # @abstractmethod
    async def get_board_info(self):
        return None

-    async def get_config(self):
-        return None
+    @abstractmethod
+    async def get_config(self) -> MinerConfig:
+        pass

-    async def get_hostname(self):
-        return None
+    @abstractmethod
+    async def get_hostname(self) -> str:
+        pass

-    async def get_model(self):
-        return None
+    @abstractmethod
+    async def get_model(self) -> str:
+        pass

-    async def reboot(self):
-        return False
+    @abstractmethod
+    async def reboot(self) -> bool:
+        pass

-    async def restart_backend(self):
-        return False
+    @abstractmethod
+    async def restart_backend(self) -> bool:
+        pass

    async def send_config(self, *args, **kwargs):
        return None

-    async def get_mac(self):
-        return None
+    @abstractmethod
+    async def get_mac(self) -> str:
+        pass
+
+    @abstractmethod
+    async def get_errors(self) -> list:
+        pass

    async def get_data(self) -> MinerData:
        return MinerData(ip=str(self.ip))
--- a/pyasic/miners/_backends/init.py
+++ b/pyasic/miners/_backends/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .bmminer import BMMiner
 from .bosminer import BOSMiner
 from .btminer import BTMiner
--- a/pyasic/miners/_backends/bmminer.py
+++ b/pyasic/miners/_backends/bmminer.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 import ipaddress
 import logging
 from typing import Union
@@ -8,7 +22,7 @@ from pyasic.miners import BaseMiner

 from pyasic.data import MinerData

-from pyasic.settings import MINER_FACTORY_GET_VERSION_RETRIES as DATA_RETRIES
+from pyasic.settings import PyasicSettings


 class BMMiner(BaseMiner):
@@ -140,6 +154,26 @@ class BMMiner(BaseMiner):
            return True
        return False

+    async def check_light(self) -> bool:
+        if not self.light:
+            self.light = False
+        return self.light
+
+    async def fault_light_off(self) -> bool:
+        return False
+
+    async def fault_light_on(self) -> bool:
+        return False
+
+    async def get_errors(self) -> list:
+        return []
+
+    async def get_mac(self) -> str:
+        return "00:00:00:00:00:00"
+
+    async def restart_backend(self) -> bool:
+        return False
+
    async def get_data(self) -> MinerData:
        """Get data from the miner.

@@ -154,6 +188,7 @@ class BMMiner(BaseMiner):
        model = await self.get_model()
        hostname = await self.get_hostname()
        mac = await self.get_mac()
+        errors = await self.get_errors()

        if model:
            data.model = model
@@ -164,8 +199,14 @@ class BMMiner(BaseMiner):
        if mac:
            data.mac = mac

+        if errors:
+            for error in errors:
+                data.errors.append(error)
+
+        data.fault_light = await self.check_light()
+
        miner_data = None
-        for i in range(DATA_RETRIES):
+        for i in range(PyasicSettings().miner_get_data_retries):
            miner_data = await self.api.multicommand(
                "summary", "pools", "stats", ignore_x19_error=True
            )
--- a/pyasic/miners/_backends/bosminer.py
+++ b/pyasic/miners/_backends/bosminer.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 import ipaddress
 import logging
 import json
@@ -15,7 +29,7 @@ from pyasic.data import MinerData

 from pyasic.config import MinerConfig

-from pyasic.settings import MINER_FACTORY_GET_VERSION_RETRIES as DATA_RETRIES
+from pyasic.settings import PyasicSettings


 class BOSMiner(BaseMiner):
@@ -97,7 +111,7 @@ class BOSMiner(BaseMiner):
            return True
        return False

-    async def get_config(self) -> str:
+    async def get_config(self) -> MinerConfig:
        """Gets the config for the miner and sets it as `self.config`.

        Returns:
@@ -217,13 +231,57 @@ class BOSMiner(BaseMiner):
                .as_bos(model=self.model.replace(" (BOS)", ""))
            )
        async with (await self._get_ssh_connection()) as conn:
+            await conn.run("/etc/init.d/bosminer stop")
            logging.debug(f"{self}: Opening SFTP connection.")
            async with conn.start_sftp_client() as sftp:
                logging.debug(f"{self}: Opening config file.")
                async with sftp.open("/etc/bosminer.toml", "w+") as file:
                    await file.write(toml_conf)
            logging.debug(f"{self}: Restarting BOSMiner")
-            await conn.run("/etc/init.d/bosminer restart")
+            await conn.run("/etc/init.d/bosminer start")
+
+    async def check_light(self) -> bool:
+        if not self.light:
+            self.light = False
+        return self.light
+
+    async def get_errors(self) -> list:
+        tunerstatus = None
+        errors = []
+
+        try:
+            tunerstatus = await self.api.tunerstatus()
+        except Exception as e:
+            logging.warning(e)
+
+        if tunerstatus:
+            tuner = tunerstatus[0].get("TUNERSTATUS")
+            if tuner:
+                if len(tuner) > 0:
+                    chain_status = tuner[0].get("TunerChainStatus")
+                    if chain_status and len(chain_status) > 0:
+                        board_map = {
+                            0: "Left board",
+                            1: "Center board",
+                            2: "Right board",
+                        }
+                        offset = (
+                            6
+                            if chain_status[0]["HashchainIndex"] in [6, 7, 8]
+                            else chain_status[0]["HashchainIndex"]
+                        )
+                        for board in chain_status:
+                            _id = board["HashchainIndex"] - offset
+                            if board["Status"] not in [
+                                "Stable",
+                                "Testing performance profile",
+                            ]:
+                                _error = board["Status"]
+                                _error = _error[0].lower() + _error[1:]
+                                errors.append(
+                                    BraiinsOSError(f"{board_map[_id]} {_error}")
+                                )
+        return errors

    async def get_data(self) -> MinerData:
        """Get data from the miner.
@@ -249,8 +307,10 @@ class BOSMiner(BaseMiner):
        if mac:
            data.mac = mac

+        data.fault_light = await self.check_light()
+
        miner_data = None
-        for i in range(DATA_RETRIES):
+        for i in range(PyasicSettings().miner_get_data_retries):
            try:
                miner_data = await self.api.multicommand(
                    "summary",
--- a/pyasic/miners/_backends/bosminer_old.py
+++ b/pyasic/miners/_backends/bosminer_old.py
@@ -1,6 +1,21 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 import logging

 import ipaddress
+from typing import Union

 from pyasic.API.bosminer import BOSMinerAPI
 from pyasic.miners import BaseMiner
@@ -15,7 +30,7 @@ class BOSMinerOld(BaseMiner):
        self.uname = "root"
        self.pwd = "admin"

-    async def send_ssh_command(self, cmd: str) -> str or None:
+    async def send_ssh_command(self, cmd: str) -> Union[str, None]:
        """Send a command to the miner over ssh.

        :return: Result of the command or None.
@@ -44,7 +59,36 @@ class BOSMinerOld(BaseMiner):
        # return the result, either command output or None
        return str(result)

-
    async def update_to_plus(self):
        result = await self.send_ssh_command("opkg update && opkg install bos_plus")
        return result
+
+    async def check_light(self) -> bool:
+        return False
+
+    async def fault_light_on(self) -> bool:
+        return False
+
+    async def fault_light_off(self) -> bool:
+        return False
+
+    async def get_config(self) -> None:
+        return None
+
+    async def get_errors(self) -> list:
+        return []
+
+    async def get_hostname(self) -> str:
+        return "?"
+
+    async def get_mac(self) -> str:
+        return "00:00:00:00:00:00"
+
+    async def get_model(self) -> str:
+        return "S9"
+
+    async def reboot(self) -> bool:
+        return False
+
+    async def restart_backend(self) -> bool:
+        return False
--- a/pyasic/miners/_backends/btminer.py
+++ b/pyasic/miners/_backends/btminer.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 import ipaddress
 import logging
 from typing import Union
@@ -9,8 +23,9 @@ from pyasic.API import APIError

 from pyasic.data import MinerData
 from pyasic.data.error_codes import WhatsminerError
+from pyasic.config import MinerConfig

-from pyasic.settings import MINER_FACTORY_GET_VERSION_RETRIES as DATA_RETRIES
+from pyasic.settings import PyasicSettings


 class BTMiner(BaseMiner):
@@ -85,6 +100,40 @@ class BTMiner(BaseMiner):

        return str(mac).upper()

+    async def check_light(self) -> bool:
+        if not self.light:
+            self.light = False
+        return self.light
+
+    async def fault_light_off(self) -> bool:
+        return False
+
+    async def fault_light_on(self) -> bool:
+        return False
+
+    async def get_errors(self) -> list:
+        return []
+
+    async def reboot(self) -> bool:
+        return False
+
+    async def restart_backend(self) -> bool:
+        return False
+
+    async def get_config(self) -> MinerConfig:
+        pools = None
+        cfg = MinerConfig()
+
+        try:
+            pools = await self.api.pools()
+        except APIError as e:
+            logging.warning(e)
+
+        if pools:
+            if "POOLS" in pools.keys():
+                cfg = cfg.from_api(pools["POOLS"])
+        return cfg
+
    async def get_data(self) -> MinerData:
        """Get data from the miner.

@@ -115,8 +164,10 @@ class BTMiner(BaseMiner):
        if hostname:
            data.hostname = hostname

+        data.fault_light = await self.check_light()
+
        miner_data = None
-        for i in range(DATA_RETRIES):
+        for i in range(PyasicSettings().miner_get_data_retries):
            try:
                miner_data = await self.api.multicommand("summary", "devs", "pools")
                if miner_data:
--- a/pyasic/miners/_backends/cgminer.py
+++ b/pyasic/miners/_backends/cgminer.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 import ipaddress
 import logging
 from typing import Union
@@ -9,7 +23,7 @@ from pyasic.API import APIError

 from pyasic.data import MinerData

-from pyasic.settings import MINER_FACTORY_GET_VERSION_RETRIES as DATA_RETRIES
+from pyasic.settings import PyasicSettings


 class CGMiner(BaseMiner):
@@ -137,6 +151,23 @@ class CGMiner(BaseMiner):
            self.config = result.stdout
        return self.config

+    async def check_light(self) -> bool:
+        if not self.light:
+            self.light = False
+        return self.light
+
+    async def fault_light_off(self) -> bool:
+        return False
+
+    async def fault_light_on(self) -> bool:
+        return False
+
+    async def get_errors(self) -> list:
+        return []
+
+    async def get_mac(self) -> str:
+        return "00:00:00:00:00:00"
+
    async def get_data(self) -> MinerData:
        """Get data from the miner.

@@ -161,8 +192,10 @@ class CGMiner(BaseMiner):
        if mac:
            data.mac = mac

+        data.fault_light = await self.check_light()
+
        miner_data = None
-        for i in range(DATA_RETRIES):
+        for i in range(PyasicSettings().miner_get_data_retries):
            miner_data = await self.api.multicommand(
                "summary", "pools", "stats", ignore_x19_error=True
            )
--- a/pyasic/miners/_backends/hiveon.py
+++ b/pyasic/miners/_backends/hiveon.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from pyasic.miners._backends import BMMiner
 import ipaddress

--- a/pyasic/miners/_types/init.py
+++ b/pyasic/miners/_types/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .antminer import *
 from .avalonminer import *
 from .whatsminer import *
--- a/pyasic/miners/_types/antminer/X17/S17.py
+++ b/pyasic/miners/_types/antminer/X17/S17.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from pyasic.miners import BaseMiner


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


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


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


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


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


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


--- a/pyasic/miners/_types/antminer/X17/init.py
+++ b/pyasic/miners/_types/antminer/X17/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .S17 import S17
 from .S17_Plus import S17Plus
 from .S17_Pro import S17Pro
--- a/pyasic/miners/_types/antminer/X19/S19.py
+++ b/pyasic/miners/_types/antminer/X19/S19.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from pyasic.miners import BaseMiner


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


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


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


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


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


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

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


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


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


--- a/pyasic/miners/_types/antminer/X9/init.py
+++ b/pyasic/miners/_types/antminer/X9/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .S9 import S9
 from .S9i import S9i
 from .T9 import T9
--- a/pyasic/miners/_types/antminer/init.py
+++ b/pyasic/miners/_types/antminer/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X9 import *
 from .X17 import *
 from .X19 import *
--- a/pyasic/miners/_types/avalonminer/A10X/A1026.py
+++ b/pyasic/miners/_types/avalonminer/A10X/A1026.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from pyasic.miners import BaseMiner


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


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


--- a/pyasic/miners/_types/avalonminer/A10X/init.py
+++ b/pyasic/miners/_types/avalonminer/A10X/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .A1026 import Avalon1026
 from .A1047 import Avalon1047
 from .A1066 import Avalon1066
--- a/pyasic/miners/_types/avalonminer/A7X/A721.py
+++ b/pyasic/miners/_types/avalonminer/A7X/A721.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from pyasic.miners import BaseMiner


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


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


--- a/pyasic/miners/_types/avalonminer/A7X/init.py
+++ b/pyasic/miners/_types/avalonminer/A7X/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .A721 import Avalon721
 from .A741 import Avalon741
 from .A761 import Avalon761
--- a/pyasic/miners/_types/avalonminer/A8X/A821.py
+++ b/pyasic/miners/_types/avalonminer/A8X/A821.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from pyasic.miners import BaseMiner


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


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


--- a/pyasic/miners/_types/avalonminer/A8X/init.py
+++ b/pyasic/miners/_types/avalonminer/A8X/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .A821 import Avalon821
 from .A841 import Avalon841
 from .A851 import Avalon851
--- a/pyasic/miners/_types/avalonminer/A9X/A921.py
+++ b/pyasic/miners/_types/avalonminer/A9X/A921.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from pyasic.miners import BaseMiner


--- a/pyasic/miners/_types/avalonminer/A9X/init.py
+++ b/pyasic/miners/_types/avalonminer/A9X/init.py
@@ -1 +1,15 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .A921 import Avalon921
--- a/pyasic/miners/_types/avalonminer/init.py
+++ b/pyasic/miners/_types/avalonminer/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .A7X import *
 from .A8X import *
 from .A9X import *
--- a/pyasic/miners/_types/whatsminer/M2X/M20.py
+++ b/pyasic/miners/_types/whatsminer/M2X/M20.py
@@ -0,0 +1,33 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from pyasic.miners import BaseMiner
+
+
+class M20(BaseMiner):
+    def __init__(self, ip: str):
+        super().__init__()
+        self.ip = ip
+        self.model = "M20"
+        self.nominal_chips = 70
+        self.fan_count = 2
+
+
+class M20V10(BaseMiner):
+    def __init__(self, ip: str):
+        super().__init__()
+        self.ip = ip
+        self.model = "M20 V10"
+        self.nominal_chips = 70
+        self.fan_count = 2
--- a/pyasic/miners/_types/whatsminer/M2X/M20S.py
+++ b/pyasic/miners/_types/whatsminer/M2X/M20S.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from pyasic.miners import BaseMiner


@@ -14,7 +28,7 @@ class M20SV10(BaseMiner):
    def __init__(self, ip: str):
        super().__init__()
        self.ip = ip
-        self.model = "M20S"
+        self.model = "M20S V10"
        self.nominal_chips = 105
        self.fan_count = 2

@@ -23,6 +37,6 @@ class M20SV20(BaseMiner):
    def __init__(self, ip: str):
        super().__init__()
        self.ip = ip
-        self.model = "M20S"
+        self.model = "M20S V20"
        self.nominal_chips = 111
        self.fan_count = 2
--- a/pyasic/miners/_types/whatsminer/M2X/M20S_Plus.py
+++ b/pyasic/miners/_types/whatsminer/M2X/M20S_Plus.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from pyasic.miners import BaseMiner


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


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


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


--- a/pyasic/miners/_types/whatsminer/M2X/init.py
+++ b/pyasic/miners/_types/whatsminer/M2X/init.py
@@ -1,3 +1,18 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from .M20 import M20, M20V10
 from .M20S import M20S, M20SV10, M20SV20
 from .M20S_Plus import M20SPlus

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


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


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


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


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


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


--- a/pyasic/miners/_types/whatsminer/M3X/init.py
+++ b/pyasic/miners/_types/whatsminer/M3X/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .M30S import M30S, M30SVE10, M30SVE20, M30SVG20, M30SV50
 from .M30S_Plus import M30SPlus, M30SPlusVG60, M30SPlusVE40, M30SPlusVF20
 from .M30S_Plus_Plus import M30SPlusPlus, M30SPlusPlusVG30, M30SPlusPlusVG40
--- a/pyasic/miners/_types/whatsminer/init.py
+++ b/pyasic/miners/_types/whatsminer/init.py
@@ -1,2 +1,16 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .M2X import *
 from .M3X import *
--- a/pyasic/miners/antminer/init.py
+++ b/pyasic/miners/antminer/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .bmminer import *
 from .bosminer import *
 from .cgminer import *
--- a/pyasic/miners/antminer/bmminer/X17/S17.py
+++ b/pyasic/miners/antminer/bmminer/X17/S17.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X17 import BMMinerX17
 from pyasic.miners._types import S17  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X17/S17_Plus.py
+++ b/pyasic/miners/antminer/bmminer/X17/S17_Plus.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X17 import BMMinerX17
 from pyasic.miners._types import S17Plus  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X17/S17_Pro.py
+++ b/pyasic/miners/antminer/bmminer/X17/S17_Pro.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X17 import BMMinerX17
 from pyasic.miners._types import S17Pro  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X17/S17e.py
+++ b/pyasic/miners/antminer/bmminer/X17/S17e.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X17 import BMMinerX17
 from pyasic.miners._types import S17e  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X17/T17.py
+++ b/pyasic/miners/antminer/bmminer/X17/T17.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X17 import BMMinerX17
 from pyasic.miners._types import T17  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X17/T17_Plus.py
+++ b/pyasic/miners/antminer/bmminer/X17/T17_Plus.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X17 import BMMinerX17
 from pyasic.miners._types import T17Plus  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X17/T17e.py
+++ b/pyasic/miners/antminer/bmminer/X17/T17e.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X17 import BMMinerX17
 from pyasic.miners._types import T17e  # noqa - Ignore access to _module

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

+from pyasic.settings import PyasicSettings
+
 import httpx
+from typing import Union


 class BMMinerX17(BMMiner):
    def __init__(self, ip: str) -> None:
        super().__init__(ip)
        self.ip = ip
+        self.uname = "root"
+        self.pwd = PyasicSettings().global_x17_password

-    async def get_hostname(self) -> str or None:
+    async def get_hostname(self) -> Union[str, None]:
        hostname = None
        url = f"http://{self.ip}/cgi-bin/get_system_info.cgi"
-        auth = httpx.DigestAuth("root", "root")
+        auth = httpx.DigestAuth(self.uname, self.pwd)
        async with httpx.AsyncClient() as client:
            data = await client.get(url, auth=auth)
        if data.status_code == 200:
@@ -21,10 +40,10 @@ class BMMinerX17(BMMiner):
                    hostname = data["hostname"]
        return hostname

-    async def get_mac(self):
+    async def get_mac(self) -> Union[str, None]:
        mac = None
        url = f"http://{self.ip}/cgi-bin/get_system_info.cgi"
-        auth = httpx.DigestAuth("root", "root")
+        auth = httpx.DigestAuth(self.uname, self.pwd)
        async with httpx.AsyncClient() as client:
            data = await client.get(url, auth=auth)
        if data.status_code == 200:
@@ -36,7 +55,7 @@ class BMMinerX17(BMMiner):

    async def fault_light_on(self) -> bool:
        url = f"http://{self.ip}/cgi-bin/blink.cgi"
-        auth = httpx.DigestAuth("root", "root")
+        auth = httpx.DigestAuth(self.uname, self.pwd)
        async with httpx.AsyncClient() as client:
            try:
                await client.post(url, data={"action": "startBlink"}, auth=auth)
@@ -47,35 +66,43 @@ class BMMinerX17(BMMiner):
        if data.status_code == 200:
            data = data.json()
            if data["isBlinking"]:
+                self.light = True
                return True
        return False

    async def fault_light_off(self) -> bool:
        url = f"http://{self.ip}/cgi-bin/blink.cgi"
-        auth = httpx.DigestAuth("root", "root")
+        auth = httpx.DigestAuth(self.uname, self.pwd)
        async with httpx.AsyncClient() as client:
            await client.post(url, data={"action": "stopBlink"}, auth=auth)
            data = await client.post(url, data={"action": "onPageLoaded"}, auth=auth)
        if data.status_code == 200:
            data = data.json()
            if not data["isBlinking"]:
+                self.light = False
                return True
        return False

-    async def check_light(self):
+    async def check_light(self) -> Union[bool, None]:
+        if self.light:
+            return self.light
        url = f"http://{self.ip}/cgi-bin/blink.cgi"
-        auth = httpx.DigestAuth("root", "root")
+        auth = httpx.DigestAuth(self.uname, self.pwd)
        async with httpx.AsyncClient() as client:
            data = await client.post(url, data={"action": "onPageLoaded"}, auth=auth)
        if data.status_code == 200:
            data = data.json()
            if data["isBlinking"]:
+                self.light = True
                return True
-        return False
+            else:
+                self.light = False
+                return False
+        return None

    async def reboot(self) -> bool:
        url = f"http://{self.ip}/cgi-bin/reboot.cgi"
-        auth = httpx.DigestAuth("root", "root")
+        auth = httpx.DigestAuth(self.uname, self.pwd)
        async with httpx.AsyncClient() as client:
            data = await client.get(url, auth=auth)
        if data.status_code == 200:
--- a/pyasic/miners/antminer/bmminer/X17/init.py
+++ b/pyasic/miners/antminer/bmminer/X17/init.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .S17 import BMMinerS17
 from .S17_Plus import BMMinerS17Plus
 from .S17_Pro import BMMinerS17Pro
--- a/pyasic/miners/antminer/bmminer/X19/S19.py
+++ b/pyasic/miners/antminer/bmminer/X19/S19.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X19 import BMMinerX19
 from pyasic.miners._types import S19  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X19/S19_Pro.py
+++ b/pyasic/miners/antminer/bmminer/X19/S19_Pro.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X19 import BMMinerX19
 from pyasic.miners._types import S19Pro  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X19/S19a.py
+++ b/pyasic/miners/antminer/bmminer/X19/S19a.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X19 import BMMinerX19
 from pyasic.miners._types import S19a  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X19/S19j.py
+++ b/pyasic/miners/antminer/bmminer/X19/S19j.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X19 import BMMinerX19
 from pyasic.miners._types import S19j  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X19/S19j_Pro.py
+++ b/pyasic/miners/antminer/bmminer/X19/S19j_Pro.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X19 import BMMinerX19
 from pyasic.miners._types import S19jPro  # noqa - Ignore access to _module

--- a/pyasic/miners/antminer/bmminer/X19/T19.py
+++ b/pyasic/miners/antminer/bmminer/X19/T19.py
@@ -1,3 +1,17 @@
+#  Copyright 2022 Upstream Data Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
 from .X19 import BMMinerX19
 from pyasic.miners._types import T19  # noqa - Ignore access to _module

--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
UpstreamData	b7d4891140	bump version number	2022-08-09 11:12:10 -06:00
UpstreamData	5f5cbd9060	add support for setting X19 web passwords and X17 web passwords.	2022-08-09 11:04:08 -06:00
UpstreamData	8379359caf	update documentation and make BaseMiner and BaseMinerAPI unable to be instantiated directly. Add more unittests for miners.	2022-08-08 13:19:59 -06:00
UpstreamData	62238192ce	bump version number	2022-08-05 16:34:00 -06:00
UpstreamData	1997003643	fix a bug with whatsminer crashing if hitting a S19 condition	2022-08-05 16:33:40 -06:00
UpstreamData	3a81844898	bump version number	2022-08-05 12:12:25 -06:00
UpstreamData	0ac80fb205	fix a bug with vnish miner identification	2022-08-05 12:12:10 -06:00
UpstreamData	9494018c12	bump version number	2022-08-05 12:08:05 -06:00
UpstreamData	0bc86c98c5	add support for some X19 models running vnish to be able to get miner type from them	2022-08-05 12:07:33 -06:00
UpstreamData	f0d69c9ca7	bump version number	2022-08-05 10:23:22 -06:00
UpstreamData	b81590bd2e	add support for X19 miner errors codes shown on their dashboard	2022-08-05 10:23:03 -06:00
UpstreamData	a53e01df6f	bump version number	2022-08-02 08:19:03 -06:00
UpstreamData	f63e063954	fix a bug with not capitalizing BITMAIN for a model check	2022-08-02 08:18:46 -06:00
upstreamdata	9cbaf7076a	bump version number	2022-07-28 12:29:24 -06:00
upstreamdata	daa5ac5870	fixed a bug with capitalization of "Pro" in antminer models	2022-07-28 12:28:55 -06:00
upstreamdata	0b8c08016b	bump version number.	2022-07-27 23:48:42 -06:00
upstreamdata	8c768d351b	fix a bug with braiinsOS+ miners which return with a capital letter in their model instead of a lowercase letter.	2022-07-27 23:44:19 -06:00
UpstreamData	c9e7fa2629	bump version number	2022-07-22 13:05:13 -06:00
UpstreamData	9d3f2b5968	add support for M20 versions and update docs	2022-07-22 13:04:47 -06:00
UpstreamData	283e3d5e11	bump version number	2022-07-21 08:43:30 -06:00
UpstreamData	add4b575c2	update shields and improve typing and handling of fault light checks	2022-07-21 08:42:35 -06:00
UpstreamData	af2f1e9ad5	misc docs changes	2022-07-20 14:54:59 -06:00
UpstreamData	8258320a7b	fix a bug with avalonminer imports and bump version number	2022-07-20 14:42:33 -06:00
UpstreamData	a5dc7f485b	bump version number	2022-07-20 14:37:04 -06:00
UpstreamData	025b5bf6f0	improved avalonminer handler and added fault light to get_data	2022-07-20 14:36:13 -06:00
UpstreamData	3d3064d78e	improve some type hinting compatibility	2022-07-20 11:19:13 -06:00
UpstreamData	2e3991355b	Update README.md	2022-07-20 10:05:23 -06:00
UpstreamData	73a4cf5834	bump version number	2022-07-19 16:16:56 -06:00
UpstreamData	b120064e80	fixed a bug with miner factory not handling ConnectionRefused errors properly	2022-07-19 16:16:36 -06:00
UpstreamData	3ec833e700	add copyright license, using Apache 2.0 license	2022-07-19 15:43:24 -06:00
UpstreamData	29aeea1194	bump version number	2022-07-19 13:02:55 -06:00
UpstreamData	994d53ae3b	removed arbitrary scan thread limitation dividing	2022-07-19 13:01:39 -06:00
UpstreamData	a95333eb1c	removed arbitrary scan thread limitation dividing	2022-07-19 13:01:28 -06:00
UpstreamData	c5f2d71791	improved the speed of scanning by only checking secondary ports if the 4028 connection is refused	2022-07-19 13:00:15 -06:00
UpstreamData	26ae6ebfb2	bump version number	2022-07-19 11:19:32 -06:00
UpstreamData	e65cb0573d	update miner factory to handle some types of stock fw S9s	2022-07-19 11:18:55 -06:00
UpstreamData	f8590b0c5f	improve more typing	2022-07-18 14:46:17 -06:00
UpstreamData	43b4992cee	improve logging and some documentation	2022-07-18 14:38:54 -06:00
UpstreamData	98e2cfae84	bump version number	2022-07-18 12:05:44 -06:00
UpstreamData	cb01c1a8ee	update network to scan fast even if some miners are not responding properly	2022-07-18 12:05:22 -06:00
UpstreamData	36a273ec2b	bump version number	2022-07-18 11:45:14 -06:00
UpstreamData	6a0dc03b9d	update to a better way to handle settings	2022-07-18 11:44:22 -06:00