diff options
| author | Bramastyo Harimukti Santoso <bram.santoso@qt.io> | 2021-01-19 16:23:52 +0100 |
|---|---|---|
| committer | Bramastyo Harimukti Santoso <bram.santoso@qt.io> | 2021-01-19 16:47:09 +0100 |
| commit | df878f3935fe28dd3d7253b9fa59d65db331eed0 (patch) | |
| tree | df27168c9196d4ff4458f86a9fefdd6ecee84d47 /doc/src | |
| parent | 88c1d70ca626be6420160c6218e07867541ae8e3 (diff) | |
| parent | e5dcdea6750b7689feae69083f39f283cc79b9b1 (diff) | |
Merge remote-tracking branch 'origin/5.15' into dev
Change-Id: I6f570e6c387b10e7c07e925429d275761bdf6cda
Diffstat (limited to 'doc/src')
107 files changed, 841 insertions, 133 deletions
diff --git a/doc/src/examples-parking-app-tutorial.qdoc b/doc/src/examples-parking-app-tutorial.qdoc index e07177ca..71a64273 100644 --- a/doc/src/examples-parking-app-tutorial.qdoc +++ b/doc/src/examples-parking-app-tutorial.qdoc @@ -226,7 +226,7 @@ created, it's shown for a few seconds on top of the UI. If that notification is stored in the notification center afterwards. The user can then decide to keep these notifications or remove each of them. -\image center-stack-notification-center.jpg +\image center-stack-notification-center.png To create a notification, first, you need to import QtApplicationManager 2.0. Then, you can create a Notification object as part of the Parking App. Suppose you want to inform the user that the diff --git a/doc/src/images/alexa-status-bar-button.png b/doc/src/images/alexa-status-bar-button.png new file mode 100644 index 00000000..bf42d055 --- /dev/null +++ b/doc/src/images/alexa-status-bar-button.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f3e29ce38e6ebf3a77d13008d32e48d9ffd4e36cb2fa15b238b61a3b0efb4464 +size 75878 diff --git a/doc/src/images/app-launcher-downloads.png b/doc/src/images/app-launcher-downloads.png new file mode 100644 index 00000000..7a176e59 --- /dev/null +++ b/doc/src/images/app-launcher-downloads.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:db96d87a26b98956c4ee045ca62c9da10a12f7d1ba25b4c0a10d5868928dd6a2 +size 74205 diff --git a/doc/src/images/app-launcher-downloads2.png b/doc/src/images/app-launcher-downloads2.png new file mode 100644 index 00000000..acca0865 --- /dev/null +++ b/doc/src/images/app-launcher-downloads2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6313a8c41bb576f000dfaf21771f0df620c747a3a65f064a7d6ec5a87b244e50 +size 235774 diff --git a/doc/src/images/arrow_bc.png b/doc/src/images/arrow_bc.png new file mode 100644 index 00000000..d505fb1a --- /dev/null +++ b/doc/src/images/arrow_bc.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:607f6b2a66760be49d621e19a6164eb9d3487f12fc148382e07b7f598366b3f3 +size 1071 diff --git a/doc/src/images/bgrContent.png b/doc/src/images/bgrContent.png new file mode 100644 index 00000000..23bd6613 --- /dev/null +++ b/doc/src/images/bgrContent.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:32aa1c0d48132615c8921052bca5c17c405142ada1784ad7ad193e4cd5f87896 +size 149 diff --git a/doc/src/images/btn_next.png b/doc/src/images/btn_next.png new file mode 100644 index 00000000..9366f7c8 --- /dev/null +++ b/doc/src/images/btn_next.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c4151ddc486972d7608e1bbc454bd54f66513cc8e70a490f263b28de12d8731 +size 695 diff --git a/doc/src/images/btn_prev.png b/doc/src/images/btn_prev.png new file mode 100644 index 00000000..e4f32bd2 --- /dev/null +++ b/doc/src/images/btn_prev.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:95a8b2eda14c743c0ba85356bdf1363fec0c1a05eee61d4c0c17a75599711751 +size 687 diff --git a/doc/src/images/bullet_dn.png b/doc/src/images/bullet_dn.png new file mode 100644 index 00000000..9f52c351 --- /dev/null +++ b/doc/src/images/bullet_dn.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:caca8e8597829bca12ca7234642f6dea9ef160651ac74fce61b4cffb89a62d8a +size 230 diff --git a/doc/src/images/bullet_sq.png b/doc/src/images/bullet_sq.png new file mode 100644 index 00000000..f71a9656 --- /dev/null +++ b/doc/src/images/bullet_sq.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bba29f8c0f23e2b33d55c4fab7bf6d94930b2c7818d6a37d55c0e1946c0f24b3 +size 74 diff --git a/doc/src/images/center-stack-add-widget.jpg b/doc/src/images/center-stack-add-widget.jpg Binary files differdeleted file mode 100644 index cefc5f33..00000000 --- a/doc/src/images/center-stack-add-widget.jpg +++ /dev/null diff --git a/doc/src/images/center-stack-add-widget.png b/doc/src/images/center-stack-add-widget.png new file mode 100644 index 00000000..6e3afbb3 --- /dev/null +++ b/doc/src/images/center-stack-add-widget.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6b0f50d9e01d4be6c331a7e0eed99ff2fb339b62246c0ed8a900fabe2f2b5fd +size 64864 diff --git a/doc/src/images/center-stack-app-launcher.jpg b/doc/src/images/center-stack-app-launcher.jpg Binary files differdeleted file mode 100644 index 16e6e835..00000000 --- a/doc/src/images/center-stack-app-launcher.jpg +++ /dev/null diff --git a/doc/src/images/center-stack-app-launcher.png b/doc/src/images/center-stack-app-launcher.png new file mode 100644 index 00000000..0c6d8b15 --- /dev/null +++ b/doc/src/images/center-stack-app-launcher.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d2d3bc22410c2d5bd7ed75ab7ae2ff3e1b66ce30f7687996c2f89bbeaf46939b +size 152668 diff --git a/doc/src/images/center-stack-climate.jpg b/doc/src/images/center-stack-climate.jpg Binary files differdeleted file mode 100644 index d1f84b62..00000000 --- a/doc/src/images/center-stack-climate.jpg +++ /dev/null diff --git a/doc/src/images/center-stack-climate.png b/doc/src/images/center-stack-climate.png new file mode 100644 index 00000000..09ae4d2b --- /dev/null +++ b/doc/src/images/center-stack-climate.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5fb23f5569263ffdc14236ee65419d2fad9b67972f846fae3b15d1eb6956e243 +size 62728 diff --git a/doc/src/images/center-stack-max-app-from-widget.png b/doc/src/images/center-stack-max-app-from-widget.png new file mode 100644 index 00000000..271d2b54 --- /dev/null +++ b/doc/src/images/center-stack-max-app-from-widget.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eea21e5d962a6413b1b677cf7b3fdb2b91b7c9ffe9f23df3540b397116359d27 +size 149115 diff --git a/doc/src/images/center-stack-maximized-app-home.png b/doc/src/images/center-stack-maximized-app-home.png new file mode 100644 index 00000000..453c1e73 --- /dev/null +++ b/doc/src/images/center-stack-maximized-app-home.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8253eb9bee15fa9f7ece554c4618ecec3dcf92b0396ae0a38a5621c9347fe0fd +size 210964 diff --git a/doc/src/images/center-stack-maximized-app.jpg b/doc/src/images/center-stack-maximized-app.jpg Binary files differdeleted file mode 100644 index 068ff8b7..00000000 --- a/doc/src/images/center-stack-maximized-app.jpg +++ /dev/null diff --git a/doc/src/images/center-stack-maximized-app.png b/doc/src/images/center-stack-maximized-app.png new file mode 100644 index 00000000..2be0153c --- /dev/null +++ b/doc/src/images/center-stack-maximized-app.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a63b59c0bcf41e42f6887f39daeebfed1f48ebac978d7b331d78233f8457b6d8 +size 174661 diff --git a/doc/src/images/center-stack-nav.jpg b/doc/src/images/center-stack-nav.jpg Binary files differdeleted file mode 100644 index c21506df..00000000 --- a/doc/src/images/center-stack-nav.jpg +++ /dev/null diff --git a/doc/src/images/center-stack-nav.png b/doc/src/images/center-stack-nav.png new file mode 100644 index 00000000..bc2ae36e --- /dev/null +++ b/doc/src/images/center-stack-nav.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9d78eae92f7cf44ff9faf8193ab855a5bebe9db1063768eab10df43baf92e0d1 +size 207997 diff --git a/doc/src/images/center-stack-notification-center.jpg b/doc/src/images/center-stack-notification-center.jpg Binary files differdeleted file mode 100644 index 5beb4c09..00000000 --- a/doc/src/images/center-stack-notification-center.jpg +++ /dev/null diff --git a/doc/src/images/center-stack-notification-center.png b/doc/src/images/center-stack-notification-center.png new file mode 100644 index 00000000..9c5b30aa --- /dev/null +++ b/doc/src/images/center-stack-notification-center.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:021db91872c566fdb487966ce1ae98d782d5ae63f1647a4bfcb08346a231f65a +size 203344 diff --git a/doc/src/images/center-stack-resize-widget.png b/doc/src/images/center-stack-resize-widget.png new file mode 100644 index 00000000..3f20ed30 --- /dev/null +++ b/doc/src/images/center-stack-resize-widget.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0de130d78a45bc156058eb2ad1d81fbd774229398e3f71ce829a91249c259207 +size 150376 diff --git a/doc/src/images/center-stack.jpg b/doc/src/images/center-stack.jpg Binary files differdeleted file mode 100644 index 60b011b9..00000000 --- a/doc/src/images/center-stack.jpg +++ /dev/null diff --git a/doc/src/images/center-stack.png b/doc/src/images/center-stack.png new file mode 100644 index 00000000..4ddff83a --- /dev/null +++ b/doc/src/images/center-stack.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f620eae4585b18692e98674aa84772ea493abd4a616e3b144af640512acb504 +size 133284 diff --git a/doc/src/images/cluster-app-car.png b/doc/src/images/cluster-app-car.png new file mode 100644 index 00000000..31c84655 --- /dev/null +++ b/doc/src/images/cluster-app-car.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:896a1c1544f86eede988cca9e4eb33c96f5ae2b83615ff67ec6fb2c1ba9af8b4 +size 191470 diff --git a/doc/src/images/cluster-app-main.png b/doc/src/images/cluster-app-main.png new file mode 100644 index 00000000..c94e00ad --- /dev/null +++ b/doc/src/images/cluster-app-main.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f742600a38686a5e8ca5809f94f914d6535677674c16040149601ef9d24ba8b7 +size 226186 diff --git a/doc/src/images/cluster-app-map.png b/doc/src/images/cluster-app-map.png new file mode 100644 index 00000000..c41dfab5 --- /dev/null +++ b/doc/src/images/cluster-app-map.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ff7c6461e5a6fa6dd3aeaade0dd005771356407d48c26ed10619077522a06b3c +size 167635 diff --git a/doc/src/images/cluster-app-music.png b/doc/src/images/cluster-app-music.png new file mode 100644 index 00000000..8c077964 --- /dev/null +++ b/doc/src/images/cluster-app-music.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:272204a2ac033a5708e5a1a94bfafb744f5d61e4de57671ef5961e1a4e5e0194 +size 152571 diff --git a/doc/src/images/companion-app.png b/doc/src/images/companion-app.png new file mode 100644 index 00000000..d0c6f659 --- /dev/null +++ b/doc/src/images/companion-app.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ed3f65e97fc5ee92542add82a5b6affbdbe930db020cc24d4c0663f444e0270 +size 157166 diff --git a/doc/src/images/desktop_startup.png b/doc/src/images/desktop_startup.png new file mode 100644 index 00000000..5beac17f --- /dev/null +++ b/doc/src/images/desktop_startup.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b9f195e0169550fbc1d937008f1d4df93cb66f9dfbd28a56c9f7313c70f0912a +size 376882 diff --git a/doc/src/images/first-integration.png b/doc/src/images/first-integration.png index 2744dc11..52ce8c8b 100644 --- a/doc/src/images/first-integration.png +++ b/doc/src/images/first-integration.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:068ed9fb5f5f8b254bf862445346748b2a8d7ab9cc6d5e060cf2c439513bb69b -size 184330 +oid sha256:64e9cb49728d73a6dd76221e4441177868b6009d6fb7d3d7e100a2fb70d345e0 +size 183250 diff --git a/doc/src/images/home.png b/doc/src/images/home.png new file mode 100644 index 00000000..07f0bb6c --- /dev/null +++ b/doc/src/images/home.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bce73b47e9e5c7a90121ee8414046b380b0c84144194f3fc493d37025661215e +size 1076 diff --git a/doc/src/images/ico_note.png b/doc/src/images/ico_note.png new file mode 100644 index 00000000..ee4fb91a --- /dev/null +++ b/doc/src/images/ico_note.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:28c8dff65b8e6b19d50f597e254a0f943740f742183310fe8d5be7edcbd343c1 +size 649 diff --git a/doc/src/images/ico_note_attention.png b/doc/src/images/ico_note_attention.png new file mode 100644 index 00000000..3099163f --- /dev/null +++ b/doc/src/images/ico_note_attention.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b75fcddaaf182c8f3a9a93f51394049b34513e55cf194e1683f95ee7ff586526 +size 529 diff --git a/doc/src/images/ico_out.png b/doc/src/images/ico_out.png new file mode 100644 index 00000000..dd5096ce --- /dev/null +++ b/doc/src/images/ico_out.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9901b1ec9cc2569c1f43b679e715b6aa3bf28c86575de539f6203ec3a059410 +size 388 diff --git a/doc/src/images/instrument-cluster-3d-navi.png b/doc/src/images/instrument-cluster-3d-navi.png index 97bd1634..cf638c3c 100644 --- a/doc/src/images/instrument-cluster-3d-navi.png +++ b/doc/src/images/instrument-cluster-3d-navi.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:460e1e3a0523544685b1d5c05daa62f09241c2a2bc43c63c1725d4dd6c10f0c3 -size 1059738 +oid sha256:470cbeecad8b62bbaee3a2435cbd3329629af8700c4729a381dc516249ac5f42 +size 422816 diff --git a/doc/src/images/instrument-cluster-3d.png b/doc/src/images/instrument-cluster-3d.png index 8f4762f5..23fbf26b 100644 --- a/doc/src/images/instrument-cluster-3d.png +++ b/doc/src/images/instrument-cluster-3d.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2874087bcb3d34aafc5e0cfb75a48213b520c06f799d154d9dbde7cf880fa9cf -size 1131712 +oid sha256:01fd003445a851bfb3619282403ba6c80a97eb4c298316ebd2fd0047360ad35c +size 477977 diff --git a/doc/src/images/instrument-cluster-nav.jpg b/doc/src/images/instrument-cluster-nav.jpg Binary files differdeleted file mode 100644 index b8fa22ca..00000000 --- a/doc/src/images/instrument-cluster-nav.jpg +++ /dev/null diff --git a/doc/src/images/instrument-cluster-nav.png b/doc/src/images/instrument-cluster-nav.png new file mode 100644 index 00000000..0fdc4a7d --- /dev/null +++ b/doc/src/images/instrument-cluster-nav.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c90399ca73ab3211479674bde3fc6aab3dc5cf5cf2e976f12901221e149a79ab +size 350763 diff --git a/doc/src/images/instrument-cluster-tt.png b/doc/src/images/instrument-cluster-tt.png new file mode 100644 index 00000000..02fdbc9b --- /dev/null +++ b/doc/src/images/instrument-cluster-tt.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bffa99182189393f1250721eb965379b6012e86be87efd598c462972ba09f079 +size 403747 diff --git a/doc/src/images/instrument-cluster-vehicle.png b/doc/src/images/instrument-cluster-vehicle.png index 933959ad..ad7d390d 100644 --- a/doc/src/images/instrument-cluster-vehicle.png +++ b/doc/src/images/instrument-cluster-vehicle.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ef870b3a08f6f89542271eb99edcc96e5d63db78e96e8d1a39d237171a563422 -size 1180286 +oid sha256:465bce0f29776c52a7c90b88137e9253579f839ef0ef564dd332d2ae8eb780f2 +size 375761 diff --git a/doc/src/images/instrument-cluster.jpg b/doc/src/images/instrument-cluster.jpg Binary files differdeleted file mode 100644 index 495edbe7..00000000 --- a/doc/src/images/instrument-cluster.jpg +++ /dev/null diff --git a/doc/src/images/instrument-cluster.png b/doc/src/images/instrument-cluster.png new file mode 100644 index 00000000..b451e2a9 --- /dev/null +++ b/doc/src/images/instrument-cluster.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c7ff1ed87c44e7c4e65f1c59d2367ca3ce81275cb1eebdb7f3bc991eddab75e1 +size 350572 diff --git a/doc/src/images/logo.png b/doc/src/images/logo.png new file mode 100644 index 00000000..b056b74a --- /dev/null +++ b/doc/src/images/logo.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4bbe72713fa329c43b762b583d2933895a50c9b135e5b5f632574b306ca19ba1 +size 2370 diff --git a/doc/src/images/music-app-popup.jpg b/doc/src/images/music-app-popup.jpg Binary files differdeleted file mode 100644 index 56812ece..00000000 --- a/doc/src/images/music-app-popup.jpg +++ /dev/null diff --git a/doc/src/images/music-app-popup.png b/doc/src/images/music-app-popup.png new file mode 100644 index 00000000..41993c5e --- /dev/null +++ b/doc/src/images/music-app-popup.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:df9bcf7817e988d76592f353df8c80ba763337f845d43fbc89d091a00be649e1 +size 79235 diff --git a/doc/src/images/neptune-dark-theme1.jpg b/doc/src/images/neptune-dark-theme1.jpg Binary files differdeleted file mode 100644 index 1f3a243c..00000000 --- a/doc/src/images/neptune-dark-theme1.jpg +++ /dev/null diff --git a/doc/src/images/neptune-dark-theme2.jpg b/doc/src/images/neptune-dark-theme2.jpg Binary files differdeleted file mode 100644 index f346bade..00000000 --- a/doc/src/images/neptune-dark-theme2.jpg +++ /dev/null diff --git a/doc/src/images/neptune-light-theme1.png b/doc/src/images/neptune-light-theme1.png new file mode 100644 index 00000000..e91f0f2e --- /dev/null +++ b/doc/src/images/neptune-light-theme1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9a7018c627b871616851656de1b4a1a01d3fe6380ca455349c27ca049944a41c +size 395181 diff --git a/doc/src/images/neptune-light-theme2.png b/doc/src/images/neptune-light-theme2.png new file mode 100644 index 00000000..146b7249 --- /dev/null +++ b/doc/src/images/neptune-light-theme2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c0db6e8fd3366908012e35b575e43af50705f573606f6a7011cebbf8f514321 +size 264457 diff --git a/doc/src/images/parking-app.png b/doc/src/images/parking-app.png index f2a75581..2b4edfc0 100644 --- a/doc/src/images/parking-app.png +++ b/doc/src/images/parking-app.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:419df8cdc0340ee9cb8d2ce1bb217505ef24367019b7fceaafe1d9a810b47829 -size 418655 +oid sha256:6eb53b5538bfe90ab46be298718815e8a06e5212a2d3aedcc86e805c70736b42 +size 183463 diff --git a/doc/src/images/settings-app-accent-color.jpg b/doc/src/images/settings-app-accent-color.jpg Binary files differdeleted file mode 100644 index 7662a11e..00000000 --- a/doc/src/images/settings-app-accent-color.jpg +++ /dev/null diff --git a/doc/src/images/settings-app-accent-color.png b/doc/src/images/settings-app-accent-color.png new file mode 100644 index 00000000..c204fe97 --- /dev/null +++ b/doc/src/images/settings-app-accent-color.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef2d858a12e22fcb097f1510c994e48f170b649d1285c1c18f107ccbc2992e3b +size 219479 diff --git a/doc/src/images/settings-app-languages.jpg b/doc/src/images/settings-app-languages.jpg Binary files differdeleted file mode 100644 index 6b0e4397..00000000 --- a/doc/src/images/settings-app-languages.jpg +++ /dev/null diff --git a/doc/src/images/settings-app-languages.png b/doc/src/images/settings-app-languages.png new file mode 100644 index 00000000..161df600 --- /dev/null +++ b/doc/src/images/settings-app-languages.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e75165fe368fa05783f1e5c10d71dca54340a6e1a28993d8f16f1c18b2c2e1b +size 236820 diff --git a/doc/src/images/settings-app-themes.jpg b/doc/src/images/settings-app-themes.jpg Binary files differdeleted file mode 100644 index 1d3da403..00000000 --- a/doc/src/images/settings-app-themes.jpg +++ /dev/null diff --git a/doc/src/images/settings-app-themes.png b/doc/src/images/settings-app-themes.png new file mode 100644 index 00000000..7b997a99 --- /dev/null +++ b/doc/src/images/settings-app-themes.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b40ba092728bef5bf630ce0375615f95322df7b499abf665807267877bd694fb +size 209228 diff --git a/doc/src/images/settings-app-timezone.jpg b/doc/src/images/settings-app-timezone.jpg Binary files differdeleted file mode 100644 index ba8829af..00000000 --- a/doc/src/images/settings-app-timezone.jpg +++ /dev/null diff --git a/doc/src/images/settings-app-timezone.png b/doc/src/images/settings-app-timezone.png new file mode 100644 index 00000000..22a0b39d --- /dev/null +++ b/doc/src/images/settings-app-timezone.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:49e521f9f17e9f24b08285efda15b3b2f6e2b39b75513bd5d4f113cfd377fd91 +size 223609 diff --git a/doc/src/images/sheets-app-button.png b/doc/src/images/sheets-app-button.png new file mode 100644 index 00000000..910b920e --- /dev/null +++ b/doc/src/images/sheets-app-button.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a950aa1496014f43a672e0b799dddfe8bd1f32901d5cd44fd9d04e7817970563 +size 91508 diff --git a/doc/src/images/sheets-app-listitem.png b/doc/src/images/sheets-app-listitem.png new file mode 100644 index 00000000..1bb34684 --- /dev/null +++ b/doc/src/images/sheets-app-listitem.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2c18a2a42ad22c84de3fd354ffe57a500d40768df850aa975582a995c47a5106 +size 211536 diff --git a/doc/src/images/sheets-app-notification.png b/doc/src/images/sheets-app-notification.png new file mode 100644 index 00000000..43351b31 --- /dev/null +++ b/doc/src/images/sheets-app-notification.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5b1948b5b5669b7661ecc48bdc30ef27f2438afca7390c202b762a580e4bd63a +size 186230 diff --git a/doc/src/images/sheets-app-popup.jpg b/doc/src/images/sheets-app-popup.jpg Binary files differdeleted file mode 100644 index c9ada237..00000000 --- a/doc/src/images/sheets-app-popup.jpg +++ /dev/null diff --git a/doc/src/images/sheets-app-popup.png b/doc/src/images/sheets-app-popup.png new file mode 100644 index 00000000..562bc525 --- /dev/null +++ b/doc/src/images/sheets-app-popup.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ad47de048152166deaef69094bf7c3db2bb15c7328f16c82a33bd72099e25162 +size 175677 diff --git a/doc/src/images/sheets-app-popupcolor.png b/doc/src/images/sheets-app-popupcolor.png new file mode 100644 index 00000000..f8f0ab1f --- /dev/null +++ b/doc/src/images/sheets-app-popupcolor.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:71e103396b986d94cf0b6cb45dd9bb1646410d3d81e13d4ed7986175cc7709e1 +size 68107 diff --git a/doc/src/images/sheets-app-popups.png b/doc/src/images/sheets-app-popups.png new file mode 100644 index 00000000..439bbd60 --- /dev/null +++ b/doc/src/images/sheets-app-popups.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:954d1b3cc72a572a528a9f22ab8f6ebcbc13b48f9808d39b6dcde4cf5b96c5b8 +size 68107 diff --git a/doc/src/images/sheets-app-progress-bar.png b/doc/src/images/sheets-app-progress-bar.png new file mode 100644 index 00000000..849c3ac3 --- /dev/null +++ b/doc/src/images/sheets-app-progress-bar.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:df8bdcf9216f6d8ebe8eea0f97e6c4d11dfde02c4d34f6f075c9eeec84b746e1 +size 111834 diff --git a/doc/src/images/sheets-app-slider.png b/doc/src/images/sheets-app-slider.png new file mode 100644 index 00000000..7aecd07e --- /dev/null +++ b/doc/src/images/sheets-app-slider.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b80931932784f5d0edb0bb35613f5bcce20e85227a29962143928a9ff5ab352b +size 185176 diff --git a/doc/src/images/sheets-app-toolbutton.png b/doc/src/images/sheets-app-toolbutton.png new file mode 100644 index 00000000..2a23fa43 --- /dev/null +++ b/doc/src/images/sheets-app-toolbutton.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:514c1f3c730185078d74942e8db63f872f002d8e4fbf20de82739353424a4f81 +size 190975 diff --git a/doc/src/images/sheets-app.png b/doc/src/images/sheets-app.png new file mode 100644 index 00000000..61a5ec1b --- /dev/null +++ b/doc/src/images/sheets-app.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a71fe0e638127199ec101c2b5db44ca843b2f410f7594f442afbe53ce7b28e05 +size 245297 diff --git a/doc/src/images/system-dialog-apps.jpg b/doc/src/images/system-dialog-apps.jpg Binary files differdeleted file mode 100644 index 856b7b69..00000000 --- a/doc/src/images/system-dialog-apps.jpg +++ /dev/null diff --git a/doc/src/images/system-dialog-apps.png b/doc/src/images/system-dialog-apps.png new file mode 100644 index 00000000..663a11fc --- /dev/null +++ b/doc/src/images/system-dialog-apps.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f4b84eab4f240c0eed38db30ff37d910de95db137728423a52a2d69b1f1182d +size 83811 diff --git a/doc/src/images/system-dialog-diagnostics.jpg b/doc/src/images/system-dialog-diagnostics.jpg Binary files differdeleted file mode 100644 index 82b556b8..00000000 --- a/doc/src/images/system-dialog-diagnostics.jpg +++ /dev/null diff --git a/doc/src/images/system-dialog-diagnostics.png b/doc/src/images/system-dialog-diagnostics.png new file mode 100644 index 00000000..7fb2d525 --- /dev/null +++ b/doc/src/images/system-dialog-diagnostics.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:798427ec639839e4728a8ec188aacfe4b17ea84e1ed094defeb49e57f7551f95 +size 191032 diff --git a/doc/src/images/system-dialog-performance.jpg b/doc/src/images/system-dialog-performance.jpg Binary files differdeleted file mode 100644 index 1e750ef4..00000000 --- a/doc/src/images/system-dialog-performance.jpg +++ /dev/null diff --git a/doc/src/images/system-dialog-performance.png b/doc/src/images/system-dialog-performance.png new file mode 100644 index 00000000..61dcc5d1 --- /dev/null +++ b/doc/src/images/system-dialog-performance.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:633ff6789316e97287526df81ecb9b911a730499cfc6cc7b9122d1c992080b93 +size 65907 diff --git a/doc/src/images/system-dialog-system.jpg b/doc/src/images/system-dialog-system.jpg Binary files differdeleted file mode 100644 index 645ec25d..00000000 --- a/doc/src/images/system-dialog-system.jpg +++ /dev/null diff --git a/doc/src/images/system-dialog-system.png b/doc/src/images/system-dialog-system.png new file mode 100644 index 00000000..aa200ecd --- /dev/null +++ b/doc/src/images/system-dialog-system.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:af48c26c2e7af3f85938dbb1e44beccdd1973e06ada4a2cd8d1d76ade4c50d74 +size 82863 diff --git a/doc/src/images/system-dialog-system2.jpg b/doc/src/images/system-dialog-system2.jpg Binary files differdeleted file mode 100644 index 0ccac21c..00000000 --- a/doc/src/images/system-dialog-system2.jpg +++ /dev/null diff --git a/doc/src/images/system-dialog-system2.png b/doc/src/images/system-dialog-system2.png new file mode 100644 index 00000000..fcaba8c0 --- /dev/null +++ b/doc/src/images/system-dialog-system2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:032887933cc7e5012792eb0a08fd21ee8cb65e94a99082bd4945494196ed305b +size 81604 diff --git a/doc/src/images/tools-column.jpg b/doc/src/images/tools-column.jpg Binary files differdeleted file mode 100644 index 20b82053..00000000 --- a/doc/src/images/tools-column.jpg +++ /dev/null diff --git a/doc/src/images/tools-column.png b/doc/src/images/tools-column.png new file mode 100644 index 00000000..b023ddd5 --- /dev/null +++ b/doc/src/images/tools-column.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1612369e0cc979a10699caaca33f28673a6cbb714bcbeb5bbfb0157f40e04da9 +size 56865 diff --git a/doc/src/images/volume-control-mute.png b/doc/src/images/volume-control-mute.png new file mode 100644 index 00000000..350b0fca --- /dev/null +++ b/doc/src/images/volume-control-mute.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1bcab42e01297749a09f43a78647d927ae824eed4726607b1b5bdc8202e4f288 +size 167491 diff --git a/doc/src/images/volume-control.png b/doc/src/images/volume-control.png new file mode 100644 index 00000000..67542d29 --- /dev/null +++ b/doc/src/images/volume-control.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2bd9183ce033f817db0e8dced4741bd21b108d63811db044b155156b0b82cb6d +size 164585 diff --git a/doc/src/images/widget-bottom.png b/doc/src/images/widget-bottom.png new file mode 100644 index 00000000..b5fa5e56 --- /dev/null +++ b/doc/src/images/widget-bottom.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d30fa3a331de5f8cc36164d70732d918890c3dd8ce386a9210e75275d815d17a +size 235774 diff --git a/doc/src/neptune3ui-3d-integration.qdoc b/doc/src/neptune3ui-3d-integration.qdoc index c514da45..997f387b 100644 --- a/doc/src/neptune3ui-3d-integration.qdoc +++ b/doc/src/neptune3ui-3d-integration.qdoc @@ -137,7 +137,7 @@ \note You must have \l{Qt 3D Studio} installed and your Qt installation must support OpenGL ES. For more details, see \l{Use the Qt 3D Studio Runtime}. - \section1 Vehicle Integration with Qt 3D + \section1 Vehicle 3D Model Integration with Qt 3D The diagram below shows the current structure of the Vehicle app sub-part built with Qt 3D: @@ -158,7 +158,7 @@ animation is done with: transform the door to another origin, rotate it, then transform it back. As a result, the door doesn't rotate around its own axis. - \section1 Vehicle Integration with Qt 3D Studio + \section1 Vehicle 3D Model Integration with Qt 3D Studio The integration scheme for the other sub-part, built with Qt 3D Studio, is similar to \l{3D Gauges Integration with Qt 3D Studio}. The diagram below further illustrates this: diff --git a/doc/src/neptune3ui-application-anatomy.qdoc b/doc/src/neptune3ui-application-anatomy.qdoc index 6d9f8b66..e4d91005 100644 --- a/doc/src/neptune3ui-application-anatomy.qdoc +++ b/doc/src/neptune3ui-application-anatomy.qdoc @@ -38,7 +38,7 @@ \section1 Full-Screen - \image center-stack-maximized-app.jpg + \image center-stack-maximized-app.png When applications are in full-screen they typically have two main content areas: top and bottom. The top area is for the most important @@ -54,12 +54,12 @@ \section2 Breaking the rules - Not every application should look the same. The best explaining cases are - probably Navigation and Camera apps since they include complex graphics. - Both applications need to look different from the default one, + Not every application should look the same. The best explaining case is + probably a Navigation app since it includes complex graphics. + The application needs to look different from the default one, but should give the same impression. - \image center-stack-nav.jpg + \image center-stack-nav.png Some applications might not need to display the ToolBar, neither the top area. Use a layout that fits the content of your application. diff --git a/doc/src/neptune3ui-application-popups.qdoc b/doc/src/neptune3ui-application-popups.qdoc index 66ec7d3d..f56e089d 100644 --- a/doc/src/neptune3ui-application-popups.qdoc +++ b/doc/src/neptune3ui-application-popups.qdoc @@ -53,11 +53,11 @@ \section3 Media Application All available at the moment media sources. - \image music-app-popup.jpg + \image music-app-popup.png - \section4 Sheets Application + \section3 Sheets Application Popup example in sheets application. - \image sheets-app-popup.jpg + \image sheets-app-popups.png */ diff --git a/doc/src/neptune3ui-application-requests.qdoc b/doc/src/neptune3ui-application-requests.qdoc index 381ec2c7..0c059766 100644 --- a/doc/src/neptune3ui-application-requests.qdoc +++ b/doc/src/neptune3ui-application-requests.qdoc @@ -30,6 +30,11 @@ \page neptune3ui-requests.html \title Neptune 3 UI - App Requests + An application request is a collective term used in Neptune 3 UI to describe + an exchange of commands between apps. Application requests currently use two + features in \l{Qt Application Manager}: OpenDocument interface and + \l{Intents in Neptune 3 UI apps}. + An application request is used to send a request to an application to just open or open in a certain state. That said, the action should be possible to be performed from wherever in the system. @@ -81,7 +86,7 @@ Connections { target: ApplicationInterface //handle here all specific app behavior - onOpenDocument: { + function onOpenDocument: { //process documentUrl "getmeto/Donald Weese Ct, Las Vegas" } } @@ -114,21 +119,93 @@ \image application-requests-goback.jpg - \section1 Current Use-Cases in Neptune 3 UI - - \section2 Media Application - All media applications (Radio, Web Radio, Music are connected to each other using - requests. To try it, navigating to either Music, Radio and/or WebRadio app and press - "sources" in the toolbar menu on the right side. A popup will open with all available music - sources. Choosing any of those will direct you to the respective music application. - - \section2 Vehicle Settings - In the energy panel is a list with 'charging station' suggestions. If any of those is - pressed, the maps application will directly open, loading the selected charging station's - address and ready to navigate there. - - \section2 System Notifications - A ctrl+n press simulates a "Battery Low" event by triggering a system notification containing - an action button. If the action button is pressed, the map application will directly open, - loading the suggested charging station's address and ready to navigate there. + \section1 Intents in Neptune 3 UI apps + + \l{Qt Application Manager} intents enable an app to communicate with another app or with + System UI by sending a command and then waiting for a return value (information) in response. + + The table below describes the set of intents (see \l{Qt Application Manager}{Intents System UI and Applications Example} + documentation) provided by apps, as well as a generalized description of how an app reacts on an + intent. For example, in the first row, the apps listed in "App" column react on activate-app intent + by opening or rising an app window. + + + \table + \header + \li Name + \li Functionality + \li App + + \row + \li activate-app + \li opens or rises app window + \li \list + \li com.luxoft.vehicle + \li com.pelagicore.apps.settings + \li com.pelagicore.calendar + \li com.pelagicore.downloads + \li com.pelagicore.map + \li com.pelagicore.music + \li com.pelagicore.phone + \li com.pelagicore.tuner + \li com.luxoft.alexa + \endlist + + \row + \li set-next-accent-color + \li switches to the next theme color + \li \list + \li com.pelagicore.apps.settings + \endlist + \row + \li show-destination + \li opens map search for text query (parameter: \c destination: text address query) + \li \list + \li com.pelagicore.map + \endlist + \row + \li music-command + \li switches music tracks (parameter: \c musiccommand: prev/next) + \li \list + \li com.pelagicore.music + \endlist + + \row + \li call-support + \li initiates call to neptune support service (for more information + see \l{Chapter 2: Extend the Parking App and Integrate + with Intent and Notification} {Develop a Parking App}) + \li \list + \li com.pelagicore.phone + \endlist + \row + \li trigger-voiceassistant + \li enables Alexa app to listen to commands + \li \list + \li com.luxoft.alexa + \endlist + \row + \li vehicle-control + \li operates vehicle's doors, trunk and sun roof. This intent requires 3 parameters: + \list + \li action: open/close + \li side: left/right + \li part: trunk/sunroof/door + \endlist + \li \list + \li com.luxoft.vehicle + \endlist + \endtable + + \section2 Current Use-Cases in Neptune 3 UI + + \section3 Media apps + All media apps (Radio, Web Radio, Music) are connected to each other using + requests. To try it, navigate to either Music, Radio or WebRadio app and press + "sources" in the toolbar menu on the left. A popup with all available music + sources will open. Tapping on any of those sources will direct you to the respective media app. + + \section3 Vehicle Settings + There is a list with 'charging station' suggestions in the energy panel. If any of those is + pressed, the maps app will open and load the address of a selected charging station. */ diff --git a/doc/src/neptune3ui-companion-app.qdoc b/doc/src/neptune3ui-companion-app.qdoc index 55c5256c..17051af5 100644 --- a/doc/src/neptune3ui-companion-app.qdoc +++ b/doc/src/neptune3ui-companion-app.qdoc @@ -43,6 +43,8 @@ implementing this kind of app, without requiring separate APIs and a dedicated architecture to access vehicle function data. + \image companion-app.png + \section1 Using the app The app is built and installed along with Neptune 3 UI. To start the app, run the diff --git a/doc/src/neptune3ui-components.qdoc b/doc/src/neptune3ui-components.qdoc index 61928e85..37397ea7 100644 --- a/doc/src/neptune3ui-components.qdoc +++ b/doc/src/neptune3ui-components.qdoc @@ -52,6 +52,7 @@ \li \l{ScalableBorderImage} \li \l{ToolsColumn} \li \l{Tracer} + \li \l{TouchPointsTracer} \endlist Neptune UI interfaces: diff --git a/doc/src/neptune3ui-configure.qdoc b/doc/src/neptune3ui-configure.qdoc index 30ed0f8c..ebdeda74 100644 --- a/doc/src/neptune3ui-configure.qdoc +++ b/doc/src/neptune3ui-configure.qdoc @@ -63,13 +63,14 @@ formatType: am-configuration --- # basic AM functionality - the builtin apps are in 'apps'. - # installations will go into the standard /tmp/am hierarchy + # installations will go into the standard QStandardPath AppLocalDataLocation + # (e.g. ~/.local/share/Luxoft Sweden AB/Neptune UI) /am hierarchy applications: - builtinAppsManifestDir: "${CONFIG_PWD}/apps" - installedAppsManifestDir: "/tmp/neptune3-ui/manifests" - appImageMountDir: "/tmp/neptune3-ui/image-mounts" - database: "/tmp/neptune3-ui/apps.db" + builtinAppsManifestDir: "${CONFIG_PWD}/apps" + installedAppsManifestDir: "${stdpath:AppLocalDataLocation}/neptune3-ui/manifests" + installationDir: "${stdpath:AppLocalDataLocation}/neptune3-ui/apps" + documentDir: "${stdpath:AppLocalDataLocation}/neptune3-ui/docs" # QML apps will be able to import from modules... @@ -88,35 +89,34 @@ # ... as well as the SystemUI ui: - fullscreen: no - style: "${CONFIG_PWD}/styles/neptune" - iconThemeName: "neptune" - iconThemeSearchPaths: [ "${CONFIG_PWD}/imports_shared/assets/icons" ] - mainQml: "${CONFIG_PWD}/Main.qml" - importPaths: [ "${CONFIG_PWD}/imports_shared", "${CONFIG_PWD}/imports_system", "${CONFIG_PWD}/sysui" ] - windowIcon: "${CONFIG_PWD}/imports_shared/assets/icons/neptune/sysui/ic-menu-home.png" + fullscreen: no + style: "${CONFIG_PWD}/styles/neptune" + iconThemeName: "neptune" + iconThemeSearchPaths: [ "${CONFIG_PWD}/imports_shared/assets/icons" ] + mainQml: "${CONFIG_PWD}/Main.qml" + importPaths: [ "${CONFIG_PWD}/imports_shared", "${CONFIG_PWD}/imports_system", "${CONFIG_PWD}/sysui" ] + windowIcon: "${CONFIG_PWD}/imports_shared/assets/icons/neptune/sysui/ic-menu-home.png" systemProperties: public: - showCluster: yes - showHUD: yes - devMode: yes - hardwareVariant: 'high' - #Qt Safe Renderer settings - qsrEnabled: no - qsrServerAddress: '127.0.0.1' - qsrServerPort: '1111' - showSystemAppsInLauncher: no + showCluster: yes + showHUD: yes + devMode: yes + hardwareVariant: 'high' + #Qt Safe Renderer settings + qsrEnabled: no + qsrServerAddress: '127.0.0.1' + qsrServerPort: '1111' + showSystemAppsInLauncher: no private: - appStoreServerUrl: 'http://chaos.pelagicore.net:9090' - orientation: 'Portrait' - adjustSizesForScreen: yes + appStoreServerUrl: 'http://demoappsdeploy.qt.io:8514' + orientation: 'Portrait' + adjustSizesForScreen: yes # development setup: no security - flags: - noSecurity: yes - noUiWatchdog: yes + noSecurity: yes + noUiWatchdog: yes \endcode The YAML file contains options for system properties to show screens other than the Center @@ -151,7 +151,7 @@ If you'd like to use the \l{Qt Automotive Suite Deployment Server}, set the \c appStoreServerUrl parameter to contain your server's base URL together with its port. Currently, the default value - is \c{http://chaos.pelagicore.net:9090}. + is \c{http://demoappsdeploy.qt.io:8514}. All of these options are also configurable from the command line as a parameter to the \c appman utility. For more information, see \l{Qt Application Manager Configuration}. diff --git a/doc/src/neptune3ui-deployment-server.qdoc b/doc/src/neptune3ui-deployment-server.qdoc new file mode 100644 index 00000000..22655b32 --- /dev/null +++ b/doc/src/neptune3ui-deployment-server.qdoc @@ -0,0 +1,49 @@ +/**************************************************************************** +** +** Copyright (C) 2020 Luxoft Sweden AB +** Copyright (C) 2018 Pelagicore AG +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Neptune 3 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-deployment-server.html + \title Neptune 3 UI - Deployment Server + \brief Overview of how Neptune 3 UI works with \l{Qt Automotive Suite Deployment Server} + + Neptune 3 UI works with Qt Automotive Suite Deployment Server, which is a + lightweight HTTP server that provides network feeds of application packages + that are available for installation by a Qt Application Manager instance, + running on a target device connected to a network. For more information, + see \l{Qt Automotive Suite Deployment Server} section. + + A user interacts with \l{Qt Automotive Suite Deployment Server} using Downloads App, + described in \l{Neptune 3 UI Apps} section. + + To change Deployment Server address please edit {appStoreServerUrl} property in Neptune 3 UI + configuration YAML file. See \l{Neptune 3 UI - Configure}. + + Deployment Server YAML tags (see \l{Qt Automotive Suite Deployment Server}{Assumptions}) + are used for packages with specific target architecture for C++ plugins. + +*/ diff --git a/doc/src/neptune3ui-install.qdoc b/doc/src/neptune3ui-install.qdoc index bae78a20..515bc74d 100644 --- a/doc/src/neptune3ui-install.qdoc +++ b/doc/src/neptune3ui-install.qdoc @@ -109,8 +109,8 @@ \section2 Dependencies \list - \li \l{Qt Application Manager} 5.13 - \li \l{Qt IVI} 5.13 + \li \l{Qt Application Manager} 5.15 + \li \l{Qt IVI} 5.15 \li \l{Qt Safe Renderer} 1.1 (optional) \li \l{Qt 3D Studio} (optional) \endlist @@ -119,9 +119,9 @@ \list 1 \li Clone the repositories mentioned in \l{Install Qt Automotive Suite}. - \li Build \l{Qt Application Manager} against Qt 5.13. For more detailed build + \li Build \l{Qt Application Manager} against Qt 5.15. For more detailed build instructions, see \l{Qt Applicaton Manager Installation}. - \li Build \l{Qt IVI} against Qt 5.13. For more detailed build instructions, see + \li Build \l{Qt IVI} against Qt 5.15. For more detailed build instructions, see \l[QtIvi]{Installation}. \li Run the following command in a terminal, to build Neptune 3 UI: \badcode diff --git a/doc/src/neptune3ui-middleware.qdoc b/doc/src/neptune3ui-middleware.qdoc index 966f837e..9f07afd3 100644 --- a/doc/src/neptune3ui-middleware.qdoc +++ b/doc/src/neptune3ui-middleware.qdoc @@ -130,6 +130,7 @@ \l {Generate QtRemoteObjects based backends with the Qt IVI Generator} for a more detailed explanation and a walkthrough on generating middleware services. \li See \l{Qt IVI Simulation System} for more info about simulations. + \li See \l{Develop a Parking App} \endlist */ diff --git a/doc/src/neptune3ui-overview.qdoc b/doc/src/neptune3ui-overview.qdoc index ffad6b96..1045bc03 100644 --- a/doc/src/neptune3ui-overview.qdoc +++ b/doc/src/neptune3ui-overview.qdoc @@ -75,8 +75,8 @@ \li Description \row \li \l{Neptune 3 UI - System UI}{System UI} (\c sysui) - \li Displays system information and provides a way to discover as well - as launch apps. Examples such as apps are the climate panel, + \li Displays system information and provides a way to discover and + launch apps. Examples of apps are the climate panel, notification center, app launcher, status bar, and so on. \row \li Apps (\c apps) @@ -122,7 +122,7 @@ \li Calendar App (\c calendarapp) \li An organizer app with some dummy data showing a set of appointments, the current year calendar and dummy weather forecast - with mockup data. Currently, there is no real backend implemented. + with mockup data. Currently, there is no real backend implemented for this app. \row \li Phone App (\c phoneapp) @@ -140,7 +140,7 @@ these external apps using the Downloads app. \row \li \l{Neptune 3 UI - General Settings App}{General Settings} - \c settingsapp) + (\c settingsapp) \li General Settings provides a set of common UI settings, such as language settings, theme settings, date and time settings, as well as color settings. @@ -155,22 +155,32 @@ \li \l{Center Console Display} \li \l{App Launcher} \li \l{App Widget} + \li \l{Volume Control} + \li \l{Sheets App} \li \l{Climate Bar} \li \l{Notification Center} \endlist \section2 Instrument Cluster - \image instrument-cluster.jpg + \image instrument-cluster.png The Instrument Cluster displays driving related information such as speed, cruise control parameters, gear and energy use (for an electric car). Users can also have information from the selected app windows, such as Music or Maps, ordered in views which they can navigate between. To switch - between the app windows available, the user can use Neptune 3 UI's remote - settings server or press \uicontrol{Ctrl+C} in a physical keyboard. + between the available app windows, the user can use \l{Neptune 3 UI Companion App} + or press \uicontrol{Ctrl+C} on a physical keyboard. + The tell-tales (for example, the icons of headlights, engine and oil check, or other) + in the upper part of the instrument cluster (see image below) are not shown by default + on start-up. Instead, they are shown by a simulation after a certain time and can + be controlled only by using the \l{Neptune 3 UI Companion App}. After UI-startup, + the default backend simulation is started. More information about the backend + simulation can be found in section \l{Neptune 3 UI - Middleware}. - \image instrument-cluster-nav.jpg + \image instrument-cluster-tt.png + + \image instrument-cluster-nav.png The size and position of gauges and other driving related information are flexible to make space for views, like Maps that can take up more space @@ -191,17 +201,59 @@ with opengl ES 3.0 requirements set by \c{.yaml} config file. For more details, see \l{Qt Application Manager}. + \section3 Cluster App + + \image cluster-app-main.png + + A Cluster App has its own life cycle and can run independently from Neptune + 3 UI, allowing user to see the whole scope of necessary information, like maps, music, + and vehicle view on the \l{Instrument Cluster} screen. + + As a stand-alone app, Cluster App can be run on a separate board or in a dedicated hypervisor + domain. It connects to the same backends, as Neptune 3 UI, using a network connection. + + Cluster App shares the design and generic components of Neptune 3 UI. For example, if the user + has changed the theme in Neptune 3 UI, the same one will be applied to Cluster App. + + There are three types of views available for user to switch between: + + \list + \li \l{Vehicle View} + \li \l{Music View} + \li \l{Maps View} + \endlist + + \section4 Vehicle View + + This view reflects the same state, which is shown (or would be shown if the cluster app is active) + in the cluster app displayed on the cluster window. + + \image cluster-app-car.png + + \section4 Music View + + Music view is almost the same as the part of the music app (which is displayed in cluster window) except + for the track covers, that are not displayed. + + \image cluster-app-music.png + + \section4 Maps View + + Maps View displays the map in the same way, as it's displayed in Neptune 3 UI \l{Maps App}, + allowing user to see vehicle's location, destination and route right on the \l{Instrument Cluster}. + + \image cluster-app-map.png + + \note The Cluster App is a plain Qt/Qml app, it is not based on \l{Qt Application Manager}. \section2 Center Console Display - The Center Console display shows the multi-process capabilities; the fact - that we can run several apps simultaneously, with quick response and - smooth transitions. Even if, technically, we have different apps that run on - separate processes, the border between these apps is faded out. In turn, the - border between these apps and the System UI is also faded out, giving the - user an experience that this is one unified system. + The Center Console display demonstrates the multi-process capabilities. This means, + that several apps can be run simultaneously, using separate processes, providing + quick response and smooth transitions, and giving the user an experience of operating + one unified system. - \image center-stack.jpg + \image center-stack.png In addition to traditional apps, like Music, Phone, and Maps, the Center Console display also contains climate settings, system notifications, @@ -209,12 +261,12 @@ Some apps, such as Music, can be displayed in fullscreen or as widgets. Widgets are apps that run in a smaller window and adapt their content to fit - into a widget window. These widgets are used in the customizable home screen. + into a widget window. These \l{App Widget}s are used in the customizable home screen. When an app is maximized, it takes over the whole Center Console and shows the app's full content, as illustrated below. - \image center-stack-maximized-app.jpg + \image center-stack-maximized-app.png \section2 App Launcher @@ -223,12 +275,25 @@ \image grid-icon.jpg - Users can choose which app to maximize by tapping on the app icon. Users - can also define four top apps to show without expanding the launcher by - pressing and holding the selected app, and then dragging it to the desired - position as illustrated in the following image: + Users can choose which app to maximize by tapping on the app icon. + To go back to the home screen after maximizing the desired app, + user can tap on "Home" button as illustrated below: - \image center-stack-app-launcher.jpg + \image center-stack-maximized-app-home.png + + Users can also define four top apps to show without expanding + the launcher by pressing and holding the selected app, and then + dragging it to the desired position as illustrated in the following image: + + \image center-stack-app-launcher.png + + The App Launcher displays pre-installed apps, such as Music, Maps, or Phone, + that are already there when Neptune 3 UI is started up for the first time, + but the user can also download and install other apps by tapping on Downloads App + as illustrated below: + + \image app-launcher-downloads.png + \image app-launcher-downloads2.png \section2 App Widget @@ -236,28 +301,103 @@ choose which app to show on the home screen as a widget, by tapping on the Add Widget icon below the lowest widget and choose the desired app. - \image center-stack-add-widget.jpg + \image center-stack-add-widget.png Only apps that have a widget option are listed there. The user can also remove a widget from the home screen by tapping on the X icon at the widget's bottom left corner. + After an app is started and shows up full-screen, the bottom widget still remains + visible. This allows a quick access to the functionality provided by the widget even + if an app is in foreground. It is possible to swipe the widget to the side: + + \image widget-bottom.png + + \note Users can remove any widget from the Home screen, except the bottom one. \note Removing an app widget does not mean that the app is terminated. The - app might still be running in the background. See - \l{Neptune 3 UI System Dialog} for more information about terminating an - app. + app is still running in the background. See \l{Neptune 3 UI System Dialog} + for more information about terminating an app. - \section2 Climate Bar + Users can maximize the desired app by tapping on "Maximize" icon in the upper right corner of a widget: + + \image center-stack-max-app-from-widget.png + + The widgets can also be resized by tapping and holding a line between two consequent widgets: + + \image center-stack-resize-widget.png + + \section2 Volume Control + + To modify the volume, users can simply tap on a speaker icon in the bottom + left corner of the display and modify the volume using a stepper slider, as illustrated below: + + \image volume-control.png + + Users can also mute the sounds by tapping on the corresponding icon, as illustrated below: + + \image volume-control-mute.png + + \note The volume can be changed in any menu, except for \l{App Launcher} + + \section2 Sheets App + + \image sheets-app.png + + The Sheets App provides information about UI controls used in the Neptune 3 UI and can be + used as a UI component gallery for development purposes. All available UI controls are listed + in the following categories: - \image center-stack-climate.jpg + \list + \li Button + \li ListItem + \li Notifications + \li Popups + \li ProgressBar + \li Slider + \li ToolButton + + \endlist + + \section3 Button + + \image sheets-app-button.png + + \section3 ListItem + + \image sheets-app-listitem.png + + \section3 Notifications + + \image sheets-app-notification.png + + \section3 Popups + + \image sheets-app-popup.png + \image sheets-app-popupcolor.png + + \section3 ProgressBar + + \image sheets-app-progress-bar.png + + \section3 Slider + + \image sheets-app-slider.png + + \section3 ToolButton + + \image sheets-app-toolbutton.png + + \section2 Climate Bar The Climate Bar is located at the bottom of the \l{Center Console Display}. Tapping on it displays a climate panel with some simulation data interface to \l{Qt IVI} as shown in the following image: + \image center-stack-climate.png + \section2 Notification Center - \image center-stack-notification-center.jpg + \image center-stack-notification-center.png The Notification Center stores notifications that are triggered in Neptune 3 UI. When a notification is triggered, first, a notification toast @@ -265,6 +405,19 @@ can remove individual notifications in the Notification Center, or clear the Notification Center completely. + \section2 Starting the Neptune 3 UI on a desktop + + Neptune 3 UI can also be started up on a desktop. The following picture + demonstrates the three windows (\l{Instrument Cluster}, \l{Center Console Display} + and HUD), that are started up on a desktop PC: + + \image desktop_startup.png + + The users can resize desktop windows, and the content will be scaled according + to the standard aspect ratio. + Moreover, the users can close the windows separately in the desktop mode, + and Neptune 3 UI shuts down only after the last window is closed. + \section2 Keyboard Shortcuts The following keyboard shortcuts are supported: @@ -292,6 +445,33 @@ \row \li Ctrl+Shift+R \li Rotate the content in the Instrument Cluster. + \row + \li Ctrl+V + \li Activate or stop Voice Assistant. \endtable + \section2 Gamepad Shortcuts + + Neptune 3 UI can be controlled by some buttons from Gamepad QML Type. If you'd + like to get more information on Gamepad QML Type, go to the corresponding section + of Qt Documentation. + + The following buttons are currently used: + + \table + \header + \li Shortcut + \li Description + \row + \li Button B + \li Moves the user to the next window in cluster + \row + \li Button R1 + \li Switch to the next music track + \row + \li Button L1 + \li Switch to the previous music track + \endtable + + */ diff --git a/doc/src/neptune3ui-qt-safe-renderer-integration.qdoc b/doc/src/neptune3ui-qt-safe-renderer-integration.qdoc index 70fc55b1..2e1b4b89 100644 --- a/doc/src/neptune3ui-qt-safe-renderer-integration.qdoc +++ b/doc/src/neptune3ui-qt-safe-renderer-integration.qdoc @@ -222,16 +222,22 @@ \image qt-safe-renderer-overlay.png - To run Qt Safe Renderer on desktop, first start \c neptune3-ui and then run - \c neptune3-ui-qsr-cluster app. The transparent Safe UI window is shown with the same telltales, - text values for speed and power as Neptune 3 UI cluster shows.On desktop, it's possible to - place a Qt Safe Renderer window directly over Neptune 3 UI's cluster window to demonstrate that - telltales are positioned and scaled the same on both Safe and Non-Safe parts. Cluster window - positions are sent from the non-safe partition to the Safe part if Qt Safe Renderer support is - enabled. For \c neptune3-ui-qsr-cluster overlaying of Neptune's 3 UI Cluster window is enabled - by default and can be switched off by modifying the Boolean key in the settings file based on - \l{QSettings' Platform-Specific Notes}{QSettings} with "Luxoft Sweden AB" as the company name and - "QSRCluster" as the application name: + To run Qt Safe Renderer on desktop, first start \l {Neptune 3 UI - Middleware}{middleware} + services: \c remotesettings-server and \c drivedata-simulation-server. + + \note If these services are not started before Neptune 3 UI app, they will be stopped after + the app has been closed. + + Then start \c neptune3-ui and afterwards \c neptune3-ui-qsr-cluster app. The transparent Safe UI + window is shown with the same telltales and text values for speed and power as in Neptune 3 UI + cluster. It's possible to place a Qt Safe Renderer window directly over Neptune 3 UI's + cluster window in the desktop version to demonstrate that telltales have the same position and + scale on both Safe and Non-Safe parts. If Qt Safe Renderer support is enabled, cluster window + positions are sent from the non-safe partition to the safe part. For \c neptune3-ui-qsr-cluster + Neptune 3 UI Cluster window overlay is enabled by default and can be switched off by + modifying the Boolean key in the settings file based on + \l{QSettings' Platform-Specific Notes}{QSettings} with "Luxoft Sweden AB" as the company name + and "QSRCluster" as the application name: \badcode [gui] diff --git a/doc/src/neptune3ui-service-settings.qdoc b/doc/src/neptune3ui-service-settings.qdoc new file mode 100644 index 00000000..127585dd --- /dev/null +++ b/doc/src/neptune3ui-service-settings.qdoc @@ -0,0 +1,139 @@ +/**************************************************************************** +** +** Copyright (C) 2020 Luxoft Sweden AB +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Neptune module of the Qt Toolkit. +** +** $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-systemd-service-settings.html + \title Neptune 3 UI - Systemd Service Settings + \brief Description of settings used to start Neptune 3 UI as a systemd service. + + There are three sections in Neptune 3 UI service file: + + \list + \li [Unit] + \li [Service] + \li [Install] + \endlist + + \section1 [Unit] Section + + This section describes the service itself, including dependencies and/or conflicts, + as well as loading order. + + The section consists of a number of variables, as follows: + + \table + \header + \li Variable + \li Description + + \row + \li Description=Neptune3-UI + \li Service description displayed by system tools + + \row + \li After=dbus.service dbus-session@root.service systemd-user-sessions.service ivi-services.target + \li Loading order (After=dbus.service). It means that Neptune 3 UI systemd Service will be loaded + after dbus.service. Then goes dbus user session (there are two sessions - user and system session), and + a number of services providing data for Neptune 3 UI (ivi-services.target). + + \row + \li Wants=ivi-services.target dbus-session@root.service + \li Tells that ivi-services.target and dbus user session are in direct dependence. + + \row + \li Conflicts=neptune-qsr.service + Before=neptune-qsr.service + OnFailure=neptune-qsr.service + \li These variables describe the startup behavior: first, neptune3-ui starts, then it conflicts with + QSR Content app. Also, those variables mean that QSR content app should start, if neptune3-ui + crashes. It could be just {conflicts}, but in this case systemd does not wait for + complete shut down of Neptune 3 UI and shuts down both of the services. + \endtable + + \section1 [Service] Section + + This section describes, how the service starts up and what parameters are used for that. + + \table + \header + \li Variable + \li Description + + \row + \li User=root + \li Start as a root user (administrator in linux/unix). + + \row + \li ExecStart=/opt/neptune3/neptune3-ui -r --dbus session -c am-config-neptune.yaml + \li Sevice startup command. + + \row + \li WorkingDirectory=/opt/neptune3 + \li Catalog, to which systemd switches to before service is started. + + \row + \li EnvironmentFile=/etc/default/qt + \li Environment variables are loaded from the file in format \c Variable=value + + \row + \li Environment=AM_STARTUP_TIMER=1 + \li When set to "1", this variable enables measuring of time needed to + start up the Neptune 3 UI. In this case, the measured time value is displayed + in the system menu. + When set to "0", the measuring of time needed to start up the Neptune 3 UI + is turned off, and is not displayed in the system menu. + + \row + \li Environment=QT_QPA_EGLFS_HIDECURSOR=1 + \li This variable manages visibility of mouse cursor: when set to "1" mouse cursor + is hidden, when set to "0" it is visible. + + \endtable + + \section1 [Install] Section + + In this section it's determined, how the service file will be installed. + + \table + \header + \li Variable + \li Description + + \row + \li WantedBy=multi-user.target + \li In this use case the service file is a part of multi-user system target. That's why it + will be installed as one of dependencies. + + \endtable + + \note In any case of changes in .service file, it's necessary to run \c {systemctl daemon-reload}, + otherwise \c systemd will not reload the file changes and will use the old file. + + + + */ diff --git a/doc/src/neptune3ui-settings-application.qdoc b/doc/src/neptune3ui-settings-application.qdoc index ef544559..cb32efdd 100644 --- a/doc/src/neptune3ui-settings-application.qdoc +++ b/doc/src/neptune3ui-settings-application.qdoc @@ -36,7 +36,7 @@ \section1 Languages Settings - \image settings-app-languages.jpg + \image settings-app-languages.png Settings application contains a language settings menu that allows the user to set the global language used in Neptune 3 UI. @@ -50,35 +50,40 @@ \li Japanese Language \li Chinese Language \li Korean Language + \li Arabic \endlist + Users don't need to restart the UI to make the UI layout change + from "left-to-right" to "right-to-left" and vice versa + when switching between Arabic and other supported languages. + \section1 Date and Time Settings - \image settings-app-timezone.jpg + \image settings-app-timezone.png Settings application contains a date and time settings menu that allows the user to set the time format and time zone. \section1 Themes Settings - \image settings-app-themes.jpg + \image settings-app-themes.png - Neptune 3 UI supports two type of themes, dark theme and light theme. By default, - light theme is used. The user can change the UI theme through the Settings application - to switch between dark and light theme. + Neptune 3 UI supports two type of themes - dark and light. By default, + dark theme is used. The user can switch between dark and light themes + in the Settings App. - The images below show how the dark theme looks like: + The images below show how the light theme looks like: - \image neptune-dark-theme1.jpg + \image neptune-light-theme1.png - \image neptune-dark-theme2.jpg + \image neptune-light-theme2.png \section1 Accent Color Settings - \image settings-app-accent-color.jpg - Neptune 3 UI provides eight options of color to be used as the accent color. The - default color is orange. + default color is green, as shown on the image below: + + \image settings-app-accent-color.png The following images show how it looks when the accent color is being changed. diff --git a/doc/src/neptune3ui-system-dialog.qdoc b/doc/src/neptune3ui-system-dialog.qdoc index 0730a2c5..2a5ce418 100644 --- a/doc/src/neptune3ui-system-dialog.qdoc +++ b/doc/src/neptune3ui-system-dialog.qdoc @@ -42,7 +42,9 @@ \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 CPU consumptions and memory consumptions (CPU, GPU and Memory consumption values + should be taken as absolute values, because visualization of these values takes performance + resources as well) \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 @@ -53,9 +55,9 @@ 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-system.png - \image system-dialog-system2.jpg + \image system-dialog-system2.png \section1 List of Apps @@ -94,7 +96,12 @@ widgets, if the app is stopped or the widget is closed, and \c Autostart is disabled, then the app doesn't start and the widget isn't shown on the Home screen upon system restart. - \image system-dialog-apps.jpg + You can remove the app if it is not built-in (installed with + \l{Qt Creator Plugin for Qt Application Manager}, \l{Controller}{appman-controller} or from + \l{Neptune 3 UI Apps}{Downloads app}). To remove the installed app, tap on the recyle bin icon + near the app id. + + \image system-dialog-apps.png \section1 Performance Tab @@ -102,11 +109,11 @@ overlay of the \l{center console display} and the \l{instrument cluster}. It forces the System UI to constantly re-draw itself to get the current GPU/CPU consumptions. - \image system-dialog-performance.jpg + \image system-dialog-performance.png \section1 Diagnostics Tab - The last tab of the system dialog shows the output of the QtDiag diagnostic tool. + The last tab of the system dialog shows the output of the qtdiag diagnostic tool. - \image system-dialog-diagnostics.jpg + \image system-dialog-diagnostics.png */ diff --git a/doc/src/neptune3ui-testing-squish.qdoc b/doc/src/neptune3ui-testing-squish.qdoc index 2fbbe163..6d864c30 100644 --- a/doc/src/neptune3ui-testing-squish.qdoc +++ b/doc/src/neptune3ui-testing-squish.qdoc @@ -130,12 +130,12 @@ attachableAUT/app_vehicle = "localhost:7732" \li remotesettings-server \endlist - Consequently, for Neptune 3 UI you have to force Squish to ignore these processes to run the + Consequently, for Neptune 3 UI you need to force Squish to ignore these processes to run the tests. Otherwise these tests might not succeed from the beginning - for example because of a stopped D-Bus session. To \l{https://doc.froglogic.com/squish/latest/rg-ini-files.html#ignoredauts.txt}{ignore these processes} - you have to add or edit the \c ignoredauts.txt file in your Squish installation directory. + you need to add or edit the \c ignoredauts.txt file in your Squish installation directory. For macOS and other Unix-like Operating Systems, the file is in \c{SQUISHDIR/etc/}. For Linux, make the following change: diff --git a/doc/src/neptune3ui-topics.qdocinc b/doc/src/neptune3ui-topics.qdocinc index 1f6f7186..2a36b74b 100644 --- a/doc/src/neptune3ui-topics.qdocinc +++ b/doc/src/neptune3ui-topics.qdocinc @@ -45,6 +45,7 @@ \li \l {Neptune 3 UI - Companion App}{Companion App} \li \l {Neptune 3 UI - Configure Screens on Embedded Linux}{Configure Screens on Embedded Linux} \li \l {Neptune 3 UI - Squish Automated UI Testing}{Squish Automated UI Testing} + \li \l {Neptune 3 UI - Voice Assistant}{Voice Assistant} \endlist \section2 Application Insights @@ -65,7 +66,9 @@ \list \li \l {Neptune 3 UI - Components and Interfaces}{Components and Interfaces} + \li \l {Neptune 3 UI - Systemd Service Settings}{Systemd Service Settings} \li \l {Develop a Parking App} + \li \l {Neptune 3 UI - Deployment Server}{Deployment Server} \endlist //! [content] */ diff --git a/doc/src/neptune3ui-troubleshoot.qdoc b/doc/src/neptune3ui-troubleshoot.qdoc index 683508ab..615cca3f 100644 --- a/doc/src/neptune3ui-troubleshoot.qdoc +++ b/doc/src/neptune3ui-troubleshoot.qdoc @@ -33,11 +33,11 @@ can be configured via Qt's \l{https://doc.qt.io/qt-5/qloggingcategory.html}{Logging Category System}. In addition to controlling the categories using the \c QT_LOGGING_RULES environment variable and the global \c qtlogging.ini, the QtApplicationManager, which is Neptune 3 UI's base, also - allows you to define these categories as part of the \c am-config.yaml file. + allows you to define these categories as a part of the \c am-config.yaml file. \note On embedded systems, Neptune 3 UI is started with systemd. Here, you can control the categories using environment variables or custom command-line arguments, via the - \c neptune.service file. + \c neptune.service file. For more information, see \l{Neptune 3 UI systemd Service Settings}. \section1 Recreate the Application Database diff --git a/doc/src/neptune3ui-voice-assistant.qdoc b/doc/src/neptune3ui-voice-assistant.qdoc new file mode 100644 index 00000000..c58f73b2 --- /dev/null +++ b/doc/src/neptune3ui-voice-assistant.qdoc @@ -0,0 +1,61 @@ +/**************************************************************************** +** +** Copyright (C) 2020 Luxoft Sweden AB +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Neptune 3 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-voice-assistant.html + \title Neptune 3 UI - Voice Assistant + \brief Neptune 3 UI Voice Assistant description + + The Neptune 3 UI provides optional support for a voice assistant, + that allows user to operate UI features by voice commands. + Amazon's Alexa (c) is currently used as a voice assistant. + + The voice assistant app can be installed via the Downloads App. + Please note, that the app might not be available for all platforms and + CPU architectures. + + A dedicated button for the activation of Alexa is available in the + Neptune 3 UI status bar after a successful installation: + + \image alexa-status-bar-button.png + + In order to appear in Neptune 3 UI status bar, the window inside the voice + assistant app should have window property "windowType", that is + equal to "statusbar": + \code + setWindowProperty("windowType", "statusbar") + \endcode + It is possible to get available space inside status bar by using: + \code + Config.statusBarHeight + \endcode + The Alexa app sources can be downloaded from Qt Voice Assistant repository at: + \l {https://code.qt.io/cgit/qt/qtvoiceassistant.git/}{Qt Voice Assistant} + + +*/ |
