CAT_TOM/pyasic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
8258320a7b7424a6d47ea0f278b230c992705e27
pyasic/docs/API/api.md
UpstreamData ca6980b1ad update documentation and add docs from config
2022-07-13 16:17:08 -06:00

954 B
Raw Blame History

pyasic

Miner APIs

Each miner has a unique API that is used to communicate with it. Each of these API types has commands that differ between them, and some commands have data that others do not. Each miner that is a subclass of BaseMiner should have an API linked to it as Miner.api.

All API implementations inherit from [BaseMinerAPI][pyasic.API.BaseMinerAPI], which implements the basic communications protocols.

BaseMinerAPI should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare). Use these instead -

[BMMiner API][pyasic.API.bmminer.BMMinerAPI]

[BOSMiner API][pyasic.API.bosminer.BOSMinerAPI]

[BTMiner API][pyasic.API.btminer.BTMinerAPI]

[CGMiner API][pyasic.API.cgminer.CGMinerAPI]

[Unknown API][pyasic.API.unknown.UnknownAPI]


BaseMinerAPI

::: pyasic.API.BaseMinerAPI handler: python options: heading_level: 4