scratch/libretiny
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[core] Rename project to LibreTiny

Browse Source
This commit is contained in:
Kuba Szczodrzyński
2023-04-27 22:26:43 +02:00
parent 461e4c6df0
commit dbc905dca3
21 changed files with 54 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.github/workflows/docs.yml vendored
View File

@@ -33,13 +33,13 @@ jobs:
- name: Set custom domain
run: |
mkdir -p site/
echo docs.libretuya.ml > site/CNAME
echo docs.libretiny.eu > site/CNAME
- name: Deploy docs
uses: libretuya/mkdocs-deploy-gh-pages@master
uses: libretiny-eu/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CONFIG_FILE: mkdocs.yml
EXTRA_PACKAGES: build-base doxygen
REQUIREMENTS: docs/requirements.txt
CUSTOM_DOMAIN: docs.libretuya.ml
CUSTOM_DOMAIN: docs.libretiny.eu

18
README.md
View File

@@ -2,36 +2,42 @@
<div align="center" markdown>
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/kuba2k2/libretuya/Deploy%20docs%20on%20GitHub%20Pages?label=docs&logo=markdown)](https://kuba2k2.github.io/libretuya/)
![GitHub last commit](https://img.shields.io/github/last-commit/kuba2k2/libretuya?logo=github)
[![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 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)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Discord](https://img.shields.io/discord/967863521511608370?color=%235865F2&label=Discord&logo=discord&logoColor=white)](https://discord.gg/SyGCB9Xwtf)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/kuba2k2/platform/libretuya.svg)](https://registry.platformio.org/platforms/kuba2k2/libretuya)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/kuba2k2/platform/libretiny.svg)](https://registry.platformio.org/platforms/kuba2k2/libretiny)
![RTL8710BN](https://img.shields.io/badge/-rtl8710bn-blue)
![BK7231](https://img.shields.io/badge/-bk7231-blue)
</div>
## 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,
the project focuses on developing working Arduino-compatible cores for supported families. The cores are inspired by Espressif's official core for ESP32,
which should make it easier to port/run existing ESP apps on less-common, unsupported IoT modules.
**There's an [ESPHome port](https://docs.libretuya.ml/docs/projects/esphome/) based on LibreTiny, which supports BK7231 and RTL8710B chips.**
**There's an [ESPHome port](https://docs.libretiny.eu/docs/projects/esphome/) based on LibreTiny, which supports BK7231 and RTL8710B chips.**
**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/libretuya`
2. `platformio platform install -f https://github.com/kuba2k2/libretiny`
3. Create a project, build it and upload!
4. See the [docs](https://docs.libretuya.ml/) for any questions/problems.
4. See the [docs](https://docs.libretiny.eu/) for any questions/problems.
<!--
## Arduino Core support status

2
boards/generic-bk7231n-qfn32-tuya.json
View File

@@ -12,7 +12,7 @@
},
"name": "Generic - BK7231N (Tuya QFN32)",
"symbol": "BK7231N (Tuya QFN32)",
"url": "https://kuba2k2.github.io/libretuya/boards/generic-bk7231n-qfn32-tuya/",
"url": "https://docs.libretiny.eu/boards/generic-bk7231n-qfn32-tuya/",
"vendor": "Generic",
"pcb": {
"pinout": {

2
boards/generic-bk7231t-qfn32-tuya.json
View File

@@ -12,7 +12,7 @@
},
"name": "Generic - BK7231T (Tuya QFN32)",
"symbol": "BK7231T (Tuya QFN32)",
"url": "https://kuba2k2.github.io/libretuya/boards/generic-bk7231t-qfn32-tuya/",
"url": "https://docs.libretiny.eu/boards/generic-bk7231t-qfn32-tuya/",
"vendor": "Generic",
"pcb": {
"pinout": {

2
boards/generic-bk7252.json
View File

@@ -11,7 +11,7 @@
},
"name": "Generic - BK7252",
"symbol": "BK7252",
"url": "https://kuba2k2.github.io/libretuya/boards/generic-bk7252/",
"url": "https://docs.libretiny.eu/boards/generic-bk7252/",
"vendor": "Generic",
"pcb": {
"pinout": {

2
boards/generic-rtl8710bn-2mb-468k.json
View File

@@ -11,7 +11,7 @@
},
"name": "Generic - RTL8710BN (2M/468k)",
"symbol": "RTL8710BN (2M/468k)",
"url": "https://kuba2k2.github.io/libretuya/boards/generic-rtl8710bn-2mb-468k/",
"url": "https://docs.libretiny.eu/boards/generic-rtl8710bn-2mb-468k/",
"vendor": "Generic",
"pcb": {
"pinout": {

2
boards/generic-rtl8710bn-2mb-788k.json
View File

@@ -11,7 +11,7 @@
},
"name": "Generic - RTL8710BN (2M/788k)",
"symbol": "RTL8710BN (2M/788k)",
"url": "https://kuba2k2.github.io/libretuya/boards/generic-rtl8710bn-2mb-788k/",
"url": "https://docs.libretiny.eu/boards/generic-rtl8710bn-2mb-788k/",
"vendor": "Generic",
"pcb": {
"pinout": {

4
boards/generic-rtl8710bx-4mb-980k.json
View File

@@ -12,13 +12,13 @@
},
"name": "Generic - RTL8710BX (4M/980k)",
"symbol": "RTL8710BX (4M/980k)",
"url": "https://kuba2k2.github.io/libretuya/boards/generic-rtl8710bx-4mb-980k/",
"url": "https://docs.libretiny.eu/boards/generic-rtl8710bx-4mb-980k/",
"vendor": "Generic",
"doc": {
"extra": [
"## Information",
"This is a generic board definition for RTL8710BX with 4 MiB of flash. It has a bigger application partition size (980 KiB). The used bootloader is also different from the standard Tuya one.",
"It can be found in [Ezviz T31 smart plug](https://www.ezviz.com/product/T31/2021) - bare chip soldered onto the manufacturer-made PCB. The plug is not Tuya/SmartLife-compatible and has a 25Q32CSIG flash chip. Refer to [libretuya#23](https://github.com/kuba2k2/libretuya/issues/23) for photos and more information.",
"It can be found in [Ezviz T31 smart plug](https://www.ezviz.com/product/T31/2021) - bare chip soldered onto the manufacturer-made PCB. The plug is not Tuya/SmartLife-compatible and has a 25Q32CSIG flash chip. Refer to [libretiny#23](https://github.com/kuba2k2/libretiny/issues/23) for photos and more information.",
"Note that stock firmware seems to use smaller app images (0x80000 / 512 KiB). After 0x180000 some product-test data and device logs can be found. Because the OTA2 offset is 0x100000, the board definition was configured to use all available space."
]
},

2
boards/generic-rtl8720cf-2mb-992k.json
View File

@@ -12,7 +12,7 @@
},
"name": "Generic - RTL8720CF (2M/992k)",
"symbol": "RTL8720CF (2M/992k)",
"url": "https://kuba2k2.github.io/libretuya/boards/generic-rtl8720cf-2mb-992k/",
"url": "https://docs.libretiny.eu/boards/generic-rtl8720cf-2mb-992k/",
"vendor": "Generic",
"pcb": {
"pinout": {

0
cores/common/base/libretuya.h → cores/common/base/libretiny.h
View File

2
docs/README.md
View File

@@ -2,6 +2,6 @@
This documentation is best suited for rendering with MkDocs. Some elements may not display correctly in the GitHub markdown reader.
Please visit [https://docs.libretuya.ml/](https://docs.libretuya.ml/) for the full experience.
Please visit [https://docs.libretiny.eu/](https://docs.libretiny.eu/) for the full experience.
If you still want to read the docs on GitHub, visit [SUMMARY.md](../SUMMARY.md).

12
docs/flashing/tools/ltchiptool.md
View File

@@ -1,22 +1,22 @@
# ltchiptool
[ltchiptool](https://github.com/libretuya/ltchiptool) is a universal, easy-to-use GUI flashing/dumping tool for BK7231, RTL8710B and RTL8720C. It also contains some CLI utilities for binary firmware manipulation.
[ltchiptool](https://github.com/libretiny-eu/ltchiptool) is a universal, easy-to-use GUI flashing/dumping tool for BK7231, RTL8710B and RTL8720C. It also contains some CLI utilities for binary firmware manipulation.
<div align="center" markdown>
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPI](https://img.shields.io/pypi/v/ltchiptool)](https://pypi.org/project/ltchiptool/)
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/libretuya/ltchiptool?include_prereleases&label=GUI%20release)](https://github.com/libretuya/ltchiptool/releases/latest)
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/libretuya/ltchiptool?include_prereleases&label=GUI%20release)](https://github.com/libretiny-eu/ltchiptool/releases/latest)
<img src="https://raw.githubusercontent.com/libretuya/ltchiptool/master/.github/screenshot.png" style="height:500px">
<img src="https://raw.githubusercontent.com/libretiny-eu/ltchiptool/master/.github/screenshot.png" style="height:500px">
</div>
## Installation
<div align="center" markdown>
[:material-download-outline: Download Windows GUI](https://github.com/libretuya/ltchiptool/releases/latest){ .md-button }
[:material-download-outline: Download Windows GUI](https://github.com/libretiny-eu/ltchiptool/releases/latest){ .md-button }
</div>
### CLI program
@@ -26,7 +26,7 @@ Install the package from PyPI, using `pip install ltchiptool`. Run the CLI using
### GUI application
???+ quote "Windows 7 and newer"
Download the latest release .EXE from the [GitHub Releases page](https://github.com/libretuya/ltchiptool/releases/latest). Open the file, and you're ready to go!
Download the latest release .EXE from the [GitHub Releases page](https://github.com/libretiny-eu/ltchiptool/releases/latest). Open the file, and you're ready to go!
??? quote "Windows (manual installation)"
Install the package from PyPI (**including GUI extras**), using `pip install ltchiptool[gui]`. Note that Python 3.10 or newer is required for the GUI. I recommend Python 3.10 since it has [prebuilt wheels](https://pypi.org/project/wxPython/4.2.0/#files) of wxPython, which doesn't require C++ build dependencies.
@@ -96,7 +96,7 @@ If you want to flash unrecognized/raw binaries (or fine-tune the flashing parame
!!! note
If you're here to learn how to flash or dump firmware files, use the instructions above.
The content below serves as a short documentation page for [`ltchiptool`](https://github.com/libretuya/ltchiptool) and is mostly meant for advanced users.
The content below serves as a short documentation page for [`ltchiptool`](https://github.com/libretiny-eu/ltchiptool) and is mostly meant for advanced users.
```console
$ ltchiptool --help

2
docs/getting-started/README.md
View File

@@ -3,7 +3,7 @@
Using LibreTiny is simple, just like every other PlatformIO development platform.
1. [Install PlatformIO](https://platformio.org/platformio-ide)
2. `platformio platform install -f https://github.com/kuba2k2/libretuya`
2. `platformio platform install -f https://github.com/kuba2k2/libretiny`
## Board selection

2
docs/platform/realtek-ambz/flashing.md
View File

@@ -50,7 +50,7 @@ These tools are **not recommended** and are kept here for reference only. Don't
- [Flashing (Tuya manual)](https://developer.tuya.com/en/docs/iot/burn-and-authorize-wr-series-modules?id=Ka789pjc581u8)
- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip)
- [rtltool.py](https://github.com/libretuya/ltchiptool/blob/master/ltchiptool/soc/ambz/util/rtltool.py)
- [rtltool.py](https://github.com/libretiny-eu/ltchiptool/blob/master/ltchiptool/soc/ambz/util/rtltool.py)
OTA1/2 files can be flashed using `ImageTool_v2.3.1_AmebaZ(8710b)`. Browse and select one of the files and enter an appropriate address. Select COM port, press `Open` and then `Download`.

8
docs/projects/esphome.md
View File

@@ -28,8 +28,8 @@ If your board isn't listed, use one of the **Generic** boards, depending on the
Assuming you have PlatformIO, git and Python installed:
1. Open a terminal/cmd.exe, create `esphome` directory and `cd` into it.
2. `git clone https://github.com/kuba2k2/libretuya-esphome`
3. `cd` into the newly created `libretuya-esphome` directory.
2. `git clone https://github.com/kuba2k2/libretiny-esphome`
3. `cd` into the newly created `libretiny-esphome` directory.
4. Check if it works by typing `python -m esphome`
!!! tip
@@ -42,8 +42,8 @@ If your board isn't listed, use one of the **Generic** boards, depending on the
For this, you need Docker, Docker Compose and Python installed. After running the commands, you'll have a running ESPHome Dashboard interface that you can connect to.
1. `git clone https://github.com/kuba2k2/libretuya-esphome` (or download the .ZIP and unpack it, not recommended)
2. Open a terminal/cmd.exe in the cloned directory (`libretuya-esphome`).
1. `git clone https://github.com/kuba2k2/libretiny-esphome` (or download the .ZIP and unpack it, not recommended)
2. Open a terminal/cmd.exe in the cloned directory (`libretiny-esphome`).
3. `python docker/build.py --tag libretiny --arch amd64 --build-type docker build` - this will build the Docker image of ESPHome. Change `amd64` to something else if you're using a Raspberry Pi.
4. Create a `docker-compose.yml` file in the same directory:

2
docs/scripts/update_docs.py
View File

@@ -261,7 +261,7 @@ def write_families():
# Source SDK
"[`{}`]({})".format(
family.target_package,
f"https://github.com/libretuya/{family.target_package}",
f"https://github.com/libretiny-eu/{family.target_package}",
)
if family.target_package
else "-",

2
docs/style.css
View File

@@ -12,7 +12,7 @@ article a[href^="https://"]::after {
display: inline-block;
}
a[href^="https://docs.libretuya.ml"]::after,
a[href^="https://docs.libretiny.eu"]::after,
a[href^="http://localhost"]::after,
a[href^="https://"].md-button::after,
div[align="center"] a[href^="https://"]::after {

2
examples/PinScan/platformio.ini
View File

@@ -1,5 +1,5 @@
[env]
platform = libretuya
platform = libretiny
framework = arduino
[env:bk7231n]

4
mkdocs.yml
View File

@@ -1,8 +1,8 @@
site_name: LibreTiny
docs_dir: .
site_url: https://docs.libretuya.ml/
repo_url: https://github.com/kuba2k2/libretuya
site_url: https://docs.libretiny.eu/
repo_url: https://github.com/kuba2k2/libretiny
theme:
name: material

24
platform.json
View File

@@ -1,10 +1,10 @@
{
"name": "libretuya",
"name": "libretiny",
"title": "LibreTiny",
"description": "PlatformIO development platform for IoT modules",
"repository": {
"type": "git",
"url": "https://github.com/kuba2k2/platformio-libretuya"
"url": "https://github.com/kuba2k2/platformio-libretiny"
},
"version": "1.0.0-alpha.1",
"frameworks": {
@@ -21,7 +21,7 @@
"framework-realtek-amb1": {
"type": "framework",
"optional": true,
"version": "https://github.com/libretuya/framework-realtek-amb1#v2022.06.21",
"version": "https://github.com/libretiny-eu/framework-realtek-amb1#v2022.06.21",
"version_prefix": true,
"toolchains": {
"any": "gccarmnoneeabi@~1.100301.0"
@@ -39,7 +39,7 @@
"framework-realtek-ambz2": {
"type": "framework",
"optional": true,
"version": "https://github.com/libretuya/framework-realtek-ambz2#v2022.11.17",
"version": "https://github.com/libretiny-eu/framework-realtek-ambz2#v2022.11.17",
"version_prefix": true,
"toolchains": {
"any": "gccarmnoneeabi@~1.100301.0"
@@ -48,7 +48,7 @@
"framework-beken-bdk": {
"type": "framework",
"optional": true,
"version": "https://github.com/libretuya/framework-beken-bdk#v2021.06.07",
"version": "https://github.com/libretiny-eu/framework-beken-bdk#v2021.06.07",
"version_prefix": true,
"toolchains": {
"any": "gccarmnoneeabi@~1.100301.0"
@@ -66,29 +66,29 @@
"framework-arduino-api": {
"type": "framework",
"optional": true,
"version": "https://github.com/libretuya/ArduinoCore-API#2022.08.24"
"version": "https://github.com/libretiny-eu/ArduinoCore-API#2022.08.24"
},
"library-lwip": {
"type": "framework",
"optional": true,
"base_url": "https://github.com/libretuya/lwip"
"base_url": "https://github.com/libretiny-eu/lwip"
},
"library-freertos": {
"type": "framework",
"optional": true,
"base_url": "https://github.com/libretuya/library-freertos"
"base_url": "https://github.com/libretiny-eu/library-freertos"
},
"library-freertos-port": {
"type": "framework",
"version": "https://github.com/libretuya/library-freertos-port#2023.03.13"
"version": "https://github.com/libretiny-eu/library-freertos-port#2023.03.13"
},
"library-flashdb": {
"type": "framework",
"version": "https://github.com/libretuya/library-flashdb#1.2.0"
"version": "https://github.com/libretiny-eu/library-flashdb#1.2.0"
},
"library-printf": {
"type": "framework",
"version": "https://github.com/libretuya/library-printf#6.1.0"
"version": "https://github.com/libretiny-eu/library-printf#6.1.0"
},
"toolchain-gccarmnoneeabi": {
"type": "toolchain",
@@ -101,7 +101,7 @@
},
"tool-ltchiptool": {
"type": "uploader",
"version": "https://github.com/libretuya/ltchiptool#v4.0.0a4",
"version": "https://github.com/libretiny-eu/ltchiptool#v4.0.0a4",
"version_prefix": true,
"note": "This is used only for C/C++ code from ltchiptool."
},

2
platform.py
View File

@@ -103,7 +103,7 @@ def get_os_specifiers():
]
class LibretuyaPlatform(PlatformBase):
class LibretinyPlatform(PlatformBase):
custom_opts: Dict[str, object] = None
versions: Dict[str, str] = None