Merge pull request #1 from grobx-stm/main

Add support for MP23DB01HP

Author: cparata

.github/workflows/Continuous-integration.yml

@@ -0,0 +1,65 @@
+name: STEVAL-Examples Continuous Integration
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '*'
+      - '**.md'
+      - '**.txt'
+  pull_request:
+    paths-ignore:
+      - '*'
+      - '**.md'
+      - '**.txt'
+jobs:
+  astyle_check:
+    runs-on: ubuntu-latest
+    name: AStyle check
+    steps:
+    # First of all, clone the repo using the checkout action.
+    - name: Checkout
+      uses: actions/checkout@main
+
+    - name: Astyle check
+      id: Astyle
+      uses: stm32duino/actions/astyle-check@main
+
+    # Use the output from the `Astyle` step
+    - name: Astyle Errors
+      if: failure()
+      run: |
+        cat ${{ steps.Astyle.outputs.astyle-result }}
+        exit 1
+  spell-check:
+    runs-on: ubuntu-latest
+    name: Spell check
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Spell check
+        uses: codespell-project/actions-codespell@master
+        with:
+          ignore_words_file: ./extras/codespell-ignore-words-list.txt
+  # lib_build:
+  #   runs-on: ubuntu-latest
+  #   name: Library compilation
+  #   steps:
+
+  #   # First of all, clone the repo using the checkout action.
+  #   - name: Checkout
+  #     uses: actions/checkout@main
+
+  #   - name: Compilation
+  #     id: compile
+  #     uses: stm32duino/actions/compile-examples@main
+  #     with:
+  #       board-pattern: "NUCLEO_L476RG"
+
+  #   # Use the output from the `Compilation` step
+  #   - name: Compilation Errors
+  #     if: failure()
+  #     run: |
+  #       cat ${{ steps.compile.outputs.compile-result }}
+  #       exit 1

README.md

@@ -0,0 +1,86 @@
+# STEVAL Audio
+
+Arduino library to support the [MP23DB01HP](https://www.st.com/en/mems-and-sensors/mp23db01hp.html) digital microphone.
+Currently, this library works only with the STEVAL board.
+It requires a [STM32 Core](https://github.com/stm32duino/Arduino_Core_STM32) equal to or greater than version X.Y.Z.
+
+## API
+
+This library can be used to record PCM audio on STEVAL board.
+
+After including `PCM.h`, initialize the library by calling `PCM.Begin`:
+
+```cpp
+#include <PCM.h>
+
+void setup()
+{
+  // [...]
+  PCM.Begin();
+  // [...]
+}
+```
+
+Register the data processing callback using `PCM.OnReceive`:
+
+```cpp
+void process()
+{
+  Serial.write((const uint8_t *)RecBuff, PCM_REC_BUFF_SIZE * 2U);
+}
+
+void setup()
+{
+  // [...]
+  PCM.OnReceive(process);
+  // [...]
+}
+```
+
+Start recording PCM audio by passing a non-null pointer of a `uint16_t[PCM_REC_BUFF_SIZE]` buffer to `PCM.Record`:
+
+```cpp
+uint16_t RecBuff[PCM_REC_BUFF_SIZE];
+
+void setup()
+{
+  // [...]
+  PCM.Record(RecvBuff);
+  // [...]
+}
+```
+
+You can pause a recording by calling `PCM.Pause`; in order to resume it, just call `PCM.Resume`:
+
+```cpp
+void loop()
+{
+  // [...]
+  if (cmd == '1') PCM.Pause();
+  if (cmd == '2') PCM.Resume();
+  // [...]
+}
+```
+
+In order to deinitialize the library, you can execute `PCM.End` (if recording, you need first to stop it):
+
+```cpp
+void loop()
+{
+  // [...]
+  if (cmd == '3') {
+    if (PCM.GetState() == PCM_AUDIO_IN_STATE_RECORDING) PCM.Stop();
+    PCM.End();
+    while(1);
+  }
+  // [...]
+}
+```
+
+## More Info
+
+Source files can be found at
+https://github.com/stm32duino/STEVAL-Audio
+
+Take a look at STEVAL examples applications at
+https://github.com/stm32duino/STEVAL-Examples

extras/codespell-ignore-words-list.txt

@@ -0,0 +1,37 @@
+#######################################
+# Syntax Coloring Map For STEVAL-Audio
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+PCM	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+Begin	KEYWORD2
+End	KEYWORD2
+SetVolume	KEYWORD2
+GetVolume	KEYWORD2
+GetState	KEYWORD2
+OnReceive	KEYWORD2
+Record	KEYWORD2
+Pause	KEYWORD2
+Resume	KEYWORD2
+Stop	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+
+PCM_OK	LITERAL1
+PCM_ERROR	LITERAL1
+PCM_REC_BUFF_SIZE	LITERAL1
+PCM_AUDIO_IN_STATE_RESET	LITERAL1
+PCM_AUDIO_IN_STATE_STOP	LITERAL1
+PCM_AUDIO_IN_STATE_RECORDING	LITERAL1
+PCM_AUDIO_IN_STATE_PAUSE	LITERAL1
+PCM_AUDIO_IN_STATE_ERROR	LITERAL1

keywords.txt

@@ -0,0 +1,9 @@
+name=STM32duino STEVAL Audio
+version=1.0.0
+author=SRA
+maintainer=stm32duino
+sentence=PCM recording using digital microphone MP23DB01HP on STEVAL.
+paragraph=This library provides Arduino support for the MP23DB01HP digital microphone on STM32 STEVAL board.
+category=Sensors
+url=https://github.com/stm32duino/STEVAL-Audio
+architectures=stm32