ZZ-Cat / CRSFforArduino

An Arduino Library for communicating with ExpressLRS and TBS Crossfire receivers.
GNU Affero General Public License v3.0
161 stars 27 forks source link

chore(library): House keeping #135

Closed ZZ-Cat closed 3 months ago

ZZ-Cat commented 3 months ago

Overview

[!NOTE]

This Pull Request targets the v1.0.x-Maintenance-Branch

This PR brings various clean-ups, and streamlines the Semantic Versioning for each source and header file.

Details

Streamlined Semantic Versioning

As CRSF for Arduino grows, it has become increasingly tedious to go through every individual file to update the Semantic Version header. Not only that, this is the primary source of clashes when it comes to re-basing CRSF for Arduino onto different branches... namely when a branch's head has been updated.

New debug configuration flags

This Pull Request also brings in a small-ish feature where CRSF for Arduino's boiler plate (IE Name, Version, and Build Date etc) are printed to the Serial Monitor if you have the CRSF_DEBUG_ENABLED flag set to 1.

Another helpful debug feature intorduced by this Pull Request is the CRSF_DEBUG_ENABLE_CONFIGURATION_DUMP flag. Setting this to 1 will show your current configuration of CRSF for Arduino in the Serial Monitor.

The configuration dump identifies your development board and what pins you are currently using with CRSF for Arduino as well as LQI and RSSI thresholds, maximum number of RC channels, minimum and maximum RC channel values (in microseconds) and the centre channel value (also in microseconds).