bump version number

LICENSE.txt

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

README.md

@@ -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/)
 

docs/API/api.md

@@ -0,0 +1,24 @@
+# pyasic
+## Miner APIs
+Each miner has a unique API that is used to communicate with it.
+Each of these API types has commands that differ between them, and some commands have data that others do not.
+Each miner that is a subclass of `BaseMiner` 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).
+Use these instead -
+
+#### [BMMiner API][pyasic.API.bmminer.BMMinerAPI]
+#### [BOSMiner API][pyasic.API.bosminer.BOSMinerAPI]
+#### [BTMiner API][pyasic.API.btminer.BTMinerAPI]
+#### [CGMiner API][pyasic.API.cgminer.CGMinerAPI]
+#### [Unknown API][pyasic.API.unknown.UnknownAPI]
+
+<br>
+
+## BaseMinerAPI
+::: pyasic.API.BaseMinerAPI
+    handler: python
+    options:
+        heading_level: 4

docs/API/bmminer.md

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

docs/API/bosminer.md

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

docs/API/btminer.md

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

docs/API/cgminer.md

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

docs/API/unknown.md

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

docs/api.md

@@ -1,42 +0,0 @@
-# pyasic
-## Miner APIs
-Each miner has a unique API that is used to communicate with it.
-Each of these API types has commands that differ between them, and some commands have data that others do not.
-Each miner that is a subclass of `BaseMiner` should have an API linked to it as `Miner.api`.
-
-All API implementations inherit from `BaseMinerAPI`, which implements the basic communications protocols.
-
-## BMMinerAPI
-::: pyasic.API.bmminer.BMMinerAPI
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## BOSMinerAPI
-::: pyasic.API.bosminer.BOSMinerAPI
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## BTMinerAPI
-::: pyasic.API.btminer.BTMinerAPI
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## CGMinerAPI
-::: pyasic.API.cgminer.CGMinerAPI
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4
-
-## UnknownAPI
-::: pyasic.API.unknown.UnknownAPI
-    handler: python
-    options:
-        show_root_heading: false
-        heading_level: 4

docs/config/miner_config.md

@@ -0,0 +1,24 @@
+# pyasic
+## Miner Config
+
+::: pyasic.config.MinerConfig
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## Pool Groups
+
+::: pyasic.config._PoolGroup
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## Pools
+
+::: pyasic.config._Pool
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/index.md

@@ -5,10 +5,14 @@
 [![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.
 
+[Supported Miner Types](miners/supported_types.md)
+
 Getting started with pyasic is easy.  First, find your miner (or miners) on the network by scanning for them or getting the correct class automatically for them if you know the IP.
 
 <br>

docs/miners/antminer/X17.md

@@ -0,0 +1,59 @@
+# pyasic
+## X17 Models
+
+## S17
+
+::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S17+
+
+::: pyasic.miners.antminer.bmminer.X17.S17_Plus.BMMinerS17Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S17 Pro
+
+::: pyasic.miners.antminer.bmminer.X17.S17_Pro.BMMinerS17Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S17e
+
+::: pyasic.miners.antminer.bmminer.X17.S17e.BMMinerS17e
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T17
+
+::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T17+
+
+::: pyasic.miners.antminer.bmminer.X17.T17_Plus.BMMinerT17Plus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+
+## T17e
+
+::: pyasic.miners.antminer.bmminer.X17.T17e.BMMinerT17e
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/miners/antminer/X19.md

@@ -0,0 +1,52 @@
+# pyasic
+## X19 Models
+
+## S19
+
+::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19 Pro
+
+::: pyasic.miners.antminer.bmminer.X19.S19_Pro.BMMinerS19Pro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+
+## S19a
+
+::: pyasic.miners.antminer.bmminer.X19.S19a.BMMinerS19a
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+
+## S19j
+
+::: pyasic.miners.antminer.bmminer.X19.S19j.BMMinerS19j
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S19j Pro
+
+::: pyasic.miners.antminer.bmminer.X19.S19j_Pro.BMMinerS19jPro
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T19
+
+::: pyasic.miners.antminer.bmminer.X19.T19.BMMinerT19
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/miners/antminer/X9.md

@@ -0,0 +1,26 @@
+# pyasic
+## X9 Models
+
+## S9
+
+::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## S9i
+
+::: pyasic.miners.antminer.bmminer.X9.S9i.BMMinerS9i
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## T9
+
+::: pyasic.miners.antminer.bmminer.X9.T9.BMMinerT9
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/miners/avalonminer/A10X.md

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

docs/miners/avalonminer/A7X.md

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

docs/miners/avalonminer/A8X.md

@@ -0,0 +1,26 @@
+# pyasic
+## A8X Models
+
+## A821
+
+::: pyasic.miners.avalonminer.cgminer.A8X.A821.CGMinerAvalon821
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## A841
+
+::: pyasic.miners.avalonminer.cgminer.A8X.A841.CGMinerAvalon841
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## A851
+
+::: pyasic.miners.avalonminer.cgminer.A8X.A851.CGMinerAvalon851
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/miners/avalonminer/A9X.md

@@ -0,0 +1,10 @@
+# pyasic
+## A9X Models
+
+## A921
+
+::: pyasic.miners.avalonminer.cgminer.A9X.A921.CGMinerAvalon921
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/miners/backends/bmminer.md

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

docs/miners/backends/bosminer.md

@@ -0,0 +1,8 @@
+# pyasic
+## BOSMiner Backend
+
+::: pyasic.miners._backends.bosminer.BOSMiner
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/miners/backends/btminer.md

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

docs/miners/backends/cgminer.md

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

docs/miners/backends/hiveon.md

@@ -0,0 +1,8 @@
+# pyasic
+## Hiveon Backend
+
+::: pyasic.miners._backends.hiveon.Hiveon
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/miners/supported_types.md

@@ -0,0 +1,75 @@
+# pyasic
+## Supported Miners
+
+Supported miner types are here on this list.  If your miner (or miner version) is not on this list, please feel free to [open an issue on GitHub](https://github.com/UpstreamData/pyasic/issues) to get it added.
+
+## Miner List
+
+##### pyasic currently supports the following miners and subtypes:
+* Braiins OS+ Devices:
+    * All devices supported by BraiinsOS+ are supported here.
+* Stock Firmware Whatsminers:
+    * M3X Series:
+        * [M30S][pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30S]:
+            * [VE10][pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SVE10]
+            * [VG20][pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SVG20]
+            * [VE20][pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SVE20]
+            * [V50][pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SV50]
+        * [M30S+][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlus]:
+            * [VF20][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlusVF20]
+            * [VE40][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlusVE40]
+            * [VG60][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlusVG60]
+        * [M30S++][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus_Plus.BTMinerM30SPlusPlus]:
+            * [VG30][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus_Plus.BTMinerM30SPlusPlusVG30]
+            * [VG40][pyasic.miners.whatsminer.btminer.M3X.M30S_Plus_Plus.BTMinerM30SPlusPlusVG40]
+        * [M31S][pyasic.miners.whatsminer.btminer.M3X.M31S.BTMinerM31S]
+        * [M31S+][pyasic.miners.whatsminer.btminer.M3X.M31S_Plus.BTMinerM31SPlus]:
+            * [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]
+        * [M20S+][pyasic.miners.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlus]
+        * [M21][pyasic.miners.whatsminer.btminer.M2X.M21.BTMinerM21]
+        * [M21S][pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21S]:
+            * [V20][pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV20]
+            * [V60][pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV60]
+        * [M21S+][pyasic.miners.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlus]
+* Stock Firmware Antminers:
+    * X19 Series:
+        * [S19][pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19]
+        * [S19 Pro][pyasic.miners.antminer.bmminer.X19.S19_Pro.BMMinerS19Pro]
+        * [S19a][pyasic.miners.antminer.bmminer.X19.S19a.BMMinerS19a]
+        * [S19j][pyasic.miners.antminer.bmminer.X19.S19j.BMMinerS19j]
+        * [S19j Pro][pyasic.miners.antminer.bmminer.X19.S19j_Pro.BMMinerS19jPro]
+        * [T19][pyasic.miners.antminer.bmminer.X19.T19.BMMinerT19]
+    * X17 Series:
+        * [S17][pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17]
+        * [S17+][pyasic.miners.antminer.bmminer.X17.S17_Plus.BMMinerS17Plus]
+        * [S17 Pro][pyasic.miners.antminer.bmminer.X17.S17_Pro.BMMinerS17Pro]
+        * [S17e][pyasic.miners.antminer.bmminer.X17.S17e.BMMinerS17e]
+        * [T17][pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17]
+        * [T17+][pyasic.miners.antminer.bmminer.X17.T17_Plus.BMMinerT17Plus]
+        * [T17e][pyasic.miners.antminer.bmminer.X17.T17e.BMMinerT17e]
+    * X9 Series:
+        * [S9][pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9]
+        * [S9i][pyasic.miners.antminer.bmminer.X9.S9i.BMMinerS9i]
+        * [T9][pyasic.miners.antminer.bmminer.X9.T9.BMMinerT9]
+* Stock Firmware Avalonminers:
+    * A7X Series:
+        * [A721][pyasic.miners.avalonminer.cgminer.A7X.A721.CGMinerAvalon721]
+        * [A741][pyasic.miners.avalonminer.cgminer.A7X.A741.CGMinerAvalon741]
+        * [A761][pyasic.miners.avalonminer.cgminer.A7X.A761.CGMinerAvalon761]
+    * A8X Series:
+        * [A821][pyasic.miners.avalonminer.cgminer.A8X.A821.CGMinerAvalon821]
+        * [A841][pyasic.miners.avalonminer.cgminer.A8X.A841.CGMinerAvalon841]
+        * [A851][pyasic.miners.avalonminer.cgminer.A8X.A851.CGMinerAvalon851]
+    * A9X Series:
+        * [A921][pyasic.miners.avalonminer.cgminer.A9X.A921.CGMinerAvalon921]
+    * A10X Series:
+        * [A1026][pyasic.miners.avalonminer.cgminer.A10X.A1026.CGMinerAvalon1026]
+        * [A1047][pyasic.miners.avalonminer.cgminer.A10X.A1047.CGMinerAvalon1047]
+        * [A1066][pyasic.miners.avalonminer.cgminer.A10X.A1066.CGMinerAvalon1066]

docs/miners/whatsminer/M2X.md

@@ -0,0 +1,91 @@
+# 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
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M20SV10
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M20SV20
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M20S+
+
+::: pyasic.miners.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M21
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21.BTMinerM21
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+
+## M21S
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21S
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M21SV20
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M21SV60
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV60
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M21S+
+
+::: pyasic.miners.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/miners/whatsminer/M3X.md

@@ -0,0 +1,131 @@
+# pyasic
+## M3X Models
+
+## M30S
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30S
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30SVE10
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SVE10
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30SVG20
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SVG20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30SVE20
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SVE20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30SV50
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S.BTMinerM30SV50
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30S+
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30S+VF20
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlusVF20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30S+VE40
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlusVE40
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30S+VG60
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S_Plus.BTMinerM30SPlusVG60
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30S++
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S_Plus_Plus.BTMinerM30SPlusPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30S++VG30
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S_Plus_Plus.BTMinerM30SPlusPlusVG30
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M30S+VG40
+
+::: pyasic.miners.whatsminer.btminer.M3X.M30S_Plus_Plus.BTMinerM30SPlusPlusVG40
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+
+## M31S
+
+::: pyasic.miners.whatsminer.btminer.M3X.M31S.BTMinerM31S
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M31S+
+
+::: pyasic.miners.whatsminer.btminer.M3X.M31S_Plus.BTMinerM31SPlus
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M31S+VE20
+
+::: pyasic.miners.whatsminer.btminer.M3X.M31S_Plus.BTMinerM31SPlusVE20
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## M32S
+
+::: pyasic.miners.whatsminer.btminer.M3X.M32S.BTMinerM32S
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/network/miner_network_range.md

@@ -0,0 +1,12 @@
+# pyasic
+## Miner Network Range
+
+`MinerNetworkRange` is a class used by [`MinerNetwork`][pyasic.network.MinerNetwork] to handle any constructor stings.
+The goal is to emulate what is produced by `ipaddress.ip_network` by allowing [`MinerNetwork`][pyasic.network.MinerNetwork] to get a list of hosts.
+This allows this class to be the [`MinerNetwork.network`][pyasic.network.MinerNetwork] and hence be used for scanning.
+
+::: pyasic.network.net_range.MinerNetworkRange
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

mkdocs.yml

@@ -2,12 +2,42 @@ site_name: pyasic
 repo_url: https://github.com/UpstreamData/pyasic
 nav:
   - Introduction: "index.md"
-  - Usage:
-      - Miner Factory: "miner_factory.md"
-      - Miner Network: "miner_network.md"
-      - Miner Data: "miner_data.md"
+  - Miners:
+      - Supported Miners: "miners/supported_types.md"
+      - Miner Factory: "miners/miner_factory.md"
+      - Backends:
+          - BMMiner: "miners/backends/bmminer.md"
+          - BOSMiner: "miners/backends/bosminer.md"
+          - BTMiner: "miners/backends/btminer.md"
+          - CGMiner: "miners/backends/cgminer.md"
+          - Hiveon: "miners/backends/hiveon.md"
+
+      - Classes:
+          - Antminer X9: "miners/antminer/X9.md"
+          - Antminer X17: "miners/antminer/X17.md"
+          - Antminer X19: "miners/antminer/X19.md"
+          - Avalon 7X: "miners/avalonminer/A7X.md"
+          - Avalon 8X: "miners/avalonminer/A8X.md"
+          - Avalon 9X: "miners/avalonminer/A9X.md"
+          - Avalon 10X: "miners/avalonminer/A10X.md"
+          - Whatsminer M2X: "miners/whatsminer/M2X.md"
+          - Whatsminer M3X: "miners/whatsminer/M3X.md"
+
+  - Network:
+      - Miner Network: "network/miner_network.md"
+      - Miner Network Range: "network/miner_network_range.md"
+  - Data:
+      - Miner Data: "data/miner_data.md"
+  - Config:
+      - Miner Config: "config/miner_config.md"
   - Advanced:
-      - API: "api.md"
+      - Miner APIs:
+          - Base: "API/api.md"
+          - BMMiner: "API/bmminer.md"
+          - BOSMiner: "API/bosminer.md"
+          - BTMiner: "API/btminer.md"
+          - CGMiner: "API/cgminer.md"
+          - Unknown: "API/unknown.md"
 
 plugins:
   - mkdocstrings

pyasic/API/__init__.py

@@ -1,8 +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 asyncio
 import json
 import ipaddress
 import warnings
 import logging
+from typing import Union
 
 
 class APIError(Exception):
@@ -41,7 +56,11 @@ class BaseMinerAPI:
         self.ip = ipaddress.ip_address(ip)
 
     def get_commands(self) -> list:
-        """Get a list of command accessible to a specific type of API on the miner."""
+        """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
@@ -59,51 +78,75 @@ 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,
-        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,
         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)
@@ -115,7 +158,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
@@ -133,9 +176,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()
@@ -144,7 +187,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]}")
@@ -153,8 +196,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():
@@ -181,8 +223,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

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
 
 

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
 
 

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
@@ -10,7 +24,7 @@ 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,7 +175,12 @@ 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
@@ -204,7 +223,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 +239,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])
 

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
 
 

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
 
 

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.

pyasic/config/__init__.py

@@ -1,5 +1,19 @@
+#  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 List, Literal
+from typing import Literal, List
 import random
 import string
 
@@ -13,9 +27,10 @@ import time
 class _Pool:
     """A dataclass for pool information.
 
-    :param url: URL of the pool.
-    :param username: Username on the pool.
-    :param password: Worker password on the pool.
+    Attributes:
+        url: URL of the pool.
+        username: Username on the pool.
+        password: Worker password on the pool.
     """
 
     url: str = ""
@@ -25,7 +40,8 @@ class _Pool:
     def from_dict(self, data: dict):
         """Convert raw pool data as a dict to usable data and save it to this class.
 
-        :param data: The raw config data to convert.
+        Parameters:
+             data: The raw config data to convert.
         """
         for key in data.keys():
             if key == "url":
@@ -36,10 +52,11 @@ class _Pool:
                 self.password = data[key]
         return self
 
-    def as_x19(self, user_suffix: str = None):
+    def as_x19(self, user_suffix: str = None) -> dict:
         """Convert the data in this class to a dict usable by an X19 device.
 
-        :param user_suffix: The suffix to append to username.
+        Parameters:
+             user_suffix: The suffix to append to username.
         """
         username = self.username
         if user_suffix:
@@ -48,7 +65,12 @@ class _Pool:
         pool = {"url": self.url, "user": username, "pass": self.password}
         return pool
 
-    def as_avalon(self, user_suffix: str = None):
+    def as_avalon(self, user_suffix: str = None) -> str:
+        """Convert the data in this class to a string usable by an Avalonminer device.
+
+        Parameters:
+             user_suffix: The suffix to append to username.
+        """
         username = self.username
         if user_suffix:
             username = f"{username}{user_suffix}"
@@ -56,10 +78,11 @@ class _Pool:
         pool = ",".join([self.url, username, self.password])
         return pool
 
-    def as_bos(self, user_suffix: str = None):
+    def as_bos(self, user_suffix: str = None) -> dict:
         """Convert the data in this class to a dict usable by an BOSMiner device.
 
-        :param user_suffix: The suffix to append to username.
+        Parameters:
+            user_suffix: The suffix to append to username.
         """
         username = self.username
         if user_suffix:
@@ -73,9 +96,10 @@ class _Pool:
 class _PoolGroup:
     """A dataclass for pool group information.
 
-    :param quota: The group quota.
-    :param group_name: The name of the pool group.
-    :param pools: A list of pools in this group.
+    Attributes:
+        quota: The group quota.
+        group_name: The name of the pool group.
+        pools: A list of pools in this group.
     """
 
     quota: int = 1
@@ -91,7 +115,8 @@ class _PoolGroup:
     def from_dict(self, data: dict):
         """Convert raw pool group data as a dict to usable data and save it to this class.
 
-        :param data: The raw config data to convert.
+        Parameters:
+             data: The raw config data to convert.
         """
         pools = []
         for key in data.keys():
@@ -105,24 +130,31 @@ class _PoolGroup:
         self.pools = pools
         return self
 
-    def as_x19(self, user_suffix: str = None):
-        """Convert the data in this class to a dict usable by an X19 device.
+    def as_x19(self, user_suffix: str = None) -> List[dict]:
+        """Convert the data in this class to a list usable by an X19 device.
 
-        :param user_suffix: The suffix to append to username.
+        Parameters:
+             user_suffix: The suffix to append to username.
         """
         pools = []
         for pool in self.pools[:3]:
             pools.append(pool.as_x19(user_suffix=user_suffix))
         return pools
 
-    def as_avalon(self, user_suffix: str = None):
+    def as_avalon(self, user_suffix: str = None) -> str:
+        """Convert the data in this class to a dict usable by an Avalonminer device.
+
+        Parameters:
+             user_suffix: The suffix to append to username.
+        """
         pool = self.pools[0].as_avalon(user_suffix=user_suffix)
         return pool
 
-    def as_bos(self, user_suffix: str = None):
+    def as_bos(self, user_suffix: str = None) -> dict:
         """Convert the data in this class to a dict usable by an BOSMiner device.
 
-        :param user_suffix: The suffix to append to username.
+        Parameters:
+             user_suffix: The suffix to append to username.
         """
         group = {
             "name": self.group_name,
@@ -136,21 +168,22 @@ class _PoolGroup:
 class MinerConfig:
     """A dataclass for miner configuration information.
 
-    :param pool_groups: A list of pool groups in this config.
-    :param temp_mode: The temperature control mode.
-    :param temp_target: The target temp.
-    :param temp_hot: The hot temp (100% fans).
-    :param temp_dangerous: The dangerous temp (shutdown).
-    :param minimum_fans: The minimum numbers of fans to run the miner.
-    :param fan_speed: Manual fan speed to run the fan at (only if temp_mode == "manual").
-    :param asicboost: Whether or not to enable asicboost.
-    :param autotuning_enabled: Whether or not to enable autotuning.
-    :param autotuning_wattage: The wattage to use when autotuning.
-    :param dps_enabled: Whether or not to enable dynamic power scaling.
-    :param dps_power_step: The amount of power to reduce autotuning by when the miner reaches dangerous temp.
-    :param dps_min_power: The minimum power to reduce autotuning to.
-    :param dps_shutdown_enabled: Whether or not to shutdown the miner when `dps_min_power` is reached.
-    :param dps_shutdown_duration: The amount of time to shutdown for (in hours).
+    Attributes:
+        pool_groups: A list of pool groups in this config.
+        temp_mode: The temperature control mode.
+        temp_target: The target temp.
+        temp_hot: The hot temp (100% fans).
+        temp_dangerous: The dangerous temp (shutdown).
+        minimum_fans: The minimum numbers of fans to run the miner.
+        fan_speed: Manual fan speed to run the fan at (only if temp_mode == "manual").
+        asicboost: Whether or not to enable asicboost.
+        autotuning_enabled: Whether or not to enable autotuning.
+        autotuning_wattage: The wattage to use when autotuning.
+        dps_enabled: Whether or not to enable dynamic power scaling.
+        dps_power_step: The amount of power to reduce autotuning by when the miner reaches dangerous temp.
+        dps_min_power: The minimum power to reduce autotuning to.
+        dps_shutdown_enabled: Whether or not to shutdown the miner when `dps_min_power` is reached.
+        dps_shutdown_duration: The amount of time to shutdown for (in hours).
     """
 
     pool_groups: List[_PoolGroup] = None
@@ -174,27 +207,28 @@ class MinerConfig:
     dps_shutdown_enabled: bool = None
     dps_shutdown_duration: float = None
 
-    def as_dict(self):
+    def as_dict(self) -> dict:
         """Convert the data in this class to a dict."""
-
         data_dict = asdict(self)
         for key in asdict(self).keys():
             if data_dict[key] is None:
                 del data_dict[key]
         return data_dict
 
-    def as_toml(self):
+    def as_toml(self) -> str:
         """Convert the data in this class to toml."""
         return toml.dumps(self.as_dict())
 
-    def as_yaml(self):
+    def as_yaml(self) -> str:
         """Convert the data in this class to yaml."""
         return yaml.dump(self.as_dict(), sort_keys=False)
 
     def from_raw(self, data: dict):
         """Convert raw config data as a dict to usable data and save it to this class.
+        This should be able to handle any raw config file from any miner supported by pyasic.
 
-        :param data: The raw config data to convert.
+        Parameters:
+             data: The raw config data to convert.
         """
         pool_groups = []
         for key in data.keys():
@@ -256,7 +290,8 @@ class MinerConfig:
     def from_dict(self, data: dict):
         """Convert an output dict of this class back into usable data and save it to this class.
 
-        :param data: The raw config data to convert.
+        Parameters:
+            data: The dict config data to convert.
         """
         pool_groups = []
         for group in data["pool_groups"]:
@@ -270,21 +305,24 @@ class MinerConfig:
     def from_toml(self, data: str):
         """Convert output toml of this class back into usable data and save it to this class.
 
-        :param data: The raw config data to convert.
+        Parameters:
+            data: The toml config data to convert.
         """
         return self.from_dict(toml.loads(data))
 
     def from_yaml(self, data: str):
         """Convert output yaml of this class back into usable data and save it to this class.
 
-        :param data: The raw config data to convert.
+        Parameters:
+            data: The yaml config data to convert.
         """
         return self.from_dict(yaml.load(data, Loader=yaml.SafeLoader))
 
     def as_x19(self, user_suffix: str = None) -> str:
         """Convert the data in this class to a config usable by an X19 device.
 
-        :param user_suffix: The suffix to append to username.
+        Parameters:
+            user_suffix: The suffix to append to username.
         """
         cfg = {
             "pools": self.pool_groups[0].as_x19(user_suffix=user_suffix),
@@ -301,14 +339,20 @@ class MinerConfig:
         return json.dumps(cfg)
 
     def as_avalon(self, user_suffix: str = None) -> str:
-        cfg = self.pool_groups[0].as_avalon()
+        """Convert the data in this class to a config usable by an Avalonminer device.
+
+        Parameters:
+            user_suffix: The suffix to append to username.
+        """
+        cfg = self.pool_groups[0].as_avalon(user_suffix=user_suffix)
         return cfg
 
     def as_bos(self, model: str = "S9", user_suffix: str = None) -> str:
         """Convert the data in this class to a config usable by an BOSMiner device.
 
-        :param model: The model of the miner to be used in the format portion of the config.
-        :param user_suffix: The suffix to append to username.
+        Parameters:
+            model: The model of the miner to be used in the format portion of the config.
+            user_suffix: The suffix to append to username.
         """
         cfg = {
             "format": {

pyasic/data/__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 typing import Union
 from dataclasses import dataclass, field, asdict
 from datetime import datetime
 
@@ -34,7 +49,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 +57,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
@@ -80,6 +96,7 @@ class MinerData:
     pool_2_url: str = ""
     pool_2_user: str = ""
     errors: list = field(default_factory=list)
+    fault_light: Union[bool, None] = None
 
     def __post_init__(self):
         self.datetime = datetime.now()

pyasic/data/error_codes/X19.py

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

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

pyasic/data/error_codes/bos.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
 
 

pyasic/data/error_codes/whatsminer.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, field, asdict
 
 

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:

pyasic/miners/__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 asyncssh
 import logging
 import ipaddress
@@ -54,13 +68,11 @@ 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
 
     async def fault_light_on(self) -> bool:
@@ -100,5 +112,8 @@ class BaseMiner:
     async def get_mac(self):
         return None
 
+    async def get_errors(self):
+        return None
+
     async def get_data(self) -> MinerData:
         return MinerData(ip=str(self.ip))

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

pyasic/miners/_backends/bmminer.py

@@ -1,5 +1,20 @@
+#  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
 
 
 from pyasic.API.bmminer import BMMinerAPI
@@ -7,10 +22,12 @@ 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):
+    """Base handler for BMMiner based miners."""
+
     def __init__(self, ip: str) -> None:
         super().__init__(ip)
         self.ip = ipaddress.ip_address(ip)
@@ -19,10 +36,11 @@ class BMMiner(BaseMiner):
         self.uname = "root"
         self.pwd = "admin"
 
-    async def get_model(self) -> str or None:
+    async def get_model(self) -> Union[str, None]:
         """Get miner model.
 
-        :return: Miner model or None.
+        Returns:
+            Miner model or None.
         """
         # check if model is cached
         if self.model:
@@ -46,7 +64,8 @@ class BMMiner(BaseMiner):
     async def get_hostname(self) -> str:
         """Get miner hostname.
 
-        :return: The hostname of the miner as a string or "?"
+        Returns:
+            The hostname of the miner as a string or "?"
         """
         if self.hostname:
             return self.hostname
@@ -72,12 +91,14 @@ class BMMiner(BaseMiner):
             logging.warning(f"Failed to get hostname for miner: {self}")
             return "?"
 
-    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.
 
-        :param cmd: The command to run.
+        Parameters:
+            cmd: The command to run.
 
-        :return: Result of the command or None.
+        Returns:
+            Result of the command or None.
         """
         result = None
 
@@ -101,10 +122,11 @@ class BMMiner(BaseMiner):
         # return the result, either command output or None
         return result
 
-    async def get_config(self) -> list or None:
+    async def get_config(self) -> Union[list, None]:
         """Get the pool configuration of the miner.
 
-        :return: Pool config data or None.
+        Returns:
+             Pool config data or None.
         """
         # get pool data
         pools = await self.api.pools()
@@ -120,6 +142,11 @@ class BMMiner(BaseMiner):
         return pool_data
 
     async def reboot(self) -> bool:
+        """Reboot the miner.
+
+        Returns:
+            The result of rebooting the miner.
+        """
         logging.debug(f"{self}: Sending reboot command.")
         _ret = await self.send_ssh_command("reboot")
         logging.debug(f"{self}: Reboot command completed.")
@@ -128,6 +155,11 @@ class BMMiner(BaseMiner):
         return False
 
     async def get_data(self) -> MinerData:
+        """Get data from the miner.
+
+        Returns:
+            A [`MinerData`][pyasic.data.MinerData] instance containing the miners data.
+        """
         data = MinerData(ip=str(self.ip), ideal_chips=self.nominal_chips * 3)
 
         board_offset = -1
@@ -136,6 +168,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
@@ -146,8 +179,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
             )

pyasic/miners/_backends/bosminer.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 ipaddress
 import logging
 import json
+from typing import Union
 
 import toml
 
@@ -14,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):
@@ -27,10 +42,11 @@ class BOSMiner(BaseMiner):
         self.pwd = "admin"
         self.config = None
 
-    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.
+        Returns:
+            Result of the command or None.
         """
         result = None
 
@@ -74,6 +90,7 @@ class BOSMiner(BaseMiner):
         return False
 
     async def restart_backend(self) -> bool:
+        """Restart bosminer hashing process.  Wraps [`restart_bosminer`][pyasic.miners._backends.bosminer.BOSMiner.restart_bosminer] to standardize."""
         return await self.restart_bosminer()
 
     async def restart_bosminer(self) -> bool:
@@ -94,7 +111,12 @@ class BOSMiner(BaseMiner):
             return True
         return False
 
-    async def get_config(self) -> None:
+    async def get_config(self) -> MinerConfig:
+        """Gets the config for the miner and sets it as `self.config`.
+
+        Returns:
+            The config from `self.config`.
+        """
         logging.debug(f"{self}: Getting config.")
         async with (await self._get_ssh_connection()) as conn:
             logging.debug(f"{self}: Opening SFTP connection.")
@@ -110,7 +132,8 @@ class BOSMiner(BaseMiner):
     async def get_hostname(self) -> str:
         """Get miner hostname.
 
-        :return: The hostname of the miner as a string or "?"
+        Returns:
+            The hostname of the miner as a string or "?"
         """
         if self.hostname:
             return self.hostname
@@ -129,10 +152,11 @@ class BOSMiner(BaseMiner):
             logging.warning(f"Failed to get hostname for miner: {self}")
             return "?"
 
-    async def get_model(self) -> str or None:
+    async def get_model(self) -> Union[str, None]:
         """Get miner model.
 
-        :return: Miner model or None.
+        Returns:
+            Miner model or None.
         """
         # check if model is cached
         if self.model:
@@ -166,10 +190,11 @@ class BOSMiner(BaseMiner):
         logging.warning(f"Failed to get model for miner: {self}")
         return None
 
-    async def get_version(self):
+    async def get_version(self) -> Union[str, None]:
         """Get miner firmware version.
 
-        :return: Miner firmware version or None.
+        Returns:
+            Miner firmware version or None.
         """
         # check if version is cached
         if self.version:
@@ -206,65 +231,21 @@ 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")
-
-    async def get_board_info(self) -> dict:
-        """Gets data on each board and chain in the miner."""
-        logging.debug(f"{self}: Getting board info.")
-        devdetails = await self.api.devdetails()
-        if not devdetails.get("DEVDETAILS"):
-            print("devdetails error", devdetails)
-            return {0: [], 1: [], 2: []}
-        devs = devdetails["DEVDETAILS"]
-        boards = {}
-        offset = devs[0]["ID"]
-        for board in devs:
-            boards[board["ID"] - offset] = []
-            if not board["Chips"] == self.nominal_chips:
-                nominal = False
-            else:
-                nominal = True
-            boards[board["ID"] - offset].append(
-                {
-                    "chain": board["ID"] - offset,
-                    "chip_count": board["Chips"],
-                    "chip_status": "o" * board["Chips"],
-                    "nominal": nominal,
-                }
-            )
-        logging.debug(f"Found board data for {self}: {boards}")
-        return boards
-
-    async def get_bad_boards(self) -> dict:
-        """Checks for and provides list of non working boards."""
-        boards = await self.get_board_info()
-        bad_boards = {}
-        for board in boards.keys():
-            for chain in boards[board]:
-                if not chain["chip_count"] == 63:
-                    if board not in bad_boards.keys():
-                        bad_boards[board] = []
-                    bad_boards[board].append(chain)
-        return bad_boards
-
-    async def check_good_boards(self) -> str:
-        """Checks for and provides list for working boards."""
-        devs = await self.api.devdetails()
-        bad = 0
-        chains = devs["DEVDETAILS"]
-        for chain in chains:
-            if chain["Chips"] == 0:
-                bad += 1
-        if not bad > 0:
-            return str(self.ip)
+            await conn.run("/etc/init.d/bosminer start")
 
     async def get_data(self) -> MinerData:
+        """Get data from the miner.
+
+        Returns:
+            A [`MinerData`][pyasic.data.MinerData] instance containing the miners data.
+        """
         data = MinerData(ip=str(self.ip), ideal_chips=self.nominal_chips * 3)
 
         board_offset = -1
@@ -283,8 +264,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",

pyasic/miners/_backends/bosminer_old.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 logging
 
 import ipaddress
@@ -44,7 +58,6 @@ 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

pyasic/miners/_backends/btminer.py

@@ -1,5 +1,20 @@
+#  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
 
 
 from pyasic.API.btminer import BTMinerAPI
@@ -9,7 +24,7 @@ from pyasic.API import APIError
 from pyasic.data import MinerData
 from pyasic.data.error_codes import WhatsminerError
 
-from pyasic.settings import MINER_FACTORY_GET_VERSION_RETRIES as DATA_RETRIES
+from pyasic.settings import PyasicSettings
 
 
 class BTMiner(BaseMiner):
@@ -19,7 +34,12 @@ class BTMiner(BaseMiner):
         self.api = BTMinerAPI(ip)
         self.api_type = "BTMiner"
 
-    async def get_model(self):
+    async def get_model(self) -> Union[str, None]:
+        """Get miner model.
+
+        Returns:
+            Miner model or None.
+        """
         if self.model:
             logging.debug(f"Found model for {self.ip}: {self.model}")
             return self.model
@@ -31,7 +51,12 @@ class BTMiner(BaseMiner):
         logging.warning(f"Failed to get model for miner: {self}")
         return None
 
-    async def get_hostname(self) -> str or None:
+    async def get_hostname(self) -> Union[str, None]:
+        """Get miner hostname.
+
+        Returns:
+            The hostname of the miner as a string or None.
+        """
         if self.hostname:
             return self.hostname
         try:
@@ -48,38 +73,12 @@ class BTMiner(BaseMiner):
             logging.warning(f"Failed to get hostname for miner: {self}")
             return None
 
-    async def get_board_info(self) -> dict:
-        """Gets data on each board and chain in the miner."""
-        logging.debug(f"{self}: Getting board info.")
-        devs = await self.api.devs()
-        if not devs.get("DEVS"):
-            print("devs error", devs)
-            return {0: [], 1: [], 2: []}
-        devs = devs["DEVS"]
-        boards = {}
-        offset = devs[0]["ID"]
-        for board in devs:
-            boards[board["ID"] - offset] = []
-            if "Effective Chips" in board.keys():
-                if not board["Effective Chips"] in self.nominal_chips:
-                    nominal = False
-                else:
-                    nominal = True
-                boards[board["ID"] - offset].append(
-                    {
-                        "chain": board["ID"] - offset,
-                        "chip_count": board["Effective Chips"],
-                        "chip_status": "o" * board["Effective Chips"],
-                        "nominal": nominal,
-                    }
-                )
-            else:
-                logging.warning(f"Incorrect board data from {self}: {board}")
-                print(board)
-        logging.debug(f"Found board data for {self}: {boards}")
-        return boards
+    async def get_mac(self) -> str:
+        """Get the mac address of the miner.
 
-    async def get_mac(self):
+        Returns:
+            The mac address of the miner as a string.
+        """
         mac = ""
         data = await self.api.summary()
         if data:
@@ -100,7 +99,12 @@ class BTMiner(BaseMiner):
 
         return str(mac).upper()
 
-    async def get_data(self):
+    async def get_data(self) -> MinerData:
+        """Get data from the miner.
+
+        Returns:
+            A [`MinerData`][pyasic.data.MinerData] instance containing the miners data.
+        """
         data = MinerData(ip=str(self.ip), ideal_chips=self.nominal_chips * 3)
 
         mac = None
@@ -125,8 +129,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:

pyasic/miners/_backends/cgminer.py

@@ -1,5 +1,20 @@
+#  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
 
 
 from pyasic.API.cgminer import CGMinerAPI
@@ -8,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):
@@ -21,7 +36,12 @@ class CGMiner(BaseMiner):
         self.pwd = "admin"
         self.config = None
 
-    async def get_model(self):
+    async def get_model(self) -> Union[str, None]:
+        """Get miner model.
+
+        Returns:
+            Miner model or None.
+        """
         if self.model:
             return self.model
         try:
@@ -33,7 +53,12 @@ class CGMiner(BaseMiner):
             return self.model
         return None
 
-    async def get_hostname(self) -> str or None:
+    async def get_hostname(self) -> Union[str, None]:
+        """Get miner hostname.
+
+        Returns:
+            The hostname of the miner as a string or "?"
+        """
         if self.hostname:
             return self.hostname
         try:
@@ -48,7 +73,15 @@ class CGMiner(BaseMiner):
         except Exception:
             return None
 
-    async def send_ssh_command(self, cmd):
+    async def send_ssh_command(self, cmd: str) -> Union[str, None]:
+        """Send a command to the miner over ssh.
+
+        Parameters:
+            cmd: The command to run.
+
+        Returns:
+            Result of the command or None.
+        """
         result = None
         async with (await self._get_ssh_connection()) as conn:
             for i in range(3):
@@ -63,9 +96,11 @@ class CGMiner(BaseMiner):
         return result
 
     async def restart_backend(self) -> bool:
+        """Restart cgminer hashing process.  Wraps [`restart_cgminer`][pyasic.miners._backends.cgminer.CGMiner.restart_cgminer] to standardize."""
         return await self.restart_cgminer()
 
     async def restart_cgminer(self) -> bool:
+        """Restart cgminer hashing process."""
         commands = ["cgminer-api restart", "/usr/bin/cgminer-monitor >/dev/null 2>&1"]
         commands = ";".join(commands)
         _ret = await self.send_ssh_command(commands)
@@ -74,6 +109,7 @@ class CGMiner(BaseMiner):
         return False
 
     async def reboot(self) -> bool:
+        """Reboots power to the physical miner."""
         logging.debug(f"{self}: Sending reboot command.")
         _ret = await self.send_ssh_command("reboot")
         logging.debug(f"{self}: Reboot command completed.")
@@ -82,6 +118,7 @@ class CGMiner(BaseMiner):
         return False
 
     async def start_cgminer(self) -> None:
+        """Start cgminer hashing process."""
         commands = [
             "mkdir -p /etc/tmp/",
             'echo "*/3 * * * * /usr/bin/cgminer-monitor" > /etc/tmp/root',
@@ -92,6 +129,7 @@ class CGMiner(BaseMiner):
         await self.send_ssh_command(commands)
 
     async def stop_cgminer(self) -> None:
+        """Restart cgminer hashing process."""
         commands = [
             "mkdir -p /etc/tmp/",
             'echo "" > /etc/tmp/root',
@@ -101,14 +139,24 @@ class CGMiner(BaseMiner):
         commands = ";".join(commands)
         await self.send_ssh_command(commands)
 
-    async def get_config(self) -> None:
+    async def get_config(self) -> str:
+        """Gets the config for the miner and sets it as `self.config`.
+
+        Returns:
+            The config from `self.config`.
+        """
         async with (await self._get_ssh_connection()) as conn:
             command = "cat /etc/config/cgminer"
             result = await conn.run(command, check=True)
             self.config = result.stdout
-            print(str(self.config))
+        return self.config
 
-    async def get_data(self):
+    async def get_data(self) -> MinerData:
+        """Get data from the miner.
+
+        Returns:
+            A [`MinerData`][pyasic.data.MinerData] instance containing the miners data.
+        """
         data = MinerData(ip=str(self.ip), ideal_chips=self.nominal_chips * 3)
 
         board_offset = -1
@@ -127,8 +175,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
             )

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
 

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 *

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
 
 

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
 
 

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
 
 

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
 
 

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
 
 

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
 
 

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
 
 

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

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
 
 

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
 
 

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
 
 

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
 
 

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
 
 

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
 
 

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
 

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
 
 

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
 
 

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
 
 

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

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 *

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
 
 

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
 
 

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
 
 

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

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
 
 

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
 
 

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
 
 

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

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
 
 

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
 
 

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
 
 

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

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
 
 

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

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 *

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

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
 
 
@@ -8,3 +22,21 @@ class M20S(BaseMiner):
         self.model = "M20S"
         self.nominal_chips = 66
         self.fan_count = 2
+
+
+class M20SV10(BaseMiner):
+    def __init__(self, ip: str):
+        super().__init__()
+        self.ip = ip
+        self.model = "M20S V10"
+        self.nominal_chips = 105
+        self.fan_count = 2
+
+
+class M20SV20(BaseMiner):
+    def __init__(self, ip: str):
+        super().__init__()
+        self.ip = ip
+        self.model = "M20S V20"
+        self.nominal_chips = 111
+        self.fan_count = 2

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
 
 

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
 
 

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
 
 

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
 
 

pyasic/miners/_types/whatsminer/M2X/__init__.py

@@ -1,4 +1,19 @@
-from .M20S import M20S
+#  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
 
 from .M21 import M21

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
 
 

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
 
 

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
 
 

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