OVMS3-idf/docs/en/api-reference/protocols/index.rst

Protocols API
*************

.. toctree::
   :maxdepth: 1

   mDNS <mdns>
   ESP-TLS <esp_tls>
   HTTP Client <esp_http_client>
   HTTP Server <esp_http_server>
   ASIO <asio>
   ESP-MQTT <mqtt>
   Modbus slave <modbus>
   Websocket Client <esp_websocket_client>

Example code for this API section is provided in :example:`protocols` directory of ESP-IDF examples.
Moved api documentation to new folders / categories 2017-01-16 22:08:35 +00:00			`Protocols API`
			`*************`

			`.. toctree::`
			`:maxdepth: 1`

			`mDNS <mdns>`
Resolved Issues 2018-02-14 09:45:50 +00:00			`ESP-TLS <esp_tls>`
Add esp_http_client Add error handling for http client set ssid password correct with Example_WIFI test, and clear password before free Fixed the CI failure due to HTTP errror names 2017-11-14 03:16:20 +00:00			`HTTP Client <esp_http_client>`
HTTP Server Docs : Replace http_server with esp_http_server 2018-10-24 09:55:04 +00:00			`HTTP Server <esp_http_server>`
asio: initial idf port of asio library without ssl 2018-05-29 09:25:24 +00:00			`ASIO <asio>`
MQTT: Integrate esp-mqtt library into idf added docs and tests for mqtt library, small fixes (removed warnings, option for custom outbox, websocket bug fixed for longer transports). refactored to use common tcp_transport component, support for CMake build system. Closes #2108 2018-07-24 14:59:03 +00:00			`ESP-MQTT <mqtt>`
examples: freemodbus port slave basic implementation This example adds functionality to support basic communication in RS485 networks using Modbus protocol. This example uses FreeModbus stack and regular UART driver API to communicate in RS485 half duplex mode. Added initial support of modbus controller pure C api to access device parameters over Modbus transport. Move freemodbus stack and port files into components folder Move the modbus_controller interface into components idf folder Source files updated after review. Add modbus interface documentation docs/en/api-reference/protocols/modbus.rst porttimer.c: fix bug with timer1 selected in the Kconfig Add support of cmake system (added cmake files) Closes https://github.com/espressif/esp-idf/issues/858 2018-06-28 15:45:41 +00:00			`Modbus slave <modbus>`
websocket: backport of websocket client to v3.2 Backports the websocket client and example to ESP-IDF release 3.2. 2020-01-09 09:05:10 +00:00			`Websocket Client <esp_websocket_client>`
Added links from api category TOC to example category folders Typo fix in bluetooth README.md 2017-01-18 20:04:11 +00:00
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			Example code for this API section is provided in :example:`protocols` directory of ESP-IDF examples.