Document demo images
[AGL/documentation.git] / docs / 01_Getting_Started / 02_Building_AGL_Image / 11_Available_Demo_Images.md
1 ---
2 title: Available Demo Images
3 ---
4
5 ## 1. Demo Images
6
7 These images are available when the `agl-demo` feature is given to `aglsetup.sh`.  The resulting images use DHCP for network configuration, and all except the `agl-ivi-demo-control-panel` images will contain instances of the KUKSA.val databroker by default.
8
9 ### agl-ivi-image
10
11 Base IVI demo image that the other IVI images derive from.  A user will typically not be building this image, it is more relevant if making changes to the base demo services or packaging that affects all the IVI demos.
12
13 ### agl-ivi-image-crosssdk
14
15 Corresponding SDK image for `agl-ivi-image`.  Typically, a user will be more interested in the `agl-ivi-demo-qt-crosssk`, as the resulting SDK from that image is more useful for application development.
16
17 ### agl-ivi-image-flutter
18
19 Base Flutter IVI demo image.  Derived from `agl-ivi-image` and includes the Flutter components required for running Flutter applications.  A user will typically not be building this image, it usually will only be interesting if doing development of primary Flutter applications such as IVI homescreen  applications.
20
21 ### agl-ivi-demo-flutter
22
23 Flutter based IVI demo image, using `flutter-ics-homescreen` application.
24
25 ### agl-ivi-demo-html5
26
27 HTML5 based IVI demo image, using a combination of the Chromium Embedded Framework (CEF) and Web Application Manager (WAM).
28
29 ### agl-ivi-demo-qt
30
31 Qt based IVI demo image, using `homescreen` and `launcher` as well as other Qt applications.
32
33 ### agl-ivi-demo-qt-crosssdk
34
35 This is the corresponding SDK image for `agl-ivi-demo-qt`.
36
37 ### agl-ivi-demo-control-panel
38
39 IVI demo control panel image.  Simple image that runs the `agl-demo-control-panel` application for driving demo setups.
40
41 ### agl-cluster-demo-flutter
42
43 Flutter based IC demo image, using `flutter-cluster-dashboard` application.
44
45 ### agl-cluster-demo-qt
46
47 Qt based IC demo image, using `cluster-dashboard` application.
48
49 ### agl-gateway-demo
50
51 Gateway demo image.  The image runs the KUKSA.val databroker and the associated `kuksa-dbc-feeder` for CAN input.
52
53 ### agl-telematics-demo
54
55 Telematics demo image.  Currently a WIP.
56
57 ## 2. Preconfigured Demo Images
58
59 These images are also available when the `agl-demo` feature is given to `aglsetup.sh`, but are intended for use with a more complete demo setup along the lines of what the project showcases at tradeshows such as CES or Embedded World.  The resulting images use DHCP for network configuration, but the following address assignments are assumed:
60
61 - IVI board has address 192.168.10.2
62 - IC board has address 192.168.10.3
63 - Gateway board has address 192.168.10.4
64
65 Whether an image includes the KUKSA.val databroker or not will be indicated below.
66
67 Note that the preconfigured IVI images are for the most part only tested on the Renesas H3ULCB based AGL reference hardware.  While the IC images are typically run on a Raspberry Pi 4 when a standalone IC is used as part of a tradeshow demo, the IC images are simpler and should be a bit more flexible with respect to target platform.
68
69 ### agl-ivi-demo-flutter-preconfigured
70
71 Flutter IVI demo image with:
72
73 - IC navigation streaming support
74 - KUKSA.val databroker present, preconfigured IC images assume it runs on IVI board.
75 - udev configuration for USB I2C adapter for demo setup LEDs and RTC
76 - Weston Terminal application removed
77
78 ### agl-ivi-demo-flutter-preconfigured-gateway
79
80 Flutter IVI demo image with:
81
82 - IC navigation streaming support
83 - KUKSA.val databroker removed, as it runs on the gateway.
84 - Application configuration changes for databroker being on the gateway.
85 - udev configuration for USB I2C adapter for demo setup LEDs and RTC
86 - Weston Terminal application removed
87
88 ### agl-ivi-demo-qt-preconfigured
89
90 Qt IVI demo image with:
91
92 - IC navigation streaming support
93 - KUKSA.val databroker present, preconfigured IC images assume it runs on IVI board.
94 - udev configuration for USB I2C adapter for demo setup LEDs and RTC
95 - Weston Terminal application removed
96
97 ### agl-ivi-demo-control-panel-preconfigured
98
99 IVI demo control panel image with:
100
101 - Default configuration for databroker running on IVI board.
102
103 ### agl-ivi-demo-control-panel-preconfigured-gateway
104
105 IVI demo control panel image with:
106
107 - KUKSA.val databroker present, with `kuksa-dbc-feeder` configuration to output CAN messages for the signals coming from the application's vehicle simulation.
108 - Default configuration disables HVAC and steering wheel pages, as those are driven by hardware connected to the gateway in the full demo setup.
109
110 ### agl-cluster-demo-flutter-preconfigured
111
112 Flutter IC demo image with:
113
114 - KUKSA.val databroker removed, as it runs on the IVI board.
115 - Application configuration changes for databroker being on the IVI board.
116 - Configuration tweaks to invert the screen orientation, as the IC screen in the full demo setup is upside down.
117
118 ### agl-cluster-demo-flutter-preconfigured-gateway
119
120 Flutter IC demo image with:
121
122 - KUKSA.val databroker removed, as it runs on the gateway.
123 - Application configuration changes for databroker being on the gateway.
124 - Configuration tweaks to invert the screen orientation, as the IC screen in the full demo setup is upside down.
125
126 ### agl-cluster-demo-qt-preconfigured
127
128 Qt IC demo image with:
129
130 - KUKSA.val databroker removed, as it runs on the IVI board.
131 - Application configuration changes for databroker being on the IVI board.
132 - Configuration tweaks to invert the screen orientation, as the IC screen in the full demo setup is upside down.
133
134 ### agl-gateway-demo-preconfigured
135
136 Gateway demo image with:
137
138 - `kuksa-dbc-feeder` against `can0` interface configured for vehicle simulation (e.g. vehicle and engine speed) CAN messages coming from the `agl-ivi-demo-control-panel-preconfigured-gateway` image.
139 - A second instance of `kuksa-dbc-feeder` against `can1` interface configured for input and output of CAN messages from and to the steering wheel and HVAC hardware, respectively.