diff --git a/docs/about.rst b/docs/about.rst index a45260e6..a3c3f79c 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -10,8 +10,6 @@ About Thingy:91 X: Hello nRF Cloud firmware This project is based on the `NCS Example Application`_. The project contains the firmware that is programmed on the Thingy:91 X in the factory. -.. to do intro - LED indication ************** @@ -21,17 +19,17 @@ The following table describes the supported LED states: +----------------+------------+----------------------------------------------+-----------------------------------------------------+ | LED effect | Color | Meaning | Duration (seconds) | +================+============+==============================================+=====================================================+ -| Blinking | Yellow | Device is (re-)connecting to the LTE network | NA | +| Blinking | Yellow | Device is reconnecting to the LTE network | NA | +----------------+------------+----------------------------------------------+-----------------------------------------------------+ -| Blinking | Green | Location searching | NA | +| Blinking | Green | Searching for location | NA | +----------------+------------+----------------------------------------------+-----------------------------------------------------+ | Blinking slow | Blue | Device is actively polling cloud | 10 minutes after last config update or button press | +----------------+------------+----------------------------------------------+-----------------------------------------------------+ -| Solid | Configured | Device has received a LED configuration | NA | +| Solid | Configured | Device has received an LED configuration | NA | +----------------+------------+----------------------------------------------+-----------------------------------------------------+ | Blinking rapid | Red | Fatal error, the device will reboot | NA | +----------------+------------+----------------------------------------------+-----------------------------------------------------+ -| Blinking slow | Red | Irrecoverable Fatal error | NA | +| Blinking slow | Red | Irrecoverable fatal error | NA | +----------------+------------+----------------------------------------------+-----------------------------------------------------+ Interactive bill of materials (BOM) diff --git a/docs/architecture.rst b/docs/architecture.rst index 2522db6e..52bb0746 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -7,7 +7,7 @@ Firmware Architecture :local: :depth: 2 -This is the firmware that is programmed on the nRF9151 of the Thingy:91 X in the factory. +The firmware on the nRF9151 SiP of the Thingy:91 X is factory-programmed. It showcases the device's functionality if you like to try out the device. `nRF Cloud CoAP`_ is used as the cloud solution. @@ -70,9 +70,6 @@ Shell module Accessing of modules with ZBUS channels *************************************** -.. note:: - The ERROR channel and channels only used internally in modules are omitted. - The following table showcases the access of modules with different ZBUS channels: +--------------+---------+-------------+----------+---------+---------+-----+--------+------+-----+----------+-------+-----------+ @@ -98,3 +95,6 @@ The following table showcases the access of modules with different ZBUS channels +--------------+---------+-------------+----------+---------+---------+-----+--------+------+-----+----------+-------+-----------+ | TIME | R | R | | R | | W | | | R | | | | +--------------+---------+-------------+----------+---------+---------+-----+--------+------+-----+----------+-------+-----------+ + +.. note:: + The ERROR channel and channels only used internally in modules are omitted. diff --git a/docs/gsg_guide.rst b/docs/gsg_guide.rst index a2b26456..11db3c42 100644 --- a/docs/gsg_guide.rst +++ b/docs/gsg_guide.rst @@ -19,7 +19,7 @@ Before initializing, start the toolchain environment: nrfutil toolchain-manager launch -- -To initialize the workspace folder (:file:`hello-nrfcloud`) , where the ``firmware`` project and all nRF Connect SDK modules will be cloned, run the following commands: +To initialize the workspace folder (:file:`hello-nrfcloud`) where the ``firmware`` project and all nRF Connect SDK modules will be cloned, run the following commands: .. code-block:: @@ -37,12 +37,12 @@ To initialize the workspace folder (:file:`hello-nrfcloud`) , where the ``firmwa # Use sysbuild by default west config build.sysbuild True -Building and Running +Building and running ******************** Complete the following steps for building and running: -#. Change the folder: +#. Navigate to the project folder: .. code-block:: @@ -54,7 +54,7 @@ Complete the following steps for building and running: west build -b thingy91x/nrf9151/ns app -#. When using the serial bootloader, you can update using this command: +#. When using the serial bootloader, you can update the application using the following command: .. code-block:: @@ -66,12 +66,12 @@ Complete the following steps for building and running: west flash --erase -Experimental: You can also use `pyOCD`_ to flash the nRF9151 using the CMSIS-DAP interface provided by the connectivity bridge firmware. +Experimental: You can also use `pyOCD`_ to flash the nRF9151 SiP using the CMSIS-DAP interface provided by the connectivity bridge firmware. .. important:: Do not use pyOCD with JLink probes. - Use `nRF Util`_ or the west runner instead. + Use `nRF Util`_ or the West Runner instead. .. note:: @@ -101,7 +101,7 @@ Complete the following steps for programming: pyocd erase --mass Experimental: You can update the modem firmware using pyOCD. -To do this, use the following included ``nrf91_flasher`` script: +To do this, use the included ``nrf91_flasher`` script as follows: .. code-block:: diff --git a/docs/index.rst b/docs/index.rst index 6c7d67ad..d302ce64 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,8 +5,8 @@ Thingy:91 X: Hello nRF Cloud firmware The Hello nRF Cloud firmware is the official, factory-programmed firmware for the nRF9151 SiP on the Thingy:91 X device. -The application search for and connects to an LTE network and sends network and sensor data to nRF Cloud, using CoAP over UDP as transport protocol. -Sampled data that is sent from the application, can be viewed in the `hello.nrfcloud.com`_ web interface. +The application searches for and connects to an LTE network and sends network and sensor data to nRF Cloud, using CoAP over UDP as the transport protocol. +Sampled data that is sent from the application can be viewed in the `hello.nrfcloud.com`_ web interface. Some of the key features of the firmware include: @@ -21,8 +21,9 @@ The project repository is based on the `NCS Example Application`_ and customized Read more about the various aspects of the firmware in the following sections. .. toctree:: - :maxdepth: 2 - :caption: Subpages: + :maxdepth: 1 + :caption: Contents + :glob: about gsg_guide diff --git a/docs/release_notes.rst b/docs/release_notes.rst index cec3eb98..c0a3493d 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -7,5 +7,4 @@ Release notes :local: :depth: 2 -All the notable changes to the Hello nRF Cloud firmware are listed here. -Also, see the `release on GitHub `_ for detailed information. +For all the notable changes to the Hello nRF Cloud firmware, see the `release on GitHub `_. diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 8ddfd811..749ea38f 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -9,7 +9,7 @@ Troubleshooting The following section contains guidelines on how to troubleshoot issues with the device. -Modem Traces +Modem traces ************ Modem traces are enabled by default on the Thingy:91 X and continuously stored to external flash. @@ -17,22 +17,22 @@ You can output these traces to UART for analysis using the `Cellular Monitor app Complete the following steps to capture and dump modem traces: -#. Connect to a Serial Terminal. +#. Connect to a serial terminal. - #. Connect your Thingy:91 X to a serial terminal on UART 0. - This will allow you to interact with the device's shell commands. - #. You might need to push **Button 1** to wake the UART. + a. Connect your Thingy:91 X to a serial terminal on UART 0. + This allows interaction with the device’s shell commands. + You might need to push **Button 1** to wake the UART. -#. Set up the `Cellular Monitor app`_. +#. Set up modem tracing. - #. Open the app. + a. Open the `Cellular Monitor app`_. #. Connect the Thingy:91 X to the application, select UART 1 as the trace output, and click :guilabel:`Start Traces` to begin capturing modem activity. #. Dump traces through UART. - #. Ensure that the error scenario has been captured. + a. Ensure that the error scenario has been captured. The older traces will be overwritten by new ones when the flash buffer is full. - So, ensure that the issue you want to troubleshoot has occurred relatively recently of dumping the traces over UART. + So, ensure that the issue you want to troubleshoot has occurred relatively close to the dumping of the traces over UART. #. Use the following shell commands in the connected serial terminal to manage and dump the modem traces on UART 1: .. code-block:: none