From 1af4da39c12ea7aaaeaa666485626a41c13eb41a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leksi=C5=84ski?= Date: Tue, 12 Nov 2024 12:14:30 +0100 Subject: [PATCH] Updated LEDs and Buttons namings --- docs/configuring/other_ecosystems.rst | 2 +- docs/quick-start.rst | 26 ++++++++++---------- docs/samples/ncp/README.rst | 6 ++--- samples/light_bulb/README.rst | 14 +++++------ samples/light_switch/README.rst | 34 +++++++++++++------------- samples/network_coordinator/README.rst | 18 +++++++------- samples/shell/README.rst | 2 +- samples/template/README.rst | 8 +++--- 8 files changed, 55 insertions(+), 55 deletions(-) diff --git a/docs/configuring/other_ecosystems.rst b/docs/configuring/other_ecosystems.rst index a8f5b2e..7f39b7d 100644 --- a/docs/configuring/other_ecosystems.rst +++ b/docs/configuring/other_ecosystems.rst @@ -57,7 +57,7 @@ The following instructions can help you troubleshoot the connection problem: 1. Make sure that the Coordinator node is up and running. #. Make sure that the network is accepting new devices. - The most immediate way to verify this is to check if the **LED1** on the Zigbee Coordinator node. + The most immediate way to verify this is to check if the **LED 1** on the Zigbee Coordinator node. If the LED is on, the network is configured correctly and it is open to new nodes. .. note:: diff --git a/docs/quick-start.rst b/docs/quick-start.rst index 4378fb8..c997e98 100644 --- a/docs/quick-start.rst +++ b/docs/quick-start.rst @@ -70,7 +70,7 @@ To program the samples, complete the following steps: .. figure:: images/zigbee_qsg_vsc_flash.png :alt: nRF Connect for Visual Studio Code - Refresh Connected Devices and Flash buttons - When the programming is done, the **LED1** on the development kit turns on to indicate that the Zigbee network is open. + When the programming is done, the **LED 1** on the development kit turns on to indicate that the Zigbee network is open. After some time, it turns off and the Zigbee network needs to be reopened (see below). #. Add the Zigbee light switch sample. @@ -78,22 +78,22 @@ To program the samples, complete the following steps: #. Add the Zigbee light bulb sample. Repeat Steps 2 and 3 for the sample. - The **LED2** turns on when the application is started. -#. Press **BUTTON 0** on the development kit programmed with the network coordinator sample to reopen the Zigbee network. + The **LED 2** turns on when the application is started. +#. Press **Button 0** on the development kit programmed with the network coordinator sample to reopen the Zigbee network. After some time, the devices join the Zigbee network. - * On the development kit programmed with the light bulb sample, **LED1** turns on when the light bulb joins the network. - * On the development kit programmed with the light switch sample, **LED1** turns on when the device joins the network and **LED2** turns on when the light switch finds a light bulb to control. + * On the development kit programmed with the light bulb sample, **LED 1** turns on when the light bulb joins the network. + * On the development kit programmed with the light switch sample, **LED 1** turns on when the device joins the network and **LED 2** turns on when the light switch finds a light bulb to control. Reopening the network If you find that you are having issues with your devices joining the Zigbee network, it may be because the network needs to be reopened manually. - By default, the network remains open for 180 seconds at startup and after **BUTTON 0** is pressed. + By default, the network remains open for 180 seconds at startup and after **Button 0** is pressed. After 180 seconds have passed, the network will close and needs to be re-opened. - When the network is open, **LED1** on the development kit programmed with the network coordinator sample will be on. - If **LED1** is not on, then the network is closed and needs to be reopened again. + When the network is open, **LED 1** on the development kit programmed with the network coordinator sample will be on. + If **LED 1** is not on, then the network is closed and needs to be reopened again. - To reopen the network, press **BUTTON 0** on the development kit that has been programmed as the network coordinator. + To reopen the network, press **Button 0** on the development kit that has been programmed as the network coordinator. For more information, see the :ref:`User interface ` section for the :ref:`Zigbee Network coordinator ` sample. @@ -104,10 +104,10 @@ Test the network After forming the Zigbee network, test the interaction between the devices: -1. Press **BUTTON 1** once on the development kit programmed with the light switch sample to turn off the light bulb's **LED1**. -#. Press **BUTTON 0** once on the development kit programmed with the light switch sample to turn on the light bulb's **LED1**. -#. Press and hold **BUTTON 0** on the development kit programmed with the light switch sample to decrease the light bulb's **LED1** brightness. -#. Press and hold **BUTTON 1** on the development kit programmed with the light switch sample to increase the light bulb's **LED1** brightness. +1. Press **Button 1** once on the development kit programmed with the light switch sample to turn off the light bulb's **LED 1**. +#. Press **Button 0** once on the development kit programmed with the light switch sample to turn on the light bulb's **LED 1**. +#. Press and hold **Button 0** on the development kit programmed with the light switch sample to decrease the light bulb's **LED 1** brightness. +#. Press and hold **Button 1** on the development kit programmed with the light switch sample to increase the light bulb's **LED 1** brightness. Next steps ********** diff --git a/docs/samples/ncp/README.rst b/docs/samples/ncp/README.rst index 925f15a..5d73664 100644 --- a/docs/samples/ncp/README.rst +++ b/docs/samples/ncp/README.rst @@ -254,7 +254,7 @@ To implement custom vendor-specific commands, you need to modify the NCP sample The function must follow the :c:func:`zb_ncp_custom_request_cb_t` declaration. For an example, see :c:func:`ncp_vendor_specific_req_handler` in the sample. - This function parses the command payload, validates it, performs required action on **LED1**, and sends a response. + This function parses the command payload, validates it, performs required action on **LED 1**, and sends a response. #. Register the handler function using :c:func:`zb_ncp_custom_register_request_cb`, as implemented in the sample. @@ -320,10 +320,10 @@ After building the sample and programming it to your development kit, complete t NCP_SLAVE_PTY=*serial_port_name* ./application/simple_gw/simple_gw The simple gateway device forms the Zigbee network and opens the network for 180 seconds for new devices to join. -When the light bulb joins the network, the **LED2** on the light bulb device turns on to indicate that it is connected to the simple gateway. +When the light bulb joins the network, the **LED 2** on the light bulb device turns on to indicate that it is connected to the simple gateway. The gateway then starts discovering the On/Off cluster. When it is found, the simple gateway configures bindings and reporting for the device. -It then starts sending On/Off toggle commands with a 15-second interval that toggle the **LED1** on the light bulb on and off. +It then starts sending On/Off toggle commands with a 15-second interval that toggle the **LED 1** on the light bulb on and off. Dependencies ************ diff --git a/samples/light_bulb/README.rst b/samples/light_bulb/README.rst index 52e40a7..55f2c3d 100644 --- a/samples/light_bulb/README.rst +++ b/samples/light_bulb/README.rst @@ -57,7 +57,7 @@ LED 1: LED 2: Turns on when the light bulb joins the network. -BUTTON 3: +Button 3: Depending on how long the button is pressed: * If pressed for less than five seconds, it starts or cancels the Identify mode. @@ -82,26 +82,26 @@ After programming the sample to your development kits, complete the following st 1. Turn on the development kit that runs the Network coordinator sample. - When **LED2** turns on, this development kit has become the Coordinator of the Zigbee network and the network is established. + When **LED 2** turns on, this development kit has become the Coordinator of the Zigbee network and the network is established. #. Turn on the development kit that runs the Light bulb sample. - When **LED2** turns on, the light bulb has become a Router inside the network. + When **LED 2** turns on, the light bulb has become a Router inside the network. .. note:: - If **LED2** does not turn on, press **BUTTON 0** on the Coordinator to reopen the network. + If **LED 2** does not turn on, press **Button 0** on the Coordinator to reopen the network. #. Turn on the development kit that runs the Light switch sample. - When **LED2** turns on, the light switch has become an End Device, connected directly to the Coordinator. + When **LED 2** turns on, the light switch has become an End Device, connected directly to the Coordinator. -#. Wait until **LED3** on the development kit that runs the Light switch sample turns on. +#. Wait until **LED 3** on the development kit that runs the Light switch sample turns on. This LED indicates that the switch found a light bulb to control. #. Use the buttons on the development kit that runs the :ref:`zigbee_light_switch_sample` sample to control the light bulb. - The result of using the buttons is reflected on the light bulb's **LED1**. + The result of using the buttons is reflected on the light bulb's **LED 1**. You can now use buttons on the light switch to control the light bulb, as described in the :ref:`zigbee_light_switch_user_interface` section of the Light switch sample page. diff --git a/samples/light_switch/README.rst b/samples/light_switch/README.rst index 9eda470..0a0aa72 100644 --- a/samples/light_switch/README.rst +++ b/samples/light_switch/README.rst @@ -57,7 +57,7 @@ Sleepy End Device behavior The light switch supports the :ref:`zigbee_ug_sed` that enables the sleepy behavior for the end device, for a significant conservation of energy. -To enable the sleepy behavior, press **BUTTON 2** while the light switch sample is booting. +To enable the sleepy behavior, press **Button 2** while the light switch sample is booting. This is required only when device is joining the network for the first time. After restarting the device, it will boot with the sleepy behavior enabled. @@ -166,19 +166,19 @@ LED 2: LED 3: Lit and solid when the light switch has found a light bulb to control. -BUTTON 0: - Turn on the light bulb connected to the network (light bulb's **LED1**). - This option is available after the successful commissioning (light switch's **LED2** turned on). +Button 0: + Turn on the light bulb connected to the network (light bulb's **LED 1**). + This option is available after the successful commissioning (light switch's **LED 2** turned on). - Pressing this button for a longer period of time increases the brightness of the **LED1** of the connected light bulb. + Pressing this button for a longer period of time increases the brightness of the **LED 1** of the connected light bulb. -BUTTON 1: - Turn off the light bulb connected to the network (light bulb's **LED1**). - This option is available after the successful commissioning (light switch's **LED2** turned on). +Button 1: + Turn off the light bulb connected to the network (light bulb's **LED 1**). + This option is available after the successful commissioning (light switch's **LED 2** turned on). - Pressing this button for a longer period of time decreases the brightness of the **LED1** of the connected light bulb. + Pressing this button for a longer period of time decreases the brightness of the **LED 1** of the connected light bulb. -BUTTON 3: +Button 3: When pressed for five seconds, it initiates the `factory reset of the device `_. The length of the button press can be edited using the ``CONFIG_FACTORY_RESET_PRESS_TIME_SECONDS`` Kconfig option from :ref:`lib_zigbee_application_utilities`. Releasing the button within this time does not trigger the factory reset procedure. @@ -197,7 +197,7 @@ BUTTON 3: Sleepy End Device behavior assignments ====================================== -BUTTON 2: +Button 2: When pressed while resetting the kit, enables the :ref:`zigbee_ug_sed`. Multiprotocol Bluetooth LE extension assignments @@ -237,20 +237,20 @@ After programming the sample to your development kits, complete the following st 1. Turn on the development kit that runs the Network coordinator sample. - When **LED2** turns on, this development kit has become the Coordinator of the Zigbee network. + When **LED 2** turns on, this development kit has become the Coordinator of the Zigbee network. #. Turn on the development kit that runs the Light bulb sample. - When **LED2** turns on, the light bulb has become a Router inside the network. + When **LED 2** turns on, the light bulb has become a Router inside the network. .. note:: - If **LED2** does not turn on, press **BUTTON 0** on the Coordinator to reopen the network. + If **LED 2** does not turn on, press **Button 0** on the Coordinator to reopen the network. #. Turn on the development kit that runs the Light switch sample. - When **LED2** turns on, the light switch has become an End Device, connected directly to the Coordinator. + When **LED 2** turns on, the light switch has become an End Device, connected directly to the Coordinator. -#. Wait until **LED3** on the light switch node turns on. +#. Wait until **LED 3** on the light switch node turns on. This LED indicates that the light switch found a light bulb to control. @@ -304,7 +304,7 @@ Set up nRF Toolbox by completing the following steps: The UART application of nRF Toolbox after establishing the connection - Observe that **LED0** on the light switch node is solid. + Observe that **LED 0** on the light switch node is solid. This indicates that the Bluetooth LE connection is established. In nRF Toolbox, tap the buttons you assigned to perform the test: diff --git a/samples/network_coordinator/README.rst b/samples/network_coordinator/README.rst index 598e7a2..12909ce 100644 --- a/samples/network_coordinator/README.rst +++ b/samples/network_coordinator/README.rst @@ -64,13 +64,13 @@ LED 2: LED 3: Blinks when the Network coordinator is in Identify mode. -BUTTON 0: +Button 0: Reopens the network for 180 seconds. .. note:: The network is also opened after startup. -BUTTON 3: +Button 3: Depending on how long the button is pressed: * If pressed for less than five seconds, it starts or cancels the Identify mode. @@ -95,26 +95,26 @@ After programming the sample to your development kit, complete the following ste 1. Turn on the development kit that runs the coordinator sample. - * When **LED0** starts blinking, the main application thread has started. - * When **LED2** turns on, this development kit has become the Coordinator of the Zigbee network and the network is established. + * When **LED 0** starts blinking, the main application thread has started. + * When **LED 2** turns on, this development kit has become the Coordinator of the Zigbee network and the network is established. #. Turn on the other development kits that you programmed. - * When **LED2** turns on the development kit that runs the Light bulb sample, it has become a Router inside the network. - * When **LED2** turns on the development kit that runs the Light switch sample, it has become an End Device, connected directly to the Coordinator. + * When **LED 2** turns on the development kit that runs the Light bulb sample, it has become a Router inside the network. + * When **LED 2** turns on the development kit that runs the Light switch sample, it has become an End Device, connected directly to the Coordinator. .. note:: - If **LED2** on the development kits does not turn on, press **BUTTON 0** on the Coordinator to reopen the network. + If **LED 2** on the development kits does not turn on, press **Button 0** on the Coordinator to reopen the network. #. Optionally, if you are testing with both the Light bulb and the Light switch samples, complete the following additional steps: - a. Wait until **LED3** on the development kit that runs the Light switch sample turns on. + a. Wait until **LED 3** on the development kit that runs the Light switch sample turns on. This LED indicates that the switch found a light bulb to control. #. Use buttons on the development kit that runs the Light switch sample to control the light bulb, as described in the Light switch sample's user interface section. - The result of using the buttons is reflected on the light bulb's **LED1**. + The result of using the buttons is reflected on the light bulb's **LED 1**. You can now use buttons on the light switch to control the light bulb, as described in the :ref:`zigbee_light_switch_user_interface` section of the Light switch sample page. diff --git a/samples/shell/README.rst b/samples/shell/README.rst index d8cdc37..fe2e6b4 100644 --- a/samples/shell/README.rst +++ b/samples/shell/README.rst @@ -72,7 +72,7 @@ LED 2: LED 3: Blinks to indicate that the identification mode is on. -BUTTON 3: +Button 3: Starts or cancels the Identify mode. All other interactions with the application can be handled using serial communication. diff --git a/samples/template/README.rst b/samples/template/README.rst index af2202c..ffe8098 100644 --- a/samples/template/README.rst +++ b/samples/template/README.rst @@ -52,7 +52,7 @@ LED 2: LED 3: Blinks to indicate that the identification mode is on. -BUTTON 3: +Button 3: Depending on how long the button is pressed: * If pressed for less than five seconds, it starts or cancels the Identify mode. @@ -77,14 +77,14 @@ After programming the sample to your development kit, complete the following ste 1. Turn on the development kit that runs the Network coordinator sample. - When **LED2** turns on, this development kit has become the Coordinator of the Zigbee network and the network is established. + When **LED 2** turns on, this development kit has become the Coordinator of the Zigbee network and the network is established. #. Turn on the development kit that runs the Template sample. - When **LED2** turns on, the light bulb has become a Router inside the network. + When **LED 2** turns on, the light bulb has become a Router inside the network. .. note:: - If **LED2** does not turn on, press **BUTTON 0** on the Coordinator to reopen the network. + If **LED 2** does not turn on, press **Button 0** on the Coordinator to reopen the network. The device running the Template sample is now part of the Zigbee network as a Router. As a result, the network range is extended by the template application radio range.