diff --git a/doc/nrf/index.rst b/doc/nrf/index.rst index 6f0e8439676..d46df07444d 100644 --- a/doc/nrf/index.rst +++ b/doc/nrf/index.rst @@ -25,6 +25,7 @@ A "99" at the end of the version number of this documentation indicates continuo nrf70 nrf53 nrf52 + pmic protocols applications samples diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt index 87ab6a6ab15..033e7fa5909 100644 --- a/doc/nrf/links.txt +++ b/doc/nrf/links.txt @@ -392,6 +392,9 @@ .. _`nRF21540 DK product page`: https://www.nordicsemi.com/Products/Low-power-short-range-wireless/nRF21540 +.. _`nPM1300 product website`: https://www.nordicsemi.com/products/npm1300 +.. _`nPM1300 EK product page`: https://www.nordicsemi.com/Products/Development-hardware/nPM1300-EK + .. _`nRF Desktop reference design page`: https://www.nordicsemi.com/Products/Reference-designs/nRF-Desktop .. _`Nordic Semiconductor's IoT cloud platform`: https://www.nordicsemi.com/Products/Cloud-services @@ -531,6 +534,9 @@ .. _`Measuring Current on Thingy:91`: https://infocenter.nordicsemi.com/topic/ug_thingy91/UG/thingy91/hw_description/hw_power_current_measurement.html +.. _`nPM1300`: https://infocenter.nordicsemi.com/topic/struct_pmic/struct/npm1300.html +.. _`nPM1300 EK User Guide`: https://infocenter.nordicsemi.com/topic/ug_npm1300_ek/UG/nPM1300_EK/intro.html + .. _`Debugger access protection for nRF9160`: https://infocenter.nordicsemi.com/topic/ps_nrf9160/dif.html#debugger_access .. _`AP-Protect for nRF5340`: https://infocenter.nordicsemi.com/topic/ps_nrf5340/debugandtrace.html#access_port_protection .. _`AP-Protect for nRF52840`: https://infocenter.nordicsemi.com/topic/ps_nrf52840/dif.html#concept_udr_mns_1s diff --git a/doc/nrf/pmic.rst b/doc/nrf/pmic.rst new file mode 100644 index 00000000000..3228abc26a1 --- /dev/null +++ b/doc/nrf/pmic.rst @@ -0,0 +1,13 @@ +.. _ug_pmic: + +Working with PMICs +################## + +The |NCS| provides support for development with the `nPM1300 Power Management IC (PMIC) `_, using the `nPM1300 EK (PCA10152) `_. + +.. toctree:: + :maxdepth: 2 + :caption: Subpages: + + working_with_pmic/npm1300/features + working_with_pmic/npm1300/gs diff --git a/doc/nrf/releases/release-notes-changelog.rst b/doc/nrf/releases/release-notes-changelog.rst index 697c05d5c09..53070430af8 100644 --- a/doc/nrf/releases/release-notes-changelog.rst +++ b/doc/nrf/releases/release-notes-changelog.rst @@ -542,3 +542,4 @@ Added: * A page on :ref:`ug_wireless_coexistence` in :ref:`protocols`. * Pages on :ref:`thread_device_types` and :ref:`thread_sed_ssed` to the :ref:`ug_thread` documentation. +* A new section :ref:`ug_pmic`, containing :ref:`ug_npm1300_features` and :ref:`ug_npm1300_gs`. diff --git a/doc/nrf/working_with_pmic/npm1300/features.rst b/doc/nrf/working_with_pmic/npm1300/features.rst new file mode 100644 index 00000000000..d360e47df28 --- /dev/null +++ b/doc/nrf/working_with_pmic/npm1300/features.rst @@ -0,0 +1,65 @@ +.. _ug_npm1300_features: + +Features of nPM1300 +################### + +.. contents:: + :local: + :depth: 2 + +Introduction +************ + +nPM1300 is a Power Management IC (PMIC) with a linear-mode lithium-ion, lithium-polymer, and lithium ferro-phosphate battery charger. +It has two dual-mode buck regulators, two dual purpose LDO/load switches, three LED drivers and five GPIOs. + +nPM1300 is the perfect companion for nRF52 and nRF53 Series SoCs, and the nRF91 series SiP. +It is ideal for compact and advanced IoT products such as wearables and portable medical applications. + +For additional information, see the following documentation: + +* `nPM1300`_ for the technical documentation on the nPM1300 PMIC and associated kits. +* :ref:`ug_npm1300_gs`. +* The :ref:`introductory documentation ` if you are not familiar with the |NCS| and the development environment. + +Supported boards +================ + +nPM1300 is supported by the following boards in the `Zephyr`_ open source project and in |NCS|. + +.. list-table:: + :header-rows: 1 + + * - DK or Prototype platform + - Companion module + - PCA number + - Build target + - Documentation + * - nRF52 DK + - nPM1300 EK + - PCA10040 + - ``nrf52dk_nrf52832`` + - | `Product Specification `_ + | :ref:`Getting started ` + | `User Guide `_ + * - nRF52840 DK + - nPM1300 EK + - PCA10056 + - ``nrf52840dk_nrf52840`` + - | `Product Specification `_ + | :ref:`Getting started ` + | `User Guide `_ + * - nRF5340 DK + - nPM1300 EK + - PCA10095 + - ``nrf5340dk_nrf5340_cpuapp`` + - | `Product Specification `_ + | :ref:`Getting started ` + | `User Guide `_ + * - nRF9160 DK + - nPM1300 EK + - PCA10090 + - ``nrf9160dk_nrf9160_ns`` + - | `Product Specification `_ + | :ref:`Getting started ` + | `User Guide `_ diff --git a/doc/nrf/working_with_pmic/npm1300/gs.rst b/doc/nrf/working_with_pmic/npm1300/gs.rst new file mode 100644 index 00000000000..e492102ab67 --- /dev/null +++ b/doc/nrf/working_with_pmic/npm1300/gs.rst @@ -0,0 +1,85 @@ +.. _ug_npm1300_gs: + +Getting started with nPM1300 EK +############################### + +.. contents:: + :local: + :depth: 2 + +This section gets you started with your nPM1300 :term:`Evaluation Kit (EK)` using the |NCS|. +It tells you how to build and flash the :ref:`npm1300_fuel_gauge` sample and perform a quick test of your EK. + +If this is your first time developing with a Nordic DK, read the appropriate getting started tutorial first: + +* :ref:`ug_nrf52_gs` +* :ref:`ug_nrf5340_gs` +* :ref:`ug_nrf9160_gs` + +Minimum requirements +******************** + +Make sure you have all the required hardware and that your computer has one of the supported operating systems. + +Hardware +======== + +* One of the following development kits: + + * nRF52 DK + * nRF52840 DK + * nRF5340 DK + * nRF9120 DK + +* nPM1300 EK +* A suitable battery +* Micro-USB 2.0 cable +* USB-C charger +* Jumper wires + +Software +======== + +On your computer, one of the following operating systems: + +* Microsoft Windows +* macOS +* Ubuntu Linux + +|Supported OS| + +.. _npm1300_gs_installing_software: + +Installing the required software +******************************** + +Install `nRF Connect for Desktop`_. +After installing and starting the application, install the Programmer app. + +.. _npm1300_gs_building: + +Building and programming the sample +*********************************** + +Follow the detailed instructions in the :ref:`npm1300_fuel_gauge` sample documentation to build the sample and flash it to the DK. + +.. _npm1300_gs_testing: + +Testing the sample +****************** + +When the fuel gauge software has connected successfully to the PMIC on the EK, it will display the following status information: + +.. code-block:: console + + PMIC device ok + V: 4.101, I: 0.000, T: 23.06, SoC: 93.09, TTE: nan, TTF: nan + +Next steps +********** + +You have now completed getting started with the nPM1300 EK. +See the following links for where to go next: + +* The EK `User Guide `_ for detailed information related to the nPM1300 EK. +* The :ref:`introductory documentation ` for more information on the |NCS| and the development environment.