pyasic
Base Miner
BaseMiner
is the basis for all miner classes, they all subclass (usually indirectly) from this class.
You may not instantiate this class on its own, only subclass from it. Trying to instantiate an instance of this class will raise TypeError
.
Bases: ABC
Source code in pyasic/miners/base.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
fault_light_off()
abstractmethod
async
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
165 166 167 168 169 170 171 172 |
|
fault_light_on()
abstractmethod
async
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
156 157 158 159 160 161 162 163 |
|
get_api_ver(*args, **kwargs)
abstractmethod
async
Get the API version of the miner and is as a string.
Returns:
Type | Description |
---|---|
Optional[str]
|
API version as a string. |
Source code in pyasic/miners/base.py
263 264 265 266 267 268 269 270 |
|
get_config()
abstractmethod
async
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
174 175 176 177 178 179 180 181 182 |
|
get_data(allow_warning=False, include=None, exclude=None)
async
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
|
Names of data items you want to gather. Defaults to all data. |
None
|
exclude |
list
|
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
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
|
get_env_temp(*args, **kwargs)
abstractmethod
async
Get environment temp from the miner as a float.
Returns:
Type | Description |
---|---|
Optional[float]
|
Environment temp of the miner as a float. |
Source code in pyasic/miners/base.py
317 318 319 320 321 322 323 324 |
|
get_errors(*args, **kwargs)
abstractmethod
async
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
371 372 373 374 375 376 377 378 |
|
get_fan_psu(*args, **kwargs)
abstractmethod
async
Get PSU fan speed from the miner.
Returns:
Type | Description |
---|---|
Optional[int]
|
PSU fan speed. |
Source code in pyasic/miners/base.py
353 354 355 356 357 358 359 360 |
|
get_fans(*args, **kwargs)
abstractmethod
async
Get fan data from the miner in the form [fan_1, fan_2, fan_3, fan_4].
Returns:
Type | Description |
---|---|
List[Fan]
|
A list of fan data. |
Source code in pyasic/miners/base.py
344 345 346 347 348 349 350 351 |
|
get_fault_light(*args, **kwargs)
abstractmethod
async
Check the status of the fault light and return on or off as a boolean.
Returns:
Type | Description |
---|---|
bool
|
A boolean value where |
Source code in pyasic/miners/base.py
380 381 382 383 384 385 386 387 |
|
get_fw_ver(*args, **kwargs)
abstractmethod
async
Get the firmware version of the miner and is as a string.
Returns:
Type | Description |
---|---|
Optional[str]
|
Firmware version as a string. |
Source code in pyasic/miners/base.py
272 273 274 275 276 277 278 279 |
|
get_hashboards(*args, **kwargs)
abstractmethod
async
Get hashboard data from the miner in the form of HashBoard
.
Returns:
Type | Description |
---|---|
List[HashBoard]
|
A |
Source code in pyasic/miners/base.py
308 309 310 311 312 313 314 315 |
|
get_hashrate(*args, **kwargs)
abstractmethod
async
Get the hashrate of the miner and return it as a float in TH/s.
Returns:
Type | Description |
---|---|
Optional[float]
|
Hashrate of the miner in TH/s as a float. |
Source code in pyasic/miners/base.py
299 300 301 302 303 304 305 306 |
|
get_hostname(*args, **kwargs)
abstractmethod
async
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
290 291 292 293 294 295 296 297 |
|
get_mac(*args, **kwargs)
abstractmethod
async
Get the MAC address of the miner and return it as a string.
Returns:
Type | Description |
---|---|
Optional[str]
|
A string representing the MAC address of the miner. |
Source code in pyasic/miners/base.py
246 247 248 249 250 251 252 253 |
|
get_model()
async
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
255 256 257 258 259 260 261 |
|
get_nominal_hashrate(*args, **kwargs)
abstractmethod
async
Get the nominal hashrate from factory if available.
Returns:
Type | Description |
---|---|
Optional[float]
|
A float value of nominal hashrate in TH/s. |
Source code in pyasic/miners/base.py
389 390 391 392 393 394 395 396 |
|
get_pools(*args, **kwargs)
abstractmethod
async
Get pool information from the miner.
Returns:
Type | Description |
---|---|
List[dict]
|
Pool groups and quotas in a list of dicts. |
Source code in pyasic/miners/base.py
362 363 364 365 366 367 368 369 |
|
get_uptime(*args, **kwargs)
abstractmethod
async
Get the uptime of the miner in seconds.
Returns:
Type | Description |
---|---|
Optional[int]
|
The uptime of the miner in seconds. |
Source code in pyasic/miners/base.py
407 408 409 410 411 412 413 414 |
|
get_version(*args, **kwargs)
abstractmethod
async
Get the API version and firmware version of the miner and return them as strings.
Returns:
Type | Description |
---|---|
Tuple[Optional[str], Optional[str]]
|
A tuple of (API version, firmware version) as strings. |
Source code in pyasic/miners/base.py
281 282 283 284 285 286 287 288 |
|
get_wattage(*args, **kwargs)
abstractmethod
async
Get wattage from the miner as an int.
Returns:
Type | Description |
---|---|
Optional[int]
|
Wattage of the miner as an int. |
Source code in pyasic/miners/base.py
326 327 328 329 330 331 332 333 |
|
get_wattage_limit(*args, **kwargs)
abstractmethod
async
Get wattage limit from the miner as an int.
Returns:
Type | Description |
---|---|
Optional[int]
|
Wattage limit of the miner as an int. |
Source code in pyasic/miners/base.py
335 336 337 338 339 340 341 342 |
|
is_mining(*args, **kwargs)
abstractmethod
async
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
398 399 400 401 402 403 404 405 |
|
reboot()
abstractmethod
async
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
184 185 186 187 188 189 190 191 |
|
restart_backend()
abstractmethod
async
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
193 194 195 196 197 198 199 200 |
|
resume_mining()
abstractmethod
async
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
221 222 223 224 225 226 227 228 |
|
send_config(config, user_suffix=None)
abstractmethod
async
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
202 203 204 205 206 207 208 209 210 |
|
set_power_limit(wattage)
abstractmethod
async
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
230 231 232 233 234 235 236 237 238 239 240 |
|
stop_mining()
abstractmethod
async
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
212 213 214 215 216 217 218 219 |
|