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
.. _mhz19b-sample: MH-Z19B: CO2 Sensor Sample ########################## Description *********** This sample application demonstrate the configurations of the MH-Z19B CO2 sensor, then periodically reads CO2 data from the sensor. The driver currently only support uart interrupt APIs. Requirements ************ The baudrate of the UART must be configured to 9600, and must support interrupt driven API. Building and Running ******************** To build the application, a board with UART interface has to be chosen, or a custom devicetree overlay has to be provided. Here Nucleo G0B1RE board is used. Then, connect the RX and TX from your Zephyr target board to the MH-Z19B CO2 sensor and power the sensor according to the datasheet. .. zephyr-app-commands:: :zephyr-app: samples/sensor/mhz19b :board: nucleo_g0b1re :goals: build :compact: Sample Output ============= The application will perform runtime configuration of the sensor, then read back the sensor configuration data. After that it will read the CO2 data every 2 seconds. .. code-block:: console Winsen MH-Z19B CO2 sensor application Configuring sensor - OK Reading configurations from sensor: Sensor range is set to 5000ppm Sensor ABC is enabled sensor: co2 reading: 758 sensor: co2 reading: 759 sensor: co2 reading: 762 <repeats endlessly every 2 seconds>