Merge pull request #21 from ZZ-Cat/ZZ-Cat/issue20

ZZ-Cat · Jun 2, 2023 · e60975b · e60975b
2 parents 829a40a + 0b89ef9
commit e60975b
Show file tree

Hide file tree

Showing 8 changed files with 65 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -105,7 +105,7 @@ The example below demonstrates what your code should look like, using the instru
 
 /* 2. Declare a CRSFforArduino object.
 You can call it literally anything you want, as long as you tell CRSF for Arduino what serial port your receiver is connected to. */
-CRSFforArduino crsf = CRSFforArduino(&Serial1)
+CRSFforArduino crsf = CRSFforArduino(&Serial1);
 
 void setup()
 {

diff --git a/examples/channels/channels.ino b/examples/channels/channels.ino
@@ -3,7 +3,7 @@
  * @author Cassandra "ZZ Cat" Robinson (nicad.heli.flier@gmail.com)
  * @brief This example sketch shows how to receive RC channels from a CRSF receiver using the CRSF for Arduino library.
  * @version 0.4.0
- * @date 2023-05-31
+ * @date 2023-06-03
  *
  * @copyright Copyright (c) 2023, Cassandra "ZZ Cat" Robinson. All rights reserved.
  *

diff --git a/src/CRSFforArduino.h b/src/CRSFforArduino.h
@@ -3,7 +3,7 @@
  * @author Cassandra "ZZ Cat" Robinson (nicad.heli.flier@gmail.com)
  * @brief Top level header for CRSF for Arduino, to help with Arduino IDE compatibility.
  * @version 0.4.0
- * @date 2023-05-31
+ * @date 2023-06-03
  *
  * @copyright Copyright (c) 2023, Cassandra "ZZ Cat" Robinson. All rights reserved.
  *

diff --git a/src/lib/CRSFforArduino/CRSFforArduino.cpp b/src/lib/CRSFforArduino/CRSFforArduino.cpp
@@ -3,7 +3,7 @@
  * @author Cassandra "ZZ Cat" Robinson (nicad.heli.flier@gmail.com)
  * @brief CRSF for Arduino facilitates the use of ExpressLRS RC receivers in Arduino projects.
  * @version 0.4.0
- * @date 2023-05-31
+ * @date 2023-06-03
  *
  * @copyright Copyright (c) 2023, Cassandra "ZZ Cat" Robinson. All rights reserved.
  *
@@ -25,7 +25,11 @@
  */
 
 #include "CRSFforArduino.h"
+#if defined(ARDUINO) && defined(PLATFORMIO)
 #include "CompatibilityTable.h"
+#else
+#include "lib/CompatibilityTable/CompatibilityTable.h"
+#endif
 
 CompatibilityTable CT = CompatibilityTable();
 

diff --git a/src/lib/CRSFforArduino/CRSFforArduino.h b/src/lib/CRSFforArduino/CRSFforArduino.h
@@ -3,7 +3,7 @@
  * @author Cassandra "ZZ Cat" Robinson (nicad.heli.flier@gmail.com)
  * @brief CRSF for Arduino facilitates the use of ExpressLRS RC receivers in Arduino projects.
  * @version 0.4.0
- * @date 2023-05-31
+ * @date 2023-06-03
  *
  * @copyright Copyright (c) 2023, Cassandra "ZZ Cat" Robinson. All rights reserved.
  *

diff --git a/src/lib/CompatibilityTable/CompatibilityTable.cpp b/src/lib/CompatibilityTable/CompatibilityTable.cpp
@@ -1,3 +1,29 @@
+/**
+ * @file CompatibilityTable.cpp
+ * @author Cassandra "ZZ Cat" Robinson (nicad.heli.flier@gmail.com)
+ * @brief Compatibility Table is used to determine if the current device is compatible with CRSF for Arduino.
+ * @version 0.4.0
+ * @date 2023-06-03
+ *
+ * @copyright Copyright (c) 2023, Cassandra "ZZ Cat" Robinson. All rights reserved.
+ *
+ * @section License GNU General Public License v3.0
+ * This source file is a part of the CRSF for Arduino library.
+ * CRSF for Arduino is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * CRSF for Arduino is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with CRSF for Arduino.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
 #include "CompatibilityTable.h"
 
 CompatibilityTable::CompatibilityTable()
@@ -53,6 +79,9 @@ CompatibilityTable::CompatibilityTable()
     device.type.devboard = DEVBOARD_IS_INCOMPATIBLE;
 #warning "Devboard not supported. Please check the compatibility table."
 #endif // ADAFRUIT_FEATHER_M0 etc
+#else
+    device.type.devboard = DEVBOARD_IS_INCOMPATIBLE;
+#warning "Devboard not supported. Please check the compatibility table."
 #endif // ARDUINO_ARCH_SAMD
 }
 

diff --git a/src/lib/CompatibilityTable/CompatibilityTable.h b/src/lib/CompatibilityTable/CompatibilityTable.h
@@ -1,3 +1,29 @@
+/**
+ * @file CompatibilityTable.h
+ * @author Cassandra "ZZ Cat" Robinson (nicad.heli.flier@gmail.com)
+ * @brief Compatibility Table is used to determine if the current device is compatible with CRSF for Arduino.
+ * @version 0.4.0
+ * @date 2023-06-03
+ *
+ * @copyright Copyright (c) 2023, Cassandra "ZZ Cat" Robinson. All rights reserved.
+ *
+ * @section License GNU General Public License v3.0
+ * This header file is a part of the CRSF for Arduino library.
+ * CRSF for Arduino is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * CRSF for Arduino is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with CRSF for Arduino.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
 #pragma once
 
 #include "Arduino.h"

diff --git a/src/src/main_rc.cpp b/src/src/main_rc.cpp
@@ -3,7 +3,7 @@
  * @author Cassandra "ZZ Cat" Robinson (nicad.heli.flier@gmail.com)
  * @brief This file demonstrates the full capabilities of CRSF for Arduino.
  * @version 0.4.0
- * @date 2023-05-31
+ * @date 2023-06-03
  *
  * @copyright Copyright (c) 2023, Cassandra "ZZ Cat" Robinson. All rights reserved.
  *