Gdn0559 - Sat-200 - 202 Scripting API and Command Interface

8/8/2019 Gdn0559 - Sat-200 - 202 Scripting API and Command Interface

1/130

SAT-200/202 SCRIPTING API AND COMMAND INTERFACE

Document No: GDN-0559

Issue: 1

Copy No: .................

Date: .................

SAT-200/202 SCRIPTING API AND

COMMAND INTERFACE

Project: PRN-0090

Date: 11 May 2009

Amendment Record

Issue Description Date Implemented By Approved By

1 Initial Issue 22nd April 2009 John Hatherall John Hatherall

2

3

[This document complies fully with the Design Inputs referenced within]

Typing Reference: JRH

Commercial In Confidence


2/130


GDN-0559 Issue 1

COPYRIGHT

Copyright in this document is vested in Satamatics Ltd. This document is issued in confidence for thepurpose only for which it is supplied. It must not be reproduced in whole or in part except with the

consent in writing of Satamatics Ltd and then only on the condition that this notice is included in anysuch reproduction. No information as to the contents or subject matter of this document or any partthereof arising directly or indirectly therefrom shall be given orally or in writing or communicated inany manner whatsoever to any third party being an individual firm or company or any employeethereof without the prior consent in writing of Satamatics Ltd.

Satamatics Ltd Page i of xCommercial In Confidence


3/130


GDN-0559 Issue 1

CONTENTS

1 INTRODUCTION........................................................................................................................1 2 TERMINAL DETAILS ...............................................................................................................2

2.1 Processors ..............................................................................................................................22.2 Physical Interface ..................................................................................................................2

3 PROGRAMMING MODEL .......................................................................................................34 SCRIPTING OVERVIEW ..........................................................................................................45 SCRIPTING MODULES AND REGISTERS...........................................................................5

5.1 Functional Modules ...............................................................................................................55.2 Registers ................................................................................................................................6

5.2.1 Configuration Module Registers...................................................................................75.2.2 Timer Module Registers ...............................................................................................85.2.3 Alarm Module Registers.............................................................................................105.2.4 Interface Module Registers.........................................................................................12

5.2.5 GPS Module Registers................................................................................................135.2.6 Messaging Module Registers......................................................................................145.2.7 Scratchpad Module Registers .....................................................................................155.2.8 Operation Configuration Registers .............................................................................165.2.9 Constant Generator Registers .....................................................................................17

5.3 Configuration Module .........................................................................................................185.3.1 Ocean Region Selection Register................................................................................185.3.2 Service ID Selection Register .....................................................................................185.3.3 Satellite Selection Mode .............................................................................................19

5.3.3.1 Auto Select on Start Up..........................................................................................195.3.3.2 Follow Best Satellite Operation..............................................................................195.3.3.3 Switch On Satellite Loss ........................................................................................19

5.3.4 Power Control Register...............................................................................................205.3.5 DSP Firmware Version Number.................................................................................215.3.6 MSP Firmware Version Number ................................................................................215.3.7 Application Script Version Number ...........................................................................215.3.8 Store Application Script..............................................................................................215.3.9 Delete Application Script............................................................................................215.3.10 Power Supply Status ...................................................................................................215.3.11 NMEA Message Output..............................................................................................225.3.12 Slotted Receive Mode Register...................................................................................225.3.13 Slotted Receive Mode Maximum Acquisition Retries ...............................................225.3.14 ISN, & PSN.................................................................................................................235.3.15 Hardware Version .......................................................................................................235.3.16 Group PID...................................................................................................................235.3.17 Service ID / Beam ID..................................................................................................235.3.18 Operational Flags........................................................................................................235.3.19 Terminal Mobility.......................................................................................................235.3.20 PACC Enable..............................................................................................................235.3.21 GEM Compatibility Enable ........................................................................................245.3.22 Terminal Reset............................................................................................................245.3.23 Scripting Capabilities..................................................................................................24

5.4 Timer Module......................................................................................................................255.4.1 Timer Functionality ....................................................................................................25

5.4.1.1 Updating Timer Trigger Values .............................................................................255.4.2 Timer Count Register..................................................................................................255.4.3 Timer Configuration Register .....................................................................................25

Satamatics Ltd Page ii of xCommercial In Confidence


4/130


GDN-0559 Issue 1

5.4.3.1 Enable.....................................................................................................................26 5.4.3.2 Repeat.....................................................................................................................26 5.4.3.3 Mode.......................................................................................................................265.4.3.4 Operation Number ..................................................................................................26

5.4.3.5 Terminal Count Value ............................................................................................265.4.4 Timer Control .............................................................................................................26

5.4.4.1 Stop Timers ............................................................................................................265.4.4.2 Start Timers ............................................................................................................265.4.4.3 Reset Timers...........................................................................................................275.4.4.4 Restart Timers ........................................................................................................275.4.4.5 Combined Operation to Enable and Disable Timer Channels................................275.4.4.6 Combined Operation to Restart and Reset Timer Channels...................................27

5.4.5 Mixed Timer/Alarm Operations .................................................................................275.4.5.1 Mixed Operation to Enable Timer and Alarm Channels ........................................275.4.5.2 Mixed Operation to Disable Timer and Alarm Channels.......................................275.4.5.3 Mixed Operation to Restart Timer and Alarm Channels........................................28

5.4.5.4 Mixed Operation to Reset Timer and Alarm Channels ..........................................285.4.6 Real Time Functionality .............................................................................................28

5.4.6.1 Seconds Past Midnight ...........................................................................................285.4.6.2 Time and Date ........................................................................................................28

5.5 Alarm Module .....................................................................................................................295.5.1 Alarm Functionality....................................................................................................29

5.5.1.1 Updating Alarm Threshold Values.........................................................................295.5.2 Alarm Control/Status ..................................................................................................295.5.3 Alarm Configuration...................................................................................................30

5.5.3.1 Enable.....................................................................................................................30 5.5.3.2 Latch Mode.............................................................................................................305.5.3.3 Auto Latch Release.................................................................................................305.5.3.4 Operation Number ..................................................................................................305.5.3.5 Comparison Mode ..................................................................................................315.5.3.6 Target Register ID ..................................................................................................31

5.5.4 Alarm Threshold .........................................................................................................315.5.5 Alarm Control.............................................................................................................31

5.5.5.1 Disable Alarms .......................................................................................................315.5.5.2 Enable Alarms ........................................................................................................315.5.5.3 Reset Alarms ..........................................................................................................325.5.5.4 Trigger Alarms .......................................................................................................325.5.5.5 Toggle Alarms ........................................................................................................325.5.5.6 Restart Alarms........................................................................................................32

5.5.5.7 Combined Operation to Enable and Disable Alarm Channels ...............................325.6 Interface Module .................................................................................................................335.6.1 I/O Configuration Register .........................................................................................335.6.2 Analogue Inputs..........................................................................................................345.6.3 Digital Inputs ..............................................................................................................345.6.4 Digital Outputs............................................................................................................355.6.5 Processor Supply Voltage...........................................................................................355.6.6 External Supply Voltage.............................................................................................355.6.7 GEM-100 Battery Supply Voltage..............................................................................355.6.8 Device Temperature....................................................................................................365.6.9 Calibrated Temperature ..............................................................................................365.6.10 GEM-100 Battery Temperature ..................................................................................36

5.6.11 GEM-100 Battery Power Output ................................................................................365.6.12 GEM-100 User LED State..........................................................................................36

Satamatics Ltd Page iii of xCommercial In Confidence


5/130


GDN-0559 Issue 1

5.7 GPS Module ........................................................................................................................375.7.1 Current Position ..........................................................................................................37

5.7.1.1 Status ......................................................................................................................375.7.1.2 Latitude...................................................................................................................37

5.7.1.3 Longitude................................................................................................................375.7.1.4 Speed ......................................................................................................................375.7.1.5 Heading ..................................................................................................................375.7.1.6 Altitude...................................................................................................................38 5.7.1.7 Horizontal Dilution of Precision (HDOP) ..............................................................38

5.7.2 Reference Position ......................................................................................................385.7.2.1 Store Current Position as Reference.......................................................................385.7.2.2 Reference Latitude..................................................................................................385.7.2.3 Reference Longitude ..............................................................................................385.7.2.4 Distance from Reference ........................................................................................38

5.7.3 Target Positions ..........................................................................................................385.7.3.1 Distance from Target..............................................................................................38

5.7.3.2 Distance to Closest Target......................................................................................395.7.3.3 Distance to the Farthest Away Target ....................................................................395.7.3.4 Target Latitude .......................................................................................................395.7.3.5 Target Longitude ....................................................................................................39

5.7.4 NMEA registers ..........................................................................................................395.7.5 Last GPS fix................................................................................................................395.7.6 Geofence .....................................................................................................................39

5.7.6.1 Geofence Status......................................................................................................395.8 Messaging Module ..............................................................................................................40

5.8.1 Return Burst Message ID Register .............................................................................405.8.1.1 Creating User Defined Messages ...........................................................................41

5.8.2 Return Burst Destination Address Register ................................................................415.8.3 Combined Control Word and Destination Address ....................................................415.8.4 Return Burst Acknowledge Flags ...............................................................................415.8.5 Return Burst Control Flags.........................................................................................415.8.6 Return Channel Message Scrambling Vector .............................................................415.8.7 Terminal Receiver Status Registers............................................................................42

5.8.7.1 Receiver Channel Number .....................................................................................425.8.7.2 Receiver Signal Quality..........................................................................................425.8.7.3 Receiver Status .......................................................................................................42

5.8.8 Terminal Transmitter Status Register .........................................................................425.8.9 Transmit Randomisation Period .................................................................................435.8.10 Transmit Retries..........................................................................................................44

5.8.11 Receive Signal Level ..................................................................................................445.8.12 Receive Frequency Offset...........................................................................................445.8.13 Receive Rate of Change Frequency............................................................................445.8.14 Receive Symbol Errors ...............................................................................................445.8.15 Number of Messages in the Transmit Queue..............................................................445.8.16 Transmit Queue Configuration ...................................................................................445.8.17 Poll Message Control Registers..................................................................................44

5.8.17.1 Poll Message ID .....................................................................................................455.8.17.2 Poll Message Repeat Rate ......................................................................................45

5.8.18 Tone Only Message Response Registers ....................................................................455.8.19 Forward Channel Message Output Mode Register .....................................................45

5.9 Scratchpad Module..............................................................................................................46

5.9.1 Scratchpad Register Special Functions.......................................................................465.9.1.1 Scratchpad Register 0.............................................................................................46

Satamatics Ltd Page iv of xCommercial In Confidence


6/130


GDN-0559 Issue 1

5.9.1.2 Scratchpad Registers 1 and 2..................................................................................465.10 Operations Module ..............................................................................................................47

5.10.1 Operation Definitions .................................................................................................475.10.2 Operation Configuration Register...............................................................................47

5.10.2.1 Operation Enable....................................................................................................475.10.2.2 Operation Chaining ................................................................................................475.10.2.3 Operation Function Codes......................................................................................485.10.2.4 Update Stored Script...............................................................................................485.10.2.5 Do Not Update Running Script ..............................................................................485.10.2.6 Target Register ID ..................................................................................................49

5.10.3 Operation Value Register............................................................................................495.10.4 Disable Operations......................................................................................................495.10.5 Enable Operations.......................................................................................................495.10.6 Reset Operations.........................................................................................................495.10.7 Trigger Operations......................................................................................................49

5.11 Constant Generator Module.................................................................................................50

6 OVER AIR REMOTE CONTROL..........................................................................................516.1 Trigger Operation Message .................................................................................................516.2 Remote Terminal Poll..........................................................................................................516.3 Remote Digital Output Control ...........................................................................................526.4 Set Target Position ..............................................................................................................526.5 Read/Write Terminal Register.............................................................................................536.6 Return Read Register Message Format.............................................................................54

7 SERIAL COMMAND INTERFACE .......................................................................................557.1 Command & Response Formats..........................................................................................55

7.1.1 Command format ........................................................................................................557.1.2 Response Format.........................................................................................................55

7.2 Command Availability ........................................................................................................567.3 Terminal Configuration Module Commands.......................................................................57

7.3.1 CA Get/Set the Terminal Satellite Selection Mode.................................................577.3.2 CB Select Ocean Region..........................................................................................577.3.3 CE Get/Set the Terminal Power Control State.........................................................577.3.4 CF Set the Terminal to Factory Defaults ..................................................................587.3.5 CI Get/Set the Service ID Selection.........................................................................587.3.6 CN NMEA Message Output Control.......................................................................587.3.7 CP Get MSP Firmware Version...............................................................................597.3.8 CR Reload Terminal Application Script..................................................................597.3.9 CS Get/Set Application Script Software Version ....................................................597.3.10 CU Get/Set Operating Power Mode ........................................................................59

7.3.11 CV Get DSP Software Version................................................................................607.3.12 CW Wipe Script Software .......................................................................................607.3.13 CZ Store Script in Non-Volatile Memory................................................................60

7.4 Interface Module Commands ..............................................................................................617.4.1 IA Get Analogue Input ............................................................................................617.4.2 IC Configure Inputs/Outputs....................................................................................617.4.3 ID Get Digital Inputs ...............................................................................................627.4.4 IE Get/Set Digital Outputs.......................................................................................627.4.5 II Get GEM-100 External Power Supply Status......................................................627.4.6 IP Get MSP Power Supply Level.............................................................................637.4.7 IO Configure GEM-100 Battery Power Output.......................................................637.4.8 IQ Get GEM-100 Battery Temperature ...................................................................63

7.4.9 IS Get External Power Supply Level.......................................................................637.4.10 IT Get Terminal Temperature..................................................................................64

Satamatics Ltd Page v of xCommercial In Confidence


7/130


GDN-0559 Issue 1

7.4.11 IU Get/SET GEM-100 User LED State...................................................................647.4.12 IX Get GEM-100 Battery Power Supply Level.......................................................64

7.5 Timer Module Commands...................................................................................................657.5.1 TC Configure Timer ................................................................................................65

7.5.2 TD Disable Timers...................................................................................................657.5.3 TE Enable Timers ....................................................................................................657.5.4 TM Get/Set Timer Trigger Value ............................................................................657.5.5 TR Reset Timers ......................................................................................................667.5.6 TS Restart Timers ....................................................................................................667.5.7 TT Get Current Time and Date (UTC) ....................................................................667.5.8 TV Get Current Timer Value...................................................................................67

7.6 Alarm Module Commands ..................................................................................................687.6.1 AC Configure Alarms..............................................................................................687.6.2 AD Disable Alarms..................................................................................................687.6.3 AE Enable Alarms ...................................................................................................687.6.4 AF Trigger Alarms...................................................................................................69

7.6.5 AR Reset Alarms .....................................................................................................697.6.6 AT Alarm Threshold................................................................................................69

7.7 Operation Module Commands.............................................................................................707.7.1 OC Configure Operation..........................................................................................707.7.2 OD Disable Operations............................................................................................707.7.3 OE Enable Operations .............................................................................................717.7.4 OR Reset Operations ...............................................................................................717.7.5 OT Trigger Operations.............................................................................................71

7.8 GPS Module Commands .....................................................................................................727.8.1 GPS Status and Configuration Commands.................................................................72

7.8.1.1 GM Get GPS Satellite Signal Strengths ..............................................................727.8.1.2 GS Get GPS Status..............................................................................................727.8.1.3 GE Get GPS Software Version Number..............................................................72

7.8.2 GPS Position Commands............................................................................................737.8.2.1 GA Get Current GPS Altitude.............................................................................737.8.2.2 GH Get Current GPS Heading.............................................................................737.8.2.3 GP Get Current GPS Position..............................................................................737.8.2.4 GV Get Current GPS Speed ................................................................................74

7.8.3 Geofence Commands..................................................................................................747.8.3.1 GD Define Geofence...........................................................................................747.8.3.2 GF Define Geofence Point ..................................................................................747.8.3.3 GW Store Geofence Data ....................................................................................757.8.3.4 GZ Define Geofence Zone ..................................................................................75

7.8.4 Reference Position Commands...................................................................................767.8.4.1 GL Distance to Reference....................................................................................767.8.4.2 GR Define Reference Point .................................................................................767.8.4.3 GX Store Current Position as Reference .............................................................76

7.8.5 Target Position Commands.........................................................................................777.8.5.1 GK Distance to Target Position...........................................................................777.8.5.2 GT Define Target Position ..................................................................................77

7.8.6 Logging Commands....................................................................................................787.8.6.1 GI Set GPS Logging Interval...............................................................................797.8.6.2 LN Get Number of Logged Positions..................................................................807.8.6.3 LR Get Logged Record .......................................................................................80

7.9 Messaging Module Commands ...........................................................................................82

7.9.1 Forward Channel Message Handling..........................................................................827.9.1.1 Forward Channel Message Buffering.....................................................................82

Satamatics Ltd Page vi of xCommercial In Confidence


8/130


GDN-0559 Issue 1

7.9.1.2 MCGet Number of Forward Messages Buffered..................................................827.9.1.3 mf Forward Channel Message Data ....................................................................827.9.1.4 MN Get Next Forward Message from the Buffer................................................837.9.1.5 MO Configure Forward Channel Message Output..............................................83

7.9.2 Return Channel Messaging.........................................................................................847.9.2.1 MA Get/Set Return Message Destination Address .............................................847.9.2.2 MB Transmit a Return Message..........................................................................847.9.2.3 MK Get/Set Return Message Acknowledge Flags ..............................................847.9.2.4 ML Get/Set Return Message Control Flags Field ...............................................857.9.2.5 MM Transmit Return Message............................................................................857.9.2.6 MP Configure Automatic Poll.............................................................................857.9.2.7 MQ Get/Set Response to a Tone only Message ..................................................867.9.2.8 MR Report Receiver Status.................................................................................867.9.2.9 MS Get/Set Return Message Transmission Slot Randomisation ........................867.9.2.10 MT Report Transmitter Status.............................................................................87

7.10 Scratchpad Module Commands...........................................................................................87

7.10.1 SR Read/Set Register...............................................................................................877.11 Register Direct Access Commands .....................................................................................88

7.11.1 RR Read Register.....................................................................................................887.11.2 RW Write Register...................................................................................................88

7.12 User Return Message Definition Commands ......................................................................897.12.1 BD Define Message Number...................................................................................897.12.2 BF Define Field Contents ........................................................................................897.12.3 BI Initialise User Message Database .......................................................................897.12.4 BN Get Number of Message Definitions.................................................................897.12.5 BQ Get Message Definition.....................................................................................907.12.6 BW Close Message Database ..................................................................................90

7.13 Terminal System Commands...............................................................................................917.13.1 Firmware Upload ........................................................................................................91

7.13.1.1 PD Program Upload ............................................................................................917.13.1.2 pa Program Record Acknowledge.......................................................................917.13.1.3 pn Program Record NAK ....................................................................................92

7.13.2 PI Reset....................................................................................................................927.13.3 PR Configure Serial Port Baud Rate........................................................................927.13.4 PS Scripting Enable/Disable....................................................................................937.13.5 PT Run Production Tests .........................................................................................937.13.6 PV Report Bootloader Version................................................................................937.13.7 PY Report MSP Software Information....................................................................937.13.8 PZ Report Unit Serial Number ................................................................................94

7.14 Inmarsat-D Network Configuration Commands .................................................................957.14.1 DS PY Report DSP Software Information...............................................................957.14.2 DS PW Enter Access Password ...............................................................................957.14.3 DS TA Get/Set Service ID (SID).............................................................................957.14.4 DS TC Get/Set Pager Subset Number (PSN)...........................................................967.14.5 DS TE Get/Set Beam ID..........................................................................................967.14.6 DS TG Get/Set the Group PIDs..............................................................................967.14.7 DS TJ Get Configured Service IDs..........................................................................977.14.8 DS TK Get/Set the Number of RC Transmission Retries........................................97 7.14.9 DS TM Get/Set the Terminal Mobility....................................................................977.14.10 DS TN Get the Terminal ISN ..................................................................................987.14.11 DS TO Get/Set the Operational Flags......................................................................98

7.14.12 DS TR Report Receiver Status ................................................................................987.14.13 DS TS Report Signal Status.....................................................................................99

Satamatics Ltd Page vii of xCommercial In Confidence


9/130


GDN-0559 Issue 1

7.14.14 DS TT Report Transmitter Status ..........................................................................1007.14.15 DS TW Return Channel Transmission Queue Write Function..............................1017.14.16 DS TZ Write/Restore Configuration to/from Non-Volatile Memory.....................101

7.15 NMEA Input/Output Messages .........................................................................................103

7.16 Script Debugging Messages ..............................................................................................1057.16.1 za - Alarm Trigger Message .....................................................................................1057.16.2 zo Operation Chain Message .................................................................................1057.16.3 zt Timer Trigger Message......................................................................................105

7.17 Error Messages ..................................................................................................................1067.18 Command Summary..........................................................................................................108

A APPENDIX A EXAMPLE GEOFENCE DEFINITION...................................................A-1A.1 Introduction .......................................................................................................................A-1A.2 Definition...........................................................................................................................A-1A.3 Geofence Constraints.........................................................................................................A-2A.4 Geofence Definition Sequence ..........................................................................................A-2A.5 Example Geofence Definition ...........................................................................................A-3

B APPENDIX B EXAMPLE USER MESSAGE DEFINITION ..........................................B-1B.1 Message Number Definition..............................................................................................B-1B.2 Message Field Data Selection............................................................................................B-1B.3 Message Definition Rules..................................................................................................B-1B.4 Message Definition Commands.........................................................................................B-2B.5 Programming Command Sequence ...................................................................................B-2B.6 Example - Time Stamped Analogue Input Report ............................................................B-2

C APPENDIX C NOTES FOR USERS MIGRATING FROM THE SAT-201 SERIES. ..C-4

Satamatics Ltd Page viii of xCommercial In Confidence


10/130


GDN-0559 Issue 1

TABLESTable 1 Terminal Module ID Codes ....................................................................................................5Table 2 Configuration Module Registers.............................................................................................7Table 3 Timer Module Registers .........................................................................................................9

Table 4 Alarms Module Registers .....................................................................................................11Table 5 Interface Module Registers ...................................................................................................12Table 6 GPS Module Registers..........................................................................................................13Table 7 Messaging Module Registers................................................................................................14Table 8 Scratchpad Module Registers ...............................................................................................15Table 9 Operations Module Registers................................................................................................16Table 10 Constant Generators............................................................................................................17Table 11 Bulletin Board Selection Codes..........................................................................................18Table 12 Terminal Satellite Selection Mode Control Word ..............................................................19Table 13 Power Control Register Bit Definitions..............................................................................20Table 14 Register Bits Modified to Switch Terminal Operating Modes ...........................................20Table 15 Power Supply Status Bit Definitions ..................................................................................21Table 16 NMEA Message Enable Bits ..............................................................................................22Table 17 Slotted Receive Mode Register Values...............................................................................22Table 18 - ISN Register Bit Allocation.................................................................................................23Table 19 Timer Control Codes...........................................................................................................25Table 20 Timer Configuration Register Field Definitions.................................................................25Table 21 Alarm Control Codes ..........................................................................................................29Table 22 Alarm Configuration Register Field Definitions ................................................................30Table 23 Alarm Comparison Mode Codes ........................................................................................31Table 24 Valid I/O Channel Configurations......................................................................................33Table 25 I/O Pin Mode Configuration Codes ....................................................................................34Table 26 User LED Colour Codes .....................................................................................................36

Table 27 Latitude/Longitude Data Format.........................................................................................37Table 28 Geofence Status Register ....................................................................................................39Table 29 Return Message Type Numbers..........................................................................................41Table 30 Receiver Status Byte Fields ................................................................................................42Table 31 Transmitter Status Register Fields......................................................................................43Table 32 Operation Configuration Register Field Definitions...........................................................47Table 33 Operation Function Codes ..................................................................................................48Table 34 Trigger Operation Forward Channel Message....................................................................51Table 35 Remote Poll Forward Channel Message.............................................................................51Table 36 - Remote Digital Output Control Forward Channel Message................................................52Table 37 Target Position Definition Message....................................................................................52Table 38 Remote Register Read/Write Message ...............................................................................53

Table 39 Example of Multiple Register Update Message Data Structure .........................................54Table 40 Return Burst Message Format ............................................................................................54Table 41 Operating Power Modes .....................................................................................................60Table 42 - GPS data log record format .................................................................................................79Table 43 - Forward Channel Message Header Format .........................................................................83Table 44 DS TO Operational Flags....................................................................................................98Table 45 DS TR Receiver Inhibit Status Codes.................................................................................99Table 46 DS TR Receiver Progress Codes ........................................................................................99Table 47 DS TR Terminal Error Codes .............................................................................................99Table 48 DS TT Transmit Progress .................................................................................................100Table 49 DS TT Transmit inhibit status...........................................................................................101Table 50 NMEA RMC Sentence Format.........................................................................................103Table 51 NMEA GGA Sentence Format.........................................................................................104

Satamatics Ltd Page ix of xCommercial In Confidence


11/130


GDN-0559 Issue 1

Table 52 NMEA GSV Sentence Format..........................................................................................104Table 53 Terminal Error Report Codes............................................................................................107Table 54 - Command Summary ..........................................................................................................111Table 55 Example Message Definition............................................................................................B-3

REFERENCES

[1].MAN-0048 SAT-200/202 Functional Manual[2].GDN-0051 Satamatics Application Message Registry[3].MAN-0012 Programming in TSL

Satamatics Ltd Page x of xCommercial In Confidence


12/130


GDN-0559 Issue 1

1 INTRODUCTIONThis document describes the application programming interface to the Satamatics SAT-202 series ofInmarsat-D terminals and other Satamatics products that incorporate the Satamatics, Inmarsat Type

Approved, SAT-200 module. This document also applies to the SAT-202 series when used incombination with the GEM-100 interface module.

The SAT-202 terminal comprises a SAT-200 module contained within a SAT-201 type enclosure.The SAT-202 supersedes, and provides a plug in replacement for, the SAT-201/201i series ofterminals. Backwards compatibility with regards to functionality has been largely maintained, butthere are some differences as detailed in Appendix C Notes for Users Migrating from the SAT-201Series..

Two methods of programming or configuring the SAT-202 terminal are available:

Using the terminals internal scripting engine. This method would be used if autonomousoperation is required.

Using the serial communications interface to control the terminal. This method would be usedif the terminal is operated in conjunction with an external controller.

There is some commonality between these two methods but sections 4 and 5 of this document aremore relevant to the use of the scripting engine whereas section 7 focuses on external control.

Satamatics Ltd Page 1 of 111Commercial In Confidence


13/130


GDN-0559 Issue 1

2 TERMINAL DETAILSA full description of the terminal variants and their capabilities is given in the relevant user

manual. You are also advised to read the SAT-200 Functional Manual, Ref. [1], before using the

commands detailed in this document to program a terminal.

2.1 ProcessorsThe SAT-200 module contains three processors each with certain dedicated functions. These are:

MSP a low power microprocessor that runs all of the time that power is applied to the terminal.This processor provides the overall control of the terminal enabling the other two processors asrequired for correct terminal operation. The MSP provides the scripting engine and processes thecommands received over the serial port interface.

DSP a digital signal processor that provides the INMARSAT-D modem functionality, i.e.transmission and reception of messages between the terminal and the satellite.

GPS a dedicated processor that receives and decodes the GPS satellite signals to provide theposition data used by the terminal.

These three processors are referred to as MSP, DSP and GPS throughout this document.

2.2 Physical InterfaceThe command serial interface to the terminal is configured as an RS-232, bi-directional, asynchronousserial port operating at 9600 or, following an operator command, 4800 baud, 8 bit data, no parity and1 stop bit. The interface comprises the two data lines and a signal ground. There are no modemcontrol lines (CTS, RTS). There is no software flow control implemented on the interface.

Note: The serial port baud rate can be increased during a firmware upload (paragraph 7.13.1.1)



14/130


GDN-0559 Issue 1

3 PROGRAMMING MODELA script is a simple program that is interpreted by the scripting engine, implemented within theMSP, to perform autonomous control of the terminal.

To run a script it must first be uploaded to the terminal via the serial interface. The uploaded scriptfile would normally comprise a configuration part and an operating script part. The configurationpart consists of standard terminal commands that perform a one-time configuration of those functionswithin the terminal that are not accessible through the autonomous operation of the scripting engine.The operating script is that part of the uploaded file that is interpreted by the scripting engine i.e. itis run within the terminal in a manner similar to a software program.

Figure 1 shows access to the terminal functionality and status information. All functions areaccessible via the serial interface whereas some functionality and information is not accessible to anoperating script. (Configuration functions not accessible to the operating part of a script can still beincluded in the configuration part of the uploaded script file as explained above.)

INMARSAT-D Terminal

Script accessible modulesand registers

Serial port Access

Scripting engine

Terminal control andtorinmoni g

Serial Interface

Functions and statusinformation inaccessible to

g enscriptin gine

This document is structured as follows:

Section 5 Details the scripting modules and registers and how these are interpreted by thescripting engine.

Section 6 - Provides details of over air remote control operation.

Section 7 Provides details of the serial command interface including command syntax andfunction. Most of these functional specific commands control/monitor the terminalthrough indirect access of the scripting registers, however the RR & RW commands(paragraph 7.11) provide direct access, and Satamatics advise, where possible, the useof the RR & RW commands for control and monitoring.



15/130


GDN-0559 Issue 1

4 SCRIPTING OVERVIEWFor autonomous operation the terminal must be configured to perform actions (operations) inresponse to events (alarms or timers).

Events are detected by monitoring values and status information, including that of user configurabletimers, held in the scripting registers. These values are compared with threshold or trigger values setwithin the script and, if the comparison results in a trigger, then a number of response operations maybe performed.

The process of performing operations is controlled by the scripting engine. The terminal can beconsidered to be running a script if at least one operations register (paragraph 5.10) has been

configured to perform an action in response to an event.

The terminal scripting functionality is provided by a set of functional modules that may beprogrammed by a user to produce the required results. Each of the programmable modules has a setof addressable registers that configure the module operation. The registers are addressable directlythrough the RR & RW commands (paragraph 7.11), or indirectly via many of the other serial interfacecommands listed in section 7.

Note: Satamatics advise the use of the RR & RW commands where possible. In any future

extensions, scripting registers will only be accessible via the RR & RW commands. The other

serial commands listed in section 7 are kept to maintain compatibility with legacy products.

Not all of the resources and functionality defined by the programming model is available on allterminal variants. Functionality affected in this way is identified in this document. Any attempt to usean unimplemented function will be ignored.

Determining the values to be written to the appropriate registers in order to realise an operationalscript can be a lengthy and error prone process. Satamatics therefore provide a TSL (TerminalScripting Language) compiler, ref.[3], that enables users to write their script in a textual format andenvironment more familiar to software programmers. Once written the script is compiled to produce afile that comprises the serial commands (described in this document) that can then be sent to theterminal to configure all the appropriate registers and functions.



16/130


GDN-0559 Issue 1

5 SCRIPTING MODULES AND REGISTERS5.1 Functional ModulesThe functional modules provided are:

Terminal Configuration Module

Interface Module GPS Module Messaging Module Timer Module Alarms Module Operations Module Scratchpad Module Constant Generator Module

The functionality provided by each of the modules is described in sections 5.3 to 5.11.

The functional modules within the terminal each contain a number of registers. These are addressedby concatenating their module and internal register addresses. The address is used to access theregisters either through the RR & RW commands (paragraph 7.11) or, if being accessed as part of ascript, through the Operations registers (paragraph 5.10.1).

The module addresses used within the terminal are listed in Table 1.

Module Name Module ID Number

Configuration 0x00

Timers 0x01

Alarms 0x02

Interfaces 0x03

GPS 0x04

Messaging 0x05

Scratchpad 0x06

Operations 0x07

Constant Generator 0x0F

Table 1 Terminal Module ID Codes



17/130


GDN-0559 Issue 1

5.2 RegistersRead/write access to the registers is indicated in the Access column as follows:

R = Read onlyW = Write onlyR/W = Read and Write operation possible using the RR an RW commands respectively.R/[W] = Register can be read using RR command but write access is achieved indirectly by

writing to another register or via a serial command other than RW.

Paragraph references are given for both the register description and, where applicable, the serialcommand by which it can be accessed. It should be noted that all registers can be accessed by the RRand/or RW commands (paragraph 7.11) and hence this reference is not listed. Some registers can onlybe accessed via the RW/RR commands and in these cases no serial command reference is provided.



18/130


GDN-0559 Issue 1

5.2.1 Configuration Module RegistersModule 0x00

Register Size(bits)

Access Function TSL Register Name Para ref.

0x00 5 R/W Bulletin Board/Ocean Region OceanRegion 5.3.1, 7.3.2

0x01 3 R/W Service ID Selection SelectedServiceID 5.3.2,7.3.5

0x02 16 R/W Satellite Selection Mode SatelliteSelectionMode 5.3.3, 7.3.1

0x03 9 R/W Power Control Register PowerControl 5.3.4, 7.3.3

0x04 32 R Notification Flags[Not yet available]

NotificationFlags

0x05 32 R DSP Firmware Version FirmwareVersionDSP 5.3.5, 7.3.11

0x06 32 R MSP Firmware Version FirmwareVersionMSP 5.3.6, 7.3.7

0x07 32 R/W Script Application Version ScriptVersion 5.3.7, 7.3.9

0x08 32 W Store Application Script StoreScript 5.3.8, 7.3.13

0x09 32 W Delete Application Script DeleteScript 5.3.9, 7.3.12

0x0A 2 R Power Supply Status PowerSupplyStatus 5.3.10, 7.4.5

0x10 8 R

: :

0x1F 8 R

0x20 8 R/W NMEA output control OutputNMEA 5.3.11, 7.3.6

0x30 8 R

: :

0x34 8 R

0x40 8 R/W Slotted Receive - Wakeup Period SlottedWakeupPeriod 5.3.12

0x41 8 R/W Slotted Receive - MaxAcquisition Retries

SlottedRetries 5.3.13

0x50 32 R ISN & PSN ISN 5.3.14

0x51 8 R Hardware Version HardwareVersion 5.3.15

0x52 20 R/[W] GPID 0 GPID0





5.3.16

0x57 8 R/[W] SID/BID for Service 0 SID0



0x5A 8 R/[W] SID/BID for Service 3 SID3

0x5B 8 R/[W] SID/BID for Service 4 SID4

5.3.17

0x5C 24 R/[W] Operational Flags OperationalFlags 5.3.18, 7.14.11

0x5D 8 R/W Terminal Mobility TerminalMobility 5.3.190xFC 1 R/W PACC Enable PACCEnable 5.3.20

0xFD 1 R/W GEM-100 compatibility enable GEMEnable 5.3.21

0xFE 32 W Terminal reset TerminalReset 5.3.22

0xFF 32 R Scripting capabilities ScriptingCapabilities 5.3.23

Table 2 Configuration Module Registers



19/130


GDN-0559 Issue 1

5.2.2 Timer Module RegistersModule 0x01

Register Size(bits)

Access Function TSL Register Name Para Ref.

R Timer 0 Count0x00 32

W Timer 0 ControlTimerCountCtrl0



: : :

R Timer 14 Count0x0E 32


R Timer 15 Count0x0F 32


5.4.2, 7.5.8

0x10 32 R/W Timer 0 Configuration TimerConfig0

0x11 32 R/W Timer 1 Configuration TimerConfig1: : :

0x1E 32 R/W Timer 14 Configuration TimerConfig14

0x1F 32 R/W Timer 15 Configuration TimerConfig15

5.4.3, 7.5.1

0x20 32 W Stop timers designated by bitmap StopTimers 5.4.4.1

0x21 32 W Start timers designated by bitmap StartTimers 5.4.4.2

0x22 32 W Reset timers designated by bitmap ResetTimers 5.4.4.3,7.5.5

0x23 32 W Restart timers designated bybitmap

RestartTimers 5.4.4.4, 7.5.6

0x28 32 W Enable/Disable Timers EnableDisableTimers 5.4.4.5,7.5.2,7.5.3

0x29 32 W Reset/Restart Timers ResetRestartTimers 5.4.4.6,7.5.5,7.5.6

0x2C 32 W Enable Timers & Alarms EnableTimersAlarms 5.4.5.1,7.5.3,7.6.3

0x2D 32 W Disable Timers & Alarms DisableTimersAlarms 5.4.5.2,7.5.2,7.6.2

0x2E 32 W Restart Timers & Alarms RestartTimersAlarms 5.4.5.3,7.5.60x2F 32 W Reset Timers & Alarms ResetTimersAlarms 5.4.5.4,7.5.5,7.6.5

0x30 32 R Current UTC time in seconds pastmidnight

TimeUTC 5.4.6.1

0x32 12 R Current date: year, full year value DateYear

0x33 4 R Current date: month (1..12) DateMonth

0x34 5 R Current date: day (1..31) DateDay

0x35 5 R Current time: hour (0..23) TimeHours

0x36 6 R Current time: minute (0..59) TimeMinutes

0x37 6 R Current time: second (0..59) TimeSeconds

5.4.6.2,7.5.7

0x40 32 R/W Timer 0 Terminal Count TerminalCount0

0x41 32 R/W Timer 1 Terminal Count TerminalCount1

: : :0x4E 32 R/W Timer 14 Terminal Count TerminalCount14

0x4F 32 R/W Timer 15 Terminal Count TerminalCount15

5.4.3.5,7.5.4

0x50 32 R/W UTC Resynchronisation Period[Not available]

UTCResyncPeriod

Continued on following page



20/130


GDN-0559 Issue 1

Register Size(bits)




R Timer 17 Count0x81 32 W Timer 17 Control TimerCountCtrl17

: : :

R Timer 30 Count0x8E 32


R Timer 31 Count0x8F 32


5.4.2,7.5.8



: : :

0x9E 32 R/W Timer 30 Configuration TimerConfig30

0x9F 32 R/W Timer 31 Configuration TimerConfig31

5.4.3,7.5.1

0xA0 32 R/W Timer 16 Terminal Count TerminalCount16

0xA1 32 R/W Timer 17 Terminal Count TerminalCount17

: : :

0xAE 32 R/W Timer 30 Terminal Count TerminalCount30

0xAF 32 R/W Timer 31 Terminal Count TerminalCount31

5.4.3.5,7.5.4

Table 3 Timer Module Registers



21/130


GDN-0559 Issue 1

5.2.3 Alarm Module RegistersModule 0x02

Register Size(bits)


R Alarm 0 Status0x00 32

W Alarm 0 ControlAlarmStatusCtrl0



: : :

R Alarm 14 Status0x0E 32


R Alarm 15 Status0x0F 32


5.5.2

0x10 32 R/W Alarm 0 Configuration AlarmConfig0

0x11 32 R/W Alarm 1 Configuration AlarmConfig1: : :

0x1E 32 R/W Alarm 14 Configuration AlarmConfig14

0x1F 32 R/W Alarm 15 Configuration AlarmConfig15

5.5.3, 7.6.1

0x20 32 R/W Alarm 0 Threshold AlarmThreshold0


: :

0x2E 32 R/W Alarm 14 Threshold AlarmThreshold14

0x2F 32 R/W Alarm 15 Threshold AlarmThreshold15

5.5.4, 7.6.6

0x30 32 W Disable Alarms designated by bitmap DisableAlarms 5.5.5.1,7.6.2

0x31 32 W Enable Alarms designated by bitmap EnableAlarms 5.5.5.2,7.6.3

0x32 32 W Reset Alarm Latches designated bybitmap

ResetAlarms 5.5.5.3,7.6.5

0x33 32 W Trigger Alarms designated by bitmap TriggerAlarms 5.5.5.4,7.6.4

0x34 32 W Toggle Alarm enable state ToggleAlarms 5.5.5.5

0x35 32 W Reset Latch and Enable Alarmsdesignated by bitmap

RestartAlarms 5.5.5.6

0x38 32 W Enable/Disable Alarms designatedby bitmap

EnableDisableAlarms 5.5.5.7

Continued on following page



22/130


GDN-0559 Issue 1

Register Size(bits)



W Alarm 16 Control

AlarmStatusCtr16


W Alarm 17 ControlAlarmStatusCtr17

: : :

R Alarm 30 Status0x4E 32


R Alarm 31 Status0x4F 32


5.5.2



: : :

0x5E 32 R/W Alarm 30 Configuration AlarmConfig30

0x5F 32 R/W Alarm 31 Configuration AlarmConfig31

5.5.3, 7.6.1



: :

0x6E 32 R/W Alarm 30 Threshold AlarmThreshold30

0x6F 32 R/W Alarm 31 Threshold AlarmThreshold31

5.5.4, 7.6.6

Table 4 Alarms Module Registers



23/130


GDN-0559 Issue 1

5.2.4 Interface Module RegistersModule 0x03

Register Size(bits)


0x00 8 R Digital Input States DigitalInputs 5.6.3,7.4.3

0x01 8 R/W Digital Output States DigitalOutputs 5.6.4,7.4.4

0x02 32 R/W I/O Configuration(Input/Output, Digital/Analogue)

IOConfiguration 5.6.1, 7.4.2

0x03 1 R/W GEM-100 Battery output enable state 5.6.11,7.4.7

0x10 12 R Analogue Input Channel 0 Conversion Result AnalogueInput0

: : :

0x17 12 R Analogue Input Channel 7 Conversion Result AnalogueInput7

5.6.2,7.4.1

0x18 32 R Processor Supply Voltage ProcessorSupply 5.6.5,7.4.6

0x19 32 R External Supply Voltage ExternalSupply 5.6.6,7.4.9

0x1A 16 R Device Temperature ProcessorTemperature 5.6.8,7.4.100x1B 32 R GEM-100 Battery Supply Voltage BatterySupply 5.6.7,7.4.12

0x1C 16 R GEM-100 Battery Temperature BatteryTemperature 5.6.10,7.4.8

0x1F 16 R/W Calibrated Temperature CalibratedTemperature 5.6.9

0x20 12 R/W Analogue Output Channel 0 Value[Not available]

AnalogueOutput0

: : :

0x27 12 R/W Analogue Output Channel 7 Value[Not available]

AnalogueOutput7

0x30 2 R/W GEM-100 User LED state GEMLED 5.6.12,7.4.11

Table 5 Interface Module Registers



24/130


GDN-0559 Issue 1

5.2.5 GPS Module RegistersModule 0x04

Address Size(bits)


0x00 1 R GPS Status Register GPSStatus 5.7.1.1,7.8.1.2

0x01 32 R GPS Latitude Latitude 5.7.1.2, 7.8.2.3

0x02 32 R GPS Longitude Longitude 5.7.1.3, 7.8.2.3

0x03 16 R GPS Speed Speed 5.7.1.4, 7.8.2.4

0x04 16 R GPS Heading Heading 5.7.1.5, 7.8.2.2

0x05 16 R GPS Altitude Altitude 5.7.1.6,7.8.2.1

0x08 16 R Horizontal Dilution of Precision HDOP 5.7.1.7

0x10 32 W Store Current as Reference StoreReference 5.7.2.1,7.8.4.3

0x11 32 R/[W] Reference Latitude ReferenceLatitude 5.7.2.2, 7.8.4.2

0x12 32 R/[W] Reference Longitude ReferenceLongitude 5.7.2.3, 7.8.4.2

0x13 1 R/W Odometer function enable OdometerEnable0x14 32 R Odometer accumulated distance OdometerDistance

0x15 - W Odometer reset[Clears the Odometer accumulateddistance register]

OdometerReset

0x20 32 R Distance to Reference DistanceToReference 5.7.2.4, 7.8.4.1

0x28 8 R Geofence 1 Status GeofenceStatus1 5.7.6.1

0x29 8 R Geofence 2 Status GeofenceStatus2 5.7.6.1

0x30 16 R/W GPS Update Rate[For SAT-200 products, the update rate isfixed at 1 second. Writing to this registerhas no effect]

UpdateGPS

0x38 32 R Distance to Closest Target DistanceToClosest 5.7.3.2

0x39 32 R Distance to Farthest Away Target DistanceToFurthest 5.7.3.3

0x40 32 R Distance to Target 0 DistanceToTarget0

: : : : :

0x47 32 R Distance to Target 7 DistanceToTarget7

5.7.3.1,7.8.5.1

0x50 32 R/[W] Target 0 Latitude TargetLatitude0 5.7.3.4,7.8.5.2

0x51 32 R/[W] Target 0 Longitude TargetLongitude0 5.7.3.5,7.8.5.2

: : : : :

0x5E 32 R/[W] Target 7 Latitude TargetLatitude7 5.7.3.4,7.8.5.2

0x5F 32 R/[W] Target 7 Longitude TargetLongitude7 5.7.3.5,7.8.5.2

0x80 1 R NMEA Input Status Register NMEAStatus

0x81 32 R NMEA Input Latitude NMEALatitude

0x82 32 R NMEA Input Longitude NMEALongitude

0x83 16 R NMEA Input Speed NMEASpeed

0x84 16 R NMEA Input Heading NMEAHeading

0x85 16 R NMEA Input Altitude NMEAAltitude

7.15

0xF0 3 R Hours since last GPS fix HoursSinceLastFix 5.7.5

0xF1 17 R Time at last GPS fix TimeAtLastFix 5.7.5

Table 6 GPS Module Registers



25/130


GDN-0559 Issue 1

5.2.6 Messaging Module RegistersModule 0x05

Address Size(bits)


0x10 8 W Return Burst Message ID Code ReturnBurstMessageID 5.8.1,7.9.2.2

0x11 8 R/W Return Burst Destination Address ReturnBurstDestAddr orReturnBurstCannedMessage

5.8.2,7.9.2.1

0x12 8 R/W

0x13 20 R/W Concatenated Registers 0x11:0x12 plusControl Flags

ReturnBurstRegisters 5.8.3

0x14 2 R/W Return Burst Acknowledge Flags ReturnBurstAckFlags 5.8.4,7.9.2.3

0x15 4 R/W Return Burst Control Flags Field ReturnBurstCtrlFlags 5.8.5,7.9.2.4

0x18 32 R/W Return message scrambling vector ScramblingVector 5.8.6

0x20 12 R Receive Channel Number ReceiveChannel 5.8.7.1,

7.9.2.80x21 12 R Receive Signal Quality ReceiveSignalLevel 5.8.7.2,7.9.2.8

0x22 8 R Receive Status ReceiveStatus 5.8.7.3,7.9.2.8

0x23 32 R Transmit Status TransmitStatus 5.8.87.9.2.10

0x24 8 R/W Transmit Randomisation Period TransmitRandomisation 5.8.9,7.9.2.9

0x28 32 R/W Number of Transmit Retries TransmitRetries 5.8.10

0x29 32 R Receive Signal Level ReceiveSignal 5.8.11

0x2A 32 R Receive Frequency Offset ReceiveFrequencyOffset 5.8.12

0x2B 32 R Receive Doppler Rate of Change ReceiveDoppler 5.8.13

0x2C 32 R Receive Symbol Errors ReceiveSymbolErrors 5.8.14

0x2D 32 R Number of Messages in Transmit Queue TransmitQueue 5.8.150x2E 32 R Transmit Queue Configuration TransmitQueueConfig 5.8.16

0x30 8 R/W Poll Message ID code PollMessageID 5.8.17.1,7.9.2.6

0x31 16 R/W Poll Message Repeat Rate PollMessageRate 5.8.17.2,7.9.2.6

0x38 8 R/W Response Message for Tone Only type 1 ResponseToTone1

0x39 8 R/W Response Message for Tone Only type 2 ResponseToTone2

0x3A 8 R/W Response Message for Tone Only type 3 ResponseToTone3

0x3B 8 R/W Response Message for Tone Only type 4 ResponseToTone4

5.8.18,7.9.2.7

0x40 1 R/W Forward channel message output mode ForwardChannelOutput 5.8.19,7.9.1.5

Table 7 Messaging Module Registers



26/130


GDN-0559 Issue 1

5.2.7 Scratchpad Module RegistersModule 0x06

Address Size(bits)


0x00 32 R/W Scratchpad Register 0 ScratchPad0 5.9,5.9.1.1, 7.10.1

0x01 32 R/W Scratchpad Register 1 ScratchPad1

0x02 32 R/W Scratchpad Register 2 ScratchPad2

5.9,5.9.1.2, 7.10.1

: : :

0x0E 32 R/W Scratchpad Register 14 ScratchPad14

0x0F 32 R/W Scratchpad Register 15 ScratchPad15

5.9,7.10.1

Table 8 Scratchpad Module Registers



27/130


GDN-0559 Issue 1

5.2.8 Operation Configuration RegistersModule 0x07

Address Size(bits)


0x00 32 R/W Operation 0 Configuration OperationConfig0


: :

0x1E 32 R/W Operation 30 Configuration OperationConfig30

0x1F 32 R/W Operation 31 Configuration OperationConfig31

5.10.2, 7.7.1

0x20 32 R/W Operation 0 Value OperationValue0

0x21 32 R/W Operation 1 Value OperationValue1

: :

0x3E 32 R/W Operation 30 Value OperationValue30

0x3F 32 R/W Operation 31 Value OperationValue31

5.10.3, 7.7.1

0x40 32 W Disable all operations in bit mask(Affects operations 0 to 31)

DisableOperations 5.10.4, 7.7.2

0x41 32 W Enable all operations in bit mask(Affects operations 0 to 31)

EnableOperations 5.10.5, 7.7.3

0x42 32 W Reset all operations in bit mask(Affects operations 0 to 31)

ResetOperations 5.10.6, 7.7.4

0x43 32 W Trigger all operations in bit mask(Affects operations 0 to 31)

TriggerOperations 5.10.7, 7.7.5

0x44 32 W Disable operations in bit mask(Affects operations 32 to 63)

DisableOperationsExt 5.10.4

0x45 32 W Enable operations in bit mask(Affects operations 32 to 63)

EnableOperationsExt 5.10.5

0x46 32 W Reset operations in bit mask(Affects operations 32 to 63)

ResetOperationsExt 5.10.6

0x47 32 W Trigger operations in bit mask(Affects operations 32 to 63)

TriggerOperationsExt 5.10.7



: :

0x9E 32 R/W Operation 62 Configuration OperationConfig62

0x9F 32 R/W Operation 63 Configuration OperationConfig63

5.10.2, 7.7.1

0xA0 32 R/W Operation 32 Value OperationValue32

0xA1 32 R/W Operation 33 Value OperationValue33

: :

0xBE 32 R/W Operation 62 Value OperationValue62

0xBF 32 R/W Operation 63 Value OperationValue63

5.10.3, 7.7.1

Table 9 Operations Module Registers

Note: Serial port access to the registers 0x44 to 0x47 inclusive, is via the RW/RR commandsonly (section 7.11).



28/130


GDN-0559 Issue 1

5.2.9 Constant Generator RegistersModule 0x0F

Register Number Value Returned TSL Register Name Para Ref.

0x00 0x00000000 ConstantRegister0 orPaddingZeroes

0x01 0x00000001 ConstantRegister1

: : :

0x0F 0x0000000F ConstantRegister15

0x10 0x00000010

: :

0xFE 0x000000FE

0xFF 0xFFFFFFFF ConstantRegister255 or

PaddingOnes

5.11

Table 10 Constant Generators

Note: The TSL Register definition file SatConst.tsl does not define names for the Constant moduleregisters 0x10 to 0xFE.



29/130


GDN-0559 Issue 1

5.3 Configuration ModuleModule ID = 0x00

Register addresses = Table 2

The configuration module provides access to the operational parameters of the terminal.

5.3.1 Ocean Region Selection RegisterThis register contains the ID number for the currently active bulletin board (see Table 11 for BulletinBoard ID to Ocean Region mapping). If a new value is written to this register then the terminal willattempt to acquire and use the new bulletin board.

Bulletin Board ID Ocean Region

0 Invalid value1 AORW (Atlantic Ocean Region West)

2 AORE (Atlantic Ocean Region East)

3 IOR (Indian Ocean Region)

4 POR (Pacific Ocean Region)

5 PACC (Pacific Ocean Central)

6..16 Spare

17..31 Invalid value

Table 11 Bulletin Board Selection Codes

If the automatic satellite switching is enabled (section 5.3.3) then selecting an ocean region by writing

to the Ocean Region register may not result in the terminal using the selected ocean region. Forexample, consider a terminal that is located in Brazil and configured in follow best mode. In thislocation two satellites are visible; AORE and AORW, with the latter being higher in the sky. If avalue of 02 is written to this register then the terminal will switch to use AORE but, on the next GPSupdate, the follow best algorithm will switch the terminal back to AORW.

5.3.2 Service ID Selection RegisterThis register contains the number of the currently active service used by the terminal. The registertakes a value between 0x00 and 0x04 to select one of the 5 Service ID (SID) / Beam ID (BID)

pairings pre-programmed into the terminal. The SID/BID pairings corresponding to the serviceselected can be read from the SID/BID registers (see paragraph 5.3.17)



30/130


GDN-0559 Issue 1

5.3.3 Satellite Selection ModeThe satellite selection algorithm is controlled by the states of the control word bits as defined in Table

12. When the terminal performs a satellite switch it can optionally be programmed to transmit amessage over the satellite link so that the LES can detect that the terminal has changed ocean regions.

Bit Function (when bit set)

0 Auto select on start up (see 5.3.3.1)

1 Enable Automatic switching during terminal operation.

2 Only valid if Automatic switching enabled:1 = Follow Best (see 5.3.3.1)0 = Switch on loss (see 5.3.3.3)

3 Spot beam Roaming enable. (Not implemented)

4 Transmit Message on ocean region switch. Only valid if automatic switching enabled

5 6

7

8..15 Message number to transmit on an ocean region change. Only valid if bit 4 is set.

Table 12 Terminal Satellite Selection Mode Control Word

5.3.3.1 Auto Select on Start UpWith this option enabled, the terminal uses GPS position to select the best satellite (ocean region) onpower on or wake from sleep. If this option is disabled then the last configured satellite is used.

Note: This option should not be enabled if slotted receive (5.3.12) is used.

5.3.3.2 Follow Best Satellite OperationThe terminal will attempt to follow the best satellite based on the GPS position. The best satellite isdefined as the one with the highest elevation in the sky. Each time that the GPS provides a new validposition fix this is compared with the satellite positions to determine the satellite that is highest in thesky. If this is the currently selected satellite then the terminal will continue to use this satellite. If thehighest satellite is not currently selected then the terminal will switch over to the new best satellite.

If the terminal loses the signal from the best satellite due to antenna masking then it will suspend thefollow best algorithm and will try to acquire the satellites either side of the best. If it acquires the

signal from the second best satellite then it will use that satellite until its signal is lost and the followbest satellite based on GPS position will resume.

When the terminal switches between satellites it can be configured to send a message. This notifiesthe server application that the terminal has switched regions and allows any forward channel trafficfor the terminal to be routed correctly.

5.3.3.3 Switch On Satellite LossThe terminal will attempt to switch satellites when the one currently in use is lost. A satellite isconsidered lost when the terminal misses six successive traffic channel frames (three minutesmaximum) followed by two bulletin board frames (8 minutes maximum) or if, when the terminalattempts to switch to the bulletin board frequency, it cannot detect the satellite signal.



31/130


GDN-0559 Issue 1

5.3.4 Power Control RegisterThe power control register provides access to the power saving modes of operation for the terminal.

The functions controlled by this register are described in Table 13.

Bit Function

0 1 = Enable RS-232 serial port drivers

1 1 = Enable Terminal Power

2 1 = Enable terminal indicator LED

3 1 = Enable ADC (analogue to digital converter) module.If disabled the processor power rails, temperature and unit analogue inputs arenot measured.

4 1 = Disable GPS receiver

5 1 = Disable Inmarsat-D transceiver

6 write as 07 write as 0

8 1 = Enable IsatM2M slotted receive modeNOTE It is NOT possible to change the state of this bit of the power control register

using the CE or CU commands. It can be changed using the RW command,read with the RR command and used within terminal scripts.

9..31 write as 0

Table 13 Power Control Register Bit Definitions

In order to reduce overall power consumption the terminal uses an intelligent switch on method forcontrolling power. Once the terminal has set its internal clock to UTC, it will power up the

Inmarsat-D transceiver at the optimal time to allow acquisition of the next Traffic Channel frameheader. As a consequence, a command to switch the power on to the terminal might not take effect forup to 30 seconds.

Power to the Inmarsat-D transceiver and GPS module can be controlled independently.

The terminal operating mode can be switched by setting and clearing the register bits as shown inTable 14 below:

OperatingMode

RegisterBits Set

Register BitsCleared

Bits 0 to 8 (bits 9..31 set to 0)x = dont care

y = Function as Table 13Sleep none 1 yyyxxyy0y

Standby 1,4,5 none yyy11yy1y

GPS Tracking 1,5 4 yyy10yy1y

Static 1,4 5 yyy01yy1y

Mobile 1 4,5 yyy00yy1y

Table 14 Register Bits Modified to Switch Terminal Operating Modes

Satamatics Ltd Page 20 of 111Commercial In Confidenc

Documents

Gdn0559 - Sat-200 - 202 Scripting API and Command Interface