.\" Automatically generated by Pandoc 2.17.1.1 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. .ie "\f[CB]x\f[]"x" \{\ . ftr V B . ftr VI BI . ftr VB B . ftr VBI BI .\} .el \{\ . ftr V CR . ftr VI CI . ftr VB CB . ftr VBI CBI .\} .TH "MBEDHTRUN" "1" "December 2018" "1.4.4" "User Commands" .hy .SH NAME .PP \f[B]mbedhtrun\f[R] - flash, reset and perform host-supervised tests on Mbed platforms .SH SYNOPSIS .PP \f[B]mbedhtrun\f[R] \f[B]--image-path\f[R] \f[I]FLASH_FILE\f[R] \f[B]--micro\f[R] \f[I]MICRO\f[R] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ \ \f[B]--port\f[R] \f[I]PORT\f[R] \f[B]--disk\f[R] \f[I]TARGET_PATH\f[R] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--target-id\f[R] \f[I]TARGET_ID\f[R]] [\f[B]--sync\f[R] \f[I]SYNC\f[R]] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--sync-timeout\f[R] \f[I]TIMEOUT\f[R]] [\f[B]--copy\f[R] \f[I]METHOD\f[R]] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--retry-copy\f[R] \f[I]ATTEMPTS\f[R]] [\f[B]--tag-filters\f[R] \f[I]FILTERS\f[R]] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--reset\f[R]] [\f[B]--program_cycle_s\f[R] \f[I]TIMEOUT\f[R]] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--reset-timeout\f[R] \f[I]TIMEOUT\f[R]] [\f[B]--process-start-timeout\f[R] \f[I]TIMEOUT\f[R]] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--polling-timeout\f[R] \f[I]TIMEOUT\f[R]] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--enum-host-tests\f[R] \f[I]DIR\f[R]] [\f[B]--test-cfg\f[R] \f[I]FILE\f[R]] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--run\f[R]] [\f[B]--skip-flashing\f[R]] [\f[B]--skip-reset\f[R]] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--send-break\f[R]] [\f[B]--baud-rate\f[R] \f[I]BAUD_RATE\f[R]] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--serial-output-file\f[R] \f[I]FILE\f[R]] [\f[B]--compare-log\f[R] \f[I]FILE\f[R]] .PD 0 .P .PD \ \ \ \ \ \ \ \ \ [\f[B]--verbose\f[R]] .PP \f[B]mbedhtrun\f[R] \f[B]\[en]-list\f[R] .PP \f[B]mbedhtrun\f[R] \f[B]\[en]-plugins\f[R] .PP \f[B]mbedhtrun\f[R] \f[B]\[en]-version\f[R] .PP \f[B]mbedhtrun\f[R] \f[B]\[en]-help\f[R] .SH DESCRIPTION .PP \f[B]mbedhtrun\f[R] supports flashing, resetting and testing of Mbed Enabled devices from the command line. .PP Whilst test automation tools such as \f[B]mbed-test-wrapper\f[R] can provide automated flashing and testing of Mbed devices, \f[B]mbedhtrun\f[R] provides a simple and convenient CLI to flash, reset and test devices directly. .SH OPTIONS .TP -f, --image-path \f[I]FLASH_FILE\f[R] path to file to flash .TP -m, --micro \f[I]MICRO\f[R] target microcontroller name .TP -p, --port \f[I]PORT\f[R] serial port of the target .TP -d, --disk \f[I]TARGET_PATH\f[R] target disk (mount point) path .TP -t, --target-id \f[I]TARGET_ID\f[R] unique Target ID or Mbed platform .TP --sync \f[I]SYNC\f[R] how many times __sync packet will be sent to device (0: none; -1: forever; 1,2,3\&...: number of times; default: 2) .TP --sync-timeout \f[I]TIMEOUT\f[R] delay in seconds between __sync packet (default: 5) .TP -c, --copy \f[I]METHOD\f[R] copy (flash the target) method selector .TP --retry-copy \f[I]ATTEMPTS\f[R] number of attempts to flash the target (default: 3) .TP --tag-filters \f[I]FILTERS\f[R] comma-separated list of device tags used when allocating a target to specify required hardware or attributes [\[en]tag-filters tag1,tag2] .TP -r, --reset force different type of reset .TP -C, --program_cycle_s \f[I]TIMEOUT\f[R] duration for program to sleep after copying binary onto target (default: 4) .TP -R, --reset-timeout \f[I]TIMEOUT\f[R] when forcing a reset (with -r), specify a post-reset idle delay in seconds (default: 1) .TP --process-start-timeout \f[I]TIMEOUT\f[R] set maximum time (seconds) to wait for an internal process to start (default: 60) .TP -e, --enum-host-tests \f[I]DIR\f[R] define directory with local host tests (default: ./test/host_tests) .TP --test-cfg \f[I]FILE\f[R] specify test class data about host test configuration .TP --run runs binary image on target (workflow: flash, reset, output console) .TP --skip-flashing skips use of copy/flash plugin. Note: target will not be reflashed .TP --skip-reset skips use of reset plugin. Note: target will not be reset .TP -P, --polling-timeout \f[I]TIMEOUT\f[R] timeout (seconds) for readiness of mount point and serial port of local or remote device (default: 60) .TP -b, --send-break send reset signal to board on specified port (-p PORT) and print serial output; can be combined with \f[V]-r RESET_TYPE\f[R] switch .TP --baud-rate \f[I]BAUD_RATE\f[R] baud rate of target; overrides values from mbed-ls, disk/mount point (-d, --disk-path), and serial port -p : .TP -v, --verbose enable verbose mode .TP --serial-output-file \f[I]FILE\f[R] save target serial output to this file .TP --compare-log \f[I]FILE\f[R] log file to compare with the serial output from target .TP --list print registered host test and exit .TP --plugins print registered plugins and exit .TP --version print version and exit .TP --help print usage details and exit .SH EXAMPLES .PP To flash the file \f[V]test.bin\f[R] to the mounted path \f[V]/mnt/MBED\f[R] on the \f[V]K64F\f[R] microcontroller, using the \f[V]shell\f[R] copy method with target serial port \f[V]COM5\f[R], and sleeping for 5 seconds after flashing, run: .IP .nf \f[C] $ mbedhtrun --disk /mnt/MBED --port COM5 --image-path \[dq]test.bin\[dq] -C 4 --copy shell --micro K64F \f[R] .fi .SH REPORTING BUGS .PP Upstream bug tracker: https://github.com/ARMmbed/htrun/issues .SH COPYRIGHT .PP Copyright (c) 2011-2018 ARM Limited .SH AUTHOR .PP This manual page is based on the mbed-host-tests documentation. It was created by Nick Morrott for the Debian GNU/Linux system, but may be used by others .SH SEE ALSO .PP \f[B]yotta\f[R](1), \f[B]mbed-test-wrapper\f[R](1), \f[B]mbedflsh\f[R](1)