ZZ-Cat · ZZ-Cat · Jul 24, 2023 · Jul 16, 2023 · Jul 16, 2023 · Jul 16, 2023
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,112 @@
+name: Submit a bug report
+description: Create a bug report & help me improve CRSF for Arduino
+labels: ["🐞 Bug 🐞", "Pending 📌"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to report a bug in CRSF for Arduino.
+        Please fill out the form below to help me improve CRSF for Arduino.
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this bug?
+      description: Please check if there is already an issue for this bug.
+      options: 
+        - label: I have searched the issues and there is no existing issue for this bug.
+          required: true
+  - type: dropdown
+    id: development-environment
+    attributes:
+      label: What development environment are you using?
+      description: Are you using the Arduino IDE or PlatformIO?
+      options:
+        - Arduino IDE
+        - PlatformIO
+    validations:
+      required: true
+  - type: dropdown
+    id: board
+    attributes:
+      label: What board are you using?
+      description: |
+        Please select the board you are using.
+        Please note that only the boards listed below are supported.
+      options:
+        - Adafruit Feather M0 (Any variants EG Bluefruit LE, LoRa, etc)
+        - Adafruit Feather M0 Express
+        - Adafruit Feather M4 Express
+        - Adafruit Feather M4 CAN Express
+        - Adafruit Grand Central M4
+        - Adafruit ItsyBitsy M0 Express
+        - Adafruit ItsyBitsy M4 Express
+        - Adafruit Metro M0 Express
+        - Adafruit Metro M4 Express
+        - Adafruit Metro M4 AirLift Lite
+        - Adafruit QtPy M0
+        - Adafruit Trinket M0
+        - Arduino MKR 1000
+        - Arduino MKR FOX 1200
+        - Arduino MKR GSM 1400
+        - Arduino MKR NB 1500
+        - Arduino MKR VIDOR 4000
+        - Arduino MKR WAN 1300
+        - Arduino MKR WAN 1310
+        - Arduino MKR WiFi 1010
+        - Arduino MKR ZERO
+        - Arduino Nano 33 IoT
+        - Arduino Zero
+        - Seeed Studio XIAO SAMD21
+    validations:
+      required: true
+  - type: dropdown
+    id: bug-type
+    attributes:
+      label: What part of CRSF for Arduino is this bug related to?
+      description: Please select the part of CRSF for Arduino that this bug is related to.
+      options:
+        - Build/Compile/Upload
+        - Compatibility Table
+        - RC Channels
+        - Other (please specify)
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Current behaviour
+      description: Provide a clear & concise description of the bug.
+      placeholder: |
+        A clear and concise description of what the bug is.
+        EG: When I try to compile the code I get this error...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected behaviour
+      description: Provide a clear & concise description of what you expected to happen.
+      placeholder: |
+        A clear and concise description of what you expected to happen.
+        EG: The code should compile without any errors.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: |
+        Provide a clear & concise description of how to reproduce the bug.
+        Please include any code that is required to reproduce the bug.
+      placeholder: |
+        A clear and concise description of how to reproduce the bug.
+        EG: To reproduce the bug, compile the code with the following settings...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: |
+        Provide any additional information that may be relevant to the bug.
+        EG: I am using the following version of the Arduino IDE...
+
+        Tip: You can paste code, logs, or config files into the text box below.
+        Screenshots can also be pasted into the text box below.
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/devboard-request.yml b/.github/ISSUE_TEMPLATE/devboard-request.yml
@@ -0,0 +1,32 @@
+name: Devboard Compatibility Request
+description: Tell me which development board you would like me to add to CRSF for Arduino.
+labels: ["✨️ Enhancement ✨️"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Request your development board to be added to CRSF for Arduino's Compatibility Table.
+  - type: checkboxes
+    attributes:
+      label: Minimum requirements
+      description: |
+        Your devboard _must_ meet these requirements in order for it to be compatible with CRSF for Arduino.
+        Please check your development board's documentation & the data sheet of its host microcontroller for more information.
+      options:
+        - label: Core clock speed is 48 MHz or faster?
+          required: true
+        - label: Is the CPU an ARM Cortex M0+ or later?
+          required: true
+        - label: Is the host microcontroller's UART peripheral able to support 420,000 (or higher) baud rate(s)?
+          required: true
+        - label: Is your development board currently supported in the Arduino IDE?
+          required: true
+  - type: textarea
+    attributes:
+      label: What development board would you like me to add?
+      description: |
+        Provide a clear & concise description of what your devboard is, what its host microcontroller is,
+        & provide links to the development board's documentation & the data sheet of its host microcontroller.
+      placeholder: My development board is...
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,51 @@
+name: Submit a feature request
+description: Suggest an idea for CRSF for Arduino to help make it better.
+labels: ["✨️ Enhancement ✨️"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for suggesting an idea for CRSF for Arduino!
+
+        If your idea is still in its early stages or you're not sure if it will benefit my project,
+        you can open a discussion in the [Ideas](https://github.com/ZZ-Cat/CRSFforArduino/discussions/categories/ideas) category instead.
+  - type: checkboxes
+    attributes:
+      label: Is there already an issue for this?
+      description: Please check if there is already an issue for this feature request.
+      options:
+        - label: I have searched the issues and there is no existing issue for this feature request.
+          required: true
+  - type: textarea
+    attributes:
+      label: Is your feature request related to a problem?
+      description: Please provide a clear & concise description of what the problem is.
+      placeholder: I'm always frustrated when [...]
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the solution you'd like
+      description: Please provide a clear & concise description of what you want to happen.
+      placeholder: I'd like to be able to [...]
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe alternatives you've considered
+      description: Please provide a clear & concise description of any alternative solutions or features you've considered.
+      placeholder: |
+        I have considered [...]
+        But it will not work because [...]
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Please provide any other context or screenshots about the feature request here.
+      placeholder: |
+        Add any other context or screenshots about the feature request here.
+        EG: I am using [...]
+        EG: I am using the following version of CRSF for Arduino [...]
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/.github/workflows/auto_close.yml b/.github/workflows/auto_close.yml
@@ -13,8 +13,8 @@ jobs:
           stale-issue-message: 'This issue has been closed due to inactivity in over 30 days after being marked for closure.'
           stale-pr-message: 'This pull request has been closed due to inactivity in over 30 days after being marked for closure.'
           days-before-stale: 30
-          days-before-close: 30
+          days-before-close: 60
           stale-issue-label: 'Stale 🚮'
-          exempt-issue-labels: '🚨 Help Wanted 🚨'
+          exempt-issue-labels: '🚨 Help Wanted 🚨, Note to self ✏️🗒, Pending 📌'
           stale-pr-label: 'Stale 🚮'
-          exempt-pr-labels: 'Bug Fix 👋🐞💥, 🚨 Help Wanted 🚨'
+          exempt-pr-labels: 'Bug Fix 👋🐞💥, 🚨 Help Wanted 🚨, ⤴️ Rebase Needed ⤴️'
diff --git a/README.md b/README.md
@@ -208,6 +208,7 @@ While CRSF for Arduino is primarily developed on the Adafruit Metro M4 Express,
     - MKR Zero
   - Arduino Nano 33 IoT
   - Arduino Zero
+  - Seeed Studio XIAO SAMD21
 - SAMD51 based boards:
   - Adafruit Feather M4 Express
   - Adafruit Grand Central M4
@@ -219,12 +220,16 @@ While CRSF for Arduino is primarily developed on the Adafruit Metro M4 Express,
 
 Compatibility with other microcontroller boards may be added in future, if there is demand for it. Keep in mind that this will be subject to hardware limitations of the host microcontroller itself.
 
-Generally speaking, if the host microcontroller's UART peripheral supports 420k bauds (or higher), it is a likely candidate for CRSF for Arduino. Bonus points if the microcontroller has DMA (Direct Memory Access), because this helps immensely to capture RC data & send out telemetry data.
+In order for CRSF for Arduino to run, the host microcontroller _must_ meet these minimum requirements:
 
-The only limitation so far is the microcontroller's ability to change the UART's data order. CRSF requires data to be transmitted & received in MSB (Most Significant Bit) First. Traditionally, UART is transmitted & received in LSB (Least Significant Bit) First. ATSAMD21 & ATSAMD51 microcontrollers are the only two Arduino-compatible microcontrollers (that I am aware of) that have the ability to select what data order the UART is sent & received as.
+- Core Clock Speed: 48 MHz or higher.
+- CPU: ARM Cortex M0+ or later.
+- UART Baud Rate: 420 KB/s.
 
 I am now aware that Arduino are making an R4 of their UNO & Adafruit are making a Metro M7. This is exciting news for me, because I would like to make these development boards fully compatible with CRSF for Arduino as & when their respective underlying code & toolchain support is added.
 
+As for other development boards (& their host microcontrollers), if they meet the minimum requirements & you are still having compatibility issues, it is likely that I have not yet added your board to the Compatibility Table. Consider opening up an [Issue](https://github.com/ZZ-Cat/CRSFforArduino/issues/new/choose) & we can go from there.
+
 ## AVR based microcontrollers are not compatible
 
 Development boards of yesteryear that were built around ATmega AVR microcontrollers such as the 328, 32u4, 2560 & 4809 are incompatible with CRSF for Arduino.
@@ -251,6 +256,7 @@ Here are some examples:
 - These have an equivalent "breadboard-friendly" form factor that is similar to the Arduio Micro & the Arduino Nano:
   - Adafruit Feather M0 (all variants, including the Feather M0 Express)
   - Adafruit Feather M4 Express
+  - Seeed Studio XIAO SAMD21
 - These have the "Arduino R3" form factor - The same shape as the Arduino UNO:
   - Adafruit:
     - Metro M0 Express
@@ -276,6 +282,10 @@ For wiring, here is how you do it:
 - T (or Tx) on your receiver goes to ►Rx/Pin0 on your development board. This step can catch you out, if you're not careful.
 - R (or Rx) on your reciever goes to ◄Tx/Pin1 on your development board. This step can catch you out, if you're not careful.
 
+**NB:** Some development boards (especially smaller ones) may not route the primary UART port to the default 0 & 1 pins, as these pins may be used for other purposes or they simply are not physically available to you on the device.
+As a workaround, CRSF for Arduino automatically selects the closest available pins that has a suitable UART port.
+You _must_ refer to your development board's documentation to determine where your default Tx & Rx pins are. These are the pins that CRSF for Arduino will use.
+
 ## Telemetry
 
 Currently, there is no telemetry feedback from the host microcontroller's side... _yet!_

diff --git a/examples/channels/channels.ino b/examples/channels/channels.ino
@@ -2,8 +2,8 @@
  * @file channels.ino
  * @author Cassandra "ZZ Cat" Robinson ([email protected])
  * @brief This example sketch shows how to receive RC channels from a CRSF receiver using the CRSF for Arduino library.
- * @version 0.3.2
- * @date 2023-06-03
+ * @version 0.4.0
+ * @date 2023-07-17
  *
  * @copyright Copyright (c) 2023, Cassandra "ZZ Cat" Robinson. All rights reserved.
  *
@@ -118,7 +118,14 @@ void setup()
     }
 
     // Initialize the CRSFforArduino library.
-    crsf.begin();
+    if (!crsf.begin())
+    {
+        Serial.println("CRSF for Arduino initialization failed!");
+        while (1)
+        {
+            ;
+        }
+    }
 
     // Show the user that the sketch is ready.
     Serial.println("RC Channels Example");

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=CRSFforArduino
-version=0.3.2
+version=0.4.0
 author=Cassandra Robinson <[email protected]>
 maintainer=Cassandra Robinson <[email protected]>
 sentence=An Arduino Library for communicating with ExpressLRS receivers.

diff --git a/platformio.ini b/platformio.ini
@@ -91,6 +91,10 @@ lib_deps = ${common.lib_deps}
 board = mkrzero
 lib_deps = ${common.lib_deps}
 
+[env:seeed_xiao]
+board = seeed_xiao
+lib_deps = ${common.lib_deps}
+
 [env:zero]
 board = zero
 lib_deps = ${common.lib_deps}
@@ -113,8 +117,8 @@ board_build.f_cpu = ${common.cpu_speed}
 build_flags = ${common.compile_flags}
 lib_deps = ${common.lib_deps}
 
-[env:adafruit_grand_central_m4]
-board = adafruit_grand_central_m4
+[env:adafruit_grandcentral_m4]
+board = adafruit_grandcentral_m4
 board_build.f_cpu = ${common.cpu_speed}
 build_flags = ${common.compile_flags}
 debug_tool = ${common.debugger}

diff --git a/src/CRSFforArduino.h b/src/CRSFforArduino.h
@@ -2,8 +2,8 @@
  * @file CRSFforArduino.h
  * @author Cassandra "ZZ Cat" Robinson ([email protected])
  * @brief Top level header for CRSF for Arduino, to help with Arduino IDE compatibility.
- * @version 0.3.2
- * @date 2023-06-03
+ * @version 0.4.0
+ * @date 2023-07-17
  *
  * @copyright Copyright (c) 2023, Cassandra "ZZ Cat" Robinson. All rights reserved.
  *