feature: add serial number for antminers

Author: b-rowan

pyasic/data/__init__.py

@@ -83,6 +83,7 @@ class MinerData(BaseModel):
 
     # about
     device_info: DeviceInfo | None = None
+    serial_number: str | None = None
     mac: str | None = None
     api_ver: str | None = None
     fw_ver: str | None = None

pyasic/miners/backends/antminer.py

@@ -39,6 +39,10 @@
 
 ANTMINER_MODERN_DATA_LOC = DataLocations(
     **{
+        str(DataOptions.SERIAL_NUMBER): DataFunction(
+            "_get_serial_number",
+            [WebAPICommand("web_get_system_info", "get_system_info")],
+        ),
         str(DataOptions.MAC): DataFunction(
             "_get_mac",
             [WebAPICommand("web_get_system_info", "get_system_info")],
@@ -360,6 +364,21 @@ async def _get_expected_hashrate(
             except LookupError:
                 pass
 
+    async def _get_serial_number(
+        self, web_get_system_info: dict = None
+    ) -> Optional[str]:
+        if web_get_system_info is None:
+            try:
+                web_get_system_info = await self.web.get_system_info()
+            except APIError:
+                pass
+
+        if web_get_system_info is not None:
+            try:
+                return web_get_system_info["serinum"]
+            except LookupError:
+                pass
+
     async def set_static_ip(
         self,
         ip: str,

pyasic/miners/base.py

@@ -209,6 +209,14 @@ async def upgrade_firmware(
     ### DATA GATHERING FUNCTIONS (get_{some_data}) ###
     ##################################################
 
+    async def get_serial_number(self) -> Optional[str]:
+        """Get the serial number of the miner and return it as a string.
+
+        Returns:
+            A string representing the serial number of the miner.
+        """
+        return await self._get_serial_number()
+
     async def get_mac(self) -> Optional[str]:
         """Get the MAC address of the miner and return it as a string.
 
@@ -379,6 +387,9 @@ async def get_pools(self) -> List[PoolMetrics]:
         """
         return await self._get_pools()
 
+    async def _get_serial_number(self) -> Optional[str]:
+        pass
+
     async def _get_mac(self) -> Optional[str]:
         pass
 

pyasic/miners/data.py

@@ -20,6 +20,7 @@
 
 
 class DataOptions(Enum):
+    SERIAL_NUMBER = "serial_number"
     MAC = "mac"
     API_VERSION = "api_ver"
     FW_VERSION = "fw_ver"

tests/miners_tests/__init__.py

@@ -92,6 +92,7 @@ def test_miner_data_map_keys(self):
                 "hashrate",
                 "hostname",
                 "is_mining",
+                "serial_number",
                 "mac",
                 "expected_hashrate",
                 "uptime",