BleBox Technical
Documentation Powered by ReDoc

API Type: tvLiftBox (20200518)

Download OpenAPI specification:Download

Introduction

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.

General

Information about device

Returns general information about device

Responses

Response samples

Content type
application/json
{
  • "device": {
    }
}

Information about device Deprecated

Returns general information about device

It is deprecated -> look at:

Information about device - /info

Responses

Response samples

Content type
application/json
{
  • "device": {
    }
}

Device upTime

Returns information about number of seconds from boot

Responses

Response samples

Content type
application/json
{
  • "upTimeS": 243269
}

Perform firmware update

Perform firmware update. Return conflict if update is in progress

Responses

Network

Network information

Returns information about internal WiFi AP or about connected local WiFi network

Responses

Response samples

Content type
application/json
{
  • "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
}

Local WiFi Status Deprecated

Returns information about connected local WiFi network and if scanning is in progress

It is deprecated -> look at:

Network information - /api/device/network

Responses

Response samples

Content type
application/json
{
  • "scanning": false,
  • "ssid": "WiFi_Name",
  • "ip": "192.168.1.11",
  • "station_status": 5
}

Set internal access Point's settings

Allows to set interal access Point's ssid and password. Allows also to turn off internal AP.

Request Body schema: application/json
required
object

Internal access Point's settings

Responses

Request samples

Content type
application/json
{
  • "network": {
    }
}

Response samples

Content type
application/json
{
  • "device": {
    },
  • "network": {
    }
}

Perform WiFi scan and get results

Perform WiFi scan and return list of found WiFi networks. Return conflict if scanning is in progress

Responses

Response samples

Content type
application/json
{
  • "ap": [
    ]
}

Perform WiFi connect

Perform connect to local WiFi network

Request Body schema: application/json
ssid
required
string (ssid_connect) [ 0 .. 32 ] characters

SSID of WiFi network.
Empty string will disconnect from WiFi network

pwd
string (pwd) [ 0 .. 64 ] characters Nullable

Password to WiFi network. Empty string or 'null' indicates open mode (without password).

Responses

Request samples

Content type
application/json
{
  • "ssid": "WiFi_Name",
  • "pwd": "my_secret_password"
}

Response samples

Content type
application/json
{
  • "ssid": "WiFi_Name",
  • "station_status": 5
}

Perform WiFi disconnect

Perform disconnect from current local WiFi network

Responses

Response samples

Content type
application/json
{
  • "ssid": "WiFi_Name",
  • "station_status": 5
}

Control & State

Device state 'Returns information about **TV lift state**'

Responses

Response samples

Content type
application/json
{
  • "tvLift": { }
}

State set

Allow to send command to TV lift - see the Note in the Introduction

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "tvLift": {
    }
}

Response samples

Content type
application/json
{
  • "tvLift": { }
}

TV lift state Deprecated

Returns information about TV lift state

It is deprecated -> look at:

Device state - /state

Responses

Response samples

Content type
application/json
{
  • "tvLift": { }
}

Extended device state

extended information about TV lift
(all parameters needed to display user interface)

Responses

Response samples

Content type
application/json
{
  • "tvLift": {
    }
}

Extended TV lift state Deprecated

extended information about TV lift
(all parameters needed to display user interface)


It is deprecated -> look at:

Extended device state - /state/extended

Responses

Response samples

Content type
application/json
{
  • "tvLift": {
    }
}

State set Deprecated

Allow to send command to TV lift - see the Note in the Introduction

It is deprecated -> look at:

Device state - /state
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "tvLift": {
    }
}

Response samples

Content type
application/json
{
  • "tvLift": { }
}

Control with GET

Send command

Allow to send command to TV lift using GET request

path Parameters
basicCommand
required
string (basicCommandSet)
Enum: "p" "s" "n"
Example: p


Send basic command to TV lift (basic command mapping depends on the selected controlTyp), where:

Enum: Description:
p primary commad
s secondary command
n step-by-step - next step from the list: [primary, primary, secondary, secondary]

Definition of **controlType**

Responses

Response samples

Content type
application/json
{
  • "tvLift": { }
}

Send command

Allow to send command to TV lift using GET request

path Parameters
command
required
string (commandSet)
Enum: "open_or_stop" "close_or_stop" "up_or_stop" "down_or_stop" "to_fav" "set_fav" "left_or_stop" "right_or_stop" "setup_mode"
Example: up_or_stop


Send command to TV lift, where:

Enum: Supported in controlType:
open_or_stop 0, 4
close_or_stop 0, 4
up_or_stop 1, 2, 3
down_or_stop 1, 2, 3
to_fav 4
set_fav 4
left_or_stop 2
right_or_stop 2
setup_mode 3

Definition of **controlType**

Responses

Response samples

Content type
application/json
{
  • "tvLift": { }
}

Settings

Settings state

Return device's specific settings

Responses

Response samples

Content type
application/json
{
  • "settings": {
    }
}

Settings set

Allow to set device's specific settings

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "settings": {
    }
}