Welcome to the Mac OS X Quick Installation Guide which covers the key elements for installing the UPDD Mac OS X version 6 driver. At the time of writing this driver supports Mac OS X 10:7 thro’ 10:14.
A full UPDD driver installation document is available here and contains comprehensive installation and usage instructions and should be referenced if installation fails or the touch screen does not function as expected and for a greater understanding of the UPDD driver software.
Very important MacOS High Sierra 10.13 /10.14 notes:
- Apple introduced additional security features in MacOSX 10.13 that affected the installation of system (kernel) extensions - commonly known as a kext. All 3rd party kexts now need to be explicitly allowed, regardless of whether they're signed with a valid key. To cater for this we had to make changes to the UPDD kext file and our installer. These changes are in UPDD V6 version 304 and above. Earlier versions will not work in 10.13. The updated kext file is now installed in 10.9 thru' 10.13. Only 10.7 and 10.8 use the old kext file. These installation notes have been updated to show the additional installation procedures that need to be undertaken in 10.13.
- The changes we made in the new kext not only allowed our software to install in 10.13 and 10.14 but also addressed a few ongoing issues, such as often needing a reboot after install for our driver to get control of the device. All of this is positive. However, since moving over to the new kext we have had a few customers whereby the kext has not been correctly installed and the touch has not worked and we have investigated these cases in great detail and documented our findings and possible solutions here.
The software is delivered via email as a HTTP download link to a Mac OS X disk image container file updd_06_nn_nn.dmg. The actual name of the .dmg file reflects the version of the driver being installed, e.g.updd_06_00_1.dmg.
The .dmg file will expand to a package file updd.pkg (this step may be invoked automatically when downloading the .dmg file).
To install the software double click on the package file and follow the instructions on the install dialog until the ‘Installation has completed’ screen is seen. During the installation procedure you will be prompted to enter your password.
If installing on 10.13 or above then on the first time you install the driver you will be informed that you will need approve the system extension during the installation.
The driver install dialog will also list any additional software packages that are included as part of the driver install. These are also available for download from our UPDD V6 documentation should they be required but are not included in your installation.
In 10.13 and above if the system extension has not previously been approved you will be presented with the block notification:
A customer reported that installing remotely they were blocked from clicking OK on this dialog. They created an Automator script to press the button!
Once you acknowledge the above dialog the installer will automatically invoke the general section of the Security & Privacy dialog to allow you to approve our system extension to be installed.
Click the lock to make changes and select Allow.
Some customers have reported at this point the 'Allow' option does not work, especially with keyboard only access. In this case you may need to follow the instructions here once installation has completed.
Enabling accessibility features
Starting with MacOS 10.13 and extended in 10.14 the OS now seeks permission for any applications that use system interfaces to control the system. This applies to four of our components as described below:
Gestures will seek permission on 10.13 and above. The other components only need permission to be granted for 10.14 and above.
|| UPDD Daemon.app
The driver's daemon process that runs as a background process for each logged in use. Handles single touch mouse emulation if no other process is controlling the touch (e.g. gestures). Mouse emulation is also needed when running UPDD Annotate and Test programs to activate the dialog controls via touch.
When it starts up it checks to see if permission is granted and if not will invoke the 'Request permission dialog'.
If you decline this request touch will not work should at any time the driver be responsible for single touch mouse emulation (if gestures is not running or quits or if the mouse emulation mode is specifically set)
When installing over a previous version of UPDD you will need to invoke the Securities and Privacy dialog and remove UPDD Daemon from the list and either manually add it or wait for the system to add it and prompt you to approve permission.
| UPDD Gestures.app
The gesture process that runs as a background process for each logged in use. Handles both touch and gesture functions.
When it starts up it checks to see if permission is granted and if not will invoke the 'Request permission dialog'. This request is made when gestures loads and discovers an active touch device so will only be seen if a supported touch device is connected or when it is connected at a later time.
If you decline this request many of the gesture features will not work and the gesture dialog will give you an option to enable accessibility.
The driver that runs as a root service. Handles the touch on the login screen. This service cannot invoke the permission dialog so has to be manually added to the Securities & Privacy dialog if you are using and need touch support on the login screen. The updd.app component resides in the /Library/Application Support/UPDD folder.
If this is not manually added touch will not work on the logging screen.
| TUIO server
|| UPDD TUIO.app
||Permission is required by this user mode process if you set the 'hide mouse' setting in the TUIO server settings program. It does not automatically invoke the Securities & Privacy dialog so if you want to hide the cursor whilst using a TUIO Client application you need to open the TUIO Server settings dialog and if it doesn't have permission there will be a button at the bottom named "Enable Accessibility" which will open a dialog to allow you to grant permission.
Given the above at some point during the installation you will be asked to grant permission for the driver's daemon process and gestures (if/when a touch device is connected for the first time) to access the system (in 10.7/10.8 the dialog will be different).
Selecting the 'Open System Preferences' option will invoke the Securities & Privacy dialog as per this example showing all four UPDD components that have been granted permission.
The '+' control can be used to add a component. Please check the component to be granted permission:
In most cases UPDD Gestures is likely to be the only component processing the touch given that most touch uses don't have touch at login (driver), don't use single touch mouse emulation (daemon) and don't use TUIO clients with mouse cursor disabled (TUIO server). We had one reported incident whereby all appeared to be OK with the install, kext load and granted permissions and UPDD test showed touch was OK but there was no cursor movement or gesture support. In this case the user removed and added UPDD Gestures from the Security dialog as per these instructions and all started working as expected.
All being well you will then see the installation complete dialog:
Once the driver is loaded it will check to see if the UPDD kernel extension is registered correctly (for 10.13 you must have given permission for the kernel extensions to load). The driver will issue a notification if the kext is loaded but not registered:
If this is seen you need to open up Security & Privacy system dialog and allow the 'Touch-Base' software or, if permission has already been granted, follow the troubleshooting instructions here.
In most cases the installer will only install the touch driver, related driver utilities and gesture extension but in other cases it may also install additional driver add-ons such as the TUIO server. The latest Gesture and TUIO software can always be downloaded from the associated documentation.
Following install the touch screen should be working and the point of touch activated under the stylus. If the touch is working but the point of touch is not calibrated then invoke the configure procedure.
If touch is not working you may see a notification to reboot the system. This is issued if the driver fails to get exclusive access to a newly discovered device and will be repeated at 1 minute intervals for 5 minutes.
If there is no touch response after a reboot please refer to the troubleshooting document. Should you need to contact Touch-Base please run diagnostics and send us the resultant file.
The touch hardware and UPDD software can initially be tested with the test utility.
Notes if the touch device is an HID compatible device
1. After install there can be a considerable delay (1 to 4 minutes!) before UPDD is in control as it waits for the native HID driver to relinquish control. This only occurs at the initial install. In some extreme cases a reboot may be required.
2. We have discovered that on MacOS 10.12 and 10.13 installing on top of an existing UPDD V6 install will often result in the native HID driver staying in control of the touch device (albeit unlikely to be working correctly) with the UPDD Status showing No device connected. If this occurs a reboot will be required.
Menu Bar Items
There will be Menu Bar item for each UPDD component installed (in some OEM installs these may be disabled):
Selecting the menu bar icon will list the menu options:
With UPDD version 6, applications that connect to the driver via the driver's API, such as the three above, will receive notification if the connection to the API drops, implying the driver is not available. In this instance the menu bar icons will show an exclamation mark and touch is unlikely to be active, such as the driver's menu bar icon:
- driver disconnected / connected notification
If installing an evaluation version of the driver then the 'Register' option will be shown in the UPDD Daemon menu. Prior to being registered the driver will work for a certain number of touches (normally 200) per reboot for 7 days. This restriction is removed once the driver is registered. The UPDD Status screen indicates if you are running an evaluation version and shows number of touches remaining for this session and the number of days remaining:
The UPDD utilities programs are placed in the Mac’s Utilities or the UPDD's Application folder. There are a number of utilities related to the driver and one each for Annotate, Gestures and TUIO Server when they are installed (either by the driver installer or separately).
Following installation the touch should be working and calibrated, if not please review the troubleshooting guide.
A simple test utility exist to test the touch mouse interface and the UPDD API and TUIO Server data input.
If the registered touch point is offset from the point of touch, or the touch is not associated with the correct monitor, then the touch screen will need to be calibrated with the video area. The simplest way to achieve this is to invoke the Configure option from the Daemon menu.
A number of System Interfaces are used to post touch data into the Mac OS X system and applications as described below:
||The driver reads all touch data from the touch screen but only posts single touches directly into the system such that the touch screen acts like a mouse type device. All touch data received from the device is made available on the driver’s Application Programmers Interface (API).
||The complete documentation is here.
||Common settings can be adjusted via the Settings dialog. All user controllers driver settings can be adjusted in the Command Line Utility.
||The UPDD Daemon, About box shows the version in use. Contact the driver supplier for any updates.
||The gesture application receives touch data from the driver API, performs the action associated with the incoming gesture and then posts the touch data into the OS as native touch events.
||The complete documentation is here.
||The gesture settings can be adjusted in the gesture settings dialog.
Note – The ‘Click nearest clickable UI element’ in the Taps and Presses dialog is a useful setting to enable if you are using the touchscreen to select small buttons, such as the minimise, maximise and close buttons in standard application dialogs as these were not designed for touch screen usage.
||The gestures menu bar item ‘Change History’ will show the version in use. Release notes can be found here.
The latest software is available via a link in the Gesture documentation.
|| The TUIO Server receives touch data from the driver API and posts the touch data to TUIO Client applications.
This software is only required if you are running TUIO client applications.
|| The complete documentation is here.
|| The TUIO settings can be adjusted in the TUIO settings dialog.
|| The TUIO Menu Bar menu item ‘Change History’ will show the version in use. Release notes can be found here.
The latest software is available via a link in the TUIO documentation.