health summary

Description

Outputs the status/errors of various modules running in a vehicle.

Field	datatype	Description
utime	string	Local machine utime of the most recently reported health update
statuses	[Statuses]	Array of Statuses
nuids	uint32	How many uids there are in the report
nfields	uint32	How many reporting fields for every uid there are
vehicle	string	unique vehicle name the data is associated to.
topic	string	type of telemetry data

Statuses

Field	datatype	Description
items	[string]	Array of {module, mapping, status (match for runlevel), error} indexed by uid

Status-Runlevel Mapping

Id	Runlevel
7	NOMINAL
6	CONSERVATIVE
5	CONTROLLED_STOP
4	BLIND_STOP
3	MANUAL
2	SERVICE
0	IGNORE

Topic/channel string

For Realtime API

Pass the comma seperated topic name as a query param

/.vehicle.{vehiclename}.HEALTH_SUMMARY

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/HEALTH_SUMMARY

JSON Output

Order of fields might differ

{
    "nfields": 4,
    "nuids": 354,
    "statuses": [
        {
            "items": [
                "unknown/uninitialized",
                "7",
                "unknown",
                "unknown"
            ]
        },
        {
            "items": [
                "rate monitor: ENCODER",
                "4",
                "okay",
                "okay"
            ]
        },
        {
            "items": [
                "rate monitor: EPAS_STATUS",
                "4",
                "okay",
                "okay"
            ]
        },
        .
        .
        .
        {
            "items": [
                "ovtl output monitor",
                "7",
                "okay",
                "okay"
            ]
        },
        {
            "items": [
                "health introspection monitor",
                "7",
                "unknown",
                "unknown"
            ]
        }
    ],
    "topic": "HEALTH_SUMMARY",
    "utime": "1683643023474304",
    "vehicle": "medusa"
}