Download OpenAPI specification:Download
It is specific API of BleBox devices with API type: gateBox
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": "20210118",
- "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": "20210118",
- "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": "20210118",
- "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
}
Send command to gate using GET request
command required | string (sendCommand) Enum: "p" "s" "o" "c" Example: p
Primary and secondary actions simply trigger gate and extraButton output. Open and close actions work only in specified conditions:
If open or close command will be send to gate somewhere between open and close ( currentPos: 50 ), 409 error response will be returned. If open command will be send to fully open or close command will be send to fully closed gate, 200 response will be returned but there will be no pulse on the output. |
{- "gate": {
- "currentPos": 50
}
}
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1,
- "logEnabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "gate": {
- "gateType": 1,
- "gatePulseTimeMs": 1500,
- "gateRelayNumber": 0,
- "gateInvert": 0,
- "extraButtonType": 1,
- "extraButtonPulseTimeMs": 1500,
- "extraButtonInvert": 0,
- "extraButtonRelayNumber": 1,
- "inputsType": 0,
- "openLimitSwitchInputNumber": 0,
- "closeLimitSwitchInputNumber": 1
}
}
}
Allow to set device's specific settings
object Object which contain specific settings |
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1,
- "logEnabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "gate": {
- "gateType": 1,
- "gatePulseTimeMs": 1500,
- "gateRelayNumber": 0,
- "gateInvert": 0,
- "extraButtonType": 1,
- "extraButtonPulseTimeMs": 1500,
- "extraButtonInvert": 0,
- "extraButtonRelayNumber": 1,
- "inputsType": 0,
- "openLimitSwitchInputNumber": 0,
- "closeLimitSwitchInputNumber": 1
}
}
}
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1,
- "logEnabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "gate": {
- "gateType": 1,
- "gatePulseTimeMs": 1500,
- "gateRelayNumber": 0,
- "gateInvert": 0,
- "extraButtonType": 1,
- "extraButtonPulseTimeMs": 1500,
- "extraButtonInvert": 0,
- "extraButtonRelayNumber": 1,
- "inputsType": 0,
- "openLimitSwitchInputNumber": 0,
- "closeLimitSwitchInputNumber": 1
}
}
}