background image

M110 Series

Cellular Modem

mPACK Command Reference

Part number PMD-00035

Revision A September 2019

Summary of Contents for M110 Series

Page 1: ...M110 Series Cellular Modem mPACK Command Reference Part number PMD 00035 Revision A September 2019 ...

Page 2: ...censed under the Berkeley Software Distribution BSD li cense the GNU General Public License GPL as published by the Free Software Foundation FSF or the Python Software Foundation PFS License Agreement for Python 2 7 3 Python License Lantronix grants you no right to receive source code to the Open Source software however in some cases rights and access to source code for certain Open Source softwar...

Page 3: ...ss usefulness suitability or performance of the information provided herein Lantronix shall have no liability whatsoever to any user for any damages losses and causes of action whether in contract or in tort or otherwise in connection with the user s access or usage of any of the information or content contained herein The information and specifications contained in this document are subject to ch...

Page 4: ...us Indicator 10 2 6 Factory reset 11 3 Administration Commands 12 3 1 AT INFO 12 3 2 AT CONFIGDEL 12 3 3 AT RESET 13 3 4 AT MRST 13 3 5 AT NWRST 13 3 6 AT MATSCR 14 3 7 AT USBATCOM 15 3 8 AT PASS 15 3 9 AT STRUPMSG 16 4 Hardware commands 18 4 1 AT SERIAL 18 4 2 AT HFLW 18 4 3 AT SETRTC 19 4 4 AT GETRTC 20 4 5 AT VIO 20 4 6 AT VAMODE 21 4 7 AT RDIO 22 M110 Series Cellular Modem mPACK Command Refere...

Page 5: ...AT IPTCP 29 7 2 AT IPUDP 30 7 3 AT AUTOTCP 30 7 4 AT AUTOUDP 31 7 5 AT OTCP 32 7 6 AT OUDP 32 7 7 AT SCHOST 33 7 8 AT IPOPT 34 7 9 AT AUOPT 35 7 10 AT SERVAUTH 36 7 11 AT MURC 36 8 Remote Control Commands 38 8 1 AT SMSAT 38 8 2 AT TCPTERM 39 9 Firmware Update Commands 41 9 1 AT WEBUPDATE 41 9 2 AT UPDATE 41 10 D2Sphere Commands 43 10 1 AT IPD2S 43 10 2 AT D2S 43 M110 Series Cellular Modem mPACK Co...

Page 6: ...mands 50 12 1 AT MLOC 50 13 Applications Notes 51 13 1 Cellular Setup Example 51 13 2 AutoTCP Client Setup Example 51 13 3 AutoTCP Server Setup Example 52 13 4 Flow diagram of Auto TCP UDP Connection 53 14 Troubleshooting 55 14 1 The modem s LED does not light 55 14 2 The modem s GREEN LED blinks but does not become stable for a long time after power up 55 14 3 The modem does not respond to the te...

Page 7: ...List of Figures 8 1 1Example of remote AT command by SMS 38 13 4 1 Auto TCP UDP Flow Diagram 54 M110 Series Cellular Modem mPACK Command Reference 6 ...

Page 8: ... Please contact authorized dealer on finding an approved antenna Always keep the antenna with minimum safety distance of 26 6 cm or more from human body Do not put the antenna inside metallic box containers etc Protecting your modem To ensure error free usage please install and operate your modem with care Remember the following Do not expose the modem to extreme conditions such as high humidity t...

Page 9: ...Chapter 1 Introduction 3G 5 76 7 2 Mbps NB IoT 62 5 27 2 kbps LTE M1 375 375 kbps LTE cat 1 5 10 Mbps M110 Series Cellular Modem mPACK Command Reference 8 ...

Page 10: ... as listed below provides extra functionality and greatly improves the ro bustness of the wireless connected system Automatic and self recovery TCP UDP socket connection AT command driven TCP UDP socket connection Ping Service Network Watchdog Input output and Analog triggered AT command Remote AT command through SMS and TCP Terminal Remote program updating Socket data sending 2 2 Getting Started ...

Page 11: ...mands start with AT are the only ones covered in this document e g AT INFO Error codes for uBlox commands are as described in the uBlox AT command manual Error codes for mPACK commands are as follows ERROR BAD PARAMETER for wrong parameters or out of range values ERROR UNKNOWN COMMAND for wrong command syntax 2 5 LED Status Indicator The LED will indicate different status of the modem For Orange L...

Page 12: ...vice hold the reset pin for over 30 seconds Initially both LED s are off After 5 seconds the green LED will go on and the orange LED remains off After 30 seconds the orange LED will go on and the green LED goes off M110 Series Cellular Modem mPACK Command Reference 11 ...

Page 13: ...8022601ALPHA01 FLASH ID 0xef 0x4015 OK state AT INFO HW_version M110Series 01V Cellular_Module u blox SARA U201 23 60 Bootcode_version mPACK_boot_1 0_rc1_b2017112301 SW_build mPACK_m110_2 1_rc0_2018022601ALPHA01 FLASH ID 0xef 0x4015 OK info AT INFO OK 3 2 AT CONFIGDEL Factory reset device configuration ALLOWED exec Note Device restarts after this command is executed AT CONFIGDEL exec AT CONFIGDEL ...

Page 14: ...tate info AT MRST mode delay mode timer reset mode 0 disabled 1 enabled delay time set to reset the embedded module range 000 01 167 59 format hhh mm remainTime time before next reset range 000 01 167 59 format hhh mm exec AT MRST 1 100 00 OK state 1 minute after executing the exec command AT MRST MRST 1 100 00 099 59 OK info AT MRST OK 3 5 AT NWRST Controls reset of the modem in case of network f...

Page 15: ...fault 5 counter 10 1000 count of consecutive network failures after which the device will reset if option 1 Default 10 exec AT NWRST 2 10 18 OK state AT NWRST NWRST 0 10 18 OK info AT NWRST NWRST 0 2 5 120 10 1000 OK 3 6 AT MATSCR Enters a list of modem internal AT commands cannot be mPACK AT commands that will be executed at each start up ALLOWED exec state info AT MATSCR list_of_commands list of...

Page 16: ...nd allow cellular AT commands on the serial port 1 to reverse the ports exec AT USBATCOM 1 OK state AT USBATCOM USBATCOM 1 OK info AT USBATCOM USBATCOM 0 1 OK 3 8 AT PASS Enables Disables pass through mode ALLOWED exec state info Note This command applies to a specific version of software only In M113 NB user can enter either mPACK commands usually beginning with AT or u Blox com mands usually beg...

Page 17: ...t pass through mode is desired Issue and the modem should exit pass through mode AT PASS 0 to make the switch permanent otherwise the modem will be in pass through mode again when it restarts AT PASS flag flag 0 to disable pass through mode 1 to enable Default 0 Note all commands work only when pass through mode is 0 exec AT PASS 1 OK state AT PASS PASS 0 OK info AT PASS PASS 0 1 OK 3 9 AT STRUPMS...

Page 18: ...te that there is always a startup message and the default startup message is READY which can be selected using as the text argument and shown as in state query exec AT STRUPMSG Hello OK state AT STRUPMSG STRUPMSG Hello OK info AT STRUPMSG STRUPMSG 60 OK M110 Series Cellular Modem mPACK Command Reference 17 ...

Page 19: ...eset if AT SERIAL exec command is issued AT SERIAL baud charFraming flowCtrl baud one of 1200 2400 4800 9600 19200 38400 57600 115200 charFraming one of 8N1 8N2 9O1 9E1 See also note above flowCtrl 0 disable 1 enable exec AT SERIAL 115200 8N1 0 OK state AT SERIAL SERIAL 115200 8N1 0 OK info AT SERIAL SERIAL 1200 2400 4800 9600 19200 38400 57600 115200 8N1 8N2 9O1 9E1 0 1 OK 4 2 AT HFLW Enable or d...

Page 20: ... time clock ALLOWED exec state info AT SETRTC op value1 value2 value3 op 0 enter time value1 value2 value3 hh mm ss 1 enter date value1 value2 value3 YY MM DD 2 start or stop the RTC clock value1 hour if op is 0 year if op is 1 1 to enable RTC and 0 to disable RTC if op is 2 value2 minute if op is 0 month if op is 1 value3 second if op is 0 day if op is 1 M110 Series Cellular Modem mPACK Command R...

Page 21: ...TRTC Get the real time clock ALLOWED exec state info AT GETRTC exec AT GETRTC GETRTC 2018 03 05 16 50 48 OK state AT GETRTC ERROR info AT GETRTC ERROR 4 5 AT VIO Command to configure Versatile I O ALLOWED exec state info AT VIO channel mode channel 1 or 2 mode DI digital input DO digital output M110 Series Cellular Modem mPACK Command Reference 20 ...

Page 22: ...DE Command to set current or voltage mode ALLOWED exec state info AT VAMODE channel AN_mode channel 1or 2 AN_mode mode within Analogue 0 voltage mode 1 current mode exec Set channel 1 to current mode AT VAMODE 1 1 OK state AT VAMODE VAMODE 1 0 VAMODE 2 0 OK info AT VAMODE VAMODE 1 2 0 1 OK M110 Series Cellular Modem mPACK Command Reference 21 ...

Page 23: ...oltage in mV or current in mA which one depends on AT VAMODE exec AT RDIO 1 RDIO 1 AN 35 OK state AT RDIO ERROR info AT RDIO RDIO 1 2 OK 4 8 AT OPSET To control versatile I O in output mode ALLOWED exec info Note On Power up the device output state will be reset Before setting the output value the channel need to be configured as digital output first AT OPSET channel status M110 Series Cellular Mo...

Page 24: ...Chapter 4 Hardware commands channel 1 or 2 status 0 or 1 exec AT OPSET 1 1 OK state AT OPSET ERROR info AT OPSET OPSET 1 2 0 1 OK M110 Series Cellular Modem mPACK Command Reference 23 ...

Page 25: ...st gasp SMS 2nd argument specifies which situation applies 2 Edt the mobile number argument for mode 1 1 to enable power down SMS 2 to enable power up SMS 3 to enable both for mode 2 mobile number to which Last Gasp SMS is sent exec AT LGPARA 2 919876543210 OK AT LGPARA 1 3 OK state AT LGPARA LGPARA 3 919876543210 OK info AT LGPARA LGPARA 0 2 1 3 10 29 OK 5 2 AT LGMSG Last gasp SMS message content...

Page 26: ...wn 2 Configure last gasp SMS for power up arg for message content of the SMS up to 60 printable ASCII characters exec AT LGMSG 2 M110 modem powered up OK state AT LGMSG LGMSG 1 M110 modem powered down LGMSG 2 M110 modem powered up OK info AT LGMSG LGMSG 1 2 60 OK M110 Series Cellular Modem mPACK Command Reference 25 ...

Page 27: ...lular data access If no password is needed can omit the argument and mPACK software will use a non null but meaningless value when state is read CID context ID Please consult Lantronix team on when to use this parameter and what value to use exec AT IPCELLULAR 1 CMHK OK state AT IPCELLULAR IPCELLULAR 1 internet 8 OK info AT IPCELLULAR IPCELLULAR 1 64 25 25 1 11 OK 6 2 AT IPCONNECT The 1st paramete...

Page 28: ...T IPCONNECT IPCONNECT 1 0 1 OK 6 3 AT GETBRIP Get the IP address when data activated ALLOWED state info NOTE The command returns only IPv4 address for now AT GETBRIP state AT GETBRIP GETBRIP 1 1 182 153 105 197 OK info AT GETBRIP GETBRIP 1 0 1 IPV4 or IPV6 OK 6 4 AT IPPING IP PING configuration ALLOWED exec state info M110 Series Cellular Modem mPACK Command Reference 27 ...

Page 29: ...in ms before ping is timed out Default value is 10 Valid range is 5000 to 60000 NOTE The IPPING command is just used for setting the PING address and parameters interval timeout for use by oher functions This command cannot be used to directly PING a given address in the current implementation exec AT IPPING 2 8 8 8 8 4 10 5000 OK state AT IPPING IPPING 8 8 8 8 4 10 5000 OK info AT IPPING IPPING 0...

Page 30: ...rimary IP of remote TCP server client mode only 2 set backup IP of remote TCP server client mode only port number from 0 to 65535 mode C Modem as client to remote server S Modem as server for remote client to connect ip IP address of remote partner IPv4 dotted notation delay deprecated no need to enter exec AT IPTCP 1 50002 C 162 242 170 48 OK state AT IPTCP IPTCP 1 50002 C 162 242 170 48 1 IPTCP ...

Page 31: ...mmand not applicable to UDP port number from 0 to 65535 mode C Modem to connect to remote UDP server S Modem waiting for remote UDP client to connect ip IP address of remote partner IPv4 dotted notation delay delay deprecated no need to enter exec AT IPUDP 1 50003 C 162 242 170 47 OK exec AT IPUDP IPUDP 1 50003 C 162 242 170 47 1 IPUDP 2 0 C 1 OK exec AT IPUDP IPUDP 1 2 0 65535 C S 120 0 1 OK 7 3 ...

Page 32: ...TCP 0 OK info AT AUTOTCP AUTOTCP 0 1 OK 7 4 AT AUTOUDP Command to Start Auto UDP functionality ALLOWED exec state info AT AUTOUDP mode mode 0 AUTOUDP connection OFF 1 AUTOUDP connection ON exec AT AUTOUDP 0 OK state AT AUTOUDP AUTOUDP 0 OK info AT AUTOUDP AUTOUDP 0 1 OK M110 Series Cellular Modem mPACK Command Reference 31 ...

Page 33: ...mand is accepted It does not mean that the device is connected to the server CONNECT should appear on the appropriate terminal UART or USB if connection is successful state AT OTCP OTCP 0 OK info AT OTCP OTCP 0 1 OK 7 6 AT OUDP On demand UDP socket connection ALLOWED exec state info AT OUDP mode mode 0 UDP connection OFF 1 UDP connection ON exec AT OUDP 0 OK state M110 Series Cellular Modem mPACK ...

Page 34: ... oper 0 enter host setting 1 read host setting 2 erase host setting id only 1 for now server IP address of host IPv4 or text notation port port number on host retry delay type DEPRECATED Not settable exec AT SCHOST 0 1 162 242 170 59 8888 OK state AT SCHOST 1 1 SCHOST 1 162 242 170 59 8888 1 1 0 OK info AT SCHOST 0 2 1 120 0 65535 0 10 1 60 0 1 OK M110 Series Cellular Modem mPACK Command Reference...

Page 35: ...ration to send keep alive packet in seconds 0 disables the feature for option 2 0 1472 TCP Packet size if 0 default size is used for option 4 1 65535 Time period of PING If 0 then PING is disabled for option 5 0 to disable 1 to enable data on first connection 2 to edit the string to be sent action To specify the action will be taken if a set of ping action fail 0 do nothing default If ping fails t...

Page 36: ... option 1 0 43200 Duration of connection without data transfer in seconds 0 disables the feature for option 2 0 43200 Duration of SERVER without a connected remote client in seconds 0 disables the feature for option 3 0 43200 Duration of connection in seconds 0 disables the feature for option 4 0 to disable 1 to enable connection prefix 2 to edit the string to be sent for option 5 0 180 Period of ...

Page 37: ...lease refer to AT TCPTERM on the sequence for AT SERVAUTH AT SERVAUTH mode password mode 0 Disable server authentication 1 Enable server authentication 2 Configure password password 6 characters enclosed in double quotes Default 000000 exec AT SERVAUTH 2 123456 OK info AT SERVAUTH SERVAUTH 0 2 6 OK 7 11 AT MURC Enables Disables CONNECT message upon Socket connection and DISCONNECT message upon soc...

Page 38: ... 0 to disable cellular AT commands on the USB port and allow cellular AT commands on the serial port 1 to reverse the ports exec AT MURC 1 OK state AT MURC MURC 1 OK info AT MURC MURC 0 1 OK M110 Series Cellular Modem mPACK Command Reference 37 ...

Page 39: ...AT SMSAT command default key is 000000 c The 7th and 8th characters of the SMS content is AT in capital letters 2 If SMSAT is enabled the modem will read each incoming SMS if the conditions mentioned in 1 are matched the message will be executed even it is an invalid AT command 3 When using SMSAT feature only CNMI x 1 x x x setting could be used i e incoming message will be stored in SIM card 4 Th...

Page 40: ... mode param mode 0 Disable SMSAT 1 Enable SMSAT 2 Change the password for SMSAT 3 Change the SMS response trigger param for mode 2 password 6 alphanumeric characters in quotes for mode 3 0 to disable SMS response 1 to enable SMS response not needed for modes 0 or 1 exec AT SMSAT 2 123456 OK state AT SMSAT SMSAT 0 123456 0 OK info AT SMSAT SMSAT SMSAT 0 3 6 0 2 OK 8 2 AT TCPTERM Parameter configura...

Page 41: ... port timeout password max 16 characters Default 000000 port port used on the modem for incoming TCP connection Default 23 timeout specified in seconds Default 30 exec AT TCPTERM 2 000000 23 30 OK state AT TCPTERM TCPTERM 0 000000 23 30 OK info AT TCPTERM TCPTERM 0 2 16 1 65535 1 43200 OK M110 Series Cellular Modem mPACK Command Reference 40 ...

Page 42: ...lename up to 120 characters in quotes port port of the server on which the update file is stored the default value is updates d2sphere com ip IP address of the server on which the update file is stored the default value is 80 exec AT WEBUPDATE mpack mpack_R0100 bin 80 3 252 19 23 OK state AT WEBUPDATE WEBUPDATE mpack mpack_R0100 bin 80 3 252 19 23 OK info AT WEBUPDATE WEBUPDATE 120 0 65535 120 OK ...

Page 43: ...ter 9 Firmware Update Commands 0 stop the update process 1 stop the update process exec AT UPDATE 0 OK state AT UPDATE UPDATE 0 OK info AT UPDATE ERROR M110 Series Cellular Modem mPACK Command Reference 42 ...

Page 44: ...here server IP address IP address of D2sphere server in IPv4 dotted notation delay delay to start in seconds Range 0 43200 exec AT IPD2S 4444 5 35 253 3 1000 OK exec AT IPD2S IPD2S 4444 5 35 253 3 1000 OK exec AT IPD2S IPD2S 0 65535 120 0 43200 OK 10 2 AT D2S Enable or disable D2Sphere function ALLOWED exec state info AT D2S mode mode 0 disable M110 Series Cellular Modem mPACK Command Reference 43...

Page 45: ...ME name name name of the device in quotes exec AT DVNAME M11x_001 OK state AT DVNAME DVNAME M11x_001 OK info AT DVNAME DVNAME 23 OK 10 4 How to add a M110 modem to D2sphere platform feature For D2sphere support for the M110 modem please consult Lantronix representative for enabling the sup port and obtaining a D2sphere account M110 Series Cellular Modem mPACK Command Reference 44 ...

Page 46: ...t of all devices under the control of the current user Press Add at the upper right Fill in the IMEI of the device to be added Press Register Refresh the administrate page Note that it may take a few minutes for the device to be registered and then a few more minutes for information about the device to be obtained 10 5 Operation of D2sphere The most updated information are on the following web pag...

Page 47: ...l 0 32 in V must be min_val debounce 0 500 in seconds exec AT DITRIG 1 3000 11250 10 OK state AT DITRIG DITRIG 1 3000 11250 10 DITRIG 2 0 3200 0 OK info AT DITRIG DITRIG 1 2 0 32 0 32 0 500 OK 11 2 AT DITRIGENB Enable DI trigger parameters ALLOWED exec state info AT DITRIGENB pin_number enb trigger_type pin_number 1 2 enb 0 disable trigger M110 Series Cellular Modem mPACK Command Reference 46 ...

Page 48: ...nfo AT DITRIGENB DITRIGENB 1 2 0 1 0 3 OK 11 3 AT MSGPER Configure Message ID and message strings associated with the 2 pins ALLOWED exec state info AT MSGPER pin_number interval count pin_number 1 2 interval how often messages are generated in sec Value 0 60000 count number of messages generated Value 0 100 exec AT MSGPER 2 10 3 OK state AT MSGPER MSGPER 1 0 0 MSGPER 2 10 3 OK M110 Series Cellula...

Page 49: ... yet implemented 1 enable message string not yet implemented 2 configure message string msg_ID message ID msg1 concatenated with msg_ID for DI1 msg2 concatenated with msg_ID for DI2 exec AT MSGSTR 2 Lantronix 001 234 OK state AT MSGSTR MSGSTR 2 Lantronix 001 234 OK info AT MSGSTR MSGSTR 0 2 120 5 5 OK 11 5 AT TRANSMODE Configure I O event reporting mode ALLOWED exec state info AT MSGSTR mode M110 ...

Page 50: ...ng mode 3 UDP reporting mode 4 FTP reporting mode 5 HTTP reporting mode 6 customer specific mode not available to general customer 7 D2sphere reporting mode exec AT TRANSMODE 1 OK state AT TRANSMODE TRANSMODE 1 OK info AT TRANSMODE TRANSMODE 0 7 OK M110 Series Cellular Modem mPACK Command Reference 49 ...

Page 51: ...itude longitude altitude uncertainty speed direction vertical_acceleration sensor_used SV_used antenna_status jamming_status ALLOWED state info AT MLOC state AT MLOC MLOC 31 07 2019 10 21 16 000 0 0000000 0 0000000 0 20000000 0 0 0 0 0 0 0 OK info AT MSGSTR MSGSTR 0 2 120 5 5 OK M110 Series Cellular Modem mPACK Command Reference 50 ...

Page 52: ...et the cellular data network by configuring the sim slot APN Username and Password AT IPCELLULAR IPCELLULAR SIM1 internet 8 OK This commands reads what is the current setting AT IPCELLULAR IPCELLULAR 1 64 25 25 1 11 OK The command is used to give the valid range of all parameters 13 2 AutoTCP Client Setup Example Note 1 AutoTCP should be disabled before changing any AT IPCELLULAR and AT IPTCP para...

Page 53: ...UTOTCP AUTOTCP 0 OK This command checks the current status of AutoTCP AT AUTOTCP OK This command turns on AutoTCP Notes After enabling for client mode CONNECT should appear on the UART USB port of the modem approximately 20 seconds after wards Thereafter the port is turned into data mode where no AT commands are accepted Every byte sent in data mode goes to the remote peer If is sent in data mode ...

Page 54: ...the read response This parameter is deprecated and can be ignored The AT AUTOTCP command is used to enable or disable AutoTCP by AT AUTOTCP enable disable where enable disable 1 to enable 0 to disable Notes After enabling for server mode After at most 30 seconds the modem is ready as server When external client connects to the modem the serial USB port is turned into data mode Every byte sent in d...

Page 55: ...Chapter 13 Applications Notes Figure 13 4 1 Auto TCP UDP Flow Diagram M110 Series Cellular Modem mPACK Command Reference 54 ...

Page 56: ...d has been properly inserted Check if the SIM card has been locked refer to AT CPIN command in AT command guide Check if the external power has been properly connected to the modem Check if the network coverage is available 14 3 The modem does not respond to the terminal program Check if the RS 232 cable has been properly connected Check if your program has proper settings Factory setting of the U...

Reviews: