canair read

Alias: query

usage: canair read [-h] [--param NAME [NAME ...]] [--session] [--wake]
                   [--repl] [--save] [--label TEXT] [--state TEXT]
                   [--notes TEXT] [--include-static] [--wican WICAN]
                   [--transport {slcan-tcp,wican-ws,elm327-tcp}]
                   [--no-fallback] [--wait] [--elm-timeout MS]
                   [--timeout SECONDS] [--json] [--verbose] [--timings]
                   [--reboot] [--unsafe] [--force]
                   [STEP ...]

[UDS] Read ECUs/parameters live. Positional STEPs use the multi mini-language.

positional arguments:
  STEP                  Read selector(s), @group(s), or multi mini-language
                        step(s)

options:
  -h, --help            show this help message and exit
  --param NAME [NAME ...]
                        Read named parameters instead of selectors
  --session             Enter extended session (10 03)
  --wake                Wake ECUs from deep sleep (10 01)
  --repl                Drop into REPL after the pipeline
  --save                Save results to captures/
  --label TEXT          Session label for --save
  --state TEXT          Session state for --save
  --notes TEXT          Session notes for --save
  --include-static      Include static config/identity PIDs (e.g. 21F2) in a
                        bare-ECU sweep. By default `canair read ECU` omits
                        PIDs flagged static:true; naming one explicitly
                        (ECU:21F2) always queries it.
  --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 read BMS:2101                      Read BMS PID 2101
  canair read "VCU:2101 BMS:2101"           Cross-ECU read
  canair read @charging                     Read a saved group (see `canair groups`)
  canair read @driving CLU:220B             A group plus an extra selector
  canair read "skm-wake acc" "query IGPM:BC03,BC06"
  canair read --param SOC_BMS SOC_DISP      Read named parameters

`canair query` is a kept alias. For a live, continuously-refreshing view use
`canair monitor` instead.