Skip to content

canair routines

usage: canair routines [-h] [--rid RID] [--sf SF] [--wican WICAN]
                       [--transport {slcan-tcp,wican-ws,elm327-tcp}]
                       [--no-fallback] [--wait] [--elm-timeout MS]
                       [--timeout SECONDS] [--json] [--verbose] [--timings]
                       [--reboot] [--unsafe] [--force]
                       [ECU]

[UDS] RoutineControl (0x31): interactive TUI, or single command with --rid.

positional arguments:
  ECU                   ECU name (e.g. BCM)

options:
  -h, --help            show this help message and exit
  --rid RID             Routine ID to execute (e.g. 12A1)
  --sf SF               Sub-function: results (0x03, safe default), start
                        (0x01, actuates), stop (0x02)
  --wican WICAN         WiCAN address: ap or IP (default: config
                        transport.host / default_wican=ap)
  --transport {slcan-tcp,wican-ws,elm327-tcp}
                        CAN transport: slcan-tcp (raw CAN), wican-ws (WiCAN
                        ELM327 WebSocket), or elm327-tcp (direct ELM327
                        adapter over TCP). Overrides the config
                        `transport.type` (default: slcan-tcp).
  --no-fallback         Don't auto-fall-back to other configured devices when
                        the selected one is unreachable (see config
                        transport.fallback).
  --wait                Keep retrying to reach the device indefinitely, then
                        start as soon as it comes online (Ctrl-C to stop). For
                        'monitor', also reconnects forever if the connection
                        drops mid-session (auto-failover to another same-
                        transport device is bounded by default; --wait makes
                        it unbounded).
  --elm-timeout MS      ELM327 ECU response timeout in ms (sent as ATSTxx
                        after init)
  --timeout SECONDS     Overall UDS response timeout in seconds (default 3.0
                        ELM / 2.0 raw). Overrides any per-ECU
                        response_timeout_ms for the whole run.
  --json                Output results as JSON
  --verbose, -v         Show raw transport traffic and expressions
  --timings             Print per-ECU/PID round-trip timing stats on exit (to
                        stderr)
  --reboot              Reboot WiCAN after session to restore AutoPID mode
  --unsafe              Bypass dangerous command blocklist (requires explicit
                        per-command consent)
  --force               Ask a session already holding the connection to
                        release it, then wait for it

examples:
  canair routines BCM                     Interactive TUI
  canair routines BCM --json              List all BCM routines (offline JSON)
  canair routines BCM --rid 12A1          Request results (SF 0x03, safe)
  canair routines BCM --rid 12A1 --sf stop