SkyWave IDP 100 Series Developer'S Manual Download

Page: 1 / 106

IDP 100 Modem Series

Developer Guide

T203, Version 04

The electronic version of this document allows

you to use the built-in Hyperlinks and

bookmarks when using Adobe Reader

© SkyWave Mobile Communications Inc.

Summary of Contents for IDP 100 Series

Page 1: ...P 100 Modem Series Developer Guide T203 Version 04 The electronic version of this document allows you to use the built in Hyperlinks and bookmarks when using Adobe Reader SkyWave Mobile Communications Inc ...

Page 2: ... or performance of the software Under no circumstance shall SkyWave be held liable for any direct indirect consequential or incidental damages arising from the use or inability to use the software or documentation All trademarks or registered trademarks are the property of their respective owners INMARSAT the Inmarsat logo and IsatData Pro are trademarks of Inmarsat used under license by SkyWave I...

Page 3: ...Beam Switch 3 2 1 5 Blockage 4 2 1 6 Muting 4 2 2 Message States 4 2 2 1 To Mobile States 5 2 2 2 From Mobile States 6 2 3 AT Message Commands 7 2 3 1 From Mobile Messages 7 2 3 2 To Mobile Messages 8 2 4 On board Memory 9 2 4 1 Satellite Messages 10 2 4 2 Network Configuration 11 2 4 3 S Registers 11 2 5 Trace Table 11 2 6 Modem Outputs 11 2 6 1 Reset Out 12 2 6 2 Event Notification 12 2 7 GPS 12...

Page 4: ...5 4 4 S3 Command Line Terminator 28 5 4 5 S4 Response Formatting Character 29 5 4 6 S5 Command Line Editing Character 29 5 4 7 S50 Power Mode 30 5 4 8 S51 Wake up Interval 30 5 4 9 S60 Echo Setting S60 31 5 4 10 S61 Quiet Setting 31 5 4 11 S62 Verbose Setting 32 5 4 12 S63 CRC Setting 32 5 4 13 S64 Prefix Character of CRC Sequence 33 5 4 14 S80 Last Error Code 33 5 4 15 S81 Most Recent Result Code...

Page 5: ...g Mode Commands 65 6 2 Trace Types 65 6 3 AT Command Access 65 6 4 Trace Record Format 66 6 4 1 Trace Record Header 66 6 4 2 Class Data 67 6 5 Trace Class Definitions 68 6 5 1 System Reset Event Traces Class 2 68 6 5 2 Satellite Event Traces Class 3 70 6 5 3 GPS Class 4 76 6 5 4 Receive Message Class 5 77 APPENDIX A Supported AT Commands 79 APPENDIX B To Mobile Messages 80 B 1 reset MIN 68 80 B 2 ...

Page 6: ...IDP 100 Modem Series Developer Guide T203 Version 04 vi SkyWave Proprietary Documentation Version 91 Acronyms Glossary 92 Index 93 ...

Page 7: ...rs 27 Table 12 Extended Command Formats 42 Table 13 Extended AT Commands 43 Table 14 SkyWave Proprietary Extended Commands 43 Table 15 Response Result Codes 64 Table 16 Common Trace Log Information 66 Table 17 Trace Class and Subclasses 67 Table 18 Trace Data 67 Table 19 Reset Trace Record Class 2 Subclass 1 68 Table 20 Low Power Trace Record Class 2 Subclass 2 69 Table 21 Satellite General Status...

Page 8: ...i SkyWave Proprietary Table 31 GPS Status Trace Record Class 4 Subclass 2 76 Table 32 Receive Message Trace Record Class 5 Subclass 1 77 Table 33 Transmit Message Trace Record Class 5 Subclass 2 77 Table 34 Transmit Message Trace Record Class 5 Subclass 3 77 ...

Page 9: ... 3 5 4 7 and 5 4 8 Added new to mobile setSleepSchedule message Table 5 and Appendix B 2 Added new from mobile sleepSchedule message Table 6 and Appendix C 3 Added low power to Trace Class and Subclass Table 17 Added a new Low Power Trace Record table Class 2 Subclass 2 Table 20 Added low power to the modemRegistration message Appendix C 1 Additional Updates New UTC command to display UTC date and...

Page 10: ...riod To the maximum extent permitted by applicable law SkyWave s total liability for damages of any kind whether based on breach of contract tort including negligence product liability incidental special consequential indirect or similar damages with product application and usages will be limited to an amount equal to the product s original price paid by the Purchaser to SkyWave and this limitatio...

Page 11: ...ommands are based on the ITU T Recommendation V 250 In addition to an AT command interface the modems provide a trace log interface for provisioning and diagnostics This document describes the IDP modem s serial command interfaces that allow developers to build host applications to send and receive IsatData Pro messages This document is also applicable to developers who are using the IDP 600 serie...

Page 12: ...IDP 100 Modem Series Developer Guide T203 Version 04 2 SkyWave Proprietary THIS PAGE INTENTIONALLY LEFT BLANK ...

Page 13: ...ating in the current region it also has the traffic channel information In this case the modem tunes directly to the traffic channel If the modem had not been previously powered in the current region it may first need to get information from the bulletin board channel More information on the bulletin board and how it is used is found in N200 2 1 3 Modem Registration Message On a power up or reset ...

Page 14: ...is sending or receiving The modem only samples the adjacent beams when it knows it is not receiving a message and when it has no messages to transmit 2 1 5 Blockage When a modem can no longer acquire the traffic channel it does not know if the traffic channel has changed or if the satellite signal is blocked Note The modem attempts to acquire the most recent beam Failing that it periodically scans...

Page 15: ...onal messages At this point the message is deleted to make space for a new message A to mobile message can be repeatedly retrieved until it is overwritten 2 2 1 1 Rx Completed The host only knows about messages that have completed and gone to the Completed state The host is not notified when a to mobile message fails Rx Completed Rx Retrieved Message Unavailable AT Command Read Message To Mobile M...

Page 16: ...tered on the network there are a number of messages already in progress sending state or the modem is not receiving a valid satellite signal Once the modem starts the transmission the modem automatically changes the message s state to Tx Sending when it starts transmitting the message When a message is in the Tx Sending state it cannot be deleted Once the message transmission is complete the state...

Page 17: ...sage name is unique If a new message is submitted with the same name as a stored message the modem rejects the new message The host can use the outgoing message name to reference the message and either check the message status or delete the message before it starts transmission The outgoing message name is not transmitted to the Gateway As per Figure 3 once the modem starts to send a message the I...

Page 18: ...ending on its length and number of message retries If the host wants to ensure a priority message transmission it is recommended to use priority levels appropriately 2 3 2 To Mobile Messages Figure 5 describes the message flow for a to mobile message Like the from mobile messages to mobile messages are sent as a sequence of message fragments The IDP modem creates an incoming message name based on ...

Page 19: ...oes not propagate throughout the file system The file system also ensures that single flash memory locations are not continually overwritten The allocation of files from flash memory storage and the individual flash memory pages are written using a wear leveling technique to maximize the 100 000 write cycle life of each flash memory page From the user perspective the file system is transparent the...

Page 20: ... 5 years Table 1 when the modem sends or receives up to 1 MB of data a month The number of writes is calculated from the maximum manufacturer s flash writes per sector i e 100 000 times the number of message partitions Table 1 Maximum Flash Size Extra Large Message 5250 bytes Large Message 1250 bytes Medium Message 250 Bytes Number Writes 500 000 800 000 1 600 000 Writes per month assume 5 year li...

Page 21: ...own and stored in non volatile memory These S registers are stored files in the serial flash memory On power up and reset the non volatile S registers from the serial flash are automatically loaded into the modem AT commands can be used to temporary modify the current active S registers An AT command is provided that can copy the current active S registers into flash storage If an S register file ...

Page 22: ...ion is set it is necessary to confirm that the trigger condition was not set directly prior For example if the event notification condition is set to trigger the output the modem should first check if there is a new incoming message Table 2 Configurable Conditions Condition Trigger Condition Event Notification New incoming satellite messages modem reset new GPS position or transmit compete GPS Pos...

Page 23: ...g for a fix Once an AT command initiates a GPS fix the AT command cannot turn off the GPS The GPS remains on until one of the following occurs The modem gets a GPS fix A 3 minute timeout if the wait time is shorter than 3 minutes The modem reaches the wait time as specified if the wait time is longer than 3 minutes 2 7 1 3 Over the Air Request A GPS fix can be initiated by a modem message that req...

Page 24: ... allows simultaneous GPS and message transmission providing the GPS is able to update its ephemeris data at least every four hours 2 8 Broadcast Messages A broadcast message is a message that is sent to a broadcast ID that is programmed into multiple modems Each modem can have up to 16 different broadcast IDs The OEM Integrator is responsible to configure the set of beams where the broadcast messa...

Page 25: ...Decimal Modem 0x00 0x0F 0 15 Terminal Core Services 0x10 0x7F 16 127 User Services 0x80 0xFF 128 255 The second byte of a message is the MIN The MIN is defined based on the SIN Only MIN for the modem message is relevant as the modem passes through the terminal core services and user services messages 3 2 1 Modem Messages The modem directly initiates and responds to all incoming modem messages Mode...

Page 26: ...IN MIN Description modemRegistration 0 0 Response include the modem s configuration and reset cause protocolError 0 2 Modem error cause sleepSchedule 0 70 Sent in response to change in sleep schedule position 0 72 Sent in response to a position request configuration 0 97 Same data as the modem registration message pingResponse 0 112 Echo of the response pingRequest 0 113 Echo of the response testM...

Page 27: ...uence Ctrl B Ctrl B is received After reset the modem enters one of the configured operating modes By default the modem enters AT command mode However the user can configure the startup mode to use any startup mode Trace mode exits to AT command mode when Enter is pressed 4 1 1 Baud Rate On reset the modem defaults to following serial port settings Rate 9600 bits s Data bits 8 Stop bits 1 Parity n...

Page 28: ...IDP 100 Modem Series Developer Guide T203 Version 04 18 SkyWave Proprietary THIS PAGE INTENTIONALLY LEFT BLANK ...

Page 29: ...al element The actual element appears on the command line rather than the angle brackets Indicates optional items Brackets themselves do not appear in the command line Indicates or E g data length indicates that one of data or length must be specified The examples in this document intentionally omit cr and lf 5 1 2 Command Rules The IDP 100 series modems follow the basic AT command rules below At ...

Page 30: ... line can be edited with the command line editing character defined in register S5 default 8 ASCII backspace The IDP modem first checks characters from the host to see if they match the termination character register S3 and then the editing character register S5 before checking for other characters This ensures that these characters are properly recognized even if they are set to values that the I...

Page 31: ...MM IsatData Pro Modem cr lf cr lf OK cr lf On a serial interface the dialogue would appear as follows AT i GMM SkyWave Mobile Communications GMM IsatData Pro Modem OK 5 1 3 5 Error Detection The integrity of AT command lines and responses can be ensured via Cyclic Redundancy Checks CRC When error detection is enabled the IDP modem requires a CRC sequence at the end of each AT command line to allow...

Page 32: ...e response with CRC sequence to ATS5 2FBD cr is cr lf 008 cr lf cr lf OK cr lf DC04 cr lf The CRC used is the CRC 16 CCITT with initial value 0xFFFF Error detection is enabled or disabled via the CRC command The following exemplifies CRC sequences associated with AT command lines denoted by bold and corresponding responses using the default value as the CRC prefix character ATI FD97 SkyWave Mobile...

Page 33: ...a single character or the character followed by an optional single character The basic AT commands supported are described in Table 9 Table 9 Basic Commands Supported Command Description Parameter E Echo value I Request Identification Information value Q Quiet value S S Registers V Verbose value Z Load Current Configuration with NVM Stored Values value F Load Current Configuration with Factory Def...

Page 34: ... Description Quiet2 mode suppress Result Codes Parameters None 0 Disabled 1 Enabled Information Response 5 3 4 V Verbose Description Verbose2 setting ResultCode numeric textual Parameters None 0 Disabled 1 Enabled Information Response 5 3 5 Z Load Saved Values Description Load current configuration with stored values Parameters None 0 0 5 3 6 F Load with Factory Default Values Description Load cur...

Page 35: ...configuration Configuration includes all the modem s S registers Parameters None 0 0 Information Response 5 3 9 Null Command Description Null command Parameters None Information Response 5 3 10 A Repeat Last Command Description Repeat last command The modem immediately executes the body of the preceding command line when it receives the prefix A or a This command is issued without the leading AT o...

Page 36: ...eference write or read command e g AT 8 value S registers are used to configure various AT command related values and other non AT command related values 5 4 2 S Register Types Different sizes of S registers exist S registers can be 1 8 16 or 32 bits in size and can contain unsigned or signed values S registers can be read write or read only There are two types of S registers They are used to Stor...

Page 37: ...C 1 Y Y 0 1 0 S64 Prefix character of CRC sequence 8 N Y 255 42 S80 Last error code 8 Y N 0 S81 Most recent result code 8 Y N 0 S85 Temperature signed 16 Y N S88 Event Notification Control 8 N Y 0 255 0 S89 Event Notification Status 8 N N S90 Capture Trace Define Class 8 N Y 0 7 0 S91 Capture Trace Define Subclass 8 N Y 0 31 0 S92 Capture Trace Define Initiate 1 N N S93 Captured Trace Property Dat...

Page 38: ...tary 5 4 4 S3 Command Line Terminator Description Configure the command line termination character Syntax ATS3 terminator See Table 10 for other command formats Parameters A decimal number ranging from 1 to 127 Information Response Syntax None Result Codes OK Success ERROR ...

Page 39: ...ers A decimal number ranging from 0 to 127 Note When set to 0 no response formatting characters are generated Information Response Syntax None Result Codes OK Success ERROR 5 4 6 S5 Command Line Editing Character Description Configure the command line editing character Syntax ATS5 editingchar See Table 10 for other command formats Parameters A decimal number ranging from 0 to 127 Information Respo...

Page 40: ...obile battery operated terminal 3 Fixed position battery operated terminal 4 9 Reserved Information Response Syntax None Result Codes OK Success ERROR 5 4 8 S51 Wake up Interval Description Set the wake up interval for a terminal Syntax ATS51 wakeupinterval See Table 10 for other command formats Parameters 0 5 second receives 1 2 Reserved 3 3 minute receives 4 10 minute receives 5 30 minute receiv...

Page 41: ...setting as configured by the ATE command Syntax ATS60 Information Response Syntax echoSetting 0 Disabled 1 Enabled Result Codes OK Success 5 4 10 S61 Quiet Setting Description Quiet setting as configured by the ATQ command Syntax ATS61 Information Response Syntax quietSetting 0 Disabled 1 Enabled Result Codes OK Success ...

Page 42: ... as configured by the ATV command Syntax ATS62 Information Response Syntax verboseSetting 0 Disabled 1 Enabled Result Codes OK Success 5 4 12 S63 CRC Setting Description Cyclic Redundancy Check setting as configured by the CRC command Syntax ATS63 Information Response Syntax crcSetting 0 Disabled 1 Enabled Result Codes OK Success ...

Page 43: ...he CRC command Syntax ATS64 crcPrefix See Table 10 for other command formats Parameters A decimal number ranging from 0 to 255 Information Response Syntax None Result Codes OK Success ERROR 5 4 14 S80 Last Error Code Description Returns the last error code Syntax ATS80 Information Response Syntax Returns the last error code refer to Table 15 that was generated by an AT command Result Codes OK Succ...

Page 44: ...last AT command refer to Table 15 The code is either OK or an error reason Result Codes OK Success ERROR 5 4 16 S85 Internal Temperature Description This command reports the modem s internal temperature Syntax ATS85 Information Response Syntax temp Parameters A signed decimal number in tenths of degrees Celsius Result Codes OK Success ERROR Example Value returned corresponding to a temperature of ...

Page 45: ...ble 10 for other command formats Information Response Syntax eventBitMap Parameters An unsigned number of Boolean flags 0 false 1 true if condition Bit 00 New GPS fix Bit 01 New message received Bit 02 Transmit completed either success or failure Bit 03 Modem registered on network Bit 04 Modem reset Bits 05 07 Reserved Result Codes OK Success ERROR Example Enable assertion of Event Notification on...

Page 46: ... read or written all status conditions are automatically cleared Syntax ATS89 See Table 10 for other command formats Parameters None Information Response Syntax eventBitMap Parameters Bit 00 New GPS fix Bit 01 New Message Received Bit 02 Transmit completed either success or failure Bit 03 Modem registered on network Bit 04 Modem reset Bits 05 07 Reserved Result Codes OK Success ERROR Example Modem...

Page 47: ...e Syntax None Result Codes OK Success ERROR Example The trace tables are searched for a satellite status general event Class 3 Subclass 1 The OK response indicates that a trace record was found and moved to the capture record ATS90 3 S91 1 S92 1 OK The following command attempts to capture a trace record for a satellite event The ERROR response indicates that there is no matching trace record in t...

Page 48: ...ponse Syntax size Parameters A decimal number of size 0 to 24 Result Codes OK Success ERROR 5 4 21 S94 Captured Record Properties Data Sign Description This command returns a 32 bit value that contains a bitmap to identify if each data record in the capture record is signed or unsigned S93 reports the data size and the number of valid bits reported by S94 The first bit bit 00 corresponds to the fi...

Page 49: ...4 bit decimal value Result Codes OK Success ERROR 5 4 23 S96 Captured Record Properties Timestamp Description This command returns the timestamp for the event The timestamp does not include the day month or year Syntax ATS96 Information Response Syntax timestamp Parameters A decimal number containing UTC hour minute and second Bits 00 07 Seconds 0 59 Bits 08 15 Minute 0 59 Bits 16 22 Hour 0 23 Bit...

Page 50: ...ss A decimal number identifying the class of the trace record captured It is same as value defined by S90 subclass A decimal number identifying the subclass trace record captured It is same value as defined by S91 Result Codes OK Success ERROR 5 4 25 S99 Captured Trace Properties Severity Level Description This command returns the severity level assigned to the captured trace record Syntax ATS99 R...

Page 51: ...many data values in the command set are valid The first data value is in S register 100 Some of the data register can be signed values The bitmap in S register 94 must be queried to determine the sign of a particular data index Syntax ATS100 S101 S102 S123 Response Syntax dataValue100 A decimal number It can be signed or unsigned dataValue101 A decimal number It can be signed or unsigned dataValue...

Page 52: ...91 1 s92 1 s109 s110 0000000002 0000000002 OK To repeat this command the class and subclass S registers are already configured and can be omitted from the AT command at s92 1 s109 s110 0000000001 0000000001 OK Repeat the previous command a 0000000000 0000000000 OK 5 5 Extended Commands Extended commands are prefixed by a plus sign The supported formats of extended AT commands are shown in Table 12...

Page 53: ...ve proprietary extended commands are prefixed with The various formats of SkyWave proprietary extended commands are similar to the extended command formats listed in Table 12 Note that in addition to the command syntax shown below the Test syntax of command can be used to query the support of the command and its parameter ranges Table 14 SkyWave Proprietary Extended Commands Command Description Pa...

Page 54: ...ange becomes non volatile persists reset or power cycle when S registers are stored via the W command Syntax CRC value Parameters value 0 Disable error detection 1 Enable error detection Example AT CRC 1 AT CRC 0 BBEB at crc 0 1749 Information Response Syntax None Result Codes OK Success ERROR Invalid parameter Syntax CRC Information Response Syntax CRC 0 Error detection disabled CRC 1 Error detec...

Page 55: ...formation Response Syntax EVNT dataCount signedBitmask NetworkID timestamp class subclass priority data0 data1 dataN Parameters dataCount Number of event data values corresponding to specified event class subclasses signedBitmask 0 Unsigned 1 Signed Bit 0 corresponds to data0 bit N corresponds to dataN NetworkID First eight characters of the modem s Mobile ID timestamp Bits 00 07 Seconds 0 59 Bits...

Page 56: ...ues are present for the corresponding class subclass signedBitmask indicates whether the data longword should be interpreted as an unsigned or signed value Result Codes OK Event log information successfully obtained event log corresponding to the specified class and subclass exists ERROR Invalid class and or subclass specified or event log corresponding to the specified class and subclass does not...

Page 57: ...its the AT command processor and starts a different proprietary serial protocol Syntax EXIT value Parameters Number indicates what protocol to invoke upon exit of AT command mode value 1 AT command mode 2 4 Reserved 5 Streaming trace log interface Information Response Syntax None Result Codes OK Success ERROR Invalid parameter ...

Page 58: ... no older than staleSecs is unavailable range 1 600 GGA Request GGA NMEA sentence RMC Request RMC NMEA sentence Note GGA and or RMC must be specified Information Response Syntax GPS GGA NMEA Sentence if requested RMC NMEA Sentence if requested Example GPS GPGGA 182008 00 4520 2015 N 07554 2787 W 1 80 8 M 10 GPRMC 182008 00 A 4520 2015 N 07554 2787 W 000 019 357 43 041110 39 Result Codes OK GPS inf...

Page 59: ...command mode automatically resumes once the data exchange is complete The maximum length of a to mobile message is 10 000 bytes including the SIN byte and the MIN byte Syntax MGFG fwdMsgName dataFormat Parameters fwdMsgName The to mobile message name reported by MGFS or MGFN dataFormat 0 Transfer mode to be entered after information response to transfer message data and AT command mode automatical...

Page 60: ...ce the data transfer is complete 1 Text format message data bounded by double quote characters included in information response 2 ASCII Hex format message data included in information response 3 Base64 MIME encoded message data included in information response data Message data formatted as specified by dataFormat See above for details Example The examples below all represent identical message wit...

Page 61: ...IDP 100 Modem Series Developer Guide SkyWave Proprietary 51 T203 Version 04 Result Codes OK To mobile message corresponding to fwdMsgName exists ERROR Otherwise ...

Page 62: ...obile message from Rx Completed to Rx Retrieved This allows the message space to be reused for future messages without retrieving the message via the MGFG command Syntax MGFM fwdMsgName Parameters fwdMsgName The to mobile name as reported by MGFS or MGFN Information Response Syntax None Result Codes OK To mobile message corresponding to fwdMsgName exists ERROR Otherwise ...

Page 63: ... number An empty string denotes all to mobile messages If a to mobile message is received with the same active message number and message sequence number as an existing message the existing message is deleted if its state is Rx Retrieved and the new message is saved with the name of the deleted message If the existing message has not been read state is Completed the new message is saved with a nam...

Page 64: ...able but not yet read length Total message length in bytes including SIN byte and MIN byte bytesRxd Number of bytes received including SIN byte and MIN byte Note cr lf are used to delimit multiple messages Result Codes OK If all to mobile messages were specified via MGFN or MGFN even if no Completed to mobile messages exists or a match was found when a specific msgName was specified via MGFN fwdMs...

Page 65: ...le messages If a to mobile message is received with the same active message number and message sequence number as an existing message the existing message is deleted if its state is Rx Retrieved and the new message is saved with the name of the deleted message If the existing message has not been read state is Completed the new message is saved with a name using the format FMaa ssx where x is a ch...

Page 66: ...t yet read 3 Rx Retrieved Message has been retrieved read via MGFG and message data is still available length Total message length in bytes including SIN byte and MIN byte bytesRxd The number of bytes received including SIN byte and MIN byte Note cr lf are used to delimit multiple messages Result Codes OK If all to mobile messages were specified via MGFS or MGFS even if no to mobile messages exist...

Page 67: ...le Message Cancel Description This command cancels a specific from mobile message with a state of Tx Ready Syntax MGRC msgName Parameters msgName Message name specified in the corresponding MGRT command Information Response Syntax None Result Codes OK Message successfully cancelled ERROR Otherwise ...

Page 68: ...e MGRT command Syntax MGRS msgName Parameters msgName From mobile message name specified in the corresponding MGRT command If empty string or omitted all current from mobile messages are requested Information Response Syntax MGRS msgName msgNum priority sin state length bytesAcknowleged or MGRS msgName1 msgNum priority sin state length bytesAcknowleged msgName2 msgNum priority sin state length byt...

Page 69: ...ul 7 Tx Failed Transmission failed length Total message length in bytes including SIN byte and MIN byte bytesAcknowleged The number of message bytes acknowledged by the gateway including SIN byte and MIN byte Result Codes OK If all from mobile messages were specified via MGRS or MGRS even if no from mobile messages exist or a match was found when a specific msgName was specified via MGRS msgName E...

Page 70: ...as 5C The double quote character used as the beginning and ending string delimiter shall be represented within a string constant as 22 When transfer mode is specified length is specified instead of data and transfer mode is entered after the information response to exchange the data and AT command mode automatically resumes once the data exchange is complete When an optional MIN is specified it is...

Page 71: ...mitted for transfer mode The data field can be a maximum of 6398 bytes if the optional MIN is specified or 6399 bytes if the optional MIN is not specified length Number of valid data bytes to be exchanged via transfer mode note that 128 byte blocks are used and that data beyond msgLen bytes in the last block are discarded Information Response Syntax None Result Codes OK Message successfully added ...

Page 72: ...IDP 100 Modem Series Developer Guide T203 Version 04 62 SkyWave Proprietary Base64 Example MGRT TestMsg 2 128 0 3 SGVsbG8h Block mode Example MGRT TestMsg 2 128 0 0 6 then send Hello Via block mode ...

Page 73: ...ters in table format Syntax SREG Parameters Information Response Syntax Multi line table of all S registers Result Codes OK Success 5 6 13 UTC Display UTC Date and Time Description This command is used to obtain the current UTC date and time Syntax UTC Parameters Information Response Syntax UTC yyyy mm dd hh mm ss Result Codes OK Success ERROR UTC unavailable Example AT UTC UTC 2011 10 27 18 20 25...

Page 74: ...ength exceeded parameter value invalid or other problem with processing the command line 1005 Invalid command line CRC sequence 101 5 Unknown command encountered in command line 102 5 Invalid command parameter encountered 103 5 Message length exceeds permitted size for specified data Format 104 5 Transfer mode error occurred 105 5 System error 106 5 Insufficient resources 107 5 Message name alread...

Page 75: ... in a trace table The key events can be grouped in the following classes Hardware Faults System Events Satellite Events GPS Events Message Events 6 3 AT Command Access The AT commands have access to the trace log file Using S registers the AT command can select a specific trace log class that it wants to read Once the record type is selected the modem copies the newest matching record into a trace...

Page 76: ...ce class subclass 4 Captured trace signed bitmask 0 Unsigned 1 Signed Bit 00 corresponds to S100 bit 23 corresponds to S123 4 Captured Network ID The first characters of the modem s Mobile ID 4 Captured Trace timestamp Bits 00 07 Second 0 59 Bits 08 15 Minute 0 59 Bits 16 22 Hour 0 23 Bits 23 31 Reserved 4 Captured Trace class See Table 17 1 Captured Trace subclass See Table 17 1 Captured Trace Se...

Page 77: ... metrics Minute 22 Transmit metrics Hour 23 Transmit metrics Day 4 GPS Event 1 Fix statistics when a fix is received by the GPS server 2 Status when GPS server changes its state 5 Message Event 1 Receive message statistics 2 Transmit message statistics 3 Transmit message utilization 6 4 2 Class Data A trace record consists of a block of 24 32 bit data entries Not all the data indices in the class ...

Page 78: ...Minor Bits 08 15 Major Bits 16 31 Reserved 2 RelVer Release version Bits 00 07 Minor Bits 08 15 Major Bits 16 31 Reserved 3 BootVer Micro controller boot version Bits 00 07 Minor Bits 08 15 Major Bits 16 31 Reserved 4 ApplVer Micro controller application version Bits 00 07 Minor Bits 08 15 Major Bits 16 31 Reserved 5 DspBootVer DSP boot version Bits 00 07 Minor Bits 08 15 Major Bits 16 31 Reserved...

Page 79: ...eserved 2 Reserved 3 3 min 4 10 min 5 30 min 6 60 min 3 Current Power Profile Configured power profile 0 Mobile powered 1 Fixed powered 2 Mobile battery 3 Fixed battery 4 Rx Wake up Time Operating system clock time for scheduled receive wake up 0 if none 5 Beam Search Wake up Time Operating system clock time for scheduled beam search 6 GPS Wake up Time Operating system clock time for scheduled GPS...

Page 80: ...bs Number of outstanding transmit packets 12 Transmit State Transmit State 0 Active 1 Suspending 2 Suspended for GPS management or required GPS fix 13 Number of Active Receive Messages Number of messages being received 14 Averaging Window Size of main adjacent beam samples window Used for beam switching 15 Averaging Count Current number of main adjacent beam samples Used for beam switching 16 C N ...

Page 81: ... board 10 Active 23 Beam Search State Beam search state 0 Idle 1 Search for any traffic channel 2 Search for the last acquired traffic channel 3 Reserved 4 Search for another traffic channel ID 5 Search for a global traffic channel 6 Delay the traffic channel search 7 Delay the last acquired traffic channel search 8 Search for a traffic channel better than the current one ...

Page 82: ... packets or acknowledgments 8 Modem Return Code Modem return code 9 Message Number Message number 10 Packet Type Packet type 0 Acknowledgement 1 Transmit data half second coding rate 0P33 2 Transmit data half second coding rate 0P50 3 Transmit data half second coding rate 0P75 4 Transmit data half second coding rate 0P95 5 Transmit data one second coding rate 0P33 6 Transmit data one second coding...

Page 83: ...SIP 10 BHP ID Beam hop pattern ID from SIP 11 SF Offset Subframe offset from SIP 12 Freq Offset Frequency offset 100 13 Time Offset Time offset in mS 14 UW Strength Signal strength of unique word 15 UW C No C No of unique word 100 16 UW Berr Bit error in unique word 17 UW Bits Number of bits in unique word Table 25 Satellite Geographic Adjust Class 3 Subclass 5 Data Index Name Description 0 VC ID ...

Page 84: ...cess Successful receive 1 Subframe Number Subframe number of this receive 2 Beam Number Beam number 3 to 8 Reserved Reserved 9 Number Packet Symbols Number of packet symbols in this receive 10 Number Packet Errors Number of packet errors 11 C N C N x100 12 Number Packets Detected Number of packets decoded The Rx metrics are defined below Rx metrics are reported as accumulated totals over the last ...

Page 85: ...s 23 Table 29 Tx Metrics Trace Record Class 3 Subclass 20 21 and 22 Data Index Name Description 0 Tx Packets Sent Acknowledgements Number of packets of each type 1 Tx Packets Sent type 1 half second 33 2 Tx Packets Sent type 2 half second 5 3 Tx Packets Sent type 3 half second 75 4 Tx Packets Sent type 4 half second 94 5 Tx Packets Sent type 5 one second 33 6 Tx Packets Sent type 6 one second 5 7 ...

Page 86: ...st fix ms 5 Current Fix Elapsed Time Elapsed time since start of session seconds 6 to 23 Reserved Reserved Table 31 GPS Status Trace Record Class 4 Subclass 2 Data Index Name Description 0 to 5 Reserved Reserved 6 Current Fix Valid Valid fix 0 1 7 Current Fix Age Current fix age seconds 8 Current Fix Type Current fix type 1 2D 2 3D 9 Current Fix Elapsed Time Current fix elapsed time Ms 10 Current ...

Page 87: ...essage Trace Record Class 5 Subclass 3 Data Index Name Description 0 Packets Formatted rate 1 Number of unique packets submitted for rate 1 5 s 33 1 Packets Transmitted rate 1 Number of packets transmitted including retries 2 Flags rate 1 Bit 00 Rate permitted in current location Bit 01 Rate disabled due to excessive errors 3 Packets Formatted rate 2 As above for rate 2 5 s 50 4 Packets Transmitte...

Page 88: ...ame Description 19 Packets Transmitted rate 7 As above for rate 2 5 s 50 20 Flags rate 7 Reserved 21 Utilization Disable Threshold Error threshold for disabling a rate number sent number formatted 100 22 Utilization Age Time Duration in minutes after which the error counts are divided by 2 ...

Page 89: ...omplete capabilities list GMI Request manufacturer identification GMM Request model identification GMR Request revision identification GSN Request product serial number identification Mobile ID IPR Baud rate rate CRC Error detection value EXIT Exit command value GPS Get GPS information staleSecs waitSecs GGA RMC MGFS To mobile message state fwdMsgName MGFG To mobile message get fwdMsgName dataForm...

Page 90: ...erminal board Application messages can be sent over the air to the terminal to cause other types of terminal resets Syntax reset Fields ResetType 8 bits Details Field Description Value ResetType Indicates the type of reset and whether queued from mobile message are kept or flushed 0 modem preserve Modem software reset with messages preserved note this resets both the DSP and microcontroller proces...

Page 91: ...ve to mobile messages 0 Off terminal receives every 5 seconds 1 Reserved 2 Reserved 3 3 minutes 4 10 minutes 5 30 minutes 6 60 minutes 0 6 B 3 setTxMute MIN 71 Definition This message controls an individual mobile s transmit capability If muteFlag is set to 1 mute the transmission control level is only allows registration beam login and responses to to mobile messages If muteFlag is set to 0 unmut...

Page 92: ...on This message requests configuration information from the mobile device Syntax getConfiguration Fields No fields B 6 pingRequest MIN 112 Definition This message is posted at the IsatData Pro Gateway Web Service IGWS interface and sent to the mobile device The mobile responds with pingResponse Syntax pingRequest Fields RequestTime 16 bits Details Field Description Value RequestTime Time the reque...

Page 93: ...escription Value RequestTime Time the original request was sent seconds since midnight UTC Copied by the Gateway from the pingRequest message 0 86 399 ResponseTime Time this response was created by the Gateway seconds since midnight UTC 0 86 399 B 8 getBroadcastIDs MIN 115 Definition This message queries mobile device broadcast IDs The modem responds with a list of its broadcast IDs The mobile res...

Page 94: ...s failed Syntax modemRegistration Fields HardwareVersion 16 bits SoftwareVersion 16 bits Product 8 bits WakeupInterval 8 bits LastResetReason 8 bits Traffic channel 12 bits Beam 4 bits VAIN 16 bits Reserved 2 bits OperatorTxState 3 bits UserTxState 3 bits BroadcastIDCount 8 bits Details Field Description Value HardwareVersion Identifies the mobile s hardware version SoftwareVersion Identifies the ...

Page 95: ... are for SkyWave use BroadcastIDCount Number of active broadcast IDs provisioned in this modem 0 16 C 2 protocolError MIN 2 Definition This message is sent when the modem encounters an error that prevents successful message delivery Syntax protocolError Fields Reserved 5 bits MessageReference 8 bits ErrorCode 8 bits ErrorInfo 8 bits Details Field Description Value MessageReference Provides the ref...

Page 96: ...ed 5 bits Details Field Description Value WakeupPeriod Length of time the modem sleeps between attempts to receive to mobile messages 0 Off terminal receives every 5 seconds 1 Reserved 2 Reserved 3 3 minutes 4 10 minutes 5 30 minutes 6 60 minutes 0 6 MobileInitiated Flag which indicates that this request was initiated from the modem AT interface Set to 1 if request was terminal initiated 0 1 Messa...

Page 97: ...e in 0 001 minutes 2 s complement Longitude Longitude in 0 001 minutes 2 s complement Altitude Altitude in meters 2 s complement Up to 16 380 m Speed Speed in km hour 0 255 Heading Heading in 2º increments 0 179 DayOfMonth Day of month this GPS fix taken 1 31 MinuteOfDay Minutes of day this GPS fix taken 0 1439 0 Midnight GPS time C 5 configuration MIN 97 Definition The configuration reply is sent...

Page 98: ...riginal request was sent seconds since midnight UTC Copied by the modem for the pingRequest message ResponseTime Time this reply was created by the modem seconds since midnight UTC 0 86 399 C 7 pingRequest MIN 113 Definition This message is posted at the modem AT interface and sent to the Gateway The Gateway sends a response to this message Syntax pingRequest Fields RequestTime 16 bits Details Fie...

Page 99: ...nterface starts and stops the process Syntax testMessage Fields Text variable size Details Field Description Value Text A variable length byte array containing ASCII text The length is determined by the message length C 9 broadcastIDs MIN 115 Definition This message is the response to the getBroadcastIDs message The response contains the entire list of 16 broadcast IDs IDs of 0 are null no broadca...

Page 100: ...IDP 100 Modem Series Developer Guide T203 Version 04 90 SkyWave Proprietary THIS PAGE INTENTIONALLY LEFT BLANK ...

Page 101: ...ble Class 5 Subclass 3 New UTC command to display UTC date and time Added new parameter for Request ID New extended command Event Log Get New Response Result Code added Added DSP RomDB Version to Class 2 Subclass 1 Updated satellite control state and beam search state values and Renamed the to mobile and from mobile messages throughout the document 01 Aug 2011 Official customer release 10 Feb 2011...

Page 102: ...uter which communicates with data communications equipment DCE IDP 100 series The family of IsatData Pro mobile DCE modem devices ITU T International Telecommunication Union Telecommunication Standardization Sector Network ID The first eight characters of a mobile ID or broadcast ID Sometimes referred to as the Link ID MIN message identification number Each SIN has a suite of possible messages ide...

Page 103: ...ID I 24 store configuration to NVM W 25 verbose V 24 baud rate 17 baud rate IPR 43 boot loader 17 bulletin board 3 comma dial modifier time S8 27 command line editing character S5 27 command line termination S3 27 connection complete timeout S7 27 CRC command setting S63 27 Customer Support ii display configurations V 25 display UTC UTC 63 E 23 echo E 23 S60 27 error detection CRC 44 45 event logs...

Page 104: ...ID GSN 43 model ID GMM 43 revision ID GMR 43 reset out 12 response formatting character S4 27 S0 27 S10 27 S100 S123 27 41 S3 27 S4 27 S5 27 S50 27 S51 27 S6 27 S60 27 S61 27 S62 27 S63 27 S64 27 S7 27 S8 27 S80 27 S81 27 S85 27 S88 27 S89 27 S90 27 S91 27 S92 27 S94 27 S95 27 S96 27 S97 27 S98 27 S99 27 serial modes boot loader 17 SkyWave specific extended commands error detection CRC 44 45 exit ...

Page 105: ...IDP 100 Modem Series Developer Guide SkyWave Proprietary 95 T203 Version 04 THIS PAGE INTENTIONALLY LEFT BLANK ...

Page 106: ...www SkyWave com ...

Search results

Summary of Contents for IDP 100 Series

Reviews:

Related manuals for IDP 100 Series

Brands by name

Popular brands

SkyWave IDP 100 Series, Developer'S Manual

Search results

Summary of Contents for IDP 100 Series

Reviews:

Related manuals for IDP 100 Series

Brands by name

Popular brands