2017-01-03 20:38:53 +01:00
|
|
|
Samples and Demos
|
|
|
|
|
#################
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
subsys: console: Add pull-style console API support.
This change introduces console_getchar() and console_getline() API
calls which can be used to get pending console input (either one
char or whole line), or block waiting for one. In this regard, they
are similar to well-known ANSI C function getchar/gets/fgets, and
are intended to ease porting of existing applications to Zephyr, and
indeed, these functions (shaped as an external module) are already
used by few applications.
The implementation of the functions is structured as a new "console"
subsystem. The intention is that further generic console code may be
pulled there instead of being in drivers/console/. Besides the
functions themselves, initialization code and sample applications
are included.
At this time, there're may limitations of how these functions can
be used. For example, console_getchar() and console_getline() are
mutually exclusive, and both are incompatible with callback
(push-style) console API (and e.g. with console shell subsystem
which uses this API). Again, the intention is to make a first step
towards refactoring console subsystem to allow more flexible
real-world usage, better reusability and composability.
Change-Id: I3f4015bb5b26e0656f82f428b11ba30e980d25a0
Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2017-03-24 11:50:16 +01:00
|
|
|
:maxdepth: 3
|
2017-01-03 20:38:53 +01:00
|
|
|
:glob:
|
|
|
|
|
|
|
|
|
|
kernel
|
|
|
|
|
basic/*
|
subsys: console: Add pull-style console API support.
This change introduces console_getchar() and console_getline() API
calls which can be used to get pending console input (either one
char or whole line), or block waiting for one. In this regard, they
are similar to well-known ANSI C function getchar/gets/fgets, and
are intended to ease porting of existing applications to Zephyr, and
indeed, these functions (shaped as an external module) are already
used by few applications.
The implementation of the functions is structured as a new "console"
subsystem. The intention is that further generic console code may be
pulled there instead of being in drivers/console/. Besides the
functions themselves, initialization code and sample applications
are included.
At this time, there're may limitations of how these functions can
be used. For example, console_getchar() and console_getline() are
mutually exclusive, and both are incompatible with callback
(push-style) console API (and e.g. with console shell subsystem
which uses this API). Again, the intention is to make a first step
towards refactoring console subsystem to allow more flexible
real-world usage, better reusability and composability.
Change-Id: I3f4015bb5b26e0656f82f428b11ba30e980d25a0
Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2017-03-24 11:50:16 +01:00
|
|
|
subsys/subsys.rst
|
2017-01-16 14:55:24 +01:00
|
|
|
net/net.rst
|
2017-01-20 02:42:36 +01:00
|
|
|
bluetooth/bluetooth.rst
|
2017-01-03 20:38:53 +01:00
|
|
|
sensor/*
|
|
|
|
|
grove/*
|
|
|
|
|
advanced
|
2017-01-23 22:59:55 +01:00
|
|
|
power/power.rst
|
2017-01-03 20:38:53 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2017-01-06 19:26:28 +01:00
|
|
|
To add a new sample documentation, please use the template available under
|
|
|
|
|
:file:`doc/templates/sample.tmpl`
|