nav: add README (#26802)

* start docs

* Update README.md
pull/26803/head
Adeeb Shihadeh 2 years ago committed by GitHub
parent 9743b37cf2
commit 8d95faf97a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 24
      selfdrive/navd/README.md
  2. 0
      selfdrive/navd/set_destination.py

@ -0,0 +1,24 @@
# navigation
This directory contains two daemons, `navd` and `map_renderer`, which support navigation in the openpilot stack.
### navd
`navd` takes in a route through the `NavDestination` param and sends out two packets: `navRoute` and `navInstruction`. These packets contain the coordinates of the planned route and turn-by-turn instructions.
### map renderer
The map renderer listens for the `navRoute` and publishes a rendered map view over VisionIPC for the navigation model, which lives in `selfdrive/modeld/`. The rendered maps look like this:
![](https://i.imgur.com/oZLfmwq.png)
## development
Currently, [mapbox](https://www.mapbox.com/) is used for navigation.
* get an API token: https://docs.mapbox.com/help/glossary/access-token/
* set an API token using the `MAPBOX_TOKEN` environment variable
* routes/destinations are set through the `NavDestination` param
* use `set_destination.py` for debugging
* edit the map: https://www.mapbox.com/contribute
* mapbox API playground: https://docs.mapbox.com/playground/
Loading…
Cancel
Save