Merge pull request #1 from Vuurvos1/feat/moduleCode

Feat/module code

Author: Vuurvos1

.github/workflows/test-shared.yml

@@ -0,0 +1,36 @@
+name: Test Shared
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'code/shared/**'
+  pull_request:
+    branches: [main]
+    paths:
+      - 'code/shared/**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/pip
+            ~/.platformio/.cache
+          key: ${{ runner.os }}-pio
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install PlatformIO Core
+        run: pip install --upgrade platformio
+
+      - name: Run Shared Tests
+        run: |
+          cd code
+          pio test -e shared_test

code/.gitignore

@@ -1,7 +1,7 @@
 .pio
-.vscode/.browse.c_cpp.db*
-.vscode/c_cpp_properties.json
-.vscode/launch.json
-.vscode/ipch
+**/.vscode/.browse.c_cpp.db*
+**/.vscode/c_cpp_properties.json
+**/.vscode/launch.json
+**/.vscode/ipch
 
 config.h

code/controller/.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
+}

code/include/README renamed to code/controller/include/README

@@ -0,0 +1,18 @@
+[env:controller]
+platform = espressif32
+board = esp32dev
+framework = arduino
+monitor_speed = 115200
+lib_deps = 
+  ; TODO: remove one stepper lib
+	gin66/FastAccelStepper@^0.28.4
+	waspinator/AccelStepper@^1.64
+lib_extra_dirs = ../shared
+
+[env:native]
+platform = native
+build_flags = -I../shared
+lib_deps = 
+  gin66/FastAccelStepper@^0.28.4
+  waspinator/AccelStepper@^1.64
+lib_extra_dirs = ../shared

code/include/config.example.h renamed to code/controller/include/config.example.h

@@ -1,11 +1,19 @@
 #include <Arduino.h>
 #include <config.h>
+#include <HardwareSerial.h>
 
 #include <WiFi.h>
 #include <WebServer.h>
 #include <ESPmDNS.h>
 
 #include <SplitFlap.h>
+#include <utils.h>
+
+#define TXD1 19
+#define RXD1 21
+
+// Use Serial1 for UART communication
+HardwareSerial mySerial(1);
 
 WebServer server(80);
 
@@ -54,6 +62,9 @@ void handleFlaps()
 void setup()
 {
   Serial.begin(115200);
+  mySerial.begin(9600, SERIAL_8N1, RXD1, TXD1); // UART setup
+
+  Serial.println("ESP32 UART Transmitter");
 
   while (!Serial)
     ;
@@ -96,4 +107,32 @@ void loop()
   server.handleClient();
 
   splitFlap.update();
+
+  // send a message over serial every 2 seconds
+  static unsigned long lastSend = 0;
+  if (millis() - lastSend > 2000)
+  {
+    // data
+    std::vector<uint8_t> data = {
+        static_cast<uint8_t>(random(65)),
+        static_cast<uint8_t>(random(65)),
+        static_cast<uint8_t>(random(65)),
+        static_cast<uint8_t>(random(65)),
+        static_cast<uint8_t>(random(65))};
+
+    auto packet = createPacket(data);
+
+    // print the packet
+    Serial.print("Packet: ");
+    for (uint8_t byte : packet)
+    {
+      Serial.print(byte);
+      Serial.print(" ");
+    }
+    Serial.println();
+
+    mySerial.write(packet.data(), packet.size());
+
+    lastSend = millis();
+  }
 }

code/lib/README renamed to code/controller/lib/README

@@ -0,0 +1,5 @@
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

code/controller/platformio.ini

@@ -0,0 +1,10 @@
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
+}

code/src/main.cpp renamed to code/controller/src/main.cpp

@@ -0,0 +1,37 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the convention is to give header files names that end with `.h'.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

code/test/README renamed to code/controller/test/README

@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into the executable file.
+
+The source code of each library should be placed in a separate directory
+("lib/your_library_name/[Code]").
+
+For example, see the structure of the following example libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional. for custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+Example contents of `src/main.c` using Foo and Bar:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+The PlatformIO Library Dependency Finder will find automatically dependent
+libraries by scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html

code/module/.gitignore

@@ -0,0 +1,20 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:module]
+platform = espressif32
+board = esp32dev
+framework = arduino
+monitor_speed = 115200
+lib_deps = 
+  ; TODO: remove one stepper lib
+	gin66/FastAccelStepper@^0.28.4
+	waspinator/AccelStepper@^1.64
+lib_extra_dirs = ../shared

code/module/.vscode/extensions.json

@@ -0,0 +1,65 @@
+#include <Arduino.h>
+#include "utils.h"
+#include <vector>
+#include "SplitFlap.h"
+
+#define TXD1 19
+#define RXD1 21
+
+// defines pins
+#define STEP_PIN 13
+#define DIR_PIN 12
+
+SplitFlap splitFlap(STEP_PIN, DIR_PIN);
+
+// Use Serial1 for UART communication
+HardwareSerial mySerial(2);
+
+SplitFlap splitFlap(13, 12);
+
+bool readingPacket = false;
+
+void handleMyByte(uint8_t byte)
+{
+  Serial.println("Received byte: " + String(byte));
+  splitFlap.setFlap(byte);
+}
+
+void setup()
+{
+  Serial.begin(115200);
+  mySerial.begin(9600, SERIAL_8N1, RXD1, TXD1); // UART setup
+
+  splitFlap.init();
+
+  Serial.println("Module started");
+}
+
+void loop()
+{
+  splitFlap.update();
+
+  // Check if data is available to read
+  if (mySerial.available())
+  {
+    uint8_t incoming = mySerial.read();
+
+    if (!readingPacket && incoming != END_BYTE)
+    {
+      readingPacket = true;
+      handleMyByte(incoming);
+    }
+    else
+    {
+      // forward the data
+      Serial.print(String(incoming) + " ");
+      mySerial.write(incoming);
+    }
+
+    if (incoming == END_BYTE)
+    {
+      Serial.println("End of packet");
+      readingPacket = false;
+    }
+  }
+}

code/module/include/README

@@ -0,0 +1,11 @@
+
+This directory is intended for PlatformIO Test Runner and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PlatformIO Unit Testing:
+- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html

code/module/lib/README

@@ -8,11 +8,25 @@
 ; Please visit documentation for the other options and examples
 ; https://docs.platformio.org/page/projectconf.html
 
-[env:esp32dev]
+; [env:esp32dev]
+[env:module]
 platform = espressif32
 board = esp32dev
 framework = arduino
+build_src_filter = module/src shared/src
+include_filter = module/include shared/include
 monitor_speed = 115200
-lib_deps = 
-	gin66/FastAccelStepper@^0.28.4
-	waspinator/AccelStepper@^1.64
+
+[env:controller]
+platform = espressif32
+board = esp32dev
+framework = arduino
+build_src_filter = controller/src shared/src
+include_filter = controller/include shared/include
+monitor_speed = 115200
+
+[env:shared_test]
+platform = native
+build_type = debug
+build_src_filter = shared/src
+test_filter = shared/test/*

code/module/platformio.ini

@@ -30,6 +30,13 @@ class SplitFlap
     pinMode(dirPin, OUTPUT);
 
     digitalWrite(dirPin, HIGH); // Enables the motor to move in a particular direction
+
+    this->home();
+  }
+
+  void home()
+  {
+    // TODO: implement homing sequence
   }
 
   void update()