NetComm HSPA+ M2M User manual

M2M CDMA Router
SMS Tools User Guide

2
M2M CDMA Router – SMS Tools User Guide
www.netcommwireless.com
Copyright
Copyright© 2013 NetComm Wireless Limited. All rights reserved.
The information contained herein is proprietary to NetComm Wireless. No part of this document may be translated, transcribed,
reproduced, in any form, or by any means without prior written consent of NetComm Wireless.
Please note: This document is subject to change without notice.
DOCUMENT VERSION
DATE
Initial document release November 2013
Table 1 - Document Revision History
Note: Before performing the instructions in this guide, please ensure that you have the latest firmware version installed on
your router. Visit http://www.netcommwireless.com/product/m2m/nwl-11 to download the latest firmware. Please also
ensure that the SMS service is available on your mobile account.

www.netcommwireless.com
M2M CDMA Router – SMS Tools User Guide
3
Table of contents
Introduction....................................................................................................................................................................................4
Diagnostics ...................................................................................................................................................................................................8
Sending an SMS Diagnostic Command........................................................................................................................................................11

4
M2M CDMA Router – SMS Tools User Guide
www.netcommwireless.com
Introduction
The M2M CDMA Router offers an advanced SMS feature set, including sending messages, receiving messages, redirecting
incoming messages to another destination, as well as supporting remote commands and diagnostics messages.
Some of the functions supported include:
Ability to send a text message via a CDMA network and store it in permanent storage.
Ability to receive a text message via a CDMA network and store it in permanent storage.
Ability to forward incoming text messages via a CDMA network to another remote destination which may be a
TCP/UDP server or other mobile devices.
Ability to receive run-time variables from the device (e.g. uptime) on request via SMS
Ability to change live configuration on the device (e.g. network username) via SMS.
Ability to execute supported commands (e.g. reboot) via SMS
Ability to trigger the M2M CDMA Router to download and install a firmware upgrade
Ability to trigger the M2M CDMA Router to download and apply a configuration file
To access the SMS messaging functions of the M2M CDMA Router, click on the Services menu item from the top menu bar, and
then select one of the options under the SMS messaging section on the left hand menu.
Setup
The Setup page provides the options to enable or disable the SMS messaging functionality and SMS forwarding functionalities of
the router. SMS messaging is enabled by default.
Figure 1 - General SMS Configuration

www.netcommwireless.com
M2M CDMA Router – SMS Tools User Guide
5
OPTION DEFINITION
General SMS Configuration
SMS Toggles the SMS functionality of the router on and off.
Messages Per Page (10-50) The number of SMS messages to display per page. Must be a value between 10 and 50.
Encoding Scheme
The encoding method used for outbound SMS messages. GSM 7-bit mode permits up to 160
characters per message but drops to 50 characters if the message includes special characters.
UCS-2 mode allows the sending of Unicode characters and permits a message to be up to 50
characters in length.
SMS Forwarding Setup
Forwarding Toggles the SMS forwarding function of the router on and off.
Redirect to Mobile Enter a mobile number as the destination for forwarded SMS messages.
TCP server IP address Enter an IP address or domain name as the destination for forwarded SMS messages using
TCP.
TCP Port The TCP port on which to connect to the remote destination.
UDP server IP address Enter an IP address or domain name as the destination for forwarded SMS messages using
UDP.
UDP Port The UDP port on which to connect to the remote destination.
Table 2 - SMS Setup Settings
SMS Forwarding Setup
Incoming text messages can be redirected to another mobile device and/or a TCP/UDP message server.
Redirect to Mobile
You can forward incoming text messages to a different destination number. This destination number can be another mobile phone
or a 3G router phone number.
For Example:
If someone sends a text message and Redirect to mobile is set to “[phone]”, the text message is stored on the router and
forwarded to “[phone]” at the same time.
To disable redirection to a mobile, clear the Redirect to mobile field and click the Save button.
Redirect to TCP / UDP address
You can also forward incoming text messages to a TCP/UDP based destination. The TCP or UDP server can be any kind of public
or private server if the server accepts incoming text-based messages.
The TCP/UDP address can be an IP address or domain name. The port number range is from 1 to 65535. Please refer to your
TCP/UDP based SMS server configuration for which port to use.
For Example:
If someone sends a text message and TCP address is set to “192.168.20.3” and TCP port is set to “2002”, this text message is
stored in the router and forwarded to “192.168.20.3” on port “2002” at the same time.
To disable redirection to a TCP or UDP address, clear the TCP address and UDP address fields and click the Save button.

6
M2M CDMA Router – SMS Tools User Guide
www.netcommwireless.com
New message
The New message page can be used to send SMS text messages to a single or multiple recipients.
A new SMS message can be sent to a maximum of 100 recipients at the same time. After sending the message, the result is
displayed next to the destination number as “Success” or “Failure” if the message failed to send. By default, only one destination
number field is displayed. Additional destination numbers may be added one at a time after entering a valid number for the current
destination number field. To add a destination number, click the button and to remove the last destination in the list, click the
button.
Figure 2 - SMS - New Message
Destination numbers should begin with the “+” symbol followed by the country calling code. To send a message to a destination
number, enter the “+” symbol followed by the country calling code and then the destination number.
For example:
To send a message to the mobile destination number 0412345678 in Australia (country calling code 61), enter
“[phone]”.
After entering the required recipient numbers, type your SMS message in the New message field. As you type your message, a
counter shows how many characters you have entered out of the total number available for your chosen encoding scheme. When
you have finished typing your message and you are ready to send it, click the Send button.

www.netcommwireless.com
M2M CDMA Router – SMS Tools User Guide
7
Inbox / Outbox
The Inbox displays all received messages that are stored on the router while the Outbox displays all sent messages.
Figure 3 - SMS Inbox
Figure 4 - SMS Outbox
ICON DESCRIPTION
Forward button. Click this button to open a new message window where you can forward the corresponding
message to another recipient.
Reply button. Click this button to open a new message window where you can reply to the sender.
Add to White list. Click this button to add the sender’s mobile number to the white list on the router.
Delete button. Click this button to delete the corresponding message.
Refresh button. Click this button to refresh the inbox or outbox to see new messages.
Table 3 - Inbox/Outbox icons

8
M2M CDMA Router – SMS Tools User Guide
www.netcommwireless.com
Diagnostics
The Diagnostics page is used to configure the SMS diagnostics and command execution configuration. This enables you to change
the configuration, perform functions remotely and check on the status of the router via SMS commands.
To access the Diagnostics page, click on the Services menu item then select the SMS menu on the left and finally select
Diagnostics beneath it.
Figure 5 - SMS diagnostics and command execution configuration
SMS Diagnostics and Command Execution Configuration
The options on this page are described below.
Enable Remote Diagnostics
Enables or disables the remote diagnostics feature. If this setting is enabled all incoming text messages are parsed and tested for
remote diagnostics commands.
If remote diagnostics commands are found, the router executes those commands. This feature is enabled by default. All remote
diagnostic commands that are received are stored in the Inbox.
Note: It is possible to adjust settings and prevent your router from functioning correctly using remote diagnostics. If this
occurs, you will need to perform a factory reset in order to restore normal operation.
We highly recommended that you use the white list and a password when utilising this feature to prevent unauthorised
access. See the White list description for more information.

www.netcommwireless.com
M2M CDMA Router – SMS Tools User Guide
9
Authentication
Enables or disables checking the sender’s phone number against the allowed sender white list for incoming diagnostics and
command execution SMS messages.
If authentication is enabled, the router will check if the sender’s number exists in the white list. If it exists, the router then checks the
password (if configured) in the incoming message against the password in the white list for the corresponding sending number. If
they match, the diagnostic or command is executed.
If the number does not exist in the white list or the password does not match, the router does not execute the incoming diagnostic
or command in the SMS message.
This is enabled by default and it is strongly advised that you leave this feature enabled to maintain security.
Send Ack. SMS for Set Command
The M2M CDMA Router will automatically reply to certain types of commands received, such as
get commands, or execute
commands. However replies from the M2M CDMA Router are optional with
set commands and the Wakeup command. This option
Enables or disables sending an acknowledgment message after execution of a
set command or SMS Wakeup command. If
disabled, the router does not send any acknowledgement after execution of a
set command or SMS Wakeup command. All
acknowledgment replies are stored in the Outbox after they have been sent.
This can be useful to determine if a command was received and executed by the router. This option is disabled by default.
Send Ack. SMS to
This option allows you to specify where to send acknowledgment messages after the execution of a
set, or exec command.
If a fixed number is selected, the acknowledgement message will be sent to the number defined in the Fixed number to send replies
to field. If the sender’s number is selected, the acknowledgement message will be sent to the number that the SMS diagnostic or
command message originated from. The default setting is to use the sender’s number.
Send Error SMS for Get/Set/Exec Command
Enables or disables the sending of an error message resulting from the execution of a
get , set , or exec command. All error replies
are stored in the Outbox after they have been sent.
Send Error SMS to
When Send Error SMS for Get/Set/Exec Command is set to ON, this option is used to specify where the error SMS is sent. Use the
radio buttons to select either Fixed Number or SMS Sender Number. When set to SMS Sender Number the router will reply to the
originating number of the SMS diagnostic or command. When set to Fixed Number the router will send the error messages to the
number specified in the following field.
Fixed Error SMS Number
This field defines the destination number to which error messages are sent after the execution of a get , set, or exec command. This
field is only displayed when Send Error SMS to is set to Fixed Number.
Max. Diag SMS Tx Limit
You can set the maximum number of acknowledgement and error messages sent when an SMS diagnostic or command is
executed. The maximum limit can be set per hour, day, week or month. The router will send a maximum of 100 replies by default.
The number of messages sent is shown below the options. The total transmitted message count resets after a reboot or at the
beginning of the time frame specified.

10
M2M CDMA Router – SMS Tools User Guide
www.netcommwireless.com
White List for Diagnostic or Execution SMS Messages
The white list is a list of mobile numbers that you can create which are considered “friendly” to the router. If Authentication is
enabled in the diagnostics section, the router will compare the mobile number of all incoming diagnostic and command messages
against this white list to determine whether the diagnostic or command should be executed. You may optionally configure a
password for each number to give an additional level of security. When a password is specified for a number, the SMS diagnostic or
command message is parsed for the password and will only be executed if the number and password match.
Figure 6 - White list for diagnostic or execution SMS
A maximum of 20 numbers can be stored on the router in the white list. To add a number to the white list, click the “+Add” button.
Figure 7 – Adding a number to the SMS white list
The White List numbers and passwords can be cleared by pressing the button to the right of each entry. To add a number to
the white list, enter it in the Destination Number field and optionally define a password in the Password field. When you have
finished adding numbers click the Save button to save the entries.

www.netcommwireless.com
M2M CDMA Router – SMS Tools User Guide
11
Sending an SMS Diagnostic Command
Follow the steps below to configure the router to optionally accept SMS diagnostic commands only from authenticated senders and
learn how to send SMS diagnostic commands to the router.
1. Navigate to the Services > SMS > Diagnostics page
2. Confirm that the Enable Remote Diagnostics toggle key is set to the ON position. If it is set to OFF click the toggle key to
switch it to the ON position.
3. If you wish to have the router only accept commands from authenticated senders, ensure that Authentication is set to the
ON position. In the White List for Diagnostic or Execution SMS Messages section, click the +Add button and enter the
sender’s number in international format into the Destination Number field that appears. If you wish to also configure a
password, enter the password in the Password field corresponding to the destination number.
4. If you would prefer to accept SMS diagnostic commands from any sender, set the Authentication toggle key to the OFF
position.
Note: An alternative method of adding a number to the white list is to send an SMS message to the router, navigate to
Services > SMS > Inbox and then click the button next to the message which corresponds to the sender’s number.
5. Click the Save button.
Types of SMS diagnostic commands
There are three types of commands that can be sent; execute, get and set. The basic syntax is as follows:
execute COMMAND
get VARIABLE
set VARIABLE=VALUE
If authentication is enabled, each command must be preceded by the password:
PASSWORD execute COMMAND
PASSWORD get VARIABLE
PASSWORD set VARIABLE=VALUE
The following are some examples of SMS diagnostic commands:
password6657 execute reboot
get rssi
set pppoe=0
SMS Acknowledgment replies
The router automatically replies to get commands with a value and execute commands with either a success or error response. Set
commands will only be responded to if the Send Ack. SMS for Set Command toggle key is set to ON. If the Send Error SMS for
Get/Set/Exec Command toggle key is set to ON, the router will send a reply if the command is correct but a variable or value is
incorrect, for example, due to misspelling.

12
M2M CDMA Router – SMS Tools User Guide
www.netcommwireless.com
SMS Command format
Generic Format for reading variables:
get VARIABLE
PASSWORD get VARIABLE
Generic Format for writing to variables:
set VARIABLE=VALUE
PASSWORD set VARIABLE=VALUE
Generic Format for executing a command:
Execute COMMAND
PASSWORD execute COMMAND
Replies
Upon receipt of a successfully formatted, authenticated (if required) command, the gateway will reply to the SMS in the following
format:
TYPE SMS CONTENTS NOTES
get command “VARIABLE=VALUE”
set command “Successfully set VARIABLE to VALUE” Only sent if the acknowledgment message
function is enabled
execute command “Successfully executed command COMMAND”
Table 4 - SMS Diagnostic Command Syntax
Where “VARIABLE” is the name of the value to be read
Where “VARIABLE (x)” is the name of another value to be read
Where “VALUE” is the content to be written to the “VARIABLE”
Where “COMMAND” is a supported command to be executed by the device (e.g. reboot)
Where “PASSWORD” is the password (if configured) for the corresponding sender number specified in the White List
Multiple commands can be sent in the same message, if separated by a semicolon.
For Example:
get VARIABLE1; get VARIABLE2; get VARIABLE3
PASSWORD get VARIABLE1; get VARIABLE2
set VARIABLE=VALUE1 ; set VARIABLE2=VALUE2
PASSWORD set VARIABLE1=VALUE1; set VARIABLE2=VALUE2; set VARIABLE3=VALUE3
If required, values can also be bound by an apostrophe, double apostrophe or back tick.
For Example:
“set VARIABLE=’VALUE’”
“set VARIABLE=”VALUE””
“set VARIABLE=`VALUE`”
“get VARIABLE”

www.netcommwireless.com
M2M CDMA Router – SMS Tools User Guide
13
A password (if required), only needs to be specified once per SMS, but can be prefixed to each command if desired.
“PASSWORD get Variable1”; “get VARIABLE2”
“PASSWORD set VARIABLE1=VALUE1”; “set VARIABLE2=VALUE2”
If the command sent includes the “reboot” command and has already passed the white list password check, the device keeps this
password and executes the remaining command line after the reboot with this same password.
For Example:
“PASSWORD execute reboot; getVariable1”; “get VARABLE2”
“PASSWORD execute reboot; PASSWORD get Variable1”; “get VARABLE2”
Note: Commands, variables and values are case sensitive.
List of valid commands
A list of valid commands which can be used in conjunction with the execute command are listed below:
“pdpcycle”, “pdpdown” and “pdpup” commands can have a profile number suffix ‘x’ added. Without the suffix specified, the
command operates against the default profile configured on the profile list page of the Web-UI.
# COMMAND NAME DESCRIPTION
1 reboot Immediately performs a soft reboot.
2 pdpcycle
Disconnects (if connected) and reconnects the data connection. If a profile number is selected in the
command, try to disconnect/reconnect the specified profile in case the profile is active. If no profile
number is selected, try to disconnect/reconnect the current active profile. Reports an error if no profile
number is selected and there is no currently activated profile.
3 pdpdown
Disconnects the PDP. If a profile number is selected in the command, the router tries to disconnect the
specified profile in case the profile is active. If no profile number is selected, try to disconnect the current
active profile. Reports an error if no profile number is selected and there is no currently activated profile.
4 pdpup
Reconnects the PDP. If a profile number is selected in the command, the router tries to connect with
the specified profile. If no profile number is selected, the router tries to connect to the last active profile.
The gateway will check the currently activated profile and disconnect this profile before executing the
command. The router reports an error if no profile number is selected and there is no stored last active
profile number.
5 factorydefaults Performs a factory reset on the router.
6 download
Performs a download and install of a Firmware Upgrade (.cdi), Config File (.tar.gz) or a help document
(.pdf) file.
If the file is a firmware image as in the case of a .cdi file, the router will apply the recovery image first and
then the main firmware image. When the router has finished installing the both recovery and main
images, it automatically reboots. The download location is specified immediately after the command and
may be from an HTTP or FTP source URL.
If the file is a .tar.gz file, the router will apply the file as a configuration file update for the device and then
prompt the user to reboot the router so that the new configuration can take effect.
If the file is a .pdf, the router will assume this is a user guide document and save it to the router and
make the file available for viewing via the help menu on the Web-UI.
Note: If your download URL includes any space characters, please encode these prior to transmission
according to RFC1738, for example:
ftp://username:password@serveraddress/directory%20with%20spaces/filename.cdi
Note: Authenticated FTP addresses may be used following the format as defined in RFC1738, for
example:
ftp://username:password@serveraddress/directory/filename.cdi
Table 5 - List of Valid SMS diagnostic commands

14
M2M CDMA Router – SMS Tools User Guide
www.netcommwireless.com
The following table lists valid variables where “x” is a profile number (1-6). If no profile is specified, variables are read from or written
to for the current active profile. If a profile is specified, variables are read from or written to for the specified profile number (‘x’).
# RDB VARIABLE NAME SMS VARIABLE
NAME
READ/
WRITE DESCRIPTION EXAMPLE VALUE
0
link.profile.1.enable
link.profile.1.dialstr
link.profile.1.user
link.profile.1.pass
link.profile.1.auth_type
link.profile.1.iplocal
link.profile.1.status
profile
RW Profile
Read:
(profile
no,atd#xxx,user,pass,auth,iplocal,status)
1,atd#777,username,password,
chap,202.44.185.111,up
Write:
(atd#xxx, user, pass,auth)
atd#777,username,password
2 link.profile.1.user username RW 3G username Guest, could also return “null”
3 link.profile.1.pass
password RW 3G password Guest, could also return “null”
4 link.profile.1.auth_type authtype RW 3G Authentication
type ”pap” or”chap”
5 link.profile.1.iplocal wanip R WAN IP address 202.44.185.111
6 wwan.0.radio.information.signal_strength rssi R 3G signal strength -65 dBm
7 wwan.0.meid
meid R MEID number 0x00A1000021D003BB
8 statistics.usage_current
usage R 3G data usage of
current session
“Rx 500 bytes, Tx 1024 bytes, Total 1524
bytes” or “Rx 0 byte, Tx 0 byte, Total 0 byte”
when wwan down
9 statistics.usage_current
wanuptime R Up time of current 3G
session
1 days 02:30:12 or 0 days 00:00:00 when
wwan down
10 /proc/uptime deviceuptime R Device up time 1 days 02:30:12
11 wwan.0.system_network_status.current_ba
nd band R Current Frequency channel & band CH:425 PCS-B Band
Table 6 - List of SMS diagnostics variables
SMS diagnostics examples
The examples below demonstrate various combinations of supported commands. This is not an exhaustive list and serves as an
example of possibilities only.
DESCRIPTION AUTHENTICATION INPUT EXAMPLE
Send SMS to change the data
connection username
Not required set username=’NetComm’
Required PASSWORD set username= ”NetComm”
Send SMS to change the data
connection password
Not required set password= `NetComm`
Required PASSWORD set password= `NetComm`
Send SMS to change the data
connection authentication
Not required set authtype= ‘pap’
Required PASSWORD set authtype = pap
Send SMS to reboot
Not required execute reboot
Required PASSWORD execute reboot
Send SMS to check the WAN IP
address
Not required get wanip
Required PASSWORD get wanip
Send SMS to check the mobile
signal strength
Not required get rssi
Required PASSWORD get rssi
Send SMS to check the MEID
number
Not required get meid
Required PASSWORD get meid

www.netcommwireless.com
M2M CDMA Router – SMS Tools User Guide
15
Send SMS to check the current
band
Not required get band
Required PASSWORD get band
Send SMS to Disconnect (if
connected) and reconnect the data
connection
Not required execute pdpcycle
Required PASSWORD execute pdpcycle
Send SMS to disconnect the data
connection
Not required execute pdpdown
Required PASSWORD execute pdpdown
Send SMS to connect the data
connection
Not required execute pdpup
Required PASSWORD execute pdpup
Send multiple get command
Not required get wanip; get rssi
Required PASSWORD get wanip; get rssi
Send multiple set command
Not required set ssh.genkeys=1; set username=test; set auth=pap
Required PASSWORD set ssh.genkeys=1; set username=test; set auth=pap
Send SMS to reset to factory default
settings
Not required execute factorydefaults
Required PASSWORD execute factorydefaults
Send SMS to retrieve status of
router
Not required get status
Required PASSWORD get status
Send SMS to retrieve the history of
the session, including start time, end
time and total data usage
Not required get sessionhistory
Required PASSWORD get sessionhistory
Send SMS to configure the router to
send syslog to a remote syslog
server
Not required set syslogserver
Required PASSWORD set syslogserver
Send SMS to wake up the router,
turn on the default gateway and
trigger the ‘connect on demand’
profile if in waiting state.
Not required execute wakeup
Required PASSWORD execute wakeup
Send SMS to perform firmware
upgrade when firmware is located
on HTTP server
Not required execute download http://download.com:8080/firmware_image.cdi
execute download http://download.com:8080/firmware_image_r.cdi
Required
PASSWORD execute download http://download.com:8080/firmware_image.cdi
PASSWORD execute download
http://download.com:8080/firmware_image_r.cdi
Send SMS to perform firmware
upgrade when firmware is located
on FTP server
Not required
execute download
ftp://username:[e-mail]/firmware_image.cdi
execute download ftp://username:password@
download.com/firmware_image_r.cdi
Required
PASSWORD execute download ftp://username:password@
download.com/firmware_image.cdi
PASSWORD execute download ftp://username:password@
download.com/firmware_image_r.cdi
Send SMS to turn off PPPoE
Not required set pppoe=0
Required PASSWORD set pppoe=0
Send SMS to turn on PPPoE and
set dialstring and service name
Not required set pppoe=1,atd#777, Test
Required PASSWORD set pppoe=1,atd#777, Test
Send SMS to retrieve the PPPoE
status, currently configured dial
string and service name
Not required get pppoe
Required PASSWORD get pppoe
Send SMS to set the LED mode
timeout to 10 minutes
Not required set ledmode=10
Required PASSWORD set ledmode=10
Send SMS to retrieve the current
LED mode
Not required get ledmode
Required PASSWORD get ledmode
Retrieve current SSH protocol
Not required get ssh.proto
Required PASSWORD get ssh.proto
Select SSH protocol
Not required set ssh.proto=1
Required PASSWORD set ssh.proto=1

16
M2M CDMA Router – SMS Tools User Guide
www.netcommwireless.com
Table 7 - SMS diagnostics example commands
Retrieve password authentication
status
Not required get ssh.passauth
Required PASSWORD get.ssh.passauth
Enable/disable password
authentication on host
Not required set ssh.passauth=1 or set ssh.passauth=0
Required PASSWORD set ssh.passauth=1 or PASSWORD set ssh.passauth=0
Generate set of public/private keys
on the host
Not required execute ssh.genkeys
Required PASSWORD execute ssh.genkeys
Clear client public keys stored on
host
Not required execute ssh.clearkeys
Required PASSWORD execute ssh.clearkeys
Retrieve the MEID of the router
Not required get MEID
Required PASSWORD get MEID