POWERKEY PRO & POWERKEY

Transcription

1 POWERKEY PRO & POWERKEY J1939 PROGRAMMERS MANUAL

2 Contents WARNING... 4 Introduction... 5 Keypad Functionality... 5 Default Configuration... 5 Programming Protocol... 5 Group Function Definitions 7 Keypad Contact Status/Led Command (0x01)... 7 Dim Level (0x02)... 8 Back Light Level (0x03)... 8 Set ECU Source Address (0x70)... 8 Periodic Status Transmission (0x71)... 9 Event Status Transmission (0x72)... 9 LED Acknowledgement (0x73)... 9 Address Claim (0x74) Heartbeat (0x75) Heart Beat Message Format Periodic Key Message Period (0x77) Start Demo Mode (0x7A) Set Backlight Startup (0x7B) Set Led Dim Startup (0x7C) Enter Boot Mode (0XF0) Configuration Tool Commands...14 Basic Command Structure...14 CAN ID Used For Commands from the Configuration Software Command Message Data Descriptions Continuation Frames Data Time between main command and continuation frames must be greater than 1ms but not more than 5ms. This also is the time between continuation frames Keypad Response Structure CAN ID Used For Keypad Responses Keypad Response Data Bytes Continuation of response frames data Configuration Commands Set Periodic transmission

3 Get Periodic transmission Set maximum power value Get maximum power value Set Virtual key values Get Virtual Key Values Set Virtual LED Values Get Virtual LED Values Get Model ID Configuration Commands Continuation Set LED Reply Get LED Reply Set CAN and RS485 Address Get CAN and RS485 Address Set Event Key Status Enable Get Event Key Status Enable Configuration Commands Continuation Set Default Dim Level Get Default Dim Level Set Backlight Level Get Backlight Level Get Number of LEDS Configuration Commands Continuation Get LED States Get Number of Switches Get Serial Number Set Startup Keys Message Get Startup Keys Message Get Software Revision Set CAN Address Get CAN Address Revision Record

4 WARNING IMPROPER SELECTION, IMPROPER USE AND/OR FAILURE OF THE POWERKEY PRO PRODUCTS DESCRIBED HEREIN OR RELATED ITEMS CAN CAUSE DEATH, PERSONAL INJURY AND PROPERTY DAMAGE. This document and other information from Digital Switching Systems, LLC, provide product and/or system options for further investigation by users having technical expertise. It is important to analyze all aspects of the application, including consequences of any failure. Due to the variety of operating conditions and applications for these product(s), the manufacturer of the application is solely responsible for making the final selection of the product(s) and system(s) and assuring that all performance, safety and warning requirements of the application are met. The products described herein, including without limitation, product features, specifications, designs, availability and pricing, are subject to change by Digital Switching Systems, LLC at any time without notice. 04

5 INTRODUCTION This document describes the PowerKey Pro (PKP) keypad s functionalility, default configuration and programmable parameters. KEYPAD FUNCTIONALITY The PowerKey Pro is a microcontroller based momentary contact keypad with LED illumination that can be interfaced to CAN and RS485 networks. Keypad contact closures are monitored by the microcontroller and their occurrence is transmitted on the CAN and/or RS485 interface. LED illumination states are received over the CAN and/or RS485 interface by the microcontroller, which then illuminates the LEDs accordingly. DEFAULT CONFIGURATION The PowerKey Pro keypad s default configuration is as follows: The keypad s amber LEDs flash instantenously at power-up The contact type is set to momentary The Green and Red indicator LEDs are set to OFF Back lighting is set to off The CAN source address is set to 0x21 The Keypad Identifier is set to 0x21 Periodic Status Transmission is disabled Event Status Transmission is enabled LED Acknowledgement is disabled Address Claim Transmission is disabled Demo Mode is disabled PROGRAMMING PROTOCOL Parameter group numbers (PGNs) and group functions are used to control/command the PowerKey Pro keypad. The following sections define the proprietary format used by Digital Switching Systems (DSS) for NMEA 2000 Addressable Proprietary Single Frame (SF) parameter group (PGN 61184), as well as the assigned group functions/commands. 05

6 Proprietary Single Frame Parameter Group PGN is defined by both J1939 and NMEA This parameter group number (PGN) is also known in J1939 as Proprietary A. DSS has defined this parameter group as a group function type of parameter group. A Group function parameter group uses an enumerated Group Function field to identify the purpose of the parameter group. Typically, the remaining fields in the parameter group following the group function field are defined specifically for that group function. The general format of the parameter group definition is shown below. DSS Proprietary SF Group Function (PGN 61184) (Based on NMEA 2000 Proprietary SF A General Message Format) This proprietary message is defined as a group function with a maximum available payload of 5 bytes # Field Name Size Description 1 Manufacturer Code 11 bits Field 1-3 make up the Definer Tag that ensures the definition of 2 Reserved 2 bits (each bit set to logical 1 ) 3 Industry Group 3 bits Marine = 4 4 Group Function 1 byte See Assigned Group Function Codes TBD TBD TBD Allocated/defined in accordance with group function code TBD TBD TBD (for a total of 5 bytes) The first three bytes of the parameter group are always encoded as shown in the following diagram. This diagram illustrates one aspect of CAN data transmissions that is frequently misunderstood. CAN data bytes are transmitted LSB first, and fields are defined according to the bit order defined by transmission. For fields that overlap byte boundaries, the higher order bits are mapped into the lower bits of the next byte before the next field is mapped / transmitted. As Transmitted As Returned in Data Bytes Byte 1 Byte 2 Byte MSB LSB MSB LSB MSB LSB Manufacturer Code Reserved Industry Group Group Function On each receipt of the PGN 61184, the receiving keypad first tests to see if the Destination address in the CANId matches the keypad s own address, and to see if the Definer Tag in the first two data bytes matches the DSS manufacturer and industry code. The third byte of each frame is the group function byte used to determine the format and use of any remaining data bytes. 06

7 GROUP FUNCTION DEFINITIONS This section contains data format definitions for assigned group functions defined for the DSS Proprietary SF Parameter Group (PGN 61184). Field numbers may not directly map to byte positions. Unused bits and bytes are set to all 1 s (0xFF). Keypad Contact Status/Led Command (0x01) This group function is used to send contact status from or receive LED commands by a keypad. The group function is defined differently depending on whether it is sent from or received by a keypad ECU. Contact Status: Broadcast with Destination Address = 255 from a Source Address assigned to a keypad. LED Command: Addressed to a specific keypad Destination Address. # Byte # Field Name Size Description 4 2 Group Function 1 byte Keypad Contact Status/LED Command = 0x01 Remaining Field Defined Only When Transmitted From A Keypad ECU Source Address (Keypad Transmit) 5 3 Key Code/ID 1 byte Contact Identifier For Red LED Key Code = Key Number For Green LED Key Code = Key Number + n (where n = total number of keys on keypad) Example: PKP2400 has 8 keys, therefore n = 8. The Key Code for Key #3 is 0x03 for the Red LED And 0x0B for the Green LED. 6 4 Contact State 1 byte 0x00 = [Turn off, Disable, Reset] 0x01 = [Turn on, Enable, Set] 0x02 = [Blink RED] 7 5 Keypad Identifier 1-byte Valid range 0x21 to 0x2F 8 6 Contact Process Type 1-byte 0x01 = Momentary 07

8 Dim Level (0x02) This group function transmits the desired LED illumination level when on. The illumination level is given as an integer value from 0 no illumination, to 64 full illumination. Transmitted level applies to all LEDs. 4 2 Group Function 1 byte Dim Level = 0x LED Brightness 1 byte Valid range 0 to 64 Back Light Level (0x03) This group function transmits the desired LED back lighting level when on. The back lighting level is given as an integer value from 0 no back lighting, to 64 full back lighting. Transmitted level applies to all LEDs. 4 2 Group Function 1 byte Back light Level = 0x LED Brightness 1 byte Valid range 0 to 64 Set ECU Source Address (0x70) This group function is used to change the ECU CAN Source Address and/or keypad identifier. Either or both the Source Address or Keypad Identifier may be changed independently. It is required that only the one keypad be connected to the Bus when changing the keypad address. 4 2 Group Function 1 byte Set ECU Source Address = 0x CAN Source Address 1 byte Valid range 0 to 252 Values 253 and 254 reserved Value 255 = No change. 6 4 Keypad Identifier 1 byte Valid range 0x21 to 0x2F Value =0xFF = No change 08

9 Periodic Status Transmission (0x71) This group function enables or disables periodic ECU status transmissions at a rate of 10 messages per second. For example, a keypad may transmit the status of all contacts periodically; this enables or disables that feature. 4 2 Group Function 1 byte Configuration Periodic Status Transmission = 0x Periodic Status Transmission Flag 1 byte 0x00 = [Off, Disabled, Reset] 0x01 = [On, Enabled, Set] Event Status Transmission (0x72) This group function enables or disables event driven ECU status transmissions. For example, a keypad may transmit the status of a contact at the time that the contact changes state (opens or closes); this enables or disables that feature. 4 2 Group Function 1 byte Configuration Event Status Transmission = 0x Event Status Transmission 1 byte 0x00 = [Off, Disabled, Reset] 0x01 = [On, Enabled, Set] LED Acknowledgement (0x73) This group function enables or disables the transmission of an LED Acknowledgement. For example, a keypad may transmit an acknowledgement each time an LED Command is received; this enables or disables that feature. 4 2 Group Function 1 byte Configuration LED Acknowledgement = 0x LED Acknowledge 1 byte 0x00 = [Off, Disabled, Reset] 0x01 = [On, Enabled, Set] 09

10 Address Claim (0x74) This group function enables or disables the CAN Address claim when the keypad boots up 4 2 Group Function 1 byte Configuration Address Claim = 0x Address Claim 1 byte 0x00 = [Off, Disabled, Reset] 0x01 = [On, Enabled, Set] Heartbeat (0x75) This group function enables or disables the transmission of Heartbeat message. This message is transmitted 10 times per second. It is designed to indicate to other devises on the bus that this unit continues to function. 4 2 Group Function 1 byte Configuration Heartbeat = 0x Enable Bit 1 Byte Enables or Disables the Heart Beat 0 = Disable 1 = Enable 6 4 Heart Beat Period in 10ms tics 1 Byte Sets the Heartbeat Period time is in 10ms tics. With a range from 100ms to 2.55 seconds Heart Beat Message Format 4 2 Group Function 1 byte Heart Beat = 0xF9 5 3 Toggle Bit 1 Byte Bit Toggles [0/1] every message sent; used to indicate new message 10

11 Periodic Key Message Period (0x77) This group function sets the period time for the Key status messages. This does not enable or disable the keys periodic status messages. 4 2 Group Function 1 byte Configuration Message Period = 0x Key Status Period (10ms ticks) 1 byte This contains the period value in 10ms tics. Minimum value is 10 (100ms); maximum is 255 ( 2.55 sec) Start Demo Mode (0x7A) This group function puts the keypad into a demo mode. The key pad reverts back to normal once a valid CAN message is received. 4 2 Group Function 1 byte Configuration Demo Mode = 0x7A 5 3 Demo Mode 1 byte 0x00 = [Off, Disabled, Reset] 0x01 = [On, Enabled, Set] Set Backlight Startup (0x7B) This group function sets the value of the backlight when the system resets. The value is 0 63 for 0 to 100% of the backlight range. 4 2 Group Function 1 byte Configuration Set Backlight = 0x7B 5 3 LED Brightness 1 byte Valid range 0 to 64 11

12 Set Led Dim Startup (0x7C) This group function sets the value of the LED Dim when the system resets. The value is 0 63 for 0 to 100% of the LED DIM range. 4 2 Group Function 1 byte Configuration Set Dim Level = 0x7C 5 3 LED Brightness 1 byte Valid range 0 to 64 12

13 Enter Boot Mode (0XF0) This group function places the keypad into boot mode which allows keypad to be programmed. 4 2 Group Function 1 byte Boot Loader Command = 0xF0 13

14 CONFIGURATION TOOL COMMANDS The command used by the configuration tool has CAN message definitions different from previous allowing for more powerful commands. This is allowed due to the fact that the keypad is the only device connected on the CAN buss during setup and no other device will be effected by commands. This also allows room for future changes without effecting existing messages during normal operation. BASIC COMMAND STRUCTURE The basic commands consist of the command sent by the configuration software and the keypad responses with either acknowledge or requested data. Commands can be of multiple frames commands with data lengths that cannot fit into a single CAN message. 0x18EF1000 Byte Number CAN ID Used For Commands from the Configuration Software This indicates a message from the master configuration software (0x00) to the keypads command device (0x10) Description Command Message Data Descriptions 0 Command Byte allows up to 239 commands (0x10 0xFF) 1 Number of frames to follow. Zero indicates single frame command 2-7 Command related data Continuation Frames Data Time between main command and continuation frames must be greater than 1ms but not more than 5ms. This also is the time between continuation frames. 0 Indicates frame count first frame is 1 etc. 1-7 Contains command data for this frame 14

15 0x18EF0010 Byte Number KEYPAD RESPONSE STRUCTURE CAN ID Used For Keypad Responses. Indicates a message from the keypad command device (0x10) to The configuration software (00) Description Keypad Response Data Bytes 0 Echo s the requested command 1 Number of frames to follow. Zero indicates single frame response. 2 Response Status. 0x06 Command accepted 0x01 Command not understood 0x02 Command data out of range 0x03 Command not used in this model 0x15 Command not accepted due to command rules 3-7 Data returned that is requested by command Continuation of response frames data 0 Indicates frame count first frame is 1 etc. 1-7 Contains Response data for this frame 15

16 Command Byte 0x10 0x11 0x12 0x13 0x14 0x15 0x16 0x17 0x19 Configuration Commands Description Set Periodic transmission Data 0 = Enable/Disable Individual key status periodic transmission Data 1 = Enable/Disable Heart beat periodic transmission Data 2 = Period between Key status ( time in 10ms slices 100ms to 2.55 seconds) Data 3 = Period between heart beat ( time in 10ms slices 100ms to 2.55 seconds) Get Periodic transmission Data 0 = Enable/Disable Individual key status periodic transmission Data 1 = Enable/Disable Heart beat periodic transmission Data 2 = Time period between Key status ( time in 10ms slices max 2.55 seconds) Data 3 = Time period between heart beat ( time in 10ms slices max 2.55 seconds) Set maximum power value Data 0 = Power in percentage of maximum. Range 0-100% Get maximum power value Data 0 = Power in percentage of maximum. Range 0-100% Set Virtual key values Keys are set in 4 bytes Byte 0 Key Code (Virtual Number) Byte 1 Key Type ( Momentary or Latching) Byte 2 Logic Sense ( 0 or 1 for contact closed ) Byte 3 Actual Key Number Keys are set one at a time. Get Virtual Key Values This requests all the virtual key settings for the keypad. (Using above Command Structure) Set Virtual LED Values LEDS are in sets of 2 Bytes Byte 0 Led Code (Virtual Number) Byte 1 Actual LED Number Get Virtual LED Values This requests all the virtual LED settings for the keypad. Get Model ID Returns the stored Model ID as a string of 16 bytes. 16

17 Command Byte 0x1A 0x1B 0x1C 0x1D 0x1E 0x1F Configuration Commands Continuation Description Set LED Reply Enables / Disables CAN acknowledge message after LED command Byte 0 0 = Disable, 1 = Enable Get LED Reply Returns the present state of the Reply setting Byte 0 0 = Disable, 1 = Enable Set CAN and RS485 Address Sets the keyboard address used in CAN and RS485 Byte 0 = CAN Address Byte 1 = RS485 Address Get CAN and RS485 Address Returns the present address of the CAN and RS485 Byte 0 = CAN Address Byte 1 = RS485 Address Set Event Key Status Enable Sets whether Key change event triggers CAN Message Byte 0 0 = Disable, 1 = Enable Byte 1 = Periodic Status Byte 2 = Periodic Period Get Event Key Status Enable Sets state of whether Key change event triggers CAN Message Byte 0 0 = Disable, 1 = Enable Byte 1 = Periodic Status Byte 2 = Periodic Period 17

18 Command Byte 0x20 0x21 0x22 0x23 0x24 Configuration Commands Continuation Description Set Default Dim Level This sets the DIM level default values Valid numbers must be 0-63 Byte(0) = Present Dim Level Byte(1)= Startup DIM Level Get Default Dim Level This returns the present Default DIM Level Byte(0) = Present Dim Level Byte(1) = Default Dim Level Set Backlight Level Sets the backlight level LEDs Valid Number must be 0-62 Byte(0) = LED Backlight Level Byte(1)= LED Backlight Startup Level Get Backlight Level Gets the stored backlight Level Byte(0) = LED Backlight Level Byte(1) = LED Backlight Startup Level Get Number of LEDS Gets the total number of LEDS Byte = Number of LEDS 18

19 Command Byte 0x25 0x26 0x27 0x28 0x29 0x2A 0x2B 0x2C Configuration Commands Continuation Description Get LED States Returns the present LED State for each LED 0 = OFF, 1 = ON, 2 = Blink OFF, 3 = Blink On Each data byte contains 4 LED states each occupies Two bits. MSB contains lowest LED. Get Number of Switches Gets the total Number of Switches Byte(0) = Number of switches Get Serial Number Returns Binary value of key boards SN Returns 0xFFFFFF if not set. Byte(0) = MSB (0x??XXXX) Byte(1) = (0xXX??XX) Byte(2) = (0xXXXX??) Set Startup Keys Message This command enables/disables the sending of all the keys during power up. The Enable / Disable is sent in Byte (0) Get Startup Keys Message This command returns the setting of the startup message enable. Byte(0) = 0; Disabled Byte(0) = 1; Enabled Get Software Revision This command retrieves the Firmware revision, The value is returned in three bytes Byte(0) = Major Revision Byte(1) = Minor Revision Byte(2) = Sub Minor Revision Set CAN Address This command sets the CAN address of the device. Available range is 1 to 15. And corresponds to actual addresses of 0x21 to 0x2F Get CAN Address This command retrieves the CAN address of the connected key pad. Valid range of 0x21 to 0x2F 19

20 Revision Record Date Rev Filename Comment A PowerKey Pro Programmers Manual Initial Release B PowerKey Pro Programmers Manual Modified Table, page C PowerKey Pro Programmers Manual REVC Updated Paragraph 2, page D PowerKey Pro Programmers Manual REVD Corrected Errors and updated for REV-C software release _6 PowerKey Pro Programmers Manual REV5_6 Added additional capabilities for new PKP platform, including the new PKP2200 keypad. 20