version: bump version number.

README.md

@@ -19,6 +19,23 @@ Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with
 
 [Click here to view supported miner types](https://docs.pyasic.org/en/latest/miners/supported_types/)
 
+---
+## Installation
+
+It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
+  - [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
+  - [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
+    ```
+    pyenv install <python version number>
+    pyenv virtualenv <python version number> <env name>
+    pyenv activate <env name>
+    ```
+  - [conda](https://docs.conda.io/en/latest/)
+
+##### Installing `pyasic`
+
+`python -m pip install .` or `poetry install`
+
 ---
 ## Getting started
 

docs/index.md

@@ -18,6 +18,23 @@ Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with
 
 [Click here to view supported miner types](miners/supported_types.md)
 
+---
+## Installation
+
+It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
+  - [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
+  - [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
+    ```
+    pyenv install <python version number>
+    pyenv virtualenv <python version number> <env name>
+    pyenv activate <env name>
+    ```
+  - [conda](https://docs.conda.io/en/latest/)
+
+##### Installing `pyasic`
+
+`python -m pip install .` or `poetry install`
+
 ---
 ## Getting started
 ---
@@ -236,6 +253,7 @@ settings.update("default_antminer_password", "my_pwd")
 "factory_get_timeout": 3,
 "get_data_retries": 1,
 "api_function_timeout": 5,
+"antminer_mining_mode_as_str": False,
 "default_whatsminer_password": "admin",
 "default_innosilicon_password": "admin",
 "default_antminer_password": "root",

docs/settings/settings.md

@@ -12,6 +12,7 @@ Settings options:
 - `factory_get_timeout`
 - `get_data_retries`
 - `api_function_timeout`
+- `antminer_mining_mode_as_str`
 - `default_whatsminer_password`
 - `default_innosilicon_password`
 - `default_antminer_password`

pyasic/config/mining.py

@@ -17,6 +17,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass, field
 
+from pyasic import settings
 from pyasic.config.base import MinerConfigOption, MinerConfigValue
 from pyasic.web.braiins_os.proto.braiins.bos.v1 import (
     HashrateTargetMode,
@@ -39,7 +40,9 @@ class MiningModeNormal(MinerConfigValue):
         return cls()
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
 
     def as_wm(self) -> dict:
         return {"mode": self.mode}
@@ -63,7 +66,9 @@ class MiningModeSleep(MinerConfigValue):
         return cls()
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "1"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "1"}
+        return {"miner-mode": 1}
 
     def as_wm(self) -> dict:
         return {"mode": self.mode}
@@ -87,7 +92,9 @@ class MiningModeLPM(MinerConfigValue):
         return cls()
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "3"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "3"}
+        return {"miner-mode": 3}
 
     def as_wm(self) -> dict:
         return {"mode": self.mode}
@@ -108,7 +115,9 @@ class MiningModeHPM(MinerConfigValue):
         return cls()
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
 
     def as_wm(self) -> dict:
         return {"mode": self.mode}
@@ -165,7 +174,9 @@ class MiningModePowerTune(MinerConfigValue):
         return cls(**cls_conf)
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
 
     def as_wm(self) -> dict:
         if self.power is not None:
@@ -204,7 +215,9 @@ class MiningModeHashrateTune(MinerConfigValue):
         return cls(dict_conf.get("hashrate"))
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
 
     def as_boser(self) -> dict:
         return {
@@ -239,7 +252,9 @@ class ManualBoardSettings(MinerConfigValue):
         return cls(freq=dict_conf["freq"], volt=dict_conf["volt"])
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
 
 
 @dataclass
@@ -259,7 +274,9 @@ class MiningModeManual(MinerConfigValue):
         )
 
     def as_am_modern(self) -> dict:
-        return {"miner-mode": "0"}
+        if settings.get("antminer_mining_mode_as_str", False):
+            return {"miner-mode": "0"}
+        return {"miner-mode": 0}
 
     @classmethod
     def from_vnish(cls, web_overclock_settings: dict) -> "MiningModeManual":

pyasic/miners/antminer/bmminer/X21/S21.py

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

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

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

pyasic/miners/antminer/bmminer/__init__.py

@@ -18,3 +18,4 @@ from .X7 import *
 from .X9 import *
 from .X17 import *
 from .X19 import *
+from .X21 import *

pyasic/miners/factory.py

@@ -103,6 +103,7 @@ MINER_CLASSES = {
         "ANTMINER S19 PRO HYD.": BMMinerS19ProHydro,
         "ANTMINER S19 PRO+ HYD.": BMMinerS19ProPlusHydro,
         "ANTMINER T19": BMMinerT19,
+        "ANTMINER S21": BMMinerS21,
     },
     MinerTypes.WHATSMINER: {
         None: type("WhatsminerUnknown", (BTMiner, WhatsMinerMake), {}),

pyasic/settings/__init__.py

@@ -28,6 +28,7 @@ _settings = {  # defaults
     "factory_get_timeout": 3,
     "get_data_retries": 1,
     "api_function_timeout": 5,
+    "antminer_mining_mode_as_str": False,
     "default_whatsminer_rpc_password": "admin",
     "default_innosilicon_web_password": "admin",
     "default_antminer_web_password": "root",

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyasic"
-version = "0.54.2"
+version = "0.54.5"
 description = "A simplified and standardized interface for Bitcoin ASICs."
 authors = ["UpstreamData <brett@upstreamdata.ca>"]
 repository = "https://github.com/UpstreamData/pyasic"
@@ -9,7 +9,7 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.8"
-httpx = "^0.26.0"
+httpx = ">=0.26.0"
 asyncssh = "^2.14.2"
 passlib = "^1.7.4"
 pyaml = "^23.12.0"