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
.. _vcnl4040_sample:
VCNL4040: proximity and ambient light sensor
############################################
Overview
********
This sample periodically measures proximity and light for
5 sec in the interval of 300msec in polling mode. Then threshold trigger mode
is enabled with the high threshold value of 127 and data is fetched based
on interrupt. The result is displayed on the console.
Requirements
************
This sample uses the VCNL4040 sensor controlled using the I2C interface.
Connect sensor INT for interrupt to Feather D5 pin on the Adafruit STM32F405 Feather.
References
**********
- VCNL4040: https://www.vishay.com/docs/84274/vcnl4040.pdf
Building and Running
********************
This project outputs sensor data to the console. It requires a VCNL4040
sensor to be connected to the desired board.
.. zephyr-app-commands::
:app: samples/sensor/vcnl4040/
:goals: build flash
Sample Output
=============
.. code-block:: console
get device vcnl4040
Testing the polling mode.
Proximity: 31
Light (lux): 288
<repeats for 5sec every 300ms>
Polling mode test finished.
Testing the trigger mode.
Testing proximity trigger.
...
Triggered.
Proximity: 122
<repeats whenever triggered for 5sec>
Threshold trigger test finished.
Trigger mode test finished.