usbhidaction - perform actions according to USB HID controls
usbhidaction [-div] -c config-file -f device arg ...
usbhidaction can be used to execute commands when certain
on HID controls. The normal operation for this program is
to read the
configuration file and then become a daemon and execute commands as the
HID items specify. If a read from the HID device fails the
this will make it die when the USB device is unplugged.
The options are as follows:
Specify a path name for the config file.
-d Toggle the daemon flag.
Specify a path name for the device to operate on.
If device is
numeric, it is taken to be the USB HID device number. If it is a
relative path, it is taken to be the name of the device under
/dev. An absolute path is taken to be the literal
-i Ignore HID items in the config file that do not exist in the device.
-v Be verbose, and do not become a daemon.
The config file will be re-read if the process gets a HUP
The configuration file has a very simple format. Each line
action; if a line begins with a whitespace it is considered
of the previous line. Lines beginning with `#' are
Each line has three parts: a name of a USB HID item, a value
item, and an action. There must be whitespace between the
The item names are similar to those used by usbhidctl(1),
but each part
must be prefixed by its page name.
The value is simply a numeric value. When the item reports
the action will be performed. If the value is `*' it will
match any value.
The action is a normal command that is executed with system(3). Before
it is executed some substitution will occur: `$n' will be
replaced by the
nth argument on the command line, `$V' will be replaced by
value of the HID item, `$N' will be replaced by the name of
and `$H' will be replaced by the name of the HID device.
/usr/share/misc/usb_hid_usages The HID usage table.
The following configuration file can be used to control a
pair of Philips
USB speakers with the HID controls on the speakers.
# Configuration for various Philips USB speakers
mixerctl -f $1 -n -w fea8-i7-master++
mixerctl -f $1 -n -w fea8-i7-master--
mixerctl -f $1 -n -w fea8-i7-mute++
mixerctl -f $1 -n -w fea8-i7-bass++
mixerctl -f $1 -n -w fea8-i7-bass--
A sample invocation using this configuration would be
$ usbhidaction -f /dev/uhid1 -c conf /dev/mixer1
usbhidctl(1), usbhid(3), uhid(4), usb(4)
The usbhidaction command first appeared in OpenBSD 3.2.
OpenBSD 3.6 December 29, 2000
[ Back ]