Driver and device functions


These parameters are used by upddutils to handle driver and device configurations.

The syntax is 'upddutils {[<device selector>] {command}}'

[<device selector>] Selects the UPDD device against which to perform request. Only required in multi-device environment.
If no device is specified then device related commands will be applied to the first device listed.
Syntax Description
nodevice The “nodevice” option allows actions on general (non-device specific) parameters
device <handle> Perform request on the specified UPDD device based on the device's UPDD handle as shown in the "upddutils devices" command.
device <location> Perform request on the specified UPDD device based on the device's UPDD bindkey, e.g. Port_#0005.Hub_#0007
connected Perform request on the first USB connected device

Supported commands are as follows:  

Parameters Description
Calibrate Performs a basic text based 2 point corner calibration.
e.g. upddutils device 1 calibrate

Calibrating point 1 of 2. Please touch the top left corner of the screen
after touching the top left corner....
Calibrating point 2 of 2. Please touch the bottom right corner of the screen

Calibreport Earlier versions of UPDD V6 uses a very simple calibration program that presents 4 points at 10% in from the corners. Four touches are used so that the calibration procedure can determine the orientation of the touch screen but for the purposes of actual calibration only 2 points are utilised, hence this command on earlier versions only shows 2 point calibration data. Later versions of the driver allow for 4,9,25 points with different margin values.
If using EEPROM calibration storage the the report will also list EEPROM information.

Number of points: 2
Rotation when calibrated: 0
Margin: 10
Points:
X Y
393 240
388 1928

digitizer_events
or
de

Lists the calibrated co-ordinate values received from the controller, stylus information and the UPDD physical events.
The following example, taken with a pen device, shows the calibrated co-ordinates (X,Y), pressure (z) and stylus details along with the 'touching' status (pen down/up) and stylus width and height:

When the W and H values are 1 it's likely the device does not support Width and Height. If 1,1 is returned when using a finger, then it's highly likely it's just showing the default value used when no height and width values are coming from the device.

events [types]
or
ev [types]
This prints all event types. This option has an optional "types" field. If entered then only events of the specified types are shown, as in the example below and additionally for some event types prints more detailed data.
This is intended for technical users / internal use only. Users should refer to UPDD API header file for a better understanding of the fields


setdefault Set the default value of a setting for a specified device handle 
device handle can be "*" for all controllers 
any non-default value is cleared, i.e. this value becomes effective for any device instances of this device type (new devices that are discovered on the system)
e.g. 'upddutils setdefault * active_touch_interface mouse' - set the default touch interface for all device types to single touch mouse.
toolbar_events
or
te
List the toolbar events; device, id, name, stylus, row, column, touch state.
The following example shows touches within a 1 column, 5 row toolbar called 'Rightmost' with each toolbar cell being touched in turn:

writeeeprom
<addr> <data>
Writes data to the specified address (hexidecimal) to the controller’s eeprom storage.
e.g. writeeeprom 70 03 02 01 writes 3 bytes of data starting at addr 70
​The address must be specified in hexidecimal. In UPDD V5 it was decimal.
readeeprom
<addr> <length>
Reads data from the specified address (hexidecimal) and specified length from the controller’s eeprom storage and dumps this to the screen (stdout):
e.g. readeeprom 70 3 would return 03 02 01 if following the above write example:

get <name|pattern> Return the value of a setting. For more details see here.
remove <name> Remove a setting from the settings file. For more details see here.

setall <name> <Value>

All devices inherit a default set of settings for a particular device when first discovered by the driver. This command creates a custom setting for a device that overwrites the default setting. For more details see here.
set <name> <value> Update the value of a setting. For more details see here.