STU-540 Serial Installation
STU-540 Installation for Serial operation
Please note that the instructions below are only needed if the 540 is to be configured as a serial device.
Normally it is expected that the 540 will be used as a standard HID device (as supplied from the manufacturer).
There are two situations in particular where it may be necessary to use the 540 in serial mode:
- Over RDP in order to avoid having to install third-party USB forwarding software (which incurs extra cost)
- Over Citrix on installations where the 540 is not supported natively - for more information see Citrix compatibility of the STU-540
Serial configuration of the STU-540:
-
Log into https://developer.wacom.com and download the STU SDK
-
Download the STU SDK samples:
https://github.com/Wacom-Developer/stu-sdk-samples -
Download the Serial Connection Utilities
-
Connect the pad
-
Run "hid2serial" to change the 540 over into serial mode (if currently in HID mode).
-
Ensure your FTDI driver is up-to-date. Normally this is done automatically through Windows Update.
To do this manually select "Update Driver Software" on the "USB Serial Port" right-click menu in Device Manager.
Alternatively the driver can be downloaded from http://www.ftdichip.com/Drivers/VCP.htm -
Run the “getSerialPorts” sample program which should show the pad as a virtual serial port:
If no virtual port is shown then then open Device Manager and expand out the “Universal Serial Bus controllers” section as illustrated below.
Right-click on “USB Serial Converter”, select “Properties” and then the “Advanced” tab as below.
If the “Load VCP” check box is not ticked then tick it and click <OK>.
Unplug the pad and plug it back in again.
Try running “getSerialPorts” again – this time the virtual COM port should be listed.
- Run the “query” utility against the virtual COM port number to check your firmware version which should be at least 1.03.r0:
C:\STU-SDK-Serial-Samples\serial-samples>
query COM8
The information returned should show you the firmware major and minor versions and the secure version number which together make up the firmware release.
In the screenshot below the firmware version is 1.03.r0 (the secure version is given as a HEX value):
If your firmware version is too old please raise a support ticket via the "Submit a request" link at the top of this web page.
- In Device Manager select the “USB Serial Port” entry corresponding to the virtual port number shown by “getSerialPorts”.
The example below shows COM8:
Right-click on the “USB Serial Port (COM?)” entry, select “Properties” and then the “Port Settings” tab as shown below.
Next click the <Advanced…> button and check the setting of the “Latency Timer” drop-down – if it is not set to 1 then change it so that it is and click <OK> twice to return to the Device Manager.
- Run the “Query” sample program on the virtual appropriate COM port number as follows:
C:\STU-SDK-Serial-Samples\serial-samples> query COM8
N.B. For COM numbers from COM10 upwards special syntax is required, e.g.
query \\.\COM10
This should return information similar to the following:
11. Assuming the “query” was successful the next step is to try DemoButtons which is provided in a zip file with other STU 540 test utilities in the FAQ below:
STU-540 Test Utilities and ROM Image Deletion
DemoButtons will present you with an initial selection box as below.
Tick the “Serial” check box and amend the port value to the appropriate COM number, set the baud rate to 128000 if needed and tick the “Use Signature Mode” check box as well
Click the <Signature> button and you should see a signature capture window on the pad and also on your PC monitor.
Enter your test signature on the pad using the pen and you should see inking on the pad as well as on the PC monitor window:
Please note:
We highly recommend that you focus on getting DemoButtons working successfully with a locally connected pad before attempting to use the pad in a Citrix, client/server or similar environment.
If DemoButtons is operating correctly at a local level then any problems operating the pad via a remote connection can safely be attributed to the mechanisms or configuration being used to forward the pad data.
- If the virtual port number allocated to your pad is higher than COM9 then this creates syntax complications as mentioned in 8 above.
This could potentially cause difficulties with configuration settings in Citrix or other software needing to access the device.
It is possible to override the pre-allocated COM port number manually as described below.
i) Find the USB serial port by expanding “Ports” in Device Manager:
ii) Right-click on the “USB Serial Port (COM?)” entry and select “Properties” to see the screen below:
iii) On the “Port Settings” tab click the “Advanced” button:
iv) On the “Advanced Settings for COM?” window click the “COM Port Number” drop-down:
v) From the list of COM ports select a different number.
If the dialogue box informs you that the COM port is already in use you can safely ignore this warning and continue with the change if you know that nothing else is plugged into any of your COM ports.
vi) Click “OK” on this window and again on the previous window to return to Device Manager.
-
Using the 540 with the Signature SDK and sign pro PDF
In order to operate the 540 in serial mode with sign pro PDF or the Signature SDK add the following registry keys:
FULL PATH OF KEY | DATA TYPE | VALUE | DESCRIPTION |
---|---|---|---|
HKLM\Software\Florentis\sd\stuPort | REG_SZ | COM8 (see section 6 above | The virtual COM port number |
HKLM\Software\Florentis\sd\stuBaudRate | REG_DWORD | 128000 | Baud rate |
N.B. These registry values will need to be in HKLM\Software\Wow6432Node\Florentis\sd if you are running a 32-bit application or SDK on a 64-bit system.
Please make sure that you have installed the latest release of the Signature SDK as some older releases will not recognise the registry values.
Please also note that the 540 is only supported from sign pro PDF version 3.3 onwards.
- Using the 540 in serial mode with the STU SDK
In order to control the 540 in serial mode from the STU SDK a different type of connection needs to be made in the code.
The example below illustrates how to do so with Javascript:
var ec = m_tablet.serialConnect("COM4", 128000, true);
The first parameter is the COM port (which has previously been identified using getSerialPorts.
The second parameter is always 128000 (baud rate).
The third parameter is a true or false Boolean value indicating whether the connection should prohibit sharing of the port with another application – this is sometimes necessary on Windows 7.
A C# sample demonstrating the differences between USB and serial connections, called “DemoButtonsHIDSerial”, is available to download from the STU SDK C# Extra Samples on Github.