Merge pull request #192 from adafruit/add-note-multi-cdc

update multiple cdc example

Author: hathach

examples/CDC/cdc_multi/cdc_multi.ino

@@ -15,22 +15,45 @@
  *
  * Requirement:
  *  The max number of CDC ports (CFG_TUD_CDC) has to be changed to at least 2.
- *  Config file is located in Adafruit_TinyUSB_Arduino/src/arduino/ports/platform/tusb_config_platform.h
- *  where platform is one of: esp32, nrf, rp2040, samd
+ *  Config file is located in Adafruit_TinyUSB_Arduino/src/arduino/ports/{platform}/tusb_config_{platform}.h
+ *  where platform is one of: nrf, rp2040, samd
+ *
+ *  NOTE: Currnetly multiple CDCs on ESP32-Sx is not yet supported.
+ *  An PR to update core/esp32/USBCDC and/or pre-built libusb are needed.
+ *  We would implement this later when we could.
  */
 
 #include <Adafruit_TinyUSB.h>
 
 #define LED LED_BUILTIN
 
-// Create extra USB Serial Ports.  "Serial" is already created.
-Adafruit_USBD_CDC USBSer1;
+// Create 2nd instance of CDC Ports.
+#ifdef ARDUINO_ARCH_ESP32
+  #error "Currnetly multiple CDCs on ESP32-Sx is not yet supported. An PR to update core/esp32/USBCDC and/or pre-built libusb are needed."
+  // for ESP32, we need to specify instance number when declaring object
+  Adafruit_USBD_CDC USBSer1(1);
+#else
+  Adafruit_USBD_CDC USBSer1;
+#endif
 
 void setup() {
   pinMode(LED, OUTPUT);
 
-  // start up all of the USB Vitual ports, and wait for them to enumerate.
   Serial.begin(115200);
+
+  // check to see if multiple CDCs are enabled
+  if ( CFG_TUD_CDC < 2 ) {
+    digitalWrite(LED, HIGH); // LED on for error indicator
+
+    while(1) {
+      Serial.printf("CFG_TUD_CDC must be at least 2, current value is %u\n", CFG_TUD_CDC);
+      Serial.println("  Config file is located in Adafruit_TinyUSB_Arduino/src/arduino/ports/{platform}/tusb_config_{platform}.h");
+      Serial.println("  where platform is one of: nrf, rp2040, samd");
+      delay(1000);
+    }
+  }
+
+  // initialize 2nd CDC interface
   USBSer1.begin(115200);
 
   while (!Serial || !USBSer1) {

src/arduino/Adafruit_USBD_CDC.h

@@ -27,7 +27,14 @@
 
 #include "Adafruit_TinyUSB_API.h"
 
-#if defined(__cplusplus) && !defined(ARDUINO_ARCH_ESP32)
+#if defined(__cplusplus)
+
+#if defined(ARDUINO_ARCH_ESP32)
+
+// For ESP32 use USBCDC as it is compatible
+#define Adafruit_USBD_CDC USBCDC
+
+#else
 
 #include "Adafruit_USBD_Interface.h"
 #include "Stream.h"
@@ -96,5 +103,7 @@ extern Adafruit_USBD_CDC Serial;
 extern Adafruit_USBD_CDC SerialTinyUSB;
 #endif
 
+#endif // else of ESP32
 #endif // __cplusplus
+
 #endif