View source for R-Car/Boards/Yocto-Gen3/Azure IoT Edge/v5.9.0

{{Template:R-Car-Gen3-Navbox}}
{{TOC right}}

[[Category:R-Car]]
[[Category:R-Car Gen3]]

== Introduction ==
This page describes how to setup the Yocto environment to use the Azure IoT Edge with R-Car and run it.

This page contains information abot building and running Azure IoT Edge on Yocto environment on:
* [[R-Car/Boards/H3SK | Renesas R-Car-H3 Starter Kit Premier]] (unofficial name - H3ULCB)
* [[R-Car/Boards/M3SK | Renesas R-Car-M3 Starter Kit Pro]] (unofficial name - M3ULCB)
** https://www.renesas.com/us/en/products/automotive-products/automotive-system-chips-socs/r-car-h3-m3-starter-kit
* [[R-Car/Boards/CCPF-SK]]
** http://www.shimafuji.co.jp/products/2308

== Topic ==
{{Template:R-Car-Gen3-Topic}}

== Software revisions ==

{| class="wikitable"
|-
! Software !! Revision
|-
| Yocto Project || [https://git.yoctoproject.org/poky/tag/?id=yocto-3.1.11 3.1.11]
|- 
| aarch64-poky-linux-gcc (GCC) || 9.3
|- 
| Kernel Ver || 5.10.41
|- 
| Userland 64/32bit || 64
|- 
| U-Boot || 2020.10
|- 
| OP_TEE || 3.13.0
|- 
| IoT Edge || 1.1.8
|- 
|}

== Environment ==
=== Host PC ===
{| class="wikitable"
|-
| OS || Ubuntu 20.04 LTS (64bit)
|- 
| Memory || 8 GB or more
|- 
| Storage || At least 100 GB free
|- 
|}
=== Boards confirmed to work ===
{| class="wikitable"
|-
! Board !! SoC !! Confirmed
|-
| R-Car Starter Kit Premier(H3) || H3e-2G v3.0 || OK
|- 
| R-Car Starter Kit Premier(H3) || H3 v3.0 (1rank DDR) || OK
|- 
| R-Car Starter Kit Premier(H3) || H3 v3.0 (2rank DDR) || NT
|- 
| R-Car Starter Kit Premier(H3) || H3 v2.0 with 4GB DDR || OK
|- 
| R-Car Starter Kit Pro || M3 v3.0 || OK
|- 
| R-Car Starter Kit Pro || M3 v1.0 || OK
|- 
| CCPF-SK + R-Car Starter Kit Premier(H3) || H3e-2G v3.0 || OK
|- 
| CCPF-SK + R-Car Starter Kit Premier(H3) || H3 v3.0 (1rank DDR) || OK
|- 
| CCPF-SK + R-Car Starter Kit Premier(H3) || H3 v3.0 (2rank DDR) || NT
|- 
| CCPF-SK + R-Car Starter Kit Premier(H3) || H3 v2.0 with 4GB DDR || OK
|- 
| CCPF-SK + R-Car Starter Kit Pro || M3 v3.0 || OK
|- 
| CCPF-SK + R-Car Starter Kit Pro || M3 v1.0 || OK
|- 
|}
{{Note}} NT='Not Tested' but will work

See also:
* [[R-Car/Boards/H3SK#Hardware]]
* [[R-Car/Boards/M3SK#Hardware]]

== Set up in the Azure ==
# Create an Azure account
#: Create an Azure account with reference to https://azure.microsoft.com/en-us/free/.
# Create an Azure IoT Hub
#: Create an Azure IoT Hub with reference to [https://docs.microsoft.com/ja-jp/azure/iot-hub/iot-hub-create-through-portal#create-an-iot-hub Create an IoT hub].
# Register an Azure Device
#: Access https://portal.azure.com/ and select your IoT Hub.
#: Select "IoT Edge" under "Device Management" from the side menu, and then click "+ Add IoT Edge Device".
#:: [[File:Azure-device-1.png|1000px]]<br>
#: Then, set an arbitrary name for "Device ID" and click "Save" without changing the other settings.
#: And then, select "IoT Edge" under "Device Management" from the side menu, and click the device ID you created to check the "Primary Connection String".
#: (The "Primary Connection String" is used in [[#Receive_telemetry_messages|Receive telemetry messages]].)
#:: [[File:Azure-device-3.png|1000px]]<br>
# Add the Azure module
#: Add the Simulated Temperature Sensor module with reference to [https://docs.microsoft.com/en-us/azure/iot-edge/quickstart-linux?view=iotedge-2018-06#deploy-a-module Deploy a module].

== Prepare the SW for R-Car ==

=== Getting Started using prebuilt binaries ===

# Download prebuilt binaries
#* Download Yocto BSP binary with Azure IoT Edge from following page:
#*: Binary:
#*:: [https://www.renesas.com/node/1602221 Download for Starter Kit Premiere(H3)]
#*:: [https://www.renesas.com/node/1602231 Download for Starter Kit Pro(M3)]
#*:: [https://www.renesas.com/node/1602226 Download for CCPF-SK + Starter Kit Premiere(H3)]
#*:: [https://www.renesas.com/node/1602236 Download for CCPF-SK + Starter Kit Pro(M3)]
#*: {{Note}} '''Source code is not needed for this guide'''. But, if source code is required, please refer to following:
#*:: Source:
#*::: [https://www.renesas.com/node/1602246 Download for Starter Kit Premiere(H3)]
#*::: [https://www.renesas.com/node/1602266 Download for Starter Kit Pro(M3)]
#*::: [https://www.renesas.com/node/1602251 Download for CCPF-SK + Starter Kit Premiere(H3)]
#*::: [https://www.renesas.com/node/1602271 Download for CCPF-SK + Starter Kit Pro(M3)]
#* Extract downloaded files
#*: ex.) R-Car Starter Kit Premier(H3)
#*:: Unzip Yocto-v5.9.0-ccpfsk-iotedge-h3ulcb-binary.zip -d <working directory>
# Setup SW
#* Setup SW (Prepare SD card, Flashing IPL, Booting). Please refer to [[R-Car/Boards/CCPF-SK/GettingStarted/Linux#SW_Setup]]

=== Building the BSP ===
==== Required packages ====

# Install the required packages
#: <syntaxhighlight lang="bash">
$ 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 python3-git python3-jinja2 libegl1-mesa \
libsdl1.2-dev pylint3 xterm
</syntaxhighlight>
#: Refer to [http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html#packages Yocto Project Quick Start] for more information.
# Set up initial git configuration
#: <syntaxhighlight lang="bash">
$ git config --global user.email "you@example.com"
$ git config --global user.name "Your Name"
</syntaxhighlight>

==== Building the BSP ====
# Create the following script(build.sh) for building
#: <syntaxhighlight lang="bash">
#!/bin/bash

BOARD_LIST=("h3ulcb" "m3ulcb" "h3ulcb-ccpf-sk" "m3ulcb-ccpf-sk")
TARGET_BOARD=$1
WORK=`pwd`/${TARGET_BOARD}-build

repolist=( \
    "git://git.yoctoproject.org/poky;74b22db6879b388d700f61e08cb3f239cf940d18" \
    "git://git.openembedded.org/meta-openembedded;814eec96c2a29172da57a425a3609f8b6fcc6afe" \
    "https://github.com/renesas-rcar/meta-renesas;13fd24957b9acc29a235ee0c7f398fd867f38b47" \
    "https://github.com/renesas-rcar/meta-renesas-ccpf;09dd815616cce3a2bdcf8906c0d21403df8b93bd" \
    "https://github.com/yhamamachi/meta-rcar-dev-utils;remotes/origin/v5.9.0"
)
repolist_iotedge=( \
    "git://git.yoctoproject.org/meta-virtualization;c4f156fa93b37b2428e09ae22dbd7f5875606f4d" \
    "https://github.com/tkomagata/meta-docker;f8f83a7b15930b74b4af2ae5e7c4c55607fafa86" \
    "https://github.com/meta-rust/meta-rust;7ff669d8cedd83a2d3efb73073a63b0a7efffddc" \
    "https://github.com/tkomagata/meta-iotedge;e9f1e6373b3e2017aff2eeceebb3d267fd10f3a8" \
)

_usage () {
    echo "Usage: $0 \${BOARD_NAME} [release package option]"
    echo "BOARD_NAME list: "
    for i in ${BOARD_LIST[@]}; do echo "  - $i"; done
    echo "release package options:"
    echo "  -r: Create core-image-xxxxx-release"
    exit
}

repo_clone () {
    mkdir -p ${WORK}
    for repo in ${repolist[@]}; do
        URL=$(echo $repo | cut -d';' -f1)
        COMMIT=$(echo $repo | cut -d';' -f2)
        NAME=${URL##*/}
        if [[ ! -d "${WORK}/${NAME}" ]]; then
            git clone ${URL} ${WORK}/${NAME}
        fi
        cd ${WORK}/${NAME}; git checkout -B tmp ${COMMIT}
    done
}

check_target_board () {
    if ! `IFS=$'\n'; echo "${BOARD_LIST[*]}" | grep -qx "${TARGET_BOARD}"`; then
        _usage
    fi
}

set_build_type () {
    BUILD_TARGET=core-image-minimal
    BUILD_TYPE=bsp
    repolist=(${repolist[@]} ${repolist_iotedge[@]})
}

build_yocto () {
    cd ${WORK}
    BUILD_DIR=${WORK}/build_${TARGET_BOARD}_${BUILD_TYPE}${RELEASE}
    rm -rf ${BUILD_DIR}/conf
    TEMPLATECONF=${WORK}/meta-iotedge/conf/machine/${TARGET_BOARD}/${BUILD_TYPE}/ \
        source poky/oe-init-build-env ${BUILD_DIR}
    echo "DL_DIR = '${DL_DIR:-${WORK}/yocto_dl_dir}'" >> ${BUILD_DIR}/conf/local.conf
    echo "SSTATE_DIR = '${SSTATE_DIR:-${WORK}/yocto_sstate_dir}'" >> ${BUILD_DIR}/conf/local.conf
    echo "${LOCAL_CONF_APPEND}" >> ${BUILD_DIR}/conf/local.conf
    bitbake-layers add-layer ${WORK}/meta-rcar-dev-utils/meta-rcar-gen3
    if [[ "${RELEASE}" != "" ]]; then
        cp -f ${WORK}/meta-rcar-bsp-release/meta-rcar-gen3/docs/sample/site.conf.sample \
            ${BUILD_DIR}/conf/site.conf
        bitbake-layers add-layer ${WORK}/meta-rcar-bsp-release/meta-rcar-gen3
    fi
    bitbake ${BUILD_TARGET}${RELEASE}
}

build_32bit_rom_writer () {
    cd ${WORK}
    BUILD_32_DIR=${WORK}/build_32
    source poky/oe-init-build-env ${BUILD_32_DIR}
    cp -f ${BUILD_DIR}/conf/* -t ${BUILD_32_DIR}/conf/
    echo "MACHINE ??= 'qemuarm'" >> ${BUILD_32_DIR}/conf/local.conf
    echo "DEFAULTTUNE = 'armv7a'" >> ${BUILD_32_DIR}/conf/local.conf
    bitbake flash-writer renesas-bsp-rom-writer
    cp -rf ${BUILD_32_DIR}/tmp/deploy/images/qemuarm/renesas-bsp-rom-writer_32bit \
        -t ${BUILD_DIR}/tmp/deploy/release/binary/ipl/
}

## main process ##
RELEASE=""
check_target_board $@
set_build_type $@
if [[ "$(echo $*' ' | grep ' -r ')" != "" ]]; then
    repolist+=("https://github.com/yhamamachi/meta-rcar-bsp-release;remotes/origin/v5.9.0")
    RELEASE=-release
fi
repo_clone
build_yocto
if [[ "$(echo $*' ' | grep ' -r ')" != "" ]]; then
    build_32bit_rom_writer
fi
</syntaxhighlight>
# Build
#: <syntaxhighlight lang="bash">
$ chmod a+x build.sh
$ ./build.sh <target_board_name> <release package option>
Ex.)
    h3ulcb build:
        ./build.sh h3ulcb
    m3ulcb-ccpf-sk build for release:
        ./build.sh m3ulcb-ccpf-sk -r
</syntaxhighlight>
#: target_board_name is specified for each board according to the following table:
#: [[File:R-car-sk-target-board-name.png|400px]]<br><br>
#: Depending on the performance of the host PC, it may take several hours for the build to complete.
#: When the build completes successfully, you will see the following output:
#: <syntaxhighlight lang="bash">
NOTE: Tasks Summary: Attempted 4704 tasks of which 31 didn't need to be rerun and all succeeded.
</syntaxhighlight>
# Check the built images
#: The built images are stored in the following:
#: 　<target_board_name>-build/build_<target_board_name>_bsp(-release)/tmp/deploy/images/<target_board_name>/
# Write the images to the SD card
#:  Write the images to the SD card with reference to [[R-Car/Boards/Yocto-Gen3/v5.5.0#Loading_kernel_and_rootfs_via_eMMC.2FSD_card|Loading kernel and rootfs via eMMC/SD card]].
#: {{Note}} Please replace "core-image-weston" with "core-image-minimal".

== Receive telemetry messages ==
# Procedure on the target board
## Turn on the target board
### Insert the SD card into the target board, and connect the LAN cable to it.
### Use a microUSB cable to connect the target board, connect a power supply to it, and connect to serial console.
### Power on.
###: Short-press SW8 "Power" to switch the board on.
###: If the board is attached to the CCPF board, short-press SW4 "Power" instead of SW8.
## Configure U-Boot to boot from SD card
##: Refer to [[R-Car/Boards/Yocto-Gen3/v5.5.0#Configure_U-Boot_to_boot_from_SD_card|Configure U-Boot to boot from SD card]].
## Connect to your IoT Hub
##: Configure to connect to your IoT Hub.
### Add a write permission to "/etc/iotedge/config.yaml".
###: <syntaxhighlight lang="bash">
$ chmod +w /etc/iotedge/config.yaml
</syntaxhighlight>
### Set the "Primary Connection String" to device_connection_string.
###: <syntaxhighlight lang="bash">
$ vi /etc/iotedge/config.yaml
  device_connection_string: "<ADD DEVICE CONNECTION STRING HERE>"　← ★
</syntaxhighlight>
###: {{Note}} See [[#Set_up_in_the_Azure|Register an Azure Device]] for the "Primary Connection String".
### Remove a write permission from "/etc/iotedge/config.yaml".
###: <syntaxhighlight lang="bash">
$ chmod -w /etc/iotedge/config.yaml
</syntaxhighlight>
### Restart the IoT Edge daemon.
###: <syntaxhighlight lang="bash">
$ systemctl restart iotedge
</syntaxhighlight>
### Check that the IoT Edge daemon is running.
###: <syntaxhighlight lang="bash">
$ systemctl status iotedge --no-page
</syntaxhighlight>
###: [[File:Azure-status-no-page.png|1000px]]<br><br>
### Check that the following modules are deployed and are running.
###: {{Note}} It may take several minutes for the deployment to complete.
###: <syntaxhighlight lang="bash">
$ iotedge list
</syntaxhighlight>
##:: [[File:Azure-list.png|1000px]]<br><br>
# Procedure on the Azure IoT Explorer
#: Check that it receives telemetry messages from the IoT Edge Device.
## Install the Azure IoT Explorer.
##:: Download the installer from https://github.com/Azure/azure-iot-explorer/releases/tag/v0.14.1.
##:: {{Note}} Use v0.14.1 because v0.14.7(latest version) does not receive any telemetry messages.
## Launch the Azure IoT Explorer.
## Get the "Primary Connection String" for the iothubowner.
##: Go the IoT Hub page on the Azure Portal, click your "IoT Hub", "Shared access policies" from the side menu, and then click "iothubowner". Next, copy the  "Primary Connection string".
##: [[File:Azure-iot-exp-1.png|1000px]]<br>
## Register your IoT Hub to the IoT Explorer
##: Select the "IoT hubs" from the side menu of the Azure IoT Explorer, and click "+ Add connection".
##: Paste the "Primary Connection string" you copied into the "Connection string" text box, finally click the "Save".
## Receive telemetry messages
##: Select the "Telemetry" from the side menu, and click "Start".
##: When a message is received, the following log is displayed.
##: [[File:Azure-iot-exp-3.png|1000px]]<br>