Skip to content

Commit 9950583

Browse files
nordic-aukonordicjm
nordic-auko
authored and
nordicjm
committed
doc: working_with_nrf: Add npm1304 pmic
Add "Developing with the nPM1304 PMIC" document to the list of "Developing with PMICs" guide document. Update links accordingly. Signed-off-by: Audun Korneliussen <[email protected]>
1 parent 685ac11 commit 9950583

File tree

5 files changed

+139
-4
lines changed

5 files changed

+139
-4
lines changed

‎doc/nrf/app_dev/device_guides/pmic/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ Zephyr and the |NCS| provides support for developing applications with the follo
2525
| `nPM1300 EK get started`_
2626
- | `nPM1300 EK product page`_
2727
| `nPM1300 Power Management IC (PMIC) <nPM1300 product website_>`_
28+
* - :ref:`zephyr:npm1304_ek`
29+
- PCA10195
30+
- See :ref:`ug_npm1304_compatible_boards`
31+
- | `Data sheet <nPM1304 Data sheet_>`_
32+
| `User Guide <nPM1304 EK User Guide_>`_
33+
| `nPM1304 EK get started`_
34+
- | `nPM1304 EK product page`_
35+
| `nPM1304 Power Management IC (PMIC) <nPM1304 product website_>`_
2836
* - `nPM2100 EK <nPM2100 EK User Guide_>`_
2937
- PCA10170
3038
- See :ref:`ug_npm2100_compatible_boards`
@@ -41,4 +49,5 @@ Zephyr and the |NCS| provides support for developing applications with the follo
4149
:caption: Subpages:
4250

4351
npm1300
52+
npm1304
4453
npm2100

‎doc/nrf/app_dev/device_guides/pmic/npm1304.rst

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
.. _ug_npm1304_developing:
2+
.. _ug_npm1304_gs:
3+
4+
Developing with the nPM1304 PMIC
5+
################################
6+
7+
.. contents::
8+
:local:
9+
:depth: 2
10+
11+
The |NCS| provides support for development with the `nPM1304 Power Management IC (PMIC) <nPM1304 product website_>`_, using the `nPM1304 Evaluation Kit (PCA10195) <nPM1304 EK product page_>`_.
12+
13+
.. _ug_npm1304_features:
14+
15+
nPM1304 features
16+
****************
17+
18+
nPM1304 is a PMIC with a linear-mode lithium-ion, lithium-polymer, and lithium ferro-phosphate battery charger.
19+
It has two dual-mode buck regulators, two dual purpose LDO/load switches, three LED drivers, and five GPIOs.
20+
21+
nPM1304 is the perfect companion for nRF52, nRF53, and the nRF54 Series SoCs.
22+
It is ideal for compact and advanced IoT products, such as wearables and portable medical applications.
23+
24+
For additional information on the nPM1304 PMIC and associated kits, see the `nPM1304`_ technical documentation, especially the `nPM1304 EK User Guide`_.
25+
26+
.. _ug_npm1304_compatible_boards:
27+
28+
Boards compatible with nPM1304
29+
******************************
30+
31+
The following boards in the `Zephyr`_ open source project and in the |NCS| are compatible with nPM1304 PMIC through the nPM1304 EK:
32+
33+
.. list-table::
34+
:header-rows: 1
35+
36+
* - DK or Prototype platform
37+
- Companion module
38+
- PCA number
39+
- Board target
40+
- Documentation
41+
* - :zephyr:board:`nrf54l15dk`
42+
- nPM1304 EK
43+
- PCA10156
44+
- | ``nrf54l15dk/nrf54l15/cpuapp``
45+
- | `Datasheet <nRF54L15 Datasheet_>`_
46+
| `Quick Start app`_
47+
| `User Guide <nRF54L15 DK User Guide_>`_
48+
* - :zephyr:board:`nrf5340dk`
49+
- nPM1304 EK
50+
- PCA10095
51+
- ``nrf5340dk/nrf5340/cpuapp``
52+
- | `Product Specification <nRF5340 Product Specification_>`_
53+
| `Quick Start app`_
54+
| `User Guide <nRF5340 DK User Guide_>`_
55+
* - :zephyr:board:`nrf52840dk`
56+
- nPM1304 EK
57+
- PCA10056
58+
- ``nrf52840dk/nrf52840``
59+
- | `Product Specification <nRF52840 Product Specification_>`_
60+
| `Quick Start app`_
61+
| `User Guide <nRF52840 DK User Guide_>`_
62+
* - :zephyr:board:`nrf52dk`
63+
- nPM1304 EK
64+
- PCA10040
65+
- ``nrf52dk/nrf52832``
66+
- | `Product Specification <nRF52832 Product Specification_>`_
67+
| `Quick Start app`_
68+
| `User Guide <nRF52 DK User Guide_>`_
69+
70+
PMIC samples and libraries
71+
**************************
72+
73+
The |NCS| provides several :ref:`pmic_samples` that demonstrate the features and capabilities of nPM1304 using the nPM1304 EK.
74+
The :ref:`nrfxlib:nrf_fuel_gauge` processes battery measurements made by PMICs and provides a state-of-charge (SOC) prediction, along with other metrics.
75+
76+
PMIC tools
77+
**********
78+
79+
The :ref:`nrfxlib:nrf_fuel_gauge` is supported by the `nPM PowerUP app`_ in `nRF Connect for Desktop`_.
80+
You can use this application together with the library to derive a battery model for your product.
81+
For this purpose, you can use the nPM1304 EK that characterizes the battery using an active load circuit.
82+
See `Evaluate nPM1304 using nPM PowerUP`_ in the `nPM1304 EK User Guide`_ for more information.
83+
84+
.. _ug_npm1304_developing_overlay_import:
85+
86+
Importing an overlay from the nPM PowerUP app
87+
=============================================
88+
89+
The `nPM PowerUP app`_ from `nRF Connect for Desktop`_ supports exporting a full configuration of the nPM1304 in devicetree overlay format.
90+
You can use this exported overlay file to quickly configure the nPM1304 in your application.
91+
92+
If there is no overlay file for your project, include the file directly in your :file:`app.overlay` in the application folder.
93+
If an overlay already exists, append the contents of the generated overlay to the existing file.
94+
95+
For more information about devicetree overlays, see :ref:`zephyr:use-dt-overlays`.
96+
97+
.. _npm1304_building:
98+
99+
Building and programming for nPM1304
100+
************************************
101+
102+
There is no firmware for nPM1304 that can be built and programmed onto the PMIC.
103+
104+
Instead, you need to connect the compatible development kit to nPM1304 and program that kit with the firmware.
105+
106+
Connecting the development kit to nPM1304
107+
=========================================
108+
109+
If you are using the nRF54L15 DK, follow the steps in `Use the nPM1304 EK with an nRF54L15 DK`_ in the `nPM1304 EK User Guide`_.
110+
For other Nordic Semiconductor kits, use the wiring steps in the documentation for :ref:`pmic_samples` as reference (:ref:`wiring for the Fuel gauge sample <npm13xx_fuel_gauge_wiring>` and :ref:`wiring for the One button sample <npm13xx_one_button_wiring>`, respectively).
111+
112+
If you are using custom hardware, the wiring process is similar to the `one for the nRF54L15 DK <Use the nPM1304 EK with an nRF54L15 DK_>`_, but board-specific steps are different.
113+
114+
Programming the development kit with nPM1304-compatible firmware
115+
================================================================
116+
117+
Follow the detailed instructions in the building and programming sections of the :ref:`pmic_samples` documentation to build the sample and flash it to the compatible DK.

‎doc/nrf/links.txt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,8 @@
351351
.. _`nPM1300 EK get started`: https://www.nordicsemi.com/Products/Development-hardware/nPM1300-EK/Get-started?lang=en#infotabs
352352

353353
.. _`nPM1304 product website`: https://www.nordicsemi.com/products/npm1304
354+
.. _`nPM1304 EK product page`: https://www.nordicsemi.com/Products/Development-hardware/nPM1304-EK
355+
.. _`nPM1304 EK get started`: https://www.nordicsemi.com/Products/Development-hardware/nPM1304-EK/Get-started?lang=en#infotabs
354356

355357
.. _`nPM2100 product website`: https://www.nordicsemi.com/Products/nPM2100
356358
.. _`nRF Desktop reference design page`: https://www.nordicsemi.com/Products/Reference-designs/nRF-Desktop
@@ -894,7 +896,14 @@
894896
.. _`nPM1300 EK User Guide`: https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/intro.html
895897
.. _`Evaluate nPM1300 using nPM PowerUP`: https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/npm_powerup.html
896898
.. _`Use the nPM1300 EK with an nRF5340 DK`: https://docs.nordicsemi.com/bundle/ug_npm1300_ek/page/UG/nPM1300_EK/using_nrf5340_DK.html
897-
.. _`Using the nPM1300 Fuel Gauge`: https://docs.nordicsemi.com/bundle/nan_045/page/APP/nan_045/intro.html
899+
.. _`Using the nPM1300 and nPM1304 Fuel Gauge`: https://docs.nordicsemi.com/bundle/nan_045/page/APP/nan_045/intro.html
900+
901+
.. _`nPM1304`: https://docs.nordicsemi.com/category/npm1304-category
902+
.. _`nPM1304 Data sheet`: https://docs.nordicsemi.com/bundle/ps_npm1304/page/keyfeatures_html5.html
903+
904+
.. _`nPM1304 EK User Guide`: https://docs.nordicsemi.com/bundle/ug_npm1304_ek/page/UG/nPM1304_EK/intro.html
905+
.. _`Evaluate nPM1304 using nPM PowerUP`: https://docs.nordicsemi.com/bundle/ug_npm1304_ek/page/UG/nPM1304_EK/use_ek_power_up.html
906+
.. _`Use the nPM1304 EK with an nRF54L15 DK`: https://docs.nordicsemi.com/bundle/ug_npm1304_ek/page/UG/nPM1304_EK/using_nrf54L15_dk.html
898907

899908
.. _`nRF21540 EK User Guide`: https://docs.nordicsemi.com/bundle/ug_nrf21540_ek/page/UG/nrf21540_DK/intro.html
900909

‎samples/pmic/native/npm13xx_fuel_gauge/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ nPM1300 and nPM1304: Fuel gauge
99

1010
The Fuel gauge sample demonstrates how to calculate the state of charge of a development kit battery using `nPM1300 <nPM1300 product website_>`_ or `nPM1304 <nPM1304 product website_>`_ and the :ref:`nrfxlib:nrf_fuel_gauge`.
1111

12-
For more information about fuel gauging with the nPM1300 or nPM1304, see `Using the nPM1300 Fuel Gauge`_.
12+
For more information about fuel gauging with the nPM1300 or nPM1304, see `Using the nPM1300 and nPM1304 Fuel Gauge`_.
1313

1414
Requirements
1515
************
@@ -18,7 +18,7 @@ The sample supports the following development kits:
1818

1919
.. table-from-sample-yaml::
2020

21-
The sample also requires an `nPM1300 EK <nPM1300 EK product page_>`_ or nPM1304 EK that you need to connect to the development kit as described in `Wiring`_.
21+
The sample also requires an `nPM1300 EK <nPM1300 EK product page_>`_ or an `nPM1304 EK <nPM1304 EK product page_>`_ that you need to connect to the development kit as described in `Wiring`_.
2222

2323
Overview
2424
********

‎samples/pmic/native/npm13xx_one_button/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The sample supports the following development kits:
1616

1717
.. table-from-sample-yaml::
1818

19-
The sample also requires an `nPM1300 EK <nPM1300 EK product page_>`_ or an nPM1304 EK that you need to connect to the development kit as described in `Wiring`_.
19+
The sample also requires an `nPM1300 EK <nPM1300 EK product page_>`_ or an `nPM1304 EK <nPM1304 EK product page_>`_ that you need to connect to the development kit as described in `Wiring`_.
2020

2121
Overview
2222
********

0 commit comments

Comments
 (0)