Storm EZ-Key User manual

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 1 of 35

.
Contents Page
Product Overview
Product Features (from Host Specification)
USB Device Information 3
Device Manager 4
CodeTables 5
Using the Windows Utility to change USB Codes 6
System Requirements
Installing the Utility 7
Using the Utility 10
Customising the USB Codes 11
Keypad Test 18
API for controlling the Keypad from the Host Computer
Device Communications 19
Message Format 20
Change History 35
EZ® and EZ® Access are registered trademarks of the University of Wisconsin.
For further information about EZ Access go to www.trace.wisc.edu/ez

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 2 of 35
Product Features
The product has following characteristics:
HID keyboard
HID consumer controlled device (The functionality will be explained below)
USB audio device
Illuminated audio jack with dimming capability via software
Beeper (duration controlled by software)
Standard EZKEY + audio keypad tables supported as default
Customisable keypad table
It also supports an HID-data pipe back channel, which is used to configure the EZKEY + audio
No additional drivers are required.
Supports standard modifiers, i.e. Ctrl, Shift, Alt
Supports loadable firmware for future upgrades
EZKEY VOIP Keypads supported
5 Way 6 Way 8 Way
Physical Layer
- HID over USB
Boot Loader
- A Boot Loader is provided to allow software to be updated over USB.
oThe Boot-loader is invoked by software
oAn ‘emergency’ hardware boot loader override switch is provided in the event of the software Boot Loader failing.
Keypad - De-bounce parameters
oOptimal values for Storm keypads are set as default (20ms)
Beeper Command
- It is possible to enable/disable beeps on a key press
oThe duration of the key beep is selectable via USB
- It is possible to send a beep command to operate the beeper via USB
Audio Jack Socket LED illumination commands
- It is possible to turn illumination on and off – LED Illumination is on by default
oIt is possible to dim the illumination in 10 steps via a USB command
Keycode table
There is provision for three selectable keycode tables in the keypad – you can select the table with the API or with the Utility
On one of the tables (Alternate table), the up/down key will act as HID consumer controlled keys for volume up and volume
down.
The user can customise the third table with any USB keycode, including modifiers.
Configuration
The utility allows user to configure the EZKEY VOIP via ini file, including the customisation of keycodes.

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 3 of 35
USB Device Information
USB HID
The USB interface for EZKEY+ audio keypad comprises a USB HUB with keyboard device and audio device
connected.
JACK SOCKET (AUDIO) KEYS
TO PC
The following VID/PID combinations are used:
For USB HUB:
• VID – 0x0424
• PID – 0x2512
For Standard Keyboard/Composite HID/Consumer Controlled device
• VID – 0x2047
• PID – 0x09BF
For USB Audio device
• VID – 0x0D8C
• PID – 0x0170
This document will concentrate on the Standard Keyboard/Composite HID/Consumer Controlled device. This
interface will enumerate as
• Standard HID Keyboard
• Composite HID-datapipe Interface
• HID Consumer Controlled device
One of the advantages of using this implementation is that no drivers are required.
The data-pipe interface is used to provide the host application to facilitate customisation of the product.
USB AUDIO
DEVICE HUB USB KEYBOARD
DEVICE

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 4 of 35
Device Manager
When connected to a PC, the EZKEY + audio keypad should be detected by the operating system and
enumerated without drivers. Windows shows following devices in the Device Manager:



Keyboard
Audio
Keyboard
Keyboard
Audio
HUB

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 5 of 35
Code Tables
Default
Alternate
For Volume up/Down key a volume up/down report will be sent to PC according to the HID descriptor setup for HID
consumer controlled device. The following report will be sent:
Volume UP key <0x01><0x02>
Volume DOWN key <0x01><0x04>
LEGEND TACTILE
IDENTIFIER KEY COLOR USB
(KEYCODE)
HEX
CODES DESCRIPTION
<< < BLACK F23 0x72 Home/Menu
? . BLUE F17 0x6C EZ-Help
>> > RED F24 0x73 End
BACK WHITE F21 0x70 Back
NEXT WHITE F22 0x72 Next
^ YELLOW F18 0x6D Up
v YELLOW F19 0x6E Down
GREEN F20 0x6F Action
In addition the unit will also output keycodes for JACK IN and JACK OUT
F15 0x6A JACK IN
F16 0x6B JACK OUT
LEGEND TACTILE
IDENTIFIER KEY COLOR USB
(KEYCODE)
HEX
CODES DESCRIPTION
<< < BLACK F23 0x72 Home/Menu
? . BLUE F17 0x6C EZ-Help
>> > RED F24 0x73 End
BACK WHITE F21 0x70 Back
NEXT WHITE F22 0x72 Next
^ YELLOW Volume Up
v YELLOW Volume Down
GREEN F20 0x6F Action
In addition the unit will also output keycodes for JACK IN and JACK OUT
F15 0x6A JACK IN
F16 0x6B JACK OUT

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 6 of 35
Using the Windows Utility to change USB Codes
System Requirements
The utility requires .NET framework to be installed on the PC and will communicate over the same usb connection
but via the HID-HID data pipe channel, no special drivers are required.
Compatability
Windows 8 
Windows 7 
Windows Vista 
Windows XP Only if you install .NET framework
Windows ME and earlier Not investigated
The utility can be used to configure the product for:
• LED On/Off
• LED brightness (0 to 9)
• Beeper On/Off
• Beeper Duration ( ¼ to 2 ¼ seconds)
• Load customised keypad table
• Write default values from volatile memory to flash
• Reset to factory default
• Load Firmware

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 7 of 35
Installing the Utility
To install StormEZKeyUtility click on the setup.exe (windows installer package) and following instruction as below:

Click on “Next
Select “I Agree” and Click on “Next

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 8 of 35

Select if you would like to install for just you or
everyone and select location if you do not want to
install at default location. Then click on “Next”














Clickon“Next”andinstallationprocesswillstart


EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 9 of 35








Clickoncloseforsuccessfulinstallation.

AshortcutwillbeinstalledonDesktop 

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 10 of 35
Using the Utility
Double Click on the Shortcut to start and it will display the form below
Note : Before loading the form it initially detects the EZKey+ audio using the VID/PID and if found it sends a
device status message. If all successful then all the buttons are enabled. If not then they will all be disabled except
for “Scan” and “Exit

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 11 of 35
Using the Utility –Changing Code Tables
You can select from three tables:
EZkey – Default Table
EZKey – Alternate Table
EZKey – Customise Table (select the codes you prefer using the Utility)
Once a table has been selected then the keypad will retain that configuration whilst it is powered up.
Once the keypad has been disconnected that configuration will be lost (unless you Save Changes)
To save the configuration in flash memory in the keypad click on “Save Changes”



NOTE: If the EZKey – Alternate table is selected the function of the UP/DOWN key changes to be the HID
consumer controlled VOLUME UP/VOLUME DOWN.
If audio file is being played then if user presses the UP/DOWN key the volume on the PC will be adjusted.
The volume ICON will be shown on PC.

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 12 of 35
Using the Utility
Changing Audio Jack LED Brightness
Beeper On/Off
This controls if the beeper sounds when a key is pressed on the keypad. The beeper period is ¼ seconds, which is
fixed.

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 13 of 35
Using the Utility
Changing Beeper Duration
The beeper period can be selected from 0 to 9. Each step has an increase of 1/4sec, so 9 will sound the beeper for
2 and ¼ seconds.

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 14 of 35
Using the Utility
Customising the Key Code Table
Select “Customise Table” and the following is displayed showing the current USB Code (in hex) for each key on the
product.
Above each key is a button to show the modifier

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 15 of 35
Using the Utility
Customising the Key Code Table
To customise a key, click on it
and the “Select Code” combo box will appear.
Select the code you require from dropdown list
Once a code is selected, the button’s background
colour will display the new code selected.
Press Apply to send the new code to the keypad

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 16 of 35
Using the Utility
Customising the Key Code Table – adding a modifier
Now if you wanted a “D” (uppercase) then you need to add a SHIFT modifier for that key.
Click on the modifier button for that key.
The background colour for modifier button will change
to orange and a modifier combo box will appear . The following selection is available:
.
Once you have made a selection :-
Click on “Apply”, this will save your changes and return you back to the main screen
Click on “Reset” removes all the customised codes.
Click on “Close” will exit the customize form without saving changes and returns you back to main screen.
NONE
L SHT – Left Shift
L ALT – Left Alt
L CTL – Left Ctrl
L GUI – Left Gui
R SHT – Right Shift
R ALT – Right Alt
R CTL – Right Ctrl
R GUI – Right Gui

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 17 of 35
Using the Utility
Don’t forget to SAVE YOUR CHANGES
All configurations, including the customized table are modified in volatile memory.
So if after modifying the code table the user just disconnects the keypad, then next time the encoder is powered
on, it will revert back to previous configuration data.
To save the modified data in non volatile memory, click on “Save changes” button before you power down the
keypad.
Reset to factory defaults
Clicking on “Factory Default” will set the EZKey + audio keypad with values that are preset.
EZKEY – default table
LED brightness – 9
Beeper – on
Beeper Period - 1

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 18 of 35
Using the Utility to Test the Keypad
This will test all the functionality of EZKEY + audio keypad. The utility will detect which keypad type is connected.
• Sequence the illumination over all dimming levels
• Beep the beeper ( SHORT AND LONG BEEPS)
• Key test
• Jack in/out
• Audio test
To test the audio of the EZkey you must be using the default code table.
Click On “Test EZKey” to start

EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 19 of 35
API for controlling the Keypad from the Host Computer
This section provides details on how the EZkey can be controlled from a host that has USB capabilities.
The API incorporating this command set is downloadable separately from www.storm-interface.com.
Device Communications and Message Format
EZKEY_VOIP keypad uses the ASCII/binary Message format described below. Every message that is sent from a
host should be acknowledged with the control byte ACK (0x06). A retransmission should be initiated if an NAK
(0x15) is received or if no acknowledge is received at all.
Message Formats
A Alpha character, 'A'-'Z' and 'a' - 'z'
C Control character one byte in length.
H Hexadecimal characters, ‘0’-‘9’, ‘A’-‘F’
N Numeric character, ‘0’-‘9’
S Special characters, entire character set 0x00 - 0xFF
ASCII Message Format
MessageFieldTypeLengthDescription
1STXC1ControlcharacterStartofText=0x02
2MessageIdH2Definesthetypeofmessageandformatofthedatafield
3DataLengthH2HexadecimalvaluerepresentedinASCIIdefinesthe
numberofbytesinthedatafield.'00'to'FF'.Maximum
datafieldsizeis256bytes.
4DataFieldSvarInbinaryformat
5ETXC1ControlcharacterETX=0x03
6LRCC1LongitudinalRedundancyCheckDigit,calculatedonall
previousdataincludingSTX


EZ-Key Keypad with integrated audio
Technical Manual

The content of this communication and/or document, including but not limited to images, specifications, designs, concepts and information is
confidential and is not to be used for any purpose or disclosed to a third party without the express and written consent of
Keymat Technology Ltd., Copyright 2015. All rights reserved.
EZ-Key + Audio - Technical Manual Rev 1 Apr 2015 www.storm-interface.com Page 20 of 35
Controlling the Keypad from the Host Computer
Message Definitions and Error Codes
Here is a general table describing the message Ids, more detailed descriptions for each message Id follows. When
a message is one way only, the Message Id. is the same for both the message and response.
ID. Message Description
01 Device Status
Request Host To EZKEY_VOIP keypad – Output the firmware version and all currently selected parameters
02 LED Brightness Host To EZKEY_VOIP keypad – adjust led brightness. (default: 0)
03 Reserved RESERVED
04 Key Press Beeper
On/Off Host To EZKEY_VOIP keypad - Enable/Disable beeper. (Default: Enable)
05 Load New code
table Host To EZKEY_VOIP keypad – Load new code table
06 Beeper Command Host To EZKEY_VOIP keypad – sound beeper
07 Keypad Table Host To EZKEY_VOIP keypad – Select layout table 0 – Default Table 1 –
Alternate Table 2 – Customised
08 Reserved Reserved
09 Write to default Host To EZKEY_VOIP – EZkey writes configuration data from ram to flash.
10 Reset to factory
default Host To EZKEY_VOIP – Reset device back to factory default
11 RESERVED Reserved
12 Load Firmware Host To EZKEY_VOIP – Sets the EZkey to detect the device loader for
firmware loading
13 Status Beeper Host to EZKEY_VOIP – Sounds the beeper for x period. X is passed in value
(0 -9). This will sound the beeper even if beeper is switched off.
Error Code
Every response message contains one of the following error codes:
00 No error
01 Command not recognized
02 Command not support at this stage
03 Parameter not supported
04 Hardware fault
.