BleBox Technical
Documentation Powered by ReDoc

API Type: thermoBox (20200229)

Download OpenAPI specification:Download

Introduction

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

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

Response samples

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

Control & State

Device state

Returns information about controller

Responses

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

State set

Allow to set desired state (ON, OFF, BOOST) and temperature

Request Body schema: application/json
object

Section of thermoBox

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

Device state Deprecated

Returns information about controller

Device state - /state

Responses

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

State set Deprecated

Allow to set desired state (ON, OFF, BOOST) and temperature

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

Section of thermoBox

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

Device extended state

Returns extended information about controller

Responses

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

Device extended state Deprecated

Returns extended information about controller

Device state - /state

Responses

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

Control with GET

Set state

Set state of controller using GET request

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


Set state of regulator (controller):

Enum: Description:
0 OFF
1 ON (set desiredTemp)
2 ON (do not set desiredTemp)
3 BOOST

Responses

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

Set temperature

Set desired temperature using GET request

path Parameters
desiredTemp
required
integer <int16_t> (desiredTemp) [ -5500 .. 12500 ]
Example: 2150

Desired temperature, where

Value: Description:
xxxx as xx.xx Temperature in Celsius degrees. Value need to be multiplied by 100

Responses

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

Increase temperature

Increase temperature using GET request

path Parameters
byTempValue
required
integer <uint16_t> (increaseDecreaseTempValue) >= 0
Example: 50


Temperature (increase or decrease by given value).
If given value exceed maximum or mininimum temperature then controller automatically set respectively maximumTemp or minimumTemp

Value: Description:
xxxx as xx.xx Temperature in Celsius degrees. Value need to be multiplied by 100

Responses

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

Decrease temperature

Decrease temperature using GET request

path Parameters
byTempValue
required
integer <uint16_t> (increaseDecreaseTempValue) >= 0
Example: 50


Temperature (increase or decrease by given value).
If given value exceed maximum or mininimum temperature then controller automatically set respectively maximumTemp or minimumTemp

Value: Description:
xxxx as xx.xx Temperature in Celsius degrees. Value need to be multiplied by 100

Responses

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

Set state & temperature

Set state of controller and temperature using GET request

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


Set state of regulator (controller):

Enum: Description:
0 OFF
1 ON (set desiredTemp)
2 ON (do not set desiredTemp)
3 BOOST

desiredTemp
required
integer <int16_t> (desiredTemp) [ -5500 .. 12500 ]
Example: 2150

Desired temperature, where

Value: Description:
xxxx as xx.xx Temperature in Celsius degrees. Value need to be multiplied by 100

Responses

Response samples

Content type
application/json
{
  • "thermo":
    {
    },
  • "sensors":
    [
    ]
}

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