chore(library): House keeping#135
Merged
ZZ-Cat merged 5 commits intov1.0.x-Maintenance-Branchfrom Aug 29, 2024
Merged
Conversation
…l header and source file Currently, with over 28 files, CRSF for Arduino is incredibly tedious to re-base because of these two tags in the boiler plate. In addition to this, the version numbering and dates are already tracked in `CFA_Config.hpp`. Therefore, it is pointless to keep tracking CRSF for Arduino's overall version and date in every individual file. At this point, it's work for work's sake, and it's unnecessarily tedious to do it... even more so as CRSF for Arduino grows and more headers and source files are added over time. The juice is not worth the squeeze to track CRSF for Arduino's version and date in every individual file, when it's more efficient to do it in the config and properties files.
…iver.cpp`, and `CRSF.cpp`
…ABLE_CONFIGURATION_DUMP` is set to `1`
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Note
This Pull Request targets the
v1.0.x-Maintenance-BranchThis 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_ENABLEDflag set to1.Another helpful debug feature intorduced by this Pull Request is the
CRSF_DEBUG_ENABLE_CONFIGURATION_DUMPflag. Setting this to1will 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).