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
.. _apds9960: APDS9960 RGB, Ambient Light, Gesture Sensor ########################################### Overview ******** This sample application demonstrates how to use the APDS9960 sensor to get ambient light, RGB, and proximity (or gesture) data. This sample checks the sensor in polling mode (without an interrupt trigger). Building and Running ******************** This sample application uses an APDS9960 sensor connected to a board (for example as shown in this `Sparkfun APDS9960 tutorial`_). .. zephyr-app-commands:: :zephyr-app: samples/sensor/apds9960 :board: reel_board :goals: flash :compact: Sample Output ============= .. code-block:: console ambient light intensity without trigger is 387 proxy without trigger is 115 ambient light intensity without trigger is 386 proxy without trigger is 112 ambient light intensity without trigger is 386 .. _Sparkfun APDS9960 tutorial: https://www.sparkfun.com/products/12787