Download
Share
Print this page
  1. Manuals
  2. Brands
  3. Storm Interface Manuals
  4. Keypad
  5. NavPad ATP EZ08-22200
  6. Manual

Storm Interface NavPad ATP EZ08-22200 Manual

Hide thumbs

Advertisement

Quick Links

Download this manual
API Overview
Device Communications / Message Format
Message Definitions / Error Codes
Message Details
API Functions
Change History
The content of this communication and / or document, including but not limited to images, specifications, designs, concepts, data and
information in any format or medium is confidential and is not to be used for any purpose or disclosed to any third party without the express and
written consent of Keymat Technology Ltd. Copyright Keymat Technology Ltd. 2022 .
Storm, Storm Interface, Storm AXS, Storm ATP, Storm IXP , Storm Touchless-CX, AudioNav, AudioNav-EF and NavBar are trademarks of
Keymat Technology Ltd. All other trademarks are the property of their respective owners.
Storm Interface is a trading name of Keymat Technology Ltd
Storm Interface products include technology protected by international patents and design registration. All rights reserved
NavPad - API Rev 1.0
www.storm-interface.com
2
3
4
5
19
31
Page 1 of 31
NavPad
API

Advertisement

loading
Need help?

Need help?

Do you have a question about the NavPad ATP EZ08-22200 and is the answer not in the manual?

Questions and answers

Related Manuals for Storm Interface NavPad ATP EZ08-22200

Summary of Contents for Storm Interface NavPad ATP EZ08-22200

  • Page 1 Keymat Technology Ltd. Copyright Keymat Technology Ltd. 2022 . Storm, Storm Interface, Storm AXS, Storm ATP, Storm IXP , Storm Touchless-CX, AudioNav, AudioNav-EF and NavBar are trademarks of Keymat Technology Ltd. All other trademarks are the property of their respective owners.
  • Page 2 NavPad API for controlling the Keypad from the Host Computer This details 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. Host API Library - Overview The Host API Library is a middleware application between the host application and the NavPad.
  • Page 3 NavPad Device Communications and Message Format NAVPAD™ 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.
  • Page 4 NavPad Controlling the Keypad from the Host Computer Message Definitions and Error Codes 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.
  • Page 5 NavPad 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 Non-illuminated NavPad Illuminated NavPad LED Brightness...
  • Page 6 NavPad 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 ec Error Code Lb LED Brightness Value (0 –...
  • Page 7 NavPad LED Brightness Command (02) Host sends this message to control brightness of LEDs Data Field Type Length Description 1 LED brightness 0 - 9 LED Brightness Command Response Data Field Type Length Description ec Error Code Host Device NAVPAD™ [02][lb] [02][ec] Note: LED brightness of 0 value indicates LEDs are off...
  • Page 8 NavPad Jack LED Brightness Command (03) Host sends this message to control brightness of Jack LEDs Data Field Type Length Description 1 Jack LED brightness 0 - 9 Jack LED Brightness Command Response Data Field Type Length Description ec Error Code Host Device NAVPAD™...
  • Page 9 NavPad Key Press Beeper Command (04) Host sends this message to enable/disable beeper on key presses Data Field Type Length Description 1 Beeper 0-Disable, 1-Enable Beeper Command Response Data Field Type Length Description Error Code Host Device NavPad™ [04][bp] [04][ec] NavPad - API Rev 1.0 www.storm-interface.com Page 9 of 31...
  • Page 10 NavPad Load New Key Code Table Command (05) Host sends this message to Load New Code Table Data Field Type Length Description 1 Load New Code Table Key Code Table: Load New Table Command & Response Data Field Type Length Description ec Error Code Host Device NavPad™...
  • Page 11 NavPad Buzzer Command (06) Host sends this message to start buzzer for specified duration Data Field Type Length Description 1 Duration Value 0 - 9 Beeper Command &Response Data Field Type Length Description ec Error Code Host Device NavPad™ [06][bp] [06][ec] Buzzer duration value increments in 0.25s.
  • Page 12 NavPad Keypad Table Command (07) Host sends this message to set code table to be used. Data Field Type Length Description 1 Code Table 0 – Default Table 1 – Alternate Table 2 – Customised Table Keypad Command & Response Data Field Type Length Description ec Error Code...
  • Page 13 NavPad Reserved (08) NavPad - API Rev 1.0 www.storm-interface.com Page 13 of 31...
  • Page 14 NavPad 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 Data Field Type Length Description ec Error Code Host Device...
  • Page 15 NavPad 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 Type Length Description ec Error Code Host Device NAVPAD™...
  • Page 16 NavPad 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] [12][ec] NavPad - API Rev 1.0 www.storm-interface.com Page 16 of 31...
  • Page 17 NavPad Status Buzzer command (13) Host sends this message to start buzzer for specified duration Data Field Type Length Description 1 Duration Value 0 - 9 Status Beeper Command & Response Data Field Type Length Description ec Error Code Host Device NAVPAD™...
  • Page 18 NavPad 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 BIT6 BIT5 BIT4 BIT3 BIT2 BIT1 BIT0...
  • Page 19 NavPad The API makes the following functions available to developers All Message Types ..............................42 GetDeviceStatus ............................... 44 GetJackStatus ................................52 InitialiseStormUSBDevice ............................43 LoadCodeTable ................................ 47 ResetToFactoryDefault ............................51 SetBuzzer .................................. 46 SetBuzzerPeriod ............................... 48 SetKeypadTable ............................... 49 SetLedLevel ................................45 WriteDefaultToFlash ..............................
  • Page 20 NavPad Message Types This is referenced in below functions: REQUEST_TYPE{ // message types DEVICE_STATUS = 1, ///Device status message LED_BRIGHTNESS, //< set led brightness RESERVED_1, ///< not required for backward compatible BUZZER_ON_OFF, // Enable buzzer on/off LOAD_NEW_TABLE, //load new key code table BUZZER_PERIOD, // set buzzer on on for x ms KEYPAD_TYPE,...
  • Page 21 • 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 22 NavPad 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; unsigned char buzzer_period; unsigned char keypad_table; unsigned char keyCode[20];...
  • Page 23 NavPad SetLedLevel This function sets the brightness of the LED. The led level 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.
  • Page 24 NavPad SetBuzzer This function enables/disables the buzzer. Parameters : Int enableBuzzer timeToWait maximum time to wait for command to complete Return Value: 0 for success ///\brief SetBuzzer This function enables/disables buzzer ///\param enableBuzzer 0 - disable 1 - enable ///\param _timeToWait is the time in milliseconds to wait for the data to be retrieved.
  • Page 25 NavPad LoadCodeTable This function loads the keycode table in customise table. Parameters : Int *keyCodePtr pointer to code table must hold 20 values including 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...
  • Page 26 NavPad SetBuzzerPeriod This function sets the buzzer period from 0 (off) to 9 in increment of 0.25ms Parameters : Int buzzerPeriod Buzzer period from 0 to 9 timeToWait maximum time to wait for command to complete Return Value: 0 for success ///\brief SetBuzzerPeriod This function sets buzzer period.
  • Page 27 NavPad SetKeypadTable This function sets the current keypad code table that will be used. 0 – default, 1 – 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...
  • Page 28 NavPad 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 Flash ///\param None ///\param _timeToWait is the time in milliseconds to wait for the data to be retrieved.
  • Page 29 NavPad 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 default ///\param None ///\param _timeToWait is the time in milliseconds to wait for the data to be retrieved.
  • Page 30 NavPad GetJackStatus This function command retrieves the status of the Jack Parameters : İnt *jackStatus 0 – Jack In 1 - Jack Out timeToWait maximum time to wait for command to complete Return Value: 0 for success ///\brief GetJackStatus This function retrieves status of the JACK ///\param jackStatus ///\param _timeToWait is the time in milliseconds to wait for the data to be retrieved.
  • Page 31 NavPad Remote Up Change History Instructions for Date Version Details 15 Aug 24 First Release (split out from Tech Manual) Host API Library Date Version Details 01 Sep 15 First Release 08 Sep 17 Rolled in intermediate changes + Win 10 fix Added API command for Jack LED.

This manual is also suitable for:

Navpad atp ez08-22301Navpad atp ez08-43001