version: bump version number.

README.md

@@ -23,6 +23,10 @@ Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with
 ## Installation
 
 It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
+  - [pypoetry](https://python-poetry.org/): the reccommended way, since pyasic already uses it by default
+    ```
+    poetry install
+    ```
   - [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
     ```
@@ -36,6 +40,12 @@ It is recommended to install `pyasic` in a [virtual environment](https://realpyt
 
 `python -m pip install .` or `poetry install`
 
+##### Additional Developer Setup
+```
+poetry install --with dev
+pre-commit install
+```
+
 ---
 ## Getting started
 

pyasic/miners/backends/vnish.py

@@ -74,6 +74,10 @@ VNISH_DATA_LOC = DataLocations(
             "_get_uptime",
             [RPCAPICommand("rpc_stats", "stats")],
         ),
+        str(DataOptions.IS_MINING): DataFunction(
+            "_is_mining",
+            [WebAPICommand("web_summary", "summary")],
+        ),
     }
 )
 
@@ -127,16 +131,6 @@ class VNish(BMMiner):
         return False
 
     async def _get_mac(self, web_summary: dict = None) -> str:
-        if web_summary is None:
-            web_info = await self.web.info()
-
-            if web_info is not None:
-                try:
-                    mac = web_info["system"]["network_status"]["mac"]
-                    return mac
-                except KeyError:
-                    pass
-
         if web_summary is not None:
             try:
                 mac = web_summary["system"]["network_status"]["mac"]
@@ -144,6 +138,15 @@ class VNish(BMMiner):
             except KeyError:
                 pass
 
+        web_info = await self.web.info()
+
+        if web_info is not None:
+            try:
+                mac = web_info["system"]["network_status"]["mac"]
+                return mac
+            except KeyError:
+                pass
+
     async def _get_hostname(self, web_summary: dict = None) -> str:
         if web_summary is None:
             web_info = await self.web.info()
@@ -216,6 +219,19 @@ class VNish(BMMiner):
             except LookupError:
                 return fw_ver
 
+    async def _is_mining(self, web_summary: dict = None) -> Optional[bool]:
+        if web_summary is None:
+            web_summary = await self.web.summary()
+
+        if web_summary is not None:
+            try:
+                is_mining = (
+                    not web_summary["miner"]["miner_status"]["miner_state"] == "stopped"
+                )
+                return is_mining
+            except LookupError:
+                pass
+
     async def get_config(self) -> MinerConfig:
         try:
             web_settings = await self.web.settings()

pyasic/miners/factory.py

@@ -372,7 +372,7 @@ MINER_CLASSES = {
         "ANTMINER S19J PRO NOPIC": BOSMinerS19jPro,
         "ANTMINER S19J PRO+": BOSMinerS19jProPlus,
         "ANTMINER S19K PRO NOPIC": BOSMinerS19kProNoPIC,
-        "ANTMINER S19XP": BOSMinerS19XP,
+        "ANTMINER S19 XP": BOSMinerS19XP,
         "ANTMINER T19": BOSMinerT19,
     },
     MinerTypes.VNISH: {
@@ -915,10 +915,11 @@ class MinerFactory:
     async def get_miner_model_braiins_os(self, ip: str) -> str | None:
         sock_json_data = await self.send_api_command(ip, "devdetails")
         try:
-            miner_model = sock_json_data["DEVDETAILS"][0]["Model"].replace(
-                "Bitmain ", ""
+            miner_model = (
+                sock_json_data["DEVDETAILS"][0]["Model"]
+                .replace("Bitmain ", "")
+                .replace("S19XP", "S19 XP")
             )
-
             return miner_model
         except (TypeError, LookupError):
             pass
@@ -931,7 +932,9 @@ class MinerFactory:
                 )
             if d.status_code == 200:
                 json_data = d.json()
-                miner_model = json_data["data"]["bosminer"]["info"]["modelName"]
+                miner_model = json_data["data"]["bosminer"]["info"][
+                    "modelName"
+                ].replace("S19XP", "S19 XP")
                 return miner_model
         except (httpx.HTTPError, LookupError):
             pass

pyasic/settings/__init__.py

@@ -46,7 +46,9 @@ _settings = {  # defaults
 
 ssl_cxt = httpx.create_ssl_context()
 
-
+#this function configures socket options like SO_LINGER and returns an AsyncHTTPTransport instance to perform asynchronous HTTP requests 
+#using those options.
+#SO_LINGER controls what happens when you close a socket with unsent data - it allows specifying linger time for the data to be sent. 
 def transport(verify: Union[str, bool, SSLContext] = ssl_cxt):
     l_onoff = 1
     l_linger = get("so_linger_time", 1000)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyasic"
-version = "0.54.8"
+version = "0.54.11"
 description = "A simplified and standardized interface for Bitcoin ASICs."
 authors = ["UpstreamData <brett@upstreamdata.ca>"]
 repository = "https://github.com/UpstreamData/pyasic"