API Reference - HVAC.climateContext
Required Privacy:
Data &
Location
This API allows to retrieve the current climate context.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| Activation | Return if the AC status. |
int |
- 0: off
- 1: on
|
true
|
| CenteredValue | int |
|
|
|
| OffsetLeft | int |
|
|
|
| OffsetRight | int |
|
|
|
| IsFarehneit | Return if the setting of temperature Farehneit or not. |
boolean |
- true: on
- false: off
|
false
|
| NumberOfZones | Enum of strings |
- 0: Monozone
- 1: Bizone
|
|
|
| TypeClim | Return 1 = Clim Type left. |
int |
|
1
|
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
/* api name */
"HVAC.climateContext",
/* parameters */
null
)
/* callback for `REPLY` messages */
.then((message) => {
if (message.status === 200) {
/* handle `REPLY` success */
}
else { /* handle `REPLY` error */ }
})
1
2
3
4
5
6
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "GET",
"api": "HVAC.climateContext",
"params": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// --- format of the `REPLY` message ---
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"api": "HVAC.climateContext",
"status": 200,
"statusText": "OK",
"data": {
"Activation": true,
"CenteredValue": ,
"OffsetLeft": ,
"OffsetRight": ,
"IsFarehneit": false,
"NumberOfZones": " ",
"TypeClim": 1
}
}
false
This API allows to retrieve the current climate context.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| Activation | Return if the AC status. |
int |
- 0: off
- 1: on
|
true
|
| CenteredValue | int |
|
|
|
| OffsetLeft | int |
|
|
|
| OffsetRight | int |
|
|
|
| IsFarehneit | Return if the setting of temperature Farehneit or not. |
boolean |
- true: on
- false: off
|
false
|
| NumberOfZones | Enum of strings |
- 0: Monozone
- 1: Bizone
|
|
|
| TypeClim | Return 1 = Clim Type left. |
int |
|
1
|
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
webportal.subscribe(
/* api name */
"HVAC.climateContext",
/* parameters */
null,
/* callback for `NOTIFY` messages */
async (notifyMessage) => {
if (notifyMessage.status === 200) {
/* handle `NOTIFY` response */
}
else { /* handle `NOTIFY` error */ }
}
)
/* callback for `REPLY` messages */
.then((message) => {
if (message.status === 200) {
/* handle `REPLY` success */
}
else { /* handle `REPLY` error */ }
})
1
2
3
4
5
6
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "SUBSCRIBE",
"api": "HVAC.climateContext",
"params": null
}
1
2
3
4
5
6
7
8
9
10
11
// --- format of the `REPLY` message ---
// type: acknowledge the status of the subscription
// reception: only once after the subscription request
// contains outputed data: no
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"status": 200,
"statusText": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// --- format of the `NOTIFY` message ---
// type: event message about the subscription
// reception: each time the conditions of the subscription are met
// contains outputed data: yes
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "NOTIFY",
"api": "HVAC.climateContext",
"status": 200,
"statusText": "OK",
"data": {
"Activation": true,
"CenteredValue": ,
"OffsetLeft": ,
"OffsetRight": ,
"IsFarehneit": false,
"NumberOfZones": " ",
"TypeClim": 1
}
}