doc: nrf5340audio: add docs for new apps (nrfconnect#37)

Reworked the existing documentation to include the 4 new apps.

Signed-off-by: Grzegorz Ferenc <[email protected]>
Signed-off-by: Alexander Svensen <[email protected]>

applications/nrf5340_audio/broadcast_sink/README.rst

@@ -0,0 +1,98 @@
+.. _nrf53_audio_broadcast_sink_app:
+
+nRF5340 Audio: Broadcast sink
+#############################
+
+.. contents::
+   :local:
+   :depth: 2
+
+The nRF5340 Audio broadcast sink application implements the :ref:`BIS headset mode <nrf53_audio_app_overview>`.
+In this mode, receiving broadcast audio happens using Broadcast Isochronous Stream (BIS) and Broadcast Isochronous Group (BIG).
+
+The following limitations apply to this application:
+
+* One BIG, one of the two BIS streams (selectable).
+* Audio output: I2S/Analog headset output.
+* Configuration: 16 bit, several bit rates ranging from 32 kbps to 124 kbps.
+
+.. _nrf53_audio_broadcast_sink_app_requirements:
+
+Requirements
+************
+
+The application shares the :ref:`requirements common to all nRF5340 Audio application <nrf53_audio_app_requirements>`.
+
+.. _nrf53_audio_broadcast_sink_app_ui:
+
+User interface
+**************
+
+Most of the user interface mappings are common across all nRF5340 Audio applications.
+See the :ref:`nrf53_audio_app_ui` page for detailed overview.
+
+This application uses specific mapping for the following user interface elements:
+
+* Long-pressed on the broadcast sink device during startup:
+
+  * **VOL-** - Changes the headset to the left channel one.
+  * **VOL+** - Changes the headset to the right channel one.
+
+* Pressed on the broadcast sink device during playback:
+
+  * **PLAY/PAUSE** - Starts or pauses listening to the stream.
+  * **VOL-** - Turns the playback volume down.
+  * **VOL+** - Turns the playback volume up.
+  * **BTN 4** - Changes audio stream (different BIS), if more than one is available.
+  * **BTN 5** - Changes the gateway, if more than one is available.
+
+* **LED1**:
+
+  * Solid blue - Devices have synchronized with a broadcasted stream.
+  * Blinking blue - Devices have started streaming audio (BIS mode).
+
+* **RGB**:
+
+  * Solid blue - The device is programmed as the left headset.
+  * Solid magenta - The device is programmed as the right headset.
+
+.. _nrf53_audio_broadcast_sink_app_configuration:
+
+Configuration
+*************
+
+See :ref:`nrf53_audio_app_configuration` and :ref:`nrf53_audio_app_fota` for configuration options common to all nRF5340 Audio applications.
+
+For information about how to configure applications in the |NCS|, see :ref:`modifying`.
+
+.. _nrf53_audio_broadcast_sink_app_building:
+
+Building and running
+********************
+
+This application can be found under :file:`applications/nrf5340_audio/broadcast_sink` in the nRF Connect SDK folder structure.
+
+The nRF5340 Audio DK comes preprogrammed with basic firmware that indicates if the kit is functional.
+See :ref:`nrf53_audio_app_dk_testing_out_of_the_box` for more information.
+
+To build the application, see :ref:`nrf53_audio_app_building`.
+
+.. _nrf53_audio_broadcast_sink_app_testing:
+
+Testing
+*******
+
+.. note::
+    |nrf5340_audio_external_devices_note|
+
+To test the broadcast sink application, complete the following steps:
+
+1. Make sure you have another nRF5340 Audio DK for testing purposes.
+#. Program the other DK with the :ref:`broadcast source <nrf53_audio_broadcast_source_app>` application.
+   The broadcast sink device automatically synchronizes with the broadcast source after programming.
+#. Proceed to testing the devices using the :ref:`nrf53_audio_broadcast_sink_app_ui` buttons and LEDs.
+
+Dependencies
+************
+
+For the list of dependencies, check the application's source files under :file:`applications/nrf5340_audio/broadcast_sink`.

applications/nrf5340_audio/broadcast_source/README.rst

@@ -0,0 +1,88 @@
+.. _nrf53_audio_broadcast_source_app:
+
+nRF5340 Audio: Broadcast source
+###############################
+
+.. contents::
+   :local:
+   :depth: 2
+
+The nRF5340 Audio broadcast source application implements the :ref:`BIS gateway mode <nrf53_audio_app_overview>`.
+
+In this mode, transmitting broadcast audio happens using Broadcast Isochronous Stream (BIS) and Broadcast Isochronous Group (BIG).
+Play and pause are emulated by enabling and disabling stream, respectively.
+
+The following limitations apply to this application:
+
+* One BIG with two BIS streams.
+* Audio input: USB or I2S (Line in or using Pulse Density Modulation).
+* Configuration: 16 bit, several bit rates ranging from 32 kbps to 124 kbps.
+
+.. _nrf53_audio_broadcast_source_app_requirements:
+
+Requirements
+************
+
+The application shares the :ref:`requirements common to all nRF5340 Audio application <nrf53_audio_app_requirements>`.
+
+.. _nrf53_audio_broadcast_source_app_ui:
+
+User interface
+**************
+
+Most of the user interface mappings are common across all nRF5340 Audio applications.
+See the :ref:`nrf53_audio_app_ui` page for detailed overview.
+
+This application uses specific mapping for the following user interface elements:
+
+* Pressed on the broadcast source device during playback:
+
+  * **PLAY/PAUSE** - Starts or pauses the playback of the stream.
+  * **BTN 4** -  Toggles between the normal audio stream and different test tones generated on the device.
+    Use this tone to check the synchronization of headsets.
+
+* **LED1** - Blinking blue - Device has started broadcasting audio.
+* **RGB** - Solid green - The device is programmed as the gateway.
+
+.. _nrf53_audio_broadcast_source_app_configuration:
+
+Configuration
+*************
+
+See :ref:`nrf53_audio_app_configuration` and :ref:`nrf53_audio_app_fota` for configuration options common to all nRF5340 Audio applications.
+
+For information about how to configure applications in the |NCS|, see :ref:`modifying`.
+
+.. _nrf53_audio_broadcast_source_app_building:
+
+Building and running
+********************
+
+This application can be found under :file:`applications/nrf5340_audio/broadcast_source` in the nRF Connect SDK folder structure.
+
+The nRF5340 Audio DK comes preprogrammed with basic firmware that indicates if the kit is functional.
+See :ref:`nrf53_audio_app_dk_testing_out_of_the_box` for more information.
+
+To build the application, see :ref:`nrf53_audio_app_building`.
+
+After programming, the broadcast source automatically starts broadcasting the default 48-kHz audio stream.
+
+.. _nrf53_audio_broadcast_source_app_testing:
+
+Testing
+*******
+
+.. note::
+    |nrf5340_audio_external_devices_note|
+
+To test the broadcast source application, complete the following steps:
+
+1. Make sure you have another nRF5340 Audio DK for testing purposes.
+#. Program the other DK with the :ref:`broadcast sink <nrf53_audio_broadcast_sink_app>` application.
+   The broadcast sink device automatically synchronizes with the broadcast source after programming.
+#. Proceed to testing the broadcast source using the :ref:`nrf53_audio_broadcast_source_app_ui` buttons and LEDs.
+
+Dependencies
+************
+
+For the list of dependencies, check the application's source files.

applications/nrf5340_audio/doc/adapting_application.rst

@@ -1,18 +1,18 @@
 .. _nrf53_audio_app_adapting:
 
-Adapting nRF5340 Audio application for end products
-###################################################
+Adapting nRF5340 Audio applications for end products
+####################################################
 
 .. contents::
    :local:
    :depth: 2
 
-This page describes the relevant configuration sources and lists the steps required for adapting the :ref:`nrf53_audio_app` application to end products.
+This page describes the relevant configuration sources and lists the steps required for adapting the :ref:`nrf53_audio_app` to end products.
 
 Board configuration sources
 ***************************
 
-The nRF5340 Audio application uses the following files as board configuration sources:
+The nRF5340 Audio applications use the following files as board configuration sources:
 
 * Devicetree Specification (DTS) files - These reflect the hardware configuration.
   See :ref:`zephyr:dt-guide` for more information about the DTS data structure.
@@ -30,15 +30,15 @@ For detailed instructions for adding Zephyr support to a custom board, see Zephy
 Application configuration sources
 *********************************
 
-The application configuration source file defines a set of options used by the nRF5340 Audio application.
+The application configuration source file defines a set of options used by the given nRF5340 Audio application.
 This is a :file:`.conf` file that modifies the default Kconfig values defined in the Kconfig files.
 
 Only one :file:`.conf` file is included at a time.
 The :file:`prj.conf` file is the default configuration file and it implements the debug application version.
 For the release application version, you need to include the :file:`prj_release.conf` configuration file.
 In the release application version no debug features should be enabled.
 
-The nRF5340 Audio application also use several :file:`Kconfig.defaults` files to change configuration defaults automatically, based on the different application versions and device types.
+Each nRF5340 Audio application also uses its own :file:`Kconfig.default` file to change configuration defaults automatically.
 
 You need to edit :file:`prj.conf` and :file:`prj_release.conf` if you want to add new functionalities to your application, but editing these files when adding a new board is not required.