From 39c9a6f7d8ad1fbe6bcc66fa48ddb476b5dd2b7e Mon Sep 17 00:00:00 2001 From: spernsteiner Date: Tue, 17 Dec 2024 09:56:24 -0800 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Michal Podhradsky --- components/logging/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/components/logging/README.md b/components/logging/README.md index 6b425153..a2fdcf02 100644 --- a/components/logging/README.md +++ b/components/logging/README.md @@ -4,6 +4,22 @@ This is a simple tool for logging telemetry data from Ardupilot. It connects to Ardupilot SITL's SERIAL2 port (by default, TCP port 5762), reads MAVLink messages from that socket, and writes the messages in textual format to stdout. +## Requirements + +1. The logging component shall connect to the secondary autopilot telemetry port and record some or all telemetry values to disk. + + 1.1 The logging component shall read MAVlink messages from a socket + +2. Logs shall be saved in text format, with a timestamp on each line. + + 2.1. Logs may be printed to stdout for debugging purposes. + +3. Logs shall be encrypted by storing them on an encrypted filesystem + +4. The key for the encrypted filesystem shall be obtained from the Mission Key Management component + +5. The filesystem shall be initialized on first use. + ## Building The build process involves generating MAVLink protocol headers, which requires