Skip to content

Commit a0a6705

Browse files
nordic-aukonordic-auko
committed
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 e4a9869 commit a0a6705

File tree

2 files changed

+140
-0
lines changed

2 files changed

+140
-0
lines changed

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

+8
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:npm2100_ek`
29+
- PCA10170
30+
- See :ref:`ug_npm2100_compatible_boards`
31+
- | `Product Specification <nPM2100 Product Specification_>`_
32+
| `User Guide <nPM2100 EK User Guide_>`_
33+
| `nPM2100 EK get started`_
34+
- | `nPM2100 EK product page`_
35+
| `nPM2100 Power Management IC (PMIC) <nPM2100 product website_>`_
2836
2937
.. note::
3038
Despite being supported in Zephyr, the |NCS| does not support :ref:`zephyr:npm1100_ek` and :ref:`zephyr:npm6001_ek`.

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

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
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 (PCA10152) <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`_ technical documentation, especially the `nPM2100 EK User Guide`_.
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 compatible with nPM2100 PMIC through the nPM2100 EK:
32+
33+
OPEN QUESTION: Should we only list boards that we have overlays for in the samples, even though all nRF5 SoCs would support the PMIC if given an overlay?
34+
35+
.. list-table::
36+
:header-rows: 1
37+
38+
* - DK or Prototype platform
39+
- Companion module
40+
- PCA number
41+
- Board target
42+
- Documentation
43+
* - :ref:`zephyr:nrf54h20dk_nrf54h20`
44+
- nPM2100 EK
45+
- PCA10175
46+
- | ``nrf54h20dk_nrf54h20_cpuapp``
47+
| ``nrf54h20dk_nrf54h20_cpurad``
48+
| ``nrf54h20dk_nrf54h20_cpuppr``
49+
- | `Objective Product Specification <nRF54H20 Objective Product Specification 0.3.1_>`_
50+
| :ref:`Getting started <ug_nrf54h20_gs>`
51+
* - :ref:`zephyr:nrf54l15dk_nrf54l15`
52+
- nPM2100 EK
53+
- PCA10156
54+
- | ``nrf54l15dk/nrf54l15/cpuapp``
55+
- --
56+
* - :ref:`zephyr:nrf5340dk_nrf5340`
57+
- nPM2100 EK
58+
- PCA10095
59+
- ``nrf5340dk/nrf5340/cpuapp``
60+
- | `Product Specification <nRF5340 Product Specification_>`_
61+
| `Quick Start app`_
62+
| `User Guide <nRF5340 DK User Guide_>`_
63+
* - :ref:`zephyr:nrf52840dk_nrf52840`
64+
- nPM2100 EK
65+
- PCA10056
66+
- ``nrf52840dk/nrf52840``
67+
- | `Product Specification <nRF52840 Product Specification_>`_
68+
| `Quick Start app`_
69+
| `User Guide <nRF52840 DK User Guide_>`_
70+
* - :ref:`zephyr:nrf52dk_nrf52832`
71+
- nPM2100 EK
72+
- PCA10040
73+
- ``nrf52dk/nrf52832``
74+
- | `Product Specification <nRF52832 Product Specification_>`_
75+
| `Quick Start app`_
76+
| `User Guide <nRF52 DK User Guide_>`_
77+
78+
PMIC samples and libraries
79+
**************************
80+
81+
The |NCS| provides several :ref:`pmic_samples` that demonstrate the features and capabilities of nPM2100 using the nPM2100 EK.
82+
83+
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.
84+
: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.
85+
These generic models can be used directly in your application to calculate the state of charge of the battery connected to the PMIC.
86+
87+
PMIC tools
88+
**********
89+
90+
The :ref:`nrfxlib:nrf_fuel_gauge` is supported by the `nPM PowerUP app`_ in `nRF Connect for Desktop`_.
91+
See `Evaluate nPM2100 using nPM PowerUP`_ in the `nPM2100 EK User Guide`_ for more information.
92+
93+
.. _ug_npm2100_developing_overlay_import:
94+
95+
Importing an overlay from the nPM PowerUP app
96+
=============================================
97+
98+
The nPM PowerUP app from nRF Connect for Desktop supports exporting a full configuration of the nPM2100 in devicetree overlay format.
99+
You can use this exported overlay file to quickly configure the nPM2100 in your application.
100+
101+
If there is no overlay file for your project, include the file directly in your application folder with the name :file:`app.overlay`.
102+
103+
If an overlay already exists, append the contents of the generated overlay to the existing file.
104+
105+
For more information about devicetree overlays, see :ref:`zephyr:use-dt-overlays`.
106+
107+
.. _npm2100_building:
108+
109+
Building and programming for nPM2100
110+
************************************
111+
112+
There is no firmware for nPM2100 that can be built and programmed onto the PMIC.
113+
114+
Instead, you need to connect the compatible development kit to nPM2100 and program that kit with the firmware.
115+
116+
Connecting the development kit to nPM2100
117+
=========================================
118+
119+
If you are using the nRF5340 DK, follow the steps in `Use the nPM2100 EK with an nRF5340 DK`_ in the `nPM2100 EK User Guide`_.
120+
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).
121+
122+
If you are using custom hardware, the wiring process is similar to the `one for the nRF5340 DK <Use the nPM2100 EK with an nRF5340 DK_>`_, but board-specific steps will be different.
123+
124+
.. note::
125+
Logic levels on the nPM2100 EK follow the nPM2100 boost regulator output voltage. There is no voltage level translation on the nPM2100 EK headers.
126+
In order to ensure proper communication between the nPM2100 EK and the development kit, the development kit must be powered by the nPM2100 EK.
127+
Appropriate wiring for supported DKs is provided in the :ref:`pmic_samples` documentation.
128+
129+
Programming the development kit with nPM2100-compatible firmware
130+
================================================================
131+
132+
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.

0 commit comments

Comments
 (0)