PlatformIO restructure

.doxygen/Doxyfile

@@ -871,7 +871,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../ESPixelStick
+INPUT                  = ../src ../include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

.github/workflows/build.yaml

@@ -1,7 +1,7 @@
 name: ESPixelStick CI
 on: [push, pull_request, workflow_dispatch]
 env:
-  VERSION_BASE: '4.0'
+  VERSION_BASE: "4.0"
 jobs:
   firmware:
     strategy:
@@ -148,7 +148,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: "3.10"
 
       - name: Install PlatformIO
         run: |
@@ -199,7 +199,7 @@ jobs:
       # Install Node
       - uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: "20"
       - run: npm install
 
       # Build and move the web pages
@@ -210,7 +210,7 @@ jobs:
           if [ -z "$ESPS_RELEASE" ]; then
           gulp ci
           fi
-          mv ESPixelStick/data/* dist/fs
+          mv data/* dist/fs
 
       - name: Set release archive filename
         run: |

.gitignore

@@ -1,13 +1,12 @@
 /debug/
 /firmware/
-/ESPixelStick/ESPixelStick.ino.cpp
 /.doxygen/doc/
-/.pio/
 /.vscode/
 !/.vscode/extensions.json
 /dist/*.html
 /node_modules/
-/ESPixelStick/data
+/data
+/.pio
 __pycache__
 platformio_user.ini
 secrets.h

README.md

@@ -38,6 +38,23 @@ The recommended way to build ESPixelStick is with PlatformIO. Building from the
 - In the same status bar, click ☑️ to compile or ➡️ to compile and upload.
 - To build and upload the filesystem, click on the PlatformIO icon on the left bar, then click on _Project Tasks->Platform->Upload Filesystem Image_. Note that before the filesystem is built, the web pages **must** be processed. Instructions for processing the web pages are in the html [README](html/README.md).
 
+## Directory Structure
+
+ESPixelStick is now a PlatformIO project and follows the standard PlatformIO directory structure. All code should be in the releveant `src` and `include` sub-directories. Within each you will find the follwing directories:
+
+- `input` - Show input modules should reside here and inherit from `c_InputCommon` as defined in `InputCommon.hpp`.
+- `ouput` - Show output modules should reside here and inherit from `c_OutputCommon` as defined in `OutputCommon.hpp`.
+- `service` - Auxiliary services should reside here. These include non-show critical input mechansims like FPP discovery / configuration mechanisms.
+
+You'll want to refer to `src/input/InputMgr.cpp` and `src/output/OutputMgr.cpp` for adding modules to the system.
+
+Other notable directories:
+
+- `dist` - These are the files used for creating the binary distributions. Updated binaries for flashing, ESPSFlashTool and `firmware.json` should all be updated here.
+- `html` - All frontend / web related code, refer to the html [README](html/README.md) for details.
+- `SupportingDocs` - Datasheets and protocol formats related to this project.
+- `tools` = Misc tools related to this project.
+
 ## Supported Inputs and Outputs
 
 Details on the supported input protocols and outputs can be found in the [wiki](https://github.com/forkineye/ESPixelStick/wiki/Supported-Inputs-and-Outputs).