OVMS3-idf/docs/api-reference/peripherals/uart.rst

UART
====

Overview
--------

`Instructions`_

.. _Instructions: ../template.html

Application Example
-------------------

Configure uart settings and install uart driver to read/write using UART0 and UART1 interfaces: :example:`peripherals/uart`.

API Reference
-------------

.. include:: /_build/inc/uart.inc
Revised api files - Included UART API - Addedd "Header Files" - Improved template - deleted redundat nvs.rst 2016-11-10 21:50:55 +00:00			`UART`
			`====`

			`Overview`
			`--------`

			`Instructions`_

Added links to examples in API documentation 2017-01-17 18:12:48 +00:00			`.. _Instructions: ../template.html`

Revised api files - Included UART API - Addedd "Header Files" - Improved template - deleted redundat nvs.rst 2016-11-10 21:50:55 +00:00			`Application Example`
			`-------------------`

docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests. 2017-01-19 08:16:06 +00:00			Configure uart settings and install uart driver to read/write using UART0 and UART1 interfaces: :example:`peripherals/uart`.
Revised api files - Included UART API - Addedd "Header Files" - Improved template - deleted redundat nvs.rst 2016-11-10 21:50:55 +00:00
			`API Reference`
			`-------------`

docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`.. include:: /_build/inc/uart.inc`
Revised api files - Included UART API - Addedd "Header Files" - Improved template - deleted redundat nvs.rst 2016-11-10 21:50:55 +00:00