ioBroker / ioBroker.type-detector

Helper module (not adapter) to detect types of devices
MIT License
8 stars 9 forks source link

indicator.error is not valid state role #23

Open o0shojo0o opened 3 years ago

o0shojo0o commented 3 years ago

The role indicator.error is not valid. This is used everywhere here! https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/stateroles.md#indicators-boolean-read-only

Garfonso commented 3 years ago

Looking at indicator.maintenance - indicates system warnings/errors, alarms, service messages, battery empty or stuff like that ERROR seems to be a bit redundant with MAINTENANCE. So one possibility would be to scrap ERROR and only use MAINTENANCE and allow the regex to accept indicator.error.

If ERROR should still be a different thing, then my proposal would be that the role should change to indicator.maintenance.error and docs and code be updated accordingly.

@GermanBluefox what is your opinion?

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs within the next 7 days. Please check if the issue is still relevant in the most current version of the adapter and tell us. Also check that all relevant details, logs and reproduction steps are included and update them if needed. Thank you for your contributions. Dieses Problem wurde automatisch als veraltet markiert, da es in letzter Zeit keine Aktivitäten gab. Es wird geschlossen, wenn nicht innerhalb der nächsten 7 Tage weitere Aktivitäten stattfinden. Bitte überprüft, ob das Problem auch in der aktuellsten Version des Adapters noch relevant ist, und teilt uns dies mit. Überprüft auch, ob alle relevanten Details, Logs und Reproduktionsschritte enthalten sind bzw. aktualisiert diese. Vielen Dank für Eure Unterstützung.

Apollon77 commented 2 years ago

@GermanBluefox ? What do you think?

Garfonso commented 2 years ago

I can create a PR for it, if wanted.

mcm1957 commented 1 year ago

I cannot see any error.xx roles here https://github.com/ioBroker/ioBroker.docs/blob/master/docs/en/dev/stateroles.md#indicators-boolean-read-only

Possibly this Issue is obolete?

Garfonso commented 1 year ago

Yes, that is the problem. There are no indicator.error roles defined, but they are used in type-detector, for example here https://github.com/ioBroker/ioBroker.type-detector/blob/master/index.js#L80

mcm1957 commented 1 year ago

OK, sorry - i read the issue the other way round. :-)

But I do not see if error.xxx is required. There are maintanance.xxx and alarm.xxx anyway.

Garfonso commented 1 year ago

Today I thought I'd create a PR, but I recognized that defaultType for ERROR is 'string'. So it seems to be meant for a error message or something?

But that would not fit well with the indicator.* prefix, which is meant to be boolean. So, if ERROR should be meant to contain some human-readable error description, which might be useful (I have some devices that report something like that in KNX) to have a generic field for all possible devices, we might keep it but change the role to text.error and add the role to our ever-growing list of allowed roles. :-)

Any thoughts on this? I could not find an Adapter that really uses/interprets the ERROR field, tbh. (Apart from lovelace Adapter, but lovelace interprets ERROR as boolean, currently, which is, as said above, redundant with MAINTAIN, so I'd change it there, too or get rid of it).