BleBox Technical
API docs by Redocly

API Type: displayBox (20241124)

Download OpenAPI specification:Download

Introduction

It is specific API of BleBox devices with API type: displayBox

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.

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 or null (pwd) [ 0 .. 64 ] characters

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 basic information about state of the display and connected controllers.

Responses

Response samples

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

Device state set

Restores device operations if checkPIN equals PIN

Request Body schema: application/json
required
object

Responses

Request samples

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

Response samples

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

Extended device state

Returns extended information about state of the display and connected controllers.
(all parameters needed to display user interface)

Responses

Response samples

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

Control with GET

Set awake state

path Parameters
awakeVal
required
integer <uint8_t> (awakeState)
Enum: 0 1
Example: 1

Set state of display backlight:

Enum Description
0 Backlight off
1 Backlight on

Responses

Response samples

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

Set lock state

path Parameters
lockVal
required
integer <uint8_t> (lockState)
Enum: 0 1
Example: 1

Set state of app lock:

Enum Description
0 Unlocked
1 Locked

Responses

Response samples

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

Set awake and lock state

path Parameters
awakeVal
required
integer <uint8_t> (awakeState)
Enum: 0 1
Example: 1

Set state of display backlight:

Enum Description
0 Backlight off
1 Backlight on
lockVal
required
integer <uint8_t> (lockState)
Enum: 0 1
Example: 1

Set state of app lock:

Enum Description
0 Unlocked
1 Locked

Responses

Response samples

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

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
required
object

An object which contains specific settings

Responses

Request samples

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

Response samples

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