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
MAX6675 K-thermocouple to digital converter ########################################### Overview ******** This is a sample application to read an external MAX6675 cold-junction-compensated K-thermocouple to digital converter. Requirements ************ - MAX6675 wired to your board SPI bus - K-thermocouple connected to MAX6675 T+/T- inputs References ********** - MAX6675: https://datasheets.maximintegrated.com/en/ds/MAX6675.pdf Building and Running ******************** This sample can be built with any board that supports SPI. A sample overlay is provided for the NUCLEO-F030R8 board. .. zephyr-app-commands:: :zephyr-app: samples/sensor/max6675 :board: nucleo_f030r8 :goals: build :compact: Sample Output ============= The application will read and print sensor temperature every second. Note that temperature fetch will fail if the K-thermocouple is not connected. This is because MAX6675 is able to detect if the K-thermocouple is connected or not. .. code-block:: console Temperature: 25.25 C Temperature: 25.50 C <repeats endlessly every second>