API Reference - driving.currentGear
This API allows to retrieve current gear engaged.
This API is available starting software 20.60.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| currentGear | Value of the currently engaged gear. |
int |
- 0: 'P'
- 1: 'R'
- 2: 'N'
- 3: 'D'
- 4: '6th gear'
- 5: '5th gear'
- 6: '4th gear'
- 7: '3rd gear'
- 8: '2nd gear'
- 9: '1st gear'
- 10: 'Invalid'
- 11: 'No gear to display'
- 12: '7th gear'
|
12
|
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
/* api name */
"driving.currentGear",
/* 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": "driving.currentGear",
"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": "driving.currentGear",
"status": 200,
"statusText": "OK",
"data": 12
}
false
This API allows to retrieve current gear engaged.
This API is available starting software 20.60.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| currentGear | Value of the currently engaged gear. |
int |
- 0: 'P'
- 1: 'R'
- 2: 'N'
- 3: 'D'
- 4: '6th gear'
- 5: '5th gear'
- 6: '4th gear'
- 7: '3rd gear'
- 8: '2nd gear'
- 9: '1st gear'
- 10: 'Invalid'
- 11: 'No gear to display'
- 12: '7th gear'
|
12
|
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 */
"driving.currentGear",
/* 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": "driving.currentGear",
"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": "driving.currentGear",
"status": 200,
"statusText": "OK",
"data": 12
}