Configure Commands#

You can configure certain Certain Simplicity Commander settings by using the configure command. These settings persist across Commander runs and updates.

Logging Overview#

You can use Simplicity Commander to log all Commander invocations in a user-defined log file by using the configure log commands. Each entry in the log includes the following parameters:

  • Timestamp in the form YYYY-MM-DD hh:mm:ss.zzz

  • The full path to the Commander executable

  • The command being executed, exactly as Commander receives it from the command line

Get Current Logging Status#

To view the the current logging status, use the configure log command.

Command Line Syntax

$ commander configure log

Command Line Input Example

$ commander configure log

This example gets the current logging status.

Command Line Output Example

Logging is disabled.
Current log file path: /Users/username/logs/commander.log
DONE

Enable Logging#

To enable logging, use the configure log enable command.

  • If you provide a file name, Commander uses that file for the log output file.

  • If no file name is provided, Commander uses the last known output file name.

  • If logging previously hasn't been enabled, Commander uses ~/.silabs/commander/commander.log as the default file name.

Commander will create the path to the log file if it does not already exist. If the log file itself does not exist when logging is enabled, it will be created upon the next invocation of Commander.

Command Line Syntax

$ commander configure log enable [path]

Command Line Input Example

$ commander configure log enable "~/logs/commander.log"

This example enables logging and sets ~/logs/commander.log as the output log file.

Command Line Output Example

Log file set to: /Users/username/logs/commander.log
DONE

Disable Logging#

To disable logging, use the configure log disable command. Reenabling logging will use the last known output filename.

Command Line Syntax

$ commander configure log disable

Command Line Input Example

$ commander configure log disable

This example disables logging.

Command Line Output Example

Logging disabled.
DONE

Using Custom Device XML Files#

Simplicity Commander includes a default device XML file that contains information about the devices supported by Commander. Commander uses this file whenever it communicates with a device.

If you are working with custom or experimental devices, you can configure Commander to use a custom device XML file (JLinkDevices.xml) by using the configure devicexml command.

When a custom device XML file is configured, Commander displays the path to the file whenever a command interacts with a device.

Note: If the configured path is empty or does not exist, Commander displays a warning and uses the default device XML file instead.

Getting the Current Device XML File Path#

To display the current device XML file path, use the configure devicexml --get command.

If no custom device XML file path is configured, Commander indicates that no custom path is set and displays the path to the default device XML file.

Command Line Syntax

$ commander configure devicexml --get

Command Line Input Example

$ commander configure devicexml --get

Command Line Output Example

Current device XML file path: /Users/username/devices/
DONE

Setting a Custom Device XML File Path#

To configure a custom device XML file path, use the configure devicexml --set <path> command.

Relative paths are resolved against the current working directory and stored as absolute paths in Commander settings.

Note: The provided path must be a valid path to a directory containing a valid JLinkDevices.xml file.

Command Line Syntax

$ commander configure devicexml --set <path>

Command Line Input Example

$ commander configure devicexml --set "~/devices/custom_work/"

Command Line Output Example

Device XML file path set to: /Users/username/devices/custom_work/
DONE

Clearing the Current Device XML File Path#

To remove the configured custom device XML file path and return to the default device XML file, use the configure devicexml --clear command.

Command Line Syntax

$ commander configure devicexml --clear

Command Line Input Example

$ commander configure devicexml --clear

Command Line Output Example

Device XML file path reset to default value:
/path/to/commander/Resources/jlink/JLinkDevices.xml
DONE

Temporarily Providing a Custom Device XML File Path#

To use a custom device XML file path for a single command, specify the --devicexml <path> option. This option overrides the configured device XML file path only for the current command.

Note: The provided path must be a valid path to a directory containing a valid JLinkDevices.xml file.

Command Line Syntax

$ commander <command> --devicexml <path>

Command Line Input Example

$ commander <command> --devicexml "~/devices/custom_work/"

Command Line Output Example

Using custom device XML directory: /Users/username/devices/custom_work/...
<command output>
DONE