New PlatformIO listener client

.github/workflows/build-listener-clients.yaml

@@ -1,145 +1,46 @@
 name: Build Listener Clients
 
-on: [push, pull_request, workflow_dispatch]
+on:
+  push:
+    paths:
+      - '.github/**'
+      - 'listener_clients/**'
+  pull_request:
+    paths:
+      - '.github/**'
+      - 'listener_clients/**'
+  workflow_dispatch:
 
 jobs:
-  build_m5stickc-listener:
-    name: Build M5StickC Listener
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: arduino/compile-sketches@v1
-      with:
-        platforms: |
-          - name: esp32:esp32
-            source-url: https://dl.espressif.com/dl/package_esp32_index.json
-        fqbn: 'esp32:esp32:m5stick-c'
-        libraries: |
-          - source-url: https://github.com/m5stack/M5StickC/archive/refs/tags/0.2.4.zip
-          - source-url: https://github.com/m5stack/M5StickC-Plus/archive/refs/tags/0.0.4.zip
-          - name: WebSockets
-          - name: WiFiManager
-          - name: MultiButton
-          - name: Arduino_JSON
-        cli-compile-flags: |
-          - --export-binaries
-        sketch-paths: |
-          - listener_clients/m5stickc-listener
-        enable-deltas-report: true
-    - name: Upload Artifact
-      uses: actions/upload-artifact@v2
-      with:
-        name: 'TallyArbiter-Listener-M5StickC'
-        path: 'listener_clients/m5stickc-listener/build/esp32.esp32.m5stick-c'
-
-  build_m5atom-listener:
-    name: Build M5Atom Listener
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: arduino/compile-sketches@v1
-      with:
-        platforms: |
-          - name: esp32:esp32
-            source-url: https://dl.espressif.com/dl/package_esp32_index.json
-        fqbn: 'esp32:esp32:m5stack-atom'
-        libraries: |
-          - source-url: https://github.com/m5stack/M5Atom/archive/refs/tags/0.0.6.zip
-          - name: WebSockets
-          - name: WiFiManager
-          - name: MultiButton
-          - name: Arduino_JSON
-          - name: FastLED
-        cli-compile-flags: |
-          - --export-binaries
-        sketch-paths: |
-          - listener_clients/M5AtomMatrix-listener/tallyarbiter-m5atom
-        enable-deltas-report: true
-    - name: Upload Artifact
-      uses: actions/upload-artifact@v2
-      with:
-        name: 'TallyArbiter-Listener-M5Atom'
-        path: 'listener_clients/M5AtomMatrix-listener/tallyarbiter-m5atom/build/esp32.esp32.m5stack-atom'
-
-  build_esp32-neopixel-listener:
-    name: Build ESP32 NeoPixel Listener
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: arduino/compile-sketches@v1
-      with:
-        platforms: |
-          - name: esp32:esp32
-            source-url: https://dl.espressif.com/dl/package_esp32_index.json
-        fqbn: 'esp32:esp32:esp32'
-        libraries: |
-          - name: WebSockets
-          - name: WiFiManager
-          - name: MultiButton
-          - name: Arduino_JSON
-          - name: Adafruit NeoPixel
-        cli-compile-flags: |
-          - --export-binaries
-        sketch-paths: |
-          - listener_clients/esp32-neopixel-listener
-        enable-deltas-report: true
-    - name: Upload Artifact
-      uses: actions/upload-artifact@v2
-      with:
-        name: 'TallyArbiter-Listener-ESP32-NeoPixel'
-        path: 'listener_clients/esp32-neopixel-listener/build/esp32.esp32.esp32'
-
-  build_TTGO-listener:
+  build_embedded-listener:
+    name: Build Embedded Listener ${{ matrix.env }}
     strategy:
-      fail-fast: false
       matrix:
-        board:
-          - fqbn: esp32:esp32:ttgo-t1
-            name: TTGO T1
-          - fqbn: esp32:esp32:ttgo-t7-v13-mini32
-            name: TTGO T7 v13 Mini32
-          - fqbn: esp32:esp32:ttgo-t7-v14-mini32
-            name: TTGO T7 v14 Mini32
-          - fqbn: esp32:esp32:twatch
-            name: TTGO T-Watch
-    name: Build ${{ matrix.board.name }} Listener
-    runs-on: ubuntu-latest
+        env: [m5atom, m5stack-core-esp32, m5stick-c, m5stick-c-plus, ttgo-t7-v13-mini32, ttgo-t7-v14-mini32, esp32dev, esp12e, nodemcu, esp01_1m, esp07]
+    runs-on: windows-latest
     steps:
-    - uses: actions/checkout@v1
-    - name: Setup TFT_eSPI and select User Setup
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+
+    - name: Install PlatformIO
       run: |
-        git clone https://github.com/Bodmer/TFT_eSPI/
-        cd TFT_eSPI
-        sed -i 's/#include <User_Setup.h>/\/\/#include <User_Setup.h>/g' User_Setup_Select.h
-        sed -i 's/\/\/#include <User_Setups\/Setup22_TTGO_T4.h>/#include <User_Setups\/Setup22_TTGO_T4.h>/g' User_Setup_Select.h
-    - uses: arduino/compile-sketches@v1
-      with:
-        platforms: |
-          - name: esp32:esp32
-            source-url: https://dl.espressif.com/dl/package_esp32_index.json
-        fqbn: ${{ matrix.board.fqbn }}
-        libraries: |
-          - name: WebSockets
-          - name: WiFiManager
-          - name: MultiButton
-          - name: Arduino_JSON
-          - source-path: TFT_eSPI
-        cli-compile-flags: |
-          - --export-binaries
-        sketch-paths: |
-          - listener_clients/TTGO_T-listener
-        enable-deltas-report: true
-    - name: Get FQBN build dir for ${{ matrix.board.name }}
+        python -m pip install --upgrade pip
+        pip install --upgrade platformio
+        pio system info
+
+    - name: Run PlatformIO
       run: |
-        RAW_FQBN="${{ matrix.board.fqbn }}"
-        FQBN_REPLACED=$(echo $RAW_FQBN | sed 's/:/./g')
-        echo "FQBN_REPLACED=$FQBN_REPLACED" >> $GITHUB_ENV
-    - name: Upload Artifact
-      uses: actions/upload-artifact@v2
+        cd listener_clients/embedded-listener
+        pio run -e "${{ matrix.env }}" -v
+
+    - name: Upload a Build Artifact
+      uses: actions/upload-artifact@v2.3.1
       with:
-        name: 'TallyArbiter-Listener-${{ matrix.board.name }}'
-        path: 'listener_clients/TTGO_T-listener/build/${{ env.FQBN_REPLACED }}'
-
+        name: embedded-listener_${{ matrix.env }}
+        path: listener_clients/embedded-listener/.pio/build/${{ matrix.env }}/firmware.bin
+  
   analyse_blink1-listener:
     name: Analyse Blink1 Listener
     runs-on: ubuntu-latest
@@ -178,12 +79,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
-    - name: Install dependencies
-      working-directory: listener_clients/relay-listener
-      run: |
-        sudo apt install libudev-dev libusb-1.0-0 libusb-1.0-0-dev
-        npm install
-        npm install --global eslint
-    - name: Run eslint
-      working-directory: listener_clients/relay-listener
-      run: eslint index.js || exit 0
+    #- name: Install dependencies
+    #  working-directory: listener_clients/relay-listener
+    #  run: |
+    #    sudo apt install libudev-dev libusb-1.0-0 libusb-1.0-0-dev
+    #    npm install
+    #    npm install --global eslint
+    #- name: Run eslint
+    #  working-directory: listener_clients/relay-listener
+    #  run: eslint index.js || exit 0

listener_clients/embedded-listener/.gitignore

@@ -0,0 +1,4 @@
+.pio
+.vscode/*
+!.vscode/extensions.json
+src/user_config_override.h

listener_clients/embedded-listener/.vscode/extensions.json

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

listener_clients/embedded-listener/README.md

@@ -0,0 +1,26 @@
+# Embedded listener client
+
+# Development
+
+## Configuring platformio.ini
+
+Used build flags here:
+|                   FLAG NAME                  |                         DESCRIPTION                        | EXAMPLE VALUE |
+|:--------------------------------------------:|:----------------------------------------------------------:|:-------------:|
+| PLATFORM_ARCH_ESP32<br>PLATFORM_ARCH_ESP8266 | Determine if the processor is ESP32-based or ESP8266-based |               |
+| PLATFORM_NAME                                | Listener client name added in TallyArbiter                 |               |
+|                                              |                                                            |               |
+
+We use the following flags to enable platform-specific features (like displays and custom hardware peripherals):
+|     FLAG NAME     |        DESCRIPTION       | EXAMPLE VALUE |
+|:-----------------:|:------------------------:|:-------------:|
+| PLATFORM_M5ATOM   | Enable M5Atom features   |               |
+| PLATFORM_M5STACK  | Enable M5Stack features  |               |
+| PLATFORM_M5STICKC | Enable M5StickC features |               |
+| PLATFORM_TTGO     | Enable TTGO features     |               |
+
+> If a device has no other internal peripherals (like esp32dev, esp12e, esp1_1m, esp07), you can add it without other "PLATFORM_ABCDEF" flag
+Doing this, it's required to edit your personal user_config_override.h file to enable platform-agnostic features, like tally status output or NeoPixel.
+
+
+

listener_clients/embedded-listener/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

listener_clients/embedded-listener/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