Skip to content

Commit 8378efa

Browse files
authored
Merge pull request #326 from NordicSemiconductor/doc_app_name_fix_npm
doc: remove app_name
2 parents 9705e6f + b85d64f commit 8378efa

File tree

7 files changed

+20
-21
lines changed

7 files changed

+20
-21
lines changed

doc/docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# {{app_name}}
1+
# nPM PowerUP app
22

3-
The {{app_name}} 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.
3+
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.
44

55
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.
66

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

99
## Supported devices
1010

11-
The {{app_name}} supports the following Power Management IC devices from Nordic Semiconductor:
11+
The nPM PowerUP app supports the following Power Management IC devices from Nordic Semiconductor:
1212

1313
| PMIC device | Documentation | Setup |
1414
|-------------|---------------|-------|
@@ -18,7 +18,7 @@ The {{app_name}} supports the following Power Management IC devices from Nordic
1818
| nPM Fuel Gauge Board | [nPM Fuel Gauge Board Hardware](https://docs.nordicsemi.com/bundle/ug_npm_fuel_gauge/page/UG/nPM_fuel_gauge/intro.html) | [Connect the nPM1300 EK with the nPM Fuel Gauge Board](https://docs.nordicsemi.com/bundle/nan_045/page/APP/nan_045/battery_profiling.html) |
1919

2020
!!! note "Note"
21-
Some features of the {{app_name}} are only available for specific devices.
21+
Some features of the nPM PowerUP app are only available for specific devices.
2222
In the documentation, such features are marked with notes that specify the supported device.
2323
When no note is present, the feature is available on all supported devices.
2424

doc/docs/installing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# Installing the {{app_name}}
1+
# Installing the nPM PowerUP app
22

33
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.

doc/docs/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Overview and user interface
22

3-
After starting the {{app_name}}, the main application window is displayed.
3+
After starting the nPM PowerUP app, the main application window is displayed.
44

55
!!! info "Tip"
66
This page provides only a general overview of the application UI. For detailed information, see each option's tooltip.
@@ -20,7 +20,7 @@ The available options and information change after you **Select Device**.
2020
Dropdown to list the PMIC devices attached to the computer.
2121

2222
!!! note "Note"
23-
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}}.
23+
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.
2424

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

doc/docs/profiling_battery.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
!!! note "Note"
44
This feature is available for the nPM1300 EK and the nPM1304 EK.
55

6-
Use the {{app_name}} together with the [nPM1300 Evaluation Kit (EK)](https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/intro.html) or the nPM1304 Evaluation Kit (EK) to profile your battery and generate a battery model.
6+
Use the nPM PowerUP app together with the [nPM1300 Evaluation Kit (EK)](https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/intro.html) or the nPM1304 Evaluation Kit (EK) to profile your battery and generate a battery model.
77

88
Once the battery model is extracted, you only need the PMIC and the SoC (or SiP) in your application to do fuel gauging.
99

@@ -21,9 +21,9 @@ Depending on the EK you are using:
2121
* The nPM Fuel Gauge Board is not required.
2222
* Connect the nPM1304 EK and download the software as described in [Connect the nPM1304 EK with nPM PowerUP](https://docs.nordicsemi.com/bundle/ug_npm1304_ek/page/UG/nPM1304_EK/use_ek_power_up.html).
2323

24-
## Profiling a battery in the {{app_name}}
24+
## Profiling a battery in the nPM PowerUP app
2525

26-
Complete the following steps to profile a battery and use the generated battery model to initialize and run the fuel gauge in the {{app_name}}:
26+
Complete the following steps to profile a battery and use the generated battery model to initialize and run the fuel gauge in the nPM PowerUP app:
2727

2828
1. Click the [**Profile Battery**](overview.md#fuel-gauge) button in the side panel.
2929
1. Enter the battery data and one or more temperatures for the profiling test. Provide the generic information about the selected battery. Refer to the battery datasheet for information. For further information on profiling, see [Guidelines for battery profiling](profiling_guidelines.md).
@@ -48,9 +48,9 @@ To start fuel gauge evaluations using a battery model, see [Evaluating a battery
4848

4949
All or some of the following files are generated as the result of profiling a battery:
5050

51-
* A JSON file for the combined temperature model, used for fuel gauge evaluations in the {{app_name}}
51+
* A JSON file for the combined temperature model, used for fuel gauge evaluations in the nPM PowerUP app
5252
* An INC file that you can use to integrate the battery model into your application
53-
* `profileSettings.json` that contains the {{app_name}} settings for the profiling process
53+
* `profileSettings.json` that contains the nPM PowerUP app settings for the profiling process
5454
* Directory for each battery profile, which includes the following files:
5555

5656
* CSV data file for the given profile and temperature, which can be used to [merge temperature profiles](./working_with_profiles.md)

doc/docs/profiling_guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
!!! note "Note"
44
Battery profiling is available for the nPM1300 EK and the nPM1304 EK.
55

6-
The guidelines in this section optimize the use of the {{app_name}} for [battery profiling](profiling_battery.md).
6+
The guidelines in this section optimize the use of the nPM PowerUP app for [battery profiling](profiling_battery.md).
77

88
- Before starting battery profiling, refer to the battery datasheet and ensure that the parameters are set correctly. This includes specification of the battery capacity, termination voltages, and any other relevant parameters provided in the datasheet.
99
- Ensure a solid, low-resistance battery connection to the EK. Make sure to use stable connectors. Poor contacts can cause profiling or model errors (or both).

doc/docs/working_with_profiles.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Working with profiles
22

3-
The {{app_name}} comes with the [**Profiles**](overview.md#npm1300-and-npm1304-profiles-tab) tab, where you can interact with the battery profiles you create as well as with pre-profiled and generic battery models.
3+
The nPM PowerUP app comes with the [**Profiles**](overview.md#npm1300-and-npm1304-profiles-tab) tab, where you can interact with the battery profiles you create as well as with pre-profiled and generic battery models.
44

55
!!! note "Note"
66
- This feature is available for the nPM1300 EK and the nPM1304 EK.
77
- You cannot use profiles for the nPM1300 EK with the nPM1304 EK and vice-versa.
88

99
## Merging temperature profiles
1010

11-
If you [profile the battery](profiling_battery.md) at each temperature individually, the {{app_name}} creates distinct CSV files for each temperature session. You can then combine these CSV files to create a comprehensive battery model that covers all individual temperature ranges.
11+
If you [profile the battery](profiling_battery.md) at each temperature individually, the nPM PowerUP app creates distinct CSV files for each temperature session. You can then combine these CSV files to create a comprehensive battery model that covers all individual temperature ranges.
1212

1313
Complete the following steps to merge individual temperature profiles into a single battery model:
1414

1515
1. Make sure you have the CSV files for the temperature profiles you want to merge.
16-
1. Open the **Profiles** tab in the {{app_name}}.
16+
1. Open the **Profiles** tab in the nPM PowerUP app.
1717
1. Click the **Create New Project** button from the custom profiles section.
1818

1919
![Create New Project option in the Profiles tab](./screenshots/npm_profiles_tab_custom_create_new.png "Create New Project option")
@@ -42,19 +42,19 @@ Complete the following steps to merge individual temperature profiles into a sin
4242

4343
![Include toggle](./screenshots/npm_profiles_tab_custom_include.png "Include toggle")
4444

45-
1. In the [**Project** drop-down menu](overview.md#project-section), click the **Process Included Data** button. The {{app_name}} will analyze the data from the individual profiles and generate a single battery model by merging the profiles for each included temperature.
45+
1. In the [**Project** drop-down menu](overview.md#project-section), click the **Process Included Data** button. The nPM PowerUP app will analyze the data from the individual profiles and generate a single battery model by merging the profiles for each included temperature.
4646

4747
![Processing started](./screenshots/npm_profiles_tab_custom_processing.png "Processing started")
4848

4949
1. After processing is complete for all temperatures, save the final model by selecting **Save Battery Model** in the [**Project** drop-down menu](overview.md#project-section). The model will include all temperature-specific data and can be saved as a single [INC or JSON](profiling_battery.md#profiling-output-files) file.
5050

5151
## Using pre-profiled battery models
5252

53-
The {{app_name}} includes bundled profiles from selected vendors that have been profiled by Nordic Semiconductor. These pre-profiled battery models provide ready-to-use configurations for common battery types.
53+
The nPM PowerUP app includes bundled profiles from selected vendors that have been profiled by Nordic Semiconductor. These pre-profiled battery models provide ready-to-use configurations for common battery types.
5454

5555
Complete the following steps to use a pre-profiled battery model:
5656

57-
1. Open the [**Profiles**](overview.md#npm1300-and-npm1304-profiles-tab) tab in the {{app_name}}.
57+
1. Open the [**Profiles**](overview.md#npm1300-and-npm1304-profiles-tab) tab in the nPM PowerUP app.
5858
1. Expand the **Bundled profiles** section.
5959

6060
![Bundled profiles section](./screenshots/npm_profiles_tab_bundled.png "Bundled profiles section")

doc/mkdocs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ plugins:
5353

5454
extra:
5555
test: This is a test abbreviation snippet
56-
app_name: nPM PowerUP app
5756

5857
nav:
5958
- Home: index.md

0 commit comments

Comments
 (0)