Skip to content

Commit

Permalink
doc: fixes from _dev deployment check (#413)
Browse files Browse the repository at this point in the history
Implemented fixes to docs spotted on _dev.

Signed-off-by: Grzegorz Ferenc <[email protected]>
  • Loading branch information
greg-fer authored Dec 19, 2023
1 parent 6c52ce5 commit cd547e7
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 18 deletions.
2 changes: 1 addition & 1 deletion doc/docs/identifying_port.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The number and function of the serial ports depends on the selected device and the onboard application firmware.

The virtual serial ports on a Nordic Semiconductor Development Kit (DK) are indexed from zero. Your computer's operating system maps each of the device's virtual serial ports to a unique, persistent serial port identifier for the device and computer. nRFConnect for Desktop app lists the selected device's serial ports in ascending order of its virtual serial port index.
The virtual serial ports on a Nordic Semiconductor Development Kit (DK) are indexed from zero. Your computer's operating system maps each of the device's virtual serial ports to a unique, persistent serial port identifier for the device and computer. The nRF Connect for Desktop app lists the selected device's serial ports in ascending order of its virtual serial port index.

In the following example, the virtual serial ports indexed 0, 1, and 2 on the nRF9160 DK are mapped to serial ports 9, 12, and 10 respectively on the computer. See your product's hardware user guide for more information on the device's virtual serial ports and Universal Asynchronous Receiver/Transmitter (UART) interface settings.

Expand Down
4 changes: 2 additions & 2 deletions doc/docs/memfault_in_production.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

In a production environment, you can configure the application to send modem traces to Memfault. The trace files can be downloaded from Memfault for playback and analysis in Cellular Monitor.

For information on nRF Connect SDK samples showing how to send modem traces to Memfault, see [NCS Memfault configuration](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/libraries/debug/memfault_ncs.html#memfault).
For information on nRF Connect SDK samples showing how to send modem traces to Memfault, see [Memfault configuration](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/debug/memfault_ncs.html#configuration) in the nRF Connect SDK documentation.

See also [Memfault](https://memfault.com/).

!!! note "Note"
The Memfault shell is enabled by default, using the UART interface. If [AT Host](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/libraries/modem/at_host.html#lib-at-host) library and the Memfault module are enabled simultaneously, neither behave as expected, as they both require the same UART interface. You can use Modem Shell or AT Shell as an alternative to [AT Host](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/libraries/modem/at_host.html#lib-at-host).
The Memfault shell is enabled by default, using the UART interface. If [AT Host](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html) library and the Memfault module are enabled simultaneously, neither behave as expected, as they both require the same UART interface. You can use Modem Shell or AT Shell as an alternative to [AT Host](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html).
23 changes: 12 additions & 11 deletions doc/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,31 @@ Opens file explorer and allows you to select a trace file. Traces captured using

Opens file explorer and allows you to select an `.mtrace` or `.bin` file. The selected file is converted to Packet Capture Next Generation (PcapNG) format and displayed in Wireshark.

### After selection
## After selection

When a device is selected, **Cellular Monitor** tries to discover its capabilities. The side panel options are updated depending on the results.

## Start
- Starts tracing.
### Start

Starts tracing.

### Refresh dashboard

Extensively populates the dashboard fields by sending a set of recommended AT commands to your device. This button is available only if **Cellular Monitor** has identified either Modem Shell or [AT Host](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/libraries/modem/at_host.html#lib-at-host) on the device, and if you are tracing.
Extensively populates the dashboard fields by sending a set of recommended AT commands to your device. This button is available only if **Cellular Monitor** has identified either Modem Shell or [AT Host](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html) on the device, and if you are tracing.

### Open Serial Terminal

Opens the Serial Terminal application in a new window. You can view the modem dialog and logging information from your application and the RTOS here. See [nRF Connect for Desktop Serial Terminal User Guide](link) for more information on the application.
Opens the Serial Terminal application in a new window. You can view the modem dialog and logging information from your application and the RTOS here. See [nRF Connect for Desktop Serial Terminal User Guide](lhttps://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/index.html) for more information on the application.

### Connection Status

Displays the trace status. If you have enabled Modem Shell or [AT Host](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/libraries/modem/at_host.html#lib-at-host) and click **Refresh Dashboard**, the Connection Status is updated automatically. See [Capturing a Modem trace](link) for more information.
Displays the trace status. If you have enabled Modem Shell or [AT Host](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html) and click **Refresh Dashboard**, the Connection Status is updated automatically. See [Capturing a Modem trace](./capturing.md) for more information.

### Trace Database

The trace database is used to decode the raw modem trace. Each modem firmware version has a separate trace database. The trace database version must match the modem firmware version of the selected device.

If AT Host is enabled, choose **Autoselect**, and **Cellular Monitor** automatically selects the trace database version. If not, select the database whose version matches your modem firmware from the dropdown list of databases.
If [AT Host](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html) is enabled, choose **Autoselect**, and **Cellular Monitor** automatically selects the trace database version. If not, select the database whose version matches your modem firmware from the dropdown list of databases.

### Serial Port Trace Capture

Expand All @@ -61,19 +62,19 @@ Opens and displays trace data live in Wireshark when the trace is started.

### Program Device

Select and program precompiled sample applications and modem firmware to your device. The samples enable the trace and AT Host prerequisites for **Cellular Monitor**. Modem firmware supporting trace is available with all samples, and you can choose to program the modem or application firmware, or both. The modem firmware needs only to be programmed once.
Select and program precompiled sample applications and modem firmware to your device. The samples enable the trace and [AT Host](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html) prerequisites for **Cellular Monitor**. Modem firmware supporting trace is available with all samples, and you can choose to program the modem or application firmware, or both. The modem firmware needs only to be programmed once.

### Terminal Serial Port

The serial port used to send AT commands to your device if Modem Shell or [AT Host](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/libraries/modem/at_host.html#lib-at-host) is enabled. This is the port used by Serial Terminal. It is the first port in the dropdown list if your application firmware uses default settings.
The serial port used to send AT commands to your device if Modem Shell or [AT Host](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html) is enabled. This is the port used by Serial Terminal. It is the first port in the dropdown list if your application firmware uses default settings.

### Dashboard Tab and Packet Event Viewer

See [Viewing a Modem trace in Cellular Monitor](link).
See [Viewing a Modem trace in Cellular Monitor](./viewing.md).

### Certificate Manager Tab

See [Managing modem credentials](link).
See [Managing modem credentials](./managing_credentials.md).

## Log

Expand Down
6 changes: 3 additions & 3 deletions doc/docs/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Either **Program** one of the built-in sample apps and/or required modem firmwar

- The modem firmware must be at least version 1.3.3.
- The application firmware must use nRF Connect SDK version v2.0.1 or higher. The latest version is recommended.
- The application must enable modem trace over Universal Asynchronous Receiver/Transmitter (UART) using snippets. See [nRF Connect SDK nRF91 modem tracing with UART backend using snippets](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/device_guides/working_with_nrf/nrf91/nrf9160.html#nrf91-modem-trace-uart-snippet) for more information.
- The application must enable modem trace over Universal Asynchronous Receiver/Transmitter (UART) using snippets. See [nRF Connect SDK nRF91 modem tracing with UART backend using snippets](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/device_guides/working_with_nrf/nrf91/nrf9160.html#nrf91_modem_tracing_with_uart_backend_using_snippets) for more information.
- Your application must also include Modem Shell, the AT Host library, or AT Shell. See the following for more information.
- Enable the [AT Host](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/libraries/modem/at_host.html#lib-at-host) library using the Kconfig option `CONFIG_AT_HOST_LIBRARY` in the `prj.conf` file of your application. The library exposes the AT commands interface to the application and enables you to communicate with the modem using AT commands.
- Information on Modem Shell and AT Shell can be found in [nRF Connect SDK documentation](https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/index.html).
- Enable the [AT Host](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/modem/at_host.html) library using the Kconfig option `CONFIG_AT_HOST_LIBRARY` in the `prj.conf` file of your application. The library exposes the AT commands interface to the application and enables you to communicate with the modem using AT commands.
- Information on Modem Shell and AT Shell can be found in [nRF Connect SDK documentation](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html).

## Limitations

Expand Down
2 changes: 1 addition & 1 deletion doc/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These troubleshooting instructions can help you fix issues you might encounter i
Check Cellular Monitor's [Minimum requirements and limitations](./requirements.md).

## Trace data is not displayed or the file size does not increase
- Check the trace serial port used, see [Identifying trace serial port](./identifying_port.md).
- Check the trace serial port used. See [Identifying trace serial port](./identifying_port.md).
- The default UART trace settings are 1,000,000 baud rate, with hardware flow control enabled.

## Refresh Dashboard is greyed out
Expand Down

0 comments on commit cd547e7

Please sign in to comment.