Storm Interface NavPad Technical Manual

Hide thumbs Also See for NavPad:

Technical manual (55 pages)

Table of Contents

Quick Links

Download this manual

Product Overview

Features

Audio Control – Typical Method

Part Numbers & Specifications

USB Device Information

Code Tables

Windows Utility

System Requirements

Using the Utility

Customising the USB Codes

API for controlling the Keypad from the Host Computer

Device Communications / Message Format

List of Messages

Message Details

Host API Library for Application Developers

Code Examples (Visual Studio)

Remote Update of Device Firmware

Change History

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

NavPad - Technical Manual Rev 2.2

www.storm-interface.com

Page

NavPad

Technical Manual

Page 1 of 64

™

Table of Contents

Need help?

Do you have a question about the NavPad and is the answer not in the manual?

Questions and answers

Summary of Contents for Storm Interface NavPad

Page 2: Product Features
Kiosks, ATMs, ticketing machines and voting terminals usually present information about available products and services via a visual display or touch screen. NavPad™ is a highly tactile interface that improves accessibility, making audio navigation and selection of screen based menus possible. An audio description of available menu options is transmitted to the user through a headset, handset or cochlea implant.
Page 4: Product Range
NavPad 8-Key Tactile Interface & Integrated Audio – Backlit, Underpanel, no cable EZ08-43200 NavPad 8-Key Tactile Interface & Integrated Audio – Backlit, Desktop, w/2.5m USB Cable 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 2020.
Page 8 Technical Manual Device Manager When connected to a PC, the NavPad™ + audio keypad should be detected by the operating system and enumerate without drivers. Windows shows the following devices in the Device Manager: Keyboard Audio ...
Page 14 Using the Utility Double Click on the Shortcut to start and it will display the form below. Connect the NavPad to a USB port. Note: Before loading the form it initially detects the NavPad™+ audio using the VID/PID and if found it sends a device status message.
Page 15 NOTE: If the NavPad™ – Alternate table is selected the function of the UP/DOWN key changes to be the HID consumer controlled VOLUME UP/VOLUME DOWN. If an audio file is being played and the user presses the UP/DOWN key, the volume on the PC will be adjusted.
Page 22 To save the modified data in nonvolatile memory, click on “Save changes” button before you power down the keypad. Reset to factory defaults Clicking on “Factory Default” will set the NavPad™ + audio keypad with values that are preset. NAVPAD™ – default table LED brightness – 9 Beeper –...
Page 23 Technical Manual Using the Utility to Test the Keypad This will test all the functionality of NAVPAD™ + audio keypad. The utility will detect which keypad type is connected. • Sequence the illumination over all dimming levels •...
Page 24: Upgrade Firmware
Using the Utility Upgrade Firmware To upgrade the firmware click on “Upgrade NavPad™ Keypad Firmware” button Click on “Yes” to confirm After a few seconds the “Browse” and “Upgrade” button will be enabled. 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 2020.
Page 25 Upgrade Firmware The screen below will be displayed while the upgrade is in process. Once unit has upgraded to new firmware, the NavPad™ will auto reboot. Press “Close” and the new firmware version will be displayed on the utility. 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 2020.
Page 26: Message Formats
API for controlling the Keypad from the Host Computer This section provides details on how the NavPad™ can be controlled from a host that has USB capabilities. The API incorporating this command set is downloadable from www.storm-interface.com. Device Communications and Message Format NAVPAD™...
Page 27: Error Code
Host To NAVPAD™ – Sets the NavPad™ to detect the device loader for firmware loading 13 Status Beeper Host to NAVPAD™ – 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...
Page 28 Controlling the Keypad from the Host Computer List of Messages (Structure of Messages from Host to NavPad™ is on the following pages) Name Description Device Status Request Output the firmware version & selected parameters Brightness functions are dependent on which product is being controlled...
Page 29: Device Status
Technical Manual Device Status (01) Host sends this message to request the status of the NAVPAD™ keypad NAVPAD™ Status Response Secure device sends this message to Host in response to the Device Status message. Data Field Type Length Description...
Page 37 Write Config Data To Flash command (09) Host sends this command to request the NAVPAD™ to write the configuration data from RAM to FLASH. This command has no data associated with it. RAM to FLASH Command & Response...
Page 38 Reset To Factory Default command (10) Host sends this command to request the NAVPAD™ to reset parameters back to factory default. This command has no data associated with it. Reset To Factory Default Command & Response Data Field...
Page 39 NavPad ™ Technical Manual Enable BSL Command (12) Host sends this command to request the NAVPAD™ to start downloader Enable BSL Command & Response Data Field Type Length Description ec Error Code Host Device NAVPAD™ [12]...
Page 41 Technical Manual Key Press Code With the USB stack configured for a standard keyboard interface, the NavPad™ sends appropriate key report to HOST when a key is pressed on keypad. Keyboard Report HID Keyboard Report Format BIT7...
Page 42 This document is prepared for application developers who will implement a host application for the NavPad™. The Host API Library for the NavPad™ is a middleware application between the Host application and keypad device. You can download this together with the HIDAPI library from www.storm-interface.com.
Page 45: Return Value
 Product ID – 0x09BF On successful finding the keypad the manufacturer_local will be filled with “Storm Interface” and product_local will be filled with “EZ Key”. If not successful both of the strings will be filled with “none” Parameters :...
Page 46 NavPad ™ Technical Manual GetDeviceStatus This function retrieves status information about the NavPad™. For example, led_brightness, buzzer_on_off, buzzer_period etc. All information is stored in DEVICE_INFO structure. Parameters : typedef struct unsigned char led_brightness; unsigned char buzzer_on_off;...
Page 52 Technical Manual WriteDefaultToFlash This function commands the NavPad™ to commit current values to flash. Parameters : timeToWait maximum time to wait for command to complete Return Value: 0 for success ///\brief WriteDefaultToFlash This function writes changed values to...
Page 53: Reset To Factory Default
Technical Manual ResetToFactoryDefault This function commands the NavPad™ to reset the NavPad™ to factory default. Parameters : timeToWait maximum time to wait for command to complete Return Value: 0 for success ///\brief ResetToFactoryDefault This function reset AudioNav to factory...
Page 55: Code Examples
Technical Manual Code Examples Click on NavPad™ Api (microsoft visual studio solution) and the workspace will be launched. The workspace has 5 projects: NavPad™Api This is the API as described above. Hidapi This is freeware API for low level communication with USB device.
Page 56 It may be a requirement (with a population of installed units) to remotely change the firmware that is installed on the NavPad. To facilitate this process Storm has created a batch file that can be integrated within your Terminal Management System. This comes in a .zip file together with other files that you will need.
Page 57 1. To retrieve current configuration use following parameters: NavpadDownloaderUtility -p <PRODUCT NAME> -v -p <PRODUCT NAME> where PRODUCT NAME is always NAVPAD Retrieves current configuration of unit If successful the output will be : C:\>NavpadDownloaderUtility.exe -p NAVPAD -v Navpad Downloader Console Utility Version V1.0...
Page 58 1. To set main configuration parameters, number of keys and serial number: NavpadUtility ‐k <KEYS> ‐n <SERIAL NO> -k < KEYS > Sets number of keys for Navpad (it can have 5, 6 or 8) -n <SERIAL NO> Sets the serial number of Navpad. 2. To compare before and after upgrade files.
Page 64: Change History
Removed 5 key version 10 Feb 20 WARF info removed page 1 – no issue change 03 Mar 20 Added desktop and non-audio versions 01 Apr 20 Product name changed from Nav-Pad to navPad Utility - std Date Version Details 06 May 15...

Storm Interface NavPad Technical Manual

Quick Links

Need help?

Questions and answers

Summary of Contents for Storm Interface NavPad

Page 2: Product Features

Page 4: Product Range

Page 10: System Requirements

Page 11: Installing The Utility

Page 24: Upgrade Firmware

Page 26: Message Formats

Page 27: Error Code

Page 29: Device Status

Page 34: Buzzer Command

Page 45: Return Value

Page 53: Reset To Factory Default

Page 55: Code Examples

Page 64: Change History

Storm Interface NavPad Technical Manual

Quick Links

Need help?

Questions and answers

Related Manuals for Storm Interface NavPad

Summary of Contents for Storm Interface NavPad

Table of Contents