diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml new file mode 100644 index 0000000..d110a38 --- /dev/null +++ b/.github/workflows/compile-examples.yml @@ -0,0 +1,65 @@ +name: Compile Examples + +on: + pull_request: + paths: + - ".github/workflows/compile-examples.yml" + - "examples/**" + - "src/**" + push: + paths: + - ".github/workflows/compile-examples.yml" + - "examples/**" + - "src/**" + schedule: + # run every Tuesday at 3 AM UTC to catch breakage caused by changes to external dependencies (libraries, platforms) + - cron: "0 3 * * 2" + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + + env: + SKETCHES_REPORTS_PATH: sketches-reports + + strategy: + fail-fast: false + + matrix: + fqbn: + - arduino:samd:arduino_zero_edbg + - arduino:samd:mkr1000 + - arduino:samd:mkrzero + - arduino:samd:mkrwifi1010 + - arduino:samd:nano_33_iot + - arduino:samd:mkrfox1200 + - arduino:samd:mkrwan1300 + - arduino:samd:mkrwan1310 + - arduino:samd:mkrgsm1400 + - arduino:samd:mkrnb1500 + - arduino:samd:mkrvidor4000 + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Compile examples + uses: arduino/compile-sketches@main + with: + fqbn: ${{ matrix.fqbn }} + libraries: | + # Install the AudioZero library from the local path + - source-path: ./ + - name: SD + sketch-paths: | + - examples + enable-deltas-report: true + sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }} + + - name: Save memory usage change report as artifact + uses: actions/upload-artifact@v2 + with: + name: ${{ env.SKETCHES_REPORTS_PATH }} + path: ${{ env.SKETCHES_REPORTS_PATH }} diff --git a/.github/workflows/report-size-deltas.yml b/.github/workflows/report-size-deltas.yml new file mode 100644 index 0000000..fa5a566 --- /dev/null +++ b/.github/workflows/report-size-deltas.yml @@ -0,0 +1,18 @@ +name: Report Size Deltas + +on: + schedule: + - cron: "*/5 * * * *" + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch + workflow_dispatch: + +jobs: + report: + runs-on: ubuntu-latest + + steps: + - name: Comment size deltas reports to PRs + uses: arduino/report-size-deltas@main + with: + # The name of the workflow artifact created by the "Compile Examples" workflow + sketches-reports-source: sketches-reports diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml new file mode 100644 index 0000000..b670567 --- /dev/null +++ b/.github/workflows/spell-check.yml @@ -0,0 +1,26 @@ +name: Spell Check + +on: + pull_request: + push: + schedule: + # run every Tuesday at 3 AM UTC + - cron: "0 3 * * 2" + +jobs: + spellcheck: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v2 + + # See: https://github.com/codespell-project/actions-codespell/blob/master/README.md + - name: Spell check + uses: codespell-project/actions-codespell@master + with: + check_filenames: true + check_hidden: true + # In the event of a false positive, add the word in all lower case to this file: + ignore_words_file: extras/codespell-ignore-words-list.txt + skip: ./.git diff --git a/README.adoc b/README.adoc index 6d71e6c..3058074 100755 --- a/README.adoc +++ b/README.adoc @@ -1,8 +1,15 @@ -= AudioZero Library for Arduino = +// Define the repository information in these attributes +:repository-owner: arduino-libraries +:repository-name: AudioZero -The AudioZero library enables an Arduino SAMD Board (e.g., https://store.arduino.cc/catalogsearch/result/?q=mkr[MKR boards], https://store.arduino.cc/arduino-nano-33-iot[Nano 33 IoT], https://store.arduino.cc/arduino-zero[Zero]) to play back .wav files from a storage device like an SD card to the `DAC0`/`A0` pin. += {repository-name} library for Arduino = + +image:https://github.com/{repository-owner}/{repository-name}/workflows/Compile%20Examples/badge.svg["Compile Examples Status", link="https://github.com/{repository-owner}/{repository-name}/actions?workflow=Compile+Examples"] +image:https://github.com/{repository-owner}/{repository-name}/workflows/Spell%20Check/badge.svg["Spell Check Status", link="https://github.com/{repository-owner}/{repository-name}/actions?workflow=Spell+Check"] + +The {repository-name} library enables an Arduino SAMD Board (e.g., https://store.arduino.cc/catalogsearch/result/?q=mkr[MKR boards], https://store.arduino.cc/arduino-nano-33-iot[Nano 33 IoT], https://store.arduino.cc/arduino-zero[Zero]) to play back .wav files from a storage device like an SD card to the `DAC0`/`A0` pin. For more information about this library please visit us at -https://www.arduino.cc/en/Reference/AudioZero +https://www.arduino.cc/en/Reference/{repository-name} == License == diff --git a/extras/codespell-ignore-words-list.txt b/extras/codespell-ignore-words-list.txt new file mode 100644 index 0000000..e69de29 diff --git a/keywords.txt b/keywords.txt index 3e37cbd..f1631e0 100755 --- a/keywords.txt +++ b/keywords.txt @@ -1,5 +1,5 @@ ####################################### -# Syntax Coloring Map For Audio +# Syntax Coloring Map For AudioZero ####################################### ####################################### diff --git a/library.properties b/library.properties index df176da..ecdfc46 100755 --- a/library.properties +++ b/library.properties @@ -3,7 +3,7 @@ version=1.1.1 author=Arduino maintainer=Arduino sentence=Allows playing audio files from an SD card. For Arduino Zero, MKRZero and MKR1000 only. -paragraph=With this library you can use the Arduino Zero ort MKR1000 DAC output (A0) to play audio files.
The audio files must be in the raw .wav format. +paragraph=With this library you can use the Arduino Zero or MKR1000 DAC output (A0) to play audio files.
The audio files must be in the raw .wav format. category=Signal Input/Output url=https://www.arduino.cc/en/Reference/Audio architectures=samd