# Kvaser Air Bridge Utility CLI

## Version

V1.5.5

## Description

This utility tool is used to configure/upgrade firmware on Kvaser Air Bridge
devices. A Kvaser CAN interface is required to connect to the Air Bridge device
while employing this utility tool. For the upgrade feature, the firmware is
self-contained within the utility tool. The firmware release contained in the
utility tool corresponds to the release of the utility tool. Note: Order of the
arguments are not of importance!

## Arguments

      -v| --verbose               verbose, have 4 levels 0(MINIMAL), 1(INFO/DEFAULT), 2(DEBUG), 3(VERBOSE).
                                  e.g. "airbridge-utility-cli.exe --verbose 3"
                                  e.g. "airbridge-utility-cli.exe -v 3"

     -ch| --channel               channel, input the canlib channel that is connected to the desired Air Bridge.
                                  e.g. "airbridge-utility-cli.exe --channel 0"
                                  e.g. "airbridge-utility-cli.exe -ch 0"

      -R| --Reboot                Reboot, used to reboot an already powered up Air Bridge before issuing commands.
                                  Note: For Air Bridge Light HS, this will only work after it has been booted in
                                  Diagnostic mode.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --Reboot"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -R"

      -D| --Diagnostic            Diagnostic, used to put Air Bridge into diagnostic mode.
                                  Note: Air Bridge will now have the Managment Interface enable with default RX/TX ID.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --Diagnostic"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -D"

      -c| --connect               connect, used to put device in bootloader mode upon startup and remain in this mode.
                                  If not provided, the device is assumed to already be in the desired mode.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c"

     -LP| --List_Parameters       List_Parameters, used to read out parameters from the Air Bridge.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect --Diagnostic --List_Parameters"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D -LP"

   -SAB | --Set_APP_Bitrate       Set_APP_Bitrate, used to configure the startup bitrate on the Air Bridge.
                                  Default bitrate is A|Autobaud, ten there are 4 possible bitrates possible 125, 250,
                                  500 and 1000.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect --Diagnostic --Set_APP_Bitrate
                                  125"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D -SAB 125"

    -SHP| --Set_Heartbeat_Period  Set_Heartbeat_Period, used to set the Heartbeat period of the device.
                                  The Heartbeat is by default inactivated (0) but can be configured to run periodically
                                  in the intervall [100,60000]ms. The Heartbeat is persistent when powercycling a
                                  device, however there is a possiblity to use a non persistent version. For more
                                  information about this version of Heartbeat se the "Kvaser Air Bridge Managment
                                  Interface description."
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D --Set_Heartbeat_Period 100"

   -SRFP| --Set_RF_PWR            Set_RF_PWR, used to configure the power level as Full, Low, UltraLow, Reset.
                                  Note: Reset sets the power level to default value (Full).
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect --Diagnostic --Set_RF_PWR Low"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D -SRFP Low"

        | --upgrade               upgrade, used to upgrade a device to the firmware distributed in this utility tool.
                                  During the upgrade process DO NOT under any circumstances power off the device or
                                  abort the upgrade process! This may render the device unrecoverable!
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect --upgrade"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c --upgrade"

    ================================================================================
           The section below is NOT possible to use with Air Bridge Light HS
    ================================================================================

   -SRFR| --Set_RF_Role           Set_RF_Role, used to configure the role as M|Master, S|Slave.
                                  The role can be either Master or Slave. A Kvaser Air Bridge can establish a pair
                                  consisting of one Master unit and one Slave unit. Several Kvaser Air Bridge M12
                                  devices can form a domain within which discovery and pairing is made possible. Such a
                                  domain set typically has one Master unit and several Slave units. A domain may
                                  however consist of mutiple Master units and multiple Slave units.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect --Diagnostic --Set_RF_Role
                                  Master"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D -SRFR Master"

        | --Set_RF_Master_Seed    Set_RF_Master_Seed, used to configure the RF Master Seed (4 hexadecimal numbers).
                                  The RF Master seed is used internally in the Air Bridge to generate a key that define
                                  a domain for the Discovery/Pairing procedure within which the correct key is
                                  required.
                                  Kvaser Air Bridge devices use the default seed 0000 until each pairing key is set.
                                  Note: Only devices that uses the same seed value can be discovered, selected in
                                  Discovery/Pairing mode and paired.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect --Diagnostic
                                  --Set_RF_Master_Seed 0EFE"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D --Set_RF_Master_Seed 01F1"

        | --Set_RF_Slave_Seed     Set_RF_Slave_Seed, used to configure the RF Slave Seed (4 hexadecimal numbers).
                                  The RF Slave seed is used internally in the Air Bridge to generate a key that define
                                  a domain for the Discovery/Pairing procedure within which the correct key is
                                  required.
                                  Kvaser Air Bridge devices use the default seed 0000 until each pairing key is set.
                                  Note: Only devices that uses the same seed value can be discovered, selected in
                                  Discovery/Pairing mode and paired.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect --Diagnostic
                                  --Set_RF_Master_Seed 0FEF"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D --Set_RF_Slave_Seed 0F1F"

    -SCV| --Set_Custom_Value      Set_Custom_Value, used to set the Custom value of the device.
                                  The Custom value is by default not configured(0), but can be set by the user as
                                  desiered.
                                  Note that the value is 4 bytes long written in hex.For more information about Custom
                                  Value se the "Kvaser Air Bridge Managment Interface description."
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D --Set_Custom_Value F0F1F2E0"

    -------------------------------------------
           Managment Interface - MI
    -------------------------------------------

        | --Set_MI_Enable         Set_MI_Enable, used to configure if the Managment Interface Receinving ID shall be
                                  "Enable" or "Disable" on the device.
                                  The Managment Interface is used for runtime configuration of the Air Bridge device
                                  and for control of the Air Bridge constellation, e.g. pairing and diagnostics.
                                  The Managment Interface Sending ID is however always enabled providing the
                                  opportunity to subscribe to events even though the Managment Interface Receiving ID
                                  is disabled.
                                  Note: Air Bridge will now have the Managment Interface enabled with default Managment
                                  Interface Receiving ID & Managment Interface Sending ID unless configured.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect --Diagnostic --Set_MI_Enable
                                  Enable"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D --Set_MI_Enable Enable"

        | --Set_MI_Receiving_ID   Set_MI_Receiving_ID, used to configure the Managment Interface Receving CAN ID on the
                                  device.
                                  Reset to default with 0, default value is 1BC78FFFx. Note: The value is in
                                  hexadecimal format and in order to signal to the software that it is an extended CAN
                                  IDare you supposed to add a small 'x' right after the CAN ID.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect --Diagnostic
                                  --Set_MI_Receiving_ID 1BC78FFFx"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D --Set_MI_Receiving_ID 1BC78FFFx"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D --Set_MI_Receiving_ID 0"

        | --Set_MI_Sending_ID     Set_MI_Sending_ID, used to configure the Managment Interface Sending CAN ID on the
                                  device.
                                  Reset to default with 0, default value is 1BFFF8F1x. Note: The value is in
                                  hexadecimal format and in order to signal to the software that it is an extended CAN
                                  IDare you supposed to add a small 'x' right after the CAN ID.
                                  e.g. "airbridge-utility-cli.exe --channel 0 --connect --Diagnostic
                                  --Set_MI_Sending_ID 1BFFF8F1x"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D --Set_MI_Sending_ID 1BFFF8F1x"
                                  e.g. "airbridge-utility-cli.exe -ch 0 -c -D --Set_MI_Sending_ID 0"
