UPDD Setting definitions              Revision 1.6 – 28th Dec 2012
www.touch-base.com\documentation\API

 

Kernel mode

User mode

Settings file

 

Contact

Kernel Mode driver registry settings

These registry settings relate to the Windows kernel mode driver, called TBUPDDSU.

Registry branch: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\tbupddsu\

Only settings that directly affect the functionality of the kernel mode driver are documented:

NoForwardPower

Set to 1 indicates the driver does not pass on IRP requests

DebugLevel

When set to 5 driver debug messages are directed to a system kernel debugger (if one is active)

Updd\parameters\0

Holds the registry settings needed to allow for basic touch functionality in situations where the start of the user mode driver is delayed, such as in sysprep envirionments.  These are created by the command line TBcalib kernel

User Mode driver registry settings

These registry settings relate to the Windows user mode driver, called TBUPDDWU.

Registry branch: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\tbupddwu\

Only settings that directly affect the functionality of the user mode driver are documented:

Home

UPDD application folder

Settings file

The settings file, tbupdd.ini, is the main location of the UPDD driver’s settings.

Operating system

Location

Windows

 

UPDD Application folder

(e.g. c:\program files\UPDD)

 

Linux

/opt/tbupddlx

Mac OS X

4.1.10 - /tbupddmx

5.0.2 - /Library/Preferences

Solaris

/opt/tbupddso

CE

\Windows

The settings file has been used by UPDD since version 4.0.x and reflects all the settings used since the initial development of this version.  At the time of writing UPDD is on version 4.1.8 and inevitably some of the settings in the file are redundant or obscure and do not warrant documenting.

It is important to note that some settings may be closely related to others or made redundant due to other settings changes. E.g. a touch device once having 9 calibration points but now changed to use 4 point calibration will still retain 9 calibration points in the settings file but 5 of these settings will not be used.

Setting definitions

The section describes the most useful settings that are likely to be referenced outside the UPDD Console.  Those in the settings file not listed here are either redundant, internal use only or are obscure!

Setting

Description

General system and configuration specific settings

[UPDD]

AutoRunTBAlt

Indicated that the on-screen Event Selector is loaded automatically on system startup.

DebugLevel

Controls debug feature. Set to 5 to generate driver debug info to a system debugger (in Windows) or STDOUT in Linux or Mac OS X (such as used by general console programs).

InitialMousePortEnabled

Indicates if the driver is active once loaded. True by default this can be set to false so that the driver is inactive at load time until activated by an application.

Installing Bundle

Bundle GUID Used during installation – the bundle currently being installed.

KickStartDelay

KickStartDwell

KickStartDelta

Specifies the values used by the kick start process when accessing the hardware port after system restart.  Introduced to overcome a problem with a specific system which was correctly addressed with another fix.  Left in as useful function should similar problem occur.

MouseSpeed

An acceleration factor applied to relative mouse movement.

PnP

Plug and Play enabled indicator.

PnPtag

 

Primary Monitor Height

Vertical resolution of primary monitor, e.g. 480

Primary Monitor Left

Leftmost position on primary monitor

Primary Monitor Top

Topmost position on primary monitor

Primary Monitor Width

Horizontal resolution of primary monitor, e.g. 640

PS2Support

PS/2 interface supported by this device

Rotate

Defines desktop rotation angle Obsolete in version 3.x (rotation angle now held in memory in the driver).

Tick Trace

Set to non zero value to cause driver to generate debug message at kernel debugger every 100 heartbeats – used to test system timer interval.

W9x Full Screen DOS Support

Enable UPDD’s 9x/ME DOS Full Screen support.

W9x Mouse Discard Interval ***

If the "W9x Mouse Queue Limit" threshold is exceeded the driver discards 1 in every "W9x Mouse Discard Interval" non-critical mouse events, until the queue size is within limits.

W9x Mouse Priority Yield Time ***

The number of millisecond pause during the VM priority event.

W9x Mouse Queue Limit ***

The maximum size of the mouse event ring buffer.

General driver settings

[UPDD\parameters]

When using the API to get or set these settings a Device Handle = 0 refers to this section.

When using tbutils utility to change these settings use  ‘device selector’ = nodevice

Anchor Liftoff

If set the driver will return the mouse to the anchor position (the last point the physical mouse was moved to) n heartbeats after a liftoff.

Anchor Poll

Determine how often the UPDD daemon process polls the mouse location when not touching.

Announce

Obsolete

AutoSelect

Indicates that only 1 device is attached but multiple controllers are defined – the driver will select the controller which responds correctly to a macro.

BuildLevel

Driver build level, e.g. Beta

Bundle Handle

Relative bundle number (first installed = 1 etc).

ButtonModeNN

Defines the full list of available button modes (mouse click actions), e.g. ‘Touchdown Left:2,4,2,4,2,4,L,Y’

Calibration Beeps

Indicates if a calibration point has been accepted by sounding the system speaker

Calibration Program

Defines the executable name of the calibration program, e.g. Tbcalib.exe

Check Calibration

Controls the display of the ‘Check Calibration’ dialog following calibration

Company

Company name

Control Panel Program

Name of UPDD program dialog processor, e.g. Tbmorph.exe

Controller Id

Id from list of available controllers in this build.

Customisation

Instructs various modules to perform custom processing – and defines which “extra” configuration files to copy to a release package.

DfltDevName

‘Device name’ legend for DCU display.

DfltDoubleClickHeight

Default vertical pixels within which Windows recognizes double clicks

DfltDoubleClickSpeed

Default double click speed period

DfltDoubleClickWidth

Default horizontal pixels within which Windows recognizes double clicks

DfltFolder

Default location of UPDD files

DfltGroup

Default Group name for UPDD on Windows Start Menu

DriverDate

Driver build date

Eepromreadsilent

If set suppresses the eeprom read dialog issued by tbcalib.

ExtInSvc

Extensions on nt / 2k / xp are run in a system service (rather than tbsystry) if this option is selected.

First Touch Calibration

If true then the next time the system tray process loads the next touch will invoke calibration

Globalport

UPDD utilizes tcp/ip for inter-process communication. The driver requires access to TCP IP port 4141 for internal computer processing only. Starting with version 4.1.10 this port can be bound either to the local loopback address only (default), or all addresses. Binding to all addresses is enabled by this setting being set to 1 and is only required when specialist updd i/p features are to be used.

Hardware calibration

Used internally when handling EEprom calibration.

History File

Filename containing driver revision history notes

InfName

INF filename (contains all the necessary information about the device(s) and file(s) to be installed, such as driver images, registry information, version information etc.

Install In Progress

Set if UPDD installation is currently underway correct

Installing

Used during installation

InteractiveTouchRadius

Specifies the visual feedback drawing radius when using Interactive Touch mouse click emulation.

Keycode

Holds the activation code for drivers that need to be activated from evaluation to production.

Kickstart

Indicates if kick start processing delays are enabled.

Language

Language mnemonic, e.g. ‘EN’ or “ENU”

Number Of Button Modes

Number of supported button modes

Number Of Controllers

Number of controllers available within this bundle

Number of Devices

Number of configured devices including deleted devices.

OEMName

OEM Name

OEMresName

OEM Resource name

One Hit Mode

Used by Event Selector. Indicates if secondary event (normally set to right click) returns to primary event (normally set to left click) after one occurrence.

Packet Queue Size

Default buffer size to accommodate incoming packets, e.g. 512

Packet Queue Size Max

Maximum buffer size for incoming packets, e.g. 1024

Pen20

MS Pen 2.0  support is enabled

penservicesavailable

Indicates if pen services are available in Win 7 (needed for UPDD extended touch to work)

PortraitAngle

Defines the angle used on the UPDD Rotate API call performed by the UPDD daemon process when the desktop is rotated from landscape 0° to portrait (90° or 270°)

QMFolder

Path of .qm language files if moved from the UPDD folder. Used by TBCalib to locate language files.

Raw Trace Buffer Length

Sets the size of a trace buffer. Raw controller data is written to this buffer and dumped to the kernel debugger when the DCU reset option is pressed.

Release

The software release number

Rotate

Defines desktop rotation angle. Obsolete in Version 3.x.

SCN

Support Contract Number

security.enabled

Touch security enabled

security.number.programs

Number of programs to monitor

security.program.<n>

Individual program path

security.poll.secs

Interval to check program process

security.block

Indicates if touch to be blocked

Show Hidden Devices

Indicates if ‘inactive’ devices, such as an unplugged USB device, are to be listed in the DCU, Devices list.

Show Systray

Show UPDD menu item in System tray.

ShowDualTouch

Enables the Zytronic Dual Touch checkbox in the UPDD Console, Hardware, Firmware dialog if disabled.

ShowExtendedTouch

Enables the Extended Touch checkbox in the UPDD Console, Click Mode dialog if disabled in Vista / Win 7.  It is not shown under XP.

Silent

Obsolete

Support

Driver support details

Suppress NT Conflict

Instructs NT4 driver to suppress a conflict message in the error log (caused by a bug in Windows serial.sys).

SWEval

Indicates if driver has reverted to evaluation mode.

SWExpires

Date production mode expires unless Key Code entered.

SWKey

Licensing control code

Test Program

Program filename of UPDD test program, e.g. ‘Tbtest.exe’

Timer Interval

The assumed heartbeat interval in ms.

TUIO xxxx

UPDD TUIO Server settings

UPDD Folder

UPDD folder location as used, e.g. ‘C:\Program Files\UPDD’

UPDD Group

UPDD group name as used, e.g. ‘UPDD’

UPDDClicksUninstalled

Not a core UPDD setting

UseLinearisation

OEM specific, controls linearisation.

W2Ksigned

Reserved for future use.

Touch controller specific settings. One for each configured device

[UPDD\parameter\N]

When using the API to get or set these settings a Device Handle = N refers to this section.

When using tbutils utility to change these settings set the  ‘device selector’ as appropriate

2SComplement

Indicates that controller data is encoded using twos complement format.

ActualDriver

Port value as displayed in the DCU, Devices, Port column

Ad Hoc Settings

Device-specific configuration parameters retrieved from the driver

Address

Com port address, e.g. 3F8h (COM1)

Address To

Maximum COM port address, e.g. 3FFh

ADInterval

OEM specific analog digital sampling interval

ADSettle

OEM specific analog digital settling time

Anchor Mouse

Indicates whether the mouse cursor is to return to it’s original position after the pointer device has been used

Auto Detect

Set if controller is to be auto-detected

Averaging

The most recent N packets are averaged

Averaging Zone

If position moves > N raw points the averaging algorithm is reset

Baud

Baud rate, e.g. 9600

Buttondowntime

When the driver requests Windows to move the system pointer and generate a click the sequence of Windows messages will be:

WM_MOUSEMOVE

WM_LBUTTONDOWN

WM_LBUTTONUP

The move and down messages are generated at the same time. However, a user had written an application that was triggered on Mouse Move but did not function correctly unless there was a delay between the move message and the button down message.  This setting defines any delay needed at that point.

Calibration Background

If 0 calibration background is transparent.

Calibration Changed

Used internally by calibration routine.

Calibration Event

The event mnemonic that UPDD recognizes for registering a calibration event, e.g. ‘DFLT’

Calibration Points

The number of calibration points required, in the range 2-25

Calibration Rotation

The rotation angle that was active when the active calibration was performed.

Calibration Start Pct

Indicates if the outside calibration points are to be at the edge (0%) or 12% or 20% in from the corners/edges

Calibration Style

Names the style (in the Calibration Styles sub-tree) that will be used for the next calibration. Will usually be “normal”.

Calibration Styles

Now obsolete

Calibration Timeout

Calibration timeout period (in seconds), e.g. ‘10’

CalXn

Co-ordinate for each calibration X-axis calibration point where ‘n’ is within the range 0-24 for each configured calibration point

CalYn

Co-ordinate for each calibration Y-axis calibration point where ‘n’ is within the range 0-24 for each configured calibration point

Check Port

Test the hardware at this interval to see if still working – only used in direct serial mode, so not generally applicable.

ClickTime

Defines (in units of 20ms) short time interval used by the driver button click logic

Controller Id

Id of this controller

Controller Type

Controller description

DataBits

Number of data bits for serial data communication

DataQueueSize

Initial size of internal data buffers

Deglitch Length

Number of consecutive packets before a large movement is considered “not a glitch”

Deglitch

Used to filter out glitches or ‘spikes’

Delta Filter

1 enables a special jitter filter.

Device Name

As displayed for this device in the DCU

Direct Hardware Access

0 = access serial port via Windows serial driver, 1 = access UART directly. Usually off.

DoubleClickTime

Time period between clicks for registering a double-click

Eepromreadstatus

Last eeprom read result (0 = fail, 1 = success)

Eepromwritestatus

Last eeprom write result (0 = fail, 1 = success)

Enabled

Indicates if the device is enabled or disabled.

EnumeratedDriver

For PnP devices the associated Windows driver instance

EnumeratedIProduct

USB internal identifier if driver bound to iProduct

EnumeratedSerial#

USB internal identifier if driver bound to USB serial number

Event Alt Mode 0 – n

Name of a button mode that is triggered when the bound event occurs and the event selector is set to activate secondary (alternate) mode. Alternate mode is typically used to switch the default action from left to right click.

Event Alt Bind 0 - n

A named protocol level event that causes the event to change its state – and thereby cause an action in the button mode manager. This might be an event explicitly defined in the protocol (e.g. L/R/EV00) or an implied (e.g. DFLT means set when data stream starts, unset at end of stream).

Event Bind 0 - n

See Event Alt Bind

Event Mode 0

Mode associated with this event, e.g. ‘Touchdown Immediate Left’

Event Mode 1

Button mode associated with this event, e.g. ‘None’

Event Name 0

Name of this event, e.g. ‘DFLT’ etc.

Event Name 1

Name of this event, e.g. ‘Z’ etc.

Event Port Offset 0 - n

An event can also be triggered by an external hardware signal. This specifies the port offset. E.g. to tie an event to the serial DSR line the bound event above would be HW32 and this offset value 6. This means monitor  (base i/o address + 6) & 0x20 – the DSR bit.

FFintensity

FFMode

Flash Flood settings if using Light Pens

FIFO

Enables the buffered mode of operation for UART serial devices

Firmware

Obsolete

First Touch Calibration

If true then the next time the system tray process loads the next touch will invoke calibration

Hardware Calibration

Used internally when handling EEprom calibration.

Has Logconf

Indicates that the device is a legacy (non PnP) device with it’s resources defined in the INF file’s LOGCONF section.

Horizontal Edge Gain

Some devices cannot be touched at the extreme edge. An acceleration mechanism can be defined to allow the mouse to be moved to the edge of the physical screen. Horizontal Edge Gain defines the acceleration rate.

Horizontal Edge Width

Some devices cannot be touched at the extreme edge. An acceleration mechanism can be defined to allow the mouse to be moved to the edge of the physical screen. Horizontal Edge Width defines the size of the accelerated margin.

Init Before Int Enable

For most controllers we enable interrupts before we send any nitialization sequence.

Init Hardware

Init Software

EEprom calibration mode settings

Initialise

If set, indicates that an initialization macro (if it exists) is to be executed

Interlock Mode

In a multi pointer device environment this setting indicates the priority given to the device. See UPDD Help File for more information.

Interlock Release Time

In a multi pointer device environment this setting indicates amount of time that must have lapsed since last usage of another pointer device before this device can be used. See UPDD Help File for more information

Interrupt

Denotes the IRQ used.

InvertX

If set, indicates that the pointer device is inverted on the X axis

InvertY

If set, indicates that the pointer device is inverted on the Y axis

IProductBinding

USB devices can be identified by their iProduct code. If this flag is set the UPDD will search for a USB device with this product id and bind the UPDD connection to it.

IRQSharing

If set IRQ sharing is enabled

Jitterrange

The value used by UPDD to calculate a stationary stylus, such as in Interactive Touch click mode. Default 1000 dec.

LiftOffTime

In units of 20ms this indicates the time interval required to register a stylus lift-off

LightPenCalibration

Enables a light pen calibration mode whereby a series of lines are drawn on the calibration screen and the pen scanned over these lines.

Logical Desktop Segment

Description of device coverage, e.g ‘Whole Desktop’, ‘Left Half’, ‘Right Half’ etc.

Logically Deleted

If set, this device has been removed, i.e. deconfigured.

Low Pass Filter Gain

A filter used to improve drawing on jittery devices.

Macro Bus 0 – n

An ISA bus interface macro or preprocessor macro, one entry per line.

Macro Bus Lines

Number of lines above

Min Cal Delta

Number of co-ordinates that must differ between calibration points for the next point to be accepted.

Monitor Height

Vertical measurement of monitor area for this device

Monitor Left

Co-ordinate for left-most edge of device

MonitorNumberForSegment

Explicitly defines a monitor number to be used in conjunction with a desktop segment (i.e. Left Half). If not specified defaults to monitor 1.

Monitor Top

Co-ordinate for top-most edge of device

Monitor Width

Horizontal measurement of monitor area for this device

Motion

If set UPDD supports dragging, otherwise the mouse remains at the point of the last touch.

Notes

Device specific notes

Number Of Calibration Styles

Number of calibration styles defined within the DCU

Number Of Events

Number of handled events

Number Of Macros

Number of macros defined within the DCU

Number Of Packet Definitions

Number of packet definitions for this device

Number Of Toolbars

Number of toolbars defined for this device

Packet Comment 0

Packet descriptor, e.g. ‘Main touch packet that generates X and Y data’

Packet Definition 0-n A

Packet layout details

Packet Definition 0-n B

Packet layout details

Packet Definition 0-n

Packet layout details

Packet Enabled 0-n

Set if packet enabled

Packet Name 0-n

Packet name, e.g. ‘Touch’

Packets Per Second

The peak rate at which UPDD has seen packets from the controller

Parity

0 = None, 1 = Odd, 2 = Even

PNP Bus

Obsolete

PNP ID

Plug and Play ID for the device

Port

Com port used for serial devices, e.g.’COM1’

PortType

Port type, i.e.PS2, Serial, Bus, USB

Product Id

USB product id to identify device

Raw Data Mode Block Size

UPDD can be switch into “raw data mode”. In this mode the raw data stream from the controller is delivered to the API. This setting sets the minimum delivery block size

Raw Data Mode

Enables “raw data mode”

Recogniser Rate

Defines the sample rate for handwriting recognition.

RefX0-n

Calibration reference points, define the placement of the points using a 65535 x 0-65535 co-ordinate range based at top left.

RefY0-n

As above

Reset

A control code which if received from the controller causes UPDD to reinitialize e.g. BYTE-FF indicates a reset when 0xff is seen in the data stream

RotatedCalibration

Obsolete?

RX Buffer Length

Initial size of UPDD’s receive data buffer.

SampleRate

Determines the percentage of pointer device data packets that are passed on to the mouse driver

Sound Duration

Defines the time period for sounds accompanying button presses

Sound Pitch

Defines the pitch for sounds accompanying button presses

Sound

If set, sound is enabled

Stabilisation

If set, this causes small movements to be ignored

StopBits

Number of stop bits in serial data packets

Suppress Autocal

Internal use only – temporarily suppresses the action whereby UPDD “guesses” calibration co-ordinates if they are missing.

SwapXY

When checked, X and Y axes of the pointer device are swapped

Tablet Height Thou

Used to define the physical size of an input device for use by the handwriting recognition engine

Tablet Width Thou

Ditto – as above.

TapTime

Defines (in units of 20ms) short time interval used by the driver tap logic click logic

Toolbars

Obsolete

Touch Surround

If set indicates that touches outside the calibrated area are ignored – unless they are in a toolbar

Touchdownfilter

Specifies the initial number of touch packets to ignore before sensing a touchdown

Touchdowntimefilter

Specifics the length of time before a touch is deemed valid.  Used to filter out short duration touches

TouchdownTimeFilterBoundary

Defines an area (in raw controller coordinates) that if the input location (touch) moves further than this distance from the original input during the filtered time period the timer is restarted.

Touchpadxxxxx

Settings related to the UPDD Touch Pad feature

TMAcceleration

TMEnable

TMSensitivity

Touch Mouse settings when touch screen relative mode in use.

TX Buffer Length

Initial size of internal buffer

Unmatched Lift Wakeup

If set a lift packet from the controller will generate a dummy movement to terminate the active screen saver.

Use Liftoff Bit

If the pointing device packet contains lift-off data, use this (in preference to lift off time period) to invoke a pen up.

Vendor Id

USB vendor identifier

Vertical Edge Gain

Some devices cannot be touched at the extreme edge. An acceleration mechanism can be defined to allow the mouse to be moved to the edge of the physical screen. Vertical Edge Gain defines the acceleration rate.

Vertical Edge Width

Some devices cannot be touched at the extreme edge. An acceleration mechanism can be defined to allow the mouse to be moved to the edge of the physical screen. Vertical Edge Width defines the size of the accelerated margin.

VisibleEvents

Indicates if the currently selected button mode is reflected in the button mode list on the system tray menu.

Xmin

Minimum horizontal value for this segment

Xrange

Logical horizontal extent of device, e.g. 65535

Ymin

Minimum vertical value for this segment

Yrange

Logical vertical extent of device, e.g. 65535

ZSupport

Set if Z axis support is enabled

ZThreshold

Threshold for registering a click on the Z axis

Device sub section and nodes

[updd\parameters\N\[Sub-section]

[updd\parameters\N\calibration styles\N]

Calibration style specific settings

Calibration Background

The calibration values have been described above. Those in the level above this are the active values. Those in this branch represent the inactive values. NB changes in the DCU calibration settings are made here and copied to the active area upon calibration.

Calibration Points

Calibration Rotation

Calibration Start Pct

Calibration Style

Calibration Timeout

CalXn

CalYn

RefX0

RefY0

RefX1

RefY1

[updd\parameters\N\macros\N]

UPDD macro string definition

[updd\parameters\N\macros\1\macro]

[updd\parameters\N\macros\1\macrodata]

Controller Start

May contain a macro command set to invoke when starting the controller

[updd\parameters\N\macros\2\macro]

[updd\parameters\N\macros\2\macrodata]

Controller Stop

May contain a macro command set to invoke when shutting down the controller

[updd\parameters\N\macros\3\macro]

[updd\parameters\N\macros\3\macrodata]

Driver load

May contain a macro command set to invoke when the driver loads

[updd\parameters\N\macros\4\macro]

[updd\parameters\N\macros\4\macrodata]

Driver Unload

May contain a macro command set to invoke when the driver unloads

[updd\parameters\N\toolbars\N]

Toolbar settings.

 

 

[updd\parameters\controller\tsNNN]

Default controller settings

[Various]

These entries are the factory settings for each driver within a given bundle. When devices are added from this list, the settings are moved to the next appropriate N entry under the GUID

 

 

Contact

For further information or technical assistance please email the technical support team at technical@touch-base.com.