platform health

Description

Provides details on the compute, storage, power and processes of a vehicle.

Field	datatype	Description
utime	string	Best estimate of when this message is from, host clock in UTC
groupId	Group Id	Each group is identified by its ID. Within a group
value	uint32	the value of interpretation
valueId	Value Id	the ID to define the interpretation of the value
vehicle	string	unique vehicle name the data is associated to.
topic	string	type of telemetry data

Enums

The enumerator values used to represent each field type with its description.

Group Id

Value	Description
1	Compute
2	Storage
3	Power
4	Process
5	Software

Value Id

Value	Description
1	Load 1 Min
2	Load 5 Min
3	Load 15 Min
4	Uptime in Seconds
5	Ram Used in MB
6	Ram Total in MB
7	Swap Used in MB
8	Swap Total in MB
9	Temp Thermal Zone from ACPI
10	Temp Thermal Zone from PCH
11	Temp Thermal Zone from internal X86 pacakges
12	Temp Thermal Zone from IWL WIFI
13	TempThermalZone from the MCU BCM2835
14	TempThermalZone from the processor/CPU Thermal
15	Redundant CPU and PSU
16	Temp Thermal Zone from internal X86 packages 2
17	ECC Correc table Error Count
18	ECC Uncorrec table Error Count
19	CPU Throttle Count

Topic/channel string

For Realtime API

Pass the comma seperated topic name as a query param

/.vehicle.{vehiclename}.PLATFORM_HEALTH

For Batch API - TBD

To access the Batch API, you need to include the vehicle name and topic name as path parameters in the URL.

/vehicles/{vehiclename}/topics/PLATFORM_HEALTH

JSON Output

Order of fields might differ

{
    "nparams": 21,
    "params": [
        {
            "groupId": 2,
            "value": 6900568,
            "valueId": 4
        },
        {
            "groupId": 2,
            "value": 709136,
            "valueId": 3
        },
        {
            "groupId": 2,
            "value": 427800,
            "valueId": 2
        },
        {
            "groupId": 2,
            "value": 266736,
            "valueId": 1
        },
        {
            "groupId": 1,
            "value": 18567,
            "valueId": 4
        },
        {
            "groupId": 1,
            "value": 744,
            "valueId": 1
        },
        {
            "groupId": 1,
            "value": 704,
            "valueId": 2
        },
        {
            "groupId": 1,
            "value": 699,
            "valueId": 3
        },
        {
            "groupId": 1,
            "valueId": 8
        },
        {
            "groupId": 1,
            "valueId": 7
        },
        {
            "groupId": 1,
            "value": 98399,
            "valueId": 6
        },
        {
            "groupId": 1,
            "value": 20916,
            "valueId": 5
        },
        {
            "groupId": 5,
            "value": 892940336,
            "valueId": 1
        },
        {
            "groupId": 5,
            "value": 842413878,
            "valueId": 2
        },
        {
            "groupId": 5,
            "value": 1681416547,
            "valueId": 3
        },
        {
            "groupId": 4,
            "value": 1,
            "valueId": 2
        },
        {
            "groupId": 1,
            "value": 1,
            "valueId": 15
        },
        {
            "groupId": 1,
            "valueId": 17
        },
        {
            "groupId": 1,
            "valueId": 18
        },
        {
            "groupId": 1,
            "valueId": 19
        },
        {
            "groupId": 4,
            "value": 1683649971,
            "valueId": 3
        }
    ],
    "topic": "PLATFORM_HEALTH",
    "utime": "1683652907942424",
    "vehicle": "vehiclenamegit "
}