From 6192e9be7285318c10d43785d036d85e03ad0228 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kuba=20Szczodrzy=C5=84ski?= Date: Fri, 29 Apr 2022 21:32:00 +0200 Subject: [PATCH] [docs] Describe libraries --- docs/README.md | 10 +++++++++- docs/libraries/README.md | 25 +++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 docs/libraries/README.md diff --git a/docs/README.md b/docs/README.md index 77621ef..312e1e9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,11 @@ # LibreTuya documentation -TODO +- [LibreTuya API](api/README.md) +- [Built-in libraries](libraries/README.md) +- [3-rd party libraries](Libraries.md) +- [Configuration options](API%20Configuration.md) + +## Realtek AmebaZ Series + +- [Debugging](platform/realtek/Debugging.md) +- [Exception decoder](platform/realtek/Exception%20decoder.md) diff --git a/docs/libraries/README.md b/docs/libraries/README.md new file mode 100644 index 0000000..a8cc7af --- /dev/null +++ b/docs/libraries/README.md @@ -0,0 +1,25 @@ +# Built-in libraries +(in alphabetical order) + +## base64 +- [Source](https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/base64.cpp): ESP32 Arduino Core +- [API](../../arduino/libretuya/libraries/base64/base64.h) + +Helper base64 encoder used in some libs taken from ESP32. + +## HTTPClient +- [Source](https://github.com/espressif/arduino-esp32/tree/master/libraries/HTTPClient): ESP32 Arduino Core +- [API](../../arduino/libretuya/libraries/HTTPClient/HTTPClient.h) +- [Examples](https://github.com/espressif/arduino-esp32/tree/master/libraries/HTTPClient/examples) + +HTTP(S) client. Some reference may be found here: [https://links2004.github.io/Arduino/dd/d8d/class_h_t_t_p_client.html](https://links2004.github.io/Arduino/dd/d8d/class_h_t_t_p_client.html). + +## WiFiMulti +- [Source](https://github.com/espressif/arduino-esp32/tree/master/libraries/WiFi/src): ESP32 Arduino Core +- [API](../../arduino/libretuya/libraries/WiFiMulti/WiFiMulti.h) +- [Docs](https://docs.espressif.com/projects/arduino-esp32/en/latest/api/wifi.html#wifimulti) +- Examples: + - [WiFiMulti](https://github.com/espressif/arduino-esp32/blob/master/libraries/WiFi/examples/WiFiMulti/WiFiMulti.ino) + - [WiFiClientBasic](https://github.com/espressif/arduino-esp32/blob/master/libraries/WiFi/examples/WiFiClientBasic/WiFiClientBasic.ino) + +Class for selecting best available AP from a list of several ones.