Storm Interface Nav-Pad User manual

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 1 of 55
 
Product OverviewPage
Features, Part Numbers & Specifications 2
Audio Control – Typical Method
USB Device Information 6
Code Tables 7
Windows Utility
System Requirements 8
Using the Utility 12
Customising the USB Codes 14
API for controlling the Keypad from the Host Computer
Device Communications / Message Format 24
List of Messages 26
Message Details 27
Host API Library for Application Developers 40
Code Examples (Visual Studio) 53
Remote Update of Device Firmware 54
Change History 55
Nav-Pad™ was developed in association with the Trace Research & Development Center with support from the University of Wisconsin.
Nav-Pad™ is a compliant tactile interface device for use as part of an ADA audible menu navigation system or EZ-Access® implementation.
Storm, Storm ATP, Storm Interface, Nav-Pad and Audio-Module are trademarks of Keymat Technology Ltd. All rights reserved,
EZ Access® is a trademark of the Wisconsin Alumni Research Foundation


Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 2 of 55
Product Features
Kiosks, ATMs, ticketing machines and voting terminals usually present Information about available products
and services via a visual display or touch screen. The Nav-Pad™ keypad is a highly tactile interface that
have been designed to facilitate audio navigation of software applications by those with sensory or mobility
impairment. An audio description of available menu options can be transmitted to the user through a plug-in
audio headset. When the desired page or menu option is located, it can then be selected by the press of a
distinctive tactile button.
An important feature of the module is that it provides compliance as far as is practicable with various country
standards for equipment use by disabled people, including the Americans with Disabilities Act (ADA – USA)
the Disabilities Discrimination Act (DDA) & the Equality Act (UK)
Colour makes location of individual keys much easier for those with partial vision. The keytop’s distinctive
shape and tactile symbols provide the primary means of identifying a key’s specific function.
Keypad
- Keypad comes in 5, 6 or 8 key versions.
- Designed for under panel installation to a 1.2mm - 2mm panel only.
- Illuminated 3.5mm audio jack socket (illumination under software control)
- Beeper (duration controlled by software)
- Mini-USB socket for connection to host
USB Interface
- HID keyboard
- Supports standard modifiers, i.e. Ctrl, Shift, Alt
- HID consumer controlled device
- Advanced audio device
- No special drivers required
- Audio Jack Insert / Removal sends USB code to host
Support Tools
The following support software tools are available for download at www.storm-interface.com
These are all described in full later on in this document
- Windows Utility for changing the USB Code Tables
- API for custom integration
- Remote Firmware update tool.

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 3 of 55
Typical method for audio module volume control using the API
Alternate method for audio volume control using the API
User Action
‐ Plug in the headphone jack
Host
‐ Host system detects the connection
‐ Repeating message generated by the host
application software :
“Welcometotheaudiomenu.Presstheselect
keytobegin”
User Action
‐ Press the select key
Host
‐ Activate the Volume Control function
‐ Repeating message :
“Usetheup&downkeystochangethevolume.
Presstheselectkeywhenfinished”
User Action
‐ Adjust the volume
‐ Press the select key
Host
‐ De-activate the volume control function
“Thankyou.Welcometothe(nextmenu)”
User Action
‐ Plug in the headphone jack Host
‐ Host system detects the connection
‐ Sets volume level to initial default
‐ Repeating message :
“Pressthevolumekeyatanytimetoincreasethe
volumelevel”
User Action
‐ Presses the volume key
Host
‐ Message stops if volume key is not pressed
inside 2 seconds.
Host
‐ Host system changes the volume on each key
press (up to a max limit, then revert to default)

Nav-Pad
™
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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 4 of 55
Product Range
5 Way 6 Way 8 Way



Product Range: Part Numbers
EZ05-23001 Nav-Pad 5-Key Tactile Interface & Integrated Audio
EZ06-23001 Nav-Pad 6-Key Tactile Interface & Integrated Audio
EZ08-23001 Nav-Pad 8-Key Tactile Interface & Integrated Audio
Accessories / Cables 
6000-MK00 PANEL FIXING CLIPS (PACK OF 8 CLIPS)
Use to install into a 1.6 – 2mm steel panel
Refer to drawing EZK-00-33 for cutout dims.
4500-01 USB CABLE MINI-B TO TYPE A, 0.9m
RECOMMEND USE
OF 2.5MM CABLE
TIE TO RETAIN
CABLE

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 5 of 55
Specifications
Rating 5V ±0.25V (USB 2.0)
Connection mini USB B socket
Audio 3.5mm audio jack socket (illuminated)
Ground 100mm Earth Wire with M3 ring terminal
Sealing Gasket included
USB Cable not included
Dimensions (mm)
Overall Dims 105 x 119 x 29
Packed Dims 150 x 160 x 60 (0.38 kg)
Panel Cutout 109.5 x 95.5 Rad 5mm corners. Refer to drawing EZK-00-33
Underpanel Depth 28 mm 1.6 – 2.0mm panel recommended
Mechanical
Operational Life 4 million cycles (min) per key
Performance/Regulatory
Operational Temp -20°C to +70°C
Weather Resistant IP65 (front)
Impact Resistance IK09 (10J Rating)
Shock & Vibration ETSI 5M3
Certification CE / FCC / UL
Connectivity
The USB interface comprises an internal USB hub with connected keyboard and audio module.
This is a composite USB device and no additional drivers are required.
PC based software utility and API are available to set/control: -
• Volume key function
• Illumination on audio jack socket
• Customise the USB codes

Nav-Pad
™
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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 6 of 55
USB Device Information
USB HID
The USB interface for NAV-PAD™+ 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: For Standard Keyboard/Composite HID/ For USB Audio device
Consumer Controlled device
• VID – 0x0424 • VID – 0x2047 • VID – 0x0D8C
• PID – 0x2512 • PID – 0x09D0 • 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.
Supported Audio Jack Configurations
The following jack configurations are supported.
Notes: Application software should always ensure the same audio is present on both Left and Right Channels for
correct mono operation. Headsets with microphones can be used but there is no microphone support.
USB AUDIO
DEVICE HUB USB KEYBOARD
DEVICE

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 7 of 55
Device Manager
When connected to a PC, the NAV-PAD™ + 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

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 8 of 55
Code Tables
Default
Alternate
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 0x71 Next
^ YELLOW F18 0x6D Up
v YELLOW F19 0x6E Down
O GREEN F20 0x6F
A
ction
In addition the unit will also output keycodes for JACK IN and JACK OUT
F15 0x6
A
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 0x71 Next
^ YELLOW Volume Up
v YELLOW Volume Down
O GREEN F20 0x6F
A
ction
In addition the unit will also output keycodes for JACK IN and JACK OUT
F15 0x6
A
JACK IN
F16 0x6B JACK OUT

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 9 of 55
Using the Nav-Pad TM Windows Utility to change USB Codes
If any other keypad utility software is installed (e.g EZ-Key Utility) then you should un-install that before you start.
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 10 
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)
• Buzzer On/Off
• Buzzer Duration (¼ to 2 ¼ seconds)
• Load customised keypad table
• Write default values from volatile memory to flash
• Reset to factory default
• Load Firmware

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 10 of 55
Installing the Utility
To install StormNav-Pad™Utility click on the setup.exe (windows installer package) and follow instructions below:

Click on “Next
Select “I Agree” and Click on “Next


Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 11 of 55
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











Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 12 of 55
Clickonclosewhencomplete.
AshortcutwillbeinstalledontheDesktop 








Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 13 of 55
Using the Utility
Double Click on the Shortcut to start and it will display the form below. Connect the Nav-Pad to a USB port.
Note: Before loading the form it initially detects the Nav-Pad™+ 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
The utility allows you to :
View the installed firmware version and code table in use.
Select a Code Table, or create a Customised Table
Change buzzer behaviour / duration
Change Audio Jack Socket LED brightness
Update the firmware
Reset to factory defaults
Test the keypad.

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 14 of 55
Using the Utility – Selecting a Code Table
You can select from three tables:
Nav-Pad™ – Default Table
Nav-Pad™ – Alternate Table
Nav-Pad™ – 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 Nav-Pad™ – 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.

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 15 of 55
Using the Utility
Changing Audio Jack LED Brightness

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 16 of 55
Buzzer On/Off
This controls if the buzzer sounds when a key is pressed on the keypad. The duration is ¼ sec.

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 17 of 55
Using the Utility
Changing Buzzer Duration
The buzzer duration can be selected from 0 to 9. Each step has an increase of ¼ sec, so 9 will sound the buzzer
for 2 ¼ seconds.

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 18 of 55
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

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 19 of 55
Using the Utility
Customising the Key Code Table
Click on a key to customise 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.
Note that 0x74 through 0x81 are extendable codes
Also note that codes
0x80 Vol Up
and
0x81 Vol Down
will be transmitted as Windows Multimedia codes.
Press Apply to send the new code to the keypad

Nav-Pad™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 2017. All rights reserved.
Nav-Pad + Audio - Technical Manual Rev 1.9 www.storm-interface.com Page 20 of 55
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