79e6b0e0f6
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> |
||
|---|---|---|
| .. | ||
| boards | ||
| src | ||
| CMakeLists.txt | ||
| README.rst | ||
| prj.conf | ||
| sample.yaml | ||
README.rst
.. _stm32_vbat_sensor:
STM32 VBat Sensor
#################
Overview
********
This sample reads the Vbat from the STM32 Internal
Sensor and displays the results.
Building and Running
********************
In order to run this sample, make sure to enable ``stm32_vbat`` node in your
board DT file or with a board overlay in the samples/sensor/stm32_temp_sensor/boards :
.. code-block:: dts
stm32_vbat: stm32vbat {
compatible = "st,stm32-vbat";
io-channels = <&adc1 14>;
ratio = <3>;
status = "okay";
};
Enable the corresponding ADC, with the correct vref value (in mV)
.. code-block:: dts
&adc1 {
vref-mv = <3000>;
status = "okay";
};
.. zephyr-app-commands::
:zephyr-app: samples/sensor/stm32_vbat_sensor
:board: nucleo_g071rb
:goals: build
:compact:
Sample Output
=============
.. code-block:: console
Current Vbat voltage: 3.04 V