BleBox Technical
Documentation Powered by ReDoc

API Type: switchBox (20180604)

Download OpenAPI specification:Download

Introduction

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

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": {
    }
}

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 [ 0 .. 32 ] characters

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

pwd
string [ 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

Control & State

Relay state

Returns information about relays state

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Extended relay state

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

Responses

Response samples

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

Set relay

Allows to set desired relay state
(turn on, turn off, toggle state, turn on for time)

Request Body schema: application/json
Array ()
relay
required
integer <uint8_t> (relay)
Value: 0

ID - relay number

state
required
integer <uint8_t> (stateSet)
Enum: 0 1 2


Set state of relay, where:

Enum: Description:
0 OFF
1 ON
2 Toggle (change to the opposite)

object (forTime)

Module "forTime" which contain parameters of this functionality. Requires state == 1 (ON)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Control with GET

Set relay

Set relay state using GET request

path Parameters
state
required
integer <uint8_t> (stateSet)
Enum: 0 1 2
Example: 1


Set state of relay, where:

Enum: Description:
0 OFF
1 ON
2 Toggle (change to the opposite)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set relay for a given time

Set relay state to ON for a given time in seconds using GET request

path Parameters
timeS
required
integer <uint16_t> (timeS) [ 0 .. 65535 ]
Example: 30

Time in seconds

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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": {
    }
}