feat: Add basic dev container to aid for quicker debugging of the Arduino-Temperature-Control-Library

Author: Miles Burton

.devcontainer/Dockerfile

@@ -0,0 +1,64 @@
+FROM mcr.microsoft.com/vscode/devcontainers/cpp:debian
+
+# Install required packages
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && apt-get -y install --no-install-recommends \
+    python3 \
+    python3-pip \
+    git \
+    curl \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install arduino-cli
+RUN curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
+
+# Set up arduino-cli config
+RUN arduino-cli config init
+
+# Add arduino-cli to PATH
+ENV PATH="/usr/local/bin:${PATH}"
+
+# Create workspace directory
+WORKDIR /workspace
+
+# Copy arduino-cli configuration
+COPY arduino-cli.yaml /root/.arduino15/arduino-cli.yaml
+
+# Install build essentials
+RUN apt-get update && apt-get install -y build-essential
+
+# Install common Arduino libraries
+RUN arduino-cli lib install \
+    "OneWire" \
+    "DallasTemperature" \
+    "Adafruit BusIO" \
+    "Adafruit Unified Sensor" \
+    "DHT sensor library" \
+    "WiFiManager" \
+    "ArduinoJson" \
+    "PubSubClient" \
+    "ESP8266WiFi" \
+    "ESP32" \
+    "Wire" \
+    "SPI" \
+    "FastLED" \
+    "NTPClient" \
+    "AsyncTCP" \
+    "ESPAsyncTCP" \
+    "ESPAsyncWebServer"
+
+# Verify library installation
+RUN arduino-cli lib list
+
+# Copy update script
+COPY update-libraries.sh /usr/local/bin/
+RUN chmod +x /usr/local/bin/update-libraries.sh
+
+# Add a weekly cron job to update libraries
+RUN (crontab -l 2>/dev/null; echo "0 0 * * 0 /usr/local/bin/update-libraries.sh > /var/log/library-updates.log 2>&1") | crontab -
+
+# Add aliases for build operations
+RUN echo 'alias arduino-build="./build.sh build"' >> /home/vscode/.bashrc && \
+    echo 'alias arduino-test="./build.sh test"' >> /home/vscode/.bashrc && \
+    echo 'alias arduino-build-test="./build.sh all"' >> /home/vscode/.bashrc

.devcontainer/arduino-cli.yaml

@@ -0,0 +1,21 @@
+board_manager:
+  additional_urls:
+    - https://arduino.esp8266.com/stable/package_esp8266com_index.json
+    - https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
+daemon:
+  port: "50051"
+directories:
+  data: /root/.arduino15
+  downloads: /root/.arduino15/staging
+  user: /root/Arduino
+library:
+  enable_unsafe_install: true
+logging:
+  file: ""
+  format: text
+  level: info
+metrics:
+  addr: :9090
+  enabled: true
+sketch:
+  always_export_binaries: false

.devcontainer/devcontainer.json

@@ -0,0 +1,15 @@
+{
+    "name": "Arduino Library Development",
+    "dockerFile": "Dockerfile",
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "vsciot-vscode.vscode-arduino",
+                "ms-vscode.cpptools"
+            ]
+        }
+    },
+    "postCreateCommand": "arduino-cli core install arduino:avr && arduino-cli lib install ArduinoUnit && /usr/local/bin/update-libraries.sh",
+    "updateContentCommand": "/usr/local/bin/update-libraries.sh",
+    "remoteUser": "vscode"
+}

.devcontainer/update-libraries.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+echo "Updating arduino-cli core and index..."
+arduino-cli core update-index
+arduino-cli update
+
+echo "Updating installed libraries..."
+arduino-cli lib update-index
+arduino-cli lib upgrade
+
+# List of libraries to ensure are installed/updated
+LIBRARIES=(
+    "OneWire"
+    "DallasTemperature"
+    "Adafruit BusIO"
+    "Adafruit Unified Sensor"
+    "DHT sensor library"
+    "WiFiManager"
+    "ArduinoJson"
+    "PubSubClient"
+    "ESP8266WiFi"
+    "ESP32"
+    "Wire"
+    "SPI"
+    "FastLED"
+    "NTPClient"
+    "AsyncTCP"
+    "ESPAsyncTCP"
+    "ESPAsyncWebServer"
+)
+
+echo "Checking and installing libraries..."
+for lib in "${LIBRARIES[@]}"; do
+    echo "Processing library: $lib"
+    if ! arduino-cli lib list | grep -q "$lib"; then
+        echo "Installing $lib..."
+        arduino-cli lib install "$lib"
+    else
+        echo "$lib is already installed"
+    fi
+done
+
+echo "Verifying all libraries are up to date..."
+arduino-cli lib list
+
+echo "Library update complete!"

build.sh

@@ -0,0 +1,72 @@
+#!/bin/bash
+
+# Note this is intended for use within the devcontainer
+
+# Set error handling
+set -e
+
+# Function to display usage
+show_usage() {
+    echo "Usage: ./build.sh [option]"
+    echo "Options:"
+    echo "  build    - Only compile library and examples"
+    echo "  test     - Only compile and run tests"
+    echo "  all      - Build everything and run tests (default)"
+}
+
+# Function to compile for a specific board
+compile_for_board() {
+    local fqbn=$1
+    local sketch=$2
+    echo "📦 Compiling $sketch for $fqbn..."
+    arduino-cli compile --fqbn $fqbn "$sketch"
+}
+
+# Function to build library and examples
+build() {
+    echo "🔨 Building library and examples..."
+    
+    # Compile library
+    echo "📚 Installing library..."
+    arduino-cli lib install .
+    
+    # Compile all examples
+    echo "🔍 Compiling examples..."
+    for example in examples/*/*.ino; do
+        if [ -f "$example" ]; then
+            echo "Building example: $example"
+            compile_for_board "arduino:avr:uno" "$example"
+        fi
+    done
+}
+
+# Function to run tests
+run_tests() {
+    echo "🧪 Running tests..."
+    for test in test/*/*.ino; do
+        if [ -f "$test" ]; then
+            echo "Running test: $test"
+            compile_for_board "arduino:avr:uno" "$test"
+        fi
+    done
+}
+
+# Main execution
+case "${1:-all}" in
+    "build")
+        build
+        ;;
+    "test")
+        run_tests
+        ;;
+    "all")
+        build
+        run_tests
+        ;;
+    *)
+        show_usage
+        exit 1
+        ;;
+esac
+
+echo "✅ Process completed!"