Command line interface reference

RadLoggerPy interactive command line interface

radloggercli [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]

--version: show program’s version number and exit

-v, --verbose: Increase verbosity of output. Can be repeated.

-q, --quiet: Suppress output except warnings and errors.

--log-file <LOG_FILE>: Specify a file to log output. Disabled by default.

-h, --help: Show help message and exit.

--debug: Show tracebacks on errors.

complete¶

The complete command is inherited from the python-cliff library, it can be used to generate a bash-completion script. Currently, the command will generate a script for bash versions 3 or 4. The bash-completion script is printed directly to standard out.

Typical usage for this command is:

radloggercli complete | sudo tee /etc/bash_completion.d/radloggercli > /dev/null

device add serial

Command to add serial devices

radloggercli device add serial
    [-h]
    [--bytesize {5,6,7,8}]
    [--parity {none,odd,even,mark,space}]
    [---stopbits {1,1.5,2}]
    [--timeout TIMEOUT]
    name
    {ArduinoGeigerPCB}
    port
    baudrate

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

--bytesize <BYTESIZE>, -b <BYTESIZE>

--parity <PARITY>, -p <PARITY>

---stopbits <STOPBITS>, -s <STOPBITS>

--timeout <TIMEOUT>, -t <TIMEOUT>

name: Unique name to help identify this device.

implementation: The specific implementation of radiation monitor device see documentation for supported models.

port: Symbolic name of the serial port to be translated to the physical device, such as /dev/ttyUSB0 or COM1.

baudrate: The speed at which the device sends data expressed in symbols per second (baud), typically 9600 Bd/s.

This command is provided by the RadLoggerPy plugin.

device list

Command to show lists of devices

radloggercli device list
    [-h]
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id ID]
    [--name NAME]
    [--interface {ethernet,serial,usb}]
    [--implementation {ArduinoGeigerPCB}]

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

-f <FORMATTER>, --format <FORMATTER>: the output format, defaults to table

-c COLUMN, --column COLUMN: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>: when to include quotes, defaults to nonnumeric

--noindent: whether to disable indenting the JSON

--max-width <integer>: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty: Print empty table if there is no data to show.

--sort-column SORT_COLUMN: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending: sort the column(s) in ascending order

--sort-descending: sort the column(s) in descending order

--id <ID>, -i <ID>: Database id associated with this object

--name <NAME>, -n <NAME>: Unique name to help identify this device.

--interface <INTERFACE>: Type of interface to communicate with the radiation monitoring device.

--implementation <IMPLEMENTATION>, -m <IMPLEMENTATION>: The specific implementation of radiation monitor device. See documentation for supported models.

This command is provided by the RadLoggerPy plugin.

device list serial

Command to show lists of serial devices

radloggercli device list serial
    [-h]
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--id ID]
    [--name NAME]
    [--implementation {ArduinoGeigerPCB}]
    [--port PORT]
    [--baudrate BAUDRATE]
    [--bytesize {5,6,7,8}]
    [--parity {none,odd,even,mark,space}]
    [---stopbits {1,1.5,2}]
    [--timeout TIMEOUT]

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

-f <FORMATTER>, --format <FORMATTER>: the output format, defaults to table

-c COLUMN, --column COLUMN: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>: when to include quotes, defaults to nonnumeric

--noindent: whether to disable indenting the JSON

--max-width <integer>: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty: Print empty table if there is no data to show.

--sort-column SORT_COLUMN: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending: sort the column(s) in ascending order

--sort-descending: sort the column(s) in descending order

--id <ID>, -i <ID>: Database id associated with this object

--name <NAME>, -n <NAME>: Unique name to help identify this device.

--implementation <IMPLEMENTATION>, -m <IMPLEMENTATION>: The specific implementation of radiation monitor device. See documentation for supported models.

--port <PORT>: Symbolic name of the serial port to be translated to the physical device, such as /dev/ttyUSB0 or COM1.

--baudrate <BAUDRATE>, -r <BAUDRATE>: The speed at which the device sends data expressed in symbols per second (baud), typically 9600 Bd/s.

--bytesize <BYTESIZE>, -b <BYTESIZE>

--parity <PARITY>, -p <PARITY>

---stopbits <STOPBITS>, -s <STOPBITS>

--timeout <TIMEOUT>, -t <TIMEOUT>

This command is provided by the RadLoggerPy plugin.

device models

Command to list available device interfaces and implementations

radloggercli device models
    [-h]
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

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

-f <FORMATTER>, --format <FORMATTER>: the output format, defaults to table

-c COLUMN, --column COLUMN: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>: when to include quotes, defaults to nonnumeric

--noindent: whether to disable indenting the JSON

--max-width <integer>: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty: Print empty table if there is no data to show.

--sort-column SORT_COLUMN: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending: sort the column(s) in ascending order

--sort-descending: sort the column(s) in descending order

This command is provided by the RadLoggerPy plugin.

device remove

Command to remove device

radloggercli device remove
    [-h]
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--id ID]
    [--name NAME]

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

-f <FORMATTER>, --format <FORMATTER>: the output format, defaults to table

-c COLUMN, --column COLUMN: specify the column(s) to include, can be repeated to show multiple columns

--noindent: whether to disable indenting the JSON

--prefix <PREFIX>: add a prefix to all variable names

--max-width <integer>: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty: Print empty table if there is no data to show.

--id <ID>, -i <ID>: Database id associated with this object

--name <NAME>, -n <NAME>: Unique name to help identify this device.

This command is provided by the RadLoggerPy plugin.

device show

Command to show information about a device

radloggercli device show
    [-h]
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--id ID]
    [--name NAME]
    [--interface {ethernet,serial,usb}]
    [--implementation {ArduinoGeigerPCB}]
    [--detailed]

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

-f <FORMATTER>, --format <FORMATTER>: the output format, defaults to table

-c COLUMN, --column COLUMN: specify the column(s) to include, can be repeated to show multiple columns

--noindent: whether to disable indenting the JSON

--prefix <PREFIX>: add a prefix to all variable names

--max-width <integer>: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty: Print empty table if there is no data to show.

--id <ID>, -i <ID>: Database id associated with this object

--name <NAME>, -n <NAME>: Unique name to help identify this device.

--interface <INTERFACE>: Type of interface to communicate with the radiation monitoring device.

--implementation <IMPLEMENTATION>, -m <IMPLEMENTATION>: The specific implementation of radiation monitor device. See documentation for supported models.

--detailed, -d: Show details related to the specific device type if found.

This command is provided by the RadLoggerPy plugin.

device show serial

Command to show information about devices

radloggercli device show serial
    [-h]
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--id ID]
    [--name NAME]
    [--implementation {ArduinoGeigerPCB}]
    [--detailed]
    [--port PORT]
    [--baudrate BAUDRATE]
    [--bytesize {5,6,7,8}]
    [--parity {none,odd,even,mark,space}]
    [---stopbits {1,1.5,2}]
    [--timeout TIMEOUT]

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

-f <FORMATTER>, --format <FORMATTER>: the output format, defaults to table

-c COLUMN, --column COLUMN: specify the column(s) to include, can be repeated to show multiple columns

--noindent: whether to disable indenting the JSON

--prefix <PREFIX>: add a prefix to all variable names

--max-width <integer>: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty: Print empty table if there is no data to show.

--id <ID>, -i <ID>: Database id associated with this object

--name <NAME>, -n <NAME>: Unique name to help identify this device.

--implementation <IMPLEMENTATION>, -m <IMPLEMENTATION>: The specific implementation of radiation monitor device. See documentation for supported models.

--detailed, -d: Show details related to the specific device type if found.

--port <PORT>: Symbolic name of the serial port to be translated to the physical device, such as /dev/ttyUSB0 or COM1.

--baudrate <BAUDRATE>, -r <BAUDRATE>: The speed at which the device sends data expressed in symbols per second (baud), typically 9600 Bd/s.

--bytesize <BYTESIZE>, -b <BYTESIZE>

--parity <PARITY>, -p <PARITY>

---stopbits <STOPBITS>, -s <STOPBITS>

--timeout <TIMEOUT>, -t <TIMEOUT>

This command is provided by the RadLoggerPy plugin.

measurement list

Command to show lists of measurements

radloggercli measurement list
    [-h]
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--device DEVICE]
    [--name NAME]

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

-f <FORMATTER>, --format <FORMATTER>: the output format, defaults to table

-c COLUMN, --column COLUMN: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>: when to include quotes, defaults to nonnumeric

--noindent: whether to disable indenting the JSON

--max-width <integer>: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty: Print empty table if there is no data to show.

--sort-column SORT_COLUMN: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending: sort the column(s) in ascending order

--sort-descending: sort the column(s) in descending order

--device <DEVICE>, -d <DEVICE>: Device id for associated measurements

--name <NAME>, -n <NAME>: Device name for associated measurements

This command is provided by the RadLoggerPy plugin.