Skip to content

Commit

Permalink
doc: split documentation for Tau
Browse files Browse the repository at this point in the history
Split profiling_battery.md into two pages.
Added notes about features available for specific devices.
Updated overview.md with WIP info (TBD sections).
NCD-1113.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
  • Loading branch information
greg-fer committed Dec 4, 2024
1 parent 736c9de commit c998b13
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 22 deletions.
15 changes: 15 additions & 0 deletions doc/docs/evaluating_battery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Evaluating a battery model with nPM PowerUP

To start fuel gauge evaluations using a battery model, complete the following steps:

1. Make sure the following conditions are met:

- You have a battery connected to the EK.
- You have the **Fuel Gauge** setting enabled on the [**Dashboard**](./overview.md#dashboard-tab) tab.
- For nPM1300: You have an active battery model selected in the [**Fuel Gauge**](./overview.md#fuel-gauge) side panel, either using the **Active Battery Model** for a preloaded battery model or the **Add New Battery Model** > **Custom Model** for your own custom battery model from a JSON file.

1. Open the [**Graph**](./overview.md#graph-tab) tab.
1. Make sure the **Live** toggle is enabled.</br>
The graph will display the live State of Charge over time.

![nPM PowerUP graph during real time evaluation](./screenshots/battery_evaluation.png "nPM PowerUP graph during real time evaluation")
8 changes: 7 additions & 1 deletion doc/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ The {{app_name}} is installed and updated using [nRF Connect for Desktop](https:

## Supported devices

THe {{app_name}} supports the following Power Management IC devices from Nordic Semiconductor:
The {{app_name}} supports the following Power Management IC devices from Nordic Semiconductor:

- nPM2100 Evaluation Kit (EK)
- [nPM1300 Evaluation Kit (EK)](https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/intro.html) - 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 the nPM1300 EK with nPM PowerUP.
- [nPM Fuel Gauge Board](https://docs.nordicsemi.com/bundle/ug_npm_fuel_gauge/page/UG/nPM_fuel_gauge/intro.html) - Read [Connect the nPM1300 EK with the nPM Fuel Gauge Board](https://docs.nordicsemi.com/bundle/nan_045/page/APP/nan_045/battery_profiling.html) for information about the hardware setup required to use the nPM1300 Fuel Gauge Board together with nPM1300 EK and nPM PowerUP.

!!! note "Note"
Some features of the {{app_name}} are only available for specific devices.
In the documentation, such features are marked with notes that specify the supported device.
When no note is present, the feature is available on all supported devices.
34 changes: 32 additions & 2 deletions doc/docs/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview and user interface

After starting nPM PowerUP, the main application window is displayed.
After starting the {{app_name}}, the main application window is displayed.

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

Expand All @@ -20,7 +20,7 @@ Before a device is selected, the side panel contains the following buttons:
Dropdown to list the PMIC devices attached to the computer.

!!! note "Note"
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 the nPM1300 EK with nPM PowerUP.
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 {{app_name}}.

### Offline mode actions

Expand Down Expand Up @@ -48,6 +48,9 @@ This side panel area contains the following buttons:

### Fuel Gauge

!!! note "Note"
This feature is available for the nPM1300 EK.

This side panel area lets you select the following options:

| Menu | Description |
Expand All @@ -56,6 +59,20 @@ This side panel area lets you select the following options:
| **Add New Active Battery Model** | Select a battery from selected vendors that has been profiled by Nordic Semiconductor or your own custom battery model, added with the **Profile Battery** feature and saved in the [**Profiles**](#profiles-tab) tab. |
| **Profile Battery** | Create your own, custom battery profile, and collect the data. These are then saved in the [**Profiles**](#profiles-tab) tab and added to the **Add New Active Battery Model** drop-down menu.</br></br>An additional board, nPM Fuel Gauge, is required to perform the battery profiling. See [Profiling a battery with nPM PowerUP](profiling_battery.md) for more information. |

### Power Source

!!! note "Note"
This feature is available for the nPM2100 EK.

TBD

### Maximum Energy Extraction

!!! note "Note"
This feature is available for the nPM2100 EK.

TBD

### Settings

This side panel area lets you configure the reporting rate. This can affect the frequency of the data in the [**Graph**](#graph-tab) tab and on the **Battery Status** tile in the **Dashboard** and **Charger** tabs.
Expand All @@ -77,6 +94,9 @@ The **Dashboard** tab provides a quick look overview of the major PMIC settings

## Charger tab

!!! note "Note"
This feature is available for the nPM1300 EK.

You can use the options in the **Charger** tab to control and monitor the charging settings and status of the PMIC device.

!!! info "Tip"
Expand All @@ -100,6 +120,9 @@ You can use the options in the **System Features** tab to configure the **Reset

## Profiles tab

!!! note "Note"
This feature is available for the nPM1300 EK.

The **Profiles** tab provides an overview of all battery profiles that you can select using the [Fuel Gauge drop-down menus](#fuel-gauge).

Here you can make changes to the generated battery model settings, make edits to your custom projects, or merge individual temperature profiles.
Expand Down Expand Up @@ -146,6 +169,13 @@ This can overwrite the [**Active Battery Model**](#fuel-gauge).

When saving, the battery model is saved in the selected directory either to a JSON file that can be downloaded to the nPM Controller or to an INC file. The INC file format is meant for integrating the battery model into your final application with a Nordic System on Chip (SoC).

## MEE tab

!!! note "Note"
This feature is available for the nPM2100 EK.

TBD

## Graph tab

Here you can monitor the state of the PMIC, including the current voltage temperature and State of Charge (SOC). For SOC, make sure the battery Fuel Gauge in the **Dashboard** tab or **Fuel Gauge** tab is enabled.
Expand Down
22 changes: 4 additions & 18 deletions doc/docs/profiling_battery.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Profiling a battery with nPM PowerUP

!!! note "Note"
This feature is available for the nPM1300 EK.

Use the nPM PowerUP together with the [nPM1300 Evaluation Kit (EK)](https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/intro.html) and the [nPM Fuel Gauge Board](https://docs.nordicsemi.com/bundle/ug_npm_fuel_gauge/page/UG/nPM_fuel_gauge/intro.html) to profile your battery and generate a battery model.

The EK and the nPM Fuel Gauge Board are used to profile and generate the model. Once the battery model is extracted, you only need nPM1300 and the SoC (or SiP) in your application to do fuel gauging.
For the complete overview of the whole process, read the [Using the nPM1300 Fuel Gauge](https://docs.nordicsemi.com/bundle/nan_045/page/APP/nan_045/intro.html) application note.

## Generating a battery model

Complete the following steps to profile a battery and use the generated battery model to initialize and run the nPM1300 fuel gauge in the nPM PowerUP app:

1. Connect the nPM Fuel Gauge Board to the nPM1300 Evaluation Kit (EK) at the edge connectors **P20** and **P21** (denoted as **EXT BOARD** on the EK).
Expand All @@ -29,19 +30,4 @@ Complete the following steps to profile a battery and use the generated battery
A drop-down menu appears.
1. Select **Custom Model** to load the generated JSON battery model file to the host System on Chip (SoC) of nPM1300 EK.

## Evaluating a battery model

To start fuel gauge evaluations using a battery model, complete the following steps:

1. Make sure the following conditions are met:

- You have a battery connected to the EK.
- You have an active battery model selected in the [**Fuel Gauge**](./overview.md#fuel-gauge) side panel, either using the **Active Battery Model** for a preloaded battery model or the **Add New Battery Model** > **Custom Model** for your own custom battery model from a JSON file.
- You have the **Fuel Gauge** setting enabled on the [**Dashboard**](./overview.md#dashboard-tab) tab.

1. Open the [**Graph**](./overview.md#graph-tab) tab.
1. Make sure the **Live** toggle is enabled.</br>
The graph will display the live State of Charge over time.

![nPM PowerUP graph during real time evaluation](./screenshots/battery_evaluation.png "nPM PowerUP graph during real time evaluation")

To start fuel gauge evaluations using a battery model, see [Evaluating a battery model with nPM PowerUP](evaluating_battery.md).
3 changes: 2 additions & 1 deletion doc/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,5 @@ nav:
- Home: index.md
- Installing the nPM PowerUP app: installing.md
- Overview and user interface: overview.md
- Profiling a battery with nPM PowerUP: profiling_battery.md
- Profiling a battery: profiling_battery.md
- Evaluating a battery: evaluating_battery.md

0 comments on commit c998b13

Please sign in to comment.