Move Arduino examples, add GitHub workflow #499

gojimmypi · 2025-04-05T16:02:07Z

Overview

This pull request adds a comprehensive set of Arduino examples to the wolfssl-examples repository, along with GitHub workflows for continuous integration testing. The examples demonstrate how to use wolfSSL in various Arduino environments and provide templates for developers to build upon.

The new and updated examples were originally in wolfssl/IDE/ARDUINO, but moved here as noted in wolfSSL/wolfssl#8514 (comment)

Note there's a bit of a chicken-and-egg problem of:

Moving the examples.
Modifying the install script to include those examples from the new home when publishing the Arduino library to https://github.com/wolfSSL/Arduino-wolfSSL for the respective examples.
Taking into account other changes in wolfSSL/wolfssl#8514 that are needed for some of the examples. (several board examples combos are disabled in this PR Arduino.yml workflow until wolfSSL/wolfssl#8514 is merged)

As such, follow-up pull requests will be needed both here and in wolfssl

Changes

Arduino Examples

Added five Arduino example sketches:

wolfssl_version: A bare-bones example that simply displays the current wolfSSL version. Ideal for verifying library installation and compatibility.
template: A reference template with multiple files demonstrating proper project structure for Arduino projects using wolfSSL. Includes VisualGDB project files for developers using that IDE.
wolfssl_AES_CTR: Demonstrates AES Counter mode encryption and decryption using wolfSSL. Shows proper key setup, encryption/decryption workflow, and error handling.
wolfssl_client: A TLS client implementation that connects to a wolfSSL server. Includes support for various Arduino boards with both WiFi and Ethernet connectivity options.
wolfssl_server: A TLS server implementation that listens for connections from wolfSSL clients. Includes detailed documentation on connecting with both Arduino clients and command-line clients.

Documentation

Added comprehensive README files for each example with setup instructions, board compatibility information, and troubleshooting tips
Included detailed code comments explaining wolfSSL usage patterns and best practices
Added cross-references between related examples (e.g., client and server)

GitHub Workflow and Templates

Added GitHub workflow for automated testing of Arduino examples across multiple board types
Added issue templates for bug reports and general issues (copied from wolfssl/.github).
Updated .gitignore to exclude Arduino-specific temporary files

CI/CD Integration

Implemented Arduino CI build workflow that tests compilation across various Arduino boards:
- Arduino UNO, Mega, Nano, Zero
- ESP32 and ESP8266
- Teensy 4.0
- Due and other supported boards

Benefits

Provides ready-to-use examples for developers integrating wolfSSL with Arduino
Demonstrates proper wolfSSL usage patterns in Arduino environments
Ensures examples remain compatible with various Arduino boards through CI testing
Improves developer experience with detailed documentation and troubleshooting guides

Copilot

Copilot reviewed 14 out of 26 changed files in this pull request and generated 2 comments.

Files not reviewed (12)

Arduino/sketches/template/template.adeps: Language not supported
Arduino/sketches/template/template.ino: Language not supported
Arduino/sketches/template/template.sln: Language not supported
Arduino/sketches/template/template.vgdbproj: Language not supported
Arduino/sketches/template/wolfssl_helper.c: Language not supported
Arduino/sketches/template/wolfssl_helper.h: Language not supported
Arduino/sketches/template/wolfssl_library/src/wolfssl_library.cpp: Language not supported
Arduino/sketches/template/wolfssl_library/wolfssl_library.h: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.adeps: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.ino: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.sln: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.vgdbproj: Language not supported

Comments suppressed due to low confidence (3)

Arduino/sketches/template/README.md:1

The title in the template README seems incorrect; consider renaming it to indicate that it is a template example rather than an AES CTR example.

# Arduino AES CTR Example

Arduino/README.md:141

Fix the typo 'ARDUNIO' to 'Arduino' in the library folder path.

    - In `Sketch -> Include Library -> Add .ZIP Library...` and choose the `IDE/ARDUNIO/wolfSSL` folder.

Arduino/sketches/README.md:26

Correct 'configh.h' to 'config.h' for the proper filename reference.

 * Do not edit wolfSSL `settings.h` or `configh.h` files.

Arduino/sketches/README.md

Arduino/README.md

…#499

Copilot

Copilot reviewed 14 out of 26 changed files in this pull request and generated 2 comments.

Files not reviewed (12)

Arduino/sketches/template/template.adeps: Language not supported
Arduino/sketches/template/template.ino: Language not supported
Arduino/sketches/template/template.sln: Language not supported
Arduino/sketches/template/template.vgdbproj: Language not supported
Arduino/sketches/template/wolfssl_helper.c: Language not supported
Arduino/sketches/template/wolfssl_helper.h: Language not supported
Arduino/sketches/template/wolfssl_library/src/wolfssl_library.cpp: Language not supported
Arduino/sketches/template/wolfssl_library/wolfssl_library.h: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.adeps: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.ino: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.sln: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.vgdbproj: Language not supported

Comments suppressed due to low confidence (1)

.github/workflows/arduino.yml:79

The pattern matching for boards uses the pipe character ('|') incorrectly, which may cause the condition to evaluate unexpectedly. Consider using a proper regular expression with grouping (e.g., "arduino:avr:(uno|mega|nano)") to ensure accurate matching.

if [[ "$BOARD" =~ "arduino:avr:uno"|"arduino:avr:mega"|"arduino:avr:nano"|"arduino:sam:arduino_zero_native" && ( "$EXAMPLE" =~ "wolfssl_server" || "$EXAMPLE" =~ "wolfssl_client" || "$EXAMPLE" =~ "test" ) ]]; then

.github/workflows/arduino.yml

Copilot

Copilot reviewed 14 out of 26 changed files in this pull request and generated no comments.

Files not reviewed (12)

Arduino/sketches/template/template.adeps: Language not supported
Arduino/sketches/template/template.ino: Language not supported
Arduino/sketches/template/template.sln: Language not supported
Arduino/sketches/template/template.vgdbproj: Language not supported
Arduino/sketches/template/wolfssl_helper.c: Language not supported
Arduino/sketches/template/wolfssl_helper.h: Language not supported
Arduino/sketches/template/wolfssl_library/src/wolfssl_library.cpp: Language not supported
Arduino/sketches/template/wolfssl_library/wolfssl_library.h: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.adeps: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.ino: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.sln: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.vgdbproj: Language not supported

Comments suppressed due to low confidence (1)

.github/workflows/arduino.yml:5

Typo in comment: 'om push/ branches' should be corrected to 'on push/ branches'.

# TODO remove '*' om push/ branches, and uncomment github.repository_owner == 'wolfssl'

Copilot

Copilot reviewed 14 out of 26 changed files in this pull request and generated no comments.

Files not reviewed (12)

Arduino/sketches/template/template.adeps: Language not supported
Arduino/sketches/template/template.ino: Language not supported
Arduino/sketches/template/template.sln: Language not supported
Arduino/sketches/template/template.vgdbproj: Language not supported
Arduino/sketches/template/wolfssl_helper.c: Language not supported
Arduino/sketches/template/wolfssl_helper.h: Language not supported
Arduino/sketches/template/wolfssl_library/src/wolfssl_library.cpp: Language not supported
Arduino/sketches/template/wolfssl_library/wolfssl_library.h: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.adeps: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.ino: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.sln: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.vgdbproj: Language not supported

Comments suppressed due to low confidence (1)

.github/workflows/arduino.yml:5

There appears to be a typo in the comment on line 5 ('om' should be 'on' or corrected to 'from').

# TODO remove '*' om push/ branches, and uncomment github.repository_owner == 'wolfssl'

Copilot

Copilot reviewed 14 out of 26 changed files in this pull request and generated no comments.

Files not reviewed (12)

Arduino/sketches/template/template.adeps: Language not supported
Arduino/sketches/template/template.ino: Language not supported
Arduino/sketches/template/template.sln: Language not supported
Arduino/sketches/template/template.vgdbproj: Language not supported
Arduino/sketches/template/wolfssl_helper.c: Language not supported
Arduino/sketches/template/wolfssl_helper.h: Language not supported
Arduino/sketches/template/wolfssl_library/src/wolfssl_library.cpp: Language not supported
Arduino/sketches/template/wolfssl_library/wolfssl_library.h: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.adeps: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.ino: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.sln: Language not supported
Arduino/sketches/wolfssl_AES_CTR/wolfssl_AES_CTR.vgdbproj: Language not supported

Comments suppressed due to low confidence (2)

.github/workflows/arduino.yml:5

Typo in comment: 'om push/ branches' should be corrected to 'on push/branches'.

# TODO remove '*' om push/ branches, and uncomment github.repository_owner == 'wolfssl'

Arduino/sketches/wolfssl_client/README.md:9

[nitpick] Consider rephrasing for clarity, for example: 'Refer to the definition of WOLFSSL_TLS_SERVER_HOST to configure your server address.'

See the `#define WOLFSSL_TLS_SERVER_HOST` to set your own server address.

gojimmypi · 2025-04-06T11:04:20Z

See example workflow output.

Many workflow items are disabled due to either known memory limitations (e.g. server on Arduino UNO) and/or issues fixed in wolfSSL/wolfssl#8514

.github/workflows/arduino.yml

gojimmypi requested review from Copilot and dgarske April 5, 2025 16:02

gojimmypi assigned gojimmypi, dgarske and wolfSSL-Bot Apr 5, 2025

Copilot AI reviewed Apr 5, 2025

View reviewed changes

Arduino/sketches/README.md Outdated Show resolved Hide resolved

Arduino/README.md Outdated Show resolved Hide resolved

gojimmypi mentioned this pull request Apr 5, 2025

Introduce and move new Arduino examples and configuration updates. wolfSSL/wolfssl#8514

Merged

4 tasks

gojimmypi added a commit to gojimmypi/wolfssl that referenced this pull request Apr 5, 2025

Revert TLSX gate; Move Arduino Examples; See wolfSSL/wolfssl-examples…

ce8a52e

…#499

gojimmypi added a commit to gojimmypi/wolfssl that referenced this pull request Apr 6, 2025

Revert TLSX gate; Move Arduino Examples; See wolfSSL/wolfssl-examples…

67ccccb

…#499

gojimmypi force-pushed the pr-arduino-examples branch from 90e468d to 5623f7f Compare April 6, 2025 09:56

gojimmypi requested a review from Copilot April 6, 2025 09:56

Copilot AI reviewed Apr 6, 2025

View reviewed changes

.github/workflows/arduino.yml Outdated Show resolved Hide resolved

.github/workflows/arduino.yml Outdated Show resolved Hide resolved

gojimmypi force-pushed the pr-arduino-examples branch from 5623f7f to 9ccbdb9 Compare April 6, 2025 10:10

gojimmypi requested a review from Copilot April 6, 2025 10:10

Copilot AI reviewed Apr 6, 2025

View reviewed changes

gojimmypi requested a review from Copilot April 6, 2025 10:18

Copilot AI reviewed Apr 6, 2025

View reviewed changes

Move Arduino examples, add GitHub workflow

638297a

gojimmypi force-pushed the pr-arduino-examples branch from 6982a10 to 638297a Compare April 6, 2025 11:01

gojimmypi requested a review from Copilot April 6, 2025 11:02

Copilot AI reviewed Apr 6, 2025

View reviewed changes

gojimmypi mentioned this pull request Apr 6, 2025

Add scheduled runs of MQTT workflows wolfSSL/wolfMQTT#408

Closed

Assume unspecified boards are using standard WiFi library.

40fa4eb

dgarske requested changes Apr 9, 2025

View reviewed changes

.github/workflows/arduino.yml Outdated Show resolved Hide resolved

dgarske removed their assignment Apr 9, 2025

remove push wildcard, run only for wolfssl owner

1aa07ac

gojimmypi requested a review from dgarske April 9, 2025 19:27

gojimmypi assigned dgarske Apr 9, 2025

gojimmypi mentioned this pull request Apr 14, 2025

Fix Arduino progmem print, AVR WOLFSSL_USER_IO wolfSSL/wolfssl#8668

Merged

4 tasks

gojimmypi mentioned this pull request Apr 29, 2025

Feature Request: Add wolfSSL ability to force AVR constants into flash. wolfSSL/Arduino-wolfSSL#14

Open

dgarske approved these changes May 6, 2025

View reviewed changes

dgarske merged commit 7e65d00 into wolfSSL:master May 6, 2025

gojimmypi mentioned this pull request May 7, 2025

wolfssl 5.8.0 Release for Arduino wolfSSL/Arduino-wolfSSL#15

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move Arduino examples, add GitHub workflow #499

Move Arduino examples, add GitHub workflow #499

gojimmypi commented Apr 5, 2025

Copilot AI left a comment

Copilot AI left a comment

Copilot AI left a comment

Copilot AI left a comment

Copilot AI left a comment

gojimmypi commented Apr 6, 2025 •

edited

Loading

Move Arduino examples, add GitHub workflow #499

Move Arduino examples, add GitHub workflow #499

Conversation

gojimmypi commented Apr 5, 2025

Overview

Changes

Arduino Examples

Added five Arduino example sketches:

Documentation

GitHub Workflow and Templates

CI/CD Integration

Benefits

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot AI left a comment

Choose a reason for hiding this comment

gojimmypi commented Apr 6, 2025 • edited Loading

gojimmypi commented Apr 6, 2025 •

edited

Loading