refactor(compatibility table): Permissive Incompatibility #68
Conversation
This file contains 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
…etical order in bug report template
…ig.hpp` This means debugging messages will now appear when `CRSF_DEBUG_ENABLED` is set to `1` at compile time.
…itor on how to request compatibility support
…ABLE_OUTPUT` define to enable or disable debugging outputs from the Compatibility Table
This enables or disables debut outputs to the Serial Monitor via the selected `CRSF_DEBUG_SERIAL_PORT`.
ZZ-Cat
commented
Jan 18, 2024
src/CRSFforArduino/src/Hardware/CompatibilityTable/CompatibilityTable.cpp
Outdated
Show resolved
Hide resolved
ZZ-Cat
commented
Jan 18, 2024
src/CRSFforArduino/src/Hardware/CompatibilityTable/CompatibilityTable.cpp
Outdated
Show resolved
Hide resolved
…pport instruction messages.
… in permissive incompatibility statements EG `The target board is unknown. CRSF for Arduino will attempt to run on this board, but it may not work properly.`, followed by instructions on how to request compatibility with your development board.
…ibility to the unknown board and chipset permissive incompatibility statement
…" message. This is now handled in the Compatibility Table
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This implements #67 by allowing CRSF for Arduino to initialise successfully on unknown development boards with unknown chipsets, provided that the overall architecture (EG ESP32, SAMD, TEENSY etc) is known.
Details
When CRSF for Arduino is flashed onto a development board that is not supported and it has a microcontroller that is also not supported, but the overall architecture is supported, you will be met with instructions on how to request support in the Serial Monitor when
CRSF_DEBUG_ENABLEDis set to1.If your device shows up as completely incompatible (but compilation succeeds), you can set
CRSF_DEBUG_ENABLE_COMPATIBILITY_TABLE_OUTPUTto1to find out why.This will help me out a lot with diagnosing bugs during compilation, flashing, and initialising - particularly when you guys submit issues surrounding the Compatibility Table, as this seems to be the thing that is tripping a lot of people up now.
So, if your target has one of CRSF for Arduino's supported architectures, but the board itself isn't known, you can still use my library. But, keep in mind that you will still need to ask me to add compatibility at some point.