MClimate API Documentation
Search…
API Control
Functions
Vicki
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": "0******6",
4
"version": 1,
5
"uptime": "2020-11-24T17:35:20.024Z",
6
"displayDigits": 23, //digits in range 5-30; to be regarded as Target Temperature
7
"temperature": 15.4296875, // ambient temperature in celsius
8
"humidity": 99.609375, // relative ambient humidity in %
9
"motorRange": 506, // total range of the step motor
10
"motorPosition": 0, // current position of the step motor
11
"batteryVoltage": 3,
12
"ip": "",
13
"port": 24189,
14
"openWindow": false, //If open window event was detected and the settings
15
are currently executed, field “openWindow” will be true;
16
"childLock": false,
17
"pendingCommandStatus": {
18
"statusOfLastDisplayDigitsCommand": "sent",
19
"statusOfLastMotorPositionCommand": "sent",
20
"pendingDisplayDigits": null,
21
"pendingMotorPosition": null,
22
"lastUnsentToDeviceCommand": null
23
},
24
"online": true,
25
"timeOfRecord": "2020-11-24T17:36:00.905Z"
26
},
27
"_links": {
28
"self": {
29
"href": "/v1/provider/fetch"
30
}
31
}
32
}
Copied!
Vicki high priority commands:
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
"_links": {
4
"self": {
5
"href": "/v1/provider/send"
6
}
7
}
8
}
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
"_links": {
4
"self": {
5
"href": "/v1/provider/send"
6
}
7
}
8
}
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
"_links": {
4
"self": {
5
"href": "/v1/provider/send"
6
}
7
}
8
}
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
254,
4
5,
5
0,
6
0
7
],
8
"_links": {
9
"self": {
10
"href": "/v1/provider/send"
11
}
12
}
13
}
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
254,
4
5,
5
0,
6
0
7
],
8
"_links": {
9
"self": {
10
"href": "/v1/provider/send"
11
}
12
}
13
}
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
254,
4
5,
5
0,
6
0
7
],
8
"_links": {
9
"self": {
10
"href": "/v1/provider/send"
11
}
12
}
13
}
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
254,
4
5,
5
0,
6
0
7
],
8
"_links": {
9
"self": {
10
"href": "/v1/provider/send"
11
}
12
}
13
}
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" : 30 // in seconds
5
}
Copied!
Response:
1
{
2
"provider": [
3
254,
4
5,
5
0,
6
0
7
],
8
"_links": {
9
"self": {
10
"href": "/v1/provider/send"
11
}
12
}
13
}
Copied!
Assign Vicki to Mom
Request URL:
1
PATCH /vickies/{Vicki Serial Number}
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body:
1
{
2
"mom_id": 16***3
3
}
Copied!
Response:
1
{
2
"vicki": {
3
"id": 2*7,
4
"controller_id": 1***4,
5
"mom_id": 1***3,
6
"display_digits": 18,
7
"motor_position": 0,
8
"motor_range": 0,
9
"battery_level": 0,
10
"keepalive_time": 60,
11
"open_window": "{\"delta\": 1, \"enabled\": false, \"close_time\": 20}",
12
"temp_range_min": 5,
13
"temp_range_max": 30,
14
"algorithm_status": "v1",
15
"force_close": 0,
16
"dev_eui": null,
17
"app_eui": null,
18
"app_key": null,
19
"network_provider": null
20
},
21
"_links": {
22
"self": {
23
"href": "/v1/vickies/ZA*********4L"
24
}
25
}
26
}
Copied!
Last modified 7mo ago