← Back to ratslair.com
aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index 34e5407..ba9e538 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
-# TNE107-RPI \ No newline at end of file
+# TNE107-RPI
+
+## control.py
+
+This control program is not needed for operation and is strictly used to test implementation.
+
+## bt.py
+
+This program controls the Bluetooth behaviour of the system.
+
+## DWM.py
+
+This program interfaces with the DWM1001 UWB transciever via serial to get location data.
+
+## LIDAR
+
+This program interfaces with the SLAMTEC RPLIDAR C1. To use this there are a couple steps to take.
+
+1. Compile the SDK in its respective folder.
+2. Compile the actual LIDAR program and move it from output to the source directory with name `LIDARProg`.
+
+## main.py
+
+This program starts all the other programs at the correct times for communication to occur and for data handling to be done properly. This program is run as a systemd service on the Raspberry Pi. \ No newline at end of file