aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBramastyo Harimukti <bramastyo.harimukti.santoso@pelagicore.com>2018-06-08 18:25:04 +0200
committerAlexandra Betouni <ABetouni@luxoft.com>2018-06-11 10:13:53 +0000
commit12a87665cf63c00ddc48e0f3ae768cd31e712e80 (patch)
treec3be404fd0ca41d557ae779d90003dae1e28bc32
parentc284534cec38b0c4b6cec969939eb3cfa20a6c36 (diff)
[doc] documentation updates
- add documentation about system dialog - neptune insights page update - index page updates Change-Id: I5b03c127d5da8268fecc6baa53d38016d23b4fa1 Reviewed-by: Alexandra Betouni <ABetouni@luxoft.com>
-rw-r--r--doc/src/images/remote-settings-app.png (renamed from doc/src/images/remote-settings-app.jpg)0
-rw-r--r--doc/src/images/system-dialog-diagnostics.jpgbin0 -> 42203 bytes
-rw-r--r--doc/src/images/system-dialog-performance.jpgbin0 -> 19503 bytes
-rw-r--r--doc/src/images/system-dialog-runningapps.jpgbin0 -> 28909 bytes
-rw-r--r--doc/src/images/system-dialog-system.jpgbin0 -> 21839 bytes
-rw-r--r--doc/src/images/system-dialog-system2.jpgbin0 -> 23384 bytes
-rw-r--r--doc/src/neptune3ui-index.qdoc49
-rw-r--r--doc/src/neptune3ui-insights.qdoc13
-rw-r--r--doc/src/neptune3ui-system-dialog.qdoc97
9 files changed, 134 insertions, 25 deletions
diff --git a/doc/src/images/remote-settings-app.jpg b/doc/src/images/remote-settings-app.png
index 65c475f8..65c475f8 100644
--- a/doc/src/images/remote-settings-app.jpg
+++ b/doc/src/images/remote-settings-app.png
diff --git a/doc/src/images/system-dialog-diagnostics.jpg b/doc/src/images/system-dialog-diagnostics.jpg
new file mode 100644
index 00000000..1b91a69a
--- /dev/null
+++ b/doc/src/images/system-dialog-diagnostics.jpg
Binary files differ
diff --git a/doc/src/images/system-dialog-performance.jpg b/doc/src/images/system-dialog-performance.jpg
new file mode 100644
index 00000000..0a2a7d86
--- /dev/null
+++ b/doc/src/images/system-dialog-performance.jpg
Binary files differ
diff --git a/doc/src/images/system-dialog-runningapps.jpg b/doc/src/images/system-dialog-runningapps.jpg
new file mode 100644
index 00000000..c89faf1b
--- /dev/null
+++ b/doc/src/images/system-dialog-runningapps.jpg
Binary files differ
diff --git a/doc/src/images/system-dialog-system.jpg b/doc/src/images/system-dialog-system.jpg
new file mode 100644
index 00000000..d852322d
--- /dev/null
+++ b/doc/src/images/system-dialog-system.jpg
Binary files differ
diff --git a/doc/src/images/system-dialog-system2.jpg b/doc/src/images/system-dialog-system2.jpg
new file mode 100644
index 00000000..8779b268
--- /dev/null
+++ b/doc/src/images/system-dialog-system2.jpg
Binary files differ
diff --git a/doc/src/neptune3ui-index.qdoc b/doc/src/neptune3ui-index.qdoc
index 863abad2..7c067c1b 100644
--- a/doc/src/neptune3ui-index.qdoc
+++ b/doc/src/neptune3ui-index.qdoc
@@ -43,8 +43,8 @@
a \l{center stack display} and a \l{instrument cluster}. You can develop, maintain,
and deploy applications with Neptune 3 UI.
- See \l{Neptune 3 UI Insights} for further information on how you can start
- working with Neptune 3 UI.
+ See \l{Neptune 3 UI Insights} for further information to understand the concept
+ and how to run and start working with Neptune 3 UI.
\section1 Overview
@@ -106,7 +106,7 @@
\section1 Neptune 3 UI Applications
- Neptune 3 UI contains of several pre-installed applications:
+ Neptune 3 UI contains several built-in (pre-installed) applications:
\table
\header
@@ -159,22 +159,25 @@
\image instrument-cluster.jpg
- In the Instrument Cluster the user can find driving related information like the speed,
+ In the Instrument Cluster, the user can find driving related information like the speed,
cruise control parameters, gear and energy use (for an electric car). Users can also
- have information from the selected \uicontrol application-window (Music, Navigation,
- Phone etc.) ordered in views which you can navigate between with controls on the
- steering wheel. The size and position of meters and other driving related information
- is flexible to make space for views, like Navigation, that requires more space.
+ have information from the selected application-windows (Music or Navigation
+ ordered in views which you can navigate between. In order to switch between available
+ application-window, the user can use the remote settings server of Neptune 3
+ UI or a physical keyboard and press CTRL + c. The size and position of gauges and
+ other driving related information is flexible making space for views, like Navigation,
+ that requires more space.
\image instrument-cluster-nav.jpg
\section2 Center Stack Display
- The Center Stack display is designed around showing the multiprocess capabilities;
+ The Center Stack display is designed to show the multiprocess capabilities;
the fact that we can run several applications at the same time with quick response and
- smooth transitions. Even if we technically have different applications, running in
+ smooth transitions. Even if we technically have different applications running on
separate processes, the intention is to fade out the border between them, and between
- the apps and the System UI, giving the user a perception that it is one unified system.
+ them and the System UI, giving the user a perception that it is one unified
+ system.
In addition to traditional applications, like Music Player, Phone and Navigation, the
Center Stack display also contains climate settings, system notifications and different
@@ -194,7 +197,7 @@
\section2 Application Launcher
- The \uicontrol Application Launcher can be expanded by tapping on the grid icon on the upper
+ The Application Launcher can be expanded by tapping on the grid icon on the upper
end of the screen. Users can choose which application to be maximized by tapping on the
application icon. Users can also define four top applications to be shown without expanding the
launcher by pressing-and-hold the selected application and drag it to the desired position as
@@ -204,16 +207,21 @@
\section2 Application Widget
- By default, the \l{center stack display} has three application widgets. User can choose which application
- to be shown on the home screen as widget by tapping on the \uicontrol Add-Widget icon below
- the lowest widget and choose the desired application. Only application that is specified to
- have a widget-option will be listed there.
+ By default, the \l{center stack display} shows three application widgets. User can choose which
+ application to be shown on the home screen as widget by tapping on the Add-Widget icon
+ below the lowest widget and choose the desired application. Only application that is specified to
+ have a widget-option will be listed there. The user can also remove a widget from the home screen
+ by tapping on the X icon at the bottom left corner of the widget.
+
+ \note removing an application widget does not mean that the application is killed. The application
+ will be still running on the background. See \l{Neptune 3 UI System Dialog} for more information
+ about killing an application.
\image center-stack-add-widget.jpg
\section2 Climate Bar
- Neptune 3 has a \uicontrol Climate Bar located at the bottom of the \l{Center Stack Display}. When tapping
+ Neptune 3 UI has a Climate Bar located at the bottom of the \l{Center Stack Display}. When tapping
into it, a Climate Panel will be shown up with some simulation data interface to \l{Qt IVI}
as shown in the following image:
@@ -221,9 +229,10 @@
\section2 Notification Center
- Neptune 3 has a \uicontrol Notification Center to store Notifications that are triggered in
- Neptune 3. User can remove each notification in the \uicontrol Notification Center or clear
- the \uicontrol Notification Center.
+ Neptune 3 UI has a Notification Center to store Notifications that are triggered in
+ Neptune 3 UI. When a notification is triggered, a Notification Toast will be shown first
+ and it will be stored in the Notification Center afterwards. The User can remove each
+ notification in the Notification Center or clear the Notification Center.
\image center-stack-notification-center.jpg
*/
diff --git a/doc/src/neptune3ui-insights.qdoc b/doc/src/neptune3ui-insights.qdoc
index 37f2a01a..436aaa7b 100644
--- a/doc/src/neptune3ui-insights.qdoc
+++ b/doc/src/neptune3ui-insights.qdoc
@@ -43,18 +43,21 @@
to develop applications for Neptune 3 UI.
See \l{Application Architecture of Neptune 3 UI} to understand the Core UI Architecture
- that is applied in Neptune 3 UI.
+ that is applied in all applications of Neptune 3 UI.
- See \l{Neptune 3 UI Application Requests} to know more about the application requests
- concept that is implemented in Neptune 3 UI.
+ \l{Neptune 3 UI Application Requests} shows how the application requests
+ concept is implemented in Neptune 3 UI.
- See \l{Neptune 3 UI Components and Interfaces} for a list of all
- provided UI components and interfaces in Neptune 3 UI.
+ \l{Neptune 3 UI Components and Interfaces} lists all provided UI components and
+ interfaces in Neptune 3 UI.
\l{Application Anatomy of Neptune 3 UI} explains how the application behavior
is implemented in Neptune 3 UI.
\l{Neptune 3 UI Remote Settings Server} shows the concept of the remote settings
server that is used by Neptune 3 UI.
+
+ Neptune 3 UI also provides a \l{Neptune 3 UI System Dialog}{System Dialog} displaying
+ details about the environment being used and the performance monitor of the system.
*/
diff --git a/doc/src/neptune3ui-system-dialog.qdoc b/doc/src/neptune3ui-system-dialog.qdoc
new file mode 100644
index 00000000..47ed9867
--- /dev/null
+++ b/doc/src/neptune3ui-system-dialog.qdoc
@@ -0,0 +1,97 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 Pelagicore AG
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Neptune 3 IVI UI.
+**
+** $QT_BEGIN_LICENSE:FDL-QTAS$
+** Commercial License Usage
+** Licensees holding valid commercial Qt Automotive Suite licenses may use
+** this file in accordance with the commercial license agreement provided
+** with the Software or, alternatively, in accordance with the terms
+** contained in a written agreement between you and The Qt Company. For
+** licensing terms and conditions see https://www.qt.io/terms-conditions.
+** For further information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \page neptune3ui-system-dialog.html
+ \title Neptune 3 UI System Dialog
+ \previouspage neptune3ui-insights.html
+
+ Neptune 3 UI has a system dialog where the user can see and monitor the performance
+ of the system while running Neptune 3 UI. In order to pop the dialog up, user can
+ tap on the Qt logo that is located at the bottom right corner of the UI.
+
+ \section1 System Monitor
+
+ The first tab of the system dialog contains the following information:
+
+ \list
+ \li Startup Timings: provides the time spent from booting until the process starting
+ point of the System UI and from the starting point of the System UI until the first
+ frame to be drawn
+ \li CPU consumptions and memory consumptions
+ \li Network (Internet Connection) Status
+ \li Connected Network Devices with all their address information
+ \li Version: shows which Neptune 3 UI, Application Manager and Qt IVI versions are being
+ used
+ \li Platform: shows which operating system, Qt version, and OpenGL are being used.
+ \endlist
+
+ On top of the list, there is also a switch button that is used to show the system monitor
+ overlay on top of the UI to show the performance monitor numbers while operating the UI.
+
+ \image system-dialog-system.jpg
+
+ \image system-dialog-system2.jpg
+
+ \section1 List of Running Applications
+
+ The second tab of the system dialog shows a list of current running applications in
+ Neptune 3 UI. Each application item contains the following information:
+
+ \list
+ \li CPU and Memory consumptions
+ \li Time spent until first frame of the application to be drawn
+ \endlist
+
+ Each application item also has a switch button to enable the performance overlay on top
+ of the application window. For an application that has two windows, \l{PrimaryWindow} and
+ \l{SecondaryWindow}, two switch buttons can be seen and selected depending on the need.
+
+ In order to kill the application, an X icon on the right side of the application item
+ can be tapped. Once the application is killed, it will also be removed from the application
+ list.
+
+ \note By only removing the application widget in the home screen, does not mean that
+ the application is killed and that means, the application is still running on the background.
+
+ \image system-dialog-runningapps.jpg
+
+ \section1 Performance Tab
+
+ The third tab of the system dialog contains two switch buttons to enable the performance
+ overlay of the \l{center stack display} and the \l{instrument cluster}. It forces the System UI
+ to constantly redraw itself to get the actual GPU/CPU consumptions.
+
+ \image system-dialog-performance.jpg
+
+ \section1 Diagnostics Tab
+
+ The last tab of the system dialog shows the output of the QtDiag diagnostic tool.
+
+ \image system-dialog-diagnostics.jpg
+*/
+