Add README about locally testing profiles

This commit is contained in:
Kuba Szczodrzyński
2022-12-02 18:59:01 +01:00
parent dce1ae1854
commit 210aed18b6

View File

@@ -9,3 +9,19 @@ https://github.com/tuya-cloudcutter/tuya-cloudcutter.github.io
---
If you'd like to submit a profile you generated, create a pull request **to the repo above**, not `tuya-cloudcutter`.
## Testing custom profiles
After generating a profile, you'll get two files in `profile-classic` directory. You can rename the one in `profile-classic/devices/` however you want, and update its `manufacturer` and `name` strings. Do not change any other fields, as well as the file in `profile-classic/profiles/`.
These two files can be added to [tuya-cloudcutter.github.io](https://github.com/tuya-cloudcutter/tuya-cloudcutter.github.io) repository in a pull request.
To test the profile locally, you can copy the 2 JSONs (without any parent directories) to a subdirectory in `device-profiles`, like this:
```
device-profiles/
├─ your-device-name/
│ ├─ your-device-name.json
│ ├─ oem-bk7231n-dctrl-switch-1.1.0-sdk-2.3.1-40.00.json
```
and run `./run_flash.sh -p your-device-name` or `./run_detach.sh -p your-device-name`.