Initial codebase for airsense

.github/workflows/build_release.yml

@@ -0,0 +1,109 @@
+---
+name: Compile AirSense Firmware
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    tags:
+      - "v*"
+    paths:
+      - AirSense/**
+      - .github/workflows/build_release.yml
+  pull_request:
+    branches:
+      - main
+    paths:
+      - AirSense/**
+      - .github/workflows/build_release.yml
+
+jobs:
+
+  build_airsense_firmware:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: AirSense
+
+    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.9'
+
+      - name: Install PlatformIO core
+        run: pip install -U platformio
+
+      - name: Build Firmware
+        run: pio run
+
+      - name: List all files
+        if: always()
+        continue-on-error: true
+        run: |
+          set -x
+          pwd
+          ls -all
+          tree
+
+      # TODO: Validate
+
+      - name: Upload firmware
+        uses: actions/upload-artifact@v4
+        with:
+          path: .pio/build/esp32dev/firmware.bin
+          name: demo.pio
+          compression-level: 0
+          if-no-files-found: error
+
+  create_release:
+    runs-on: ubuntu-latest
+    environment: github_release
+    needs: 
+      - build_airsense_firmware
+    # if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
+
+    steps:
+    - id: version
+      name: Get Version
+      run: |
+        set -x
+
+        if [[ "${{ github.ref_type }}" == "tag" ]]; then
+          version=${{ github.ref_name }}
+        else
+          version="${GITHUB_SHA::7}"
+        fi
+
+        echo "version=${version}" > $GITHUB_OUTPUT
+
+    - uses: actions/download-artifact@v4
+      with:
+        merge-multiple: true
+
+    - name: List all files
+      if: always()
+      continue-on-error: true
+      run: |
+        set -x
+        pwd
+        ls -all
+        tree
+
+    - name: Create Release ${{ steps.version.outputs.version }}
+      uses: softprops/action-gh-release@v1
+      with:
+        name: Release ${{ steps.version.outputs.version }}
+        tag_name: ${{ steps.version.outputs.version }}
+        generate_release_notes: true
+        files: |
+          *.bin

AirSense/.gitignore

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

AirSense/.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"
+    ]
+}

AirSense/include/README

@@ -0,0 +1,39 @@
+
+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 usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+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

AirSense/lib/README

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

AirSense/platformio.ini

@@ -0,0 +1,15 @@
+; 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:esp32dev]
+platform = espressif32
+board = esp32dev
+framework = arduino
+monitor_speed = 115200

AirSense/src/main.cpp

@@ -0,0 +1,18 @@
+#include <Arduino.h>
+
+#define LED_BUILTIN 2
+
+void setup() {
+  Serial.begin(115200);
+  pinMode(LED_BUILTIN, OUTPUT);
+
+  Serial.println("AirSense is running...");
+}
+
+void loop() {
+  digitalWrite(LED_BUILTIN, HIGH);
+  delay(1000);
+
+  digitalWrite(LED_BUILTIN, LOW);
+  delay(1000);
+}

AirSense/test/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

README.md

@@ -1 +1,38 @@
-# AirSense
+# AirSense
+
+
+## Setup Development
+
+```bash
+
+pip install -U platformio
+
+```
+
+## Compile Firmware
+
+
+```shell
+
+pio run
+
+```
+
+- firmware will be at `.pio/build/*` directory
+
+## Flash Firmware
+
+
+### Option-I: Using esptool
+- Install esptool.py - `pip install -U esptool`
+```
+python -m esptool write_flash -z 0 firmware.bin
+```
+
+---
+
+## Development Notes
+
+```bash
+
+```