diff --git a/doc/images/unify_sample_new.png b/doc/images/unify_sample_new.png deleted file mode 100644 index 65a4aa9401..0000000000 Binary files a/doc/images/unify_sample_new.png and /dev/null differ diff --git a/doc/images/unify_sample_new.svg b/doc/images/unify_sample_new.svg new file mode 100644 index 0000000000..45a5085e3b --- /dev/null +++ b/doc/images/unify_sample_new.svg @@ -0,0 +1,4 @@ + + + +
demo app
hello app
sidewalk end device
main
cli
ble only
sidewalk
...
app
echo
app
sensor
buttons
buttons
AWS
demo app
AWS
MQTT
 \ No newline at end of file diff --git a/doc/images/unify_sample_old.png b/doc/images/unify_sample_old.png deleted file mode 100644 index 054301d6ed..0000000000 Binary files a/doc/images/unify_sample_old.png and /dev/null differ diff --git a/doc/images/unify_sample_old.svg b/doc/images/unify_sample_old.svg new file mode 100644 index 0000000000..01c4c621b6 --- /dev/null +++ b/doc/images/unify_sample_old.svg @@ -0,0 +1,4 @@ + + + +
template_ble
main
application_thread
sidewalk_callbacks
board_events
template_subghz
main
application_thread
sidewalk_callbacks
board_events
sid_dut
main
sidewalk_thread
shell
sensor monitor
main
tasks
callbacks
buttons and leds
AWS
demo app
AWS
MQTT
 \ No newline at end of file diff --git a/doc/migration_guide.rst b/doc/migration_guide.rst index 5c8f3245a5..e57a449c02 100644 --- a/doc/migration_guide.rst +++ b/doc/migration_guide.rst @@ -20,14 +20,14 @@ The samples' model was changed to allow users to easily: * Understand how the application works. The old Amazon Sidewalk samples model in the nRF Connect SDK was divided into four different samples: Template sub-GHz, Template Bluetooth® LE, Sensor monitor and Device under test (dut). -The new approach allows to present the same functionalities through one, unified, and configurable :ref:`Sidewalk_Template`. +The new approach allows to present the same functionalities through one, unified, and configurable :ref:`sidewalk_end_device`. .. tabs:: .. tab:: New model for samples Introduces common, configurable code base: - .. figure:: images/unify_sample_new.png + .. figure:: images/unify_sample_new.svg :scale: 100 % :alt: New samples model @@ -35,7 +35,7 @@ The new approach allows to present the same functionalities through one, unified Samples are separate for each configuration: - .. figure:: images/unify_sample_old.png + .. figure:: images/unify_sample_old.svg :scale: 100 % :alt: Old samples model @@ -54,17 +54,64 @@ Building The following table is an example of the new commands used for the `nRF52840 DK`_ with the :file:`{NCS_PATH}/sidewalk/samples` path. -+---------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| Sample | Old commands | New commands | -+===========================+=========================================================+==============================================================================================+ -| Template sub-GHz | ``west build -b nrf52840dk_nrf52840 template_subghz`` | ``west build -b nrf52840dk_nrf52840 template`` | -+---------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| Template Bluetooth LE only| ``west build -b nrf52840dk_nrf52840 template_ble`` | ``west build -b nrf52840dk_nrf52840 template -- -DCONFIG_SIDEWALK_SUBGHZ_SUPPORT=y`` | -+---------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| Sensor monitoring demo | ``west build -b nrf52840dk_nrf52840 sensor_monitoring`` | ``west build -b nrf52840dk_nrf52840 template -- -DCONFIG_TEMPLATE_APP_SENSOR_MONITORING=y`` | -+---------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------------+ -| Device under test (CLI) |``west build -b nrf52840dk_nrf52840 sid_dut`` | ``west build -b nrf52840dk_nrf52840 template -- -DOVERLAY_CONFIG="overlay-dut.conf"`` | -+---------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------------+ ++----------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| Sample | Old commands | New commands | ++============================+=========================================================+==============================================================================================+ +| Template sub-GHz | ``west build -b nrf52840dk_nrf52840 template_subghz`` | ``west build -b nrf52840dk_nrf52840 sid_end_device`` | ++----------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| Template Bluetooth LE only | ``west build -b nrf52840dk_nrf52840 template_ble`` | ``west build -b nrf52840dk_nrf52840 sid_end_device -- -DCONFIG_SIDEWALK_SUBGHZ_SUPPORT=y`` | ++----------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| Sensor monitoring demo | ``west build -b nrf52840dk_nrf52840 sensor_monitoring`` | ``west build -b nrf52840dk_nrf52840 sid_end_device -- -DOVERLAY_CONFIG="overlay-demo.conf"`` | ++----------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------------+ +| Device under test | ``west build -b nrf52840dk_nrf52840 sid_dut`` | ``west build -b nrf52840dk_nrf52840 sid_end_device -- -DOVERLAY_CONFIG="overlay-dut.conf"`` | ++----------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------------+ + +User interface +-------------- + +The user interface was changed to better support boards with a smaller amount of buttons and LEDs. + +The following table shows button action differences between the old template samples and new :ref:`sidewalk_end_device` application in the :ref:`sidewalk_hello` variant: + ++--------------------------------+--------------------------+-------------------------+ +| Button action | Old mapping | New mapping | ++================================+==========================+=========================+ +| Send Hello | ``Button 3 (short)`` | ``Button 1 (short)`` | ++--------------------------------+--------------------------+-------------------------+ +| Enter DFU mode | ``Button4 (long)`` | ``Button 1 (long)`` | ++--------------------------------+--------------------------+-------------------------+ +| Factory Reset | ``Button1 (long)`` | ``Button 2 (long)`` | ++--------------------------------+--------------------------+-------------------------+ +| Board support | ``board_events.c`` | N/A (use CLI command) | ++--------------------------------+--------------------------+-------------------------+ +| Set fake battery level | ``Button 4 (short)`` | N/A (use CLI command) | ++--------------------------------+--------------------------+-------------------------+ +| Get current Device Profiles | ``Button 2 (short)`` | N/A (use CLI command) | ++--------------------------------+--------------------------+-------------------------+ +| Switch between Device Profiles | ``Button 2 (long)`` | N/A (use CLI command) | ++--------------------------------+--------------------------+-------------------------+ +| Switch Link Mask | N/A | ``Buttons 3 (long)`` | ++--------------------------------+--------------------------+-------------------------+ + +The following table shows LED assignment differences between the old template samples and new :ref:`sidewalk_end_device` application in the :ref:`sidewalk_hello` variant: + ++--------------------------------+--------------+--------------+ +| LED status | Old | New | ++================================+==============+==============+ +| Application Link and Connected | ``LED 1``, | ``LED 1`` | +| | ``LED 4`` | | ++--------------------------------+--------------+--------------+ +| Application time sync | ``LED 3`` | ``LED 2`` | ++--------------------------------+--------------+--------------+ +| Application Registered | ``LED 2`` | ``LED 3`` | ++--------------------------------+--------------+--------------+ +| Application woke up | N/A | ``LED 4`` | ++--------------------------------+--------------+--------------+ + +Additionally, the following CLI changes have been made: + +* All Sidewalk Device Under Test application (``sid_dut``) commands are available when the ``CONFIG_SID_END_DEVICE_CLI`` option is enabled. +* The old ``CONFIG_SIDEWALK_CLI`` option was removed. Source files ------------ @@ -73,7 +120,7 @@ The file structure was refactored for the sample unification purposes. The following table shows the relocation of most of the components: +--------------------------------+------------------------------+------------------------+ -| Sample | Old location | New location | +| Component | Old location | New location | +================================+==============================+========================+ | Sidewalk thread implementation | :file:`application_thread.c` | :file:`sidewalk.c` | +--------------------------------+------------------------------+------------------------+ @@ -305,7 +352,7 @@ The following examples show code differences for selected events: Sidewalk and custom Bluetooth Service ------------------------------------- -:ref:`Sidewalk_Template` uses the `Zephyr State Machine Framework`_. +:ref:`sidewalk_end_device` uses the `Zephyr State Machine Framework`_. The :file:`sidewalk.c` file uses the state machine to demonstrate how the application can switch between Sidewalk and the `Zephyr SMP Server sample`_. You can use this as a reference design for switching between Sidewalk mode and another Bluetooth LE service-based application. @@ -321,7 +368,7 @@ To use the deprecated functionalities, you have to enable the relevant Kconfig o * ``DEPRECATED_SIDEWALK_BLE_MAC_ADDR_TYPE`` -- The option switches the Bluetooth LE Mac address type for the Sidewalk application. These configurations are redundant to the nRF Connect SDK Bluetooth configurations. * ``DEPRECATED_DFU_FLAG_SETTINGS_KEY`` -- The option saves the DFU mode after reset. - The new template uses the :ref:`migration_guide_dfu_mode`. + The new sample uses the :ref:`migration_guide_dfu_mode`. * ``CONFIG_SIDEWALK_LINK_MASK`` -- The option chooses sidewalk link mask to start with. New Sidewalk libraries support link switch in runtime. To switch between the full link mask support libraries and Bluetooth LE only libraries, use the ``CONFIG_SIDEWALK_SUBGHZ_SUPPORT`` option. diff --git a/doc/samples/samples_list.rst b/doc/samples/samples_list.rst index 59da9204f2..34c38cdbba 100644 --- a/doc/samples/samples_list.rst +++ b/doc/samples/samples_list.rst @@ -7,14 +7,18 @@ In the Sidewalk repository, all samples are placed in the :file:`samples` direct The following table demonstrates configuration for the supported development kits: -+-----------------------------+-----------------------------+--------------------------------------------------------------------------+-----------------------------------------------+-------------------------------+-----------------------+--------------+-------------+-------------+ -| Development kit | Sample | Additional hardware | Bootloader (in release and debug configs) | Application overlays | Bluetooth® LE support | LoRa support | FSK support | DFU support | -+=============================+=============================+==========================================================================+===============================================+===============================+=======================+==============+=============+=============+ -| * `nRF52840 DK`_ | :ref:`sidewalk_template` | * External flash (included in the DK) | * MCUboot - DFU partition in external flash | * ``overlay-dut.conf`` | Supported | Supported | Supported | Supported | -| * `nRF5340 DK`_ | | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK) | * Application partition size = 956 kB | * ``overlay-demo.conf`` | | | | | -| | | | | * ``overlay-hello.conf`` | | | | | -+-----------------------------+-----------------------------+--------------------------------------------------------------------------+-----------------------------------------------+-------------------------------+-----------------------+--------------+-------------+-------------+ - ++-----------------------------+------------------------------------------+-----------------------------+--------------------------------------------------------------------------+-----------------------------------------------+-------------------------------+ +| Sample variant | Description | Development kit | Additional hardware | Bootloader (in release and debug configs) | Application overlays | ++=============================+==========================================+=============================+==========================================================================+===============================================+===============================+ +| :ref:`sidewalk_hello` | Sample application showing communication | * `nRF52840 DK`_ | * External flash (included in the DK) | * MCUboot - DFU partition in external flash | * ``overlay-hello.conf`` | +| | over Sidewalk network. | * `nRF5340 DK`_ | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK) | * Application partition size = 956 kB | | ++-----------------------------+------------------------------------------+-----------------------------+--------------------------------------------------------------------------+-----------------------------------------------+-------------------------------+ +| :ref:`sidewalk_demo` | Demo application of Sidewalk protocol | * `nRF52840 DK`_ | * External flash (included in the DK) | * MCUboot - DFU partition in external flash | * ``overlay-demo.conf`` | +| | with temperature sensor monitoring. | * `nRF5340 DK`_ | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK) | * Application partition size = 956 kB | | ++-----------------------------+------------------------------------------+-----------------------------+--------------------------------------------------------------------------+-----------------------------------------------+-------------------------------+ +| :ref:`sidewalk_dut` | Device under test generic application | * `nRF52840 DK`_ | * External flash (included in the DK) | * MCUboot - DFU partition in external flash | * ``overlay-dut.conf`` | +| | having activated CLI. | * `nRF5340 DK`_ | * `Semtech SX1262MB2CAS`_ (only for the configurations with LoRa or FSK) | * Application partition size = 956 kB | | ++-----------------------------+------------------------------------------+-----------------------------+--------------------------------------------------------------------------+-----------------------------------------------+-------------------------------+ .. note:: @@ -26,7 +30,7 @@ The following table demonstrates configuration for the supported development kit :glob: :caption: List of samples: - template.rst + sid_end_device.rst .. include:: ../ncs_links.rst diff --git a/doc/samples/template.rst b/doc/samples/sid_end_device.rst similarity index 61% rename from doc/samples/template.rst rename to doc/samples/sid_end_device.rst index 5cac18dc46..60dd08e12b 100644 --- a/doc/samples/template.rst +++ b/doc/samples/sid_end_device.rst @@ -1,9 +1,9 @@ -.. _sidewalk_template: +.. _sidewalk_end_device: -Sidewalk Template -################# +Sidewalk end device +################### -This sample demonstrates a template for the Sidewalk End Node application. +This sample demonstrates how to implement an end device for the Sidewalk End Device application. It supports Bluetooth LE, LoRa, and FSK link modes. External QSPI Flash is used for firmware updates. @@ -38,38 +38,51 @@ Overview ******** You can use this sample as a starting point to implement a Sidewalk device. -The Sidewalk Template demonstrates a simple Sidewalk application that allows you to send and receive messages, as well as update firmware. +The Sidewalk end device demonstrates a simple Sidewalk application that allows you to send and receive messages, as well as update firmware. -.. _sidewalk_template_user_interface: +Sample variants +*************** -User Interface -************** - -Common button actions for all template configurations: - -Button 1 (short press): - Sends a message to the cloud. The type of message depends on sample configuration. +Testing application scenarios are different dependent of the Sidewalk configuration was chosen. -Button 1 (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 1**. +.. toctree:: + :maxdepth: 1 + :glob: -Button 2 (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. + variants/hello.rst + variants/demo.rst + variants/dut.rst -Button 3 (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. +.. _sidewalk_end_device_configuration: Configuration ************* When running the sample, you can use different configuration files depending on the supported features. -.. _sidewalk_template_build_type: +Configuration overlays +====================== + +* ``overlay-hello`` -- Configuration for the Hello Sidewalk variant. + It is also a default configuration. +* ``overlay-demo`` -- Configuration for the Sensor monitoring variant. +* ``overlay-dut`` -- Configuration for the Device under test (DUT) variant. + The overlay enables CLI and disables sample automation. + +You can build the end device application with the Sidewalk DUT configuration overlay by running the following command in the project directory: + +.. parsed-literal:: + :class: highlight + + $ west build -b *build_target* -- -DOVERLAY_CONFIG="overlay-dut.conf" + +For example: + +.. code-block:: console + + $ west build -b nrf52840dk_nrf52840 -- -DOVERLAY_CONFIG="overlay-dut.conf" + + Configuration files =================== @@ -109,7 +122,7 @@ For example: Selecting a build type is optional. However, if the build type is not selected, the ``debug`` build type is used by default. -.. _sidewalk_template_config_options: +.. _sidewalk_end_device_config_options: Configuration options for Sidewalk ================================== @@ -120,50 +133,36 @@ Configuration options for Sidewalk * ``CONFIG_SIDEWALK_DFU`` -- Enables the nRF Connect SDK bootloader and DFU service over Bluetooth LE. -* ``CONFIG_TEMPLATE_APP`` -- Switch between different application types. - - * ``CONFIG_TEMPLATE_APP_HELLO`` -- Enables simple Sidewalk hello world application. This is default option. See :ref:`sidewalk_hello` for more information. - * ``CONFIG_TEMPLATE_APP_SENSOR_MONITORING`` -- Enables Sidewalk Sensor monitoring application. See :ref:`sensor_monitoring` for more information. - -* ``CONFIG_TEMPLATE_APP_CLI`` -- Enables Sidewalk CLI. To see the list of available commands, flash sample and type ``sid help``. - -* ``CONFIG_SIDEWALK_AUTO_START`` -- Enable automatic Sidewalk initialization and start. - -* ``CONFIG_SIDEWALK_AUTO_CONN_REQ`` -- Enable automatic connection request before message send. The Bluetooth LE connection request action is performed automatically if needed. - -You can build the ``sensor_monitoring`` template application, with Bluetooth LE only libraries for ``build_target`` by running the following command in the project directory: - -.. parsed-literal:: - :class: highlight - - $ west build -b *build_target* -- -DCONFIG_TEMPLATE_APP_SENSOR_MONITORING=y -DCONFIG_SIDEWALK_SUBGHZ_SUPPORT=n - -For example: +* ``CONFIG_SID_END_DEVICE`` -- Switches between the application variants. -.. code-block:: console + * ``CONFIG_SID_END_DEVICE_HELLO`` -- Enables the Hello Sidewalk application. + This is the default option. + For more details, see the :ref:`sidewalk_hello` page. + * ``CONFIG_SID_END_DEVICE_SENSOR_MONITORING`` -- Enables the Sidewalk Sensor monitoring application. + For more details, see the :ref:`sidewalk_demo` page. + * ``CONFIG_SID_END_DEVICE_DUT`` -- Enables the Sidewalk device under test application. + For more details, see the :ref:`sidewalk_dut` page. - $ west build -b nrf5340dk_nrf5340_cpuapp -- -DCONFIG_TEMPLATE_APP_SENSOR_MONITORING=y -DCONFIG_SIDEWALK_SUBGHZ_SUPPORT=n +* ``CONFIG_SID_END_DEVICE_CLI`` -- Enables Sidewalk CLI. + To see the list of available commands, flash the sample and type ``sid help``. -Configuration overlays -====================== +* ``CONFIG_SID_END_DEVICE_AUTO_START`` -- Enables an automatic Sidewalk initialization and start. -* ``overlay-dut`` -- Sidewalk Device Under Test configuration. Enables CLI, disables sample automation. -* ``overlay-demo`` -- Sidewalk sensor monitoring configuration. -* ``overlay-hello`` -- Sidewalk hello sample configuration. This is default configuration. +* ``CONFIG_SID_END_DEVICE_AUTO_CONN_REQ`` -- Enables an automatic connection request before sending a message. + If needed, the Bluetooth LE connection request is sent automatically. -You can build the template application with Sidewalk DUT configuration overlay for ``build_target`` by running the following command in the project directory: +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* -- -DOVERLAY_CONFIG="overlay-dut.conf" + $ 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 nrf52840dk_nrf52840 -- -DOVERLAY_CONFIG="overlay-dut.conf" - + $ west build -b nrf5340dk_nrf5340_cpuapp -- -DCONFIG_SID_END_DEVICE_SENSOR_MONITORING=y -DCONFIG_SIDEWALK_SUBGHZ_SUPPORT=n Source file setup ***************** @@ -188,24 +187,6 @@ The application consists of two source files: Sidewalk --> FirmwareUpdate : event_dfu FirmwareUpdate --> Sidewalk : event_dfu -.. _sidewalk_template_building_and_running: - -Building and Running -******************** - -This sample can be found under :file:`samples/template`. - -.. note:: - Before you flash your Sidewalk sample, make sure you have completed the following: - - * You downloaded the Sidewalk repository and updated west according to the :ref:`dk_building_sample_app` section. - * You provisioned your device during the :ref:`setting_up_sidewalk_product`. - - This step needs to be completed only once. - You do not have to repeat it for every sample rebuild. - -To build the sample, follow the steps in the `Building and programming an application`_ documentation. - .. _registering_sidewalk: Registering Sidewalk Endpoint @@ -228,22 +209,6 @@ For the exact instructions on both of these methods, refer to the `Registering a .. _Registering and testing your Sidewalk endpoint: https://docs.sidewalk.amazon/provisioning/iot-sidewalk-register-endpoint.html -.. _sidewalk_template_testing: - -Testing -******* - -Testing application scenarios are different dependent of the Sidewalk configuration was chosen. - -.. toctree:: - :maxdepth: 1 - :glob: - - template_testing/hello_sidewalk.rst - template_testing/sensor_monitoring.rst .. include:: ../ncs_links.rst - -.. _Semtech SX1262MB2CAS: https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262mb2cas - .. _SX1262: https://os.mbed.com/components/SX126xMB2xAS/ diff --git a/doc/samples/template_testing/sensor_monitoring.rst b/doc/samples/template_testing/sensor_monitoring.rst deleted file mode 100644 index 813d732576..0000000000 --- a/doc/samples/template_testing/sensor_monitoring.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. _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 consists of an edge device (a sensor). -An application server (cloud backend with web UI) compatible with this sample is provided in `Amazon Sidewalk Sample IoT App`_ repository. - - -User Interface -************** - -Button 1-4 (short press): - Send button action message. This action works after application successfully sends capability message. - -LED 1-4: - Notify LED action message. This action works after application successfully sends capability message. - -For common sidewalk template user interface description see ::ref:`sidewalk_template_user_interface` - -Configuration -************* - -.. note:: - To build Sidewalk template as sensor monitoring application - the ``CONFIG_TEMPLATE_APP_SENSOR_MONITORING`` must be enabled in sample configuration. - -The Sidewalk sensor monitoring demo application supports the following configurations: - -* ``CONFIG_TEMPLATE_APP_NOTIFY_DATA_PERIOD_MS`` -- Notify period of sensor monitoring template app in milliseconds. - - -Testing -******* - -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 Zephyr OS build v3.2.99-ncs2 *** - ---------------------------------------------------------------- - sidewalk v1.14.3-1-g1232aabb - nrf v2.3.0 - zephyr v3.2.99-ncs2 - ---------------------------------------------------------------- - sidewalk_fork_point = af5d608303eb03465f35e369ef22ad6c02564ac6 - build time = 2023-03-14 15:00:00.000000+00:00 - ---------------------------------------------------------------- - - [00:00:00.006,225] sid_template: Sidewalk example started! - -Wait for the device to complete the automatic registration. - -.. note:: - For the full installation guidelines and the application overview, refer to the `Amazon Sidewalk Sample IoT App`_ repository. - -.. include:: testing_nordic_dfu_include.txt - -.. include:: ../../ncs_links.rst - -.. _SX1262: https://os.mbed.com/components/SX126xMB2xAS/ -.. _Amazon Sidewalk Sample IoT App: https://github.com/aws-samples/aws-iot-core-for-amazon-sidewalk-sample-app diff --git a/doc/samples/variants/demo.rst b/doc/samples/variants/demo.rst new file mode 100644 index 0000000000..00a6195587 --- /dev/null +++ b/doc/samples/variants/demo.rst @@ -0,0 +1,94 @@ +.. _sidewalk_demo: + +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). +An application server (cloud backend with web UI) compatible with this sample is provided in `Amazon Sidewalk Sample IoT App`_ repository. + + +User Interface +************** + +.. include:: include_user_interface_common.txt + +Button 1-4 (short press): + Send button action message - This action works after the application successfully sends capability message. + +LED 1-4: + Notify LED action message - This action works after the application successfully sends capability message. + +Configuration +************* + +.. note:: + To build the Sensor monitoring application variant of the Sidewalk end device, use the ``OVERLAY_CONFIG="overlay-demo.conf"`` configuration. + +The Sidewalk sensor monitoring demo application supports the following configurations: + +* ``CONFIG_SID_END_DEVICE_NOTIFY_DATA_PERIOD_MS`` -- Enables the notify period of the sensor monitoring end device app in milliseconds. + +For more configuration options, see :ref:`sidewalk_end_device_configuration`. + +Source file setup +***************** + +The application consists of two source files: + +* :file:`app.c` (:file:`app.h`) -- The main application file starts the TX and RX thread, assigns button actions to the board's buttons, 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 form 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. + + .. uml:: + :caption: Application TX thread state machine + + [*] -> Init + Init --> Notify_Capacity : time_syc_success + Notify_Capacity --> Notify_Data : capacity_success + Notify_Data --> Notify_Capacity : time_syc_fail + Notify_Data --> Notify_Data : action_response + Notify_Data --> Notify_Data : action_notify + +Building and running +******************** + +.. include:: 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 nRF Connect SDK 883c3709f9c8 *** + ---------------------------------------------------------------- + sidewalk v2.5.0-3-g1232aabb + nrf v2.5.0-g271e80422 + zephyr 883c3709f9 + ---------------------------------------------------------------- + sidewalk_fork_point = af5d608303eb03465f35e369ef22ad6c02564ac6 + build time = 2023-03-14 15:00:00.000000+00:00 + board = nrf52840dk_nrf52840 + ---------------------------------------------------------------- + [00:00:00.001,373] application_state: working = true + [00:00:00.055,480] sidewalk_app: Sidewalk link switch to BLE + +Wait for the device to complete the automatic registration. + +.. include:: include_testing_nordic_dfu.txt + +.. include:: ../../ncs_links.rst +.. _SX1262: https://os.mbed.com/components/SX126xMB2xAS/ +.. _Amazon Sidewalk Sample IoT App: https://github.com/aws-samples/aws-iot-core-for-amazon-sidewalk-sample-app diff --git a/doc/samples/variants/dut.rst b/doc/samples/variants/dut.rst new file mode 100644 index 0000000000..6679ac29e1 --- /dev/null +++ b/doc/samples/variants/dut.rst @@ -0,0 +1,33 @@ +.. _sidewalk_dut: + +Device Under Test +################# + +This sample demonstrates how to use Sidewalk Device Under Test for the testing and evaluation purposes. + +Configuration +************* + +.. note:: + To build the Device under test application variant of the Sidewalk end device, use the ``OVERLAY_CONFIG="overlay-dut.conf"`` configuration. + +For more configuration option see :ref:`sidewalk_end_device_configuration`. + +Building and running +******************** + +.. include:: include_building_and_running.txt + +Testing +******* + +#. After successfully building and flashing the sample is ready to use. You should see the following command-line prompt: + + .. code-block:: console + + uart$ + +#. To start testing the application, use the Sidewalk CLI (DUT). + Type ``sid help`` and press enter to get the list of supported commands. + +.. include:: ../../ncs_links.rst diff --git a/doc/samples/template_testing/hello_sidewalk.rst b/doc/samples/variants/hello.rst similarity index 87% rename from doc/samples/template_testing/hello_sidewalk.rst rename to doc/samples/variants/hello.rst index 899e781999..9adccef25b 100644 --- a/doc/samples/template_testing/hello_sidewalk.rst +++ b/doc/samples/variants/hello.rst @@ -5,21 +5,14 @@ Hello Sidewalk This sample demonstrates a simple Sidewalk End Node application. It can send Hello message to Sidewalk cloud on button press, as well as represent the Sidewalk status by LED state. -It supports Bluetooth LE, LoRa, and FSK link modes. -External QSPI Flash is used for firmware updates. - -Overview -******** - -The Sidewalk status is indicated by LEDs state and is also printed in the device logs. -It supports actions, such as sending messages, performing factory reset, and entering the DFU state. - .. _sidewalk_hello_user_interface: User Interface ************** +.. include:: include_user_interface_common.txt + Button 1 (short press): Send Hello - This action queues a message to the cloud. If Sidewalk is not ready, it displays an error without sending the message. @@ -46,19 +39,22 @@ LED 3: LED 4: Application woke up successfully. -For common sidewalk template user interface description see ::ref:`sidewalk_template_user_interface` - Configuration ************* The hello Sidewalk application supports the following configurations: -* ``CONFIG_TEMPLATE_APP_ECHO_MSGS`` -- The sample echoes received Sidewalk messages of type GET and SET to the Sidewalk cloud. +* ``CONFIG_SID_END_DEVICE_ECHO_MSGS`` -- The sample echoes the received Sidewalk messages (``GET`` and ``SET`` type) to the Sidewalk cloud. + +For more configuration options, see :ref:`sidewalk_end_device_configuration`. -.. _sidewalk_template_source_files: +Building and running +******************** + +.. include:: include_building_and_running.txt Testing -======= +******* See `Testing and debugging an application`_ for information on testing and debugging in the nRF Connect SDK. @@ -148,7 +144,7 @@ Follow the outlined steps: .. code-block:: console # Logs from DK after pressing "Button 1" - [00:04:57.461,029] sid_template: Pressed button 1 + [00:04:57.461,029] sid_end device: Pressed button 1 [00:04:57.461,120] sid_thread: sending counter update: 0 [00:04:57.461,456] sid_thread: queued data message id:3 @@ -246,8 +242,14 @@ Receiving message from AWS MQTT 21 |! -.. include:: testing_nordic_dfu_include.txt - -.. include:: ../ncs_links.rst +.. include:: include_testing_nordic_dfu.txt +.. include:: ../../ncs_links.rst .. _SX1262: https://os.mbed.com/components/SX126xMB2xAS/ +.. _AWS IoT MQTT client: https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html +.. _Installing or updating the latest version of the AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html +.. _ID users change permissions: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html +.. _Sidewalk Protocol Specification: https://docs.sidewalk.amazon/specifications/ +.. _Sidewalk_Handler CloudWatch log group: https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logsV2:log-groups/log-group/$252Faws$252Flambda$252FSidewalk_Handler +.. _AWS IoT MQTT client: https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html +.. _CloudShell: https://console.aws.amazon.com/cloudshell diff --git a/doc/samples/variants/include_building_and_running.txt b/doc/samples/variants/include_building_and_running.txt new file mode 100644 index 0000000000..3d40092c63 --- /dev/null +++ b/doc/samples/variants/include_building_and_running.txt @@ -0,0 +1,12 @@ +This sample can be found under :file:`samples/sid_end_device`. + +.. note:: + Before you flash your Sidewalk sample, make sure you have completed the following: + + * You downloaded the Sidewalk repository and updated west according to the :ref:`dk_building_sample_app` section. + * You provisioned your device during the :ref:`setting_up_sidewalk_product`. + + This step needs to be completed only once. + You do not have to repeat it for every sample rebuild. + +To build the sample, follow the steps in the `Building and programming an application`_ documentation. diff --git a/doc/samples/template_testing/testing_nordic_dfu_include.txt b/doc/samples/variants/include_testing_nordic_dfu.txt similarity index 61% rename from doc/samples/template_testing/testing_nordic_dfu_include.txt rename to doc/samples/variants/include_testing_nordic_dfu.txt index f437db0e4d..0342c0dca6 100644 --- a/doc/samples/template_testing/testing_nordic_dfu_include.txt +++ b/doc/samples/variants/include_testing_nordic_dfu.txt @@ -18,11 +18,4 @@ Testing Device Firmware Update (DFU) .. include:: ../../ncs_links.rst -.. _AWS IoT MQTT client: https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html -.. _Installing or updating the latest version of the AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html -.. _ID users change permissions: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html .. _DevZone DFU guide: https://devzone.nordicsemi.com/guides/nrf-connect-sdk-guides/b/software/posts/ncs-dfu#ble_testing -.. _Sidewalk Protocol Specification: https://docs.sidewalk.amazon/specifications/ -.. _Sidewalk_Handler CloudWatch log group: https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logsV2:log-groups/log-group/$252Faws$252Flambda$252FSidewalk_Handler -.. _AWS IoT MQTT client: https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html -.. _CloudShell: https://console.aws.amazon.com/cloudshell diff --git a/doc/samples/variants/include_user_interface_common.txt b/doc/samples/variants/include_user_interface_common.txt new file mode 100644 index 0000000000..84d6910cd2 --- /dev/null +++ b/doc/samples/variants/include_user_interface_common.txt @@ -0,0 +1,13 @@ +Button 1 (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 1**. + +Button 2 (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 3 (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. diff --git a/doc/setting_up_sidewalk_environment/requirements.rst b/doc/setting_up_sidewalk_environment/requirements.rst index b7705de0e9..0cb6469582 100644 --- a/doc/setting_up_sidewalk_environment/requirements.rst +++ b/doc/setting_up_sidewalk_environment/requirements.rst @@ -49,49 +49,41 @@ All values are provided in kilobytes (KB). .. tabs:: - .. tab:: nRF52840 DK + .. tab:: `nRF52840 DK`_ The following table lists memory requirements for samples running on the `nRF52840 DK`_. - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | Sample | MCUboot ROM | Application ROM | Sidewalk Settings | Total ROM | Total RAM | - +=====================================================================+===============+===================+=====================+=============+=============+ - | :ref:`Sensor monitoring ` (Bluetooth LE Debug) | 0 | 364 | 32 | 396 | 78 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sensor monitoring ` (FSK Debug) | 0 | 517 | 32 | 549 | 98 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sensor monitoring ` (LoRa Debug) | 0 | 464 | 32 | 496 | 97 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sidewalk template ` (Debug) | 36 | 478 | 28 | 542 | 109 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sidewalk template ` (Bluetooth LE Debug) | 36 | 378 | 28 | 442 | 91 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sidewalk template ` (Bluetooth LE Release) | 36 | 313 | 28 | 377 | 86 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sidewalk template ` (Release) | 36 | 407 | 28 | 471 | 104 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - - .. tab:: nRF5340 DK + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + | Sample | MCUboot ROM | Application ROM | Sidewalk Settings | Total ROM | Total RAM | + +=======================================================================+===============+===================+=====================+=============+=============+ + | :ref:`Sensor monitoring ` (Debug) | 36 | 494 | 28 | 558 | 119 | + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + | :ref:`End device Bluetooth LE and sub-GHz ` (Debug) | 36 | 494 | 28 | 558 | 109 | + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + | :ref:`End device Bluetooth LE ` (Debug) | 36 | 409 | 28 | 473 | 89 | + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + | :ref:`End device Bluetooth LE ` (Release) | 36 | 350 | 28 | 414 | 84 | + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + | :ref:`End device Bluetooth LE and sub-GHz ` (Release) | 36 | 431 | 28 | 495 | 104 | + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + + .. tab:: `nRF5340 DK`_ The following table lists memory requirements for samples running on the `nRF5340 DK`_. - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | Sample | MCUboot ROM | Application ROM | Sidewalk Settings | Total ROM | Total RAM | - +=====================================================================+===============+===================+=====================+=============+=============+ - | :ref:`Sensor monitoring ` (Bluetooth LE Debug) | 0 | 309 | 32 | 341 | 67 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sensor monitoring ` (FSK Debug) | 0 | 449 | 32 | 481 | 87 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sensor monitoring ` (LoRa Debug) | 0 | 405 | 32 | 437 | 86 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sidewalk template ` (Debug) | 40 | 419 | 28 | 487 | 98 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sidewalk template ` (Bluetooth LE Debug) | 40 | 324 | 28 | 392 | 81 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sidewalk template ` (Bluetooth LE Release) | 40 | 255 | 28 | 323 | 76 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ - | :ref:`Sidewalk template ` (Release) | 40 | 346 | 28 | 414 | 93 | - +---------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + | Sample | MCUboot ROM | Application ROM | Sidewalk Settings | Total ROM | Total RAM | + +=======================================================================+===============+===================+=====================+=============+=============+ + | :ref:`Sensor monitoring ` (Debug) | 40 | 430 | 28 | 498 | 109 | + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + | :ref:`End device Bluetooth LE and sub-GHz ` (Debug) | 40 | 429 | 28 | 497 | 99 | + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + | :ref:`End device Bluetooth LE ` (Debug) | 40 | 348 | 28 | 416 | 80 | + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + | :ref:`End device Bluetooth LE ` (Release) | 40 | 286 | 28 | 354 | 75 | + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ + | :ref:`End device Bluetooth LE and sub-GHz ` (Release) | 40 | 364 | 28 | 432 | 94 | + +-----------------------------------------------------------------------+---------------+-------------------+---------------------+-------------+-------------+ .. include:: ../ncs_links.rst diff --git a/samples/sid_end_device/CMakeLists.txt b/samples/sid_end_device/CMakeLists.txt index f3aab54821..a0e718199a 100644 --- a/samples/sid_end_device/CMakeLists.txt +++ b/samples/sid_end_device/CMakeLists.txt @@ -26,7 +26,7 @@ endif() # Zephyr CMake project find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE}) -project(sidewalk_template) +project(sidewalk_sid_end_device) # Source files target_include_directories(app PRIVATE include) @@ -35,7 +35,7 @@ target_sources(app PRIVATE src/sidewalk.c ) -if(CONFIG_TEMPLATE_APP_SENSOR_MONITORING) +if(CONFIG_SID_END_DEVICE_SENSOR_MONITORING) target_sources(app PRIVATE src/sensor_monitoring/app_buttons.c src/sensor_monitoring/app_leds.c @@ -44,7 +44,7 @@ if(CONFIG_TEMPLATE_APP_SENSOR_MONITORING) src/sensor_monitoring/app_rx.c src/sensor_monitoring/app.c ) -elseif(CONFIG_TEMPLATE_APP_DUT) +elseif(CONFIG_SID_END_DEVICE_DUT) target_sources(app PRIVATE src/cli/app.c ) @@ -54,7 +54,7 @@ else() ) endif() -if(CONFIG_TEMPLATE_APP_CLI) +if(CONFIG_SID_END_DEVICE_CLI) target_sources(app PRIVATE src/cli/app_dut.c src/cli/app_shell.c diff --git a/samples/sid_end_device/Kconfig b/samples/sid_end_device/Kconfig index f36542fb2d..4f14a7f8a0 100644 --- a/samples/sid_end_device/Kconfig +++ b/samples/sid_end_device/Kconfig @@ -4,55 +4,55 @@ # SPDX-License-Identifier: LicenseRef-Nordic-5-Clause # -mainmenu "Sidewalk nRF Connect Application" +mainmenu "Sidewalk End Device nRF Connect Application" -choice TEMPLATE_APP - prompt "Select template application to run" - default TEMPLATE_APP_HELLO -config TEMPLATE_APP_HELLO +choice SID_END_DEVICE + prompt "Select application variant to run" + default SID_END_DEVICE_HELLO +config SID_END_DEVICE_HELLO bool "Sidewalk hello world application" -config TEMPLATE_APP_SENSOR_MONITORING +config SID_END_DEVICE_SENSOR_MONITORING bool "Demo sensor monitoring application" imply SIDEWALK_DEMO_PARSER imply SENSOR imply TEMP_NRF5 -config TEMPLATE_APP_DUT +config SID_END_DEVICE_DUT bool "Device under test application" -endchoice #TEMPLATE_APP +endchoice #SID_END_DEVICE -if TEMPLATE_APP_HELLO +if SID_END_DEVICE_HELLO -config TEMPLATE_APP_ECHO_MSGS +config SID_END_DEVICE_ECHO_MSGS bool "Eable message echo feature" default y help Echo received messages back to Sidewlak cloud. Works with GET and SET messages types. -endif #TEMPLATE_APP_HELLO +endif #SID_END_DEVICE_HELLO -if TEMPLATE_APP_SENSOR_MONITORING +if SID_END_DEVICE_SENSOR_MONITORING rsource "Kconfig.sensor_monitoring" -endif #TEMPLATE_APP_SENSOR_MONITORING +endif #SID_END_DEVICE_SENSOR_MONITORING -config TEMPLATE_APP_CLI +config SID_END_DEVICE_CLI bool "Enable Sidewalk CLI (DUT)" imply SHELL help Enables Sidewalk command line interface. The interface commands are compatilbe with former dut sample. -config SIDEWALK_AUTO_START +config SID_END_DEVICE_AUTO_START default y bool "Enable automatic Sidewalk initlization and start" -config SIDEWALK_AUTO_CONN_REQ +config SID_END_DEVICE_AUTO_CONN_REQ default y bool "Enable automatic connection request before message send" -config SIDEWALK_PERSISTENT_LINK_MASK +config SID_END_DEVICE_PERSISTENT_LINK_MASK select EXPERIMENTAL bool "Enable persitent link mask" help @@ -60,7 +60,7 @@ config SIDEWALK_PERSISTENT_LINK_MASK but defaults after a factory reset. This could affect the flash lifespan. -config TEMPLATE_APP_EVENT_HEAP_SIZE +config SID_END_DEVICE_EVENT_HEAP_SIZE int "Heap for Sidewalk event contexts" default 2048 diff --git a/samples/sid_end_device/Kconfig.defconfig b/samples/sid_end_device/Kconfig.defconfig index ca586ccd81..56afef8627 100644 --- a/samples/sid_end_device/Kconfig.defconfig +++ b/samples/sid_end_device/Kconfig.defconfig @@ -57,7 +57,7 @@ config LOG_PROCESS_THREAD_STARTUP_DELAY_MS default 50 if SHELL config SHELL_STACK_SIZE - default 8192 if TEMPLATE_APP_CLI + default 8192 if SID_END_DEVICE_CLI config HEAP_MEM_POOL_SIZE default 8192 if SIDEWALK_ON_DEV_CERT @@ -67,7 +67,7 @@ config SPI_NRFX_RAM_BUFFER_SIZE default 0 # CLI -if TEMPLATE_APP_CLI +if SID_END_DEVICE_CLI config SHELL_CMD_BUFF_SIZE default 1024 @@ -78,7 +78,7 @@ config SHELL_BACKEND_SERIAL_TX_RING_BUFFER_SIZE config SHELL_BACKEND_SERIAL_RX_RING_BUFFER_SIZE default 1024 -endif # TEMPLATE_APP_CLI +endif # SID_END_DEVICE_CLI # Others config SPIN_VALIDATE diff --git a/samples/sid_end_device/Kconfig.sensor_monitoring b/samples/sid_end_device/Kconfig.sensor_monitoring index 67d40ca1ba..9bc079a68d 100644 --- a/samples/sid_end_device/Kconfig.sensor_monitoring +++ b/samples/sid_end_device/Kconfig.sensor_monitoring @@ -4,33 +4,33 @@ # SPDX-License-Identifier: LicenseRef-Nordic-5-Clause # -config TEMPLATE_APP_NOTIFY_DATA_PERIOD_MS - int "Notify period of sensor monitoring template app" +config SID_END_DEVICE_NOTIFY_DATA_PERIOD_MS + int "Notify period of sensor monitoring demo app" default 10000 config SIDEWALK_THREAD_PRIORITY default 12 -config TEMPLATE_APP_TX_THREAD_PRIORITY +config SID_END_DEVICE_TX_THREAD_PRIORITY int default 13 -config TEMPLATE_APP_RX_THREAD_PRIORITY +config SID_END_DEVICE_RX_THREAD_PRIORITY int default 14 -config TEMPLATE_APP_TX_THREAD_STACK_SIZE +config SID_END_DEVICE_TX_THREAD_STACK_SIZE int default 4096 -config TEMPLATE_APP_RX_THREAD_STACK_SIZE +config SID_END_DEVICE_RX_THREAD_STACK_SIZE int default 4096 -config TEMPLATE_APP_TX_THREAD_QUEUE_SIZE +config SID_END_DEVICE_TX_THREAD_QUEUE_SIZE int default 10 -config TEMPLATE_APP_RX_THREAD_QUEUE_SIZE +config SID_END_DEVICE_RX_THREAD_QUEUE_SIZE int default 4 diff --git a/samples/sid_end_device/include/app.h b/samples/sid_end_device/include/app.h index 4f26832f1b..077f3caf5e 100644 --- a/samples/sid_end_device/include/app.h +++ b/samples/sid_end_device/include/app.h @@ -5,7 +5,7 @@ */ /** - * @brief Start template application + * @brief Start Sidewalk end device application. * * @note This function should never return. */ diff --git a/samples/sid_end_device/overlay-demo.conf b/samples/sid_end_device/overlay-demo.conf index 8ecfb20576..35fd400a51 100644 --- a/samples/sid_end_device/overlay-demo.conf +++ b/samples/sid_end_device/overlay-demo.conf @@ -4,4 +4,4 @@ # SPDX-License-Identifier: LicenseRef-Nordic-5-Clause # -CONFIG_TEMPLATE_APP_SENSOR_MONITORING=y +CONFIG_SID_END_DEVICE_SENSOR_MONITORING=y diff --git a/samples/sid_end_device/overlay-dut.conf b/samples/sid_end_device/overlay-dut.conf index 99cc6de08f..d33149b7c9 100644 --- a/samples/sid_end_device/overlay-dut.conf +++ b/samples/sid_end_device/overlay-dut.conf @@ -3,13 +3,13 @@ # # SPDX-License-Identifier: LicenseRef-Nordic-5-Clause # -CONFIG_TEMPLATE_APP_DUT=y +CONFIG_SID_END_DEVICE_DUT=y -CONFIG_TEMPLATE_APP_CLI=y +CONFIG_SID_END_DEVICE_CLI=y CONFIG_SIDEWALK_ON_DEV_CERT=y CONFIG_SIDEWALK_BLE_ADAPTER_LOG_LEVEL_DBG=y -CONFIG_SIDEWALK_AUTO_START=n -CONFIG_SIDEWALK_AUTO_CONN_REQ=n -CONFIG_TEMPLATE_APP_ECHO_MSGS=n +CONFIG_SID_END_DEVICE_AUTO_START=n +CONFIG_SID_END_DEVICE_AUTO_CONN_REQ=n +CONFIG_SID_END_DEVICE_ECHO_MSGS=n diff --git a/samples/sid_end_device/overlay-hello.conf b/samples/sid_end_device/overlay-hello.conf index 6941882b88..9989cb8a10 100644 --- a/samples/sid_end_device/overlay-hello.conf +++ b/samples/sid_end_device/overlay-hello.conf @@ -4,4 +4,4 @@ # SPDX-License-Identifier: LicenseRef-Nordic-5-Clause # -CONFIG_TEMPLATE_APP_HELLO=y +CONFIG_SID_END_DEVICE_HELLO=y diff --git a/samples/sid_end_device/sample.yaml b/samples/sid_end_device/sample.yaml index a3d3c46949..4fbfc7e5df 100644 --- a/samples/sid_end_device/sample.yaml +++ b/samples/sid_end_device/sample.yaml @@ -5,7 +5,7 @@ tests: sample.sidewalk.hello: build_only: true platform_allow: nrf52840dk_nrf52840 nrf5340dk_nrf5340_cpuapp - extra_args: CONFIG_SIDEWALK_PERSISTENT_LINK_MASK=y + extra_args: CONFIG_SID_END_DEVICE_PERSISTENT_LINK_MASK=y integration_platforms: - nrf52840dk_nrf52840 - nrf5340dk_nrf5340_cpuapp @@ -16,7 +16,7 @@ tests: platform_allow: nrf52840dk_nrf52840 nrf5340dk_nrf5340_cpuapp extra_args: CONF_FILE=prj_release.conf - CONFIG_SIDEWALK_PERSISTENT_LINK_MASK=y + CONFIG_SID_END_DEVICE_PERSISTENT_LINK_MASK=y integration_platforms: - nrf52840dk_nrf52840 - nrf5340dk_nrf5340_cpuapp @@ -27,7 +27,7 @@ tests: platform_allow: nrf52840dk_nrf52840 nrf5340dk_nrf5340_cpuapp extra_args: CONF_FILE=prj_no_dfu.conf - CONFIG_SIDEWALK_PERSISTENT_LINK_MASK=y + CONFIG_SID_END_DEVICE_PERSISTENT_LINK_MASK=y integration_platforms: - nrf52840dk_nrf52840 - nrf5340dk_nrf5340_cpuapp @@ -58,7 +58,7 @@ tests: platform_allow: nrf52840dk_nrf52840 nrf5340dk_nrf5340_cpuapp extra_args: OVERLAY_CONFIG="overlay-demo.conf" - CONFIG_SIDEWALK_PERSISTENT_LINK_MASK=y + CONFIG_SID_END_DEVICE_PERSISTENT_LINK_MASK=y integration_platforms: - nrf52840dk_nrf52840 - nrf5340dk_nrf5340_cpuapp diff --git a/samples/sid_end_device/src/hello/app.c b/samples/sid_end_device/src/hello/app.c index 939597f89f..7145e56dac 100644 --- a/samples/sid_end_device/src/hello/app.c +++ b/samples/sid_end_device/src/hello/app.c @@ -45,7 +45,7 @@ static void on_sidewalk_msg_received(const struct sid_msg_desc *msg_desc, const application_state_receiving(&global_state_notifier, true); application_state_receiving(&global_state_notifier, false); -#ifdef CONFIG_TEMPLATE_APP_ECHO_MSGS +#ifdef CONFIG_SID_END_DEVICE_ECHO_MSGS if (msg_desc->type == SID_MSG_TYPE_GET || msg_desc->type == SID_MSG_TYPE_SET) { LOG_INF("Send echo message"); sidewalk_msg_t *echo = sidewalk_data_alloc(sizeof(sidewalk_msg_t)); @@ -70,7 +70,7 @@ static void on_sidewalk_msg_received(const struct sid_msg_desc *msg_desc, const application_state_sending(&global_state_notifier, true); } }; -#endif /* CONFIG_TEMPLATE_APP_ECHO_MSGS */ +#endif /* CONFIG_SID_END_DEVICE_ECHO_MSGS */ } static void on_sidewalk_msg_sent(const struct sid_msg_desc *msg_desc, void *context) @@ -97,7 +97,7 @@ static void on_sidewalk_send_error(sid_error_t error, const struct sid_msg_desc static void on_sidewalk_factory_reset(void *context) { ARG_UNUSED(context); -#ifndef CONFIG_TEMPLATE_APP_CLI +#ifndef CONFIG_SID_END_DEVICE_CLI LOG_INF("Factory reset notification received from sid api"); if (sid_hal_reset(SID_HAL_RESET_NORMAL)) { LOG_WRN("Cannot reboot"); diff --git a/samples/sid_end_device/src/sensor_monitoring/app.c b/samples/sid_end_device/src/sensor_monitoring/app.c index c182f6e30e..a165aabb0a 100644 --- a/samples/sid_end_device/src/sensor_monitoring/app.c +++ b/samples/sid_end_device/src/sensor_monitoring/app.c @@ -22,8 +22,8 @@ LOG_MODULE_REGISTER(app, CONFIG_SIDEWALK_LOG_LEVEL); #define NOTIFY_TIMER_DURATION_MS (500) -K_THREAD_STACK_DEFINE(app_tx_stack, CONFIG_TEMPLATE_APP_TX_THREAD_STACK_SIZE); -K_THREAD_STACK_DEFINE(app_rx_stack, CONFIG_TEMPLATE_APP_RX_THREAD_STACK_SIZE); +K_THREAD_STACK_DEFINE(app_tx_stack, CONFIG_SID_END_DEVICE_TX_THREAD_STACK_SIZE); +K_THREAD_STACK_DEFINE(app_rx_stack, CONFIG_SID_END_DEVICE_RX_THREAD_STACK_SIZE); static struct k_thread app_main; static struct k_thread app_rx; @@ -169,12 +169,12 @@ static int app_buttons_init(void) void app_start_tasks(void) { (void)k_thread_create(&app_main, app_tx_stack, K_THREAD_STACK_SIZEOF(app_tx_stack), - app_tx_task, NULL, NULL, NULL, CONFIG_TEMPLATE_APP_TX_THREAD_PRIORITY, - 0, K_NO_WAIT); + app_tx_task, NULL, NULL, NULL, + CONFIG_SID_END_DEVICE_TX_THREAD_PRIORITY, 0, K_NO_WAIT); (void)k_thread_create(&app_rx, app_rx_stack, K_THREAD_STACK_SIZEOF(app_rx_stack), - app_rx_task, NULL, NULL, NULL, CONFIG_TEMPLATE_APP_RX_THREAD_PRIORITY, - 0, K_NO_WAIT); + app_rx_task, NULL, NULL, NULL, + CONFIG_SID_END_DEVICE_RX_THREAD_PRIORITY, 0, K_NO_WAIT); k_thread_name_set(&app_main, "app_main"); k_thread_name_set(&app_rx, "app_rx"); @@ -211,5 +211,5 @@ void app_start(void) app_start_tasks(); k_timer_start(¬ify_timer, K_MSEC(NOTIFY_TIMER_DURATION_MS), - K_MSEC(CONFIG_TEMPLATE_APP_NOTIFY_DATA_PERIOD_MS)); + K_MSEC(CONFIG_SID_END_DEVICE_NOTIFY_DATA_PERIOD_MS)); } diff --git a/samples/sid_end_device/src/sensor_monitoring/app_rx.c b/samples/sid_end_device/src/sensor_monitoring/app_rx.c index 6e90421da0..13e0028d02 100644 --- a/samples/sid_end_device/src/sensor_monitoring/app_rx.c +++ b/samples/sid_end_device/src/sensor_monitoring/app_rx.c @@ -17,7 +17,7 @@ LOG_MODULE_REGISTER(app_rx, CONFIG_SIDEWALK_LOG_LEVEL); #define ACTION_RESP_BTN_ALL (0xFF) #define ACTION_REQ_LED_ALL (0xFF) -K_MSGQ_DEFINE(rx_msgq, sizeof(struct app_rx_msg), CONFIG_TEMPLATE_APP_RX_THREAD_QUEUE_SIZE, 4); +K_MSGQ_DEFINE(rx_msgq, sizeof(struct app_rx_msg), CONFIG_SID_END_DEVICE_RX_THREAD_QUEUE_SIZE, 4); static void app_rx_button_resp_process(struct sid_demo_msg *msg) { diff --git a/samples/sid_end_device/src/sensor_monitoring/app_tx.c b/samples/sid_end_device/src/sensor_monitoring/app_tx.c index 5b3fb05e75..21ba5c430e 100644 --- a/samples/sid_end_device/src/sensor_monitoring/app_tx.c +++ b/samples/sid_end_device/src/sensor_monitoring/app_tx.c @@ -50,8 +50,8 @@ static const struct smf_state app_states[] = { [STATE_APP_NOTIFY_DATA] = SMF_CREATE_STATE(NULL, state_notify_data, NULL), }; -static uint8_t - __aligned(4) app_msgq_buff[CONFIG_TEMPLATE_APP_TX_THREAD_QUEUE_SIZE * sizeof(app_event_t)]; +static uint8_t __aligned(4) + app_msgq_buff[CONFIG_SID_END_DEVICE_TX_THREAD_QUEUE_SIZE * sizeof(app_event_t)]; K_TIMER_DEFINE(button_timer, button_timer_cb, NULL); @@ -421,7 +421,7 @@ void app_tx_task(void *dummy1, void *dummy2, void *dummy3) K_MSEC(APP_NOTIFY_BUTTON_PERIOD_MS)); k_msgq_init(&app_sm.msgq, app_msgq_buff, sizeof(app_event_t), - CONFIG_TEMPLATE_APP_TX_THREAD_QUEUE_SIZE); + CONFIG_SID_END_DEVICE_TX_THREAD_QUEUE_SIZE); smf_set_initial(SMF_CTX(&app_sm), &app_states[STATE_APP_INIT]); while (1) { diff --git a/samples/sid_end_device/src/sidewalk.c b/samples/sid_end_device/src/sidewalk.c index 461597e86e..77d38a93dc 100644 --- a/samples/sid_end_device/src/sidewalk.c +++ b/samples/sid_end_device/src/sidewalk.c @@ -8,10 +8,10 @@ #include #include #include -#ifdef CONFIG_TEMPLATE_APP_CLI +#ifdef CONFIG_SID_END_DEVICE_CLI #include #endif -#ifdef CONFIG_SIDEWALK_PERSISTENT_LINK_MASK +#ifdef CONFIG_SID_END_DEVICE_PERSISTENT_LINK_MASK #include #endif #include @@ -35,7 +35,7 @@ LOG_MODULE_REGISTER(sidewalk_app, CONFIG_SIDEWALK_LOG_LEVEL); static struct k_thread sid_thread; K_THREAD_STACK_DEFINE(sid_thread_stack, CONFIG_SIDEWALK_THREAD_STACK_SIZE); -K_HEAP_DEFINE(data_heap, CONFIG_TEMPLATE_APP_EVENT_HEAP_SIZE); +K_HEAP_DEFINE(data_heap, CONFIG_SID_END_DEVICE_EVENT_HEAP_SIZE); typedef struct sm_s { struct smf_ctx ctx; @@ -49,7 +49,7 @@ enum state { STATE_DFU, }; -#ifdef CONFIG_SIDEWALK_AUTO_CONN_REQ +#ifdef CONFIG_SID_END_DEVICE_AUTO_CONN_REQ static void *pending_msg_ctx; #endif @@ -92,17 +92,17 @@ static void state_sidewalk_entry(void *o) return; } -#ifdef CONFIG_SIDEWALK_AUTO_START +#ifdef CONFIG_SID_END_DEVICE_AUTO_START sm_t *sm = (sm_t *)o; -#ifdef CONFIG_SIDEWALK_PERSISTENT_LINK_MASK +#ifdef CONFIG_SID_END_DEVICE_PERSISTENT_LINK_MASK int err = settings_utils_link_mask_get(&sm->sid->config.link_mask); if (err) { LOG_WRN("Link mask get failed %d", err); sm->sid->config.link_mask = 0; settings_utils_link_mask_set(DEFAULT_LM); } -#endif /* CONFIG_SIDEWALK_PERSISTENT_LINK_MASK */ +#endif /* CONFIG_SID_END_DEVICE_PERSISTENT_LINK_MASK */ if (!sm->sid->config.link_mask) { sm->sid->config.link_mask = DEFAULT_LM; @@ -121,7 +121,7 @@ static void state_sidewalk_entry(void *o) if (e) { LOG_ERR("sid start err %d", (int)e); } -#endif /* CONFIG_SIDEWALK_AUTO_START */ +#endif /* CONFIG_SID_END_DEVICE_AUTO_START */ } static void state_sidewalk_run(void *o) @@ -137,7 +137,7 @@ static void state_sidewalk_run(void *o) } break; case SID_EVENT_FACTORY_RESET: -#ifdef CONFIG_SIDEWALK_PERSISTENT_LINK_MASK +#ifdef CONFIG_SID_END_DEVICE_PERSISTENT_LINK_MASK (void)settings_utils_link_mask_set(0); #endif e = sid_set_factory_reset(sm->sid->handle); @@ -164,12 +164,12 @@ static void state_sidewalk_run(void *o) LOG_INF("Sidewalk link switch to %s", (SID_LINK_TYPE_3 & new_link_mask) ? "LoRa" : (SID_LINK_TYPE_2 & new_link_mask) ? "FSK" : "BLE"); -#ifdef CONFIG_SIDEWALK_PERSISTENT_LINK_MASK +#ifdef CONFIG_SID_END_DEVICE_PERSISTENT_LINK_MASK int err = settings_utils_link_mask_set(new_link_mask); if (err) { LOG_ERR("New link mask set err %d", err); } -#endif /* CONFIG_SIDEWALK_PERSISTENT_LINK_MASK */ +#endif /* CONFIG_SID_END_DEVICE_PERSISTENT_LINK_MASK */ if (sm->sid->handle != NULL) { e = sid_deinit(sm->sid->handle); @@ -205,11 +205,11 @@ static void state_sidewalk_run(void *o) memcpy(&sm->sid->last_status, p_status, sizeof(struct sid_status)); sidewalk_data_free(p_status); -#ifdef CONFIG_SIDEWALK_AUTO_CONN_REQ +#ifdef CONFIG_SID_END_DEVICE_AUTO_CONN_REQ if (pending_msg_ctx) { sidewalk_event_send(SID_EVENT_SEND_MSG, pending_msg_ctx); } -#endif /* CONFIG_SIDEWALK_AUTO_CONN_REQ */ +#endif /* CONFIG_SID_END_DEVICE_AUTO_CONN_REQ */ break; case SID_EVENT_SEND_MSG: sidewalk_msg_t *p_msg = (sidewalk_msg_t *)sm->event.ctx; @@ -218,14 +218,14 @@ static void state_sidewalk_run(void *o) break; } -#ifdef CONFIG_SIDEWALK_AUTO_CONN_REQ +#ifdef CONFIG_SID_END_DEVICE_AUTO_CONN_REQ bool is_link_up = sm->sid->last_status.detail.link_status_mask & SID_LINK_TYPE_ANY; if (!is_link_up && !pending_msg_ctx) { pending_msg_ctx = p_msg; sidewalk_event_send(SID_EVENT_CONNECT, NULL); break; } -#endif /* CONFIG_SIDEWALK_AUTO_CONN_REQ */ +#endif /* CONFIG_SID_END_DEVICE_AUTO_CONN_REQ */ e = sid_put_msg(sm->sid->handle, &p_msg->msg, &p_msg->desc); if (e) { @@ -235,11 +235,11 @@ static void state_sidewalk_run(void *o) sidewalk_data_free(p_msg->msg.data); sidewalk_data_free(p_msg); -#ifdef CONFIG_SIDEWALK_AUTO_CONN_REQ +#ifdef CONFIG_SID_END_DEVICE_AUTO_CONN_REQ if (is_link_up && pending_msg_ctx) { pending_msg_ctx = NULL; } -#endif /* CONFIG_SIDEWALK_AUTO_CONN_REQ */ +#endif /* CONFIG_SID_END_DEVICE_AUTO_CONN_REQ */ break; case SID_EVENT_CONNECT: sid_error_t e = sid_ble_bcn_connection_request(sm->sid->handle, true); @@ -251,11 +251,11 @@ static void state_sidewalk_run(void *o) break; } -#ifdef CONFIG_TEMPLATE_APP_CLI +#ifdef CONFIG_SID_END_DEVICE_CLI if (sm->event.id >= SID_EVENT_LAST) { app_dut_event_process(sm->event, sm->sid); } -#endif /* CONFIG_TEMPLATE_APP_CLI */ +#endif /* CONFIG_SID_END_DEVICE_CLI */ } static void state_dfu_entry(void *o) diff --git a/scripts/ci/memory_requirements.py b/scripts/ci/memory_requirements.py index 70cfe59d51..f358ff1e50 100755 --- a/scripts/ci/memory_requirements.py +++ b/scripts/ci/memory_requirements.py @@ -70,23 +70,17 @@ def full_title(self) -> str: SAMPLES = [ - Sample('sensor_monitoring', 'sample.sidewalk.demo', - ':ref:`Sensor monitoring `'), - Sample('template_subghz', 'sample.sidewalk.template', - ':ref:`Template sub-GHz `'), - Sample('template_ble', 'sample.sidewalk.template_ble', - ':ref:`Template Bluetooth LE `'), + Sample('sid_end_device', 'sample.sidewalk.demo', + ':ref:`Sensor monitoring `'), + Sample('sid_end_device', 'sample.sidewalk.hello', + ':ref:`End device Bluetooth LE and sub-GHz `'), + Sample('sid_end_device', 'sample.sidewalk.hello.ble_only', + ':ref:`End device Bluetooth LE `'), ] VARIANTS = { '': 'Debug', '.release': 'Release', - '.ble': 'Bluetooth LE Debug', - '.fsk': 'FSK Debug', - '.lora': 'LoRa Debug', - '.ble.release': 'Bluetooth LE Release', - '.fsk.release': 'FSK Release', - '.lora.release': 'LoRa Release', } diff --git a/tests/manual/simple_bootloader/CMakeLists.txt b/tests/manual/simple_bootloader/CMakeLists.txt index ccb22c950a..9652145b85 100644 --- a/tests/manual/simple_bootloader/CMakeLists.txt +++ b/tests/manual/simple_bootloader/CMakeLists.txt @@ -6,9 +6,9 @@ cmake_minimum_required(VERSION 3.20.0) -include($ENV{ZEPHYR_BASE}/../sidewalk/samples/template/bootloader_version.cmake) +include($ENV{ZEPHYR_BASE}/../sidewalk/samples/sid_end_device/bootloader_version.cmake) -set(mcuboot_KCONFIG_ROOT $ENV{ZEPHYR_BASE}/../sidewalk/samples/template/child_image/mcuboot/Kconfig.root) +set(mcuboot_KCONFIG_ROOT $ENV{ZEPHYR_BASE}/../sidewalk/samples/sid_end_device/child_image/mcuboot/Kconfig.root) find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE}) project(simple_bootloader) diff --git a/tests/manual/simple_bootloader/README.rst b/tests/manual/simple_bootloader/README.rst index 7d68305f4a..266a30ad33 100644 --- a/tests/manual/simple_bootloader/README.rst +++ b/tests/manual/simple_bootloader/README.rst @@ -10,11 +10,11 @@ It is significantly smaller then any Sidewalk sample. Maintenance notes ================ .. note:: - This appclication is designed to work with sidewalk template_ble sample + This appclication is designed to work with sidewalk sid_end_device sample Configuration: * prj.conf - From Kconfig.dependencies config SIDEWALK_DFU_BOOTLOADER - * pm_static.yaml - copied from template_ble. Setting storage added as static partition (values from ninja partition_manager_report) to keep application footprint small. + * pm_static.yaml - copied from sid_end_device. Setting storage added as static partition (values from ninja partition_manager_report) to keep application footprint small. Requirements ************ @@ -32,7 +32,7 @@ Testing ======= Precondition -#. Build and flash Sidewalk template_ble sample +#. Build and flash Sidewalk sid_end_device sample #. Flash MFG.hex (provisioning data) #. Enter DFU mode (button action) diff --git a/tests/unit_tests/sid_dut_shell/CMakeLists.txt b/tests/unit_tests/sid_dut_shell/CMakeLists.txt index dc7fbea356..97f838c57e 100644 --- a/tests/unit_tests/sid_dut_shell/CMakeLists.txt +++ b/tests/unit_tests/sid_dut_shell/CMakeLists.txt @@ -16,7 +16,7 @@ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g3 -O0") target_sources(testbinary PRIVATE src/main.c - ${SIDEWALK_BASE}/samples/template/src/cli/app_shell.c + ${SIDEWALK_BASE}/samples/sid_end_device/src/cli/app_shell.c $ENV{ZEPHYR_BASE}/lib/os/hex.c mock/sidewalk_version.c ) @@ -24,7 +24,7 @@ target_sources(testbinary PRIVATE add_definitions(--include ztest.h) target_include_directories(testbinary PRIVATE - ${SIDEWALK_BASE}/samples/template/include + ${SIDEWALK_BASE}/samples/sid_end_device/include ${SIDEWALK_BASE}/subsys/sal/common/sid_ifc ${SIDEWALK_BASE}/subsys/sal/common/sid_time_ops ${SIDEWALK_BASE}/subsys/sal/common/sid_pal_ifc