canair wican
usage: canair wican [-h] <command> ...
[UDS] Build and sync the WiCAN device's AutoPID profile.
Nothing is written until you ask for it — a bare `canair wican` prints this help. Choose a subcommand:
autopid write generate the v4 and v6 AutoPID JSON to the bundle's out/
autopid upload generate + upload to the device (Pro)
autopid download download the device's current AutoPID JSON (Pro)
autopid diff download + diff against the generated JSON (Pro)
autopid show print the generated JSON for a QUERY, offline
autopid stats per-ECU/PID statistics table
mode show show the device's active protocol
mode set MODE switch the device protocol/mode, reboot + align transport (Pro)
positional arguments:
<command>
autopid Generate/sync the WiCAN AutoPID profile JSON
mode Show or set the WiCAN device protocol/mode
options:
-h, --help show this help message and exit
Build and sync the WiCAN device's AutoPID vehicle profile.
`canair wican` groups two families of device operations. Nothing is written
until you ask for it — a bare `canair wican` just prints this help.
Terminology (deliberately disambiguated):
* the canair *profile bundle* — the `profiles/<name>/` directory (ecus/,
profile.yaml, captures/, …) managed by `canair profile`; and
* the WiCAN *AutoPID profile* — the JSON generated from that bundle's
ecus/ and stored on the device's AutoPID feature, managed here.
Subcommands:
autopid write Generate the v4 and v6 AutoPID JSON to the bundle's out/
autopid upload Generate + upload to the device (Pro only)
autopid download Download the device's current AutoPID JSON (Pro)
autopid diff Download + diff against the generated JSON (Pro)
autopid show [QUERY] Print the generated JSON for some PIDs (offline)
autopid stats Per-ECU/PID statistics table
mode show Show the device's active protocol
mode set MODE Switch the device protocol/mode + align transport (Pro)
Examples:
canair wican autopid write # verified-only, both firmware files
canair wican autopid write --firmware 6 # only the firmware v6 table
canair wican autopid write --include-unverified # also unverified: autopid-v*-unverified.json
canair wican autopid write --no-expected-responses # omit the response-frame counts
canair wican autopid upload --reboot # upload + reboot to apply
canair wican autopid diff --wican home # compare device vs generated
canair wican autopid show BMS:2101 --firmware 6 # what one PID ships as
canair wican mode set slcan # raw CAN + set transport slcan-tcp
canair wican autopid
usage: canair wican autopid [-h] <action> ...
Build the WiCAN AutoPID profile from the active bundle's ecus/ and (optionally) sync it with the device.
positional arguments:
<action>
write Generate the AutoPID JSON for firmware 4.x and v6 to the
bundle's out/
upload Generate + upload the AutoPID profile to the device (Pro)
download Download the device's current AutoPID profile (Pro)
diff Download + diff the device profile against the generated one
(Pro)
show Print the AutoPID JSON that write would generate, for the PIDs a
QUERY selects
stats Show a per-ECU/PID statistics table
options:
-h, --help show this help message and exit
canair wican autopid write
usage: canair wican autopid write [-h] [--firmware {4,6}] [--out PATH]
[--include-unverified]
[--no-expected-responses]
Generate the WiCAN AutoPID profile and write it to the active bundle's out/,
once per firmware generation: autopid-v4.json is the 4.x vehicle profile,
autopid-v6.json the v6 AutoPID table (from 6.0.0-beta.3; it also names the
car's 'vehicle' and 'specific_init' device settings). On a profile with
several variants both go to out/<variant>/, one device profile per car. With
--include-unverified they are autopid-v4-unverified.json and
autopid-v6-unverified.json instead, so the verified-only files stay as they
are. Refused while an ECU's revision is undetermined: the device polls a fixed
list and can't detect it.
options:
-h, --help show this help message and exit
--firmware {4,6} Write only the file for this WiCAN firmware generation
(default: both)
--out PATH Write to PATH instead of the bundle's out/ (needs
--firmware: one file)
--include-unverified Include unverified parameters (default: verified only)
--no-expected-responses
Do not append each PID's recorded response_frames
count to its request (by default the count is
appended, so the adapter answers as soon as that many
frames arrive instead of waiting out its ~614ms
budget)
canair wican autopid upload
usage: canair wican autopid upload [-h] [--reboot] [--include-unverified]
[--no-expected-responses] [--wican WICAN]
[--no-fallback]
Generate the AutoPID profile and upload it to the WiCAN device (POST
/store_car_data). WiCAN Pro on firmware 4.x only.
options:
-h, --help show this help message and exit
--reboot Reboot the device after upload
--include-unverified Include unverified parameters (default: verified only)
--no-expected-responses
Do not append each PID's recorded response_frames
count to its request (by default the count is
appended, so the adapter answers as soon as that many
frames arrive instead of waiting out its ~614ms
budget)
--wican WICAN WiCAN address: ap, an IP/host, or a URL (default:
config transport.host / default_wican=ap, falling back
to another configured device when it is unreachable)
--no-fallback Don't fall back to another configured device when the
default is unreachable (see config transport.fallback)
canair wican autopid download
usage: canair wican autopid download [-h] [--wican WICAN] [--no-fallback]
Download the WiCAN device's current AutoPID profile (GET
/load_auto_pid_car_data) and print it, normalized. WiCAN Pro on firmware 4.x
only.
options:
-h, --help show this help message and exit
--wican WICAN WiCAN address: ap, an IP/host, or a URL (default: config
transport.host / default_wican=ap, falling back to another
configured device when it is unreachable)
--no-fallback Don't fall back to another configured device when the default
is unreachable (see config transport.fallback)
canair wican autopid diff
usage: canair wican autopid diff [-h] [--include-unverified]
[--no-expected-responses] [--wican WICAN]
[--no-fallback]
Download the device's current AutoPID profile and show a parameter-level diff
against the freshly generated one. WiCAN Pro on firmware 4.x only.
options:
-h, --help show this help message and exit
--include-unverified Include unverified parameters (default: verified only)
--no-expected-responses
Do not append each PID's recorded response_frames
count to its request (by default the count is
appended, so the adapter answers as soon as that many
frames arrive instead of waiting out its ~614ms
budget)
--wican WICAN WiCAN address: ap, an IP/host, or a URL (default:
config transport.host / default_wican=ap, falling back
to another configured device when it is unreachable)
--no-fallback Don't fall back to another configured device when the
default is unreachable (see config transport.fallback)
canair wican autopid show
usage: canair wican autopid show [-h] [--firmware {4,6}]
[--include-unverified]
[--no-expected-responses]
[QUERY ...]
Generate the AutoPID profile in memory and print it as one JSON document,
{"v4": …, "v6": …}, narrowed to the PIDs the QUERY selects. Reads ecus/, never
out/, and writes nothing. The progress lines go to stderr. The smallest way to
check what one PID ships as.
positional arguments:
QUERY ECU/PID selection, e.g. 'BMS:2101' or 'VCU' (default:
every shipped PID)
options:
-h, --help show this help message and exit
--firmware {4,6} Print only this WiCAN firmware generation's document
(default: both)
--include-unverified Include unverified parameters (default: verified only)
--no-expected-responses
Do not append each PID's recorded response_frames
count to its request (by default the count is
appended, so the adapter answers as soon as that many
frames arrive instead of waiting out its ~614ms
budget)
canair wican autopid stats
usage: canair wican autopid stats [-h]
Print a per-ECU/PID statistics table for the active bundle.
options:
-h, --help show this help message and exit
canair wican mode
usage: canair wican mode [-h] <action> ...
Inspect or switch the WiCAN device's operating protocol (elm327/slcan/auto_pid/…). This is the device's own mode, distinct from the AutoPID profile. Firmware 4.x only: v6 has no protocol mode.
positional arguments:
<action>
show Show the device's active protocol
set Switch the device protocol/mode and reboot (Pro)
options:
-h, --help show this help message and exit
canair wican mode show
usage: canair wican mode show [-h] [--wican WICAN] [--no-fallback]
Report the WiCAN device's currently active protocol/mode.
options:
-h, --help show this help message and exit
--wican WICAN WiCAN address: ap, an IP/host, or a URL (default: config
transport.host / default_wican=ap, falling back to another
configured device when it is unreachable)
--no-fallback Don't fall back to another configured device when the default
is unreachable (see config transport.fallback)
canair wican mode set
usage: canair wican mode set [-h] [--yes] [--no-transport] [--wican WICAN]
[--no-fallback]
{elm327,slcan,savvycan,realdash66,auto_pid}
Switch the WiCAN device to MODE and reboot it, then align canair's transport to match (slcan -> slcan-tcp, elm327 -> wican-ws). WiCAN Pro on firmware 4.x only.
Valid modes:
slcan raw CAN — canair drives ISO-TP client-side; enables sniff
elm327 ELM327 terminal — the dongle runs ISO-TP
auto_pid restore Home Assistant AutoPID broadcasting
savvycan stream frames to SavvyCAN
realdash66 stream frames to RealDash (CAN 66)
positional arguments:
{elm327,slcan,savvycan,realdash66,auto_pid}
Target protocol/mode
options:
-h, --help show this help message and exit
--yes Skip the confirmation prompt
--no-transport Don't auto-align the device's configured transport
(devices.<alias>.transport, else transport.type) to
the new mode
--wican WICAN WiCAN address: ap, an IP/host, or a URL (default:
config transport.host / default_wican=ap, falling back
to another configured device when it is unreachable)
--no-fallback Don't fall back to another configured device when the
default is unreachable (see config transport.fallback)