Storm EZ-Key, Technical Manual

Page 1: ...ual 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 Code Tables 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 Devi...

Page 2: ...pads 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 o The Boot loader is invoked by software o An emergency hardware boot loader override switch is provided in the event of the software Boot Loader failing Keypad De bounce parameters o Optimal values for Storm keypads are set as default 20ms Beeper Command It i...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Page 21: ... 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 Key Press Beeper Enable Disable beeper 05 Load New code table Load new code table 06 Beeper Command Sound beeper 07 Keypad Type Select layout table 08 Reserved Start end a self test 09 Write to default EZkey writes configuratio...

Page 22: ...VOIP Status Response Secure device 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 Lc LED Colour SN 1 0 White Bz Beeper SN 1 0 OFF 1 ON Ky Keypad type SN 1 0 5 way 1 6 way 2 8 way Bp Beeper Period SN 1 0 9 Kt Keypad Table SN 1 0 Default Table 1 Alternate Table 2 Customised Table Kc Keycode SH...

Page 23: ...t of Keymat Technology Ltd Copyright 2015 All rights reserved EZ Key Audio Technical Manual Rev 1 Apr 2015 www storm interface com Page 23 of 35 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 EZKEY VOIP 02 lb ...

Page 24: ...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 24 of 35 Reserved 03 ...

Page 25: ...d 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 25 of 35 Key Press Beeper Command 04 Host sends this message to enable disable beeper on key presses Data Field Type Length Description 1 Beeper SN 1 0 Disable 1 Enable Beeper Command Response Data Field Type Lengt h D...

Page 26: ... Load New Table Command Response Data Field Type Lengt h Description ec Error Code H 2 Host Device EZkey_VOIP 05 lt 32 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...

Page 27: ...d 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 27 of 35 Beeper Command 06 Host sends this message to start beeper for specified duration Data Field Type Length Description 1 Duration SN 1 Value 0 9 Beeper Command Response Data Field Type Lengt h Description ec Error Code H 2 Host Device EZkey_V...

Page 28: ...y 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 28 of 35 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 L...

Page 29: ...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 29 of 35 Reserved 08 ...

Page 30: ...out 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 30 of 35 Write Config Data To Flash command 09 Host sends this command to request the EZKEY_VOIP to write the configuration data from RAM to FLASH This command has no data associated with it RAM to FLASH command Response Data Fiel...

Page 31: ...thout 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 31 of 35 Reset To Factory Default command 10 Host sends this command to request the EZKEY_VOIP to reset parameters back to factory default This command has no data associated with it Reset To Factory Default Response Data Field ...

Page 32: ...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 32 of 35 Enable BSL Command 12 Host sends this command to request the EZKEY_VOIP to start downloader Enable BSL command Response Data Field Type Lengt h Description ec Error Code H 2 H...

Page 33: ...hird 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 33 of 35 Status Beeper command 13 Host sends this message to start beeper for specified duration Data Field Type Length Description 1 Duration SN 1 Value 0 9 Status Beeper Command Response Data Field Type Lengt h De...

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

Page 35: ...sent of Keymat Technology Ltd Copyright 2015 All rights reserved EZ Key Audio Technical Manual Rev 1 Apr 2015 www storm interface com Page 35 of 35 Change History Engineering Manual Date Version Details 11 May 2015 1 0 First Release Configuration Utility Date Version Details 06 May 20115 1 0 First Release Product Firmware Date Version Details 23 Apr 15 1 0 First Release 05 May 15 2 0 Updated so th...