Skip to content

canair signals

usage: canair signals [-h] {list,upsert,rm} ...

[CAN] ``canair signals`` — view/edit broadcast signal definitions (domain B).

The broadcast-frame (domain-B) authoring counterpart to ``canair pids`` (which
authors domain-A diagnostic UDS PID params): manage the ``signals/<bus>.yaml``
sidecar (arbitration ID → named linear signals) with surgical, validated,
comment-preserving edits (via :mod:`canlib.signals_edit`). Never hand-edit the
sidecar. See ``plans/2026-07-24-raw-can-analysis.md``.

  canair signals                     # list all broadcast signals
  canair signals list [BUS]          # list (optionally one bus)
  canair signals upsert BUS 0x386 WHL_SPD_FL --start-bit 0 --length 14 \
      --byte-order little --scale 0.03125 --unit km/h
  canair signals rm BUS 0x386 WHL_SPD_FL

positional arguments:
  {list,upsert,rm}
    list            List broadcast signals (optionally one bus)
    upsert          Add or update a broadcast signal
    rm              Remove a broadcast signal

options:
  -h, --help        show this help message and exit

canair signals list

usage: canair signals list [-h] [--json] [bus]

positional arguments:
  bus         Restrict to one bus (signals/<bus>.yaml)

options:
  -h, --help  show this help message and exit
  --json      Machine-readable output

canair signals upsert

usage: canair signals upsert [-h] --start-bit START_BIT --length LENGTH
                             [--byte-order {little,big}] [--scale SCALE]
                             [--offset OFFSET] [--min MIN] [--max MAX]
                             [--unit UNIT] [--verified] [--unverified]
                             [--source SOURCE] [--notes NOTES]
                             [--msg-name MSG_NAME] [--tx-ecu TX_ECU]
                             bus arb_id name

positional arguments:
  bus                   Bus name (signals/<bus>.yaml)
  arb_id                Arbitration ID, e.g. 0x386
  name                  Signal name, e.g. WHL_SPD_FL

options:
  -h, --help            show this help message and exit
  --start-bit START_BIT
  --length LENGTH
  --byte-order {little,big}
  --scale SCALE
  --offset OFFSET
  --min MIN
  --max MAX
  --unit UNIT
  --verified
  --unverified
  --source SOURCE       Provenance (DBC, log file, or RE evidence)
  --notes NOTES
  --msg-name MSG_NAME   Message name (DBC BO_ name)
  --tx-ecu TX_ECU       Transmitting ECU (annotation)

canair signals rm

usage: canair signals rm [-h] bus arb_id name

positional arguments:
  bus
  arb_id      Arbitration ID, e.g. 0x386
  name

options:
  -h, --help  show this help message and exit