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.
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "device": {
- "deviceName": "My BleBox device name",
- "product": "shutterBoxV2",
- "type": "shutterBox",
- "apiLevel": "20200229",
- "hv": "9.1d",
- "fv": "0.987",
- "id": "g650e32d2217",
- "ip": "192.168.1.11"
}
}
Returns general information about device
It is deprecated -> look at:
OK
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "device": {
- "deviceName": "My BleBox device name",
- "product": "shutterBoxV2",
- "type": "shutterBox",
- "apiLevel": "20200229",
- "hv": "9.1d",
- "fv": "0.987",
- "id": "g650e32d2217",
- "ip": "192.168.1.11"
}
}
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "upTimeS": 243269
}
Perform firmware update. Return conflict if update is in progress
OK
Conflict
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
Returns information about internal WiFi AP or about connected local WiFi network
OK
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "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
}
Returns information about connected local WiFi network and if scanning is in progress
It is deprecated -> look at:
OK
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "scanning": false,
- "ssid": "WiFi_Name",
- "ip": "192.168.1.11",
- "station_status": 5
}
Allows to set interal access Point's ssid and password. Allows also to turn off internal AP.
network required | object Internal access Point's settings |
OK
Bad request
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "network": {
- "apEnable": true,
- "apSSID": "shutterBox-g650e32d2217",
- "apPasswd": "my_secret_password"
}
}
{- "device": {
- "deviceName": "My BleBox device name",
- "product": "shutterBoxV2",
- "type": "shutterBox",
- "apiLevel": "20200229",
- "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
OK
Conflict
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "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). |
OK
Bad request
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "ssid": "WiFi_Name",
- "pwd": "my_secret_password"
}
{- "ssid": "WiFi_Name",
- "station_status": 5
}
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "ssid": "WiFi_Name",
- "station_status": 5
}
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "relays": [
- {
- "relay": 0,
- "state": 1
}, - {
- "relay": 1,
- "state": 1
}
]
}
Allow to set desired relay state (ON, OFF, TOGGLE, FORTIME)
relays | Array of objects [ 1 .. 2 ] items List of relays state |
OK
Bad request
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "relays": [
- {
- "relay": 0,
- "state": 1,
- "forTime": {
- "timeS": 30,
- "ns": 0
}
}
]
}
{- "relays": [
- {
- "relay": 0,
- "state": 1
}, - {
- "relay": 1,
- "state": 1
}
]
}
Returns information about relays state
It is deprecated -> look at:
OK
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "relays": [
- {
- "relay": 0,
- "state": 1
}, - {
- "relay": 1,
- "state": 1
}
]
}
Returns extended information about device and relays
(all parameters needed to display user interface)
OK
Controller's web server - connecting via device's WiFi AP
Controller's web server - connecting via local network - please change IP
Controller's web server - connecting via local network - for own DNS resolving
{- "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"
}
]
}