Skip to content

canair variants

usage: canair variants [-h] [--json]
                       {list,show,add,set-meta,unset-meta,set-revisions,rename,rm} ...

List the variants of the active profile's car — the versions an owner can name, such as a battery size or a facelift — or edit them (add/set-meta/unset-meta/set-revisions/rename/rm). A variant can limit which ECU revisions its car carries and override some profile.yaml settings.

positional arguments:
  {list,show,add,set-meta,unset-meta,set-revisions,rename,rm}
    list                List the variants (default)
    show                Show one variant's metadata
    add                 Add a variant
    set-meta            Set metadata fields on a variant
    unset-meta          Remove metadata fields from a variant
    set-revisions       Say which revisions of an ECU this car can carry
    rename              Change a variant's ID, retagging the captures, logs
                        and ECU files that use it
    rm                  Remove a variant (refused while captures, logs or ECU
                        files use it)

options:
  -h, --help            show this help message and exit
  --json                Output the list as JSON

  canair variants                                   # list the variants
  canair variants show 38kwh --json
  canair variants add 38kwh --name "Ioniq Electric 38 kWh (facelift)" \
      production=2019-06,2022 battery.usable_kwh=38.3 status=seed
  canair variants set-meta 28kwh model_code=AEEV markets=EU,US,KR
  canair variants set-meta 38kwh "also_known_as=Ioniq vFL,Ioniq facelift"
  canair variants unset-meta 28kwh trims
  canair variants set-meta 38kwh profile_overrides.car_model="Ioniq Electric 38 kWh"
  canair variants set-revisions 38kwh BMS UDS        # the 38 kWh car's BMS is the UDS one
  canair variants rename 28kwh 28kwh-eu
  canair variants rm 38kwh

canair variants list

usage: canair variants list [-h] [--json]

options:
  -h, --help  show this help message and exit
  --json      Output as JSON

canair variants show

usage: canair variants show [-h] [--json] id

positional arguments:
  id          Variant ID (e.g. 28kwh)

options:
  -h, --help  show this help message and exit
  --json      Output as JSON

canair variants add

usage: canair variants add [-h] --name NAME id [KEY=VALUE ...]

positional arguments:
  id           Variant ID: lower-case, names what differs (e.g. 38kwh)
  KEY=VALUE    Metadata as KEY=VALUE (battery.<field>=…; repeat sources= per
               source)

options:
  -h, --help   show this help message and exit
  --name NAME  Human-readable name

canair variants set-meta

usage: canair variants set-meta [-h] id KEY=VALUE [KEY=VALUE ...]

positional arguments:
  id          Variant ID
  KEY=VALUE   Metadata as KEY=VALUE (battery.<field>=…; repeat sources= per
              source)

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

canair variants unset-meta

usage: canair variants unset-meta [-h] id KEY [KEY ...]

positional arguments:
  id          Variant ID
  KEY         Field (battery.<field> for battery)

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

canair variants set-revisions

usage: canair variants set-revisions [-h] [--clear] id ECU [REVISION ...]

Record which of an ECU's revisions (its revisions: IDs in ecus/) a variant's
car can carry. One revision: that ECU is determined for the car. Several: a
running change, so the ECU decides (pin it with `profile use --pin`). --clear:
any of them (the default).

positional arguments:
  id          Variant ID
  ECU         ECU name
  REVISION    Revision IDs (or a comma list)

options:
  -h, --help  show this help message and exit
  --clear     Any of the ECU's revisions

canair variants rename

usage: canair variants rename [-h] old new

positional arguments:
  old         Current variant ID
  new         New variant ID

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

canair variants rm

usage: canair variants rm [-h] id

positional arguments:
  id          Variant ID

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