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

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 {