​

Accessing the page

The logs page is loated at Communications/Logs in the navigation bar.

​

The anatomy of a log

​

Logs contain 6 key pieces of information:

1. The timestamp of the log
2. The log level
3. The name of the log’s origin
4. The file origin
5. The function origin
6. The message

The following is an example of a log entry:

2024-10-25 20:10:34,131 - INFO - root - utils.py:41 - create_pwm_controllers - Device is Raspberry Pi 5

1. 2024-10-25 20:10:34,131 - specifies the timestamp of the log entry
   The timestamp will not reflect the real-world time, unless syncronized to an internet clock.

2. INFO - specifies the log level as INFO
3. root - specifies the origin as the root of the program
4. utils.py:41 - indicates the log originates from the utils.py file at line 41
5. create_pwm_controllers - indicates the function it originated from is for creating the pwm controllers
6. Device is Raspberry Pi 5 - the message shows that the type of device is what is being logged here

​

Exporting a log

There are two ways to export a log:

​

Exporting to a file

Select the export button on the bottom left.

​

Copying the text

Select the copy button on the bottom left. This will copy the text to the clipboard.