STM32F469 lib and demo

demo/mcu/README.md

@@ -2,7 +2,8 @@
 
 This package provides demo projects for the following development boards:
 - [STM32H747I-DISCO](/demo/mcu/stm32h747)
+- [STM32F469I-DISCO](/demo/mcu/stm32f469)
 
 ## Usage
 
-For these demos, the default wake word is `Porcupine`.
+For these demos, the default wake word is `Porcupine`.

demo/mcu/generate_pv_params_file.py

@@ -32,23 +32,23 @@
 """
 
 
-def generate_pv_params(ppn_files, header_file_paths):
+def generate_pv_params(ppn_files, header_file_folders):
 
     script_dir = os.path.dirname(os.path.abspath(__file__))
     repo_dir = os.path.join(script_dir, '../..')
     ppn_dir = os.path.join(repo_dir, 'resources/keyword_files/cortexm')
 
-    for header_file_path in header_file_paths:
+    for header_file_path in header_file_folders:
         header_file = os.path.join(header_file_path, 'pv_params.h')
         with open(header_file, 'w') as f_out:
             f_out.write(HEADER)
             for keyword in ppn_files:
                 keyword_file_path = os.path.join(ppn_dir, keyword + '_cortexm.ppn')
                 ppn_c_array = ppn_to_c_array(keyword_file_path)
                 if (keyword == 'porcupine'):
-                    f_out.write('static const uint8_t default_keyword_array[] = {\n')
+                    f_out.write('static const uint8_t DEFAULT_KEYWORD_ARRAY[] = {\n')
                 else:
-                    f_out.write('static const uint8_t %s_keyword_array[] = {\n' % keyword)
+                    f_out.write('static const uint8_t %s_KEYWORD_ARRAY[] = {\n' % keyword.upper())
                 f_out.write('\n'.join(ppn_c_array))
                 f_out.write('};\n\n')
 
@@ -79,6 +79,7 @@ def ppn_to_c_array(ppn_file_path):
 
 if __name__ == '__main__':
     wake_words = ('porcupine', 'picovoice', 'bumblebee', 'alexa',)
-    header_file_paths = ('stm32h747/stm32h747i-disco/CM7/Inc/',)
+    include_folders = ('stm32h747/stm32h747i-disco/CM7/Inc/',
+    			'stm32f469/stm32f469i-disco/Inc/',)
 
-    generate_pv_params(wake_words, header_file_paths)
+    generate_pv_params(wake_words, include_folders)

demo/mcu/stm32f469/README.md

@@ -0,0 +1,48 @@
+
+# Porcupine Wake Word Engine Demo for STM32F469
+
+This package contains a demo project for the STM32F469 Discovery kit using Porcupine wake word engine. 
+
+## Installation
+
+For this demo, you need to: 
+1. Download and install [STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html), which is an all-in-one multi-OS development tool for STM32 microcontrollers.
+1. Download [STM32Cube middleware for audio PDM to PCM conversion](https://www.st.com/en/licensed-software/audiopdm-mw.html) and copy it to the project folder. A more detailed guide can be found in the [readme](./stm32f469i-disco/Middlewares/ST/STM32_Audio/Addons/PDM/readme.txt) file.
+1. Install a serial port monitor on your system to be able to communicate with the board. [Arduino environment's built-in serial monitor](https://www.arduino.cc/en/software) and [Coolterm](https://freeware.the-meiers.org/) are two free options available on all platforms (Windows, Linux, and macOS).
+
+## Usage
+
+In order to compile and run the demo project on a STM32f469 discovery board, perform the following steps:
+
+1. Open STM32CubeIDE
+2. Click `File` > `Open Projects from file system...` to display the `Import Projects` dialog box. Select the [stm32f469i-disco](./stm32f469i-disco) folder from this repository, and then press the `Finish` button.
+3. Copy the `Inc` and `Lib` folders from the downloaded **PCM2PDM** library to [/Middlewares/ST/STM32_Audio/Addons/PDM](./stm32f469i-disco/Middlewares/ST/STM32_Audio/Addons/PDM)
+4. Select the `stm32f469i-disco-demo_CM7` inner project inside the `Project Explorer` window
+5. Click `Project` > `Build All`
+6. Connect the board to the computer and press `Run` > `Run`
+7. There are two build configurations in this project: Single wake word demo, and Multiple wake words demo; choose one of them in the `Qualifier` window and press `ok`
+
+For the single wake word demo, the default wake word is `Porcupine`; and below are the LED colors associated with supported wake words for the multiple wake words demo:
+
+- ![#00ff00](https://via.placeholder.com/15/00ff00/000000?text=+) `Porcupine`
+- ![#ff8000](https://via.placeholder.com/15/ff8000/000000?text=+) `Picovoice`
+- ![#ff0000](https://via.placeholder.com/15/ff0000/000000?text=+) `Bumblebee`
+- ![#0000ff](https://via.placeholder.com/15/0000ff/000000?text=+) `Alexa`
+
+## Create Custom Wake Word
+
+1. Copy the UUID of the board printed at the beginning of the session to the serial port monitor.
+2. Go to [Picovoice Console](https://console.picovoice.ai/) to create a model for [Porcupine wake word engine](https://picovoice.ai/docs/quick-start/console-porcupine/).
+3. Select `Arm Cortex-M` as the platform when training the model.
+4. Select `STM32` as the board type and provide the UUID of the chipset on the board.
+
+The model is now being trained. You will be able to download it within a few hours.
+
+## Import the Custom Wake Word
+
+1. Download your custom voice model(s) from [Picovoice Console](https://console.picovoice.ai/).
+2. Decompress the zip file. The model file is `.ppn` for Porcupine wake word.
+3. Use [binary_to_c_array.py](https://github.com/Picovoice/picovoice/tree/master/resources/scripts/binary_to_c_array.py) to convert your binary models to C array format  utilizing the following command:
+`python3 binary_to_c_array.py input_binary_model output_c_array.txt`
+1. Copy the content of `output_c_array.txt` and update the `default_keyword_array` value in [/stm32f469i-disco/Inc/pv_params.h](./stm32f469i-disco/Inc/pv_params.h)
+