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: update for v0.3.0 #98

Merged
merged 3 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ When you select a device, the following actions become available in the side pan
- **Write config** - Writes the selected configurations to the development kit, overwriting the defaults.
- **Load default config** - Loads the default configuration settings into the application UI for the selected device. It does not write anything to the development kit.

## Board controller info

This side panel area lists advanced information about the board controller configuration:

* **DK Hardware Revision** - Version of the selected device.
* **Board Controller FW version** - Version of the Interface MCU firmware that you are going to [configure](updating.md).
* **Pin Configuration** - List of available GPIO pins, with their respective pin number. Depending on the connected device and its hardware design, different pins are connected to different features.

!!! note "Note"
Some of the pins on the list are inverted (active low). This is indicated by the forward slash (`/`). Enabling such pins might disable a setting in the **Configuration** tab, and vice-versa. For example, disabling **Software Debugger** on the nRF9161 DK will enable the `swd-control` pin in the **Pin Configuration**.

* **PMIC Configuration** - List of the BUCK output ports available for configuration. These correspond to the **nPM VUOT** settings in the **Configuration** tab.
* **Show Config JSON** - Click to open the JSON array that lets you review the configuration sent to the board controller. You can copy the configuration to use it in [nRF Util](https://docs.nordicsemi.com/bundle/nrfutil/page/README.html) using the `nrfutil device x-boardcontroller-program` command.
Copy link
Contributor

Choose a reason for hiding this comment

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

the x-boardcontroller-program is actually to DFU the imcu with a new board controller firmware. The command we're using to configure the bctl is x-execute-batch or x-execute. This is not very user friendly, but the ones needing it will probably understand.


## Configuration tab

In the **Configuration** tab, you can see the options that are configurable for the selected development kit.
Expand Down
15 changes: 8 additions & 7 deletions doc/docs/revision_history.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

| Date | Description |
|------------|---------------|
| 2024-03-22 | Updated documentation for the experimental [v0.2.0](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md) of the application: Removed revision number next to the nRF9161 DK on the list of supported devices, given the support for the revision v1.0.0. |
| 2024-03-20 | Updated documentation for the experimental [v0.1.12](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md) of the application. |
| 2024-03-07 | Updated documentation for the experimental [v0.1.9](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md) of the application. |
| 2024-03-05 | Updated documentation for the experimental [v0.1.8](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md) of the application. |
| 2024-02-21 | Added the nRF9151 DK to the list of supported devices with the release of [v0.1.6](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md) of the application. |
| 2024-02-15 | Updated documentation for the experimental [v0.1.4](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md) of the application. |
| 2024-01-15 | First release, for the experimental [v0.1.0](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md) of the application. |
| 2024-04-11 | Updated documentation for the experimental [v0.3.0](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md): Updates to the [Overview](overview.md) page. |
| 2024-03-22 | Updated documentation for the experimental [v0.2.0](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md): Removed revision number next to the nRF9161 DK on the list of supported devices, given the support for the revision v1.0.0. |
| 2024-03-20 | Updated documentation for the experimental [v0.1.12](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md). |
| 2024-03-07 | Updated documentation for the experimental [v0.1.9](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md). |
| 2024-03-05 | Updated documentation for the experimental [v0.1.8](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md). |
| 2024-02-21 | Added the nRF9151 DK to the list of supported devices with the release of [v0.1.6](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md). |
| 2024-02-15 | Updated documentation for the experimental [v0.1.4](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md). |
| 2024-01-15 | First release, for the experimental [v0.1.0](https://github.com/NordicSemiconductor/pc-nrfconnect-board-configurator/blob/main/Changelog.md). |
Binary file modified doc/docs/screenshots/board_configurator_connected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion doc/docs/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ To update the configuration of a development kit, complete the following steps:
1. Configure the settings in the [**Configuration**](./overview.md#configuration-tab) tab.

!!! note "Note"
Some options are interdependable. For example, if the VCOM is disconnected, the Hardware Flow Control will automatically be disconnected too.
- Some options are interdependable. For example, if the VCOM is disconnected, the Hardware Flow Control will automatically be disconnected too.
- Advanced users can also configure some of the settings by toggling pins in the [**Pin Configuration**](overview.md#board-controller-info) section.

1. Click [**Write config**](./overview.md#actions) to upload the config to the device.</br>
The application overwrites the default board controller configuration with the updated settings.
Expand Down