Download OpenAPI specification:Download
It is specific API of BleBox devices with API type: buttonBox
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.
{- "device": {
- "deviceName": "My BleBox device name",
- "product": "shutterBoxV2",
- "type": "shutterBox",
- "apiLevel": "20200831",
- "hv": "9.1d",
- "fv": "0.987",
- "id": "g650e32d2217",
- "ip": "192.168.1.11"
}
}
Returns general information about device
It is deprecated -> look at:
{- "device": {
- "deviceName": "My BleBox device name",
- "product": "shutterBoxV2",
- "type": "shutterBox",
- "apiLevel": "20200831",
- "hv": "9.1d",
- "fv": "0.987",
- "id": "g650e32d2217",
- "ip": "192.168.1.11"
}
}
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",
- "product": "shutterBoxV2",
- "type": "shutterBox",
- "apiLevel": "20200831",
- "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 (ssid_connect) [ 0 .. 32 ] characters SSID of WiFi network. |
pwd | string or null (pwd) [ 0 .. 64 ] characters 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
}
Trigger the selected input in the chosen way to run the assigned actions (using GET request).
inputId required | integer <uint8_t> (inputId) Example: 0 Input ID. Numbered from 0. Maximum ID depending on the number of inputs available in the device (the available IDs are given in inputs array in the response of Device state - /state). | ||||||||||||
triggerType required | integer <uint8_t> (triggerType) Enum: 1 2 3 4 5 Example: 1 Type of selected trigger, where:
|
{- "inputs": [
- {
- "input": 0,
- "state": 1
}
]
}
Allow to set device's specific settings
object |
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1,
- "logEnabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "buttonbox": {
- "uiType": 1
}
}
}
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1,
- "logEnabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "buttonbox": {
- "uiType": 1
}
}
}