Merge branch 'main' of github.com:bbogdanmircea/DIY-Sim-Racing-Active…

…-Pedal into main
MrUnzO · Aug 15, 2023 · 237b8b8 · 237b8b8
2 parents 5d1bc24 + ad0a58e
commit 237b8b8
Show file tree

Hide file tree

Showing 19 changed files with 110,818 additions and 1 deletion.
diff --git a/Arduino/.DS_Store b/Arduino/.DS_Store
diff --git a/Arduino/Esp32/.DS_Store b/Arduino/Esp32/.DS_Store
diff --git a/Arduino/Esp32/Main/.last-used b/Arduino/Esp32/Main/.last-used
diff --git a/Arduino/Esp32/Main/compile_commands.json b/Arduino/Esp32/Main/compile_commands.json
@@ -0,0 +1 @@
+[]
diff --git a/Arduino/Esp32/arduinoCliBuildScript.sh b/Arduino/Esp32/arduinoCliBuildScript.sh
@@ -0,0 +1,5 @@
+# shell script for automatic built of the ESP32 binaries
+# for Arduino-cli help, see https://arduino.github.io/arduino-cli/0.33/commands/arduino-cli_compile/
+
+
+arduino-cli compile --fqbn esp32:esp32:fm-devkit --output-dir Arduino/Esp32/bin Arduino/Esp32/Main/.
diff --git a/Arduino/Esp32/bin/Main.ino.bin b/Arduino/Esp32/bin/Main.ino.bin
diff --git a/Arduino/Esp32/bin/Main.ino.bootloader.bin b/Arduino/Esp32/bin/Main.ino.bootloader.bin
diff --git a/Arduino/Esp32/bin/Main.ino.elf b/Arduino/Esp32/bin/Main.ino.elf
diff --git a/Arduino/Esp32/bin/Main.ino.map b/Arduino/Esp32/bin/Main.ino.map
diff --git a/Arduino/Esp32/bin/Main.ino.partitions.bin b/Arduino/Esp32/bin/Main.ino.partitions.bin
diff --git a/Arduino/html/.DS_Store b/Arduino/html/.DS_Store
diff --git a/README.md b/README.md
@@ -16,7 +16,14 @@ Feel free to join, research before you build and ask questions.
 
 # Hardware
 ## ESP32
-The embedded code of the DIY active pedal runs on an ESP32 microcontroller. 
+The embedded code of the DIY active pedal runs on an ESP32 microcontroller. Some PCB design, which hold the ESP32 breakoutboard, the ADC breakoutboard and connectors are uploaded to the [Wiring](Wiring) directory. They were used to proof the concept. 
+The regular ESP32 is currently recommended over the ESP32 S2, as it has a FPU and it performs better with the stepper library. ESP32 S2 is losing steps currently.
+
+ESP32 PCB            |  ESP32 S2 mini PCB
+:-------------------------:|:-------------------------:
+![](Wiring/Esp32/Esp32_PCB_0.png)  |  ![](Wiring/Esp32_s2_mini/Esp32_S2_mini_PCB_0.png)
+
+A more sophisticated custom PCB is currently under development and tested. Please refer to the Discord for up-to-date designs.
 
 ## Mechanics
 There are multiple variations of the DIY active pedal build by users, which can be found at our [discord](https://discord.gg/j9K5vUuT) channel.   
@@ -34,11 +41,34 @@ Currently a nicer PCB deisgn is under development, which has the ESP & ADS integ
 # Software
 
 ## ESP32 code
+
+### Architecture
+A Doxygen report of the sources can be found [here](Arduino/html/index.html).
+
+### Built from source
 To flash the [code](Arduino/Esp32/Main), e.g. via Ardiono IDE to esp32. 
 
+### flash prebuilt binaries via webflasher
+HASN'T BEEN TESTED YET:
+The prebuilt binaries for the regular ESP32 can be found [here](Arduino/Esp32/bin). They can be flashed via the ESP [webflasher](https://esp.huhn.me/). 
+
 ## SimHub plugin:
 The SimHub plugin was designed to communicate with the esp32 to (a) modify the pedal configuration, e.g. the force vs. travel parameterization and (b) to trigger effects such as ABS oscillations.  
 
 ![image](SimHubPlugin/Images/SimHubPluginOverview.png)
 
 To install the plugin, copy the plugin [binaries](SimHubPlugin/bin) content to your SimHub directory, e.g. C:/Program Files (x86)/SimHub
+
+
+# Todo
+- [ ] Add Doxygen + Graphviz to the project to automatically generate documentation, architecureal design overview, etc.
+- [ ] Add automatic system identification of pedal response
+- [ ] Add model-predictive-controll to the ESP code for improved pedal response
+- [ ] Add build manual
+- [ ] Create video describing the build progress and the features
+- [ ] https://github.com/gin66/FastAccelStepper/issues/194
+- [ ] https://github.com/br3ttb/Arduino-PID-Library/issues/138
+- [ ] GUI design improvements for the SimHub plugin
+- [ ] SimHub plugin: Bugfix for COM port selection wrong, when switching between pedals
+- [ ] Send SimHub data via wifi to ESP
+- [ ] Automatically generate the bin files and refer to the ESP32 [webflasher](https://esp.huhn.me/)
diff --git a/Wiring/.DS_Store b/Wiring/.DS_Store
diff --git a/Wiring/Esp32/Esp32_PCB_0.png b/Wiring/Esp32/Esp32_PCB_0.png
diff --git a/Wiring/Esp32/Gerber_PCB_ActivePedalEsp32Ads1256V1_3.zip b/Wiring/Esp32/Gerber_PCB_ActivePedalEsp32Ads1256V1_3.zip
diff --git a/Wiring/Esp32/Schematic_ActivePedalEsp32Ads1256V1_2023-08-14.pdf b/Wiring/Esp32/Schematic_ActivePedalEsp32Ads1256V1_2023-08-14.pdf
diff --git a/Wiring/Esp32_s2_mini/Esp32_S2_mini_PCB_0.png b/Wiring/Esp32_s2_mini/Esp32_S2_mini_PCB_0.png
diff --git a/..._ActivePedalEsp32S2miniAds1256V1 copy.zip → ..._ActivePedalEsp32S2miniAds1256V1 copy.zip b/..._ActivePedalEsp32S2miniAds1256V1 copy.zip → ..._ActivePedalEsp32S2miniAds1256V1 copy.zip
diff --git a/...ePedalEsp32S2miniAds1256V1_2023-05-28.png → ...ePedalEsp32S2miniAds1256V1_2023-05-28.png b/...ePedalEsp32S2miniAds1256V1_2023-05-28.png → ...ePedalEsp32S2miniAds1256V1_2023-05-28.png