Webportal v2

embedded apps

API Reference - settings.units

Edit
Availability: SDK only.
Required Privacy: Always available
Operations:
GET
settings.units
Edit

This API allows to retrieve HMI units.

Using configuration.consumptionUnit you are able to change system units.

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
distance

Unit of distance in the HMI.

string

 - km
- miles 		miles
volume

Unit of volume in the HMI.

string

 - liter
- gallon 		liter
consumption

Unit of consumption in the HMI.

string

 - l/100km
- km/l
- mpg
- Kwh/100km
- km/Kwh
- invalid 		km/l
speed

Unit of speed in the HMI.

string

 - km/h
- mph 		mph
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12
13

webportal.get(
    /* api name */
    "settings.units",
    /* 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": "settings.units",
  "params":  null
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "settings.units",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "distance": "miles",
    "volume": "liter",
    "consumption": "km/l",
    "speed": "mph"
  } 
}

false

SUBSCRIBE
settings.units
Edit

This API allows to retrieve HMI units.

Using configuration.consumptionUnit you are able to change system units.

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
distance

Unit of distance in the HMI.

string

 - km
- miles 		miles
volume

Unit of volume in the HMI.

string

 - liter
- gallon 		liter
consumption

Unit of consumption in the HMI.

string

 - l/100km
- km/l
- mpg
- Kwh/100km
- km/Kwh
- invalid 		km/l
speed

Unit of speed in the HMI.

string

 - km/h
- mph 		mph
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 */
    "settings.units",
    /* 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": "settings.units",
  "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

// --- 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": "settings.units",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "distance": "miles",
    "volume": "liter",
    "consumption": "km/l",
    "speed": "mph"
  } 
}

Back to Ref List

Related References