Getting Started¶
This page explains how to start-up the HMI SDK.
Note
Hereafter, we use following terminology.
- EVK: Refers "Evaluation Board Kit".
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.
The RZ/G2L Evaluation Board Kit (EVK) is the ideal board kit for RZ/G2L evaluation.
Following items are included in the RZ/G2L Evaluation Board Kit.
Equipment | Details |
---|---|
RZ/G2L Evaluation Board | Evaluation board itself. |
Micro USB to Serial Cable | For serial communication between PC and the board. |
Step 2: Obtain necessary environment¶
1. Necessary Equipment¶
Please prepare the following equipment for your EVK.
Equipment | Purpose | Remarks |
---|---|---|
RZ/G2L Module Board (SMARC2.1) + Common Carrier Board (P/N: RTK9744L23S01000BE) | It is used to evaluate not only Linux but also demo programs or applications that run on Linux in the Linux operating environment provided by HMI SDK.
| Included with RZ/G2L Evaluation Board Kit (EVK). |
USB serial cable | It is used to connect the PC and the EVK and get the console output of Linux running on the EVK.
| Included with RZ/G2L Evaluation Board Kit (EVK). |
USB Power Delivery (PD) AC adapter + USB C PD cable for power supply | Use for power supply.
| |
PC | It can be used to operate the demo environment from a terminal on a PC, rebuild HMI SDK Linux, or use it as a development device for applications.
| The OS of the PC is as follows. However, Windows PCs are for debugging using a serial connection and cannot be used for development such as building software.
|
HDMI display monitor + HDMI cable | Used to display demo programs or applications provided by HMI SDK.
| If you need a touch panel function, you need a panel that supports USB connection. The HMI SDK supports the display of resolutions supported by the Extended Display Identification Data (EDID) information obtained from this HDMI display monitor. |
USB mouse | Used to operate demo programs and applications provided by HMI SDK.
| |
USB hub | Used when multiple USB devices are required for the demo program or applications provided by HMI SDK. | |
USB keyboard | Used to operate demo programs and applications provided by HMI SDK.
| |
USB touch screen | Used to operate demo programs and applications provided by HMI SDK.
| |
Audio speaker | Used to evaluate the audio output demo programs or applications provided by HMI SDK.
| |
micro SD card | Linux and demo images provided by the HMI SDK are written and used as a Linux boot device.
| Linux on the RZ/G2L EVK is booted from a micro SD card by eSD boot. |
2. Necessary Software¶
Please install following software on Linux PC.
- git
Step 3: Obtain RZ/G HMI SDK¶
Please download from Renesas.com website.
Once downloaded, please check the Release Note included inside package.
Step 4: Prepare HMI SDK SD card image for demo¶
Prebuilt binary are prepared as wic
image.
wic
image is available inside image-file_rzg2l_hmi-sdk_v1.0.zip
.
1. In case of Windows PC¶
- Download or copy the release package into your PC
- Unzip the release package and extract an image file
-
Write the image file to your micro SD card by using one of the following tool
Image file is:
core-image-weston-smarc-rzg2l.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)¶
- Download or copy the release package into your PC
- Unzip the release package and extract an image file
-
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
-
After inserting the SD card
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. -
-
Unmount the SD card if it is mounted
Use
umount
command with mount points that are displayed when you executedlsblk
command. For example: -
Write the image to the SD card
Use
bmaptool
command with device name of SD card is displayed when you executedlsblk
command. For example: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
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¶
- Insert the bootable SD card created at Step 4
- Connect a USB cable to CN6 for power supply
-
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.
Note
This step requires a Linux PC (Ubuntu).
The prebuilt binary of executable files are also provided, and you can run it directly.
-
Install cross compiler to you Linux PC (Ubuntu)
Note
This step is optional, as prebuilt binaries was prepared.
Note
Please set target directory (default:
/opt/poky/3.1.31
). -
Enable cross compiler
Note
This step is optional, as prebuilt binaries was prepared.
Note
Please make sure where cross compiler is installed (default:
/opt/poky/3.1.31
). -
Clone sample application source code
-
Go to source code working directory
Note
Existing
<sample-application-directory>
(s) are listed on below table.<sample-application-directory>
Description lvgl_sample_img_disp
LVGL Sample Program for Image Display lvgl_sample_audio_playback
LVGL Sample Program for Audio Playback lvgl_sample_video_playback
LVGL Sample Program for Video Playback -
Build sample application
Note
This step is optional, as prebuilt binaries was prepared.
-
Executable file of sample application
Each executable file of sample application built as
rzg_hmi_sdk/sample_app/<sample-application-directory>/<sample-application-binary>
.
Step 7: Deploy sample application¶
Note
This step requires a Linux PC (Ubuntu).
1. Over ethernet (using SCP
)¶
-
Boot and connect your EVK into your local network
Connect an ethernet cable to RJ45 port for networking.
RJ45 ports are CN8 and CN9.
Note
Just connect 1 ethernet cable to CN8 or CN9.
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.
-
Check your EVK's IP
Open terminal of your EVK, and check using
ip
command as below.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
(ateth1
). -
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. -
Copy resources required by sample application
scp <path-to>/rzg_hmi_sdk/sample_app/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.
2. Directly write into HMI SDK's SD card¶
- Turn off your EVK (if its on)
- Insert and mount your SD card into PC
-
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). -
Copy resources required by sample application
For example, in case mounted on
/media/user/rootfs
.cp <path-to>/rzg_hmi_sdk/sample_app/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.
Step 8: Run sample application¶
-
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.
-
Go to
/home/root
directoryOpen terminal of your EVK, and go to
/home/root
usingcd
command as below. -
Set sample application binary executable
-
Execute sample application binary