TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 101 RU Example : ru -g<CR><LF> <CR><LF> <STX>Test Summary: OK 10 visible satellites SW Version 2.0.00<CR><LF> Navigation Mode: 1 FOM: 1 UTC: 1<CR><LF> Accept Altitude: 0 Hold: 0 VPerr: 0 m<CR><LF> PDOP: 02 HDOP: 01 HPerr: 0 m<CR><LF> Elevation mask: 00 HVerr: 0 cm/s<CR><LF> <CR><LF> Satellite Tracking Status<CR><LF> Satellites: 05* 30* 14* 09* 04* 24* 29* 06* 25* <CR><LF> Signal Level:46 46 49 46 47 45 42 43 41 <CR><LF> Elevation: 075 061 035 034 029 028 028 022 008 <CR><LF> Azimuth: 150 050 008 209 101 063 014 105 054 <CR><LF> <CR><LF> V. Speed : 0 ft/m Altitude: 256 ft<ETX><CR><LF> Position : <STX>55 47 64 N 012 31 38 E<ETX> at 14:18:46 UTC <STX><ETX><CR><LF> Course : <STX>006<ETX> deg/true north<CR><LF> Speed : <STX>000<ETX> knots : 0000 kmph : 0000 mph<CR><LF> <CR><LF> : The position part of the information will be the same as with the set -p command. The satellites marked with a star are currently tracked by the GPS, and used in position calculations. The entries are explained in Table 4.8.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 102 RU Navigational Status Result of the self-test: Either 'OK' or 'ERROR XXXXH' which is a hexadecimal error word (16 bits). The MES will indicate FFFFH from the test is started and until the results are received from the GPS. Please refer to Table 4.9 GPS Error Codes for an explanation of the Error Codes. Visible Satellites This is the number of satellites that the GPS is able to see on the current hemisphere. SW Version Software version of the GPS Module. Navigation Mode Boolean: 1 for yes, 0 for no. Informs of valid position data. FOM Field not used. Retained only for backward compatibility. UTC Boolean: 1 for yes, 0 for no. Informs of valid time received from the GPS satellites. Accept Altitude Field not used. Retained only for backward compatibility. AltHold Field not used. Retained only for backward compatibility. Vperr Field not used. Retained only for backward compatibility. PDOP Position Dilution of Precision: A number representing the geometric properties of the satellites. A low number indicates a good satellite geometry resulting in a small position error. PDOP is the RMS value of HDOP and VDOP. HDOP Horizontal Dilution of Precision: A number representing the geometric properties of the satellites. A low number indicates a good satellite geometry resulting in a small position error. Hperr Field not used. Retained only for backward compatibility. Hverr Field not used. Retained only for backward compatibility. Elevation Mask Field not used. Retained only for backward compatibility. Satellite Tracking Status Data from the five GPS channels. Satellite Vessel ID, carrier to noise in dBHz, elevation angle and azimuth of the satellite. Position Latitude and longitude of the last position (maybe from the non-volatile storage). V. Speed Field not used. Retained only for compatibility. Altitude Not referring to mean sea level. For global applications, the geodetic reference (datum) used for GPS is the World Geodetic System 1984 (WGS84). Altitude is described as the perpendicular distance above the ellipsoid surface (which is not to be confused with the mean sea level datum). The WGS84 ellipsoid approximates the geoid (The datum that defines the mean sea level) on a worldwide basis with deviations between the two datums never exceeding 100 meters. Altitude is measured in feet. Speed Horizontal speed in knots, km per hour and miles per hour. Table 4.8 GPS entries
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 103 SECRETTEXT 4 digit hex Value or OK Description Cause Bit 15 Ex. 8000H GPS currently has no fix. Not yet synchronised to no. of satellites necessary to get fix. Not possible to get fix due to antennas view to the sky is blocked. Defect GPS module. Note: If fix is lost for 30 minutes, the GPS module will reset. Bit 14 - bit 1 Not used. Retained only for compatibility. Bit 0 Ex. 0001H Failed to read from GPS serial interface. Initialisation error. Try resetting the MES. Table 4.9 GPS Error Codes 4.32.3 RU -L ______________________________ LIST THE CURRENTLY CONNECTED DEVICES Purpose: List the current connected devices and show their status. Format: RU -l <options> An example is: : ru -l<CR> <CR><LF> Device Nav SatCnt PDOP AltHold UTC Stat<CR><LF> BGPS <STX>1<ETX> 5 002 0 <STX>1<ETX> OK<CR><LF> The Built-in GPS columns have the following interpretation: Device List the name of the connected device: BGPS for the built-in GPS Module. Nav Navigation Mode: 1 for yes, 0 for no, signifies valid position data. SatCnt This is the number of satellites that the BGPS uses for it's position calculations. This may be less than the number of tracked satellites PDOP Position Dilution of Precision: A number representing the geometric properties of the satellites. A low number indicates a good satellite geometry resulting in a small position error. AltHold Field not used. Retained only for compatibility. UTC Indicates if the GPS supplies a valid UTC (1) or not (0). Stat Result of the self-test: Either 'OK' or 'ERROR XXXXH' which is a hexadecimal error word (16 bits). The MES will indicate FFFFH from the test is started and until the results are received from the GPS. Table 4.10 GPS Status Interpretation 4.33 SECRETTEXT 4.33.1 SECRETTEXT ______________________________ SECRET TEXT FOR REMOTE ACCESS Purpose: Format: SECrettext <text>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 104 SENDFILE (NA) 4.34 SENDFILE (NA) 4.34.1 SENDFILE __________________________________________________ SEND FILE Purpose: Send file from MES to terminal using TFTP. Format: SENDFILE <file name> SF <file name> This command initiates a file transmission of the file <file name> from the MES to the terminal using the TFTP protocol. 4.35 SET Purpose: Adjust or display MES settings. Format: SEt <options> SE <options> The set command has several options. The default is to show the menu for the command. This command makes it possible to set position parameters for the navigation reports, if a navigator is not available. Other possibilities are setting of the complete NCS list, or to configure the reception filter of the EGC (Enhanced Group Call) receiver part of the MES. The EGC filter is mainly a set of switches that control whether or not a particular EGC message type will be received. Other possibilities are to specify a reception area for a service (NAVAREA). The spare NAVAREA is used to point out an additional reception area (e.g. on an expected course), as the default area is calculated by the MES, from the position that is entered with the set -p command or via a connected navigational device. The preferred ocean command specifies which ocean (None, Atlantic, Indian, Pacific or Spare) to use as the default for the next login or scanning operation. The complete set command option listing is obtained: : set Illegal argument (?). Legal arguments are : -p (arg) Position and heading -o (arg) Preferred ocean region -l (arg) NCS table -c (arg) Console parameters -u (arg) Mobile number -r (arg) Silent (remote) -z (arg) Environment variables -m (arg) Distress message -g (arg) Distress Generator -q (arg) Distress test mode -k (arg) Enable Land Mobile Alert -e (num) value is 0 Receive only EGC messages -a (num) value is 1 EGC: System Calls -i (num) value is 1 EGC: FleetNet Calls -w (num) value is 1 EGC: SafetyNet Calls -s (num) value is 0 EGC: Spare Navarea no. -t (num) value is 0 EGC: Wmo area no. -n (num) value is 1 EGC: Navtex switch -x (str) value is EGC: Navtex coverage areas -y (str) value is ABDL EGC: Navtex services -sp(arg) Speed limits -au(arg) Set authority levels -sn(arg) EGC: Set all 4 spare Navareas
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 105 SET -ns(arg) Startup: NCS choice -fd(arg) Clear filesystem after startup -am(arg) Set covert alert message addresses -ame(arg) Set covert alert message address extended properties -at(arg) Set covert alert message free text (from console) -atf(arg) Set covert alert message free text (from file) -atx(arg) Set covert alert message additional free text -ap(arg) Set covert alert message repeat rate -ar(arg) High priority msg/EGC light indication reset -b (arg) Reinitialize system parameters -ab (arg) Set remote ssas reconfiguration button requirement : 4.35.1 SET -A _________ ENABLE OR DISABLE RECEPTION OF INMARSAT SYSTEM CALL EGCS Purpose: Enable or Disable Reception of Inmarsat System Call EGCs. Format: SE -a <0|1> SE -a 0: Disables reception 1: Enables reception Using the command without parameters displays the current setting 4.35.2 SET -AB __________________________ SET REMOTE SSAS RECONFIGURATION BUTTON Purpose: Set remote ssas reconfiguration button Format: SE -ab <0|1> SE -ab 0: The flag is reset 1: The flag is set Using the command without parameters displays the current setting If the user authority is SYSADM or higher, the command works as follows: If the flag is 0, the user may remote reconfigure without any limitations. If the flag 1, the SSAS test button shall be pressed to allow the user remote reconfiguration of SSAS parameters for 1 hour. The flag can always be set without limitations, but only reset if the test button has been pressed within the last hour. The flag is by default not set.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 106 SET 4.35.3 SET -AM __________________________________ SET SSA MESSAGE DESTINATIONS Purpose: Set the destination address for Covert/Security alert when using SSA messages. There can be entered six individual addresses numbered 0..5. A minimum of system administrator userlevel is required to see/change message destination setup. Format: SE -am <entry>,<type>[,<address>[,<param>]] entry: Address list entry number [0..5]. type: Destination type. 255 = Unused 0 = TELEX 1 = PSTN 3 = PSDN 6 = Special access code 254 = e-mail address: Destination address. This can be telephone numbers, telex numbers, or email addresses depending on the type. Max length 128 characters. param: Supplementary parameter for some address types. For PSTN, T30 selects fax and V22B selects modem; for special access code it may specify various information required for a given code. The parameters for the command correspond largely to the parameters that may be specified for the TX command . Examples Set address 0 to fax number 12345678 in Denmark (country code 45): SE -am 0,1,4512345678,T30 Set address 1 to e-mail: SE -am 1,254,[email protected] Clear address 2: SE -am 2,255 View configuration: SE -am <CR><LF> Update time: 2004-02-10 14:24:11<CR><LF> Entry Type Param Address<CR><LF> 0 1 T30 4512345678<CR><LF> 1 254 [email protected]<CR><LF> 2 Address not used<CR><LF> 3 Address not used<CR><LF> 4 Address not used<CR><LF> 5 Address not used<CR><LF> <CR><LF> To set/clear addresses: se -am <Entry>,<Type>[,<Addresses>[,<Param>]]<CR><LF> <CR><LF> : 4.35.4 SET -AME _________________________SET EXTENDED SSA MESSAGE DESTINATIONS Purpose: Set the extended properties for a message destination for Covert/Security alert when using SSA messages. For each of the available addresses see command SE –am the extended property can be configured. It is thus possible to control which addresses
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 107 SET that will receive Covert/Security alert and which addresses that will receive test messages. It is not permitted to disable the Covert/Security alert for the two first message destinations. Note, configuration change message will always be send regardless of this configuration. A minimum of system administrator userlevel is required to see/change extended message destination setup. Format: SE -ame <entry>,<usage>[,<cfg>] entry: Address list entry number [0..5]. usage: 0 = Reserved 1 = Message only 2 = Test only 3 = Both test and message. cfg: 0 = No Configuration message 1 = Configuration message Examples Set the first message destination to be used for both Covert/Security alert and Test messages: SE -ame 0,3 Set the second message destination to be used for Covert/Security alert only: SE -ame 1,1 Set the third message destination to be used for Test messages only: SE -ame 2,2 Set the fourth message destination to be used for Covert/Security alert, Test and Configuration messages: SE -ame 2,3,1 View configuration: SEt -ame <CR><LF> Extended address configuration. Entry Usage 0 Msg+Test 1 Msg 2 Test 3 Msg+Test+Config 4 Address not used 5 Address not used To set address-usage: se -ame <Entry>,<Usage>[,<Cfg>]
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 108 SET 4.35.5 SET -AP ___________________________________ SET SSA MESSAGE REPEAT RATE Purpose: Set number of minutes between two covert alert messages if repeated. Format: SE -ap <value> SE -ap <value>: From 20 min. to 60 min. Using the command without parameters displays the current setting. 4.35.6 SET -AR _________________ RESET HIGH PRIORITY MESSAGE OR EGC LIGHT INDICATION Purpose: Reception of a high priority message and/or EGC results in a aural and visual indication from the attached alarm. The aural indication can be reset by activating the Reset/Test button - reset of the visual indication can only be accomplished using the set -ar command Format: SE -ar 4.35.7 SET -AT __________________________________________ SET SSA MESSAGE TEXT Purpose: Set the supplementary text note on SSA messages. This may be used to provide information such as ship name, radio call sign, country of registration, etc. A minimum of system administrator userlevel is required to see/change message text. Format: SE -at <text> text: Text note of max. 64 characters. Examples Set the text note: SE -at “Ship name: THRANE” View configuration: SE -at<CR><LF> Current text: Ship name: THRANE<CR><LF> <CR><LF> To change text: se -at <Text><CR><LF> 4.35.8 SET -ATF _________________________________ SET SSA MESSAGE TEXT FROM FILE Purpose: Set the supplementary text note on SSA messages. This may be used to provide information such as ship name, radio call sign, country of registration, etc. The supplementary text note is extracted from a file to support texts up to 200 characters - in contrast to the se -at which only supports up to 64 characters. If file contains more than 200 characters, the length of the content is truncted before used as supplementary text note. A file with the supplementary text note can be created using the TR command A minimum of system administrator userlevel is required to see/change supplementary text note. Format: SE -atf <filename>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 109 SET <filename>: Name of file where the supplementary text is Examples Set and View configuration : tr suppltx.txt<CR><LF> Supplementary text note: <CR><LF> The content of this file is used as supplementary text note for covert/security alert.<CR><LF> Can also be used to provide information such as ship name, radio call sign, country of registration, ect. <CTRL><C> : dir<CR><LF> IOPORT TXT 75 04-06-10 09:16 _EGCLOG 41 04-06-10 09:16 _TXLOG 292 04-06-10 09:16 _RXLOG 533 04-06-10 09:16 EGC 001 3070 04-06-10 09:34 suppltx txt 221 04-06-10 13:14 6 File(s) 168144 bytes free : se -atf suppltx.txt<CR><LF> Filecontent truncated due to oversize (to 200 characters) : set -atf<CR><LF> Current text: Supplementary text note: The content of this file is used as supplementary text note for covert/security alert. Can also be used to provide information such as ship name, radio call sign, country o To change text: se -atf <filename> 4.35.9 SET -ATX ________________________________ SET SSA ADDITIONAL MESSAGE TEXT Purpose: Set the additional supplementary text note on SSA messages. This may be used to provide additional information - can be accessed at normal userlevel contrary command "set -at" which requires system administrator userlevel. Format: SE -atx <text> text: Text note of max. 64 characters. Examples Set the text note: SE -atx "2006-06-28 12:30:09 55.47N 012.31E" View configuration: SE -atx<CR><LF> Current additional text: 2006-06-28 12:30:09 55.47N 012.31E<CR><LF> <CR><LF> To change text: se -atx <Text><CR><LF>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 110 SET 4.35.10 SET -AU ___________________________________________ SET AUTHORITY LEVELS Purpose: Set the authority levels for the commands. User can change authority level for commands, which are accessible for user. User cannot set an authority level higher than users own. Format: SE -au <command>,<authoritylevel> <command>: Any of the commands in the table below. Not listed commands have higher authority levels. Please see the table below
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 111 SET Command Description Default Authority Level ca Calibrate frequency correction sysadm cfg Read/write configuration sysadm clear Abort current operation normal user confirm Confirmation request normal user data Send data report normal user date Time and date normal user delete Delete a file normal user diagnostics Diagnostics Sysadm directory List of files normal user dn Data Network setup normal user errorlog Errorlog normal user ev Event pgm setup normal user fi For backward compatibility only sysadm fx Fixed positions setup normal user gps GPS configuration and status normal user help This help test normal user id System identification normal user io Input Output pins sysadm li Login at channel number normal user lo Logout normal user log Data log sysadm ncs Common channel management normal user password Change password normal user pg Program Setup normal user sysadm for remote created pg pp Enhanced pre-assigned program normal user print Print a file normal user reboot Reboot MES normal user recvfile Receive file normal user route Routing received files normal user rs Report Setup normal user ru Remote Units normal user secrettext Secret text for remote access sysadm sendfile Send file normal user set Set parameters sysadm se –w (for type M/LT/SSA) normal user (for all other se cmd) sleep Sleep Mode normal user status Various status normal user su Substitute user normal user test Request Link Test normal user transfer Transfer a file to tranceiver normal user tx Transmission normal user type Type a file normal user ver Software version info normal user weeksched Program week schedule normal user zone Surveillance zones sysadm Table 4.11 Commands allowing user to change authority levels. The reserved word "all" can be used to set authority level for all commands.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 112 SET <authoritylevel>: Authority level: 0-2, 0:normal user, 1:super user, 2: sysadm. The reserved word "reset" can be used to set the authority level to the default settings. Examples Set the authority level for the “tx” command to “sysadm”: Set -au tx,2 Set the authority level for all commands to default: Set -au all,reset 4.35.11 SET -B ____________________________________REINITIALIZE SYSTEM PARAMETERS Purpose: Complete reset of configuration - essentially "a reset to factory default". Note, some system specific values are not reset (system id's, frequency correction offset, distributor password). Use this feature with outmost caution: lost data cannot in any way be restored Format: SE -b 1,<value> <value>: Value is returned by MES when issuing command "se -b" (without parameters) - used as part of a "are you sure" mechanism. Examples Configuration reset: :se -b 1 Usage: set -b 1,49325 : se -b 1,49325 Rebooting ... 4.35.12 SET -C (NA) _________________________ SHOW OR SET SERIAL PORT PARAMETERS 4.35.13 SET –E (NA) _________________________________ RECEIVE ONLY EGC MESSAGES Output will be "0" (disabled). 4.35.14 SET -FD ____________________________________________ FILESYSTEM CLEANUP Purpose: Enables or disables filesystem cleanup when MES boots. [2.12] Format: SE -fd <options> SE -fd Show current setting SE -fd { 0 / 1 } (disable or enable) When filesystem cleanup is enabled, all files on disk are removed when MES boots. Note, the three files _EGCLOG, _TXLOG and _RXLOG are regenerated by MES regardless of how the set -fd option is set.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 113 SET 4.35.15 SET -G _________________________________________ SET UP ALERT GENERATOR Purpose: Set up or show alert parameters. Format: SE -g <options> SE -g <LES_ID>[,<LES_ID>,<...>],<nature of alert>, <N or S>,<lat_deg>,<lat_min>,<lat_hun>, <E or W>,<lon_deg>,<lon_min>,<lon_hun>, <hour>,<minute>,<course>,<speed> <options> This command is allowed for TT3027C/D/SSA, otherwise “ERROR 550: No distress facility available” is returned. se -g without any parameters causes the MES to display the current alert generator setup. se -g with 14-17 parameters sets every manually adjustable parameter of the alert generator. A description of each parameter follows below. LES_ID: 1 to 4 LES IDs can be entered, although no more than one for each ocean region. Alerting will be disabled in ocean regions where no LES IDs have been entered. Nature of Alert: One letter representing the nature of alert. The babel below lists the possible natures of alert and their respective letters. Identifier Nature of Alert U Undesignated E Explosion/fire F Flooding C Collision G Grounding L Listing S Sinking D Disabled and adrift A Abandoning ship R Require further assistance P Piracy/armed attack Table 4.12 Nature of Alert. Position: Is given in latitude hemisphere, latitude degrees, minutes, and hundredths of minutes, longitude hemisphere, longitude degrees, minutes, and hundredths of minutes. Instead of entering an actual position the default values can be entered instead, causing the MES to use the most recent GPS position if available when sending the alert. The default values are S,127,63,124,W,255,63,124. Time: This time, given in hours and minutes, should correspond to the manually entered position. If the position was set to defaults, the value of the time parameter is ignored and the time of the GPS position is used instead. Time is entered in 24 hour format. Course: Course in degrees. Also ignored when using GPS position. Speed: Ignored when using GPS position.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 114 SET Example Set up LESs for two ocean regions (131 and 231), nature of alert (hijack), position, time (12:15), course (180°), and speed (150 km/h): se -g 131,231,g,n,55,53,0,e,12,14,0,12,15,180,150<CR> 4.35.16 SET -I ____________________ ENABLE OR DISABLE RECEPTION OF FLEETNET EGCS Purpose: Enable or Disable Reception of FleetNet EGCs. Format: SE -i <0|1> SE -i 0: Disables reception 1: Enables reception Using the command without parameters displays the current setting 4.35.17 SET -K (NA) _______________________ ENABLE OR DISABLE LAND MOBILE ALERTING -- se -k 1<CR> 4.35.18 SET –L (NA) ____________________________________ SETUP OR SHOW NCS LIST Purpose: Setup or show NCS list. Format: SE -l This command is obsolete and only preserved for backwards compatibility. Use the command NCS -l instead. 4.35.19 SET -M _________________________________________________ SET UP ALERT Purpose: Set up or show alert parameters. Format: SE -m <options> SE -m <LES_ID>,<protocol>,<nature> <options> SE -m <LES_ocean_r1>,<LES_ocean_r2>, <LES_ocean_r3>, <LES_ocean_r4> <options> SE -m ALL_OCEANS se -m without parameters causes the MES to display the current alert set-up. se -m with 3 parameters (LES_ID, protocol, and nature of alert) sets up the parameters for maritime alerts. Note that the protocol parameter is obsolete (insert any digit) and is only retained for backward compatibility. LES_ID should be a valid LES number. The Nature of Alert should be a letter according to Table 4.12. se -m with 4 parameters (4 valid LES numbers for 4 different ocean regions) sets up which LESs to send Covert Security and maritime alerts to. The MES will automatically select the LES corresponding to the current ocean region. In case the user does not wish to set up a LES for every ocean region, zeroes can be entered instead of one or more of the LES IDs. This form is preferred to configure the LES configuration for user defined LESs for Covert/Security alert.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 115 SET se -m followed by the text ALL_OCEANS will cause the MES to display all 4 LESs set up for alerting. Example Set up one LES ID, 131, and set Nature of Alert to “hijack” (G): se -m 131,0,g<CR> Set up LES IDs for three ocean regions, but leave one ocean region empty (no Alerts can be sent in that ocean region): se -m 31,131,0,331<CR> 4.35.20 SET -N _________ ENABLE OR DISABLE RECEPTION OF COASTAL WARNING CALL EGCS Purpose: Enable or disable reception of Coastal Warning Call EGCs (Navtex calls). Format: SE -n <0|1> SE -n 0: Disables reception 1: Enables reception Using the command without parameters displays the current setting 4.35.21 SET -NS _________ ENABLE OR DISABLE LOGIN ON THE NEAREST ALLOWED SATELLITE Purpose: Enable or disable the login on the ocean region with the nearest satellite when booting. Format: SE -ns SE -ns <0|1> 0: Use last used satellite 1: Use nearest allowed satellite Using the command without parameters displays the current setting 4.35.22 SET -O _________________________________________PREFERRED OCEAN REGION Purpose: Setup or show preferred or allowed ocean region, the current NCS and the synchronisation status. Format: SE -o <options> -o : Show preferred ocean region, the current NCS and the synchronisation status. -o , : Show preferred ocean region and the allowed ocean regions. -o : <preferred_ocean_region>[,<allowed_ocean_regions>] Set preferred ocean region. preferred_ocean_region : one letter <W,E,P,I,N> allowed_ocean_regions : one or more letter <W,E,P,I,N> Allowed_ocean_regions are only effective when the MES performs a scan.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 116 SET The ocean region possibilities are: West Atlantic East Atlantic Pacific Indian None In allowed ocean regions None really means all ocean regions. In order to display or change the allowed ocean region settings, system administrator authority level is required. Example : se -o<CR> <CR><LF> Preferred ocean : None<CR><LF> Current NCS : <STX>144<ETX> <STX>East Atlantic<ETX><CR><LF> Sync : Yes<CR><LF> : se -o ,pie<CR> : se -o ,<CR> Allowed ocean(s): East Atlantic, Pacific, Indian<CR><LF> 4.35.23 SET -P __________________________ SHOW OR SET POSITION AND HEADING VALUES Purpose: Show position and heading values. , or set a manual position for reception of geographically addressed EGCs. Format: SE -p SE -p <lat_deg>,<lat_min>,<lat_hun>,<N|S>,<lon_deg>,<lon_min>, <lon_hun>,<E|W>, <course>,<speed> lat_deg: Latitude degrees (0-90) lat_min: Latitude minutes (0-59) lat_hun: Latitude hundredths of minutes (0-99) N or S: Latitude hemisphere lon_deg: Longitude degrees (0-180) lon_min: Longitude minutes (0-59) lon_hun: Longitude hundredths of minutes (0-99) E or W: Longitude hemisphere course: integer from 0 to 360 degrees speed: positive integer in knots (0-255) Note The manually entered position is only used for area EGC reception. If a GPS position is available, it will always override the manual position. Please see the command FX to enter extra manual positions.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 117 SET Example : se -p<CR><LF> <CR><LF> Position : <STX>55 47 64 N 012 31 38 E<ETX> at 13:43:16 UTC <STX>Valid<ETX><CR><LF> Course : <STX>134<ETX> deg/true north<CR><LF> Speed : <STX>000<ETX> knots : 0000 kmph : 0000 mph<CR><LF> <CR><LF> 4.35.24 SET -Q ______________________________________________DISTRESS TEST MODE Purpose: Show, enable, or disable distress test mode Format: SE -q <0/1> <options> -q Show Distress Test Mode. -q 0 Distress Test Mode OFF. Distress functionality enabled. -q 1 Distress Test Mode ON. Distress functionality disabled. The Distress Test Mode is used to allow test of distress buttons, wiring and remote alarm box without sending distress. The se -q command is intended for implementation of a Test Mode menu in a message terminal. Test of the Distress Button in Distress Test Mode: Press the Distress Button for at least 5 seconds until the Distress LED is flashing at high frequency. Observe that the MES reacts by flashing the Alarm LED when the Distress Button has been activated. 4.35.25 SET -R ____________________________________________________SILENT MODE Purpose: Show, enable, or disable silent mode Format: SE -r <options> SE -r <1|0> When the MES is in silent mode, which is the default, INFO messages will not be displayed automatically. Instead they are stored in a log, which can be read using the ST –l command. SET -r without parameters prints out the current mode (silent or not silent). The parameter "1" enables silent mode, while the parameter "0" disables silent mode. 4.35.26 SET -S _____________________________________________ SET SPARE NAVAREA Purpose: Set extra Navarea for reception of Navarea-addressed EGCs. Format: SE -s <navarea> SE -s navarea: Navarea number or 0 for no area. In addition to the EGCs that would normally be received, EGCs addressed to the navarea set with this command will also be received. Using the command without parameters displays the current setting.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 118 SET Note The command SET -sn allows up to 4 extra Navareas to be set and displayed. 4.35.27 SET -SN ___________________________________________ SET SPARE NAVAREAS Purpose: Set up to 4 extra Navareas for reception of Navarea-addressed EGCs. Format: SE -sn <navarea>,[<navarea>,[<navarea>,[<navarea>]]] SE -sn navarea: Navarea number or 0 for no area. In addition to the EGCs that would normally be received, EGCs addressed to the navareas set with this command will also be received. Using the command without parameters displays the current setting. Note The command SET -sn allows up to 4 extra Navareas to be set and displayed. 4.35.28 SET -SP __________________________________________________ SPEED LIMITS Purpose: Setup or show speed limits . Format: SE -sp <option> SE -sp Show setup. SE -sp <SpeedLimit>,<Time> Setup limits and time. <SpeedLimit> Speed in km/h, [0..255]. <Time>Time in seconds [0..65535]. The setup will only have meanings, if the MES has been setup to send data-report on speed events or if an I/O pin is configured to respond to these events. Please see IO-o. Example : se -sp 80,120 <CR><LF> : se -sp <CR><LF> Speed limit: 80 km/h for 120 seconds<CR><LF> : 4.35.29 SET -U ________________________________________________ MOBILE NUMBER Purpose: Setup or show the Mobile Number. Format: SE -u <number> <options> -u Display the Mobile Number. -u <number> Set the Mobile Number in the MES. The number must be in the range of 400000000-499999999. The MES will respond with an error if the number is out of range otherwise the number will be stored in non-volatile memory:
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 119 SET Examples : set -u<CR> <CR><LF> Mobile number : 492380049<CR><LF> : set -u 1<CR> Illegal Number!<CR><LF> : : set -u 492380021<CR> The number will now be stored permanently<CR><LF> : : set -u ?<CR> <CR><LF> Mobile number : 492380049<CR><LF> Enter new number > 4.35.30 SET -W ________________________ DISPLAY SAFETYNET EGC RECEPTION SETTING Purpose: Display whether SafetyNet call reception is enabled or disabled. Format: SE -w 0: Disabled 1: Enabled This command is applicable for TT-3027M/LT/SSA. Please note that changing the setting requires sysadm authority level. 4.35.31 SET -X _____________________________________ SET COASTAL WARNING AREAS Purpose: Set Coastal Warning Areas (Navtex areas) for EGC reception. Format: SE -x <areas> SE -x areas: List of letters representing the areas. Using the command without parameters displays the current setting Example : se -x abcdefg : se -x -x (str) value is abcdefg : 4.35.32 SET -Y ____________________________________________ SET NAVTEX SERVICES Purpose: Set Navtex Services for EGC reception. Format: SE -y <services> SE -y services: List of letters representing the services. Using the command without parameters displays the current setting
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 120 Sleep Example : se -y abcdefg : se -y -y (str) value is abcdefg : 4.35.33 SET -Z __________________________________________ ENVIRONMENT VARIABLES Purpose: Set up or show environment variables. IMPORTANT: Environment variables are only implemented for backward compatibility reasons. Only the TZ (Time Zone) and PRNFILTER (disable log or status printing) is stored and restored at power-on. Any other changes to environment variables are lost and reset to default settings at power-on. Format: SE -z <options> SE -z Show all environment variables SE -z <variable>=<value> Set environment <variable> equal to <value>. SE -z <variable>= Delete environment <variable> The intention with this command is that old implementations can still read environment variables without receiving error messages. Therefore a number of environment variables are implemented with fixed values, which cannot be changed. Example : se -z<CR><LF> <CR><LF> 1: POSFORMAT=PU<CR><LF> 2: PRINTER=NO<CR><LF> 3: PPAGING=NO<CR><LF> 4: PLINES=61<CR><LF> 5: FFEED=NO<CR><LF> 6: OCEANSHIFT=SIGNAL<CR><LF> 7: PCHARS=80<CR><LF> 8: PCUTLN=NO<CR><LF> : 4.36 SLEEP Purpose: Controls sleep mode operation. Format: SLeep <options> Sleep mode is allowed for TT-3027D/M and controlled from the command interface. Since the TCU is mandatory when paired with a TT-3027D, the TCU shall also be configured for sleep mode operation. Please see Power control (X1) in [7]. Whether or not sleep mode is enabled or disabled if the power to the MES is removed, the MES will send "Power Down Report" and "Power Up Report" when supply power has been re-established. The "Power Down Report" includes the last known position before the power was removed. The "Power Up Report" includes the current position.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 121 Sleep If sleep mode is enabled and the supply power is removed using the remote switch on the TCU then the MES will indicate this by sending an "Enter Sleep Mode Report", before the power is switched off and "Leave Sleep Mode Report" when MES is switched on again. The "Enter Sleep Mode Report" includes position at the time of MES is switched off. The " Leave Sleep Mode Report" includes position at the time of MES is switched on again. Sleep mode is configured with wakeup using “SL -i x,x,x,x,x” (x is any value, except from all 0). This allows the MES to save power/battery and periodically wakeup in interval of 1-24 hours and transmit data-report etc. The MES always automatically turns off the power, after transmission of the last data-report. The configurations also setup the MES to wakeup every 24 hours at a fixed time for a fixed period of time (from 15 to 60 minutes). During this fixed time wakeup, the MES can be reconfigured, receive messages etc. 4.36.1 SLEEP -C _______________________________ DISABLES SLEEP MODE OPERATION Purpose: Disables sleep mode operation. Format: SL -c Example Disable sleep mode: : sl -c<CR> <CR><LF> : sl -d<CR> <CR><LF> Sleep mode not enabled<CR><LF> : 4.36.2 SLEEP -D _____________________________________ SHOW SLEEP MODE STATUS Purpose: Show sleep mode status. Format:SL –d 4.36.3 SLEEP -F _________________________________ SETUP SLEEP MODE REPORT FILTER Purpose: Enables or Disables filtering of sleep mode reports. Format: SL -f <enable>,<distance> Enable: 0 = Sleep mode reports will not be filtered 1 = Sleep mode reports will be filtered. Distance: Maximum distance from the ‘enter sleep mode’ position before the filtering is forced off thus permitting sleep mode reports to be sent. Values are entered in 10 meter steps, eg. ”100” means 1 km. Filtering (i.e., removal) of sleep mode reports applies to In Sleep and Fix Time reports. Note that the filter will be disabled when sufficient movement has been detected thus allowing sleep mode reports to be sent; if the filter is required to be re-enabled at a later time this can be done either be issuing this command again, or be using an I/O pin programmed as input. .
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 122 Status 4.36.4 SLEEP -I ___________________________________ SETUP SLEEP MODE OPERATION Purpose: Setup sleep mode operation. Format: SL -i <T1>,<HH>,<MM>,<T2>,<FC> T1: Wake up interval. T1 is the duration in hours the MES sleeps between wake ups. If T1=0, then there are no periodic wake ups defined. HH: Hour of fixed time wake-up in UTC time (0-23) MM: Minute of fixed time wake-up in UTC time (0-59) T2: Duration of fixed time wake-up in minutes (0, 15-60) FC: Number of fixed time wake-ups in 24 hour (1,2,3,4,6,8,12). This parameter is optional. If it is omitted, there will be one wake-up occurring the given time. If T1, HH, MM, and T2 are all zero then there will be no wake-up (neither fixed time nor sleep mode based) after the MES is powered down. If more than one fixed time wake-up is requested (FC > 1) these wake-up times will be distributed evenly over a 24-hour period. Example Enable sleep mode: : sl -i 5,23,0,30,3<CR> <CR><LF> : sl -d<CR> <CR><LF> Next Wake Up: 04-07-08 14:27<CR><LF> Wake Up Interval: 5 Hours<CR><LF> Next Fix Time: 04-07-08 23:00 (3 fix times per 24 hours) <CR><LF> <CR><LF> Duration: 30 minutes<CR><LF> <CR><LF> : This example sets three fixed time wake-ups at 23:00, 07:00, and 15:00 (11 PM, 7 AM, and 3 PM). 4.36.5 SLEEP -L ____________________________ SETUP AUTO-LOGOUT BEFORE SLEEP MODE Purpose: Enables or Disables automatic logout before power down for sleep mode without wakeup. Format: SL -l [0|1|?] 4.37 STATUS 4.37.1 STATUS __________________________________________ DISPLAY MES STATUS Purpose: Display Inmarsat-C related information that the user can not directly change. Format: STatus <options> The status command displays various Inmarsat-C system parameters. The only parameters that can be changed with this command are the enable and disable status of the ENID and DNID's.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 123 Status The command without any parameters will display all the options: : st status : Various status status Usage: status <option> -a : Latest distress -c : Channel -d <addOption> : DNID table -e : EGC log -g <d/e><enid> : EGC FleetNet ID's -i <str> : Identification -l : Last command(s) -m : Latest test result (P) -n : LES Network table -q : Queued command(s) -r : RX log -s : Signal strength -o <flag> : Power-on statistics (P) -t : TX log -w : Hardware screen (P) (F) -v : Program version : 4.37.2 STATUS -A _____________________________________ STATUS OF LATEST ALERT Purpose: Show the latest distress status and clear any audible and visual alert indications. Format: ST -a The possibilities are: None (No distress has been sent since power on) Sending (MES is sending a distress) Accepted (MES has sent a distress and it has been acknowledged by LES) Rejected (MES has sent a distress and it has been rejected by LES Example st -a<CR> <STX><CR><LF> Latest Distress : none<ETX><STX><CR><LF> Latest Distress test : none<ETX><CR><LF>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 124 Status 4.37.3 STATUS -C ________________________________________ CHANNEL PARAMETERS Purpose: Show the current channel parameters: synchronisation, login status, TDM type, TDM channel number, current channel, current protocol activity, TDM origin, TDM frame number, Bulletin Board error rate and time of last login or logout. Format: ST -c Example : st -c<CR> <CR><LF> <CR><LF> SOFTWARE: Version 1.0 Oct 16 2001 09:23:04, Inmarsat-C MES <CR><LF> Synchronization : yes Serial no : 906407<CR><LF> Logged in : yes Mobile no : 492380049<CR><LF> TDM type : NCS Preferred ocean: None <CR><LF> TDM channel number : 12580<CR><LF> Current channel : NCS<CR><LF> Current protocol : Free<CR><LF> TDM origin : 144<CR><LF> TDM frame number : 5449<CR><LF> BB error rate : 2 of 100<CR><LF> Last login at Fri Oct 12 11:50:43 2001<CR><LF> <CR><LF> : Synchronization Yes | No Serial no 6 digit number Logged in Yes | No Mobile no 9 digit number TDM type NCS | LES | Joint NCS | Standby NCS | - Preferred ocean West Atlantic | East Atlantic | Pacific | Indian | None TDM channel number 6000-14000 Current channel NCS | LES | Signalling | Message | Retuning | - Current protocol Free | Pending | Sending Distress | Sending Distress test | Confirmation request | Login | Logout | Changing NCS | Scanning | Link Test | Transmission | Receiving message | Position report | Data report | Programmed report TDM origin 1-63 | 101-163 | 201-263 | 301-363 TDM frame number 0-9999 BB error rate 0-100 Table 4.13 Channel Parameter Field Values 4.37.4 STATUS -D ___________________________________________ DNID INFORMATION Purpose: Display the stored DNID information. Format: ST -d <add options> The term DNID entry refers to the union of the four elements: LES ID, DNID, Member Number and Sub-address. The command displays a line of information for each DNID entry. All four elements is downloaded to the MES via the link and except for the Sub Address the user is not able to alter any of them.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 125 Status Via the DA data report command set-up command the user is able to select an alternative sub-address when responding to a poll. The items in Table 4.14 will currently be displayed. Provider Name Describes the service provider. The MES stores this in a compressed format internally with maximally 24 characters length. S (tatus) A bit field describing the current use of the DNID entry. Several bits may be combined into one status code number. LES Land Earth Station ID. DNID Data Network ID. Mem(ber) Member Number in the DNID group. Sub (Address) Logical address of a unit attached to the MES. Chan(nel) TDM channel number to use for reporting. Rd (Randomising) A timing interval used by the MES to spread out a group response to a poll. Table 4.14 DNID Item List When the use of a particular DNID entry is not needed any more it’s status should be set to disabled as this will indicate to the MES that the particular DNID can be overwritten if a new DNID is downloaded, in case the DNID storage is full. A DNID entry is disabled by putting the letter D in front of the DNID entry when sending the st -d command. This will also remove any position reporting indication for this DNID entry. The MES currently has capacity for 64 DNID entries. When a new DNID is downloaded it will automatically be set Active and in use for data reporting as this will prevent the entry from being overwritten by a subsequent download. Example st -d Provider Name S LES DNID Mem Sub Chan Rd Thrane & Thrane USR Group: 5 131 17734 37 0 11096 48 A colon always separates the provider name (always 25 characters) from the other information.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 126 Status 4.37.5 STATUS -E _____________________________________________ SHOW EGC LOG Purpose: Show the Enhanced Group Calls (EGC) log. Format: ST -e Table of EGC Log Columns and Terms LES Land Earth Station number. Sv Service number. Hexadecimal: 00H General Call 02H Group Call 04H Urgency Message, Nav Warning to Rectangular Area 11H INMARSAT System Message 13H Coastal Warning 14H Distress Alert to Circular area 23H EGC System Message 24H Urgency Message, Nav Warning to Circular Area 31H MET Navarea Warning or MET Forecast 33H Download Group Identity (ENID) 34H SAR Coordination to Rectangular area 44H SAR Coordination to Circular area 72H Chart Correction Service 73H Chart Correction Service for fixed areas P Priority number: 0 Routine 1 Safety 2 Urgency 3 Distress L Language (presentation). 0 Int. Alphabet no. 5, odd parity 6 ITA 2, packed baudot 7 Data Time Local time of reception. (DD-MM-YY HH:MM). Bytes Number of characters in the message. Seq.no Message reference number. Given by the LES. R LES message repetition number. Status Message destination. As for receive log. File Received file. Name begins with the letters "EGC." followed by a sequential three digit number. Table 4.15 EGC Log Terms Example : st -e EGC log at 02-12-12 12:48:45 LES Sv P L Time Bytes Seq.no Errors R Status File ---------------------------------------------------------------- 012 31 1 0 02-12-02 10:38 246 109 0 0 Mem EGC.288 012 31 0 0 02-12-02 10:39 328 108 0 0 Mem EGC.289 012 31 2 0 02-12-02 10:39 164 110 0 0 Mem EGC.290 012 00 0 0 02-12-02 11:08 21 24 0 0 Mem EGC.291 012 11 0 0 02-12-02 11:08 21 25 0 0 Mem EGC.292 012 14 0 0 02-12-02 11:20 21 38 0 0 Mem EGC.293 012 04 0 0 02-12-02 11:34 21 46 0 0 Mem EGC.294 012 33 0 0 02-12-02 12:49 47 106 1 0 Mem EGC.301 012 33 0 0 02-12-02 12:54 47 106 0 0 Mem EGC.302 9 Entries listed :
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 127 Status 4.37.6 STATUS -G ___________________________________________ ENID INFORMATION Purpose: Display or configure ENID information. Format: ST -g <d/e><enid> <options> -g Show the list of stored ENID’s (EGC Network ID)'s. -g e<enid> Enable reception for the ENID. -g d<ENID>Disable reception for the ENID. The ENID list contains the items shown in Table 4.16. Provider Name Describes the service provider. The MES stores this in a compressed format internally with maximally 24 characters length. ENID EGC Network ID Status ENID status: Enabled or disabled. Only if disabled the status is printed. Table 4.16 ENID Item List Example st -g<CR> <CR><LF> <CR><LF> EGC Network ID list<CR><LF> <STX>131,t&t egc user gr <ETX> <STX> 100<ETX><CR><LF> <STX>131,t&t egc user gr <ETX> <STX> 101<ETX><CR><LF> <STX>131,t&t egc user gr <ETX> <STX> 102<ETX><CR><LF> <STX>131,t&t egc user gr <ETX> <STX> 103<ETX> disabled<CR><LF> <STX>131,t&t egc user gr <ETX> <STX> 104<ETX><CR><LF> 5 ENID(s) stored<CR><LF> ENID’s are downloaded via the Inmarsat-C Network automatically, and are used for various automatic messaging protocols. When the EGC facility is used in the MES the status of the downloaded ENID's can be displayed and changed. The ENID's are downloaded to the MES by an individual addressed EGC message (to mobile number of the MES). When a particular ENID is stored and enabled any EGC message addressed to this ENID will be received. If the ENID is disabled the MES will ignore these messages. Example Enabling and disabling an ENID st -g e101 st -g d103 A disabled ENID can be overwritten by new ENID download if the ENID storage is full. 24 ENID’s can be stored in the MES.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 128 Status 4.37.7 STATUS -I ______________________________________ SHOW MES IDENTIFICATION Purpose: Show MES identification: serial number, type and mobile number. Format: ST -i Example : st -i<CR><LF> <CR><LF> Serial number : <STX>0890254<ETX><CR><LF> Terminal type : <STX>Inmarsat-C MES<ETX><CR><LF> Mobile number : <STX>492380345<ETX><CR><LF> Mobile type : <STX>Non-SOLAS Maritime<ETX><CR><LF> ISN number : 4TT09851af1f<ETX><CR><LF> Hardware id : 0<ETX><CR><LF> : 4.37.8 STATUS -L ________________________________________ SHOW STATUS REPORT Purpose:Show status reports from the last commands. These are described in chapter 5 . Format: ST -l Example An example from a longer session: st -l<CR> <CR><LF> INFO 82: Transmission issued OUT.646 and put in queue<CR><LF> ERROR 253: No printer. Fetch file: REPORT.001 named OUT.646<CR><LF> INFO 52: Changing NCS issued and put in queue<CR><LF> INFO 41: Logout successful<CR><LF> INFO 31: Login successful<CR><LF> INFO 51: Changing NCS successful<CR><LF> INFO 80: Transmission failed.<CR><LF> <CR><LF> Destination <STX>581482380010 File OUT.646<ETX><CR><LF> Vital earth station information is missing<CR><LF> ERROR 253: No printer. Fetch file: REPORT.004 named REPORT.<CR><LF>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 129 Status 4.37.9 STATUS -M ______________________________________ SHOW LAST TEST RESULT Purpose: Show the results of the last test preformed using the command “TEST”. Format: ST -m 4.37.10 STATUS -N ___________________________________ SHOW LES NETWORK TABLE Purpose: Show land station network table entry by entry from a shown list. Format: ST -n <options> -n Show all LES’s supporting “Mini-C MES traffic” -n A Show all LES’s The LES network table is (apart from the NCS table) downloaded from the current NCS when loging in for the first time. The version number that the MES send with the login request, assures that the MES will always have the latest table, as the NCS will download the newest version number, if an older is stored in the MES. The command lists the status of the LES and the services available at the LES. The services are listed with one service on each line and the maximum number of services are 16. Example : st -n<CR><LF> <CR><LF> Land Station Network version number: 39<CR><LF> Total number of LES: 5<CR><LF> Choose a LES id from this list<STX><CR><LF> 102 104 112 114 121<ETX><CR><LF> > 102<CR><LF> <CR><LF> LES id <STX>102<ETX> at Frequency 11846<CR><LF> Status :<STX><CR><LF> 600 bps return link<CR><LF> Operational satellite<CR><LF> In service<CR><LF> Clear at the moment<CR><LF> Open terrestrial links<ETX><CR><LF> Service :<STX><CR><LF> FleetNet traffic<CR><LF> Closed network traffic<CR><LF> Telex S&F traffic<CR><LF> Inmarsat-C traffic<CR><LF> SafetyNet traffic<CR><LF> Maritime Distress traffic<CR><LF> Mini-C MES traffic<CR><LF> 8 Bit (Data) traffic<CR><LF> 5 Bit (ITA-2) traffic<CR><LF> Aero-C traffic<CR><LF> Land mobile alerting traffic<ETX><CR><LF> Choose a LES id from this list<STX><CR><LF> 102 104 112 114 121<ETX><CR><LF> > <CR><LF> : Enter is used to quit. Possible information, row by row: 300 | 600 Operational | Spare
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 130 Status In service | out of service except for alarms Clear | Congested Open | Closed <variable number of service lines, max 16> list of integer numbers (max. 80) 4.37.11 STATUS -O ________________________________________ POWER ON STATISTICS Purpose: Show the power-on statistics of the MES. Format: ST -o [E] The result of the command is a list of the last 5 power-ons indicating the time the MES was turned on and the length of time it remained on. The duration is shown with an accuracy of one hour. Example : st -o<CR><LF> <CR><LF> Power-on statistics:<CR><LF> --------------------<CR><LF> At 01-12-06 18:32 for 0 hours<CR><LF> At 01-12-07 08:49 for 72 hours<CR><LF> At 01-12-10 08:59 for 0 hours<CR><LF> At 01-12-10 09:05 for 0 hours<CR><LF> At 01-12-10 14:22 for 64 hours<CR><LF> Using power on statistics with option 'E' (st -o E), extends the statistics to 15 entries and detailed information; Power on time and reasons (Wakeup or Remote Power On) Duration of Power on time Power off reason (watchdog reset, Remote Power Off) Example : st -o E System power up time: Thu Jan 1 00:00:16 1970 Power-on statistics: -------------------- At 15-06-01 13:44:53 for 00:01:35 hours (15-06-01 13:46:28), POWER_ON, NICE_POWERDOWN At 15-06-01 13:48:11 for 00:03:54 hours (15-06-01 13:52:05), POWER_ON, NICE_POWERDOWN At 15-06-01 13:53:58 for 00:00:00 hours (15-06-01 13:53:58), POWER_ON, NICE_POWERDOWN At 15-06-01 13:56:30 for 00:14:07 hours (15-06-01 14:10:37), POWER_ON, NICE_POWERDOWN At 15-06-01 14:29:45 for 19:45:56 hours (15-06-02 10:15:41), POWER_ON, FORCED_RESET At 15-06-02 10:17:08 for 00:09:49 hours (15-06-02 10:26:57), POWER_ON, FORCED_RESET At 15-06-02 10:28:25 for 214:07:04 hours (15-06-11 08:35:29), POWER_ON, POWER_LOST At 15-06-11 08:45:04 for 03:23:22 hours (15-06-11 12:08:26), POWER_ON, FORCED_RESET At 15-06-11 12:09:54 for 21:24:19 hours (15-06-12 09:34:13), POWER_ON, FORCED_RESET At 15-06-12 09:35:42 for 03:08:57 hours (15-06-12 12:44:39), POWER_ON, FORCED_RESET At 15-06-12 12:46:07 for 53:30:34 hours (15-06-14 18:16:41), POWER_ON, FORCED_RESET At 15-06-14 18:18:09 for 12:09:07 hours (15-06-15 06:27:16), POWER_ON, FORCED_RESET At 15-06-15 06:28:44 for 00:39:26 hours (15-06-15 07:08:10), POWER_ON, FORCED_RESET
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 131 Status At 15-06-15 07:09:38 for 00:12:57 hours (15-06-15 07:22:35), POWER_ON, FORCED_RESET At 15-06-15 07:24:03 for 01:20:18 hours (15-06-15 08:44:21), POWER_ON : Reason text NICE_POWER_DOWN WATCHDOG_RESET EXCEPTION POWER_LOST FORCED_RESET POWER_ON WAKEUP FIXED_WAKEUP Table 4.17 Power on statistics reasons. 4.37.12 STATUS -Q ____________________________ SHOW CONTENTS OF COMMAND QUEUE Purpose: Show contents of command queue. Format: ST -q Example : st -q<CR><LF> <CR><LF> Current activity : Scanning<CR><LF> Activities in queue<CR><LF> 1 : Transmit message 2 : Transmit message 3 : Logout<CR><LF> : The information is the same as seen in the 5th row of the st -c information. 4.37.13 STATUS -R _______________________________________________ RECEIVE LOG Purpose: Show receive log. Format: ST -r Example st -r<CR><LF> <CR><LF> RX log at 01-10-25 10:33<CR><LF> LES Sv P L Time Bytes Mess.no S Status File<CR><LF> -----------------------------------------------------------<CR><LF> 131 0 0 0 01-10-24 16:28 120 102425 0 Mem IN.203<CR><LF> 131 0 0 0 01-10-24 19:15 120 102461 0 Mem IN.204<CR><LF> 131 0 0 0 01-10-24 21:23 120 102485 0 Mem IN.205<CR><LF> 131 0 0 0 01-10-24 21:55 120 102508 0 Mem IN.206<CR><LF> 131 0 0 0 01-10-24 22:11 120 102515 0 Mem IN.207<CR><LF> 131 0 0 0 01-10-25 00:23 120 102524 0 Mem IN.208<CR><LF> 131 0 0 0 01-10-25 00:37 120 102546 0 Mem IN.209<CR><LF> 7 Entries listed<CR><LF> Explanation of the columns are given in Table 4.18.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 132 Status LES Land Earth Station number. Sv Service number. Hexadecimal value. 0 Store-and-forward. 1 Half duplex data. 2 Data. Bit transparent. No ARQ. 3 Data. With ARQ. 4 Pre-assigned data reporting. 5-D Spare. E Performance verification message. F Reserved. P Priority number. 0 Routine. 1 Spare. 2 Spare. 3 Distress. L Language (presentation). 0 Int. Alphabet no. 5, odd parity 6 ITA-2. Packed baudot. 7 Data. Time Local time of reception: DDMM-YY HH:MM. Bytes Number of characters in the message. Mess. no Message reference number. Given by the LES. S Sub-address. Local routing at the MES. Status Message destination. Mem Memory (or disk). File Name of received file. Begins with the letters "IN." followed by a sequential three digit number. Table 4.18 Receive Log Description If a message reception fails, no information about it is stored in the receive log. 4.37.14 STATUS -S ______________________________________ SHOW SIGNAL STRENGTH Purpose: Show signal strength : number from 0 to 5. Format: ST -s Example st -s<CR> <CR><LF> Signal strength : <STX>5<ETX><CR><LF>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 133 Status 4.37.15 STATUS -T ______________________________________________ TRANSMIT LOG Purpose: Show the transmit log. Format: ST -t Example st -t<CR> <CR><LF> TX log at 01-10-25 10:52<CR><LF> LES Sv P L Time Bytes Destination MTCA Status File/Ref<CR><LF> ----------------------------------------------------------------------<CR><LF> 131 0 1 0 01-10-25 09:02 67 581482380120 0000 Acknowl 107352<CR><LF> 131 0 1 0 01-10-25 09:13 67 581482380120 0000 Acknowl 107364<CR><LF> 131 0 1 0 01-10-25 09:14 463 581482380010 0010 Failed 107373<CR><LF> 131 0 1 0 01-10-25 09:14 463 581482380120 0010 Cleared OUT.267<CR><LF> 131 0 1 0 01-10-25 09:29 463 581482380120 0010 ConReq 107385<CR><LF> 131 0 1 0 01-10-25 09:20 463 581482380010 0010 Cleared OUT.268<CR><LF> 131 0 1 0 01-10-25 09:36 361 581482380010 0010 Sending OUT.269<CR><LF> 7 Entries listed<CR><LF> Plase see Table 4.19
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 134 Status LES Land Earth Station number. Sv Service number. Hexadecimal. Please see above (st -r command). P Priority number. 1 Immediate delivery 0 Deferred delivery L Language (presentation). Please see above (st -r command). Time Local time of reception. (DDMM-YY HH:MM). Bytes Number of characters in the message. Destin . Number of the called party. M Multi addressed message number. 0 are single addr. 0 is the primary receiver, 1 is the secondary etc. T Destination network type. 0 Telex 1 PSTN 2 CSDN 3 PSDN 5 Closed network. 6 Special access code. 7 Other. C Confirmation request. 0 Not requested. 1 Requested. A Alarm (SOS) message. 0 Normal message type. 1 Alarm message type. Status Current status of the message. Waiting is waiting to be sent. Sending is being sent or are in queue. Acknowl has been accepted by the LES. ConReq as above + confirmation is requested. Deliver has been successfully delivered Pending is held pending by the LES. Reject has been rejected by the LES. Cleared has been cancelled or transmission has failed. Failed delivery has failed. NotDelv message is not yet delivered. NoInfo LES has no info of this message. File / Ref Name of received file. File Name of transmitted file. Begins with the letters "OUT." followed by a sequential three digit number. Ref message reference number (from the LES) in case of a successful transmission. Table 4.19 Transmission Log Description
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 135 Status 4.37.16 STATUS -V ______________________________ SHOW SOFTWARE VERSION NUMBER Purpose: Show software copyright notice and version number. Format: ST -v Example : st -v<CR><LF> <LF> <LF> <LF> <LF> <LF> Non-SOLAS Maritime Inmarsat-C MES, Tr Version 3.00<CR><LF> (C) Copyright 2001 Thrane & Thrane A/S<CR><LF> Version 1.0 Oct 16 2001 09:23:04<CR><LF> <CR><LF> : 4.37.17 STATUS -W ____________________________________ HARDWARE STATUS SCREEN Purpose: Show hardware status screen Format: ST -w Example This is an example of the information: : st -w<CR><LF> <CR><LF> <STX><CR><LF> HARDWARE: System Clock 2004-11-18 09:36 PCB 0-00000000-0000<CR><LF> LO Vtune OSC offset/Acc/PllF RX/TX/AGC B/S/CNo<CR><LF> 0mV -137Hz 0mA 1<CR><LF> . -139Hz 0mA 5<CR><LF> . -21Hz 99 43dBHz<CR><LF> <CR><LF> SOFTWARE: Version 2.14 Nov 1 2004 18:20:53, Inmarsat-C MES<CR><LF> <CR><LF> Synchronization : yes Serial no : 906405<CR><LF> Logged in : yes Mobile no : 0<CR><LF> TDM type : NCS Preferred ocean : None <CR><LF> TDM channel number : 11080 <CR><LF> Current channel : NCS <CR><LF> Current protocol : Free <CR><LF> TDM origin : 44 <CR><LF> TDM frame number : 3999 <CR><LF> BB error rate : 0 of 100 <ETX><CR><LF> : Table 4.20 gives a description of the fields in the hardware status screen. For backward compatibility reasons, some of the values are always displayed with value zero. A description of the other fields can be found in Table 4.13.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 136 SU Field Normal values Description OSC offset <25 kHz Offset to actual carrier. The value is likely to rise with temperature and as the MES ages. Acc <25 kHz Offset to actual carrier do to aging. PllF <100 Hx Measured offset to current channel carrier RX TBD TX TBD AGC 20 - 255 Signal gain. The values listed are maximum and minimum values respectively. In normal operating conditions, the value will be around the middle of this range. B TBD S TBD CNo >28 dbHz Carrier to noise ratio. A lower value indicates no signal or bad signal. RX, LO Vtune, and TX are always displayed with value zero, for backward comparability reasons. Table 4.20 Hardware Status Screen Description 4.38 SU 4.38.1 SU ___________________________________________________ SUBSTITUTE USER Purpose: Substitute user identity. Format: SU <username> Prompts: Enter password: This command change the effective user id to that of <username>, if the correct password is entered. Username can be one of the 3 built in user accounts. Level Username Default password 2 sysadm sysadm 1 super super 0 normal (no password) Table 4.21 Built in users and default passwords. The assignment of factory default username (Authority Level) to shell commands can be seen in command SE -au
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 137 Test 4.39 TEST 4.39.1 TEST _______________________________________________________ LINK TEST Purpose: Issues a link test request. Format: TEst <options> A link test is an automatic test procedure which tests message reception, message transmission and alert transmission. 4.40 TIME 4.40.1 TI _________________________________________________ SHOW PRESENT TIME Purpose: Display or set the system clock. Format: TIme <options> TI -u Show UTC time TI -g Show GMT time (same as utc-time) TI -l Show local time TI -? Request Help The command will show the present time: local time if the TZ configuration parameter is set, UTC if not. This command gives the following possibilities: When a GPS position is available, the time shown by this command will be the current time obtained from the GPS satellites. The MES will automatically adjust its RTC (Real Time Clock) hardware continually, so that the MES's time will be accurate between power-ons. An INFO 463 message is received when this happens. TZ configuration variable TZ is the environment variable used for setting the time zone. Use the following syntax to set the TZ environment variable: set -z TZ=tzn[+ | -]hh[:mm] The tzn is a three-letter time-zone name, such as “UTC”, followed by an optionally signed number, +/- hh, giving the difference in hours between UCT and local time. To specify the exact local time, the hours can be followed by minutes. The time-zone name has no effect to the functionality of the TZ setting and i.e. can be any three-letter name. Example se -z TZ=UTC-2:0
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 138 Transfer 4.40.2 TI -L _________________________________________________ SHOW LOCAL TIME Purpose: Display local time. Format: TI -l Example ti -l<CR> <CR><LF> 01-10-22 12:35:00<CR><LF> : 4.40.3 TI -S ________________________________________________________ SET TIME Purpose: Set UTC time. Please notice that the UTC time is adjusted frequently, whenever the GPS delivers a valid time. Format: TI <yyyy-mm-dd> <hh:mm> Example ti 01-10-22 10:35:00<CR><LF> : 4.40.4 TI -U ___________________________________________________ SHOW UTC TIME Purpose: Display UTC time. Format: TI -u Example ti -u<CR> <CR><LF> 01-10-22 10:35:00<CR><LF> : 4.41 TRANSFER 4.41.1 TRANSFER ________________________________ TRANSFER FILE FROM CONSOLE Purpose: Make a new file with data from the console input. Format: TRansfer <filename> The command will input a file from the console and stop after a 5-second time-out. The transfer will then be in text mode, which means that a LF character on the console input is converted to a CR+LF pair in the file. The MES should be allowed at least 20 ms to switch from text mode (command line) to binary mode (the input data).
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 139 TX 4.41.2 TRANSFER -B ______________________________ TRANSFER IN BINARY NOTATION Purpose: The file is transferred binary. Format: TR <filename> -b <byte_count> All characters from 00H to FFH can be used. The number <byte_count> must match the actual number of characters transferred. If <byte_count> is larger than the number of characters sent, the command will time-out after 5 seconds. 4.42 TX 4.42.1 TX _______________________________________________ TRANSMIT A MESSAGE Purpose: Transmit a message file. Format: TX <filename> <options> TX -c <LES ID> <filename> [-s <delivery service>] [-t <destination network>] [-l <Language>] [-e <destination extension>] [-h <hour>:<minutes>] [-k] [-y <YY-MM-DD>] [-v] [-a] This command initiates a transmission. If no options are given, the default transmission parameters are shown. In the telex service case the file must contain a destination as the first line (using the CCITT U.80 recommendation). The same message can be sent to several destinations by adding more address lines in the beginning of the file. If only the filename and LES ID are specified in the command lime, the default parameter values will be used as default. If the LES is busy it can either reject the call attempt or give it Pending status. If pending status is given to the MES, it will show this in the 'Current protocol' field of the st -c command. When pending the MES will not service any other transmission commands from the user. The LES will automatically call up the MES when it has spare capacity. 4.42.2 TX -A ________________________________________ SEND WITH DISTRESS PRIORITY Purpose: Transmits a message with distress priority. Format: TX <filename> -a <options> This option is only allowed on TT-3027C/D. 4.42.3 TX -C _________________________________ SPECIFY LES TO ROUTE THE MESSAGE Purpose: Specifies which LES to route the message. Format: TX <filename> -c <LES ID> <LES ID> is an integer from in the ranges 1-63, 100-163, 200-263 or 300-363. 4.42.4 TX -E ___________________________ ADDITIONAL RECEIVER ADDRESS INFORMATION Purpose: Specifies additional receiver information Format: TX <filename> -e <destination extension> The destination extension is a string describing additional information for the PSTN destination type specifying the modem protocol, the code for the Special Access Code destination or the DNID and Member Number for Transmissions to Closed Networks.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 140 TX When the destination network type is PSTN (-t 1) the destination extensions holds: "V22B" selects a telephone modem. "T30" selects a FAX modem. This is not used by the MES, but at the LES to choose the correct modem protocol type. When the destination network type is closed network (-t 5) the destination extensions holds the DNID. Specify the DNID and Member Number as: DNID,Member. Destination address may be ommited in the file. When the destination network type is Special access code (-t 6) the destination extensions holds a string of up to 6 letters. Destination address may be omitted in the file. 4.42.5 TX -H _______________________________________________ TRANSMISSION TIME Purpose: Transmission time. Format: TX <filename> -h <hour:minutes> <options> Must be entered in 24 hour format. If specified without parameters current time is displayed after execution. 4.42.6 TX -K _________________________________ KEEP MESSAGE AFTER TRANSMISSION Purpose: Keep the message after transmission. Format: TX <filename> -k <options> 4.42.7 TX -L ______________________________ SET PRESENTATION AT THE RECEIVING END Purpose: An integer specifying the presentation at the receiving end. Format: TX <filename> -l <language> 0 Int. Alphabet no. 5, odd parity 6 ITA-2. Packed baudot. 7 Data. 4.42.8 TX -S _________________________________________ SPECIFY TRANSMIT SERVICE Purpose: Specifying the transmit service to use. Format: TX <filename> -s <delivery service> An integer specifying the delivery service: 0 Store-and-forward. 1 Prefixed Store-and-forward. 4.42.9 TX -T _________________________________________ SPECIFY TERRESTRIAL LINK Purpose: Specifying the terrestrial link to use. Format: TX <filename> -t <destination network type> An integer specifying the destination network type: 0 Telex
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 141 Type 1 PSTN Use -e(fax or telephone modem) 3 PSDN(X.25 data network) 5 Closed networkUse -e(DNID's) 6 Special access codeUse -e 4.42.10 TX -V ___________________________________________ REQUEST CONFIRMATION Purpose: Request confirmation from the LES on the final delivery from the LES to the destination. Format: TX <filename> -v <options> 4.42.11 TX -Y _______________________________________________ TRANSMISSION DATE Purpose: Set transmission date. Format: TX <filename> -y <year-month-day> <options> If specified without parameters current date is displayed after execution. 4.43 TYPE 4.43.1 TYPE ____________________________________ DISPLAY THE CONTENTS OF A FILE Purpose: Display the contents of a file. Format: TYpe <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.43.2 TYPE -B _________________________________________________ TYPE BINARY Purpose: The file is typed binary. Format: TY <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.43.3 TYPE -K ________________________________________________ TYPE AND KEEP Purpose: The file is typed and the file is kept in the MES. Format: TY <filename> -k <options> The file may be deleted using the delete command. 4.44 VER 4.44.1 VER _________________________________________ DISPLAY SOFTWARE VERSIONS Purpose: Lists software versions Format: VEr Software version for CPU, DSP, AVR, CPU (OMAP) and AVR bootloader and GPS are shown
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 142 Weeksched 4.45 WEEKSCHED 4.45.1 WEEKSCHED _________________________________ SETTING UP A WEEK SCHEDULE Purpose: Setting up a week schedule. Format: WeekSched <options> A week schedule can be set up to control interval programs in order to suppress reports that, e.g., fall outside office working hours. The week schedule contains up to 21 time intervals where programs are allowed to send reports. The week schedule only has effect on the interval programs where this function is enabled. Please see paragraph PG -e for information on how to activate the week schedule control. 4.45.2 WEEKSCHED -C ____________________________________ CLEAR WEEK SCHEDULE Purpose: Delete one (or all) of the week schedule entries. Format: WS -c all WS -c <EntryNo> EntryNo: The schedule entry to delete [0..20]. This command can delete either all or one specific week schedule entry. Use the ‘WEEKSCHED -d’ command to obtain a list of the current schedule entries. 4.45.3 WEEKSCHED -D __________________________________ DISPLAY WEEK SCHEDULE Purpose: Display the current set of week schedule entries. Format: WS -d Example: This schedule is set up to enable interval reports Monday-Thursday 8.00 AM to 4:00 PM and Friday 8:00 AM to 3:00 PM. : weeksched -d<CR><LF> <CR><LF> No Start day/hour Stop day/hour<CR><LF> 0 1 (Mon) 8 1 (Mon) 16<CR><LF> 1 2 (Tue) 8 2 (Tue) 16<CR><LF> 2 3 (Wed) 8 3 (Wed) 16<CR><LF> 3 4 (Thu) 8 4 (Thu) 16<CR><LF> 4 5 (Fri) 8 5 (Fri) 15<CR><LF> <CR><LF> 5 schedule entries used<CR><LF> :
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 143 Weeksched 4.45.4 WEEKSCHED -O ______________________________ CREATE WEEK SCHEDULE ENTRY Purpose: Create a week schedule entry. Format: WS -o <StartDay>,<StartHour>,<StopDay>,<StopHour> StartDay: Start day for entry [1..7]. 1 = Monday … 7 = Sunday StartHour: Start hour for entry [0..24]. 0 = midnight at the beginning of the day … 24 = midnight at the end of the day. StopDay: Stop day for entry [1..7]. 1 = Monday … 7 = Sunday StopHour: Stop hour for entry [0..24]. 0 = midnight at the beginning of the day … 24 = midnight at the end of the day. Creates a new entry in the week schedule. The schedule can contain up to 21 entries (internally numbered from 0 to 20). Stop day/hour must be later than the start day/hour. Example: Create a schedule entry covering Friday 8:00 AM to 3:00 PM. : weeksched -o 5,8,5,15<CR><LF> <CR><LF> :
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 144 Zone 4.46 ZONE The zones can be used to reduce or increase the number of transmitted position reports depending on, where the vessel/vehicle is.. Surveillance zones are geographical areas that can be set up on the MES by the system administrator. Some of the features of the MES can then be set to behave differently depending on which zone it is in. Interval programs can be set to report at special intervals when the MES is inside specific zones. This may be used to increase the frequency of reports when the MES is near important places, or to reduce the frequency when the position of the MES is of less interest, e.g. a ship in port. Event programs can be set up to send data reports whenever the MES enters or leaves a zone. The current zone status, i.e. the zone that the MES is currently inside, can be read by external equipment through the terminal interface, thereby enabling this equipment to take advantage of the advanced geographical positioning features. In order to have the reporting interval change inside zones, this feature must be enabled for the interval program (see PG -e and an interval must be set up for each of the zones (see the commands ZO -i and ZO -ig. In order to have event data reports sent when entering and leaving zones, an event program must be set up for zone. The command ZO -s can be used to get the current zone status. The MES automatically checks the current position against the active zones at regular intervals. Zones are checked every 10 seconds. Zones are checked every 10 seconds. There are 9 types of zones with different shapes: Zone type Shape Limits 1 Circle Min radius 100 m Max radius 6553500 m (6553.5 km) 2 Polygon with 3 positions Max angle between sides = 180 3 Polygon with 4 positions Max angle between sides = 180 4 Polygon with 5 positions Max angle between sides = 180 5 Polygon with 6 positions Max angle between sides = 180 6 Polygon with 7 positions Max angle between sides = 180 7 Polygon with 8 positions Max angle between sides = 180 8 Polyline with up to 40 positions Min with 100 m
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 145 Zone Max width 25500 m 9 Polygon with up to 40 positions None Table 4.22 Zone types Figure 4.6 Zone example Examples of zones: Zone 1 is a valid type 3 zone. Zone 2 is a invalid type 5 because of the angle above 180°. If an invalid shape or invalid data is programmed the entire zone is ignored. When zones overlap the zone with the highest priority (lowest number) will determine the reporting interval. After the MES has entered or left a zone, and this has been detected, the next zone check can be configured (zo -w). By default the configuration is set to 2 minutes. This delay prevents an excessive amount of zone events that might otherwise occur if the MES is moving along or near a zone border. Allowing enter/exit events can be configured for an individual zone (zo –e) or an individual group of zones Basic Zones Feature Zones may be set up in 2 different ways. The Basic feature is simpler and will suit a lot of purposes, while the advanced feature provides more flexibility but is also more complex to manage. It is possible to combine the basic and advanced features, but it is advisable to stick to one method only to avoid confusion. In the basic feature, all zones are stored in a single file and all the existing zones are always active at all times. Advanced Zone Feature The advanced feature allows zones to be grouped in a number of separate files, Zone Groups. The zone groups can be activated separately. Only the active zone group will be checked against the current position. If it is necessary to have more than one zone group checked, a Zone Group List may be created. A zone group list does not contain
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 146 Zone any zones itself, it just refers to existing zone groups. A zone group list may also refer to a single zone within a zone group. A number of zone group lists may be created. Because the lists only contain references, it is possible for multiple lists to refer to the same group or the same zone. A list may also contain references to single zones within groups. Multiple Zone Group Lists may refer to the same Zone Group Zone Group List 1 Zone Group List 2 Zone Group List 3 Zone Group 1 Zone Group 2 Zone Group 3 Zone Group 4 Zone Group 5 Any Zone Group List may be selected as the active one. Only zones that are in the active zone list will cause events. Zone 1 (polyline) Zone 2 (polyline) Zone 3 (circle) Zone 1 (polygon) Zone 2 (polyline) Zone 3 (circle) Zone 4 (polyline) Zone 1 (polyline) Zone 2 (polyline) Zone 1 (polyline) Zone 1 (polyline) Zone 2 (polyline) Zone 3 (circle) A zone group list is a list of zone groups. A zone group list file contains no zones, only references to zone groups. A zone group is a collection of zones. Each zone may be either a polygon, a polyline, or a circle. All the zones in a zone group is stored in one file on the transceiver. A Zone is part of one, and only one Zone Group. contains refers to refers to refers to refers to refers to refers to contains refers to contains contains contains contains contains contains contains contains contains contains contains refers to Figure 4.7 Advanced Zone features The commands ZO -ag and ZO -al are used to active a zone group or a zone group list. The command ZOzo -g is used to add a zone or zone group to a zone group list. Configuring the Advanced Feature When it is desired to use the same zone configuration on many MESs, this can be done by setting up the zones on one MES and then copying the zone files to the others. The zone group files are named _ZONEnnn.DAT, where nnn is the number of the zone group. Temporary files are sometimes created and they are named _ZONEnnn.tmp. Zone group list files are named _ZLSTnnn.DAT, where nnn is the number of the zone group list. A quick way to delete zone groups and zone group lists is to delete the files. Sysadm authority is required to access the files.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 147 Zone NOTE: Whenever files have been added, modified or deleted, the MES should be rebooted to update it with the changes. The Default Zone Group Default Zone Group is the zone group used by the basic features. It may be used like other zone groups (it is identified by zone group number 0), but in order to avoid confusion, it is recommended that the default zone group is not used when using the advanced features. The Default zone group file is named zonefile.dat and is has a corresponding temporary file named zonef~_1.tmp. Advantages of the Advanced Feature There are several situations where it may be convenient (or even necessary) to use the advanced zones feature. If a very long or complex zone is needed, this can be created by using several zones grouped together in one zone group. For example, a polyline zone with more than 40 points can be created using several polylines in one group. If the zones needed are not always the same it may still be convenient to keep them stored in the MES, but inactive. Example of Use The first table describes the configuration that needs to be done only once. This configuration may be copied to other MESs using normal file copying. Description Shell commands A polyline following the road from São Paulo to Rio de Janeiro is created in Zone Group 1. The polyline is split into polyline zones of max. 40 points each. For example, a route requiring 60 points would have to be split into one zone of 40 points and one with 20. Create a new polyline zone: zo -ng 1,1,8,40 Enter positions 1-40 by repeating this for each point: zo -pg 1,1,<posno>,<position> Create a new polyline zone for positions 41-60: zo -ng 1,2,8,20 Enter positions 41-60 by repeating this for each point: zo -pg 1,2,<posno>,<position> Set width of polyline to 300 meter: zo -og 1,1,3 zo -og 1,2,3
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 148 Zone A polyline zone following the road from São Paulo to Curitiba is created in Zone Group 2. Please see above A polyline zone following the road from Curitiba to Porto Alegre is created in Zone Group 3 Please see above A polygon zone around the area in Rio de Janeiro (in which the truck is allowed to drive) is added to Zone Group 1. Create a new polygon zone with 4 points: zo -ng 1,3,3 zo -pg 1,2,1,<position1> zo -pg 1,2,2,<position2> zo -pg 1,2,3,<position3> zo -pg 1,2,4,<position4> Sometimes the truck needs to go from Rio de Janeiro to São Paolo and then to Curitiba. Therefore a Zone Group List referring to Zone Group 1, and Zone Group 2 is created. The list is called Zone Group List 1. zo -g 1,1 zo -g 1,2 Sometimes the truck needs to go from Porto Alegre to Curitiba and then to São Paolo. Therefore a Zone Group List referring to Zone Group 3, and Zone Group 2 is created. The list is called Zone Group List 2. zo -g 2,3 zo -g 2,2 Sometimes the truck needs to go all the cities in Zone Group 1, 2, and 3. Therefore a Zone Group List referring to Zone Group 1, Zone Group 2,and Zone Group 3 is created. The list is called Zone Group List 3. zo -g 3,1 zo -g 3,2 zo -g 3,3 Table 4.23 Example of use The second table describes the actions that will be taken during operation. Description Shell commands Depending on where the truck is going, either one of the Zone Groups and Zone Group Lists above may be selected as the Active Zones. The inactive zones are still stored in the MES, but they don't cause events or interval changes. To deactivate the zones, the default zone group may be set to active. Note that if any zones exist in the default zone group, those will then be active. Set zone list 1 active: zo -al 1 or set zone list 3 active: zo -al 3 or set zone group 3 active: zo -ag 3
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 149 Zone Set the default zone group active (deactivate others): zo -ag 0 Table 4.24 Example of use
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 150 Zone 4.46.1 ZONE ________________________________________ SET-UP SURVEILLANCE ZONES Purpose: Set-up surveillance zones. Format: ZOne <options> BASIC ZONES FEATURE, SUMMARY OF COMMANDS ZONE -d Displays the zone configuration ZONE -i Change the reporting interval ZONE -n Create a new zone ZONE -o Add radius or width ZONE -p Add a position to a zone ZONE -r Remove a zone ZONE -t Test a position ZONE -s Get the current zone number ZONE –u Check all zones now ADVANCED ZONES FEATURE, SUMMARY OF COMMANDS ZONE -dg Display Zone Group Configuration ZONE -ig Setup interval for zone in group ZONE –ng Add Zone to Group ZONE -og Setup radius of zone in group ZONE -pg Setup positions in group ZONE -rg Remove zone in group ZONE –dl Display Zone Group List Configuration ZONE –e Set enter/exit event flag ZONE -rl Remove Zone Group List ZONE –g Add a Group to Zone Group List ZONE -a Display active zones ZONE -ag Set active zone group ZONE -al Set active zone group list ZONE –tg Test if position is in a zone group ZONE –w Wait searching when near zone border ZONE –e Set enter/exit event flag ZONE –eg Set enter/exit event flag in group GENERAL COMMENTS The zone has to be created using zone -n or zone -ng before the interval and positions can be entered. <zone no.> = "0" - "249" <zone group no.> = "1" - "255" <zone group list no.> = "1" - "255"