Resource Centre / Command Reference / CTM-15X Modem Command Reference R1.2.1

CTM-15X Modem Command Reference (R1.2.1)

Browse the command reference section below to find common commands for Chameleon CTM-15X modems.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A
apn (set carrier access-point name)
APN <name-of-apn>

This command configures the APN(Access Point Name) for a modem. This command is only applicable to GSM/GPRS/HSPA devices.

A cmd save is required for this command to take effect.

cmd apn will query current APN value

Examples:

1. Query current APN
cmd apn
cmd apn internet.com
OK

2. Set APN
cmd apn newapn.com
OK

http://en.wikipedia.org/wiki/Access_Point_Name

Back to top
B
boomreport (set the boom tracker report)
boomreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

This command sets the report(s) to be used for boom-tracker triggered reports.
Where:
r = 0 disables the report
r = 1 to 999 report number

boomreport requires the modem to be listening for traffic from the WPAN gateway, this requires cmd mode 10 to be configured.

Examples:

1. Use report 2 for boom-tracker triggered reports.
cmd boomreport 2
OK
cmd boomreport
cmd boomreport 2 0 0 0 0 0 0 0

2. User report 1, 2 and 4 for boom-tracker triggered reports.
cmd boomreport 1 2 4
OK
cmd boomreport
cmd boomreport 1 2 4 0 0 0 0 0
OK

3. Disable boom-tracker triggered reports
cmd boomreport 0
OK
cmd boomreport
cmd boomreport 0 0 0 0 0 0 0 0
OK

A cmd save is required for this command to take effect.
See also: mode, repaddmes, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype

Back to top
C
cardlistclear (erase approved ID list from modem) NEW to R1.2.1
cardlistclear

Removes list of approved swipe-card IDs from modem.

Example
cmd cardlistclear
OK
See also: cardlistload, cardlistsave

cardlistload (load approved ID list for swipe card interface) NEW to R1.2.1
cardlistload file-name url username passwd

This command is used to load the approved ID list used with the swipe card interface from a remote location (FTP/HTTP server). The approved ID list file is copied to /var/config/approved.txt.

The command requires 4 parameters when accessing an FTP server or 2 parameters when accessing an HTTP server:
  • file-name the name of the approved ID list to load onto the modem
  • url the address of the FTP or HTTP server, can also be an IP address, prefixed by ftp:// or http:// respectively; if no prefix is specified (eg. cypress.bc.ca) then ftp:// is used
  • username username to access FTP server (ignored when url is prefixed by http://)
  • passwd password to access FTP server (ignored when url is prefixed by http://)
Examples:
cmd cardlistload new-approved.txt cypress.bc.ca guest guestpw where new-approved.txt is the approved ID list, cypress.bc.ca is the FTP server, guest is the username of the FTP server and guestpw is the password of the FTP server

cmd cardlistload new-approved.txt http://cypress.bc.ca where new-approved.txt is the approved ID list, and cypress.bc.ca is the HTTP server

After using this command, a cmd save is required to save the approved ID list.
See also: cardlistclear, cardlistsave, mode, swipereport

cardlistsave (save approved ID list to non-volatile RAM) NEW to R1.2.1
cardlistsave

Store a list of approved swipe-card IDs for use by redboot loader swipe card reader application.
Note that a list of approved IDs must first be loaded to the modem using cardlistload.

Example:
cmd cardlistsave
OK
See also: cardlistclear, cardlistload

cardlockload (load a swipe card lock script to the modem) NEW to R1.2.1
cardlockload lock-script-file-name url username passwd

This command is used to load the custom lock script associated with the swipe card interface. The command requires 4 parameters when accessing an FTP server or 2 parameters when accessing an HTTP server:
  • lock-script-file-name the name of the lock script file
  • url the address of the FTP or HTTP server, can also be an IP address, prefixed by ftp:// or http:// respectively; if no prefix is specified (eg. cypress.bc.ca) then ftp:// is used
  • username username to access FTP server (ignored when url is prefixed by http://)
  • passwd password to access FTP server (ignored when url is prefixed by http://)
Examples:
cmd cardlockload lock.sh cypress.bc.ca guest guestpw where lock.sh is the lock script, cypress.bc.ca is the FTP server, guest is the username of the FTP server and guestpw is the password of the FTP server

cmd cardlockload lock.sh http://cypress.bc.ca where lock.sh is the lock script, and cypress.bc.ca is the HTTP server

After using this command, a cmd save is required to save the lock script.
See also: cardunlockload, mode

cardunlockload (load a swipe card unlock script to the modem) NEW to R1.2.1
cardunlockload lock-script-file-name url username passwd

This command is used to load the custom unlock script associated with the swipe card interface. The command requires 4 parameters when accessing an FTP server or 2 parameters when accessing an HTTP server:
  • unlock-script-file-name the name of the unlock script file
  • url the address of the FTP or HTTP server, can also be an IP address, prefixed by ftp:// or http:// respectively; if no prefix is specified (eg. cypress.bc.ca) then ftp:// is used
  • username username to access FTP server (ignored when url is prefixed by http://)
  • passwd password to access FTP server (ignored when url is prefixed by http://)
Examples:
cmd cardunlockload unlock.sh cypress.bc.ca guest guestpw where unlock.sh is the unlock script, cypress.bc.ca is the FTP server, guest is the username of the FTP server and guestpw is the password of the FTP server

cmd cardunlockload unlock.sh http://cypress.bc.ca where unlock.sh is the unlock script, and cypress.bc.ca is the HTTP server

After using this command, a cmd save is required to save the unlock script.
See also: cardlockload, mode

confupgrade (configures the modem for automatic configuration capability)
confupgrade script-name url username passwd

Configures the modem for over-the-air configuration by means of a custom configuration script retrieved from a defined FTP or HTTP server.

The command requires 4 parameters when accessing an FTP server or 2 parameters when accessing an HTTP server:

The script file is a text file containing modem commands used to configure a modem:

For example:
cmd mode 2
cmd gpsrep 1 0 3
cmd gpscond 1 1 30
cmd gpsremip 1 123.123.123.123
cmd gpsremport 1 5005
......
....
..
  • script-name the name of the configuration script to fetch/run
  • url the address of the FTP or HTTP server, can also be an IP address, prefixed by ftp:// or http:// respectively; if no prefix is specified (eg. cypress.bc.ca) then ftp:// is used
  • username username to access FTP server (ignored when url is prefixed by http://)
  • passwd password to access FTP server (ignored when url is prefixed by http://)
Examples:
cmd confupgrade ctm15x-config.sh cypress.bc.ca guest guestpw where ctm15x-config.sh is the script file, cypress.bc.ca is the FTP server, guest is the username of the FTP server, and guestpw is the password of the FTP server

cmd confupgrade ctm15x-config.sh http://cypress.bc.ca where ctm15x-config.sh is the script file, and cypress.bc.ca is the HTTP server

ctm15x (command for configuration of protected values) NEW to R1.2.1
ctm15x

This command is used to enable a reset of protected configuration values.
Current protected configuration commands are:
  • cmd data
  • cmd ethernet
  • cmd enghours
  • cmd odometer
  • cmd rfswitch
cmd ctm15x must be run once prior to setting any of the above configuration values.
cmd ctm15x is volatile and cannot be saved, its state will be reset following a modem power cycle or reboot
See also: data, ethernet, enghours, odometer

ctmsts (CTM status)
ctmsts n

This command is used to configure the reporting mode of the modems status report.
This status report is controlled by GPS report #11
use gpsrep, gpslocport, gpsremip, and gpsremport to configure the reporting destination.
Default destinations are: local port 6102; remote IP 0.0.0.0, remote port 6102. This report sends messages #03 (Modem ID), #30 (Network status), #80 (NMEA GGA), and #82 (NMEA RMC).
These messages can be imported and displayed using the Chameleon Viewer software utility running on a local or remote PC.
The report is sent every 10 seconds.

n = 0 status reporting: disabled (default)

n = 1 local reporting only

(cmd gpsrep 1 1 3 0 – to enable local reporting)

The current setting for the modem’s status report can be queried by using the ctmsts command without parameters

Examples:
cmd ctmsts 1 switches on local status reporting
cmd ctmsts queries the current configuration of status reporting

A cmd save is required for this command to take effect.

Back to top
D
data (query count of data transmitted/received over wireless link) NEW to R1.2.1
data [0]

This command keeps track of the amount of data transmitted and received over the wireless data link.

The total data transmitted and data received counts can only be reset by using the following command:
cmd data 0

0 Set to 0 to reset

The current amount of data transmitted and received can be queried using cmd data without parameters, the result is shown in megabytes (MB).
A cmd factory does not reset the wireless link count statistics of this command.

Examples:

1. Reset the link data count to 0
cmd ctm15x
OK
cmd data 0
OK

2. Query the current link data count
cmd data
TX: 4 MB
RX: 2 MB
Total: 6 MB
OK
See also: ctm15x, datacond

datacond (wireless link total data count trigger condition) NEW to R1.2.1
datacond x

This command is used to set the condition that will trigger wireless link data count report(s). Report(s) are sent whenever the total amount of data transmitted and received is a multiple of a specified amount.

x = 0 disables the condition
x = 1 to 1999999 total data amount in MB used for periodic triggering

The default configuration upon cmd factory is cmd datacond 10.

Examples:
1. Set trigger when 5 MB total data has been transmitted and received (such as when 1 MB of data was transmitted, and 4 MB of data was received)
cmd datacond 5
OK

2. Query the current link data trigger condition
cmd datacond
cmd datacond 10
OK
See also: data, datareport

datareport (set the link data report(s)) NEW to R1.2.1
datareport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

This command sets the report(s) to be used for link data count triggered events.
See data and datacond for information on configuring the link data reports.

Where:
r = 0 disables the report
r = 1 to 999 report number

Examples:

1. Use report 2 for link data count triggered reports.
cmd datareport 2
OK
cmd datareport
cmd datareport 2 0 0 0 0 0 0 0

2. User report 1, 2 and 4 for link data count triggered reports.
cmd datareport 1 2 4
OK
cmd datareport
cmd datareport 1 2 4 0 0 0 0 0
OK

3. Disable link data count triggered reports
cmd datareport 0
OK
cmd datareport
cmd datareport 0 0 0 0 0 0 0 0
OK
See also: datacond, repaddmes, repdelmes, repemail, replocport, repremip,
repremport, repsms, reptype

dir (set NAM phone number,MDN,MIN)
dir pppppppppp [qqqqqqqqqq]

This command sets the NAM (Number Assignment Module) value for the modem. It is a 10-digit phone number assigned to the modem by the service provider. Use the spc command to unlock the modem first. The NAM value may be queried by using the dir command without parameters.

This command also sets the MIN (Mobile Identification Number) value for the modem. It is a 10-digit number assigned to the modem by the service provider. Use the spc command to unlock the modem first.

pppppppppp 10-digit phone number (MDN) to be assigned to the modem or “+” if only MIN is to be assigned

Optional Parameter:

qqqqqqqqqq 10-digit phone number (MIN) to be assigned to the modem

Note: Previous firmware versions included cmd min for setting the MIN value of the modem. However, cmd min has been replaced by cmd dir. Using cmd dir as shown one of the examples below are the only ways to set the MIN value of the modem.

Examples:

1. Set the modem’s MDN and MIN
cmd dir 1234567890 0987654321
OK

2. Set the modem’s 10-digit number (MDN)
cmd dir 5551234567
OK

3. Set the modem’s 10-digit number (MIN)
cmd dir + 0987654321
OK

4. Query the modem’s currently assigned phone number (MDN)
cmd dir
cmd dir 6049998888
OK

A cmd save is required for this command to take effect.

dout (digital outputs)
dout n x

This command is used to set the state of each of the all outputs. There are four outputs in total.

n = 1 to 4 output channel number

x = 0 sets output to off

x = 1 sets output to on

The current settings can be queried by using the dout command without parameters.

Examples:

1. Set output #2 ON
cmd dout 2 1
OK

2. Query the state of all four outputs
cmd dout
cmd dout 1 0
cmd dout 2 1
cmd dout 3 0
cmd dout 4 0

A cmd save is required for this command to take effect.

dyndns (dynamic DNS)
dyndns text1 text2 text3

This command configures the modem to perform regular updates to the Dynamic Domain Name Service.
This feature creates an alias from a dynamic IP address to a static hostname allowing the modem to be more easily accessed over the Internet for remote configuration or for end application. For this feature, the modem requires a public IP address . By default this feature is disabled - “, ,”.

text1 user name for the DYNDNS service.
text2 user password for the DYNDNS service.
text3 domain (hostname) name for the DYNDNS

The current settings of the DYNDNS (Dynamic Domain Name Service) can be queried by using the dyndns command without parameters.
DYNDNS updates can be disabled by using 0 for the user name, 0 for the user password, and 0.0.0.0 for the hostname. Note that after disabling DYNDNS updates, the hostname will continue to point to the last IP address of the modem. For instructions on clearing the IP address associated with the hostname, please refer to DYNDNS documentation for details on using the offline hostname feature.

Examples:

1. Set the user name and password and the domain name
cmd dyndns cypressdemo cypress cypresscamera2.dyndns.org
OK

2. Disable DYNDNS updates
cmd dyndns 0 0 0.0.0.0
OK

3. Query the modem’s setting for this setting
cmd dyndns
cmd dyndns cypressdemo cypress cypresscamera2.dyndns.org
OK

A cmd save command and power cycle are required for the changes to take effect.

http://en.wikipedia.org/wiki/Dyndns
http://www.dyndns.com/

Back to top
E
emailsrv (set email server)
emailsrv a.a.a.a

This command is used to set the IP address of the SMTP email server that will be used by the modem for sending email reports.
The commands gpsrep, ignreport, and reptype are used to enable email reporting.

a.a.a.a = 0.0.0.0 to 255.255.255.255 IP address of the email server to be used for email reports. Default = 0.0.0.0 The current email server IP address can be queried by using the emailsrv without parameters.

Examples:

1. Set the email server IP address to 100.120.10.10
cmd emailsrv 100.120.10.10
OK

2. Query current email server
cmd emailsrv
cmd emailsrv 100.120.10.10
OK

A cmd save is required for this command to take effect.

enghours (calculate engine hours)
enghours n

Since total engine hours data is not available through standard OBD2 interface, Total engine hours must be calculated using other methods.
When a modem is installed in a vehicle and the current vehicle engine hours are known, the current engine hours will need to be programmed.

This can be done through the following command:
cmd enghours n

n Total engine hours in hours (0-999999.99).

The current value of engine hours can be queried using cmd enghours without parameters and is shown in hours.

The modem must be configured to enable engine hours counting using the enghrmode command.

Examples:

1. Set the engine hours to 2501
cmd ctm15x
OK
cmd enghours 2501
OK
See also: ctm15x

enghrmode (used to configure enghours command)
enghrmode n

cmd enghrmode n
where n:

0 Disabled (Default, Engine hours can still be obtained if vehicle has J1939 capability)
1 Use ignition input only
2 Use OBD2 input only
3 Use combination of ignition and OBD2 inputs

A cmd save is required for this command to take effect.

esn (electronic serial number)
esn

This command queries the 32 bit ESN (Electronic Serial Number) of the embedded wireless network access device.
The ESN is read only and cannot be altered.

Example:

1. Query the 11 digit ESN in decimal format
cmd esn
12345678901
OK

http://en.wikipedia.org/wiki/Electronic_Serial_Number

ethernet (Enable/Disable Ethernet services)
ethernet x

This command is used to enable or disable the Ethernet services of the modem.
Ethernet services are enabled by default whenever a cmd factory is issued.
x = 0 disable Ethernet services
x = 1 enable Ethernet services

Examples:
1. Disable Ethernet services
cmd ctm15x
OK
cmd ethernet 0
OK

A cmd save is required for this command to take effect.
See also: ctm15x

Back to top
F
factory (restores modem settings to factory default settings)
factory

Restores the modem configuration to the factory defaults. This command will also reset the GPS odometer, engine hours, or wireless link data count to zero if any of these values have not been previously set. For modems configured for use the with the redboot loader swipe card reader application, this command will also remove the list of approved swipe-card IDs.

The only parameter for factory is gsm, cmd factory gsm will configure a modem for use on the GSM/GPRS/HSPA network once a compatible GSM/GPRS/HSPA data device module/card has been installed in the modem.

Restoring the modem configuration to its factory defaults should not be performed while remotely accessing a modem. You will not be able to remotely access the modem via Telnet or the embedded Web server after issuing this command.

Example:

1. Restore modem to factory configuration
cmd factory
OK
firewall (Firewall – Port forwarding)
firewall n eeeee lllll t iii.iii.iii.iii s

This command is used to setup the port forwarding configuration of the modem.
Up to 10 port forwarding configurations can be set.
The local IP address will default to 192.168.1.X, where X is extracted from iii.iii.iii.iii and 192.168.1 is extracted from the IP address in the LAN Configuration setting.

n = 1 to 10 port forwarding number
eeeee = 0 to 65535 external port number to forward to
lllll = 0 to 65535 local port number to forward to
t = 0 disable
t = 1 UDP
t = 2 TCP
t = 3 both UDP and TCP
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 local IP address to forward to
s = 0 disable forwarding
s = 1 enable forwarding

The current port forward settings can be queried by using firewall without parameters.

Note that LAN IP addresses used in port forwarding rules must match the LAN subnet as configured using cmd lanip, cmd lannetmask, and cmd lanrepip.

Examples:

1. Set port forwarding #1 to forward data destined for port 8080 (same external & local port number), on both using UDP and TCP protocol to IP 192.168.1.20 and enabled
cmd firewall 1 8080 8080 3 192.168.1.20 1
OK

2. Set port forwarding #2 to forward data destined for external port 42375 and redirect it to local port 5001, on UDP protocol to IP 192.168.1.20 and enabled.
cmd firewall 2 42375 5001 1 192.168.1.20 1
OK

3. Query the current firewall configuration
cmd firewall
cmd firewall 1 8080 8080 3 192.168.1.20 1
OK

A cmd save is required for this command to take effect.

Back to top
G
gpsaccel (GPS report trigger for hard acceleration and deceleration events)
gpsaccel n a d

Sets the GPS report triggers for capturing hard acceleration and deceleration events.
Reports will be triggered if the instantaneous acceleration is greater than a or the instantaneous acceleration is less than d.
The default thresholds are 0 km/h/s for acceleration and 0 km/h/s for deceleration.

n = 1 to 8 GPS report number
a acceleration threshold in km/h/s
d deceleration threshold in km/h/s

Examples:

1. Send GPS report #7 whenever acceleration is greater than 10 km/h/s or deceleration is less than -10 km/h/s
cmd gpsaccel 7 10 -10
OK

A cmd save is required for this command to take effect.

gpsaddmes (add GPS messages to a report)
gpsaddmes n x [x2] [x3] [x4]

Adds messages to a GPS report. 4 messages can be included in a single report. Duplicate messages cannot be included in a report.
Messages will be sent in a report in the same order that they are added with this command.
ULCP header messages will be sent as individual UDP packets, NMEA format messages will be combined into a single packet.

n = 1 to 8 GPS report number
x message type to be added, valid message types must be used - see Message Formats

Examples:

1. Adds message #16 – GPS NMEA GLL – to GPS report #4
cmd gpsaddmes 4 16
OK

2. Query messages for GPS report #4
cmd gpsaddmes 4
cmd gpsaddmes 4 16 80 82 0
OK

A cmd save is required for this command to take effect.
See also: gpsrep, gpsdelmes, gpslocport, gpsremip, gpsremport, gpsemail, gpssms

gpscond (GPS report trigger conditions)
gpscond n b t [d] [ms Ms] [h hs] [mt]

Sets the condition(s) that will trigger a GPS report.
The conditional operator is used to indicate how all following parameters will be used to determine if a report is triggered.
The mt parameter must be used at the end if all other optional parameters are entered.
The default condition for report #11 is 11 1 10 (these can be changed, the first three parameters are valid for report #11 ONLY).

n = 1 to 8 GPS report number
b = 0 conditional operator for all following parameters: Off
b = 1 conditional operator for all following parameters: AND
b = 2 conditional operator for all following parameters: OR
t = 0 timeout disabled
t = 1 to 65535 timeout in seconds

Optional parameters:
d = 0 to 65535 distance traveled threshold in meters
ms = 0 to 65535 low speed threshold in kph – use with Ms
Ms = 0 to 65535 high speed threshold in kph – use with ms
h = 0 to 359 heading change in degrees – use with hs
hs = 0 65535 minimum speed threshold to make heading measurement valid, in kph – use with h
mt = 0 to 65535 maximum reporting rate in seconds (minimum time between reports)

The current condition(s) for a report can be queried by using the gpscond n command. If n is blank, all GPS reports will be queried.

Examples:

1. Send report #1 every 60 seconds
cmd gpscond 1 1 60
OK

2. Send report #2 every 60 seconds AND distance is greater than 50 metres
cmd gpscond 2 1 60 50
OK

3. Send report #4 every 60 seconds AND the distance traveled is greater than 50 metres AND the speed is between 20kph and 60kph
cmd gpscond 4 1 60 50 20 60
OK

4. Send report #5 every 60 seconds OR when distance traveled is greater than 50 metres OR speed is greater than 60kph, OR if the heading changes by more than 45 degrees, with a maximum report rate of one every 10 seconds
cmd gpscond 5 2 60 50 60 200 45 10 10
OK

5. Send report #6 only when distance traveled is greater than 0 metres AND the speed is between 0kph and 5kph AND with a maximum report rate of one every 7 seconds
cmd gpscond 6 1 0 0 0 5 0 0 7
OK

6. Query the conditions used to trigger all GPS reports
cmd gpscond
cmd gpscond 1 1 30 0 0 0 0 0 0
cmd gpscond 2 1 30 0 0 0 0 0 0
cmd gpscond 3 2 10 10 0 0 0 0 0
OK

7. Query the conditions used to trigger GPS report #4
cmd gpscond 4
cmd gpscond 4 1 0 0 0 5 0 0 7
OK

A cmd save is required for this command to take effect.

gpsdelmes (delete GPS message)
gpsdelmes n x

This command is used to delete a message type (or all messages) from a GPS report.

n = 1 to 8 GPS report number
x message type to be deleted (0 to delete all messages)

Examples:

1. Delete message type #16 from GPS report #1
cmd gpsdelmes 1 16
OK

2. Delete all messages from GPS report #4
cmd gpsdelmes 4 0
OK

A cmd save is required for this command to take effect.
See also: gpsrep, gpsaddmes, gpslocport, gpsremip, gpsremport, gpsemail, gpssms

gpsemail (GPS email address)
gpsemail n <email address>

Sets the email address that the GPS report will be sent to (if configured for email using gpsrep).
Up to 8 email addresses may be configured – one for each of the 8 GPS reports. The default email address is blank.

Note that an email server is required – see emailsrv.

n = 1 to 8 GPS report number
<email address> = name@domain email address to which the report will be sent
(leave blank to clear the address)

The current email address configured for all GPS reports can be queried by using the gpsemail command without parameters.

Examples:

1. Set the destination email address for GPS report #1
cmd gpsemail 1 me@home.com
OK

2. Clear the email address for GPS report #1
cmd gpsemail 1
OK

3. Query the email address for all GPS reports
cmd gpsemail
cmd gpsemail 1 me@home.com
OK

A cmd save is required for this command to take effect.
See also: gpsrep, gpsdelmes, gpslocport, gpsremip, gpsremport, gpsaddmes, gpssms
gpsgga (GPS GGA message)
gpsgga

Displays the current GPS position in NMEA0183 format.
This command is a read only command.

Example:

1. Return a current GPS NMEA format GGA message
cmd gpsgga $GPGGA,215619.00,4948.7174,N,11928.6175,W,0,5,01.9,++00380,M,,M,,0000*58 OK
gpslocport (GPS local port)
gpslocport n xxxxx

Sets the port number of the local server that the GPS report will be sent to.
Up to 8 GPS reports may be configured.
The default port for report #11 is 6102.

n = 1 to 8 or 11 GPS report number
xxxxx = 0 to 65535 local port number in decimal

The current local port configuration for a GPS report can be queried by entering gpslocport n, where n is the port number.
If n is omitted, all reports will be queried.

Examples:

1. Send report #1 to local port 5005
cmd gpslocport 1 5005
OK

2. Query the local port setting of all GPS reports
cmd gpslocport
cmd gpslocport 1 5005
OK

A cmd save is required for this command to take effect.
See also: gpsrep, gpsdelmes, gpsaddmes, gpsremip, gpsremport, gpsemail, gpssms

gpsmes (GPS messages)
gpsmes

Displays all messages associated with each GPS report.
This command is read only.

Example:
cmd gpsmes displays all messages associated with each GPS report

gpsremip (GPS remote IP)
gpsremip n iii.iii.iii.iii

Sets the IP address of the remote server that the GPS report will be sent to. Up to 8 GPS reports can be configured.

n = 1 to 8 or 11 GPS report number
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 remote IP address in decimal

The remote IP address of a report can be queried by using gpsremip n where n is the report number.
If n is omitted, all reports will be queried.

Examples:

1. Report #1 will be sent to remote IP address 123.10.1.101
cmd gpsremip 1 123.10.1.101
OK

2. Query the remote IP address setting of all GPS reports
cmd gpsremip
cmd gpsremip 1 123.10.1.101
cmd gpsremip 2 99.99.99.99
OK

A cmd save is required for this command to take effect.
See also: gpsrep, gpsdelmes, gpslocport, gpsaddmes, gpsremport, gpsemail, gpssms

gpsremport (GPS remote port)
gpsremport n xxxxx

Sets the IP port number of the remote server that the GPS report will be sent to.
Up to 8 GPS reports can be configured.

n = 1 to 8 or 11 GPS report number
xxxxx = 0 to 65535 remote port number in decimal

The current IP port configuration for a GPS report can be queried by using gpsremport n where n is the report number.
If n is omitted, all reports will be queried.

Examples:

1. Report #1 will be sent to port 5005 on remote IP address set by gpsremip
cmd gpsremport 1 5005
OK

2. Query the remote port setting of all GPS reports
cmd gpsremport
cmd gpsremport 1 7001
cmd gpsremport 2 4114
OK

A cmd save is required for this command to take effect.
See also: gpsrep, gpsdelmes, gpsaddmes, gpsremip, gpsremport, gpsemail, gpssms

gpsrep (GPS reporting)
gpsrep n l r s

Sets the reporting type for each GPS report for the local and remote servers.

n = 1 to 8 or report 11 GPS report number

l = 0 disables local GPS report (default)
l = 1 asynchronous NMEA or ULCP messages over RS232
l = 2 asynchronous NMEA or ULCP messages with a ULCP header over RS232
l = 3 in-band NMEA or ULCP messages in a UDP Packet over Ethernet
l = 4 in-band NMEA or ULCP messages with a ULCP header and in individual UDP packets over Ethernet
l = 5 in-band NMEA or ULCP messages in a TCP Packet over Ethernet

r = 0 disables remote GPS report (default)
r = 3 in-band NMEA or ULCP messages in a UDP Packet
r = 4 in-band NMEA or ULCP messages with a ULCP header and in individual UDP packets
r = 5 in-band NMEA or ULCP messages in a TCP Packet
r = 6 email reports
r = 7 SMS reports

s = 0 disables the store and forward of GPS reports
s = 1 enables the store and forward of GPS reports

Note: For r = 7 (SMS reports), the total length of the report must not exceed 166 characters including <CR> and <LF>

The current report type configuration for a GPS report can be queried by using gpsrep n where n is the report number.
If n is omitted, all reports will be queried.

Examples:

1.Send GPS report #4 as a UDP packet over Ethernet and over the wireless link, do not store GPS reports
cmd gpsrep 4 3 3
OK

2. Send GPS report #2 as a UDP packet over Ethernet and as an SMS message to the SMS destination set using the gpssms command, and enable the store and forward of GPS reports
cmd gpsrep 2 3 7 1
OK

3. Queries the reporting method for all GPS reports
cmd gpsrep
cmd gpsrep 1 0 3 1
cmd gpsrep 2 3 3 0
cmd gpsrep 11 3 0 0
OK

A cmd save is required for this command to take effect.
See also: gpsaddmes, gpsdelmes, gpslocport, gpsremip, gpsremport, gpsemail, gpssms

gpsrmc (GPS RMC message)
gpsrmc

Displays the current GPS position in NMEA0183 format.
This command is a read only command.

Example:

1. Return a current GPS NMEA format GGA message
cmd gpsrmc $GPRMC,215812.00,V,4948.7177,N,11928.6161,W,000.0,000.0,280409,,*38
OK
gpssms (set destination of GPS SMS report)
gpssms n pppppppppp or <email address>

Sets the destination of the GPS report that is sent as an SMS message.
Up to 8 GPS reports may be configured. The default SMS destination is blank.

Note: SMS features are only available for specific manufacturer, RF modules, cards or devices. Please contact Cypress Solutions for a complete list of products that support SMS functionality.

n = 1 to 8 GPS report number
pppppppppp phone number which the SMS report will be sent to. For long distance calls, a “1” needs to be added In front of the phone number.
(leave blank to clear the phone number)

<email address> email address which the SMS report will be sent to.
(leave blank to clear the address)

The current SMS destination configured for all GPS reports can be queried by using the gpssms command without parameters.

Examples:

1. Send GPS report #1 as an SMS message to the specified phone number
cmd gpssms 1 1234567890
OK

2. Send GPS report #2 as an SMS message to the specified email address
cmd gpssms 2 me@home.com
OK

3. Clear the SMS destination for GPS report #1
cmd gpssms 1
OK

4. Query the phone numbers or email addresses for all GPS SMS reports
cmd gpssms
cmd gpssms 1 1234567890
cmd gpssms 2 me@home.com
OK

A cmd save is required for this command to take effect.

Back to top
H
  • No commands
Back to top
I
igncond (ignition report trigger conditions)
igncond n a

Sets the condition(s) that would trigger an ignition report.
The state of the ignition is controlled by the "white" wire of the 3 wire power connection.
The conditional parameter, a is used to indicate how all following parameters will be used to determine if a report is triggered.

n = 1 to 8 ignition condition number
a = 0 trigger disabled (default)
a = 1 trigger on ignition going OFF
a = 2 trigger on ignition going ON
a = 3 trigger on transition (ON->OFF or OFF->ON)

The current ignition condition(s) for can be queried by igncond n where n is the condition number.
If n is blank, all ignition conditions will be queried.

Examples:

1. Set ignition condition 1 to trigger when ignition is going OFF
cmd igncond 1 1
OK

2. Set ignition condition 2 to trigger when an ignition transition (ON to OFF or OFF to ON) is detected.
cmd igncond 2 3
OK

A cmd save is required for this command to take effect.
See also: ignreport

ignreport (set ignition trigger report)
ignreport [n] [r]

This command sets the report to be used for ignition triggered reports.
Up to 8 ignition trigger reports can be configured.

n = 1 to 8 ignition trigger condition
r = 1 to 999 report number
r = 0 disables the report

Example:

1. Set report #2 for ignition trigger condition #1.
cmd ignreport 1 2
OK

A cmd save is required for this command to take effect.
See also: igncond, repaddmes, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype

input (query input channels status)
input

Reads the value and state of all inputs. There are a total of six inputs.
Both the analog voltage (range 0 to 10 Volts) and digital state (0 for off and 1 for on) are returned.

This is a read only command.

Example:

1. Query the current status of input #1 through #6
cmd input
0.00V 0
0.00V 0
0.00V 0
0.08V 0
0.08V 0
0.08V 0
OK
insetup (input setup)
insetup n d x.x p a

Configures the six inputs. Their use as a digital or analog input can be set along with their alarm states.

Note: Voltage threshold values are accurate to one decimal place, (X.X), if additional decimal place values are entered, they will be rounded to the nearest decimal place.

n = 1 to 6 input channel number

d = A set as analog input
d = D set as digital input

x.x = 0 to 9.9 sets the voltage threshold for alarm reporting (valid if input set as analog only, use 0.0 for digital input)

p = P sets input polarity to positive (this also determines the alarm level)
p = N sets input polarity to negative (this also determines the alarm level)

a = 0 alarm off
a = 1 alarm on
a = 2 alarm on change state (valid for digital inputs only)

The current setup can be queried by using the insetup without parameters.

Note: When configuring insetup with a digital input, the voltage threshold parameter is ignored. The modem's I/O module has fixed digital input thresholds of 3 V and 2 V (1 V hysteresis).

Examples:

1. Set input #2 as digital, with alarm when ON
cmd insetup 2 D 0.0 P 1
OK

2. Set input #4 as analog, with alarm when > 7.5V
cmd insetup 4 A 7.5 P 1
OK

3. Query the setup parameters for all 6 inputs
cmd insetup
cmd insetup 1 A 0.0 N 0
cmd insetup 2 A 0.0 N 0
cmd insetup 3 A 0.0 N 0
cmd insetup 4 A 0.0 N 0
cmd insetup 5 A 0.0 N 0
cmd insetup 6 A 0.0 N 0
OK

A cmd save is required for this command to take effect.

ioaddmes (add IO message)
ioaddmes n x [x2][x3][x4]

Adds a message to an IO report. 4 messages can be included in a single report. Duplicate messages cannot be included in a report.
Messages will be sent in a report in the same order that they are added.
Note that ULCP header messages will be sent as individual UDP packets – NMEA format messages will be combined into one UDP packet.

n = 1 to 8 IO report number
x message type to be added, valid message types must be used - see Message Formats.

Example:
cmd ioaddmes 4 16 adds message type #16 – GPS NMEA GLL – to IO report #4
cmd ioaddmes 4 displays all messages associated with IO report #4

A cmd save is required for this command to take effect.

iocond (IO report trigger conditions)
iocond n b t i1 i2 IP mt

Sets the condition(s) that would trigger an IO report.
The conditional parameter is used to indicate how all following parameters will be used to determine if a report is triggered.
Use the Off setting to disable the report.

n = 1 to 8 IO report number

b = 0 conditional operator for the following parameters: Off (default)
b = 1 conditional operator for the following parameters: AND
b = 2 conditional operator for the following parameters: OR

t = 0 timeout disabled
t = 1 to 65535 timeout in seconds

i1 = 0 alarm on input trigger: disabled
i1 = 1 to 6 alarm on input trigger: input number
i2 = 0 alarm on input trigger: disabled
i2 = 1 to 6 alarm on input trigger: input number

IP = 0 report if change in IP address: disabled
IP = 1 report if change in IP address: enabled

mt = 0 to 65535 maximum reporting rate in seconds (minimum time between reports)

The current condition(s) for a report can be queried by using iocond n where n is the report number.
If n is blank, all IO reports will be queried.

Examples:
cmd iocond 1 1 60 sends report #1 every 60 seconds
cmd iocond 2 1 60 1 sends report #2 every 60 seconds if input #1 is in alarm
cmd iocond 3 1 60 1 2 send report #3 every 60 seconds if inputs #1 and #2 are in alarm
cmd iocond 4 2 0 0 0 1 send report #4 whenever the IP address of the modem changes – this indicates that it has made a new network connection
cmd iocond 5 2 60 0 3 0 10 send report #5 every 60 seconds or while input #3 is in alarm but with a maximum report rate of one every 10 seconds
cmd iocond 6 1 0 6 0 0 10 send report #6 only while input #6 is in alarm but with a maximum report rate of one every 10 seconds
cmd iocond queries the conditions to trigger all IO reports

A cmd save is required for this command to take effect.

iodelmes (delete IO message)
iodelmes n x

Deletes a message (or all messages) from an IO report.

n = 1 to 8 IO report number
x message type to be deleted or 0 to delete all messages

Examples:
cmd iodelmes 1 16 deletes message type #16 from IO report #1
cmd iodelmes 4 0 deletes all messages from IO report #4

A cmd save is required for this command to take effect.

ioemail (IO email address)
ioemail n <email address>

Sets the email address that the IO report will be sent to (if configured for email using iorep).
Up to 8 email addresses may be configured – one for each of the 8 IO reports. The default email address is blank.

n = 1 to 8 IO report number

<email address> = name@domain email address to which the report will be sent
(leave blank to clear the email address)

The current email address can be queried for all IO reports by using the ioemail command without parameters.

Note that an email server is required – see emailsrv

Examples:

cmd ioemail 1 me@… sets the send to email address for IO report #1
cmd ioemail 1 clears the email address for IO report #1
cmd ioemail returns the email address for all 8 IO reports

A cmd save is required for this command to take effect.

iolocport (IO local port)
iolocport n xxxxx

Sets the port number of the local server that the IO report will be sent to. Up to 8 IO reports may be configured.

n = 1 to 8 IO report number
xxxxx = 0 to 65535 local port number

The current local port configuration for an IO report can be queried by using iolocport n where n is the report number.
If n is omitted, all reports will be queried.

Examples:
cmd iolocport 1 5005 report #1 will be sent to local port 5005
cmd iolocport queries the local port setting of all IO reports

A cmd save is required for this command to take effect.

iomes (IO messages)
iomes

Displays all messages associated with each IO report.
This is a read only command.

Example:
cmd iomes displays all messages associated with each IO report

ioremip (IO remote IP address)
ioremip n iii.iii.iii.iii

Set the IP address of the remote server that the IO report will be sent to. Up to 8 IO reports may be configured.

n = 1 to 8 IO report number

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 remote IP address in decimal

The current IP address for an IO report can be queried by using ioremip n where n is the report number.
If n is omitted, all reports will be queried.

Examples:

cmd ioremip 1 123.10.1.101 report #1 will be sent to remote IP address 123.10.1.101

cmd ioremip queries the remote IP address setting of all IO reports

A cmd save is required for this command to take effect.

ioremport (IO remote port)
ioremport n xxxxx

Sets the IP port number of the remote server that the IO report will be sent to. Up to 8 IO reports may be configured.

n = 1 to 8 IO report number

xxxxx = 0 to 65535 remote port number

The current IP port configuration for an IO report can be queried by using ioremport n where n is the report number.
If n is omitted, all reports will be queried.

Examples:

cmd ioremport 1 5005 report #1 will be sent to port 5005 on remote IP address set by ioremip

cmd ioremport queries the remote port setting of all IO reports

A cmd save is required for this command to take effect.

iorep (IO reporting)
iorep n l r s

Sets the reporting type for each IO report for the local and remote servers.

n = 1 to 8 IO report number

l = 0 disables the local report (default)
l = 1 asynchronous NMEA or ULCP messages over RS232
l = 2 asynchronous NMEA or ULCP messages with a ULCP header over RS232
l = 3 in-band NMEA or ULCP messages in a UDP Packet over Ethernet
l = 4 in-band NMEA or ULCP messages with a ULCP header and in individual UDP packets over Ethernet
l = 5 in-band NMEA or ULCP messages in a TCP Packet over Ethernet

r = 0 disables the remote report (default)
r = 3 in-band NMEA or ULCP messages in a UDP Packet
r = 4 in-band NMEA or ULCP messages with a ULCP header and in individual UDP packets
r = 5 in-Band NMEA or ULCP messages in a TCP Packet
r = 6 email reports
r = 7 SMS reports

s = 0 disables the store and forward of IO reports
s = 1 enables the store and forward of IO reports

Note: For r = 7 (SMS reports), the total length of the report must not exceed 166 characters including <CR> and <LF>

The current report configuration for an IO report can be queried by using iorep n where n is the report number.
If n is omitted, all reports will be queried.

Examples: cmd iorep 4 3 3 this will send IO report #4 as a UDP packet over Ethernet and over the wireless link, and will not store IO reports

cmd iorep 2 3 7 1 this will send IO report #2 as a UDP packet over Ethernet and as an SMS message to the SMS destination set using the iosms command, and will enable the store and forward of IO reports

cmd iorep queries the reporting method for all IO reports

A cmd save is required for this command to take effect.

iosms (set destination of IO SMS report)
iosms n pppppppppp or <email address>

Sets the destination of the IO report that is sent as an SMS message. Up to 8 IO reports may be configured. The default SMS destination is blank.

Note: SMS features are only available for specific manufacturer, RF modules, cards or devices. Please contact Cypress Solutions for a complete list of products that support SMS functionality.

n = 1 to 8 IO report number

pppppppppp phone number which the SMS report will be sent to. For long distance calls, a “1” needs to be added In front of the phone number.
(leave blank to clear the phone number)

<email address> email address which the SMS report will be sent to.
(leave blank to clear the address)

The current SMS destination configured for all IO reports can be queried by using the iosms command without parameters.

Examples:

cmd iosms 1 1234567890 sends IO report #1 as an SMS message to the specified phone number

cmd iosms 2 me@… sends IO report #2 as an SMS message to the specified email address

cmd iosms 1 clears the SMS destination for IO report #1

cmd iosms queries the phone numbers or email addresses for all IO SMS reports

A cmd save is required for this command to take effect.

ipadr (IP address)
ipadr
Queries the IP address assigned to the modem by the wireless network.

This is a read only command.

Example:

1. Query the current IP address of the modem
cmd ipadr
96.2.1.161
OK
Back to top
J
  • No commands
Back to top
K
  • No commands
Back to top
L
landhcp (LAN DHCP server settings)
landhcp aaa.aaa.aaa.aaa bbb.bbb.bbb.bbb n (Firmware version R1.2.x)

Configures the LAN dynamic host configuration protocol (DHCP) server settings, specifically the range of IP addresses to assign to DHCP users and the maximum number of DHCP users on the LAN.

aaa.aaa.aaa.aaa = 0.0.0.0 to 255.255.255.255 Starting DHCP IP address in decimal (default: 192.168.1.20)
bbb.bbb.bbb.bbb = 0.0.0.0 to 255.255.255.255 Ending DHCP IP address in decimal (default: 192.168.1.254)
n = 1 to 254 Maximum number of DHCP clients (default: 10)

This command requires a cmd save and power cycle to take effect.

Examples:

1. Assign DHCP users with IP addresses within 192.168.10.20 – 192.168.10.254 inclusive to a maximum of 15 users
cmd landhcp 192.168.10.20 192.168.10.254 15
OK

2. Query current DHCP range and number of users
cmd landhcp
cmd landhcp 192.168.1.20 192.168.1.254 10
OK

See also: landns, lanip, lannetmask, lanrepip, http://en.wikipedia.org/wiki/DHCP

landns (LAN DNS nameserver settings)
landns aaa.aaa.aaa.aaa bbb.bbb.bbb.bbb

Configures the DHCP DNS nameserver(s). Configure up to two DNS nameserver IP addresses.

aaa.aaa.aaa.aaa = 0.0.0.0 to 255.255.255.255 DNS nameserver 1 IP address (default: 204.174.120.45)
bbb.bbb.bbb.bbb = 0.0.0.0 to 255.255.255.255 DNS nameserver 2 IP address (default: 204.174.120.46)

Examples:

1. Configure DNS nameserver to IP address 199.199.199.199
cmd landns 199.199.199.199
OK

2. Query current DNS nameservers
cmd landns
cmd landns 204.174.120.45 204.174.120.46
OK

A cmd save is required for this command to take effect.
See also: landhcp, lanip, lannetmask, lanrepip

lanip (IP address of modem on LAN)
lanip iii.iii.iii.iii

Sets the IP address of the modem on the LAN.

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 LAN IP address of the modem in decimal (default: 192.168.1.1)

Note: Special care must be taken when configuring this command, if an improperly configured lanip IP address is entered the ethernet port can be rendered unusable. Before configuring this command it is advisable to make sure that a command console is available via the serial port, or the IP address is known and remote telnet is enabled to allow the modem to be accessed wirelessly.

The current LAN IP address can be queried by using lanip.

Examples:

1. Set the LAN IP address of the modem to 192.168.10.1
cmd lanip 192.168.10.1
OK

2. Query the LAN IP address of the modem
cmd lanip
cmd lanip 192.168.1.1
OK

This command requires a cmd save and power cycle to take effect. After taking effect, local Telnet should be accessed via the IP address specified in the command.
See also: landhcp, landns, lannetmask, lanrepip

lannetmask (Netmask of modem on LAN)
lannetmask iii.iii.iii.iii

Sets the netmask of the modem on the LAN.

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 LAN netmask of the modem in decimal (default: 255.255.255.0)

Note: Special care must be taken when configuring this command, if an improperly configured lannetmask IP address is entered the ethernet port can be rendered unusable. Before configuring this command it is advisable to make sure that a command console is available via the serial port, or the IP address is known and remote telnet is enabled to allow the modem to be accessed wirelessly.

The current LAN netmask can be queried by using lannetmask.

Examples:

1. Set the LAN netmask of the modem to 255.255.0.0
cmd lannetmask 255.255.0.0
OK

2. Query the LAN netmask of the modem
cmd lannetmask
cmd lannetmask 255.255.255.0
OK

This command requires a cmd save and power cycle to take effect.
See also: landhcp, landns, lanip, lanrepip

http://en.wikipedia.org/wiki/Netmask

lanrepip (LAN IP address for local reporting)
lanrepip iii.iii.iii.iii

Sets the IP address of the local server connected to the modem’s LAN that will receive local reports.

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 LAN IP address to receive local reports in decimal (default: 192.168.1.20)

This command requires a cmd save and power cycle to take effect.

The LAN IP address of the server currently used to receive local reports can be queried by using lanrepip.

Examples:

1. Set the local reporting LAN IP address to 192.168.1.21
cmd lanrepip 192.168.1.21
OK

2. Query the LAN IP address to which local reports will be sent
cmd lanrepip
cmd lanrepip 192.168.1.20
OK

A cmd save is required for this command to take effect.
See also: landhcp, landns, lanip, lannetmask

Back to top
M
mip (mobile IP)
mip n

Sets the Mobile IP operation of the modem.

n = 0 simple IP only (mobile IP disable)
n = 1 mobile IP preferred (default)
n = 2 mobile IP only

The current mobile IP can be queried by using the mip without parameters.

Examples:
cmd mip 1 sets the MIP option to be MIP preferred
cmd mip returns the current MIP value

A cmd save is required for this command to take effect.

http://en.wikipedia.org/wiki/Mobile_IP

modbusadd (add a MODBUS TCP slave, serial slave or self slave, query MODBUS slave gateway list)
modbusadd

This command when used without arguments is used to display all the entries in the MODBUS slave gateway list.

Example:
cmd modbusadd displays the MODBUS list

modbusadd id nnn.nnn.nnn.nnn

This command is used when the modem is being used as a MODBUS SLAVE device.

Adds a MODBUS TCP Slave. The listening port for TCP slaves is the port number configured using modbusport.

id = 1 to 247 MODBUS ID
nnn.nnn.nnn.nnn = 1.0.0.0 to 255.255.255.255 MODBUS slave IP address (IP address of MODBUS devices connected to the modem's ethernet port)

modbusadd id Serial m

Adds a MODBUS Serial Slave (Added in firmware version R1.2.1)

id = 1 to 247 MODBUS ID
m = a or A ASCII transmission mode
m = r or R RTU transmission mode

Note1: The MODBUS slave gateway will use the serial port settings configured using the port command for all serial slaves.

Note2: For MODBUS RTU configuration to function properly d = 8 must be entered. (This configuration is in accordance with the MODBUS specification)

Note3: modbusadd will return “Invalid IP address (Sx)” followed by an “OK” if modbusadd is configured with parameters missing or incorrect parameters. Ensure that the modbussadd parameters match those from the above list.

Note4: All MODBUS serial slave devices connected to a serial bus configuration such as RS485 must use the same transmission mode. (This configuration is in accordance with the MODBUS specification)

modbusadd id n p d s m w

Adds a MODBUS Serial Slave (Previously in firmware version R1.2.0 and below)

id = 1 to 247 MODBUS ID
n = 1200 1200 Baud
n = 2400 2400 Baud
n = 4800 4800 Baud
n = 9600 9600 Baud
n = 19200 19200 Baud
n = 38400 38400 Baud
n = 57600 57600 Baud
n = 115200 115200 Baud
p = n or N no parity
p = e or E even parity
p = o or O odd parity
d = 7 or 8 data bits
s = 1 or 2 stop bits
m = a or A ASCII transmission mode
m = r or R RTU transmission mode
w = f or F flow control, leave empty for no flow control

Note1: For MODBUS RTU configuration to function properly d = 8 must be entered. (This configuration is in accordance with the MODBUS specification)

Note2: modbusadd will return ERROR if modbusadd is configured with parameters missing or incorrect parameters. Ensure that the modbusadd parameters match those from the above list.

modbusadd backward compatibility
Starting in firmware version R1.2.1, the newer form modbusadd id Serial m used with the port command is the preferred way for adding new serial slaves.

Starting in firmware version R1.2.1, the form modbusadd id n p d s m w is provided for backward compatibility only. This form uses the n p d s w parameters with port to set the serial port settings and the id m parameters with modbusadd id Serial m. The form modbusadd id n p d s m w is only used for setting and will not be queried back in the same form. The changes that come into effect by using this form can be queried by using the modbusadd and the port commands; using modbusadd without parameters will always display commands in the form modbusadd id Serial m.

Example:
# cmd modbusadd 5 9600 e 7 2 a
OK
# cmd port
cmd port 9600 7 E 2 0
OK
# cmd modbusadd
cmd modbusadd 5 Serial A
OK

When the modem is upgraded to firmware version R1.2.1 and has been previously set to cmd mode 6, modem configurations containing the form modbusadd id n p d s m w will automatically be converted upon power cycle to modbusadd id Serial m and port n d p s f (where f = 2 if w = f or F, and f = 0 in all other cases).

After upgrading to firmware version R1.2.1, to convert from modbusadd id n p d s m w to modbusadd id Serial m when another mode has been previously configured, enter cmd mode 6, cmd save, and power cycle. To restore the modem to its previous mode, enter cmd mode n (where n is the previous mode), cmd save, and power cycle.

modbusadd id

Adds MODBUS self slave - only one is permitted.

id = 1 to 247 MODBUS ID

Examples:

1. add TCP slave with ID 1 and IP 192.168.100.122
cmd modbusadd 1 192.168.100.122

2. add itself as a MODBUS slave with ID = 3
cmd modbusadd 3

3. Add serial slave with baud 115200, no parity, 8 data bits, 1 stop bit and as ASCII transmission mode
cmd port 115200 8 N 1 0
cmd modbusadd 17 Serial A

4. Display the list of modbus devices.
TCP slave device with ID = 247, self slave device with ID = 10, serial slave device (ASCII transmission mode) with ID = 155
cmd modbusadd
(192.168.1.20,247)
(Localhost,10)
(Serial.A,155)

A cmd save is required for this command to take effect.

modbusctm130 (enable backward compatibility with CTM13x MODBUS messages over-the-air)
modbusctm130 n

Enables MODBUS backward compatibility with the CTM13x by using MODBUS RTU encapsulated in UDP packets for messages transmitted/received over-the-air.
The CTM13x modems only use MODBUS RTU over UDP as the over-the-air protocol for communicating between other modems configured as MODBUS master and slave gateways.

n = 0 use MODBUS TCP for over-the-air communications (default)
n = 1 use MODBUS RTU over UDP for over-the-air communications

A cmd save, and a power cycle are required before the modem is configured to use the specified MODBUS over-the-air protocol.

Examples:

cmd modbusctm130 1 Set MODBUS gateway to send/receive MODBUS RTU over UDP messages

cmd modbusctm130 Query the currently configured MODBUS over-the-air protocol

A cmd save is required for this command to take effect.

modbusdel (delete MODBUS entry)
modbusdel n

Deletes an entry or all entries from the MODBUS list.

n = 0 deletes all MODBUS entries
n = 1 to 247 MODBUS ID entry

Examples:

cmd modbusdel 1 delete the entry with MODBUS ID 1

cmd modbusdel 0 delete all entries in the MODBUS list

A cmd save is required for this command to take effect.

modbusidmap (set up MODBUS ID to modem IP:port map)
modbusidmap n a.a.a.a p

This command is only configured when using the modem as a MASTER GATEWAY (cmd modbusmode 1 or cmd modbusmode 2). This command returns ERROR if the modem is configured as a SLAVE GATEWAY (cmd modbusmode 0).

This command sets up the MODBUS ID to modem IP for each remote MODBUS slave device (i.e. another CTM15x modem configured as a MODBUS slave gateway).
The default for all entries is n 0.0.0.0. Use n 0.0.0.0 0 to erase an entry. Use 0 0.0.0.0 to erase all entries. One entry is added at a time with a limit of up to 247 entries (each entry requires a unique ID).
To change an entry, one must first erase it then enter the changed IP address and port number.

n = 1 to 247 MODBUS ID, in decimal
a.a.a.a = 0.0.0.0 to 255.255.255.255 MODBUS slave modem IP address, in decimal(wireless modem IP address)
p = 0 to 65535 Port that the slave modem will be listening on, in decimal

Examples:

1. Set the MODBUS master gateway to forward messages designated for the slave device with ID 1 to the modem at 123.1.2.3, port 502
cmd modbusidmap 1 123.1.2.3 502
OK

2. Clear the MODBUS ID to modem IP entry for slave ID 1
cmd modbusidmap 1 0.0.0.0 0
OK

3. Change slave ID 1 entry to the modem with an IP of 123.1.2.4
cmd modbusidmap 1 123.1.2.4 502
OK

4. Clear all MODBUS ID to modem IP entries
cmd modbusidmap 0 0.0.0.0
OK

5. Query all MODBUS ID to modem IP entries
cmd modbusidmap
OK

A cmd save is required for this command to take effect.
See also: modbusctm130, modbusmode

modbusmode (sets the MODBUS gateway mode)
modbusmode n

Sets the specified MODBUS gateway mode of the modem, specifically, the transmission mode between the modem configured as the serial master gateway and the MODBUS serial device connected to the modem.

n = 0 slave gateway (default)
n = 1 RTU master gateway
n = 2 ASCII master gateway

A cmd mode 6, cmd save, and a power cycle are required before the modem is fully configured in a MODBUS mode.

Examples:

1. Set modem to be a MODBUS serial RTU master gateway

cmd modbusmode 1
OK

2. Query the currently configured MODBUS gateway mode

cmd modbusmode
cmd modbusmode 1
OK

A cmd save is required for this command to take effect.

See also: mode

modbusport (sets the MODBUS port number)
modbusport xxxxx

Sets the listening port number for the MODBUS server and the listening port number for MODBUS TCP slaves.
Default is 502.

xxxxx = 1 to 65535 MODBUS server port number

The current MODBUS port number can be queried by entering the modbusport command without parameters.

Note:

If the modem is currently in MODBUS mode and any other LAN or firewall configuration commands are set after issuing the modbusport command, then both a cmd save and a power cycle are required to resume proper MODBUS operation.

Examples:

1.Set the MODBUS port to 12345

cmd modbusport 12345 OK

2. Query the existing MODBUS port

cmd modbusport cmd modbusport 502 OK

A cmd save and power cycle are required for this command to take effect.

See also: modbusadd, modbusdel, modbusctm130, modbusidmap, modbusmode, mode

mode (sets connection mode)
mode n

Sets the required connection mode of the modem.

n = 1 manual connection
n = 2 auto connect to the network (default)
n = 3 auto connect to the network and go directly into PPP mode
n = 4 auto connect to both the network and the PAD host interface
n = 5 auto connect to the network and serial LCD (future)
n = 6 auto connect to both the network and the MODBUS host interface
n = 8 auto connect to both the network and the Elmscan diagnostic tool for OBD II
n = 9 auto connect to both the network and the magnetic swipe card reader
n = 10 auto connect to both the network and the WPAN Gateway
n = 12 auto connect to both the network and the Chlorobyte Salt Spreader interface

For n = 3 to 8, a cmd save and a power cycle are required before the mode takes effect, for all others mode settings a power cycle is not required.

To escape out of the mode (to get a command prompt – console) do the following:

mode = 3 – type EXIT, type cmd port nnnn (where nnnn is the current baud rate)

mode = 4 – type +++, wait 3 seconds, type cmd port nnnn (where nnnn is the current baud rate); Refer to padesc and padesct for escape sequence

mode = 8 – change hyper terminal baud rate to 9600, type EXIT, change hyper terminal baud rate to nnnn, type cmd port nnnn (where nnnn is the currently set baud rate)

The current mode setting can be queried by using the mode without parameters.

Examples:
1. Set the mode to auto connect

cmd mode 2
OK

2. Query the current connection mode of the modem

cmd mode
cmd mode 2
OK

A cmd save is required for this command to take effect.

modemdevice (configure modem device port) NEW to R1.2.1
modemdevice [ /dev/ttyUSBn ]

Configure the modem serial port device. Default is /dev/ttyUSB0.

This command requires a cmd save and modem power cycle to take effect.

Example:

cmd modemdevice /dev/ttyUSB1
OK

cmd modemdevice
cmd modemdevice /dev/ttyUSB1
OK
modemid (assign modem ID)
modemid <string>

Assigns a user configurable ID to the modem.
If no ID is given then the modem’s 11-digit decimal ESN (if available) will be used.
If less than 11 characters is entered, trailing 0’s will be automatically inserted in message type 112.

Examples:
cmd modemid CAR1234 sets the modem ID to <CAR1234>

cmd modemid returns the currently configured modem ID

A cmd save is required for this command to take effect.

Back to top
N
netwd (Network watchdog)
netwd t n

Sets the network watchdog feature.
This feature is used to listen for incoming data traffic to make sure there is network connectivity.
If no data is received within the watchdog timer time out period (t * n), the modem will disconnect from the network and reconnect to the network. If the watchdog timer expires a second time after attempting to reconnect unsuccessfully the first time (no data received), the modem will be power cycled.

The user will define the time interval (t) the command will use to monitor network activity. The user will also define the number of times the command needs to see consecutive data packets (n) before the watchdog timer expires and the command resets the network connection/device. If data is received within this interval, the timer interval and number of times will be reset.

t = 0 disable (default)
t = 1 to 65535 time to wait for incoming data (seconds)
n = 0 to 65535 number of times the timer needs to expire before disconnecting and reconnecting to the network

A cmd save and power cycle is required before this setting takes effect.

Typically, netwd is used in conjunction with the ping command. The ping command will generate the network traffic that netwd will watch for.

Examples:

1. Set the timer to 10 seconds and check 6 times.

cmd netwd 10 6
OK

In the above example, the command will look for incoming traffic from the network at 10 seconds intervals. If no data traffic is detected for 6 consecutive intervals 6 x 10 = 60 sec. the command will disconnect and reconnect to the network. If a reconnect does not resolve the issue (approx 10 seconds reconnect time) the command will cycle the modem power completely (approx 50 seconds reconnect time) after an additional 6 intervals of no data.

If data is received, the command will not reset the network connection and the device will operate without interruption.

2. Query the current netwd configuration

cmd netwd
cmd netwd 10 6
OK

See also: ping

Back to top
O
obdcond (OBD report trigger conditions)
obdcond n b t mt [trig1 ... trig4]

Sets the condition(s) that will trigger an OBD report.
The conditional operator is used to indicate how all following parameters will be used to determine if a report is triggered.

n = 1 to 8 OBD trigger number
b = 0 conditional operator for all following parameters: Off
b = 1 conditional operator for all following parameters: AND
b = 2 conditional operator for all following parameters: OR
t = 0 timeout disabled
t = 1 to 65535 timeout in seconds
mt = 0 to 65535 maximum reporting rate in seconds (minimum time between reports)

Optional parameters:
trigx trigger parameter x enclosed in single quotes and without spaces in between, in the form 'pid^val' where:
pid = p1 to pb engine parameters as per OBD2/J1939 Parameters table except for p4 and id
^ - > trigger using greater than operator
^ - = trigger using equal to operator
^ - < trigger using less than operator
val engine parameter value that sets off the trigger, in decimal nnnn.nn (refer to OBD2/J1939 Parameters table for allowable range of values)

Each OBD trigger condition may be configured with up to 4 trigger parameters.

The current parameter(s) for a trigger condition can be queried by using the obdcond n command. If n is blank, all OBD trigger conditions will be queried.

Examples of OBD trigger parameters:
'p1>0' trigger is set off when p1 (vehicle speed) is greater than 0 km/h
'p2=5000' trigger is set off when p2 (engine RPM) is equal to 5000 RPM
'p8<200.75' trigger is set off when p8 (engine coolant temperature) is less than 200.75°C

Examples:

1. Set OBD trigger #1 to send a report every 60 seconds

cmd obdcond 1 1 60
OK

2. Set OBD trigger #2 to send a report every 30 seconds AND P1 (vehicle speed) is equal to 0.0 km/h with a maximum report rate of one every 5 seconds

cmd obdcond 2 1 30 5 'p1=0.0'
OK

3. Set OBD trigger #3 to send a report every 60 seconds OR P1 (vehicle speed) is greater than 0 km/h OR P2 (engine RPM) is greater than 2000 with a maximum report rate of one every 5 seconds

cmd obdcond 3 2 60 5 'p1>0' 'p2>2000'
OK

4. Set OBD trigger #4 to send a report only when P1 (vehicle speed) is less than 10 km/h AND P2 (engine RPM) is equal to 0 RPM AND P7 (calculated engine load value) is equal to 0 percent AND P8 (engine coolant temperature) is -40°C with a maximum report rate of one every 15 seconds

cmd obdcond 4 1 0 15 'p1<10.00' 'p2=0.00' 'p7=0.00' 'p8=-40.00'
OK

5. Query all the trigger conditions used for OBD reports

cmd obdcond
cmd obdcond 2 1 30 5 'p1=0.0'
cmd obdcond 3 2 60 5 'p1>0' 'p2>2000'
OK

6. Query the parameters for OBD trigger condition #3

cmd obdcond 3
cmd obdcond 3 2 60 5 'p1>0' 'p2>2000'
OK

A cmd save is required for this command to take effect.

See also: OBD2/J1939 Parameters, obdreport, pobda-pobdd

obddata (Display data obtained from OBDII transmitter)
obddata

Displays the current OBD engine parameters and corresponding values obtained from the OBDII transmitter and the time since they were last updated.
If no engine parameters have been obtained yet, the command returns ERROR

This command is read-only.

Example:
cmd obddata displays OBD engine parameters and time since they were last updated

# cmd obddata
These OBD engine parameters were updated 001 seconds ago
Timestamp : Thu Jan 1 00:14:48 1970
p1=131,p2=0,p3=40,p4=AGV-SIMULATOR 1.5
p5=0,p6=0,p7=16,p8=55
p9=384,p10=128,p12=80,p13=81.92
id=0013A200403078CF,pa=0,pb=0
OK
obdreport (Set report for OBD trigger)
obdreport [n] [r]

This command sets the report to be used for a OBD triggered report.

n = 1 to 8 number of the OBD trigger condition
r = 1 to 999 report number
r = 0 disables the report

obdreport requires the modem to be listening for traffic from the WPAN gateway, this requires cmd mode 10 to be configured.

Example:

1. Set report #2 for OBD triggered report #1.

cmd obdreport 1 2
OK

A cmd save is required for this command to take effect.

See also: mode, obdcond, repaddmes, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype

obdsp (Sets protocol used by OBDII transmitter)
obdsp n

Sets the protocol used by the OBDII transmitter.

n = 0 Automatic
n = 1 SAE J1850 PWM
n = 2 SAE J1850 VPW
n = 3 ISO 9141-2
n = 4 ISO 14230-4 KWP (slow)
n = 5 ISO 14230-4 KWP (fast)
n = 6 ISO 15765-4 CAN (11 bit ID, 500 Kbaud)
n = 7 ISO 15765-4 CAN (29 bit ID, 500 Kbaud)
n = 8 ISO 15765-4 CAN (11 bit ID, 250 Kbaud)
n = 9 ISO 15765-4 CAN (29 bit ID, 250 Kbaud)
n = 10 SAE J1939 CAN (29 bit ID, 250 Kbaud)
n = 11 USER1 CAN (11 bit ID, 125 Kbaud)
n = 12 USER2 CAN (11 bit ID, 50 Kbaud)

The current OBDII transmitter protocol can be queried by using the obdsp command without parameters.
Note that option 0 (Automatic) only replaces OBD2 protocol options 1-9. Some vehicles may exhibit problems with automatic protocol discovery. obdsp must specifically be set to match the protocol on those vehicles.

Examples:

1. Set the OBDII transmitter to use the J1939 protocol

cmd obdsp 10
OK

2. Query the current OBDII transmitter protocol

cmd obdsp
cmd obdsp 7
OK

A cmd save is required for this command to take effect.

odometer (GPS odometer)
odometer n

Sets/queries the GPS odometer.
The GPS odometer keeps track of the distance travelled in km by using GPS position data. If n is omitted, the current value of the GPS odometer will be queried.
The maximum odometer value is 1999999 km. The odometer will roll over to 0 km when the current odometer value exceeds the maximum.

The GPS odometer is reset to 0 km whenever one of these cases applies:
(i) n is specified as reset
(ii) n is specified as 0
(iii) cmd factory is issued.

Examples:

1. Reset the GPS odometer value to 0

cmd ctm15x OK cmd odometer reset OK

2. Reset the GPS odometer value to 0

cmd ctm15x OK cmd odometer 0 OK

3. Set the GPS odometer to 100000 km

cmd ctm15x OK cmd odometer 100000 OK

4. Query the current GPS odometer value in km

cmd odometer 1245 KM OK

See also: ctm15x

otasp (Over-The-Air Service Provisioning)
otasp

This command is used to perform automatic wireless network activation and updates any required network related files that are embedded in the wireless modem.

The modem responds with one or more of the following messages:

  • SPL Unlocked
  • Authentication key has been exchanged
  • Shared secrets data has been updated
  • New NAM parameters have been downloaded
  • New MDM has been downloaded
  • IMSI has been downloaded
  • PRL has been downloaded

During updating, if any of the above data is unsuccessful, an OTASP Timeout message will be displayed.
A progress message OTASP Processing will be displayed every 10 seconds.
When the OTASP process has been completed, the OTASP Disconnected message will be displayed.

Example:

1. Initiate automatic wireless network activation

cmd otasp
OK
Back to top
P
pad (manual PAD initiation)
pad

Initiates a packet data connection. Use this to initiate a manual PAD connection from the serial port console. Do not use this command from telnet console!
Use cmd mode 4 to put the modem in permanent PAD mode (enter PAD automatically after a power cycle).

Example:

1. Initiate a manual PAD packet connection to the wireless network

cmd pad
OK

See also: padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padmode, padport, padreset, padsvct

padecho (PAD echo mode)
padecho n

Sets the PAD echo mode – if echo is enabled then all data sent to the modem on its RS232 port by an external device is echoed back to that device.

n = 0 PAD echo mode: disabled

n = 1 PAD echo mode: enabled (default) The current PAD echo mode can be queried by using the padecho command without parameters.

Examples:

1. Disable the PAD echo – characters received on the modem’s RS232 port will not be echoed to the connected device

cmd padecho 0
OK

2. Query the current PAD echo setting

cmd padecho
cmd padecho 1
OK

A cmd save is required for this command to take effect.

See also: pad, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padmode, padport, padreset, padsvct

padesc (PAD escape sequence)
padesc <str>

Sets the PAD escape sequence used to return to command line mode.
Default is +++.
When using the escape sequence it is necessary to wait the guard time (padesct) before entering data
Enter only the escape sequence (do not enter any other characters including <CR> or <LF>)
If PAD forwarding time (padfwdt) is set there will be a delay until the escape characters are forwarded.
The guard time (padesct) must also be honored, to allow the modem to escape from PAD mode.

<str> PAD escape sequence, 10 characters maximum, no spaces, case sensitive

The current PAD escape sequence can be queried by using the padesc command without parameters.

Examples:

1. Set the PAD escape sequence to ASCII string 12345

cmd padesc 12345
OK

2. Query the current PAD escape string

cmd padesc
cmd padesc +++
OK

A cmd save is required for this command to take effect.

See also: pad, padecho, padesct, padfwdc, padfwdl, padfwdt, padip, padmode,
padport, padreset, padsvct

padesct (PAD escape guard time)
padesct n

Sets the PAD escape guard time.
This is the idle time before and after the PAD escape sequence which must be present for the escape sequence to be recognized.

n = 0 to 65535 PAD escape guard time in seconds. Default is 3 seconds.

NOTE: values greater than 8 seconds shouldn't be used in TCP PAD client mode.

The current PAD escape guard time can be queried by using the padesct command without parameters.

Examples:

1. Set the PAD escape guard time to 4 seconds

cmd padesct 4
OK

2. Query the current PAD escape guard time

cmd padesct
cmd padesct 3
OK

A cmd save is required for this command to take effect.

See also: pad, padecho, padesc, padfwdc, padfwdl, padfwdt, padip, padmode, padport, padreset, padsvct

padfwdc (PAD forwarding character)
padfwdc x

Sets the PAD forwarding character. Default = 13 (ASCII <enter>)

x = 0 padfwdt or padfwdl will invoke sending the packet
x = 1 to 255 PAD forwarding character representing an ASCII character.

The current PAD forwarding character can be queried by using the padfwdc command without parameters

Examples:

1. sets the PAD forwarding character to ASCII <space>

cmd padfwdc 32
OK

2. Query the current PAD forwarding character

cmd padfwdc
cmd padfwdc 32
OK

A cmd save is required for this command to take effect.

See also: pad, padecho, padesc, padesct, padfwdl, padfwdt, padip, padmode,
padport, padreset, padsvct

padfwdl (PAD forwarding length)
padfwdl x

Sets the maximum PAD packet length. Default = 40.
If 0 is specified then every character is sent immediately.

x = 0 sent every characters immediately

x = 1 to 1000 maximum PAD packet length

The current PAD packet length can be queried by using the padfwdl command without parameters.

Examples:

1. Configure the received RS232 data to be sent in packets of 10 characters each

cmd padfwdl 10 OK

2. Query the current PAD forwarding length setting

cmd padfwdl cmd padfwdl 10 OK

A cmd save is required for this command to take effect.

See also:pad, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padmode,
padport, padreset, padsvct

padfwdt (PAD forwarding time)
padfwdt x

Sets the PAD forwarding time. Default = 1 second.
If 0 is specified then this disables the forwarding timer and every character will be sent immediately.

x = 0 to 255 PAD forwarding time in increments of 50ms

The current PAD forwarding time can be queried by using the padfwdt command without parameters.

Examples:

1. Set the PAD forwarding time to 2 seconds

cmd padfwdt 40 OK

2. Query the current PAD forwarding time

cmd padfwdt cmd padfwdt 40 OK

A cmd save is required for this command to take effect.

See also: pad, padecho, padesc, padesct, padfwdc, padfwdl, padip, padmode, padport, padreset, padsvct

padip (PAD IP address)
padip iii.iii.iii.iii

Sets the remote PAD IP address.

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 remote IP address

Use 0.0.0.0 to set the modem in PAD server mode. Default is 0.0.0.0

The current remote PAD IP address can be queried by using the padip command without parameters.

Examples:

1. Set the PAD IP address to 192.168.1.1

cmd padip 192.168.1.1
OK

2. Query the current PAD IP address

cmd padip
cmd padip 192.168.1.1
OK

A cmd save is required for this command to take effect.

See also: pad, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padmode, padport, padreset, padsvct

padmode (PAD mode)
padmode x

Sets the PAD mode.

x = 0 start up UDP PAD mode. The modem will revert to server mode once the connection is closed. (default)
x = 1 start up TCP PAD mode. The modem will revert to server mode once the connection is closed.
x = 2 start up UDP PAD client mode - one session. The modem will revert to command mode once the connection is closed.
x = 3 start up TCP PAD client mode - one session. The modem will revert to command mode once the connection is closed.
x = 4 start up persistent UDP PAD client mode
x = 5 start up persistent TCP PAD client mode

The current PAD mode can be queried by entering the padmode command without parameters. The connection is closed if one of the following occurs:

  • padsvct idle timeout expires
  • padsvct maximum session timeout expires
  • cmd padreset is executed
  • The connection is closed by remote host (TCP PAD only)

If padip is set to 0.0.0.0, PAD will start in server mode. Otherwise it will start in client mode. Note that for the client modes (2, 3, 4 and 5), padip must be different than 0.0.0.0.

Examples:

1. Set to TCP PAD mode

cmd padmode 1
OK

2. Query the current PAD mode

cmd padmode
cmd padmode 1
OK

A cmd save is required for this command to take effect.

See also: pad, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padport, padreset, padsvct

padport (PAD port number)
padport xxxxx

Sets the remote PAD port number.
This is the listening port if the modem is in PAD server mode. Default is 5005.

xxxxx = 0 to 65535 remote PAD port number

The current PAD port number can be queried by entering the padport command without parameters.

Note:

If the modem is currently in PAD mode and any other LAN or firewall configuration commands are set after issuing the padport command, then both a cmd save and a power cycle are required to resume proper PAD operation."

Examples:

1.Set the PAD port to 5005

cmd padport 5005 OK

2. Query the existing PAD port

cmd padport cmd padport 5005 OK

A cmd save is required for this command to take effect.

See also: pad, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padmode, padreset, padsvct

padreset (PAD reset)
padreset

Resets the PAD connection.
The actions taken by padreset are to drop the PAD connection and to return the modem to server mode.
These actions are equivalent to those that occur when the padsvct timer expires.

Examples:

1. Reset the PAD port

cmd padreset
OK

See also: pad, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padmode, padport, padreset, padsvct

padsvct (PAD server connection cut-off timer)
padsvct n [c]

Sets the PAD server connection timeout.
If no data is sent or received within this timeout value, the PAD connection will be dropped and the modem will return to server mode.
If the optional parameter for the maximum PAD connection timer is specified, once the timer expires, the current PAD connection will be dropped regardless of the data connection condition.
The modem will revert to the current PAD mode setting and maintain the PAD session.

n = 0 PAD server connection timeout: disabled

n = 1 to 65535 PAD server connection timeout in seconds. Default is 15 seconds

Optional Parameter:

c = 0 Maximum PAD connection time: disabled (default)

c = 1 to 65535 Maximum PAD connection time in seconds.

The current PAD server connection timeout setting can be queried by entering padsvct command without parameters

Examples:

1. Configure the modem to revert to server mode after 10 seconds of data inactivity

cmd padsvct 10
OK

2. Configure the PAD connection to be dropped after 60 seconds

cmd padsvct 15 60
OK

3. Query the current padsvct settings

cmd padsvct
cmd padsvct 15 0
OK

A cmd save is required for this command to take effect.

See also: pad, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padmode, padport, padreset, padsvct

pendantreport (set pendant report)
pendantreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

This command sets the report(s) to be used for pendant triggered reports.

Up to 8 reports can be assigned to the pendantreport.

r = 0 disables the report
r = 1 to 999 report number

pendantreport requires the modem to be listening for traffic from the WPAN gateway, this requires cmd mode 10 to be configured.

The modem must be configured using the commands wpanadddev and wpanacktype and wpanpanid for pendantreport to function properly.

Example: use report 1 for pendant triggered reports

cmd pendantreport 1
OK

A cmd save is required for this command to take effect.

Pendant report is triggered by any message received from the pendant. The following message is appended to the report:

$PPEN,ID,SEQ,MES*CHKSUM
ID - 64 bit unique hex ID of Pendant
SEQ - Packet sequence number
MES - Pendant message payload
CHKSUM - NMEA message checksum

Example:
$PPEN,0013A200402CB498,17,PANIC*07

See also: mode, repaddmes, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype

ping (pings a specific IP address)
ping n [iii.iii.iii.iii or <website name>]

Configures the modem to ping a specific IP address or website periodically.
This feature is similar to ppp keep alive.

n = 0 disables ping

n = 1 to 65535 number of seconds between pings

iii.iii.iii.iii IP address of the site to ping, IP Address must be in the range 0 to 255 for each value of iii, If values outside this range are entered, it will be interpreted as a URL

<website name> website to ping

The current ping setting can be queried by using the ping command without parameters.

Examples:

1. ping www.google.ca every 10 seconds

cmd ping 10 www.google.ca
OK

2. ping 66.102.7.147 every 15 seconds

cmd ping 15 66.102.7.147
OK

3. Disable ping

cmd ping 0 0.0.0.0
OK

4. Queries the modem’s ping setting

cmd ping
cmd ping 15 66.102.7.147
OK

See also: netwd

pobda-pobdd (OBDII reports)

pobdx n1 [n2] [n3] [n4]

Configures the engine - vehicle diagnostic report messages.

Maximum of 4 report messages.

Maximum of 4 parameters can be configured for each report message.

x = a, b, c, d

n1 (n2, n3, n4 are optional parameters) = engine parameters as per OBD2/J1939 Parameters table

Examples:

cmd pobda p1 reports vehicle speed

cmd pobdb p2 p12 p25 reports engine speed, intake air temperature and total engine hours

cmd pobdc pa pb reports calculated peak acceleration and calculated peak deacceleration

cmd pobdd p20 reports distance travelled since diagnostic trouble codes cleared

A cmd save is required for this command to take effect.

port (serial port settings)
port n d p s f

Configures the modem’s serial port baud rate and data format.
After implementing this command it will be necessary to change the baud rate of the host application to match the new configuration.

n = 1200 1200 Baud
n = 2400 2400 Baud
n = 4800 4800 Baud
n = 9600 9600 Baud
n = 19200 19200 Baud
n = 38400 38400 Baud
n = 57600 57600 Baud
n = 115200 115200 Baud (default)

d = 5,6,7 or 8 number of data bits (d=8, default)

p = n or N no parity (default)
p = e or E even parity
p = o or O odd parity

s = 1 or 2 number of stop bits (s=1, default)

f = 0 no flow control (default)
f = 1 software flow control
f = 2 hardware flow control

The current port setting can be queried by entering the port command without parameters.

Examples:
cmd port 115200 8 n 1 2 baud rate=115200bps, 8 data bits, no parity, 1 stop bit and hardware flow control

cmd port returns the current port value

Note: For MODBUS Serial Master Gateway there are 2 options only for the data bit configuration:

  • 7 and 8 for ASCII Mode.
  • 8 for RTU-over-UDP Mode.

A cmd save and a powercycle are required for this command to take effect.

ppp (Local Point to Point Protocol connection)
ppp

Provide the connected device a PPP connection through the serial port.
After the modem is powered up, enter the cmd ppp command and disconnect from the terminal program.
Use a Windows Dial Up Network (DUN) connection to connect to the modem.
To escape from this mode and return to the command line, type EXIT in the terminal program.
Use cmd mode 3 to put the modem into permanent PPP mode.

Example:
1. Start the modem into PPP mode

cmd ppp
OK
pswd (sets password used for wireless network access via simple IP)
pswd n

Sets the password used for wireless network access via simple IP. This is often set to the electronic serial number (ESN) of the modem.

n a maximum of 40-character alpha-numeric username

A save operation is required.

Examples:
cmd pswd 12345678900 sets the password to 12345678900
cmd pswd displays the current password used for wireless network access via simple IP

A cmd save is required for this command to take effect.

See also: mip, user

pupcond (power up report trigger conditions)
pupcond n a

Sets the condition(s) that would trigger a power up report.

The conditional parameter is used to indicate how all following parameters will be used to determine if a report is triggered.

n = 1 to 8 power up condition numbers
a = 0 power up trigger disabled
a = 1 power up trigger enabled

The current power up reporting condition(s) can be queried by entering the pupcond n where n is the condition number.
If n is blank, all power up condition triggers will be queried.

Examples:

cmd pupcond 1 1 enables powerup condition 1
cmd pupcond 2 0 disables powerup condition 2
cmd pupcond queries the conditions to trigger all power up reports

A cmd save is required for this command to take effect.

See also: pupreport

pupreport (set power up report)
pupreport [n] [r]

This command sets the report to be used for power-up triggered reports.
Up to 8 ignition trigger reports can be configured.

n = 1 to 8 power-up trigger condition
r = 1 to 999 report number
r = 0 disables the report

Example:

1. Configure report #2 for power-up trigger condition #1.

cmd pupreport 1 2
OK

A cmd save is required for this command to take effect.

See also: pupcond, repaddmes, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype

pwrmode (power mode)
pwrmode n

Controls the modem’s power mode.

n = 1 puts the modem in shutdown mode - it can be woken up either by a power cycle, an input alarm event if configured, or a configured periodic wakeup, see pwrwoe.

n = 2 will power cycle the modem immediately

This command is immediate and does not require a save operation.

Example:
cmd pwrmode 2 this command will power cycle the modem

pwrsdown (power shutdown)
pwrsdwn a ddddd

Places the modem into shutdown mode(blinking power LED) based on the state of the modem's standby signal(ignition).
The ignition state is controlled by the "white" wire of the 3 wire power connection to the modem.
To disable any ignition sense capability connect the "white" wire to the + Voltage "Red" wire.
Default is pwrsdwn 1 10 (modem will switch off based on the standby (ignition) signal state changing with a 10 second delay before entering shutdown mode).

a = 0 disables the standby signal (ignition) event qualifier
a = 1 enables the standby signal (ignition) event qualifier (default)
ddddd = 10 to 65535 the delay time in seconds after the standby signal event changing state that the modem will go into power shutdown mode.

The current configuration can be queried by using the pwrsdwn without parameters.

Examples:

cmd pwrsdwn 1 3600 this will cause the modem to power down when the standby signal (ignition) has been inactive for 1 hour. The modem will power back up when the standby signal becomes active with no delay.

cmd pwrsdwn returns the current settings of enable/disable and delay time

A cmd save is required for this command to take effect.

pwrvcct (supply voltage threshold)
pwrvcct vv.v t

Controls the supply voltage below which the modem will automatically go into shutdown mode (blinking power LED). This command is useful for battery powered applications where the modem can be put into a very low power consumption mode (shutdown mode) to prevent draining the battery.

vv.v = 9.0 to 25.5 The threshold supply voltage at which the modem will go into shutdown (default = 9.0V, typical for 12V battery operation)
t = 10 to 255 the time in seconds after which the modem will go into shutdown once the supply voltage has gone below the threshold voltage. (default = 10)
Note that this timeout applies for powering the modem back up as well.

The current setting can be queried by entering the pwrvcct command without parameters.

Examples:

1. Set the threshold to 20.0 volts with 10 seconds delay – this may be appropriate for a 24 volt battery

cmd pwrvcct 20.0 10
OK

2. Query the current voltage and time settings

cmd pwrvcct cmd pwrvcct 9.0 10
OK

A cmd save is required for this command to take effect.

pwrwoe (power wake on event)
pwrwoe m t1 t2 i

Configures what event will wake the modem up (input alarm event or timer expire) and how long the modem will stay awake after the event.
This is used to have the modem in minimum power mode(< 2 mA) until it is required to communicate over the wireless network.

If it is required to have the modem start its shutdown mode immediately (without waiting for timer t1 to expire) than use the pwrmode command to put the modem into shutdown with immediate effect.

If the standby signal in the pwrsdwn command is enabled or on then this will cause the modem to be on whenever the standby signal is on. The modem will only use the pwrwoe parameters when the standby signal is off (and after the delay timer has expired). If the standby signal is disabled then the pwrwoe parameters will be in effect all the time.

This command can also be used to configure scheduled power cycles without having to put the modem into shutdown.
m = 0 disables the power wake on event operation
m = 1 shutdown
m = 2 shutdown with periodic wakeup when ignition is off

t1 = 0 disables the ON timer (stay on forever – pwrsdwn can be enabled to shutdown the modem)
t1 = 1 to 65535 the ON time in minutes – the modem will remain on for this time once it has woken up due to an input alarm event, or periodic wakeup (set by parameter t2)

t2 = 0 disables the OFF timer (stay in shutdown mode forever or until an input alarm event occurs –or standby signal if enabled in pwrsdwn).
t2 = 1 to 255 the OFF time in minutes - the time that the modem will stay in shutdown if an input alarm event (or standby signal if enabled in pwrsdwn) does not occur
t2 = c power cycle the modem immediately once the ON timer expires (only use with m = 1 and i = 0)

i = 0 disables the input event trigger
i = 1 to 6 selects which input going into alarm will trigger wake up

Default configuration is 0 0 10 0 (wake on event disabled). The current configuration can be queried by using the pwrwoe without parameters.

Examples:

1. Configure the modem to go into shutdown mode in 5 minutes. An alarm event on input #2 – and only this - will cause it to wake up for 5 minutes then go back into shutdown
cmd pwrwoe 1 5 0 2
OK

2. Configure the modem to go into shutdown mode in 5 minutes. Every 55 minutes it will wake up and remain on for 5 minutes then go back into shutdown.
cmd pwrwoe 1 5 55 0
OK

3. Configure the modem to power cycle after 60 minutes.
cmd pwrwoe 1 60 c 0
OK

4. QUery the current configured parameters for wake on event
cmd pwrwoe
cmd pwrwoe 0 0 10 0
OK

A cmd save is required for this command to take effect.

Back to top
Q
  • No commands
Back to top
R
ratesel (Rate select for selected data devices/modules only)
ratesel n

Sets the required network rate mode (CDMA vs. EV-DO) of the device. This command is not valid for GSM/GPRS/HSPA devices.

Note:

  • Prior to using the cmd ratesel command, use cmd mode to verify that the modem is in manual connection mode=1. Otherwise, use cmd mode 1 to put the modem in manual connection mode. The ratesel command talks directly to the embedded card/module and does not require cmd save for the setting to be saved.
  • Entering cmd ratesel without parameters before setting the command to 0 or 1 will return an “ERROR”, this is normal operation.
  • ratesel is valid for Sierra Wireless CDMA/EV-DO data devices and modules only
  • The Sierra Wireless AC580 (EV-DO revision 0, Cardbus device) only supports ratesel n = 2

n = 0 1xRTT only

n = 1 EV-DO only

n = 2 Auto Rate Select (hybrid mode) - default

The network rate mode can be queried by entering ratesel without parameters.

Examples:
1. Set the network rate mode to 1xRTT only

cmd ratesel 0
OK

2. Query the current network rate mode of the device

cmd ratesel
cmd ratesel 0
OK
ratetmr (Rate Timer, Sierra Wireless CDMA/EVDO only)
ratetmr n

Sets the required network rate test timer of the device. This is used to configure the modem to test for an available EV-DO network while it is in a 1xRTT connection.
This command is valid for Sierra Wireless CDMA/EV-DO data devices and modules only.

n = 0 disable the timer (default)

n = 1 to 65535 time in seconds. Note that time in second is an approximate value; the time between periods will be greater than the “n” value set

The current timer setting can be queried by entering the ratetmr without parameters.

Examples:

1. During a 1xRTT connection the modem will disconnect approx. every 120 seconds and then reconnect on the EV-DO network if available, otherwise it will reconnect on the 1xRTT network

cmd ratetmr 120
OK

2. Query the current network rate test timer setting

cmd ratetmr
cmd ratetmr 120
OK

A cmd save is required for this command to take effect.

repaddmes (add messages to a report configuration, display report configuration messages)
repaddmes n x [x2][x3][x4]

Adds a message type to a report. 4 messages can be included in a single report. Duplicate messages cannot be included in a report.
Messages will be sent in a report in the same order that they are added.
ULCP header messages will be sent as individual UDP packets – NMEA format messages will be combined into a single UDP packet.

n = 1 to 999 report number
x message type to be added, valid message types must be used - see Report Messages

The messages associated with a single report can be displayed by using the repaddmes n command. If n is omitted, the messages associated with all configured reports will be displayed.

Examples:

1. Add message type #16 – GPS NMEA GLL – to report #4

cmd repaddmes 4 16
OK

2. Query messages associated with report #4

cmd repaddmes 4
cmd repaddmes 4 80 82 3 30
OK

3. Query messages associated with all configured reports

cmd repaddmes
cmd repaddmes 1 80 82
cmd repaddmes 4 80 82 3 30
OK

A cmd save is required for this command to take effect.

See also: message formats, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype

repdelmes (delete messages from a report configuration)
repdelmes n x

This command is used to delete a message type (or all messages) from a report.

n = 1 to 999 report number
x message type to be deleted (0 to delete all messages)

Examples:

1. Delete message type #16 from report #1

cmd repdelmes 1 16
OK

2. Delete all messages from report #4

cmd repdelmes 4 0
OK

A cmd save is required for this command to take effect.

See also: repaddmes repemail replocport repremip repremport repsms reptype

repemail (configure report email address)
repemail n <email address>

Sets the email address that the report will be sent to (if configured for email using reptype).
The default email address is blank.

Note that an email server is required – see emailsrv.

n = 1 to 999 report number
<email address> = name@domain email address to which the report will be sent

The current email address configured for all reports can be queried by using the repemail command without parameters.

Examples:

1. Set the send to email address for report #1

cmd repemail 1 me@home.com
OK

2. Query the email address for report #1

cmd repemail 1
cmd repemail 1 me@home.com
OK

3. Query the email address for all reports

cmd repemail
cmd repemail 2 me@home.com
OK

A cmd save is required for this command to take effect.

See also: repaddmes repdelmes replocport repremip repremport repsms reptype

replocport (configure report local port)
replocport n xxxxx

Sets the port number of the local server that the report will be sent to.
Up to 999 reports may be configured.

n = 1 to 999 report number
xxxxx = 0 to 65535 local port number in decimal

The current local port configuration for a report can be queried by entering replocport n, where n is the port number.
If n is omitted, all reports will be queried.

Examples:

1. Report #1 will be sent to local port 5005

cmd replocport 1 5005
OK

2. Query the local port setting of all reports

cmd replocport
cmd replocport 1 7000
OK

A cmd save is required for this command to take effect.

See also: repaddmes repdelmes repemail repremip repremport repsms reptype

repremip (configure report remote IP address)
repremip n iii.iii.iii.iii

Sets the IP address of the remote server that the report will be sent to. Up to 999 reports may be configured.

n = 1 to 999 report number
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 remote IP address in decimal

The current IP address for a report can be queried by using the repremip n where n is the report number.
If n is omitted, all reports will be queried.

Examples:

1. Report #1 will be sent to remote IP address 123.10.1.101

cmd repremip 1 123.10.1.101
OK

2. Query the remote IP address setting of all reports

cmd repremip
cmd repremip 1 123.10.1.101
cmd repremip 2 199.99.99.99
OK

A cmd save is required for this command to take effect.

See Also: repaddmes repdelmes repemail replocport repremport repsms reptype

repremport (configure report remote port)
repremport n xxxxx

Sets the IP port number of the remote server that the report will be sent to.

n = 1 to 999 report number

xxxxx = 0 to 65535 remote port number

The current IP port configuration for a report can be queried by using remport n where n is the report number.
If n is omitted, all reports will be queried.

Examples:

1. Report #1 will be sent to port 5005 on remote IP address set by repremip

cmd remport 1 5005
OK

2. Query the remote port setting of all reports

cmd remport
cmd remport 1 5001
cmd remport 2 5005
OK

A cmd save is required for this command to take effect.

See also: repaddmes, repdelmes, repemail, replocport, repremip, repsms, reptype

repsms (configure report SMS address)
repsms n pppppppppp or <email address>

Sets the destination of the report that is sent as an SMS message. Up to 999 reports may be configured. The default SMS destination is blank.

Note: SMS features are only available for specific manufacturer, RF modules, cards or devices. Please contact Cypress Solutions for a complete list of products that support SMS functionality.

n = 1 to 999 report number

pppppppppp phone number which the SMS report will be sent to. For long distance calls, a “1” needs to be added In front of the phone number.

<email address> email address which the SMS report will be sent to.

The current SMS destination configured for all reports can be queried by using the repsms command without parameters.

Examples:

1. Send report #1 as an SMS message to the specified phone number

cmd repsms 1 1234567890
OK

2. Send report #2 as an SMS message to the specified email address

cmd repsms 2 me@home.com
OK

3. Query the SMS destination for report #1

cmd repsms 1
cmd repsms 1 1234567890
OK

4. Query the SMS phone numbers or email addresses for all reports

cmd repsms
cmd repsms 1 1234567890
cmd repsms 2 me@home.com
OK

A cmd save is required for this command to take effect.

See also: repaddmes, repdelmes, repemail, replocport, repremip, repremport, reptype

reptype (configure local and remote report types, store-and-forward)
reptype n l r s

Sets the reporting type for local and remote servers.

Note: SMS features are only available for specific manufacturer, RF modules, cards or devices. Please contact Cypress Solutions for a complete list of products that support SMS functionality.

n = 1 to 999 report number

l = 0 disables local report (default)
l = 1 asynchronous NMEA or ULCP messages over RS232
l = 2 asynchronous NMEA or ULCP messages with a ULCP header over RS232
l = 3 in-band NMEA or ULCP messages in a UDP Packet over Ethernet
l = 4 in-band NMEA or ULCP messages with a ULCP header and in individual UDP packets over Ethernet
l = 5 in-band NMEA or ULCP messages in a TCP Packet over Ethernet

r = 0 disables remote report (default)
r = 3 in-band NMEA or ULCP messages in a UDP Packet
r = 4 in-band NMEA or ULCP messages with a ULCP header and in individual UDP packets
r = 5 in-band NMEA or ULCP messages in a TCP Packet
r = 6 email reports
r = 7 SMS reports

s = 0 disables the store and forward of report
s = 1 enables the store and forward of report

Note: For r = 7 (SMS reports), the total length of the report must not exceed 166 characters including <CR> and <LF>

The current report type configuration for a report can be queried by using reptype n where n is the report number.
If n is omitted, all reports will be queried.

Examples:

1. Send report #4 as a UDP packet over Ethernet and over the wireless link, and will not store reports

cmd reptype 4 3 3
OK

2. Send report #2 as a UDP packet over Ethernet and as an SMS message to the SMS destination set using the repsms command, and will enable the store and forward of reports

cmd reptype 2 3 7 1
OK

3. Query the reporting methods for all reports

cmd reptype
cmd reptype 1 3 0 0
cmd reptype 2 3 0 0
cmd reptype 10 0 6 0
OK

A cmd save is required for this command to take effect.

See also: repaddmes, repdelmes, repemail, replocport, repremip, repremport, repsms

restore (restores last saved configuration)
restore

Restores the configuration to the previously saved version (overwrite any commands not yet saved).
This command has the same effect as a power cycle with regard to the configuration.

Example:
cmd restore

rmtd (reverse telnet connection)
rmtd iii.iii.iii.iii xxxx

Configures the modem to perform a reverse telnet connection to an IP address and port.
The modem tries to connect periodically until a connection is established.
By default this is disabled with IP 0.0.0.0 and port 0.

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 remote IP address. 0.0.0.0 = disabled (default)

xxxxx = 0 to 65535 remote port number. 0 = disabled (default)

The current state of remote reverse telnet setting can be queried by using the rmtd command without parameters

Examples:

cmd rmtd 204.123.1.10 5000 sets the IP to 204.123.1.10 and the port to 5000

cmd rmtd queries the modem’s rtmd setting

A cmd save is required for this command to take effect.

rmttelnet (remote telnet)
rmttelnet

This command configures the modem to respond to incoming telnet commands over the wireless network.
The modem must be connected to a wireless network.

n=0 remote telnet = disabled (default)

n=1 remote telnet = enabled

The current state of remote telnet setting can be queried by using the rmttelnet command without pararmeters.

Examples:

cmd rmttelnet 1 sets the modem to respond to incoming telnet commands

cmd rmttelnet queries the modem’s setting for remote telnet access

A cmd save is required for this command to take effect.

rmtweb (Remote web access)
rmtweb n

Enables or disables remote access to the embedded web server feature of the modem.
If enabled, it will be possible to access the modems embedded web pages by using the current IP address allocated to the modem by the network.

n = 0 remote access = disabled (default)

n = 1 remote access = enabled

The current status of remote web server access can be queried by using the rmtweb command without parameters.

Examples:

cmd rmtweb 1 enables remote access to the modem’s web pages

cmd rmtweb queries the current status of remote web

A cmd save is required for this command to take effect.

rssi (RF signal strength)
rssi

This command queries to the current wireless network signal strength seen by the modem for both the 1x and EV-DO networks.
The values are given in dBm in the range, for example: -105dBm (poor), to -60dBm (excellent).

Note: This command is not supported by all wireless network cards and modules.

This is a read only command.

Example:

1. Query the current network signal strengths seen by the modem

cmd rssi
EVDO: -98dBm
1xRTT: -99dBm
OK
Back to top
S
saltreport (set salt-spreader report)
saltreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

This command sets the report(s) to be used for the chlorobyte salt-spreader interface triggered reports.
Up to 8 reports can be assigned to the saltreport configuration:

r = 0 disables the report
r = 1 to 999 report number

When saltreport is configured to use a report, it appends to the already existing messages configured in the report a modified 114 message.

The appended message contains the specific salt spreader parameters received on the serial port instead of the modem ID in the default 114 message. The mode must be configured correctly to allow the spreader controller to communicate with the modem.

Example:

cmd saltreport 2
cmd repaddmes 2 114
cmd save

uses report 2 for salt-spreader interface triggered reports, adds a standard message 114 as a message, saves the configuration.

Report output:

$PGPS,000000.00,V,0000.0000,N,00000.0000,E,000.0,000.0,000000,+00000,0,
09604890958*42

$PGPS,000000.00,V,0000.0000,N,00000.0000,E,000.0,000.0,000000,+00000,0,
131213141516171819202122232425262728293031*7E

In the above example the first line is the default 114 message, the second line shows the 114 message but with the salt spreader information instead of the modem ID. Note, the message type 114 does not have to be explicitly added as a message, this is handled automatically by the saltreport command.

A cmd save is required for this command to take effect.

See also: mode, reptype, repremport, repremip, replocport, repemail, repsms, repaddmes

satbackup (switch to backup satellite modem)
satbackup b bt g gt o

Sets the option to switch to a backup satellite modem if the cellular network’s coverage is poor.
The satellite modem power must be driven by a modem output for this feature to work.
The user defines the RSSI(receive signal strength) threshold to initiate the switchover, the timeouts and the output number to use.
When the RSSI value falls below the bad RSSI threshold for a certain timeout period, an output will be set.
When the RSSI value rises above or equal to the good RSSI threshold for a certain timeout period, an output will be cleared.

NOTE: This command is only available on data cards/modules that provide RSSI information to the modem. Contact Cypress Solutions for a complete line of supported data devices

b = 0 Disable (default)[[br] b = -1 to -125 Bad RSSI threshold in dBm; requires the negative sign

bt = 0 to 65535 Bad RSSI timeout in seconds; if the RSSI is less than the bad threshold for the timeout period, than set the output. Default is 0

g = 0 Disable (default)
g = -1 to -125 Good RSSI threshold in dBm; requires the negative sign

gt = 0 to 65535 Good RSSI timeout in seconds; if the RSSI is greater than or equal to the good threshold for the timeout period than clear the output. Default is 0

o = 1 to 4 Output number. Default is 1

A cmd save and power cycle are required before this setting takes effect.
The current satellite backup setting can be queried by entering satbackup without parameters.
To clear setting, use cmd satbackup 0 0 0 0 0

Examples:

cmd satbackup -100 30 -95 30 2 Set the bad RSSI threshold to -100dBm with a timeout of 30 seconds; set the good RSSI threshold to -95dBm with a timeout of 30 second; trigger output 2.

cmd satbackup Queries the current satbackup configuration

A cmd save is required for this command to take effect.

save (saves configuration)
cmd save

Save modem configuration to non-volatile memory.

Note: A single cmd save can be entered after a series of commands are configured, the entire session will be saved.

If settings are not saved, they will remain in effect until the next powercycle

Example:

1. Save current configuration

cmd save
OK
showconfig (displays current configuration settings)
showconfig

Returns the current configurations of the modem.
This is a read only command.

showconfig returns the configuration of the commands as they were entered, including the cmd statement.

The output of showconfig is written to a script file /tmp/config.sh and to the console, both of which can be used to configure the modem.

The below commands are not supported in showconfig. To query the status of the below commands use showstate. To configure these commands the showconfig script file or input text must be manually updated.

cmd odometer
cmd smstext
cmd enghours

The below commands are not supported in either showconfig or showstate commands. To configure these commnands the showconfig script file or input text must be manually updated.

cmd factory
cmd telnetpswd

Commands can be manually entered as shown in the output of showconfig using the syntax shown. The showconfig output can be 'Copy & Pasted', if there is a long list list of commands, it is recommended to use a telnet session rather than the serial console to capture the output of showconfig.

Example:

cmd showconfig returns the current modem configurations

showstate (displays modem state)
showstate

Returns the current state of the modem.
This is a read only command.

showstate returns the modem state:

  • firmware revision
  • modem ESN
  • modem ID
  • modem IP address
  • odometer
  • engine hours
  • RF Switch output mode, 0 = RF device connected or connecting, 1 = RF device off, awaiting switch input.
  • SMS text
  • amount of data transmitted and received over the wireless data link

Example:

# cmd showstate
Firmware Version:CTM15x R1.2.2 (rev. 1483)
ESN:09604890958
Modem ID:09604890958
Modem IP Address:68.182.130.226
Odometer:0 KM
Engine Hours:0.00 h
Output mode (RF Switch):0
SMS Text:
Wireless link data count:
TX: 0 MB
RX: 0 MB
Total: 0 MB
OK
singlepc (single pc mode)
singlepc n

Sets the modem’s DHCP allocation of IP addresses.
If enabled, the modem’s DCHP server will only allocate one IP address.
This single IP address assigned by the modem will be 192.168.1.20.

n = 0 Disable (default)
n = 1 Enable

The current DCHP allocation setting can be queried by entering singlepc without parameters.

Examples:

1.Enable single PC mode

cmd singlepc 1
OK

2. Query the current singlepc configuration

cmd singlepc
cmd singlepc 0
OK

A cmd save is required for this command to take effect.

smssend (send SMS message)
smssend

Used to SEND the previously setup SMS message (smsto and smstext).

Note: SMS features are only available for specific manufacturer, RF modules, cards or devices. Please contact Cypress Solutions for a complete list of products that support SMS functionality.

The modem needs to be connected to the network.

Example:

cmd smssend send the SMS message

smstext (SMS text message)
smstext <string> <delimiter>

Used to enter the text message of the SMS.

Note: SMS features are only available for specific manufacturer, RF modules, cards or devices. Please contact Cypress Solutions for a complete list of products that support SMS functionality.

The delimiter is used to indicate an end of text message.
Text message is not saved in non-volatile memory a <CR> denotes a carriage return.

<string> text message(max 166 chars)

<delimiter> sequence of a blank line followed by a carriage return and then the sequence “.”

Example:

cmd smstext <CR>
Hi <CR>
This is test <CR>
message<CR>
from Bob<CR>

.<CR>

Note:cmd smstext cannot be used from a serial console.

smsto (send SMS to)
smsto pppppppppp

This command is used to set the phone number of the SMS text message to be sent.

Note: SMS features are only available for specific manufacturer, RF modules, cards or devices. Please contact Cypress Solutions for a complete list of products that support SMS functionality.

The phone number is not saved in non-volatile memory.

pppppppppp phone number which the text message will be sent to. For long distance calls, a “1” needs to be added in front of the phone number.

The current settings can be queried by using the smsto command without parameters.

Examples:
cmd smsto 1235551212 sets the phone number to send the SMS
cmd smsto returns the phone number this command is set to

smsview (SMS message view)
smsview

Querys the message entered via smstext command.

Note: SMS features are only available for specific manufacturer, RF modules, cards or devices. Please contact Cypress Solutions for a complete list of products that support SMS functionality.

This is a read only command.

Example:

cmd smsview returns the text message to be sent

snfdelay (Store and Forward delay period before SNF starts)
snfdelay [n]

This command sets the store-and-forward delay time. The delay time is the number of seconds the modem must have a good quality RF connection before stored messages are forwarded. Valid range is 1 to 65535 seconds. The default is 20 seconds.

Note that message forwarding may not occur exactly at the snfdelay interval specified, and stored messages will only start forwarding when network conditions are deemed acceptable. Example:

1. Set the delay time before forwarding SNF data to 60 seconds

cmd snfdelay 60

A cmd save is required for this command to take effect.

snfflush (Store and Forward Flush)
snfflush

Flushes and resets store and forward NVRAM.

snflog (Store and Forward log)
snflog n

Used to display the contents of the store and forward log locally thru a serial console, and the status of the log entries. The log can contain up to 3000 records.

This is a read only command.

n = 1 to 3000 number of store reports to be displayed

The number of stored reports and their status can be queried by entering snflog without parameters.

T:t where t is the total number of stored reports

F:f where f is the number of reports forwarded

N:n where n is the number of reports not yet forwarded

Examples:

cmd snflog 100 displays the first 100 SnF log entries

cmd snflog displays the SnF log status

Note: snflog may erroneously report number of forwarded messages as 1 in cases where number of forwarded messages is actually 0. When network coverage resumes, all packets will be forwarded.

spc (service provisioning code)
spc nnnnnn

This command is used to enter the modem’s CSL (Client Subsidy Lock) as part of the network activation commands prior to loading the modem’s 10-digit phone number using the dir command.
The 6-digit lock code is used by the modem’s embedded module to compare against the pre-loaded 6-digit CSL. This number will be provided by the service provider at the time of service activation.

nnnnnn 6-digit lock code

Example:
cmd spc 123456 set the modem’s SPC to 123456

A cmd save is required for this command to take effect.

speedth (speed threshold for enabling RF module of the modem)
speedth ss t

Sets the speed threshold for automatically enabling the RF module of the modem when it has been previously disabled.
Turns off output #4 when it has been previously turned on.
The RF module of the modem is disabled by using an external switch box(supplied by Cypress Solutions) connected to the modem when the modem is used in areas sensitive to RF interference.

The defaults are 30 km/h for ss and 3 seconds for t.
If ss and t are omitted, the current speed threshold will be queried.

ss speed threshold(kph)
t time (seconds)

Example:

cmd speedth 50 5 set the RF module of the modem to automatically turn on when the speed reaches 50 km/h for at least 5 seconds

cmd speedth queries the current speed threshold conditions

A cmd save is required for this command to take effect.

swipereport (set swipe-card report)
swipereport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

This command sets the report(s) to be used for swipe card reader triggered reports.
Up to 8 reports can be assigned to the swipereport configuation:
r = 0 disables the report
r = 1 to 999 report number

When swipereport is configured to use a report, it appends to the already existing messages configured in the report a modified 114 message.
The appended message contains the ID of the swipe card detected by the swipe card reader. The mode must be configured correctly to allow the swipe card reader to communicate with the modem.

Example:

cmd reptype 2 0 3
cmd repremip 2 123.123.123.123
cmd repremport 2 5555
cmd repaddmes 2 114
cmd swipereport 2
cmd save

uses report 2 for swipe card reader triggered reports, adds a standard message 114 as a message, saves the configuration.

Report output:

$PGPS,171134.00,A,4915.3868,N,12259.8049,W,000.0,000.0,170609,+00004,
5,09604890958*4A

$PGPS,171134.00,A,4915.3868,N,12259.8049,W,000.0,000.0,170609,+00004,
5,09604890958,039-30391,V*33

In the above example the first line is the default 114 message, the second line shows the appended swipe card ID information added to the message. Note, the message type 114 does not have to be explicitly added as a message, this is handled automatically by the swipereport command.

A cmd save is required for this command to take effect.

See also: mode, reptype, repremport, repremip, replocport, repemail, repsms, repaddmes

syslog (system log)
syslog n

Provides a mechanism to retrieve the log of system events recorded by the modem.
Log events include network connects and disconnects.
Note that the system log is stored in volatile memory so it will be lost when power is cycled on the modem.

n = 0 to 65535 number of system log records to return. Leaving n blank will return the entire contents of the system log up to a maximum of 65535.

Examples:

cmd syslog 10 returns the last 10 events stored in the system log
cmd syslog returns all events stored in the system log

Back to top
T
telnetport (telnet port)
telnetport n

Sets the port for telnet access (both local and remote).
A cmd save and power cycle is required for this command to take effect.

n = 1 to 65535 port to be used for telnet (default: port 23)

The current telnet port setting can be queried by entering telnetport without parameters.

R1.2.1 and below: When the telnet port is changed using telnetport from within a local/remote Telnet session, this session will be disconnected. To complete telnet port configuration, you will need to reconnect to the telnet server at the new telnet port, issue a cmd save and power cycle.

R1.2.1 OpenCTM only: To complete telnet port configuration, power cycle the modem.

Example:

1. Set telnet port to 33

cmd telnetport 33
OK

A cmd save is required for this command to take effect.
See also: telnetpswd, telnettimeout

telnetpswd (password for telnet access)
telnetpswd n

Sets password for telnet access (both local and remote) and ssh access (both local and remote). ssh access is available in R1.2.1 OpenCTM only.

n a maximum of 40-character alpha-numeric password

Example:

1. Set telnet password to ‘cypress’

cmd telnetpswd cypress
OK

R1.2.1 and below: A cmd save is required for this command to take effect.
R1.2.1 OpenCTM only: This command takes effect immediately.

See also: telnetport, telnettimeout

telnettimeout (telnet timeout)
telnettimeout n

Sets the timeout period for a telnet session with no activity. The telnet timeout will take effect on the next telnet login.

n = 0 to 65535 timeout time, in seconds (default: 60 seconds)

The current telnet timeout setting can be queried by entering telnettimeout without parameters.

Example:

1. Disable telnet timeout
cmd telnettimeout 0
OK

A cmd save is required for this command to take effect.
See also: telnetpswd, telnetport

Back to top
U
univwd (configure universal watchdog)
univwd <mode> <url>/<report>

Configure the Universal Watchdog.

mode = 0 disabled
mode = 1 detect increase in received packets.
mode = 2 ping specified url
mode = 3 send specified report

Examples:

1. Configure a report to send PMID message #3, to remote server on UDP port 7002.
Set universal watchdog into mode 3, which will use report 1 to generate ping activity.
cmd repremip 1 209.121.68.211
cmd repremport 1 7002
cmd reptype 1 0 3
cmd repaddmes 3
cmd univwd 3 1
cmd save

A cmd save is required for this command to take effect.
See also: message formats, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype

univwdtimer (set universal watchdog timer interval)
univwdtimer [n] [p]

Sets the timer value (in seconds) for the universal watchdog timer.

n = 1 to 65535 seconds watchdog timer interval
p = 1 to 60 seconds watchdog ping interval, valid for univwd modes = 2 and 3

A cmd save is required for this command to take effect.

upgradesrv (set authorized IP for remote admin)
upgradesrv a.a.a.a

This command is used to set the IP address of a remote client that is authorized to run remote administration commands.

The RemoteAdminServer commands: Showconfig, Confupgrade and Pwrcycle are restricted to an authorized IP.

a.a.a.a = 0.0.0.0 to 255.255.255.255 IP address of the authorized IP client. Default = 0.0.0.0
0.0.0.0 disables all remote clients 255.255.255.255 enables all remote clients
The current upgrade server IP address can be queried by using the upgradesrv without parameters.

Examples:

1. Set the upgrade server IP address to 209.121.68.211
cmd upgradesrv 209.121.68.211 OK

2. Query current email server
cmd upgradesrv cmd upgradesrv 209.121.68.211 OK
user (sets username used for wireless network access via simple IP)
user n

Sets the username used for wireless network access via simple IP. This is often in the format of [phone number]@[carrier].com.

n a maximum of 40-character alpha-numeric username

A save operation is required.

Examples:
cmd user 6045551234@… sets the username to 6045551234@…
cmd user displays the current username used for wireless network access via simple IP

A cmd save is required for this command to take effect.
See also: mip, pswd

Back to top
V
vcc (supply voltage)
vcc

Returns the current value of the modem’s supply voltage. This is a read only command.

Example:

1. Query the supply voltage in xx.xx ASCII format
cmd vcc
11.99V
OK
vcccond (supply voltage level report trigger conditions)
vcccond [n] [o] [a.a] [mt]

This command is used to set the condition(s) that would trigger a supply voltage level report.
The conditional parameter is used to indicate how all following parameters will be used to determine if a report is triggered. Use the Off setting to disable the report.

n = 1 to 8 supply voltage level condition trigger
o=0 trigger disabled (default)
o=1 trigger while supply voltage is below threshold
o=2 trigger while supply voltage is above threshold
o=3 trigger on transition (whenever supply voltage threshold is passed)
(above threshold->below threshold or below threshold->above threshold)
Optional parameters:
a.a = 9.0 to 36.0 threshold voltage, in volts (default = 9.0 V)
mt = 0 to 65535 maximum reporting rate in seconds (minimum time between reports)
(default = 60 s)
The current condition(s) can be queried by using the vcccond n command.
If n is blank, all vcccond triggers will be queried.

Examples:

1.Triggers vcccond 1 every 60 seconds while supply voltage is below the threshold voltage of 9.0 volts
cmd vcccond 1 1
OK

2. Triggers vcccond 2 every 60 seconds while supply voltage is below the threshold voltage of 9.0 volts
cmd vcccond 2 1 9.0
OK

A cmd save is required for this command to take effect.
See also: vccreport

vccreport (set supply voltage level report)
vccreport [n] [r]

This command sets the report to be used for supply voltage level triggered reports.
Up to 8 supply voltage level trigger reports can be configured.

n = 1 to 8 supply voltage level trigger condition
r = 1 to 999 report number
r = 0 disables the report

Example:
cmd vccreport 1 1 uses report #1 for supply voltage level trigger condition #1.

A cmd save is required for this command to take effect.
See also: vcccond, repaddmes, repdelmes, repemail, replocport, repremport, repremip repsms, reptype

ver (firmware version)
ver

Queries the currently installed firmware version of the modem.

Example:

1. Query the current firmware version
cmd ver
CTM15x R1.2.0 (rev. 1140)
OK
Back to top
W
webpswd (password for web access)
webpswd n

Sets the password for web access (both local and remote).

A cmd save and power cycle is required for this command to take effect.

n a maximum of 40-character alpha-numeric password

Example:

1. Set web password to ‘cypress’
cmd webpswd cypress
OK
wifiwd (configures Wifi Watchdog)
wifiwd n [t]

Enable/disable wifi watchdog.
n 0 = disabled; 1 = enabled t watchdog threshold time in seconds, time must be in range 31 to 65535 (optional:default is 120 seconds).

Example:

1. Enable wifi watchdog with a 5 minute threshold
cmd wifiwd 1 300
OK
wpanacktype (Man Down Pendant acknowledgement type)
wpanacktype n

Assigns an acknowledgment type for the Work Alone system.
There are two acknowledgment types:
  • modem
  • server
Note: CTM-15X modem firmware 1.2.0 only supports modem mode acknowledgment type.

If a user initiates a ‘Man Down Emergency’ alert, the Pendant will provide the worker with either a positive acknowledgment or a negative acknowledgment.

n = m modem type acknowledgment (default)
n = s server type acknowledgment

Entering wpanacktype with no arguments returns the current command configuration.

A cmd save and a power cycle are required before either mode takes effect.
  • Modem type acknowledgment:
A positive acknowledgment (ACK) means the modem has received the alert. If the Pendant has not received an acknowledgment from the modem the Pendant will continue to send PANIC/MPANIC messages until an Acknowlegeemtn(ACK) is received (Pendant firmware V1.1 and later)
  • Server type acknowledgment:
A positive acknowledgment means that the server has received the alert from the modem and acknowledged back to the modem then to the Pendant. If the Pendant has not received an acknowledgment from the server the Pendant continue sending PANIC/MPANIC messages until it receives an acknowledgement(ACK)(Pendant firmware V1.1 and later)

Note:

The remote server must also be configured to respond to messages from the modem.
The message format sent from the modem is as follows:
$PPEN,0013A200402CB498,13,PANIC*03

The acknowledgment that the modem expects from the server is as follows:
$PPQ,PAN,0013A200402CB498,13,ACK*36

The 16-digit hex number following the PPEN message is the Pendant ID and is unique to each Pendant.

Examples:

1. Configured as modem type acknowledgment
cmd wpanacktype m
OK

2. Configured as server type acknowledgment
cmd wpanacktype s
OK
wpanadddev (WPAN accessory add device id, query device id)
wpanadddev xx-xx-xx-xx-xx-xx-xx-xx

Adds a WPAN device ID to the Chameleon modem’s registered WPAN devices list. Up to 16 WPAN IDs can be entered.

xx-xx-xx-xx-xx-xx-xx-xx WPAN device ID (hex digits), hyphens are optional

Using wpanadddev without a device ID, queries all WPAN devices IDs currently registered in the Chameleon modem.

Note that the ID of FF-FF-FF-FF-FF-FF-FF-FF will allow any Pendant to talk through the modem.

Example:

cmd wpanadddev 00-13-a2-00-40-08-58-5e add WPAN device with this ID to the registered devices list

cmd wpanadddev 0013a2004008585e above example with optional hyphens omitted

cmd wpanadddev queries all devices IDs

A cmd save is required for this command to take effect.
Note that the modem needs to be power cycled for the new settings to take effect.

wpandelall (WPAN accessory delete all device ids)
wpandelall

Deletes all WPAN device IDs from the Chameleon modem’s registered WPAN devices list.

Example:

cmd wpandelall deletes all WPAN devices from the registered devices list
Note that the modem needs to be power cycled for the new settings to take effect.

wpandeldev (WPAN accessory delete device id)
wpandeldev xx-xx-xx-xx-xx-xx-xx-xx

Deletes a WPAN device ID from the Chameleon modem’s registered WPAN devices list. xx-xx-xx-xx-xx-xx-xx-xx WPAN device ID (hex digits), hyphens are optional

Example:

cmd wpandeldev 00-13-a2-00-40-08-58-5e delete WPAN device with this ID from the registered devices list

cmd wpandeldev 0013a2004008585e above example with optional hy[hens omitted

A cmd save is required for this command to take effect.
Note that the modem needs to be power cycled for the new settings to take effect.

wpanpanid (WPAN accessory set PAN id, query PAN id)
wpanpanid xxxx

Set the WPAN PAN ID to communicate with the WPAN devices.

xxxx WPAN PAN ID (hex digits)

Using wpanpanid without a PAN ID, queries the WPAN PAN ID currently configured in the Chameleon modem.

Example:

cmd wpanpanid 2000 change the WPAN PAN ID to 0x2000

cmd wpanpanid queries the current WPAN PAN ID
Note: A cmd save and a power cycle must occur for the new settings to take effect.

Back to top
X
  • No commands
Back to top
Y
  • No commands
Back to top
Z
  • No commands
Back to top
Subscribe to our
free newsletter