KEYBOX J1939UM REV1 - NetSuite
Transcript of KEYBOX J1939UM REV1 - NetSuite
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 1 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] KEYBOX_J1939_UM_REV1.2
KEYBOX J1939UM_REV1.2
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] KEYBOX_J1939_UM_REV1.2
Table of contents 1. Cinch Connector 30 pin: ......................................................................................................................................................... 3
2. Message header description ............................................................................................................................................... 4
3. General Data Format ............................................................................................................................................................... 4
4. Default Settings .......................................................................................................................................................................... 5
5. Single contact command (01h) .......................................................................................................................................... 5
6. Multiple contact command (02h) ...................................................................................................................................... 6
7. Get software revision (2Ah) .................................................................................................................................................. 6
8. Baud rate setting (6Fh) ........................................................................................................................................................... 7
9. Set Source address (70h) ..................................................................................................................................................... 7
10. Contact status acknowledgment (73h) ........................................................................................................................... 8
11. Heartbeat TX (75h) .................................................................................................................................................................. 9
12. Heartbeat RX (76h) ............................................................................................................................................................... 10
13. Set CAN protocol .................................................................................................................................................................... 11
14. Revision history ........................................................................................................................................................................ 11
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 3 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] KEYBOX_J1939_UM_REV1.2
1. Cinch Connector 30 pin:
Output Pin
Battery Positive E1
Battery Ground F3
RS485 bus D2
RS485 bus E2
Contact1 C1, D1
Contact2 C2, C3
Contact3 H1, H2
Contact4 G2, H3
Contact5 D3, E3
Contact6 J1, K1
Contact7 J2, K2
Contact8 J3, K3
Contact9 A1, B1
Contact10 A2, B2
Contact11 A3, B3
Contact12 F2, G3
CAN H F1
CAN L G1
Pin Out – Harness Connector CINCH 5810130029:
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 4 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] KEYBOX_J1939_UM_REV1.2
2. Message header description The29-bitCANidentifierusedinJ1939isstructuredinthefollowingway.Priority Reserved DataPage PDUFormat PDUSpecific SourceAddress
3bits 1bit 1bit 8bits 8bits 8bits
Theproprietaryformatusedbykeyboxisdefinedasfollows:Priority=6.Reserved=0.Datapage=0.PDUFormat=EFh(themessageisaddressable).PDUSpecific=DestinationAddress.ParameterGroupNumber(PGN)=61184(EF00h).AnexampleofCANidentifierofmessagessenttothekeyboxis18EF2100hwhere:21histhedestinationaddress(keybox)00histhesourceaddress.AnexampleofCANidentifierofmessagessentbythekeyboxis18EFFF21hwhere:FFhreferstobroadcastmessages(nospecificdestinationaddress)21histhesourceaddress(keybox).
3. General Data Format
TheproprietaryprotocolhasdefinedageneralformatforthedatafieldsinthePGN61184.Theformatconsistsof:1headerfield(2bytes)1commandbyte8bytes(theremainingfield)aredefinedspecificallyforeachcommand.Thedatalengthis8bytes,unusedbitsandbytesaresettoall1’s(0xFF).
Byte0 04h
Byte1 1Bh
Byte2 Command
Byte3-7 Datarequiredforeachspecificcommand
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 5 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] KEYBOX_J1939_UM_REV1.2
4. Default Settings
Setting Defaultstatusorlevel HowtochangeBaudrate 250kbit/s Command6FhSourceaddress 21h Command70hKeyboxidentifier 21h Command70hHeartbeatTX Disable Command75hHeartbeatRX Disable Command76hContactacknowledgment
Disable Command73h
5. Single contact command (01h) Thismessageissenttothekeyboxtosetthestatusofeachoutputpin.
Byte0 04h HeaderbytesByte1 1BhByte2 01h Singlecontactoutput
messageByte3 XXh XX:Contactnumber
01h:contact102h:contact203h:contact304h:contact405h:contact506h:contact607h:contact708h:contact809h:contact90Ah:contact100Bh:contact110Ch:contact12
Byte4 YYh Contactstatus00h:OFF01h:ON
Byte5,6,7 FFh Notused
Examples:Direction Identifier Format Message DataToKeybox 18EF2100h Ext 041B010101FFFFFF Contact1ONToKeybox 18EF2100h Ext 041B010100FFFFFF Contact1OFFToKeybox 18EF2100h Ext 041B010601FFFFFF Contact6ONToKeybox 18EF2100h Ext 041B010600FFFFFF Contact6OFFToKeybox 18EF2100h Ext 041B010A01FFFFFF Contact100NToKeybox 18EF2100h Ext 041B010C00FFFFFF Contact12OFF
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 6 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] KEYBOX_J1939_UM_REV1.2
6. Multiple contact command (02h) Thismessageissenttothekeyboxtosetthestatusofoneormoreoutputpinsatthesametime.
Byte0 04h HeaderbytesByte1 1BhByte2 02h MultiplecontactoutputmessageByte3 K8K7K6K5K4K3K2K1 ‘1’=setON;‘0’=setOFFByte4 0000K12K11K10K9 ‘1’=setON;‘0’=setOFFByte5,6,7
00h Notused
Example
Direction Identifier Format Message DataToKeybox
18EF2100h Ext 041B020100000000
Setcontact1ON.AlltheotheroutputsOFF
ToKeybox
18EF2100h Ext 041B02C003000000
Setcontacts10,9,8,and7ON.AlltheotheroutputsOFF
ToKeybox
18EF2100h Ext 041B023F00000000
Setcontacts1,2,3,4,5,6ON.AlltheotheroutputsOFF
7. Get software revision (2Ah)
Byte0 04h HeaderbytesByte1 1BhByte2 2Ah GetsoftwarerevisionByte3,7 FFh Notused
Answer:
Byte0 04h HeaderbytesByte1 1BhByte2 2Ah GetsoftwarerevisionByte3,6 XXhXXhXXhXXh SWrevisionASCIIByte7 00h Notused
Example:
Direction Identifier Format Message DataToKeybox 18EF2100h Ext 041B2AFFFFFFFF
FFGetsoftwarerevision
FromKeybox 18EFFF21h Ext 041B2A56362E3000
V6.0
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 7 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] KEYBOX_J1939_UM_REV1.2
8. Baud rate setting (6Fh) ThismessageisusedtochangethebaudrateoftheCANbus.Connectingonlyonekeyboxtothebuswhenchangingthebaudrateisrecommended.Ifaninvalidvalueischosen,thennochangeisdonetothestoredvalue.
Example:
Direction Identifier Format Message DataToKeybox
18EF2100h Ext 041B6F02FFFFFFFF Setbaudrate=500kbit/s
9. Set Source address (70h) ThismessageisusedtochangethekeyboxCANsourceAddressand/orthekeyboxidentifier.EitherorboththeSourceAddressorkeyboxidentifiermaybechangedindependently.Connectingonlyonekeyboxtothebusduringtheaddresschangeisrecommended.Ifaninvalidvalueischosen,thennochangeisdonetothestoredvalue.Byte0 04h HeaderbytesByte1 1BhByte2 70h SetaddressmessageByte3 XXh XX:CANsourceaddress
From01htoFEhFFh:nochange
Byte4 YYh YY:keyboxidentifierFrom00htoFEhFFhnochange
Byte5,7 FFh Notused Example
Byte0 04h HeaderbytesByte1 1BhByte2 6Fh SetbaudratemessageByte3 02h 500kbit/s
03h 250kbit/s
Byte4,7 FFh Notused
Direction Identifier Format Message DataToKeybox
18EF2100h Ext 041B700521FFFFFF
Setsourceaddress=05hSetkeyboxidentifier=21h
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 8 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] KEYBOX_J1939_UM_REV1.2
10. Contact status acknowledgment (73h) Thismessageenablesordisablesthetransmissionofthecontactacknowledgmentmessage.Whenthisfeatureisenabledthekeyboxtransmitsanacknowledgmentmessageeachtimeacontactcommandisreceived.Note:availableonlyforthesinglecontactcommand(01h)
Byte0 04h HeaderbytesByte1 1BhByte2 73h ContactacknowledgmentByte3
XXh
XX:00hOFF(default)01hON
Byte4,7 FFh Notused
Example:Direction Identifier Format Message DataToKeybox 18EF2100h Ext 041B7301FFFFFF
FFEnablecontactacknowledgement
ToKeybox 18EF2100h Ext 041B010A01000000
Singlecontactcommand(01h)
FromKeybox 18EFFF21h Ext 00010AFFFF21FFFF
contactAckmessage(contact10active)
Contactacknowledgmentmessage:
Byte0 00h Byte1 XXh XX:ContactstatusByte2 YYh YY:ContactnumberByte5 ZZh KeyboxidentifierByte3,4,6,7 FFh Notused
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 9 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] KEYBOX_J1939_UM_REV1.2
11. Heartbeat TX (75h) ThismessageenablesordisablesthetransmissionofHeartbeatmessage.Thismessageisdesignedtoindicatetootherdevicesonthebusthatthisunitcontinuestowork.NOTE:When enabled if it is set a period value out of range, this parameter remainsunchanged.Byte0 04h HeaderbytesByte1 1BhByte2 75h HeartbeatTXByte3
XXh
XX:00hDisabled(default)01hEnabled
Byte4 YYh YY:Periodinmilliseconds÷10From05h(50ms)toFEh(2.54sec)
Byte5,7 FFh Notused
Example:Direction Identifier Format Message DataToKeybox
18EF2100h Ext 041B750132FFFFFF
Setheartbeatmessagetransmissioneach500milliseconds
HeartbeatTXgeneratedmessage:Byte0 04h HeaderbytesByte1 1BhByte2 F9h HeartbeatmessageByte3 XXh XX:Messagecounter,incremented
eachmessagesentByte4 K8K7K6K5K4K3K2K1 Contactstateindicators
Eachbitrepresentsacontactstatus0:OFF1:ON
Byte5 00000000K12K11K10K9
Byte6,7 FFh Notused
Example:Direction Identifier Format Message DataFromKeybox
18EFFF21h Ext 041BF90380000000
Heartbeatmessagewithcontact8active.
FromKeybox
18EFFF21h Ext 041BF90300080000
Heartbeatmessagewithcontact12active
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 10 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] KEYBOX_J1939_UM_REV1.2
12. Heartbeat RX (76h) This command is used to determine that CAN communication is active by monitoring at apredefinedtime interval thereceptionof theheartbeatmessagefromthemasterdevice. If forwhatever reason this periodic message is not transmitted anymore, the keybox goes intocommunicationfailureandalltheoutputswillbeturnedoff.ThefollowingtabledetailshowtosetthemonitoringtimeandtheCANmasteridentifierparameters(PRIORITYandPGN).NOTE:theheartbeatRXtimeshouldbegreaterthantherelatedtransmissiontimecomingfromtheproducer.NOTE2:thecommandisarrangedtoreceiveheartbeatsignalstransmittedtoaspecificdestinationortoalldevicesconnectedonthebus(BROADCAST).
Byte0 04h HeaderbytesByte1 1BhByte2 76h HeartbeatRXByte3 RRh RR:Priorityusedbythemasterdevice
00h-1FhByte4 SSh SS:00h-FFh(PGNvalueLSByte)Byte5 TTh TT:00h-FFh(PGNvalueMSByte)Byte6 YYh YY:HeartbeatRXtimeinmillisecondsLSByteByte7 XXh XX:HeartbeatRXtimeinmillisecondsMSByte
Heartbeattime:XXYYh(from000AhtoFEFFh:from10to65279milliseconds). Whentheperiodissetto0000h,thefeatureisdisabled. NOTE3:Ifitissetatimevalueoutofrange,thisparameterremainsunchanged.
Example1:
If themasterdevicepriority=0x18h;PGN=0xEFFFh;PDUSPECIFIC=0x21h (addressed to thekeybox 0x21h); heartbeat message transmitted each 400 milliseconds; then CAN identifier is0x18EF21FFhandthecommandshouldbesetasshowninthetablebelow:
Direction Identifier Format Message DataToKeybox 18EF2100h Ext 041B7618FFEFF4
01Monitoringtimesetto500milliseconds
FromMaster
18EF21FFh Ext - Messagetransmittedeach400milliseconds
Example2:If themaster devicepriority = 0x1Fh; PGN=0xAB15h; PDUSPECIFIC = 0xFFh (addressed to alldevices-BROADCAST);heartbeatmessagetransmittedeach900milliseconds;thenCANidentifieris0x1FABFF15handthecommandshouldbesetasshowninthetablebelow:
Direction Identifier Format Message DataToKeybox 18EF2100h Ext 041B761F15ABE8
03Monitoringtimesetto1s
FromMaster
1FABFF15h Ext - Messagetransmittedeach900milliseconds
Via Montefeltro, 6 – 20156 Milano (MI) – Italy - 11 - Tel. +39 (02) 3088583 – Fax +39 (02) 33406697 www.blinkmarine.com – [email protected] KEYBOX_J1939_UM_REV1.2
13. Set CAN protocol ThissetofmessagesareusedtochangetothedesiredCANbusprotocol.
• ChangefromCANopentoJ1939:
Direction Identifier Format Message DataToKeybox 615h Std 2FFF2000
01ChangetoJ1939
• ChangefromJ1939toCANopen:
Direction Identifier Format Message DataToKeybox
18EF2100h Ext 041B8000FFFFFFFF
ChangetoCANopen
14. Revision history
Date ManualRevision
Comment RelatedSWversion
06/03/2018 1.0 FirstreleaseKeyboxJ1939 Swx.x05/02/2019 1.1 Secondrelease:
DeletedCANopenmessagesstructuretableSwx.x
21/02/2019 1.2 Thirdrelease:AddedheartbeatRXcommand(76h)
Swx.x