Improve voice instructions

[Trietes]

Issue

This pull request will solve issue #4640, so improves the voice instructions which can be used by navigation SDKs. I'm replacing pull request #4696 with this one.

Tasklist

• Add tests
• Add #fixes with the issue number that this PR addresses
• Update the changelog

[Trietes]

This would be ready from my side now. Anybody feel free to review the code. I'm already using this changes in an production environment for navigation and @ianthetechie also gave it a test and it seems to work fine. I hope @eikes will also try it out and share his feedback soon.
There is still quiet some optimization potential left, but I think this should make Valhalla being usable with the navigation SDKs. So if we get this merged, people might start using Valhalla for those SDKs and we can collect more feedback and continue further improving the voice instructions.

Maybe another thing: Should we mention somewhere in the README that Valhalla is compatible with the navigation SDKs? I think that's quiet a good selling point for using Valhalla over other routing engines.

[ianthetechie]

@Trietes Yeah, we've been using it in prod for a while too and it hasn't caused any ill effects (though to be fair that code path isn't widely used yet).

Maybe another thing: Should we mention somewhere in the README that Valhalla is compatible with the navigation SDKs? I think that's quiet a good selling point for using Valhalla over other routing engines.

Good question... maybe there should be a link section talking about ways you can use / integrate it... or an awesome-valhalla repo, like many other orgs seem to have 😂

Not to be overly pedantic, but the big 3 for me (Valhalla, OSRM, and GraphHopper) all have some sort of OSRM-flavored output, and will at least marginally work with the navigation SDKs with some effort ;) It just takes some effort haha.

I am going to guess you're talking about the MapLibre Navigation SDKs, which are forks of old open-source Mapbox code. There are a lot of rough edges, but yes, the response format is compatible so once you get the thorny request issues worked out, it's a pretty solid integration.

I have some opinions about the current state of affairs wrt open-source navigation SDKs, so I started fresh on a "next-gen" navigation SDK, which solves these integration issues much more elegantly. Since I'm also using Valhalla, there is already a first-class Valhalla integration, but adding OSRM or GraphHopper would be pretty easy. It's beta quality right now, but if you're interested to contribute, check out Ferrostar.

[ianthetechie]

@Trietes it looks like this branch has diverged a bit now and conflicts with some other changes. Think you could do a quick cleanup pass?

[kevinkreiser]

hi all, i am wonder the same as @ianthetechie please let me know if this is ready for review and shipping and we'll be happy to queue it up for our weekly review

[eikes]

I have read the changes and they seem to be good. I have not tried them using an actual device yet though. I have made some changes which make it a little easier to read though:

eikes@5dcdab0

[Trietes]

I like the changes done by @eikes in eikes@5dcdab0. There might also be some conflicts to the main branch du to #4742. So this is in generally ready for review, but needs the mentioned updates. I've to see when I've some time for updating the branch.

[Trietes]

This is ready from my side now

[kevinkreiser]

excellent at the latest we will take a look by Monday if not before then