1jscal(1)                    General Commands Manual                   jscal(1)
2
3
4

NAME

6       jscal - joystick calibration and remapping program
7

SYNOPSIS

9       jscal [options] <device‐name>
10

DESCRIPTION

12       jscal  calibrates  joysticks and maps joystick axes and buttons.  Cali‐
13       brating a joystick ensures the positions on the various axes  are  cor‐
14       rectly  interpreted.   Mapping  axes and buttons allows the meanings of
15       the joystick's axes and buttons to be redefined.
16
17       On Debian systems the calibration settings  can  be  stored  and  later
18       applied automatically using the jscal-store command.
19

OPTIONS

21       -c, --calibrate
22              Calibrate the joystick.
23
24       -h, --help
25              Print out a summary of available options.
26
27       -s, --set-correction <nb_axes,type,precision,coefficients,...>
28              Sets correction to specified values.  For each axis, specify the
29              correction type (0 for none, 1 for "broken  line"),  the  preci‐
30              sion,  and  if  necessary  the  correction coefficients ("broken
31              line" corrections take four coefficients).
32
33       -u,  --set-mappings  <nb_axes,axmap1,axmap2,...,nb_buttons,btnmap1,btn‐
34       map2,...>
35              Sets  axis and button mappings.  n_of_buttons can be set to 0 to
36              remap axes only.
37
38       -t, --test-center
39              Tests if the joystick is correctly calibrated.  Returns 2 if the
40              axes  are  not calibrated, 3 if buttons were pressed, 1 if there
41              was any other error, and 0 on success.
42
43       -V, --version
44              Prints the version numbers of the running  joystick  driver  and
45              that which jscal was compiled for.
46
47       -p, --print-correction
48              Prints  the current correction settings.  The format of the out‐
49              put is a jscal command line.
50
51       -q, --print-mappings
52              Prints the current axis and button mappings.  The format of  the
53              output is a jscal command line.
54

CALIBRATION

56       Using  the Linux input system, joysticks are expected to produce values
57       between -32767 and 32767 for axes, with 0 meaning the joystick is  cen‐
58       tred.   Thus, full‐left should produce -32767 on the X axis, full‐right
59       32767 on the X axis, full‐forward -32767 on the Y axis, and so on.
60
61       Many joysticks and gamepads (especially older ones) are  slightly  mis‐
62       aligned; as a result they may not use the full range of values (for the
63       extremes of the axes), or more annoyingly they may not give 0 when cen‐
64       tred.  Calibrating a joystick provides the kernel with information on a
65       joystick's real behaviour, which allows the kernel to  correct  various
66       joysticks'  deficiencies  and  produce consistent output as far as joy‐
67       stick‐using software is concerned.
68
69       jstest(1) is useful to determine whether a joystick is calibrated: when
70       run,  it  should  produce all 0s when the joystick is at rest, and each
71       axis should be able to produce the values  -32767  and  32767.   Analog
72       joysticks should produce values in between 0 and the extremes, but this
73       is not necessary; digital directional pads  work  fine  with  only  the
74       three values.
75

SEE ALSO

77       ffset(1), jstest(1), jscal-store(1).
78

AUTHORS

80       jscal  was  written  by Vojtech Pavlik and improved by many others; see
81       the linuxconsole tools documentation for details.
82
83       This manual page was written by Stephen Kitt <steve@sk2.org>,  for  the
84       Debian GNU/Linux system (but may be used by others).
85
86
87
88jscal                            Jul 11, 2010                         jscal(1)