Velocity - Remapping a Function Key to Send a Unique Escape Sequence

Issue / Question

Customer migrating from TelnetCE to an Android device running Velocity. Need to bring over a KeyMacro for the F5 key.

Applicable To

Ivanti, Velocity, Function Key, Wavelink, Emulation, Android, Mobile Devices, Key Macro, Script
VC8300, TC 5x Series, TC 7x Series, All Touch Terminal Emulation, TC 8x Series, WT6000, MC Series, VC80X, VC80

Resolution / Answer

Remapping a Function key in Velocity requires that you know the HEX value for the Function Key to be remapped.  You can get this HEX value by going to the following link on Ivanti's web page:
https://help.ivanti.com/wl/help/en_US/VelCon/1.2/admin/keyboardCodes.htm


This link will list all the Velocity Keyboard Codes for each Emulation Type.
In this Article, we are only concerned with the VT220 F5 Key.  The list below shows all the VT220 Function Keys:

The highlighted line is for F5.  The HEX value associated with F5 is E03F


Now that we know the HEX value for the Function key we are modifying, we will now go to the Velocity Console to bring in a pre-loaded Velocity Script:


In the Velocity Console, select Scripts:




You will now select Library from the Project Scripts window:



This will bring up a list of pre-loaded Scripts that you can select from.



Highlight the Key Macro Script and press OK:




You will now have the Key Macro Script in your Script window:




Click on the box to the left of Key Macro.  This will put a check in the box.



Select Link to link this Script to your Project.



You will see the following window:



Select OK to link the Script to all screens in your Velocity Project.



You will now be able to configure your Key Macro Script using the F5 HEX value that we found earlier:



In the HEX Code field, key in E03F
(E03F is the HEX value for F5)


In the New Value field you can put in your custom VT Escape Sequence.
Escape Sequences usually start off with ESC and then then have a series of symbols and numbers.
We will use ESC[15~ as our VT Escape Sequence.
We need to following the format outlined in the Script to the right of the New Value field.  This uses the following format:
{hex:xxxx}
The Escape value is 001B
The remainder of the characters can be typed.
So our New Value will be:
{hex:001B}[15~



Here is what the Script will look like:





Save your Project:





Then select Deploy to create your new .wldep (Deployment) file:




Sent the newly created .wldep file to your Mobile Device for testing.