Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
6 changes: 2 additions & 4 deletions doc/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# nPM PowerUP app
# Get started

The nPM PowerUP app is a desktop application intended to work with the Power Management Integrated Circuit (PMIC) devices from Nordic Semiconductor to allow customers to quickly and efficiently evaluate the PMIC for their projects.

Once connected to an Evaluation Kit (EK), the app gives full control over the adjustable settings of the PMIC. Using the included battery models, you can also get an estimated time-to-full and time-to-empty when charging or discharging a battery connected to the EK.

The nPM PowerUP app is installed and updated using [nRF Connect for Desktop](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/index.html).

## Installing the nPM PowerUP app

For installation instructions, see [Installing nRF Connect for Desktop apps](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/installing_apps.html) in the nRF Connect for Desktop documentation.
For installation instructions, see [Installing nRF Connect for Desktop apps](https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/installing_apps.html).

## Supported devices

Expand Down
31 changes: 9 additions & 22 deletions doc/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,24 @@ After starting the nPM PowerUP app, the main application window is displayed.

![Example of a tooltip in nPM PowerUP](./screenshots/npm_tooltip_example.png "Example of a tooltip in nPM PowerUP")

## Common interface

This app uses the nRF Connect for Desktop UI framework. Shared UI elements such as **Select device**, **About** tab, and **Log** panel are described in the [Common user interface](https://docs.nordicsemi.com/bundle/swtools_docs/page/common_interface.html) documentation.

## Before selection

Before a device is selected, you can use the links in the **Instructions** to [buy a PMIC Evaluation Kit](https://www.nordicsemi.com/About-us/BuyOnline) or [read more about PMIC products from Nordic Semiconductor](https://www.nordicsemi.com/Products/Power-Management-ICs).

![nPM PowerUP application window](./screenshots/npm_overview_app.png "nPM PowerUP application window")

The available options and information change after you **Select Device**.

### Select Device

Dropdown to list the PMIC devices attached to the computer.
The available options and information change after you select a device.

!!! note "Note"
If you are using the nPM1300 EK, read [Connect the nPM1300 EK with nPM PowerUP](https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/use_ek_power_up.html) for information about the hardware setup required to use this device with the nPM PowerUP app.

#### Virtual device selection and offline mode actions
### Virtual device selection and offline mode actions

In **Select Device**, you can also select a virtual device.
In **Select device**, you can also select a virtual device.

![Select Devices with virtual devices listed](./screenshots/npm_select_device_virtual_menu.png "Select Devices with virtual devices listed")

Expand All @@ -50,7 +50,7 @@ This side panel area contains the following buttons:
| **Load Configuration** | Load the PMIC configuration from a JSON file and update all configurations accordingly.</br></br>You can also load a configuration before you select a device ([Offline Mode](#virtual-device-selection-and-offline-mode-actions)). |
| **Open Serial Terminal** | Open the [Serial Terminal app](https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/index.html) application in a separate window. Make sure to first [install the application](). |
| **Reset Device** | Reset the PMIC device and the nPM Controller. The PMIC default device configuration is restored. |
| **Record Events** | Record all terminal [log](#log) events to CSV files in a selected directory.<br/>You can share these files with Nordic Semiconductor if you encounter issues.<br/><br/>Recording events is automatically started when you [profile a battery](profiling_battery.md). |
| **Record Events** | Record all terminal [log](https://docs.nordicsemi.com/bundle/swtools_docs/page/common_interface.html#log) events to CSV files in a selected directory.<br/>You can share these files with Nordic Semiconductor if you encounter issues.<br/><br/>Recording events is automatically started when you [profile a battery](profiling_battery.md). |

### Fuel Gauge

Expand Down Expand Up @@ -83,7 +83,7 @@ This side panel area lets you configure the reporting rate. This can affect the

### Connection Status

You can check the connection status to the [device you selected](#select-device).
You can check the connection status to the [device you selected](https://docs.nordicsemi.com/bundle/swtools_docs/page/common_interface.html#select-device).

If no device is connected, the application works in the [Offline Mode](#virtual-device-selection-and-offline-mode-actions).

Expand Down Expand Up @@ -201,16 +201,3 @@ Here you can monitor the state of the PMIC, including voltage, current, system t
The monitoring can happen in real time after [profiling a battery](profiling_battery.md). You can use the **Live** toggle to enable or disable real time monitoring.

![nPM PowerUP graph example](./screenshots/npm_graph_example.png "nPM PowerUP graph example")

## Log

The Log panel allows you to view the most important log events, tagged with a timestamp. Each time you open the app, a new session log file is created. You can find the Log panel and its controls, below the main application Window.

- When troubleshooting, to view more detailed information than shown in the Log panel, use **Open log file** to open the current log file in a text editor.
- To clear the information currently displayed in the Log panel, use **Clear Log**. The contents of the log file are not affected.
- To hide or display the Log panel in the user interface, use **Show Log**.
- To freeze Log panel scrolling, use **Autoscroll Log**.

## About tab

You can view application information, restore defaults, access source code and documentation. You also can find information on the selected device, access support tools, send feedback, and enable verbose logging.
12 changes: 0 additions & 12 deletions doc/docs/revision_history.md

This file was deleted.

28 changes: 28 additions & 0 deletions doc/docs/revision_history.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
tool:
- name: nPM PowerUP app
link: true
sections:
- name: January 2026
entries:
- "Renamed the Home page to [Get started](./index.md)."
- "Removed the separate Installing the nPM PowerUP app page. This page is now a section of the Get started page."
- name: August 2025
entries:
- "Added the [Guidelines for battery profiling](./profiling_guidelines.md) page"
- "Updated documentation for the nPM1304 EK public launch"
- name: March 2025
entries:
- "Updated the [Overview and user interface](./overview.md) page for the nPM2100 EK public launch"
- name: January 2025
entries:
- "Added the [Application source code](./index.md#application-source-code) section on the [Home](./index.md) page"
- "Updated the list of supported devices for the nPM2100 EK limited customer sampling"
- name: December 2024
entries:
- "Moved the section about evaluating a battery model from the [Profiling a battery with nPM PowerUP](./profiling_battery.md) page to [its own page](./evaluating_battery.md)"
- name: September 2024
entries:
- "Added the [Profiling a battery with nPM PowerUP](./profiling_battery.md) page"
- name: July 2024
entries:
- "First release of the current documentation set"
1 change: 0 additions & 1 deletion doc/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,3 @@ nav:
- Evaluating a battery: evaluating_battery.md
- Working with profiles: working_with_profiles.md
- Guidelines for battery profiling: profiling_guidelines.md
- Revision history: revision_history.md