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

[docs] Rewrite flashing guides

Browse Source
This commit is contained in:
Kuba Szczodrzyński
2023-08-17 17:17:10 +02:00
parent ccf21b4eab
commit ef6dd35977
25 changed files with 264 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/inc/find-board.md Normal file
View File

@@ -0,0 +1 @@
You need to know which board your device uses. Head to [Supported Boards](../status/supported.md) to find it. A good number of popular boards have their dedicated support and documentation pages in LibreTiny. Otherwise, you have to use one of the **Generic** boards that matches the CPU model of your device.

8
docs/inc/ota-cloudcutter.md Normal file
View File

@@ -0,0 +1,8 @@
## Converting devices with tuya-cloudcutter
!!! note
This currently applies to BK7231T and BK7231N only. `tuya-cloudcutter` can't be used for other chips.
Grab the `image_bk7231x_app.ota.ug.bin` file from the build directory - take care to choose the correct file. It must have "OTA" and "UG" in its name.
Next, refer to [Using tuya-cloudcutter](../flashing/tools/cloudcutter.md) guide.

5
docs/inc/ota-openbeken.md Normal file
View File

@@ -0,0 +1,5 @@
## Migrating from OpenBeken (OTA)
[OpenBeken](https://github.com/openshwprojects/OpenBK7231T_App) is a custom, Tasmota-like firmware for non-ESP chips. Currently, this part of the guide applies to BK7231 only, as that's the only chip supported both by LT and OBK.
OBK is compatible with standard Beken OTA packages, but the web panel does a filename check to prevent chip type mismatch. Grab the `image_bk7231t_app.ota.rbl` file from build directory (note: without "UG" in the name!), rename it to something like `OpenBK7231T_esphome.rbl` (change T to N depending on the chip type), and drop it on the OTA panel.

1
docs/inc/uart-adr.md Normal file
View File

@@ -0,0 +1 @@
If you have a recent version of LibreTiny already installed on the chip, you don't need to perform any steps to enter download mode. Instead, [Auto-download-reboot](../flashing/tools/adr.md) will reboot the chip automatically, as soon as it notices the flasher program. This is enabled by default, so you don't have to configure anything.

4
docs/inc/uart-cen.md Normal file
View File

@@ -0,0 +1,4 @@
!!! note
"CEN" pin is the RESET pin - connecting it to GND will keep the chip in "reset" state. Disconnecting it will allow the chip to start back up.
If you're having issues with using CEN pin (or if it's not accessible on your device) you can toggle the 3.3V power instead. Removing power will keep it in "reset", and applying it back will start it again.

1
docs/inc/uart-info.md Normal file
View File

@@ -0,0 +1 @@
The device needs to be connected to your PC with a UART-TTL adapter. Refer to [chip connection guides](../platform/SUMMARY.md) to learn how to connect your device.

6
docs/inc/uart-ltchiptool.md Normal file
View File

@@ -0,0 +1,6 @@
## Using ltchiptool (wired, via UART)
You can use the [ltchiptool](../flashing/tools/ltchiptool.md) GUI or CLI to manually flash the firmware. Grab the `firmware.uf2` file from the build directory. Then, follow the [ltchiptool usage guide](../flashing/tools/ltchiptool.md) to flash it to the device.
!!! tip
The UF2 file may have a different name, depending on the project you're building. Usually it's best to grab the latest (sorted by date) file with UF2 extension from the build directory.

4
docs/inc/uart-power.md Normal file
View File

@@ -0,0 +1,4 @@
!!! warning "Important"
Using a **good, stable 3.3V power supply** is crucial. Most flashing issues are caused by either voltage drops during intensive flash operations, or bad/loose wires. The UART adapter's 3.3V power regulator is usually **not enough**.
Instead, a regulated bench power supply, or a linear 1117-type regulator is recommended.