Overview

This is a follow-up release to Version 1.0.0, and it is for those that were unable to install or build CRSF for Arduino in the Arduino IDE.

What's Changed

Fixes

• fix(arduino): Arduino IDE build failure by @ZZ-Cat in https://github.com/ZZ-Cat/CRSFforArduino/pull/94

Chores

• ci(workflows): Arduino, Auto-close, and PlatformIO maintenance by @ZZ-Cat in https://github.com/ZZ-Cat/CRSFforArduino/pull/91

More information

Full Changelog: https://github.com/ZZ-Cat/CRSFforArduino/compare/v1.0.0...v1.0.1

Semantic Versioning

All releases of CRSF for Arduino follow the Semantic Versioning Guidelines. This means "Major.Minor.Patch". Major = New features that are incompatible with previous iterations. Minor = New features &/or hardware support that retains compatibility with the current Major release. Patch = Bug fixes.

This is Patch Version is the first follow-up release to Major Version 1.x.x. While every effort has gone in to ensure the latest release is bug-free, there are no guarantees with firmware development. Your feedback is always welcome. If you spot any bugs, don't hesitate to open an issue. For general comments & questions, please use the discussions section. New contributors are always welcome. Please read through my Contribution Guidelines before you go Gung Ho with coding.

Installation

Arduino IDE v2.x.x

1. Download the Source Code (ZIP) in the Assets section of this Release, and save to a convenient space on your hard drive.
2. In the Arduino IDE, go to Sketch -> Include Library -> Add .ZIP Library...
3. Click CRSFforArduino-1.0.1 and Arduino IDE will automatically install it for you.
4. Build-test one of the examples. preferably the rc_channels example by File -> Examples -> CRSFforArduino -> rc_channels.
5. Click Verify and the build should pass.

PlatformIO

Installing for the first time:

1. Type pio pkg install -l https://github.com/ZZ-Cat/CRSFforArduino.git into your Terminal, using the version tag #1.0.1 suffix.
2. Hit enter.
3. PlatformIO will automatically install CRSF for Arduino for you.

Updating from a previous version:

You MUST delete the previous version before you update to this version.
The version tag suffix MUST match the Semantic Version of CRSF for Arduino that you currently have.

1. Type: pio pkg install -l https://github.com/ZZ-Cat/CRSFforArduino.git into your Terminal, followed by your existing version suffix. EG #v1.0.0
2. Hit enter.
3. Once PlatformIO has cleared out CRSF for Arduino, this is where you install this version.
4. Type: pio pkg install -l https://github.com/ZZ-Cat/CRSFforArduino.git#v1.0.1 into your Terminal.
5. PlatformIO will automatically install this version of CRSF for Arduino.

You MAY build-test your side of things, to ensure compilation passes.

If you're unfamiliar with the Command Line, you MAY add https://github.com/ZZ-Cat/CRSFforArduino.git#v1.0.1 to your lib_deps section of your platformio.ini configuration file.