1UR98(4) Kernel Interfaces Manual UR98(4)
2
3
4
6 UR-98 - UR98 (TR88L803) head tracker driver
7
9 Section "InputDevice"
10 Identifier "idevname"
11 Driver "UR-98"
12 Option "Device" "devpath"
13 ...
14 EndSection
15
17 UR-98 is an Xorg input driver for the Union Reality UR-F98 headtracker.
18
19 The UR-98 driver functions as a pointer input device, and can be used
20 either as an additional input device or as the X server's core pointer.
21 The driver provides support for the three axes, throttle and four but‐
22 tons of the controller. If mapped as the core pointer the headtracker
23 provides headtracking to try and place the mouse cursor where you look.
24 As a secondary input device the unit can be used for gaming, for exam‐
25 ple to provide the look up/down and the turn in quake, and with the Z
26 axis bound to ack/forward to provide movement control.
27
28 The default mapping maps left-right movement to X, up-down movement to
29 Y and near/far movement to the Z axis. The throttle is mapped as the
30 fourth axis by default but can also be mapped as button 5.
31
32 For use in "head only" mode the Z axis can be mapped as a button. This
33 allows the user to select objects with head/neck movement alone but
34 takes some practice to use well.
35
37 Union Reality UR-98. While this is a joystick driver the behaviour is
38 absolute so this driver is not useful for true joystick interfaces.
39
41 Please refer to xorg.conf(5x) for general configuration details and for
42 options that can be used with all input drivers. This section only
43 covers configuration details specific to this driver.
44
45 The following driver options are supported
46
47 Option "MinX" "integer"
48 Set the left hand X value from the headgear, for calibration.
49
50 Option "MaxX" "integer"
51 Set the right hand X value from the headgear, for calibration.
52
53 Option "MinY" "integer"
54 Set the top Y value from the headgear, for calibration.
55
56 Option "MaxY" "integer"
57 Set the bottom Y value from the headgear, for calibration.
58
59 Option "MinZ" "integer"
60 Set the nearest Z value from the headgear, for calibration.
61
62 Option "MaxZ" "integer"
63 Set the furthest Z value from the headgear, for calibration.
64
65 Option "MinT" "integer"
66 Set the low throttle value from the headgear, for calibration.
67
68 Option "MaxT" "integer"
69 Set the high throttle value from the headgear, for calibration.
70
71 Option "Screen" "integer"
72 The screen to attach to the headgear when running with multiple
73 screens. The default is screen 0.
74
75 Option "Device" "string"
76 The joystick port that is attached to the headgear interface.
77 This is usually /dev/input/js0. The digital port is not sup‐
78 ported due to lack of documentation.
79
80 Option "DeviceName" "string"
81 Set the X11 device name for the headgear. This defaults to HEAD.
82
83 Option "PortraitMode" "string"
84 Set the display orientation. The default is "landscape" but you
85 can rotate the screen clockwise ("portrait") or anticlockwise
86 ("portraitCCW").
87
88 Option "SwapXY" "boolean"
89 Swap the X and Y values on the display. The default is false.
90
91 Option "Button5" "boolean"
92 Map the throttle as a button instead of axis 4. For some gaming
93 applications this can be more useful. The default is to map the
94 throttle as axis 4.
95
96 Option "HeadButton" "boolean"
97 Map the Z axis as button 1. This defaults to false.
98
99 Option "HeadThresh" "boolean"
100 Set the distance that is held to be mouse down.
101
102 Option "HeadLock" "boolean"
103 Set the range of depth around the mouse down point where mouse x
104 and y movement is locked out. Set to zero to disable.
105
107 The "HeadButton" option is currently not implemented.
108
109 The hardware or kernel driver has some idiosyncracies. Notably on ker‐
110 nel initialization the interface occasionally gets into a state where
111 the readings rapidly cycle left-right-left-right or top-bottom-top-bot‐
112 tom. In those cases it seems to be necessary to unload the driver,
113 unplug, replug and reload the joystick drivers. Once it initializes
114 sanely it remains sane.
115
116 If the device refuses to work check the gray/black cables are plugged
117 into the right ports on the unit. Be careful about this as crossing the
118 cables can lead to the device failing with a nasty burning electronics
119 smell. The author writes from direct experience.
120
121 This driver is currently Linux specific.
122
124 Xorg(1x), xorg.conf(5x), xorgconfig(1x), Xserver(1x), X(7).
125
127 Authors include...
128 Alan Cox
129
130
131
132X Version 11 xf86-input-ur98 1.1.0 UR98(4)