Here is the professional English translation of the technical instructions, tailored for your users. I have provided a standard version and a more detailed version depending on where you are using it (e.g., in a manual or a UI tooltip).
Standard Technical Translation (Recommended)
API Reference Data The API request format is:
http://<base_ip><api_endpoint>Example: > If your management IP address is 192.168.1.100, the request URL would be:
http://192.168.1.100/api/system/info
Request: /api/set_brightness
method： HTTP_POST
Set screen brightness,Valid values 0-100 [For S1 and U1]
Request: /api/system/info
method: HTTP_GET
Response
| Field | type | explanation |
|---|---|---|
| hashRate | num | current hashrate |
| hashRateavg | num | It’s of no use at this stage |
| bestDiff | str | Best share String |
| networkdiff | num | Network Difficulty |
| frequency | num | ASIC FREQ (The field s1 is meaningless.) |
| minerversion | str | version |
| boardVersion | str | BOARD_VERSION |
| watchdogtime | num | 0:false A value greater than 0 corresponds to the set time, in seconds. |
| screen_type | num | |
| ssid | str | wifi ssid |
| hostname | str | |
| wifiPass | str | |
| wifiStatus | str | |
| sharesAccepted | num | |
| sharesRejected | num | |
| uptimeSeconds | num | online time(Seconds) |
| stratumURL | str | |
| stratumPort | num | |
| stratumUser | str | |
| stratumPassword | str | |
| stratum_difficulty | num | |
| invertscreen | num | |
| fenping | num | for color screen.eg: d12 and s1 /u1/y7 |
| flipscreen | num | |
| screenld | num | screen brightness.0-100 (for s1 and u1) |
| staticipopen | num | 0:false 1:true |
| staticip | str | |
| staticnetmask | str | |
| staticopengw | str | |
| dnsmain | str | |
| dnsbackup | str | |
| dnsfallback | str | |
| tianqijiekou | num | for d12 .This field will be obsolete in the future; it should only be used to distinguish which weather API is being called. |
| xinzhimiyao | str | weather private key.This field will be obsolete in the future. |
| chengshi | str | city.for color screen.eg: d12 and s1 /u1/y7 |
| shiqu | str | time zone.for color screen.eg: d12 and s1 /u1/y7 |
| ntpserver | str | for color screen.eg: d12 and s1 /u1/y7 |
| jingweidu | str | Accuracy and latitude.for d12.This field will be obsolete in the future; it should only be used to distinguish which weather API is being called. |
| wendudanwei | num | 2: metric temperature.other num: imperial temperature, |
| mycoinopen | num | Should I open coin price?0:false 1:true .for color screen.eg: d12 and s1 /u1 |
| coinname1 | str | coin name |
| coinname2 | str | |
| coinname3 | str | |
| coinname4 | str | |
| coinname5 | str | |
| boardtemp | num | for n8,u1 |
| fanspeedrpm | num | for n8/y7(4 line fan).Current fan speed. |
| fanspeedbfb | num | for n8/y7(4 line fan).Current fan speed percentage. |
| defaultfanspeed | num | for n8/y7(4 line fan).Default fanspeed |
| fanpwmauto | num | Should I enable PWM auto-speed adjustment? 0:false 1:true.for n8/y7(4 line fan) |
| isfan | num | Y7 board is 1 ,other is 0 |
Request: /api/system/simpleinfo
method: HTTP_GET
A relatively small amount of data was obtained.
Response:
hostname, minerversion, boardVersion, screen_type, stratumURL, stratumPort, stratumUser
Please refer to the table above for field types and explanations.
Request: /api/system/gethash
method: HTTP_GET
Response:
hostname, minerversion, hashRate, hashRateavg, bestDiff, networkdiff, freeHeap, frequency, stratum_difficulty
sharesAccepted, sharesRejected, uptimeSeconds, boardtemp, fanspeedrpm, fanspeedbfb
Please refer to the table above for field types and explanations.
Request: /api/swarm/alldel
method: HTTP_GET
System will del all swarm.
Request: /api/swarm/info
method: HTTP_GET
Get all swarm info json.
Request: /api/hello
method: HTTP_GET
Response: “bitdsk”
Request: /api/swarm
method: HTTP_PATCH
update swarm
Request: /api/system/restart
method: HTTP_POST
Reboot
Request: /api/system
method: HTTP_PATCH
update settings.Please refer to the table above for field types and explanations.
Request: /api/wifi_setup
method: HTTP_PATCH
update wifisetup.You can send Wi-Fi settings separately to this interface, which will result in a faster response and you won’t need to send the full form.
Required fields: stratumURL, stratumUser, stratumPassword, stratumPort, ssid, wifiPass
Request: /api/system/OTA
It is not recommended to use the OTA upgrade interface externally, as unpredictable errors may occur, which could brick the motherboard.
Request: /api/ws
method: HTTP_GET
websocket: true
Log output.
