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

Application Protocols
*********************
:link_to_translation:`zh_CN:[中文]`

.. toctree::
   :maxdepth: 1

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

Code examples for this API section are provided in the :example:`protocols` directory of ESP-IDF examples.


IP Network Layer
================

Documentation for IP Network Layer protocols (below the Application Protocol layer) are provided in :doc:`../network/index`.
doc: Rearrange wifi & ethernet docs into a common "network" doc 2018-12-03 07:11:31 +00:00			`Application Protocols`
			`*********************`
zh_CN translation of HTTP Server API reference 2019-03-19 10:46:47 +00:00			:link_to_translation:`zh_CN:[中文]`
Moved api documentation to new folders / categories 2017-01-16 22:08:35 +00:00
			`.. 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>`
esp_websocket_client: Add websocket client component Closes https://github.com/espressif/esp-idf/issues/2829 2019-06-20 07:37:40 +00:00			`Websocket Client <esp_websocket_client>`
HTTP Server Docs : Replace http_server with esp_http_server 2018-10-24 09:55:04 +00:00			`HTTP Server <esp_http_server>`
esp_https_server : Docs and API references fixed 2018-11-01 12:54:19 +00:00			`HTTPS Server <esp_https_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>`
freemodbus: Fix bug with incorrect coils read mask Contains two different component folders per each implementation (serial_master and serial_slave) with concrete ports. Added common public api for master and slave and common interface for master and slave implementation. Add support of cmake system (added cmake files). Added sdkconfig.defaults files for slave and master modbus examples. Updated make file and KConfig for freemodbus component Update according to review and fix doxygen warnings Fix Doxyfile to pass documentation build Update headers and change interface file names as per review comments Merge branch feature/freemodbus_move_rs485_mode_control Update after review: The stack modbus folder updated to support master and slave ports together and moved into freemodbus/modbus Stack and port files updated to remove duplicated simbols Make file, KConfig and CMakeLists.txt updated to compile master and slave stacks, common interface and concrete implementations of ports Stack callback functions execute callbacks using interface pointer from concrete port implementation User can instantiate any of concrete port using common API (only one concrete port at a time) and it does not require to select port by KConfig Port pins and mode configuration moved into example files from port files to allow user select pins and port mode (customer request) Changes tested using pymodbus, ModbusPoll and communication between two boards Updated DoxyFile according to public include path Fix maximum instance size for slave (merge from master of customer issue) Fix critical section issue TW#28622 (change spin lock based critical section to semaphore) Move serial port files into component port folder for master and slave accordingly Fix example issue showed in the log when IO slave is not configured correctly Fix conflicts while merging from origin/master Fix errors handling in modbus controller interface + some final corrections according to review Update maximum allowed number of slaves in the network segment Fix bug with incorrect coils read mask Closes https://github.com/espressif/esp-idf/issues/858 2018-10-19 13:51:27 +00:00			`Modbus <modbus>`
Added links from api category TOC to example category folders Typo fix in bluetooth README.md 2017-01-18 20:04:11 +00:00
Doc/review api reference indexes 2019-04-29 02:53:42 +00:00			Code examples for this API section are provided in the :example:`protocols` directory of ESP-IDF examples.
doc: Rearrange wifi & ethernet docs into a common "network" doc 2018-12-03 07:11:31 +00:00

			`IP Network Layer`
			`================`

Doc/review api reference indexes 2019-04-29 02:53:42 +00:00			Documentation for IP Network Layer protocols (below the Application Protocol layer) are provided in :doc:`../network/index`.