Pelican sends a command to your car and reads signals from the response. The command defines where each signal appears and how to decode it.
Properties
The OBDb schema defines these properties:
| Property | Type | Required | Description |
|---|---|---|---|
hdr | string | Yes | Header identifier for the command, hex |
rax | string | No | Receive filter address, hex. On 29-bit CAN, up to six digits are the reply ID's low bits under the command's priority, and eight digits are the whole reply ID, for a module that answers at another priority |
eax | string | No | Extended address, hex |
pri | string | No | CAN priority, hex |
tst | string | No | Tester address, hex |
tmo | string | No | Timeout value, hex |
fcm1 | boolean | No | Whether to enable flow control; disabled by default |
dbg | boolean | No | Whether to debug the signal responses |
din | string | No | Diagnostic level the ECU must enter in order to run this command |
dout | string | No | Diagnostic level the ECU should return to after running this command |
cmd | object | Yes | Which service to execute the command on |
freq | number | Yes | Frequency at which to request this command, seconds |
baud | number | No | K-line bus rate in bits per second, for a 9141-2 or 14230 command. Without it the adapter's default applies, 10400 |
init | object | No | Fast-init wake-up timing in milliseconds, for a 14230 command whose module answers only to non-standard timing. Without it the adapter's own init applies, 25 ms low then 25 ms high |
proto | string | No | Communication protocol used for this command |
filter | object | No | |
dbgfilter | object | No | |
signals | object[] | Yes | Signals to extract from the command response |
ServicePID
A service PID pairs a service with its parameter ID. The object uses the service as its key and the PID as its value.
If baud is set, proto must be 9141-2 or 14230. If init is set, proto must be 14230.