TT-3027 TT98-147405-A Software Interface Reference Manual 1 Software Interface Reference Manual for the TT-3027C/D/M/LT/SSA mini-C transceiver Document number: TT98-147405-A Release date: July 2, 2015
TT-3027 TT98-147405-A Software Interface Reference Manual 2 Disclaimer Any responsibility or liability for loss or damage in connection with the use of this product and the accompanying documentation is disclaimed by Thrane & Thrane A/S. The information in this manual is provided for information purposes only, is subject to change without notice and may contain errors or inaccuracies. Manuals issued by Thrane & Thrane A/S are periodically revised and updated. Anyone relying on this information should acquire the most current version e.g. from www.cobham.com/communications-and-connectivity/satcom, Service and support, or from the distributor. Thrane & Thrane A/S is not responsible for the content or accuracy of any translations or reproductions, in whole or in part, of this manual from any other source. In the event of any discrepancies, the English version shall be the governing text. Thrane & Thrane A/S is trading as Cobham SATCOM. Copyright © 2015 Thrane & Thrane A/S. All rights reserved. Warranties Any attempt to install or execute software not supplied by Thrane & Thrane on the devices in this system will result in the warranty being void. Any attempt to modify the software on these devices in a way not specified by Thrane & Thrane A/S will result in the warranty being void. Trademark Acknowledgements Inmarsat is a registered trademark of the International Maritime Satellite Organisation (IMSO) and is licensed by IMSO to Inmarsat Limited and Inmarsat Ventures plc. SAILOR is a registered trademark of Thrane & Thrane A/S in the European Union, the United States and other countries. Other product and company names mentioned in this manual may be trademarks or trade names of their respective owners.
TT-3027 TT98-147405-A Software Interface Reference Manual 3 TABLE OF CONTENTS Table of Contents .......................................................................................3 List of Figures...........................................................................................10 List of Tables ............................................................................................11 1 Introduction.........................................................................................13 1.1 Applicability .....................................................................................................13 1.2 Related Documents and References .................................................................13 1.3 Abbreviations ...................................................................................................14 1.4 Overview ..........................................................................................................15 1.4.1 Inmarsat-C satellite communications system .........................................15 1.4.2 System overview ....................................................................................15 1.4.3 Inmarsat Communication channels ........................................................16 2 General Transceiver Properties ........................................................18 2.1 Automatic Operations .......................................................................................18 2.1.1 Power On Operation...............................................................................18 2.1.2 Automatic Ocean Region Shift ................................................................18 2.1.3 Automatic Login .....................................................................................19 2.2 Authority Levels ................................................................................................20 2.3 File System........................................................................................................21 2.3.1 File Priorities ..........................................................................................21 2.3.2 File Commands ......................................................................................21 3 Services...............................................................................................22 3.1 Messages (store and forward) to and from MES ...............................................22 3.1.1 File Format .............................................................................................23 3.1.2 Message Alphabets ................................................................................24 3.1.3 Inmarsat Network Destination Codes .....................................................25 3.1.4 Examples................................................................................................25 3.2 Distress Calling from MES ...............................................................................27 3.2.1 Maritime Distress alert ...........................................................................27 3.2.2 Covert/Security alerts ............................................................................27 3.2.3 Alert reporting .......................................................................................27 3.3 EGC (including SafetyNET) to MES...................................................................30 3.4 Data Reports from MES .....................................................................................31 3.4.1 Interval Reports ......................................................................................32 3.4.2 Event Reports .........................................................................................34 3.5 Polling to MES...................................................................................................41 3.5.1 Initial Data Reporting and Polling Procedures .......................................41 3.5.2 Pollfile Contents .....................................................................................42 3.5.3 Poll syntax ..............................................................................................42 3.5.4 Poll commands .......................................................................................44 3.5.5 Acknowledgement and Data Reports .....................................................48 4 Command Reference..........................................................................49 4.1 CA.....................................................................................................................50 4.1.1 CA Calibrate Frequency Correction ....................................................50 4.2 CAT...................................................................................................................50 4.2.1 CAT Display the Contents of a File .......................................................50 4.2.2 CAT -b Type Binary ..............................................................................50
TT-3027 TT98-147405-A Software Interface Reference Manual 4 4.2.3 CAT -k Type and Keep..........................................................................50 4.3 CFG...................................................................................................................51 4.3.1 CFG -c Configure Covert/Security Alert ..............................................51 4.4 Clear .................................................................................................................51 4.4.1 CLEAR Abort Current Operation ..........................................................51 4.5 Confirm.............................................................................................................52 4.5.1 CONFIRM Confirmation Request ..........................................................52 4.6 Data...................................................................................................................52 4.6.1 DATA Manual Data Report ....................................................................52 4.6.2 DATA -b Byte Count..............................................................................54 4.6.3 DATA -o Insert Position at the Start of the Data Report..........................54 4.6.4 DATA -p Append Data to the Data Report Buffer ..................................54 4.7 Date ..................................................................................................................55 4.7.1 Date Set data and time...........................................................................55 4.8 Delete ...............................................................................................................55 4.8.1 Delete Delete File(s).............................................................................55 4.9 DIAG .................................................................................................................56 4.9.1 DIAG Diagnostics .................................................................................56 4.9.2 DIAG DSP INFO Enable or disable DSP diagnsotics ..............................56 4.9.3 DIAG DSP LD 7Request Lock detect status ............................................56 4.9.4 DIAG DSP ADC ADC sample data .........................................................56 4.9.5 DIAG DSP RD Read DSP memory...........................................................56 4.9.6 DIAG TC Enable or Disable diagnostics trace.....................................56 4.9.7 DIAG TC CLR Disable diagnostics trace...............................................57 4.9.8 DIAG TC CLRALL Disable diagnostics trace.........................................57 4.9.9 DIAG TC SET Enable diagnostics trace ................................................57 4.9.10 DIAG TC SETMASK Enable diagnostics trace.......................................57 4.9.11 DIAG TC TEST Test Trace logging.........................................................57 4.9.12 DIAG TC LIST List processes with trace.................................................57 4.9.13 DIAG ACCESS Access layer diagnostics ..............................................57 4.9.14 DIAG ACCESS -c Channel status ...........................................................57 4.9.15 DIAG ACCESS -i List info .......................................................................57 4.9.16 DIAG ACCESS -p Show Packet log ........................................................57 4.9.17 DIAG ACCESS -t Show the last frame received .....................................58 4.10 DN.....................................................................................................................58 4.10.1 DN Data Network Setup ........................................................................58 4.10.2 DN -a Display DNID auto-grouping .......................................................59 4.10.3 DN -c Delete DNIDs ..............................................................................59 4.10.4 DN -d Display DNID status .....................................................................59 4.10.5 DN -e Change DNID group....................................................................59 4.10.6 DN -f Set Default DNID Format...............................................................62 4.10.7 DN -fa (NA) Default auto-gruoping ........................................................63 4.10.8 DN -fg Default Reporting Protocol ........................................................64 4.10.9 DN -g Reporting Protocol......................................................................65 4.10.10 DN -l Display/Change User Default Mem Codes...................................65 4.10.11 DN -m Display/Change MEM codes to DNID-entry...............................66 4.10.12 DN –mm (NA) Mobile to mobile settings ...............................................67 4.10.13 DN -n Set max active DNID number.......................................................67 4.10.14 DN -o Create DNID ................................................................................68 4.10.15 DN -p Program DNID Data format..........................................................68 4.10.16 DN -s Change DNID Status....................................................................69 4.10.17 DN -t Attach User-string.........................................................................69 4.10.18 DN -tb Attach Binary User-string ...........................................................70 4.11 Directory...........................................................................................................71 4.11.1 DIRECTORY List Files ...........................................................................71 4.12 Errorlog ............................................................................................................72 4.12.1 Errorlog Show errorlog ........................................................................72 4.13 EV .....................................................................................................................72
TT-3027 TT98-147405-A Software Interface Reference Manual 5 4.13.1 EV -b Bit error limits for antenna blocked ............................................72 4.13.2 EV -c Clear Event Program...................................................................72 4.13.3 EV -d Display Event Programs..............................................................72 4.13.4 EV -e Setup Extended Event Parameters..............................................72 4.13.5 EV -fe Default extended program parameters .....................................73 4.13.6 EV -fp Default program parameters .....................................................73 4.13.7 EV -o Create Event Program.................................................................73 4.13.8 EV -p Enable or Disable events ............................................................74 4.14 FI (NA) ..............................................................................................................74 4.14.1 FI Fishery configuration.........................................................................74 4.14.2 FI 34 Autogrouping................................................................................75 4.14.3 FI 72 Set Max number of DNID................................................................75 4.15 FX......................................................................................................................75 4.15.1 FX Set Fixed Positions............................................................................75 4.16 GPS ...................................................................................................................76 4.16.1 GPS GPS Configuration.........................................................................76 4.16.2 GPS -d Display SBAS state .....................................................................76 4.16.3 GPS -g Display Status of the GPS Receiver .............................................76 4.16.4 GPS -s Show or set SBAS configuration ..................................................77 4.17 Help ..................................................................................................................78 4.17.1 HELP Show Command Help..................................................................78 4.18 ID ......................................................................................................................78 4.18.1 ID System Identification........................................................................78 4.19 IO ......................................................................................................................79 4.19.1 IO -c Clear io-pin setup .........................................................................80 4.19.2 IO -i Input-pin Setup ..............................................................................81 4.19.3 IO -o Output-pin setup............................................................................81 4.19.4 IO -s Show Io-pin setup..........................................................................82 4.20 LI.......................................................................................................................83 4.20.1 LI Login .................................................................................................83 4.21 LO .....................................................................................................................83 4.21.1 LO Logout .............................................................................................83 4.22 LOG...................................................................................................................84 4.22.1 LOG -c Clear the Data-Log ....................................................................85 4.22.2 LOG -d Display Data-Log Settings .........................................................85 4.22.3 LOG -e Set Extended Data-Log Settings .................................................85 4.22.4 LOG -f Select Data-Log Fields................................................................85 4.22.5 LOG -i Start Logging..............................................................................86 4.22.6 LOG -p Select Data-Log Events ..............................................................86 4.22.7 LOG -s Stop Logging .............................................................................86 4.22.8 LOG -x Extract log data to file for TFTP transfer ....................................86 4.23 LS ......................................................................................................................87 4.23.1 LS List of files .........................................................................................87 4.24 NCS...................................................................................................................88 4.24.1 NCS -a Add an NCS................................................................................88 4.24.2 NCS -g Go to Specific NCS....................................................................88 4.24.3 NCS -l Show NCS list.............................................................................88 4.24.4 NCS -r Remove an NCS.........................................................................89 4.24.5 NCS -s Initiate Scanning for the Strongest NCS Signal..........................89 4.25 Password...........................................................................................................90 4.25.1 PASSWORD Change Password .............................................................90 4.26 PG .....................................................................................................................90 4.26.1 PG -a Set alert activation........................................................................90 4.26.2 PG -b Value of sparebit for dateformat 3 ...............................................91 4.26.3 PG -c Close a Local Connection............................................................91 4.26.4 PG -d Overview of Connection Status...................................................91 4.26.5 PG -e Extended program set-up...........................................................94 4.26.6 PG -fa Set default alert activation...........................................................95
TT-3027 TT98-147405-A Software Interface Reference Manual 6 4.26.7 PG -fe Default extended program set-up..............................................95 4.26.8 PG -fl Set default Long Interval and Minimum Distance.........................95 4.26.9 PG -fp Set default program parameters................................................96 4.26.10 PG -fv View default extended program parameters.............................96 4.26.11 PG -i Initiate a Programmed Local Connection.....................................96 4.26.12 PG -l Set Long Interval and Minimum Distance.....................................96 4.26.13 PG -o Open a Local Connection............................................................98 4.26.14 PG -p Program a Local Connection With PU Program ..........................98 4.26.15 PG -pa Program a Local Connection With PA Program ........................98 4.26.16 PG -s Stop a Programmed Local Connection ........................................99 4.26.17 PG -v View Extended Program Parameters..........................................99 4.27 Pp......................................................................................................................99 4.27.1 Pp Display EPADR program status........................................................99 4.28 Reboot...............................................................................................................99 4.28.1 Reboot Reboot MES ..............................................................................99 4.29 Recvfile (NA).....................................................................................................99 4.29.1 RECVFILE Receive File .........................................................................99 4.30 Rs (NA)............................................................................................................100 4.30.1 Rs Report Setup ...................................................................................100 4.31 Rm...................................................................................................................100 4.31.1 Rm remove file .....................................................................................100 4.32 RU ...................................................................................................................100 4.32.1 remote Units .........................................................................................100 4.32.2 RU -g Display Status of the GPS Receiver ...........................................100 4.32.3 RU -l List the Currently Connected Devices .......................................103 4.33 SECRETTEXT...................................................................................................103 4.33.1 Secrettext Secret text for remote access.............................................103 4.34 SENDFILE (NA) ...............................................................................................104 4.34.1 SENDFILE Send File ............................................................................104 4.35 SET..................................................................................................................104 4.35.1 SET -a Enable or Disable Reception of Inmarsat System Call EGCs ..105 4.35.2 SET -ab Set remote ssas reconfiguration button .................................105 4.35.3 SET -am Set SSA message destinations................................................106 4.35.4 SET -ame Set Extended SSA message destinations .............................106 4.35.5 SET -ap Set SSA message repeat rate .................................................108 4.35.6 SET -ar Reset high priority message or egc light indication................108 4.35.7 SET -at Set SSA message text...............................................................108 4.35.8 SET -atf Set SSA message text from file................................................108 4.35.9 SET -atx Set SSA additional message text ............................................109 4.35.10 SET -au Set authority levels .................................................................110 4.35.11 SET -b Reinitialize system parameters.................................................112 4.35.12 SET -c (NA) Show or Set Serial Port Parameters ..................................112 4.35.13 SET –e (NA) Receive only EGC messages ...........................................112 4.35.14 SET -fd Filesystem cleanup.................................................................112 4.35.15 SET -g Set Up Alert Generator ............................................................113 4.35.16 SET -I Enable or Disable Reception of FleetNet EGCs .......................114 4.35.17 SET -k (NA) Enable or Disable Land Mobile Alerting..........................114 4.35.18 SET –l (NA) Setup or Show NCS List ....................................................114 4.35.19 SET -m Set Up Alert.............................................................................114 4.35.20 SET -n Enable or Disable Reception of Coastal Warning Call EGCs ...115 4.35.21 SET -ns Enable or Disable Login On the Nearest Allowed Satellite ....115 4.35.22 SET -o Preferred Ocean Region............................................................115 4.35.23 SET -p Show or Set Position and Heading Values ................................116 4.35.24 SET -q Distress test mode ....................................................................117 4.35.25 SET -r Silent Mode ...............................................................................117 4.35.26 SET -s Set Spare NavArea ...................................................................117 4.35.27 SET -sn Set Spare NavAreas................................................................118 4.35.28 SET -sp Speed Limits ..........................................................................118
TT-3027 TT98-147405-A Software Interface Reference Manual 7 4.35.29 SET -u Mobile Number.......................................................................118 4.35.30 SET -w Display SafetyNet EGC Reception Setting ..............................119 4.35.31 SET -x Set Coastal Warning Areas ......................................................119 4.35.32 SET -y Set Navtex Services .................................................................119 4.35.33 SET -z Environment Variables ............................................................120 4.36 Sleep...............................................................................................................120 4.36.1 SLEEP -c Disables Sleep Mode Operation ..........................................121 4.36.2 SLEEP -d Show Sleep Mode Status ......................................................121 4.36.3 SLEEP -f Setup Sleep Mode Report Filter.............................................121 4.36.4 SLEEP -i Setup Sleep Mode Operation................................................122 4.36.5 SLEEP -l setup auto-logout before sleep mode....................................122 4.37 Status...............................................................................................................122 4.37.1 STATUS Display MES Status ................................................................122 4.37.2 STATUS -a Status of Latest Alert ..........................................................123 4.37.3 STATUS -c Channel Parameters ..........................................................124 4.37.4 STATUS -d DNID Information ..............................................................124 4.37.5 STATUS -e Show EGC Log ....................................................................126 4.37.6 STATUS -g ENID Information...............................................................127 4.37.7 STATUS -i Show MES Identification .....................................................128 4.37.8 STATUS -l Show Status Report .............................................................128 4.37.9 STATUS -m Show Last Test Result........................................................129 4.37.10 STATUS -n Show LES Network Table...................................................129 4.37.11 STATUS -o Power On Statistics ............................................................130 4.37.12 STATUS -q Show Contents of Command Queue..................................131 4.37.13 STATUS -r Receive Log .......................................................................131 4.37.14 STATUS -s Show Signal Strength .........................................................132 4.37.15 STATUS -t Transmit Log.......................................................................133 4.37.16 STATUS -v Show Software Version Number ........................................135 4.37.17 STATUS -w Hardware Status Screen....................................................135 4.38 SU....................................................................................................................136 4.38.1 SU Substitute User...............................................................................136 4.39 Test .................................................................................................................137 4.39.1 TEST Link Test.....................................................................................137 4.40 Time................................................................................................................137 4.40.1 TI Show Present Time..........................................................................137 4.40.2 TI -l Show Local Time ..........................................................................138 4.40.3 TI -s Set Time .....................................................................................138 4.40.4 TI -u Show UTC Time...........................................................................138 4.41 Transfer...........................................................................................................138 4.41.1 TRANSFER Transfer File From Console ..............................................138 4.41.2 TRANSFER -b Transfer in Binary Notation...........................................139 4.42 TX....................................................................................................................139 4.42.1 TX Transmit A Message ......................................................................139 4.42.2 TX -a Send with distress priority...........................................................139 4.42.3 TX -c Specify LES to Route the Message .............................................139 4.42.4 TX -e Additional Receiver Address Information .................................139 4.42.5 TX -h Transmission time......................................................................140 4.42.6 TX -k Keep Message After Transmission ............................................140 4.42.7 TX -l Set Presentation at the Receiving End ........................................140 4.42.8 TX -s Specify Transmit Service ...........................................................140 4.42.9 TX -t Specify Terrestrial Link ..............................................................140 4.42.10 TX -v Request Confirmation................................................................141 4.42.11 TX -y Transmission date ......................................................................141 4.43 Type................................................................................................................141 4.43.1 TYPE Display the Contents of a File....................................................141 4.43.2 TYPE -b Type Binary...........................................................................141 4.43.3 TYPE -k Type and Keep ......................................................................141 4.44 Ver ..................................................................................................................141
TT-3027 TT98-147405-A Software Interface Reference Manual 8 4.44.1 Ver Display software versions .............................................................141 4.45 Weeksched.....................................................................................................142 4.45.1 Weeksched Setting up a week schedule .............................................142 4.45.2 WEEKSCHED -c Clear week schedule ................................................142 4.45.3 WEEKSCHED -d Display week schedule.............................................142 4.45.4 WEEKSCHED -o Create week schedule entry.....................................143 4.46 Zone................................................................................................................144 4.46.1 ZONE Set-up surveillance zones.........................................................150 4.46.2 ZONE -a Display active zones...............................................................151 4.46.3 ZONE -ag Set active zone group..........................................................151 4.46.4 ZONE -al Set active zone group list......................................................151 4.46.5 ZONE -d Displays the zone configuration............................................152 4.46.6 ZONE -dg Display Zone Group Configuration......................................152 4.46.7 ZONE -dl Display Zone Group List Configuration ................................153 4.46.8 ZONE -e Set enter/exit event flag.........................................................153 4.46.9 ZONE -eg Set enter/exit event flag in group ........................................153 4.46.10 ZONE -g Add a Group to a Zone Group List .........................................154 4.46.11 ZONE -i Change the reporting interval ...............................................154 4.46.12 ZONE -ig Setup interval for zone in group...........................................154 4.46.13 ZONE -n Create a new zone.................................................................155 4.46.14 ZONE –ng Add Zone to Group..............................................................155 4.46.15 ZONE -o Add radius or width...............................................................155 4.46.16 ZONE -og Setup radius of zone in group ..............................................156 4.46.17 ZONE -p Add a position to a zone........................................................156 4.46.18 ZONE -pg Setup positions in group......................................................157 4.46.19 ZONE -r Remove a zone.......................................................................157 4.46.20 ZONE -rg Remove zone in group..........................................................157 4.46.21 ZONE -rl Remove Zone Group List .......................................................158 4.46.22 ZONE -s Get the current zone number ................................................158 4.46.23 ZONE -t Test a position ........................................................................158 4.46.24 ZONE -tg Test if position is in a zone group..........................................159 4.46.25 ZONE -u Check all zones now ..............................................................159 4.46.26 ZONE -w Wait searching when near zone border ................................159 5 Info and Error Messages..................................................................160 5.1 Introduction ....................................................................................................160 5.2 Command Status Reports ................................................................................160 5.3 Message Delivery Reports..............................................................................162 5.4 Command Errors ............................................................................................163 5.5 Receiving Messages .......................................................................................164 5.6 GPS Status .......................................................................................................164 5.7 General Status.................................................................................................164 5.8 Link Status .......................................................................................................164 5.8.1 List of Link Error Messages ..................................................................165 5.9 Link Test Messages .........................................................................................168 5.10 Distress Test Mode..........................................................................................168 5.11 Sleep Mode.....................................................................................................168 A Position Report Packet Format .......................................................169 A.1 Packet Formats defined for the satellite link...................................................169 A.2 T&T Data report format ...................................................................................179 A.3 Message data report format............................................................................180 B Packet format of the configuration poll..........................................181 B.1 General format................................................................................................181 B.2 Packet format of the zone configuration poll...................................................182 B.3 Examples of zone configuration polls .............................................................188
TT-3027 TT98-147405-A Software Interface Reference Manual 9 B.4 Configuration poll Acknowledgement............................................................196 B.5 Packet format of the zone group selection poll...............................................197 C Format of data from the data log.....................................................198 C.1 Header format.................................................................................................198 C.2 Entry format ....................................................................................................200 D Remote TBus 2 interface..................................................................203 E SSA messages format......................................................................204 E.1 Rules for future change of message format and explanation of content:.........205 E.2 Start of message body.....................................................................................206 E.3 Message body ................................................................................................206 E.4 End of message body .....................................................................................208 E.5 message supplementary text note..................................................................208 E.6 trailing message configuration information: ...................................................208 E.7 End of message (message footer)...................................................................209 F DNID Download Confirmation Format ............................................210 G Packet Format of LES file (API header) ..........................................212 H Acknowledgment Data report..........................................................213 Index ........................................................................................................215
TT-3027 TT98-147405-A Software Interface Reference Manual 10 LIST OF FIGURES Figure 3.1 Activating Interval Data Reporting ................................................................33 Figure 3.2 Activating Event Data Reporting....................................................................35 Figure 3.3 Rules for DNID in relation to filter feature......................................................35 Figure 3.4 Blocking reports with filtered blocking disabled. .........................................36 Figure 3.5 Antenna blocked reports with filtered blocking enabled. ............................37 Figure 3.6 Power reports with filtered power enabled...................................................38 Figure 3.7 Speed Limits ..................................................................................................39 Figure 4.1 Precondition for group examples shown below ............................................60 Figure 4.2 Case 1. Add DNID´s to group.........................................................................61 Figure 4.3 Case 2. Add DNID's to group (advanced)......................................................61 Figure 4.4 Case3.Delete DNID's......................................................................................62 Figure 4.5 Automatic change of reporting interval.........................................................97 Figure 4.6 Zone example ...............................................................................................145 Figure 4.7 Advanced Zone features ..............................................................................146 Figure 5.1 Position Report Format ................................................................................169 Figure 5.2 Date format 1 ...............................................................................................171 Figure 5.3 Date format 2 ...............................................................................................172 Figure 5.4 Date format 3 ...............................................................................................172 Figure 5.5 I/O format for TT-3027 C(covert alert disabled)/D/M/LT............................173 Figure 5.6 I/O format for TT-3027 C(covert alert enabled)/SSA...................................173 Figure 5.7 Speed and course ........................................................................................174 Figure 5.8 I/O format for TT-3027 C(covert alert enabled)/SSA...................................175 Figure 5.9 User stiring ..................................................................................................175 Figure 5.10 Extra position precision0.005 ....................................................................176 Figure 5.11 Extra position precision0.001 ....................................................................176 Figure 5.12 Tachograph data........................................................................................177 Figure 5.13 T&T´s data report format............................................................................179 Figure 5.14 Message data reporting format..................................................................180 Figure 5.15 Short packet descriptor .............................................................................181 Figure 5.16 Medium packet descriptor ........................................................................181 Figure 5.17 Ack reference ............................................................................................182 Figure 5.18 Zone poll data. ...........................................................................................183 Figure 5.19 Position format ..........................................................................................185 Figure 5.20 Radius format .............................................................................................186 Figure 5.21 Width format ..............................................................................................186 Figure 5.22 Generation of checksum............................................................................187 Figure 5.23 Fields used to calculate checksum.............................................................187 Figure 5.24 Calculation of the position field .................................................................189 Figure 5.25 Data Field for the circle zone poll ..............................................................190 Figure 5.26 Calculation of the position field .................................................................192 Figure 5.27 Data Field for the polygon zone poll..........................................................193 Figure 5.28 Calculation of the position field .................................................................195 Figure 5.29 Data Field for the polyline zone poll..........................................................196 Figure 5.30 B.5 Packet format of the zone group selection poll ................................197 Figure 5.31 Format when retrieving data from the data log. ........................................198 Figure 5.32 Mask of fields .............................................................................................199 Figure 5.33 Position GPS...............................................................................................201 Figure 5.34 I/O status....................................................................................................201 Figure 5.35 Extended Position GPS ..............................................................................202 Figure 5.36 Speed GPS in knots....................................................................................202 Figure 5.37 API header format......................................................................................212 Figure 5.38 Acknowledgement data report Format......................................................213 Figure 5.39 Extended data for result code 6CH...........................................................214
TT-3027 TT98-147405-A Software Interface Reference Manual 11 LIST OF TABLES Table 2.1 Automatic Ocean Region shift .........................................................................19 Table 2.2 Authority Levels ..............................................................................................20 Table 2.3 File propertiess ...............................................................................................21 Table 3.1 Inmarsat Services............................................................................................22 Table 3.2 7-bit alphabet..................................................................................................24 Table 3.3 Inmarsat Network Destination Codes..............................................................25 Table 3.4 Interval Reporting MEM-Code........................................................................33 Table 3.5 Events generating Data Reports......................................................................34 Table 3.6 Pollfile Header ................................................................................................42 Table 3.7 DNID User Data ...............................................................................................42 Table 3.8 Inmarsat Defined Polls ....................................................................................45 Table 3.9 T&T Defined Polls to Sub-address 1 ................................................................45 Table 3.10 T&T Defined Polls to Sub-address 3 ..............................................................45 Table 4.1 GPS SBAS status values ...................................................................................76 Table 4.2 GPIO mapping tables......................................................................................79 Table 4.3 Input event table .............................................................................................81 Table 4.4 Output event table ..........................................................................................82 Table 4.5 Possible data fields in a log entry ...................................................................84 Table 4.6 Possible events creating log entries. ..............................................................84 Table 4.7 Connection Status Summary............................................................................93 Table 4.8 GPS entries....................................................................................................102 Table 4.9 GPS Error Codes ...........................................................................................103 Table 4.10 GPS Status Interpretation ............................................................................103 Table 4.11 Commands allowing user to change authority levels..................................111 Table 4.12 Nature of Alert.............................................................................................113 Table 4.13 Channel Parameter Field Values.................................................................124 Table 4.14 DNID Item List .............................................................................................125 Table 4.15 EGC Log Terms ...........................................................................................126 Table 4.16 ENID Item List..............................................................................................127 Table 4.17 Power on statistics reasons..........................................................................131 Table 4.18 Receive Log Description .............................................................................132 Table 4.19 Transmission Log Description .....................................................................134 Table 4.20 Hardware Status Screen Description...........................................................136 Table 4.21 Built in users and default passwords. ..........................................................136 Table 4.22 Zone types...................................................................................................145 Table 4.23 Example of use............................................................................................148 Table 4.24 Example of use............................................................................................149 Table 5.1 Command Status Reports ..............................................................................162 Table 5.2 Message Delivery Reports ............................................................................162 Table 5.3 Command Errors...........................................................................................163 Table 5.4 Receiving Messages Info's ............................................................................164 Table 5.5 GPS Info's ......................................................................................................164 Table 5.6 General Status ...............................................................................................164 Table 5.7 General Status after Log file Changes ...........................................................164 Table 5.8 LES Messages in case of a Pending/Rejected Call ........................................165 Table 5.9 LES Messages in case of an Aborted Call......................................................166 Table 5.10 MES Messages.............................................................................................168 Table 5.11 Link Test Messages .....................................................................................168 Table 5.12 Test Mode Messages ...................................................................................168 Table 5.13 Sleep Mode Messages.................................................................................168 Table 5.14: Configuration poll command types ............................................................181 Table 5.15: Zone types..................................................................................................184 Table 5.16 Data fields ...................................................................................................199 Table 5.17 Acknowledgement result codes..................................................................214 Table 5.18 Result codes for extended result field.........................................................214
TT-3027 TT98-147405-A Software Interface Reference Manual Introduction 12 Applicability
TT-3027 TT98-147405-A Software Interface Reference Manual Introduction 13 Applicability 1 INTRODUCTION 1.1 APPLICABILITY This document describes the general transceiver (from here on MES), properties, data services and command interface of the TT-3027. The document applies to the following MES types: TT-3027C SOLAS TT-3027D Non-SOLAS and Distress. TT-3027M for Maritime. TT-3027LT for LRIT. TT-3027SSA for Maritime SSA installation. Please note that a “land mobile” MES is not a part of the TT-3027 product portfolio. This document meets a requirement for command interface compatibility with legacy MESs. Therefore, references to “land mobile” will occur in the text, but the commands and parameters are no longer applicable. 1.2 RELATED DOCUMENTS AND REFERENCES [1] TT 99-110036, Internet Gateway User Manual [2] TT 99-103879, PSDN User Interface Manual [3] TT98-130752 Sailor 6110 GMDSS System Installation Manual [4] TT98-131589 Sailor 6120-30-40-50 System Installation Manual [5] TT98-130753 Sailor 6110 mini-C GMDSS User Manual [6] TT98-131590 Sailor 6120-30-40-50 System User Manual [7] TT98-131593 SAILOR 6194 Terminal Control Unit Installation and User Manual [8] TT98-130088 SAILOR 6006/7 Message Terminal Installation Manual [9] TT99-119479 Tbus2 Interface Control Document
TT-3027 TT98-147405-A Software Interface Reference Manual Introduction 14 Abbreviations 1.3 ABBREVIATIONS A number of abbreviations are used in the document. The most important ones are: <CR> The ASCII carriage return character, 0DH. <ETX> The ASCII end-of-text character, 03H. <LF> The ASCII linefeed character, 0AH. <SPACE> The ASCII space character, 20H. <STX> The ASCII start-of-text character, 02H. AORE Atlantic Ocean Region East AORW Atlantic Ocean Region West BBER Bulletin Board Error Rate BGPS Built in GPS DCE Data Circuit Terminating Equipment DNID Data closed Network ID DTE Data Terminal Equipment ENID ENhanced ID EPADR Enhanced Pre-Assigned Data Report GPS Global Positioning System IOR Indian Ocean Region LES Land Earth Station. LES ID Land Earth Station identifier (number). LRIT Long Range Identification and Tracking MEM Macro Encoded Message MES Mobile Earth Station MRCC Maritime Rescue Coordinating Centre MT SAILOR TT-6006/7 Message Terminal NA Not Applicable NCS Network Co-ordinating Station NOC Network Operations Center POR Pacific Ocean Region PU Programmed Unreserved Data reporting SES Ship Earth Station SSAS Ship Security Alert System TCU SAILOR 6194 Terminal Control Unit TDM Time Division Multiplexing TFTP Trivial File Transfer Protocol TMA ThraneLink Management Application T&T Thrane & Thrane UTC Coordinated Universal Time
TT-3027 TT98-147405-A Software Interface Reference Manual Introduction 15 Overview 1.4 OVERVIEW 1.4.1 INMARSAT-C SATELLITE COMMUNICATIONS SYSTEM Inmarsat-C is a satellite communications system which facilitates data transfer between MESs and fixed LESs which are connected to terrestrial networks. Data can also be transferred from MES to MES via an LES. Services provided by the Inmarsat-C Network: messages (store and forward) to and from MES distress calling (i.e distress alerts and distress priority messages) from MES EGC (including SafetyNET) to MES data reports from MES polling to MES 1.4.2 SYSTEM OVERVIEW The Inmarsat-C system consists of the following major elements in an ocean region: the space segment (including NOC), NCS , LES and MES. SPACE SEGMENT The space segment, which includes the satellites and their associated ground support facilities, is the responsibility of Inmarsat. It utilises a number of satellites to provide almost complete global coverage with the exception of the polar regions, which cannot be seen by geostationary satellites. There are four ocean regions: AORE, AORW , IOR and POR. Satellite utilisation is co-ordinated by the NOC in London. NCS Each ocean region is served by a Network Coordination Station which manages the allocation of central resources such as traffic and signalling channels. The NCS controls the access rights of MESs. Every MES that is active in an ocean region is required to log in to the Network: a copy of the list of all registered MESs is held at each LES. When an LES receives a call for an MES from a terrestrial subscriber, it checks that the MES is present in its ocean region before forwarding it. The location of each MES is monitored so that if a call is received for an MES which has moved on to another ocean region, the call can be redirected or rejected. The NCS transmits a common channel which is used to announce calls (addressed to MESs) which are waiting at LESs, for broadcasting EGC messages, and at various stages for protocol signalling and other optional services. When an MES is not involved in message transfer it automatically tunes to the NCS common channel. Associated with each NCS common channel is a signalling channel on which the NCS receives information from MESs. All the NCSs are connected to each other and also to the NOC.
TT-3027 TT98-147405-A Software Interface Reference Manual Introduction 16 Overview LES Each LES serves as a gateway between the terrestrial networks and the MESs within the coverage area of the satellite. It is also used for the transfer of calls from one MES to another. All LESs shall provide telex, maritime distress alerting, and EGC message handling facilities with appropriate interfaces to the terrestrial network: other interfaces can be provided at the discretion of the LES operator. Each LES in a particular region is connected by an Interstation Signalling Link to that region's NCS. LESs can operate some or all of their traffic channels in a demand assigned mode. If traffic and satellite power considerations call for this mode of operation to be used, the NCS allocates temporary LES TDM channels, signalling channels, and message channels on the basis of need. MES Each MES consists of a DCE which acts as an interface to the satellite network and a DTE such as a personal computer or intelligent black box. The DTE may provide an interface at which information gathered by, for example, a monitoring system or a position location device can be transferred to the DCE or it may allow the user to enter information manually. Similarly, received information is processed by the DTE and can be displayed or printed. Alternatively the data can be used by, for example, a control system. In the From Mobile direction, the DTE assembles a complete message and then transfers it to the DCE. In the receive direction, the DTE receives messages from the DCE. 1.4.3 INMARSAT COMMUNICATION CHANNELS Several different types of channel are used in the Inmarsat-C system. All information is transferred in packets on the different channels; both fixed and variable length packets are used. Each packet includes a checksum allowing Automatic Repeat Request (ARQ) error correction to be implemented. NCS COMMON CHANNEL The NCS common channel is a Time Division Multiplex (TDM) channel with a frame length of 8.64 seconds (10.000 frames in 24 hours). The channel carries network information, signalling information and EGC messages. It is transmitted continuously by the NCS to all MESs in its region. MESs automatically tune to the NCS common channel when they are idle. An NCS may transmit more than one common channel (for example, when operating with spot beams). TDM CHANNEL The LES TDM channel has the same frame structure as the NCS common channel. It carries all signalling and message traffic from the LES to the MESs with which it is communicating; it is the forward link for LES to MES communication. MESSAGE CHANNEL The message channels operate in Time Division Multiple Access (TDMA) mode and are controlled by the LES. Message channels are used by MESs to transfer messages to an LES. Each LES has one or more message channels assigned to it by the NCS.
TT-3027 TT98-147405-A Software Interface Reference Manual Introduction 17 Overview Allocation of a message channel to an MES is performed by the LES using assignment packets. Each message channel may be used by several MESs simultaneously engaged in From-Mobile calls. SIGNALLING CHANNEL The signalling channels operate in hybrid slotted Aloha mode, where some of the capacity can be reserved. Signalling channels are used by MESs to transmit signalling packets and short messages to LESs and NCSs. Each LES has one or more signalling channels assigned to it. All MESs use a signalling channel to the NCS for logging in and out of the ocean region. Its characteristics are exactly the same as an LES's signalling channel.
TT-3027 TT98-147405-A Software Interface Reference Manual General Transceiver Properties 18 Automatic Operations 2 GENERAL TRANSCEIVER PROPERTIES 2.1 AUTOMATIC OPERATIONS The transceiver executes the following automatic operations: Check BBER every 8.64 seconds. At a BBER of 80 (default) an info is generated and a scanning will begin. Automatic spotbeam scanning every 24 hours. Requesting data and/or sending position information at regular intervals. Clean-up of the logs when needed. Network version check every 24 hours. If the Network version stored in the MES's LES tabel is different from the NCS TDM's, a login will commence. Clean-up of the file system when needed. If a tuning operation in a protocol fails, the MES will check the LES Network version number against the NCS TDM Network version, and if they differ a login will be issued. Automatic correction of MES CMOS clock time when deviation to the GPS UTC reaches 10 sec. Read Navigational data from internal GPS 2.1.1 POWER ON OPERATION If the MES is logged-out it will by default log into the current ocean region. The default setting can be changed so that the MES login on the ocean region with the nearest satellite (Please see the command se -ns). If using login on nearest satellite: The MES use the last known position to decide which ocean region to use. Only allowed ocean regions are considered when deciding which ocean region to use. If the login for some reason fails the MES will try to find another ocean region. The time and date of power-on, login and logout are stored. 2.1.2 AUTOMATIC OCEAN REGION SHIFT This feature is very useful when the vessel/vehicle operates in different ocean regions. The MES will perform automatic scanning and ocean region shift, if the signal strength has been bad for a few minutes or at 24 hours interval. The ocean region shift can be disabled or restricted to one or more allowed regions (Please see below and the se -o command).
TT-3027 TT98-147405-A Software Interface Reference Manual General Transceiver Properties 19 Automatic Operations Preferred ocean setting Allowed ocean(s) setting Automatic ocean-region shift behavior Preferred ocean set to "NONE" Allowed ocean set to "NONE" Scanning current ocean region, and login on the strongest spot. If synchronizing to current ocean region fails the other regions are scanned. Allowed ocean set to one or more oceans (W, E, P and I) Scanning current ocean region, and login on the strongest spot. If synchronizing to current ocean region fails the allowed regions are scanned. Preferred ocean set to an ocean (W, E, P or I) Allowed oceans setting has no effect. Scanning preferred ocean region, and login on the strongest spot. If synchronizing to the preferred ocean region fails info is sent to the operator. The MES will be tuned to preferred ocean Table 2.1 Automatic Ocean Region shift 2.1.3 AUTOMATIC LOGIN The MES will start an automatic login under the following circumstances: When a scan command finds a different NCS with a stronger signal than the current NCS. The MES will login to the new NCS. If this fails, it will return to the original NCS. Every 24 hours the MES will check if the Network Version Number of the stored LES Table and the NCS TDM channel are different. If they are different the MES will login again on the current NCS TDM to get a new LES Network Table. If a tuning operation during a protocol failed the MES will check if the Network Version Number of the stored LES Table and the NCS TDM channel are different. If they are the MES will login again on the current NCS TDM to get a new LES Network Table. When the MES is turned on it will start a login to the current NCS TDM if its status shows that it is not logged in. The MES will start an automatic login to a new NCS if the satellite signal is lost for a few minutes.
TT-3027 TT98-147405-A Software Interface Reference Manual General Transceiver Properties 20 Authority Levels 2.2 AUTHORITY LEVELS Many commands and features in the MES require that the user has a certain authority level. This system exists in order to allow system administrators of various sorts to configure the MES with settings, which the normal users cannot change. Authority level protection also prevents users from inadvertently changing settings, which may interfere with the correct operation of the MES. A user can acquire a specific authority level using the SU command. The user supplies the desired level and the password for that level. Users can change the password for each level, provided that they are at a sufficient authority level. The levels are: User Name Default Password Description Normal (empty) Normal user level. This authority level is the default after boot-up. Super super Super user level. Sysadm sysadm System administrator level. Intended for system administrators Table 2.2 Authority Levels At a given authority level, the user has access to all the features at that level in addition to those at the lower levels. Some commands can be assigned a required authority level if it is necessary to reduce the set of commands that are available to users at lower authority levels. A user can set the required authority level to his/her own level or lower. Please see the SE –au command. Authority levels also affect Data Network IDs (DNIDs), interval programs and event programs. Each DNID is given an authority level. Access at this level is required to modify the properties of the DNID and the programs that are associated with it. Super users and Sysadm users are required to change their password the first time they use the SU command.
TT-3027 TT98-147405-A Software Interface Reference Manual General Transceiver Properties 21 File System 2.3 FILE SYSTEM The file-system and all files are stored in flash. It has the following specification/characteristic: 2.3.1 FILE PRIORITIES The file-system operates with the following internal priorities, which cannot be altered by normal users: Priority Description File naming Highest System data-setup files ZoneFile.Dat, DnidStr.Dat, Datarep.dat System log files _EGCLOG, _TXLOG, _RXLOG and ERROR.LOG. Poll files POLL.xxx Incoming messages/files IN.xxx EGC messages/files EGC.xxx Lowest User files *.* Table 2.3 File propertiess 2.3.2 FILE COMMANDS The command interface provides the following commands for file operations. Please see the chapter for details about each command. DIRirectory / LS. Displays a list of files. TYpe / CAT. Displays the contents of file(s). TRansfer. Transfers a file from the console to the RAM-disk. DELete / RM. Deletes one or more files. SENDFILE / SF. Sends a file using build in TFTP server (NA) RECVFILE / RF. Receives a file using build in TFTP server. (NA) The MES has a build in TFTP server. The “current directory” is fixed, pointing at the directory where files are stored. The files can be retrieved using a TFTP client connected to the system To get a file, type the IP address of the MES and the filename of the file at the client. The TMA or TCU can be used to find the MES IP address. Presently only LO –x make use of the TFTP.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 22 Messages (store and forward) to and from MES 3 SERVICES Inmarsat-C is a satellite communications system which facilitates data transfer between MESs and fixed LESs which are connected to terrestrial networks. Data can also be transferred from MES to MES via an LES. Services provided by the Inmarsat-C Network: messages (store and forward) to and from MES distress calling (i.e distress alerts and distress priority messages) from MES EGC (including SafetyNET) to MES data reports from MES polling to MES Some of the services supported by the Inmarsat-C system are mandatory; other services are optional as indicated in the following table: Service TT-3027C TT-3027D TT-3027M/LT/SSA Messaging Mandatory Mandatory Mandatory Distress alerting Mandatory Mandatory Not allowed Data Reporting Optional Optional Optional Polling Optional Optional Optional EGC (SafetyNet) Mandatory Optional Optional Table 3.1 Inmarsat Services 3.1 MESSAGES (STORE AND FORWARD) TO AND FROM MES The store and forward data and messaging service is a reliable method of sending data or text messages between an MES and a terrestrial subscriber using the satellite link and a public or private land network. It can also be used for MESe to MES communication within the Inmarsat-C network. Messages originating from a MES are transmitted in packets, via a satellite, to a fixed LES. At the LES the packets are re-assembled before being sent on to their destination. The LES transmits the information in the form nominated by the sender (telex, data or electronic mail, for example). A similar procedure is used for communications being sent in the opposite direction, with callers being able to call one or a group of MESs. To protect the integrity of the message each packet is checked for errors. Where possible, errors are corrected but otherwise a partial acknowledgement is returned, requiring retransmission of the packets in error. Only messages which have been fully received error free are forwarded; the originator is informed if the system is unable to deliver a message. This error correction is applied to communications in both directions.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 23 Messages (store and forward) to and from MES Sending a message from the MES involves two steps. 1. Transfer a file containing the message to the MES using the TR command 2. Transmitting the file using the TX command When a message transmission is initiated, the transmit-log is updated. Since the log and the transmitted file are preserved, the MES can retrieve and send the message after a reboot. 3.1.1 FILE FORMAT Depending on the destination the file may, apart from the message itself, contain the destination addresses. In the following the address format for the supported destination are described. Multiple address lines of the same type (e.g. PSTN) can be specified. After the address information, an empty line must be inserted. TELEX ADDRESS The file shall contain the address information at the beginning of the file. Telex addresses are defined in the ITU-T U.80 recommendation and have the general format. <International telex number><+>[suffix]<CR><LF> Currently only the following suffixes are recognized: 1. Detection of expected destination answer-back as specified with the '/' switch Please note that answer-back checks are not applicable for MES to MES calls 2. Attention line information, which might be added to the message header, as specified within parentheses 3. Request for message delivery acknowledgement as specified with the 'ACK' switch 4. Delayed delivery request as specified with the ',Dxx' switch 5. Time limited delivery as specified with the ',Lxx' switch PUBLIC SWITCHED TELEPHONE NETWORK (PSTN) ADDRESS The file shall contain the address information at the beginning of the file. <International PSTN number><+><CR><LF> PUBLIC SWITCHED DATA NETWORK (PSDN ) X.25 ADDRESS The file shall contain the address information at the beginning of the file. <International PSDN number><+><CR><LF> CLOSED DATA NETWORK ID (DNID) ADDRESS The file contains no address information. DNID specified at the command line.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 24 Messages (store and forward) to and from MES SPECIAL ACCESS CODE (SAC) ADDRESS The file shall contain the address information. The address format depends on the service and the LES configuration; contact the LES operator for details. The special access code addressing is selceted with the “-t 6” option and the SAC is specified at the command line with the “-e NN” option. Examples of sending email using the SAC below. ADDRESS PREFIX The Telex, PSTN and PSDN addresses may be prefixed with a two-digit prefix. The prefixed store and forward service must be used. 3.1.2 MESSAGE ALPHABETS Messages can be transmitted using a 5-bit or a 7-bit alphabet or 8-bit data. Alphabet or data can be selected with the "-l" option of the "tx" command. When a message is transmitted the MES assumes that the file is in ASCII format and will convert the message to the selected 5 or 7-bit alphabet. If 8-bit data is selected no conversion are performed. The 5-bit alphabet (ITA2) defined in ITU-T S.1 with some T&T additions consist of the following characters. the 26 Latin alphabetic characters: a b c d e f g h i j k l m n o p q r s t u v w x y z decimal figures: 0 1 2 3 4 5 6 7 8 9 Punctuation marks and miscellaneous signs: . , : ? ’ - / = ( ) T&T additions: $ # @ % Other characters will be converted to: ? The 7-bit alphabet (IA5) defined in ITU-T T.50. Removing the most significant bit does conversion to this alphabet from ASCII. Destination network Telex PSTN PSDN DNID SAC ITA2 ITA2 ITA2 ITA2 ITA2 IA5 IA5 IA5 IA5 IA5 Data Data Data Data Table 3.2 7-bit alphabet
TT-3027 TT98-147405-A Software Interface Reference Manual Services 25 Messages (store and forward) to and from MES 3.1.3 INMARSAT NETWORK DESTINATION CODES Destination network type All regions code AORE POR IOR AORW Telex (TNIC) 580 581 582 583 584 PSTN (PNIC) 870 871 872 873 874 PSDN (DNIC) 1110 1111 1112 1113 1114 Table 3.3 Inmarsat Network Destination Codes 3.1.4 EXAMPLES SENDING A MESSAGE TO ANOTHER MES USING 5-BIT TELEX, VIA EIK LES(AORE) Content of file named "ex1.txt" 581492380021+<CR><LF> <CR><LF> this is a test telex message with a MES destination. The message is transmitted with the command tx -c 104 -l 6 -t 0 -s 0 ex1.txt SENDING A MULTI-ADDRESSED TELEX MESSAGE USING 7-BIT TO THE FOLLOWING A MES requesting acknowledge and a 1 hour delayed transmission. A MES requesting acknowledge and a limited delivery of 1 hour. A telex receiver with an attention line. Content of file named "ex2.txt" 581492380046+,ack,D01<CR><LF> 581492380237+,ack,L01<CR><LF> 5519298+(ATTENTION BRP)<CR><LF> <CR><LF> This is multi-addressed telex. The message is transmitted with the command tx -c 104 -l 0 -t 0 -s 0 ex2.txt SENDING A MULTI ADDRESSED MESSAGE TO PSTN DESTINATIONS A MES A FAX machine Content of file named "ex3.txt" 871492380046+<CR><LF> 4539558888+<CR><LF> <CR><LF> This is multi-addressed message to an MES and a FAX machine at the PSTN network.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 26 Messages (store and forward) to and from MES The message is transmitted with the command tx -c 104 -l 7 -t 1 -s 0 -e T30 ex3.txt SENDING A MESSAGE TO ANOTHER MES USING PSDN DESTINATION AND 8-BIT DATA. Content of file named "ex4.txt" 1111492380046+<CR><LF> <CR><LF> This is a message to an MES at the PSDN network. The message is transmitted with the command tx -c 104 -l 7 -t 3 -s 0 ex4.txt SENDING AN E-MAIL Sending an E-mail using EIK LES using the Special access code(-t 6), and the email destination extension for EIK LES(28). Content of file named "ex5.txt" TO:[email protected]<CR><LF> CC:[email protected]<CR><LF> SUBJECT:Email Test<CR><LF> <CR><LF> (your email text goes here) The CC: and SUBJECT: fields can be omitted The command to send the message file (called ex5.txt) is then tx ex5.txt -c 104 -s 0 -t 6 -l 0 -e 28
TT-3027 TT98-147405-A Software Interface Reference Manual Services 27 Distress Calling from MES 3.2 DISTRESS CALLING FROM MES "Distress Calls" is a generic term covering both distress alerts and distress priority messages. A distress alert is a data packet carried on a signalling channel. The addressed LES will immediately confirm to the MES that the alert has been received. If automatic or manual position updates are given to the MES, this initial distress alert will include its position and an indication that it has been updated within the last 24 hours. Distress priority messages are store and forward messages having distress priority and can be sent in both directions, i.e. To-Mobile and From-Mobile. The MES support distress and covert alert transmission schemes; the availability of these functions depends on the configuration and the type of the MES. 3.2.1 MARITIME DISTRESS ALERT Maritime Distress alerts may be issued by TT-3027C/D tranceivers. These alerts are handled by LESs wich forwards it to the nearest MRCC. If the distress can not be delivered to the desired LES the MES will send the distress to the NCS it is logged in to. The MESs have the following commands to support the Maritime Distress alert function: Set up alert information. Please see command se –g. The tranceivers have no commands to send a distress alert. The alert is initiated via an alarm button connected to dedicated I/O pin. 3.2.2 COVERT/SECURITY ALERTS The TT-3027C/SSA support a Ship Security Message for flexible routing (MRCC or Ship Owner). The Ship Security Message use the messaging capability of Inmarsat-C to send a covert Message with routine priority to a competent authority designated by the Administration (could be MRCC) or any other recipient such as a ship owner. Please see SSA message format for a specification of the message format used for alert messages. The MES has a set of commands to configure the following: Selection of up to 6 recipient addresses for SSA messages. Please see se -am. Each of these message destinations has a set of extended properties which controls the usage. Please see se -ame. Selection of an additional text note to be attached to SSA messages. Please see SE – ar and SE -atf. Selection of preferred LES. Please see SE -m. 3.2.3 ALERT REPORTING Each of the alert types described in the previous section Covert/Security Alerts may be combined with Alert Reporting. This reporting is an extension of the normal interval reporting. The following points summarize how alert reporting works. Alert reporting is created and configured just like an ordinary interval reporting program. Normally the program should be set up remotely as described in section
TT-3027 TT98-147405-A Software Interface Reference Manual Services 28 Distress Calling from MES Inmarsat PU reporting because this enables subsequent remote control of the reporting in case an alert’ The content of an interval report is configurable. It is recommended to include the I/O information in the data format as this provides information about the current alerting status. Please see DN -p for details about configuration of the data format. When an interval reporting program has been created it is made alert controlled by using the PG -a command that enables or disables the feature and also sets the interval to be used for alert reporting. Please see PG -a. An alert controlled interval program differs from a normal interval program in the following ways: o When an alert is issued, the reporting is started (or reprogrammed if already running) and the interval is set to the alert interval. o The MEM code of the data report is changed to code 91 indicates the alert reporting mode. o The alert reporting bit in the I/O status byte is set. Please see appendix A.1 for details. The reporting mode can only be cancelled by re-programming or stopping the interval program. This can be done via a PU poll as described in section Inmarsat PU reporting Poll. o After cancellation of the alert reporting mode, the interval reporting program behaviour is reset to normal and it will continue ordinary reporting or stop depending on whether an init poll or a stop poll was sent to the MES. o Note that releasing the alert buttons will not cancel alert reporting: An interval program holds its own memory of the previous alert situation and this will not be reset until the program is stopped or changed as described above. In dedicated alert installations that aren’t otherwise operated or used for other purposes, the alert reporting can be configured with default values to make the installation procedure easier. There are two sets of default settings that are relevant in this situation: DN -f describes how to set default settings that apply to download of DNIDs. In particular it can be relevant to set the <auint> selection to have a standard interval program created at DNID download. Furthermore, the commands described in PG -fa to PG-fv can be used to specify the default behaviour for newly created programs. By combining these two functions it is possible to set a predefined set of configuration values so that a DNID download automatically creates an alert controlled interval program as shown in this example: : dn -f 3,1,0,1,0,0,0,0,0,1,0 : dn -f Default Data Network format: Authority level : 3 Time/pos type : Maritime Date format : 0 I/O pin data : Yes Add speed/course : No
TT-3027 TT98-147405-A Software Interface Reference Manual Services 29 Distress Calling from MES Single packet report : No Append userstring : No Extra pos precision : No Tachograph data : No Autocreate intvpgr : 1 Autocreate evpgr : 0 : pg -fa 1,200 Connection no: Default, Alert controlled: 1, Alert interval: 200 : The first command sets ‘Autocreate interval program’ as a default property when downloading DNIDs; the last command enables alert control for future created interval programs. After a DNID download, inspection shows that following program has been created: : pg -d Connection Program Ocean region 0: remote none 104,8048,10 1: closed 2: closed 3: closed : pg -a 0 Connection no: 0, Alert controlled: 1, Alert interval: 200 : Note, that the program is not initiated (started); this will not happen until an alert is issued or until the program is initiated remotely via a poll (see section Inmarsat PU reporting).
TT-3027 TT98-147405-A Software Interface Reference Manual Services 30 EGC (including SafetyNET) to MES 3.3 EGC (INCLUDING SAFETYNET) TO MES The EGC service is a message broadcast service within the Inmarsat-C communications system. EGC messages are sent to LESs using terrestrial facilities such as telex, X.400 electronic mail, and so on. The messages are processed at the LES and forwarded to the NCS. EGC messages for the entire ocean region are queued and scheduled at the NCS for transmission on the NCS common channel. Receiver addressing can be performed on the basis of: unique individual ID group ID geographical area (circular or rectangular) defined by co-ordinates (absolute geographical area address). pre-defined geographical area addressing (e.g. NAVAREA). To receive geographically addressed messages, the MES must store information about its current position. This can be obtained from a navigation system or can be entered into the terminal manually. Two of the services provided are: FleetNET SafetyNET FleetNET is used to send commercial messages to individuals or groups of subscribers (for example, individual companies communicating with their own MESs). SafetyNET is used for broadcasting Maritime Safety Information (MSI) such as navigational warnings, meteorological warnings, meteorological forecasts and other safety related information (including Distress Alert Relays) from official sources. EGC is also used for transmitting Inmarsat system messages.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 31 Data Reports from MES 3.4 DATA REPORTS FROM MES This service allows the MES to send data reports (position data, for example) and short messages. Two access methods are available: reserved access unreserved access Reserved access is used for pre-assigned data reporting. The LES transfers the required information to the MES by poll messages which include instructions on the starting time and duration of the assignment, the type of report that should be transmitted, and the interval between reports. The MES can, after initialisation, be programmed to make subsequent reports at specified time intervals without further intervention. Up to four packets can be transmitted via the signalling channel. For unreserved access, the transmission of the report is initiated by the MES. Only the slot for the first packet of the sequence is selected randomly; access for subsequent packets uses a reservation scheme to guarantee access. Up to three packets, containing at most 32 bytes, can be transmitted via the signalling channel. Two data reporting protocols exist: Basic data reporting protocol and enhanced data reporting protocol. By default the MES will use the enhanced data reporting protocol if the LES support this protocol otherwise the transciver will use the basic data reporting protocol. But it is possible to force the transciver to use basic reporting for a DNID, see PG –fg and PG –g. The basic data reporting protocol is the original data reporting protocol. A basic data report can contain up to 32 bytes The enhanced data reporting protocol provides full acknowledgment of data report transmissions and an automatic retransmission scheme. It is therefore strongly recommended to use the enhanced data reporting protocol. An enhanced data report can contain 37 bytes data. DNID For the MES to be able to send any data reports it must be associated with one or more DNIDs (max. 64 DNIDs). The DNID is loaded into the MES via poll. The LES operator controls the DNID loading procedure. The data deport contains routing information and user data. A DNID and a LES number make the destination. A Data report is routed to a mailbox identified by the DNID in the LES. A DNID is unique in the domain of a specific LES. A group of MES’s may be associated with the same DNID. Each MES within the group is then identified by a member number (1-255). The member number is included in the Data Report as a part of the routing information. A user may initiate Data Report either over the air by use of poll or locally by use of the command da. A DNID and a LES number identify the Data Networks. The DNID and LES are loaded into the MES by means of a poll.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 32 Data Reports from MES As the DNID is loaded into the MES it is set up by use of the DN command. A DNID holds a number of parameters specifying the format of the Data Reports. Use DN –p to change the format. By default a DNID hold a set of default parameters. Use DN –f to change the default parameters. The definition of the basic data report and layout of the user data field are described in appendix A 3.4.1 INTERVAL REPORTS An Interval Report is a Data Report that is automatically sent by the MES. The transmission of the Data Report is repeated with a fixed period of time (interval). Interval reporting is controlled by interval report programs. There are 4 different types of interval programs: A local unreserved program (local PU): Use unreserved data reporting when transmitting reports and is configured using the command PG. A remote unreserved program (remote PU): Use unreserved data reporting when transmitting reports and is configure using polling. A local enhanced pre-assigned program (local PA): (NA) A remote enhanced pre-assigned program (remote PA): Use reserved data reporting when transmitting report and is configured by the LES. Contact the LES to get information about the interface for configuration of enhanced pre-assigned data reporting. Details for all types of interval programs can be viewed using the command PG. The PG command can also be used for creating and configuring local Interval Report Programs. Up to 15 Interval Programs can be defined and each program runs independently and at its own interval. PU programs can be configured with the PG command to use a number of settings for controlling the reporting interval. These settings cannot be used with PA programs which cannot be allowed to change interval in the same way as a PU program. CONFIGURING A LOCAL PU PROGRAM The following example shows how to set up a local PU Interval program. The Interval program is sending Data Reports with a period of 100 frames (one frame = 8.64 sec.), starting at frame 687 the 26 November 2007. The destination is LES 002, 102, 202, 302 (all four oceans are covered) and DNID 10289 (same in all four oceans). The MES has been given member number 3. : pg -d Connection Program Ocean region 0: closed 1: closed 2: closed 3: closed : pg -o 002,10289,3 102,10289,3 202,10289,3 302,10289,3 INFO 459: Connection no. 0 opened : pg -d
TT-3027 TT98-147405-A Software Interface Reference Manual Services 33 Data Reports from MES Connection Program Ocean region 0: local PU[s] 002,10289,3 102,10289,3 202,10289,3 302,10289,3 1: closed 2: closed 3: closed : pg -p 0,100 : pg -d 0 LES DNID Mem OK Err Inter Sub Rd Auth 002 10289 3 0 0 100 0 4 0 102 10289 3 0 0 100 0 4 0 202 10289 3 0 0 100 0 4 0 302 10289 3 0 0 100 0 4 0 Start at : 687 (26-11-07 01:38:56) Next at : End at : Status : 0 - OK : pg -i 0,p : pg -d 0 LES DNID Mem OK Err Inter Sub Rd Auth 002 10289 3 0 0 100 1 4 0 102 10289 3 0 0 100 1 4 0 202 10289 3 0 0 100 1 4 0 302 10289 3 0 0 100 1 4 0 Start at : 687 (26-11-07 01:38:56) Next at : 687 (26-11-07 01:38:56) End at : Status : 0 – OK : Figure 3.1 Activating Interval Data Reporting INTERVAL REPORTING MEM-CODE Data reports normally contain a MEM code that can be used to determine the origin or nature of the report. Interval reports use the following two codes: Reporting MEM code Description Normal 11 Normal interval position reporting and Polled positions, Alert reporting 93 Alert reporting active. Please see section Alert reporting for more information on this topic. Table 3.4 Interval Reporting MEM-Code WEEK SCHEDULE A standard interval report program will keep on reporting periodically regardless of the time of the day. However, in some situations it may be convenient (and more economical) to skip data reports in some periods of the week. Typically this can be used if, e.g., frequent interval reporting is required but only within ordinary working hours. To achieve this, a week schedule can be set up to permit only some of the interval reports to be sent. The following steps set up the week schedule control: The interval program must be set up to send reports as desired; this is described earlier in this section. Additionally the program must be set up to subject to the week schedule; this is done with the PG -e command that described in PG -e (look for the < wksch> option).
TT-3027 TT98-147405-A Software Interface Reference Manual Services 34 Data Reports from MES 3.4.2 EVENT REPORTS If one of the listed events in the table below occurs the MES can be programmed to transmit a Data Report containing information about the event. All event Data Reports contain time and position and a MEM code indicating the type of event. Please see the Data Report format in Appendix A Event T&T Default MEM code Description PowerCtrl 64 (Power Up) 66 (Power Down) At power-up two Data Reports are sent, one Power-down report, including the last known power down time/position, and one report including the power-up time/position. Antenna Blockage 69 (Antenna Blocked) Data report sent when the antenna is blocked (actually the report is sent when the antenna is unblocked afterwards, but with the original postition and time). Stored Position 70 (Stored positiion) IO-pin 71 (Io Report) Any changes of IO-pin status generates a data report including current status of the IO-pins [1..5]. Zone 72 (Enter Zone) 73 (Leave Zone) If Zone Events is set to 2, no event reports will be sent when moving from one zone to another - only when moving from outside zones to inside zones and vice versa. 74 - 79 -- Unused -- Sleep Mode 80 (Enter Sleepmode) 81 (In Sleepmode) 82 (Leave Sleepmode) 83 (Fix Time Begin) Data Reports are sent when the sleep mode function is activated/deactivated and while the MES is waked up (in sleep mode). NOTE: the sleep mode function MUST be activated (see sl -i and section Sleep Mode Setup Poll) if this event should generate any Data reports. 84 -- Unused -- Reduced 85 (Enter Reduced) 86 (In Reduced) 87 (Leave Reduced) (NA) Manual Position 88 (Manual Position) -- Not implemented -- Speed Limit 89 (Above Speed Limits) 90 (Below Speed Limits) Data report are sent when speed event Is enabled and setup with command “set –sp x,y”. Please see GPS Blocked 91 (GPS Blocked) Data report sent when GPS is blocked. Table 3.5 Events generating Data Reports The following example shows how to set up an event program. The event program initiates a Data Report to LES 102, DNID 10289, when the status of the I/O-pins changes. : ev Usage: ev <option> -o <LES>,<DNID>[,<mem>] : Create event program -c <entry> : Delete event program -p <entry>,<powerctrl>,<sleepmode>,<io>, <antennablockedtime>,<gpsblockedtime>, <zoneevents>,<speedevents> : Enable or disable events -e <entry>,<retxfail>,<store>,<normafterantblock> [,<antblockedfn>] : Program set-up -d : Display event status -fp <powerctrl>,<sleepmode>,<io>,
TT-3027 TT98-147405-A Software Interface Reference Manual Services 35 Data Reports from MES <antennablockedtime>,<gpsblockedtime>, <zoneevents>,<speedevents> : Default enable or disable events -fe <retxfail>,<store>,<normafterantblock>, <antblockedfn> : Default program set-up -b <max>,<high>,<low> : Bit error limits for antenna blocked : ev -o 102,10289 : ev -d Entry LES DNID Mem auth pwctrl sleep io retx store nantb antbt gpsbt zone speed antbtfn 0 : 102 10289 3 0 0 0 0 0 0 0 0 0 0 0 0 : ev -p 0,0,0,1,0,0,0,0 : ev -d Entry LES DNID Mem auth pwctrl sleep io retx store nantb antbt gpsbt zone speed antbtfn 0 : 102 10289 3 0 0 0 1 0 0 0 0 0 0 0 0 Figure 3.2 Activating Event Data Reporting ANTENNA BLOCKED EVENT When Antenna Blocked Events are enabled, data reports will be sent whenever the antenna has been blocked for more than a specified period. The minimum time that the antenna must be blocked before the report is sent is configured by the user (Please see EV -p). The antenna is considered blocked if the MES is unable to achieve synchronization with the Inmarsat satellite signal for more than 80 frames (approx. 12 minutes). Note that, depending on the nature of the blockage, the GPS may still have fix in this situation. Antenna blocked reports are not sent until the antenna has been unblocked, but the position in the report is the last known position before the blockage occurred. The command for setting up Antenna Blocked Events (along with the other events) is EV –p. ANTENNA BLOCKED FILTER FEATURE The purpose of the feature is to reduce the number of data reports that come from power and blocking events. Note, that only event and interval programs based on the same DNID can be used to operate with this feature. DNID1 Eventprogram Intervalprogram Data Network IDentifier (dnid) DNID2 Eventprogram Intervalprogram Figure 3.3 Rules for DNID in relation to filter feature. These points summarizes the function: Discards antenna block event reports if the corresponding interval program did not lose any reports during blocking (referred to as filtered unblock events). Discards power up/down event reports if the corresponding interval program did not lose any reports during power off (referred to as filtered power events).
TT-3027 TT98-147405-A Software Interface Reference Manual Services 36 Data Reports from MES The basic purpose of this feature is to reduce traffic and avoid less important data reports when interval reporting is enabled. Note that this feature should not be used if it is important to detect all antenna block reports and power event reports. Consider a MES with an interval reporting set to one hour and a event program which report power- and antenna blocked events. Blocking: A fishing vessel operating in severe weather at high northern latitudes might send blocking data reports as often as every 15 minutes. A truck driving in urban high-rise areas faces a similar situation because the view to the satellite can be obscured. In this case the antenna blocked filtering can be used to suppress the antenna blocking reports except when the interval program actually fails because of the blocking. Frame interval Blocked Antenna block report sent Blocking started With filtered blocking feature disabled: Frame interval Antenna block report sent Blocking started Blocked Interval reports fail because of blocking Note, the blockevent is sent after blocking ends even though reports are lost or not. Short blocking: Prolonged blocking: Figure 3.4 Blocking reports with filtered blocking disabled.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 37 Data Reports from MES Frame interval Blocking started Blocked Interval reports fail because of blocking Frame interval Blocked Antenna block report discarded Blocking started Retransmissions With filtered blocking feature enabled: Prolonged blocking: Short blocking: Antenna block report send Retransmissions Retransmissions Frame interval Blocked Antenna block report discarded Blocking started Short blocking: Retransmissions fail fail Figure 3.5 Antenna blocked reports with filtered blocking enabled. The filtered blocking reports is enabled with the EV -e command; look for the <antblockedfn> command switch). For this feature to operate correctly, it is required to set the interval report retransmission attempt to at least 25. This requirement is crucial because the MES does not enter blocking mode before the BBER rises to 80 frames (each retransmission takes a couple of frames). Use the command "DIAG prot retxrep <no. of retransmissions>" to set retransmissions - only available as system administrator or above. : diag prot retxrep 25 Reports are retransmitted 25 times The recommended retransmissions in relation to the reporting interval is described in a rule of thumb: Report interval Retransmissions = 4 If this requirement is not fulfilled, an undesired data report queue build-up will result in disruption of the blocking filter function. Power down/up: In many types of installations it is not important to detect the loss of power. The filtered power event feature suppresses power up/down reports if the interval program has not lost any reports during the power off.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 38 Data Reports from MES Frame interval Transceiver off Power up/down reports send Frame interval Transceiver off Power up/down reports are discarded Filtered power events: Short power off: Prolonged power off: Figure 3.6 Power reports with filtered power enabled. The filtered blocking reports is enabled with the EV -p command (see section EV –p); look for the <powerctrl> command switch). STORED POSITION EVENT The MES can store the scheduled data reports when the MES is outside Inmarsat-C coverage. When the Inmarsat-C signal is blocked for approximately 12 minutes and the GPS signal is still present the MES will begin store the scheduled data reports in non-volatile memory. When Inmarsat signal is restored and the MES has synchronized to a stable NCS signal for approximately 3 minutes, the MES will begin transmitting the stored data reports. The reports will be sent with a 25 frames interval. Scheduled report will have a new MEM code specifying that it is a saved position and event reports will remain unchanged. The MES is capable of storing up to 250 reports independent of size and type. When the storage area is full the MES will delete the oldest data-reports and store the newest. Please see section 8.13.4 to find out how to enable stored positions. SLEEP MODE EVENTS If a TCU is connected to TT-3027C/D/M/LT/SSA, hardware controlled sleep mode is possible. Please see [7] TT-3027M and D have also a software controlled sleep mode feature: Wake up; send position reports and go to sleep again for a predefined duration. The parameter T1 controls this mode. E.g. T1=4 means sleep 4 hours, wake up, send a position report and go to sleep again for 4 hours. Fix Time wake up. Wake up at a fixed time every day, send a position report and stay awake for a 15 - 60 minutes. The parameters HH, MM and T2 control this mode.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 39 Data Reports from MES E.g. HH=23, MM=0 and T2=30 mean wake up at 23:00 UTC and stay awake for 30 minutes. The purpose of the Fix Time wake up is to allow the MES to receive messages and polls during sleep mode operation; e.g. the MES can receive a poll that changes the sleep mode operation. The following data reports with special MEM codes are defined for sleep mode operation: Enter sleep mode report: Sent when entering sleep. A enter sleep mode report contain the last known position when entering sleep mode. When the report has been send the MES goes to sleep. If not able to send the report the MES will timeout after 13 minutes and go to sleep. In sleep mode report: Sent when waking up just to send a report. The report contains the current time/position. When the report has been sent the MES goes back to sleep. If the current position cannot be obtained the MES will timeout after 5 minutes and try to send the last known time/position instead. If not able to send the report the MES will timeout after 13 minutes and go to sleep. Leave sleep mode report: Sent when leaving sleep mode. A leave sleep mode report contains the current time/position. When the report has been sent the MES has left sleep mode and stay on. If the current position cannot be obtained the MES will timeout after 5 minutes and try to send the last known time/position instead. Fix Time begin report: Sent when waking up in fix time. A fix time report contains the current time/position. When the report has been sent the MES stay on until the fix time is gone then it goes to sleep. If the current position cannot be obtained the MES will timeout after 5 minutes and try to send the last known time/position instead. If not able to send the report before the fix time is gone the MES will go to sleep anyway. Please see the SL command. SPEED LIMIT EVENT This feature enables the MES to send above/below speed-limit data-report. Speed t t t Send event for Above speed-limit Send event for Belowe speed-limit No event sent time for belowlimit was to short Limit Figure 3.7 Speed Limits The same event can never be sent twice. Ex. an above speed limit will always be followed by a below speed limits and visa versa. The first event after power-on is always the above speed-limit. As can be seen on the figure above an event/data-report
TT-3027 TT98-147405-A Software Interface Reference Manual Services 40 Data Reports from MES is only sent if the speed has been stable for a certain time. The data-report always contains the position at the end of time 't'. The speed limit event is configured using SE -sp Enabling/disabling data reports for speed limit events is done using EV -p. For information on configuring one or more I/O-pin(s) to act on speed limit events, see command IO -o. GPS BLOCKED EVENTS When GPS Blocked Events are enabled, data reports will be sent whenever the GPS has been blocked (out of fix) for more than a specified period. The minimum time that the GPS must be blocked before the report is sent is configured by the user. Note that the Inmarsat signal does not necessarily have to be blocked because the GPS signal is blocked, although this will often be the case. The command for setting up GPS Blocked Events (along with the other events) is EV –p.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 41 Polling to MES 3.5 POLLING TO MES Polling is used by the base station to initiate transmission of a data report, message or configuration. Some of the polling commands are defined by Inmarsat; others by T&T. The poll command tells the MES how and when to respond and can also include a coded text message or IA5 text of up to 256 characters (maximum packet length is 300 bytes). All polling packets can include instructions for all the addressed MESs to respond with data reports that acknowledge the poll. There are three types of polling: individual poll group poll area poll INDIVIDUAL POLLING Individual polling means that an explicit poll command is sent to MESs on an individual basis. The poll is originated by a terrestrial subscriber, usually a base station associated with the MESs that are being polled. Using the terrestrial network, the base station sends the LES a list of the MESs which are to be polled. An individual poll command is sent to each MES on the list; if the MES is busy, the poll is queued until the MES is idle. On receipt of a polling command the MES responds in accordance with the instructions it has been given. GROUP POLLING With group polling, a single poll command is broadcast on the NCS common channel. MESs respond only if they are idle and they receive the poll. The transmission of the poll command may be repeated in order to obtain responses from MESs that did not respond the first time. (An MES which responded to the first poll may or may not respond a second time depending on the individual design.) AREA POLLING Area polling is similar to group polling except that only MESs located in a specified geographical area are addressed. This geographical area is defined by coordinates in the poll message. In the following sections poll files, poll addressing and polling commands are described. 3.5.1 INITIAL DATA REPORTING AND POLLING PROCEDURES If the polling and data reporting is used, the following has to done Apply for a DNID at the preferred LES. The service is ready for use when the LES informs that the DNID has been entered in the LES database. Make the LES download the DNID to the MES. Log into the MES in the the correct ocean region (command: LI <ncs_id>) Make the LES initiate a DNID download poll.
TT-3027 TT98-147405-A Software Interface Reference Manual Services 42 Polling to MES Contact the LES and tell which destination the data reports should be routed to (Fax, Telex, PSTN, etc.) The DNID is downloaded when an INFO message (see ST -l) and a poll POLLFILE.XXX file is received. Program the MES locally or from remot via PSTN, PSDN, ISDN or internet/mail The DNID can now be used for data reporting and poll reception. Use the DN -d command to obtain a list of the DNID’s downloaded in the MES. Data reports can only be sent on signaling channels having 'Closed User Group' access, and if this is not the case for a particular LES (all channels will be searched by the MES), the error message 'No Closed User Group service available' will appear. 3.5.2 POLLFILE CONTENTS The format of a pollfile contain a common header and user data. The header part has the following format: Byte Information Remark 0 Header Length Header size including this byte 1 LES ID Compressed Inmarsat format: Two bits for Ocean and 6 bits for ID, e.g. 5FH for LES ID 131 2 LSB of DNID 3 MSB of DNID 4 Member Number 1..255 5 Sub Address 0=DTE Port, 1=GPS, 2= Status Infos, 3=IO-Pin 6 Command Command parameter from poll packet. This includes the Acknowledgement bit (80h) if this was included. Please see section Poll commands. 7 Sequence Number A LES poll packet identifier. This value is returned in an acknowledgement. Table 3.6 Pollfile Header Byte Information Remark 8 Member Number In binary 9-31 Provider name In ASCII with Odd Parity. The name may be shorter than 25 characters. If user data is available, the name will be padded with (space) characters. 32-307 User supplied data Binary data Table 3.7 DNID User Data 3.5.3 POLL SYNTAX The poll in Inmarsat-C has a defined syntax, which is:
TT-3027 TT98-147405-A Software Interface Reference Manual Services 43 Polling to MES Poll <P1>,<P2>,<P3>,<P4>,<P5>,<P6>,<P7>,<P8>,<P9>,<P10>,<P11> Where each Parameter means: P1 = Satellite(0=AORW, 1=AORE, 2=POR, 3=IOR) P2 = Poll Type(i = Individual, g = Group) P3 = DNID(1 – 65535) P4 = Response(d=Data Report, m=Message, n=None) P5 = Sub Address(0 = DTE Port, 1=GPS, 2, Status Infos, 3=IO-Pins) P6 = Mobile No(400000000 – 499999999) P7 = Poll Command(0 – 255) P8 = Member No(1 – 255) P9 = Start Frame(0 – 9999) P10 = Report/24h(1 – 500) P11 = Acknowledge(1 / 0) P1 = Specifies the satellite the MES is logged in to. P2 = Specifies the Poll Type. Individual poll is used when polling a single MES and Group poll is used when polling a fleet of MESs. P3 = Specifies the DNID number downloaded in the MES(s). P4 = Specifies the response type to the poll. This is normally set to Data report when addressing sub address 1 (P5 = GPS) P5 = Specifies the sub address in the MES. Sub Address 0: Sub Address 0 By sending a poll to the Sub address 0 (P5=0) the MES will store the poll in a poll file with the filename “POLLFILE.XXX”. The XXX is a three-digit number that counts up. Sub Address 1: Polls to sub address 1 (P5=1) will be handled by the MES. It can be a poll to demand a position report, set up an interval program, to start it, stop it etc. Sub Address 2: Polls to sub address 2 (P5=2) with response set to data report (P4=d) can instruct the MES to send back a Response report with information about Serial No., Mobile No., Mobile Type, Software version and the DNID List. Sub Address 3:
TT-3027 TT98-147405-A Software Interface Reference Manual Services 44 Polling to MES Polls to sub address 3 goes to the I/O-Pins of the MES. It can be poll commands to read or set the I/O Pins. P6 = Specifies the Mobile Number of the MES in an Individual poll (P2=i). In a group poll (P2=g) the mobile number is set to 0 (zero) as it concerns all members in a fleet. P7 = Specifies the Poll Command that is used to configure or interrogate the MES. See a complete list of supported poll commands in appendix 2. P8 = Specifies the Member No. of the DNID, which again refers to a single MES in a fleet. This is used when sending an individual poll (P2=i). In a group poll (P2=g) the Member No. is set to 0 (zero) as it concerns all members in a fleet. P9 = Specifies the Start Frame of a Program Poll (P7=4). The Start Frame refers to the time of the day where the program should start reporting after it has been started with a Start Poll (P7=5). The Inmarsat-C system is a TDM channel system, which is divided into 10.000 frames per 24 hours. Starting with frame 0 at 00:00:00 UTC time and incremented every 8.64 seconds until it reaches frame number 9999 at midnight again. See figure 3 illustrating this. In all other poll commands than Program Poll (P7=4) this parameter has no effect and can be set to 0. P10 = Specifies how many position reports the user wants per day from the MES. This parameter has to be specified in a Scheduled Program Poll (P7=4). In all other poll commands this parameter has no effect and can be set to 0. P11 = If this parameter is set to 1 (one) it indicates to the MES to send an acknowledgement when receiving this poll. When set to 0 (zero) the MES will not send any acknowledgement. With some Poll Commands it is not necessary to demand the MES to send an acknowledgement. Or instance in a Demand Poll Command (P7=0) it is not necessary to ask for acknowledgement as the MES will send its position anyway if the Demand Poll is received 3.5.4 POLL COMMANDS The poll commands are used to program the MES for position reporting, I/O status, downloading of zones etc. The poll commands can be sent from the base station to the LES using different connections: E-Mail FTP PSTN/ISDN X.25 The MES supports the following commands:
TT-3027 TT98-147405-A Software Interface Reference Manual Services 45 Polling to MES Command Command Name Meaning 0AH (10) Download DNID Add the DNID to memory 0BH (11) Delete DNID Remove the DNID from memory 00H (0) Request response Used to convey a request to the User Application (not the MES) 04H (4) PU Program Store program information in the MES and mark this as the start time. Contains a start frame number and a frame interval. 05H (5) PU Initiate Initiate the stored program (especially the device at <sub-address>. 06H (6) PU Stop Stop the stored program. Table 3.8 Inmarsat Defined Polls Command Command Name Meaning 6AH (106) Sleep mode Setup Sleep mode. 6CH (108) Remote configuration Remotely configure MES. Used to setup surveillance zones. Table 3.9 T&T Defined Polls to Sub-address 1 Command Command name Meaning 70H (112) Set I/O Set the I/O pins. 71H (113) Read I/O Read the I/O pins and return a datareport. Table 3.10 T&T Defined Polls to Sub-address 3 DEMAND POLL (0) Demand a single position report from the MES immediately: Command: P7= 0 Sub Address: P5=1 Attachment: None STATUS INFO POLL (0) Instruct the MES to send a data report containing the MES status information (serial no., mobile no., mobile type and sw version no. Command: P7= 0 Sub Address: P5=2 which refers to the Status of the MES. There is no need to request acknowledgement on the poll as the MES will answer back the status info as a data report if it received the Status Info poll. Attachment: 00h
TT-3027 TT98-147405-A Software Interface Reference Manual Services 46 Polling to MES DNID LIST POLL (0) The DNID List Poll is used to instruct the MES to send back a data report containing information about the DNIDs that are present in the MES. Command: P7= 0 Sub Address: P5=2 which refers to the Status of the MES. There is no need to request acknowledgement on the poll as the MES will answer back the status info as a data report if it received the DNID List poll. Attachment 01h PROGRAM POLL (4) Download a scheduled program sending position report automatically at a certain interval into the MES. The start time for the program relates to the UTC time and the associated Inmarsat-C system frame number. Command: P7= 4 Sub Address: P5=1 Attachment: None PROGRAM START POLL (5) Starts a scheduled program, which has already been downloaded to the MES with the Program Poll Command. Command: P7=5 Sub address 1 Attachment: None PROGRAM STOP POLL (6) Stop a program, which has already been downloaded and started. The syntax for the Stop Scheduled Program Poll is: Command: P7= 6 Sub Address: P5=1 Attachment: None SLEEP MODE POLL (106) Setup sleep mode Command: P7= 106 Sub address 1 Attachment:
TT-3027 TT98-147405-A Software Interface Reference Manual Services 47 Polling to MES T1 (1byte), 0..24, Duration in hours between wakeup. T1=0=no wakeup HH (1byte), 0..23, HH and MM UTC time for fixed time wake up MM (1byte), 0.59 T2 (1byte), 0..60, Duration in minutes for fixed time wakeup REMOTE CONFIGURATION (108) Allows for remote configuration. Presently partial zone configuration is supported Command: P7=108 Sub Address: P5=1 Attachment: Please see Appendix B SET I/O POLL (112) Change the state of one or more of the five I/O pins (I/O Pin 2 to I/O Pin 6). Command: P7= 112 Sub Address 3 which refers to the hardware I/O pins in the MES. There is no need to request acknowledgement on the poll if the MES has been configured to automatically send I/O event reports on I/O state changes. Attachment. (binary) has to be created which must contain information of which I/O pins that needs to be changed. This attachment has to be included in the E-Mail poll message. Each I/O Pin has to be defined by two bits are there are three different ways to define the pin: Go HIGH Go LOW Do not change state The attachment has to be created following way: Where: Bit 0-1specifies the I/O 2 state Bit 2-3 specifies the I/O 3 state Bit 4-5specifies the I/O 4 state Bit 6-7 specifies the I/O 5 state Bit 8-9specifies the I/O 6 state The two bits specify: 00 = LOW output (0 Volt)
TT-3027 TT98-147405-A Software Interface Reference Manual Services 48 Polling to MES 01 = HIGH output (3.3 Volt) 11 = Unchanged (Do not change Output state) READ I/O POLL (113) Sends back a position report containing the status of all five I/O pins (I/O Pin 2 to I/O Pin 6). Command: P7=113 Sub Address: P5=3 which refers to the hardware I/O pins in the MES. There is no need to request acknowledgement on the poll as the MES should send back a position report including the status of the I/O pins anyway. Attachment: None 3.5.5 ACKNOWLEDGEMENT AND DATA REPORTS The LES will append an API header to the acknowledgement and data report as a prefix. The API header contains information about where the acknowledgement or data report comes from i.e. DNID number, member number and LES. The API header is not subject to charge, as it has not been sent over the satellite link. POLL ACKNOWLEDGEMENTS An acknowledgement is a confirmation that informs the base station that the MES has received the poll. The acknowledgement consists of 8 bytes where the most important bytes contain the poll command, which together with the API header information is used to identify the related poll and the result code stating the outcome of the poll. The parameter P11 in the poll command has to be set to 1 (one) to instruct the MES to send an acknowledgement report, which confirms that the MES has received the poll. It is recommended to apply for an acknowledgement on all poll commands except for the Demand poll command and Read I/O poll command because these polls will automatically respond with a report which confirms that the poll has been received by the MES. Please see Poll acknowledgement format appendix H and Data Report format in appendix A.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 49 Polling to MES 4 COMMAND REFERENCE The MES provides a text-based command interface accessable from either a PC via the TCU using a serial or LAN connection (please see [7]), or via a MT (please see[8]). Please note. The command interface was originally designed for use in former MESs and it has been a requirement that it remain compatible with legacy products. This means, that some commands are still shown, but not applicable. This is marked with (NA). The command prompt is configurable and will in this document be the ‘colon’ character ‘:’. Once the MES issues the prompt, just type in the desired shell command. A typical example of a command description is: ncs -r <ncs_id> where "ncs" is the command name, "-r" is the option switch and "<ncs_id>" is the parameter value that should be supplied. Short forms are available for most commands; usually they are the first two letters of the full command name. The commands are not case-sensitive however the command options may. The prompt sequence from the MES is in this notation: <Previous command …> <CR><LF> :<SPACE> Please note that there is a space character after the colon character. The results of the commands are returned in INFO or ERROR messages. By default, these messages are not displayed but stored in a log, which can be accessed using the ST –l command. This is called silent mode. Silent mode can be turned off using the command SE -r. When silent mode is off, all INFO and ERROR messages will be printed directly to the console. A list of messages can be found in the paragraph 5
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 50 CA 4.1 CA 4.1.1 CA ____________________________________ CALIBRATE FREQUENCY CORRECTION Purpose: Issues a calibration of the frequency correction. Format: CA <ocean_region> ocean_region: W | E | P | I In some rare circumstances, it might be necessary to issue a calibration command. If the MES is unable to synchronize to the TDM channel because the MES has been stored for 6 months or more, at extreme temperatures or other reasons. A frequency calibration might solve the synchronizing problems. When a calibration is issued, the MES searches for a NCS TDM, starting with the ocean region specified by the command argument. The calibration will not stop until a NCS TDM has been found. A successful calibration could take several minutes (up to 45 minutes). Note: When the MES synchronized to a NCS TDM the frequency correction is done automatically. Therefore, calibration of the frequency correction is not necessary under normal circumstances. 4.2 CAT 4.2.1 CAT _____________________________________ DISPLAY THE CONTENTS OF A FILE Purpose: Display the contents of a file. Format: CAT <filename> <options> This command will display the contents of a file on the console the way the DOS typecommand does if no options are specified. 4.2.2 CAT -B __________________________________________________ TYPE BINARY Purpose: The file is typed binary. Format: CAT <filename> -b <options> The file is typed binary. In the first line the byte count is given. All characters from 00H to FFH are used. After typing the file the MES automatically removes the file from its memory unless the -k option is added. 4.2.3 CAT -K _________________________________________________ TYPE AND KEEP Purpose: The file is typed and the file is kept in the MES. Format: CAT <filename> -k <options> The file may be deleted using the delete command.