Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: thingy53: remove GSG guide #19828

Merged

Conversation

greg-fer
Copy link
Contributor

@greg-fer greg-fer commented Jan 9, 2025

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.


  • Changelog entry

@greg-fer greg-fer added CI-disable Disable CI for this PR doc only labels Jan 9, 2025
@greg-fer greg-fer added this to the 3.0.0 milestone Jan 9, 2025
@greg-fer greg-fer requested review from a team as code owners January 9, 2025 16:05
@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jan 9, 2025
@greg-fer greg-fer marked this pull request as draft January 9, 2025 16:06
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jan 9, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 7

Inputs:

Sources:

more details

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (0)

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests

Note: This message is automatically posted and updated by the CI

@greg-fer greg-fer force-pushed the doc_move_thingy53_gs_to_dev_section branch from ef11554 to 8659c0b Compare January 10, 2025 09:23
@github-actions github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 10, 2025
@greg-fer greg-fer marked this pull request as ready for review January 10, 2025 09:41
@greg-fer greg-fer requested a review from a team as a code owner January 10, 2025 09:41
@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publish GitHub Action.

@greg-fer greg-fer force-pushed the doc_move_thingy53_gs_to_dev_section branch from 8659c0b to 4b459a1 Compare January 10, 2025 10:20
Comment on lines 71 to 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.
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_>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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_>`_.
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>`, or the `Programmer app <Programming Nordic Thingy:53_>`_ from nRF Connect for Desktop.
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_>`_.

==========================================

You can program the firmware on the Nordic Thingy:53 using an external debug probe and 10-pin JTAG cable.
In such cases, you can program the Thingy:53 the same way as nRF5340 DK.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In such cases, you can program the Thingy:53 the same way as nRF5340 DK.
In such cases, you can program the Thingy:53 the same way as the nRF5340 DK.

In such cases, you can program the Thingy:53 the same way as nRF5340 DK.

The external debug probe must support Arm Cortex-M33 (such as the nRF5340 DK).
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
You need a 10-pin 2x5 socket-to-socket 1.27 mm IDC (:term:`Serial Wire Debug (SWD)`) JTAG cable to connect to the external debug probe.

In this scenario, the Thingy is connected directly to your PC through USB.
For details, refer to the :ref:`thingy53_app_mcuboot_bootloader` section.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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.

You can program the Nordic Thingy:53 using the `Programmer app`_ from nRF Connect for Desktop and MCUboot's serial recovery feature.
This application can also be used to program precompiled firmware packages.

You can program the Thingy:53 using the Programmer app using either USB-C or an external debug probe.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can program the Thingy:53 using the Programmer app using either USB-C or an external debug probe.
You can program the Thingy:53 using the Programmer app with either USB-C or an external debug probe.

Programming using nRF Util
**************************

You can use the nRF Util utility to program Thingy:53, including programming precompiled firmware packages.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can use the nRF Util utility to program Thingy:53, including programming precompiled firmware packages.
You can use the nRF Util tool to program Thingy:53, including programming precompiled firmware packages.


Samples and applications built for Thingy:53 include the MCUboot bootloader that you can use to update the firmware out of the box.
This method uses signed binary files :file:`app_update.bin` and :file:`net_core_app_update.bin` (or :file:`dfu_application.zip`).
You can program the precompiled firmware image using one of the following ways:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can program the precompiled firmware image using one of the following ways:
You can program the precompiled firmware image in one of the following ways:

@greg-fer greg-fer force-pushed the doc_move_thingy53_gs_to_dev_section branch 2 times, most recently from 15fbef8 to f017ca8 Compare January 10, 2025 11:56
Copy link
Contributor

@umapraseeda umapraseeda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be updates required for the tags file.

The Nordic Thingy:53 is preprogrammed with Edge Impulse firmware.
The Edge Impulse firmware enables data collection from all the sensors on the Nordic Thingy:53.
You can use the collected data to train and test machine learning models.
Deploy the trained machine learning model to the Nordic Thingy:53 over Bluetooth LE or USB.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Deploy the trained machine learning model to the Nordic Thingy:53 over Bluetooth LE or USB.
Deploy the trained machine learning model to the Nordic Thingy:53 over Bluetooth® LE or USB.


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.

* Update the firmware over-the-air (OTA) using Bluetooth® LE and the nRF Programmer mobile application for Android or iOS.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Update the firmware over-the-air (OTA) using Bluetooth® LE and the nRF Programmer mobile application for Android or iOS.
* Update the firmware over-the-air (OTA) using Bluetooth LE and the nRF Programmer mobile application for Android or iOS.

@greg-fer greg-fer force-pushed the doc_move_thingy53_gs_to_dev_section branch from f017ca8 to 547dfc5 Compare January 13, 2025 07:41
@greg-fer greg-fer requested a review from a team as a code owner January 13, 2025 07:41
Copy link
Contributor

@divipillai divipillai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nits.

Firmware update using external debug probe
==========================================

You can program the firmware on the Nordic Thingy:53 using an external debug probe and 10-pin JTAG cable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can program the firmware on the Nordic Thingy:53 using an external debug probe and 10-pin JTAG cable.
You can program the firmware on the Nordic Thingy:53 using an external debug probe and a 10-pin JTAG cable.

Programming methods for Thingy:53
*********************************

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>`, or the `Programmer app <Programming Nordic Thingy:53_>`_ from nRF Connect for Desktop.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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>`, or the `Programmer app <Programming Nordic Thingy:53_>`_ from nRF Connect for Desktop.
You can program the firmware on the Nordic Thingy:53 using an external debug probe and a 10-pin JTAG cable, using :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.


* Update the firmware over-the-air (OTA) using Bluetooth® LE and the nRF Programmer mobile application for Android or iOS.
To use this method, the application that is currently programmed on Thingy:53 must support it.
For details, refer to :ref:`thingy53_app_fota_smp` section.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For details, refer to :ref:`thingy53_app_fota_smp` section.
For details, refer to the :ref:`thingy53_app_fota_smp` section.

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 <[email protected]>
@greg-fer greg-fer force-pushed the doc_move_thingy53_gs_to_dev_section branch from 547dfc5 to 2f4ed87 Compare January 13, 2025 12:24
@gmarull gmarull merged commit 962ac08 into nrfconnect:main Jan 13, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI-disable Disable CI for this PR doc only doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants