diff --git a/README.md b/README.md index 6a8420b..5cec670 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # LibreTiny +(formerly LibreTuya) +
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/kuba2k2/libretiny/Deploy%20docs%20on%20GitHub%20Pages?label=docs&logo=markdown)](https://kuba2k2.github.io/libretiny/) +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/kuba2k2/libretiny/docs.yml?label=docs&logo=markdown)](https://kuba2k2.github.io/libretiny/) ![GitHub last commit](https://img.shields.io/github/last-commit/kuba2k2/libretiny?logo=github) [![Code style: clang-format](https://img.shields.io/badge/code%20style-clang--format-purple.svg)](.clang-format) @@ -16,12 +18,6 @@
-## LibreTuya is now LibreTiny! šŸŽ‰ - -We have [renamed the project](https://github.com/kuba2k2/libretiny/issues/92) to LibreTiny, also marking the very first v1.0.0 release, along with a huge structure refactor. While some care has been taken to ensure that things don't break, you may still need to update some references in your code to use the new name. - ---- - PlatformIO development platform for IoT modules manufactured by Tuya Inc. The main goal of this project is to provide a usable build environment for IoT developers. While also providing vendor SDKs as PlatformIO cores, @@ -32,62 +28,11 @@ which should make it easier to port/run existing ESP apps on less-common, unsupp **Note:** this project is work-in-progress. -## Usage +
-1. [Install PlatformIO](https://platformio.org/platformio-ide) -2. `platformio platform install -f https://github.com/kuba2k2/libretiny` -3. Create a project, build it and upload! -4. See the [docs](https://docs.libretiny.eu/) for any questions/problems. +## [ā­ Getting started ā­](https://docs.libretiny.eu/docs/getting-started/) - +
## License diff --git a/SUMMARY.md b/SUMMARY.md index f5ede20..6d8fbbb 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,14 +1,15 @@ * [Home](README.md) -* [](SUMMARY.md) * [šŸ˜Š Getting started](docs/getting-started/README.md) * [āž”ļø Info on accessing GPIOs](docs/getting-started/gpio.md) +* [](SUMMARY.md) * [šŸ“ŗ Cloudcutter & ESPHome video guide](https://www.youtube.com/watch?v=sSj8f-HCHQ0) * [šŸ’” ESPHome setup guide](docs/projects/esphome.md) * [šŸ›– ESPHome Hassio Add-On](https://github.com/libretiny-eu/esphome-hass-addon/pkgs/container/libretiny-esphome-hassio) * [](SUMMARY.md) * [šŸ“² Flashing/dumping guide](docs/flashing/) * [šŸ”Œ How to flash/enter download mode?](docs/platform/) -* [šŸ’» Supported chips](docs/status/supported.md) +* [](SUMMARY.md) +* [šŸ’» Chips, boards, features](docs/status/supported.md) * [All boards](boards/) * [](SUMMARY.md) * šŸŖ Chip family docs & info diff --git a/docs/status/arduino.md b/docs/status/arduino.md deleted file mode 100644 index 041b3d4..0000000 --- a/docs/status/arduino.md +++ /dev/null @@ -1,7 +0,0 @@ -# Implementation status - -{% - include-markdown "../../README.md" - start="\n## Arduino Core support status\n" - end="\n## License\n" -%} diff --git a/docs/status/supported.md b/docs/status/supported.md index 1e2fa92..bcc15a2 100644 --- a/docs/status/supported.md +++ b/docs/status/supported.md @@ -26,12 +26,49 @@ A list of chip families currently supported by this project. !!! note The term *family* was chosen over *platform*, in order to reduce possible confusion between LibreTiny supported "platforms" and PlatformIO's "platform", as an entire package. *Family* is also more compatible with the UF2 term. -The following list corresponds to UF2 OTA format family names, and is also [available as JSON](../../families.json). The IDs are also present in [lt_types.h](../../ltapi/lt__types_8h.md). +The following list corresponds to UF2 OTA format family names, and is also [available as JSON](../../families.json). The IDs are also present in [lt_types.h](../../ltapi/lt__types_8h.md). You can view the family list by using `ltchiptool list families`. {% include-markdown "./supported_families.md" %} +## Feature support + +If you notice a feature that you've tested, which works (or not) and doesn't match this table, feel free to submit an issue on GitHub. + +  | `BK7231T` | `BK7231N` | `RTL8710B` | `RTL8720C` | `BK7231Q` +-------------------------|-----------|-----------|------------|------------|---------- +Stability | 5/5 | 5/5 | 4/5 | 2/5 | 1/5 +LibreTiny Core | āœ”ļø | āœ”ļø | āœ”ļø | āœ”ļø | āœ”ļø +Wiring Core | āœ”ļø | āœ”ļø | āœ”ļø | āœ”ļø | āœ”ļø +**PERIPHERALS** (Core) | | | | | +UART I/O | āœ”ļø | āœ”ļø | āœ”ļø | āœ”ļø | āœ”ļø +Flash I/O | āœ”ļø | āœ”ļø | āœ”ļø | ā“ | ā“ +Deep sleep | ā“ | āœ”ļø | āŒ | āŒ | ā“ +Watchdog timer | āœ”ļø | āœ”ļø | āœ”ļø | ā“ | ā“ +**PERIPHERALS** (Wiring) | | | | | +Digital I/O | āœ”ļø | āœ”ļø | āœ”ļø | ā“ | ā“ +PWM | āœ”ļø | āœ”ļø | āœ”ļø | ā“ | ā“ +Interrupts | āœ”ļø | āœ”ļø | āœ”ļø | ā“ | ā“ +Analog input (ADC) | āœ”ļø | āœ”ļø | āœ”ļø | ā“ | ā“ +`Wire` (IĀ²C) | āŒ | āŒ | ā— | āŒ | āŒ +`SPI` | āŒ | āŒ | āŒ | āŒ | āŒ +`Serial` | āœ”ļø | āœ”ļø | āœ”ļø | āœ”ļø | ā“ +`SoftwareSerial` | āŒ | āŒ | āœ”ļø | āŒ | āŒ +**NETWORKING** | | | | | +Wi-Fi STA/AP/Mixed | āœ”ļø | āœ”ļø | āœ”ļø | ā“ | āŒ +Wi-Fi Events | āœ”ļø | āœ”ļø | āœ”ļø | ā“ | āŒ +OTA updates | āœ”ļø | āœ”ļø | āœ”ļø | āŒ | āŒ +MDNS | āœ”ļø | āœ”ļø | āœ”ļø | ā“ | ā“ + +Symbols: + +- āœ”ļø working +- ā“ untested +- ā— broken +- āŒ not implemented (yet?) +- \- not applicable + ## Unsupported boards ### Tuya Inc.