refactor: rename API to rpc, and classes from {X}API to {X}RPCAPI to clarify naming.

This commit is contained in:
UpstreamData
2024-01-15 15:09:51 -07:00
parent 4ed49c2321
commit aab8825997
27 changed files with 86 additions and 86 deletions

View File

@@ -4,24 +4,24 @@ 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`][pyasic.miners.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.
All API implementations inherit from [`BaseMinerRPCAPI`][pyasic.API.BaseMinerRPCAPI], which implements the basic communications protocols.
[`BaseMinerAPI`][pyasic.API.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).
[`BaseMinerAPI`][pyasic.API.BaseMinerAPI] cannot be instantiated directly, it will raise a `TypeError`.
[`BaseMinerRPCAPI`][pyasic.API.BaseMinerRPCAPI] should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare).
[`BaseMinerRPCAPI`][pyasic.API.BaseMinerRPCAPI] cannot be instantiated directly, it will raise a `TypeError`.
Use these instead -
#### [BFGMiner API][pyasic.API.bfgminer.BFGMinerAPI]
#### [BMMiner API][pyasic.API.bmminer.BMMinerAPI]
#### [BOSMiner API][pyasic.API.bosminer.BOSMinerAPI]
#### [BTMiner API][pyasic.API.btminer.BTMinerAPI]
#### [CGMiner API][pyasic.API.cgminer.CGMinerAPI]
#### [LUXMiner API][pyasic.API.luxminer.LUXMinerAPI]
#### [Unknown API][pyasic.API.unknown.UnknownAPI]
#### [BFGMiner API][pyasic.API.bfgminer.BFGMinerRPCAPI]
#### [BMMiner API][pyasic.API.bmminer.BMMinerRPCAPI]
#### [BOSMiner API][pyasic.API.bosminer.BOSMinerRPCAPI]
#### [BTMiner API][pyasic.API.btminer.BTMinerRPCAPI]
#### [CGMiner API][pyasic.API.cgminer.CGMinerRPCAPI]
#### [LUXMiner API][pyasic.API.luxminer.LUXMinerRPCAPI]
#### [Unknown API][pyasic.API.unknown.UnknownRPCAPI]
<br>
## BaseMinerAPI
::: pyasic.API.BaseMinerAPI
## BaseMinerRPCAPI
::: pyasic.API.BaseMinerRPCAPI
handler: python
options:
heading_level: 4

View File

@@ -1,6 +1,6 @@
# pyasic
## BFGMinerAPI
::: pyasic.API.bfgminer.BFGMinerAPI
## BFGMinerRPCAPI
::: pyasic.API.bfgminer.BFGMinerRPCAPI
handler: python
options:
show_root_heading: false

View File

@@ -1,6 +1,6 @@
# pyasic
## BMMinerAPI
::: pyasic.API.bmminer.BMMinerAPI
## BMMinerRPCAPI
::: pyasic.API.bmminer.BMMinerRPCAPI
handler: python
options:
show_root_heading: false

View File

@@ -1,6 +1,6 @@
# pyasic
## BOSMinerAPI
::: pyasic.API.bosminer.BOSMinerAPI
## BOSMinerRPCAPI
::: pyasic.API.bosminer.BOSMinerRPCAPI
handler: python
options:
show_root_heading: false

View File

@@ -1,6 +1,6 @@
# pyasic
## BTMinerAPI
::: pyasic.API.btminer.BTMinerAPI
## BTMinerRPCAPI
::: pyasic.API.btminer.BTMinerRPCAPI
handler: python
options:
show_root_heading: false

View File

@@ -1,6 +1,6 @@
# pyasic
## CGMinerAPI
::: pyasic.API.cgminer.CGMinerAPI
## CGMinerRPCAPI
::: pyasic.API.cgminer.CGMinerRPCAPI
handler: python
options:
show_root_heading: false

View File

@@ -1,6 +1,6 @@
# pyasic
## LUXMinerAPI
::: pyasic.API.luxminer.LUXMinerAPI
## LUXMinerRPCAPI
::: pyasic.API.luxminer.LUXMinerRPCAPI
handler: python
options:
show_root_heading: false

View File

@@ -1,6 +1,6 @@
# pyasic
## UnknownAPI
::: pyasic.API.unknown.UnknownAPI
## UnknownRPCAPI
::: pyasic.API.unknown.UnknownRPCAPI
handler: python
options:
show_root_heading: false