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
.. _dht: DHT: Aosong DHT Digital-output Humidity and Temperature Sensor ############################################################## Description *********** This sample application periodically (0.5 Hz) measures the ambient temperature and humidity. The result is written to the console. Wiring ******* This sample uses an external breakout for the sensor. A devicetree overlay must be provided to identify the sensor variant and the GPIO used to control the sensor. Building and Running ******************** After providing a devicetree overlay that specifies the sensor location, build this sample app using: .. zephyr-app-commands:: :zephyr-app: samples/sensor/dht :board: nrf52dk_nrf52832 :goals: build flash Sample Output ============= .. code-block:: console *** Booting Zephyr OS build zephyr-v2.1.0-329-g38418b26c4cc *** [0:00:00.027]: 20.0 Cel ; 48.7 %RH [0:00:02.053]: 19.8 Cel ; 48.7 %RH [0:00:04.079]: 20.0 Cel ; 48.7 %RH [0:00:06.105]: 19.8 Cel ; 48.7 %RH [0:00:08.130]: 20.0 Cel ; 48.8 %RH [0:00:10.156]: 20.1 Cel ; 48.8 %RH [0:00:12.182]: 19.7 Cel ; 48.7 %RH [0:00:14.207]: 20.0 Cel ; 48.8 %RH <repeats endlessly>