Skip to content

canair groups

usage: canair groups [-h] [--json]
                     {list,add,rm,rename,set-description,set-members} ...

List the active profile's named selector groups, or edit the vocabulary (add/rm/rename/set-description/set-members). Reference a group on the command line with the @ sigil, e.g. `canair monitor @charging`.

positional arguments:
  {list,add,rm,rename,set-description,set-members}
    list                List the groups (default)
    add                 Add a new group
    rm                  Remove a group
    rename              Rename a group
    set-description     Set/clear a group's description
    set-members         Replace a group's member selectors

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

  canair groups                                   # list the groups
  canair groups --json                            # machine-readable
  canair groups add commute BMS:2101 VCU MCU --description "My commute set"
  canair groups set-members charging BMS:2101 BMS:2105 OBC VCU MCU
  canair groups set-description driving "Powertrain + chassis while driving"
  canair groups rename body comfort
  canair groups rm commute

canair groups list

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

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

canair groups add

usage: canair groups add [-h] [--description DESCRIPTION] name SEL [SEL ...]

positional arguments:
  name                  Group name (lower-cased)
  SEL                   Member selectors (ECU or ECU:PID)

options:
  -h, --help            show this help message and exit
  --description DESCRIPTION, -d DESCRIPTION
                        Human-readable description

canair groups rm

usage: canair groups rm [-h] name

positional arguments:
  name

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

canair groups rename

usage: canair groups rename [-h] old new

positional arguments:
  old
  new

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

canair groups set-description

usage: canair groups set-description [-h] name [value]

positional arguments:
  name
  value       Description (omit to clear)

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

canair groups set-members

usage: canair groups set-members [-h] name SEL [SEL ...]

positional arguments:
  name
  SEL         Member selectors (ECU or ECU:PID)

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