BleBox Technical
redocly logo API docs by Redocly

API Type: shutterBox (20190911)

Download OpenAPI specification:Download

Introduction

Introduction

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

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

Control & State

Shutter state

Returns information about shutter state
(state, current/desired position and tilt)

Responses

Response samples

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

Extended shutter state

Returns extended information about shutter state
(all parameters needed to display user interface)

Responses

Response samples

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

Control with GET

Control shutter

Allows to control shutter using GET request

path Parameters
command
required
string
Enum: "u" "d" "s" "n" "f" "us" "ds"
Example: u


Command to execute, where:

Enum: Description:
u Up - open(lift shutter/blinds)
d Down - close (lower shutter/blinds)
s Stop
n Next step (in sequence open-stop-close-stop)
f Set favorite position
us Go up or stop - if the motor is running, stop it. If it is stopped, go up (open/lift shutter/blinds).
ds Go down or stop - if the motor is running, stop it. If it is stopped, go down (close/lower shutter/blinds).

Responses

Response samples

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

Set position

Allows to set position of shutter using GET request
(requires calibration - can be used only when shutter is calibrated)

path Parameters
positionPercentage
required
integer <int8_t> (position_set) [ 0 .. 100 ]
Example: 42


Position of shutter, where:

Value: Description:
0 Open window / shutter
1-99 Percentage value of window (shutter) closure (only if calibrated)
100 Close window / shutter

Responses

Response samples

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

Set tilt

Allows to set tilt using GET request
(only for tilt-supported controlTypes)

path Parameters
tiltPercentage
required
integer <int8_t> (tilt_set) [ 0 .. 100 ]
Example: 50


Tilt of blinds (only for tilt-supported controlTypes), where:

Value: Description:
0 Minimum tilt
1-99 Percentage value of full tilt move
100 Maximum tilt

Responses

Response samples

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

Set position and tilt

Allows to set position and tilt of shutter using GET request
(requires calibration - can be used only when shutter is calibrated)
(only for tilt-supported controlTypes)

path Parameters
positionPercentage
required
integer <int8_t> (position_set) [ 0 .. 100 ]
Example: 42


Position of shutter, where:

Value: Description:
0 Open window / shutter
1-99 Percentage value of window (shutter) closure (only if calibrated)
100 Close window / shutter

tiltPercentage
required
integer <int8_t> (tilt_set) [ 0 .. 100 ]
Example: 50


Tilt of blinds (only for tilt-supported controlTypes), where:

Value: Description:
0 Minimum tilt
1-99 Percentage value of full tilt move
100 Maximum tilt

Responses

Response samples

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

Adjust tilt - increase

Allows to increase tilt using GET request
(only for tilt-supported controlTypes)

path Parameters
tiltDiffPP
required
integer <int8_t> (value_diff_pp_set) [ 0 .. 100 ]
Example: 33


Value of adjustment to apply (percentage points), where:

Value: Description:
0 No changes
1-100 Adjust by given percentage points in the given direction (type of adjustment). Desired value will be crop to range [0 - 100]

Responses

Response samples

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

Adjust tilt - decrease

Allows to decrease tilt using GET request
(only for tilt-supported controlTypes)

path Parameters
tiltDiffPP
required
integer <int8_t> (value_diff_pp_set) [ 0 .. 100 ]
Example: 33


Value of adjustment to apply (percentage points), where:

Value: Description:
0 No changes
1-100 Adjust by given percentage points in the given direction (type of adjustment). Desired value will be crop to range [0 - 100]

Responses

Response samples

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

Settings

Settings state

Returns device's specific settings

Responses

Response samples

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

Settings set

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