diff --git a/SUMMARY.md b/SUMMARY.md index 6785cae..bac5256 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -9,7 +9,7 @@ * [Common methods](ltapi/_libre_tuya_a_p_i_8h.md) * [Family-provided methods](ltapi/_libre_tuya_custom_8h.md) * [Logger](ltapi/lt__logger_8h.md) - * [Chip & family IDs](ltapi/_chip_type_8h.md) + * [Chip & family IDs](ltapi/_chip_type_8h_source.md) * [POSIX utilities](ltapi/lt__posix__api_8h.md) * Common API * [Flash](ltapi/class_i_flash_class.md) diff --git a/docs/config.md b/docs/config.md index 5383f06..53b4bb1 100644 --- a/docs/config.md +++ b/docs/config.md @@ -14,7 +14,8 @@ custom_fw_version = 1.2.0 ## LibreTuya API -Note: see [LibreTuyaConfig.h](../arduino/libretuya/core/LibreTuyaConfig.h) for most options and their defaults. +!!! note + See [LibreTuyaConfig.h](../ltapi/_libre_tuya_config_8h_source.md) for most options and their defaults. All options are configurable via C++ defines in PlatformIO project file. For example: ```ini diff --git a/docs/libs-3rd-party.md b/docs/libs-3rd-party.md index 05069fe..717ea61 100644 --- a/docs/libs-3rd-party.md +++ b/docs/libs-3rd-party.md @@ -2,11 +2,12 @@ A page outlining 3-rd party libraries compatible with LibreTuya. -To use some (most? (all?)) of these, a flag in `platformio.ini` is required to disable compatibility checks (because most libs are meant for ESP32/Arduino official framework): -```ini -[env:my_board] -lib_compat_mode = off -``` +!!! note + To use some (most? (all?)) of these, a flag in `platformio.ini` is required to disable compatibility checks (because most libs are meant for ESP32/Arduino official framework): + ```ini + [env:my_board] + lib_compat_mode = off + ``` ## MQTT Tested with `realtek-ambz`. diff --git a/docs/ota/README.md b/docs/ota/README.md index 35e638d..1c3064e 100644 --- a/docs/ota/README.md +++ b/docs/ota/README.md @@ -2,7 +2,8 @@ LibreTuya's OTA updating is based on [Microsoft's UF2 specification](https://microsoft.github.io/uf2/). Some aspects of the process, such as OTA1/2 support and target partition selection, have been customized with extension tags. -Note: just like in UF2, all values in this format are little-endian. +!!! note + Just like in UF2, all values in this format are little-endian. ## Firmware images @@ -27,16 +28,9 @@ For easier understanding, these update types will be referred to in this documen ## Custom family IDs -Name | ID | Description ------------|------------|---------------- -`RTL8710A` | 0x9FFFD543 | Realtek Ameba1 -`RTL8710B` | 0x22E0D6FC | Realtek AmebaZ -`RTL8720C` | 0xE08F7564 | Realtek AmebaZ2 -`RTL8720D` | 0x3379CFE2 | Realtek AmebaD -`BK7231T` | 0x675A40B0 | Beken 7231T -`BK7231N` | 0x7B3EF230 | Beken 7231N -`BL602` | 0xDE1270B7 | Boufallo 602 -`XR809` | 0x51E903A8 | Xradiotech 809 +{% + include-markdown "../supported_families.md" +%} ## Extension tags diff --git a/docs/ota/uf2ota.md b/docs/ota/uf2ota.md index 3fa5900..405ad25 100644 --- a/docs/ota/uf2ota.md +++ b/docs/ota/uf2ota.md @@ -32,6 +32,7 @@ When using two different firmware binaries, they need to have the same `offset` "bootloader;boot.bin" "ota1;xip1.bin;ota2;xip2.bin" "config;config1.bin;config;config2.bin" ``` will: + - flash the bootloader in both OTA schemes - flash `xip1.bin` or `xip2.bin` to `ota1` or `ota2` partitions - flash `config1.bin` or `config2.bin` to `config` partition