Tool Command Lines¶

Command syntax, options and examples for the host tools that ship with the SDK. Examples use the IPRO7AI Reef EVK V4.0. For step-by-step flashing and console use, see Flashing & Serial Console.

Tools at a glance¶

This release has no setup or procedure for on-target debugging over JTAG / GDB. Debugging relies on the serial console, logs and offline addr2line; see Debugging & Troubleshooting.

Environment variables¶

build_freertos.sh¶

./build_freertos.sh [actions...] [options] <project>

Actions can be chained and run in order; the first failure stops the run. With no action, build runs. It is a bash script for macOS and Linux.

The console baud rate is CONFIG_PLATFORM_UART_BAUDRATE in the configuration file in use, 115200 when unset.

<project> is an application name (ipro7ai_reef_demo) or a path below apps/ (platform/ipro7ai_reef_demo). An ambiguous or unknown name prints the candidates. The description column of -l comes from the first comment line of .config and is blank for some applications.

Build, flash and open the console on the Reef in one go (before the very first flash there is no SDK firmware on the board to answer reboot_dl, so enter download mode by hand):

export IPRO_FLASH_TOOL=<IntelProCube>/ipro_iot_tool_macos
./build_freertos.sh -p /dev/cu.usbserial-XXXX \
    -P <IntelProCube>/chips/ipro7/partition/partition_cfg_2M.toml \
    build flash monitor ipro7ai_reef_demo

You should see, in order:

→ Entering download mode...
→ Flashing ipro7ai_reef_demo_IPRO7.bin (--chip-variant IPRO7AI, --pt <IntelProCube>/chips/ipro7/partition/partition_cfg_2M.toml)...
...
✓ Flash succeeded (…)
→ Opening serial monitor on /dev/cu.usbserial-XXXX at 115200...

Pick another Reef configuration with -d, for example:

./build_freertos.sh -d defconfig_reef build ipro_ble_remote          # output in build_reef/build_out/
./build_freertos.sh -d defconfig_reef_ov5640 build flash ipro7_uvc_cam
./build_freertos.sh -l                                              # list the 40 projects
./build_freertos.sh size ipro7ai_reef_demo

Output goes to <app>/build/build_out/ (build_<name>/build_out/ with -d): <app>_<chip>.bin, .elf and .map, where the chip comes from CONFIG_CHIP (_IPRO7 for IPRO7 applications, _IPRO6 for IPRO6S applications).

make targets¶

Each application's Makefile calls project.build in the SDK root (CMake with the Unix Makefiles generator, then make -j4).

• CMake: the cmake on PATH first, then tools/cmake/ (Linux x86-64); with neither, the build stops at No cmake found.
• After each build, compile_commands.json is copied to the SDK root for editors.
• make menuconfig needs tools/kconfig/menuconfig.py, which does not ship; the defconfig and list-defconfigs targets of some Makefiles look in a configs/ directory that does not ship either. Edit .config directly, or save a copy as defconfig_<name> and build it with DEFCONFIG=.

IntelProCube flash tool¶

Flashing uses the IntelProCube command-line tool. It is not included in V2.2.1: download 0.7.0.1 from GitHub and install it as in Set Up Your Host. The tool reads its chip files from its own chips/ directory, so run it from the IntelProCube directory. The table is compiled from the READMEs and scripts in the SDK; the tool itself is the reference for the full option set.

Flashing the Reef's out-of-box firmware (enter download mode first):

cd <IntelProCube>
./ipro_iot_tool_macos --chipname ipro7 --chip-variant IPRO7AI \
    --port /dev/cu.usbserial-XXXX --baudrate 921600 \
    --pt chips/ipro7/partition/partition_cfg_2M.toml \
    --firmware <SDK>/apps/platform/ipro7ai_reef_demo/build/build_out/ipro7ai_reef_demo_IPRO7.bin

A successful run ends with [All Success]. The tool exits 0 even when it fails, so judge by that line. On Linux use ./ipro_iot_tool_linux; on Windows ipro_iot_tool.exe and a port such as COM5. The partition table, --boot2 and --mfg each Reef application needs are listed on IPRO7AI Reef EVK.

serial_monitor.py¶

python3 tools/serial_monitor.py <port> [--baud 115200] [--timeout 30]
                                [--send CMD] [--wait-for PATTERN] [--log FILE]

Opens the port with the Python standard library's termios, so it needs no pyserial; it runs on macOS and Linux, not on Windows. It only reads output (optionally after sending one command); it is not an interactive terminal. To type commands line by line, use screen, minicom or another serial terminal program.

# Reef console (115200): run the self-test, stop after 10 s
python3 tools/serial_monitor.py /dev/cu.usbserial-XXXX --send "reef selftest" --timeout 10

# ipro7_jpeg_decode's Reef configuration (921600): watch until Ctrl-C and save a log
python3 tools/serial_monitor.py /dev/cu.usbserial-XXXX --baud 921600 --timeout 0 --log console.log

# Reboot the running firmware into download mode (it prints "reboot to download mode")
python3 tools/serial_monitor.py /dev/cu.usbserial-XXXX --send reboot_dl --timeout 2

On macOS use /dev/cu.*; /dev/tty.* waits for carrier detect and hangs. Stop the monitor before flashing so the port is free.

create_ota.py¶

Wraps the combined image that IntelProCube builds into a boot2 OTA package: XZ-compressed by default, written as <input name>.xz.ota, or uncompressed as <input name>.ota with --raw. The input must be the combined image with a boot header that starts with IPNP (the tool's chips/ipro7/img_create_iot/whole_img.bin), not the .bin from an SDK build; the script stops on any other format.

python3 tools/create_ota.py <whole_img.bin> [--raw] [-o OUTPUT] [--hw-ver STR] [--fw-ver STR]

On the Reef, make_reef_ota.sh of ipro_ble_remote runs the tool's --build and this script for you; see Host tools for Reef applications. The complete OTA flow is in OTA Updates.

Host tools for Reef applications¶

Browser image Teach: tools/teach_web¶

Collect images from the Reef's camera, train a classifier and deploy it over USB in Chrome or Edge, without installing IPRO AI Studio. The board must run ipro_reef_teach in image mode; the host needs Python 3.8 or newer.

The mfg content of ipro_reef_teach: mfg_payload.py¶

The first flash of ipro_reef_teach writes the boot mode and the voiceprint model with --mfg:

python3 apps/ai/ipro_reef_teach/mfg_payload.py \
    --voice apps/ai/ipro_reef_teach/model/model_b.spkb --mode image -o reef_teach_mfg.bin

--mode is image, voice or sensor. Pass the resulting reef_teach_mfg.bin to IntelProCube with --mfg; the flash command is on the example page. Leave out --mfg when you update only the firmware.

Reef OTA tools of ipro_ble_remote¶

Both Python scripts need bleak: python3 -m venv .venv && .venv/bin/pip install bleak. OTA works only on a board flashed with boot2 and partition_cfg_2M_remote_ab.toml; never run OTA on a Reef flashed with the standard partition_cfg_2M.toml.

Tools of other Reef applications¶

Zephyr scripts¶

tools/zephyr/ (bootstrap.sh, build.sh, flash.sh, monitor.sh, ci_build.sh) serves the Zephyr boards ipro7_evb and ipro7ai_evk; this release has no Zephyr board for the Reef. Usage is in Zephyr RTOS.

Size and memory analysis¶

./build_freertos.sh size ipro7ai_reef_demo
/opt/toolchain/riscv_ipro7/bin/riscv64-unknown-elf-nm --size-sort -S \
    apps/platform/ipro7ai_reef_demo/build/build_out/ipro7ai_reef_demo_IPRO7.elf | tail -20

With both CONFIG_AI_SUPPORT and CONFIG_MM_SUPPORT, the linker script shrinks the OCRAM region to 64 KB (CONFIG_EM_SIZE 0) or 48 KB (CONFIG_EM_SIZE above 0), and CMake prints AI+MM …: OCRAM=… at configure time. The memory map is on IPRO7; the OCRAM budget is in Build System & Configuration.

Automated testing¶

./build_freertos.sh test ipro_unit_test builds, flashes and waits for ALL TESTS PASSED or SOME TESTS FAILED; ipro_unit_test needs the IPRO7 EVB. The Reef's on-board self-test is reef selftest in the out-of-box firmware; see Debugging & Troubleshooting.

Other tools¶

Development workflow¶

The edit, build, flash and console loop on the Reef is in Build and Flash Workflow; to start your own application, see Create your first application. Debugging and common errors are in Debugging & Troubleshooting.