Storm AudioNav EF User manual

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 1 of 37
Windows Utility
System Requirements 2
Installation 3
Using the Utility 5
API for controlling the Keypad from the Host Computer 16
List of Messages
Device Communications / Message Format 17
Message Definitions / Details 18
Host API Library for Application Developers 26
Overview
Code Examples (Visual Studio)
Change History 37

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 2 of 37
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.
Compatibility
Windows 10 
Windows 8 
Windows 7 
Windows Vista 
Windows XP Only if you install .NET framework
The utility can be used to configure the product to
• Select Code Table
• LED brightness (0 to 9)
• Test AudioNav
• Create customised keypad table
• Reset to factory default
• Load Firmware

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 3 of 37
Installing the Configuration Utility
To install the Configuration Utility download from www.storm-interface.com/downloads, double click on the
downloaded .exe file and the Setup Wizard will launch
Click on “Next” Select “I Agree” and Click on “Next”
Select if you would like to install for just you or
everyone and select location if you do not want Click on “Next” to confirm.
to install at default location. Then click on “Next”

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 4 of 37
The “Disk Cost” shows available space at your chosen folder. The program requires 10MB of space.
Click on “Close” for successful installation.
A shortcut will be installed on your desktop.
Double-click this to start the Utility and the following screen will appear. If an AudioNav EF device is connected it
will be detected automatically and the details displayed in the blue panel at the top

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 5 of 37
The following functions are available and will be described on the following pages :-
Select a Code table
Create a customised code table
Change the LED brightness
Test the AudioNav EF
Update the Firmware
Reset the AudioNav EF to factory defaults
Reset the AudioNav EF from a saved configuration

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 6 of 37
Select a Code Table
The user can select from three tables:
Once a table has been selected then the keypad will hold that configuration unless it is disconnected.
Once the keypad has been disconnected that configuration will be lost unless you save the configuration in
memory by clicking on “Save Changes”
FACTORY DEFAULT
CODE TABLE
ALTERNATE
CODE TABLE
CUSTOMISED
CODE TABLE
Function Hex USB Description Hex USB Description
Set initially to the
factory default
values
Right 0x4F Right Arrow
Left 0x50 Left Arrow
Down 0x51 Down Arrow
Up 0x52 Up Arrow
Select 0x28 Enter
Jack IN 0x6A F15
Jack OUT 0x6B F16
Increase
Volume
01 02 Windows
Multimedia Codes
Decrease
Volume
01 04
Increase
Playback Speed
0x72 F23
Reduce
Playback Speed
0x73 F24
SELECT
SAVE

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 7 of 37
Create a Custom Code Table
First select Customise Table
Note that Multimedia Control Codes ( Vol Up / Down ) are not available in Customised Table.
Please note: JACK IN/OUT and Horizontal/Vertical codes can also be customised.
Click on ‘Customise Code table. The following will be displayed
SELECT

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 8 of 37
Choosing a USB Code
The current customised code table will be displayed from memory on the keypad.
Attached to each key is another button (“NONE”),
this shows the modifier for each key.
To customize a key, click on the key and
Key Code combo box will appear, with “Select Code”
.
The button colour will change to “Orange”
Now press on the down arrow on the combo box:
This will display all the codes that can be selected.
These codes are the ones defined by USB.org.
Once code is selected, the code will be displayed
on the selected button.
In this example I have selected “e” and code is represented by 0x08 and button colour will change to Aqua.
Press the “Apply” button and the code will be
sent to the AUDIONAV EF.
When you press key “Down” on keypad,
“e” will be sent to the relevant application.

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 9 of 37
Adding a modifier
Now if you wanted a “E” (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 modifier combo box will appear. Select down
arrow key on modifier combo box and the following selection will be available:
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
Select either L SHT or R SHT – I have selected R SHT.
SELECT
SELECT

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 10 of 37
The R SHT modifier is now displayed on the button and background colour changed to grey. Now if you click on
“Apply” and if successfully transferred then pressing “down” on keypad will display “E” (uppercase).
If you did not want the current setting then click on “Reset” then all buttons will revert to original coding and then
click on “apply” to send this coding to AudioNav EF keypad.
“Close” will exit the customize form and return back to main screen.
Press “Save Changes”
PRESS TO SAVE

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 11 of 37
LED Brightness
This will set the brightness of the LEDs. The selection is from 0 to 9.
LEDs in Audio Nav EF can be configured differently when the jack is in or out
In addition, there are 3 separate lighting zones
JACK OUT
JACK IN
ZONE 1
ZONE 3
ZONE 2

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 12 of 37
Test the AudioNav
This will test all the functions :-.
•illumination dimming levels
•Key test
•Jack in/out
•H/V Switch
•Audio test
First test the audio (make sure it is set as the default audio device).
PRESS TO START TEST

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 13 of 37
Now press each key on keypad, each key will light up on screen.
Press close when finished.

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 14 of 37
Update the Firmware
Press YES
BROWSE for the file
press UPGRADE
and CLOSE

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 15 of 37
Reset the AudioNav EF to Factory Defaults
Clicking on “Factory Default” will
reset the keypad to factory settings
Code Table – Default
LED brightness – 9
Reset the AudioNav from a saved Configuration
You can load the saved settings
onto another AudioNav.
This is useful (for example) you
have set up a customised table
and you wish to load this table
on a number of devices
Press to reset to load the saved
settings from the previous device
onto the device that is
currently connected
PRESS TO RESET

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 16 of 37
API for controlling the AudioNav device from the Host Computer
This section provides details on how the AudioNav can be controlled from a host that has USB capabilities.
List of Messages
(Structure of Messages from Host to AudioNav™ is on the following pages
ID Name Description
01 Device Status Request Output the firmware version & selected parameters
02 LED Brightness Adjust led brightness.
03 Reserved Reserved for future use
04 Reserved Reserved for future use
05 Load New code table Load new code table
06 Reserved Reserved for future use
07 Keypad Type Select layout table
08 Reserved Reserved
09 Write to default AudioNav writes configuration data from ram to flash
10 Reset to factory default Reset device back to factory default
11 Reserved Reserved for future use
12 Load Firmware Sets the AudioNav to detect the device loader for firmware loading
13 Reserved Reserved for future use
14 Set Serial Number Write 12 digit serial number
Structure of Messages from AudioNav to Host
01 Key Press Code sends a key scan code back to HOST when a key is pressed on keypad

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 17 of 37
AudioNav Device Communications
AudioNav 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

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 18 of 37
Message ID Definitions
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 AUDIONAV keypad – Output the firmware version and all currently
selected parameters
02
LED Brightness
Host To AUDIONAV keypad – adjust led brightness. (default: 0)
03
Reserved
RESERVED
04
Reserved
RESERVED
05
Load New code
table
Host To AUDIONAV keypad – Load new code table
06
Reserved
RESERVED
07
Keypad Table
Host To AUDIONAV keypad – Select layout table 0 –Default Table 1 –
Alternate Table 2 – Customised
08
Reserved
Reserved
09
Write to default
Host To AUDIONAV – AudioNav writes configuration data from ram to flash.
10
Reset to factory
default
Host To AUDIONAV – Reset device back to factory default
11
Reserved
RESERVED
12
Load Firmware
Host To AUDIONAV– Sets the AudioNav to detect the device loader for
firmware loading
13
Reserved
RESERVED
14
Set Serial Number
Host to AUDIONAV– to store a serial number (12 digits)
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

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 19 of 37
Device Status (01)
Host sends this message to AudioNav to request the status of the AudioNav keypad
AudioNav Status Response
Keypad sends this message to Host in response to the Device Status message.
Data Field
Type
Length
Description
ec
Error Code
SH
2
Lb
LED Brightness
SN
1
Value (0 – 9)
Kt
Keypad Table
SN
1
0 – Default Table
1 – Alternate Table
2 – Customised Table
Js
Jack status
SN
1
0 – Jack IN, 1 – Jack Out
Hs
Horizontal/Verticle
SN
1
0 – Vertical 1 - Horizontal
Kc
Keycode
SH
20
Customised keycode for each key
fw
Firmware Version
ANS
20
Left justified, if Firmware Version is less than 20 then just
add enough spaces after the Firmware Version until this
field is completed, for instance, “123456” becomes:
“123456 “
sn
Serial Number
ANS
12
Returns serial number YYQQXXXXXXXX
Where YY – year, QQ – Quarter XXXXXXXX – Sequential
number
Host Device
AUDIONAV-
[01]
[01][ec][lb][kt][Js][Hs][20*kc][fw][sn]

AudioNav EF
Config Utility & API
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 2018. All rights reserved.
1400 Series AudioNav EF - Config Utility & API Rev 1.2 www.storm-interface.com Page 20 of 37
LED Brightness Command (02)
Host sends this message to control brightness of LEDs
Data Field
Type
Length
Description
1
LED brightness
SN
1
0 - 9
LED Brightness Command Response
Data Field
Type
Length
Description
ec
Error Code
H
2
Host Device
AudioNav
[02][lb]
[02][ec]
Note: LED brightness of 0 value indicates LEDs are off
LED brightness of 9 value indicates full brightness
Reserved (03)
Reserved (04)