Mirrors/tuya-cloudcutter
2
0
Fork 0
mirror of https://github.com/tuya-cloudcutter/tuya-cloudcutter.git synced 2026-02-19 21:51:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add video guides and flashing tools to README

Browse Source
This commit is contained in:
Kuba Szczodrzyński
2023-06-01 10:41:11 +02:00
parent 5b3815eb2b
commit 0b3dbd5c62
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -48,10 +48,12 @@ You can also contribute device dumps by [making an issue](https://github.com/tuy
Flash dumps of devices that have never been joined to Smart Life (or disconnected with a data wipe) are now generally acceptable. In order to not potentially leak personal information, that may be the preferred way.
Tools to dump flash from devices:
- https://github.com/tuya-cloudcutter/bk7231tools
- https://github.com/tuya-cloudcutter/lightleak (wireless dumping, still in development; testing is appreciated)
- [ltchiptool](https://docs.libretiny.eu/docs/flashing/tools/ltchiptool/) - universal flashing/dumping GUI tool
- [BK7231Flasher](https://github.com/openshwprojects/BK7231GUIFlashTool) - GUI tool for firmware backup and flashing OpenBeken
- [bk7231tools](https://github.com/tuya-cloudcutter/bk7231tools) - original toolset for dumping and analyzing Beken binaries
- [Lightleak](https://github.com/tuya-cloudcutter/lightleak) - wireless dumping, still in development; testing is appreciated
**Note:** other tools, such as hid_download_py or BkWriter, create incomplete dumps, or have data out-of-order which makes processing more difficult. Please use bk7231tools instead.
**Note:** other tools, such as hid_download_py or BkWriter, create incomplete dumps, or have data out-of-order which makes processing more difficult. Please use the tools outlined above instead.
- **Example dump command:** `bk7231tools read_flash -d COM5 device-make-and-model.bin`
- Since bk7231tools v1.0.0, the `-s` and `-c` parameters are not needed (additionally, `-c` is deprecated in favor of `-l/--length <bytes>`). The program now reads the entire flash contents by default.

12
custom-firmware/README.md
View File

@@ -1,20 +1,22 @@
# Custom Firmware
This is the directory you may place custom firmware for flashing. The selectable list will be automatically filtered to binaries that match your chosen profile. If you need newer or more custom firmware, you can add them here, abiding by the naming rules below. Custom firmware must be in the format of either Tuya's `UG` bin file for OTA or the `.uf2` file format.
# Naming rules
## Naming rules
If you place custom files here, they must include either `bk7231t` or `bk7231n` in the file name which will allow Tuya-CloudCutter to verify you are flashing a firmware that matches the profile you are using.
# Included 3rd party firmware
## Included 3rd party firmware
For convenience, binaries from the two most prevelant options, [ESPHome (Kickstart version by LibreTiny)](https://github.com/libretiny-eu/esphome-kickstart) and [OpenBeken (OpenBK7231T_App)](https://github.com/openshwprojects/OpenBK7231T_App) have been included automatically. All included binaries will flash your device with a firmware that will put the device into AP mode where you must connect and configure the device as appropriate.
### ESPHome (Kickstart by LibreTiny)
The AP provided by this firmware will start with `kickstart-` followed by the chip family name. You can connect with no password and configure your network information. Once connected you can enter the captive portal at IP address 192.168.4.1 where you will be able join the device to your local network. Once joined to your network, you can scan pin functionality and flash a custom updated firmware (with the .uf2 format) with a more customized configuration.
* See https://github.com/libretiny-eu/esphome-kickstart for guides and support.
* See https://www.youtube.com/watch?v=sSj8f-HCHQ0&t=497s for a video guide about configuring Kickstart and generating ESPHome configuration automatically.
* See https://github.com/libretiny-eu/esphome-kickstart for other guides and support.
* See https://github.com/libretiny-eu/esphome-kickstart/releases for the most recent binaries.
### OpenBekn (OpenBK7231T_App)
### OpenBeken (OpenBK7231T_App)
The AP provided by this firmware will start with `OpenBK` followed by the chip family name and part of the device's MAC address. Once connected you can enter the captive portal at IP address 192.168.4.1 where you will be able to join the device to your local network. Once joined to your network, you can begin configuring your device and use all tools available to OpenBeken.
* See https://github.com/openshwprojects/OpenBK7231T_App for guides and support.
* See https://www.youtube.com/watch?v=WunlqIMAdgw for a video guide about configuring OpenBeken, and finding pins and drivers automatically.
* See https://github.com/openshwprojects/OpenBK7231T_App for other guides and support.
* See https://github.com/openshwprojects/OpenBK7231T_App/releases for the most recent binaries.