Merge pull request #244 from NordicSemiconductor/feat/nPM2100-support-custom-model-uploading

Feat/n pm2100 support custom model uploading

Author: kylebonnici

Changelog.md

@@ -1,5 +1,10 @@
 ## 2.2.3 - Unreleased
 
+### Added
+
+-   nPM2100: Uploading of custom battery models from the **Fuel Gauge** side
+    panel.
+
 ### Changed
 
 -   nPM2100: Setting the Boost regulator to the forced pass-through mode will

doc/docs/evaluating_battery.md

@@ -6,7 +6,7 @@ To start fuel gauge evaluations using a battery model, complete the following st
 
     - 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 and nPM1304: You have an active battery model selected in the [**Fuel Gauge**](./overview.md#npm1300-and-nPM1304-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 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>

doc/docs/overview.md

@@ -52,18 +52,18 @@ This side panel area contains the following buttons:
 | **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. |
 
-### nPM1300 and nPM1304: Fuel Gauge
+### Fuel Gauge
 
 !!! note "Note"
-     This feature is available for the nPM1300 EK and the nPM1304 EK.
+     The **Profile Battery** option is only available for the nPM1300 EK and the nPM1304 EK.
 
 This side panel area lets you select the following options:
 
 |               Menu               | Description |
 | -------------------------------- | ----------- |
 | **Active Battery Model**         | Select the battery model you want to use for Fuel Gauge in nPM PowerUP.        |
 | **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. The results are then saved in the [**Profiles**](#npm1300-and-npm1304-profiles-tab) tab and added to the **Add New Active Battery Model** drop-down menu.</br></br>Clicking the button opens a window where you can select several options for the battery profiling:<br/>![Profile Battery test configuration](./screenshots/battery_profiling.PNG "Profile Battery test configuration")<br/>See the tooltips for more information about each of the options.</br></br>To perform the battery profiling with the nPM1300 EK, you need the nPM Fuel Gauge Board. See [Profiling a battery with nPM PowerUP](profiling_battery.md) for more information. |
+| **Profile Battery**              | **This option is only available for nPM1300 and nPM1304 devices.**<br/><br/>Create your own, custom battery profile, and collect the data. The results are then saved in the [**Profiles**](#npm1300-and-npm1304-profiles-tab) tab and added to the **Add New Active Battery Model** drop-down menu.</br></br>Clicking the button opens a window where you can select several options for the battery profiling:<br/>![Profile Battery test configuration](./screenshots/battery_profiling.PNG "Profile Battery test configuration")<br/>See the tooltips for more information about each of the options.</br></br>To perform the battery profiling with the nPM1300 EK, you need the nPM Fuel Gauge Board. See [Profiling a battery with nPM PowerUP](profiling_battery.md) for more information. |
 
 ### nPM2100: Power Source
 
@@ -128,7 +128,7 @@ Some devices also allow you to configure **Power Failure** and **Vbus input curr
 !!! note "Note"
      This feature is available for the nPM1300 EK and the nPM1304 EK.
 
-The **Profiles** tab provides an overview of all battery profiles that you can select using the [Fuel Gauge drop-down menus](#npm1300-and-nPM1304-fuel-gauge).
+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.
 
@@ -137,15 +137,15 @@ Here you can make changes to the generated battery model settings, make edits to
 
 ### Custom profiles
 
-Here you can find all the custom profiles you have added with the [**Profile Battery** option](#npm1300-and-nPM1304-fuel-gauge).
+Here you can find all the custom profiles you have added with the [**Profile Battery** option](#fuel-gauge).
 
 The following options are available for the custom profiles:
 
 |          Button          |                                                              Description                                                               |
 | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
 | **Reload Projects**      | Refresh the list of projects and profiles.                                                                                             |
 | **Add Existing Project** | Add a new project to the list from a JSON file.                                                                                        |
-| **Create New Project**   | Create a new custom project template. This option includes some of the fields present when using the [**Profile Battery** option](#npm1300-and-nPM1304-fuel-gauge), but without collecting data. |
+| **Create New Project**   | Create a new custom project template. This option includes some of the fields present when using the [**Profile Battery** option](#fuel-gauge), but without collecting data. |
 
 The following drop-down menu options are available for the project and profile sections:
 
@@ -154,7 +154,7 @@ The following drop-down menu options are available for the project and profile s
 | **Process Included Data**| Project  | If your project includes multiple temperature profiles, you can include a selection of them with the **Include** toggle. Using this option processes only the included temperature profiles. |
 | **Save Battery Model**   | Project  | Save the battery model for the entire project to a JSON or an INC file. This only saves the temperature profiles you have selected with the **Include** toggle. |
 | **Write Battery Model**  | Project  | Write the battery model for the entire project to the nPM Controller on the EK. This only writes the temperature profiles you have selected with the **Include** toggle. |
-| **Add Profile**          | Project  | Add a new battery profile with a specific temperature and a CSV data file. Data files are generated when you use the [**Profile Battery** option](#npm1300-and-nPM1304-fuel-gauge). |
+| **Add Profile**          | Project  | Add a new battery profile with a specific temperature and a CSV data file. Data files are generated when you use the [**Profile Battery** option](#fuel-gauge). |
 | **Open Folder**          | Project  | Open the project directory in the **File Explorer**. |
 | **Edit Project**         | Project  | Edit the project settings.  |
 | **Remove Project**       | Project  | Remove the current project, including all battery profiles. |
@@ -170,7 +170,7 @@ The following drop-down menu options are available for the project and profile s
 Here you can write and save battery models from selected vendors that has been profiled by Nordic Semiconductor.
 
 When you **Write Model**, you are going to write new battery model on the nPM Controller to one of its available battery model slots.
-This can overwrite the [**Active Battery Model**](#npm1300-and-nPM1304-fuel-gauge).
+This can overwrite the [**Active Battery Model**](#fuel-gauge).
 
 When you **Save Model**, 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).
 

doc/docs/profiling_battery.md

@@ -25,7 +25,7 @@ Depending on the EK you are using:
 
 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}}:
 
-1. Click the [**Profile Battery**](overview.md#npm1300-and-npm1304-fuel-gauge) button in the side panel.
+1. Click the [**Profile Battery**](overview.md#fuel-gauge) button in the side panel.
 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).
 
     ![Profile Battery test configuration](./screenshots/battery_profiling.PNG "Profile Battery test configuration")
@@ -39,7 +39,7 @@ Complete the following steps to profile a battery and use the generated battery
     The measurement data is automatically processed in the Nordic battery modeling software to make a single battery model file for each test temperature.
 
 1. After the temperature profiling at a given temperature is complete, follow the instructions in the application to charge the battery at room temperature before profiling at the next test temperature. When all the individual temperature models have been completed, they are merged to generate the final battery model file. The final battery model is automatically saved as both a JSON file and an INC file.
-1. Select [**Add New Active Battery Model**](./overview.md#npm1300-and-nPM1304-fuel-gauge) in the side panel.</br>
+1. Select [**Add New Active Battery Model**](./overview.md#fuel-gauge) in the side panel.</br>
    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 the nPM1300 EK or the nPM1304 EK.