API Reference - configuration.consumptionUnit
This API allows to work HMI unit of consumption.
Info:
- Internal combustion engine vehicle, allowed values are in [0-2] range
- Electric vehicle, allowed values are in [3-5] range
Error: In case the vehicle do not allow the selected consumption unit (exemple: set kwh a thermic vehicle), you’ll receive this response with "status": 500, "statusText": "Error: value isn't allowed in this configuration"
Input Parameter | |||||
---|---|---|---|---|---|
No input params |
Output Data | ||||
---|---|---|---|---|
Data name | Description | Type | Unit/Values | Example |
consumptionUnit | An int that correspond to a unit of consumption. |
int |
- 0: 'Liters per 100 kms'
- 1: 'Kilometer per liter'
- 2: 'Miles per gallon'
- 3: 'KWh per 100 kms'
- 4: 'Km per KWh'
- 5: 'Miles per KWh'
- 6: 'Invalid unit'
|
0
|
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
/* api name */
"configuration.consumptionUnit",
/* 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": "configuration.consumptionUnit",
"params": null
}
1
2
3
4
5
6
7
8
9
10
// --- format of the `REPLY` message ---
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"api": "configuration.consumptionUnit",
"status": 200,
"statusText": "OK",
"data": 0
}
false
This API allows to work HMI unit of consumption.
Info:
- Internal combustion engine vehicle, allowed values are in [0-2] range
- Electric vehicle, allowed values are in [3-5] range
Error: In case the vehicle do not allow the selected consumption unit (exemple: set kwh a thermic vehicle), you’ll receive this response with "status": 500, "statusText": "Error: value isn't allowed in this configuration"
Input Parameter | |||||
---|---|---|---|---|---|
Param name | Description | Type | Unit/Values | Example | Required |
consumptionUnit | An int that correspond to a unit of consumption |
int |
- 0: 'Liters per 100 kms'
- 1: 'Kilometer per liter'
- 2: 'Miles per gallon'
- 3: 'KWh per 100 kms'
- 4: 'Km per KWh'
- 5: 'Miles per KWh'
- 6: 'Invalid unit'
|
0
|
true |
Output Data | ||||
---|---|---|---|---|
No outputted data |
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.set(
/* api name */
"configuration.consumptionUnit",
/* parameters */
0
)
/* 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": "SET",
"api": "configuration.consumptionUnit",
"params": 0
}
1
2
3
4
5
6
7
8
9
// --- format of the `REPLY` message ---
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"api": "configuration.consumptionUnit",
"status": 200,
"statusText": "OK"
}
false
This API allows to work HMI unit of consumption.
Info:
- Internal combustion engine vehicle, allowed values are in [0-2] range
- Electric vehicle, allowed values are in [3-5] range
Error: In case the vehicle do not allow the selected consumption unit (exemple: set kwh a thermic vehicle), you’ll receive this response with "status": 500, "statusText": "Error: value isn't allowed in this configuration"
Input Parameter | |||||
---|---|---|---|---|---|
No input params |
Output Data | ||||
---|---|---|---|---|
Data name | Description | Type | Unit/Values | Example |
consumptionUnit | An int that correspond to a unit of consumption. |
int |
- 0: 'Liters per 100 kms'
- 1: 'Kilometer per liter'
- 2: 'Miles per gallon'
- 3: 'KWh per 100 kms'
- 4: 'Km per KWh'
- 5: 'Miles per KWh'
- 6: 'Invalid unit'
|
0
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
webportal.subscribe(
/* api name */
"configuration.consumptionUnit",
/* 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": "configuration.consumptionUnit",
"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
// --- 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": "configuration.consumptionUnit",
"status": 200,
"statusText": "OK",
"data": 0
}