Hatteland JH 19T14 MMC User Manual

TECHNICAL
MANUAL
Serial Communication Control Interface (SCOM)
Applies for Series 1 Maritime Multi Display (MMD) product range:
JH 15T1x xxD-xxx-xxxx JH 19T1x xxD-xxx-xxxx JH 20T1x xxD-xxx-xxxx JH 22T1x xxD-xxx-xxxx JH 23T1x xxD-xxx-xxxx JH 26T1x xxD-xxx-xxxx JH 27T1x xxD-xxx-xxxx
Applies for Series 1 Maritime Multi Computer (MMC) product range:
JH 15T1x xxC-xxx-xxxx JH 19T1x xxC-xxx-xxxx
Technical Manual SCOM MMD Series 1
Updated: 23 Sep 2013 Doc Id: INB100018-3 (Rev 7)
Please visit www.hatteland-display.com for the latest electronic version of this manual.
Hatteland Display AS, Åmsosen, N-5578 Nedre Vats, Norway
Tel: (+47) 4814 2200 - mail@hatteland-display.com - www.hatteland-display.com
Copyright © 2013 Hatteland Display AS
Aamsosen, N-5578 Nedre Vats, Norway.
All rights are reserved by Hatteland Display AS. This information may not, in whole or in part, be
copied, photocopied, reproduced, translated or reduced to any electronic medium or machine-
readable form without the prior written consent of Hatteland Display AS. Review also:
www.hatteland-display.com/pdf/misc/doc100703-1_permission_to_create_user_manuals.pdf
The products described, or referenced, herein are copyrighted to the respective owners.
The products may not be copied or duplicated in any way. This documentation contains proprietary
information that is not to be disclosed to persons outside the user’s company without prior written consent
of Hatteland Display AS.
The copyright notice appearing above is included to provide statutory protection in the event of
unauthorized or unintentional public disclosure.
All other product names or trademarks are properties of their respective owners !
WARNING: This is a class A product. In a domestic environment this product may cause radio interference
in which case the user may be required to take adequate measures.
Last revised 9 Nov 2012
Contents
Contents .................................................................................... 3
Introduction .........................................................................................5
Serial Interface Conguration ....................................................................... 5
Cables ........................................................................................................... 5
Electrical Interface ........................................................................................ 5
Pinout Assignments ...................................................................................... 6
Block Diagram ............................................................................................... 7
Data Rates .................................................................................................... 8
Data Format Serial Mode .............................................................................. 8
Message Format ........................................................................................... 8
Attention (ATTN) .......................................................................................... 8
Address (ADDR) ........................................................................................... 8
Message Commands and Queries (CMD) Contents .................................... 9
Data Length (LEN) ...................................................................................... 10
Inverse Header Checksum (IHCHK) ........................................................... 10
Data Field (DATA) ....................................................................................... 10
Inverse Data Checksum (IDCHK) ............................................................... 10
“BRT” - User Brightness Control ................................................................. 11
“BZZ” - Buzzer Control ................................................................................ 11
“ETC” - Elapsed Time Counter Query ......................................................... 12
"DLN" - Download ECDIS package table x ................................................. 12
"DL?" - Query available ECDIS packages .................................................. 13
“DST” - Display State .................................................................................. 13
“MAN” - Manufacturer ID ............................................................................. 14
“POT” - Potentiometer Control .................................................................... 14
“SNB” - Serial Number Query ..................................................................... 15
“SWI” - ECOM Software Version ID Query ................................................. 15
"SWK" - Keypad Software Version Query ................................................... 15
“TMP” - Temperature Sensor Query ........................................................... 16
“TYP” - Type/Model Number Query ............................................................ 16
“VER” - Type/Model Number Query ............................................................ 17
“MCC” - OSD Control Functionality ............................................................. 18
“?” (Query OSD Command) ........................................................................ 25
“R” / “r” (Reset OSD Command) ................................................................. 25
“+” (Increase OSD Command) .................................................................... 25
“-” (Decrease OSD Command) ................................................................... 25
Operational Requirements .......................................................................... 26
Unit Response and Addresses ................................................................... 27
Additional Commands ................................................................................. 27
IND100130-27
3
3
Contents
Appendixes ............................................................................. 29
HEX, ASCII, BIN and Character table ..............................................30
Revision History .......................................................................................... 35
IND100130-27
4
4
Serial Communication (SCOM) Interface
Introduction
This document denes the electrical interface, serial data format, and communication protocol of the Serial
Communication Control Interface. The purpose of this interface is to enable a computer application to control one or more units. Units refer to either displays or panel computers.
Serial Interface Conguration
The serial interface can have different congurations, selected by the OSD menu. The congurations are dened as
follows:
RS-232 One computer controls one unit, no individual address 4-wire RS-485/RS-422 One computer controls max 16 units, each with individual address. 2-wire RS-485 One computer controls max 16 units, each with individual address.
Cables
A cable with an overall shield terminated at the back shell should be used.
Electrical Interface
Electrical signals shall conform to RS-485, RS-422 or RS-232. Only Receive Data, Transmit Data, and Signal Ground
are used. The same conditions apply for both 4-wire and 2-wire, and will just be referred to as RS-485 in this document. Hardware handshake is only supported by loopback handshake for RS-232.
- Display (Maritime Multi Display - MMD) based units with Multifunction Cable (VSD100692 series):
• SCOM RS-232 : 1 x 9P DSUB (female) COM1 RS232
• SCOM RS-422/485 : Multifunction Cable customized/optional on request
- Display (Industrial Standard Display - STD) based units with Multifunction Cable (VSD100692 series):
• SCOM RS-232 : 1 x 9P DSUB (female) COM1 RS232
• SCOM RS-422/485 : Multifunction Cable customized/optional on request
- Panel Computer (Maritime Multi Computer - MMC) based units are by factory default manufactured with:
• COM RS-232 : Internal Virtual COM 3 (No pin-out assignments needed, handled by OS/Driver) Internal Virtual COM x (VCOM), where x is OS/conguration dependent. This Virtual COM port enables you to send commands TO the same unit that you are sending FROM, which means there is no need to differentiate
between local control or remote control for communicating through physical ports such as RS-232, RS-485 /
RS-422 towards other units located externally.
Communication Interface
IND100084-11
5
Serial Communication (SCOM) Interface
Pin Assignments - Multifunction Cable Outputs
Pin Assignments - 9P Serial COM RS232
Pin 01 - CTRL(+) Buzzer Control (+) (+12V input for driving the buzzer) Pin 02 - TX Transmit Data Pin 03 - RX Receive Data Pin 04 - DTR Data Terminal Ready Pin 05 - GND Ground Pin 06 - DSR Data Set Ready Pin 07 - RTS Request To Send Pin 08 - CTS Clear To Send Pin 09 - CTRL (-) Buzzer Control (-) (Pull low to activate buzzer)
5 4 3 2 1
9 8 7 6
Connectors that are commonly available on the Multifunction Cable or customized cable.
Connectors are seen from users Point Of View (POV).
Pinout Assignments
For Display Units (MMD/STD w/Multifunction Cable - RS-232).
Pinout Assignments
Display Units (MMD/STD w/Multifunction Cable - RS-422 / RS-485, 4-wire and 2-wire).
Pin RS-422 / RS-485, 4-wire - Full Duplex RS-422 / RS-485, 2-wire - Half Duplex
1 N/C N/C 2 RxD- (Receive Data Negative) N/C 3 TxD+ (Transmit Data Positive) TxD+ (Transmit Data Positive) 4 N/C N/C 5 GND (Ground) GND (Ground) 6 N/C N/C 7 RxD+ (Receive Data Positive) N/C 8 TxD- (Transmit Data Negative) TxD- (Transmit Data Negative) 9 N/C N/C
NOTE: N/C (Not Connected) pins may be internally connected. Do not connect these without consulting Hatteland Display.
Communication Interface
IND100084-11
6
Serial Communication (SCOM) Interface
ECOM
EVX
USART0
USART1
USART2
UART0
RS232
RS485
FWP
Block Diagram
Communication Interface
IND100084-11
7
Serial Communication (SCOM) Interface
Data Rates
The unit is congured to transmit and receive data at 9600 bits/second (Serial mode)
Data Format Serial Mode
Data shall be transmitted with no parity, 8 data bits, one start bit and one stop bit.
Message Format
The basic message format shall be as follows:
Byte # 0 1 2 3 4 5 6 7, etc 8 or 7+DATA=END
ATTN ADDR CMD CMD CMD LEN IHCHK DATA IDCHK
The minimum message size is 7 bytes (0x07). The maximum message size is 82 bytes (0x52), consistent with the
EN61162-1 standard. Colors will be used throughout this manual to indicate byte positions. Every byte sent are viewed in this document as HEX values and are based on standard characters in the ASCII table (0 to 255) to send or receive messages in a human readable input/output. No further decoding or decrypting functionality is needed or required.
Every command sent and received should always end with a 0x00 (null byte terminator).
ATTN
Attention (ATTN)
This single byte is used to identify a start of message. 3 values are possible:
ATTN Description
0x07 Command, also known as ASCII BELL 0x06 Acknowledge, also known as ASCII ACK 0x15 Negative Acknowledge, also known as ASCII NAK
A device shall send a command using the 0x07 Attention Code. The unit will respond to the command with either an ACK if the command completed successfully, or a NAK if the command failed.
NOTE: A complete HEX, ASCII, BIN and Character table overview are available in the APPENDIX chapter.
ADDR
Address (ADDR)
This single byte is used to specify a particular unit to receive a Command and to identify the unit responding (ACK or NAK) to a Command. All units will support the broadcast address. The factory default adress is 0x00, while in this manual illustrated throughout as 0xFF.
The Address eld shall have the following values:
ADDR Description
0xFF Broadcast - Addressed to all units 0x00 to 0x0F Address of a specic unit, 0 to 15 (max 16 units)
Communication Interface
IND100084-12
8
Serial Communication (SCOM) Interface
CMD
Message Commands and Queries (CMD) Contents
The command can be one of the following values and consists always of 3 bytes in positions 2,3,4:
Byte 2 Byte 3 Byte 4 ASCII Description I/O Unit Type Page
0x42 0x52 0x54 "BRT" User Brightness Control W all 11 0x42 0x5A 0x5A "BZZ" Buzzer Control W all 11 0x45 0x54 0x43 "ETC" Elapsed Time Counter Query R all 12 0x44 0x4C 0x4E "DLN" Query available ECDIS packages R xxD 12 0x44 0x4C 0x3F "DL?" Download ECDIS package table x R xxD 13 0x44 0x53 0x54 “DST” Display State W xxD 13 0x4D 0x41 0x4E “MAN” Manufacturer ID Code R xxD 14 0x50 0x4F 0x54 "POT" Potentiometer Control W all 14 0x53 0x4E 0x42 "SNB" Serial Number Query R all 15 0x53 0x57 0x49 "SWI" ECOM Software Version ID Query R all 15 0x53 0x57 0x4B "SWK" Keypad Software Version Query R all 15 0x54 0x4D 0x50 "TMP" Temperature Sensor Query R xxD 16 0x54 0x59 0x50 "TYP" Type/Model Number Query R all 16 0x56 0x45 0x52 "VER" Unit ID Model/Version Number R all 17 0x4D 0x43 0x43 "MCC" OSD Control Functionality (*1)
with key global commands:
"?" = Query OSD value "R" = Reset OSD value "r" = Reset OSD value "+" = Increase OSD value "-" = Decrease OSD value
R/W xxD 18
Notes:
I/O = R=Read, W=Write. Unit Type = xxD = MMD/STD, xxC = MMC units, all = MMD/STD/MMC Page # = Page number in this manual where command is detailed.
(*1) “MCC" = command is not supported on Maritime Multi Computer (MMC) units, due to no OSD menu
available. The “MCC” command also features a Query “?” mode, “R” or “r” reset mode to factory default, increase +1 from current value “+” and decrease -1 from current value “-”. Details and usage of these commands are available later in this manual.
(*2) "DL?/DLN" = Command not available on units manufactured before May 2009.
Communication Interface
IND100084-12
9
Serial Communication (SCOM) Interface
LEN
Data Length (LEN)
This single byte denes the length of DATA in the message in bytes. The maximum value for this eld is 74 bytes (0x4A in HEX). The minimum value is 0 bytes (0x00 in HEX).
IHCHK
Inverse Header Checksum (IHCHK)
This single byte is a simple 8-bit checksum of the header data, message bytes 0 to 5 on which a bit-wise inversion has been performed. The checksum shall be initialised to 0. The 8-bit sum (without carry) of bytes 0, 1, 2, 3, 4, 5 and 6 shall
be 0xFF (255 in value). If the unit receives a message with an incorrect checksum, the unit will reply with the attention code set to NAK and no data eld. This does not apply to Broadcast messages in RS-485 mode, in which case there
will be no reply.
DATA
Data Field (DATA)
The single byte is the DATA eld which shall only be transmitted if LEN is greater than 0. This eld depends on the CMD
transmitted.
IDCHK
Inverse Data Checksum (IDCHK)
This single byte shall only be transmitted if LEN is greater than 0. This is a simple 8-bit checksum of the data eld,
message bytes 7 to 7+(LEN-1) on which a bit-wise inversion has been performed.
The checksum shall be initialised to 0. The 8-bit sum (without carry) of bytes 7 through 7+LEN inclusive shall be 0xFF.
The receiver will reply to any message that the checksum has failed with the attention code set to NAK.
This requirement does not reply to broadcast messages in RS-485 (for units that support it) mode, in which case there will be no reply. Basically this byte is located at the very end of a received stream.
NOTE: A complete HEX, ASCII, BIN and Character table overview are available in the APPENDIX chapter.
Communication Interface
IND100084-12
10
Serial Communication (SCOM) Interface
“BRT” - User Brightness Control
This command is sent to the unit to command the backlight brightness control setting.The brightness value shall be sent
as one byte in the DATA eld. A setting of 0x00 will indicate off. A setting of 0xFF (255 in value) will indicate maximum brightness. Intermediate values will control brightness over the range from minimum to maximum luminance.
LEN = one data byte.
After any power cycle the BRT will be set to 100%.
If the data checksum is valid and the brightness was set, the unit will reply to this command with an ACK attention code. The DATA eld in the reply shall indicate the resulting brightness control setting. If an invalid checksum was received and the message was not Broadcast and RS-485, the unit will reply with an NAK attention code. The DATA eld in the
reply will indicate the current brightness control setting.
Example:
If BRT is 100%, the user can adjust the brightness from 0-100%. If the BRT is set to 60%, the visual brightness is set to 60%. The user can adjust the brightness from 0-100% within the 60% set by BRT. If the user sets the potensiometer to half, the visual brightness will be 30% (half of 60%). If BRT is set back to 100%, the visual brightness will be 50% (half of 100%).
Command to set 60% Brightness:
0x07 0xFF 0x42 0x52 0x54 0x01 0x10 0x99 0x66
Acknowledge was set to 60% Brightness:
0x06 0xFF 0x42 0x52 0x54 0x01 0x11 0x99 0x66
Negative Acknowledge 40% Brightness:
0x15 0xFF 0x42 0x52 0x54 0x01 0x02 0x66 0x99
“BZZ” - Buzzer Control
This command is sent to the unit to control buzzer on/off if there is a buzzer present. LEN = one data byte.
0x00 0xFF
If the data checksum is valid, the unit will reply to this command with an ACK attention code. The DATA eld will indicate
the buzzer state. If an invalid data checksum was received and the message was not broadcast and RS-485, the unit
will reply with a NAK attention code and the current control setting.
Example:
Command to set Buzzer Enable: 0xFF
Turn the buzzer off Turn the buzzer on
0x07 0xFF 0x42 0x5A 0x5A 0x01 0x02 0xFF 0x00
Acknowledge Buzzer status was set to Enable: 0xFF
0x06 0xFF 0x42 0x5A 0x5A 0x01 0x03 0xFF 0x00
Communication Interface
IND100084-12
11
Loading...
+ 25 hidden pages