zephyr/samples/shields/lmp90100_evb/rtd
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>.
This patch proposes to then include <zephyr/kernel.h> instead of
<zephyr/zephyr.h> since it is more clear that you are including the
Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a
catch-all header that may be confusing. Most applications need to
include a bunch of other things to compile, e.g. driver headers or
subsystem headers like BT, logging, etc.

The idea of a catch-all header in Zephyr is probably not feasible
anyway. Reason is that Zephyr is not a library, like it could be for
example `libpython`. Zephyr provides many utilities nowadays: a kernel,
drivers, subsystems, etc and things will likely grow. A catch-all header
would be massive, difficult to keep up-to-date. It is also likely that
an application will only build a small subset. Note that subsystem-level
headers may use a catch-all approach to make things easier, though.

NOTE: This patch is **NOT** removing the header, just removing its usage
in-tree. I'd advocate for its deprecation (add a #warning on it), but I
understand many people will have concerns.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-09-05 16:31:47 +02:00
..
src includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 2022-09-05 16:31:47 +02:00
CMakeLists.txt
README.rst
app.overlay
prj.conf
sample.yaml

README.rst

.. _lmp90100_evb_rtd_sample:

LMP90100 Sensor AFE Evaluation Board: RTD Sample
################################################

Overview
********

This sample is provided as an example of how to read the temperature
of a Resistance Temperature Detector (RTD) sensor using the LMP90100
Sensor AFE Evaluation Board shield. The sample is designed for use
with a 3-wire PT100 sensor.

Please refer to :ref:`lmp90100_evb_shield` for more information on
this shield.

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

Prior to running the sample application, the LMP90100 EVB must be
connected to the development board according to Example #3 ("3-wire
RTD Application") in the `LMP90100 Sensor AFE Evaluation Board User's
Guide`_.

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

This sample runs with the LMP90100 EVB connected to any development
board with a matching Arduino connector. For this example, we use a
:ref:`frdm_k64f` board.

.. zephyr-app-commands::
   :zephyr-app: samples/shields/lmp90100_evb/rtd
   :board: frdm_k64f
   :goals: build
   :compact:

Sample Output
=============

 .. code-block:: console

    R: 111.15 ohm
    T: 28.66 degC
    R: 111.14 ohm
    T: 28.64 degC
    R: 111.14 ohm
    T: 28.63 degC
    R: 111.13 ohm
    T: 28.61 degC

.. _LMP90100 Sensor AFE Evaluation Board User's Guide:
   http://www.ti.com/lit/pdf/snau028