zephyr/samples/sensor/stm32_temp_sensor
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
..
boards
src includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 2022-09-05 16:31:47 +02:00
CMakeLists.txt
README.rst
prj.conf sensors: Remove unnecessary Kconfig setting of sensors 2022-07-25 15:18:56 +02:00
sample.yaml Samples: sensor: stm32_temp_sensor: Edit the yaml file of the sample 2022-08-24 11:35:45 +02:00

README.rst

.. _stm32_temp_sensor:

STM32 Temperature Sensor
########################

Overview
********

This sample periodically reads temperature from the STM32 Internal
Temperature Sensor and display the results.

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

In order to run this sample, make sure to enable ``stm32_temp`` node in your
board DT file.

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/stm32_temp_sensor
   :board: nucleo_f103rb
   :goals: build
   :compact:

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

.. code-block:: console

    Current temperature: 22.6 °C
    Current temperature: 22.8 °C
    Current temperature: 23.1 °C