BleBox Technical
API docs by Redocly

API Type: gateBox (20230102)

Download OpenAPI specification:Download

Introduction

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.

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 information about gate state

Responses

Response samples

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

Gate state Deprecated

Returns information about gate state

It is deprecated -> look at:

Device state - /state

Responses

Response samples

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

Extended device state

Returns extended information about device and gate
(all parameters needed to display user interface)

Responses

Response samples

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

Extended gate state Deprecated

extended information about device and gate
(all parameters needed to display user interface)


It is deprecated -> look at:

Extended device state - /state/extended

Responses

Response samples

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

Control with API command

Gate short command

Send API command to the device as URL path: gate short command.

path Parameters
shortCommand
required
string (shortCommand)
Enum: "p" "s" "o" "c" "n"
Example: p


Send shortCommand to gate, where:

Enum: Description:
p primary action - trigger the gate output
s secondary action - trigger the extra button output
o open - perform a open action on the gate if available
c close - perform a close action on the gate if available
n next - perform a next step of the "step-by-step" control

Primary and secondary actions simply trigger gate and extraButton output and return a 200 response.

Open, close, next are abstract commands to provide a common control interface for different types of device connections. These commands are translated internaly to p / s / no action / return error according to the selected openCloseMode. If the command can be executed in the given gate state, the request returns a 200 response. If the command cannot be executed in the given gate state (e.g. unable to predict next step of the "step-by-step" gate controller option), a 409 error response will be returned. See openCloseMode for details.

Definition of **openCloseMode**

Responses

Response samples

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

Gate short command

Send API command to the device as URL path: gate short command.

path Parameters
shortCommand
required
string (shortCommand)
Enum: "p" "s" "o" "c" "n"
Example: p


Send shortCommand to gate, where:

Enum: Description:
p primary action - trigger the gate output
s secondary action - trigger the extra button output
o open - perform a open action on the gate if available
c close - perform a close action on the gate if available
n next - perform a next step of the "step-by-step" control

Primary and secondary actions simply trigger gate and extraButton output and return a 200 response.

Open, close, next are abstract commands to provide a common control interface for different types of device connections. These commands are translated internaly to p / s / no action / return error according to the selected openCloseMode. If the command can be executed in the given gate state, the request returns a 200 response. If the command cannot be executed in the given gate state (e.g. unable to predict next step of the "step-by-step" gate controller option), a 409 error response will be returned. See openCloseMode for details.

Definition of **openCloseMode**

Responses

Response samples

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

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

Object which contain specific settings

Responses

Request samples

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

Response samples

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