TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 51 CFG 4.3 CFG 4.3.1 CFG -C _______________________________ CONFIGURE COVERT/SECURITY ALERT Purpose: Configures the covert/security alert type. Format: CFG -c <alert type> alert type: The alert type to be used. 0 = SSA messages 3 = SSA messages instant activation. Please note that this command is only accessible for users with authority level sysadm allowed for TT-3027C/SSA. Please see section 4.38 for more information about user level authority. 4.4 CLEAR 4.4.1 CLEAR ______________________________________ ABORT CURRENT OPERATION Purpose: Forces the MES to stop any protocol . Format: CLear <option> This command terminates the current MES link operation and deletes any message file associated with it. The command will result in a forced clear transmission to the LES in the following cases: Transmission protocol Aborting a pending call. While waiting for an assignment from the LES. During message packet transmission. While waiting for a clear packet from the LES. Receive protocol After having sent assignment/announcement response. While waiting for the message to arrive. While waiting for the clear packet. Link Test The same cases as in the two message protocols. After receiving the shore-to-ship call and it is being prepared for transmission. During a pending ship-to-shore call. While waiting for a distress test request. Just before sending the distress test. While waiting for the final Link Test clear packet. The user will always be able to abort the current protocol when sending an alert, but this will not result in a forced clear transmission from the MES.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 52 Confirm 4.5 CONFIRM 4.5.1 CONFIRM _______________________________________ CONFIRMATION REQUEST Purpose: Requesting a delivery confirmation from a Land Earth Station. Format: COnfirm <message reference number> <LES_id> The LES assigns a unique message reference number to each of the messages passing through the system. The number can then be used by the MES to request for the status of that message. The confirm command can be used to request for confirmation on a message that has the status acknowledged in the transmit log. This status is given a message that has been accepted by the Land Earth Station, but was not supposed to be confirmed. With the st -t command the status of the message and the message reference number can be seen, if the message has been acknowledged by the Land Earth Station. The message reference number is also given in the INFO 81 message (see section 5.2 ). When the confirmation (positive or negative) arrives from the LES via the NCS, the MES will generate a a status report INFO, and the status in the transmit log will be updated to deliver or failed. Example If transmit log contains a message with reference number 2345 sent to LES number 131, and the message status is acknowledged, confirmation on that message can be requested by typing: co 2345 131 4.6 DATA 4.6.1 DATA ____________________________________________ MANUAL DATA REPORT Purpose: Sending a sequence of signalling channel bursts, transferring a small amount of data to a LES or append user data to an active interval program. Please see the PG command. Format: Send data report immediately: DAta [-o [-z <mem,attr>] [-l]] [-m <mem>] [-b <byte cnt>] [-s [<mem>]] <LES>,<DNID>,<mem> [<data>] Append user data to an active program: DAta [-p] [-o] [-b <byte_cnt>] <LES>,<DNID>,<mem> [<data>] Send poll form base station immediately: DAta [-b <byte cnt>] -c <ack>,<cmd>,<sub>,<rsp> -r (i,<mobile no> | g | a1,<navarea> | a3,<n/s>,<lat>,<long>,<e/w>,<lat ext>,<long ext> |
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 53 Data a4,<n/s>,<lat>,<long>,<e/w>,<radius>) <LES>,<DNID>,<mem> [<data>] -b : Number of bytes in <data> field -c : Sending poll to mobile(s) from base station -l : Force category to land mobile -m : Set destination member number for mobile to mobile reporting -o : Insert position in data report -p : Append data to buffer -r : Configure poll addressing -s : Store report if antenna blocked -z : Set MEM and attribute field A data report command will at most send 32 bytes of user data. If the -p option is used to store data in the data report buffer and if the operation is successful, the following string will be displayed before the command line prompt: <CR><LF><STX><count><ETX> bytes stored where <count> is the number of bytes that is now stored in the buffer. The first argument to the -z option will set the MEM code. The additional arguments will set the value of the 2-byte attribute field in the position report. If the MEM code is in range 11-15 and 4 additional arguments (separated by commas) is supplied then the 4 additional arguments are encoded as Time Of Position in the 2-byte attribute field: Argument 2 month (1 bit) 0 is this month 1 is next month Argument 3 day (5 bits) Day of the month Argument 4 hour (5 bits) Hour of the day Argument 5 minute (5 bits) in units of 2 minutes If the MEM code is 25 the additional arguments are emergency related parameters for the attribute field: Argument 2 TOP (3 bits) Time Of Position Argument 3 SP (2 bits) Speed Argument 4 DOT (3 bits) Day Of Travel Argument 5 Nature of Emergency (Please see Note) Note: Consult the Inmarsat SDM, Volume 2, Part 2, Page AN2-27 for full description of the decoding of the emergency fields. Other MEM codes: The second argument will become the attribute.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 54 Data Data reports can only be sent on signalling channels having 'Closed User Group' access, and if this is not the case for a particular LES (all channels will be searched by the MES), the error message 'No Closed User Group service available' will appear. 4.6.2 DATA -B __________________________________________________ BYTE COUNT Purpose: Byte count Format: DA -b <number> <options> <LES>,<DNID>,<mem><CR><binary data> number: Value 0-32. Used if data is to be added to the report. The request is rejected if the total number of bytes exceeds 32. 4.6.3 DATA -O __________________ INSERT POSITION AT THE START OF THE DATA REPORT Purpose: Insert the position at the start of the data report. Format: DA -o <options> <LES>,<DNID>,<mem>[<CR><binary data>] If the -o option is specified alone a position data report will be sent to the specified DNID. Additional data may be added after the position using the -b option. The position format is as specified by Inmarsat for either Land Mobile or Maritime MESs. 4.6.4 DATA -P _________________________ APPEND DATA TO THE DATA REPORT BUFFER Purpose: Append data to the data report buffer. Format: DA -p <options> <LES>,<DNID>,<mem><CR><binary data> The option only has effect with a DNID programmed for PU. If the -p option is specified data will be appended to the data already in the data report buffer. The data will be sent to the DNID when the next programmed report takes place. The data report buffer will be flushed before the MES requests new data with the INFO 653 message. Data can only be added if the DNID parameters match those stored in the buffer. If the data in the buffer was specified for another LES ID, DNID, Member number pair, the buffer will be flushed before the new data is added. If the -p option is not used data will be sent the default way: unreserved access as soon as possible.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 55 Date 4.7 DATE 4.7.1 DATE ________________________________________________ SET DATA AND TIME Purpose: Set date and time. Format: DATE <options> -l : Show local date and time -g : Show GMT time -s : Set UTC time -u : Show UTC time YY[YY]-MM-DD TT:MM Set UTC time Set timezone with cmd "SEt -z TZ=tzn[+ | -]hh[:mm]" GMT and UTC time is set to GPS time. As long as the GPS provide the time input, the command date –s has no effect. 4.8 DELETE 4.8.1 DELETE _________________________________________________ DELETE FILE(S) Purpose: Deletes or removes a file from the file system. Format: DElete <filename> RM <filename> Filename: Maximally 12 characters Remarks: The reserved files _EGCLOG, _RXLOG and _TXLOG cannot be deleted. The wildcards "*" and "?" can be used to specify a group of files.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 56 DIAG 4.9 DIAG 4.9.1 DIAG ____________________________________________________ DIAGNOSTICS Purpose: Enable/disable diagnostics trace and displays diagnostics information. Format: DIAG DSP | DIAG TC | DIAG ACCESS 4.9.2 DIAG DSP INFO ________________________ ENABLE OR DISABLE DSP DIAGNSOTICS Purpose: Enable or disable DSP diagnsotics. Format: DIAG DSP INFO <ON>|<OFF> 4.9.3 DIAG DSP LD _______________________________7REQUEST LOCK DETECT STATUS Purpose: Request Lock detect status of 1 lo. Format: DIAG DSP LD 4.9.4 DIAG DSP ADC _______________________________________ ADC SAMPLE DATA Purpose: Binary dump of data sampled during app. 100ms, while receiving the TDM channel, transferred to DTE using the TFTP protocol. Format: DIAG DSP ADC 4.9.5 DIAG DSP RD ________________________________________READ DSP MEMORY Purpose: Read the DSP data or program memory. Format: DIAG DSP RD <src-addr> <cnt> <DM|PM> [-c] src_adr: Start address of memory to read from. cnt: Number of words to read. DM: Read datamemory. PM: Read program memory. -c: Continuos read of data. cnt must be less than 10. 4.9.6 DIAG TC ___________________________ ENABLE OR DISABLE DIAGNOSTICS TRACE Purpose: Enable or disable diagnostics trace from processes. Either the process name or bit mask can be used. Bit masks can be combined by addition. Process names and their bitmask Name Bitmask Name Bitmask Name Bitmask Idle 00000001h maintain 00000002h powerctrl 00000004h gps 00000008h EgcHdl 00000010h MsgHdl 00000020h PollHdl 00000040h DataRepHdl 00000080h IOctrl 00000100h shell 00000200h DspIn 00000400h DspOut 00000800h TPLayer 00001000h RegMgr 00002000h Dlink 00004000h ChannelAccess 00008000h PacketFilter 00010000h SignalCtrl 00020000h shellpost 00040000h AlertHdl 00080000h timer 00100000h DataLogHdl 00200000h PacketCmdHdl 00400000h SLink 00800000h SOutput 00000000h main 40000000h
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 57 DIAG 4.9.7 DIAG TC CLR_________________________________ DISABLE DIAGNOSTICS TRACE Purpose: Disable diagnostics trace from one process. Format: DIAG TC CLR <name> name: Process name, as listed in 4.9.6 4.9.8 DIAG TC CLRALL _____________________________ DISABLE DIAGNOSTICS TRACE Purpose: Disable diagnostics trace from all processes. Format: DIAG TC CLRALL 4.9.9 DIAG TC SET __________________________________ENABLE DIAGNOSTICS TRACE Purpose: Enable diagnostics trace from one process. Format: DIAG TC SET <name> name: Process name, as listed in 4.9.6 4.9.10 DIAG TC SETMASK_____________________________ENABLE DIAGNOSTICS TRACE Purpose: Enable diagnostics trace from one or more processes. Format: DIAG TC SETMASK <mask> mask: Process bit mask or combination, as listed in 4.9.6 4.9.11 DIAG TC TEST ______________________________________ TEST TRACE LOGGING Purpose: Testing Trace, Event and Error logging. Format: DIAG TC TEST 4.9.12 DIAG TC LIST _________________________________ LIST PROCESSES WITH TRACE Purpose: Displays processes with trace enabled. Format: DIAG TC LIST 4.9.13 DIAG ACCESS ________________________________ ACCESS LAYER DIAGNOSTICS Purpose: Displays diagnostics information from the access layer processes. Format: DIAG ACCESS 4.9.14 DIAG ACCESS -C________________________________________CHANNEL STATUS Purpose: Displays channel status. Format: DIAG ACCESS -c 4.9.15 DIAG ACCESS -I ______________________________________________ LIST INFO Purpose: Displays access layer local variables values. Format: DIAG ACCESS -i <a|p|s> a: Display ChannelAccess variables. p: Display PacketFilter variables. s: Display SignalCtrl variables. 4.9.16 DIAG ACCESS -P______________________________________ SHOW PACKET LOG
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 58 DN Purpose: Displays the log of the packets received with or without errors. Format: DIAG ACCESS -p 4.9.17 DIAG ACCESS -T ___________________________ SHOW THE LAST FRAME RECEIVED Purpose: Displays the last frame received in hexadecimal. Format: DIAG ACCESS -t 4.10 DN 4.10.1 DN _______________________________________________ DATA NETWORK SETUP Purpose: Configure the DNIDs. Format: DN -a DN -c <entry>[ - <entry>] DN -d [<entry>] DN -e <entry>,<groupid> DN -f <auth>,<cat>,<date>,<iopin>,<speed>,<1pack>,<ustr>,<prec>,<tacho>, <auint>,<auevt> DN -fa [<dautgrp>] DN -fg [<obdr>] DN -g <entry>,[<obdr>] DN -l [<memindex>,<memcode>] DN -m <entry>[,<memindex>,<memcode>] DN -o <LES>,<DNID>,<mem>,<sub>,<predef>,<provider> DN -p <entry>,<auth>,<cat>,<date>,<iopin>,<speed>,<1pack>,<ustr>,<prec>, <tacho> DN -s <entry>,<'D'|'E'> DN -t <entry>,[<tmemcode>,<string>] DN -n <number of active DNIDs (0..64)> DNIDs are used for receiving poll and sending data reports. Up to 64 DNIDs can be stored. The DN command manages the DNIDs and configures the format of the data reports. Please see appendix A
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 59 DN 4.10.2 DN -A _______________________________________DISPLAY DNID AUTO-GROUPING Purpose: Display auto-grouping settings for DNIDs. Format: DN –a Two DNIDs with the same DNID number and LES number in different oceans can be auto-grouped. This command can be used to display whether auto-grouping is enabled/disabled for the DNIDs in the MES. The section about the default autogrouping command DN -fa describes the use of auto-grouping. Example: Auto-grouping enabled for entry 0 and disabled for entry 1 and 2: : dn -a Entry dautgrp 0 : 0 1 : 1 2 : 1 : Please note that the command doesn’t take command options “DN -a [<entry>,<obdr>]” as otherwise indicated indicated in DN command. 4.10.3 DN -C ____________________________________________________ DELETE DNIDS Purpose: Delete DNID. Format: DN -c <entry>[-<entry2>] Delete all DNID entries between entry and entry2. 4.10.4 DN -D ______________________________________________ DISPLAY DNID STATUS Purpose: Display DNIDs Format: DN -d DN -d <entry> Displays the list of DNIDs and associated format specification. 4.10.5 DN -E _______________________________________________ CHANGE DNID GROUP Purpose: Display and change DNID groups Format: DN -e Displays the list of DNIDs in each group . DN -e <entry>[,<group no>] entry: DNID entry no. group no: DNID group number [0-64]. Default value is 0. Assigns the DNID at entry to the DNID group with number group no. Group no 0 means “not in a group”.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 60 DN Example DN -e 2, 4 Assigns the DNID at entry 2 to group 4. DN -e 2 Moves the DNID at entry 2 out of its group. The purpose of this feature is to create a global or partly global DNID that can be remotely configured and to which the MES can send data reports, regardless of which ocean region the MES is logged in to. Each DNID can be assigned to a group. Each group consists of up to 4 DNID, one in each ocean region. When the configuration for one DNID is changed it affects all the DNID's in the group. Similar, when one DNID is set-up for interval reporting or event reporting, all the DNID's in the group will be in the reporting program. Each group may be assigned a group id between 1 and 64. Group id 0 is reserved for DNID's not in any group, and 65 to 255 are reserved for special applications. The DNID's can only be assigned to a group with the terminal command DN -e. If a DNID is added to a group, and an interval- or event program already is assigned to members of the group, this will be applied to the new DNID also. A DNID entering a group always has its interval- and event programs removed. Only empty ocean regions for a group can be assigned new DNID´s. The DNID group members will inherit the attributes (general DNID properties as sub address, provider name and authority level, memcodes, ect) of the DNID already in group (if any). Deleting DNID can be done via the terminal interface or via poll - and has different consequences according to the method. Using the terminal interface the DNID is removed from group and does do appear in any programs afterwards. If the group is not empty it remains populated with the remaining DNID´s. Deleting DNID via poll using sub address 2 has the same effect. By using sub address 0 or 1 the group is removed and all members deleted (a long with all associated programs). Below are two examples of how the grouping works (summary of the rules explained above): Global (default) group: Dnid 2 Ocean: AORE Memcode setup: C Authority: C Dnid setup: C Event program Interval Interval program Event program program Dnid 3 Ocean: IOR Memcode setup: D Authority: D Dnid setup: D Dnid 4 Ocean: AORW Memcode setup: E Authority: E Dnid setup: E Dnid 1 Ocean: POR Memcode setup: B Authority: B Dnid setup: B Dnid 0 Ocean: AORE Memcode setup: A Authority: A Dnid setup: A Figure 4.1 Precondition for group examples shown below
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 61 DN Case 1: Dnid 2 added to 34 (dn -e 2,34) Create an event program based on group 34 member. (ev -o les/DNIDDNID 2 ) Dnid 4 added to group 34 (dn -e 4,34) Programs (i.e. event- and interval program) associated to DNID 2 are deleted before DNID enters group. Creation of the event program includes all DNID´s in group (DNID 2 only). Adding DNID 4 to group results initially in the deletion of the DNID 4 based programs. Afterwards DNID 4 gets all properties from DNID 2 because it already belongs to the group. Group 34 (result): Dnid 2 Ocean: AORE Memcode setup: C Authority: C Dnid setup: C Event program for group 34 Dnid 4 Ocean: AORW Memcode setup: C Authority: C Dnid setup: C Figure 4.2 Case 1. Add DNID´s to group Case 2: Add DNID 0 and DNID 1 to group 15 (dn -e 0,15 + dn -e 1,15). Add DNID 2 and DNID 3 to group 10 (dn -e 2,10 + dn -e 3,10). Create an interval program based on a group 15 member. (ev -o les/dnidDNID0/1) Create an event program based on a group 10 member. (ev -o les/dnidDNID2/3) Move DNID 2 from group 10 to group 15 (dn -e 2,15). Move DNID 3 from group 10 to group 15 (dn -e 3,15). Programs (i.e. event- and interval program) associated to DNID 0 and DNID 1 are deleted before DNID enters group. All DNID´s entering thsi group will inherit the properties of DNID 0.Creation of the interval program includes all DNID´s in group (DNID 0 and 1). Likewise, programs (i.e. event- and interval program) associated to DNID 2 and DNID 3 are deleted before DNID enters group. Creation of the event program includes all DNID´s in group (DNID 2 and 3). Changing group for DNID 2 fails because the ocean regions is already occupied in group 15. Changing group for DNID 3 succeeds because the ocean regions is not occupied in group 15. Group 15 (result): Interval program for group 15 Group 10 (result): Dnid 2 Ocean: AORE Memcode setup: C Authority: C Dnid setup: C Event program for group 10 Dnid 1 Ocean: POR Memcode setup: A Authority: A Dnid setup: A Dnid 0 Ocean: AORE Memcode setup: A Authority: A Dnid setup: A Dnid 3 Ocean: IOR Memcode setup: A Authority: A Dnid setup: A Figure 4.3 Case 2. Add DNID's to group (advanced)
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 62 DN Case 3: Add DNID 0, DNID 1, DNID 3 and DNID 4 to group 40 (dn -e 0,40 + dn -e 1,40 + dn -e 3,40 + dn -e 4,40). Delete DNID 0 via poll with sub address 2. Delete DNID 1 via terminal interface. Delete DNID 2 via poll with sub address 0. Initially the group is created an populated. The first delete DNID poll deletes and removes DNID 0 from group. Group remains with other members. The second delete DNID poll deletes and removes DNID 1 from group. Group remains with other members. The third delete DNID poll deletes the rest of group. Group 40 (result): Empty Figure 4.4 Case3.Delete DNID's Auto grouping New DNIDs with the same DNID number and LES number in different ocean regions are grouped together automatically when downloaded. Auto grouping can be enabled/disabled using the command DN –f. DNIDs are only auto-grouped if autogrouping is enabled when both DNIDs are created. The group is created when the second DNID is downloaded using the first available group number. When a third or fourth DNID is downloaded it is added to the group 4.10.6 DN -F __________________________________________ SET DEFAULT DNID FORMAT Purpose: Sets the default format specification for DNIDs. New DNIDs adapt this default format when downloaded. Format: DN -f <auth>,<cat>,<date>,<iopin>,<speed>, <1pack>,<ustr>,<reso>,<tacho>,<auint>,<auevt> auth: Authority level: 0-2, 0:normal user, 1:super user, 2: sysadm. cat: Format of data reports using this DNID. 0 = land mobile position report 1 = Maritime position report 2 = T&T data report format. Appendix A.2 date: Add additional time and date information to data reports using this DNID. 0 =no time and date information included. 1 = time and date information, type 1, included. 2 = time and date information, type 2, included. 3 = time and date information, type 3, included. iopin: Include I/O-pin status in all data reports using this DNID. 0 = no I/O-pin status included. 1 = I/O-pin status included. speed: Add additional speed and course information to data reports using this DNID 0 = no speed and course info included. 1 = speed and course info included. 1pack: Force MES to send only single packet reports. To enable this feature make sure that no options that use the second packet are enabled.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 63 DN 0 = one packet disabled. 1 = one packet enabled. ustr: User defined string up to 32 characters in length. 0 = Attaching user string disabled. 1 = Attaching user string enabled. reso: Extra position precision. 0 = no extra precision included. 1 = extra precision included: 0,005 fraction of a minute. 2 = extra precision included: 0,001 fraction of a minute. [ tacho: Add tachograph data to data reports (NA) 0 = no tachograph data is included. 1 = tachograph data is included. auint: Automatic create interval programs for downloaded DNIDs. 0 = no intervalprogram is created automatically. 1 = intervalprogram is created automatically for new DNID. 2 = intervalprogram is created if 25th character in providername is “A”. 3 = intervalprogram is created as option 1, but is not auto started. auevt: Automatic create interval programs for downloaded DNIDs. 0 = no eventprogram is created automatically. 1 = eventprogram is created automatically for new DNID 2 = eventprogram is created if 25th character in providername is “A”.. 4.10.7 DN -FA (NA) _______________________________________ DEFAULT AUTO-GRUOPING Purpose: Set whether DNIDs are auto-grouped on creation. Format: DN -fa [<dautgrp>] dautgrp: Enable/disable auto-grouping. 0 = Enable auto-grouping. 1 = Disable auto-grouping. Two DNIDs with the same DNID number and LES number in different oceans can be auto-grouped. This command is used to set whether auto-grouping is enabled/disabled for the DNIDs when they are created (downloaded or predefined, see create DNID command DN -o). DNIDs are only auto-grouped if auto-grouping is enabled when both DNIDs are created. The group is created when the second DNID is created using the smallest available group number. When a third or fourth DNID is created it is added to the group. Example: : dn -fa 0 : dn -fa Auto group disabled : 0 : dn -o 4,8048,3,1,1,T&T : dn -a Entry dautgrp 0 : 0 : dn -fa 1 : dn -fa Auto group disabled : 1 : dn -o 104,8048,3,1,1,T&T : dn -a
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 64 DN Entry dautgrp 0 : 0 1 : 1 : dn -e Group AOR-W AOR-E POR IOR : dn -fa 0 : dn -fa Auto group disabled : 0 : dn -o 204,8048,3,1,1,T&T : dn -a Entry dautgrp 0 : 0 1 : 1 2 : 0 : dn -e Group AOR-W AOR-E POR IOR 1: 004,08048,003 204,08048,003 : dn -o 304,8048,20,1,1,T&T : dn -e Group AOR-W AOR-E POR IOR 1: 004,08048,003 204,08048,003 304,08048,020 : Description of examble step by step: 1. Auto grouping enabled 2. DNID 8048 LES 4 created. 3. Auto grouping disabled 4. DNID 8048 LES 104 created. No grouping (Auto grouping is disabled). 5. Auto grouping enabled 6. DNID 8048 LES 204 created. DNID 8048 LES 4 and 204 is auto grouped (DNID 8048 LES 104 is not grouped auto grouping was disabled when the DNID was created). 7. DNID 8048 LES 304 created. DNID 8048 LES 304 added to the group with the same DNID on LES 4 and 204. 4.10.8 DN -FG ______________________________________ DEFAULT REPORTING PROTOCOL Purpose: Set the default data reporting protocol. Format: DN -fg [<obdr >] obdr: Data reporting protocol 0 = Enhanced data reporting protocol, if protocol supported by LES else the basic report protocol will be used. 1 = Force basic data reporting protocol. 2 = Force message data reporting. Data reports are sent as messages.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 65 DN Message data reports contain 4 extra bytes of data, see A.3 Message data report format. It is recommended to use the enhanced data reporting protocol. Example: : dn -fg Reporting Protocol: 0 : dn -fg 1 : dn -fg Reporting Protocol: 1 : 4.10.9 DN -G ______________________________________________ REPORTING PROTOCOL Purpose: Set the reporting protocol for a DNID. Format: DN -g <entry>,[<obdr>] obdr: Data reporting protocol 0 = Enhanced data reporting protocol, if protocol supported by LES else the basic report protocol will be used. 1 = Force basic data reporting protocol. 2 = Force message data reporting. Data reports are sent as messages. Message data reports contain 4 extra bytes of data, see A.3 Message data report format. It is recommended to use the enhanced data reporting protocol. Example: : dn -g 0 Reporting Protocol: 1 : dn -g 0,0 : dn -g 0 Reporting Protocol: 0 : 4.10.10 DN -L ____________________________ DISPLAY/CHANGE USER DEFAULT MEM CODES Purpose: Handles the user default MEM codes. Format: DN -l List user default MEM-codes with <mem-id>. DN -l <index>,<mcode> Change a single default MEM-code. DN -l ttdefault Load T&T defaults. DN -l delete Delete all user defaults MEM-codes. <index> : Reference number to MEM codes listed in DN -l command ttdefault: Load T&T default MEM-codes. delete: Command to delete all user default codes.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 66 DN <mcode> [0 .. 127 ] When sending a Data Report initiated by an event, the report always contains a MEM code identifying the event. T&T has defined default values for these MEM codes, as described in paragraph 4.5 Event Reports. There is no restriction on what value that is assigned to a MEM code, but please note that Inmarsat has predefined some codes in the range 1..63 4.10.11 DN -M ___________________________ DISPLAY/CHANGE MEM CODES TO DNID-ENTRY Purpose: Assign MEM- codes to an existing DNID entry. Format: DN -m <entry> List MEM-codes for <entry>. DN -m <entry>,default Load all user defaults. DN -m <entry>,ttdefault Load all T&T defaults. DN -m <entry>,<index> Load a single user default MEM-code. DN -m <entry>,<index>,< mcode> Change a single MEM-code. mcode: [0 .. 127 ] entry: Reference number to DNID-entries listed with DN -d. default: Load user default MEM-codes. Please see DN –l for more in information. ttdefault: Load T&T default MEM-codes. index: Reference number to MEM-codes seen in the liste-command Please see DN -l and DN -m <entry>. Example: : dn -m 0,ttdefault<CR><LF> <CR><LF> : dn -m 0<CR><LF> <CR><LF> User defined MEM-codes for DNID-entry <0>:<CR><LF> <CR><LF> Index Name Mem-code<CR><LF> 0 Time of Position 11<CR><LF> 1 Power Up 64<CR><LF> 2 Power Down 66<CR><LF> 3 Antenna Blocked 69<CR><LF> 4 Stored Position 70<CR><LF> 5 Io Report 71<CR><LF> 6 Enter Zone 72<CR><LF> 7 Leave Zone 73<CR><LF> 8 Enter Sleepmode 80<CR><LF> 9 In Sleepmode 81<CR><LF> 10 Leave Sleepmode 82<CR><LF> 11 Fix Time Begin 83<CR><LF> 12 Enter Reduced 85<CR><LF> 13 In Reduced 86<CR><LF> 14 Leave Reduced 87<CR><LF> 15 Manual Position 88<CR><LF> 16 Above Speed Limit 89<CR><LF> 17 Below Speed Limit 90<CR><LF> 18 GPS Blocked 91<CR><LF>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 67 DN 19 Tacho start 92<CR><LF> 20 Alert time of position 93<CR><LF> 21 Interval time of position 11<CR><LF> : <CR><LF> <CR><LF> : dn -m 0,0,40<CR><LF> <CR><LF> : dn -m 0,1,41<CR><LF> <CR><LF> : dn -m 0,18,58<CR><LF> <CR><LF> : dn -m 0<CR><LF> <CR><LF> User defined MEM-codes for DNID-entry <0>:<CR><LF> <CR><LF> Index Name Mem-code<CR><LF> 0 Time of Position 40<CR><LF> 1 Power Up 41<CR><LF> 2 Power Down 66<CR><LF> 3 Antenna Blocked 69<CR><LF> 4 Stored Position 70<CR><LF> 5 Io Report 71<CR><LF> 6 Enter Zone 72<CR><LF> 7 Leave Zone 73<CR><LF> 8 Enter Sleepmode 80<CR><LF> 9 In Sleepmode 81<CR><LF> 10 Leave Sleepmode 82<CR><LF> 11 Fix Time Begin 83<CR><LF> 12 Enter Reduced 85<CR><LF> 13 In Reduced 86<CR><LF> 14 Leave Reduced 87<CR><LF> 15 Manual Position 88<CR><LF> 16 Above Speed Limit 89<CR><LF> 17 Below Speed Limit 90<CR><LF> 18 GPS Blocked 58<CR><LF> 19 Tacho start 92<CR><LF> 20 Alert time of position 93<CR><LF> 21 Interval time of position 11<CR><LF> : 4.10.12 DN –MM (NA) ___________________________________ MOBILE TO MOBILE SETTINGS -- 4.10.13 DN -N ________________________________________ SET MAX ACTIVE DNID NUMBER Purpose: To change the number of active DNIDs. Format: DN -n <number> number: New number of active DNIDs [0-64]. Up to 64 DNIDs can be downloaded and stored in the MES as default. It is possible to limit the number of DNIDs to a number between 0 and 64. However, it is not recommended to change the default value, because it may reduce the functionality of the system when used by an operator on a fishing vessel or truck. This feature can be used to limit the access to local configured position reporting or as an extra security against unauthorized tracking.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 68 DN 4.10.14 DN -O _____________________________________________________ CREATE DNID Purpose: Create a pre-defined DNID entry. Format: DN -o <LES>,<DNID>,<mem>,<sub>,<predef>,<provider> LES: LES id DNID: DNID number Mem: DNID member number Sub: DNID sub address Predef: Sets the DNID to be predefined. Only the value “1” is accepted Provider: A string of up to 25 characters in which the provider name can be entered The stored DNID can be displayed using the command DN -d 4.10.15 DN -P ________________________________________ PROGRAM DNID DATA FORMAT Purpose: Program a specific DNID entry. Format: DN -p <entry>,<auth>,<cat>,<date>,<iopin>,<speed>,<1pack>,<ustr>,<prec>,<t acho> auth: Authority level: 0-2, 0: normal user, 1: super user, 2: sysadm. cat: Format of data reports using this DNID. 0 = land mobile position report 1 = Maritime position report 2 = T&T data report format. Appendix A.2 iopin: Include I/O-pin status in all data reports using this DNID. Note that the content of the I/O-pin status depends on the MES type. Please see appendix A.1 and A.2 for details. 0 = no I/O-pin status included. 1 = I/O-pin status included. speed: Add additional speed and course information to data reports using this DNID (for land mobile data reports) 0 = no speed and course info included. 1 = speed and course info included. date: Add additional time and date information to data reports using this DNID. 0 =no time and date information included. 1 = time and date information, type 1, included. 2 = time and date information, type 2, included. 3 = time and date information, type 3, included. 1pack: Force MES to send only single packet reports. To enable this feature make sure that no options that use the second packet are enabled. 0 = one packet disabled. 1 = one packet enabled. ustr: Attach user defined string up to 32 characters in length. 0 = Attaching user string disabled. 1 = Attaching user string enabled. prec: Extra position precision. 0 = no extra precision included.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 69 DN 1 = extra precision included: 0.005 fraction of a minute. 2 = extra precision included: 0.001 fraction of a minute. [ tacho: Add tachograph data to data reports (NA) 0 = no tachograph data is included. 1 = tachograph data is included. 4.10.16 DN -S _____________________________________________ CHANGE DNID STATUS Purpose: To enable or disable the DNID. Format: DN -s <entry>,<’D’ | ‘E’ | ‘d’ | ‘e’> entry: DNID entry. To enable the DNID enter ‘e’, ‘E’. To disable the DNID enter ‘d’, ‘D’. 4.10.17 DN -T _______________________________________________ ATTACH USER-STRING Purpose: To attach user-defined strings to a position report. Remember to enable this feature with the command DN -p. Format: DN -t ? List usage. DN -t <entry> List string(s) for <entry> DN -t <entry>,<tmemcode> List string for <entry>,<tmcode> DN -t <entry>,DELETE Delete all strings for <entry> DN -t DELETEALL Delete strings for all <entry> DN -t <entry>,<tmemcode>,0 Delete string. DN -t <entry>,<tmemcode>,[“]<string>[“] Add/Change string. entry: Reference number to DNID-entries listed with DN -d. tmemcode:T&T default MEM code in decimal values. [0…127]. string: User defined string up to 32 characters in length. Always used braces when string contains spaces. Ex. "String With Spaces" DELETEALL: Delete strings for all <entry> DELETE: Delete all strings for a single <entry> If for some reasons, no user-string is defined for a certain <entry> and <tmemcode> pair, only the subaddress (43H) and length zero is added to the datareport. ( ..,43,00,..) Example: : dn -t 0,83,FixedTimeBegin<CR><LF> <CR><LF> : dn -t 0<CR><LF> <CR><LF> Entry MemCode UserString<CR><LF> 00 83 [FixedTimeBegin]<CR><LF> 1 of 64 entries found<CR><LF> : dn -t 0,81,"In Sleep Mode"<CR><LF> : dn -t 0<CR><LF> <CR><LF>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 70 DN Entry MemCode UserString<CR><LF> 00 83 [FixedTimeBegin]<CR><LF> 00 81 [In Sleep Mode]<CR><LF> 2 of 64 entries found<CR><LF> : dn -t 0,71,"Intruder Alarm"<CR><LF> <CR><LF> : dn -t 0<CR><LF> <CR><LF> Entry MemCode UserString<CR><LF> 00 83 [FixedTimeBegin]<CR><LF> 00 81 [In Sleep Mode]<CR><LF> 00 71 [Intruder Alarm]<CR><LF> 3 of 64 entries found<CR><LF> : 4.10.18 DN -TB _______________________________________ ATTACH BINARY USER-STRING Purpose: To attach binary user-defined strings to a position report. [ Format: DN -tb ? List usage. DN -tb <entry> List string(s) for <entry> DN -tb <entry> List string(s) for <entry> DN -tb <entry>,<tmemcode> List string for <entry>,<tmcode> DN -tb <entry>,DELETE Delete all strings for <entry> DN -tb DELETEALL Delete strings for all <entry> DN -tb <entry>,<tmemcode>,0 Delete string. DN -tb <entry>,<tmemcode>,<size><CR><string> Add/Change string. The only difference compared with DN -t is how a user string is Added or changed. Example: : dn -tb 0,72,20<CR><LF> <00><01><02><03><04><05><06><07><08><09><0a><0b><0c><0d><0e><0f><10><11><12><13> : dn -tb 0,73,20 <ff><fe><fd><fc><fb><fa><f9><f8><f7><f6><f5><f4><f3><f2><f1><f0><ef><ee><ed><ec> : dn -t<CR><LF> <CR><LF> Entry MemCode UserString<CR><LF> 00 72 Binary[00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 10 11 12 13 ] <CR><LF> 00 73 Binary[ff fe fd fc fb fa f9 f8 f7 f6 f5 f4 f3 f2 f1 f0 ef ee ed ec ] <CR><LF> 2 of 64 entries found<CR><LF> : dn -tb<CR><LF> <CR><LF> Entry MemCode UserString<CR><LF> 00 72 Binary[00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f 10 11 12 13 ] <CR><LF> 00 73 Binary[ff fe fd fc fb fa f9 f8 f7 f6 f5 f4 f3 f2 f1 f0 ef ee ed ec ] <CR><LF> 2 of 64 entries found<CR><LF> :
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 71 Directory 4.11 DIRECTORY 4.11.1 DIRECTORY _________________________________________________ LIST FILES Purpose: List all files. Format: DIRectory LS Remarks: The time stamp is UTC. The wildcards "*" and "?" can be used to specify a group of files. Example List all files in the MES. Type : dir<CR><LF> <CR><LF> EVENT LOG 50 2001-05-17 16:21<CR><LF> EGC 001 234 2001-05-17 13:00<CR><LF> REPORT 000 152 2001-05-17 11:47<CR><LF> TEST TXT # 245 2001-08-23 11:47<CR><LF> 4 File(s) 117760 bytes free<CR><LF> : The first two columns give the filename (name and extension), where the character ‘#’ indicates an open file. The next column gives the number of bytes in the file. The last two columns give the UTC date and time for the file creation. The last line gives the number of files listed, and the number of free bytes in the file system. List all files beginning with "REP" followed a three-letter extension by typing: dir rep*.*<CR> REPORT 009 216 97-03-14 12:05<CR><LF> REPORT 011 147 97-03-14 12:11<CR><LF> REPORT 013 212 97-03-14 12:23<CR><LF> REPORT 015 169 97-03-14 12:32<CR><LF> 4 File(s) 117760 bytes free<CR><LF>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 72 Errorlog 4.12 ERRORLOG 4.12.1 ERRORLOG _____________________________________________ SHOW ERRORLOG Purpose: Show the content of the errorlog. Format: errorlog 4.13 EV 4.13.1 EV -B _______________________________ BIT ERROR LIMITS FOR ANTENNA BLOCKED Purpose: By blocking for the signal reception the number of bit errors will increment by one for every 8.64sec. as long as it is blocked. When it reaches the “high” an “Antenna blocked” event is issued. The bit errors may increment by one up to “max”. Once the antenna is unblocked the bit errors will decrement by one for every 8,64sec. and when it reaches “low”, an antenna unblocked is issued. Format: EV -b <max>,<high>,<low> max: 2..100 (default 100) high: 1..max (default 80) low: 0..high-1 (default 75) 4.13.2 EV -C ____________________________________________ CLEAR EVENT PROGRAM Purpose: Clear event program Format: EV -c <entry> entry: reference to specific event program. (0-14) 4.13.3 EV -D _________________________________________ DISPLAY EVENT PROGRAMS Purpose: Display event programs. Format: EV -d This command displays all event parameters for the active event programs. 4.13.4 EV -E _________________________________ SETUP EXTENDED EVENT PARAMETERS Purpose: Setup extended parameters. Format: EV -e <entry>,<retxfailed>,<store>, <normafterantblock>,[antblockedfn] entry: reference to specific event program. (0-14) retxfail: Retransmit failed reports. Setting retxfail only has effect when using enhanced data reporting (enhanced data reporting is used by default if the used LES support the service ). [0 - 4] store: Save Stored reports. When this mode is enabled, reports will be saved when no satellites are visible. When the satellite becomes visible again, the stored reports will be sent. Up to 250 reports can be stored. 0 = stored reports disabled 1 = stored reports enabled normafterantblock: Normal position report after antenna blocked report.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 73 EV 0 = Normal position report after antenna blocked report disabled 1 = Normal position report after antenna blocked report enabled antblockedfn: Only send unblock data report if an interval program based on the same DNID has failed during blocking. 0 = Unblock data reports are always sent. 1 = Unblock data reports are only sent if interval program failed during blocking. 4.13.5 EV -FE _____________________________ DEFAULT EXTENDED PROGRAM PARAMETERS Purpose: Setup default extended parameters for eventprograms. Format: EV -fe <retxfail>,<store>,<normafterantblock>, <antblockedfn> Please see details about "retxfail", "store", "normaafterblock" , "antblockedfn" in command EV -e Example: : ev -fe 1,1,1,1 : ev -fe Retx store nantb antbtfn 1 1 1 1 4.13.6 EV -FP _____________________________________ DEFAULT PROGRAM PARAMETERS Purpose: Setup default parameters for eventprograms for autocreation. Format: EV -fp <powerctrl>,<sleepmode>,<io>,<antennablockedtime>, <gpsblockedtime>,<zoneevents>,<speedevents> Please see details about "powerctrl", "sleepmode", "io", "antennablockedtime", "gpsblockedtime", "zoneevents", "speedevents" in section EV -p. Example: : ev -fp 1,2,1,0,0,1,0 : ev -fp Pwctrl sleep io antbt gpsbt zone speed 1 2 1 0 0 1 0 4.13.7 EV -O ___________________________________________ CREATE EVENT PROGRAM Purpose: Open/create event program. Format: EV -o <LES>,<DNID>[,<mem>] LES: Land Earth station to be used for event reporting. DNID: Destination Network ID to be used. mem: Member number.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 74 FI (NA) 4.13.8 EV -P _________________________________________ ENABLE OR DISABLE EVENTS Purpose: Program/specify event program. Format:EV -p <entry>,<powerctrl>, <sleepmode>, <io>,<antennablockedtime>,<gpsblockedtime>,<zoneevents>,<speedevents> entry: reference to specific event program. (0-14) powerctrl: Send datareport at power- up and down. 0 = no data reports at power- up/down. 1 = send data reports at power- up/down. 2 = only send data reports at power- up/down if an intervalprogram based on the same DNID has lost reports during power off. sleepmode: send data report when sleepmode is active. 0 = no data reports at sleepmode events. 1 = send data report at sleepmode events. 2 = send data report at sleepmode events except at the “enter fixtime” event. io: send data report at any changes of the I/O-pins. 0 = no data reports at changes of the I/O-pins. 1 = send data reports at changes of the I/O-pins. antennablockedtime: this parameter is the number of minutes the antenna must be blocked before an Antenna blocked report is issued. The count down is initiated when the number of bulletin board errors reaches 80/100. 0 = antenna blocked reporting disabled [1..255] number of minutes before report is sent. gpsblockedtime: Number of minutes with blocked GPS before a position report is sent. 0 = GPS blocked reporting disabled [1..255] number of minutes before report is sent. zoneevents: This parameter enables/disables the leave zone and enter zone reports. Please see ZO commands. 0 = no data report at zone events 1 = sends data report at zone events 2 = sends data report only when moving between inside zones and outside. speedevent: This event enables/disables speedevent reports. Please see SE -sp. 0 = sends data report at speed event 1 = no data report at speed event 4.14 FI (NA) 4.14.1 FI ________________________________________________ FISHERY CONFIGURATION Purpose: Display and set fishery configuration. Format: FI {<command>} Handles the fishery configuration. Only for backwards compatibility
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 75 FX 4.14.2 FI 34 ____________________________________________________ AUTOGROUPING Purpose: Enable or Disable autogrouping. Autogrouping only affect those DNIDs with an 'A' as the 25. character of provider name. Format: FI 34 <value> Value: 0 (disable) / 1 (enable) 4.14.3 FI 72 ____________________________________________ SET MAX NUMBER OF DNID Purpose: Set maximum number of DNIDs. Format: FI 72 Prompts: Set max number of DNID: {value} Value: [0 - 64] Note. Identical to the DN -n command. 4.15 FX 4.15.1 FX _________________________________________________SET FIXED POSITIONS Purpose: Displays the main menu Format: FX {<lat>,<N|S>],<lon>,<E|W>} FX -d FX A list of fixed positions can be entered into the MES. For example, a list of positions where the vessel is expected to be in the nearest future can be entered. This causes the MES to receive geographically addressed EGCs as if the MES were located at the specified positions. An example of use could be to receive meteorological warnings about areas that the vessel is approaching. Using the command with a list of positions as parameter sets up those fixed positions in the MES. Positions are given with a precision of 1 degree. Using the command with no parameters clears the list of fixed positions. Using the command with the "-d" parameter displays the current list of fixed positions. Up to 7 fixed positions may be entered using this command. Example Set up three fixed positions : fx 30,N,12,E 27,N,5,E 24,N,3,W<CR><LF> <CR><LF> : Show fixed positions
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 76 GPS : fx -d<CR><LF> <CR><LF> 3 fixed position(s)<CR><LF> 30 N 12 E<CR><LF> 27 N 5 E<CR><LF> 24 N 3 W<CR><LF> : Clear fixed positions : fx<CR><LF> <CR><LF> :<CR><LF> 4.16 GPS 4.16.1 GPS ______________________________________________ GPS CONFIGURATION Purpose: Configuration and inspection of the GPS receiver. Format: GPS <options> 4.16.2 GPS -D ______________________________________________ DISPLAY SBAS STATE Purpose: Display the current SBAS reception status. Format: GPS -d Example: : gps -d<CR><LF> <CR><LF> GPS mode : 2<CR><LF> SBAS satellite PRN : 120<CR><LF> DGPS information age: 2.1<CR><LF> The fields are described in the table below. GPS Mode 0: No fix 1: GPS fix 2: DGPS fix (using SBAS) SBAS satellite PRN Satellite PRN for SBAS; blank if no SBAS DGPS information age Age in seconds if DGPS information; blank if no SBAS Table 4.1 GPS SBAS status values 4.16.3 GPS -G ________________________________ DISPLAY STATUS OF THE GPS RECEIVER Purpose: Display status of the GPS receiver. Format: GPS –g Equivalent to the RU –g command..
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 77 GPS 4.16.4 GPS -S __________________________________ SHOW OR SET SBAS CONFIGURATION Purpose: Set or display the current SBAS reception set-up Format: GPS –s <SBAS mode>,<PRN> GPS -s SBAS mode:Reception mode. 0: SBAS reception off 1: SBAS reception on 2: SBAS reception on, allow test mode messages (type 0) PRN: Specifies SBAS satellite PRN 0: Take any available satellite 100...132: Request a specific satellite The MES has a built-in GPS receiver that provides the current time and position. The GPS receiver works by receiving timing signals from the GPS and SBAS satellites. SBAS SBAS is originally created for aviation control purposes and the advantage of having this augmentation is two-fold: Atmospherical correction that generally makes it possible to obtain greater precision. Integrity monitoring that increases the reliability of the GPS system by disregarding faulty or imprecise signals. Dispite the primary purpose being aviation, other GPS applications may also benefit from the SBAS service. There are a number of SBAS systems each covering different geographical areas. WAAS in North America. EGNOS in Europe and Africa MSAS in Asia and Australia Unlike the normal GPS signals, the SBAS signals are broadcast through geostationary satellites that are identified with PRN numbers in the range 100 to 132. The GPS receiver is capable of choosing an SBAS PRN itself, but that is not recommended for normal use. If, e.g., a WAAS signal is used in Europe, the advantage is questionable at best since Europe is outside the coverage area of WAAS (though not necessarily outside reach of the WAAS signal). The GPS receiver is not able to detect this from the received signals and therefore it is generally required to choose the SBAS PRN manually. Please note that PRN allocation is subject to change, particularly for the systems not yet in full operation. Furthermore, systems may send the augmentation information as test messages (type 0 messages). Generally test messages should not be used since there is no guarantee of
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 78 Help the quality or availability. However for test or evaluation purposes the MES may be configured to accept test messages. Updated information on SBAS PRNs and test transmissions is provided by these organisations: The European Space Agency (for EGNOS) The Federal Aviation Administration (for WAAS). The Japanese Civil Aviation Bureau (for MSAS) The SBAS reception status is recorded with the position and can be reported by adding the “Extra precisson 0.001” data. Please see DN –p and Appendix A.1 for more information. The service is disabled by default. 4.17 HELP 4.17.1 HELP ____________________________________________ SHOW COMMAND HELP Purpose: Displays the main menu. Format: HELP ? This command shows a list of the MES commands available at the current user level. Please see command SU for more information about user levels 4.18 ID 4.18.1 ID ______________________________________________ SYSTEM IDENTIFICATION Purpose: Show system identification data. Format: ID Prints the system identification parameters. Example: : id p: A1234567890170 s: 3110268 t: 2 :
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 79 IO 4.19 IO Purpose:Configuration of io-pins . Format: IO <options> This command cannot be used on a MES that is part of an SSAS installation (supporting Covert Security alert) since this will reserve all io-pins for the alert functions. For other MESs the io-pins from output pin 1..7 and input pin 1..14 can be programmed for various purposes. Input-pin(s) can be programmed to initiate an internal event, causing a data report to be sent or for example changing reporting interval etc. Output-pin(s) can be programmed to change output-behavior (low- or high-level) on various interval events. Up to 16 io-events can be programmed. Mapping of the pin number to the physical pins located on the TCU: I/O pin Pin type Block 1 Input/output/adc X8 PIN 1 2 Input/output/adc X10 PIN 1 3 Input/output/adc X12 PIN 1 4 Input/output/adc X11 PIN 1 5 Input/output/adc X9 PIN 1 6 Input/output/adc X7 PIN 1 7 Input/output X14 PIN 1 8 Input X8 PIN 2 9 Input X10 PIN 2 10 Input X12 PIN 2 11 Input X11 PIN 2 12 Input X9 PIN 2 13 Input X7 PIN 2 14 Input X14 PIN 2 Table 4.2 GPIO mapping tables The IO pin interface is located on the TCU. Please see [7]. The IO interface is controlled by the IO commands, explaned below.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 80 IO Before use, the io-pins must be configured using the IO commands When polling ‘Zone Group/Selection Poll’ for changing output status, make sure to configure the io-pins as output. Poll for reading I/O status is possible for all io-pins at any time. INPUT PINS Any io-pin can be configured to generate any of the T&T predefined internal event, using the "IO -i ..." command. Example: "IO -i 2,0,1,2" configures pin 2 to generate an internal event causing the MES to change between long and short reporting interval. Configuring short and long reporting interval is described in PG -e and PG -l. OUTPUT PINS Output pin can be configured to change on any of the T&T predefined internal event using the "IO -o ..." command as described in paragraph IO -o. Examples: "IO -o 3,0,1,2" configures pin 3 to change level, when receiving Enter/Leave Zone events. "IO -o 4,0,8,7" configures pin 4 to change level, when receiving Above/Below Speed Limit events. General configuration of speed limit etc. "IO -o 4,0,5,6" configures pin 4 to change level, when receiving GPS Blocked /Unblocked events. “IO -o 5,0,1,9” configures pin 5 to go ‘low’ when a zone is entered and to go ‘high’ on a ‘Change Output A’ event. The latter is a way of making an output pin respond to an input pin by programming an input pin to generate this specific event (e.g., the command “IO -I 2,0,3,0”: Generate ‘Change Output A’ when pin 2 goes ‘low’). As can be seen in examples 2 and 3, several (up to 16) events can be assigned for a single out-pin 4.19.1 IO -C________________________________________________ CLEAR IO-PIN SETUP Purpose: Clear/removes and io-pin configuration. Format: IO -c <id> Id: [0..15], Id number used when showing io-pin configurations. Please see IO –s
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 81 IO 4.19.2 IO -I ___________________________________________________ INPUT-PIN SETUP Purpose: This command is used for assigning events to an input-pin. Format: IO -i ? IO -i <PinNo>,<InitialLevel>,<LowLevelEvent>,<HighLevelEvent> ? Displays help and Input Event Table. PinNo: [1..14] Pin reference number InitialLevel: Value currently not used. LowLevelEvent: Event on input-level low. HighLevelEvent: Event on input-level high. The table below shows current available input-events. Input Event Table Value No event 0 Long Reporting Interval 1 Short Reporting Interval 2 IO-event 1 3 IO-event 2 4 In-sleep filter on 5 In-sleep filter off 6 Table 4.3 Input event table 4.19.3 IO -O__________________________________________________OUTPUT-PIN SETUP Purpose: This command is used for assigning events to an output-pin. Format: IO -o ? IO -o <PinNo>,<InitialLevel>,<LowLevelEvent>,<HighLevelEvent> ? Displays help and Input Event Table. PinNo: [1..7] Pin reference number InitialLevel: [ 0:Low | 1:High ], Initial output-level. LowLevelEvent: Event on output-level low. HighLevelEvent: Event on output-level high. A single output-pin can be programmed more then once. Ex. to respond on enter/leave-zone and on antenna blocked etc. The last occurred event controls the output. Remember always to pair Low-/High-LevelEvent for output, unless an output is wanted to toggle once (singleshoot). The table below shows current available output-events.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 82 IO Output Event Table Value No event 0 Enter Zone 1 Leave Zone 2 Antenna Blocked 3 Antenna Unblocked 4 GPS Blocked 5 GPS Unblocked 6 Below Speed Limit 7 Above Speed Limit 8 IO-event 1 9 IO-event 2 10 Table 4.4 Output event table The Speed Limit, which is mentioned in items 7 and 8 above. 4.19.4 IO -S_________________________________________________ SHOW IO-PIN SETUP Purpose: Show all io-pin configurations. Format: IO -s Example: : io -s<CR><LF> Id PinNo Type Init LowEvent HighEvent<CR><LF> 0 2 O 1 1 2<CR><LF> 1 3 O 1 2 1<CR><LF> 2 4 I 0 1 3<CR><LF> 3 entries used :
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 83 LI 4.20 LI 4.20.1 LI _____________________________________________________________ LOGIN Purpose: Issues a login request to an NCS. Format: LI <ncs_id | channel_no> ncs_id is an integer in the range 1-63, 100-163, 200-263 or 300-363. channel_no is an integer in the range 8000-14000. It is strongly recommended to use the NCS ID specification method instead of the channel number method, as the NCS ID also indicates to the MES which ocean region to be used. If no parameters are specified the MES will use the main NCS in the preferred ocean region. The preferred ocean region is set by the command set -o command. If the preferred ocean is set to none, the MES will send the login request to current NCS. The current NCS is the NCS channel that the MES is currently tuned to. The current NCS can be set with the ncs -g command. The date and time of the last login/logout can be seen with the st -c command. Note: The MES may start an automatic login. 4.21 LO 4.21.1 LO __________________________________________________________ LOGOUT Purpose: Issues a logout request to the Network Co-ordinating Station. Format: LO This command initiates a logout procedure from the current NCS. A MES should always be logged out when turned off for more than a few hours. The date and time of the last login/logout can be seen with the st -c command.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 84 LOG 4.22 LOG Purpose: Control the data-logging feature. Format: LOG <options> LG <options> Data can be logged in the MES over time. The stored data can be transferred to a PC/laptop using TFTP (please see LO –x command) or send over the satellite. The log consists of a set of entries created over time. Every entry contains the same data fields, which can be selected from the table below. Event number and Time of creation are always included as the two first fields of an entry the other fields are optional. The size of an entry can be calculated by adding the field size of the selected data fields. The format of the data fields is described in more details in appendix C.2 . Data fields Precision Limits Field size Description Event number - 256 types 1 byte Cause of the entry creation. Time of creation (UTC time) 1 second Year 1970 to 2038 4 byte The time where the log entry is created (time of event). Time offset GPS 1 second 18 hours 2 byte Time offset to the GPS data. GPS time equal to Time of creation minus Time offset GPS. Position GPS 9 meters - 6 byte GPS position. Speed GPS 1 km/h 254 km/h 1 byte GPS speed in km/h. Course GPS 2 degrees 0-360 degrees 1 byte GPS course. I/O status - - 1 byte Status of the I/O-pins. Distance tachograph 0.1 km 429,496,729.5 km 4 byte The total traveled distance according to the tachograph interface. Speed tachograph 1 km/h 255 km/h 1 byte The speed according to the tachograph interface. Extended position GPS 2 meters - 7 byte GPS position. Speed GPS in knots 0,1 knots 6553,5 knots 2 byte GPS speed in knots. Table 4.5 Possible data fields in a log entry Event Number Hex Number Dec Power up 40 64 Power down 42 66 Antenna blocked 45 69 IO report 47 71 Enter zone 48 72 Exit zone 49 73 Enter Sleepmode 50 80 In Sleepmode 51, 81 Leave Sleepmode 52 82 Above speed limit 59 89 Below speed limit 5A 90 GPS blocked 5B 91 Table 4.6 Possible events creating log entries.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 85 LOG In this case the log status is “cleared” (the log is not in use) setting can only be changed when the log is cleared. “log -f” include Time offset GPS, Position GPS and Speed GPS “log -p” include Power, Sleep mode; IO, Antenna blocked, GPS blocked, Zone and Speed events. 4.22.1 LOG -C _____________________________________________ CLEAR THE DATA-LOG Purpose: Clear the log: Delete all stored data and stop logging. Format: LOG -c 4.22.2 LOG -D ________________________________________ DISPLAY DATA-LOG SETTINGS Purpose: Display the current log settings and status. Format: LOG -d 4.22.3 LOG -E ___________________________________ SET EXTENDED DATA-LOG SETTINGS Purpose: Change the current settings for the extended log options. Can only be used when the log is cleared. Format: LOG -e <StopWhenFull> StopWhenFull: Stop when full or delete oldest data. 0 = When the log is full the oldest data is erased and the space is used for new data. 1 = When the log is full the logging stops. 4.22.4 LOG -F __________________________________________ SELECT DATA-LOG FIELDS Purpose: Select the data fields to be included in the log. The command can only be used when the log is cleared. Format: LOG -f <timeGPS>,<PosGPS>,<SpeGPS>,<CouGPS>,<I/O>, <DistTG>,<SpeTG> timeGPS: Time of GPS data. 0 = Time stamp for GPS data is not included in the log. 1 = Time stamp for GPS data is included in the log. PosGPS: The position GPS data. 0 = GPS position is not included in the log. 1 = GPS position in 0,005 fraction of a minute is included in the log. 2 = GPS position in 0,001 fraction of a minute is included in the log. [ SpsGPS: The speed GPS data. 0 = GPS speed is not included in the log. 1 = GPS speed in fractions of 1 km/h is included in the log. 2 = GPS speed in fractions of 0,1 knots is included in the log. [ CouGPS: The course GPS data. 0 = GPS course is not included in the log. 1 = GPS course is included in the log. I/O: I/O pin data. 0 = I/O data is not included in the log. 1 = I/O data is included in the log.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 86 LOG DistTG: The total travelled distance tachograph data. (Not Appplicable) 0 = Tachograph distance is not included in the log. 1 = Tachograph distance is included in the log. SpeTG: The speed tachograph data. (Not Appplicable) 0 = Tachograph speed is not included in the log. 1 = Tachograph speed is included in the log. 4.22.5 LOG -I___________________________________________________ START LOGGING Purpose: Start logging data. Format: LOG -i 4.22.6 LOG -P __________________________________________ SELECT DATA-LOG EVENTS Purpose: Select the events, which is to create entries in the log. The command can only be used when the log is cleared. Format: LOG -p <timeout>,<startTG>,<parkTG> Timeout: Interval timer. Every time an entry is created an interval timer is reset and when a timeout occurs a new entry is created. 0 = The interval timer is not used. 5..43200 = The number of seconds used for the interval timer. StartTG: Tachograph start event. (NA) 0 = The event is not used. 1 = The event creates an entry. 2 = The event creates an entry and starts the interval timer. 3 = The event creates an entry and stops the interval timer. ParkTG: Tachograph parked event. (NA) 0 = The event is not used. 1 = The event creates an entry. 2 = The event creates an entry and starts the interval timer. 3 = The event creates an entry and stops the interval timer. 4.22.7 LOG -S ___________________________________________________ STOP LOGGING Purpose: Stop logging data. Format: LOG -s 4.22.8 LOG -X _________________________ EXTRACT LOG DATA TO FILE FOR TFTP TRANSFER Purpose: Extract log data in a given time interval. Use the TFTP protocol for file transfer. Format: LOG -x <StartDate>,<StartTime>,<EndDate>,<EndTime>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 87 LS StartDate: The start date of the time interval. Format: YYYY-MM-DD. StartTime: The start time of the time interval. Format: HH:MM EndDate: The start date of the time interval. Format: YYYY-MM-DD. EndTime: The stop time of the time interval. Format: HH:MM The command “log -x” retrieves data from the log file and store it in the MES. : Usage: log -x <StartDate>,<StartTime>,<EndDate>,<EndTime>,<Filename> <StartDate>,<EndDate>: YYYY-MM-DD <StartTime>,<EndTime>: HH:MM e.g. : log -x 2000-01-01,00:00,2015-06-12,06:00,testlog DateTimeStart: 946684800, DateTimeEnd: 1434088800, Filename: /usrdata/testlog : Local transfer: The logfile can be retrieved using a TFTP client connected to the system To get the log file, type the IP address of the MES and the filename of the log file. The TMA or TCU can be used to find the MES IP address. Remote transfer: A TBus 2 command support remote retrieval of a portion of the log. A brief introduction to Tbus 2 is given in appendix D . 4.23 LS 4.23.1 LS _______________________________________________________ LIST OF FILES Purpose: List all files Format: LS DIR Please see DIR command
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 88 NCS 4.24 NCS Purpose: Management of NCS id's and channels. Format: NCs <options> The NCS list is a user configured list of Network Co-ordinating Stations. There is one main NCS in each of the four oceans. The four main NCS are specified by INMARSAT and pre-programmed by T&T (the first line of the list) and they can not be altered or removed. The add and delete functions are a supplement to the set -l command. The nc -g command is used to set the current NCS (see the set -o command and the li command). The scan command can be used if the MES is in an overlap region. 4.24.1 NCS -A ___________________________________________________ ADD AN NCS Purpose: Add an NCS to the NCS list. Format: NC -a <ncs_id,ncs_channel><options> The Inmarsat-C system is capable of operating with spot beams. Each spotbeam will have an Id and common channel number, and shall be entered manually using this command. 4.24.2 NCS -G ____________________________________________ GO TO SPECIFIC NCS Purpose: Go to a specific NCS. Format: NC -g <ncs_id><options> NC -g <ncs_channel><options> NC -g <ncs_id,ncs_channel><options> ncs_id: An integer in the range 1-63, 100-163, 200-263 or 300-363. ncs_channel: An integer in the range 8000-14000 Go to a specific NCS, using NCS id, channel number, or both. 4.24.3 NCS -L ________________________________________________ SHOW NCS LIST Purpose: Show NCS list Format: NC -l <options> Remarks: Similar to SE -l Example To change the current NCS to the Atlantic ocean main NCS, type: ncs -g 144 or ncs -g 11080 These specific values can be seen in the description of the set -l command. To scan only the Indian ocean region, type: set -o i
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 89 NCS to select Indian as the preferred ocean region. Then type: ncs -s to initiate a scanning of this ocean region. 4.24.4 NCS -R _______________________________________________ REMOVE AN NCS Purpose: Remove a user defined NCS from the NCS list Format: NC -r <ncs_id> <options> 4.24.5 NCS -S ___________________ INITIATE SCANNING FOR THE STRONGEST NCS SIGNAL Purpose: Initiate a scanning for the strongest NCS signal. Format: NC -s <options> Initiate a scanning of the preferred ocean region part of the NCS list, for the strongest NCS signal. Tune to and login at that NCS. If none is selected as the preferred ocean region, then all the allowed regions will be scanned. Scanning ocean regions: Preferred ocean setting Allowed ocean(s) setting Automatic ocean-region shift behavior Preferred ocean set to "NONE" Allowed ocean set to "NONE" Scanning current ocean region, and login on the strongest spot. If synchronising to current ocean region fails the other regions are scanned. Allowed ocean set to one or more oceans (W, E, P and I) Scanning current ocean region, and login on the strongest spot. If synchronising to current ocean region fails the allowed regions are scanned. Preferred ocean set to an ocean (W, E, P or I) Allowed ocean set to "NONE" Scanning preferred ocean region, and login on the strongest spot. If synchronising to preferred ocean region fail the other regions are scanned. Allowed ocean set to one or more oceans (W, E, P and I) Scanning preferred ocean region, and login on the strongest spot. If synchronising to preferred ocean region fail the allowed regions are scanned.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 90 Password 4.25 PASSWORD 4.25.1 PASSWORD _________________________________________ CHANGE PASSWORD Purpose: Changes user password. Format: PASSWORD < username > PASSWO < username > PASSWD < username > Prompts: Enter password: Confirm password: This command changes the password of <username>. The effective user id must be at the same or higher level as <username>. The password protection of a user id/level can be removed by entering a <CR> when prompted for a password. Username can be one of the 3 built in user accounts. Please see the SU command. Example passwd super<CR> Enter new password:*****<CR> Confirm new password:*****<CR> Password for user super changed. 4.26 PG Purpose: Setting up the MES for Inmarsat-C PU reporting. Format: PG <options> A connection opened with the PG command is marked as local and can not be changed by any polls. In the same way connections opened by polls (Inmarsat PU program polls, or T&T Proprietary Download DNID Poll) are marked as remote and can not be changed by the PG command. When a connection is opened all settings will be set to their default values; and these default values are also through this PG command. 4.26.1 PG -A ______________________________________________SET ALERT ACTIVATION Purpose: Selects whether an interval program should be started or altered when an alert is issued. Format: PG -a <connection>,<alert controlled>,<alert interval> connection: Points out the interval program to be configured alert controlled: Enables the alert control 0 = alert control off 1 = alert control on alert interval: Sets the reporting interval (measured in frames) for alert reporting.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 91 PG Example : pg -a 0,1,200 Connection no: 0, Alert controlled: 1, Alert interval: 200 : Enables the alert control for an interval report program. 4.26.2 PG -B ________________________________ VALUE OF SPAREBIT FOR DATEFORMAT 3 Purpose: Set value of sparebit for dateformat 3 (sparebit located in packed 2, byte 6, bit 8). Format: PG -b <connection>[,<status>] Without the optional connection and status the PG -b command will display the value of the sparebit. connection: Program connection [0 - 14] status: 00/cleared or 80/set All connections relate to the same spare bit value - only for backwards compatibility. 4.26.3 PG -C ________________________________________ CLOSE A LOCAL CONNECTION Purpose: Close a local connection. Format: PG -c <connection> Close the local connection given by <connection>, where <connection> is the connection number. Open connections can be displayed by using the PG -d command. 4.26.4 PG -D ___________________________________ OVERVIEW OF CONNECTION STATUS Purpose: Display an overview of the MESs connection status. Format: PG -d [<connection>] Without the optional connection number the PG -d command will display an overview of the MESs connection status. Example : pg -d<CR><LF> <CR><LF> Connection Program Ocean region<CR><LF> 0: remote PU[ip] 131,2540,49<CR><LF> 1: local PU[ip] 131,2541,49 312,6202,49<CR><LF> 2: remote PA[s] 104,8048,48<CR><LF> 3: closed<CR><LF> : The connection can have the status remote, local or closed. A remote connection has been opened and programmed by sending poll to the MES. A local connection is opened and programmed by the PG command. Each connection can contain one program, which can be a PU or PA program:
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 92 PG PU programs use unreserved data reporting. PA programs use reserved data reporting. The letters inside the [ ] give information about the status of the connection: p data loaded from the GPS (sub-address 1) i Initiated s stopped More information about the programming can be displayed by including the connection number in the PG -d command. PU example : pg -d 0<CR><LF> <CR><LF> LES DNID Mem OK Err Inter Sub Rd <CR><LF> 131 2540 49 5 0 200 1 10<CR><LF> <CR><LF> Start at : 2955 (03-07-07 07:05:31)<CR><LF> Next at : 4155 (03-07-07 09:58:19)<CR><LF> End at : <CR><LF> Status : 0 - OK<CR><LF> PA example : pg -d 0<CR><LF> <CR><LF> LES DNID Mem OK Err Inter Sub Auth Total Rem Data<CR><LF> 104 8048 48 0 0 440 0 3 370 370 20<CR><LF> <CR><LF> Start at : 6144 (03-07-07 14:44:44) <CR><LF> Next at : <CR><LF> End at : <CR><LF> Status : 0 - OK<CR><LF>
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 93 PG LES Land Earth Station ID. DNID Data Network ID. Member Member Number in the DNID group. OK The number of successful data reports since power-on. Err The number of failed data reports. Inter Frame interval between each report Sub Sub-address Sub-address currently being used by a specific connection. Rd Frame randomization number used to randomize the transmission of unreserved interval reports. Only used and shown for PU programs Auth Program authentication level inherit form the used DNIDs Only shown for PA programs Total The total number data report reservations Only used and shown for PA programs. Local PA programs will renew there reservation when it expires while remote PA programs will have to be renewn from the LES. Rem The remaning number of data report reservations Only used and shown for PA programs. Local PA programs will renew there reservation when it expires while remote PA programs will have to be renewn by the LES. Data The amount of user data (in byts) one data report can contain Only shown for PA programs. Start at Frame number and the corresponding date & time where the program was started Next at Frame number and the corresponding date & time where the next report is to be sent. Code This reports the state of the programming. 0 - OK The program is running normally 1 - Overflow Internal error such as erroneous parameters given in the program poll packet. 2 - Frame timing error This appears if the MES can not get the NCS TDM frame number information. This state will occur during the normal tuning operations. If the state exists for more than a minute check the TDM channel number and the antenna connection. 4 - Stopped The program has been stopped with a stop poll packet. <other> - Unknown Internal error. Table 4.7 Connection Status Summary
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 94 PG 4.26.5 PG -E _________________________________________ EXTENDED PROGRAM SET-UP Purpose: Set-up Extended program parameters. Format: PG -e <conn>,<remote>,<rand>,<zoneint>,<retxfail>,<store>, <longshortinterval>,<mindist>[,<tacho>][,<wksch>][,<gpsblocked>] Change type of a connection (0=local, 1=remote) and random interval for a connection. conn: Program connection number [0 - 14] remote: Change type of a connection 0 = local 1 = remote, rand: Randomization interval [0 - 255] zoneint: Zone Interval 0 = don't use zone interval. 1 = use zone interval, retxfail: Retransmit failed reports. Setting retxfail only has effect when using enhanced data reporting (enhanced data reporting is used by default if the used LES support the service ). [0 - 4] store: Save Stored reports. When this mode is enabled, reports will be saved when no satellites are visible. When the satellite becomes visible again, the stored reports will be sent. Up to 250 reports can be stored. 0 = stored reports disabled 1 = stored reports enabled longshortinterval: This feature enables the MES to have two different position reporting intervals. A long reporting interval for use when the vessel/vehicle has not moved more than the configured number of meters (ex. 400 meter) since last report and a short interval at all other times. 0 = long-short interval disabled 1 = long-short interval enabled mindist: Before a scheduled position report is sent, the MES checks if the position in the last report and the current position are at least the minimum distance apart. The minimum distance can be configured and if set to 0 m. all scheduled position reports are sent. 0 = minimum distance disabled 1 = minimum distance enabled tacho: (NA). wksch: Activate the week schedule control which makes it possible to limit the generation of interval reports. 0 = disable week schedule control 1 = enable week schedule control gpsblocked: In case of GPS blocked, an interval program will as default report MEM code “Time of position” (11). This feature allows the program to report “GPS blocked” (91) instead.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 95 PG 0 = Report MEM code “Time of position” (11) 1 = Report MEM code “GPS blocked” (91) 4.26.6 PG -FA _____________________________________ SET DEFAULT ALERT ACTIVATION Purpose: Selects whether a newly created interval report program should have alert control enabled by default. Format: PG -fa <alert controlled>,<alert interval> alert controlled: Sets the default alert control 0 = alert control off 1 = alert control on alert interval: Sets the default reporting interval (measured in frames) for alert reporting. The options for this command corresponds to the PG -a command except that no <connection> number is given; this is because these settings does not apply to any existing interval program but will be inserted into any future programs created. Please see PG -a. 4.26.7 PG -FE __________________________________ DEFAULT EXTENDED PROGRAM SET-UP Purpose: Setup default program format for new programs being created. Format: PG -fe <resv>,<rand>,<zoneint>,<retxfail>,<store>, <longshortinterval>,<mindist>[,<tacho>][,<wksch>][,<gpsblocked>] The options for this command corresponds to the PG -e command except that no <connection> number is given and the <remote> option has been exchanged with an unused field <resv>; The connection number is omitted because these settings does not apply to any existing interval program but will be inserted into future programs created. The remote option has been removed because whether future program is remote or local depend on whether it is created locally or remote. Please see PG -e. Example: : pg -fe 0,4,0,0,0,0,0,0,1 : pg -fv Resv Rd Zone ReTx Store LSInt MDist Tacho WkSch GpsBl 0 4 0 0 0 0 0 0 1 0 Selects this option combination (with <WkSch> set) as standard values for future generated interval programs. 4.26.8 PG -FL ____________________ SET DEFAULT LONG INTERVAL AND MINIMUM DISTANCE Purpose: Set default settings for long interval and minimum distance Format: PG -fl <longinterval>,<distance>[,<pwron reset>][,<GPS req.>] This command sets long short interval, minimum distance automatic reset of report interval and whether GPS fix is required. longinterval: Long interval in frames between reports [20-10000]
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 96 PG distance: Units of 10 meters [0-65535] The options for this command corresponds to the PG -l command except that no <connection> number is given; this is because these settings does not apply to any existing interval program but will be inserted into any future programs created. Please see PG-l. pwron reset:Controls whether the report interval should reset to ‘short’ on power up. 0 = Do not change the report interval on power up. 1 = Set the report interval to ‘short’ on power up. GPS req.Controls whether a recent GPS fix is required to accept a change to ‘long’ interval mode. 0 = Change of interval mode is done regardless of GPS fix. 1 = Change of interval mode requires GPS fix. 4.26.9 PG -FP _________________________________ SET DEFAULT PROGRAM PARAMETERS Purpose: Set the default connection values for future created programs. Format: PG -fp <interval>[,<start frame>] The options for this command corresponds to the PG -p command except that no <connection> number is given; this is because these settings does not apply to any existing interval program but will be inserted into any future programs created. Please see PG -p. 4.26.10 PG -FV _________________________ VIEW DEFAULT EXTENDED PROGRAM PARAMETERS Purpose: View default extended program parameters Format: PG -fv This command displays the extended parameters assigned to interval programs that are created. Please see PG -fe. 4.26.11 PG -I ____________________________ INITIATE A PROGRAMMED LOCAL CONNECTION Purpose: Initiate the PU programmed local connection given by <connection> Format: PG -i <connection>[,p] <options> Initiate the PU programmed local connection given by <connection> [0 - 14]. If the "p" parameter is included, the datareports are sent as position reports containing the GPS position. If the "p" is omitted, the DTE must supply the data for the report. 4.26.12 PG -L ____________________________ SET LONG INTERVAL AND MINIMUM DISTANCE Purpose: Set long interval and minimum distance Format: PG -l <conn>,<longinterval>,<distance>[,<pwron reset>][,<GPS req.>] This command sets long interval, minimum distance, automatic reset of report interval and whether GPS fix is required. conn: Program connection [0 - 14] longinterval: Long interval in frames between reports [20-10000] distance: Units of 10 meters [0-65535], 0=disable minimum distance
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 97 PG pwron reset:Controls whether the report interval should reset to ‘short’ on power up. 0 = Do not change the report interval on power up. 1 = Set the report interval to ‘short’ on power up. GPS req. Controls whether a recent GPS fix is required to accept a change to ‘long’ interval mode. 0 = Change of interval mode is done regardless of GPS fix. 1 = Change of interval mode requires GPS fix. Longinterval: This feature enables the MES to have two different position reporting intervals. A long reporting interval for use when the vessel/vehicle has not moved more than the configured number of meters (ex. 400 meter) since last report and a short interval at all other times. The interval program uses the long interval when the user activates an input pin programmed for long interval. The short interval is used automatically when the vessel/vehicle has moved the programmed distance, or an input pin programmed for short interval is activated. The change in position is checked every 1 minutes. Position time 400m from harbor Position of harbor Interval changed because vessel has moved Figure 4.5 Automatic change of reporting interval The short interval is default programmed with the PG -p command or downloaded via poll. The long to short interval change can be enabled/disabled for the individual programs using PG -e. The input pins are programmed with the IO -i command. NOTE: The long to short interval change distance and the minimum distance between p This feature applies to programmed interval reporting only. Distance: Minimum distance is a feature that makes sure the MES has moved a certain minimum distance before sending the next position report. After setting-up the program on a DNID, the first report is always sent. At the next scheduled position report, if minimum distance is enabled, the MES will check the current position and calculate the distance to the position it had when the previous position report was sent. If this distance is below the minimum distance, the position report will not be sent. This procedure is repeated at the times for the next scheduled position reports.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 98 PG This does not mean that the MES will send a data report when it has moved the minimum distance. the position reports will be sent at scheduled times, but reports will only be sent if the distance to the previous report is over the minimum distance. The minimum distance value is also used to check if the MES is to go from sending position reports with the long time interval to sending with the short interval. Minimum distance is enabled/disabled with the PG -v command. 4.26.13 PG -O ________________________________________ OPEN A LOCAL CONNECTION Purpose: Open a local connection. Format: PG -o LES_id, DNID[,MemberNo]{ LES_id, DNID[,MemberNo]} The LES ID, the DNID and the member number must be supplied as found in the DNID table. The DNID table is displayed by the DN -d command. Example : pg -o 131,2540,49<CR><LF> <CR><LF> INFO 459: Connection no. 1 opened<CR><LF> : pg -d<CR><LF> <CR><LF> Connection Program Ocean region<CR><LF> 0: remote PU[ip] 131,2540,49<CR><LF> 1: local PU[-] 131,2540,49<CR><LF> 2: closed<CR><LF> 3: closed<CR><LF> : Up to four LES_id, DNID can be linked pairs; one for each ocean region. Example pg -o 131,2540,49 31,2540,49 4.26.14 PG -P ______________________ PROGRAM A LOCAL CONNECTION WITH PU PROGRAM Purpose: Program a local connection with PU program. Format: PG -p <connection>,<interval>[,<start frame>] Program the local connection given by <connection> to send data reports every <interval> frames [20-10000]. Optionally specify the frame no. <start frame> at which the data reporting should begin. If <start frame> is not specified the data reporting will begin within 5 minutes [0- 9999]. 4.26.15 PG -PA _____________________ PROGRAM A LOCAL CONNECTION WITH PA PROGRAM Purpose: Program a local connection with PA program. Format: PG -pa <connection>,<reports/day>,<data size> Program the local conection given by <connection> to send a given number of reports each day <reports/day>. Each report can contain the given number of bytes <data size>.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 99 Pp reports/day: Number of reports to be transmitted each day. Legal values: [3, 4, 6, 8. 12, 24, 48, 96] data size: Bytes of data to be transmitted. Legal values: [2, 12, 24, 36] 4.26.16 PG -S ______________________________ STOP A PROGRAMMED LOCAL CONNECTION Purpose: Stop the PU programmed local connection given by <connection>. Format: PG -s <connection> Stop the PU programmed local connection given by <connection>. 4.26.17 PG -V _______________________________ VIEW EXTENDED PROGRAM PARAMETERS Purpose: View Extended program parameters Format: PG -v PG -v <entry> This command displays the extended parameters for a given program. 4.27 PP 4.27.1 PP _____________________________________ DISPLAY EPADR PROGRAM STATUS Purpose:Display EPADR program status. Format: PP <option> -d [<entry>] Enhanced Pre-Assigned Data Reporting (EPADR) 4.28 REBOOT 4.28.1 REBOOT __________________________________________________ REBOOT MES Purpose: Reboot the tranceiver. Format: REBOOT <option> RE <option> 42 Warm boot 117 Reboot into bootloader 4.29 RECVFILE (NA) 4.29.1 RECVFILE _______________________________________________ RECEIVE FILE Purpose: Receive file from terminal using TFTP protocol.
TT-3027 TT98-147405-A Software Interface Reference Manual Command Reference 100 Rs (NA) Format: RECVFILE <file name> RF <file name> This command initiates a file transmission of the file <file name> from the terminal using the TFTP protocol. 4.30 RS (NA) 4.30.1 RS _____________________________________________________ REPORT SETUP Purpose: Format: 4.31 RM 4.31.1 RM _______________________________________________________ REMOVE FILE Purpose: Remove or delete a file from the file system. Format: DElete <filename> RM <filename> Filename: Max. 12 characters Remarks: The reserved files _EGCLOG, _RXLOG and _TXLOG cannot be deleted. The wildcards "*" and "?" can be used to specify a group of files. 4.32 RU 4.32.1 _________________________________________________________ REMOTE UNITS Purpose: Inspect the status and set the operation of remote units. Format: RU <options> The command without any options gives the option list. An example is: : ru<CR><LF> <CR><LF> Illegal argument (?). Legal arguments are :<CR><LF> -l (arg) List remote units<CR><LF> -g (arg) GPS satellite info<CR><LF> 4.32.2 RU -G _______________________________ DISPLAY STATUS OF THE GPS RECEIVER Purpose: Display the status of the GPS Receiver. Format: RU -g <options>