Download OpenAPI specification:Download
It is specific API of BleBox devices with API type: tvLiftBox
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.
Note
This API is designed for controller for TV lifts that is dedicated to send commad (electric signals) to old-fashioned (no feedback about lift state - one way only communication) motor controller which are already on the market.
Use another API type and hardware (ask your BleBox distributor) to read the lift state.
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": "20190604",
- "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 (pwd) [ 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
}
Allow to send command to TV lift using GET request
command required | string (commandSet) Enum: "p" "s" "n" Example: p
|
{- "tvLift": { }
}
Allow to set device's specific settings
object |
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "tvLift": {
- "controlType": 1
}
}
}
{- "settings": {
- "deviceName": "My BleBox device name",
- "tunnel": {
- "enabled": 1
}, - "statusLed": {
- "enabled": 1
}, - "tvLift": {
- "controlType": 1
}
}
}