README.rst
1.. zephyr:code-sample:: dmic
2 :name: Digital Microphone (DMIC)
3 :relevant-api: audio_dmic_interface
4
5 Perform PDM transfers using different configurations.
6
7Overview
8********
9
10This is a very simple application intended to show how to use the :ref:`Audio DMIC
11API <audio_dmic_api>` and also to be an aid in developing drivers to implement this API.
12It performs two PDM transfers with different configurations (using one channel
13and two channels) but does not in any way process the received audio data.
14
15Requirements
16************
17
18The device to be used by the sample is specified by defining a devicetree node
19label named ``dmic_dev``.
20The sample has been tested on :ref:`nrf52840dk_nrf52840` (nrf52840dk/nrf52840)
21and :ref:`nrf5340dk_nrf5340` (nrf5340dk/nrf5340/cpuapp), and provides overlay
22files for both of these boards.
23
24Building and Running
25********************
26
27The code can be found in :zephyr_file:`samples/drivers/audio/dmic`.
28
29To build and flash the application:
30
31.. zephyr-app-commands::
32 :zephyr-app: samples/drivers/audio/dmic
33 :board: nrf52840dk/nrf52840
34 :goals: build flash
35 :compact:
36
