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

Update profile-building readme to include notes about Smart Life app requirements.

Browse Source
This commit is contained in:
Cossid
2023-04-16 10:18:29 -05:00
parent ca40fd0d2f
commit 84c8fec7ac
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
profile-building/README.md
View File

@@ -12,6 +12,9 @@ Profile building requires the following packages:
You can install the packages using the command `pip install .` from the profile-building directory.
##### Smart Life application requirements (optional)
You may need the Smart Life mobile application if your dumped image does not contain a schema to control the device. The instructions included to pull schemas via Smart Life no longer work with the latest version of Smart Life (without specific and less convenient steps) due to application behavior changes. The instructions included only work with Smart Life application versions **4.8.2** and earlier. This applies to both the `pull_schema.py` and `check_upgrade.py` scripts. If your device requires a 3rd party app instead, required versions for those are currently unknown.
## Usage
The only file you should need to run is `build_profile.py`, all other necessary scripts will be called from that script, and will properly guide you through making a complete and usable profile, should all necessary data be present.
@@ -25,6 +28,6 @@ Before you begin, you must name your file to match a specific pattern. The form
* If there is a dash (-) present, it should be replaced with 3 consecutive dashes (---).
* Device type is simply the general function of the device like Smart Switch, RGBCT Bulb, or Temperature Sensor.
To run, execute `py build_profile.py <path_to_full_encrypted_2MiB.bin> [<token>]` (Example: `py build_profile.py Tuya-Generic_DS---101-Light-Switch` or `py build_profile Tuya-Generic_DS---101-Light-Switch EU1A2B3C4D5E6F`) where token is optional. If the device schema is not present in storage, you will be walked through connecting to the Tuya API to retreive a valid schema for the device. Please read all instructions presented on the screen. Token is not needed to be known in advance. If one is needed, the on-screen instructions will guide you through the process of generating one by using the Smart Life app on your local network.
To run, execute `py build_profile.py <path_to_full_encrypted_2MiB.bin> [<token>]` (Example: `py build_profile.py Tuya-Generic_DS---101-Light-Switch` or `py build_profile Tuya-Generic_DS---101-Light-Switch EU1A2B3C4D5E6F`) where token is optional. If the device schema is not present in storage, you will be walked through connecting to the Tuya API to retreive a valid schema for the device. Please read all instructions presented on the screen. Token is not needed to be known in advance. If one is needed, the on-screen instructions will guide you through the process of generating one by using the Smart Life app on your local network (see requirements above, as not all versions of the app work with the instructions provided).
If successful, the script will extract and decrypt your bin to a subdirectory matching the original filename, create several files for collected pieces of data, and create a `profile-classic` directory within that subdirectory when complete, which contains the usable profile that can be submitted to the <https://github.com/tuya-cloudcutter/tuya-cloudcutter.github.io> repository.