michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/samples/index.rst

34 lines
533 B
ReStructuredText
Raw Permalink Normal View History

doc: add labels to sample docs for linking Docs need a label at the top so we can use :ref:`labelname` to create a link to that doc from other docs. Change-Id: I7d7b98f3a9d22350ca983b3558bf83f77fd6e379 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-04-04 20:11:47 +02:00
.. _samples-and-demos:
doc: move documetnation context to root directory This will allow inclusion of documentation files that exist outside of doc/ and will make it possible to add rst files across the tree, especially for boards, samples and tests. Change-Id: I7afcf92d99f504b2bc0b2b7e3452acb2f8e08294 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-03 20:38:53 +01:00
Samples and Demos
#################
.. toctree::
doc: reduce sample index clutter Docs in the samples folder are a mixture of samples and sample indexes of more samples, cluttering the index display. This change eliminates the clutter, be we should reorganize the sample docs so we have a consistent doc hierarchy (and improved organization). Fixes: #12758 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-26 22:52:26 +01:00
:maxdepth: 2
doc: move documetnation context to root directory This will allow inclusion of documentation files that exist outside of doc/ and will make it possible to add rst files across the tree, especially for boards, samples and tests. Change-Id: I7afcf92d99f504b2bc0b2b7e3452acb2f8e08294 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-03 20:38:53 +01:00
:glob:
doc: restructure and create index pages Move all lead pages to be index pages and create redirect rules from the old pointers. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-03 23:29:46 +01:00
classic
doc: move documetnation context to root directory This will allow inclusion of documentation files that exist outside of doc/ and will make it possible to add rst files across the tree, especially for boards, samples and tests. Change-Id: I7afcf92d99f504b2bc0b2b7e3452acb2f8e08294 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-03 20:38:53 +01:00
basic/*
samples: move userspace sample out of basic/ This sample does not belong under basic/, it should have its own category. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-12-03 02:11:18 +01:00
userspace/*
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
net: doc: add section about networking with qemu Change-Id: I478231b6932c379201deaf4e1ca9ff57b43bd05f Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-16 14:55:24 +01:00
net/net.rst
Bluetooth: Move Bluetooth docs to rst Change-Id: I36009f5acd4016ec47edb6dac29e81e58b1ba24f Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-20 02:42:36 +01:00
bluetooth/bluetooth.rst
doc: move documetnation context to root directory This will allow inclusion of documentation files that exist outside of doc/ and will make it possible to add rst files across the tree, especially for boards, samples and tests. Change-Id: I7afcf92d99f504b2bc0b2b7e3452acb2f8e08294 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-03 20:38:53 +01:00
sensor/*
drivers: Add support for BBC micro:bit LED display Adds a simple driver to access the 5x5 LED display found on BBC micro:bit boards. The display is so limited that no effort is done to try to integrate with the existing console (which would likely make the display unusable). Instead, dedicated mb_display_* APIs are added that are specific to this display. References: https://www.microbit.co.uk/device/screen https://lancaster-university.github.io/microbit-docs/ubit/display/ Jira: ZEP-1990 Change-Id: I431b5b358b5f07592a60d3aed87eaab6ac20ce25 Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2017-04-02 19:54:23 +02:00
boards/*
doc: add MPU samples to index Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-06-20 16:14:03 +02:00
mpu/*
samples: drivers: add LPD8806 sample application This sample displays the colors red, green, and blue on consecutive LEDs in an LED strip, moving the starting point where red begins further down the strip at each time step. The color band wraps around to the beginning when it reaches the end. Since this is the first application in samples/drivers to have documentation, add samples/drivers/drivers.rst as well, and include it in the top-level toctree from samples/samples.rst. Signed-off-by: Marti Bolivar <marti.bolivar@linaro.org>
2017-10-19 21:28:25 +02:00
drivers/drivers.rst
doc: Introduce the sample category app. dev. to the docs There are currently two samples in the ~/zephyr/samples/application_development/ directory. This commit allows them to be visible in the documentation. It is not clear why this has not been done already. Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2018-03-26 10:16:04 +02:00
application_development/*
driver: sample: ILI9340 sample application Sample application showing how to use the ILI9340 LCD display driver. Signed-off-by: Jan Van Winkel <jan.van_winkel@dxplore.eu>
2017-10-06 08:37:25 +02:00
display/*
samples: Provide x-nucleo-iks01a1 shield sample This sample is made to demonstrate use of shield x-nucleo-ik01a1. It will display embedded sensor data endlessly. It requires a board with Arduino i2c as minimum configuration Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2018-04-09 16:35:19 +02:00
shields/*
samples: cmsis_rtos_v1: Demo with Dining philosopher's problem Sample application to demonstrate usage of cmsis_rtos_v1 APIs with dining philosopher's problem implementation. This covers semaphores, mutex and thread APIs of CMSIS RTOS V1. Signed-off-by: Spoorthi K <spoorthi.k@intel.com>
2018-12-06 05:38:06 +01:00
portability/*
samples: posix: gettimeofday: Demo gettimeofday() returning correct time Achieved using CONFIG_NET_CONFIG_CLOCK_SNTP_INIT option, i.e. querying time over network using SNTP. Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2019-09-12 17:33:55 +02:00
posix/*
samples: video: Add video capture sample Simple video sample getting frames from video capture device. Tested with mimxrt1064_evk and MT9M114 sensor. Signed-off-by: Loic Poulain <loic.poulain@linaro.org>
2019-07-01 14:53:21 +02:00
video/*
samples: Add MetaIRQ dispatch sample MetaIRQs are described in docs and exercised in tests, but there's no sample explaining how they are intended to be used to perform interrupt bottom half processing. This simple tool spawns a set of worker threads at different priorities (some cooperative) which process "messages" (which require CPU time to handle) received from a fake "device" implemented with timer interrupts. The device hands off the events directly to a MetaIRQ thread which is expected to parse and dispatch them to the worker threads. The test demonstrates that no matter the state of the system, the MetaIRQ thread always runs synchronously when woken by the ISR and is able to preempt all worker threads to do its job. Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2020-01-29 21:56:23 +01:00
scheduler/*
Samples: Add SMP Pi This sample showcases efficient utilization of SMP system with processing of independent resource-hungry workloads. With no cross-dependencies between workers and no usage of shared resources (during heavy-lifting itself) we may demonstrate almost linear scaling of efficiency. I.e. 2 cores do the same amount of calculations twice faster than only 1 core. 4 cores complete the same calculations 2 times faster than 2 cores. Signed-off-by: Alexey Brodkin <abrodkin@synopsys.com>
2019-09-02 15:50:06 +02:00
smp/*
trusted-firmware-m: Add initial plumbing for TFM This commits adds a config option to build a PSA trusted-firmware-m (TF-M) application image for the secure processing environment, and configures the Zephyr application image for the non-secure processing environment. The secure and non-secure environment images will be linked together via the veneer function table that is produced as an artifact of the TF-M build process. Signed-off-by: Karl Zhang <karl.zhang@linaro.org>
2020-05-08 15:22:52 +02:00
tfm_integration/tfm_integration.rst
doc: move documetnation context to root directory This will allow inclusion of documentation files that exist outside of doc/ and will make it possible to add rst files across the tree, especially for boards, samples and tests. Change-Id: I7afcf92d99f504b2bc0b2b7e3452acb2f8e08294 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-03 20:38:53 +01:00
doc: reduce sample index clutter Docs in the samples folder are a mixture of samples and sample indexes of more samples, cluttering the index display. This change eliminates the clutter, be we should reorganize the sample docs so we have a consistent doc hierarchy (and improved organization). Fixes: #12758 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-26 22:52:26 +01:00
.. comment
To add a new sample document, please use the template available under
doc: use :zephyr_file: where appropriate A new role :zephyr_file: is available that renders to a link to the file or folder in GitHub. Find appropriate references using :file: and convert to :zephyr_file: to take advantage of its linking capability. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-08 23:21:37 +01:00
``doc/templates/sample.tmpl``
Copy permalink