Getting Started¶

This page explains how to start-up the HMI SDK.

Introduction¶

Getting Started explains the instruction to run HMI Applications.

Common instructions are explained in this document.

Step 1: Obtain an evaluation board¶

Click the button below to get the board.

Board and Software
Get the board and software for RZ/G series.

Step 2: Obtain necessary environment¶

1. Necessary Equipment¶

Please prepare the following equipment for your EVK.

2. Necessary Software¶

Please install following software on Linux PC.

• git

For information about installation and configuration of the tool, please refer to the first two instructions at Step 2: Build HMI SDK source code in How To Build HMI SDK.

Step 3: Obtain RZ/G HMI SDK¶

Please download from Renesas.com website.

Get HMI SDK

Get HMI SDK source code

Once downloaded, please check the Release Note included inside package.

Step 4: Prepare HMI SDK SD card image for demo¶

Prebuilt binary prepared as wic image

1. In case of Windows PC¶

1. Download or copy the release package into your PC
2. Unzip the release package and extract an image file

3. Write the image file to your micro SD card by using one of the following tool

   • Win32 Disk Imager
   • balenaEtcher
   RZ/G2LRZ/G2LCRZ/G2UL

   Image file is:

   • core-image-weston-smarc-rzg2l.wic.gz

   Image file is:

   • core-image-weston-smarc-rzg2lc.wic.gz

   Image file is:

   • core-image-bsp-smarc-rzg2ul.wic.gz

   Caution

   Even if you see a message such as you need to format the disk before/after writing the image, do not format the SD card.

2. In case of Linux PC (Ubuntu)¶

1. Download or copy the release package into your PC
2. Unzip the release package and extract an image file

3. Insert the micro SD Card into your Linux PC and find the device name of the SD card

   Use lsblk command to check the device name as follows.

   • Before inserting the SD card

     lsblk
     

     NAME        MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
         (snip)
     nvme0n1     259:0    0 465.8G  0 disk
     ├─nvme0n1p1 259:1    0   512M  0 part /boot/efi
     └─nvme0n1p2 259:2    0 465.3G  0 part /
     

   • After inserting the SD card

     lsblk
     

     NAME        MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
         (snip)
     nvme0n1     259:0    0 465.8G  0 disk
     ├─nvme0n1p1 259:1    0   512M  0 part /boot/efi
     └─nvme0n1p2 259:2    0 465.3G  0 part /
     sda           8:0    1  14.5G  0 disk
     ├─sda1        8:1    1   500M  0 part /media/user/boot
     └─sda2        8:2    1   3.4G  0 part /media/user/rootfs
     

   Note

   The device name is assigned to the SD card by Linux on your Host PC. It may be named /dev/sd* (* is a letter representing the physical drive). It is /dev/sda in this sample.

4. Unmount the SD card if it is mounted

   Use umount command with mount points that are displayed when you executed lsblk command. For example:

   umount /media/user/boot
   umount /media/user/rootfs
   

5. Write the image to the SD card

   Use bmaptool command with device name of SD card is displayed when you executed lsblk command. For example:

   sudo bmaptool copy <wic image>.wic.gz /dev/sda
   

   RZ/G2LRZ/G2LCRZ/G2UL

   Image file is:

   • core-image-weston-smarc-rzg2l.wic.gz

   Note

   Additionally, the files below are also required:

   • core-image-weston-smarc-rzg2l.wic.bmap

   Image file is:

   • core-image-weston-smarc-rzg2lc.wic.gz

   Note

   Additionally, the files below are also required:

   • core-image-weston-smarc-rzg2lc.wic.bmap

   Image file is:

   • core-image-bsp-smarc-rzg2ul.wic.gz

   Note

   Additionally, the files below are also required:

   • core-image-bsp-smarc-rzg2ul.wic.bmap

Step 5: Run HMI SDK demo¶

1. Setup EVK's peripheral¶

Please setup following below diagram.

2. Setup EVK's DIP switch¶

3. Turn on EVK and run demo¶

1. Insert the bootable SD card created at Step 4 into the microSD card slot on SMARC module board as illustrated in the figure at "1. Setup EVK's peripheral".
2. Connect a USB cable to CN6 for power supply.

3. Press and hold power button (SW9) for 1 second to turn on the EVK.

   Note

   Press and hold the button for 2 seconds when you turn off the EVK.

Step 6: Build sample application¶

This step explains how to build HMI SDK sample application.
To see the overview about HMI Applications, please refer to HMI Applications.

1. Install cross compiler to you Linux PC (Ubuntu)

   Note

   This step is optional, as prebuilt binaries was prepared.

   RZ/G2LRZ/G2LCRZ/G2UL

   sudo sh poky-glibc-x86_64-core-image-weston-aarch64-smarc-rzg2l-toolchain-3.1.31.sh
   

   sudo sh poky-glibc-x86_64-core-image-weston-aarch64-smarc-rzg2lc-toolchain-3.1.31.sh
   

   sudo sh poky-glibc-x86_64-core-image-bsp-aarch64-smarc-rzg2ul-toolchain-3.1.31.sh
   

   Note

   Please set target directory (default: /opt/poky/3.1.31).

2. Enable cross compiler

   Note

   This step is optional, as prebuilt binaries was prepared.

   source /opt/poky/3.1.31/environment-setup-aarch64-poky-linux
   

   Note

   Please make sure where cross compiler is installed (default: /opt/poky/3.1.31).

3. Clone sample application source code

   git clone https://github.com/renesas-rz/rzg_hmi_sdk
   

4. Go to source code working directory

   cd rzg_hmi_sdk/sample_app/<sample-application-directory>
   

   Note

   Existing <sample-application-directory>(s) are listed on below table.

   <sample-application-directory>	Description
   lvgl/lvgl_sample_img_disp	LVGL Sample Program for Image Display
   lvgl/lvgl_sample_audio_playback	LVGL Sample Program for Audio Playback
   lvgl/lvgl_sample_video_playback	LVGL Sample Program for Video Playback

5. Build sample application

   Note

   This step is optional, as prebuilt binaries was prepared.

   make
   

6. Executable file of sample application

   Each executable file of sample application built as rzg_hmi_sdk/sample_app/<sample-application-directory>/<sample-application-binary>.

   Note

   Executable file name (<sample-application-binary>) are same with the directory name. For example in case lvgl_sample_img_disp, path to executable file is:

   <path-to>/rzg_hmi_sdk/sample_app/lvgl/lvgl_sample_img_disp/lvgl_sample_img_disp
   

   In addition, prebuilt executable binaries are stored in 'bin' directory. For example in case lvgl_sample_img_disp, path to the prebuilt executable file is:

   <path-to>/rzg_hmi_sdk/sample_app/lvgl/lvgl_sample_img_disp/bin/lvgl_sample_img_disp
   

Step 7: Deploy sample application¶

1. Over ethernet (using SCP)¶

1. Boot and connect your EVK into your local network

   Connect an ethernet cable to RJ45 port for networking.

   RZ/G2LRZ/G2LCRZ/G2UL

   RJ45 ports are CN9 (Ethernet 0) and CN8 (Ethernet 1).

   Note

   Just connect 1 ethernet cable to CN9 or CN8.

   RJ45 ports is CN9 (Ethernet 0).

   Note

   Just connect a ethernet cable to CN9.

   RJ45 ports are CN9 (Ethernet 0) and CN8 (Ethernet 1).

   Note

   Just connect 1 ethernet cable to CN9 or CN8.

   Note

   Your EVK will run the demo program automatically.

   Please exit the demo by pressing the keyboard keys Ctrl+C, before proceeding to the next step.

2. Check your EVK's IP

   Open terminal of your EVK, and check using ip command as below.

   ip a
   

   Note

   For example, when RZ/G2L EVK's CN8 ethernet port connected to local network.

   root@smarc-rzg2l:~# ip a | grep eth
   5: eth0: <NO-CARRIER,BROADCAST,MULTICAST,DYNAMIC,UP> mtu 1500 qdisc mq state DOWN group default qlen 1000
       link/ether f2:d6:18:24:f0:6b brd ff:ff:ff:ff:ff:ff
   6: eth1: <BROADCAST,MULTICAST,DYNAMIC,UP,LOWER_UP> mtu 1500 qdisc mq state UP group default qlen 1000
       link/ether 72:26:f0:8b:64:59 brd ff:ff:ff:ff:ff:ff
       inet 192.168.0.32/24 brd 192.168.0.255 scope global dynamic eth1
   

   EVK's IP is 192.168.0.32 (at eth1).

3. Copy executable into your EVK storage (SD card)

   Send executable file from your Linux PC (Ubuntu) using scp command as below.

   scp <path-to>/rzg_hmi_sdk/sample_app/<sample-application-directory>/<sample-application-binary> root@<your-EVK-IP>:/home/root/
   

   Note

   We recommend you to copy to /home/root directory.

   Don't forget to replace <your-EVK-IP> with your EVK's IP.

4. Copy resources required by sample application

   lvgl_sample_img_displvgl_sample_audio_playbacklvgl_sample_video_playback

   scp <path-to>/rzg_hmi_sdk/sample_app/lvgl/lvgl_sample_img_disp/sample/* root@<your-EVK-IP>:/usr/share/images/
   

   Caution

   Make sure you are copying to /usr/share/images/ directory of EVK.

   scp <path-to>/rzg_hmi_sdk/sample_app/lvgl/lvgl_sample_audio_playback/sample/* root@<your-EVK-IP>:/usr/share/sounds/sample/
   

   Caution

   Make sure you are copying to /usr/share/sounds/sample/ directory of EVK.

   scp <path-to>/rzg_hmi_sdk/sample_app/lvgl/lvgl_sample_video_playback/sample/* root@<your-EVK-IP>:/usr/share/movies/
   

   Caution

   Make sure you are copying to /usr/share/movies/ directory of EVK.

2. Directly write into HMI SDK's SD card¶

1. Turn off your EVK (if its on)
2. Insert and mount your SD card into PC

3. Copy executable into your SD card

   For example, in case mounted on /media/user/rootfs.

   cp <path-to>/rzg_hmi_sdk/sample_app/<sample-application-directory>/<sample-application-binary> /media/user/rootfs/home/root/
   

   Note

   We recommend you to copy to /home/root directory.

   If you not sure where is your SD card mounted, please check it using lsblk command (see Step 4.2.3).

4. Copy resources required by sample application

   For example, in case mounted on /media/user/rootfs.

   lvgl_sample_img_displvgl_sample_audio_playbacklvgl_sample_video_playback

   cp <path-to>/rzg_hmi_sdk/sample_app/lvgl/lvgl_sample_img_disp/sample/* /media/user/rootfs/usr/share/images/
   

   Caution

   Make sure you are copying to /usr/share/images/ directory on SD card.

   cp <path-to>/rzg_hmi_sdk/sample_app/lvgl/lvgl_sample_audio_playback/sample/* /media/user/rootfs/usr/share/sounds/sample/
   

   Caution

   Make sure you are copying to /usr/share/sounds/sample/ directory on SD card.

   cp <path-to>/rzg_hmi_sdk/sample_app/lvgl/lvgl_sample_video_playback/sample/* /media/user/rootfs/usr/share/movies/
   

   Caution

   Make sure you are copying to /usr/share/movies/ directory on SD card.

Step 8: Run sample application¶

1. Boot your EVK (if not yet)

   Note

   Your EVK will run the demo program automatically.

   Please exit the demo by pressing the keyboard keys Ctrl+C, before proceeding to the next step.

2. Go to /home/root directory

   Open terminal of your EVK, and go to /home/root using cd command as below.

   cd /home/root
   

3. Set sample application binary executable

   chmod +x <sample-application-binary>
   

4. Execute sample application binary

   ./<sample-application-binary>