LOG

This folder contains a history of scripts that ran previously in the environment. Use this folder for debugging the foundation node or sample script file in Raspberry PI.

Warning

This is the directory .log that starts with a period, not to be confused with log from the ROS system log.

File Naming Convention

For easy lookup and organization by alphabetical order, the file's name has an easily recognizable naming convention. The following information is embedded into the file name:

• Time
• Script name
• logging level

Time: time when the script started execution Script name: main script that was executed (main.py would be main, sample files will have their name here) logging level: level of detail the logfile contains. Sometimes you want to logfile at a different level to only see the important bits.

This will result in newer files always being on the bottom of the log folder in VSCode, and it also allow us to find a specific log by file name. No extra setup is necessary for folder organization.

File format

The file format is logfile and is similar to a text file except with text highlighting done by VSCode. Each line in the text contains two things:

• File in which logging information was executed in
• Description of the executed method (has to be supplied by code)

Implementation

Go to src/raspi/state_management/utils/logger.py to see how this is implemented.