PK-1000 J1939 UM REV1.0
15
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 1 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0 PK-1000 J1939 USER MANUAL THE PRESENT MANUAL IS FOR REFERENCE ONLY AND MIGHT BE NOT UP TO DATE TO THE LATEST VERSION. PLEASE CONTACT US FOR GETTING THE MOST UPDATED FILE
Transcript of PK-1000 J1939 UM REV1.0
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 1 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
PK-1000 J1939 USER MANUAL
THE PRESENT MANUAL IS FOR REFERENCE ONLY AND MIGHT BE NOT UP TO DATE TO THE LATEST VERSION. PLEASE CONTACT US FOR GETTING THE MOST UPDATED FILE
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 2 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
Table of contents 1. How to connect Deutsch 4 pin:...........................................................................................................32. Reference.............................................................................................................................................33. Message header description...............................................................................................................44. General Data Format...........................................................................................................................45. Default settings....................................................................................................................................56. Key Contact state (01h)......................................................................................................................57. LED command (01h)............................................................................................................................68. Set LED brightness level (02h)............................................................................................................79. Set backlight level (03h).......................................................................................................................710. Set startup keys message(28h)..........................................................................................................711. Get software revision (2Ah).................................................................................................................812. Set startup LED show (34h)................................................................................................................813. Set Source Address (70h)...................................................................................................................914. Periodic state transmission (71h)......................................................................................................915. Event state transmission (72h).........................................................................................................1016. LED Acknowledgment (73h)..............................................................................................................1017. Address Claim at boot (74h).............................................................................................................1118. Heartbeat (75h).................................................................................................................................1219. Periodic Key message period (77h)..................................................................................................1320. Start Demo mode(7Ah).....................................................................................................................1321. Set backlight level at startup (7Bh)...................................................................................................1322. LED dim at startup (7Ch)...................................................................................................................1423. Set backlight color (7Dh)...................................................................................................................1424. Revision History..................................................................................................................................15
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 3 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
1. How to connect Deutsch 4 pin:
EachendoftheCANbusisterminatedwith120Ωresistorsincompliancewiththestandardtominimizesignalreflectionsonthebus.Youmayneedtoplacea120ΩresistorbetweenCAN-LandCAN-H.
2. Reference
Key: LED:
PIN COLOUR FUNCTION1 Blue CANL2 White CANH3 Black Negativebattery4 Red Vbatt.(12-24V)
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 4 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
3. Message header description The29-bitCANidentifierusedinJ1939isstructuredinthefollowingway.
Priority Reserved DataPage PDUFormat PDUSpecific SourceAddress3bits 1bit 1bit 8bits 8bits 8bitsTheproprietaryformatusedbyPKandPKPkeypadsisdefinedasfollows:
Priority=6.
Reserved=0.
Datapage=0.
PDUFormat=EFh(themessageisaddressable).
PDUSpecific=DestinationAddress.
ParameterGroupNumber(PGN)=61184(EF00h).
AnexampleofCANidentifierofmessagessenttothekeypadis18EF2100hwhere:
21histhedestinationaddress(keypad)
00histhesourceaddress.
AnexampleofCANidentifierofmessagessentbythekeypadis18EFFF21hwhere:
FFhreferstobroadcastmessages(nospecificdestinationaddress)
21histhesourceaddress(keypad).
4. General Data Format TheproprietaryprotocolhasdefinedageneralformatforthedatafieldsinthePGN61184.Theformatconsistsof:
1headerfield(2bytes)
1commandbyte
8bytes(theremainingfield)aredefinedspecificallyforeachcommand.
Thedatalengthis8bytes,unusedbitsandbytesaresettoall1’s(0xFF).
Byte0 04hByte1 1BhByte2 CommandByte3-7 Datarequiredforeachspecific
command
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 5 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
5. Default settings Setting Defaultstatusorlevel HowtochangeCANbusBaudRate 250kbit/s -SourceAddress 21h Command70hKeypadIdentifier 21h Command70hHeartbeatMessage Disable Command75hPeriodicstatetransmission
Disable Command71h
Periodictransmissionperiod
100ms Command77h
Eventstatetransmission Enable Command72hAddressclaim Disable Command74hStartupbacklight OFF Command7BhStartupLEDshow CompleteLEDSequence Command34hBacklightcolor Amber Command7DhLEDacknowledgement Disable Command73h
6. Key Contact state (01h) Thismessageissentbythekeypadtoindicatethestateofthecontacts.ThedestinationaddressissettoFFh:broadcastmessage.Seechapter2forKeynumberreference.
Byte0 04h HeaderbytesByte1 1BhByte2 01h ContactstatemessageByte3 XXh XX:KeyNumberByte4 YYh ContactState
00:SwitchOFF(Keyreleased)01:SwitchON(Keypressed)
Byte5 ZZh KeypadIdentifier(default21h)Byte6,7 FFh Notused
Examples:Direction Identifier Format Message DataFromkeypad 18EFFF21h Ext 041B01010121FFFF Key1ONFromkeypad 18EFFF21h Ext 041B01010021FFFF Key1OFFFromkeypad 18EFFF21h Ext 041B01020021FFFF Key2OFFFromkeypad 18EFFF21h Ext 041B01030121FFFF Key3ONFromkeypad 18EFFF21h Ext 041B010A0021FFFF Key10OFFFromkeypad 18EFFF21h Ext 041B01040121FFFF Key4ON
IftheEventstatetransmissionisenabled,theKeyContactstatemessageissentwhenakeyisswitched.
If the Periodic state transmission is enabled, every Periodic transmission period a KeyContactstatemessageissentforeachbuttonofthekeypad.
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 6 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
7. LED command (01h) ThismessageissenttothekeypadtosetthestateoftheLEDindicators.Seechapter2forKeyandLEDnumberreference.
Byte0 04h HeaderbytesByte1 1BhByte2 01h LEDcommandmessageByte3 XXh XX:PK1000LEDnumber
Byte4 YYh LEDColor00:off01:red02:green03:amber/orange04:yellow
Byte5 ZZh LEDState00:off01:on02:blink03:alternateblink
Byte6 WWh LEDSecondaryColor(onlyforaltblink)00:off01:red02:green03:amber/orange04:yellow
Byte7 FFh Notused
Examples:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B0101010100FF LED1redTokeypad 18EF2100h Ext 041B0101000000FF LED1offTokeypad 18EF2100h Ext 041B0102030100FF LED2amberTokeypad 18EF2100h Ext 041B0104010100FF LED4redTokeypad 18EF2100h Ext 041B0104020100FF LED4greenTokeypad 18EF2100h Ext 041B0110020200FF LED16greenblinkTokeypad 18EF2100h Ext 041B010A010302FF LED10blinksred
andgreen
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 7 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
8. Set LED brightness level (02h) ThismessagesetsthevalueoftheindicatorLEDbrightness.Thevaluecanbesetfrom0to3Fhfor0to100%oftheLEDdimmingrange.
Byte0 04h HeaderbytesByte1 1BhByte2 02h LEDbrightnesslevelmessageByte3 XXh XX:DimValue(default3Fh)
From00h(0%)to3Fh(100%)Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B0220FFFFFFFF Brightnesssetto50%
9. Set backlight level (03h) ThismessagesetsthevalueofthebacklightLEDbrightness.Thevaluecanbesetfrom0to3Fhfor0to100%ofthebrightnessrange.
Byte0 04h HeaderbytesByte1 1BhByte2 03h BacklightbrightnesslevelmessageByte3 XXh XX:Value(default00h)
From00h(0%)to3Fh(100%)Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B0310FFFFFFFF Backlightsetto25%
10. Set startup keys message(28h) Thiscommandenablesthetransmissionduringpowerupofthestateofthekeys.Byte0 04h HeaderbytesByte1 1BhByte2 28h StartupkeysmessageByte3 XXh XX:
00hDisabled(default)01hEnabled
Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B2801FFFFFF
FFEnablestartupkeysmessage
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 8 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
11. Get software revision (2Ah) Byte0 04h HeaderbytesByte1 1BhByte2 2Ah GetsoftwarerevisionByte3,7 FFh Notused
Answer:
Byte0 04h HeaderbytesByte1 1BhByte2 2Ah GetsoftwarerevisionByte3,6 XXhXXhXXhXXh SWrevisionASCIIByte7 00h NotusedExample:
Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B2AFFFFFFFFFF GetsoftwarerevisionFromKeypad 18EFFF21h Ext 041B2A56312E3000 V1.0
12. Set startup LED show (34h) Byte0 04h HeaderbytesByte1 1BhByte2 34h StartupLEDshowByte3 XXh XX:
00hOFF01hCompleteledshow(default)02hFastflash
Byte4,7 FFh NotusedExample:
Direction Identifier Format Message DataTokeypad
18EF2100h Ext 041B3400FFFFFFFF
SetStartupLEDshowOFF
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 9 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
13. Set Source Address (70h) This message is used to change the keypad CAN Source Address and/or the KeypadIdentifier. Either or both the Source Address or Keypad Identifier may be changedindependently. Connecting only one keypad to the bus when changing the keypadaddress is recommended. If an invalidvalue is chosen, thennochange isdone to thestoredvalue.
Byte0 04h HeaderbytesByte1 1BhByte2 70h SetAddressmessageByte3 XXh XX:CANSourceAddress
From01hto0FhFrom11htoF0hFFhNochange
Byte4 YYh YY:KeypadIdentifierFrom21htoFEhFFhNochange
Byte5,7 FFh Notused
Example:
Direction Identifier Format Message DataTokeypad
18EF2100h Ext 041B700521FFFFFF
SetSourceAddress=05h,SetKeypadidentifier=21h.
14. Periodic state transmission (71h) ThismessageenablesordisablestheperiodictransmissionoftheKeystate.
When enabled, one contact statemessage is periodically sent for each button of thekeypad.Forsomekeypadmodelstherecouldbeadditionalmessages(e.g. thePKP2400has8buttonbut11messagesaresent).
Theperiodissetto100msasdefaultvaluebutcanbechangedbycommand77h.
Byte0 04h HeaderbytesByte1 1BhByte2 71h PeriodicstatetransmissionmessageByte3 XXh XX:
00hDisabled(default)01hEnabled
Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B7101FFFFFF
FFEnableperiodicstatetransmission.
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 10 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
15. Event state transmission (72h) Thismessageenablesordisableseventdrivenkeystatetransmissions.Whenthisfeatureisenabled,thekeypadtransmitsthestateofacontactatthetimethatthecontactchangesstate(pressedorreleased).
Byte0 04h HeaderbytesByte1 1BhByte2 72h EventstatetransmissionByte3 XXh XX:
00hDisabled01hEnabled(default)
Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B7200FFFFFFFF Disableeventstate
transmission
16. LED Acknowledgment (73h) ThismessageenablesordisablesthetransmissionoftheLEDAcknowledgementmessage.Whenthis feature isenabledthekeypadtransmitanacknowledgementmessageeachtimeaLEDCommandisreceived.
Byte0 04h HeaderbytesByte1 1BhByte2 73h LEDAcknowledgementByte3 XXh XX:
00hDisabled(default)01hEnabled
Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B7301FFFFFFFF EnableLED
acknowledgementTokeypad 18EF2100h Ext 041B01010101FF
FFLEDCommand
Fromkeypad 18EFFF21h Ext 000101FFFFFFFFFF LEDAckmessage
LEDAcknowledgementmessage:
Byte0 00h Byte1 XXh XX:LEDstateByte2 YYh YY:LednumberByte3,7 FFh
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 11 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
17. Address Claim at boot (74h) Thismessageenablesordisablestheaddressclaimprocedure.
Byte0 04h HeaderbytesByte1 1BhByte2 74h AddressclaimatbootByte3 XXh XX:
00hDisabled(default)01hEnabled
Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B7401FFFFFFFF EnableAddressClaim
Address claiming procedure: Undernormaloperation,thekeypadapplicationsendsanAddressClaimparametergroupatstartupandwaitsupto250msfortheotherdevicesconnectedtothesamenetworktosend a message containing the device’s address and name. The keypad checks everyresponseandcomparesthenamestoseewhohasthehighestpriority.Ifadeviceisalreadyusingtheaddressandhasahigherpriority,thenanewaddressisselectedandtheprocessstartsover.Ifthekeypadhasahigherprioritythanthedeviceinusethenitwaitsforothersystemstoreply,whiletherespondingdevicewillhavetochangeitsaddressandsendanaddressclaimitself.Ifnomessageisreceivedafterthetime(250ms)isup,thenthedevicehasclaimedtheaddress.
Addressclaimparametergroup:
Priority=6.
DestinationAddressshouldalwaysbetheGlobalAddressFFh
ParameterGroupNumber(PGN)=60928(EE00h).
DataLength=8
Data=NAMEfield
Example:Direction Identifier Format Message DataFromkeypad 18EEFF21h Ext 3F426F1A00823CC0
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 12 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
18. Heartbeat (75h) ThismessageenablesordisablesthetransmissionofHeartbeatmessage.Thismessageis designedtoindicatetootherdevicesonthebusthatthisunitcontinuestofunction.
Byte0 04h HeaderbytesByte1 1BhByte2 75h HeartbeatByte3 XXh XX:
00hDisabled(default)01hEnabled
Byte4 YYh YY:Periodinmilliseconds*10From05h(50ms)toFEh(2.54sec)
Byte5,7 FFh NotusedExample:
Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B750132FFFFFF Setheartbeatenabled
with500msperiod.
Heartbeatgeneratedmessage:
Byte0 04h HeaderbytesByte1 1BhByte2 F9h HeartbeatmessageByte3 XXh XX:Messagecounter,incremented
eachmessagesentByte4 K8K7K6K5K4K3K2K1 Buttonstateindicators
Eachbitrepresentabuttonstate0:OFF1:ON
Byte5 000000000000K10K9
Byte6,7 FFh NotusedExample:
Direction Identifier Format Message DataFromkeypad 18EFFF21h Ext 041BF9030200FFFF Heartbeatmessage
withbutton2pressed.
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 13 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
19. Periodic Key message period (77h) ThismessagesetstheperiodtimefortheKeystatemessages(71h).Thisdoesnotenableordisablethemessages.
Byte0 04h HeaderbytesByte1 1BhByte2 77h PeriodickeymessageperiodByte3 XXh XX:Periodinmilliseconds*10
From05h(50ms)toFEh(2.54sec)Byte4,7 FFh NotusedExample:
Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B770AFFFFFFFF Periodsetto100ms
20. Start Demo mode(7Ah) Thismessage enables theDemomode function.Demomode is a special feature thatconsistsindifferentLEDstatesforeachbuttonpressing.Disconnectandreconnectthekeypadaftertheenablemessagetoenterthismode.
Byte0 04h HeaderbytesByte1 1BhByte2 7Ah DemomodeByte3 XXh XX:
00hDisabled(Default)01hEnabled
Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B7A01FFFFFFFF Demomode
enabled
21. Set backlight level at startup (7Bh) Thismessagesetsthevalueofthebacklightatkeypadpowerup.Thevaluecanbesetfrom0to3Fhfor0to100%ofthebrightnessrange.
Byte0 04h HeaderbytesByte1 1BhByte2 7Bh SetbacklightatstartupByte3 XXh XX:Value
From00h(0%)to3Fh(100%)Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B7B06FFFFFFFF Backlightat
startup10%
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 14 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
22. LED dim at startup (7Ch) ThismessagesetsthevalueoftheindicatorLEDbrightnessatkeypadpowerup.Thevaluecanbesetfrom0to3Fhfor0to100%oftheLEDdimmingrange.
Byte0 04h HeaderbytesByte1 1BhByte2 7Ch LEDdimatstartupByte3 XXh XX:Value
From00h(0%)to3Fh(100%)Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B7C10FFFFFF
FFLEDdimsetto25%
23. Set backlight color (7Dh) Thismessagesetsthecolorofthebacklight.
Byte0 04h HeaderbytesByte1 1BhByte2 7Dh SetbacklightcolorByte3 XXh XX:color
01:red02:green03:blue04:yellow05:cyan06:magenta07h:white/lightblue08h:amber/orange09h:yellow/green
Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataTokeypad 18EF2100h Ext 041B7D02FFFFFFFF Setbacklightcolorto
green
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 15 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] PK-1000_J1939_UM_REV1.0
24. Revision History
Date Manual Revision
Comment Related SW version
Related HW version
03/02/2017 1.0 FirstRelease SW1.6J PK1000HW-V03
