Merge pull request #287 from NordicSemiconductor/doc_combining_battery_profiles

doc: guide for merging temp profiles

Author: greg-fer

doc/docs/evaluating_battery.md

@@ -2,11 +2,17 @@
 
 To start fuel gauge evaluations using a battery model, complete the following steps:
 
-1. Make sure the following conditions are met:
+1. Connect a battery to the EK.
+1. Enable the **Fuel Gauge** setting on the [**Dashboard**](./overview.md#dashboard-tab) tab.
+1. If you are using nPM1300 EK or nPM1304 EK, select the battery model for evaluation in the [**Fuel Gauge**](./overview.md#npm1300-and-nPM1304-fuel-gauge) side panel.<br/>
+   Use one of the following options:
 
-    - You have a battery connected to the EK.
-    - You have the **Fuel Gauge** setting enabled on the [**Dashboard**](./overview.md#dashboard-tab) tab.
-    - 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.
+    * Use the **Active Battery Model** for a preloaded battery model
+    * Add a custom battery model by completing the following steps:
+
+        1. Select [**Add New Active Battery Model**](./overview.md#npm1300-and-nPM1304-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 PMIC EK.
 
 1. Open the [**Graph**](./overview.md#graph-tab) tab.
 1. Make sure the **Live** toggle is enabled.</br>

doc/docs/index.md

@@ -12,7 +12,7 @@ The {{app_name}} supports the following Power Management IC devices from Nordic
 
 | PMIC device | Documentation | Setup |
 |-------------|---------------|-------|
-| nPM1304 Evaluation Kit (EK) | *Not yet available* | *Not yet available* |
+| nPM1304 Evaluation Kit (EK) | [nPM1304 EK Hardware](https://docs.nordicsemi.com/bundle/ug_npm1304_ek/page/UG/nPM1304_EK/intro.html) | [Connect the nPM1304 EK with nPM PowerUP](https://docs.nordicsemi.com/bundle/ug_npm1304_ek/page/UG/nPM1304_EK/use_ek_power_up.html) |
 | nPM2100 Evaluation Kit (EK) | [nPM2100 EK Hardware](https://docs.nordicsemi.com/bundle/ug_npm2100_ek/page/UG/nPM2100_EK/intro/intro.html) | [Connect the nPM2100 EK with nPM PowerUP](https://docs.nordicsemi.com/bundle/ug_npm2100_ek/page/UG/nPM2100_EK/connect_ek/use_ek_power_up.html) |
 | nPM1300 Evaluation Kit (EK) | [nPM1300 EK Hardware](https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/intro.html) | [Connect the nPM1300 EK with nPM PowerUP](https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/use_ek_power_up.html) |
 | 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) |

doc/docs/overview.md

@@ -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. |
+| **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). |
 
 ### Fuel Gauge
 
@@ -126,11 +126,14 @@ Some devices also allow you to configure **Power Failure** and **Vbus input curr
 ## nPM1300 and nPM1304: Profiles tab
 
 !!! note "Note"
-     This feature is available for the nPM1300 EK and the nPM1304 EK.
+     - This feature is available for the nPM1300 EK and the nPM1304 EK.
+     - You cannot use profiles for the nPM1300 EK with the nPM1304 EK and vice-versa.
 
 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.
+![Profiles tab](./screenshots/npm_profiles_tab.png "Profiles tab")
+
+Here you can make changes to the generated battery model settings, make edits to your custom projects, or merge individual temperature profiles. See [Working with profiles](working_with_profiles.md) for more information.
 
 !!! note "Note"
       The battery model is automatically stored as a JSON and an INC file. Use the JSON file for evaluations in nPM PowerUP and the INC file when integrating the battery model into your final application with a Nordic System on Chip (SoC).
@@ -139,6 +142,8 @@ Here you can make changes to the generated battery model settings, make edits to
 
 Here you can find all the custom profiles you have added with the [**Profile Battery** option](#fuel-gauge).
 
+![Custom profiles in the Profiles tab](./screenshots/npm_profiles_tab_custom.png "Custom profiles in the Profiles tab")
+
 The following options are available for the custom profiles:
 
 |          Button          |                                                              Description                                                               |
@@ -147,27 +152,42 @@ The following options are available for the custom 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](#fuel-gauge), but without collecting data. |
 
-The following drop-down menu options are available for the project and profile sections:
-
-|          Button          | Area     |                                                             Description                                                       |
-| ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
-| **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](#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. |
-| **Include** toggle       | Profile  | Select the temperatures to be included for processing with **Process Included Data** button for the entire project. |
-| **Process Data**         | Profile  | Process the data for the given temperature profile only. |
-| **Save Battery Model**   | Profile  | Save the battery model to a JSON or an INC file. |
-| **Write Battery Model**  | Profile  | Write the battery model to the nPM Controller on the EK. |
-| **Edit Profile**         | Profile  | Edit the battery profile. |
-| **Remove Profile**       | Profile  | Remove the battery profile.|
+#### Project section
+
+![Project section options in the Profiles tab](./screenshots/npm_profiles_tab_custom_project.png "Project section options in the Profiles tab")
+
+The following drop-down menu options are available for the project section:
+
+|          Button          |                                                             Description                                                       |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
+| **Process Included Data**| 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**   | 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**  | 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**          | 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). |
+| **Open Folder**          | Open the project directory in the **File Explorer**. |
+| **Edit Project**         | Edit the project settings.  |
+| **Remove Project**       | Remove the current project, including all battery profiles. |
+
+##### Profile entries
+
+![Profile options in the Profiles tab](./screenshots/npm_profiles_tab_custom_profile.png "Profile options in the Profiles tab")
+
+The following drop-down menu options are available for the profile entries:
+
+|          Button          |                                                             Description                                                       |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
+| **Include** toggle       | Select the temperatures to be included for processing with **Process Included Data** button for the entire project. |
+| **Process Data**         | Process the data for the given temperature profile only. |
+| **Save Battery Model**   | Save the battery model to a JSON or an INC file. |
+| **Write Battery Model**  | Write the battery model to the nPM Controller on the EK. |
+| **Edit Profile**         | Edit the battery profile. |
+| **Remove Profile**       | Remove the battery profile.|
 
 ### Bundled profiles
 
-Here you can write and save battery models from selected vendors that has been profiled by Nordic Semiconductor.
+Here you can write and save battery models from selected vendors that have been profiled by Nordic Semiconductor.
+
+![Bundled profiles in the Profiles tab](./screenshots/npm_profiles_tab_bundled.png "Bundled profiles in the Profiles tab")
 
 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**](#fuel-gauge).

doc/docs/profiling_battery.md

@@ -19,7 +19,7 @@ Depending on the EK you are using:
 * nPM1304 EK:
 
     * The nPM Fuel Gauge Board is not required.
-    * Connect the nPM1304 EK and download the software.
+    * 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).
 
 ## Profiling a battery in the {{app_name}}
 
@@ -38,9 +38,21 @@ 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#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.
+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.
 
 To start fuel gauge evaluations using a battery model, see [Evaluating a battery model with nPM PowerUP](evaluating_battery.md).
+
+## Profiling output files
+
+All or some of the following files are generated as the result of profiling a battery:
+
+* A JSON file for the combined temperature model, used for fuel gauge evaluations in the {{app_name}}
+* An INC file that you can use to integrate the battery model into your application
+* `profileSettings.json` that contains the {{app_name}} settings for the profiling process
+* Directory for each battery profile, which includes the following files:
+
+    * CSV data file for the given profile and temperature, which can be used to [merge temperature profiles](./working_with_profiles.md)
+    * Debug directory that includes debugging files with information about the profiling process, such as profiling commands and logs, and about the functioning of the app.<br/>
+      You can share these files with Nordic Semiconductor if you encounter issues while profiling. You can also manually create these files with the [**Record Events**](overview.md#record-events) button in the side panel, but the contents might be different when not profiling.

doc/docs/profiling_guidelines.md

@@ -6,12 +6,21 @@
 The guidelines in this section optimize the use of the {{app_name}} for [battery profiling](profiling_battery.md).
 
 - 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.
+- 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).
+
+    !!! info "Tip"
+        For batteries without leads (pads only, for example smart-ring batteries), solder them directly to the nPM1304 EK Battery pads. For more information, see the [Power supply](https://docs.nordicsemi.com/bundle/ug_npm1304_ek/page/UG/nPM1304_EK/power_supply.html) chapter in the nPM1304 EK hardware user guide.
+
 - Due to the increased non-linearities of batteries operating at temperatures below zero degrees Celsius, it is recommended to conduct battery profiling exclusively above zero degrees. Avoid profiling at temperatures below freezing or in extreme heat conditions.
 
     !!! note "Note"
         Even if the battery is profiled at temperatures above zero Celsius, the fuel gauge can still perform reliably below zero within the standard discharge conditions of the battery.
 
 - To account for temperature variations and improve the accuracy of state-of-charge estimations, profile the battery at three different test temperatures. For example, if the operating temperature of the device ranges from -15°C to 45°C, you can profile the battery at 5°C, 25°C, and 45°C. The final battery model will be created by combining the individual temperature profiles.
+
+    !!! note "Note"
+        You can also profile the battery at each temperature separately and then use the nPM PowerUP [**Profiles**](./overview.md#npm1300-and-npm1304-profiles-tab) tab to merge the individual models into a single multi-temperature model. For details, see [Working with profiles](working_with_profiles.md).
+
 - The time to profile the battery takes approximately 48 hours per temperature, but can be longer for higher capacity batteries. Do not modify the device configuration during the profiling process as this causes the profiling to abort.
 - Ensure that your computer does not go into sleep mode or hibernate during the profiling process.
 - To avoid issues with computer restarting due to system updates, the computer can be put in flight mode during profiling.