Add Momi Navi information to documentation 63/30163/3
authorNaoto Yamaguchi <naoto.yamaguchi@aisin.co.jp>
Fri, 9 Aug 2024 22:12:36 +0000 (07:12 +0900)
committerWalt Miner <walt@linux.com>
Mon, 19 Aug 2024 20:50:29 +0000 (20:50 +0000)
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>
docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md
docs/06_Component_Documentation/01_AGL_components.md
docs/06_Component_Documentation/Demo_Application/01_Momi_Navi.md [new file with mode: 0644]
docs/06_Component_Documentation/Demo_Application/images/mominavi.jpg [new file with mode: 0644]

index 59374de..a513190 100644 (file)
@@ -370,6 +370,13 @@ UI.
 
 Please refer to Appendix 3.
 
+## Frequently Asked Questions
+
+| Questions | Answer |
+|:---|:---|
+| Why not show map in default screen of Momi IVI. | When you want show map, you need extra step.  Please fallow [this page](../../06_Component_Documentation/Demo_Application/01_Momi_Navi.md).|
+
+
 ## Appendix.1.  Typical Hardware set.
 
 ### AGL Reference Hardware.
index 3508096..4aa9a17 100644 (file)
@@ -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 (file)
index 0000000..ac0f886
--- /dev/null
@@ -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 (file)
index 0000000..8e30c05
Binary files /dev/null and b/docs/06_Component_Documentation/Demo_Application/images/mominavi.jpg differ