Log Commands

log-level-display

Displays all log levels and their status.

Usage:

log-level-display

log-message

Generates a log message

Usage:

log-message log_level_id message
Parameter Description
log_level_id The log level id associated with the message.
message The message text, enclosed in quotes.

log-output-disable

Disables 1 or more log levels' output.

Usage:

log-output-disable log_level_mask log_output_mask
Parameter Description
log_level_mask A mask of log level ids to select.
log_output_mask A mask of log output ids to disable message delivery for the selected levels.

log-output-display

Displays all log outputs and their status.

Usage:

log-output-display

log-output-enable

Enables 1 or more log levels' output. If called without args, enables defaults.

Usage:

log-output-enable log_level_mask log_output_mask
Parameter Description
log_level_mask A mask of log level ids to select.
log_output_mask A mask of log output ids to enable message delivery for the selected levels.

Log Levels

Aurora's logging system provides a simple way to record different types of actions/events that occur during operation. Each level can be configured independently to send messages to zero or more outputs. Log commands generally accept a mask of log levels. For example, a log level mask of 24 would target the Error and Warning levels since 8 + 16 = 24.

Id Mask Log Level Description
0 1 Data Data (with timestamps) collected by active data streams. Streams must also have log output enabled.
1 2 Info Messages generated by the system during normal operation.
2 4 Event Events (with timestamps) generated by the event system. Events must also have log output enabled.
3 8 Warning Messages generated by the system indicating unusual activity or potential issues.
4 16 Error Messages generated by the system when fatal errors occur.
5 32 Debug Useful messages for debugging the system.

Log Outputs

Log outputs are the "receivers" of messages generated by the different log levels. Log commands generally accept a mask of log outputs. For example a log output mask of 3 would target both the USB and File outputs since 1 + 2 = 3.

Id Mask Log Output Description
0 1 USB Outputs messages to an open USB serial connection.
1 2 File Saves messages to a log.txt file on the sdcard.

results matching ""

    No results matching ""