Skip to content

Commit 87a79a5

Browse files
nordic-aukorlubos
authored andcommitted
doc: working_with_nrf: Add npm2100 pmic
Add "Developing with the nPM2100 PMIC" document to the list of "Developing with PMICs" guide document. Signed-off-by: Audun Korneliussen <audun.korneliussen@nordicsemi.no>
1 parent 63bee04 commit 87a79a5

File tree

4 files changed

+128
-1
lines changed

4 files changed

+128
-1
lines changed

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

+7
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ 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+
* - --
29+
- PCA10170
30+
- See :ref:`ug_npm2100_compatible_boards`
31+
- | `Datasheet <nPM2100 Datasheet_>`_
32+
- | `nPM2100 EK product page`_
33+
| `nPM2100 Power Management IC (PMIC) <nPM2100 product website_>`_
2834
2935
.. note::
3036
Despite being supported in Zephyr, the |NCS| does not support :ref:`zephyr:npm1100_ek` and :ref:`zephyr:npm6001_ek`.
@@ -34,3 +40,4 @@ Zephyr and the |NCS| provides support for developing applications with the follo
3440
:caption: Subpages:
3541

3642
npm1300
43+
npm2100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
.. _ug_npm2100_developing:
2+
.. _ug_npm2100_gs:
3+
4+
Developing with the nPM2100 PMIC
5+
################################
6+
7+
.. contents::
8+
:local:
9+
:depth: 2
10+
11+
The |NCS| provides support for development with the `nPM2100 Power Management IC (PMIC) <nPM2100 product website_>`_, using the `nPM2100 Evaluation Kit (PCA10170) <nPM2100 EK product page_>`_.
12+
13+
.. _ug_npm2100_features:
14+
15+
nPM2100 features
16+
****************
17+
18+
nPM2100 is a PMIC designed for primary (non-rechargeable) batteries in an extremely compact form factor.
19+
It has an ultra-efficient boost regulator, a dual purpose LDO/load switch, two GPIOs, an ADC, and other features.
20+
21+
nPM2100 is the perfect companion for nRF52, nRF53, and nRF54 Series SoCs.
22+
It is ideal for compact and advanced IoT products that uses primary cell batteries.
23+
24+
For additional information on the nPM2100 PMIC and associated kits, see the `nPM2100 product website`_ technical documentation, especially the `nPM2100 EK product page`_.
25+
26+
.. _ug_npm2100_compatible_boards:
27+
28+
Boards compatible with nPM2100
29+
******************************
30+
31+
The following boards in the `Zephyr`_ open source project and in the |NCS| are supported in the :ref:`pmic_samples`.
32+
These boards represent a subset of the boards that are compatible with nPM2100.
33+
34+
.. list-table::
35+
:header-rows: 1
36+
37+
* - DK or Prototype platform
38+
- Companion module
39+
- PCA number
40+
- Board target
41+
- Documentation
42+
* - :ref:`zephyr:nrf54l15dk_nrf54l15`
43+
- nPM2100 EK
44+
- PCA10156
45+
- ``nrf54l15dk/nrf54l15/cpuapp``
46+
- `User Guide <nRF54L15 DK User Guide_>`_
47+
* - :ref:`zephyr:nrf5340dk_nrf5340`
48+
- nPM2100 EK
49+
- PCA10095
50+
- ``nrf5340dk/nrf5340/cpuapp``
51+
- | `Product Specification <nRF5340 Product Specification_>`_
52+
| `Quick Start app`_
53+
| `User Guide <nRF5340 DK User Guide_>`_
54+
* - :ref:`zephyr:nrf52840dk_nrf52840`
55+
- nPM2100 EK
56+
- PCA10056
57+
- ``nrf52840dk/nrf52840``
58+
- | `Product Specification <nRF52840 Product Specification_>`_
59+
| `Quick Start app`_
60+
| `User Guide <nRF52840 DK User Guide_>`_
61+
62+
PMIC samples and libraries
63+
**************************
64+
65+
The |NCS| provides several :ref:`pmic_samples` that demonstrate the features and capabilities of nPM2100 using the nPM2100 EK.
66+
67+
The |NCS| also provides the :ref:`nrfxlib:nrf_fuel_gauge` that processes battery measurements made by PMICs and provides a state-of-charge (SOC) prediction, along with other metrics.
68+
:ref:`nrfxlib:nrf_fuel_gauge` also includes battery models for a number of common primary cell battery types, such as Alkaline AA, AAA, LR44, and Lithium-manganese dioxide coin cell CR2032 batteries.
69+
You can use these generic models directly in your application to calculate the state of charge of the battery connected to the PMIC.
70+
71+
See `Using the nPM2100 Fuel Gauge`_ for more information on how to use the :ref:`nrfxlib:nrf_fuel_gauge` in your application.
72+
73+
PMIC tools
74+
**********
75+
76+
The :ref:`nrfxlib:nrf_fuel_gauge` is supported by the `nPM PowerUP app`_ in `nRF Connect for Desktop`_.
77+
See `Connect and use the nPM2100 EK`_ section of the `nPM2100 EK product page`_ for more information.
78+
79+
.. _ug_npm2100_developing_overlay_import:
80+
81+
Importing an overlay from the nPM PowerUP app
82+
=============================================
83+
84+
The nPM PowerUP app from nRF Connect for Desktop supports exporting a full configuration of the nPM2100 EK in devicetree overlay format.
85+
You can use this exported overlay file to quickly configure the nPM2100 EK in your application.
86+
87+
If there is no overlay file for your project, include the file directly in your application folder with the name :file:`app.overlay`.
88+
If an overlay already exists, append the contents of the generated overlay to the existing file.
89+
For more information about devicetree overlays, see :ref:`zephyr:use-dt-overlays`.
90+
91+
.. _npm2100_building:
92+
93+
Building and programming for nPM2100
94+
************************************
95+
96+
There is no firmware for nPM2100 EK that you can build and program onto the PMIC.
97+
Instead, you need to connect a compatible development kit to the nPM2100 EK and program the DK with the firmware.
98+
99+
Connecting the development kit to nPM2100
100+
=========================================
101+
102+
If you are using the nRF52840 DK, nRF5340 DK, or nRF54L15 DK, follow the steps in `Connect and use the nPM2100 EK`_ in the `nPM2100 EK product page`_.
103+
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 <npm2100_fuel_gauge_wiring>` and :ref:`wiring for the One button sample <npm2100_one_button_wiring>`, respectively).
104+
105+
If you are using custom hardware, the wiring process is similar to the `ones for the nRF5x DKs <Connect and use the nPM2100 EK_>`_, but board-specific steps will be different.
106+
107+
.. note::
108+
Logic levels on the nPM2100 EK follow the nPM2100 boost regulator output voltage.
109+
There is no voltage level translation on the nPM2100 EK headers.
110+
To ensure proper communication between the nPM2100 EK and the development kit, the DK must be powered by the nPM2100 EK.
111+
Appropriate wiring for supported DKs is provided in the :ref:`pmic_samples` documentation.
112+
113+
Programming the development kit with nPM2100-compatible firmware
114+
================================================================
115+
116+
Follow the detailed instructions in the building and programming sections of the :ref:`pmic_samples` documentation to build the sample and flash it to a compatible DK.

doc/nrf/links.txt

+4
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,10 @@
343343
.. _`nPM1300 EK get started`: https://www.nordicsemi.com/Products/Development-hardware/nPM1300-EK/Get-started?lang=en#infotabs
344344

345345
.. _`nPM2100 product website`: https://www.nordicsemi.com/Products/nPM2100
346+
.. _`nPM2100 Datasheet`: https://docs.nordicsemi.com/bundle/ps_npm2100/page/keyfeatures_html5.html
347+
.. _`nPM2100 EK product page`: https://docs.nordicsemi.com/bundle/ug_npm2100_ek/page/UG/nPM2100_EK/intro/intro.html
348+
.. _`Connect and use the nPM2100 EK`: https://docs.nordicsemi.com/bundle/ug_npm2100_ek/page/UG/nPM2100_EK/connect_ek/connect_ek.html
349+
.. _`Using the nPM2100 Fuel Gauge`: https://docs.nordicsemi.com/bundle/nan_048/page/APP/nan_048/intro.html
346350

347351
.. _`nRF Desktop reference design page`: https://www.nordicsemi.com/Products/Reference-designs/nRF-Desktop
348352

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Developing with Front-End Modules
126126
Developing with PMICs
127127
=====================
128128

129-
|no_changes_yet_note|
129+
* Added the :ref:`ug_npm2100_developing` documentation.
130130

131131
Developing with custom boards
132132
=============================

0 commit comments

Comments
 (0)