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 | ||
| trigger.conf | ||
README.rst
.. _sht3xd: SHT3XD: High accuracy digital I2C humidity sensor ################################################# Description *********** This sample application periodically (2 Hz) measures the ambient temperature and humidity. The result is written to the console. Optionally, it also shows how to use the upper threshold triggers. References ********** - `SHT3X-DIS sensor <https://www.sensirion.com/en/environmental-sensors/humidity-sensors/digital-humidity-sensors-for-various-applications/>`_ Wiring ******* This sample uses the SHT3X_DIS sensor controlled using the I2C interface. Connect Supply: **VDD**, **GND** and Interface: **SDA**, **SCL** and optionally connect the **ALERT** to a interrupt capable GPIO. The supply voltage can be in the 2.15V to 5.5V range. Depending on the baseboard used, the **SDA** and **SCL** lines require Pull-Up resistors. Building and Running ******************** This project outputs sensor data to the console. It requires a SHT3XD sensor. It should work with any platform featuring a I2C peripheral interface. It does not work on QEMU. In this example below the :ref:`nrf51_ble400` board is used. .. zephyr-app-commands:: :zephyr-app: samples/sensor/sht3xd :board: nrf51_ble400 :goals: build flash Sample Output ============= .. code-block:: console SHT3XD: 19.64 Cel ; 41.96 %RH SHT3XD: 19.74 Cel ; 42.06 %RH SHT3XD: 19.75 Cel ; 42.08 %RH <repeats endlessly>