MBEDHTRUN(1)

✨ MBEDHTRUN(1) ✨

okay so bestie, meet mbedhtrun — a User Commands page and literally your new fave CLI 💖

---

🌸 NAME 🌸

mbedhtrun — flash, reset and perform host-supervised tests on Mbed platforms 🦋

---

💅 SYNOPSIS 💅

mbedhtrun --image-path FLASH_FILE --micro MICRO
          --port PORT --disk TARGET_PATH
         [--target-id TARGET_ID] [--sync SYNC]
         [--sync-timeout TIMEOUT] [--copy METHOD]
         [--retry-copy ATTEMPTS] [--tag-filters FILTERS]
         [--reset] [--program_cycle_s TIMEOUT]
         [--reset-timeout TIMEOUT] [--process-start-timeout TIMEOUT]
         [--polling-timeout TIMEOUT]
         [--enum-host-tests DIR] [--test-cfg FILE]
         [--run] [--skip-flashing] [--skip-reset]
         [--send-break] [--baud-rate BAUD_RATE]
         [--serial-output-file FILE] [--compare-log FILE]
         [--verbose]

mbedhtrun –-list

mbedhtrun –-plugins

mbedhtrun –-version

mbedhtrun –-help

---

👑 DESCRIPTION 👑

mbedhtrun supports flashing, resetting and testing of Mbed Enabled devices from the command line. no cap. 🫶

So like, yeah, the big test automation tools — mbed-test-wrapper and friends — can absolutely do the whole automated flashing-and-testing thing for Mbed devices. But mbedhtrun? It gives you a simple and convenient CLI to flash, reset and test devices directly. main character energy, honestly. ✨

---

🎀 OPTIONS 🎀

• -f, --image-path FLASH_FILE — the path to the file you're gonna flash 💾
• -m, --micro MICRO — the name of the target microcontroller 🧚
• -p, --port PORT — the serial port of the target 🔌
• -d, --disk TARGET_PATH — the target disk (mount point) path 📁
• -t, --target-id TARGET_ID — unique Target ID, or the Mbed platform 🏷️
• --sync SYNC — how many times the __sync packet gets sent to the device. 0 means none, -1 means forever, 1,2,3... means that many times, and the default is 2 🔁
• --sync-timeout TIMEOUT — delay in seconds between __sync packets (default: 5) ⏳
• -c, --copy METHOD — picks the copy (flash the target) method 🖨️
• --retry-copy ATTEMPTS — how many attempts to flash the target (default: 3) 💪
• --tag-filters FILTERS — comma-separated list of device tags used when allocating a target, to specify required hardware or attributes [–tag-filters tag1,tag2] 🎯
• -r, --reset — force a different type of reset 🔄
• -C, --program_cycle_s TIMEOUT — how long the program sleeps after copying the binary onto the target (default: 4) 😴
• -R, --reset-timeout TIMEOUT — when you're forcing a reset (with -r), this sets a post-reset idle delay in seconds (default: 1) 🛌
• --process-start-timeout TIMEOUT — maximum time (seconds) to wait for an internal process to start (default: 60) ⏱️
• -e, --enum-host-tests DIR — define the directory with local host tests (default: ./test/host_tests) 📂
• --test-cfg FILE — specify test class data about host test configuration 🗂️
• --run — runs the binary image on the target (workflow: flash, reset, output console) ▶️
• --skip-flashing — skips use of the copy/flash plugin. Note: the target will not be reflashed 🙈
• --skip-reset — skips use of the reset plugin. Note: the target will not be reset 🙈
• -P, --polling-timeout TIMEOUT — timeout (seconds) for readiness of the mount point and serial port of a local or remote device (default: 60) 🕰️
• -b, --send-break — send a reset signal to the board on the specified port (-p PORT) and print serial output; can be combined with the -r RESET_TYPE switch 💥
• --baud-rate BAUD_RATE — baud rate of the target; overrides values from mbed-ls, disk/mount point (-d, --disk-path), and serial port -p 📶
• -v, --verbose — enable verbose mode 🗣️
• --serial-output-file FILE — save target serial output to this file 📝
• --compare-log FILE — log file to compare with the serial output from the target 🔍
• --list — print registered host test and exit 📋
• --plugins — print registered plugins and exit 🧩
• --version — print version and exit 🏷️
• --help — print usage details and exit 🆘

---

🌈 EXAMPLES 🌈

Say you wanna flash the file test.bin to the mounted path /mnt/MBED on the K64F microcontroller, using the shell copy method with target serial port COM5, and sleep for 5 seconds after flashing. Bestie, you run:

$ mbedhtrun --disk /mnt/MBED --port COM5 --image-path "test.bin" -C 4 --copy shell --micro K64F

---

😭 REPORTING BUGS 😭

Upstream bug tracker: https://github.com/ARMmbed/htrun/issues — go tell them, they wanna know 🫶

---

💜 COPYRIGHT 💜

Copyright (c) 2011-2018 ARM Limited

---

🦋 AUTHOR 🦋

This manual page is based on the mbed-host-tests documentation. It was created by Nick Morrott nickm@debian.org for the Debian GNU/Linux system, but may be used by others 💖

---

⭐ SEE ALSO ⭐

yotta(1), mbed-test-wrapper(1), mbedflsh(1)

---

k that's the whole page, bestie 💅 this was version 1.4.4, dated December 2018 — iconic behaviour fr fr, ily, go flash something ✨🎀