mirror of
https://github.com/skot/ESP-Miner.git
synced 2025-05-31 11:19:19 +02:00
add API section to readme.md (#135)
This commit is contained in:
parent
2f1a6c5d7d
commit
75d5643c76
32
readme.md
32
readme.md
@ -77,3 +77,35 @@ The bitaxetool requires a config.cvs preloaded file and the appropiate firmware.
|
||||
```
|
||||
bitaxetool --config ./config.cvs --firmware ./esp-miner-factory-v2.0.3.bin
|
||||
```
|
||||
|
||||
## API
|
||||
Bitaxe provides an API to expose actions and information.
|
||||
|
||||
For more details take a look at `main/http_server/http_server.c`.
|
||||
|
||||
Things that can be done are:
|
||||
|
||||
- Get System Info
|
||||
- Get Swarm Info
|
||||
- Update Swarm
|
||||
- Swarm Options
|
||||
- System Restart Action
|
||||
- Update System Settings Action
|
||||
- System Options
|
||||
- Update OTA Firmware
|
||||
- Update OTA WWW
|
||||
- WebSocket
|
||||
|
||||
Some API examples in curl:
|
||||
```bash
|
||||
# Get system information
|
||||
curl http://YOUR-BITAXE-IP/api/system/info
|
||||
```
|
||||
```bash
|
||||
# Get swarm information
|
||||
curl http://YOUR-BITAXE-IP/api/swarm/info
|
||||
```
|
||||
```bash
|
||||
# System restart action
|
||||
curl -X POST http://YOUR-BITAXE-IP/api/system/restart
|
||||
```
|
Loading…
x
Reference in New Issue
Block a user