summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2016-11-01 14:38:13 +0100
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2016-11-16 08:58:28 +0000
commit98a7db7ea250f8a33bbe66fb5cea9c3e24691b2d (patch)
tree361cff2845b52efedd1b917a36a79b2835223f64
parent8ad68e519008f9a04659adf5945177208f183ceb (diff)
downloadneptune-ui-98a7db7ea250f8a33bbe66fb5cea9c3e24691b2d.tar.gz
Doc: Add more instructions on running the UI independently
Instructions to run the UI on a Linux desktop and using the virtual machine setup added by the installer. Also tried to reduce the size of images by compressing them. Change-Id: Ibcf30724aa74fcf879bb6115da203a1750206f0d Reviewed-by: Dominik Holland <dominik.holland@pelagicore.com> Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r--doc/src/images/emulator-automotive.pngbin0 -> 54163 bytes
-rw-r--r--doc/src/images/infotainment-cluster-apps.pngbin529763 -> 140725 bytes
-rw-r--r--doc/src/images/infotainment-cluster-carsettings.pngbin0 -> 163415 bytes
-rw-r--r--doc/src/images/infotainment-cluster-mycar.pngbin0 -> 242504 bytes
-rw-r--r--doc/src/images/infotainment-cluster-settings.pngbin657485 -> 157763 bytes
-rw-r--r--doc/src/images/infotainment-cluster.pngbin532748 -> 125362 bytes
-rw-r--r--doc/src/images/instrument-cluster.pngbin134589 -> 55175 bytes
-rw-r--r--doc/src/neptuneui-index.qdoc82
8 files changed, 69 insertions, 13 deletions
diff --git a/doc/src/images/emulator-automotive.png b/doc/src/images/emulator-automotive.png
new file mode 100644
index 0000000..e0b87cb
--- /dev/null
+++ b/doc/src/images/emulator-automotive.png
Binary files differ
diff --git a/doc/src/images/infotainment-cluster-apps.png b/doc/src/images/infotainment-cluster-apps.png
index 0d2e9c4..4e87f85 100644
--- a/doc/src/images/infotainment-cluster-apps.png
+++ b/doc/src/images/infotainment-cluster-apps.png
Binary files differ
diff --git a/doc/src/images/infotainment-cluster-carsettings.png b/doc/src/images/infotainment-cluster-carsettings.png
new file mode 100644
index 0000000..5d06ba5
--- /dev/null
+++ b/doc/src/images/infotainment-cluster-carsettings.png
Binary files differ
diff --git a/doc/src/images/infotainment-cluster-mycar.png b/doc/src/images/infotainment-cluster-mycar.png
new file mode 100644
index 0000000..71e1426
--- /dev/null
+++ b/doc/src/images/infotainment-cluster-mycar.png
Binary files differ
diff --git a/doc/src/images/infotainment-cluster-settings.png b/doc/src/images/infotainment-cluster-settings.png
index 2efc44f..374f726 100644
--- a/doc/src/images/infotainment-cluster-settings.png
+++ b/doc/src/images/infotainment-cluster-settings.png
Binary files differ
diff --git a/doc/src/images/infotainment-cluster.png b/doc/src/images/infotainment-cluster.png
index e9e43ee..4b505ac 100644
--- a/doc/src/images/infotainment-cluster.png
+++ b/doc/src/images/infotainment-cluster.png
Binary files differ
diff --git a/doc/src/images/instrument-cluster.png b/doc/src/images/instrument-cluster.png
index 3fbc601..8aacd5e 100644
--- a/doc/src/images/instrument-cluster.png
+++ b/doc/src/images/instrument-cluster.png
Binary files differ
diff --git a/doc/src/neptuneui-index.qdoc b/doc/src/neptuneui-index.qdoc
index eae5718..71b890f 100644
--- a/doc/src/neptuneui-index.qdoc
+++ b/doc/src/neptuneui-index.qdoc
@@ -42,7 +42,7 @@
\caption QtQuick-based Head Unit
The Head Unit interface provides additional pages that are accessible
- by swiping from right-to-left:
+ by swiping from right-to-left or left-to-right:
\borderedimage infotainment-cluster-apps.png
\caption Available applications on the Head Unit
@@ -52,24 +52,75 @@
Cluster. The \uicontrol{APP STORE} tab in the \uicontrol Settings page lets
you install/uninstall applications from the Head Unit.
+ \borderedimage infotainment-cluster-carsettings.png
+ \caption Provides options to enable or disable features on the car.
+
+ \borderedimage infotainment-cluster-mycar.png
+ \caption Provides an overview about the car itself.
+
\section1 How to Run the UI?
Typically the UI works out-of-the-box using Qt Creator, provided you choose
to run your application on Qt Automotive emulator, iMX6, or DriveCX targets.
- You can also run the Neptune UI on a Linux desktop. To run it without Qt IVI,
- use the following command from the cloned \e neptune-ui repository:
+ You can also run only the HMI without your application. The following
+ sections provide instructions on how to run the HMI alone.
+
+ \section2 Emulator Image
+
+ The Qt online installer automatically creates a virtual machine setup for the
+ emulator image that comes with the \QAS installation, provided you have
+ VirtualBox installed before running the Qt installer.
+
+ Use the following command to run the virtual machine setup:
\badcode
- appman -r -c $AM_CONFIG_FILE -c am-config.yaml -I dummyimport
+ emulator --vbox QtAutomotive-10
\endcode
- Where, \c appman is a utility provided by Qt Automotive Suite,
- \c AM_CONFIG_FILE points to the Application Manager's \c config.yaml, and
- \c dummyimport provides the necessary data, which is usually provided by
- Qt IVI.
+ Where, \c emulator is a tool that is shipped with \QAS, and
+ \e "QtAutomotive-10" is the name of the virtual machine setup.
+
+ \image emulator-automotive.png
+
+ \section2 Linux Desktop
+
+ If you are interested in exploring the reference HMI without installing
+ \QAS, follow these instructions to run the HMI on your Linux desktop:
+
+ \list 1
+ \li Clone the Qt Application Manager and Neptune-UI git repositories.
+
+ \li Build Qt Application Manager against Qt 5.7 or later that is
+ installed on your desktop. See the Qt Application Manager
+ \l[ApplicationManager]{Installation}{installation} page for more details
+ on building.
+
+ \li Create the required directory structure based on the path used
+ in \c <qtapplicationmanager-clone>/template-opt/am/config.yaml. For
+ example, the \c installedAppsManifestDir: points to \c{/opt/am/manifests},
+ which must be created.
+
+ \li Copy \c <qtapplicationmanager-clone>/template-opt/am/config.yaml
+ to \c /opt/am
+
+ \note You can edit your \c config.yaml copy to comment out parts that
+ are not relevant. For example, the SD card install location under the
+ \c "installationLocations:" section.
+
+ \li Run the following command from the cloned \e neptune-ui directory:
+ \badcode
+ appman -r -c /opt/am/config.yaml -c am-config.yaml -I dummyimport
+ \endcode
+ \endlist
+
+ Where, \c appman is a utility that is installed when you built
+ Qt Application Manager, \c AM_CONFIG_FILE points to the Application
+ Manager's \c config.yaml, and \c dummyimport provides the necessary data,
+ which is usually provided by Qt IVI.
\note The \c {-I dummyimport} part is not required if Qt IVI is installed.
+
\section2 UI Configuration
The UI configuration is split into several \c yaml files for the ease of
@@ -138,15 +189,20 @@
\li \l{Manifest Definition}{Application manifest file}
\li \l{Main Configuration}{appman options}
\li \l{Building eLinux Image}
- \li \l{README}
+ \li \l{Qt Application Manager Git Repository}
+ \li \l{Neptune-UI Git Repository}
\endlist
*/
/*!
- \externalpage http://code.qt.io/cgit/qt-apps/neptune-ui.git/tree/README.md
- \title README
-*/
-/*!
\externalpage http://doc.qt.io/QtForDeviceCreation/qtee-custom-embedded-linux-image.html
\title Building eLinux Image
*/
+/*!
+ \externalpage http://code.qt.io/cgit/qt/qtapplicationmanager.git/
+ \title Qt Application Manager Git Repository
+*/
+/*!
+ \externalpage http://code.qt.io/cgit/qt-apps/neptune-ui.git/
+ \title Neptune-UI Git Repository
+*/