doc: add documentation framework and basic docs #172

greg-fer · 2024-07-02T14:31:51Z

Added documentation framework files.
Added basic docs.
NCD-684.

Added documentation framework files. Added basic docs. NCD-684. Signed-off-by: Grzegorz Ferenc <[email protected]>

Edited style and formatting and tooltips for consistency. NCD-684. Signed-off-by: Grzegorz Ferenc <[email protected]>

kylebonnici · 2024-07-04T07:29:26Z

doc/docs/overview.md

+
+|          Button          | Description |
+| ------------------------ | ----------- |
+| **Export Configuration** | Export the PMIC configuration based on the nPM PowerUP application settings. You can save the configuration to an `.overlay` file for [use in the nRF Connect SDK](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/device_guides/pmic/npm1300.html#importing_an_overlay_from_npm_powerup) or to a JSON file for later use in nPM PowerUP.</br></br>You can also set the configuration before you select a device and export it to a file. |


Suggested change

| **Export Configuration** | Export the PMIC configuration based on the nPM PowerUP application settings. You can save the configuration to an `.overlay` file for [use in the nRF Connect SDK](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/device_guides/pmic/npm1300.html#importing_an_overlay_from_npm_powerup) or to a JSON file for later use in nPM PowerUP.You can also set the configuration before you select a device and export it to a file. |

| **Export Configuration** | Export the PMIC configuration based on the nPM PowerUP application settings. You can save the configuration to an `.overlay` file for [use in the nRF Connect SDK](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/device_guides/pmic/npm1300.html#importing_an_overlay_from_npm_powerup) or to a JSON file for later use in nPM PowerUP.You can also set the configuration before you select a device and export it to a file ( offline mode ). |

kylebonnici · 2024-07-04T07:30:08Z

doc/docs/overview.md

+|          Button          | Description |
+| ------------------------ | ----------- |
+| **Export Configuration** | Export the PMIC configuration based on the nPM PowerUP application settings. You can save the configuration to an `.overlay` file for [use in the nRF Connect SDK](https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/device_guides/pmic/npm1300.html#importing_an_overlay_from_npm_powerup) or to a JSON file for later use in nPM PowerUP.</br></br>You can also set the configuration before you select a device and export it to a file. |
+| **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.  |


Suggested change

| **Load Configuration** | Load the PMIC configuration from a JSON file and update all configurations accordingly.You can also load a configuration before you select a device. |

| **Load Configuration** | Load the PMIC configuration from a JSON file and update all configurations accordingly.You can also load a configuration without selecting a device ( offline mode ). |

kylebonnici · 2024-07-04T07:53:57Z

doc/docs/overview.md

+
+### Settings
+
+This side panel area lets you configure the reporting rate.


Suggested change

This side panel area lets you configure the reporting rate.

This side panel area lets you configure the reporting rate. This effect the frequency of the data on the graph pan, the battery status card and the Fuel Gauge car.

kylebonnici · 2024-07-04T07:55:59Z

doc/docs/overview.md

+!!! info "Tip"
+      Check the battery datasheet for the termination voltage and current limit values that you can set for your battery.
+
+Using the built-in battery models, you can get an estimated time-to-full and time-to-empty when charging or discharging a battery connected to the EK.


Suggested change

Using the built-in battery models, you can get an estimated time-to-full and time-to-empty when charging or discharging a battery connected to the EK.

Using the built-in battery models, you can get an estimated time-to-full and time-to-empty when charging or discharging a battery connected to the EK. This also provides a State of Charge in percentage (SOC)

kylebonnici · 2024-07-04T07:58:25Z

doc/docs/overview.md

+| ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| **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. This only writes the temperature profiles you have selected with the **Include** toggle. |


Suggested change

| **Write Battery Model** | Project | Write the battery model for the entire project to the nPM Controller. This only writes the temperature profiles you have selected with the **Include** toggle. |

| **Write Battery Model** | Project | Write the battery model to the nPM controller for the entire project to the nPM Controller. This only writes the temperature profiles you have selected with the **Include** toggle. |

kylebonnici · 2024-07-04T08:00:24Z

doc/docs/overview.md

+
+Here you write and save battery models from selected vendors that has been profiled by Nordic Semiconductor.
+
+When writing, you are going to write new firmware on the nPM Controller to one of its available battery model slots.


Suggested change

When writing, you are going to write new firmware on the nPM Controller to one of its available battery model slots.

When writing, you are going to write new battery model on the nPM Controller to one of its available battery model slots.

kylebonnici · 2024-07-04T08:01:51Z

doc/docs/overview.md

+When writing, you are going to write new firmware on the nPM Controller to one of its available battery model slots.
+This can overwrite the [**Active Battery Model**](#fuel-gauge).
+
+When saving, the battery model is saved in the INC file format in the selected directory. This file format is meant for integrating the battery model into your final application with a Nordic System on Chip (SoC).


Suggested change

When saving, the battery model is saved in the INC file format in the selected directory. This file format is meant for integrating the battery model into your final application with a Nordic System on Chip (SoC).

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

kylebonnici · 2024-07-04T08:03:44Z

doc/docs/overview.md

+
+## Graph tab
+
+After generating the battery model, you can use the **Graph** tab to evaluate the battery state-of-charge predictions in real time. Make sure the battery Fuel Gauge in the **Dashboard** tab or **Fuel Gauge** tab is enabled.


Suggested change

After generating the battery model, you can use the **Graph** tab to evaluate the battery state-of-charge predictions in real time. Make sure the battery Fuel Gauge in the **Dashboard** tab or **Fuel Gauge** tab is enabled.

Here you can monitors the state of the PMIC over the such as 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.

kylebonnici

Minor comments but approved otherwise :)

Signed-off-by: Grzegorz Ferenc <[email protected]>

greg-fer added documentation Improvements or additions to documentation. doc required This PR includes user-facing changes that need to be documented. labels Jul 2, 2024

greg-fer requested a review from kylebonnici July 2, 2024 14:31

greg-fer added 2 commits July 3, 2024 16:39

doc: add documentation framework and basic docs

3ba22ae

Added documentation framework files. Added basic docs. NCD-684. Signed-off-by: Grzegorz Ferenc <[email protected]>

tooltips: edit tooltip style and formatting

4981cd9

Edited style and formatting and tooltips for consistency. NCD-684. Signed-off-by: Grzegorz Ferenc <[email protected]>

greg-fer force-pushed the doc_add_documentation_framework branch from b7a7a7f to 4981cd9 Compare July 3, 2024 14:41

greg-fer marked this pull request as ready for review July 3, 2024 14:48

kylebonnici reviewed Jul 4, 2024

View reviewed changes

kylebonnici approved these changes Jul 4, 2024

View reviewed changes

greg-fer added 4 commits July 4, 2024 10:06

edits from Kyle

90e35cb

Signed-off-by: Grzegorz Ferenc <[email protected]>

more comments from Kyle

b1fadfc

Signed-off-by: Grzegorz Ferenc <[email protected]>

prettifier for readme

d9e953b

Signed-off-by: Grzegorz Ferenc <[email protected]>

nitpicks

9a9339b

Signed-off-by: Grzegorz Ferenc <[email protected]>

greg-fer merged commit efaa7d6 into main Jul 4, 2024
4 checks passed

greg-fer deleted the doc_add_documentation_framework branch July 4, 2024 09:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add documentation framework and basic docs #172

doc: add documentation framework and basic docs #172

greg-fer commented Jul 2, 2024 •

edited

Loading

kylebonnici Jul 4, 2024

kylebonnici Jul 4, 2024

kylebonnici Jul 4, 2024 •

edited

Loading

kylebonnici Jul 4, 2024 •

edited

Loading

kylebonnici Jul 4, 2024 •

edited

Loading

kylebonnici Jul 4, 2024

kylebonnici Jul 4, 2024

kylebonnici Jul 4, 2024

kylebonnici left a comment

	\| 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. \|
	\| Load Configuration \| Load the PMIC configuration from a JSON file and update all configurations accordingly.</br></br>You can also load a configuration without selecting a device ( offline mode ). \|


		### Settings

		This side panel area lets you configure the reporting rate.

	Using the built-in battery models, you can get an estimated time-to-full and time-to-empty when charging or discharging a battery connected to the EK.
	Using the built-in battery models, you can get an estimated time-to-full and time-to-empty when charging or discharging a battery connected to the EK. This also provides a State of Charge in percentage (SOC)

	\| Write Battery Model \| Project \| Write the battery model for the entire project to the nPM Controller. This only writes the temperature profiles you have selected with the Include toggle. \|
	\| Write Battery Model \| Project \| Write the battery model to the nPM controller for the entire project to the nPM Controller. This only writes the temperature profiles you have selected with the Include toggle. \|


		Here you write and save battery models from selected vendors that has been profiled by Nordic Semiconductor.

		When writing, you are going to write new firmware on the nPM Controller to one of its available battery model slots.

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


		## Graph tab

		After generating the battery model, you can use the Graph tab to evaluate the battery state-of-charge predictions in real time. Make sure the battery Fuel Gauge in the Dashboard tab or Fuel Gauge tab is enabled.

	After generating the battery model, you can use the Graph tab to evaluate the battery state-of-charge predictions in real time. Make sure the battery Fuel Gauge in the Dashboard tab or Fuel Gauge tab is enabled.
	Here you can monitors the state of the PMIC over the such as 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.

doc: add documentation framework and basic docs #172

doc: add documentation framework and basic docs #172

Conversation

greg-fer commented Jul 2, 2024 • edited Loading

kylebonnici Jul 4, 2024

Choose a reason for hiding this comment

kylebonnici Jul 4, 2024

Choose a reason for hiding this comment

kylebonnici Jul 4, 2024 • edited Loading

Choose a reason for hiding this comment

kylebonnici Jul 4, 2024 • edited Loading

Choose a reason for hiding this comment

kylebonnici Jul 4, 2024 • edited Loading

Choose a reason for hiding this comment

kylebonnici Jul 4, 2024

Choose a reason for hiding this comment

kylebonnici Jul 4, 2024

Choose a reason for hiding this comment

kylebonnici Jul 4, 2024

Choose a reason for hiding this comment

kylebonnici left a comment

Choose a reason for hiding this comment

greg-fer commented Jul 2, 2024 •

edited

Loading

kylebonnici Jul 4, 2024 •

edited

Loading

kylebonnici Jul 4, 2024 •

edited

Loading

kylebonnici Jul 4, 2024 •

edited

Loading