canair read¶
Alias: query
usage: canair read [-h] [--param NAME [NAME ...]] [--session] [--wake]
[--repl] [--save] [--label TEXT] [--state TEXT]
[--notes TEXT] [--reveal] [--include-static]
[--wican WICAN]
[--transport {slcan-tcp,wican-ws,elm327-tcp}]
[--no-fallback] [--wait] [--elm-timeout MS]
[--timeout SECONDS] [--no-learn-frames] [--json]
[--verbose] [--timings] [--reboot] [--unsafe] [--force]
[STEP ...]
[UDS] Read ECUs/signals 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 signals instead of selectors
--session Enter extended session (10 03)
--wake Wake ECUs from deep sleep first (the ECU's wake:
ritual, else 10 01)
--repl Drop into REPL after the pipeline
--save Save results to captures/
--label TEXT Session label for --save (asked for when omitted; with
no terminal the session is saved under a generated
label)
--state TEXT Session state for --save
--notes TEXT Session notes for --save
--reveal Show sensitive PIDs and signals (`sensitive: true`,
e.g. the CCM's EVCCID) in clear instead of *****.
Display only: cannot be combined with --save, and a
sensitive reply is never saved either way.
--include-static Include static and slow PIDs (identity/calibration
blocks and per-cycle records such as 21F2) in a bare-
ECU sweep. By default `canair read ECU` omits PIDs
with status: static or slow; 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.
--no-learn-frames Don't write response_frames back into the profile's
ecus/ when this session confirms how many CAN frames a
PID's response occupies (the count that lets the
adapter answer without waiting out its full ECU
timeout). Use when reading a car the active profile
doesn't describe.
--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
(skipped on firmware v6, which resumes AutoPID by
itself)
--unsafe Bypass the dangerous-command blocklist: each refused
command asks for typed consent before it is sent.
Works only after the user sets safety.allow_unsafe to
true at a terminal (canair config set
safety.allow_unsafe true)
--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 BMS:01/0D OBD-II mode 01 PID 0D (an undefined bare
010D would read DID 0x010D)
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 signals
`canair query` is a kept alias. For a live, continuously-refreshing view use
`canair monitor` instead.