manualshive.com logo in svg

Novatel MT 3060 R, Command Reference Manual, Page: 110 / 330

Share
Download
Novatel MT 3060 R Command Reference Manual Download Page 110

- 98 -

AT$APIOPT

Enable API Optional Header Fields

<SendParam3>

0 = Disable sending of Parameter 3 data in the optional header

1 = Enable sending of Parameter 3 data in the optional header

Notes

When a message is formatted for transmission via the event engine (UDP, TCP,
SMS, or serial), we call the function to retrieve/increment the sequence number.
The sequence number is passed to the task that actually makes the decision
about what to do with the message. If the message is SMS or serial, the sequence
number doesn't actually get used in the end, but does get incremented.

To support the hex modem ID feature, each MDMID character must be a decimal
character between '0' and '9'. If the MDMID contains a character outside of this
range, the hex MDMID will be the NULL string. If all MDMID characters are
decimal characters, then the decimal MDMID is converted into the hexadecimal
equivalent value.

Examples

This example will disable the sending of the MDMID, enable the Msg Event Format
and enable the full Event Sequence Number.

AT$APIOPT=0,1,4

This example will disable the sending of the MDMID, enable the Msg Event
Format, enable the full Event Sequence Number, and enable sending of Parameter
3 data in the optional header

AT$APIOPT=0,1,4,0,0,0,0,1

This example will enable the sending of the MDMID and the least two significant
bytes of the Event Sequence Number. The state of the Enable Msg Event Format
will remain unchanged

AT$APIOPT=1,,2

This example will enable the sending of the MDMID and disable the Msg Event
Format. The state of the Event Seq Num will remain unchanged

AT$APIOPT=1,0

Hex Modem ID Examples:

AT$APIOPT=0,,,,,1

MDMID - "001036000211071"

{07}{07}{F1}{36}{6C}{B0}{7F}

Summary of Contents for MT 3060 R

Page 1: ...MT3060R AT144 MiFi Drive MT 3060 R Firmware V4 D4 Aux Processor V1 D5 Radio 10 3 Smart Agent 22 3 App 2 3 AT Command Reference Version 1 0 March 10 2015...

Page 2: ...epresentation with respect to the merchantability suitability functionality accuracy or completeness of any such New Materials The user of such New Materials assumes all risk known or unknown of such...

Page 3: ...retrieval system or transmitted in any form or by any means electronic mechanical photocopying recording or otherwise or for any purpose without the express written permission of Novatel Wireless Nova...

Page 4: ...Part Number 11 AT SRN Module Serial Number 12 AT CGMI Request Manufacturer Identification 13 AT CGMM Request Manufacturer Model Identification 14 AT CGMR Request Revision Identification 15 AT CGSN Pr...

Page 5: ...s 42 AT QCMIPMHSS MM HA Shared Secrets 43 AT QCMIPNAI Network Access Identifier 44 AT SPC Service Provisioning Code 45 AT CNUM Subscriber Number 46 AT CSS Serving System 47 AT CSQ Signal Quality And B...

Page 6: ...essage 76 AT CMGW Write Message To Memory 77 AT CMSS Send Message From Storage 78 AT CNMI New Message Indication To TE 79 AT CPMS Preferred Message Storage 81 API Commands 82 TCP API Commands 83 AT AC...

Page 7: ...MS Messages 118 AT SMSDAEN Enable Disable AT Commands Over SMS 120 AT UDPMSG Send And Receive UDP Messages 121 AT WAKEUP Modem To Server Wakeup Keep Alive 123 AT SNCNT Query or Reset The Byte Counters...

Page 8: ...rade OTA 156 AT FOTAUPG Upgrade Current Firmware 158 FTP Commands 159 AT ATEXEC Execute AT Command File 160 AT FFS Generic Flash File System Access 162 AT FTPABORT Aborts Current Data Operation With F...

Page 9: ...store GPS Filter Defaults 188 AT GPSFLT GPS Speed Filter 189 AT GPSLCL Configure Sending Of GPS Message To The Serial Port 194 AT GPSOSI Set And Query GPS Overspeed Interval 196 AT GPSQUAL GPS Quality...

Page 10: ...BD2 Ignition Off Configuration 225 AT OBDIV Ignition Voltage 226 AT OBDLBL Low Battery Level Threshold 227 AT OBDLED OBD2 LED Timer 228 AT OBDLFL Low Fuel Level Threshold 229 AT OBDODC Configure Odome...

Page 11: ...Detection Threshold 252 AT IMPLOG Impact Detection Logging Configuration 253 AT DVBVAL Driver Behavior Vertical Acceleration 255 AT OBDAM Set Any Motion Parameters 256 Event Tables 257 Event Engine 25...

Page 12: ...lt Codes 303 UNSOLICITED RESULT Codes 304 SMS Unsolicited Result Codes 305 Appendix Error Codes 306 Appendix B Error Codes 307 General Error Codes 308 SMS Error Codes CMS 310 Release Causes For Extend...

Page 13: ...1 Introduction...

Page 14: ...be used in conjunction with the Novatel Wireless Device identified in the title of this document Platform Reference And Use The device will be referred to using various terms to include MS Mobile Stat...

Page 15: ...ution mode will abort the command and return the interface to command mode Some AT commands require additional input for instance AT CMGS After terminating the AT CMGS command with a CR the AT command...

Page 16: ...lue value Execute Syntax ATx Execute Response OK ERROR or value Unsolicited Response Parameter Values Value 1 ATx 1 15 1 10 Value 2 Notes Additional command notes Examples Where applicable the value r...

Page 17: ...5 General Commands...

Page 18: ...directory number Syntax Query AT MDN Syntax OK Write Syntax AT MDN mdn number Write Response Device is SPC locked Read Syntax AT MDN Read Response mdn number Execute Syntax N A Execute Response N A Un...

Page 19: ...T MSID Syntax OK Write Syntax N A Write Response N A Read Syntax AT MSID Read Response msid number Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values msid number 10 digi...

Page 20: ...ntax N A Read Response N A Execute Syntax AT NWGMR Execute Response Chipset chipset Radio radio_vers Smart Agent smart_agent_vers HW Rev hw_rev PRI Info pri_pn PRI Version pri_vers OK Unsolicited Resp...

Page 21: ...e firmware package version Syntax Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT PKG Execute Response baseline release release offset OK U...

Page 22: ...ufacturing D Maintenance A D release includes the previous production release plus very specific bug fixes no new features Maintenance releases can be and usually are released to production Not all pr...

Page 23: ...nction This command will return the software part number Syntax Query AT SPN Syntax OK Write Syntax N A Write Response N A Read Syntax AT SPN Read Response SPN SWxxx Execute Syntax AT SPN Execute Resp...

Page 24: ...l return the serial number of the module Syntax Query AT SRN Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT SRN Execute Response SRN xxxxxxxxxxxxx Un...

Page 25: ...mand is used to obtain the manufacturer identification information Syntax Query AT CGMI Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT CGMI Execute R...

Page 26: ...nufacturer model identification information Syntax Query AT CGMM Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT CGMM Execute Response model OK Unsoli...

Page 27: ...revision information Syntax Query AT CGMR Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT CGMR Execute Response AT CGMR Radio radio_vers Smart Agent s...

Page 28: ...e and the hexadecimal value is displayed on the second line Syntax Query AT CGSN Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT CGSN Execute Response...

Page 29: ...rns information about the manufacturer Syntax Query AT GMI Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT GMI Execute Response Novatel Wireless A Nov...

Page 30: ...anufacturer model identification Syntax Query AT GMM Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT GMM Execute Response Model ID e g Enabler HS 3001...

Page 31: ...are revision information Syntax Query AT GMR Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT GMR Execute Response Radio and Smart Agent versions e g R...

Page 32: ...the second line Syntax Query AT GSN Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT GSN Execute Response MEID decimal ESN decimal MEID hexadecimal ES...

Page 33: ...About TA Command Function List manufacturer Syntax Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax ATI Execute Response Enfora A Novatel Wirel...

Page 34: ...22 Network Commands...

Page 35: ...e N A Parameter Values state 0 Autoreg off 1 Voice SMS Autoreg on 2 Auto Voice SMS Data Activation on Power up for hostif 1 and 2 MT will perform Network activation and go into PAD data mode For hosti...

Page 36: ...e CREG enableFlag OK Execute Syntax AT CREG Execute Response CREG status lac cid mip OK Unsolicited Response CREG status lac cid mip Parameter Values enableFlag 0 disable network registration unsolici...

Page 37: ...25 AT CREG Network Registration Info cid Cell ID GSM or Base Station ID CDMA mip MobileIP support 0 SimpleIP is supported and or MobileIP not supported 1 MobileIP supported Notes N A...

Page 38: ...D 549 CREG 1 CGREG 1 CODE 1 FREQ 150 PN 348 CSS Z 99999 0 CSQ 31 99 NETIP 0 0 0 0 0 0 0 0 0 0 0 0 TCPERR 0 0 0 OK Execute Syntax AT MDSTAT Execute Response Same as read response Unsolicited Response N...

Page 39: ...s 3 no service 5 registered roaming 6 unknown CODE Serving cell code also known as channel is a 16 bit integer FREQ Serving cell frequency is a 16 bit integer PN Serving cell pseudo random offset rang...

Page 40: ...ut on established connection 9 RST on established connection 10 ICMP rec d no route to host 11 ICMP rec d connection refused 12 ICMP rec d frag req DF set 13 no route found for destination 14 interfac...

Page 41: ...29 AT MDSTAT Query Modem Status 6 bad message format 7 connect fail Notes...

Page 42: ...navail_min reset_cnt ping check rst timers Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values net_unavail_min Number of minutes the network must remain unavailable befor...

Page 43: ...tivation sequence A value of zero indicates that the modem will never initiate a ping check rst timers 0 Reset network monitoring timers upon any activity on the serial port AND use legacy IP reselect...

Page 44: ...or ERROR Write Syntax AT NWACTIVATION activationCode mdn min Write Response OK or ERROR Read Syntax AT NWACTIVATION Read Response NWACTIVATION mdn min OK or ERROR Execute Syntax N A Execute Response...

Page 45: ...ntax Query AT OTASP Syntax OTASP 1 2 OK Write Syntax AT OTASP OTASP_cmd Write Response OK Read Syntax AT OTASP Read Response OTASP OTASP_status DMU_Status OK Execute Syntax N A Execute Response N A Un...

Page 46: ...mpleted DMU since initial powering on or since last cleared 1 Clear OTASP status 2 Clear OTASP and DMU_statuses OTASP_status 0 Error during OTASP commit 1 Success 255 No completed OTASP request since...

Page 47: ...ASSWD Syntax ATPASSWD PASSWORD mask passwd OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT ATPASSWD oldpasswd newpasswd Execute Response ATPASSWD passwd mask...

Page 48: ...to enter AT commands Each bit specifies one interface as enumerated in the table below Bit value Interface 1 Serial Port 2 SMS 4 API To select multiple items to authorize add the bit values of each in...

Page 49: ...twork data activation The value is stored in NVRAM Syntax Query AT QCDNSP Syntax QCDNSP OK Write Syntax AT QCDNSP IP address Write Response OK Read Syntax AT QCDNSP Read Response QCDNSP IP address OK...

Page 50: ...e Services DNS Syntax Query AT QCDNSS Syntax QCDNSS OK Write Syntax AT QCDNSS IP address Write Response OK Read Syntax AT QCDNSS Read Response QCDNSS IP address OK Execute Syntax AT QCDNSS Execute Res...

Page 51: ...the mobile automatically reverts to Simple IP forces a PPP renegotiation by sending an LCP C Req However if a Mobile IP session is registered and the mobile enters a network that does not support Mob...

Page 52: ...is used to enable or disable current MIP profile Syntax Query AT QCMIPEP Syntax QCMIPEP 0 1 Write Syntax AT QCMIPEP N Write Response OK Read Syntax AT QCMIPEP Read Response QCMIPEP N Execute Syntax N...

Page 53: ...n_aaa MN HA SPI mn_ha Rev Tun reverse_tunnel MN AAA SS aaa_shared_secret set or unset MN HA SS ha_shared_secret set or unset OK Read Syntax AT QCMIPGETP Read Response QCMIPGETP N Execute Syntax AT QCM...

Page 54: ...tax AT QCMIPMASS STR STORE Write Response OK Read Syntax AT QCMIPMASS Read Response QCMIPMASS Set or Unset Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values STR Shared...

Page 55: ...sponse OK Read Syntax AT QCMIPMHSS Read Response QCMIPMHSS Set or Unset OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values STR Shared secret data string STORE 0 Store...

Page 56: ...Syntax N A Execute Response N A Unsolicited Response N A Parameter Values NAI Network access identifierstring STORE 0 Store to NV memory 1 Do not store to NV memory Notes The first parameter of QCMIPN...

Page 57: ...which update shared secret authentication information Syntax Query N A Syntax N A Write Syntax AT SPC SPC Write Response SPC Correct Device SPC Unlocked or SPC doesn t match Read Syntax AT SPC Read Re...

Page 58: ...nd is used to obtain the MSISDNs related to the subscriber Syntax Query AT CNUM Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT CNUM Execute Response...

Page 59: ...lular 2 Band Class 1 1900 MHz PCS Band CA MS is registered with cellular A band system CB MS is registered with cellular B band system PA MS is registered with PCS A band system PB MS is registered wi...

Page 60: ...48 AT CSS Serving System 1 IS 95 or J STD 008 2 IS 95 A 3 IS 95 A TSB74 4 TIA EIA 95 B 5 TIA EIA 95 B 6 IS 2000 7 IS 2000 A 8 IS 2000 B 9 IS 2000 C 10 IS 2000 C Notes Examples...

Page 61: ...Syntax Query AT CSQ Syntax CSQ 0 31 99 0 7 99 OK Write Syntax N A Write Response N A Read Syntax AT CSQ Read Response CSQ rssi ber OK Execute Syntax AT CSQ Execute Response CSQ rssi ber OK Unsolicite...

Page 62: ...50 ME TA Commands...

Page 63: ...l setup in call modification last call release last short message or last network data session Syntax Query AT CEER Syntax Error Write Syntax N A Write Response N A Read Syntax AT CEER Read Response C...

Page 64: ...N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT RESET Execute Response N A Unsolicited Response N A Parameter Values N A Notes Execution of this command will perform a full...

Page 65: ...D UAPP OK Write Syntax AT V subsystem Write Response subsystem configuration values OK Read Syntax N A Read Response N A Execute Syntax AT V Execute Response configuration values for all subsystems OK...

Page 66: ...Parameters to Factory Defined Configuration Syntax Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT F Execute Response OK Unsolicited Respon...

Page 67: ...Execute Syntax AT V Execute Response OK Unsolicited Response N A Parameter Values N A Notes N A Only the industry standard AT command settings are displayed in the AT V output Use AT V to view the Sma...

Page 68: ...are implemented on the aux processor OBD and accelerometer commands essentially any command prefixed with OBD These settings are only persistent if AT OBDSAV is sent If AT OBDSAV is not sent any chan...

Page 69: ...57 SMS Commands...

Page 70: ...nse N A Read Syntax N A Read Response N A Execute Syntax AT QCMSS index Execute Response QCMSS mr OK Unsolicited Response N A Parameter Values index Integer value of location number supported by assoc...

Page 71: ...s 0 Delete the messages specified by the index 1 Ignore the index and delete all the read messages 2 Ignore the index and delete all the read and sent messages 3 Ignore the index and delete all the re...

Page 72: ...at of messages used with send list read and write commands and unsolicited result codes resulting from received messages Syntax Query AT QCMGF Syntax AT QCMGF 1 OK Write Syntax AT CMGF mode Write Resp...

Page 73: ...ead Response N A Execute Syntax AT QCMGL stat Execute Response QCMGL index stat da oa alpha scts tooa toda length CR LF data OK Unsolicited Response N A Parameter Values See Notes index Memory locatio...

Page 74: ...ress octet in integer format length Length of message in octets Notes Above settings for stat assume AT QCMGF 1 text mode Parameters in may or may not be reported dependent upon the setting of AT QCMG...

Page 75: ...QCMGR stat oa scts tooa fo pid sca tosca length CR LF data OK Unsolicited Response N A Parameter Values stat Status of message Rec Read Rec Unread Sto Unsent Sto Sent oa Originating address scts Serv...

Page 76: ...N A Read Response N A Execute Syntax AT QCMGS da toda Execute Response Enter text cntl Z QCMGS mr OK Unsolicited Response N A Parameter Values da Destination address mr Message reference Notes The exa...

Page 77: ...uery N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT QCMGW da CR LF Execute Response Text is entered cntlZ CMGW index OK Unsolicited Response N A...

Page 78: ...erved and flush them to the TE after reservation mt Receiving procedure for different message data coding schemes refer to GSM 03 38 2 mt 0 no class as in GSM 03 38 but use mem3 as preferred memory cl...

Page 79: ...discard message as in GSM 03 38 but also route message to TE and do not try to store it in memory message waiting indication group store message as mt 1 mt 3 class 3 route message to TE others as mt 1...

Page 80: ...se N A Parameter Values mem1 String type memory from which messages are read and deleted commands List Messages QCMGL Read Message QCMGR and Delete Message QCMGD Defined values ME ME message storage M...

Page 81: ...Write Response OK Read Syntax AT QCSMP Read Response QCSMP 4095 0 string 0 0 OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values tid Teleservice ID 4095 4102 vpf Valid...

Page 82: ...T SMSURC Read Response SMSURC OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values urc1 0 Do not send URCs from FTPOPEN FTPCLOSE FTPGET and FTPPUT via SMS if the comman...

Page 83: ...received messages Syntax Query AT CMGF Syntax CMGF 1 OK Write Syntax AT CMGF mode Write Response OK Read Syntax AT CMGF Read Response CMGF 1 OK Execute Syntax N A Execute Response N A Unsolicited Resp...

Page 84: ...delete all the read sent and unsent messages 4 Ignore the index and delete all the messages whatever the status is indexList List of the indexes for the messages in memory For example 0 1 2 for memory...

Page 85: ...ad Response N A Execute Syntax AT CMGL stat Execute Response CMGL index stat da oa alpha scts tooa toda length CR LF data OK Unsolicited Response N A Parameter Values See Notes index Memory location i...

Page 86: ...dress octet in integer format length Length of message in octets Notes Above settings for stat assume AT CMGF 1 text mode Parameters in may or may not be reported dependent upon the setting of AT CMGF...

Page 87: ...CMGR stat oa scts tooa fo pid sca tosca length CR LF data OK Unsolicited Response N A Parameter Values stat Status of message Rec Read Rec Unread Sto Unsent Sto Sent oa Originating address scts Servic...

Page 88: ...x Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT CMGS da toda Execute Response Enter text cntl Z CMGS mr OK Unsolicited Response N A Param...

Page 89: ...uery N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT CMGW da CR LF Execute Response Text is entered cntlZ CMGW index OK Unsolicited Response N A...

Page 90: ...ssage storage Syntax Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT CMSS index Execute Response CMSS mr OK Unsolicited Response N A Parame...

Page 91: ...d reject new received message unsolicited result codes when TA TE link is reserved 2 Buffer unsolicited result codes in the TA when TA TE link is reserved and flush them to the TE after reservation mt...

Page 92: ...CBM indications are routed to the TE If CBM is stored into ME TA indication of the memory location is routed to the TE using unsolicited result code CBMI mem index 1 New CBMs are routed directly to th...

Page 93: ...e N A Parameter Values mem1 String type memory from which messages are read and deleted commands List Messages CMGL Read Message CMGR and Delete Message CMGD defined values ME ME message storage MT An...

Page 94: ...82 API Commands...

Page 95: ...83 TCP API Commands...

Page 96: ...ACKTM Syntax ACKTM 1 255 0 3600 0 1 OK Write Syntax AT ACKTM max retry retry period IP reselect Write Response OK Read Syntax AT ACKTM Read Response ACKTM max retry retry period IP reselect OK Execut...

Page 97: ...age Period Retry Number 1 If an acknowledge message has not been received after all friend servers and retries for the message are exhausted assume a problem with round trip communication and initiate...

Page 98: ...TCPAPI Syntax TCPAPI 0 1 OK Write Syntax AT TCPAPI Status Write Response OK Read Syntax AT TCPAPI Read Response TCPAPI Status M Mgr Task R Rec Task T Trans Task Idx Friend Index Execute Syntax N A Exe...

Page 99: ...2 Idle 3 Connected 4 Waiting for Header 5 Waiting for Frame 6 Processing API Command Trans Task TCP API Transmit Task 0 None 1 Init 2 Idle 3 Connected 4 Sending Friend Index Friend Index 1 10 255 Not...

Page 100: ...on Syntax Query AT TCPIDLETO Syntax TCPIDLETO 10 86400 OK Write Syntax AT TCPIDLETO Timeout Write Response OK Read Syntax AT TCPIDLETO Read Response TCPIDLETO Timeout Execute Syntax N A Execute Respon...

Page 101: ...it is dropped and a new connection is attempted starting at the beginning of the Friend list Syntax Query AT TCPRESTRT Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A E...

Page 102: ...TO Timeout Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values Timeout TCP API retry timeout value in seconds Notes After closing the connection the device will attempt t...

Page 103: ...P API starting port number End Port Number TCP API ending port number Notes Each connection attempt uses the next port number in sequence until the end port is passed When this happens the port is set...

Page 104: ...ute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values clear 0 clear TCPAPI statistics Rx Bytes TCP API bytes received Tx Bytes TCP API bytes transmitted Mode Changes Counts the...

Page 105: ...nect Timeouts The number of times the reconnect timer expired The reconnect timer restarts a TCPAPI connection when not connected and TCPAPI mode is enabled Disconnect Timeouts The number of times the...

Page 106: ...mmand is used to enable and disable sending Unsolicited Response Codes over TCPAPI Syntax Query AT TCPURC Response TCPURC 0 1 OK Write Syntax AT TCPURC MODE Response OK Read Syntax AT TCPURC Response...

Page 107: ...95 Message Commands...

Page 108: ...licited Response N A Parameter Values MDMID 0 Disable sending of MDMID value in TCPAPI or UDPAPI Header 1 Enable sending of MDMID value in TCPAPI or UDPAPI Header Msg Event Format 0 Disable sending of...

Page 109: ...e Output Event Type 0 Disable sending of Output Event number in TCPAPI or UDPAPI Header 1 Enable sending of Output Event number in TCPAPI or UDPAPI Header HexModemID 0 Do not include the hex modem ID...

Page 110: ...MDMID will be the NULL string If all MDMID characters are decimal characters then the decimal MDMID is converted into the hexadecimal equivalent value Examples This example will disable the sending o...

Page 111: ...99 AT APIOPT Enable API Optional Header Fields MDMID 99 03 07 63 MDMID 999999999999999999A 03 07 00...

Page 112: ...OK Read Syntax AT APIPWD Read Response APIPWD API password Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values API password Maximum of 8 characters A NULL password indica...

Page 113: ...lternate server is listed in the FRIEND list with a usage 4 Syntax Query AT CHKIN Syntax CHKIN 0 1 0 43200 0 1 OK Write Syntax AT CHKIN enable periodic_interval enable fota upgrade status Write Respon...

Page 114: ...IEND list with a usage 4 If the Check in feature is enabled but no CHKIN server is defined in the friends list then all UDP API messages will be blocked from being transmitted over the air Example AT...

Page 115: ...server indication friend IP or DNS name destination port usage FRIEND 10 server indication friend IP or DNS name destination port usage Execute Syntax N A Execute Response N A Unsolicited Response N...

Page 116: ...ue for all active servers It clears the server indication and destination port fields If the server indication is disabled for a friend server then the UDP TCP socket is not opened for communication T...

Page 117: ...ntax AT IDENT Read Response IDENT IDENTIFIER PREPEND DIGIT OTA IDENTIFIER Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values IDENTIFIER API optional header modem identif...

Page 118: ...odem see AT WAKEUP Syntax Query AT MDMID Syntax MDMID MODEM ID OK Write Syntax AT MDMID modem ID Write Response OK Read Syntax AT MDMID Read Response MDMID modem ID Execute Syntax N A Execute Response...

Page 119: ...ting no message size restriction This is the equivalent of restricting the size of this queue to 3000 messages SmsBckupQsize Maximum of unsent messages stored in message log queue for UDP messages whe...

Page 120: ...ng only NMEA data the message log files will be completely filled after about 2500 messages Binary messages are typically smaller and take up less space in the message log files but are still subject...

Page 121: ...n conjunction with MSGLOGDMP and allows the user to restrict the number of unsent messages maintained in the buffers for the message log queues To dump the message the user needs to turn off the GPS r...

Page 122: ...yntax Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT MSGLOGCL Execute Response OK Unsolicited Response N A Parameter Values None Notes If...

Page 123: ...1 event data that was configured to be sent to a remote server via UDP API primarily but also use SMS as backup method if UDP is not available 2 event data that was configured to be sent to a remote...

Page 124: ...help debug problems related to handling unsent messages in flash However it has also been useful in collecting GPS data when other memory storage is not available and it is not possible to connect th...

Page 125: ...tax AT MSGLOGEN Read Response MSGLOGEN setting Execute Syntax Execute Response Unsolicited Response N A Parameter Values setting 0 1 possible valid values 0 Disable message logging default Event data...

Page 126: ...messages with SMS as backup total number of UDP messages with SMS as backup in the UDP SMS log Third Pair of numbers unsent SMS messages total number of SMS messages in the SMS log Fourth Pair of mess...

Page 127: ...t messages primarily but also use SMS as backup method if UDP is not available number of messages x x total number of messages one desires to read from the memory A user can choose to read 1 message i...

Page 128: ...been created to allow sending of data from one mode to another Syntax Query AT MSGSND Syntax AT MSGSND 0 5 DATA OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax...

Page 129: ...sent to OTA destinations options 1 2 3 and 4 are transmitted immediately If network coverage is not available then the message is silently discarded The message is not stored for later transmission wh...

Page 130: ...AT commands over SMS Syntax Query AT SMSDA Syntax SMSDA 1 5 1234 123 Write Syntax AT SMSDA index dest addr gateway number Write Response OK Read Syntax AT SMSDA Read Response SMSDA 1 dest addr gatewa...

Page 131: ...o controlled by AT SMSDAEN If AT SMSDAEN 1 default and if there are no addresses populated in AT SMSDA then all SMS with the correct AT command format addressed to the MSISDN of the device and with th...

Page 132: ...to send AT commands over SMS 1 Enables the ability to send AT commands over SMS Notes AT SMSDAEN is set to 1 by default This allows SMS over AT commands to be sent to the modem IF there is no entries...

Page 133: ...isplayed on the serial port with the unsolicited response UDPMSG followed by the message Syntax Query AT UDPMSG Syntax UDPMSG 0 1 0 2 data 0 1 OK Write Syntax AT UDPMSG format type data flash cr Write...

Page 134: ...es in FLASH memory 1 Store messages in FLASH memory Notes Data received from OTA shall be sent to the modem s serial port as UDPMSG text ASCII or Binary data NOTE Binary message will be displayed as t...

Page 135: ...n sequence i e server 2 is contacted after all retries for server 1 is complete and is complete when each server friend has received max retry messages or upon receipt of an acknowledge message from a...

Page 136: ...mmand populates the event timer value when the AT EVTIM4 command is issued The AT EVTIM value will be in seconds The parameter will also generate additional event group 0 entries If AT EVDEL 0 is issu...

Page 137: ...NT upo dno upp dnp CR LF Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values rst resets the counters if rst 0 upo uplink octets count dno downlink octets count upp uplink...

Page 138: ...126 Event Commands...

Page 139: ...uld be acceptable If the flag is clear the timer always starts at zero following an reset The sign represents timers 1 through X i e ETSAV1 Syntax Query AT ETSAV Syntax ETSAV 0 1 OK Write Syntax AT ET...

Page 140: ...um OK Write Syntax AT EVCID entry mode number Write Response OK Read Syntax AT EVCID Read Response EVCID entry mode number Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Va...

Page 141: ...s useful for matching to local national and international ISDN telephony numbering plans Notes In the event the incoming call number matches more than one incoming call number selection the mode selec...

Page 142: ...Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT EVDEL group letter ID Execute Response OK Unsolicited Response N A Parameter Values group e...

Page 143: ...ite Response N A Read Syntax N A Read Response N A Execute Syntax AT EVDELA Execute Response OK Unsolicited Response N A Parameter Values N A Notes N A This command deletes ALL events from the event t...

Page 144: ...event groups Syntax Query AT EVDELR Syntax EVDELR 0 255 0 255 OK Write Syntax AT EVDELR start stop Write Response OK Read Syntax N A Read Response N A Execute Syntax N A Execute Response N A Unsolici...

Page 145: ...p3 evgp evtyp evcat p1 p2 p3 1A 0 9 2 4 1B 3 37 1 0 0 2A 0 9 5 5 2B 3 21 0 0 0 3A 0 9 0 0 3B 3 13 0 0 0 4A 0 9 1 1 4B 3 21 0 0 0 Execute Syntax N A Execute Response N A Unsolicited Response N A Parame...

Page 146: ...gnored if entered for an input event or any other output events For additional details see the Event Tables section of this manual Notes A maximum of 600 events input and output are supported User var...

Page 147: ...A Read Response N A Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values event group This parameter defines the group number of a group of events and the order they are e...

Page 148: ...ed and how many are left Syntax Query AT EVNTRY Syntax ERROR Write Syntax N A Write Response N A Read Syntax AT EVNTRY Read Response EVNTRY used left Execute Syntax N A Execute Response N A Unsolicite...

Page 149: ...alues event input event number state input event test state Notes User variable values are automatically saved to flash and explicit user intervention to save the values is not required AT W does not...

Page 150: ...x EVTIM 0 604800 OK Write Syntax AT EVTIM rate Write Response OK Read Syntax AT EVTIM Read Response EVTIM rate Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values rate nu...

Page 151: ...Write Syntax AT EVTIMQRY timer_index Write Response EVTIMQRY timer_index count OK Read Syntax AT EVTIMQRY Read Response ERROR Execute Syntax AT EVTIMQRY timer_index Execute Response EVTIMQRY timer_ind...

Page 152: ...good command to run prior to a software upgrade Syntax Query AT EVTOFF Syntax EVTOFF 0 1 OK Write Syntax AT EVTOFF state Write Response OK Read Syntax AT EVTOFF Read Response EVTOFF state Execute Syn...

Page 153: ...e Response N A Read Syntax N A Read Response N A Execute Syntax AT EVTQRY input event Execute Response EVTQRY input event state bInit updateFlag Unsolicited Response N A Parameter Values max input eve...

Page 154: ...ents The AT command is executed upon the triggering of the associated input event Syntax Query AT STOATEV Syntax STOATEV 1 35 AT command OK Write Syntax AT STOATEV 1 35 AT command Write Response OK Re...

Page 155: ...44 When output event 44 is defined in the event table Parm1 defines which index to refer to The AT command associated with the index is executed The use of Dynamic Event Scripting using AT EVENT or AT...

Page 156: ...memory which can later be retrieved Syntax Query AT USRVAL Syntax USRVAL 0 FFFFFFFF OK Write Syntax AT USRVAL hex value Write Response OK Read Syntax AT USRVAL Read Response USRVAL hex value OK Execu...

Page 157: ...145 RTC Commands...

Page 158: ...min rtc_sec rtc_alarmTimeinMinutes Write Response OK Read Syntax AT RTCALRM Read Response RTCALRM rtc_enabled rtc_year rtc_month rtc_day rtc_ hour rtc_min rtc_sec rtc_alarmTimeinMinutes OK Execute Syn...

Page 159: ...rm may be cleared using the command AT RTCCLRA This call in conjunction with the use of either the EVENT engine or the RTCWAKE command the user has a rich feature set of driving other events or waking...

Page 160: ...rm The alarm interrupt enable is cleared but alarm time not altered Syntax Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT RTCCLRA Execute...

Page 161: ...xecute Response RTCRSET reset state OK Unsolicited Response N A Parameter Values reset state 1 indicates that a RTC reset occurred 0 indicates that a RTC reset did NOT occur Notes This command returns...

Page 162: ...Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values Parameters are positional dependent any parameter may be omitted with the use of the comma as a place holder on comman...

Page 163: ...Hour mode currently supported rtc_min The minute to which the time is being set Values range from 0 59 rtc_sec The second to which the time is being set Values range from 0 59 Notes This command is us...

Page 164: ...152 FOTA Commands...

Page 165: ...upgradeMode upgradeStatus Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values ftpServerHostname Either Fully Qualified Domain Name FQDN or a dotted decimal IP address of...

Page 166: ...retries This is the maximum number of FTP file resumes to attempt before giving up on original AT FOTAGET command The range of retries is 0 20 Default Value 0 reportMode The reporting mode is used to...

Page 167: ...upgrade command is issued AT FOTAUPG The command line parameters are 0 auto 1 manual Default value 0 automatic mode upgradeStatus Controls the generation of FOTA Finish status FOTA Finish status is r...

Page 168: ...ry AT FOTAGET Syntax FOTAGET remotefilename OK Write Syntax AT FOTAGET remotefilename Write Response OK Read Syntax AT FOTAGET Read Response FOTAGET fotaState remotefilename retriesRemaining appErrorC...

Page 169: ...t match 7 package version or signature does not match 8 could not install package in flash 9 previous version present and pkg Status pending 10 not enough space to write file 11 flash file open failed...

Page 170: ...UPG should not be used if automatic mode is configured in AT FOTACFG because the upgrade process is started by the modem in automatic mode AT FOTAUPG resets the modem and starts the FOTA upgrade agent...

Page 171: ...159 FTP Commands...

Page 172: ...t has been issued The first response is an immediate acknowledgement of the command either OK if the command was entered correctly or ERROR if the command was not entered correctly After the script ha...

Page 173: ...op on Error 2 Stop on Error and Reset Modem STATUS Status from Executing File 0 Ok 1 Error 2 Open File Error 3 File Read Error 4 AT Command Error 5 Busy 6 Command Length Exceeded 7 Retries Exceeded No...

Page 174: ...Wireless modem Syntax Query AT FFS Response FFS 0 6 86 filename 0 524287 0 100 ASCII HEX Write Syntax AT FFS op filename seek length data Response The device response varies by op Response for Write o...

Page 175: ...h file size 5 FFS free space and used space 6 Output flash device name 86 delete all files filename The filename in double quotes i e test txt Maximum length is 15 characters Filename parameter is req...

Page 176: ...at for the read operation Limited to 100 bytes 200 characters Data is encoded in ASCII hex i e 0x12 0x34 0xab would be entered as 1234ab Notes Examples AT FFS 0 test 0 8 0102030405060708 OK AT FFS 1 t...

Page 177: ...165 AT FFS Generic Flash File System Access OK...

Page 178: ...urrent data operation with the FTP server Syntax Query AT FTPABORT Response OK Write Syntax N A Response N A Read Syntax AT FTPABORT Response ERROR Execute Syntax AT FTPABORT Response OK Parameter Val...

Page 179: ...ze Syntax Query AT FTPBLK Response FTPBLK 128 1500 OK Write Syntax AT FTPBLK blocksize Response OK Read Syntax AT FTPBLK Response 1500 Execute Syntax N A Response N A Parameter Values blocksize FTP bl...

Page 180: ...Syntax N A Execute Response N A Unsolicited Response N A Parameter Values host Fully qualified domain name or dotted decimal notation IP address of FTP server character string up to 63 characters por...

Page 181: ...x FTPDIR directory OK Write Syntax AT FTPCHDIR directory Write Response OK Read Syntax AT FTPCHDIR Read Response ERROR Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values...

Page 182: ...ith the remote FTP server Syntax Query AT FTPCLOSE Response OK Write Syntax N A Response N A Read Syntax AT FTPCLOSE Response ERROR Execute Syntax AT FTPCLOSE Response OK Parameter Values N A Notes Th...

Page 183: ...Response N A Read Syntax AT FTPDIR Read Response OK FTPDIR current directory information Execute Syntax AT FTPDIR Execute Response OK directory listing information Unsolicited Response N A Parameter...

Page 184: ...mote FTP server localfile File name to use for storage of the retrieved file in the local flash file system Note the local filename length is limited to 15 characters output Number of bytes which have...

Page 185: ...CTIVE or PASSIVE Mode is an optional parameter If not specified the FTP connection will be in the PASSIVE mode status FTP CONNECTION OPEN FTP CONNECTION CLOSED FTP STACK ERROR Status will display the...

Page 186: ...localfile Response OK Read Syntax AT FTPPUT Response FTPPUT remotefile localfile totalWrote totalSize eof Execute Syntax N A Response N A Parameter Values remotefile File name on the remote FTP server...

Page 187: ...complete file transfer from the last point in the file successfully read Offset is not required unless the automatically computed offset is to be overridden The AT FTPRST command requires an RFC3659 c...

Page 188: ...176 IP Router Commands...

Page 189: ...te Response N A Read Syntax AT FLFILT Read Response FLFILT enable OK Execute Syntax AT FLFILT enable Execute Response OK Unsolicited Response N A Parameter Values enable 0 do not filter ICMP echo requ...

Page 190: ...user to query the modem s network assigned IP Syntax Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax AT NETIP Read Response IP DNS1 DNS2 Execute Syntax N A Execute Response N A U...

Page 191: ...N A Read Response N A Execute Syntax AT PING host count timeout Execute Response Immediate response Pinging IP address After ICMP response Reply from IP address Unsolicited Response N A Parameter Val...

Page 192: ...180 GPS Commands...

Page 193: ...nsolicited Response N A Parameter Values speed Speed in knots must be met and or exceeded to trigger the GPS overspeed event interval Number of consecutive seconds for which speed must be maintained t...

Page 194: ...ponse OK Read Syntax AT EXCACC Read Response EXCACC THRESH SET TIME CLR TIME OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values THRESH 0 Excessive Acceleration Event...

Page 195: ...ponse OK Read Syntax AT EXCDEC Read Response EXCDEC THRESH SET TIME CLR TIME OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values THRESH 0 Excessive Deceleration Event...

Page 196: ...Defines radius of the circle from given Latitude and Longitude coordinates in meters latitude Defines the latitude for the center point of a circle longitude Defines the longitude for the center point...

Page 197: ...e Syntax AT GFDBNC out_cnt in_cnt Write Response OK Read Syntax AT GFDBNC Read Response GFDBNC out_cnt in_cnt OK Execute Syntax N A Execute Response Unsolicited Response N A Parameter Values out_cnt C...

Page 198: ...fences Syntax Query AT GFDEL Syntax GFDEL 1 25 1 25 OK Write Syntax AT GFDEL start stop Write Response OK Read Syntax N A Read Response N A Execute Syntax N A Execute Response N A Unsolicited Respons...

Page 199: ...sables the GPS 1 Cold start 2 Hot start 3 Stop the current GPS fix Notes 0 GPS is in an idle state 1 Commands GPS to begin acquisition from a cold start 2 Hot start can only be accomplished if it has...

Page 200: ...full AT F This command accepts one parameter a sticky flag If the sticky flag is set the GPS filter defaults will be persistent If the sticky flag is not set the GPS filter defaults will not be mainta...

Page 201: ...nce for most applications Please contact Novatel Wireless customer support if you feel the filter settings need to be changed for your application Syntax Query AT GPSFLT Syntax If the GPSFLT debug fla...

Page 202: ...each report The confidence level is the converted into a trust factor which is compared against this threshold value If the trust factor is less than this threshold and the device is in the parked mo...

Page 203: ...to zero Default is 30 degrees second n4aHd g 0 180 Novatel Wireless heading change threshold This filter calculates the heading using the two most recent position locations and based on the time delta...

Page 204: ...uncertainty threshold If internal position uncertainty value is greater than this value the confidence level is reset to zero Default is 75 mot 0 999 Motion transition threshold in seconds If device...

Page 205: ...buted to discrepancies between the RTC time and the GPS time When GPS filtering is enabled the code ensures the RTC time is always with 5 seconds of the GPS time This time sync feature is disabled by...

Page 206: ...nction This command allows the user to configure sending of GPS data on the serial port Syntax Query AT GPSLCL Syntax GPSLCL 0 1 0 127 OK Write Syntax AT GPSLCL option nmeaMsgs Write Response OK Read...

Page 207: ...II data to the local port when the device is in AT command mode nmeaMsgs This field is the bit wise OR of the type of messages desired The user has following message options to select from Decimal For...

Page 208: ...nsolicited Response N A Parameter Values speed Speed in knots must be met and or exceeded to trigger the GPS overspeed event interval Number of consecutive seconds for which speed must be maintained t...

Page 209: ...d if GPGSA fix type is 2 2D fix This bit is provided for backwards compatibility with legacy products It has not been shown to improve performance with this product 2 Mark GPS report invalid if the re...

Page 210: ...reported solution from GPGGA sentence is below this value Notes The units of the uncertainty threshold should not be taken literally For example a position uncertainty threshold of 100 meters does not...

Page 211: ...ut NMEA sentence depends on whether the nmeaMsgs parameter is entered in Hex or Decimal format By default the decimal parameter is not required and nmeaMsgs parameter has to be entered as HEX value wi...

Page 212: ...MC 64 PENFG decimal 1 nmeaMsg value has to be sum of User Selectable values from decimal table format 0 select values out of hex table format Notes The PENFG Proprietary ENFora Gps is used for debug p...

Page 213: ...ly The second parameter allows the user to cut down the time without a lock before resetting the GPS chip when outside of the cold start window Syntax Query AT GPSRST Syntax GPSRST 0 255 0 255 OK Writ...

Page 214: ...tes If coldStartInterval is set to 0 the GPS chip will not be reset after a GPS outage of any duration Example AT GPSRST 1 2 Code will allow 10 minutes to acquire a GPS lock before reset ting the GPS...

Page 215: ...GPSVAL Syntax GPSVAL 0 1 OK Write Syntax AT GPSVAL MODE Write Response OK Read Syntax AT GPSVAL Read Response GPSVAL MODE OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter...

Page 216: ...es The user is able to set a seed value for the Trip Odometer starting at 0 but not higher than the maximum value of 4000000000 The AT F command will not reset the odometer value to 0 The Virtual Odom...

Page 217: ...e all the points for the indicated polygonal geofence see PLYFN Syntax Query AT PLYCLR Syntax PLYCLR 0 24 OK Write Syntax AT PLYCLR id Write Response OK Read Syntax N A Read Response N A Execute Synta...

Page 218: ...low for additional details You can specify your polygon with less than 26 vertices but the first and last points of the polygon still must be identical The query returns all non zero locations defined...

Page 219: ...ements the pnpoly algorithm The pnpoly algorithm is copyright 1970 2003 Wm Randolph Franklin Regardless of how many points you specify for your polygon all 26 points are fed to the algorithm Due to th...

Page 220: ...AT PLYFN Geo Fencing a Polygonal Area 0 0 0000000 0 0000000 1 32 9954987 96 7220612 2 33 0003929 96 7150269 3 33 0087471 96 7224655 4 33 0013313 96 7329788 5 32 9954987 96 7220612 6 0 0000000 0 000000...

Page 221: ...4000000000 The AT F command will not reset the odometer value to 0 see example below The Trip Odometer reading would be a 4 byte value starting from 0 to 4000000000 maximum of approximately 2500000 mi...

Page 222: ...210...

Page 223: ...211 Battery Commands...

Page 224: ...x AT OBDBAT Read Response OBDBAT status voltage OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values status 0 Internal Battery is Disabled 1 Internal Battery is Enabled...

Page 225: ...DBBT time Write Response OK Read Syntax AT OBDBBT Read Response OBDBBT time time_remaining Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values time Time in seconds to rem...

Page 226: ...erve the power in the internal battery Syntax Query AT OBDBQS Syntax OBDBQS 0 1 OK Write Syntax AT OBDBQS status Write Response OK Read Syntax AT OBDBQS Read Response OBDBQS status OK Execute Syntax N...

Page 227: ...215 OBD Commands...

Page 228: ...OBDADT DISCOVERY TIMER Write Response OK Read Syntax AT OBDADT Read Response OBDADT DISCOVERY TIMER DISCOVERY TIME REMAINING OK Execute Syntax N A Execute Response N A Unsolicited Response N A Paramet...

Page 229: ...Odometer Syntax Query AT OBDCUT Response OK Write Syntax N A Response N A Read Syntax N A Response N A Execute Syntax AT OBDCUT Response OK Parameter Values N A Notes N A Example AT STOATEV 1 AT OBDCU...

Page 230: ...ite Syntax AT OBDDSC PROTOCOL Write Response OK Read Syntax AT OBDDSC Read Response OBDDSC PROTOCOL OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values PROTOCOL OBD2 P...

Page 231: ...cited Response N A Parameter Values TIME Time in minutes that the unit will remain in a low power state 0 64800 0 timer is disabled modem will only turn on based on motion and ignition on 64800 45 day...

Page 232: ...0 30 1000 OK Write Syntax AT OBDECT value set time clear time Write Response OK Read Syntax AT OBDECT Read Response OBDECT value set time clear time OK Execute Syntax N A Execute Response N A Unsolici...

Page 233: ...SET TIME CLR TIME Write Response OK Read Syntax AT OBDEES Read Response OBDEES THRLD SET TIME CLR TIME THRLD SET TIME CLR TIME THRLD SET TIME CLR TIME Execute Syntax N A Execute Response N A Unsolicit...

Page 234: ...of the OBD2 thresholds to factory default values Syntax Query AT OBDFAC Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT OBDFAC Execute Response OK Uns...

Page 235: ...speed in binary output messages Bit Field Table 0 bit 12 Syntax Query AT OBDGSP Syntax OBDGSP 0 1 OK Write Syntax AT OBDGSP USE OBD SPEED Write Response OK Read Syntax AT OBDGSP Read Response OBDGSP...

Page 236: ...ax AT OBDIDL THRHLD SET TIME CLR TIME Write Response OK Read Syntax AT OBDIDL Read Response OBDIDL THRHLD SET TIME CLR TIME Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter V...

Page 237: ...ameter Values OBD OFF OBD2 Off Time 0 600 Time in seconds after vehicle and engine speed are zero before dropping OBD communications with the ECU IGN OFF 0 Ignition off when vehicle and engine speed a...

Page 238: ...tax AT OBDIV Voltage On time Off time Write Response OK Read Syntax AT OBDIV Read Response OBDIV Voltage On time Off time OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter...

Page 239: ...D SET TIME CLR TIME Write Response OK Read Syntax AT OBDLBL Read Response OBDLBL THRHLD SET TIME CLR TIME Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values THRHLD Low b...

Page 240: ...240 OK Write Syntax AT OBDLED LED TIMER Write Response OK Read Syntax AT OBDLED Read Response OBDLED LED TIMER LED TIME REMAINING OK Execute Syntax N A Execute Response N A Unsolicited Response N A Pa...

Page 241: ...ponse N A Unsolicited Response N A Parameter Values THRHLD Low fuel level threshold in percent SET TIME Time below threshold to set alert in seconds CLR TIME Time above threshold to clear alert in sec...

Page 242: ...OBDODC METHOD Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values METHOD Method to retrieve the odometer Use VIN to determine method default C Chrysler F Ford G GM H Hon...

Page 243: ...flash memory Syntax Query AT OBDSAV Syntax OK Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT OBDSAV Execute Response OK Unsolicited Response N A Parameter Valu...

Page 244: ...E CLR THRLD Write Response OK Read Syntax AT OBDSPD Read Response OBDSPD THRLD SET TIME CLR THRHLD THRLD SET TIME CLR THRHLD THRLD SET TIME CLR THRHLD Execute Syntax N A Execute Response N A Unsolicit...

Page 245: ...AT OBDTYP Read Response OBDTYP OBD TYPE OBD COMM OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values OBD Type OBD2 Protocol Type 0 ISO 15765 250 kHz 11 bit 1 ISO 1576...

Page 246: ...234...

Page 247: ...query the software version of the auxiliary processor Syntax Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax AT OBDVER Read Response OBDVER SW VER OK Execute Syntax N A Execute Re...

Page 248: ...236 Miscellaneous Commands...

Page 249: ...A Execute Response N A Unsolicited Response N A Parameter Values hours 0 Automatic reset turned off 1 168 Number of hours until the modem resets ign rst inhibit 0 inhibit off default Modem will be res...

Page 250: ...tate 1 Ignore ignition state when implementing automatic reset logic Note On devices that do not support ignition detection this parameter value can only be set to 1 Notes On devices that do not suppo...

Page 251: ...ses Syntax Query N A Syntax N A Write Syntax N A Write Response N A Read Syntax N A Read Response N A Execute Syntax AT OFF Execute Response None modem powers down Unsolicited Response N A Parameter V...

Page 252: ...for accelerometer data to be included in UBI messages Syntax Query AT UBITHR Syntax UBITHR 0 32767 0 32767 0 32767 OK Write Syntax AT UBITHR x_threshold y_threshold z_threshold Write Response OK Read...

Page 253: ...OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values version Version used to determine how UBI messages are formatted Notes For MT 3060 G ONLY UBIVER command has been u...

Page 254: ...te Syntax N A Execute Response N A Unsolicited Response N A Parameter Values mode 0 No sleep 1 Small 2 Big No Sleep all sections of the modem will remained powered on and ready for use Small All funct...

Page 255: ...yntax AT LPMO Modem Power Write Response OK Read Syntax AT LPMO Read Response LPMO Modem Power OK Execute Syntax N A Execute Response N A Unsolicited Response Parameter Values Modem Power 0 Modem is p...

Page 256: ...244 Accelerometer Commands...

Page 257: ...ATUS OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values ENABLE 0 Auto calibration off 1 Auto calibration on STATUS 0 Initializing 1 Getting gravity vector 2 Gravity v...

Page 258: ...ad Response ACCCQF min cqf calc cqf OK Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values min cqf Minimum Calculated Quality Factor The minimum calibration quality facto...

Page 259: ...N A Unsolicited Response N A Parameter Values Z Cal Time Time in seconds used to calibrate the Z Axis while not moving MinSamples Minimum number of samples required for Dynamic calibration Thresh Min...

Page 260: ...TIME Max Duration THRLD SET TIME CLR TIME Max Duration THRLD SET TIME CLR TIME Max Duration THRLD SET TIME CLR TIME Max Duration Execute Syntax N A Execute Response N A Unsolicited Response N A Param...

Page 261: ...ax Duration THRLD SET TIME CLR TIME Max Duration THRLD SET TIME CLR TIME Max Duration THRLD SET TIME CLR TIME Max Duration Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Va...

Page 262: ...Read Response DVBLAL THRLD SET TIME CLR TIME THRLD SET TIME CLR TIME Max Duration Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values INDEX Left acceleration index numbe...

Page 263: ...e DVBRAL THRLD SET TIME CLR TIME THRLD SET TIME CLR TIME Max Duration Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values INDEX Right acceleration index number THRHLD Acc...

Page 264: ...e IMPTHR SENSOR THRHLD SET TIME gap_time Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values SENSOR Sensor Selection 1 High sample rate accelerometer 2 Reserved THRHLD Th...

Page 265: ...impact detection threshold for the high sample rate accelerometer to 3g 3000 milli g for a duration of at least 40 milliseconds AT IMPLOG Impact Detection Logging Configuration AT IMPLOG Impact Detec...

Page 266: ...to save accelerometer data sec_before_gps Impact detection seconds before for gps data Multiple seconds of GPS log data may be included within a single TLV record The number of seconds prior to the t...

Page 267: ...AL Read Response DVBVAL THRLD SET TIME CLR TIME Max Duration THRLD SET TIME CLR TIME Max Duration Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values INDEX Vertical accel...

Page 268: ...e OBDAM enable threshold count holdtime Execute Syntax N A Execute Response N A Unsolicited Response N A Parameter Values enable 0 Disable the any motion feature 1 Enable the any motion feature defaul...

Page 269: ...257 Event Tables...

Page 270: ...development and deployment into end solutions without the need of proprietary development platforms or embedded applications Event Category The event category parameter defines the actual Input or Out...

Page 271: ...t event will be executed when the value of an input event exceeds Parm1 previously it was Parm1 or less or decreases to a value less than Parm2 previously it was Parm2 or greater Example 2 An output e...

Page 272: ...event is 1 and Parm1 along with Parm2 is set to 1 2 Input Trigger An Input Trigger is defined as an input condition defined by event category that should be used as a logical AND condition to another...

Page 273: ...GPRS registration status information 11 0 or 1 0 or 1 Receipt of IP address 0 No IP address 1 Valid IP address obtained 12 1 1 Timer 1 set by AT EVTIM1 13 1 1 Timer 2 set by AT EVTIM2 14 1 1 Timer 3 s...

Page 274: ...nce 0 Leaving Geofence area 1 Entering Geofence area 32 0 or 1 0 or 1 Geo Fence 7 33 0 or 1 0 or 1 Geo Fence 8 34 0 or 1 0 or 1 Geo Fence 9 35 0 or 1 0 or 1 Geo Fence 10 36 0 or 1 0 or 1 Geo Fence 11...

Page 275: ...s msglogrd count 61 0 100 0 100 Memory full percentage msglogrd 62 0 or 1 0 or 1 Motion Status 0 Stopped 1 Moving 63 0 or 1 0 or 1 Power Source 0 main power not applied 1 main power applied 64 65 N A...

Page 276: ...N A Reserved 119 0 or 1 0 or 1 0 An alternate GPS overspeed interval has ended 1 An alternate GPS overspeed interval has begun 120 0 or 1 0 or 1 Polygon Geofence 0 See ATPLYFN for details on setting a...

Page 277: ...DII Deceleration Threshold 2 AT DVBDCL threshold 2 155 159 N A N A Reserved 160 0 to 4 0 to 4 Accelerometer vehicle orientation calibration status 0 orientation calibration initialization 1 orientatio...

Page 278: ...7 OBD Trip Odometer distance in meters The event will fire when the trip odometer is in between the settings of param 1 and param 2 193 197 N A N A Reserved 198 0 or 1 0 or 1 Excessive Acceleration 19...

Page 279: ...send UBI data 215 N A N A Reserved 216 0 or 1 0 or 1 Usage Based Insurance UBI data buffer is ready to send use output event 157 158 159 or 160 to send UBI data 217 0 or 1 0 or 1 Right accel threshol...

Page 280: ...ue stated by parm2 49 1 25 0 1000000 Set geo fence specified by parm1 to current latitude longitude with radius specified by parm2 50 0 57 0 to 1 Emulate AT EVTEST command viaevent engine Parm1 is the...

Page 281: ...le Index Table 129 0 9 0 9 Adds user variable indicated by parm1 to user variable indicated by parm2 and places result in user variable indicated by parm1 For example if parm1 is 4 parm2 is 5 and user...

Page 282: ...indicated by parm1 and the user variable indicated by parm2 and places result in user variable indicated by parm1 136 0 0 65535 Resets input event 17 distance to value in meters indicated by parm2 Typ...

Page 283: ...ed by ACKTM command for number of retries sent This message has to be acknowledged to avoid sending of retries These messages will be sent before any messages currently buffered for non priority UDP A...

Page 284: ...272 Bit Field Tables...

Page 285: ...3 to use for the Parm2 value Bit 31 Bit 30 Description 0 0 Table selector 0 Format message based on Parm2 values using Message Format Table 0 legacy format 0 1 Reserved 1 0 Table selector 2 Format mes...

Page 286: ...the last time that the engine speed exceeded the Excessive Engine Speed 1 threshold Bit 5 1 add ADC 2 value 2 bytes binary or 5 bytes ASCII 0 do not add ADC 2 value Bit 6 1 Message is stored in non v...

Page 287: ...Altitude information in Binary format or 0 bytes if Bit 0 is set to 0 0 do not add this particular field of GPS data Bit 16 1 add GPS data 1 byte of Number Of Satellites In View information in Binary...

Page 288: ...zz is the interval duration unit seconds ASCII format x y z space delineated length of each field varies with its value 0 do not add this particular field of GPS data Bit 25 1 Add cell information as...

Page 289: ...OBD Protocol Binary 1 byte ASCII a space delimiter followed by 3 digits for the protocol If the protocol is less that 3 digits it will be padded with leading spaces FW Version Binary 4 bytes ASCII a s...

Page 290: ...able in ASCII format Bit 1 1 Add parm1 data to message 4 bytes in binary format 11 bytes of data in ASCII format 0 do not add parm1 data to outbound message Bit 2 1 add MDMID value 22 bytes of ASCII d...

Page 291: ...Bit 7 1 add input event category number 1 byte in binary format 3 bytes in ASCII format 0 do not add input event category number Bits 8 14 Reserved Bits 15 17 Bit 15 is the least significant in the fo...

Page 292: ...ongitude is 09642 854492 W then the four bytes would be FF6CDC9A 9642854 Velocity 2 bytes in tenths of knots For example if GPRMC velocity is 21 1 knots then the two bytes would be 00D3 211 Time 3 byt...

Page 293: ...s formatted as described above then converted to ASCII HEX effectively doubling the number of bytes required to contain the information before being inserted into the message There are no spaces betwe...

Page 294: ...ve Acceleration Data ASCII format 14 bytes HHMMSS LLL MMM HHMMSS time at start of event LLL length of event in seconds MMM max acceleration deceleration Binary format 5 bytes 3 bytes HMS time at start...

Page 295: ...e of last current FOTA 871 InnoPath status of last firmware upgrade 870 FTP library status of last FOTA FTP 868 The calculated CQF AutoCal LPF2 Sample Count 867 The LPF2 MMA sample count AutoCal Quali...

Page 296: ...to AT EM 2 3 452 Copies Neighbor Cell 3 absolute radio frequency channel number ARFCN Equivalent to AT EM 2 3 451 Copies Neighbor Cell 3 cell ID Equivalent to AT EM 2 3 450 Copies Neighbor Cell 3 loca...

Page 297: ...M 2 1 402 Copies Serving Cell location area code Equivalent to AT EM 2 1 401 Copies Serving Cell MNC 0x00MMNNCC where MM NN and CC are the hex values of the ASCII representations of the MNC Equivalent...

Page 298: ...pies Longitude of GPS measurement 102 Copies Latitude of GPS measurement 101 Copies Time of GPS measurement 100 Copies Date of GPS measurement 99 Copies GPS TTF Time to First Fix 98 Copies GPS Leap se...

Page 299: ...s current RTC date 0x00YYMMDD where YY last two digits of year 00 99 MM month 1 12 DD day of month 1 31 19 to 9 Reserved 8 Copies current count of event timer 8 in seconds equivalent to EVTIMQRY 8 7 C...

Page 300: ...of Input Event 7 GPIO8 0 Low 1 High 8 Copies value of Input Event 8 modem power up indication Always 1 9 Copies value of Input Event 9 modem GSM registration See AT CREG command description for GSM r...

Page 301: ...es value of Input Event 17 Maximum velocity in knots 18 Copies value of Input Event 18 ADC1 status 19 to 20 Reserved 21 Copies value of Input Event 21 Geofence 1 0 Leaving geofence area 1 Entering geo...

Page 302: ...conds 31 Copies value of Input Event 31 Geofence 6 0 Leaving geofence area 1 Entering geofence area 32 Copies value of Input Event 32 Geofence 7 0 Leaving geofence area 1 Entering geofence area 33 Cop...

Page 303: ...ent 41 Geofence 16 0 Leaving geofence area 1 Entering geofence area 42 Copies value of Input Event 42 Geofence 17 0 Leaving geofence area 1 Entering geofence area 43 Copies value of Input Event 43 Geo...

Page 304: ...tion 0 SMS message read from SIM 1 New SMS message received 53 Copies value of Input Event 53 Current Input Event Counter count that can be used as an AND condition with other input events 54 Copies v...

Page 305: ...Input Event 100 User variable 0 101 Copies value of Input Event 101 User variable 1 102 Copies value of Input Event 102 User variable 2 103 Copies value of Input Event 103 User variable 3 104 Copies...

Page 306: ...econds The toggle count is set by Parm2 The flashing GPIO event will cause the GPIO output state to toggle at time 0 to the opposite state prior to starting the GPIO output flash event processing This...

Page 307: ...ermine which of the four bit field tables 0 3 to use for the Parm2 value Bit Field Table Selection Bit 31 Bit 30 Description 0 0 Table selector 0 Format message based on Parm2 values using Message For...

Page 308: ...temperature threshold to 90c 90 40 130 Bit 4 1 add Peak Engine Speed data to outbound message 2 bytes in Binary format 5 bytes of data in ASCII format 0 do not add Peak Engine Speed data to outbound m...

Page 309: ...ytes of Time information in Binary format or 0 bytes if Bit 0 is set to 0 0 do not add this particular field of GPS data Bit 15 1 add GPS data 3 bytes of Altitude information in Binary format or 0 byt...

Page 310: ...g spaces if less than 20 chars OBD Protocol Binary 1 byte ASCII a space delimiter followed by 3 digits for the protocol If the protocol is less than 3 digits it will be padded with leading spaces FW V...

Page 311: ...299 BIT 29 1 Add OBDII Trip Odometer Data 0 Do not add OBDII Trip Odometer Data Data Format Binary 4 bytes ASCII a space delimeter followed by 7 digits for the trip distance Bits 30 31 Reserved...

Page 312: ...300 OBD Parm 3 BIT FIELD TABLE Parm 3 Bank 1 Parm3 OBD 1 0 Parameter User Variable OBD Parm Bit Notes Vehicle Battery Voltage None Parm3 Bank 1 0x40000002 OBD data parm3 2 bytes...

Page 313: ...301 Appendix Result Codes...

Page 314: ...302 Appendix A Result Codes...

Page 315: ...nd successful completed ready CONNECT 1 entering data transfer state RING 2 Ring indication detected NO CARRIER 3 connection terminated ERROR 4 Command abnormally completed ready NO DIALTONE 6 Dial to...

Page 316: ...sult Code AT CMEE x COLP number type subaddr satype alpha Connected Line Identification Presentation AT COLP 1 CR type Service Reporting Control AT CR 1 CREG stat lac ci Registration status indication...

Page 317: ...short message AT CNMI 1 1 CMT length CR LF pdu Short Message output Directly to TE PDU mode AT CNMI 1 2 CBM sn mid dcs page pages CR LF data Incoming Cell Broadcast Message routed directly to TE AT CN...

Page 318: ...306 Appendix Error Codes...

Page 319: ...307 Appendix B Error Codes...

Page 320: ...index 22 not found 23 memory failure 24 text string too long 25 invalid characters in text string 26 dial string too long 27 invalid characters in dial string 30 no network service 31 network timeout...

Page 321: ...dem Verbose Response 44 service provider personalization PIN required 45 service provider personalization PUK required 46 corporate personalization PIN required 47 corporate personalization PUK requir...

Page 322: ...lure 42 congestion 47 resources unavailable unspecified 50 requested facility not subscribed 69 requested facility not implemented 81 invalid short message transfer ref value 95 invalid message unspec...

Page 323: ...5 unspecified TP Command error 176 TPDU not supported 192 SC busy 193 no SC subscription 194 SC system failure 195 invalid SME address 196 destination SME barred 197 SM rejected duplicate SM 208 SMS s...

Page 324: ...Modem Verbose Response 320 memory failure 321 invalid memory index 322 memory full 330 SMSC address unknown 331 no network service 332 network timeout 340 no CNMA acknowledgement expected 500 unknown...

Page 325: ...busy 18 no user responding 19 user alerting 21 call rejected 22 number changed 26 non selected user clearing 27 destination out of order 28 invalid number format 29 facility rejected 30 response to s...

Page 326: ...not implemented 70 only restricted bearer cap avail 79 service not implemented 81 invalid TI 87 no member of CUG 88 incompatible destination 91 invalid transit network selection 95 incorrect message 9...

Page 327: ...315 Error Description 104 GPRS PDP context deactivation 128 No Service 202 timer 303 expiry 203 establishment failure 210 no error 211 operation failed 212 timeout 213 bearer service not compatible...

Page 328: ...service table full 5 call not found 6 no data call supported 7 one call on hold 8 hold call not supported for this type 9 number not allowed by FDN 10 number not allowed by BDN 11 parallel USSD not su...

Page 329: ...FG 168 FTPCHDIR 169 FTPCLOSE 170 FTPDIR 171 FTPGET 161 172 FTPOPEN 167 173 FTPPUT 174 FTPRST 175 GEOFNC 184 206 261 GFDBNC 185 GFDEL 186 GPSCMD 187 GPSFD 188 GPSFLT 189 GPSLCL 194 GPSOSI 196 276 GPSQU...

Page 330: ...CPAPI 86 92 117 TCPIDLETO 88 TCPRESTRT 89 92 TCPRETRYTO 90 TCPSRC 91 TCPSTATS 92 TCPURC 94 TODOM 209 UDPMSG 121 USRVAL 144 V 53 WAKEUP 102 106 123 CGREG 261 288 EM 283 SLEEP 241 SNCNT 125 F 54 102 104...

Reviews:

No comments