Table of Contents

Name

ipm - Numonics IPM Whiteboard input driver

Synopsis


Section "InputDevice"
  Identifier "idevname"
  Driver "ipm"
  Option "Device"   "devpath"
  ...
EndSection

Description

ipm is an XFree86 input driver for Numonics IPM devices.

The ipm driver functions as a pointer input device, and may be used as the X server's core pointer.

Supported Hardware

This driver supports the following Numonics IPM whiteboards.
IPM 1000RM , IPM 2000RM

Calibration

The driver is able to autodetect the dimension of the board, but it is recommanded to calibrate the driver using the ipmcali(1) tool available from the Numonics IPM Package at http://www.roqe.org/xiipm. Calibration allows the pointer to optimally move onto the projected screen on the board. By default the tool ipmcali(1) will send the calibration to this driver using a calibration file.

If autodetections and calibration fails, you can manually specify the board's dimension by using either the options Width and Height or the calibration options TopLeftX, TopLeftY, TopRightX, TopRightY, BottomLeftX, BottomLeftY, BottomRightX and BottomRightY.

Configuration Details

Please refer to XF86Config(__filemansuffix__) for general configuration details and for options that can be used with all input drivers. This section only covers configuration details specific to this driver.

Option "Device" "path"
sets the path to the special file which represents serial line where the board is plugged.
Option "Mode" "Relative"|"Absolute"
sets the mode of the device.
Option "HistorySize" "number"
sets the motion history size. By default the value is zero.
Option "MotionThreshold" "number"
sets the motion threshold. By default the value is zero. By adjusting this value, you can finetune the pointer movement.
Option "Screen" "number"
sets the screen the pointer will work on.
Option "Width" "number"
sets the width of the electronic board in pixels.
Option "Height" "number"
sets the height of the electronics board in pixels.
Option "CalibrationFile" "path"
The tool ipmcali(1) will create a calibration file that this module will try to read. If the file could be read and the input successfully parsed the board will be calibrated on the fly. By default ipmcali(1) uses the file "/tmp/.ipm-calibration". If you change this option, also change the path when using ipmcali(1) .
Option "TopLeftX" "number"
X coordinate of the top left corner of the active zone.
Option "TopLeftY" "number"
Y coordinate of the top left corner of the active zone.
Option "TopRightX" "number"
X coordinate of the top right corner of the active zone.
Option "TopRightY" "number"
Y coordinate of the top right corner of the active zone.
Option "BottomLeftX" "number"
X coordinate of the bottom left corner of the active zone.
Option "BottomLeftY" "number"
Y coordinate of the bottom left corner of the active zone.
Option "BottomRightX" "number"
X coordinate of the bottom right of the active zone.
Option "BottomRightY" "number"
Y coordinate of the bottom right of the active zone.
Option "DebugLevel" "number"
sets the level of debugging info reported.
Option "KillBlackHoles" "On"|"Off"
A hardware defect called "Black Holes" may occur in the Numonics IPM boards. While moving the pointer straight thoughts the fixed positions of the defect, the pointer will jump about a few pixels and return a little bit later. This feature tries to minimize the effect of this hardware bug.
Option "BlackHoleRange" "number"
sets the range of the jump performed by the "Black Hole" hardware defect. While writing the driver jumps around 2000 have been discovered by the author on one Numonics IPM board.
Option "BlackHoleTolerance" "number"
depending on the speed of pointer movement the "Black Hole" jumps may differ in range. A tolerance of 300 has given good results on boards with the "Black Hole" hardware defect.

Bugs

The auto-detection has not been implemented into this driver and therefore a manual configuration using either the options Width and Heigth or the calibration options TopLeftX, TopLeftY, etc. is required. The calibration utility ipmcali(1) helps getting the correct coordinates.

Please note, the "Black Hole" bug is not part of this driver, but instead a hardware problem, that has been discovered by the author on one Numonics IPM board. This driver contains a feature to minimize the effect of this bug.

See Also

XFree86(1) , XF86Config(__filemansuffix__), xf86config(1) , Xserver(1) , X(__miscmansuffix__), ipmdump(1) , ipmcali(1) , ipmpanel(1) .

Authors

Konrad Rieck <kr@roqe.org>


Table of Contents