A signalset is a JSON file that defines your car’s commands and signals. The OBDb signals schema defines its fields and validation rules.
The structure and property table below come from that schema. In this outline, ? marks an optional field and [] means an array:
{
"ecuecuobject[] · OptionalThe kind of module behind each address the commands are sent to.": object[]?,
"diagnosticLeveldiagnosticLevelstring · OptionalHexadecimal diagnostic code that should be used for the vehicle.": string?,
"commandscommandsobject[] · RequiredA collection of commands that can be executed to retrieve signal data.": object[],
"signalGroupssignalGroupsobject[] · OptionalGroups of related signals that should be presented together in UI or analysis": object[]?,
"syntheticssyntheticsobject[] · OptionalSignals that are computed from the values of other signals": object[]?
}Top-level properties
The schema defines these top-level fields:
| Property | Type | Required | Description |
|---|---|---|---|
ecu | object[] | No | The kind of module behind each address the commands are sent to. |
diagnosticLevel | string | No | Hexadecimal diagnostic code that should be used for the vehicle. |
commands | object[] | Yes | A collection of commands that can be executed to retrieve signal data. |
signalGroups | object[] | No | Groups of related signals that should be presented together in UI or analysis |
synthetics | object[] | No | Signals that are computed from the values of other signals |
Each entry in commands follows the Command format. A command contains signals, each with a format that converts the reply into a reading.
Signal groups
Each entry in signalGroups defines a group of related signals:
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Unique identifier for the signal group |
path | string | No | Path for organizing the group in a hierarchy |
matchingRegex | string | Yes | Regular expression pattern to match signal IDs that belong to this group |
suggestedMetricGroup | string | No | Standardized group name for common grouped metrics |
name | string | No | Human-readable name for the signal group |