Skip to content

Getting Started

Cassandra "ZZ Cat" Robinson edited this page Dec 10, 2025 · 14 revisions

As per this announcement, CRSF for Arduino can now be downloaded and installed in Arduino IDE's Library Manager and PlatformIO's Registry.

Arduino IDE Library Manager

Simply search up CRSFforArduino in the Library Manager, and it's the first entry you see. Screenshot_20251211_095037

Click INSTALL and Arduino IDE will automatically download-and-install it for you.
Then go to SketchInclude Library ► and click CRSFforArduino under Contributed libraries.

Screenshot_20251211_095326

That will add this header to the top of your sketch:

#include <CRSFforArduino.hpp>

PlatformIO Registry

CRSF for Arduino can be downloaded from the PlatformIO Registry here, and the installation instructions for it can be viewed here


Versioning

Which ones you should use

Use the latest version of CRSF for Arduino wherever possible.
If you are unsure, check what the latest release is here.

Rolling Release vs Point Release

From v0.1.0 to v1.0.4 I used the Point Release model, as it was the only model at the time I was familiar with while I was learning about the Semantic Versioning standard.
Since learning more about it, I decided to go to a Rolling Release model from v2025.9.2 onwards and keep backward-compatibility with this standard. This means you may get smaller incremental updates instead of one release that has change-logs at least a hundred kilometres long every so often.

I did this to lighten the load, so to speak.
I found it incredibly time-consuming to remember every little detail on what I did with CFA at the time of release and more often than not, I found I was actually forgetting what I did, and I'd end up leaving out vital changes in my release summaries because of that. Rolling Release means I am able to more easily recall what I actually did with CFA at the time of release, as each change is smaller in quantity. This also brings my release model in alignment with my "Quality not quantity" philosophy, and I am able to focus more on improving the quality of CRSF for Arduino instead of bogging myself down with pushing out the highest quantity of commits/pull requests, ultimately burning myself out in the process.

Clone this wiki locally