Set and Get Onboard Relay Status
# Set and Get Onboard Relay Status
# Set Onboard Relay Status
Path:
/api/board_relay
Method: PUT
Content-type: application/json; charset=utf-8
API Description: This can be used to open or close the onboard relay.
Note: This function is available for players of version 1.69.9 or above and with onboard relay components.
Request
| Name | Type | Example | Description |
|---|---|---|---|
| relay | int | 1 | Onboard relay No. (1 in most cases) |
| delay | int | 0 | Delay of onboard relay (unit: s) |
| status | int | 0 | Onboard relay status; 1: Closed, 0: Open |
Example
[{
"relay": 1,
"delay": 0,
"status": 0
}]
# Get Onboard Relay Data
Path:
/api/board_relay.json
Method: GET
Content-type: application/json; charset=utf-8
API Description: This can be used to get the onboard relay's data.
Note: This function is available for players of version 1.69.9 or above and with onboard relay components.
Response
| Name | Type | Example | Description |
|---|---|---|---|
| relay | int | 1 | Onboard relay No. (1 in most cases) |
| delay | int | 0 | Delay of onboard relay (unit: s) |
| status | int | 0 | Onboard relay status; 1: Closed, 0: Open |
Example
[{
"relay": 1,
"delay": 0,
"status": 0
}]