Download OpenAPI specification:Download
It is specific API of BleBox devices with API type: wLightBox
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": "20200229",
- "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": "20200229",
- "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": "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
{- "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
}
Returns information about mode, selected effect, color and transition times
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
Allows to set desired color, effect and transition times
object An object which contain parameters related with LED lighting |
{- "rgbw": {
- "effectID": 2,
- "desiredColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
Returns information about mode, selected effect, color, transition times.
Additionaly returns favorite colors and effects names
(All parameters needed to display user interface)
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}, - "effectNames": {
- "0": "NONE",
- "1": "FADE",
- "2": "RGB",
- "3": "POLICE",
- "4": "RELAX",
- "5": "STROBO",
- "6": "BELL"
}, - "favColors": {
- "0": "ff000000",
- "1": "00ff0000",
- "2": "0000ff00",
- "3": "000000ff",
- "4": "00000000",
- "5": "ff00ff00",
- "6": "ffff0000",
- "7": "00ffff00",
- "8": "ff800000",
- "9": "0080ff00"
}
}
}
Allows to set state of lighting - effect, color, transition times
Additionaly allows to set extended parameters - favorite colors
object An object which contain extended parameters related with LED lighting |
{- "rgbw": {
- "effectID": 2,
- "desiredColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}, - "favColors": {
- "0": "ff000000",
- "1": "00ff0000",
- "2": "0000ff00",
- "3": "000000ff",
- "4": "00000000",
- "5": "ff00ff00",
- "6": "ffff0000",
- "7": "00ffff00",
- "8": "ff800000",
- "9": "0080ff00"
}
}
}
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}, - "effectNames": {
- "0": "NONE",
- "1": "FADE",
- "2": "RGB",
- "3": "POLICE",
- "4": "RELAX",
- "5": "STROBO",
- "6": "BELL"
}, - "favColors": {
- "0": "ff000000",
- "1": "00ff0000",
- "2": "0000ff00",
- "3": "000000ff",
- "4": "00000000",
- "5": "ff00ff00",
- "6": "ffff0000",
- "7": "00ffff00",
- "8": "ff800000",
- "9": "0080ff00"
}
}
}
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
Set color using GET request
channels required | string (colorSet) ^(?:[0-9a-fA-F]{2}|--){1}$|^(?:[0-9a-fA-F]{2}... Example: ff003000 Color value in format: 4 channels (R)(G)(B)(W) or 1 channel (S), where |
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
Adjust brightness using GET request
adjust required | string (adjust) Enum: "inc" "dec" Example: inc As the name of field says |
channelsDelta required | string (colorValue) ^(?:[0-9a-fA-F]{2}){1}$|^(?:[0-9a-fA-F]{2}){4... Example: ff003000 As the name of field says |
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
Turning ON effect with given ID using GET request
effectID required | integer <uint8_t> (effectID) [ 0 .. 10 ] Example: 2 No (ID) of Effect, where
|
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
Set color with color fade time in milliseconds using GET request
channels required | string (colorSet) ^(?:[0-9a-fA-F]{2}|--){1}$|^(?:[0-9a-fA-F]{2}... Example: ff003000 Color value in format: 4 channels (R)(G)(B)(W) or 1 channel (S), where |
timeMs required | integer <uint32_t> (colorFade) [ 25 .. 3600000 ] Value: 0 Example: 1000 Time of transition from current color to desired color measured in milliseconds |
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
Set color for given time using GET request (after given time returns to previous state)
channels required | string (colorSet) ^(?:[0-9a-fA-F]{2}|--){1}$|^(?:[0-9a-fA-F]{2}... Example: ff003000 Color value in format: 4 channels (R)(G)(B)(W) or 1 channel (S), where |
timeS required | integer <uint16_t> [ 1 .. 65535 ] Example: 30 Time in seconds for which the selected state will be set, after this time the last state will be restored. |
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
Turning ON effect with given ID using GET request (after given time returns to previous state)
effectID required | integer <uint8_t> (effectID) [ 0 .. 10 ] Example: 2 No (ID) of Effect, where
| ||||||
timeS required | integer <uint16_t> [ 1 .. 65535 ] Example: 30 Time in seconds for which the selected state will be set, after this time the last state will be restored. |
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
Set color with color fade time for given time using GET request (after given time returns to previous state)
channels required | string (colorSet) ^(?:[0-9a-fA-F]{2}|--){1}$|^(?:[0-9a-fA-F]{2}... Example: ff003000 Color value in format: 4 channels (R)(G)(B)(W) or 1 channel (S), where |
timeMs required | integer <uint32_t> (colorFade) [ 25 .. 3600000 ] Value: 0 Example: 1000 Time of transition from current color to desired color measured in milliseconds |
timeS required | integer <uint16_t> [ 1 .. 65535 ] Example: 30 Time in seconds for which the selected state will be set, after this time the last state will be restored. |
{- "rgbw": {
- "colorMode": 1,
- "effectID": 2,
- "desiredColor": "ff003000",
- "currentColor": "ff003000",
- "lastOnColor": "ff003000",
- "durationsMs": {
- "colorFade": 1000,
- "effectFade": 1500,
- "effectStep": 2000
}
}
}
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "rgbw": {
- "colorMode": 1,
- "outputMode": 1,
- "pwmFreq": 600,
- "buttonMode": 4,
- "fieldsPreferences": [
- {
- "name": "buttonMode",
- "values": [
- 0,
- 1,
- 2,
- 3,
- 4
]
}, - {
- "name": "colorMode",
- "values": [
- 1,
- 2,
- 3,
- 4,
- 5,
- 6
]
}, - {
- "name": "outputMode",
- "values": [
- 1,
- 2,
- 3,
- 4
]
}, - {
- "name": "pwmFreq",
- "values": [
- 486,
- 600,
- 1200
]
}
]
}
}
}
Allow to set device's specific settings
object An object which contain specific settings |
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "rgbw": {
- "pwmFreq": 600,
- "colorMode": 1,
- "outputMode": 1,
- "buttonMode": 4
}
}
}
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "rgbw": {
- "colorMode": 1,
- "outputMode": 1,
- "pwmFreq": 600,
- "buttonMode": 4,
- "fieldsPreferences": [
- {
- "name": "buttonMode",
- "values": [
- 0,
- 1,
- 2,
- 3,
- 4
]
}, - {
- "name": "colorMode",
- "values": [
- 1,
- 2,
- 3,
- 4,
- 5,
- 6
]
}, - {
- "name": "outputMode",
- "values": [
- 1,
- 2,
- 3,
- 4
]
}, - {
- "name": "pwmFreq",
- "values": [
- 486,
- 600,
- 1200
]
}
]
}
}
}