usbhidctl(1) [freebsd man page]
USBHIDCTL(1) BSD General Commands Manual USBHIDCTL(1) NAME
usbhidctl -- manipulate USB HID devices SYNOPSIS
usbhidctl -f device [-t table] [-v] [-x] -r usbhidctl -f device [-t table] [-l] [-v] [-x] [-z] -a usbhidctl -f device [-t table] [-l] [-n] [-v] [-x] [-z] item ... usbhidctl -f device [-t table] [-v] [-z] -w item=value ... DESCRIPTION
The usbhidctl utility can be used to dump and modify the state of a USB HID (Human Interface Device). Each named item is printed. If the -w flag is specified usbhidctl attempts to set the specified items to the given values. The options are as follows: -a Show all items and their current values if device returns. -f device Specify a path name for the device to operate on. -l Loop and dump the device data every time it changes. -n Suppress printing of the item name. -r Dump the report descriptor. -t table Specify a path name for the HID usage table file. -v Be verbose. -w Change item values. Only 'output' and 'feature' kinds can be set with this option. -x Dump data in hexadecimal as well as decimal. -z Reset reports to zero before processing other arguments. If not specified, current values will be requested from device. SYNTAX
usbhidctl compares the names of items specified on the command line against the human interface items reported by the USB device. Each human interface item is mapped from its native form to a human readable name, using the HID usage table file. Command line items are compared with the generated item names, and the USB HID device is operated on when a match is found. Each human interface item is named by the "page" it appears in, the "usage" within that page, and the list of "collections" containing the item. Each collection in turn is also identified by page, and the usage within that page. On the usbhidctl command line the page name is separated from the usage name with the character ':'. The collections are separated by the character '.'. Some devices give the same name to more than one item. usbhidctl supports isolating each item by appending a '#'. character and a decimal item instance number, starting at zero. FILES
/usr/share/misc/usb_hid_usages The default HID usage table. SEE ALSO
usbhid(3), uhid(4), usb(4) HISTORY
The usbhidctl command appeared in NetBSD 1.4. BSD
August 1, 2011 BSD
Check Out this Related Man Page
USBHIDACTION(1) BSD General Commands Manual USBHIDACTION(1) NAME
usbhidaction -- perform actions according to USB HID controls SYNOPSIS
usbhidaction -c config-file [-d] [-i] -f device [-t table] [-v] [arg ...] DESCRIPTION
usbhidaction can be used to execute commands when certain values appear 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 pro- gram dies; this will make it die when the USB device is unplugged. The options are as follows: -c config-file Specify a path name for the config file. When running as a daemon this needs to be an absolute path for the HUP signal to work. -d Toggle the daemon flag. -i Ignore HID items in the config file that do not exist in the device. -f device 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 device pathname. -t table Specify a path name for the HID usage table file. -v Be verbose, and do not become a daemon. The config file will be re-read if the process gets a HUP signal. CONFIGURATION
The configuration file has a very simple format. Each line describes an action; if a line begins with a whitespace it is considered a con- tinuation of the previous line. Lines beginning with `#' are considered as comments. Each line has three parts: a name of a USB HID item, a value for that item, and an action. There must be whitespace between the parts. The item names are similar to those used by usbhidctl(1), but each part must be prefixed by its page name (use the -v flag to usbhidctl(1) to see the page name). Replace spaces in the item name by underscores. The value is simply a numeric value. When the item reports this value 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 the numeric value of the HID item, `$N' will be replaced by the name of the control, and `$H' will be replaced by the name of the HID device. FILES
/usr/share/misc/usb_hid_usages The HID usage table. EXAMPLES
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 Consumer:Consumer_Control.Consumer:Volume_Up 1 mixerctl -f $1 -n -w outputs.master++ Consumer:Consumer_Control.Consumer:Volume_Down 1 mixerctl -f $1 -n -w outputs.master-- Consumer:Consumer_Control.Consumer:Mute 1 mixerctl -f $1 -n -w outputs.mute++ Consumer:Consumer_Control.Consumer:Channel_Top.Microsoft:Base_Up 1 mixerctl -f $1 -n -w outputs.bass++ Consumer:Consumer_Control.Consumer:Channel_Top.Microsoft:Base_Down 1 mixerctl -f $1 -n -w outputs.bass-- A sample invocation using this configuration would be usbhidaction -f /dev/uhid1 -c conf /dev/mixer1 This configuration file can be used for various keyboards with extra keys: # Configuration for extra keyboard keys Consumer:Consumer_Control.Consumer:Volume_Up 1 mixerctl -n -w outputs.master++ Consumer:Consumer_Control.Consumer:Volume_Down 1 mixerctl -n -w outputs.master-- Consumer:Consumer_Control.Consumer:Mute 1 mixerctl -n -w outputs.mute++ Consumer:Consumer_Control.Consumer:Pause/Play 1 xmms -p Consumer:Consumer_Control.Consumer:Stop 1 xmms -s Consumer:Consumer_Control.Consumer:Scan_Previous_Track 1 xmms -r Consumer:Consumer_Control.Consumer:Scan_Next_Track 1 xmms -f And this configuration can be used with, e.g., usbhidaction -f /dev/uhid0 -c conf -i SEE ALSO
usbhidctl(1), usbhid(3), uhid(4), usb(4) HISTORY
The usbhidaction command first appeared in NetBSD 1.6. BSD
October 20, 2004 BSD