aboutsummaryrefslogtreecommitdiffstats
path: root/docs/06_Component_Documentation
diff options
context:
space:
mode:
authorNaoto Yamaguchi <naoto.yamaguchi@aisin.co.jp>2024-08-10 07:12:36 +0900
committerWalt Miner <walt@linux.com>2024-08-19 20:50:29 +0000
commitfc47271f7ce19cb79b61d00e1fd2b55fa8533171 (patch)
treedb5163ab05b276f28a28e09f7af357cd50331474 /docs/06_Component_Documentation
parent659e794ca9dcef176aaca10020aa194fb7078a19 (diff)
Add Momi Navi information to documentation
The Momi Navi need few environment variable to show map and customize view. This patch add these information. Bug-AGL: SPEC-5224 Change-Id: I00d62cd3303ef9d44f39ca5413f31036343afde8 Signed-off-by: Naoto Yamaguchi <naoto.yamaguchi@aisin.co.jp> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/30163 Reviewed-by: Walt Miner <walt@linux.com> Tested-by: Walt Miner <walt@linux.com>
Diffstat (limited to 'docs/06_Component_Documentation')
-rw-r--r--docs/06_Component_Documentation/01_AGL_components.md5
-rw-r--r--docs/06_Component_Documentation/Demo_Application/01_Momi_Navi.md35
-rw-r--r--docs/06_Component_Documentation/Demo_Application/images/mominavi.jpgbin0 -> 20411 bytes
3 files changed, 40 insertions, 0 deletions
diff --git a/docs/06_Component_Documentation/01_AGL_components.md b/docs/06_Component_Documentation/01_AGL_components.md
index 3508096..4aa9a17 100644
--- a/docs/06_Component_Documentation/01_AGL_components.md
+++ b/docs/06_Component_Documentation/01_AGL_components.md
@@ -24,3 +24,8 @@ title: AGL Components
### Application Lifecycle and Services
- [Application Framework](Application_Framework/01_Introduction.md)
+
+### Application for Demo
+
+- [Momi Navi](Demo_Application/01_Momi_Navi.md)
+
diff --git a/docs/06_Component_Documentation/Demo_Application/01_Momi_Navi.md b/docs/06_Component_Documentation/Demo_Application/01_Momi_Navi.md
new file mode 100644
index 0000000..ac0f886
--- /dev/null
+++ b/docs/06_Component_Documentation/Demo_Application/01_Momi_Navi.md
@@ -0,0 +1,35 @@
+---
+title: Momi Navi
+---
+
+# What is Momi Navi
+
+Momi Navi is a example application for navigation. It run on simple ivi demo (that name is momi IVI) for the instrument cluster container integration.
+
+![](images/mominavi.jpg)
+
+## How to use
+
+When you build the instrument cluster integration without momi navi specific setting, it will not show map. You need momi navi specific setting.
+
+The momi navi uses mapbox gl plugin fo Qt location. It requires own access token to download map. You can create own mapbox access token following [this page](https://docs.mapbox.com/help/getting-started/access-tokens/).
+
+After creation, please set environment variable to local.conf (or site.conf).
+
+```
+MOMIMAP_MAPBOX_ACCESS_TOKEN = "Your access token."
+```
+
+## Extra configuration
+
+Momi navi supports configuration for customize.
+
+When you set environment variable to local.conf (or site.conf), you can customize Momi navi.
+
+| Environment variable | Customizing parametor |
+|:---|:---|
+| MOMIMAP_MAPBOX_STYLE | Map style |
+| MOMIMAP_INITIAL_LATITUDE | Default location |
+| MOMIMAP_INITIAL_LONGITUDE | Default location |
+
+How to create map style, please check [this page](https://docs.mapbox.com/studio-manual/guides/map-styling/).
diff --git a/docs/06_Component_Documentation/Demo_Application/images/mominavi.jpg b/docs/06_Component_Documentation/Demo_Application/images/mominavi.jpg
new file mode 100644
index 0000000..8e30c05
--- /dev/null
+++ b/docs/06_Component_Documentation/Demo_Application/images/mominavi.jpg
Binary files differ