sync

Author: RobTillaart

.arduino-ci.yml

@@ -1,15 +1,15 @@
+# .arduino-ci.yml
+
+# Compilation settings
 compile:
- # Choosing to run compilation tests on 2 different Arduino platforms
  platforms:
  - uno
- - due
- # - zero # SAMD covered by M4
- # - leonardo # AVR covered by UNO
- - m4
- # - esp32 # errors on OneWire => util/crc16.h vs rom/crc.h
- - esp8266
- # - mega2560 # AVR covered by UNO
-unittest:
- # These dependent libraries will be installed
  libraries:
  - "OneWire"
+
+# Unit testing settings
+unittest:
+ platforms:
+ - uno
+ libraries:
+ - "OneWire"

.arduino_ci/.arduino-ci.cpp

@@ -0,0 +1,6 @@
+#define ARDUINO_CI 1
+
+// Mock OneWire GPIO functions
+uint8_t digitalPinToBitMask(uint8_t pin) { return 1 << (pin % 8); }
+void* digitalPinToPort(uint8_t pin) { static uint8_t dummy; return &dummy; }
+void* portModeRegister(void* port) { return port; }

.arduino_ci/util/crc16.h

@@ -0,0 +1,25 @@
+#ifndef CRC16_H
+#define CRC16_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Pure C implementation to replace the ASM version
+static inline uint16_t _crc16_update(uint16_t crc, uint8_t data) {
+ unsigned int i;
+ crc ^= data;
+ for (i = 0; i < 8; ++i) {
+ if (crc & 1)
+ crc = (crc >> 1) ^ 0xA001;
+ else
+ crc = (crc >> 1);
+ }
+ return crc;
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

.devcontainer/Dockerfile

@@ -0,0 +1,77 @@
+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 \
+ fish \
+ && apt-get clean \
+ && rm -rf /var/lib/apt/lists/*
+
+RUN mkdir -p /home/vscode/.local/share/CMakeTools \
+&& chown -R vscode:vscode /home/vscode/.local/share/CMakeTools
+
+RUN mkdir -p /home/vscode/.ssh \
+ && chown vscode:vscode /home/vscode/.ssh \
+ && chmod 700 /home/vscode/.ssh
+
+# 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 (customise to your actual path)
+COPY arduino-cli.yaml /root/.arduino15/arduino-cli.yaml
+
+# Install build essentials
+RUN apt-get update && apt-get install -y build-essential && rm -rf /var/lib/apt/lists/*
+
+# (Optional) Install Arduino cores for ESP8266 and ESP32 if needed
+RUN arduino-cli core install esp8266:esp8266 esp32:esp32
+
+# Install only required dependencies for DallasTemperature library and others
+RUN arduino-cli lib install \
+ "OneWire" \
+ "ArduinoUnit" # For testing
+
+# 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 aliases for build operations (for Bash)
+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
+
+# Add a welcome message to .bashrc
+RUN echo '\n# Welcome to the dev container! Here are some useful aliases:' >> /home/vscode/.bashrc && \
+ echo 'echo " - arduino-build: Build the project"' >> /home/vscode/.bashrc && \
+ echo 'echo " - arduino-test: Run tests for the project"' >> /home/vscode/.bashrc && \
+ echo 'echo " - arduino-build-test: Build and test the project"' >> /home/vscode/.bashrc
+
+# (Optional) Add fish-specific configuration if desired
+# For example, you might add an alias file or welcome message for fish:
+RUN mkdir -p /home/vscode/.config/fish && \
+ echo 'set -gx PATH /usr/local/bin $PATH' >> /home/vscode/.config/fish/config.fish && \
+ echo '# Welcome to the Fish shell inside the dev container!' >> /home/vscode/.config/fish/config.fish
+
+# Generate SSH keys and set proper ownership and permissions
+RUN if [ ! -f /home/vscode/.ssh/id_rsa ]; then \
+ ssh-keygen -t rsa -b 4096 -N "" -C "devcontainer@local" -f /home/vscode/.ssh/id_rsa && \
+ chmod 600 /home/vscode/.ssh/id_rsa && \
+ chmod 644 /home/vscode/.ssh/id_rsa.pub && \
+ chown vscode:vscode /home/vscode/.ssh/id_rsa /home/vscode/.ssh/id_rsa.pub ; \
+ fi

.devcontainer/arduino-cli.yaml

@@ -0,0 +1,19 @@
+compile:
+ # Choosing to run compilation tests on 2 different Arduino platforms
+ platforms:
+ - uno
+ - due
+ # - zero # SAMD covered by M4
+ # - leonardo # AVR covered by UNO
+ - m4
+ # - esp32 # errors on OneWire => util/crc16.h vs rom/crc.h
+ # - esp8266
+ # - mega2560 # AVR covered by UNO
+unittest:
+ # These dependent libraries will be installed
+ libraries:
+ - "OneWire"
+board_manager:
+ additional_urls:
+ - https://arduino.esp8266.com/stable/package_esp8266com_index.json
+ - https://dl.espressif.com/dl/package_esp32_index.json

.devcontainer/devcontainer.json

@@ -0,0 +1,23 @@
+{
+ "name": "Arduino Library Development",
+ "dockerFile": "Dockerfile",
+ "mounts": [
+ "source=devcontainer_ssh,target=/home/vscode/.ssh,type=volume",
+ "source=devcontainer_bash_history,target=/home/vscode/.bash_history,type=volume",
+ "source=devcontainer_fish_history,target=/home/vscode/.local/share/fish/fish_history,type=volume"
+ ],
+ "customizations": {
+ "vscode": {
+ "extensions": [
+ "vsciot-vscode.vscode-arduino",
+ "ms-vscode.cpptools",
+ "ms-azuretools.vscode-docker",
+ "yzhang.markdown-all-in-one"
+ ]
+ }
+ },
+ "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,36 @@
+#!/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
+
+# Update Arduino cores
+echo "Updating ESP8266 and ESP32 cores..."
+arduino-cli core install esp8266:esp8266
+arduino-cli core install esp32:esp32
+
+# List of libraries to ensure are installed/updated
+LIBRARIES=(
+ "OneWire"
+ "ArduinoUnit"
+)
+
+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!"

.github/workflows/README.md

@@ -0,0 +1,142 @@
+# 📂 GitHub Workflows for Arduino Temperature Control Library
+
+Automate testing, compilation, and validation of the Arduino Temperature Control Library across multiple platforms using GitHub Actions.
+
+## 🛠️ Workflows Overview
+
+### 1. 📦 Arduino CI Workflow
+
+**Purpose:** 
+Compiles the library and its examples for both AVR and ESP8266 platforms.
+
+**Trigger:** 
+Runs on every `push` and `pull_request`.
+
+**Key Features:**
+- **AVR Compilation:** Compiles all examples for the AVR platform (e.g., Arduino Uno).
+- **ESP8266 Compilation:** Compiles all examples for the ESP8266 platform (e.g., NodeMCU v2).
+- **Selective Compilation:** Skips ESP-specific examples (e.g., ESP-WebServer) when compiling for AVR.
+- **Unit Testing:** Executes unit tests using the `arduino_ci` framework.
+
+### 2. 🔄 Why Separate AVR and ESP Platforms?
+
+The library supports both AVR-based boards (e.g., Arduino Uno) and ESP8266-based boards (e.g., NodeMCU). Some examples utilize ESP-specific libraries like `ESP8266WiFi.h`, which are incompatible with AVR platforms. Separating the compilation ensures:
+
+- **AVR Compatibility:** Skips ESP-specific examples to prevent compilation errors.
+- **ESP Compatibility:** Compiles all examples, including ESP-specific ones, for the ESP8266 platform.
+
+### 3. ⚙️ Workflow Steps
+
+The workflow follows these steps:
+
+1. **Setup Environment:**
+ - Installs dependencies (e.g., `gcc-avr`, `avr-libc`).
+ - Configures the Arduino CLI and installs required cores (`arduino:avr` and `esp8266:esp8266`).
+
+2. **Install Libraries:**
+ - Installs the OneWire library.
+ - Applies a custom CRC implementation.
+
+3. **Run Unit Tests:**
+ - Executes unit tests using the `arduino_ci` framework for the AVR platform.
+
+4. **Compile Examples for AVR:**
+ - Compiles all examples (excluding ESP-specific ones) for the AVR platform.
+
+5. **Compile Examples for ESP8266:**
+ - Compiles all examples (including ESP-specific ones) for the ESP8266 platform.
+
+### 4. 📁 File Structure
+
+Understanding the project’s file structure is crucial for effective navigation and contribution. Below is an overview of the key files and directories:
+
+- **`Gemfile`**
+ - **Description:** 
+ Manages Ruby dependencies required for the project. It ensures that the correct versions of gems (like `arduino_ci`) are used.
+ - **Usage:** 
+ Run `bundle install` to install the necessary gems.
+
+- **`.arduino-ci.yml`**
+ - **Description:** 
+ Configuration file for the `arduino_ci` tool. It defines how the Arduino CI should run tests and compile sketches.
+ - **Key Configurations:**
+ - Specifies which boards to target.
+ - Defines libraries and dependencies needed for testing.
+ - Sets up compilation and testing parameters.
+
+- **`.arduino_ci/`**
+ - **Description:** 
+ Contains supporting files and configurations for the `arduino_ci.rb` tool.
+ - **Contents:**
+ - **`config.rb`:** 
+ Custom configuration settings for the Arduino CI.
+ - **`helpers.rb`:** 
+ Helper methods and utilities used by the CI scripts.
+ - **Other supporting scripts and assets.**
+
+- **`arduino-ci.yml`**
+ - **Description:** 
+ GitHub Actions workflow file that defines the CI pipeline for the project.
+ - **Key Sections:**
+ - **Jobs:** 
+ Defines the sequence of steps for setting up the environment, installing dependencies, running tests, and compiling examples.
+ - **Triggers:** 
+ Specifies when the workflow should run (e.g., on push or pull request).
+
+- **`examples/`**
+ - **Description:** 
+ Contains example sketches demonstrating how to use the Arduino Temperature Control Library.
+ - **Structure:**
+ - **`ESP-WebServer/`** 
+ ESP-specific examples that utilize libraries like `ESP8266WiFi.h`.
+
+- **`LICENSE`**
+ - **Description:** 
+ Contains the MIT License under which the project is released.
+
+- **Other Files and Directories:**
+ - **`.github/`**
+ - Contains GitHub-specific configurations, issues templates, and additional workflows.
+ - **`src/`**
+ - Contains the source code of the Arduino Temperature Control Library.
+
+### 5. 🔧 Workflow Configuration
+
+The workflow is defined in the `arduino-ci.yml` file. Key configurations include:
+
+- **Cores Installed:**
+ ```yaml
+ arduino-cli core install arduino:avr
+ arduino-cli core install esp8266:esp8266
+ ```
+
+- **Skipping ESP-Specific Examples:**
+ ```yaml
+ export ARDUINO_CI_SKIP_EXAMPLES="ESP-WebServer"
+ ```
+
+- **Compiling for AVR and ESP Platforms:**
+ ```yaml
+ arduino-cli compile --fqbn arduino:avr:uno "$sketch"
+ arduino-cli compile --fqbn esp8266:esp8266:nodemcuv2 "$sketch"
+ ```
+
+### 6. 🤝 Contributing
+
+If you’re contributing to the workflows, please ensure that:
+
+- **Compatibility:** New examples are compatible with both AVR and ESP platforms (if applicable).
+- **Organization:** ESP-specific examples are placed in a clearly labeled directory (e.g., `examples/ESP-WebServer`).
+- **Testing:** Unit tests are added or updated as needed.
+
+### 7. 🐞 Troubleshooting
+
+If the workflow fails:
+
+1. **Check Logs:** Navigate to the Actions tab in GitHub for detailed logs.
+2. **Local Replication:** Try to replicate the issue locally using the dev container.
+3. **Dependencies:** Ensure all dependencies are installed correctly.
+
+## 📄 License
+
+This workflow configuration and scripts are released under the [MIT License](LICENSE).