SkyWave IDP 100 Series Manual de instrucciones

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

IDP 100 Modem Series - Developer Guide

T203, Version 04 ii © SkyWave Proprietary

Legal Notice

This documentation is owned by SkyWave Mobile Communications Inc. (SkyWave) and protected by

applicable copyright laws and international treaty provisions. Other copyrighted names used are the property

of their respective owners. Therefore, you must treat this documentation like any other copyrighted material.

You may not make the documentation, or copies thereof, available in any manner or form, or use, copy or

transfer any part, to anyone outside your company.

If you received this documentation by electronic transmission or download, by installation or use of the

documentation, you acknowledge that you have read and understand this license agreement and agree to be

bound by its terms and conditions.

This documentation is provided on an as-is basis without any warranty of any kind. You assume the entire

risk as to the results 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. Inmarsat is not

responsible for the operation and regulatory compliance of the products and services referred to in this

document that connect to the Inmarsat system.

SkyWave reserves the right to make changes to products and or specifications without notice.

From www.SkyWave.com login, and follow the link to the downloads section. The complete Software and

Documentation License Agreement is distributed as a part of the IDP Developer Toolkit.

Contact Information

SkyWave Mobile Communications Inc.

Online:

Website www.SkyWave.com

Online Documentation:

Login at support.skywave.com and follow the link to the downloads section

Customer Support by Email:

support@skywave.com

Customer Support by Telephone:

+1.613.836.2222

IDP 100 Modem Series - Developer Guide

TABLE OF CONTENTS

Legal Notice....................................................................................................................................ii

Contact Information......................................................................................................................ii

List of Figures..............................................................................................................................vii

List of Tables................................................................................................................................ vii

Preface........................................................................................................................................... ix

What's New?................................................................................................................................ ix

Purpose ........................................................................................................................................ ix

Audience...................................................................................................................................... ix

Notation ....................................................................................................................................... ix

Reference...................................................................................................................................... x

Limited Liability........................................................................................................................... x

1Introduction......................................................................................................................... 1

2Modem Overview................................................................................................................ 3

2.1 Satellite Operation.............................................................................................................. 3

2.1.1 Traffic Channel Acquisition ......................................................................................... 3

2.1.2 Acquisition Times......................................................................................................... 3

2.1.3 Modem Registration Message ...................................................................................... 3

2.1.4 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

2.7.1 GPS Request Sources.................................................................................................. 12

2.7.2 GPS Fix Type ............................................................................................................. 13

2.7.3 GPS Fix Times............................................................................................................ 13

2.7.4 Satellite Transmit Effects............................................................................................ 14

2.8 Broadcast Messages ......................................................................................................... 14

3Over-the-Air Interface...................................................................................................... 15

3.1 Message Lengths.............................................................................................................. 15

3.2 Message Types................................................................................................................. 15

3.2.1 Modem Messages ....................................................................................................... 15

IDP 100 Modem Series - Developer Guide

T203, Version 04 iv © SkyWave Proprietary

3.2.2 Terminal Core Services .............................................................................................. 16

3.2.3 User Services.............................................................................................................. 16

4Serial Modes...................................................................................................................... 17

4.1 Mode Switches................................................................................................................. 17

4.1.1 Baud Rate.................................................................................................................... 17

5AT Command Mode......................................................................................................... 19

5.1 Syntax Definition ............................................................................................................. 19

5.1.1 Conventions................................................................................................................ 19

5.1.2 Command Rules.......................................................................................................... 19

5.1.3 AT Command General Format ................................................................................... 19

5.2 Transfer Mode.................................................................................................................. 23

5.3 Basic Command Set ......................................................................................................... 23

5.3.1 E –Echo...................................................................................................................... 23

5.3.2 I –Request ID............................................................................................................. 24

5.3.3 Q –Quiet..................................................................................................................... 24

5.3.4 V –Verbose................................................................................................................ 24

5.3.5 Z –Load Saved Values............................................................................................... 24

5.3.6 &F –Load with Factory Default Values..................................................................... 24

5.3.7 &V –Display Configurations..................................................................................... 25

5.3.8 &W –Save Configuration .......................................................................................... 25

5.3.9 Null Command............................................................................................................ 25

5.3.10 A/ –Repeat Last Command........................................................................................ 25

5.4 S Register Commands ...................................................................................................... 26

5.4.1 Command Format....................................................................................................... 26

5.4.2 S Register Types......................................................................................................... 26

5.4.3 S Register Definitions................................................................................................. 26

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 ................................................................................. 34

5.4.16 S85 –Internal Temperature ........................................................................................ 34

5.4.17 S88 –Event Notification Control ............................................................................... 35

5.4.18 S89 –Event Notification Assert Status....................................................................... 36

5.4.19 S90, S91, S92 –Capture Trace Define....................................................................... 37

5.4.20 S93 –Captured Record Properties - Length............................................................... 38

5.4.21 S94 –Captured Record Properties - Data Sign........................................................... 38

5.4.22 S95 –Captured Record Properties - Network ID ....................................................... 39

5.4.23 S96 –Captured Record Properties - Timestamp......................................................... 39

5.4.24 S97, S98 –Captured Trace Properties - Class/Subclass............................................. 40

5.4.25 S99 –Captured Trace Properties - Severity Level...................................................... 40

5.4.26 S100, S101, …S123 – Captured Trace Data - Index.................................................. 41

IDP 100 Modem Series - Developer Guide

5.5 Extended Commands........................................................................................................ 42

5.6 SkyWave-Proprietary Extended Commands.................................................................... 43

5.6.1 %CRC –Error Detection............................................................................................ 44

5.6.2 %EVNT –Event Log Get........................................................................................... 45

5.6.3 %EXIT –Exit Command............................................................................................ 47

5.6.4 %GPS –Get GPS Information.................................................................................... 48

5.6.5 %MGFG –To-Mobile Message Get........................................................................... 49

5.6.6 %MGFM –To-Mobile Message Rx Retrieved .......................................................... 52

5.6.7 %MGFN –To-Mobile Message New......................................................................... 53

5.6.8 %MGFS –To-Mobile Message State......................................................................... 55

5.6.9 %MGRC –From-Mobile Message Cancel................................................................. 57

5.6.10 %MGRS –From-Mobile Message State .................................................................... 58

5.6.11 %MGRT –From-Mobile Message Send.................................................................... 60

5.6.12 %SREG –View all S Registers.................................................................................. 63

5.6.13 %UTC –Display UTC Date and Time....................................................................... 63

5.7 Error Result Codes ........................................................................................................... 64

6Trace Log Mode................................................................................................................ 65

6.1 Trace Log 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 setSleepSchedule (MIN 70).............................................................................................. 81

B.3 setTxMute (MIN 71) ........................................................................................................ 81

B.4 getPosition (MIN 72)........................................................................................................ 82

B.5 getConfiguration (MIN 97) .............................................................................................. 82

B.6 pingRequest (MIN 112).................................................................................................... 82

B.7 pingResponse (MIN 113)................................................................................................. 83

B.8 getBroadcastIDs (MIN 115)............................................................................................. 83

APPENDIX C From-Mobile Messages................................................................................... 84

C.1 modemRegistration (MIN 0)............................................................................................ 84

C.2 protocolError (MIN 2)...................................................................................................... 85

C.3 sleepSchedule (MIN 70)................................................................................................... 86

C.4 position (MIN 72)............................................................................................................. 87

C.5 configuration (MIN 97).................................................................................................... 87

C.6 pingResponse (MIN 112)................................................................................................. 88

C.7 pingRequest (MIN 113).................................................................................................... 88

C.8 testMessage (MIN 114).................................................................................................... 89

C.9 broadcastIDs (MIN 115) .................................................................................................. 89

IDP 100 Modem Series - Developer Guide

T203, Version 04 vi © SkyWave Proprietary

Documentation Version............................................................................................................... 91

Acronyms/Glossary..................................................................................................................... 92

Index… ......................................................................................................................................... 93

IDP 100 Modem Series - Developer Guide

List of Figures

Figure 1 Beam Switch................................................................................................................. 4

Figure 2 Message States.............................................................................................................. 5

Figure 3 From-Mobile AT Command Parameters...................................................................... 7

Figure 4 Priority Messages.......................................................................................................... 8

Figure 5 To-Mobile Message AT Command Parameters ........................................................... 9

Figure 6 Message Partitions...................................................................................................... 10

Figure 7 Modem General Purpose Outputs............................................................................... 12

Figure 8 Trace Log.................................................................................................................... 65

Figure 9 Trace Record Format.................................................................................................. 66

List of Tables

Table 1 Maximum Flash Size.................................................................................................. 10

Table 2 Configurable Conditions............................................................................................. 12

Table 3 Message Lengths......................................................................................................... 15

Table 4 Message Types............................................................................................................ 15

Table 5 To-Mobile Modem Messages..................................................................................... 16

Table 6 From-Mobile Modem Messages................................................................................. 16

Table 7 Effect of V Parameter on Response Formats.............................................................. 21

Table 8 AT Command Information Exchange......................................................................... 23

Table 9 Basic Commands Supported....................................................................................... 23

Table 10 S Register Command Format...................................................................................... 26

Table 11 S Registers.................................................................................................................. 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 Trace Record (Class 3, Subclass 1)...................................... 70

Table 22 Transmit Status Trace Record (Class 3, Subclass 2) .................................................. 72

Table 23 Satellite Acquire Trace Record (Class 3, Subclass 3)................................................. 72

Table 24 Satellite Beam Status Trace Record (Class 3, Subclass 4) ......................................... 73

Table 25 Satellite Geographic Adjust (Class 3, Subclass 5)...................................................... 73

Table 26 Satellite Event Log Data (Class 3, Subclass 6)........................................................... 74

Table 27 Rx Metrics Trace Record (Class 3, Subclass 16)........................................................ 74

Table 28 Rx Metrics Trace Record (Class 3, Subclass 17, 18 and 19)...................................... 74

Table 29 Tx Metrics Trace Record (Class 3, Subclass 20, 21 and 22)...................................... 75

Table 30 GPS Fix Statistics Trace Record (Class 4, Subclass 1)............................................... 76

IDP 100 Modem Series - Developer Guide

T203, Version 04 viii © 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

IDP 100 Modem Series - Developer Guide

Preface

Note: Refer to the SkyWave Customer Support website for any updates or a possible

Errata Sheet available after the release of this document. Always check the site

for the most current documentation releases.

What's New?

Changes since the last release of this document are listed below. The updates below

include new functionality for the low power firmware release 1.1.0.

Updated S50 Power Mode and S51 Wake-up Interval information to show that

they are non-volatile (Sections 5.4.3, 5.4.7 and 5.4.8)

Updated for Low Power Release 1.1.0

Added new S registers for low power: S50 Power Mode and S51 Wake-up

Interval (Sections 5.4.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 time (Section 5.6.13)

New Response Result Code added (Table 15)

Added DSP RomDB Version to Class 2, Subclass 1 (Table 19)

Minor updates throughout

Purpose

This document describes the behavior and interfaces of the IDP 100 series of modems.

The primary modem serial interface is the AT command interface implemented in the

modem.

Audience

This document is for technical readers. Familiarity with the Hayes command set is

advantageous.

Notation

This document is associated with modem firmware version 3.3 or higher.

IDP 100 Modem Series - Developer Guide

An OEM Integrator is a SkyWave customer who purchases an IDP 100 series modem for

integration into their own enclosure. In order to become an OEM Integrator certain

commercial criteria must be met. Contact your Account Executive for further details.

A forward message is a message sent to the mobile device from the gateway, while a

return message is one sent from the mobile device.

Reference

The content of the following documents may be useful in conjunction with this guide.

These SkyWave documents are available from the IDP Developer Toolkit or

support.skywave.com.

[N200] IsatData Pro Network Services

[T201] IDP 100 Modem Series Hardware Guide

Manuales populares de Módem de otras marcas

Davicom

Davicom DM562AP Manual de usuario

EpiValley

EpiValley TATA indicom SXC-1080 Manual de usuario

Zte

Zte WiMAX Manual de usuario

Intelimax

Intelimax MA-2060 Manual de usuario

SMC Networks

SMC Networks D3CM1604V Manual de uso y cuidado

Telstra

Telstra Wi-Fi 4G Advanced Pro X Manual de usuario

Thrane&Thrane

Thrane&Thrane imarsat EXPLORER 300 Manual de usuario

Samsung

Samsung AceLink SAM-335A Manual de usuario

Enfora

Enfora Enabler-G Guía de configuración rápida

iRZ

iRZ ATM2-232 Manual de usuario

Zhone

Zhone 6310 Manual de usuario

Paradyne

Paradyne Hotwire 7976 Manual de usuario

US Robotics

US Robotics 3453C Manual de usuario

MaxTech

MaxTech Plug & Play Internal Voice/FAX/Data/SVD... Manual de usuario

Zte

Zte MF823 Manual de usuario

Four-Faith

Four-Faith F1403 Manual de usuario

Sierra Wireless

Sierra Wireless AIRLINK MP595W Manual de usuario

Gemtek

Gemtek WiMAX WIXFBR-103 Manual de usuario