Merge pull request #229 from adafruit/release-1.17.0

Release 1.17.0

Author: hathach

examples/CDC/no_serial/.funhouse.test.skip renamed to .codespell/exclude-file.txt

@@ -0,0 +1,3 @@
+synopsys
+sie
+inout

.codespell/ignore-words.txt

@@ -0,0 +1,10 @@
+# See: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to 'ignore-words.txt' (one word per line).
+# Or copy & paste the whole problematic line to 'exclude-file.txt'
+ignore-words = .codespell/ignore-words.txt
+exclude-file = .codespell/exclude-file.txt
+check-filenames =
+check-hidden =
+count =
+skip = .git

.codespellrc

@@ -2,18 +2,54 @@ name: Build
 
 on: [pull_request, push, repository_dispatch]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
 jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Run codespell
+      uses: codespell-project/actions-codespell@master
+
+    - name: Checkout adafruit/ci-arduino
+      uses: actions/checkout@v3
+      with:
+         repository: adafruit/ci-arduino
+         path: ci
+
+    - name: pre-install
+      run: bash ci/actions_install.sh
+
+    - name: clang
+      run: python3 ci/run-clang-format.py -r src/arduino
+
+    - name: doxygen
+      env:
+        GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
+        PRETTYNAME : "Adafruit TinyUSB Library"
+      run: bash ci/doxy_gen_and_deploy.sh
+
   build:
     runs-on: ubuntu-latest
+    needs: pre-commit
     strategy:
       fail-fast: false
       matrix:
         arduino-platform:
            # ESP32S3
            - 'feather_esp32s3'
            # ESP32S2
-           - 'funhouse'
-           - 'magtag'
+           - 'feather_esp32s2'
            - 'metroesp32s2'
            # nRF52
            - 'cpb'
@@ -48,33 +84,3 @@ jobs:
 
     - name: test platforms
       run: python3 ci/build_platform.py ${{ matrix.arduino-platform }}
-
-  clang_and_doxy:
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-    - name: Setup Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.x'  
-
-    - name: Checkout code
-      uses: actions/checkout@v3
-
-    - name: Checkout adafruit/ci-arduino
-      uses: actions/checkout@v3
-      with:
-         repository: adafruit/ci-arduino
-         path: ci
-
-    - name: pre-install
-      run: bash ci/actions_install.sh
-
-    - name: clang
-      run: python3 ci/run-clang-format.py -r src/arduino
-
-    - name: doxygen
-      env:
-        GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
-        PRETTYNAME : "Adafruit TinyUSB Library"
-      run: bash ci/doxy_gen_and_deploy.sh

.github/workflows/githubci.yml

@@ -19,7 +19,10 @@ Supported device class drivers are:
 
 ### Host Stack
 
-There is a initial (WIP) host support for rp2040 core (require [Pico-PIO-USB](https://github.com/sekigon-gonnoc/Pico-PIO-USB))
+Host support is still work-in-progress but currently available with rp2040 core thanks to Pico-PIO-USB](https://github.com/sekigon-gonnoc/Pico-PIO-USB). Supported class driver are:
+
+- Communication (CDC)
+- MassStorage class
 
 ## Supported Cores
 

README.md

@@ -135,7 +135,7 @@ uint8_t const desc_hid_report[] =
 ## 0.6.0 - 2019.08.05
 
 - Added webUSB support with 2 example: webusb-serial, webusb-rgb
-- Alligned mouse examples, added newer hid in/out example from main repo, added new composite example for ramdisk and hid in/out. PR #19 thanks to @PTS93
+- Aligned mouse examples, added newer hid in/out example from main repo, added new composite example for ramdisk and hid in/out. PR #19 thanks to @PTS93
 
 ## 0.5.0 - 2019.07.17
 

changelog.md

@@ -46,7 +46,7 @@ Adafruit_USBH_MSC_BlockDevice msc_block_dev;
 // file system object from SdFat
 FatVolume fatfs;
 
-// if file system is succesfully mounted on usb block device
+// if file system is successfully mounted on usb block device
 bool is_mounted = false;
 
 //--------------------------------------------------------------------+

examples/CDC/no_serial/.magtag.test.skip renamed to examples/CDC/cdc_multi/.feather_esp32s2.test.skip

@@ -14,7 +14,7 @@
             while True:
                 # Get input from console and encode to UTF8 for array of chars.
                 # hid generic inout is single report therefore by HIDAPI requirement
-                # it must be preceeded with 0x00 as dummy reportID
+                # it must be preceded with 0x00 as dummy reportID
                 str_out = b'\x00'
                 str_out += input("Send text to HID Device : ").encode('utf-8')
                 dev.write(str_out)

examples/DualRole/msc_file_explorer/msc_file_explorer.ino

@@ -197,7 +197,7 @@ void setup()
 }
 
 //--------------------------------------------------------------------+
-// Handle requets
+// Handle requests
 //--------------------------------------------------------------------+
 
 //format bytes

examples/HID/hid_generic_inout/hid_test.py

@@ -1,5 +1,5 @@
 name=Adafruit TinyUSB Library
-version=1.16.0
+version=1.17.0
 author=Adafruit
 maintainer=Adafruit <[email protected]>
 sentence=TinyUSB library for Arduino

examples/MassStorage/msc_esp32_file_browser/msc_esp32_file_browser.ino

@@ -45,7 +45,7 @@ class Adafruit_USBD_CDC : public Stream, public Adafruit_USBD_Interface {
 
   static uint8_t getInstanceCount(void);
 
-  // fron Adafruit_USBD_Interface
+  // from Adafruit_USBD_Interface
   virtual uint16_t getInterfaceDescriptor(uint8_t itfnum, uint8_t *buf,
                                           uint16_t bufsize);
 

examples/CDC/no_serial/.metroesp32s2.test.skip renamed to examples/MassStorage/msc_sd/.feather_esp32s2.test.skip

@@ -162,12 +162,12 @@ size_t Adafruit_USBD_MIDI::write(uint8_t b) {
 int Adafruit_USBD_MIDI::available(void) { return tud_midi_available(); }
 
 int Adafruit_USBD_MIDI::peek(void) {
-  // MIDI Library doen't use peek
+  // MIDI Library does not use peek
   return -1;
 }
 
 void Adafruit_USBD_MIDI::flush(void) {
-  // MIDI Library doen't use flush
+  // MIDI Library does not use flush
 }
 
 bool Adafruit_USBD_MIDI::writePacket(const uint8_t packet[4]) {