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
.. _vl53l0x: VL53L0X: Time Of Flight sensor ############################## Overview ******** This sample periodically measures distance between vl53l0x sensor and target. The result is displayed on the console. It also shows how we can use the vl53l0x as a proximity sensor. Requirements ************ This sample uses the VL53L0X sensor controlled using the I2C interface. References ********** - VL53L0X: http://www.st.com/en/imaging-and-photonics-solutions/vl53l0x.html Building and Running ******************** This project outputs sensor data to the console. It requires a VL53L0X sensor, which is present on the disco_l475_iot1 board. .. zephyr-app-commands:: :app: samples/sensor/vl53l0x/ :goals: build flash Sample Output ============= .. code-block:: console prox is 0 distance is 1938 prox is 1 distance is 70 prox is 0 distance is 1995 <repeats endlessly every second>