Skip to content

Getting Started

Introduction

This page guides you through getting started with the HMI SDK, including

  • preparing your environment (Step 1-3)
  • creating SD cards with the prebuilt image (Step 4)
  • running the HMI demo applications (Step 5)

Step 1: Obtain an RZ/G EVK

Click the button below to get the target board.

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

RZ/G2L-EVKIT (P/N: RTK9744L23S01000BE)

This evaluation board kit is ideal for evaluating RZ/G2L.
The kit includes the following items:

Contents

Details

RZ/G2L Module Board (SMARC2.1)

Evaluation board.

Common Carrier Board

USB Cable (USB Type-A- Micro USB Type-B)

For serial communication between the PC and the board.

RZ/G2LC-EVKIT (P/N: RTK9744C22S01000BE)

This evaluation board kit is ideal for evaluating RZ/G2LC.
The kit includes the following items:

Contents

Details

RZ/G2LC Module Board (SMARC2.1)

Evaluation board.

Common Carrier Board

USB Cable (USB Type-A- Micro USB Type-B)

For serial communication between the PC and the board.

RZ/G2UL-EVKIT (P/N: RTK9743U11S01000BE)

This evaluation board kit is ideal for evaluating RZ/G2L.
The kit includes the following items:

Contents

Details

RZ/G2UL Module Board (SMARC2.1)

Evaluation board.

Common Carrier Board

USB Cable (USB Type-A- Micro USB Type-B)

For serial communication between the PC and the board.

Parallel to HDMI Conversion Board

For converting the display output from Parallel to HDMI.

Step 2: Prepare the Necessary Equipment

Please prepare the following required equipment.

Tip

RZ/G EVK

  • Target board (Module Board & Common Carrier Board)
  • USB Cable (to connect the board and PC via serial)
  • *Parallel to HDMI Conversion Board (to convert the FFC/FPC connector to a micro HDMI connector, only for RZ/G2UL)

For Creating SD Cards with the Prebuilt Image

  • USB Power PD AC Adapter & USB Type-C PD Cable (to power the board)
  • PC (Windows or Linux OS)
  • Micro SD Card & Reader (minimum 4GB, 8GB or larger recommended)

For Running the HMI Demo Applications

  • HDMI Display & HDMI Cable (to display the demo applications)
  • USB Hub (to connect multiple USB devices)
  • USB Keyboard & Mouse (to operate the demo applications)
  • *USB Camera (for video input, for RZ/G2L and RZ/G2LC)
  • Audio Speaker (for audio output)

Step 3: Obtain the RZ/G HMI SDK Package

Please download from the HMI SDK Package using the button below.

HMI SDK Package for RZ/G2L
-eSD Boot Image & Toolchain Installer

HMI SDK Package for RZ/G2LC
-eSD Boot Image & Toolchain Installer

HMI SDK Package for RZ/G2UL
-eSD Boot Image & Toolchain Installer

Note

Refer to File Contents for details about the HMI SDK Package.
After downloading the package, please review the included Release Note.

Step 4: Create SD Cards with the Prebuilt Image

After downloading the HMI SDK Package, locate the image file.

Target Board

Image File

Location

RZ/G2L

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

image-file_rzg2l_hmi-sdk_v2.3.1.0.zip

Option 1. For Windows PC

  1. Download or copy the HMI SDK package to your PC.

  2. Unzip the package and extract the image file.

    i. Right-click the downloaded package RTK0EF0195F02310SJ_rzg2l.zip → Extract All...
    ii. Open the folder and right-click image-file_rzg2l_hmi-sdk_v2.3.1.0.zip → Extract All...
    iii. Inside, you will find the image file: core-image-weston-smarc-rzg2l.wic.gz

  3. Flash the image file core-image-weston-smarc-rzg2l.wic.gz to your micro SD card using one of the following tools:

    Caution

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

Option 2. For Linux PC (Ubuntu)

  1. Install the required packages and software.

    i. Run the following command to install the required packages.

    sudo apt-get update
sudo apt-get install unzip bmap-tools

    ii. Run the following command to set up the git environment if it has not been configured yet.

    Tip

    This step is required only if you plan to continue with further development, such as building sample applications. If you only want to complete Step 5: Run the HMI Demo Applications, you may skip this step.

    git config --global user.email "<Your email address>"
git config --global user.name "<Your user name>"

    Note

    For more information, refer to Yocto Project Quick Build.

  2. Download or copy the HMI SDK package to your PC.

  3. Unzip the package and extract the image file.

    Tip

    If you are using the GUI of Linux Ubuntu, please refer to the similar steps described in the Option 1. For Windows PC -2.

    i. Unzip the HMI SDK package.

    Navigate to the directory where the HMI SDK package was installed.

    unzip RTK0EF0195F02310SJ_rzg2l.zip
cd RTK0EF0195F02310SJ_rzg2l/

    ii. Unzip the image file folder.

    unzip image-file_rzg2l_hmi-sdk_v2.3.1.0.zip
cd image-file_rzg2l_hmi-sdk_v2.3.1.0/

    iii. Locate the target image file core-image-weston-smarc-rzg2l.wic.gz.

    ls

    core-image-weston-smarc-rzg2l.wic.gz 
core-image-weston-smarc-rzg2l.wic.bmap 
core-image-weston-smarc-rzg2l.manifest

    Notice

    • No need to decompress core-image-weston-smarc-rzg2l.wic.gz manually.
    • Ensure that the image file core-image-weston-smarc-rzg2l.wic.gz is located in the same directory as core-image-weston-smarc-rzg2l.wic.bmap to flash the image to the SD card successfully.

  4. Insert the micro SD card into your Linux PC and identify its device name and mount points.

    Use the lsblk command to check the <device name> and <mount point> 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

    Tip

    The device name is assigned to the SD card by Linux on your Host PC. It typically appears as /dev/sdx, where x is a letter representing the physical drive. In this example, the SD card’s device name is /dev/sda, and its mount points are /media/user/boot and /media/user/rootfs

  5. Unmount the SD card if it is currently mounted.

    Use the umount command with the mount points.

    umount <mount point>

    In this example:

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

  6. Flash the image to the SD card using bmaptool.

    Use the bmaptool command with the device name of SD card.

    Caution

    Before running bmaptool, double-check the <device name>. Make sure the target device (your SD card) is correct and not your system disk. Using the wrong device will overwrite all data on that disk and may render your system unbootable.

    Caution

    The operation below will erase the contents of your SD card.

    sudo bmaptool copy core-image-weston-smarc-rzg2l.wic.gz <device name>

    In this example:

    sudo bmaptool copy core-image-weston-smarc-rzg2l.wic.gz /dev/sda

After downloading the HMI SDK Package, locate the image file.

Target Board

Image File

Location

RZ/G2L

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

image-file_rzg2lc_hmi-sdk_v2.3.1.0.zip

Option 1. For Windows PC

  1. Download or copy the HMI SDK package to your PC.

  2. Unzip the package and extract the image file.

    i. Right-click the downloaded package RTK0EF0195F02310SJ_rzg2lc.zip → Extract All...
    ii. Open the folder and right-click image-file_rzg2lc_hmi-sdk_v2.3.1.0.zip → Extract All...
    iii. Inside, you will find the image file: core-image-weston-smarc-rzg2lc.wic.gz

  3. Flash the image file core-image-weston-smarc-rzg2lc.wic.gz to your micro SD card using one of the following tools:

    Caution

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

Option 2. For Linux PC (Ubuntu)

  1. Install the required packages and software.

    i. Run the following command to install the required packages.

    sudo apt-get update
sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib build-essential chrpath socat cpio python3 python3-pip python3-pexpect xz-utils debianutils iputils-ping libsdl1.2-dev xterm p7zip-full libyaml-dev libssl-dev bmap-tools

    ii. Run the following command to set up the git environment if it has not been configured yet.

    Tip

    This step is required only if you plan to continue with further development, such as building sample applications. If you only want to complete Step 5: Run the HMI Demo Applications, you may skip this step.

    git config --global user.email "<Your email address>"
git config --global user.name "<Your user name>"

    Note

    For more information, refer to Yocto Project Quick Build.

  2. Download or copy the HMI SDK package to your PC.

  3. Unzip the package and extract the image file.

    Tip

    If you are using the GUI of Linux Ubuntu, please refer to the similar steps described in the Option 1. For Windows PC -2.

    i. Unzip the HMI SDK package.

    Navigate to the directory where the HMI SDK package was installed.

    unzip RTK0EF0195F02310SJ_rzg2lc.zip
cd RTK0EF0195F02310SJ_rzg2lc/

    ii. Unzip the image file folder.

    unzip image-file_rzg2lc_hmi-sdk_v2.3.1.0.zip
cd image-file_rzg2lc_hmi-sdk_v2.3.1.0/

    iii. Locate the target image file core-image-weston-smarc-rzg2lc.wic.gz.

    ls

    core-image-weston-smarc-rzg2lc.wic.gz 
core-image-weston-smarc-rzg2lc.wic.bmap 
core-image-weston-smarc-rzg2lc.manifest

    Notice

    • No need to decompress core-image-weston-smarc-rzg2lc.wic.gz manually.
    • Ensure that the image file core-image-weston-smarc-rzg2lc.wic.gz is located in the same directory as core-image-weston-smarc-rzg2lc.wic.bmap to flash the image to the SD card successfully.

  4. Insert the micro SD card into your Linux PC and identify its device name and mount points.

    Use the lsblk command to check the <device name> and <mount point> 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

    Tip

    The device name is assigned to the SD card by Linux on your Host PC. It typically appears as /dev/sdx, where x is a letter representing the physical drive. In this example, the SD card’s device name is /dev/sda, and its mount points are /media/user/boot and /media/user/rootfs

  5. Unmount the SD card if it is currently mounted.

    Use the umount command with the mount points.

    umount <mount point>

    In this example:

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

  6. Flash the image to the SD card using bmaptool.

    Use the bmaptool command with the device name of SD card.

    Caution

    Before running bmaptool, double-check the <device name>. Make sure the target device (your SD card) is correct and not your system disk. Using the wrong device will overwrite all data on that disk and may render your system unbootable.

    Caution

    The operation below will earse the contents of your SD card.

    sudo bmaptool copy core-image-weston-smarc-rzg2lc.wic.gz <device name>

    In this example:

    sudo bmaptool core-image-weston-smarc-rzg2lc.wic.gz /dev/sda

After downloading the HMI SDK Package, locate the image file.

Target Board

Image File

Location

RZ/G2UL

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

image-file_rzg2ul_hmi-sdk_v2.3.1.0.zip

Option 1. For Windows PC

  1. Download or copy the HMI SDK package to your PC.

  2. Unzip the package and extract the image file.

    i. Right-click the downloaded package RTK0EF0195F02310SJ_rzg2ul.zip → Extract All...
    ii. Open the folder and right-click image-file_rzg2ul_hmi-sdk_v2.3.1.0.zip → Extract All...
    iii. Inside, you will find the image file: core-image-bsp-smarc-rzg2ul.wic.gz

  3. Flash the image file core-image-bsp-smarc-rzg2ul.wic.gz to your micro SD card using one of the following tools:

    Caution

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

Option 2. For Linux PC (Ubuntu)

  1. Install the required packages and software.

    i. Run the following command to install the required packages.

    sudo apt-get update
sudo apt-get install unzip bmap-tools

    ii. Run the following command to set up the git environment if it has not been configured yet.

    Tip

    This step is required only if you plan to continue with further development, such as building sample applications. If you only want to complete Step 5: Run the HMI Demo Applications, you may skip this step.

    git config --global user.email "<Your email address>"
git config --global user.name "<Your user name>"

  2. Download or copy the HMI SDK package to your PC.

  3. Unzip the package and extract the image file.

    Tip

    If you are using the GUI of Linux Ubuntu, please refer to the similar steps described in the Option 1. For Windows PC -2.

    i. Unzip the HMI SDK package.

    Navigate to the directory where the HMI SDK package was installed.

    unzip RTK0EF0195F02310SJ_rzg2ul.zip
cd RTK0EF0195F02310SJ_rzg2ul/

    ii. Unzip the image file folder.

    unzip image-file_rzg2ul_hmi-sdk_v2.3.1.0.zip
cd image-file_rzg2ul_hmi-sdk_v2.3.1.0/

    iii. Locate the target image file core-image-bsp-smarc-rzg2ul.wic.gz.

    ls

    core-image-bsp-smarc-rzg2ul.wic.gz 
core-image-bsp-smarc-rzg2ul.wic.bmap 
core-image-bsp-smarc-rzg2ul.manifest

    Notice

    • No need to decompress core-image-bsp-smarc-rzg2ul.wic.gz manually.
    • Ensure that the image file core-image-bsp-smarc-rzg2ul.wic.gz is located in the same directory as core-image-bsp-smarc-rzg2ul.wic.bmap to flash the image to the SD card successfully.

  4. Insert the micro SD card into your Linux PC and identify its device name and mount points.

    Use the lsblk command to check the <device name> and <mount point> 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

    Tip

    The device name is assigned to the SD card by Linux on your Host PC. It typically appears as /dev/sdx, where x is a letter representing the physical drive. In this example, the SD card’s device name is /dev/sda, and its mount points are /media/user/boot and /media/user/rootfs

  5. Unmount the SD card if it is currently mounted.

    Use the umount command with the mount points.

    umount <mount point>

    In this example:

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

  6. Flash the image to the SD card using bmaptool.

    Use the bmaptool command with the device name of SD card.

    Caution

    Before running bmaptool, double-check the <device name>. Make sure the target device (your SD card) is correct and not your system disk. Using the wrong device will overwrite all data on that disk and may render your system unbootable.

    Caution

    The operation below will earse the contents of your SD card.

    sudo bmaptool copy core-image-bsp-smarc-rzg2ul.wic.gz <device name>

    In this example:

    sudo bmaptool core-image-bsp-smarc-rzg2ul.wic.gz /dev/sda

Step 5: Run the HMI Demo Applications

The HMI SDK supports the following demo applications. Follow the steps below to use them.

  • LVGL Benchmark Demo
  • LVGL Home Panel Demo
  • Chromium Home Panel Demo


Follow the steps below to use them.

  1. Prepare the necessary equipment and connect it to your EVK board by following the instructions in Hardware Setup.

  2. Set up the DIP switch for eSD boot mode.

    Set up DIP switch SW1 and SW11 as follows.

    • SW1

      SW1-1SW1-2
      ONON

    • SW11

      SW11-1SW11-2SW11-3SW11-4
      ONONOFFON

    Set up DIP switch SW1 and SW11 as follows.

    • SW1

      SW1-1SW1-2SW1-3SW1-4SW1-5SW1-6
      ONONON*OFF*ON*Not used

      *These switches are not related to the settings required for this boot mode.

    • SW11

      SW11-1SW11-2SW11-3SW11-4
      ONONOFFON

    Set up DIP switch SW1 and SW11 as follows.

    • SW1

      SW1-1SW1-2SW1-3
      ONONON*

      *This switch is not related to the settings required for this boot mode.

    • SW11

      SW11-1SW11-2SW11-3SW11-4
      ONONOFFON

  3. Insert the bootable microSD card created in Step 4 into the microSD card slot for eSD boot mode (sd ChC CN3 port on Module Board), and then power on the EVK board.

    Tip

    • Please refer to the EVK Peripheral Setup for the location of the microSD card slot.
    • Press and hold the power button (red button, SW9) for 1 second to turn on the EVK board, and for 2 seconds to turn it off.

  4. The HMI SDK Demo Launcher launches automatically once the device is fully booted.

    Right after boot, you will see the launch window as shown below.

    After a few seconds, the HMI SDK Demo Launcher will appear.
    Click the corresponding button to try each demo application we provide.

This concludes the Getting Started guide.

For detailed information about each demo application, see Demo Applications.
For further development of sample applications, see Sample Applications.
For additional customizations, see Wiki.