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 | ||
| ds2484.overlay | ||
| prj.conf | ||
| sample.yaml | ||
| w1_serial.overlay | ||
README.rst
.. _w1_scanner_sample:
1-Wire Scanner Sample
#####################
Overview
********
This sample demonstrates how to scan for 1-Wire devices. It runs the 1-Wire
scan routine once and prints the family id as well as serial number of the
devices found.
Building and Running
********************
Set DTC_OVERLAY_FILE to "ds2484.overlay" or "w1_serial.overlay" in order to
enable and configure the drivers.
.. zephyr-app-commands::
:zephyr-app: samples/drivers/w1/scanner
:board: nrf52840dk_nrf52840
:gen-args: -DDTC_OVERLAY_FILE=w1_serial.overlay
:goals: build flash
:compact:
Sample Output
=============
.. code-block:: console
[00:00:00.392,272] <inf> main: Device found; family: 0x3a, serial: 0x3af9985800000036
[00:00:00.524,169] <inf> main: Device found; family: 0x3a, serial: 0x3a6ea2580000003b
[00:00:00.656,097] <inf> main: Device found; family: 0x28, serial: 0x2856fb470d000022
[00:00:00.656,097] <inf> main: Number of devices found on bus: 3