diff options
| author |   Vinod Ahuja <vahuja@unomaha.edu> | 2022-11-19 13:59:20 -0600 |
|---|---|---|
| committer |   Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2022-11-21 11:21:04 +0000 |
| commit | 120a2677992ea299eea5fb5cb0ed1081f76bb92c (patch) | |
| tree | f9cc1835cc14536f0397d3cfbbae744695d42bf1 /docs/01_Getting_Started/03_Build_and_Boot_guide_Profile | |
| parent | 33727f4e9619f9da65fdfc608a10a92887c7257c (diff) | |
Updating File name and links in the documentationoctopus_14.92.0octopus_14.91.0octopus/14.92.0octopus/14.91.014.92.014.91.0
Updating documentation:
1. Renamed all the files and folder following 01-99 index numbering
2. Matched title name and file name
3. Inserted title in the files where ever missing
4. Updated all the reference links in the documentation
Bug-AGL: [SPEC-4470]
Signed-off-by: Vinod Ahuja <vahuja@unomaha.edu>
Change-Id: Ib73e1f91107646e11b5b19ab6ead4080add506e4
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/28170
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'docs/01_Getting_Started/03_Build_and_Boot_guide_Profile')
6 files changed, 336 insertions, 0 deletions
diff --git a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md new file mode 100644 index 0000000..9abaad8 --- /dev/null +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/01_Instrument_Cluster_(IC-IVI_with_Container_isolation).md @@ -0,0 +1,127 @@ +--- +title: Instrument Cluster (IC-IVI with Container isolation) +--- + +# Build and Boot AGL Instrument Cluster demo image (IC-IVI with Container isolation) +## Required Equipments +**1) Tested board:** **[Starter Kit Pro/M3](https://elinux.org/R-Car/Boards/M3SK) + [kingfisher support](https://elinux.org/R-Car/Boards/Kingfisher)** + +**2) MicroUSB** + +**3) MicroSD card** +## 0. Host PC environemnt +**Build PC** +Ubuntu OS (Tested version 18.04.6 LTS) + +## 1. Define Your Top-Level Directory + +```bash +export AGL_TOP=$HOME/AGL +mkdir -p $AGL_TOP +``` + +## 2. Download the repo Tool and Set Permissions + +```bash +mkdir -p $HOME/bin +export PATH=$HOME/bin:$PATH +curl https://storage.googleapis.com/git-repo-downloads/repo > $HOME/bin/repo +chmod a+x $HOME/bin/repo +``` + +## 3. Download the AGL Source Files +- **AGL Version:** Magic Marlin +```bash +cd $AGL_TOP +mkdir marlin +export AGL_TOP=$HOME/AGL/marlin +cd $AGL_TOP +git config --global user.email "you@example.com" +git config --global user.name "Your Name" +repo init -b marlin -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo +repo sync +``` +- Optional: Specify the manifest file(marlin_13.0.0.xml) using -m option + +```bash +repo init -b marlin -m marlin_13.0.0.xml -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo +``` +- Optional: Specify the master branch +```bash +repo init -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo +``` + +## 4. Downloading Proprietary Drivers +Downloading Proprietary Drivers from [Renesas-automotive-products](https://www.renesas.com/us/en/products/automotive-products/automotive-system-chips-socs/r-car-h3-m3-documents-software) +- To check the files to download +```bash +grep -rn ZIP_.= $AGL_TOP/meta-agl/meta-agl-bsp/meta-rcar-gen3/scripts/setup_mm_packages.sh +export XDG_DOWNLOAD_DIR=$HOME/Downloads +``` +- Download and copy Proprietary Drivers files (Run commands at downloaded files directory) +```bash +cp R-Car_Gen3_Series_Evaluation_Software_Package_* $XDG_DOWNLOAD_DIR/ +chmod a+rw $XDG_DOWNLOAD_DIR/*.zip +``` +## 5. Define Your Board +- Supporting Starter Kit Pro/M3 + kingfisher Board (For other supported boards, check [Define Your Board](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards.md)) +```bash +export MACHINE=m3ulcb-kf +``` +## 6. Run the aglsetup.sh Script +```bash +cd $AGL_TOP +source meta-agl/scripts/aglsetup.sh -f -m $MACHINE -b $MACHINE agl-lxc +``` + +## 7. Using BitBake +```bash +bitbake lxc-host-image-demo +``` +- The build process puts the resulting image in the Build Directory +($AGL_TOP/m3ulcb-kf/tmp/deploy/images/m3ulcb) +## 8.Boot the Board (Deploying the AGL Demo Image) +- To boot your image on the Renesas board, you need to do three things: + +a) Update all [firmware](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards/#4-troubleshooting) on R-Car M3 Starter Kit board (Flashing firmware). + +b) Prepare the MicroSD card and Flash image to the MicroSD card using [Etcher](https://www.balena.io/etcher/) + (**image file name:** lxc-host-image-demo-m3ulcb-kf.wic.xz), then insert MicroSD card in the R-Car M3SK. +c) Boot the board. + +1) Use a MicroUSB cable to connect the PC to R-Car Starter Kit Pro (M3ULCB) board CN12 "CPLD/DEBUG" +- Serial settings are 115200 8N1. +- Run any standard terminal emulator program (e.g. minicom). +[Replace **"Device"** with USB tty device name, for example **`/dev/ttyUSB0`**] +```bash +sudo minicom -b 115200 -D "DEVICE" +``` + +- Power on the board +- Quickly hit any key to get into the U-boot command prompt; you should see the following: + ```bash +Hit any key to stop autoboot: 0 => +``` +- Booting image command (for details check [How to boot](https://elinux.org/R-Car/AGL#Instrument_Cluster_with_Container_isolation_demo_image)) + ```bash +ext4load 0x48080000 Image +ext4load 0x48000000 /boot/r8a77961-ulcb-kf.dtb +booti 0x48080000 - 0x48000000 +``` + +# Run SoC board Screen +A) Connect HDMI panel to M3SK(CN4) for **IVI Container** + + +B) Connect HDMI panel to Kingfisher(CN49)for **Cluster Container** + + +<! -- https://elinux.org/images/thumb/7/76/Marlin-lxc-Cluster.JPG/1200px-Marlin-lxc-Cluster.JPG) --> +# Reference webpages + 1. [eLinux](https://elinux.org/R-Car/AGL) + 1. [Kingfisher Board](https://elinux.org/R-Car/Boards/Kingfisher) + 1. [R-Car M3SK](https://elinux.org/R-Car/Boards/M3SK#Flashing_firmware) + 1. [agl reference machines](https://docs.automotivelinux.org/en/master/#02_hardware_support/01_Supported_Hardware_Overview/) + 1. [AGL Tech Day Presenation](https://static.sched.com/hosted_files/agltechday2022/3b/agl-techday-202204.pdf) + 1. [Build AGL Image](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/0_Build_Process_Overview/) + 1. [Building for Supported Renesas Boards](https://docs.automotivelinux.org/en/master/#01_Getting_Started/02_Building_AGL_Image/09_Building_for_Supported_Renesas_Boards/) diff --git a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md new file mode 100644 index 0000000..1ab8ec6 --- /dev/null +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/02_Flutter_Instrument_Cluster_(qemu-x86).md @@ -0,0 +1,128 @@ +--- +title: Flutter Instrument Cluster (qemu-x86) +--- + +# 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/master/#01_Getting_Started/02_Building_AGL_Image/02_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` + +** NOTE: Set the API key in local.conf ** + +- By default navigation will not work, you need to set your openrouteservie API key to the variable `OPENROUTE_API_KEY` in your local.conf +- It is present at `$AGL_TOP/master/build-flutter-cluster/conf/local.conf` + +- Example: Just add `OPENROUTE_API_KEY = "your_openrouteservice_api_key"` to the end of local.conf + + +## 5. Using BitBake + +```bash +$ cd $AGL_TOP/master/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/master/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: + + +## 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 +``` + diff --git a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md new file mode 100644 index 0000000..ddce79d --- /dev/null +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/03_IVI_Flutter_apps.md @@ -0,0 +1,81 @@ +--- +title: IVI Flutter apps +--- + +# Build and Boot AGL Flutter IVI dashboard demo applications 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/master/#01_Getting_Started/02_Building_AGL_Image/02_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-dashboard -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-dashboard` +- Default target paltform: `qemux86-64` + +## 5. Using BitBake + +```bash +$ cd $AGL_TOP/build-flutter-dashboard +$ source agl-init-build-env +$ bitbake agl-ivi-demo-platform-flutter +``` + +## 6. Deploying the AGL Demo Image +Boot the image using QEMU + +```bash +$ cd $AGL_TOP/build-flutter-dashboard +$ 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: + diff --git a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.png b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.png Binary files differnew file mode 100644 index 0000000..23cf19d --- /dev/null +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster.png diff --git a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.png b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.png Binary files differnew file mode 100644 index 0000000..8d3a1b2 --- /dev/null +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/flutter_instrument_cluster_map.png diff --git a/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNG b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNG Binary files differnew file mode 100644 index 0000000..8fa63e0 --- /dev/null +++ b/docs/01_Getting_Started/03_Build_and_Boot_guide_Profile/images/ivi_homescreen.PNG |
