Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
OVMS3-idf/docs/en/api-reference/protocols/index.rst

24 lines
566 B
ReStructuredText
Raw Normal View History

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>
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
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.
doc: Rearrange wifi & ethernet docs into a common "network" doc
2018-12-03 07:11:31 +00:00
IP Network Layer
================
Documentation for IP Network Layer protocols (below the Application Protocol layer) is provided in :doc:`../network/index`.
Reference in a new issue Copy permalink