[docs] Update configuration docs
This commit is contained in:
@@ -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.
|
||||
|
||||
<!--
|
||||
## Arduino Core support status
|
||||
|
||||
Note: this list will probably change with each functionality update.
|
||||
@@ -57,10 +58,10 @@ TCP Server | ✔️ | ✔️
|
||||
IPv6 | ❌ | ❌
|
||||
HTTP Client (SSL) | ✔️ (✔️) | ❓
|
||||
HTTP Server | ✔️ | ✔️
|
||||
NVS / Preferences | ❌ | ❌
|
||||
NVS / Preferences | ✔️ | ✔️
|
||||
SPIFFS | ❌ | ❌
|
||||
BLE | - | ❌
|
||||
NTP | ❌ | ❌
|
||||
NTP | ✔️ | ✔️
|
||||
OTA | ✔️ | ✔️
|
||||
MDNS | ✔️ | ✔️
|
||||
MQTT | ✅ | ❌
|
||||
@@ -80,6 +81,7 @@ Names:
|
||||
- Core functions - stuff like delay(), millis(), yield(), etc.
|
||||
- **CORE LIBRARIES** - included normally in all Arduino cores
|
||||
- **OTHER LIBRARIES** - included in ESP32 core or downloadable
|
||||
-->
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Beken 72xx
|
||||
|
||||
<div align="center" markdown>
|
||||
|
||||
[Read flashing guide](flashing.md){ .md-button }
|
||||
</div>
|
||||
|
||||
## Resources
|
||||
|
||||
Name | Notes
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Realtek AmebaZ
|
||||
|
||||
<div align="center" markdown>
|
||||
|
||||
[Read flashing guide](flashing.md){ .md-button }
|
||||
</div>
|
||||
|
||||
## Resources
|
||||
|
||||
Name | Notes
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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",
|
||||
|
||||
Reference in New Issue
Block a user