Susi Server

ELM327 OBD-II Source

Node ID: elm327 · Role: Source · Realtime config: no

Description

Reads vehicle speed from an ELM327 OBD-II adapter over serial or Bluetooth. Polls PID 0x0D to produce VehicleSpeed data for dead-reckoning fusion.

Inputs / Outputs

Config aliases

Elm327Source, elm327Source, elm327

Properties

The following fields are exposed in the node’s Properties panel in the UI. Types map to UI widgets (e.g. string → text input, number → numeric, boolean → toggle, select → dropdown, json → JSON editor).

KeyLabelTypeDefaultOptionsDescription / Notes
portSerial Portselect""``, COM11, COM18, COM3, COM4, COM5, COM6, COM7, COM8Serial port of the ELM327 adapter.
baudrateBaud Rateselect1152009600, 38400, 57600, 115200, 230400Serial baud rate for the ELM327 adapter.
isPorschePorsche ModebooleanfalseUse the Porsche-specific PID set instead of the generic OBD-II PIDs.
protocolAutoDetectProtocol Auto-Detectbooleanfalse

Example node definition

A full node definition in config.json looks like the block below. Paste it under the sources key of your config, keyed by the node’s instance name (any identifier; it doesn’t have to match the node ID).

{
  "sources": {
    "elm327": {
      "outEndpoint": "inproc://elm327_data",
      "settings": {
        "baudrate": "115200",
        "isPorsche": false,
        "port": "",
        "protocolAutoDetect": false
      }
    }
  }
}

Field reference

FieldPurpose
outEndpointZMQ / inproc endpoint this source binds to publish its output. The runtime auto-generates one if omitted.
settingsAll user-configurable fields — see the Properties table above.

Connections can also be declared at the top-level connections array when settings.explicitConnections is true, as an alternative to filling inputEndpoints on each node.

Loading documentation…