.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "MBEDHTRUN" "1" "December 2018" "1.4.4" "User Commands"
.hy
.SH NAME
.PP
\f[B]mbedhtrun\f[] \- flash, reset and perform host\-supervised tests on
Mbed platforms
.SH SYNOPSIS
.PP
\f[B]mbedhtrun\f[] \f[B]\-\-image\-path\f[] \f[I]FLASH_FILE\f[]
\f[B]\-\-micro\f[] \f[I]MICRO\f[]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \f[B]\-\-port\f[] \f[I]PORT\f[]
\f[B]\-\-disk\f[] \f[I]TARGET_PATH\f[]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [\f[B]\-\-target\-id\f[] \f[I]TARGET_ID\f[]]
[\f[B]\-\-sync\f[] \f[I]SYNC\f[]]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [\f[B]\-\-sync\-timeout\f[] \f[I]TIMEOUT\f[]]
[\f[B]\-\-copy\f[] \f[I]METHOD\f[]]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [\f[B]\-\-retry\-copy\f[] \f[I]ATTEMPTS\f[]]
[\f[B]\-\-tag\-filters\f[] \f[I]FILTERS\f[]]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [\f[B]\-\-reset] [\f[]\-\-program_cycle_s**
\f[I]TIMEOUT\f[]]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [\f[B]\-\-reset\-timeout\f[] \f[I]TIMEOUT\f[]]
[\f[B]\-\-process\-start\-timeout\f[] \f[I]TIMEOUT\f[]]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [\f[B]\-\-polling\-timeout\f[]
\f[I]TIMEOUT\f[]]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [\f[B]\-\-enum\-host\-tests\f[] \f[I]DIR\f[]]
[\f[B]\-\-test\-cfg\f[] \f[I]FILE\f[]]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [\f[B]\-\-run] [\f[]\-\-skip\-flashing]
[**\-\-skip\-reset]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [\f[B]\-\-send\-break] [\f[]\-\-baud\-rate**
\f[I]BAUD_RATE\f[]]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [\f[B]\-\-serial\-output\-file\f[]
\f[I]FILE\f[]] [\f[B]\-\-compare\-log\f[] \f[I]FILE\f[]]
.PD 0
.P
.PD
\ \ \ \ \ \ \ \ \ \ \ \ \ [**\-\-verbose]
.PP
\f[B]mbedhtrun\f[] \f[B]\[en]\-list\f[]
.PP
\f[B]mbedhtrun\f[] \f[B]\[en]\-plugins\f[]
.PP
\f[B]mbedhtrun\f[] \f[B]\[en]\-version\f[]
.PP
\f[B]mbedhtrun\f[] \f[B]\[en]\-help\f[]
.SH DESCRIPTION
.PP
\f[B]mbedhtrun\f[] 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[] can
provide automated flashing and testing of Mbed devices,
\f[B]mbedhtrun\f[] provides a simple and convenient CLI to flash, reset
and test devices directly.
.SH OPTIONS
.TP
.B \-m, \-\-micro \f[I]MICRO\f[]
target microcontroller name
.RS
.RE
.TP
.B \-p, \-\-port \f[I]PORT\f[]
serial port of the target
.RS
.RE
.TP
.B \-d, \-\-disk \f[I]TARGET_PATH\f[]
target disk (mount point) path
.RS
.RE
.TP
.B \-t, \-\-target\-id \f[I]TARGET_ID\f[]
unique Target ID or Mbed platform
.RS
.RE
.TP
.B \-\-sync \f[I]SYNC\f[]
how many times __sync packet will be sent to device (0: none; \-1:
forever; 1,2,3\&...: number of times; default: 2)
.RS
.RE
.TP
.B \-\-sync\-timeout \f[I]TIMEOUT\f[]
delay in seconds between __sync packet (default: 5)
.RS
.RE
.TP
.B \-f, \-\-image\-path \f[I]FLASH_FILE\f[]
path with target's binary image
.RS
.RE
.TP
.B \-c, \-\-copy \f[I]METHOD\f[]
copy (flash the target) method selector
.RS
.RE
.TP
.B \-\-retry\-copy \f[I]ATTEMPTS\f[]
number of attempts to flash the target (default: 3)
.RS
.RE
.TP
.B \-\-tag\-filters \f[I]FILTERS\f[]
comma\-separated list of device tags used when allocating a target to
specify required hardware or attributes [\[en]tag\-filters tag1,tag2]
.RS
.RE
.TP
.B \-r, \-\-reset
force different type of reset
.RS
.RE
.TP
.B \-C, \-\-program_cycle_s \f[I]TIMEOUT\f[]
duration for program to sleep after copying binary onto target (default:
4)
.RS
.RE
.TP
.B \-R, \-\-reset\-timeout \f[I]TIMEOUT\f[]
when forcing a reset (with \-r), specify a post\-reset idle delay in
seconds (default: 1)
.RS
.RE
.TP
.B \-\-process\-start\-timeout \f[I]TIMEOUT\f[]
set maximum time (seconds) to wait for an internal process to start
(default: 60)
.RS
.RE
.TP
.B \-e, \-\-enum\-host\-tests \f[I]DIR\f[]
define directory with local host tests (default: ./test/host_tests)
.RS
.RE
.TP
.B \-\-test\-cfg \f[I]FILE\f[]
specify test class data about host test configuration
.RS
.RE
.TP
.B \-\-run
runs binary image on target (workflow: flash, reset, output console)
.RS
.RE
.TP
.B \-\-skip\-flashing
skips use of copy/flash plugin.
Note: target will not be reflashed
.RS
.RE
.TP
.B \-\-skip\-reset
skips use of reset plugin.
Note: target will not be reset
.RS
.RE
.TP
.B \-P, \-\-polling\-timeout \f[I]TIMEOUT\f[]
timeout (seconds) for readiness of mount point and serial port of local
or remote device (default: 60)
.RS
.RE
.TP
.B \-b, \-\-send\-break
send reset signal to board on specified port (\-p PORT) and print serial
output; can be combined with \f[C]\-r\ RESET_TYPE\f[] switch
.RS
.RE
.TP
.B \-\-baud\-rate \f[I]BAUD_RATE\f[]
baud rate of target; overrides values from mbed\-ls, disk/mount point
(\-d, \-\-disk\-path), and serial port \-p :
.RS
.RE
.TP
.B \-v, \-\-verbose
enable verbose mode
.RS
.RE
.TP
.B \-\-serial\-output\-file \f[I]FILE\f[]
save target serial output to this file
.RS
.RE
.TP
.B \-\-compare\-log \f[I]FILE\f[]
log file to compare with the serial output from target
.RS
.RE
.TP
.B \-\-list
print registered host test and exit
.RS
.RE
.TP
.B \-\-plugins
print registered plugins and exit
.RS
.RE
.TP
.B \-\-version
print version and exit
.RS
.RE
.TP
.B \-\-help
print usage details and exit
.RS
.RE
.SH EXAMPLES
.PP
To flash the file \f[C]test.bin\f[] to the mounted path
\f[C]/mnt/MBED\f[] on the \f[C]K64F\f[] microcontroller, using the
\f[C]shell\f[] copy method with target serial port \f[C]COM5\f[], and
sleeping for 5 seconds after flashing, run:
.IP
.nf
\f[C]
$\ mbedhtrun\ \-\-disk\ /mnt/MBED\ \-\-port\ COM5\ \-\-image\-path\ "test.bin"\ \-C\ 4\ \-\-copy\ shell\ \-\-micro\ K64F
\f[]
.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 <knowledgejunkie@gmail.com> for the
Debian GNU/Linux system, but may be used by others
.SH SEE ALSO
.PP
\f[B]yotta(1)\f[], \f[B]mbed\-test\-wrapper(1)\f[], **mbedflsh(1)