You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I don't want to come off the wrong way, but I do wish the terminology was more user-friendly. And it kinda seems like a lot of it is up to the manufacturer, too. There's just a lot of technical implementation details in the UI
Problem: Manufacturer chosen naming and terminology, that regular users would find confusing, ends up in the UI. What does EP2 or Lifeline mean?!
My ideas:
Include hover-over hints and/or inline explanations of features, terminology, etc. in more places. When viewing a node, the Values header could state that the values are populated from the device. The implication being that Z-Wave JS is only showing what it's given. This might help people understand why some nodes have certain values and why other nodes might not.
Glossary - it could help explain what an Endpoint is in relation to a Node, let's say (and that a Node is essentially a device). Or it could define Association and its implications (like if two endpoints are associated, it means one can control the other). Maybe visual diagrams of the hierarchy, too?
Guides - Basically, how-to's for popular configurations. Grouping nodes or... how to figure out which endpoint to use when creating an association or... How to setup scenes in Home Assistant using Z-Wave JS.
Link to relevant docs in the UI - ex. add a docs link on the Scenes page which explains what it's used for, as well as how to use it.
The docs for the developer and user-side of things need to be distinguished, in my opinion. I googled "z-wave js docs" and the first hit is the page for node-zwave-js which isn't what a typical user needs. Maybe the various documentation pages can link to each other via a message at the top pointing people in the correct direction.
These ideas are only bandaids, though.
The only other idea I had to actually solve this problem is to create "translations" that would normalize the terminology. This seems like a huge task to me, though.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
For context, this is the Discord message that inspired this discussion
Problem: Manufacturer chosen naming and terminology, that regular users would find confusing, ends up in the UI.
What does EP2 or Lifeline mean?!
My ideas:
Values
header could state that the values are populated from the device. The implication being that Z-Wave JS is only showing what it's given. This might help people understand why some nodes have certain values and why other nodes might not.Endpoint
is in relation to aNode
, let's say (and that a Node is essentially a device). Or it could defineAssociation
and its implications (like if two endpoints are associated, it means one can control the other). Maybe visual diagrams of the hierarchy, too?These ideas are only bandaids, though.
The only other idea I had to actually solve this problem is to create "translations" that would normalize the terminology. This seems like a huge task to me, though.
Beta Was this translation helpful? Give feedback.
All reactions