actility / device-catalog

This repository contain all device profiles and public drivers.
22 stars 30 forks source link

twtg_RFGroup1_RP2-1.0.4_classA deviceProfileId does not reflect the actual RP version #29

Closed martinichka closed 2 months ago

martinichka commented 1 year ago

@mostafaibr

Events:

Current situation: deviceProfileId's descriptive name does not match with content (see FIXMEs in https://github.com/actility/device-catalog/pull/28)

Questions I have

  1. How to fix this specific case? Why can't we just update deviceProfileId? Can you draft a plan in what steps this can be corrected?
  2. How this can be avoided in the future? Maybe to explain in https://github.com/actility/device-catalog/tree/main/template#profile that the deviceProfileId should not be descriptive, but e.g. rather device family oriented
  3. What are the rules/guidelines regarding the deviceProfileId in the JSON and the file name? Do they need to be the same?
mostafaibr commented 1 year ago

Hello Marten,

I have accepted your PR for the fixes you have done on the description/names. For your questions:

  1. / 2. Let's keep the FIXME comment for now, and I will keep you updated about the fix to be done. I have requested the support of hide/deprecate feature of device profiles easily. This can fix the case where a mistake has been made in the IDs.

  2. Yes actually the file name of the profile should be the same as the ID. This rule is described here: https://github.com/actility/device-catalog/tree/main/template#profile : This ID of your profile should be used on your model.yaml on the field deviceProfileId. To avoid any future mistake related to that, I have added this comment in all the device profiles yaml: https://github.com/actility/device-catalog/blob/main/vendors/abeeway/profiles/ABEE-Badge-1.0.2b-AS.yaml#L10