Merge branch 'main' of github.com:romanini/AutoPilot

romanini · Jun 13, 2024 · 379d0aa · 379d0aa
2 parents 7afea4f + 7732ed7
commit 379d0aa
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,14 @@
-# Copy arduino_secrets.h.example to arduino_secrets.h
-# edit arduino_secrets.h and fill in the SSID and the password
+# Auto Pilot Project
+This Auto Pilot project is an Arduino based effort to create a DIY auto Pilot for a wheel based sail boat.   
+This project has three main parts:
+1. Navigation Computer 
+2. Processor
+3. Display 
+## Navigation Computer 
+An OrangePi Zero 2W running Ubuntu 22.04 and OpenCPN
+
+## Processor
+An Arduino Nano 33 IoT connected to an ultimate GPS , an Accelerometer and a motor controller.
+
+## Display
+One or more Arduino Nana 33 IoT which both displays the current auto pilot information and has buttons for changing from navigation to compass mode and/or disabling the auto pilot, as well as turning 1 degree, 10 degrees or 90 degrees to port or starboard if in compass mode.
diff --git a/monitor/README.md b/monitor/README.md
@@ -8,4 +8,4 @@ This simple python program listens to the UDP broadcasts from the AutoPilot Proc
 3. From the prompt do:
 ```
 ./manitorAutoPilot.py
-``
+```
-Original file line number
+Diff line change
@@ Expand Up @@
 . From the prompt do:
     ```
     ./manitorAutoPilot.py
-    ``
+    ```