Update documentation with PlatformIO

DangerMonkeys · Jan 6, 2025 · ea1c6a0 · ea1c6a0
1 parent eb0f6f1
commit ea1c6a0
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 191 deletions.
diff --git a/src/.vscode/README.md b/src/.vscode/README.md
diff --git a/src/.vscode/c_cpp_properties.json.template b/src/.vscode/c_cpp_properties.json.template
diff --git a/src/.vscode/configure_vscode.py b/src/.vscode/configure_vscode.py
diff --git a/src/README.md b/src/README.md
@@ -2,6 +2,26 @@
 
 This folder contains the source code for the leaf vario including [libraries](libraries) and [core source code](vario).  It requires Arduino and the ESP 32 Board Manager (see [documentation](vario/README.md)).
 
-## VS Code
+## PlatformIO
 
-To use [VS Code](https://code.visualstudio.com/) to develop this project, see [the VS Code README](./.vscode/README.md)
+To use [PlatformIO](https://platformio.org/) to develop this project:
+
+### Setup
+
+* Download [Visual Studio Code](https://code.visualstudio.com/)
+* In the Extensions tab, search for PlatformIO and install the extension (make sure to restart VS Code when requested)
+
+### Development
+
+* Open the [root repository folder](..) (File -> Open Folder...
+* Change build environment as desired
+    * Click second-from-right icon in PlatformIO toolbar (small bar at bottom of IDE) and select "release" or "dev" environment
+* Build and upload firmware
+    * If needed (if upload fails and/or if running a release version with mass storage enabled), put in bootloader mode:
+        * Unplug device (leaf)
+        * Make sure device is turned off (hold center button to turn off)
+        * Hold down boot button (smallest speaker hole)
+        * Plug in device to USB
+            * Alternately, press and release reset button (largest speaker hole)
+        * Release boot button
+    * Click the small rightward arrow in the PlatformIO toolbar to build and upload firmware
diff --git a/src/vario/README.md b/src/vario/README.md
@@ -14,14 +14,17 @@ Arduino board: ESP32S3 Dev Module
 
 (see [Arduino workflow](../../.github/workflows/arduino.yaml) to confirm specifics)
 
-## Programming
+## Programming with PlatformIO
+
+See [leaf README](../README.md)
+
+## Programming with Arduino
 
 To program the current hardware:
 
 * Install Arduino IDE and [ESP Board Manager Package](#esp32-configuration)
 * Install [required libraries](#required-libraries)
 * Plug board into USB
-* Connect ground ("GD" through-hole) and "3V3" to 3.3V from an external power supply
 * Select the [appropriate board](#esp32-configuration) and port in the Arduino IDE
 * Configure the [appropriate board settings](#esp32-configuration)