Useful driver settings


Settings that relate to the usability of the driver and may warrant adjustment are as follows (T= Type: D=Device;G=Global)

Settings can be set / viewed using the UPDD Command Line Interface and the UPDD Console,Advanced tab  - under General (for Global) or individual devices.

When using the command line interface to set or get a setting the commands line is different for Global and Device commands:
Global: upddutils nodevice set setting_name value
Device: upddutils device N set setting_name value (N = UPDD device handle as seen in the status dialog, defaults to device 1 if 'device N' not defined)

Setting  T   Value, default Description 
 Gestures  G   The complete set of Gesture settings are shown here
 TUIO Server  G   The complete set of TUIO Server settings are shown here
 Live Annotate  G   The complete set of Annotate settings are shown here
 Multi Monitor / Segments    User defined Multi monitor / segment settings are described here.
 active_touch_interface  D  Text, blank Indicates the system interface in use to post touch data.
 anchor_mouse.enabled
 anchor_mouse.return_time_ms
 anchor_mouse.sample_time_ms
 G  0 or 1, 0
 Numeric:N, 500ms
 Numeric:N, 500ms
AME = returns the system mouse pointer after a touch to the position immediately prior to the touch. AMRT = sets the time lapse after a touch in milli-seconds before the system mouse pointer is returned to its previous location. AMST = sets the time interval in milli-seconds at which the current mouse position is sampled.
 autoconfigure  G  0 or 1, 0 Enables the autoconfigure option.
With the autoconfigure option on (1) the configure function will operate next time any active device is touched:
    1) After installation 
    2) After any change to the geometry or number of monitors 
Configure associates screens with pointer devices and performs a calibration function if needed
The UPDD Daemon process must be running
 calibrate_confirm  G  0 or 1, 0 Confirm button is shown at end of the calibration procedure.
 click_Mode  D  Numeric 0,1,2 - 0 0: Click and drag; the standard behaviour. On touch a mouse down event occurs. At the end of touch a mouse up event occurs.
1: Move then click; The mouse is moved in response to movements of the touch. A click is generated at the end of touch.
2: Point and click; A click is generated at the start of touch. Movement is ignored.
 contact_timeout_secs  D  Numeric If set to a non zero value any contact (touch) longer than the specified number of seconds is cancelled (forced lift) and ignored until the contact ends. Other contacts are unaffected.
Depending on circumstances this can be useful to filter out ghost touches.
It will only be effective where the ghost touches are more or less constant
 edge_adjust_margin  D  Numeric:N, 2 The size in % of a margin around the controlled on screen area (monitor or segment) used by the edge adjust feature.  
In some cases it is difficult or impossible to touch on screen elements at the edges of a touch screen.
Edge adjust is a feature to deal with such cases. It works by "learning" where the touchable extremities lie and treating this as the input edge.
This is especially useful to invoke system features that are associated with edge activation.
Any touch that falls within edge_adjust_margin % of any edge of a touchable area (monitor, desktop or segment) will be adjusted towards the real edge. The degree of adjustment takes account of the outer bounding rectangle of previous touches since the last calibration.
In normal use this makes it possible for a user to touch on screen elements at the edges.
Until an extreme edge has been touched there will be a degree of touch inaccuracy at the edges, this reduces the closer to the edge that the user touches and becomes zero in that case that the edge can be and is touched.
This feature can be disabled by setting edge_adjust_margin = 0.
 enabled  G   0 or 1, 1 If set to 0 touch is disabled for all devices. A default of 1 is implied if this setting is not present. This setting is related to the UPDD Console, General, 'Enabled' entry.
Global disabled takes priority over a Device enabled.
 enabled  D  0 or 1, 1 If set to 0 touch is turned off. A default of 1 is implied if this setting is not present
The device remains connected and active; but data is not delivered to the API or touch interface
Note; to turn off the touch interface only it might be appropriate to set the system interface setting 'active_touch_interface' = "none"
Device disabled takes priority over a Global enabled.
 hid.report_descriptor.crc
 D  Calculated Holds the CRC of the controller HID Report Descriptor.  If this does not match the CRC of the HIDRD of the newly added device with the same vendor and product id the settings deduced from the HIDRD are reestablished from the data held in the HIDRD, such as X and Y range which is used to set the initial calibration data.
To force a reset of data deduced from the HIDRD set this value blank using the command upddutils setall hid.report_descriptor.crc ""
 hide_systemtray_icon  G  0 or 1, 0 Hide the UPDD Daemon system tray icon
 ignore_multi_touch  D  0 or 1, 0 Ignore multi-touch events. This only posts single touch events into the system interfaces. This setting allows the standard HID MT interface to be used but restricted to a single touch, thus disabling MT gestures such as pinch and zoom etc.
 interactive_touch
 Since 6.0.483
 D  [value],immediate
off
immediate
drag
occurs

With interactive_touch 'not off' a long press on a touch device results in a right click
off - no right click processing

immediate - the click right is generated when the time period expires

drag - a right button down event is generated when the time period expires - right button up occurs at the end of the touch

latched - the click right is generated at the end of the touch when the time period has previously expired

See also interactive_touch.visual
Only applicable if the core driver is handling the touch interface. If, for example, under Mac OS UPDD Gestures/Commander is handling touches then gestures need be set for right click processing if required.

For compatibility purposes the pre 483 settings 0 (off), 1 (immediate) are also supported since release 496.

 interactive_touch.time_ms  D  Numeric:N,500 Defines the time in milliseconds that must elapse with a steady press held before the interactive_touch feature generates a right click.
 interactive_touch.visual  D  Numeric:0/1,0

With interactive_touch_visualisation on (1) a circle is drawn on the screen during a long press to indicate the time before a right click is made.

The setting interactive_touch must not be off

The UPDD Daemon process must be running.

 interactive_touch.latched
 obsolete since 6.0.483
 D  Numeric:0/1,0 Modifies the behaviour of the interactive touch function.
Interactive touch must be enabled
With interactive_touch.latched off(0) the right click generated ends immediately, even if still touching.
With interactive_touch.latched on(1) the right click generated ends at the end of touch.
 ignore_tip_switch  D  0 or 1, 0 When enabled any lift off notification from the device is ignored. This can be useful to ignore erroneous liftoff notifications.  If set it is important that liftoff_time_ms is set otherwise the driver will never generate a pen up!
 liftoff_time_ms  D  Numeric:0 Stream mode controllers - touch data is always sent, even when stylus are held stationary: When set to a non-zero value a lift off event will be injected in the case that a touch event is not seen within this threshold (in milliseconds) following a previous touch event.  This is only required for devices that do not generate a pen up event at stylus liftoff as the driver relies on this to register a pen up.
Delta mode controllers - touch data is only sent on touch in, touch off and movement. Data is not sent if the stylus is held stationary: This setting should be set to 0 to prevent pen ups being generated by the driver. However, if a delta mode device did not, for whatever reason, generate a liftoff packet at stylus lift off this would result in a 'stuck' pen down event. If this was the case you could set this to a high value, say 5000 so a pen up event would be generated after 5 seconds of touch inactivity. See also contact_timeout_secs setting.
 monitor_bind.display_name  D   Text,blank Monitor bind name 
 monitor_number D  Numeric:N The monitor number associated with this device instance.
When using the command line interface to set the monitor number you can also use the origin value, e.g. set monitor_number (799,0).
The appropriate monitor number (with this origin) will be substituted.
Origin must be in brackets, no spaces, comma separated and in decimal.
 sample_rate D  Numeric:0 Specifies the percentage of position report packets that are passed to the OS and the UPDD API.
Note that the algorithm works on blocks of 10 packets; so for example a setting of 20 means that 2 of every 10 packets are processed.
Consequently only multiples of 10 are useful, for other values, the value is rounded down to  the next multiple of 10.
 startup.disable_touch_until
 (since 6.0.629)
 Client
 Numeric
 Any other

At driver start, indicates when the the global enabled setting is set (it has an implied default of 1. i.e.if not set the software acts as though it is 1)
'client' the "enabled" setting is set to true when the first client connection is made (e.g. when UPDD daemon starts)

A 'numeric value' the "enabled" setting is set to true after the defined number of seconds has elapsed.

Any 'other value' the "enabled" setting is set to false preventing any touches. In this case "enabled" must be set by some external means, such as 'upddutils nodevice enabled 1'

 synthesize.delta_mode D  0 or 1, 0 If set to on (1) a device will work in synthesized delta mode. Only touch packets that represent movement or a change in a contact state are delivered to the operating system and the UPDD API.
 touchdown_filter  Numeric:0 Some old touchscreens will generate a pen down packet and then take a few touch packets to zero in on the correct X and Y co-ordinates which can have negative results. This setting can be used to 'ignore' the first 'n' touch co-ordinated packets.

If set to zero touch is turned off. A default of 1 is implied if this setting is not present

The device remains connected and active; but data is not delivered to the API or touch interface

Note; to turn off the touch interface only it might be appropriate to set the system interface setting 'active_touch_interface' = "none"

If set to zero touch is turned off. A default of 1 is implied if this setting is not present

The device remains connected and active; but data is not delivered to the API or touch interface

Note; to turn off the touch interface only it might be appropriate to set the system interface setting 'active_touch_interface' = "none"

If set to zero touch is turned off. A default of 1 is implied if this setting is not present

The device remains connected and active; but data is not delivered to the API or touch interface

Note; to turn off the touch interface only it might be appropriate to set the system interface setting 'active_touch_interface' = "none"

If set to zero touch is turned off. A default of 1 is implied if this setting is not present

The device remains connected and active; but data is not delivered to the API or touch interface

Note; to turn off the touch interface only it might be appropriate to set the system interface setting 'active_touch_interface' = "none"

Search