Download OpenAPI specification:Download
It is specific API of BleBox devices with API type: switchBoxD
Please check API type and API level (version) before use,
if you don't see the expected field in response from a real device then hardware version do not support this feature.
Returns information about internal WiFi AP or about connected local WiFi network
{- "ssid": "WiFi_Name",
- "bssid": "70:4f:25:24:11:ae",
- "ip": "192.168.1.11",
- "mac": "bb:50:ec:2d:22:17",
- "station_status": 5,
- "tunnel_status": 5,
- "apEnable": true,
- "apSSID": "shutterBox-g650e32d2217",
- "apPasswd": "my_secret_password",
- "channel": 7
}
Allows to set interal access Point's ssid and password. Allows also to turn off internal AP.
required | object Internal access Point's settings |
{- "network": {
- "apEnable": true,
- "apSSID": "shutterBox-g650e32d2217",
- "apPasswd": "my_secret_password"
}
}
{- "device": {
- "deviceName": "My BleBox device name",
- "type": "shutterBox",
- "apiLevel": "20190808",
- "hv": "9.1d",
- "fv": "0.987",
- "id": "g650e32d2217",
- "ip": "192.168.1.11"
}, - "network": {
- "ssid": "WiFi_Name",
- "bssid": "70:4f:25:24:11:ae",
- "ip": "192.168.1.11",
- "mac": "bb:50:ec:2d:22:17",
- "station_status": 5,
- "tunnel_status": 5,
- "apEnable": true,
- "apSSID": "shutterBox-g650e32d2217",
- "apPasswd": "my_secret_password",
- "channel": 7
}
}
Perform WiFi scan and return list of found WiFi networks. Return conflict if scanning is in progress
{- "ap": [
- {
- "ssid": "Funny_WiFi_Name",
- "rssi": -60,
- "enc": 3
}, - {
- "ssid": "Less_Funny_WiFi_Name",
- "rssi": -75,
- "enc": 4
}, - {
- "ssid": "Not_Funny_WiFi_Name",
- "rssi": -90,
- "enc": 0
}
]
}
Perform connect to local WiFi network
ssid required | string [ 0 .. 32 ] characters SSID of WiFi network. |
pwd | string [ 0 .. 64 ] characters Nullable Password to WiFi network. Empty string or 'null' indicates open mode (without password). |
{- "ssid": "WiFi_Name",
- "pwd": "my_secret_password"
}
{- "ssid": "WiFi_Name",
- "station_status": 5
}
extended information about device and relays
(all parameters needed to display user interface)
{- "relays": [
- {
- "relay": 0,
- "state": 1,
- "stateAfterRestart": 2,
- "defaultForTime": 0,
- "name": "Output no 1"
}, - {
- "relay": 1,
- "state": 1,
- "stateAfterRestart": 2,
- "defaultForTime": 0,
- "name": "Output no 2"
}
]
}
Allows to set desired relay state
(turn on, turn off, toggle state, turn on for time)
Array of objects [ 1 .. 2 ] items List of relays state |
{- "relays": [
- {
- "relay": 0,
- "state": 1,
- "forTime": {
- "timeS": 30,
- "ns": 0
}
}
]
}
{- "relays": [
- {
- "relay": 0,
- "state": 1
}, - {
- "relay": 1,
- "state": 1
}
]
}
Set relay state using GET request
relay required | integer <uint8_t> (relay) Enum: 0 1 Example: 0 ID - relay number | ||||||||
state required | integer <uint8_t> (stateSet) Enum: 0 1 2 Example: 1
|
{- "relays": [
- {
- "relay": 0,
- "state": 1
}, - {
- "relay": 1,
- "state": 1
}
]
}
Set all relays state using GET request
state required | integer <uint8_t> (stateSet) Enum: 0 1 2 Example: 1
|
{- "relays": [
- {
- "relay": 0,
- "state": 1
}, - {
- "relay": 1,
- "state": 1
}
]
}
Set relay state to ON for a given time in seconds using GET request
relay required | integer <uint8_t> (relay) Enum: 0 1 Example: 0 ID - relay number |
timeS required | integer <uint16_t> (timeS) [ 0 .. 65535 ] Example: 30 Time in seconds |
{- "relays": [
- {
- "relay": 0,
- "state": 1
}, - {
- "relay": 1,
- "state": 1
}
]
}
Set all relays state to ON for a given time in seconds using GET request
timeS required | integer <uint16_t> (timeS) [ 0 .. 65535 ] Example: 30 Time in seconds |
{- "relays": [
- {
- "relay": 0,
- "state": 1
}, - {
- "relay": 1,
- "state": 1
}
]
}
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "relays": [
- {
- "stateAfterRestart": 2,
- "defaultForTime": 0,
- "name": "Output no. 1"
}, - {
- "stateAfterRestart": 2,
- "defaultForTime": 0,
- "name": "Output no. 2"
}
], - "switch": {
- "outputMode": 0,
- "outputOrder": [
- 0,
- 1
]
}, - "powerMeasuring": {
- "enabled": 1
}
}
}
Allow to set device's specific settings
object Object with specific settings |
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "relays": [
- {
- "stateAfterRestart": 2,
- "defaultForTime": 0,
- "name": "Output no. 1"
}, - {
- "stateAfterRestart": 2,
- "defaultForTime": 0,
- "name": "Output no. 2"
}
], - "switch": {
- "outputMode": 0,
- "outputOrder": [
- 0,
- 1
]
}, - "powerMeasuring": {
- "enabled": 1
}
}
}
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "relays": [
- {
- "stateAfterRestart": 2,
- "defaultForTime": 0,
- "name": "Output no. 1"
}, - {
- "stateAfterRestart": 2,
- "defaultForTime": 0,
- "name": "Output no. 2"
}
], - "switch": {
- "outputMode": 0,
- "outputOrder": [
- 0,
- 1
]
}, - "powerMeasuring": {
- "enabled": 1
}
}
}