dresden-elektronik / deconz-rest-plugin

deCONZ REST-API plugin to control ZigBee devices
BSD 3-Clause "New" or "Revised" License
1.9k stars 503 forks source link

Improve Display of `vendor` and `product` Keys in DDF Store #7794

Closed Zehir closed 3 months ago

Zehir commented 5 months ago

Improve Display of vendor and product Keys in DDF Store

This PR aims to enhance the user experience by providing more meaningful values for the vendor and product keys in the DDF store.

Changes include:

  1. Vendor Key: The value is now more reflective of the directory name, starting with a capital letter. In some cases, it matches the vendor name as found on the internet, providing a more recognizable reference for users. There are some exceptions to this rule, such as Xiaomi, which is split into Xiaomi Aqara and Xiaomi Mi to provide more specific vendor information.

  2. Product Key: The product key now displays the name of the product in English, with the model ID appended in parentheses at the end. In cases where multiple model IDs exist, they are separated by a /.

  3. Note: Some DDFs, like those for Lidl, have been moved to their respective directories to maintain a clean and organized structure. They was previously in the Tuya directory.

These changes aim to make the DDF store more user-friendly and intuitive, by ensuring that key information is displayed in a clear and meaningful way.

Please review and provide any feedback.

github-actions[bot] commented 5 months ago

Hey @Zehir, thanks for your pull request!

[!TIP] Modified bundles can be downloaded here. Relative expire date

DDB changes

Modified

Validation

[!TIP] Everything is fine !

:clock10: Updated for commit 65d59751b3c3e797d0e14629dcf52101327db604

Zehir commented 5 months ago

I have formated the manufacturername and modelid of https://github.com/dresden-elektronik/deconz-rest-plugin/blob/3e93eb55ae9c4f4f49c6a05051733619005c1b8a/devices/tuya/ts0202_presence_sensor.json#L4-L9

And found TZ3000_tiwq83wk instead of _TZ3000_tiwq83wk like all tuya name there is an underscore prefix. The only reference found to it is #7308 I also found references with the underscore on other zigbee projects.

@Smanar Any idea ?

Smanar commented 5 months ago

It's a typo, the good manufacture name is "_TZ3000_tiwq83wk" for sure.

Zehir commented 5 months ago

OK this PR is now ready to merge

Zehir commented 5 months ago

Thanks, I removed the spaces @manup

Zehir commented 3 months ago

@manup what we do with this PR ?

manup commented 3 months ago

Before starting to merge the other device PRs I'd like to get this in to hopefully have less merge conflicts.

Since we don't have a conclusion yet for the Develco DDFs, we have two options:

  1. Merge now, fixup later
  2. Exclude Develco DDFs from this PR, also fixup later

Note the PR is only about the user facing strings like they are shown in pages like:

https://deconz-community.github.io/ddf-tools/#/store/search https://dresden-elektronik.github.io/deconz-rest-doc/devices

Imho we won't get a perfect solution with one PR but need to improve and align the strings over time.

@Zehir @SwoopX what do you think?

Zehir commented 3 months ago

For me both is ok. But i would like to not wait more time to avoid more merge conflicts

SwoopX commented 3 months ago

Well, I guess we can move ahead and pursue option 1 to get that thing out of the way 🙂

github-actions[bot] commented 3 months ago

This pull request is now merged. The new DDB files have been uploaded to the store.

DDB Files

Modified

:clock3: Updated for commit d648c8bd7a31bc6b16b8c02585dc0825ec9ed99f