Skip to content

Commit ef11554

Browse files
committed
doc: thingy53: remove GSG guide
Moved information about updating precompiled firmware to device guide. Transferred detailed steps for programming with the Programmer app to the tool documentation. Added a new page about precompiled firmware. Reorganized information about programming methods for clarity. NCSDK-29643. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
1 parent 852ae66 commit ef11554

14 files changed

+245
-9266
lines changed

doc/_utils/redirects.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,10 @@
3434
("device_guides/working_with_nrf/nrf70/gs", "gsg_guides/nrf7002_gs"),
3535
("device_guides/working_with_nrf/nrf53/nrf5340_gs", "gsg_guides"), # Getting started with nRF5340 DK (removed in v2.8.0)
3636
("gsg_guides/nrf5340_gs", "gsg_guides"),
37-
("ug_thingy53_gs", "gsg_guides/thingy53_gs"), # Getting started with Thingy:53
38-
("working_with_nrf/nrf53/thingy53_gs", "gsg_guides/thingy53_gs"),
39-
("device_guides/working_with_nrf/nrf53/thingy53_gs", "gsg_guides/thingy53_gs"),
37+
("ug_thingy53_gs", "app_dev/device_guides/thingy53/thingy53_precompiled"), # Getting started with Thingy:53 (removed in v3.0.0)
38+
("working_with_nrf/nrf53/thingy53_gs", "app_dev/device_guides/thingy53/thingy53_precompiled"),
39+
("device_guides/working_with_nrf/nrf53/thingy53_gs", "app_dev/device_guides/thingy53/thingy53_precompiled"),
40+
("gsg_guides/thingy53_gs", "app_dev/device_guides/thingy53/thingy53_precompiled"),
4041
("ug_nrf52_gs", "gsg_guides"), # Getting started with nRF52 Series (removed in v2.8.0)
4142
("working_with_nrf/nrf52/gs", "gsg_guides"),
4243
("device_guides/working_with_nrf/nrf52/gs", "gsg_guides"),

doc/nrf/app_dev/device_guides/thingy53/building_thingy53.rst

+86-2
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,52 @@ For example, you can use the following command when building on the command line
6464
6565
For the compatible Wi-Fi samples in the |NCS|, see the :ref:`wifi_samples` section.
6666

67+
.. _thingy53_app_update:
68+
69+
Programming methods for Thingy:53
70+
*********************************
71+
72+
You can program the firmware on the Nordic Thingy:53 using an external debug probe and 10-pin JTAG cable, using :ref:`Visual Studio Code <thingy53_build_pgm_vscode>`, :ref:`command line <thingy53_build_pgm_command_line>`, :ref:`command line <thingy53_build_pgm_command_line>`, or the `Programmer app <Programming Nordic Thingy:53_>`_ from nRF Connect for Desktop.
73+
You can also program applications running on both the network and application core using the built-in MCUboot serial recovery mode, using the `Programmer app`_ from nRF Connect for Desktop or `nRF Util <Programming application firmware using MCUboot serial recovery_>`_.
74+
75+
Finally, you can use the `Programmer app`_ from nRF Connect for Desktop, the `nRF Programmer`_ mobile app for Android and iOS, or nRF Util to update the :ref:`preloaded application images <thingy53_precompiled>`.
76+
77+
.. _thingy53_app_update_debug:
78+
79+
Firmware update using external debug probe
80+
==========================================
81+
82+
You can program the firmware on the Nordic Thingy:53 using an external debug probe and 10-pin JTAG cable.
83+
In such cases, you can program the Thingy:53 the same way as nRF5340 DK.
84+
85+
The external debug probe must support Arm Cortex-M33 (such as the nRF5340 DK).
86+
You need a 10-pin 2x5 socket-socket 1.27 mm IDC (:term:`Serial Wire Debug (SWD)`) JTAG cable to connect to the external debug probe.
87+
88+
This method is supported when programming with :ref:`Visual Studio Code <thingy53_build_pgm_vscode>`, :ref:`command line <thingy53_build_pgm_command_line>`, or the `Programmer app <Programming Nordic Thingy:53_>`_ from nRF Connect for Desktop.
89+
90+
See also :ref:`ug_nrf5340` for additional information.
91+
92+
.. _thingy53_app_update_mcuboot:
93+
94+
Firmware update using MCUboot bootloader
95+
========================================
96+
97+
Samples and applications built for Thingy:53 include the MCUboot bootloader that you can use to update the firmware out of the box.
98+
This method uses signed binary files :file:`app_update.bin` and :file:`net_core_app_update.bin` (or :file:`dfu_application.zip`).
99+
You can program the precompiled firmware image using one of the following ways:
100+
101+
* Use the :doc:`MCUboot<mcuboot:index-ncs>` feature and the built-in serial recovery mode of Thingy:53.
102+
In this scenario, the Thingy is connected directly to your PC through USB.
103+
For details, refer to the :ref:`thingy53_app_mcuboot_bootloader` section.
104+
105+
See `Programming Nordic Thingy:53`_ in the `Programmer app`_ for the detailed procedures on how to program the Thingy:53 using nRF Connect for Desktop.
106+
* Update the firmware over-the-air (OTA) using Bluetooth® LE and the nRF Programmer mobile application for Android or iOS.
107+
To use this method, the application that is currently programmed on Thingy:53 must support it.
108+
For details, refer to :ref:`thingy53_app_fota_smp` section.
109+
All precompiled images support OTA using Bluetooth.
110+
111+
See the :ref:`thingy53_gs_updating_ble` section for the detailed procedures on how to program a Thingy:53 using the `nRF Programmer`_ mobile app for Android or iOS.
112+
67113
.. _thingy53_build_pgm_vscode:
68114

69115
Building and programming using |VSC|
@@ -80,8 +126,15 @@ Complete the following steps to build and program using the |nRFVSC|:
80126
3. Program the sample or application:
81127

82128
a. Connect the Nordic Thingy:53 to the debug out port on a 10-pin external debug probe, for example nRF5340 DK, using a 10-pin JTAG cable.
83-
#. Connect the external debug probe to the PC using a USB cable.
129+
130+
.. figure:: /images/thingy53_nrf5340_dk.svg
131+
:alt: Nordic Thingy:53 connected to the debug port on a 10-pin external debug probe
132+
133+
Nordic Thingy:53 connected to the debug port on a 10-pin external debug probe
134+
135+
#. Connect the external debug probe to the PC using a micro-USB cable.
84136
#. Make sure that the Thingy:53 and the external debug probe are powered on.
137+
(On the Thingy:53, move the power switch **SW1** to the **ON** position.)
85138
#. Click :guilabel:`Flash` in the :guilabel:`Actions View`.
86139

87140
.. _thingy53_build_pgm_command_line:
@@ -119,12 +172,43 @@ To build and program the source code from the command line, complete the followi
119172
#. Program the sample or application:
120173

121174
a. Connect the Nordic Thingy:53 to the debug out port on a 10-pin external debug probe, for example nRF5340 DK, using a 10-pin JTAG cable.
122-
#. Connect the external debug probe to the PC using a USB cable.
175+
176+
.. figure:: /images/thingy53_nrf5340_dk.svg
177+
:alt: Nordic Thingy:53 connected to the debug port on a 10-pin external debug probe
178+
179+
Nordic Thingy:53 connected to the debug port on a 10-pin external debug probe
180+
181+
#. Connect the external debug probe to the PC using a micro-USB cable.
123182
#. Make sure that the Nordic Thingy:53 and the external debug probe are powered on.
183+
(On the Thingy:53, move the power switch **SW1** to the **ON** position.)
124184
#. Use the following command to program the sample or application to the device:
125185

126186
.. code-block:: console
127187
128188
west flash
129189
130190
The device resets and runs the programmed sample or application.
191+
192+
.. _thingy53_gs_updating_usb:
193+
.. _thingy53_gs_updating_external_probe:
194+
195+
Programming using the Programmer app
196+
************************************
197+
198+
You can program the Nordic Thingy:53 using the `Programmer app`_ from nRF Connect for Desktop and MCUboot's serial recovery feature.
199+
This application can also be used to program precompiled firmware packages.
200+
201+
You can program the Thingy:53 using the Programmer app using either USB-C or an external debug probe.
202+
See the `Programming Nordic Thingy:53`_ in the tool documentation for detailed steps.
203+
204+
Programming using nRF Util
205+
**************************
206+
207+
You can use the nRF Util utility to program Thingy:53, including programming precompiled firmware packages.
208+
See `Programming application firmware using MCUboot serial recovery`_ in the tool documentation for detailed steps.
209+
210+
Using the nRF Programmer mobile app
211+
***********************************
212+
213+
You can use the `nRF Programmer`_ mobile app on your Android or iOS device to program precompiled firmware packages.
214+
For detailed steps, see :ref:`thingy53_gs_updating_ble`.

doc/nrf/app_dev/device_guides/thingy53/thingy53_application_guide.rst

+3-41
Original file line numberDiff line numberDiff line change
@@ -14,53 +14,15 @@ See the following sections for details of what is configured by default and what
1414

1515
.. _thingy53_serialports:
1616

17-
Connecting to Thingy:53
18-
***********************
17+
Connecting to Thingy:53 for logs
18+
********************************
1919

2020
Applications and samples for the Nordic Thingy:53 use a serial terminal to provide logs.
2121
By default, the serial terminal is accessible through the USB CDC ACM class handled by application firmware.
2222
The serial port is visible right after the Thingy:53 is connected to the host using a USB cable.
2323
The CDC ACM baudrate is ignored, and transfer goes with USB speed.
2424

25-
.. _thingy53_app_update:
26-
27-
Updating firmware image for Thingy:53
28-
*************************************
29-
30-
You can program the firmware on the Nordic Thingy:53 using an external debug probe and 10-pin JTAG cable, as described in :ref:`thingy53_building_pgming`, using either :ref:`Visual Studio Code <thingy53_build_pgm_vscode>` or :ref:`command line <thingy53_build_pgm_command_line>`.
31-
You can also update applications running on both the network and application core using the built-in MCUboot bootloader and the `Programmer app`_ for desktop or the `nRF Programmer`_ app for Android and iOS.
32-
You can also update the prebuilt application images that way.
33-
34-
See :ref:`thingy53_gs_updating_firmware` for details about updating firmware image.
35-
36-
.. _thingy53_app_update_debug:
37-
38-
Firmware update using external debug probe
39-
==========================================
40-
41-
If you are using an external debug probe, such as the nRF5340 DK, or any J-Link device supporting ARM Cortex-M33, you can program the Thingy:53 the same way as nRF5340 DK.
42-
See :ref:`ug_nrf5340` for details.
43-
44-
.. _thingy53_app_update_mcuboot:
45-
46-
Firmware update using MCUboot bootloader
47-
========================================
48-
49-
Samples and applications built for Thingy:53 include the MCUboot bootloader that you can use to update the firmware out of the box.
50-
This method uses signed binary files :file:`app_update.bin` and :file:`net_core_app_update.bin` (or :file:`dfu_application.zip`).
51-
You can program the precompiled firmware image using one of the following ways:
52-
53-
* Use the :doc:`MCUboot<mcuboot:index-ncs>` feature and the built-in serial recovery mode of Thingy:53.
54-
In this scenario, the Thingy is connected directly to your PC through USB.
55-
For details, refer to the :ref:`thingy53_app_mcuboot_bootloader` section.
56-
57-
See the :ref:`thingy53_gs_updating_usb` section in the :ref:`ug_thingy53_gs` guide for the detailed procedures on how to program the Thingy:53 using the `Programmer app`_.
58-
* Update the firmware over-the-air (OTA) using Bluetooth® LE and the nRF Programmer mobile application for Android or iOS.
59-
To use this method, the application that is currently programmed on Thingy:53 must support it.
60-
For details, refer to :ref:`thingy53_app_fota_smp` section.
61-
All precompiled images support OTA using Bluetooth.
62-
63-
See the :ref:`thingy53_gs_updating_ble` section in the :ref:`ug_thingy53_gs` guide for the detailed procedures on how to program a Thingy:53 using `nRF Programmer`_ for Android or iOS.
25+
For more information, see :ref:`thingy53_app_usb`.
6426

6527
.. _thingy53_app_partition_manager_config:
6628

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
.. _thingy53_precompiled:
2+
.. _thingy53_gs_updating_firmware:
3+
4+
Preloaded and precompiled Thingy:53 firmware
5+
############################################
6+
7+
.. contents::
8+
:local:
9+
:depth: 2
10+
11+
The Nordic Thingy:53 comes preloaded with the following firmware:
12+
13+
* `Edge Impulse`_ application firmware
14+
* MCUboot bootloader
15+
* SoftDevice controller on the network core
16+
17+
This page describes how to connect with Edge Impulse Studio or update Nordic Thingy:53 with precompiled firmware provided by Nordic Semiconductor.
18+
19+
.. _thingy53_gs_machine_learning:
20+
21+
Connecting with Edge Impulse Studio
22+
***********************************
23+
24+
The Nordic Thingy:53 is preprogrammed with Edge Impulse firmware.
25+
The Edge Impulse firmware enables data collection from all the sensors on the Nordic Thingy:53.
26+
You can use the collected data to train and test machine learning models.
27+
Deploy the trained machine learning model to the Nordic Thingy:53 over Bluetooth LE or USB.
28+
29+
Complete the following steps to get started with Edge Impulse:
30+
31+
1. Go to the `Edge Impulse`_ website.
32+
#. Create a free Edge Impulse account.
33+
#. Download the `nRF Edge Impulse mobile app`_.
34+
#. Follow the instructions in the `Nordic Semi Thingy:53 page`_.
35+
36+
Precompiled Thingy:53 firmware
37+
******************************
38+
39+
If you want to program your Nordic Thingy:53 with other precompiled firmware, you can download the latest precompiled firmware from the following sources:
40+
41+
* The `Nordic Thingy:53 Downloads`_ page (the Precompiled application firmware section).
42+
The package contains a :file:`CONTENTS.txt` file listing the locations and names of different firmware images.
43+
* The `nRF Programmer`_ mobile application (available for Android and iOS).
44+
The application lists the available precompiled firmware images when you open it.
45+
46+
.. _thingy53_app_update:
47+
.. _thingy53_gs_updating_ble:
48+
49+
Updating precompiled firmware
50+
=============================
51+
52+
You can update the precompiled firmware using any of the following methods:
53+
54+
.. tabs::
55+
56+
.. tab:: Over Bluetooth LE using nRF Programmer
57+
58+
You can update the Nordic Thingy:53 application and network core over Bluetooth LE using the nRF Programmer mobile application for Android or iOS.
59+
60+
Complete these steps to update the firmware:
61+
62+
1. Open the nRF Programmer app.
63+
64+
A list of available samples appears.
65+
66+
.. figure:: /gsg_guides/images/thingy53_sample_list.png
67+
:alt: nRF Programmer - list of samples
68+
69+
nRF Programmer - list of samples
70+
71+
#. Select a sample.
72+
73+
Application info appears.
74+
75+
.. figure:: /gsg_guides/images/thingy53_application_info.png
76+
:alt: nRF Programmer - Application Info
77+
78+
nRF Programmer - Application Info
79+
80+
#. Select the version of the sample from the drop-down menu.
81+
#. Tap :guilabel:`Download`.
82+
83+
When the download is complete, the name of the button changes to :guilabel:`Install`.
84+
#. Tap :guilabel:`Install`.
85+
86+
A list of nearby devices and their signal strengths appears.
87+
#. Select your Nordic Thingy:53 from the list.
88+
It is listed as **El Thingy:53**.
89+
90+
The transfer of the firmware image starts, and a progress wheel appears.
91+
92+
.. figure:: /gsg_guides/images/thingy53_progress_wheel.png
93+
:alt: nRF Programmer - progress wheel
94+
95+
nRF Programmer - progress wheel
96+
97+
If you want to pause the update process, tap :guilabel:`Pause`.
98+
If you want to stop the update process, tap :guilabel:`Stop`.
99+
100+
The image transfer is complete when the progress wheel reaches 100%.
101+
The Nordic Thingy:53 is reset and updated to the new firmware sample.
102+
#. Tap :guilabel:`Done` to return to Application info.
103+
104+
.. tab:: Over USB using the Programmer app
105+
106+
See the `Programming Nordic Thingy:53`_ in the tool documentation for detailed steps.
107+
108+
.. tab:: With an external debug probe using the Programmer app
109+
110+
See the `Programming Nordic Thingy:53`_ in the tool documentation for detailed steps.
111+
112+
.. tab:: Using nRF Util
113+
114+
See `Programming application firmware using MCUboot serial recovery`_ in the tool documentation for more information.

0 commit comments

Comments
 (0)