MClimate API Documentation
Search…
MClimate API Documentation
MClimate LoRaWAN Devices
Basic endpoints
API Control
Melissa
Bobbie
Vicki
Vicki LoRaWAN
HT sensor
HT Sensor LoRaWAN
CO2 Sensor LoRaWAN
T-Valve LoRaWAN
Flood Sensor LoRaWAN
AQI Sensor LoRaWAN
Smart Plug
Shelly 1/1PM/EM
Maya
Functions
Schedules
Thermostat mode
Powered By
GitBook
HT Sensor 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" : "{HT-Sensor Serial Number}"
3
}
Copied!
Response:
1
{
2
"provider": {
3
"network_provider": "the_things_network",
4
"rssi": -59,
5
"spf": "SF7BW125",
6
"sensorTemperature": 23.7,
7
"relativeHumidity": 28.90625,
8
"batteryVoltage": 3,
9
"createdAt": "2021-02-10T15:21:23.718Z",
10
"lastActive": "2021-02-24T21:10:58.777Z",
11
"keepAliveTime": 3,
12
"joinRetryPeriod": 2,
13
"deviceVersions": {
14
"hardware": 16,
15
"software": 16
16
},
17
"uplinkType": "01",
18
"online": true,
19
"mac": "70B************4"
20
},
21
"_links": {
22
"self": {
23
"href": "/v1/provider/fetch"
24
}
25
}
26
}
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": “{HT-Sensor Serial Number}”,
3
"command" : "set_keepalive_time",
4
"time" : 3 // in minutes
5
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "60366d3cbc2b0345b984da00",
5
"commandName": "SetKeepAlive",
6
"commandParams": {
7
"time": 3
8
},
9
"deviceId": "70B************4",
10
"createdAt": "2021-02-24T15:14:04.444Z",
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": “{HT-Sensor Serial Number}”,
3
"command" : "get_keepalive_time"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6036b85b25304f575e082397",
5
"commandName": "GetKeepAliveTime",
6
"commandParams": [],
7
"deviceId": "70B************4",
8
"createdAt": "2021-02-24T20:34:35.934Z",
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" : "{HT-Sensor Serial Number}",
3
"command" : "get_device_version"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "603672f5bc2b0345b984da43",
5
"commandName": "GetDeviceVersion",
6
"commandParams": [],
7
"deviceId": "70B************4",
8
"createdAt": "2021-02-24T15:38:29.537Z",
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": “{HT-Sensor 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": "603675a7bc2b0345b984da63",
5
"commandName": "SetJoinRetryPeriod",
6
"commandParams": {
7
"period": 2
8
},
9
"deviceId": "70B************4",
10
"createdAt": "2021-02-24T15:49:59.095Z",
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": “{HT-Sensor 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": "70B************4",
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!
Set Uplink Type
Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body
:
1
{
2
"serial_number": “{HT-Sensor 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": "6036bf46ed10eb592440aea5",
5
"commandName": "SetUplinkType",
6
"commandParams": {
7
"type": "01"
8
},
9
"deviceId": "70B************4",
10
"createdAt": "2021-02-24T21:04:06.611Z",
11
"__v": 0
12
},
13
"_links": {
14
"self": {
15
"href": "/v1/provider/send"
16
}
17
}
18
}
Copied!
Get Uplink Type
Request URL:
1
POST /provider/send
Copied!
Headers:
1
Content-Type: application/json
2
Authorization: Bearer {access_token}
Copied!
Body
:
1
{
2
"serial_number": “{HT-Sensor Serial Number}”,
3
"command" : "get_uplink_type"
4
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6036be66ed10eb592440ae9b",
5
"commandName": "GetUplinkType",
6
"commandParams": [],
7
"deviceId": "70B************4",
8
"createdAt": "2021-02-24T21:00:22.088Z",
9
"__v": 0
10
},
11
"_links": {
12
"self": {
13
"href": "/v1/provider/send"
14
}
15
}
16
}
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": “{HT Serial Number}”,
3
"command" : "set_watch_dog_params",
4
"period_confirmen_uplinks": 17, // in minutes, if it is disabled "0"
5
"period_unconfirmen_uplinks":24, // in hours, if it is disabled "0"
6
"device_keepalive":3 // in minutes
7
}
Copied!
Response:
1
{
2
"provider": {
3
"status": "pending",
4
"_id": "6035505708f81715fffd19c0",
5
"commandName": "SetWatchDogParams",
6
"commandParams": {
7
"periodConfirmenUplinks": 17,
8
"periodUnconfirmenUplinks": 24,
9
"deviceKeepAlive": 3
10
},
11
"deviceId": "36*************8",
12
"createdAt": "2021-02-23T18:58:31.945Z",
13
"__v": 0
14
},
15
"_links": {
16
"self": {
17
"href": "/v1/provider/send"
18
}
19
}
20
}
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": “{HT 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!
API Control - Previous
HT sensor
Next - API Control
CO2 Sensor LoRaWAN
Last modified
10mo ago
Copy link
Contents
Get device data
Set KeepAlive Time
Get KeepAlive Time
Get Device Version
Set Join Retry Period
Get Join Retry Period
Set Uplink Type
Get Uplink Type
Set Watch Dog Params
Get Watch Dog Params