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> |
||
---|---|---|
.. | ||
src | ||
CMakeLists.txt | ||
README.rst | ||
prj.conf | ||
sample.yaml |
README.rst
.. _hts221: HTS221: Temperature and Humidity Monitor ######################################## Overview ******** This sample periodically reads temperature and humidity from the HTS221 Temperature & Humidity Sensor and displays it on the console Requirements ************ This sample uses the HTS221 sensor controlled using the I2C interface. References ********** - HTS211: http://www.st.com/en/mems-and-sensors/hts221.html Building and Running ******************** This project outputs sensor data to the console. It requires an HTS221 sensor, which is present on the disco_l475_iot1 board. .. zephyr-app-commands:: :zephyr-app: samples/sensor/hts221 :board: disco_l475_iot1 :goals: build :compact: Sample Output ============= .. code-block:: console Temperature:25.3 C Relative Humidity:40% Temperature:25.3 C Relative Humidity:40% Temperature:25.3 C Relative Humidity:40% Temperature:25.3 C Relative Humidity:40% <repeats endlessly every 2 seconds>