Control functionality
Check Light
Source code in pyasic/miners/base.py
async def check_light(self) -> bool:
return await self.get_fault_light()
Fault Light Off
Turn the fault light of the miner off and return success as a boolean.
Returns:
Type | Description |
---|---|
bool
|
A boolean value of the success of turning the light off. |
Source code in pyasic/miners/base.py
async def fault_light_off(self) -> bool:
"""Turn the fault light of the miner off and return success as a boolean.
Returns:
A boolean value of the success of turning the light off.
"""
return False
Fault Light On
Turn the fault light of the miner on and return success as a boolean.
Returns:
Type | Description |
---|---|
bool
|
A boolean value of the success of turning the light on. |
Source code in pyasic/miners/base.py
async def fault_light_on(self) -> bool:
"""Turn the fault light of the miner on and return success as a boolean.
Returns:
A boolean value of the success of turning the light on.
"""
return False
Get Config
Get the mining configuration of the miner and return it as a MinerConfig
.
Returns:
Type | Description |
---|---|
MinerConfig
|
A |
Source code in pyasic/miners/base.py
async def get_config(self) -> MinerConfig:
# Not a data gathering function, since this is used for configuration
"""Get the mining configuration of the miner and return it as a [`MinerConfig`][pyasic.config.MinerConfig].
Returns:
A [`MinerConfig`][pyasic.config.MinerConfig] containing the pool information and mining configuration.
"""
return MinerConfig()
Get Data
Get data from the miner in the form of MinerData
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
allow_warning |
bool
|
Allow warning when an API command fails. |
False
|
include |
List[Union[str, DataOptions]]
|
Names of data items you want to gather. Defaults to all data. |
None
|
exclude |
List[Union[str, DataOptions]]
|
Names of data items to exclude. Exclusion happens after considering included items. |
None
|
Returns:
Type | Description |
---|---|
MinerData
|
A |
Source code in pyasic/miners/base.py
async def get_data(
self,
allow_warning: bool = False,
include: List[Union[str, DataOptions]] = None,
exclude: List[Union[str, DataOptions]] = None,
) -> MinerData:
"""Get data from the miner in the form of [`MinerData`][pyasic.data.MinerData].
Parameters:
allow_warning: Allow warning when an API command fails.
include: Names of data items you want to gather. Defaults to all data.
exclude: Names of data items to exclude. Exclusion happens after considering included items.
Returns:
A [`MinerData`][pyasic.data.MinerData] instance containing data from the miner.
"""
data = MinerData(
ip=str(self.ip),
make=self.make,
model=self.model,
expected_chips=(
self.expected_chips * self.expected_hashboards
if self.expected_chips is not None
else 0
),
expected_hashboards=self.expected_hashboards,
hashboards=[
HashBoard(slot=i, expected_chips=self.expected_chips)
for i in range(self.expected_hashboards)
],
)
gathered_data = await self._get_data(
allow_warning=allow_warning, include=include, exclude=exclude
)
for item in gathered_data:
if gathered_data[item] is not None:
setattr(data, item, gathered_data[item])
return data
Get Errors
Get a list of the errors the miner is experiencing.
Returns:
Type | Description |
---|---|
List[MinerErrorData]
|
A list of error classes representing different errors. |
Source code in pyasic/miners/base.py
async def get_errors(self) -> List[MinerErrorData]:
"""Get a list of the errors the miner is experiencing.
Returns:
A list of error classes representing different errors.
"""
return await self._get_errors()
Get Hostname
Get the hostname of the miner and return it as a string.
Returns:
Type | Description |
---|---|
Optional[str]
|
A string representing the hostname of the miner. |
Source code in pyasic/miners/base.py
async def get_hostname(self) -> Optional[str]:
"""Get the hostname of the miner and return it as a string.
Returns:
A string representing the hostname of the miner.
"""
return await self._get_hostname()
Get Model
Get the model of the miner and return it as a string.
Returns:
Type | Description |
---|---|
Optional[str]
|
A string representing the model of the miner. |
Source code in pyasic/miners/base.py
async def get_model(self) -> Optional[str]:
"""Get the model of the miner and return it as a string.
Returns:
A string representing the model of the miner.
"""
return self.model
Reboot
Reboot the miner and return success as a boolean.
Returns:
Type | Description |
---|---|
bool
|
A boolean value of the success of rebooting the miner. |
Source code in pyasic/miners/base.py
async def reboot(self) -> bool:
"""Reboot the miner and return success as a boolean.
Returns:
A boolean value of the success of rebooting the miner.
"""
return False
Restart Backend
Restart the mining process of the miner (bosminer, bmminer, cgminer, etc) and return success as a boolean.
Returns:
Type | Description |
---|---|
bool
|
A boolean value of the success of restarting the mining process. |
Source code in pyasic/miners/base.py
async def restart_backend(self) -> bool:
"""Restart the mining process of the miner (bosminer, bmminer, cgminer, etc) and return success as a boolean.
Returns:
A boolean value of the success of restarting the mining process.
"""
return False
Stop Mining
Stop the mining process of the miner.
Returns:
Type | Description |
---|---|
bool
|
A boolean value of the success of stopping the mining process. |
Source code in pyasic/miners/base.py
async def stop_mining(self) -> bool:
"""Stop the mining process of the miner.
Returns:
A boolean value of the success of stopping the mining process.
"""
return False
Resume Mining
Resume the mining process of the miner.
Returns:
Type | Description |
---|---|
bool
|
A boolean value of the success of resuming the mining process. |
Source code in pyasic/miners/base.py
async def resume_mining(self) -> bool:
"""Resume the mining process of the miner.
Returns:
A boolean value of the success of resuming the mining process.
"""
return False
Is Mining
Check whether the miner is mining.
Returns:
Type | Description |
---|---|
Optional[bool]
|
A boolean value representing if the miner is mining. |
Source code in pyasic/miners/base.py
async def is_mining(self) -> Optional[bool]:
"""Check whether the miner is mining.
Returns:
A boolean value representing if the miner is mining.
"""
return await self._is_mining()
Send Config
Set the mining configuration of the miner.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
config |
MinerConfig
|
A |
required |
user_suffix |
str
|
A suffix to append to the username when sending to the miner. |
None
|
Source code in pyasic/miners/base.py
async def send_config(self, config: MinerConfig, user_suffix: str = None) -> None:
"""Set the mining configuration of the miner.
Parameters:
config: A [`MinerConfig`][pyasic.config.MinerConfig] containing the mining config you want to switch the miner to.
user_suffix: A suffix to append to the username when sending to the miner.
"""
return None
Set Power Limit
Set the power limit to be used by the miner.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wattage |
int
|
The power limit to set on the miner. |
required |
Returns:
Type | Description |
---|---|
bool
|
A boolean value of the success of setting the power limit. |
Source code in pyasic/miners/base.py
async def set_power_limit(self, wattage: int) -> bool:
"""Set the power limit to be used by the miner.
Parameters:
wattage: The power limit to set on the miner.
Returns:
A boolean value of the success of setting the power limit.
"""
return False