Storm AudioNav EF Manual Download Page 16 | Manualshive

Page: 16 / 37

background image

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

«
...
14
15
16
17
18
...
»

Summary of Contents for AudioNav EF

Page 1: ...ten 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 A...

Page 2: ...es 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 ...

Page 3: ...18 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 yo...

Page 4: ... 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 ...

Page 5: ...press 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 ...

Page 6: ...bles 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 def...

Page 7: ...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 ...

Page 8: ...played 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 sel...

Page 9: ...lity 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 Lef...

Page 10: ...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...

Page 11: ... 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...

Page 12: ...isclosed 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 d...

Page 13: ...on 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 ...

Page 14: ...formation 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 ...

Page 15: ...dioNav 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...

Page 16: ...ost 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 defaul...

Page 17: ...ontrol 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 char...

Page 18: ...ion 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 T...

Page 19: ...s 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...

Page 20: ...d 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 bright...

Page 21: ...ble Command Response Data Field Type Length Description ec Error Code H 2 Host Device AudioNav 05 lt 20 scan codes 05 ec Note Length is always 20 Format of table is as follows modifier for key 1 code for Key 1 modifier for key 2 Code for Key 2 etc The code table is specified in the user manual together with the modifier code For example to program the following for 4 way Key 1 A Key 2 a Key 3 9 Ke...

Page 22: ...terface com Page 22 of 37 Keypad Table Command 07 Host sends this message to set keypad type Data Field Type Length Description 1 Keypad Type SN 1 0 Default Table 1 Alternate Table 2 Customised Table Keypad Command Response Data Field Type Length Description ec Error Code H 2 Host Device AudioNav 07 bp 07 ec Reserved 08 Write Config Data To Flash command 09 Host sends this command to request the A...

Page 23: ...nfig Utility API Rev 1 2 www storm interface com Page 23 of 37 Reset To Factory Default command 10 Host sends this command to request the AUDIONAV to reset parameters back to factory default This command has no data associated with it Reset To Factory Default Response Data Field Type Length Description ec Error Code H 2 Host Device AUDIONAV 10 10 ec Reserved 11 Enable BSL Command 12 Host sends thi...

Page 24: ... 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 24 of 37 Set Serial Number command 14 Host sends this command to set the serial number of the device in format YYQQXXXXXXXX Data Field Type Length Description 1 Serial Number ANS 12 YYQQXXXXXXXX Set Serial Number command Response Data Field Ty...

Page 25: ...keypad Keyboard Report HID Keyboard Report Format BIT7 BIT6 BIT5 BIT4 BIT3 BIT2 BIT1 BIT0 Byte0 Right GUI Right Alt Right Sft Right Ctrl Left GUI Left Alt Left Shift Left Ctrl Byte1 Reserved Key_array 0 Key_array 1 Key_array 2 Key_array 3 Key_array 4 Key_array 5 Byte2 Byte3 Byte4 Byte5 Byte6 Byte7 For example if user has configured for Default Table If the user now presses the top key which is and...

Page 26: ...e API for the host application developers HIDAPI This is a third party library which allows an application to interface with USB HID Compliant devices on Windows Linux and Mac OS X While it can be used to communicate with standard HID devices like keyboards mice and Joysticks it is most useful with custom Vendor Defined HID devices This allows for host software to scan for the device using its VID...

Page 27: ...d 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 27 of 37 The API makes the following functions available to developers Page All Message Types 28 GetDeviceStatus 30 InitialiseStormUSBDevice 29 LoadCodeTable 32 ResetToFactoryDefault 35 SetKeypadTable 33 SetLedLe...

Page 28: ...ww storm interface com Page 28 of 37 All Message Types This is referenced in below functions enum REQUEST_TYPE message types DEVICE_STATUS 1 Device status message LED_BRIGHTNESS set led brightness RESERVED_1 MID_RESERVED_6 RESERVED_2 MID_RESERVED_6 LOAD_NEW_TABLE load new key code table RESERVED_3 MID_RESERVED_6 KEYPAD_TYPE set keypad type 0 default table 1 alternate 2 customise RESERVED_4 MID_RES...

Page 29: ...roduct PID and Manufacturer VID This are assigned to Keymat Vendor ID 0x2047 Product ID 0x09D0 On successful finding the Audio Nav the manufacturer_local will be filled with Storm Interface and product_local will be filled with AUDIO NAV If not successful both of the strings will be filled with none Parameters storm_vid Vendor ID product_pid Product ID manufacturer vendors name will be stored prod...

Page 30: ...igned char led_brightness unsigned char keypad_table unsigned char jack_status unsigned char HV_status unsigned char keyCode 20 currently keytable in use std string version std string serialNumber DEVICE_INFO _deviceInfo DEVICE_INFO sturcture that will be filled by the function timeToWait maximum time to wait for command to complete Return Value True for success False for failure brief GetDeviceSt...

Page 31: ...vel can be set with values 0 to 9 Parameters Int ledLevel timeToWait maximum time to wait for command to complete Return Value 0 for success brief SetLedLevel This function sets led brightness level from 0 to 9 where 0 is off and 9 is on param ledLevel used to set led level param _timeToWait is the time in milliseconds to wait for the data to be retrieved return 0 on success negative error code on...

Page 32: ...cluding modifier For each key the values must be modifier USB key code timeToWait maximum time to wait for command to complete Return Value 0 for success brief LoadCodeTable This function loads a new code table to customise table in AudioNav param KeyCodePtr Point to new code table param keyCodeLen length of keycode Must be 20 param _timeToWait is the time in milliseconds to wait for the data to b...

Page 33: ... alternate 2 customise Parameters Int KeypadTable 0 default 1 alternate 2 customise timeToWait maximum time to wait for command to complete Return Value 0 for success brief SetKeypadTable This function sets which table is currently used param KeyCodeTable 0 default 1 alternate 2 customise param _timeToWait is the time in milliseconds to wait for the data to be retrieved return 0 on success negativ...

Page 34: ...unction commnds the AudioNav 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 Flash param None param _timeToWait is the time in milliseconds to wait for the data to be retrieved return 0 on success negative error code on failure Possible error codes are DE...

Page 35: ...n commnds the AudioNav to reset the Audio Nav 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 default param None param _timeToWait is the time in milliseconds to wait for the data to be retrieved return 0 on success negative error code on failure Possible error codes...

Page 36: ...AudioNav EF Config Utility API Rev 1 2 www storm interface com Page 36 of 37 Workspace Click on AudioNavApi microsoft visual studio solution and the workspace will be launched The workspace has 5 projects AudioNavApi This is the API as described above Hidapi This is freeware api for low level communication with USB device TestApi This shows how the AudioNavApi is used using c Wrapper This wrapper ...

Page 37: ...d Copyright 2018 All rights reserved 1400 Series AudioNav EF Config Utility API Rev 1 2 www storm interface com Page 37 of 37 Change History Instructions for Date Version Details Config Utility API 13 Sep 19 1 0 First release split out from AudioNav tech manual 14 Dec 20 1 1 API added 06 Jan 21 1 2 Utility update Configuration Utility Date Version Details 14 Jun 19 1 0 First Release 06 Jan 21 2 0 ...

Reviews:

No comments

Related manuals for AudioNav EF

Brand: Doorentryonline Pages: 12

Brand: Nortek Security & Control Pages: 2

VP keypad controls entry

Brand: PTI security systems Pages: 40

Videofied CMA600

Brand: RSI VIDEO TECHNOLOGIES Pages: 2

Brand: DESi Pages: 20

Brand: DAS Pages: 18

Brand: Velleman Pages: 69

Brand: Velleman Pages: 32

Brand: CAME Pages: 12

Univerge SV8100

Brand: NEC Pages: 2

Equinox 41 EQ41TB-TI

Brand: Vantage Hearth Pages: 4

Brand: C&K systems Pages: 52

Brand: Kyungwoo Pages: 7

LUTRON Sivoya QED seeTouch SVQ-2WD

Brand: Vimco Pages: 8

Brand: VISUAL PLUS Pages: 8

Brand: teko Pages: 36

FreezeAlarm Dialer CNPREC001

Brand: TEMPerature Products Pages: 11

Brand: SpeedLink Pages: 28

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands