TT-3027 TT98-147405-A Software Interface Reference Manual Format of data from the data log 201 7 6 5 4 3 2 1 0 S/N Latitude degrees Latitude Minutes Latitude Minute Fractions W/E ... Longitude Minutes Longitude Minute Fractions Not used Longitude degrees ... Not used S/N: 1 for South, 0 for North W/E: 1 for West, 0 for East In units of 1/200 minutes In units of 1/200 minutes Figure 5.33 Position GPS Data is invalid if all bits are set to one. <Speed GPS> (1 byte) This is the last known GPS speed in km/h. Data is invalid if equal to 255. <Course GPS> (1 byte) This is the last known GPS course in units of 2 degrees. Data is invalid if equal to 255. <I/O status> (1 byte) This gives the status of the I/O pins: 7 6 5 4 3 2 1 0 Port value bitmap Figure 5.34 I/O status Port value bitmap (1 byte): Bit 0 :pin 2 Bit 1 :pin 3 Bit 2 :pin 4 Bit 3 :pin 5 Bit 4 :pin 6 Bit 5-7:reserved, set to 0 Data is invalid if all bits are set to one. <Distance tachograph> (4 bytes) This is the total distance registered by the tachograph interface in units of 100 meters. <Speed tachograph> (1 byte)
TT-3027 TT98-147405-A Software Interface Reference Manual Format of data from the data log 202 This is the speed registered by the tachograph interface in km/h. <Extended Position GPS> (7 bytes) This is the last known GPS position in 0,001 fractions of a minute and the HDOP value of this position in fractions of 0,2. S/N = 1 for South, 0 for North W/E = 1 for West, 0 for East S/N Latitude degrees Latitude Minutes HDOP W/E Longitude degrees Longitude Minutes Latitude Minute Fractions Longitude Minute Fractions Figure 5.35 Extended Position GPS Data is invalid if all bits are set to one. <Speed GPS in knots> (2 bytes) Speed in knots Figure 5.36 Speed GPS in knots This is the last known GPS speed in fractions of 0,1 knots. Data is invalid if all bits are set to one.
TT-3027 TT98-147405-A Software Interface Reference Manual Remote TBus 2 interface 203 D Remote TBus 2 interface TBus2 is a remote interface (over the air interface). It allows the user to send and receive Tbus2 data request and query messages. The request messages can configure the MES over the air. Please see [9] TT99-119479 Tbus2 Interface Control Document.
TT-3027 TT98-147405-A Software Interface Reference Manual SSA messages format 204 E SSA messages format SSA alert message: ----------- Covert/Security Alert Received ----------- Mobile Terminal No : 421960216 To CES : 104 Position : 55 47.61'N 012 31.40'E Position updated : 15:15 2004-06-09 UTC Nature of distress : Piracy/armed attack Course : 128 Speed : 0 Activation : Covert/Security Alert Position activated : Yes Course/Speed updated : Yes ------------------------------------------------------ Free text ++++ TEST SSA message: ----------- TEST TEST TEST TEST TEST TEST ----------- Mobile Terminal No : 421960216 To CES : 104 Position : 55 47.61'N 012 31.40'E Position updated : 15:41 2004-06-09 UTC Nature of distress : Piracy/armed attack Course : 154 Speed : 0 Activation : Covert/Security Alert Position activated : Yes Course/Speed updated : Yes -This message is for test purposes, please disregard-- Free text Covert message setup (changed recently): Destination type : E-mail Address : [email protected] Parameter : Usage : Msg+Test Destination type : E-mail Address : [email protected] Parameter : Usage : Msg Destination type : E-mail Address : [email protected] Parameter : Usage : Test Activation : 30 sec. delay Repeat rate : 35 min. Last update : 2006-07-13 11:13:22 ++++
TT-3027 TT98-147405-A Software Interface Reference Manual SSA messages format 205 Configuration changed SSA message: ---------------- CONFIGURATION CHANGE ---------------- Mobile Terminal No : 492388069 To CES : 101 Position : 55 47.60'N 012 31.40'E Position updated : 12:44 2004-06-10 UTC Nature of distress : Piracy/armed attack Course : 034 Speed : 0 Activation : Covert/Security Alert Position activated : Yes Course/Speed updated : Yes -This message is for test purposes, please disregard-- Covert message setup (changed recently): Destination type : E-mail Address : [email protected] Parameter : Usage : Msg+Test Destination type : Address : Parameter : Usage : Destination type : Address : Parameter : Usage : Activation : 30 sec. delay Repeat rate : 35 min. Last update : 2006-07-13 11:13:22 ++++ E.1 Rules for future change of message format and explanation of content: Applications for automatic message type/content recognition must implement a certain set of rules to support future changes/additions of the covert/security message format. Note, the message header may differ depending on the type of message (email, fax, telex, ect.). In addition, the LESs have no common header specification covering one particular message type. No unambiguous format definition can be applied to this section of the message. The message can be extended in the following ways: Lines can be extended to hold more information. If lines are extended the new information will be located after one or more spaces at the end of line. Lines can be added after sections.
TT-3027 TT98-147405-A Software Interface Reference Manual SSA messages format 206 These rules are explained in the following sections in BNF (Backus-Naur Form / RFC2234): Only keywords will not be changed and can be used henceforward for automatic analyses. [2.12] The custom keywords are defined like this: IC: Including control characters. Any 7-bit US-ASCII character, excluding NULL. <%d01> - <%d127> <future useIC> ::= <CHAR>* EC: Excluding control characters. Visible printing characters including space. <%d20> - <%d126> <future useEC> ::= (<VCHAR> / <SP>)* E.2 Start of message body Messages are always composed of a message body header: Keyworda ::= <"-">11 <SP> <"Covert/Security Alert Received"> <SP> <"-">11 Keywordb ::= <"-">11 <SP> <"TEST TEST TEST TEST TEST TEST"> <SP> <SP> <"-">11 Keywordc ::= <"-">16 <SP> <"CONFIGURATION CHANGE"> <SP> <"-">16 ::= (<Keyworda> / <Keywordb> / <Keywordc>) <CR><LF> E.3 Message body Mobile number of terminal where message has originated. The mobile number is composed of digits only: Keyword ::= <"Mobile Terminal No"> ::= <Keyword> <SP>* <%d58> <SP> <DIGIT>* [<SP> <future useEC >] <CR><LF> CES, Coast Earth Station - also commonly refereed as a Land Earth Station (LES) - defines the identifier of the land earth station which received the message. Keyword ::= <"To CES"> ::= <Keyword> <SP>* <%d58> <SP> <DIGIT>* [<SP> <future useEC >] <CR><LF> The position is the last valid know position of the MES. Note, that the resolution is based on hundredth minutes. Keyword ::= <"Position">
TT-3027 TT98-147405-A Software Interface Reference Manual SSA messages format 207 ::= <Keyword> <SP>* <%d58> <SP> <DIGIT>2 <SP> <DIGIT>2 <%d46> <DIGIT>2 _ <%d39> (<%d78> / <%d83>) <SP> <DIGIT>3 <SP> <DIGIT>2 <%d46> <DIGIT>2 <%d39> _ (%d69 / %d87) [<SP> <future useEC >] <CR><LF> Keyword ::= <"Position updated"> ::= <Keyword> <SP>* <%d58> <SP> <DIGIT>2 <%d58> <DIGIT>2 <SP> <DIGIT>4 _ <%d45> <DIGIT>2 <%d45> <DIGIT>2 <SP> <CHAR>* [<SP> <future useEC>] <CR><LF> Nature of distress will always be set to 'Piracy/armed attack': Keyword ::= <"Nature of distress"> ::= <Keyword> <SP>* <%d58> <SP> <%d80> <%d105> <%d114> <%d97> <%d99> _ <%d121> <%d47> <%d97> <%d114> <%d109> <%d101> <%d100> <SP> <%d97> <%d116> _ <%d116> <%d97> <%d99> <%d107> [<SP> <future useEC>] <CR><LF> Course and speed relates to the last known valid position. Speed is given in knots : Keyword ::= <"Course"> ::= <Keyword> <SP>* <%d58> <SP> <DIGIT>3 <SP>9 <%d83> <%d112> <%d101> _ <%d101> <%d100> <SP> <%d58> <SP> <DIGIT>* [<SP> <future useEC>] <CR><LF> Activation will always be set to 'Covert/Security Alert': Keyword ::= <"Activation"> ::= <Keyword> <SP>* <%d58> <SP> <%d67> <%d111> <%d118> <%d101> <%d114> _ <%d116> <%d47> <%d83> <%d101> <%d99> <%d117> <%d114> <%d105> <%d116> _ <%d121> <SP> <%d65> <%d108> <%d101> <%d114> <%d116> [<SP> <future useEC>] _ <CR><LF> Position activated and course/speed updated. Note, after course/speed updated, new lines can be inserted: Keyword ::= <"Position activated"> ::= <Keyword> <SP>* <%d58> <SP> ( (<%d89> <%d101> <%d115>) / (<%d78> <%d111>) ) [<SP> <future useEC>] <CR><LF> Keyword ::= <"Course/Speed updated">
TT-3027 TT98-147405-A Software Interface Reference Manual SSA messages format 208 ::= <Keyword> <SP>* <%d58> <SP> ( (<%d89> <%d101> <%d115>) / (<%d78> <%d111>) ) _ [<SP> <future useEC>] <CR><LF> [<future useIC>] E.4 End of message body Messages are always composed of a message body footer: Keyworda ::= <"-This message is for test purposes, please disregard--"> Keywordb ::= <"-">54 ::= (<Keyworda> / <Keywordb>) <CR><LF> E.5 message supplementary text note The message supplementary text note is optional. ::= [<CHAR>*] <CR> <LF> E.6 trailing message configuration information: The trailing message configuration information is always started with: Keyword ::= <"Covert message setup (changed recently):"> ::= <Keyword> <CR><LF> Type of destination: Keyword ::= <"Destination type"> <DestKey> ::= <Keyword> <SP>* <%d58> <SP> [( (<%d84> <%d101> <%d108> <%d101> _ <%d120>) / (<%d80> <%d83> <%d84> <%d78>) / (<%d80> <%d83> <%d68> <%d78>) / _ (<%d68> <%d78> <%d73> <%d68>) / (<%d83> <%d66> <%d67>) / (<%d69> <%d45> _ <%d109> <%d97> <%d105> <%d108> ) )] [<SP> <future useEC>] <CR><LF> The address holds the destination address: Keyword ::= <"Address"> <AddrKey> ::= <Keyword> <SP>* <%d58> <SP> [<VCHAR>*] [<SP> <future useEC>] _ <CR><LF> The parameter field holds additional information required to use some addresses: Keyword ::= <"Parameter">
TT-3027 TT98-147405-A Software Interface Reference Manual SSA messages format 209 <ParamKey> ::= <Keyword> <SP>* <%d58> <SP> [<VCHAR>*] [<SP> <future useEC>] <CR><LF> Usage holds information regarding the use of a particular message address: Keyword ::= <"Usage"> <UsageKey> ::= <Keyword> <SP>* <%d58> <SP> [(<%d77> <%d115> <%d103>) / _ (<%d84> <%d101> <%d115> <%d116>) / (<%d77> <%d115> <%d103> <%d43> <%d84> _ <%d101> <%d115> <%d116>)] [<SP> <future useEC>] <CR><LF> The destination type, address, parameter and usage are repeated for each of the addresses. ::= (<DestKey> <AddrKey> <ParamKey> <UsageKey> [(<future useEC> <CR><LF>)*])* _ [<SP> <future useIC>] <CR><LF> E.7 End of message (message footer) Message footer will marks the end of message: Keyword ::= "++++" ::= <Keyword> <CR> <LF>
TT-3027 TT98-147405-A Software Interface Reference Manual DNID Download Confirmation Format 210 F DNID Download Confirmation Format This is a special message that may be delivered in a DNID mailbox indicating that the issuing MES has had the DNID inserted and activated. After delivering the activation message the DNID can be used just like a DNID downloaded with a poll. Note that only some MESs can send this message; it only applies to MESs that have a special factory configuration and are put into use according to a special agreement with a LES. Contact the LES operator if a DNID download confirmation message is received in the DNID mailbox from an unknown MES or from a MES that should not contain that DNID DNID download confirmation message example: Manufacturer Initiated DNID download confirmation Mobile Fwd ID = 749341 ISN + s/n = 4TT0870b6f1d + 906405 DNID = 8048 DNID member number = 200 LES ID = 304 Download date = 2004-10-26 Description of the DNID download confirmation message format: <”Manufacturer Initiated”><CR><LF> <”DNID download confirmation”><CR><LF> <”Mobile Fwd ID = “><Forward ID><CR><LF> <”ISN + s/n = “><ISN><” + “><Serial no><CR><LF> <”DNID = “><DNID no><CR><LF> <”DNID member number = “><Member no><CR><LF> <”LES ID = “><LES no><CR><LF> <”Download date = “><Year><”-“><Month><”-“><Day><CR><LF> [<Extension>] <Forward ID> MES ID: A sequence of 1-8 digits. <ISN> The ISN number: “4TT” followed by a sequence of 9 characters (digits and letters). <Serial no> MES serial number: A sequence of 1-8 digits. <DNID no> DNID number: A sequence of 1-5 digits. <Member no> DNID member number: A sequence of 1-3 digits. <LES no> LES ID: A sequence of 1-3 digits.
TT-3027 TT98-147405-A Software Interface Reference Manual DNID Download Confirmation Format 211 <Year> DNID insertion date: 4 digits <Month> DNID insertion month: 2 digits <Day> DNID insertion day: 2 digits <Extension> Future extensions: Lines with additional data can be added in the future.
TT-3027 TT98-147405-A Software Interface Reference Manual Packet Format of LES file (API header) 212 G Packet Format of LES file (API header) When a report is received by the LES a DNID file is created from the packet and placed in a DNID mailbox. The DNID file can then be forwarded to the MES owner’s surveillance center via a terrestrial network (Telnet, email, X.25, PSTN etc.). The format of the DNID files can be different on different LESes and it can also depend on the configuration of LES DNID account - contact the LES for details on account configuration issues. T&T recommends using API headers, which is a format that is widely available. Figure 5.37 shows an overview of the format. The content of the data report itself will follow directly after this header. Byte Content Size Description 0 01 1 byte Indication of header start (EOH) 1 ‘T’ 3 bytes ASCII values for string "T&T" 2 ‘&’ i.e. byte values 54H,26H,54H 3 ‘T’ 4 01 1 byte Type of API header (01 for DNID header) 5 22 1 byte The length of this header in bytes 6 Msg. Ref. LSB 4 bytes Message reference number 7 - 8 - 9 Msg. Ref. MSB 10 Presentation 1 byte Receive alphabet from satellite side message reception 11 LES ID 1 byte LES ID, can be used for identification of ocean region for multi ocean LES's 12 Data Length LSB 2 bytes Number of data bytes following 13 Data Length MSB the header 14 Stored time LSB 4 bytes Giving the time of message store. The bytes given will be the number of seconds since January 1. 1970 0:0:0 15 - 16 - 17 Stored time MSB 18 DNID LSB 2 bytes The DNID of the file. 19 DNID MSB 20 Member number 1 byte Member number sent by the MES in the position report 21 02 1 byte Indication of header end (STX) 22 .. Data .. bytes Position/data report or message Figure 5.37 API header format
TT-3027 TT98-147405-A Software Interface Reference Manual Acknowledgment Data report 213 H Acknowledgment Data report The MES will respond with an acknowledgment data report after processing an incoming poll, if acknowledgment is requested in the poll. The general format of an acknowledgement data report: <Acknowledgment> ::= [<API Header>]<Acknowledgment data>[<Extended result>] The <API Header> is described in appendix G <Acknowledgment data> ::= <Acknowledgment ID><Fixed value><Poll command> <Reserved><Spare><Result code> 7 6 5 4 3 2 1 0 1 0 0 0 0 0 0 0 Poll command Reserved Acknowledgment ID 1 Spare Result code Figure 5.38 Acknowledgement data report Format <Acknowledgment ID> (8 bits): Acknowledgment identifier, see Figure 5.38. <Fixed value> (1 bit): Value: 1 <Poll command> (7 bits): The poll command from the acknowledged poll, see Error! Reference source not found.. <Reserved> (1 byte): Any value. <Spare> (2 bytes): For future use. <Result code> (2 bytes): The result code can be found in Table 5.17.
TT-3027 TT98-147405-A Software Interface Reference Manual Acknowledgment Data report 214 Result code Description Extended data 0000H No description of the outcome of the poll is included. No 0001H No errors were encountered while processing the poll. No 0002H Illegal connection id. No 0003H Access denied No 0004H Missing poll data No 0041H One or more of the DNID(s) are not downloaded. No 006CH Acknowledgement result is placed in the extended result field. Yes 0200H Illegal poll type (individual, group or area) No 0201H Illegal LES No 0203H DNID congestion, no space for more DNID’s No 0204H Illegal response type No 0205H Illegal sub-address No 0206H DNID not active No 0207H Interval Program congestion, no space for more interval programs. No 0208H No interval program exists for the specified DNID No 0209H Data report queue congestion, no space for more data reports. No Table 5.17 Acknowledgement result codes <Extended result> ::= [<Extended data for result code 6CH>] depends on the result code see Table 5.17. <Extended result for result code 6CH> ::= <Result1><Command no1> [<Result2><Command no2>]...[<Result25><Command No25>] Contain the result of every single command in a configuration poll: Figure 5.39 Extended data for result code 6CH <Result> (3 bits): This is the result code of the configuration command. Sub result Meaning 0 No error - configuration performed correctly 1 Unknown command 2 Invalid number of parameters 3 No access 5 Not enough memory 6 No free space 7 Unspecified error Table 5.18 Result codes for extended result field <Command no> (5 bits): This is the command number identifying the command in a configuration poll, see appendix B . 7 6 5 4 3 2 1 0 ... Result1 Command no1 Result25 Command no25
TT-3027 TT98-147405-A Software Interface Reference Manual INDEX 215 INDEX A Alarm .............................................................. 27 Alert reporting .............................. 27, 90, 95, 174 Automatic login .......................................... 19, 83 Automatic ocean region shift............................ 18 Automatic operations....................................... 18 B Baudrate.........................................................110 BGPS status.....................................................164 Bulletin Board error rate .................................124 C cl command..................................................... 51 Clear............................................................... 51 Clock .............................................................137 Closed Networks ............................................139 co command.................................................... 52 Command errors ............................................163 Command queue............................................131 Command status reports.................................160 Confirmation ............................................ 52, 141 Current channel .............................................124 Current protocol activity.................................124 D da command.................................................... 52 Data ...............................................................140 Databits..........................................................110 Datareport Buffer .......................................................... 54 Byte count ................................................... 54 Insert position ............................................. 54 Datareport buffer............................................. 54 Datareport, Sending ........................................ 52 de55 Delete file........................................................ 55 di command .................................................... 71 Distress status.................................................123 E EGC Network ID.............................................127 EGNOS............................................................ 77 ENID ..............................................................127 Environment variables....................................120 ERROR messages............................................160 F File delete.......................................................... 55 list............................................................... 71 transfer ......................................................138 type ...........................................................141 fx command..................................................... 75 G GPS .................................................... 40, 77, 100 H Hardware status screen.................................. 135 he command.................................................... 78 Help ...........................................................75, 78 I I/O-pin ............................................................ 79 Identification.................................................. 128 INFO messages.............................................. 160 io command..................................................... 79 ITA-2.............................................................. 140 L Land station network table ............................. 129 Last commands .............................................. 128 li command...................................................... 83 Link status...................................................... 164 List all files....................................................... 71 lo command................................................83, 86 Login ............................................................... 83 status ......................................................... 124 Logout ............................................................. 83 ls 71 M Member Number ........................................... 124 Message delivery reports .............................. 162 Message file .................................................. 139 Mobile number .............................................. 128 Mobile Number ............................................. 118 MSAS............................................................... 77 N nc command .................................................... 88 NCS Current...................................................... 115 NCS channel .................................................... 88 NCS id ............................................................. 88 NCS list.......................................................... 114 Network table................................................ 129 O Ocean Automatic shift............................................. 18 P Packed baudot............................................... 140 Parity............................................................. 110 pg.................................................................... 98 pg command.................................................... 90 Poll
TT-3027 TT98-147405-A Software Interface Reference Manual INDEX 216 command .................................................... 44 Pollfile............................................................. 42 Polling and data reporting facility .................... 41 Position ..........................................................116 Position format................................................169 Position reporting....................................... 90, 98 Close local connection................................. 91 Default settings....................................... 95, 96 Extended Program Set-up....................... 94, 95 Initiate local connection............................... 96 Overview of status ....................................... 91 Program local connection ....................... 96, 98 Stop local connection................................... 99 Power-on statistics..........................................130 Preferred ocean region ..................................115 prompt............................................................ 49 PSTN destination.............................................139 R Receive log ....................................................131 Receiving messages .......................................164 Regular position reporting.......................... 90, 98 Remote units...................................................100 Connected devices.....................................103 Display status .............................................100 Reporting ........................................................ 41 ru command ...................................................100 S SBAS........................................................... 76, 77 Scan ................................................................ 19 Scanning .................................................... 88, 89 Serial console port parameters .......................110 Serial number.................................................128 Setup Environment variables................................120 Mobile Number ..........................................118 NCS list ......................................................114 Position and Heading.......................... 116, 117 Preferred Ocean Region.............................115 Serial Port ..................................................110 Speed Limits...............................................118 Signal strength ...............................................132 sl command....................................................120 Sleep mode ....................................................120 Disable.......................................................121 Setup..........................................................122 Show status.................................................121 Software version.............................................135 Special Access Code destination.....................139 Speed Limits............................................. 39, 118 st command....................................................122 Status .............................................................122 Channel Parameters ...................................124 Command queue........................................131 ENID information........................................127 Hardware status screen ..............................135 Latest Distress status .................................. 123 LES network table...................................... 129 MES identification...................................... 128 Power-on-statistics..................................... 130 Receive log................................................ 131 Show status report ..................................... 128 Signal strength........................................... 132 Software version ........................................ 135 Transmit log............................................... 133 Status screen.................................................. 135 Stop any protocol............................................. 51 Stopbits ......................................................... 110 Synchronisation ............................................. 124 T T&T position reporting................................90, 98 TDM Channel number........................................ 124 Frame number ........................................... 124 Origin........................................................ 124 Type.......................................................... 124 Terrestrial link............................................... 140 Test Mode...................................................... 117 ti 137 Time .............................................................. 137 Local time.................................................. 138 Set time ..................................................... 138 Show UTC time .......................................... 138 Time of last login............................................ 124 Time of last logout.......................................... 124 tr 138 Transfer ......................................................... 138 Binary........................................................ 139 Transmission date.......................................... 141 Transmission time.......................................... 140 Transmit ........................................................ 139 Additional receiver information ................. 139 Confirmation.............................................. 141 Date........................................................... 141 LES ............................................................ 139 Presentation at receiver end ...................... 140 Service ...................................................... 140 Terrestrial link........................................... 140 Transmission time...................................... 140 Transmit log................................................... 133 Transmit service ............................................ 140 tx command................................................... 139 ty 141 type............................................................... 141 Binary...................................................50, 141 Keep............................. 141, 152, 155, 157, 158 TZ variable .................................................... 137 W WAAS .............................................................. 77 Week schedule.........................................33, 142