Getting Started

This guide will walk you through downloading CRSF for Arduino and adding it to your local Arduino libraries.

For PlatformIO users, the process is simpler and more straightforward.
For Arduino IDE users, the process is a bit more "hands-on".

In either case, both methods assume you have a basic knowledge of the development environment you are working with, and have installed the required development board support packages for your chosen target. Keep in mind that the majority of STM32 targets are only available via stm32duino, which is (sadly) not available to PlatformIO. This is the same reason why Earl Phillhower's version of RP2040 support is omitted from CRSF for Arduino, due to the fact that it is currently (almost) exclusively available to those that use the Arduino IDE.

Arduino IDE Users

1. Download the Source Code (zip) from the latest release, and save the file to a convenient location on your hard drive.
2. Extract the top level CRSFforArduino folder.
3. Copy (or move. Your choice.) the extracted CRSFforArduino folder to your Arduino IDE's libraries folder.

Caveats:

• If you already have the Arduino IDE open, you MAY need to restart it in order for CRSF for Arduino to appear in your Libraries section.
• When new versions of CRSF for Arduino are released, you MAY need to manually download and install them every time. This is because CRSF for Arduino is not yet available in the Arduino IDE's Library Manager.

PlatformIO Users

In your platformio.ini file, simply add https://github.com/ZZ-Cat/CRSFforArduino.git @^ 1.0.0 to your lib_deps category.
PlatformIO will automatically update everything that is required, plus download and install any future updates to CRSF for Arduino that is released.

Caveats:

• CRSF for Arduino is not yet available in the PlatformIO Registry. Fortunately, there is no need to manually check for new updates, download, and install them. PlatformIO automatically manages this.