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
.. _lsm303dlhc: LSM303DLHC: Magnetometer and Accelerometer data Monitor ####################################################### Overview ******** This sample application periodically reads magnetometer and accelerometer data from the LSM303DLHC eCompass module's sensors, and displays the sensor data on the console. Requirements ************ This sample uses the LSM303DLHC, ST MEMS system-in-package featuring a 3D digital linear acceleration sensor and a 3D digital magnetic sensor, controlled using the I2C interface. References ********** For more information about the LSM303DLHC eCompass module, see http://www.st.com/en/mems-and-sensors/lsm303dlhc.html Building and Running ******************** This project outputs sensor data to the console. It requires a LSM303DLHC system-in-package, which is present on the stm32f3_disco board .. zephyr-app-commands:: :zephyr-app: samples/sensor/lsm303dlhc :board: stm32f3_disco :goals: build :compact: Sample Output ============= .. code-block:: console Magnetometer data: ( x y z ) = ( 0.531818 -0.435454 -0.089090 ) Accelerometer data: ( x y z ) = ( -0.078127 -0.347666 1.105502 ) Magnetometer data: ( x y z ) = ( -0.003636 0.297272 -0.255454 ) Accelerometer data: ( x y z ) = ( 0.074221 -0.304696 0.972685 ) <repeats endlessly every 2 seconds>