Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Friendly/human readable/localized field on data #1488

Closed
AndreasSchutz opened this issue Oct 25, 2022 · 3 comments
Closed

Friendly/human readable/localized field on data #1488

AndreasSchutz opened this issue Oct 25, 2022 · 3 comments

Comments

@AndreasSchutz
Copy link

Is it possible to add a name field in data path? Ex. "electrical.batteries.1.voltage" could have a human readable field that contains "Motor battery" or something localized like "Motorbatteriets spänning". To be used for identification of data and in applications like InstrumentPanel.

@sbender9
Copy link
Member

You can use the path-mapper plugin. And if your client supports it, "displayName" meta data.

@tkurki
Copy link
Member

tkurki commented Oct 26, 2022

This issue is a bit confusing, as we have already some mechanisms for making the data more human understandable:

  • paths with device id as a path element can be mapped to more understandable ones: for example use path-mapper to map incoming n2k data (that use n2k device id) electrical.batteries.1.voltage => electrical.batteries.house.voltage
  • using metadata to add a displayName to a path and UIs like InstrumentPanel will use that instead of the path

One thing that we can't do now is having separate displayNames for a single path but different sources:

For example, both my depth sounder and speed log report water temperature. I can figure out which is which because of which hs the speed and which has depth, but it would be nice if I could alias n2k-on-ve.can-socket.2.0 to “depthsounder”

Localisation support is a separate issue.

@tkurki
Copy link
Member

tkurki commented Oct 26, 2022

Added SignalK/specification#646

@tkurki tkurki closed this as completed Jan 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants