CTM-200 Command Reference

accelcond n a d l

Set acceleration trigger condition.

n = 1 to 8 Acceleration report number
a Longitudinal acceleration threshold in km/h/s (Must be positive)
d Longitudinal deceleration threshold in km/h/s (Must be negative)
l Lateral acceleration threshold in km/h/s (Must be positive)
a = 0 No trigger on longitudinal acceleration
a > 0 acceleration threshold in km/h/s
d = 0 No trigger on longitudinal deceleration (braking)
d < 0 deceleration threshold in km/h/s
l = 0 No trigger on lateral acceleration
l > 0 acceleration threshold in km/h/s
mt = 0 minimum timeout disabled
mt = 1 to 65535 minimum time between reports in seconds

Default values for all 8 reports: cmd accelcond n 0 0 0
A report is triggered when one of the following conditions applies:

• acceleration > a
OR
• acceleration < d (Note that d should be negative)
OR
• abs (lateral acceleration) > l

Examples:

1. Trigger on hard acceleration only when longitudinal acceleration exceeds 15 km/h/s.
   cmd accelcond 1 15 0 0
   OK


2. Trigger on hard braking only when longitudinal deceleration exceeds -20 km/h/s.
   cmd accelcond 1 0 -20 0
   OK


3. Trigger on hard acceleration when longitudinal acceleration exceeds 15 km/h/s OR braking when longitudinal deceleration exceeds -20 km/h/s.
   cmd accelcond 1 15 -20 0
   OK


4. Trigger on hard turning only when lateral acceleration exceeds 35 km/h/s.
   cmd accelcond 1 0 0 35
   OK


5. Set a minimum timeout of 30s between reports.
   cmd accelcond 1 0 0 35 30
   OK

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

See also: accelreport, accelsensor, orientation

accelreport n r

This command sets the report to be used for an acceleration triggered report.
n = 1 to 8 acceleration trigger condition
r = 0 disables the report (default)
r = 1 to 999 report number

The CTM-200 must be configured using the commands accelcond, accelsensor, and orientation (when cmd accelsensor 1 is set) for accelreport to function properly.

Example:

1. Set report #2 for acceleration triggered report #1.
   cmd accelreport 1 2

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

See also: accelcond, accelsensor, orientation

accelsensor m

Specify a sensor to use for report triggering on longitudinal acceleration.

m = 0 Use accelerometer (default)
m = 1 Use GPS

The accelerometer sensor is always used for lateral acceleration triggering/reporting.

With m = 0, both acceleration trigger and $PACCEL use the accelerometer sensor. GPS speed sensor is used for $PACCEL2 message.
With m = 1, both acceleration trigger and $PACCEL use the GPS speed sensor. Accelerometer sensor is used for $PACCEL2 message.

Examples:

1. Use GPS to obtain longitudinal acceleration values.
   cmd accelsensor 1
   OK


2. Query the currently configured acceleration sensor
   cmd accelsensor
   cmd accelsensor 0
   OK

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

See also: accelcond, accelreport, orientation

This command is used to configure Assisted GPS (A-GPS) parameters on supported wireless data cards/modules.

The cellular device chipset contains a GPS receiver. Position Determine Equipment (PDE) assists the cellular device to speed up satellite acquisition, the PDE sends satellite almanac and ephemeris information to the device.

This feature currently only works on later model Sierra Wireless data devices that support A-GPS (USB598, USB597). When a later model Sierra Wireless data device is used with a CTM-200 configured in half bridge mode, A-GPS support is not available and must be disabled.

cmd agpspde ip port tm pc pl nl

Where:

ip ip address for location processing (Range: 0.0.0.0 to 255.255.255.255)

port port id for location processing (Range: 0 to 65535)

tm transportation mechanism (Range: 0 to 1) 0 - TCP/IP(default), 1 - Data Burst

pc position calculation type, fix type (Range: 1 to 6) 1 - Standalone, 2 - MS-based only, 3 - MS-assisted only = A-GPS Only(default), 4 - Optimum speed, 5 - Optimum accuracy, 6 - Optimum data

pl privacy level for location processing (Range: 0 to 2) 0 - low(default), 1 - medium, 2 - high

nl network access level for location processing (Range: 0 to 3) 0 - network access only, 1 - no network access, 2 - network access with demodulation(default),3 - network access without demodulation

Examples:

1. Set A-GPS parameters:
2. Disable A-GPS feature:

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

APN <name-of-apn>
This command configures the APN (Access Point Name) for a CTM-200. This command is only applicable to GSM/GPRS/HSPA devices.

cmd apn will query current APN value

Examples:

1. Query current APN
2. Set APN

apply

This command applies changes to network and firewall settings. The command takes no arguments, and returns OK when complete.

cmd apply is required to make changes take effect after the following configuration commands:

• cmd dmz
• cmd ethernet
• cmd firewall
• cmd friends
• cmd lanip
• cmd lannetmask
• cmd landhcp
• cmd modbussecure
• cmd pad secure
• cmd pswd
• cmd rmtssh
• cmd rmttelnet
• cmd rmtweb
• cmd sshport
• cmd telnetport
• cmd user
• cmd wpan secure

cmd apply is followed by cmd save to make the changes persistent.

Example:

1. Set the LAN subnet

---

See also: dmz, ethernet, firewall, friends, lanip, lannetmask, landhcp, pswd, rmtssh, rmttelnet, rmtweb, sshport, telnetport, user

autoconnect n

Configure the modem to automatically connect to a network

n = 0 manual network connection
n = 1 auto network connection (default)

Examples:

1. Set the modem to automatically connect to a wireless service:
2. Query the current setting:

autopevent n

Enables the $PEVENT message to be pre-pended to any existing reports. $PEVENT contains trigger or event that generated the report.

Where n:
0 : disable $PEVENT message (default)
1 : enable $PEVENT message

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

auxreport

cmd auxreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8] where r = 0 disables the report and r = 1 to 999 report number

This command sets the report(s) to be used for auxiliary interface triggered reports. Up to 8 reports can be assigned to the auxreport configuration.

When auxreport is configured to use a report, it appends a modified message 114, $PGPS to the already existing messages configured in the report. The appended message contains the frame data received on the serial port at the end of the default $PGPS message.

Examples:
cmd auxreport 1 0 0 0 0 0 0 0

auxterm

cmd auxterm C1 [C2] [C3] [C4] [C5] where C1-C5 are in hex format and the default value is '0D 0A'

This command sets the termination characters for mode 22, auxiliary interface. The termination characters would not be forwarded by auxiliary interface triggered reports.

Examples:
cmd auxterm 0D cmd auxterm 0d 0a cmd auxterm 53 54 4f 50 (STOP)

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 CTM-200 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.
2. User report 1, 2 and 4 for boom-tracker triggered reports.
3. Disable boom-tracker triggered reports
A cmd save is required for this command to take effect.

---

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

cmd can apply

Force re-configuration of STM with values set in cmd can engparam and cmd can prot.

Example:
See also: can engparam, can prot

cmd can engparam m

Defines which parameters are to be queried/reported. "m" is a bit mask in hex:
bit 0 = Not used
bit 1 - p1
bit 2 - p2
...
bit 127 - p127
Default value: all off

Example:
cmd can engparam 10000000000002 enables p1 and p52

A cmd can apply is required for this command to take effect.

See also: can prot

cmd can prot p

Enables/disables internal CAN and sets the protocol to be used as follows:

• p=0 - CAN disabled (default)
• p=1 - ISO15765-4
• p=2 - J1939

Example:
cmd can prot 1 selects ISO15765-4

A cmd can apply is required for this command to take effect.

See also: can engparam

cardlistclear

Removes list of approved swipe-card IDs from CTM-200.

Example:

---

See also: cardlistload, cardlistsave

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

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 CTM-200 gateway using cardlistload.

Example:

---

See also: cardlistclear, cardlistload

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

clientmac nn:nn:nn:nn:nn:nn

Use clientmac to set the MAC address of a client computer Ethernet interface, if using modem mode (half-bridge mode) and DHCP.

nn:nn:nn:nn:nn:nn 12-digit hexadecimal address

The clientmac address can be queried by using this command without parameters.

Examples:
cmd clientmac 00:a0:d1:69:b2:c8
OK

cmd clientmac
cmd clientmac 00:a0:d1:69:b2:c8
OK

---

See also: modemmode, modemmodedhcp

confupgrade script-name url username passwd

Configures the CTM-200 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, 2 parameters when accessing an HTTP server, or 2 parameters when accessing scripts locally.

The script file is a text file containing device commands used to configure a CTM-200. The script file must have UNIX line endings.

For example:

• script-name the name of the configuration script to fetch/run
• url can be localhost, or 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:// or localhost://, or url is localhost)
• passwd password to access FTP server (ignored when url is prefixed by http:// or localhost://, or url is localhost)

When localhost is specified as the url, the script file and its corresponding .md5 file must be located in /etc/config on the CTM-200. Likewise, when localhost://tmp is specified as the url, the script file and its corresponding .md5 file must be located in /tmp on the CTM-200.

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

cmd confupgrade action.sh localhost://tmp will execute the script /tmp/action.sh on the CTM-200

cmd confupgrade action.sh localhost will execute the script /etc/config/action.sh on the CTM-200

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

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
2. Query the current link data count

---

See also: ctm15x, datacond

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)
2. Query the current link data trigger condition

---

See also: data, datareport

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.
2. User report 1, 2 and 4 for link data count triggered reports.
3. Disable link data count triggered reports

---

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

device cell type

Configure the wireless cellular data device used by the CTM-200 gateway. Default is NONE.

The table of supported wireless cellular data devices and their type identifiers can be found at: CTM-200 Device Table

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

Example:

1. Configure the CTM-200 gateway to use the AC306 HSPA+ wireless data device:
2. Query the currently configured wireless device:

---

See also: apn, device_wifi

device cellnetwork n

Configure cell device to use a specified network type.

Note:
This command is only supported on the following cell devices: Huawei E397B, Sierra Wireless AC313/320/330

n=DEFAULT use network type already set on the cell device (default)
n=AUTO automatically set the network type based on network availability
n=GSM GSM is the network type
n=HSPA HSPA is the network type
n=LTE LTE is the network type

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

Examples:

1. Configure a supported cell device to use HSPA only
   cmd device cellnetwork HSPA
   cmd save
   cmd pwr mode 2


2. Configure a supported cell device to automatically select its network type
   cmd device cellnetwork AUTO
   cmd save
   cmd pwr mode 2

See also: apn, device cell

device priority n

A CTM-200 configured with a dual-mode : cell + wifi client (cmd wlanenable 1), also requires a specification of the preferred WAN interface.

Where n:
wifi wifi is the priority device(default)
cell cellular is the priority device

In a dual-mode cell + wifi client setup, where wifi is the priority device:

• if the wifi is up then the default route for all traffic will be through the wifi gateway.
• if wifi is not online, the ppp0/eth interface will be the default route.

In a dual-mode cell + wifi client setup, where cell is the priority device:

• if the wifi is up then the default route for all traffic will be through the cell gateway.
• if wifi is not online, the ppp0/eth interface will be the default route.

Example:

1. Sample Configuration (wifi has priority):
   cmd device cell AC598
   cmd device wifi UB93
   cmd wlanenable 1
   cmd save
   cmd pwr mode 2


2. Sample Configuration (cell has priority):
   cmd device cell AC598
   cmd device wifi UB93
   cmd device priority cell
   cmd wlanenable 1
   cmd save
   cmd pwr mode 2

See also: wlanenable, device wifi, device cell

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

device wifi type

Configure the wifi device used by the CTM-200 gateway. Default is NONE.

The table of supported wifi devices and their type identifiers can be found at: CTM-200 Device Table

In addition to this command, wifi support is configured using wlanenable.

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

Example:

1. Configure the CTM-200 gateway to use the SR71 wi-fi device:
2. Query the currently configured wireless device:

---

See also: apn, device_cell, wlanenable

dir pppppppppp [qqqqqqqqqq]

This command sets the NAM (Number Assignment Module) value for the CTM-200. It is a 10-digit phone number assigned to the CTM-200 by the service provider. Use the spc command to unlock the CTM-200 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 CTM-200. It is a 10-digit number assigned to the CTM-200 by the service provider. Use the spc command to unlock the CTM-200 first.

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

Optional Parameter:

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

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 CTM-200.

Examples:

1. Set the CTM-200’s MDN and MIN
2. Set the CTM-200’s 10-digit number (MDN)
3. Set the CTM-200’s 10-digit number (MIN)
4. Query the CTM-200’s currently assigned phone number (MDN)
A cmd save is required for this command to take effect.

dnscheck x

This command is used to enable or disable the CTM-200 gateway from checking for valid DNS IP addresses obtained from the carrier when it connects to the network. If the DNS IP addresses are invalid, the gateway will disconnect the current network connection and reconnect.

After 5 reconnects have been attempted every 30 secs, and the gateway still gets an invalid DNS, the gateway will stop disconnecting and reconnecting the network connection.

x = 0 disable checking for valid DNS IP addresses from the carrier
x = 1 enable checking for valid DNS IP addresses from the carrier (default)

Examples:

1. Disable checking DNS IP addresses from the carrier.

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

dout n x [d]

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

Optional parameter:
d = 0 continuous duration (default)
d = 1 to 255 duration in 10ms intervals

Note that when cmd dout is used with cmd save, d is always 0 and the final output state is saved. The d duration parameter is used only for real-time purposes such as in a script (e.g. relay unlock).

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. Pulse output #1 ON for 2 seconds
   dout 1 1 200
   OK
   
   
3. 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 text1 text2 text3

This command configures the CTM-200 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 CTM-200 to be more easily accessed over the Internet for remote configuration or for end application. For this feature, the CTM-200 requires a public IP address. By default this feature is disabled - “, ,”. This command requires a cmd save command and power cycle for the changes to take effect.

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 CTM-200. 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
2. Disable DYNDNS updates
3. Query the CTM-200’s setting for this setting
A cmd save is required for this command to take effect.

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 CTM-200 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
2. Query current email server
A cmd save is required for this command to take effect.

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 CTM-200 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.

Example:

1. Set the engine hours to 2501

---

See also: ctm15x

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

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

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

ethernet x

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

Example:

1. Disable Ethernet services
A cmd apply followed by a cmd save are required for this command to take effect.

---

See also: ctm15x

event dump [-f or -h N] [-l or -t N] [-raw] [EVENT_FILTER] [email@address]

Displays the event log with Unix timestamps converted to human readable date strings.

Where:
-f to -h :dump first (head) N lines from the event log
-l to -t :dump last (tail) N lines from the event log
-raw :dump file in raw format, no conversion of Unix timestamps
[EVENT_FILTER] : up to 4 event filters can be defined, eg. [PWR_CYCLE]. Only events that match the filter(s) will be displayed. This can also be applied to events within the -f / -l range.
[email@address] :email the event log. SMTP server must be configured using cmd emailsrv, the event log will be emailed to the specified recipient.

Examples:

1. Dump the last 100 lines of the event log:
   cmd event dump -l 100


2. Dump the entire content of the event log:
   cmd event dump

Example output:
Note: the time stored in the event log can be changed via the device embedded web page Config -> TimeZone Page

The event dump file is stored in non-volatile memory space within the CTM-200 file system /etc/ctm_event_log

event healthinterval n

This command defines the interval (seconds) between HEALTH status reports.

Where:
n number of seconds between reports (default 14400 or 4 hr, where 600 <= n <= 86400)

Examples:

1. Define a health report to be sent every 8 hours:
   cmd event healthinterval 28800
   
   
   
2. Query the current healthinterval time:
   cmd event healthinterval

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

Example output:

event logclear

Clears the event log file.
A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

event loglevel n

Set the event reporting level, default is 1

CTM-200 Firmware Events

CTM-200 Events	Log Level
CELL_OFFLINE	10
CELL_ONLINE	1
CONFUPGRADE	1
ENTER_LPM	2
ENTER_ALLOWED_ZONE	1
EXIT_ALLOWED_ZONE	1
ENTER_RESTRICTED_ZONE	1
EXIT_RESTRICTED_ZONE	1
IGN_OFF	2
IGN_ON	2
POWER_UP	10
PWR_CYCLE:desc	1
RF_ENABLE	2
RF_DISABLE	2
WIFI_OFFLINE	2
WIFI_ONLINE	2
UPGRADEFW	1

Where:
n log level (default = 1)

Examples:

1. set the loglevel to 2:
   cmd event loglevel 2
   
   
2. Query the current loglevel:
   cmd event loglevel

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

event minoffline n

Sets the minimum time interval(seconds) before reporting a CELL_ONLINE event. Default is 120 (2 minutes). By increasing the time for this command CELL_ONLINE events will only be generated by after continuous connectivity.

Where:
n number of seconds(default 120)

Examples:

1. Define a minimum time of 300 (5 minutes) before a CELL_ONLINE event is generated:
   cmd event minoffline 300
   
   
2. Query the current minimum time interval:
   cmd event minoffline

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

event eventreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

Associate up to 8 general reports with the event server

Where:
r1 defines the general report to use for event reports

Examples:

1. Report the event(s) using general reports 1 and 2:
   cmd event report 1 2
   OK
   
   
2. Query the current event report configuration:
   cmd event report
   cmd event report 1
   OK

Note: If cmd event loglevel 5 5 is set:
When sending event reports remotely, event reports will be stored on the CTM-200 until a signal is obtained. For the stored reports to be sent, the following conditions must be met:

• the CTM-200 must obtain a signal
• the same report number(s) used in cmd event report must be used in another command (ie obdreport, vccreport)
• the 'other' command (ie. obdreport, vccreport) must be sending live data

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

firewall n eeeee lllll t iii.iii.iii.iii s

This command is used to setup the port forwarding configuration of the CTM-200.
Up to 50 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 50 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.

Notes:

• LAN IP addresses used in port forwarding rules must match the LAN subnet as configured using cmd lanip, cmd lannetmask, and cmd lanrepip.
• The corresponding Port Forwarding Rules (PortFwd) page in the Web Interface only shows the first 10 port forwarding configurations.

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 apply followed by a cmd save are required for this command to take effect.

freeconsole

Kill the serial console shell process. This command must be done at first if you use cmd pad or cmd modbusgw from the SSH/Telnet console in mode 4 or 6.

Example:

1. Free the serial console port to use by pad or modbusgw mode.

The serial console is not available after this command. You may need to set cmd port to use serial console again.

friends n x.x.x.x y.y.y.y

This command is used to setup the CTM-200 gateway's firewall friends list, which is used to block incoming packets from an IP address that is not specifically enabled.
Use this to define a range of IP addresses whose traffic you wish to be accepted by the CTM-200.

This feature controls access to the following CTM-200 features:

• MODBUS
• PAD
• ULCP
• Remote SSH access (R1.3.0 only)
• Remote Telnet access
• Remote Web access

Port forwarding configured via firewall and the DMZ feature configured via dmz are accessible by all IP addresses. The friends list feature does not control access to these features.

CTM-200 access is verified in ascending order via the OR condition of all entries in the friends list.

n = 1 to 8 friends list number
x.x.x.x = 0.0.0.0 to 255.255.255.255 IP address/range to allow
y.y.y.y = 0.0.0.0 to 255.255.255.255 netmask of addresses to allow

By default, the friends list is disabled and all IP addresses are allowed to access the CTM-200.

The current friends list can be queried by using friends without parameters. An empty friends list indicates that this feature is disabled.

Examples:

1. Allow only incoming requests from the IP address 1.2.3.4 to access the CTM-200
2. Allow only incoming requests from the 1.2.3.x subnet to access the CTM-200
3. Allow only incoming requests from the 1.2.3.x subnet to access the CTM-200. This is equivalent to Example #2 above.
4. Disable the friends list entry and allow all IP addresses to access the CTM-200 (default)

A cmd apply followed by a cmd save are required for this command to take effect.

ftp server n

Where n:
0 disable ftp server
1 enable ftp server

Notes:

• The CTM-200 must have a microSD card to use for ftp server file space.
• Pure-ftpd is the CTM-200 ftp server package.
• The pure-ftpd bandwidth options have been set to 100KB/s.
  

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

fuel io n x y z

Configures the total fuel calculation to use GPIO inputs (mode 5)

Where:
n is the GPIO used
x is the GPIO reading at empty(current or voltage)
y is the GPIO reading at full(current or voltage)
z is the number of Liters required to reach full.

Example:
Use input 1, 0 Volts input value when empty, 10 volts input value when full and a full tank taking 100 Liters.
cmd fuel io 1 0 10 100

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

fuel mode n

Set the fuel mode for fuel calcuation.

Where n:
0 disables fuel calculation
1 Use OBDII MAF (mass air flow rate) parameters for FUEL calculation (this setting requires an interface with the vehicle ECU)(p13)
2 Use J1939 total fuel parameter(p31)
3 Use J1939 fuel rate parameter(p34)
4 Use J1939 average fuel parameter (p41)
5 Use GPIO connected to analog fuel gauge for total fuel calculation

Examples:

1. configure the fuel to be calculated using data from the vehicle Engine control unit (ECU) (via OBDII):
   cmd fuel mode 1
   OK

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

fuel query

Query the total fuel (liters) for a vehicle with fuel calculation enabled.

Example:

1. Query the fuel value.
   # cmd fuel query
   904 liters
   OK

fuel rate i d t

Sets whether timer or distance or both triggers when fuel rate is calculated. Whenever d or t triggers a calculation, both triggers are reset.

Fuel rate is calculated by calculating the difference between total fuel reading at two different times based on an incrementing odometer "delta" value and factoring it to a L/100Km value.

Fuel rate calculation requires active data from a connected OBDII/J1939/GPS/GPIO interface and cmd fuel mode to be configured.

Where:
i=0 ignition based reset disabled (default)
i=1 ignition based reset enabled

d delta distance in Km the fuel rate will be calculated (default 1)
0 = disabled
otherwise distance in km (1-65535)

t delta time in seconds the fuel rate will be calculated (default 60)
0 = disabled
otherwise time in seconds (1-65535)

Examples:

1. Configure the fuel rate to be calculated based on a "delta" odometer value of 25 Km:
   cmd fuel rate 0 25 0
   
   
2. Configure the fuel rate to be calculated every minute:
   cmd fuel rate 0 0 60
   
   
3. Configure the fuel rate to be reset after each ignition ON and calculate fuel rate after every 60 seconds:
   cmd fuel rate 1 0 60
   
   
4. Configure the fuel rate to be reset after each IGN ON and to calculate fuel rate every 60s or every 100km, whichever is reached first:
   cmd fuel rate 1 100 60

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

See also: fuel rate query, fuel mode, can apply, can prot

fuel rate query

Query the fuel rate value.
This command will return ERROR if the minimum distance set by cmd fuel rate has not been met or if no fuel or odometer data is available.
Fuel rate calculation requires active data from a connected OBDII/J1939/GPS/GPIO interface and cmd fuel mode to be configured.

Example:

1. Query fuel rate:
   cmd fuel rate query
   8.9
   OK

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

See also: fuel rate, fuel mode, can apply, can prot

fuel rate reset

Resets the fuel rate value to 0.

Examples:
Resets the fuel rate.

fuel reset

Resets the fuel value to 0.

Example:
Resets the idle time.
A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

cmd geort acount

View georoute allowed area alarm ($PGRT ALRMA messages) counter. This value is non-volatile.

Example:
cmd geort acount 0 will reset the counter to 0.

See also: geort c2bin, geort delete, geort enable, geort list, geort period, geort rcount, geort report, geort th, geort update

cmd geort c2bin [-d]

Convert text-based route list into a CTM-200 binary format. '-d' flag will display the result after conversion. Warning: If the route is long, it may take a while to display all the values.

NOTE: this command is not required when the route file is uploaded via the geort update as the conversion process is built into the update command.

Requirements:
1) Filename must be geolsN.txt (N=1 to 32) (e.g. geols1.txt, geols32.txt)
2) Files must be stored in /etc/geort/rt
3) File content must be of the following format:
4) Each file can only contain 1 zone type

Examples:

1. To convert the files
   cmd geort c2bin


2. To convert the files and view the result
   cmd geort c2bin -d

See also: geort acount, geort enable, geort list, geort period, geort rcount, geort report, geort th, geort update

cmd geort delete ROUTE

Deletes Geo-Routes from active routes.
ROUTE is the Geo-Route where ROUTE = 1 to 32 or ALL, all for all available routes to download

Examples:
To disable all routes:
To disable route 3:
See also: geort acount, geort c2bin, geort enable, geort list, geort period, geort rcount, geort report, geort th, geort update

cmd geort enable m

Disable or enable Geo-Route.
m = 0 - Geo-Route disabled (default)
m = 1 - Geo-Route enabled

Example:
To enable Geo-Route
A cmd save is required for this command to take effect.

See also: geort acount, geort c2bin, geort delete, geort list, geort period, geort rcount, geort report, geort th, geort update

cmd geort list

Display Geo-Routes being monitored.

Example:

See also: geort acount, geort c2bin, geort delete, geort enable, geort period, geort rcount, geort report, geort th, geort update

cmd geort period m

Set how often Geo-Route violation is checked.
m = 10-300 seconds (60 default)

Example:

To set Geo-Route to be checked every 10 seconds
A cmd save is required for this command to take effect.

See also: geort acount, geort c2bin, geort delete, geort enable, geort list, geort rcount, geort report, geort th, geort update

cmd geort rcount

View georoute restricted area alarm ($PGRT ALRMR messages) counter. This value is non-volatile.

Example: cmd geort rcount 0 will reset the counter to 0.

See also: geort acount, geort c2bin, geort delete, geort enable, geort list, geort period, geort report, geort th, geort update

cmd geort report [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

Associate up to 8 reports for Geo-Route.
r1...r8 = 0-999 - Report number (0-999)
cmd geort report 0 will delete all reports.

Each report will be composed of the following message: $PGRT,ddmmyy,hhmmss.ss,v,MSG,rr,LAT,LON,hhh.h,sss.s,MODEMID*hh

Where
v is validity flag (A = valid, V = invalid)
MSG can be:

• "ALRMA" - alarm when allowed area violation counter has reached set threshold
• "ALRMR" - alarm when restricted area violation counter has reached set threshold
• "AOUT" - when vehicle has exited an allowed area
• "AIN" - when vehicle has entered an allowed area
• "ROUT" - when vehicle has exited a restricted area
• "RIN" - when vehicle has entered a restricted area

rr is route number
LAT/LON is the GPS location in decimal degrees (ddd.dddd)
hhh.h is heading
sss.s is speed
MODEMID is modem ID (ESN/IMEI)
hh is NMEA checksum

Example:
To set Geo-Route to be checked every 10 seconds and reporting to reports 2 and 999
Example messages:

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

See also: geort acount, geort c2bin, geort delete, geort enable, geort list, geort period, geort rcount, geort th, geort update, repaddmes, reptype, replocip, replocport, repremip, repremport

cmd geort th [r [t]]

Set the number of consecutive violations for each zone type before a corresponding alarm (ALRMA/ALRMR) message is generated. The counter is reset when an alarm is sent. Note that AIN/AOUT and RIN/ROUT do not have thresholds - they are always sent when they occur.
r = 1-2 - Zone type (1-Allowed zones, 2-Restricted zones)
t = 1-255 - Threshold (number of violations before $PGRT ALRMA/ALRMR message is sent.

Default:
cmd geort th 1 5
cmd geort th 1 3

Example:

1. To set Geo-Route to send an alarm after the vehicle is outside of all allowed zones for 3 times (checks) in a row
cmd geort th 1 3


2. To set Geo-Route to send an alarm after the vehicle is in a restricted zone for 2 times (checks) in a row
cmd geort th 2 2

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

See also: geort acount, geort c2bin, geort delete, geort enable, geort list, geort period, geort rcount, geort report, geort update

cmd geort update ROUTE URL [USER] [PWD]

Add/update Geo-Routes from specified location.
Please note that previous routes with identical route number will be deleted if routes are successfully updated!

ROUTE is the Geo-Route where ROUTE = 1 to 32 or ALL, all for all available routes to download
URL can be localhost, or 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
USER username to access server
PWD password to access server

When localhost is specified as the url, Geo-Route files must be located in /tmp on the CTM-200. Likewise, when localhost://t2 is specified as the url, files must be located in /t2 on the CTM-200.

Examples:
Remote server:
Locally:
See also: geort acount, geort c2bin, geort delete, geort enable, geort list, geort period, geort rcount, geort report, geort th

gopad n

Manually initiates a PAD connection on the CTM-200 serial port(s).

Where n
1 :First PAD configuration (Serial Port 1,2,3)
2 :Second PAD configuration (Serial Port 2,3)

If n is not specified, the PAD connection for the first PAD configuration is initiated.

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

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
A cmd save is required for this command to take effect.

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
2. Query messages for GPS report #4
A cmd save is required for this command to take effect.

---

See also: gpsrep, gpsdelmes, gpslocport, gpsremip, gpsremport, gpsemail, gpssms

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
2. Send report #2 every 60 seconds AND distance is greater than 50 metres
3. Send report #4 every 60 seconds AND the distance traveled is greater than 50 metres AND the speed is between 20kph and 60kph
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
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
6. Query the conditions used to trigger all GPS reports
7. Query the conditions used to trigger GPS report #4
A cmd save is required for this command to take effect.

gpsdata

Displays the current status of GPS input devices configured via gpsinput and corresponding GPS data.
This command is read-only.

Example:
cmd gpsdata displays the status of currently configured GPS input devices and GPS data obtained from the devices

---

See also: gpsinput, gpsparam

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
2. Delete all messages from GPS report #4
A cmd save is required for this command to take effect.

---

See also: gpsrep, gpsaddmes, gpslocport, gpsremip, gpsremport, gpsemail, gpssms

gpsdgps n

Configure DGPS mode and SBAS. DGPS correction data source will be set as WAAS or RTCM.

Where n:
0 disables DGPS mode and search of SBAS satellite (default)
1 enables search of SBAS satellite and sets DGPS correction data source as RTCM
2 enables search of SBAS satellite and sets DGPS correction data source as WAAS

Examples:

1. Enable search of SBAS satellite and set DGPS correction data source as RTCM:
   cmd gpsdgps 1
   OK


2. Query the current DGPS mode:
   cmd gpsdgps
   cmd gpsdgps 1
   OK

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

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
2. Clear the email address for GPS report #1
3. Query the email address for all GPS reports
A cmd save is required for this command to take effect.

---

See also: gpsrep, gpsdelmes, gpslocport, gpsremip, gpsremport, gpsaddmes, gpssms

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

gpsinput m

This command defines what source to use for GPS data.

cmd gpsinput m

Where:
m=mode (bit mapped) default=0x01
m.0 - Input 1 = Use internal GPS module (TSIP)
m.1 - Input 2 = Use internal GPS module (NMEA)
m.2 - Input 3 = Use external GPS module (NMEA)
m.3 - Input 4 = Use A-GPS module (NMEA)

Example:

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

gpslocip n iii.iii.iii.iii

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

n = 1 to 8 GPS report number
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 local IP address in decimal (default: 0.0.0.0)

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

If a report has no gpslocip configured, then the global local IP address configured with cmd lanrepip (default 192.168.1.20) will be used.

Examples:

1. Report #1 will be sent to local IP address 192.168.1.21
2. Query the remote IP address setting of all GPS reports

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

---

See also: gpsrep, gpsdelmes, gpslocport, gpsaddmes, gpsremport, gpsemail, gpssms

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
2. Query the local port setting of all GPS reports
A cmd save is required for this command to take effect.

---

See also: gpsrep, gpsdelmes, gpsaddmes, gpsremip, gpsremport, gpsemail, gpssms

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

gpsparam

This command configures the parameters and priority of the port the CTM-200 will use for obtaining GPS information.

cmd gpsparam input priority port br db p sb fc

Where:
input - GPS input to configure 1-4
priority - Data Priority (0-3). 0=highest
port - Serial port to use. e.g. ttyS1 or ttyUSB14
br - baud rate (same as cmd port)
db - data bits (same as cmd port)
p - parity (same as cmd port)
sb - stop bits (same as cmd port)
fc - flow control (same as cmd port)

If all enabled ports are available and have valid GPS, the highest priority input is used.

Notes:

• This can feature can also be used for A-GPS since it is outputting NMEA data on a ttyUSB port.
• When GPS inputs are configured at the same priority, GPS data will be obtained from whichever GPS input has valid data first, in ascending order from GPS input 0 to GPS input 3.

Example:

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

gpspos n ±xx.xxxxxx ±yyy.yyyyyy

Set fixed GPS position mode. This sets the GPS coordinates used in CTM-200 reports to user-defined latitude and longitude values. When this setting is enabled, the GPS date and time used in CTM-200 reports are synchronized to the CTM-200's system time.

This setting is used for monitoring modems used with fixed-site applications.

n = 0 Disable fixed GPS position mode. Use GPS position from GPS input device configured with gpsinput. (Default)

n = 1 Enable fixed GPS position mode. Use user-defined location.

±xx.xxxxxx = -90.000000 <= ±xx.xxxxxx <= +90.000000 latitude in decimal format, where North=positive and South=negative

±yyy.yyyyyy = -180.000000 <= ±yyy.yyyyyy <= +180.000000 longitude in decimal format where East=positive and West=negative

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

Notes:

• cmd gpspos 0 will disable the fixed GPS position mode but preserve the user-defined location
  
• cmd gpspos 0 0 0 will disable the fixed GPS position mode and clear the user-defined location
  

Example:

1. Enable fixed GPS position mode and set the user-defined location to (49.256553, -122.996733):
2. Disable fixed GPS position mode but preserve the user-defined location:
3. Disable fixed GPS position mode and clear the user-defined location:

---

See also: gpsinput

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
2. Query the remote IP address setting of all GPS reports
A cmd save is required for this command to take effect.

---

See also: gpsrep, gpsdelmes, gpslocport, gpsaddmes, gpsremport, gpsemail, gpssms

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
2. Query the remote port setting of all GPS reports
A cmd save is required for this command to take effect.

---

See also: gpsrep, gpsdelmes, gpsaddmes, gpsremip, gpsremport, gpsemail, gpssms

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
l = 6 file-based reports

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

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
3. Queries the reporting method for all GPS reports
A cmd save is required for this command to take effect.

---

See also: gpsaddmes, gpsdelmes, gpslocport, gpsremip, gpsremport, gpsemail, gpssms

gpsrmc

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

Example:

1. Return a current GPS NMEA format RMC message NMEA 0183 v2.0:
NMEA 0183 v3.0:

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
2. Send GPS report #2 as an SMS message to the specified email address
3. Clear the SMS destination for GPS report #1
4. Query the phone numbers or email addresses for all GPS SMS reports
A cmd save is required for this command to take effect.

gpstime n

Set the priority of valid GPS as an external system time synchronization source.

n = 0 Disabled
n = 1-3 Priority relative to other external system time synchronization sources with 1 = highest (default: 1)

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

Example:

1. Set valid GPS as lowest priority relative to other external time synchronization sources:

---

See also: networktime, ntpserver, ntptime, timesync

idle cond n a b c

Set the Idle reporting and reset condition.

Where:
n = 1 to 8 idle condition number
a = 0 idle START trigger disabled (default)
a = 1 idle START trigger enabled, idle event will be triggered when idle > idle time
b = 0 idle END trigger disabled(default), idle event triggers when vehicle leaves idle state
b = 1 idle END trigger enabled, idle event triggers when vehicle leaves idle state
c = 0 idle time accumulates, reset is via "cmd idle reset"
c = 1 idle time is reset at b=1
c = 2 idle time is reset at a=1 (state of b is ignored)

Examples:

1. Set idle time to 5 mins and condition 1. Idle event will trigger twice. When idle time > 5 minutes AND when vehicle leaves idle state (ie starts moving) at which time idle will be reset.
   cmd idle time 300
   cmd idle cond 1 1 1 1


2. Set idle time to 5 mins and condition 1. Idle event will trigger twice. When idle when idle time > 5 minutes AND when vehicle leaves idle state (ie, starts moving). Total idle time will NOT be reset.
   cmd idle time 300
   cmd idle cond 1 1 1 0


3. Set idle time to 5 mins and condition 1. Idle event will trigger once, when idle > idle time. When vehicle leaves idle, no event is generated, cumulative idle is reset.
   cmd idle time 300
   cmd idle cond 1 1 0 2


4. Set idle time to 5 mins and condition 1. INVALID case. Idle event will NOT trigger. Total idle time will NOT be reset.
   cmd idle time 300
   cmd idle cond 1 0 1 2


5. Set idle time to 5 mins and condition 1. Idle event will trigger once, when vehicle leaves idle, cumulative idle is reset after event.
   cmd idle time 300
   cmd idle cond 1 0 1 1


6. Set idle time to 5 mins and condition 1. Idle event will trigger once, when idle > idle time, cumulative idle is reset after event.
   cmd idle time 300
   cmd idle cond 1 1 0 1

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

idle mode n

Set the Idle mode for vehicle idling condition.

Where n:
0 disables Idle calculation
1 Use OBDII/J1939 parameters for IDLE calculation (this setting requires an interface with the vehicle ECU)
2 Use GPS PVT(position, velocity, time) information along with ignition sense for idle calculation (this setting requires the ignition control line of the CTM to be wired to the vehicle ignition and valid GPS signal)

Examples:

1. configure the idle time to be calculated using data from the vehicle Engine control unit (ECU) (via OBDII or J1939):
   cmd idle mode 1
   OK

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

idle query

Query the Idle time (seconds) for a vehicle with idle detection enabled.

Examples:

1. Query the idle time.
   # cmd idle query
   1154 seconds
   OK

idle report [n] [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

This command sets the report(s) to be used for IDLE triggered reports.
Up to 8 IDLE triggers can be configured, each supporting up to 8 reports.

n = 1 to 8 IDLE trigger condition
r1...r8 = 1 to 999 report number
r1...r8 = 0 disables the report

Example:

1. Set report #2 and #5 for IDLE trigger condition #1.
   cmd idle report 1 2 5
   OK

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

idle reset

Resets the idle time to 0.

Examples:

1. Resets the idle time.
   cmd ctm15x
   OK
   cmd idle reset
   OK

idle time n

Set the Idle time for vehicle idling condition to start being recorded.
Where n is the idling time in seconds.

Examples:

1. Set the time at which idle detection will start to 5 minutes.
   cmd idle time 300
   OK

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.

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
2. Set ignition condition 2 to trigger when an ignition transition (ON to OFF or OFF to ON) is detected.
A cmd save is required for this command to take effect.

---

See also: ignreport

ignreport [n] [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

This command sets the report(s) to be used for ignition triggered reports.
Up to 8 ignition triggers can be configured, each supporting up to 8 reports.

n = 1 to 8 ignition trigger condition
r1...r8 = 1 to 999 report number
r1...r8 = 0 disables the report

Example:

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

Note: When sending ignition reports remotely, ignition reports will be stored on the CTM-200 until a signal is obtained. For the stored reports to be sent, the following conditions must be met:

• the CTM-200 must obtain a signal
• the same report number(s) used in cmd ignreport must be used in another command (ie obdreport, vccreport)
• the 'other' command (ie. obdreport, vccreport) must be sending live data

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

---

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

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

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 CTM-200'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
2. Set input #4 as analog, with alarm when > 7.5V
3. Query the setup parameters for all 6 inputs
A cmd save is required for this command to take effect.

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 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 CTM-200 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 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 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.

iolocip n iii.iii.iii.iii

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

n = 1 to 8 IO report number
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 local IP address in decimal (default: 0.0.0.0)

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

If a report has no iolocip configured, then the global local IP address configured with cmd lanrepip (default 192.168.1.20) will be used.

Examples:

1. Report #1 will be sent to local IP address 192.168.1.21
2. Query the remote IP address setting of all IO reports

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

---

See also: iorep, iodelmes, iolocport, ioaddmes, ioremport, ioemail, iosms

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

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 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 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 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
l = 6 file-based reports

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

Queries the IP address assigned to the CTM-200 by the wireless network.

This is a read only command.

Example:

1. Query the current IP address of the CTM-200

ipsec

Show all IPsec commands.
This is a read only command.

Example:

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec enable n

Enable/disable IPsec on the CTM-200.

n = 0 disable IPsec (default)
n = 1 enable IPsec

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

Examples:

1. Enable IPsec on the CTM-200
2. Query the current setting:

The commands in the sequence below and a power cycle are required for this command to take effect:

• ipsec remgw
• ipsec remnet
• ipsec genconf
• ipsec gensa
• save
• ipsec psk

---

See also: ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec genconf

Generate IPsec configuration files based on settings configured using IPsec commands.
Use this command to generate configuration files used for establishing an IPsec VPN tunnel.

A power cycle is required for this command to take effect.

---

See also: ipsec enable, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec genpolicy

Enable the IKE daemon to generate an IPsec security policy whenever a new connection is made with an initiator (client). This option is only applicable if passive mode is on, which is configured using the command cmd ipsec ikepassive 1, that is, for a CTM-200 configured as an IPsec responder (server). It is useful to negotiate with clients whose IP address is allocated dynamically.

n = 0 do not generate an IPsec security policy on a new connection (default)
n = 1 generate an IPsec security policy on a new connection

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

Examples:

1. Set the CTM-200 to generate an IPsec security policy on a new connection
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle is required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec gensa

Generate IPsec Security Associations.
Use this command to generate an IPsec security association file used by the IPsec daemon to configure the Security Association Database (SAD) and the Security Policy Database (SPD) in the CTM-200's IPsec stack.

Example:

1. Generate IPsec security associations on the CTM-200

A power cycle is required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec ikedhgroup n

Define the IPsec IKE phase I Diffie-Hellman group.

n = 1 modp768
n = 2 modp1024 (default)
n = 5 modp1536
n = 14 modp2048
n = 15 modp3072
n = 16 modp4096
n = 17 modp6144
n = 18 modp8192

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

Examples:

1. Set the IPsec IKE phase I Diffie-Hellman group to modp2048
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec ikeenc alg

Define the IPsec IKE phase I encryption algorithm.

alg = des Data Encryption Standard algorithm
alg = 3des Triple DES algorithm (default)
alg = aes Advanced Encryption Standard algorithm
alg = aes256 Advanced Encryption Standard (256-bit key) algorithm

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

Examples:

1. Set the IPsec IKE phase I encryption algorithm to DES.
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec ikeexchange mode

Define the IPsec IKE phase I exchange mode when the peer is configured as an initiator (client).

mode = main Main mode (default)
mode = aggressive Agressive mode

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

Examples:

1. Set the IPsec IKE phase I exchange mode to aggressive mode:
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec ikehash alg

Define the IPsec IKE phase I hash algorithm.

alg = md5 Message-Digest algorithm 5 (MD5) hash algorithm
alg = sha1 Secure Hash Algorithm-1 (SHA-1) hash algorithm (default)

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

Examples:

1. Set the IPsec IKE phase I hash algorithm to MD5.
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec ikeinitial n

Define the IPsec IKE phase I initial contact setting. Enable this to set the IPsec daemon to send an INITIAL-CONTACT message.

n = 0 set initial contact on (default)
n = 1 set initial contact off

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

Examples:

1. Set the IPsec IKE phase I initial contact setting off.
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec ikelifetime n

Define the IPsec IKE phase I lifetime in seconds.

n = 0 to 268435455 IKE phase 1 lifetime in seconds (default: 3600 s)

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

Examples:

1. Set the IPsec IKE phase I lifetime to 2 h (7200 s):
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec ikepassive n

Define the IPsec IKE phase I peer role of the CTM-200 as either initiator or responder.

n = 0 set passive off, setting CTM-200 as IPsec initiator (client) (default)
n = 1 set passive on, setting CTM-200 as IPsec responder (server)

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

Examples:

1. Set the IPsec passive setting on:
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec natt n

Enable IPsec NAT traversal (NAT-T) setting. NAT-T allows one or both peers to reside behind a NAT gateway (i.e. doing address- or port-translation).

n = 0 Disable IPsec NAT-T setting (default)
n = 1 Enable IPsec NAT-T setting

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

Examples:

1. Set the IPsec NAT-T setting as enabled:
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec nattkeepalive n

Set the IPsec NAT traversal (NAT-T) keepalive interval. This is the interval between sending NAT-T keepalive packets.

n = 0 Disable sending of NAT-T keepalive packets
n = 1 to 3600 NAT-T keepalive interval in seconds (Default: 20 seconds)

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

Examples:

1. Set the IPsec NAT-T keepalive interval to 5 minutes (300 seconds):
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec psk iii.iii.iii.iii n

Set IPsec pre-shared key used for IKE phase I.

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 IP address of remote peer in decimal
n Alpha-numeric pre-shared key

The IPsec Peer IP address must be configured using ipsec remgw before setting this pre-shared key.

Notes:

• You should only use this command from a LAN connection.
• To set a pre-shared key securely from a remote location, this command should only be used from within a SSH connection.

Example:

1. Set the IPsec IPsec pre-shared key for remote IPsec peer with IP address of 1.2.3.4 to testPSK1234:

A power cycle is required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec remgw iii.iii.iii.iii

Define IPsec remote gateway IP address.

iii.iii.iii.iii = anonymous For a CTM-200 configured as IPsec responder (server), use this to accept IPsec connection proposals from all IP addresses
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 IP address of remote gateway in decimal

This command must be set before ipsec genconf is executed.

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

Examples:

1. Set the IPsec remote gateway IP address to 1.2.3.4:
2. Query the current setting:

An ipsec genconf, a ipsec psk, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec remnet n iii.iii.iii.iii m

Define IPsec remote subnet(s) using Classless Inter-Domain Routing (CIDR) notation (e.g. 192.168.2.1/24)

n = 1 to 50 Subnet number
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 IP address of remote subnet in decimal
m = 1 to 32 Subnet mask represented in CIDR notation

The current setting for a remote subnet can be queried by using ipsec remnet n where n is the subnet number.
If n is omitted, all subnets will be queried.

Examples:

1. Set IPsec remote subnet 1 to 192.168.2.0/24:
2. Delete IPsec remote subnet 1:
3. Query the current setting:

An ipsec genconf, a ipsec gensa, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec restrict n

Set restrictive access policy for IPsec applications. Enabling the restrictive access policy limits all traffic from the CTM-200 to the IPsec subnet(s) and the remote IPsec peer.

n = 0 Disable restrictive access policy for IPsec applications (default)
n = 1 Enable restrictive access policy for IPsec applications

At least one IPsec remote subnet must be configured using ipsec remnet for this setting to take effect.

Remote access via Telnet, SSH, or embedded Web interface is not possible when cmd ipsec restrict 1 is configured.

The current setting can be queried by using ipsec restrict.

Examples:

1. Enable the restrictive IPsec access policy:
2. Query the current setting:

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

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec saauth alg

Define the IPsec ISAKMP phase II authentication algorithm.

alg = hmac_md5 Message-Digest algorithm 5 (MD5) authentication algorithm
alg = hmac_sha1 Secure Hash Algorithm-1 (SHA-1) authentication algorithm (default)

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

Examples:

1. Set the IPsec ISAKMP phase II authentication algorithm to MD5.
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

ipsec saenc alg

Define the IPsec ISAKMP phase II encryption algorithm.

alg = des Data Encryption Standard algorithm
alg = 3des Triple DES algorithm (default)
alg = aes Advanced Encryption Standard algorithm
alg = aes256 Advanced Encryption Standard (256-bit key) algorithm

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

Examples:

1. Set the IPsec ISAKMP phase II encryption algorithm to DES.
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec salifetime, ipsec sapfsgroup

ipsec salifetime n

Define the IPsec ISAKMP phase II lifetime in seconds.

n = 0 to 268435455 ISAKMP phase II lifetime in seconds (default: 3600 s)

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

Examples:

1. Set the IPsec ISAKMP phase II lifetime to 2 h (7200 s):
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec sapfsgroup

ipsec sapfsgroup n

Define the IPsec ISAKMP perfect forward secrecy group.

n = 0 none
n = 1 modp768
n = 2 modp1024 (default)
n = 5 modp1536
n = 14 modp2048
n = 15 modp3072
n = 16 modp4096
n = 17 modp6144
n = 18 modp8192

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

Examples:

1. Set the IPsec ISAKMP perfect forward secrecy group to modp2048
2. Query the current setting:

An ipsec genconf, a cmd save, and a power cycle are required for this command to take effect.

---

See also: ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime

ipsec show

Show IPsec configuration.
This is a read only command.

Example:

---

See also:ipsec enable, ipsec genconf, ipsec genpolicy, ipsec gensa, ipsec ikedhgroup, ipsec ikeenc, ipsec ikeexchange, ipsec ikehash, ipsec ikeinitial, ipsec ikelifetime, ipsec ikepassive, ipsec natt, ipsec nattkeepalive, ipsec psk, ipsec remgw, ipsec remnet, ipsec restrict, ipsec saauth, ipsec saenc, ipsec salifetime, ipsec sapfsgroup

lanbridge 0|1

Enable bridging of LAN ports on CTM-200. When bridging is enabled, both LAN ports will be bridged to a common IP address, this allows PC devices connected to LAN0 and LAN1 to see each other on the same LAN subnet.

0 disabled
1 enabled

Restrictions:

• A static IP address must be defined for LAN0.

Example:

landhcp p ddd n

Configures the LAN dynamic host configuration protocol (DHCP) server settings on the CTM-200 gateway, specifically the starting IP address to assign to DHCP users and the maximum number of DHCP users on the LAN.

p = 0 or 1 ethernet port
ddd = 0 to 255 Last number of starting DHCP IP address in decimal (default: 20)
n = 1 to 254 Maximum number of DHCP clients (default: 10)

The starting DHCP IP address (default: 192.168.1.20) is aaa.bbb.ccc.ddd where aaa.bbb.ccc is the bitwise AND result of the LAN IP address and the LAN netmask, and ddd is specified in this command. The ending DHCP IP address (default: 192.168.1.29) is aaa.bbb.ccc.eee where aaa.bbb.ccc is the bitwise AND result of the LAN IP address and the LAN netmask, and eee = ddd + n - 1.

A cmd apply followed by a cmd save are required for this command to take effect.

Examples:

1. Assign DHCP users with IP addresses starting at 192.168.1.20 to a maximum of 15 users.
2. When the LAN IP is set to 192.168.10.1, assign DHCP users with IP addresses starting at 192.168.10.20 to a maximum of 10 users.
3. Query current DHCP range and number of users

---

See also: lanip, lannetmask, lanrepip

lanfriends n XX:XX:XX:XX:XX:XX T

his command is used to control access to PC devices connected through the CTM-200 ethernet ports.
Define up to 8 MAC addresses that are allowed ethernet access, all other devices will be denied packet forwarding/routing.

n = 1 to 8 lanfriends list number
XX:XX:XX:XX:XX:XX MAC address of PC to allow access. Use 0 to reset/disable

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

Examples:

1. Ethernet access granted to PC with ethernet MAC address 00:A0:D2:69:B2:C8
   cmd lanfriends 1 00:A0:D2:69:B2:C8
   OK
   
   
2. Show current lanfriends list
   cmd lanfriends
   cmd lanfriends 1 00:A0:D2:69:B2:C8
   cmd lanfriends 2 0
   cmd lanfriends 3 0
   cmd lanfriends 4 0
   cmd lanfriends 5 0
   cmd lanfriends 6 0
   cmd lanfriends 7 0
   cmd lanfriends 8 0
   OK
   
   
3. Reset a lanfriend entry
   cmd lanfriends 1 0
   OK

lanip p iii.iii.iii.iii [mmm.mmm.mmm.mmm]

Sets the IP address of the CTM-200 gateway's ethernet ports.

p = 0 or 1 ethernet port to configure (eth0/lan0 or eth1/lan1)
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 LAN IP address of the ethernet port in decimal (default: eth0: 192.168.1.1 and eth1: 192.168.2.1)
mmm.mmm.mmm.mmm = 0.0.0.0 to 255.255.255.255 LAN netmask of the ethernet port in decimal (default: 255.255.255.0)

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 ssh/telnet is enabled to allow the gateway to be accessed wirelessly.

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

Examples:

1. Set the LAN IP address of the eth1 port to 192.168.10.1
2. Set the LAN IP address of the eth1 port to 192.168.2.1 and netmask to 255.255.0.0
3. Query the LAN IP address
A cmd apply followed by a cmd save and a power cycle are required for this command to take effect. After taking effect, local ssh/telnet or Web page access should be accessed via the IP address specified in the command.

---

See also: landhcp, lannetmask, lanrepip

lannetmask p iii.iii.iii.iii

Sets the netmask of the CTM-200 gateway's ethernet port on the LAN.

p = 0 or 1 ethernet port to configure (eth0/lan0 or eth1/lan1)
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 LAN netmask of the gateway 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 ssh/telnet is enabled to allow the gateway to be accessed wirelessly.

The current LAN netmask can be queried by using lannetmask.

Examples:

1. Set the LAN netmask of the CTM-200 to 255.255.0.0
2. Query the LAN netmask of the CTM-200
A cmd apply followed by a cmd save and a power cycle are required for this command to take.

---

See also: landhcp, lanip, lanrepip

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

lanproto <type>

Configure LAN interface protocol to use DHCP or a Static IP address.
static | dhcp

lanrepip iii.iii.iii.iii

Sets the IP address of the local server connected to the CTM-200’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
2. Query the LAN IP address to which local reports will be sent
A cmd save is required for this command to take effect.

---

See also: landhcp, landns, lanip, lannetmask

mbusm add

Command is used when CTM-200 is being used as a MODBUS Master device and polling MODBUS Slave device through TCP or Serial port. This command will add a MODBUS Slave to MODBUS Master polling list. It will display all MODBUS slaves to be polled when it is used without arguments.

Add a MODBUS TCP Slave Type.
cmd mbusm add id nnn.nnn.nnn.nnn
Where:
id = 1 to 4 MODBUS Slave device ID
nnn.nnn.nnn.nnn = 1.0.0.0 to 255.255.255.255 MODBUS Slave Device IP address

Add a MODBUS Serial Slave Type.
cmd mbusm add id Serial m
Where:
id = 1 to 4 MODBUS Slave device ID
m = a or A ASCII Protocol
m = r or R RTU Protocol

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

See also: mbusm cond, mbusm data, mbusm del, mbusm exccond, mbusm excreport, mbusm poll, mbusm report

mbusm cond

Set the condition that will trigger a MODBUS Master report. The conditional operator is used to indicate how all of the 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 current condition for a report can be queried by using the cmd mbusm cond n command. If n is blank, all MODBUS Master reports will be queried.

cmd mbusm cond n b t [sid1, r1, dt1, md1, Md1] [sid2, r2, dt2, md2, Md2] [mt]

Where:
n = 1 to 8 the MODBUS Master trigger condition number
b = 0 conditional operator for all following parameters: Off, default
b = 1 conditional operator for all following parameters: AND
b = 2 conditional operator for all following parameters: OR
t = 0 timeout disabled, default
t = 1 to 65535 timeout in seconds

Optional parameters:
sid1 = 0 disable comparison with register r1 value of sid1, default
sid1 = 1 to 4 the MODBUS Slave device ID
r1 = 0 disable comparison with register r1 value of sid1, default
r1 = 1 to 65536 register address
dt1 = 0 single bit, discrete output, default
dt1 = 1 single bit, discrete input
dt1 = 2 2 bytes, 16-bit register input
dt1 = 3 4 bytes, 32-bit integer input
dt1 = 4 4 bytes, 32-bit float input
dt1 = 5 2 bytes, 16-bit register output
dt1 = 6 4 bytes, 32-bit integer output
dt1 = 7 4 bytes, 32-bit float output
md1 low data value from r1 of sid1, the data type is defined by dt1, 0 is default
Md1 high data value from r1 of sid1, the data type is defined by dt1, 0 is default
sid2 = 0 disable comparison with register r2 value of sid2, default
sid2 = 1 to 4 the MODBUS Slave device ID
r2 = 0 disable comparison with register r2 value of sid2, default
r2 = 1 to 65536 register address
dt2 the same as dt1
md2 low data value from r2 of sid2, the data type is defined by dt2, 0 is default
Md2 high data value from r2 of sid2, the data type is defined by dt2, 0 is default
mt = 0 to 65535 maximum reporting rate in seconds (minimum time between reports), 0 is default

Examples:

1. Send MODBUS Master report1 every 60 seconds
   # cmd mbusm cond 1 1 60
   OK
   
   
2. Send MODBUS Master report2 every 60 seconds AND the register 2 of MODBUS Slave 1 is between 10 and 20
   # cmd mbusm cond 2 1 60 1 2 5 10 20
   OK
   
   
3. Send MODBUS Master report3 every 60 seconds OR the register 2 of MODBUS Slave 1 is between 10 and 20, OR the register 3 of MODBUS Slave 4 is between 100 and 200, with a maximum report rate of one every 10 seconds
   # cmd mbusm cond 3 2 60 1 2 5 10 20 4 3 5 100 200 10
   OK
   
   
4. Query the conditions used to trigger all MODBUS Master reports
   # cmd mbusm cond
   cmd mbusm cond 1 1 60 0 0 0 0 0 0 0 0 0 0 0
   cmd mbusm cond 2 1 60 1 2 5 10 20 0 0 0 0 0 0
   cmd mbusm cond 3 2 60 1 2 5 10 20 4 3 5 100 200 10
   OK
   
   
5. Query the conditions used to trigger MODBUS Master report2
   # cmd mbusm cond 2
   cmd mbusm cond 2 1 60 1 2 5 10 20 0 0 0 0 0 0
   OK

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

See also: mbusm add, mbusm data, mbusm del, mbusm exccond, mbusm excreport, mbusm poll, mbusm report

mbusm data

Show the current register values from a MODBUS slave to debug the device status.

cmd mbusm data n
Where:
n = 1 to 4 the MODBUS Slave device ID

Example:
See also: mbusm add, mbusm cond, mbusm del, mbusm exccond, mbusm excreport, mbusm poll, mbusm report

mbusm del

This command deletes one or all MODBUS slaves from MODBUS Master polling list.

cmd mbusm del n
Where:
n = 0 deletes all MODBUS slaves
n = 1 to 4 MODBUS Slave device ID

See also: mbusm add, mbusm cond, mbusm data, mbusm exccond, mbusm excreport, mbusm poll, mbusm report

mbusm exccond

Set the condition that will trigger MODBUS exception reports.

cmd mbusm exccond e
Where:
e = 0 disable the MODBUS exception reports, default
e = 1 to 7FFF in hex the MODBUS events and exceptions to be used

MODBUS Event and Exception Bitmap:
bit0 = Illegal Function Exception, Code 1 A master sends a Modbus function, which is not supported by the slave device.
bit1 = Illegal Address Exception, Code 2 A master queries an invalid or non-existing data address.
bit2 = Illegal Value Exception, Code 3 A master sends a data value, which is not an allowable value for the slave device.
bit3 = Slave Failure Exception, Code 4 An unrecoverable error occurs in the slave device. The length might exceed the allowable data size.
bit4 = Acknowledge Exception, Code 5 A long duration of time will be required to process the request. This is to prevent a timeout error.
bit5 = Slave Device Busy Exception, Code 6 A long–duration program command is running. The command should be retransmitted later.
bit6 = NAK Exception, Code 7 The slave cannot perform the program function received in the query.
bit7 = Memory Parity Error Exception, Code 8 A master attempted to read record file, but detected a parity error in the memory.
bit8 = Gateway Path Unavailable Exception, Code 10/0x0A The gateway is unable to establish a connection with the target device.
bit9 = Gateway Target Fail Exception, Code 11/0x0B The gateway is unable to receive a response from the target device. Usually means that the device is not present on the network.
bit10 = Reply Timeout Event, Code 12/0x0C The slave device does not reply in time or does not reply at all. The device ID might be wrong.
bit11 = Send Timeout Event, Code 13/0x0D The handshake lines are not properly set.
bit12 = Device Open Error Event, Code 14/0x0E The Modbus Master couldn't open a serial or TCP slave device. The network is down, or the serial port is already opened. The function code in $PMEX will be 0 for this event.
bit13 = TCPIP Connection Closed Event, Code 15/0x0F TCP/IP connection was closed by the remote slave device.
bit14 = Unknown Poll Error Event, Code 16/0x10 This event is for all other errors when polling slave devices.

At least one event or exception defined by e should be detected to trigger reports. The exception code 12 ~ 16 are defined by Cypress Solutions.

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

See also: mbusm add, mbusm cond, mbusm data, mbusm del, mbusm excreport, mbusm poll, mbusm report

mbusm excreport

Set the reports to be used for MODBUS exception triggered reports. The message $PMEX will be appended after each generic report.

cmd mbusm excreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]
Where:
r1...r8 = 1 to 999 report number
r1...r8 = 0 disables the report, default

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

See also: mbusm add, mbusm cond, mbusm data, mbusm del, mbusm exccond, mbusm poll, mbusm report

mbusm poll

Configure polling MODBUS slaves.

cmd mbusm poll n r c [dt] [f] [o] [e]
Where:
n = 1 to 4 the MODBUS Slave device ID
r = 0 reset the configuration and disable polling, default
r = 1 to 65536 the start register address
c = 1 to 50 the number of registers to be read, 1 is default

Optional parameters:
dt = 0 single bit, discrete output
dt = 1 single bit, discrete input
dt = 2 2 bytes, 16-bit register input
dt = 3 4 bytes, 32-bit integer input
dt = 4 4 bytes, 32-bit float input
dt = 5 2 bytes, 16-bit register output, default
dt = 6 4 bytes, 32-bit integer output
dt = 7 4 bytes, 32-bit float output
f = 1 to 10000 the poll rate in ms, 1000 is default
o = 1 to 10000 the Slave timeout in ms, 1000 is default
e = 0 the little-endian, default
e = 1 the big-endian

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

See also: mbusm add, mbusm cond, mbusm data, mbusm del, mbusm exccond, mbusm excreport, mbusm report

mbusm report

Set the report to be used for MODBUS Master triggered reports.

cmd mbusm report [n] [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]
Where:
n = 1 to 8 the MODBUS Master trigger condition
r1...r8 = 1 to 999 report number
r1...r8 = 0 disables the report, default

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

See also: mbusm add, mbusm cond, mbusm data, mbusm del, mbusm exccond, mbusm excreport, mbusm poll

mip n

Sets the Mobile IP operation of the modem. This command is only applicable to CDMA/EV-DO devices.

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

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 for the port command. (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.

Note3: If the baud rate of the serial port is changed from the serial console using the modbusadd command, and the baud rate of the host application is changed to match the new configuration after implementing this command, then the serial console should still be able to accept commands. This functionality is only available if the connection mode of the modem is mode = 1 or mode = 2 before issuing modbusadd. After changing the serial port configuration, a cmd save and a power cycle is highly recommended.

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:

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

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

3. Add serial slave with baud 115200, no parity, 8 data bits, 1 stop bit and as ASCII transmission mode

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
A cmd save is required for this command to take effect.

modbusctm130 n

Enables MODBUS backward compatibility with the CTM-13X by using MODBUS RTU encapsulated in UDP packets for messages transmitted/received over-the-air.
CTM-13X 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 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.

modbusgw

Use this to initiate the MODBUS gateway manually from the serial port console. In firmware version R1.3.0 and above, "cmd freeconsole" must be run first before using this command from the SSH/Telnet console.
Use cmd mode 6 to put the modem in permanent MODBUS mode (enter MODBUS automatically after a power cycle).

Example:
1. Initiate the MODBUS gateway manually

---

See also: freeconsole, modbusadd, modbusctm130, modbusdel, modbusidmap, modbusmode, modbusport

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 CTM-15X 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
2. Clear the MODBUS ID to modem IP entry for slave ID 1
3. Change slave ID 1 entry to the modem with an IP of 123.1.2.4
4. Clear all MODBUS ID to modem IP entries
5. Query all MODBUS ID to modem IP entries
A cmd save is required for this command to take effect.

---

See also: modbusctm130, modbusmode

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

2. Query the currently configured MODBUS gateway mode

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

---

See also: mode

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

2. Query the existing MODBUS port

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

---

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

modbussecure

Secure access to the modem's MODBUS server from the Internet.
If enabled, it will not be possible to remotely access the MODBUS server via the port specified in modbusport and using the current IP address allocated to the CTM-200 by the network.
This is to support applications where the servers may be accessed through SSH tunneling.

n = 0 allow direct access to MODBUS server from Internet (default)
n = 1 secure - do not allow direct access to MODBUS server from Internet

The current status of the MODBUS secure access setting can be queried by using the modbussecure command without parameters.

Examples:

1. Set the CTM-200 to secure access to MODBUS server from Internet:
2. Query the current setting:

A cmd save followed by a power cycle is required for this command to take effect.

---

See also: modbusctm130, modbusport

mode a b c

Sets the required functionality of the serial ports.

a = The function of ttyAM0 (Primary DB9) (port 1)
b = The function of ttyAM1 (Secondary DB9) (port 2)
c = The function of ttyAM3 (RS485) (port 3)

Note that ttyAM2 is used for STM communication.

Mode 2 would be serial console.

Mode	Serial Port Function
1	None
2	Console
3	PPP
4	PAD host interface
6	MODBUS host interface
9	Magnetic Card Reader interface
10	WPAN Gateway
12	Chlorobyte Spreader Controller interface
13	external GPS receiver
15	Epomaster Spreader Controller interface
17	Garmin mode - client/server
18	Garmin mode - client only
19	Garmin mode - server only
20	WPAN PAD client loopback
21	Diagnostic passthrough
22	Auxiliary device support

For all mode settings except n = 1 or 2, a cmd save and a power cycle are required before the mode takes effect.

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

mode = 3 – type EXIT, type cmd port n bbbb (where n is the port number and bbbb is the current baud rate)

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

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

Examples:

1. Query the currently configured serial port functionality
2. Set primary serial port to use PAD

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

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:

modemid <string>

Assigns a user configurable ID to the modem containing up to 15 alphanumeric characters.

If no ID is given then the modem’s 11-digit decimal ESN (CDMA/EV-DO devices only) or 15-digit decimal IMEI (GSM/GPRS/HSPA devices only) will be used if available.
If less than 15 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.

modemmode n

Configures the modem for "half bridge mode"

This command is used to provide the connected device, such as a laptop the same IP address that is assigned to the modem.
This command is useful for application software that requires a specific IP address to operate properly.

n = 0 modem mode off (default)
n = 1 modem mode on

The current modem mode can be queried by entering modemmode without parameters.

For modemmode to take effect, a cmd save and a power cycle is required.

Notes (all versions):

• In modem mode, remote web interface, remote ssh/telnet on the modem are not available.
  
• This feature should not be used with other modem features.

Notes (applicable to OpenCTM firmware only):

• On the CTM-200, this feature is only supported on the LAN0 Ethernet port.
• For a static IP configuration, the client computer's Ethernet settings must be configured to use the WAN IP address, Gateway IP address, and DNS addresses of the phone card/module. If the modem has an active wireless connection, obtain these addresses from output displayed by using cmd syslog.
• For a dynamic IP configuration, the modem must also be configured using modemmodedhcp and clientmac commands in addition to using cmd modemmode.
• For modems configured in half bridge mode and using later model Sierra Wireless data devices that support A-GPS (USB598, USB597), A-GPS support is not available and must be disabled. Refer to agpspde for details on disabling the A-GPS feature.

Notes (applicable to Snapgear firmware only):

• This feature also requires a phone card/module that is configured to acquire a static IP address from the wireless carrier.
• modemmode does not support WAN IP addresses that have either a xxx.xxx.xxx.0 or xxx.xxx.xxx.255 as part of their IP address
• On the connected device, a DHCP release, a DHCP renew, and a power cycle may need to be performed for it to acquire the modem's IP address.

Examples:
cmd modemmode 1 enable modem mode
cmd modemmode queries the current modem mode setting

---

See also: agpspde, clientmac, modemmodedhcp

modemmodedhcp n

Configures the modem to use DHCP when configured for "half bridge mode"
DHCP with modem mode should only be enabled when the modem does not have a static IP address from the wireless carrier.

n = 0 modem mode will not use DHCP (default)
n = 1 modem mode will use DHCP

The current modem mode DHCP setting can be queried by entering modemmodedhcp without parameters.

For modemmodedhcp to take effect, a cmd save and a power cycle is required.

Note:

• If modemmodedhcp is enabled, the client computer mac address must also be configured using cmd clientmac
• The client computer must be configured with the following Ethernet settings:
  • DHCP to obtain an IP address automatically
  • Manually specified DNS server addresses. If the modem has an active wireless connection, obtain these addresses from output displayed by using cmd syslog

Examples:
cmd modemmodedhcp 1 use DHCP with modem mode
cmd modemmodedhcp queries the current modem mode DHCP setting

---

See also: clientmac, modemmode

msgredirect add xxx.xxx.xxx.xxx yyyyy

Add a redirect target used by the message redirector. x

xx.xxx.xxx.xxx = 0.0.0.0 to 255.255.255.255 redirect target IP address in decimal
yyyyy = 0 to 65535 redirect target port number in decimal

Examples:

1. Add a single redirect target with the specified IP and port:
   cmd msgredirect add 175.181.206.21 18357
   OK
   
   
2. Add a redirect target to broadcast incoming messages to UDP port 10443 on the entire LAN0 local subnet:
   cmd msgredirect add 192.168.1.255 10443

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

See also: msgredirect del, msgredirect enable, msgredirect list, msgredirect port, msgredirect remip

msgredirect del xxx.xxx.xxx.xxx yyyyy

Delete a redirect target used by the message redirector.

xxx.xxx.xxx.xxx = 0.0.0.0 to 255.255.255.255 redirect target IP address in decimal
yyyyy = 0 to 65535 redirect target port number in decimal

Example:

1. Delete a redirect target to a single target with the specified IP and port:
   cmd msgredirect del 175.181.206.21 18357
   OK

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

See also: msgredirect add, msgredirect enable, msgredirect list, msgredirect port, msgredirect remip

msgredirect enable n

Enables/disables the message redirector on the CTM-200.

n = 0 disable the message redirector (default)
n = 1 enable the message redirector

The message redirector redirects incoming UDP packets from a server to another server/remote IP address or to local devices connected to LAN1 or LAN0 of the CTM-200. Messages received by the CTM-200 will be redirected either via WWAN or LAN. For local redirection the IP address of the redirected messages will be the LAN IP address of the CTM-200, i.e. 192.168.1.1

Example:

1. Enable the message redirector
   cmd msgredirect enable 1
   OK

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

See also: msgredirect add, msgredirect del, msgredirect list, msgredirect port, msgredirect remip

msgredirect list

Display a list of redirect targets configured for the message redirector.

Example:

1. List currently configured redirect targets:
   / # cmd msgredirect list
   cmd msgredirect add 175.181.206.21 18357
   OK

See also: msgredirect add, msgredirect del, msgredirect enable, msgredirect port, msgredirect remip

msgredirect port xxxxx

Configure listening port used by the message redirector. Packets arriving on this UDP port will be redirected to configured redirect targets when the message redirector is enabled.

xxxxx = 0 to 65535 message redirector listening port number in decimal

Example:

1. Configure message redirector listening UDP port:
   cmd msgredirect port 18357
   OK

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

See also: msgredirect add, msgredirect del, msgredirect enable, msgredirect list, msgredirect remip

msgredirect remip xxx.xxx.xxx.xxx

Restrict the message redirector to redirect incoming messages originating from a specific remote source IP address.

xxx.xxx.xxx.xxx = 0.0.0.0 to 255.255.255.255 remote source IP address in decimal (default: 0.0.0.0, which does not restrict incoming messages based on remote source IP)

Examples:

1. Redirect incoming messages from the remote source IP address 1.2.3.4 only:
   cmd msgredirect remip 1.2.3.4
   OK
   
   
2. Redirect incoming messages from any remote source IP address:
   cmd msgredirect remip 0.0.0.0
   OK

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

See also: msgredirect add, msgredirect del, msgredirect enable, msgredirect list, msgredirect port

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 CTM-200 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 CTM-200 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.

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

---

See also: ping

networktime n

Set priority of cellular network time as an external system time synchronization source.

n = 0 Disabled
n = 1-3 Priority relative to other external system time synchronization sources with 1 = highest (default: 2)

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

Example:
1. Set cellular network time as highest priority relative to other external time synchronization sources:

---

See also: gpstime, ntpserver, ntptime, timesync

nmeamode n

Sets the NMEA 0183 version that applies to the GPS message format for GPGLL and GPRMC sentences. NMEA 0183 v3.0 standard supports an additional field for the Mode Indicator.

n = 0 use NMEA 0183 v2.0 messages (default)
n = 1 use NMEA 0183 v3.0 messages

Examples:
1. Enable NMEA 0183 v3.0 message format
2. Query current NMEA 0183 version

ntpserver url

Set the network time protocol (NTP) server used by the CTM-200's built-in NTP client for external system time synchronization. Requires a non-zero priority for ntptime and a modem to be configured in a mode other than manual connection mode (not in cmd mode 1).

url = URL/IP of the NTP server (default: 0.openwrt.pool.ntp.org)

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

Example:
1. Use an alternate NTP server:

---

See also: gpstime, mode, networktime, ntptime, timesync

ntptime n

Set priority of the built-in network time protocol (NTP) client as an external system time synchronization source. Requires a valid NTP server URL/IP to be configured using ntpserver and a CTM-200 to be configured in a mode other than manual connection mode (not in cmd mode 1).

n = 0 Disabled
n = 1-3 Priority relative to other external system time synchronization sources with 1 = highest (default: 3)

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

Example:
1. Set NTP time as highest priority relative to other external time synchronization sources:

---

See also: gpstime, mode, networktime, ntpserver, timesync

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
t = t or T timeout disabled, transition is enabled
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 CTM-200 Parameters 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 CTM-200 Parameters 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
   
   
7. Triggers whenever p5 changes between p5 == 1 to p5 != 1
   cmd obdcond 3 2 t 0 'p5=1'

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

---

See also: CTM-200 Parameters, obdreport, pobda-pobdd

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

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 CTM-200 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.

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

---

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

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

2. Query the current OBDII transmitter protocol

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

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

2. Reset the GPS odometer value to 0
3. Set the GPS odometer to 100000 km
4. Query the current GPS odometer value in km

---

See also: ctm15x

orientation n

Set device mounting orientation within the vehicle when using the accelerometer.

n = 0 Not specified (default)
n = 1 to 24 mounting code

The following table defines mapping between device orientation and vectors used

Orientation Code	Description	Vector for hard acceleration	Vector for hard turning
1	LEDs pointing up and located towards the front of the vehicle	Y	X
2	LEDs pointing up and located towards the passenger side	-X	Y
3	LEDs pointing up and located towards the rear of the vehicle	-Y	-X
4	LEDs pointing up and located towards the driver side	X	-Y
5	LEDs pointing down and located towards the front of the vehicle	Y	-X
6	LEDs pointing down and located towards the passenger side	X	Y
7	LEDs pointing down and located towards the rear of the vehicle	-Y	X
8	LEDs pointing down and located towards the driver side	-X	-Y
9	GPIO connector pointing up and located towards the front of the vehicle	Y	-Z
10	GPIO connector pointing up and located towards the passenger side	Z	Y
11	GPIO connector pointing up and located towards the rear of the vehicle	-Y	Z
12	GPIO connector pointing up and located towards the driver side	-Z	-Y
13	GPIO connector pointing down and located towards the front of the vehicle	Y	Z
14	GPIO connector pointing down and located towards the passenger side	-Z	Y
15	GPIO connector pointing down and located towards the rear of the vehicle	-Y	-Z
16	GPIO connector pointing down and located towards the driver side	Z	-Y
17	Standing on a short edge away from GPIO connector which is located towards the front of the vehicle	X	Z
18	Standing on a short edge away from GPIO connector which is located towards the passenger side	-Z	X
19	Standing on a short edge away from GPIO connector which is located towards the rear of the vehicle	-X	-Z
20	Standing on a short edge away from GPIO connector which is located towards the driver side	Z	-X
21	Standing on a short edge closer to GPIO connector which is located towards the front of the vehicle	X	-Z
22	Standing on a short edge closer to GPIO connector which is located towards the passenger side	Z	X
23	Standing on a short edge closer to GPIO connector which is located towards the rear of the vehicle	-X	Z
24	Standing on a short edge closer to GPIO connector which is located towards the driver side	-Z	-X

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

See also: accelcond, accelreport, accelsensor

otasp

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

The CTM-200 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

pad clientport xxxxx

Sets the default client PAD port number for use with dialup emulation via UDP mode (cmd pad mode 6) or dialup emulation via TCP mode (cmd padmode 7). Default is 5006. pad clientport is valid for only cmd pad mode 6 or cmd pad mode 7 when the dial command ATDT is issued by an external serial device to initiate an outgoing connection.

xxxxx = 0 to 65535 dialup emulation PAD client port number

The current dialup emulation PAD client port number can be queried by entering the pad clientport command without parameters.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1.Set the dialup emulation PAD client port to 5006
2. Query the existing dialup emulation PAD client port

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

---

See also: pad echo, pad esc, pad esct, pad fwdc, pad fwdl, pad fwdt, pad ip, pad mode, pad pfc, pad port, pad reset, pad svct

pad echo n

Sets the PAD echo mode – if echo is enabled then all data sent to the CTM-200 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 pad echo command without parameters.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

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

2. Query the current PAD echo setting

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

---

See also: pad clientport, pad esc, pad esct, pad fwdc, pad fwdl, pad fwdt, pad ip, pad mode, pad pfc, pad port, pad reset, pad svct

pad esc <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 (pad esct) before entering data
Enter only the escape sequence (do not enter any other characters including <CR> or <LF>)
If PAD forwarding time (pad fwdt) is set there will be a delay until the escape characters are forwarded.
The guard time (pad esct) must also be honored, to allow the CTM-200 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.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. Set the PAD escape sequence to ASCII string 12345

2. Query the current PAD escape string

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

---

See also: pad echo, pad esct, pad fwdc, pad fwdl, pad fwdt, pad ip, pad mode, pad pfc, pad port, pad reset, pad svct

pad esct 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.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. Set the PAD escape guard time to 4 seconds

2. Query the current PAD escape guard time

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

---

See also: pad clientport, pad echo, pad esc, pad fwdc, pad fwdl, pad fwdt, pad ip, pad mode, pad pfc, pad port, pad reset, pad svct

pad fwdc x r

Sets the PAD forwarding character and to remove the forwarding character before forwarding the packet (optional). Default forwarding character = 13 (ASCII <enter>), default forwarding character removal disabled.

x = 0 padfwdt or padfwdl will invoke sending the packet
x = 1 to 255 PAD forwarding character representing an ASCII character.
r = 0 Do not remove the forwarding character before forwarding the packet (default)
r = 1 Remove the forwarding character before forwarding the packet

If the r parameter is omitted, it is considered to be 0. The current PAD forwarding character can be queried by using the pad fwdc command without parameters

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. sets the PAD forwarding character to ASCII <space> and do not remove the forwarding character before forwarding the packet

2. sets the PAD forwarding character to ASCII <space> and remove the forwarding character before forwarding the packet

3. Query the current PAD forwarding character

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

---

See also: pad clientport, pad echo, pad esc, pad esct, pad fwdl, pad fwdt, pad ip, pad mode, pad pfc, pad port, pad reset, pad svct

pad fwdl 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 pad fwdl command without parameters.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. Configure the received RS232 data to be sent in packets of 10 characters each
2. Query the current PAD forwarding length setting

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

---

See also: pad clientport, pad echo, pad esc, pad esct, pad fwdc, pad fwdl, pad fwdt, pad ip, pad mode, pad pfc, pad port, pad reset, pad svct

pad fwdt 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 pad fwdt command without parameters.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. Set the PAD forwarding time to 2 seconds
2. Query the current PAD forwarding time

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

---

See also: pad clientport, pad echo, pad esc, pad esct, pad fwdc, pad fwdl, pad ip, pad mode, pad pfc, pad port, pad reset, pad svct

pad ip 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 CTM-200 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.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. Set the PAD IP address to 192.168.1.1

2. Query the current PAD IP address

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

---

See also: pad clientport, pad echo, pad esc, pad esct, pad fwdc, pad fwdl, pad fwdt, pad mode, pad pfc, pad port, pad reset, pad svct

pad mode x

Sets the PAD mode.

x = 0 start up UDP PAD mode. The CTM-200 will revert to server mode once the connection is closed. (default)
x = 1 start up TCP PAD mode. The CTM-200 will revert to server mode once the connection is closed.
x = 2 start up UDP PAD client mode - one session. The CTM-200 will revert to command mode once the connection is closed.
x = 3 start up TCP PAD client mode - one session. The CTM-200 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
x = 6 start up Dialup Emulation over UDP mode
x = 7 start up Dialup Emulation over TCP mode

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

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

If pad ip 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), pad ip must be different than 0.0.0.0. Note that for dialup emulation modes (6 and 7), pad clientport must be set.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. Set to TCP PAD mode

2. Query the current PAD mode

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

---

See also: pad clientport, pad echo, pad esc, pad esct, pad fwdc, pad fwdl, pad fwdt, pad ip, pad pfc, pad port, pad reset, pad svct

pad pfc x

Sets the PAD postfix character that is added at the end of each packet. Default = none (disabled)

x = none Disabled. No character is added to the end of a PAD packet.
x = 1 to 255 PAD forwarding character representing an ASCII character.

The current PAD forwarding character can be queried by using the pad pfc command without parameters.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. Set the PAD postfix character to ASCII <LF>

2. Query the current PAD postfix character

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

---

See also: pad clientport, pad echo, pad esc, pad esct, pad fwdc, pad fwdl, pad fwdt, pad ip, pad mode, pad pfc, pad port, pad reset, pad svct

pad port xxxxx

Sets the remote PAD port number.
This is the listening port if the CTM-200 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 pad port command without parameters.

Note: If the CTM-200 is currently in PAD mode and any other LAN or firewall configuration commands are set after issuing the pad port command, then both a cmd save and a power cycle are required to resume proper PAD operation.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1.Set the PAD port to 5005
2. Query the existing PAD port

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

---

See also: pad clientport, pad echo, pad esc, pad esct, pad fwdc, pad fwdl, pad fwdt, pad ip, pad mode, pad pfc, pad reset, pad svct

pad reset

Resets the PAD connection.
The actions taken by pad reset are to drop the PAD connection and to return the CTM-200 to server mode.
These actions are equivalent to those that occur when the pad svct timer expires.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. Reset the PAD port

---

See also: pad clentport, pad echo, pad esc, pad esct, pad fwdc, pad fwdl, pad fwdt, pad ip, pad mode, pad pfc, pad port, pad svct

pad secure

Secure access to the CTM-200's PAD server from the Internet.
If enabled, it will not be possible to remotely access the PAD server via the port specified in pad port and using the current IP address allocated to the CTM-200 by the network.
This is to support applications where the servers may be accessed through SSH tunneling.

n = 0 allow direct access to PAD server from Internet (default)
n = 1 secure - do not allow direct access to PAD server from Internet

The current status of the PAD secure access setting can be queried by using the pad secure command without parameters.

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. Set the CTM-200 to secure access to PAD server from Internet:
2. Query the current setting:

A cmd save followed by a power cycle is required for this command to take effect.

---

See also: pad mode, pad port

pad svct 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 CTM-200 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 pad svct command without parameters

On CTM devices that support multiple serial ports a second PAD session can be initiated by cmd pad2 [command].
The mode command controls the function of the serial port(s). Note: 2 or 3rd serial port is not available on all models of the CTM-200.

pad	serial port 1	serial port 2	serial port 3
pad	yes	yes	yes
pad2	no	tes	yes

Examples:

1. Configure the CTM-200 to revert to server mode after 10 seconds of data inactivity

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

3. Query the current padsvct settings

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

---

See also: pad clientport, pad echo, pad esc, pad esct, pad fwdc, pad fwdl, pad fwdt, pad ip, pad mode, pad pfc, pad port, pad reset

panicreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

This command will set the report(s) to be used for pendant triggered panic reports (PANIC and MPANIC only)

Up to 8 reports can be assigned to the panicreport.

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

panicreport requires the CTM-200 to be listening for traffic from the WPAN Gateway, this requires cmd mode 10 to be configured.

The CTM-200 must be configured using the commands wpanadddev and wpanacktype and wpanpanid for panicreport to function properly.

Note: panicreport does not support server ACK mode and report type 8 and 9

Example: use report 1 for pendant panic triggered reports

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

---

A Pendant panic report is triggered by a panic 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 panic message payload (PANIC or MPANIC)
CHKSUM - NMEA message checksum

Examples:
$PPEN,0013A200402CB498,17,PANIC*07
$PPEN,0013A2004000DBA9,16,MPANIC*33

---

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

panicreportack t

This command will set the CTM-200 to wait for a Pendant panic triggered report (PANIC or MPANIC message only) and send the corresponding acknowledgment message.

t = 0 disables panicreportack (default)
t = 1 to 65535 time period, in seconds, to wait for the next PANIC or MPANIC message from a pendant and send it an ACK

For panicreportack to function properly, the CTM-200 must be configured with wpanacktype set to server type acknowledgment and with panicreport. When panicreportack is set, panicreport will be disabled to stop triggering the script. This command is meant to be used with custom report triggered scripts via reportscripts and is always volatile.

When panicreportack is entered without parameters, the command returns the configured time period and the elapsed time, in seconds, since panicreportack was set.

Examples: 1. Wait for 60 seconds for a PANIC or MPANIC message and send a pendant an ACK if received
2. Query the time period set for waiting for a PANIC or MPANIC message to ACK, and the current time elapsed since panicreportack was set

---

See also: mode, panicreport, reportscripts, wpanacktype

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 CTM-200 to be listening for traffic from the WPAN Gateway; this requires cmd mode 10 to be configured.

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

Example: use report 1 for pendant triggered reports

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

pin n

Sets the 4-digit PIN code to lock the SIM card used with cell devices. This command is only applicable to EDGE/GSM/HSPA devices. A 4-digit PIN code is required outside of North America for EDGE/GSM/HSPA device activation.

n = 0 clear PIN code
n = 0001 to 9999 set 4-digit PIN code to lock SIM card
By default a PIN code is not set. The current PIN code can be queried by using the command without parameters.

Examples:
cmd pin 1234 sets the PIN code to 1234
cmd pin returns the current PIN code

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

ping n [iii.iii.iii.iii or <website name>]

Configures the CTM-200 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

2. ping 66.102.7.147 every 15 seconds

3. Disable ping

4. Queries the CTM-200’s ping setting

---

See also: netwd

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 CTM-200 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 n r d p s f

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

n = 1 configure Primary DB9 port
n = 2 configure Secondary DB9 port
n = 3 configure RS485 port

r = 1200 1200 Baud
r = 2400 2400 Baud
r = 4800 4800 Baud
r = 9600 9600 Baud
r = 19200 19200 Baud
r = 38400 38400 Baud
r = 57600 57600 Baud
r = 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 1 115200 8 n 1 2 configure primary serial port with baud rate=115200bps, 8 data bits, no parity, 1 stop bit and hardware flow control

cmd port returns the current port configuration settings

Note 1: 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.

Note 2: If the baud rate of the serial port is changed from the serial console using the port command, and the baud rate of the host application is changed to match the new configuration after implementing this command, then the serial console should still be able to accept commands. This functionality is only available if the connection mode is mode = 1 or mode = 2 before issuing port.

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

ppp

Provides the connected device a PPP connection through the serial port.
After the CTM-200 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 CTM-200. Use #777 as the dial string/phone number for the serial PPP connection.
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.

When the CTM-200 is configured for PPP mode, the IP addresses used in the serial PPP connection will use the same subnet as the CTM-200's Ethernet LAN IP, after configuring using cmd lanip, cmd apply, cmd save, and a power cycle. For example, if the CTM-200 was configured with a LAN IP of 192.168.6.1, the serial PPP connection will use 192.168.6.200 and 192.168.6.202 as the IP addresses for the serial PPP client and the CTM-200, respectively.

When using cmd mode 3 or cmd ppp, the CTM-200's DHCP server IP pool, configured using landhcp, must not include the range x.x.x.200 - x.x.x.202.

Example:

1. Start the CTM-200 into PPP mode

---

See also: landhcp, lanip, mode

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 CTM-200.

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 apply followed by a cmd save are required for this command to take effect.

---

See also: mip, user

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 [n] [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

This command sets the report(s) to be used for power-up triggered reports.
Up to 8 power up triggers can be configured, each supporting up to 8 reports.

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

Example:

1. Configure reports #2 and #999 for power-up trigger condition #1.
   cmd pupreport 1 2 999
   OK

Note: When sending power up reports remotely, power up reports will be stored on the CTM-200 until a signal is obtained. For the stored reports to be sent, the following conditions must be met:

• the CTM-200 must obtain a signal
• the same report number(s) used in cmd pupreport must be used in another command (ie obdreport, vccreport)
• the 'other' command (ie. obdreport, vccreport) must be sending live data A cmd save is required for this command to take effect.
  

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

---

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

pwr accelt n

Configure the CTM-200's wake up condition for acceleration based on internal accelerometer.

a = acceleration threshold in mg (0 - 8000)
Default: cmd pwr accelt 0 (Disabled)

Example:
cmd pwr accelt 1500 will configure to wake the gateway when there is acceleration of 1.5g

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