summaryrefslogtreecommitdiffstats
path: root/docs/0_Getting_Started
diff options
context:
space:
mode:
authoraakash-s45 <tech2aks@gmail.com>2022-09-03 14:02:12 +0530
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2022-09-07 17:23:20 +0000
commit3abf3496142f4d650fa4f85ba0b4dd9596764c92 (patch)
treeda136d61bdc13b31460c9a1cb3cd40f35c1a0411 /docs/0_Getting_Started
parentc45a952d009f135e528bf538635903a3b8026e92 (diff)
Add documentation for Flutter Instrument Cluster
This will add documentation to build and boot the agl-cluster-demo-platform-flutter demo image using QEMU Bug-AGL: SPEC-4543 Change-Id: I659f2d953afa76bc6fe51731258f7b3b5f747431 Signed-off-by: Aakash Solanki <tech2aks@gmail.com> Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/27969 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'docs/0_Getting_Started')
-rw-r--r--docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/2_Flutter_Instrument_Cluster_(qemu-x86).md118
-rw-r--r--docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.pngbin0 -> 601550 bytes
-rw-r--r--docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.pngbin0 -> 715977 bytes
3 files changed, 118 insertions, 0 deletions
diff --git a/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/2_Flutter_Instrument_Cluster_(qemu-x86).md b/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/2_Flutter_Instrument_Cluster_(qemu-x86).md
new file mode 100644
index 0000000..1ce8bcf
--- /dev/null
+++ b/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/2_Flutter_Instrument_Cluster_(qemu-x86).md
@@ -0,0 +1,118 @@
+# Build and Boot AGL Flutter Instrument Cluster demo image made for GSoC
+
+## 0. Prepare Your Build Host
+
+- Install the required tools to build an AGL Image. For detailed explanation, check [Preparing Your Build host](https://docs.automotivelinux.org/en/needlefish/#0_Getting_Started/2_Building_AGL_Image/1_Preparing_Your_Build_Host/)
+
+## 1. Define Your Top-Level Directory
+
+```bash
+$ export AGL_TOP=$HOME/AGL
+$ echo 'export AGL_TOP=$HOME/AGL' >> $HOME/.bashrc
+$ mkdir -p $AGL_TOP
+```
+
+## 2. Download the repo Tool and Set Permissions
+
+```bash
+$ mkdir -p $HOME/bin
+$ export PATH=$HOME/bin:$PATH
+$ echo 'export PATH=$HOME/bin:$PATH' >> $HOME/.bashrc
+$ curl https://storage.googleapis.com/git-repo-downloads/repo > $HOME/bin/repo
+$ chmod a+x $HOME/bin/repo
+```
+
+## 3. Download the AGL Source Files
+To download the latest **master** branch AGL files, use the following commands:
+```bash
+$ cd $AGL_TOP
+$ mkdir master
+$ cd master
+$ repo init -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo
+$ repo sync
+```
+
+## 4. Initialize the build environment using aglsetup.sh Script
+To initialize the build environment, we must use the setup script.
+This script is available here:
+```bash
+$ $AGL_TOP/master/meta-agl/scripts/aglsetup.sh
+```
+Run the script:
+
+```bash
+$ cd $AGL_TOP
+$ source master/meta-agl/scripts/aglsetup.sh -b build-flutter-cluster -m qemux86-64 agl-demo agl-devel
+```
+
+- Here `-b` is used to specify the build directory and `-m` is used to specify the target platform.
+
+- Running this script, will create a build directory if it does not exist. Default build directory: `$AGL_TOP/master/build-flutter-cluster`
+- Default target paltform: `qemux86-64`
+
+## 5. Using BitBake
+
+```bash
+$ cd $AGL_TOP/build-flutter-cluster
+$ source agl-init-build-env
+$ bitbake agl-cluster-demo-platform-flutter
+```
+
+## 6. Deploying the AGL Demo Image
+Boot the image using QEMU
+
+```bash
+$ cd $AGL_TOP/build-flutter-cluster
+$ source agl-init-build-env
+$ runqemu kvm serialstdio slirp publicvnc
+```
+
+## 6. Run the Graphics
+To get graphics of the app, you need VNC client like VNC Viewer or Vinagre
+
+- Open the VNC client
+- Enter the server address as `localhost:0`
+
+That's it, you should get something like this:
+![Screenshot](images/flutter_instrument_cluster.png)
+
+## 7. To start navigation widget
+To get the navigation, you need to use `kuksa_viss_client` or `kuksa_vss_init.py` script.
+
+#### **Using inbuilt `kuksa_vss_init.py` script**
+
+ After running the build, you should get this:
+
+```bash
+Automotive Grade Linux 13.93.0 qemux86-64 ttyS0
+
+qemux86-64 login:
+
+```
+
+Login as root
+
+```bash
+qemux86-64 login: root
+```
+Now run the script
+
+```bash
+root@qemux86-64:~# /usr/sbin/kuksa_vss_init.py
+```
+
+#### **Using `kuksa_viss_client`**
+
+Know more about kuksa_viss_client, [Follow this](https://github.com/eclipse/kuksa.val/tree/master/kuksa_viss_client)
+
+- Run the kuksa_viss_client
+- Authorize using token
+
+Then
+
+```bash
+Test Client> setValue Vehicle.Cabin.SteeringWheel.Switches.Info true
+```
+![Screenshot](images/flutter_instrument_cluster_map.png)
+
+
diff --git a/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.png b/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.png
new file mode 100644
index 0000000..23cf19d
--- /dev/null
+++ b/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.png
Binary files differ
diff --git a/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.png b/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.png
new file mode 100644
index 0000000..8d3a1b2
--- /dev/null
+++ b/docs/0_Getting_Started/3_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.png
Binary files differ