wolfssl/IDE/ARDUINO/Arduino_README_prepend.md

2.5 KiB

Arduino wolfSSL Library

This library is restructured from wolfSSL Release ${WOLFSSL_VERSION} for the Arduino platform.

The Official wolfSSL Arduino Library is found in The Library Manager index.

See the Arduino-wolfSSL logs for publishing status.

Instructions for installing and using libraries can be found in the Arduino docs.

wolfSSL Configuration

As described in the Getting Started with wolfSSL on Arduino, wolfSSL features are enabled and disabled in the user_settings.h file.

The user_settings.h file is found in the <Arduino>/libraries/wolfssl/src directory.

For Windows this is typically C:\Users\%USERNAME%\Documents\Arduino\libraries\wolfssl\src

For Mac: ~/Documents/Arduino/libraries/wolfssl/src

For Linux: ~/Arduino/libraries/wolfssl/src

Tips for success:

  • The WOLFSSL_USER_SETTINGS macro must be defined project-wide. (see wolfssl.h)
  • Apply any customizations only to user_settings.h; Do not edit wolfSSL settings.h or configh.h files.
  • Do not explicitly include user_settings.h in any source file.
  • For every source file that uses wolfssl, include wolfssl/wolfcrypt/settings.h before any other wolfSSL include, typically via #include "wolfssl.h".
  • See the wolfSSL docs for details on build configuration macros.

wolfSSL Examples

Additional wolfSSL examples can be found at:

Arduino Releases

This release of wolfSSL is version 5.7.6.

See GitHub for all Arduino wolfSSL releases.

The first Official wolfSSL Arduino Library was 5.6.6-Arduino.1: a slightly modified, post release 5.6.6 version update.

The ./wolfssl-arduino.sh INSTALL script can be used to install specific GitHub versions as needed.