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
.. _sm351lt:
SM351LT: Magnetoresistive Sensor Example
########################################
Overview
********
This sample application periodically polls an SM351LT magnetoresistive sensor
and displays if a magnet near to the sensor, via the console.
Requirements
************
This sample uses the Honeywell SM351LT sensor.
References
**********
For more information about the SM351LT magnetoresistive sensor see
https://sensing.honeywell.com/SM351LT-low-power
Building and Running
********************
The SM351LT (or compatible) sensors are available on the following boards:
* :ref:`bt510`
Building on bt510
==================
:ref:`bt510` includes a Honeywell SM351LT magnetoresistive sensor.
.. zephyr-app-commands::
:zephyr-app: samples/sensor/sm351lt
:board: bt510
:goals: build flash
:compact:
Sample Output
=============
.. code-block:: console
Polling at 0.5 Hz
#1 @ 6 ms: 1
#2 @ 2007 ms: 0
#3 @ 4009 ms: 0
#4 @ 6010 ms: 1
#5 @ 8012 ms: 1