1.\" $FreeBSD$ 2.\" $NetBSD: usbhidaction.1,v 1.8 2003/02/25 10:35:59 wiz Exp $ 3.\" 4.\" Copyright (c) 2000 The NetBSD Foundation, Inc. 5.\" All rights reserved. 6.\" 7.\" This code is derived from software contributed to The NetBSD Foundation 8.\" by Lennart Augustsson (lennart@augustsson.net). 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 19.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29.\" POSSIBILITY OF SUCH DAMAGE. 30.\" 31.Dd October 28, 2020 32.Dt USBHIDACTION 1 33.Os 34.Sh NAME 35.Nm usbhidaction 36.Nd perform actions according to USB HID controls 37.Sh SYNOPSIS 38.Nm 39.Op Fl diev 40.Fl c Ar config-file 41.Fl f Ar device 42.Op Fl p Ar pidfile 43.Op Fl t Ar tablefile 44.Ar arg ... 45.Sh DESCRIPTION 46The 47.Nm 48utility 49can be used to execute commands when certain values appear on HID controls. 50The normal operation for this program is to read the configuration file 51and then become a daemon and execute commands as the HID items specify. 52If a read from the HID device fails, the program dies; this will make it 53die when the USB device is unplugged. 54.Pp 55The options are as follows: 56.Bl -tag -width indent 57.It Fl d 58Toggle the daemon flag. 59.It Fl e 60Instruct 61.Nm 62to die early. 63Useful when specified with multiple verbose options to see how files are parsed. 64.It Fl i 65Ignore HID items in the configuration file that do not exist in the device. 66.It Fl v 67Be verbose, and do not become a daemon. 68.It Fl c Ar config-file 69Specify a path name for the configuration file. 70.It Fl t Ar tablefile 71Specify a path name for the HID usage table file. 72.It Fl f Ar device 73Specify a path name for the device to operate on. 74If 75.Ar device 76is numeric, it is taken to be the USB HID device number. 77If it is a relative 78path, it is taken to be the name of the device under 79.Pa /dev . 80An absolute path is taken to be the literal device pathname. 81.It Fl p Ar pidfile 82Specify an alternate file in which to store the process ID. 83.El 84.Pp 85The configuration file will be re-read if the process gets a 86.Dv SIGHUP 87signal. 88.Sh CONFIGURATION 89The configuration file has a very simple format. 90Each line describes an 91action; if a line begins with a whitespace, it is considered a continuation 92of the previous line. 93Lines beginning with 94.Ql # 95are considered as comments. 96.Pp 97Each line has four parts: a name of a USB HID item, a value for that item, 98a debounce value, and an action. 99There must be whitespace between the parts. 100.Pp 101The item names are similar to those used by 102.Xr usbhidctl 1 . 103.Pp 104The value is simply a numeric value. 105When the item reports this value, 106the action will be performed. 107If the value is 108.Ql * , 109it will match any value. 110.Pp 111The debounce value is an integer not less than 0. 112The value of 0 indicates that no debouncing should occur. 113A value of 1 will only execute the action when the state changes. 114Values greater than one specify that an action should be performed 115only when the value changes by that amount. 116.Pp 117The action is a normal command that is executed with 118.Xr system 3 . 119Before it is executed some substitution will occur: 120.Ql $n 121will be replaced by the 122.Ar n Ns th 123argument on the command line, 124.Ql $V 125will be replaced by the numeric value of the HID item, 126.Ql $N 127will be replaced by the name of the control, and 128.Ql $H 129will be replaced by the name of the HID device. 130.Sh FILES 131.Bl -tag -width ".Pa /usr/share/misc/usb_hid_usages" 132.It Pa /usr/share/misc/usb_hid_usages 133The HID usage table. 134.It Pa /var/run/usbaction.pid 135The default location of the PID file. 136.El 137.Sh EXAMPLES 138The following configuration file can be used to control a pair 139of Philips USB speakers with the HID controls on the speakers. 140.Bd -literal -offset indent 141# Configuration for various Philips USB speakers 142Consumer:Volume_Increment 1 0 mixer -f $1 vol +1 143Consumer:Volume_Decrement 1 0 mixer -f $1 vol -1 144# mute not supported 145#Consumer:Mute 1 0 mixer -f $1 mute 146Consumer:Channel_Top.Microsoft:Base_Up 1 0 mixer -f $1 bass +1 147Consumer:Channel_Top.Microsoft:Base_Down 1 0 mixer -f $1 bass -1 148.Ed 149.Pp 150A sample invocation using this configuration would be 151.Pp 152.Dl "usbhidaction -f /dev/uhid1 -c conf /dev/mixer1" 153.Pp 154The following example controls the mixer volume using a Logitech Wingman. 155Notice the debounce of 1 for buttons and 5 for the slider. 156.Bd -literal -offset indent 157Button:Button_1 1 1 mixer vol +10 158Button:Button_2 1 1 mixer vol -10 159Generic_Desktop:Z * 5 mixer vol `echo $V | awk '{print int($$1/255*100)}'` 160.Ed 161.Sh SEE ALSO 162.Xr usbhidctl 1 , 163.Xr usbhid 3 , 164.Xr uhid 4 , 165.Xr usb 4 166.Sh HISTORY 167The 168.Nm 169command first appeared in 170.Nx 1.6 . 171The 172.Nm 173command appeared in 174.Fx 5.1 . 175