1 files changed, 40 insertions, 0 deletions

diff --git a/analysis/rtt/README.txt b/analysis/rtt/README.txt
new file mode 100644
index 0000000..4a45e6d
--- /dev/null
+++ b/analysis/rtt/README.txt
@@ -0,0 +1,40 @@
+Project: MQTT RTT and Throughput Logger
+
+Description:
+This project implements an MQTT client that connects to a broker, subscribes to a topic, and logs message round-trip time (RTT) and throughput statistics to a CSV file and standard output. The logger measures the time difference between message sent timestamps and received timestamps to calculate RTT and maintains a sliding window of message times to estimate throughput in messages per second.
+
+Files:
+
+mqtt_client.h / mqtt_client.c: MQTT client wrapper using the Mosquitto library.
+
+logger.h / logger.c: Logger module for handling incoming MQTT messages and logging RTT/throughput.
+
+main.c: Entry point initializing the MQTT client and logger, then running the MQTT client loop.
+
+Dependencies:
+
+Mosquitto library (libmosquitto)
+
+Standard C libraries (stdio, stdlib, string, sys/time, time)
+
+Build Instructions:
+
+Look at the Dockerfile and Makefile to find out.
+Usage:
+
+Configure MQTT broker address, port, and topic in main.c.
+
+Run the compiled executable.
+
+The program connects to the broker, subscribes to the specified topic, and logs RTT and throughput stats to a CSV file.
+
+Output is also printed to the console.
+
+Notes:
+
+The logger expects the payload of received messages to contain a timestamp string representing the sent time in milliseconds.
+
+The program uses blocking call mosquitto_loop_forever to run the MQTT network loop.
+
+Contact:
+For questions contact Filip Wandzio at contact@philw.dev