CAT_TOM/pyasic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: more documentation improvements and fixes

Browse Source
This commit is contained in:
Upstream Data
2024-12-04 09:56:42 -07:00
parent 46788e7d14
commit b6fb0fd2b9
4 changed files with 536 additions and 233 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
pyasic/miners/base.py
View File

@@ -177,6 +177,27 @@ class MinerProtocol(Protocol):
"""
return False
async def upgrade_firmware(
self,
*,
file: str = None,
url: str = None,
version: str = None,
keep_settings: bool = True,
) -> bool:
"""Upgrade the firmware of the miner.
Parameters:
file: The file path to the firmware to upgrade from. Must be a valid file path if provided.
url: The URL to download the firmware from. Must be a valid URL if provided.
version: The version of the firmware to upgrade to. If None, the version will be inferred from the file or URL.
keep_settings: Whether to keep the current settings during the upgrade. Defaults to True.
Returns:
A boolean value of the success of the firmware upgrade.
"""
return False
##################################################
### DATA GATHERING FUNCTIONS (get_{some_data}) ###
##################################################
@@ -346,7 +367,7 @@ class MinerProtocol(Protocol):
async def get_pools(self) -> List[PoolMetrics]:
"""Get the pools information from Miner.
Return:
Returns:
The pool information of the miner.
"""
return await self._get_pools()
@@ -565,26 +586,5 @@ class BaseMiner(MinerProtocol):
if self._ssh_cls is not None:
self.ssh = self._ssh_cls(ip)
async def upgrade_firmware(
self,
*,
file: str = None,
url: str = None,
version: str = None,
keep_settings: bool = True,
) -> bool:
"""Upgrade the firmware of the miner.
Parameters:
file (str, optional): The file path to the firmware to upgrade from. Must be a valid file path if provided.
url (str, optional): The URL to download the firmware from. Must be a valid URL if provided.
version (str, optional): The version of the firmware to upgrade to. If None, the version will be inferred from the file or URL.
keep_settings (bool, optional): Whether to keep the current settings during the upgrade. Defaults to True.
Returns:
A boolean value of the success of the firmware upgrade.
"""
return False
AnyMiner = TypeVar("AnyMiner", bound=BaseMiner)