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 | ||
| prj.conf | ||
| README.rst | ||
| sample.yaml | ||
.. _grove-lcd-sample: Grove LCD ######### Overview ******** This sample displays an incrementing counter through the Grove LCD, with changing backlight. Requirements ************ To use this sample, the following hardware is required: * A board with ADC support * `Grove LCD module`_ * `Grove Base Shield`_ [Optional] Wiring ****** You will need to connect the Grove LCD via the Grove shield onto a board that supports Arduino shields. On some boards you will need to use 2 pull-up resistors (10k Ohm) between the SCL/SDA lines and 3.3V. Take note that even though SDA and SCL are connected to a 3.3V power source, the Grove LCD VDD line needs to be connected to the 5V power line, otherwise characters will not be displayed on the LCD (3.3V is enough to power just the backlight). Building and Running ******************** This sample should work on any board that has I2C enabled and has an Arduino shield interface. For example, it can be run on the FRDM K64F board as described below: .. zephyr-app-commands:: :zephyr-app: samples/subsys/display/grove_display :board: frdm_k64f :goals: flash :compact: .. _Grove Base Shield: http://wiki.seeedstudio.com/wiki/Grove_-_Base_Shield .. _Grove LCD module: http://wiki.seeed.cc/Grove-LCD_RGB_Backlight/