From 1ba683439107f8132944f5ebe59b0ee507ac2c26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kuba=20Szczodrzy=C5=84ski?= Date: Tue, 11 Apr 2023 20:11:42 +0200 Subject: [PATCH] [docs] Update configuration docs --- README.md | 8 ++++-- SUMMARY.md | 2 +- docs/dev/config.md | 37 +++++++++++++++++++------ docs/platform/beken-72xx/README.md | 5 ++++ docs/platform/realtek-ambz/README.md | 5 ++++ docs/platform/realtek-ambz/debugging.md | 2 +- platform.json | 2 +- 7 files changed, 47 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0130107..dfc11ad 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,11 @@ which should make it easier to port/run existing ESP apps on Tuya IoT (and 3-rd ## Usage 1. [Install PlatformIO](https://platformio.org/platformio-ide) -2. `platformio platform install https://github.com/kuba2k2/libretuya` +2. `platformio platform install -f https://github.com/kuba2k2/libretuya` 3. Create a project, build it and upload! 4. See the [docs](https://docs.libretuya.ml/) for any questions/problems. + ## License diff --git a/SUMMARY.md b/SUMMARY.md index 3b6881a..740c997 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -4,7 +4,7 @@ * [💡 ESPHome setup guide](docs/projects/esphome.md) * [📲 Flashing/dumping guide](docs/flashing/) * [🔌 How to enter download mode?](docs/flashing/chip-connection/) -* [💻 Supported modules list](docs/status/supported.md) +* [💻 Supported chips](docs/status/supported.md) * [All boards](boards/) * [](SUMMARY.md) * 🍪 Chip family docs & info diff --git a/docs/dev/config.md b/docs/dev/config.md index a2b40b4..ce60808 100644 --- a/docs/dev/config.md +++ b/docs/dev/config.md @@ -10,6 +10,25 @@ custom_fw_name = my_firmware # custom firmware version # - default: current date in yy.mm.dd format custom_fw_version = 1.2.0 + +# custom build options (#defines, NOT compiler flags) +custom_options.lwip = + LWIP_IPV4 = 1 +custom_options.freertos = + configUSE_TICK_HOOK = 1 + +# partition layout modification (not recommended, unless you know what you're doing) +custom_flash.app = 0x12000 + +# custom board JSON (overrides) +# - path relative to the project directory; only values specified +# in the JSON will override the defaults +# (it's like using board_build.xxx but for more keys) +custom_board = myboard.json + +# custom library versions (not recommended) +custom_versions.lwip = 2.1.3 +custom_versions.beken_bdk = 2021.06.07 ``` ## LibreTuya options @@ -31,14 +50,16 @@ build_flags = - `LT_LOGGER` (1) - enable/disable LibreTuya logger globally; disabling this sets the loglevel to `LT_LEVEL_NONE` - the logger can't be enabled even by using `lt_log_set_port()` - `LT_LOGLEVEL` - global LT loglevel: - - `LT_LEVEL_VERBOSE` - - `LT_LEVEL_TRACE` - same as `LT_LEVEL_VERBOSE` - - `LT_LEVEL_DEBUG` - - `LT_LEVEL_INFO` - default - - `LT_LEVEL_WARN` - - `LT_LEVEL_ERROR` - - `LT_LEVEL_FATAL` - - `LT_LEVEL_NONE` - disables everything + + - `LT_LEVEL_VERBOSE` + - `LT_LEVEL_TRACE` - same as `LT_LEVEL_VERBOSE` + - `LT_LEVEL_DEBUG` + - `LT_LEVEL_INFO` - default + - `LT_LEVEL_WARN` + - `LT_LEVEL_ERROR` + - `LT_LEVEL_FATAL` + - `LT_LEVEL_NONE` - disables everything + - `LT_LOGGER_TIMESTAMP` (1) - print program runtime in printk-like format - `LT_LOGGER_CALLER` (1) - print calling method name - `LT_LOGGER_TASK` (1) - print calling FreeRTOS task (if available) diff --git a/docs/platform/beken-72xx/README.md b/docs/platform/beken-72xx/README.md index 79cbb51..551959d 100644 --- a/docs/platform/beken-72xx/README.md +++ b/docs/platform/beken-72xx/README.md @@ -1,5 +1,10 @@ # Beken 72xx +
+ +[Read flashing guide](flashing.md){ .md-button } +
+ ## Resources Name | Notes diff --git a/docs/platform/realtek-ambz/README.md b/docs/platform/realtek-ambz/README.md index 6d127fc..3b3d02a 100644 --- a/docs/platform/realtek-ambz/README.md +++ b/docs/platform/realtek-ambz/README.md @@ -1,5 +1,10 @@ # Realtek AmebaZ +
+ +[Read flashing guide](flashing.md){ .md-button } +
+ ## Resources Name | Notes diff --git a/docs/platform/realtek-ambz/debugging.md b/docs/platform/realtek-ambz/debugging.md index 4c03336..55ff768 100644 --- a/docs/platform/realtek-ambz/debugging.md +++ b/docs/platform/realtek-ambz/debugging.md @@ -6,7 +6,7 @@ Debugging of Realtek Ameba chips is possible and was tested with OpenOCD running LibreTuya has ready-to-use OpenOCD config files: -- [platform/realtek-ambz/openocd/amebaz.cfg](../../../platform/realtek-ambz/openocd/amebaz.cfg) +- [platform/realtek-ambz/openocd/amebaz.cfg](../../../cores/realtek-ambz/misc/amebaz.cfg) ## Local debugger diff --git a/platform.json b/platform.json index 636f5d0..e93ec23 100644 --- a/platform.json +++ b/platform.json @@ -51,7 +51,7 @@ "version": "https://github.com/libretuya/framework-beken-bdk#v2021.06.07", "version_prefix": true, "toolchains": { - "any":"gccarmnoneeabi@~1.100301.0" + "any": "gccarmnoneeabi@~1.100301.0" }, "libraries": { "freertos": "9.0.0",