zephyr

History

Benjamin Cabé ee77704715 samples: sensor: use zephyr:code-sample directive Describe the samples using code-sample directive in preparation for upcoming changes to the Zephyr documentation that will be leveraging the provided description and metadata. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>		2024-09-04 21:26:50 +02:00
..
src	…
CMakeLists.txt	…
README.rst	samples: sensor: use zephyr:code-sample directive	2024-09-04 21:26:50 +02:00
prj.conf	…
sample.yaml	…

README.rst

.. zephyr:code-sample:: bq274xx
   :name: BQ274XX fuel gauge sensor
   :relevant-api: sensor_interface

   Get various fuel gauge parameters from a BQ274XX sensor.

Overview
********

This sample application retrieves all the fuel gauge parameters:

- Voltage, in volts
- Average current, in amps
- Standby current, in amps
- Maximum load current, in amps
- Gauge temperature
- State of charge measurement in percentage
- Full Charge Capacity in mAh
- Remaining Charge Capacity in mAh
- Nominal Available Capacity in mAh
- Full Available Capacity in mAh
- Average power in mW
- State of health measurement in percentage

from BQ274XX sensor and prints this information to the UART console.

Requirements
************

- innblue22/nrf9160 board with BQ274XX sensor `BQ274XX Sensor`_

Building and Running
********************

Build this sample using the following commands:

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/bq274xx
   :board: innblue22/nrf9160
   :goals: build flash

References
**********

.. target-notes::

.. _BQ274XX Sensor: http://www.ti.com/lit/ds/symlink/bq27421-g1.pdf