.. _variant_sensor_monitoring:

Sensor monitoring
#################

This sample demonstrates how a temperature sensor communicates over the secure Sidewalk network, which is a simple Sidewalk-based IoT use case.
It requires an edge device (a sensor).
You can find an application server (cloud backend with web UI) compatible with this sample in the `Amazon Sidewalk Sample IoT App`_ repository.

Source file setup
*****************

The application consists of the following source files:

* :file:`app.c` (:file:`app.h`) -- The main application file starts the TX and RX thread, assigns button actions to the buttons on the board, and adds received messages to the received message queue.
* :file:`app_sensor.c`, :file:`app_button.c`, :file:`app_led.c` -- The files implement interface between the hardware and sample application.
* :file:`app_rx.c` (:file:`app.h`) -- RX thread reads messages from the received messages queue, deserializes them, and triggers actions.
* :file:`app_tx.c` (:file:`app.h`) -- TX thread sends messages from the device to cloud.
  Depending on the actual state of the device, it sends capability messages or sensor data notifications.

.. figure:: ../../images/TX_thread_state_machine.svg
   :alt: Application TX thread state machine

   Application TX thread state machine.

Configuration options
*********************

Before building the Sensor monitoring application variant of the Sidewalk end device, ensure you have enabled the ``OVERLAY_CONFIG="overlay-demo.conf"`` configuration.

The sample variant supports the following Kconfig options:

.. include:: ../../includes/include_kconfig_common.txt

* ``CONFIG_SID_END_DEVICE_NOTIFY_DATA_PERIOD_MS`` -- Enables the notify period of the sensor monitoring end device app in milliseconds.

You can build the ``sensor_monitoring`` end device application with Bluetooth LE only libraries by running the following command in the project directory:

.. parsed-literal::
   :class: highlight

   $ west build -b *build_target* -- -DCONFIG_SID_END_DEVICE_SENSOR_MONITORING=y -DCONFIG_SIDEWALK_SUBGHZ_SUPPORT=n

For example:

.. code-block:: console

   $ west build -b nrf54lv10dk/nrf54lv10a/cpuapp -- -DCONFIG_SID_END_DEVICE_SENSOR_MONITORING=y -DCONFIG_SIDEWALK_SUBGHZ_SUPPORT=n

User Interface
**************

.. tabs::

   .. group-tab:: nRF54 DKs

      Button 0 (long press):
         Enter DFU state - This action disables the Sidewalk stack and starts the Bluetooth LE SMP Server.
         You can update the firmware image using the nRF Connect for mobile application.
         To exit the DFU state, long press **Button 0**.

      Button 1 (long press):
         Factory reset - The application informs the Sidewalk stack about the factory reset event.
         The Sidewalk library clears its configuration from the non-volatile storage.
         After a successful reset, the device needs to be registered with the cloud services again.

      Button 2 (long press):
         Toggles the Sidewalk link mask - This action switches from Bluetooth LE to FSK, from FSK to LoRa, and from LoRa to Bluetooth LE.
         A log message informs about the link mask switch and the status of the operation.

      Button 0-3 (short press):
         Send button action message - This action works after the application successfully sends capability message.

      LED 0-3:
         Notify LED action message - Works after the application successfully sends capability message.

Building and running
********************

.. include:: ../../includes/include_building_and_running.txt

Testing
=======

.. note::
   For the full installation guidelines and the application overview, refer to the `Amazon Sidewalk Sample IoT App`_ repository.
   Flash the Nordic device with the end device sensor monitoring application instead of the prebuilt HEX file provided in the cloud application repository.

See `Testing and debugging an application`_ for information on testing and debugging in the nRF Connect SDK.

After successfully building the sample and flashing manufacturing data, the sample is ready to use.
To refresh the logs, restart the program by pressing the :guilabel:`RESET` button on your development kit.
You should see the following output:

   .. code-block:: console

      *** Booting Sidewalk v2.7.99-ae200c29600e ***
      *** Using nRF Connect SDK v2.8.99-152acb8205de ***
      *** Using Zephyr OS v3.7.99-08f1c5bc9f20 ***
      ----------------------------------------------------------------
      Sidewalk SDK        = 1.17.1.18
      APP_BUILD_VERSION   = ae200c29600e
      APP_NAME            = sidewalk
      build time          = Oct 30 2024 15:07:09
      board               = nrf54l15dk/nrf54l15/cpuapp
      ----------------------------------------------------------------
      [00:00:01.095,637] <inf> sid_mfg: Need to parse mfg data
      [00:00:01.098,853] <inf> sid_mfg_parser_v8: MFG_ED25519 import success
      [00:00:01.101,607] <inf> sid_mfg_parser_v8: MFG_SECP_256R1 import success
      [00:00:01.109,493] <inf> sid_mfg: Successfully parsed mfg data

.. include:: ../../includes/include_testing_nordic_dfu.txt