Add guard to USB examples

me-no-dev · me-no-dev · commit fef7fb39fe07 · 2022-02-23T23:45:04.000+02:00
diff --git a/.github/scripts/install-platformio-esp32.sh b/.github/scripts/install-platformio-esp32.sh
@@ -32,7 +32,7 @@ replace_script+="data['packages']['toolchain-xtensa-esp32']['version']='$TOOLCHA
 replace_script+="data['packages']['toolchain-xtensa-esp32s2']['version']='$TOOLCHAIN_VERSION';"
 replace_script+="data['packages']['toolchain-riscv32-esp']['version']='$TOOLCHAIN_VERSION';"
 # Add ESP32-S3 Toolchain
-replace_script+="data['packages'].append({'toolchain-xtensa-esp32s3':{'type':'toolchain','optional':true,'owner':'$ESPRESSIF_ORGANIZATION_NAME','version':'$TOOLCHAIN_VERSION'}});"
+replace_script+="data['packages'].update({'toolchain-xtensa-esp32s3':{'type':'toolchain','optional':true,'owner':'$ESPRESSIF_ORGANIZATION_NAME','version':'$TOOLCHAIN_VERSION'}});"
 # esptool.py may require an upstream version (for now platformio is the owner)
 replace_script+="data['packages']['tool-esptoolpy']['version']='$ESPTOOLPY_VERSION';"
 # Save results
diff --git a/cores/esp32/HWCDC.cpp b/cores/esp32/HWCDC.cpp
@@ -381,10 +381,12 @@ void HWCDC::setDebugOutput(bool en)
     }
 }
 
-#if ARDUINO_USB_CDC_ON_BOOT && ARDUINO_USB_MODE //Serial used for USB CDC
+#if ARDUINO_USB_MODE
+#if ARDUINO_USB_CDC_ON_BOOT//Serial used for USB CDC
 HWCDC Serial;
 #else
 HWCDC USBSerial;
 #endif
+#endif
 
 #endif /* CONFIG_TINYUSB_CDC_ENABLED */
diff --git a/cores/esp32/HWCDC.h b/cores/esp32/HWCDC.h
@@ -98,10 +98,12 @@ class HWCDC: public Stream
 
 };
 
-#if ARDUINO_USB_CDC_ON_BOOT && ARDUINO_USB_MODE//Serial used for USB CDC
+#if ARDUINO_USB_MODE
+#if ARDUINO_USB_CDC_ON_BOOT//Serial used for USB CDC
 extern HWCDC Serial;
 #else
 extern HWCDC USBSerial;
 #endif
+#endif
 
 #endif /* CONFIG_IDF_TARGET_ESP32C3 */
diff --git a/libraries/USB/examples/CompositeDevice/CompositeDevice.ino b/libraries/USB/examples/CompositeDevice/CompositeDevice.ino
@@ -1,3 +1,8 @@
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 #include "USB.h"
 #include "USBHIDMouse.h"
 #include "USBHIDKeyboard.h"
@@ -211,3 +216,4 @@ void loop() {
     }
   }
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/ConsumerControl/ConsumerControl.ino b/libraries/USB/examples/ConsumerControl/ConsumerControl.ino
@@ -1,3 +1,8 @@
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 #include "USB.h"
 #include "USBHIDConsumerControl.h"
 USBHIDConsumerControl ConsumerControl;
@@ -19,3 +24,4 @@ void loop() {
   }
   previousButtonState = buttonState;
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/CustomHIDDevice/CustomHIDDevice.ino b/libraries/USB/examples/CustomHIDDevice/CustomHIDDevice.ino
@@ -1,3 +1,8 @@
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 #include "USB.h"
 #include "USBHID.h"
 USBHID HID;
@@ -50,6 +55,7 @@ public:
 };
 
 CustomHIDDevice Device;
+#endif /* ARDUINO_USB_MODE */
 
 const int buttonPin = 0;
 int previousButtonState = HIGH;
diff --git a/libraries/USB/examples/FirmwareMSC/FirmwareMSC.ino b/libraries/USB/examples/FirmwareMSC/FirmwareMSC.ino
@@ -1,3 +1,8 @@
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 #include "USB.h"
 #include "FirmwareMSC.h"
 
@@ -72,3 +77,4 @@ void setup() {
 void loop() {
   // put your main code here, to run repeatedly
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/Gamepad/Gamepad.ino b/libraries/USB/examples/Gamepad/Gamepad.ino
@@ -1,3 +1,8 @@
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 #include "USB.h"
 #include "USBHIDGamepad.h"
 USBHIDGamepad Gamepad;
@@ -19,3 +24,4 @@ void loop() {
   }
   previousButtonState = buttonState;
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/HIDVendor/HIDVendor.ino b/libraries/USB/examples/HIDVendor/HIDVendor.ino
@@ -1,3 +1,8 @@
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 #include "USB.h"
 #include "USBHIDVendor.h"
 USBHIDVendor Vendor;
@@ -50,3 +55,4 @@ void loop() {
     Serial.write(Vendor.read());
   }
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/Keyboard/KeyboardLogout/KeyboardLogout.ino b/libraries/USB/examples/Keyboard/KeyboardLogout/KeyboardLogout.ino
@@ -24,6 +24,11 @@
 
   http://www.arduino.cc/en/Tutorial/KeyboardLogout
 */
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 
 #define OSX 0
 #define WINDOWS 1
@@ -90,3 +95,4 @@ void loop() {
   // do nothing:
   while (true) delay(1000);
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/Keyboard/KeyboardMessage/KeyboardMessage.ino b/libraries/USB/examples/Keyboard/KeyboardMessage/KeyboardMessage.ino
@@ -19,6 +19,11 @@
 
   http://www.arduino.cc/en/Tutorial/KeyboardMessage
 */
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 
 #include "USB.h"
 #include "USBHIDKeyboard.h"
@@ -53,3 +58,4 @@ void loop() {
   // save the current button state for comparison next time:
   previousButtonState = buttonState;
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/Keyboard/KeyboardReprogram/KeyboardReprogram.ino b/libraries/USB/examples/Keyboard/KeyboardReprogram/KeyboardReprogram.ino
@@ -24,6 +24,11 @@
 
   http://www.arduino.cc/en/Tutorial/KeyboardReprogram
 */
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 
 #include "USB.h"
 #include "USBHIDKeyboard.h"
@@ -104,3 +109,4 @@ void loop() {
   // wait for the sweet oblivion of reprogramming:
   while (true)delay(1000);
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/Keyboard/KeyboardSerial/KeyboardSerial.ino b/libraries/USB/examples/Keyboard/KeyboardSerial/KeyboardSerial.ino
@@ -16,6 +16,11 @@
 
   http://www.arduino.cc/en/Tutorial/KeyboardSerial
 */
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 
 #include "USB.h"
 #include "USBHIDKeyboard.h"
@@ -38,3 +43,4 @@ void loop() {
     Keyboard.write(inChar + 1);
   }
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/KeyboardAndMouseControl/KeyboardAndMouseControl.ino b/libraries/USB/examples/KeyboardAndMouseControl/KeyboardAndMouseControl.ino
@@ -18,6 +18,11 @@
 
   http://www.arduino.cc/en/Tutorial/KeyboardAndMouseControl
 */
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 
 #include "USB.h"
 #include "USBHIDMouse.h"
@@ -93,3 +98,4 @@ void loop() {
   }
   delay(5);
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/Mouse/ButtonMouseControl/ButtonMouseControl.ino b/libraries/USB/examples/Mouse/ButtonMouseControl/ButtonMouseControl.ino
@@ -20,6 +20,11 @@
 
   http://www.arduino.cc/en/Tutorial/ButtonMouseControl
 */
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 
 #include "USB.h"
 #include "USBHIDMouse.h"
@@ -84,3 +89,4 @@ void loop() {
   // a delay so the mouse doesn't move too fast:
   delay(responseDelay);
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/SystemControl/SystemControl.ino b/libraries/USB/examples/SystemControl/SystemControl.ino
@@ -1,3 +1,8 @@
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 #include "USB.h"
 #include "USBHIDSystemControl.h"
 USBHIDSystemControl SystemControl;
@@ -19,3 +24,4 @@ void loop() {
   }
   previousButtonState = buttonState;
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/USBMSC/USBMSC.ino b/libraries/USB/examples/USBMSC/USBMSC.ino
@@ -1,3 +1,8 @@
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 #include "USB.h"
 #include "USBMSC.h"
 
@@ -190,3 +195,4 @@ void setup() {
 void loop() {
   // put your main code here, to run repeatedly:
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/USBSerial/USBSerial.ino b/libraries/USB/examples/USBSerial/USBSerial.ino
@@ -1,3 +1,8 @@
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 #include "USB.h"
 
 #if ARDUINO_USB_CDC_ON_BOOT
@@ -78,3 +83,4 @@ void loop() {
     USBSerial.write(b, l);
   }
 }
+#endif /* ARDUINO_USB_MODE */
diff --git a/libraries/USB/examples/USBVendor/USBVendor.ino b/libraries/USB/examples/USBVendor/USBVendor.ino
@@ -1,3 +1,8 @@
+#if ARDUINO_USB_MODE
+#warning This sketch should be used when USB is in OTG mode
+void setup(){}
+void loop(){}
+#else
 #include "USB.h"
 #include "USBVendor.h"
 
@@ -189,3 +194,4 @@ void loop() {
     Vendor.write(b, l);
   }
 }
+#endif /* ARDUINO_USB_MODE */

Original file line number	Diff line number	Diff line change
`@@ -381,10 +381,12 @@ void HWCDC::setDebugOutput(bool en)`
`381`	`381`	`}`
`382`	`382`	`}`
`383`	`383`
`384`		`-#if ARDUINO_USB_CDC_ON_BOOT && ARDUINO_USB_MODE //Serial used for USB CDC`
	`384`	`+#if ARDUINO_USB_MODE`
	`385`	`+#if ARDUINO_USB_CDC_ON_BOOT//Serial used for USB CDC`
`385`	`386`	`HWCDC Serial;`
`386`	`387`	`#else`
`387`	`388`	`HWCDC USBSerial;`
`388`	`389`	`#endif`
	`390`	`+#endif`
`389`	`391`
`390`	`392`	`#endif /* CONFIG_TINYUSB_CDC_ENABLED */`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,8 @@`
	`1`	`+#if ARDUINO_USB_MODE`
	`2`	`+#warning This sketch should be used when USB is in OTG mode`
	`3`	`+void setup(){}`
	`4`	`+void loop(){}`
	`5`	`+#else`
`1`	`6`	`#include "USB.h"`
`2`	`7`	`#include "USBHIDMouse.h"`
`3`	`8`	`#include "USBHIDKeyboard.h"`
`@@ -211,3 +216,4 @@ void loop() {`
`211`	`216`	`}`
`212`	`217`	`}`
`213`	`218`	`}`
	`219`	`+#endif /* ARDUINO_USB_MODE */`