Vicki LoRaWAN

Get device data

Request URL:
1
POST /provider/fetch
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number" : "{Vicki Serial Number}"
3
}
Copied!
Response:
1
{
2
"provider": {
3
"mac": "70B3D52DD300015E",
4
"displayDigits": 26,
5
"temperature": 24.453125,
6
"humidity": 32.03125,
7
"motorRange": 492,
8
"motorPosition": 250,
9
"batteryVoltage": 3.4000000000000004,
10
"openWindow": false,
11
"childLock": false,
12
"highMotorConsumption": false,
13
"lowMotorConsumption": false,
14
"rssi": -46,
15
"online": true,
16
"temeprature_range_settings": {
17
"min": 5,
18
"max": 30
19
},
20
"keepalive_time": 1,
21
"open_window_params": {
22
"enabled": false,
23
"duration": 20,
24
"motorPosition": 100,
25
"delta": 3
26
},
27
"operational_mode": "01",
28
"internal_algo_params": {
29
"period": 20,
30
"pFirstLast": 20,
31
"pNext": 20
32
},
33
"tdiff_params": {
34
"warm": 2,
35
"cold": 4
36
},
37
"uplink_type": "01",
38
"join_retry_period": 10,
39
"network_provider": "the_things_network"
40
},
41
"_links": {
42
"self": {
43
"href": "/v1/provider/fetch"
44
}
45
}
46
}
Copied!

Set motor position Only

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_motor_position_only",
4
"position" : 240 // range 0 to motorRange
5
}
Copied!
Response:
1
{
2
"provider": {
3
"commandName": "SetTargetTemperatureAndMotorPosition",
4
"commandParams": {
5
"motorPosition": 200,
6
"targetTemperature": 26
7
},
8
"deviceId": "70******************5E"
9
},
10
"_links": {
11
"self": {
12
"href": "/v1/provider/send"
13
}
14
}
15
}
Copied!

Set Target Temperature

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_motor_position",
4
"position" : 25 // digits in range 5-30
5
}
Copied!
Response:
1
{
2
"provider": {
3
"commandName": "SetTargetTemperatureAndMotorPosition",
4
"commandParams": {
5
"motorPosition": 200,
6
"targetTemperature": 25
7
},
8
"deviceId": "70****************E"
9
},
10
"_links": {
11
"self": {
12
"href": "/v1/provider/send"
13
}
14
}
15
}
Copied!

Set Motor Position and Target Temperature

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_mp_and_tt",
4
"motor_position" : 250, // range 0 to motorRange
5
"target_temperature": 25 // digits in range 5-30
6
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "603516e008f81715fffd182a",
5
"commandName": "SetTargetTemperatureAndMotorPosition",
6
"commandParams": {
7
"motorPosition": 250,
8
"targetTemperature": 26
9
},
10
"deviceId": "70****************E",
11
"createdAt": "2021-02-23T14:53:20.825Z",
12
"__v": 0
13
},
14
"_links": {
15
"self": {
16
"href": "/v1/provider/send"
17
}
18
}
19
}
Copied!

Set Open Window

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_open_window",
4
"enabled" : true, // true if we want to enable it or false if we want to
5
disable it
6
"close_time": 20, //for how long should the device keep the set motor position
7
after it detected an open window event (example value: 20 (if we want
8
to have the Vicki at the defined position for 20 minutes));
9
"motor_position": 300, //the motor position of the device for the specified time
10
after an open window event was detected
11
"delta" : 1 // the value of the desired difference in the measured temperature
12
(degrees in Celsius)
13
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6035176a08f81715fffd1832",
5
"commandName": "SetOpenWindow",
6
"commandParams": {
7
"enabled": true,
8
"delta": 1,
9
"closeTime": 20,
10
"motorPosition": 300
11
},
12
"deviceId": "70B*************E",
13
"createdAt": "2021-02-23T14:55:38.119Z",
14
"__v": 0
15
},
16
"_links": {
17
"self": {
18
"href": "/v1/provider/send"
19
}
20
}
21
}
Copied!

Get Open Window

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "get_open_window"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"enabled": true,
4
"close_time": 20,
5
"motor_position": 300,
6
"delta": 1
7
},
8
"_links": {
9
"self": {
10
"href": "/v1/provider/send"
11
}
12
}
13
}
14
Copied!

Child Lock

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "child_lock",
4
"enabled" : true, // true if we want to enable it or false if we want to
5
disable it
6
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "60353b9308f81715fffd18fb",
5
"commandName": "SetChildLock",
6
"commandParams": {
7
"enabled": true
8
},
9
"deviceId": "70*************E",
10
"createdAt": "2021-02-23T17:29:55.911Z",
11
"__v": 0
12
},
13
"_links": {
14
"self": {
15
"href": "/v1/provider/send"
16
}
17
}
18
}
Copied!

Set Min/Max Range

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_range",
4
"min" : 10, // the minimum value* for the device range
5
"max" : 20 // the maximum value* for the device range
6
}
Copied!
*Note that the min/max values should be between 5 and 30!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "60353c9e08f81715fffd1907",
5
"commandName": "SetTemperatureRange",
6
"commandParams": {
7
"min": 10,
8
"max": 20
9
},
10
"deviceId": "70B3D52DD300015E",
11
"createdAt": "2021-02-23T17:34:22.884Z",
12
"__v": 0
13
},
14
"_links": {
15
"self": {
16
"href": "/v1/provider/send"
17
}
18
}
19
}
Copied!

Get Min/Max Range

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "get_range"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"min": 10,
4
"max": 20
5
},
6
"_links": {
7
"self": {
8
"href": "/v1/provider/send"
9
}
10
}
11
}
Copied!

Summer Mode

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "summer_mode",
4
"enabled:" : true
5
}
Copied!
Response:
1
{
2
"provider": {
3
"success": true,
4
"message": "Vicki was succesfully updated."
5
},
6
"_links": {
7
"self": {
8
"href": "/v1/provider/send"
9
}
10
}
11
}
Copied!
More info about summer mode command:

Force Close Vicki

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "force_close_vicki"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "60353d1f08f81715fffd190f",
5
"commandName": "ForceClose",
6
"commandParams": [],
7
"deviceId": "70*************E",
8
"createdAt": "2021-02-23T17:36:31.367Z",
9
"__v": 0
10
},
11
"_links": {
12
"self": {
13
"href": "/v1/provider/send"
14
}
15
}
16
}
Copied!

Set KeepAlive Time

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_keepalive_time",
4
"time" : 3 // in minutes, minimum is 3
5
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "60353eea08f81715fffd1924",
5
"commandName": "SetKeepAlive",
6
"commandParams": {
7
"time": 3
8
},
9
"deviceId": "70*************E",
10
"createdAt": "2021-02-23T17:44:10.252Z",
11
"__v": 0
12
},
13
"_links": {
14
"self": {
15
"href": "/v1/provider/send"
16
}
17
}
18
}
Copied!

Get KeepAlive Time

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "get_keepalive_time"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6036c795994ab35c7c701b95",
5
"commandName": "GetKeepAliveTime",
6
"commandParams": [],
7
"deviceId": "70*************E",
8
"createdAt": "2021-02-24T21:39:33.922Z",
9
"__v": 0
10
},
11
"_links": {
12
"self": {
13
"href": "/v1/provider/send"
14
}
15
}
16
}
Copied!

Set Offline Algorithm Parameters

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_offline_algo_params",
4
"period": 10, // in minutes
5
"p_first_last":20, // steps
6
"p_next":20 // steps
7
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "603548f308f81715fffd1985",
5
"commandName": "SetInternalAlgoParams",
6
"commandParams": {
7
"period": 10,
8
"pFirstLast": 20,
9
"pNext": 20
10
},
11
"deviceId": "70*************E",
12
"createdAt": "2021-02-23T18:26:59.826Z",
13
"__v": 0
14
},
15
"_links": {
16
"self": {
17
"href": "/v1/provider/send"
18
}
19
}
20
}
Copied!

Get Offline Algorithm Parameters

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "get_offline_algo_params"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"period": 10,
4
"p_first_last": 20,
5
"p_next": 20
6
},
7
"_links": {
8
"self": {
9
"href": "/v1/provider/send"
10
}
11
}
12
}
Copied!

Set Offline Algorithm Tdiff Parameters

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_offline_algo_tdiff_params",
4
"warm": 1, // in °C
5
"cold":1 // in °C
6
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6081bebaa72e0d0018734b14",
5
"commandName": "SetInternalAlgoTdiffParams",
6
"commandParams": {
7
"cold": 1,
8
"warm": 1
9
},
10
"deviceId": "70*************E",
11
"createdAt": "2021-04-22T18:21:46.742Z",
12
"__v": 0
13
},
14
"_links": {
15
"self": {
16
"href": "/v1/provider/send"
17
}
18
}
19
}
Copied!

Request Offline Algorithm Tdiff Parameters

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "request_offline_algo_tdiff_params"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"commandName": "GetInternalAlgoTdiffParams",
4
"commandParams": [],
5
"deviceId": "70*************E"
6
},
7
"_links": {
8
"self": {
9
"href": "/v1/provider/send"
10
}
11
}
12
}
Copied!

Set Watch Dog Params

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_watch_dog_params",
4
"confirmed_uplinks": 3,
5
"unconfirmed_uplinks":3
6
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "611baa3f0c6c35001c5e737d",
5
"commandName": "SetWatchDogParams",
6
"commandParams": {
7
"confirmedUplinks": 3,
8
"unconfirmedUplinks": 3
9
},
10
"deviceId": "70B3D52DD3000F10",
11
"createdAt": "2021-08-17T12:23:27.419Z",
12
"__v": 0
13
},
14
"_links": {
15
"self": {
16
"href": "/v1/provider/send"
17
}
18
}
19
}
Copied!

Get Watch Dog Params

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "get_watch_dog_params"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6036ce5bf6c1b85f22d280cc",
5
"commandName": "GetWatchDogParams",
6
"commandParams": [],
7
"deviceId": "36*************8",
8
"createdAt": "2021-02-24T22:08:27.116Z",
9
"__v": 0
10
},
11
"_links": {
12
"self": {
13
"href": "/v1/provider/send"
14
}
15
}
16
}
Copied!

Get Device Version

Request URL:
1
POST /provider/fetch
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number" : "{Vicki Serial Number}",
3
"command" : "get_device_version"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6036c987994ab35c7c701bac",
5
"commandName": "GetDeviceVersion",
6
"commandParams": [],
7
"deviceId": "36*************8",
8
"createdAt": "2021-02-24T21:47:51.812Z",
9
"__v": 0
10
},
11
"_links": {
12
"self": {
13
"href": "/v1/provider/send"
14
}
15
}
16
}
Copied!

Set Join Retry Period

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_join_retry_period",
4
"period" : 2, //minutes, cannot be 0
5
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6036c9c3994ab35c7c701bb1",
5
"commandName": "SetJoinRetryPeriod",
6
"commandParams": {
7
"period": 2
8
},
9
"deviceId": "36*************8",
10
"createdAt": "2021-02-24T21:48:51.970Z",
11
"__v": 0
12
},
13
"_links": {
14
"self": {
15
"href": "/v1/provider/send"
16
}
17
}
18
}
Copied!

Get Join Retry Period

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "get_join_retry_period"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6036caaf994ab35c7c701bbe",
5
"commandName": "GetJoinRetryPeriod",
6
"commandParams": [],
7
"deviceId": "36*************8",
8
"createdAt": "2021-02-24T21:52:47.045Z",
9
"__v": 0
10
},
11
"_links": {
12
"self": {
13
"href": "/v1/provider/send"
14
}
15
}
16
}
Copied!
Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_uplink_type",
4
"type" : "01" // string, "00" - unconfirmed, "01" - confirmed
5
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6036cb0a994ab35c7c701bc4",
5
"commandName": "SetUplinkType",
6
"commandParams": {
7
"type": "01"
8
},
9
"deviceId": "36*************8",
10
"createdAt": "2021-02-24T21:54:18.528Z",
11
"__v": 0
12
},
13
"_links": {
14
"self": {
15
"href": "/v1/provider/send"
16
}
17
}
18
}
Copied!
Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "get_uplink_type"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6036cb66994ab35c7c701bcb",
5
"commandName": "GetUplinkType",
6
"commandParams": [],
7
"deviceId": "36*************8",
8
"createdAt": "2021-02-24T21:55:50.153Z",
9
"__v": 0
10
},
11
"_links": {
12
"self": {
13
"href": "/v1/provider/send"
14
}
15
}
16
}
Copied!

Set Operational Mode

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "set_operational_mode",
4
"mode": "00" // string,
5
// "00" - Online manual control mode. Default for the device,
6
// "01" - Online automatic control mode;
7
// "02" - Online automatic control mode with external temperature reading.
8
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6081c55fe4aff80018adb8f8",
5
"commandName": "SetOperationalMode",
6
"commandParams": {
7
"mode": "00"
8
},
9
"deviceId": "70*************E",
10
"createdAt": "2021-04-22T18:50:07.561Z",
11
"__v": 0
12
},
13
"_links": {
14
"self": {
15
"href": "/v1/provider/send"
16
}
17
}
18
}
Copied!

Request Operational Mode

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "request_operational_mode"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6036cb66994ab35c7c701bcb",
5
"commandName": "GetOperationalMode",
6
"commandParams": [],
7
"deviceId": "36*************8",
8
"createdAt": "2021-02-24T21:55:50.153Z",
9
"__v": 0
10
},
11
"_links": {
12
"self": {
13
"href": "/v1/provider/send"
14
}
15
}
16
}
Copied!

Recalibrate Motor

Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"serial_number": “{Vicki Serial Number}”,
3
"command" : "recalibrate_motor"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6081c92ce4aff80018adb97b",
5
"commandName": "RecalibrateMotor",
6
"commandParams": [],
7
"deviceId": "36*************8",
8
"createdAt": "2021-04-22T19:06:20.812Z",
9
"__v": 0
10
},
11
"_links": {
12
"self": {
13
"href": "/v1/provider/send"
14
}
15
}
16
}
Copied!

Last modified 3mo ago