CTM-200 Command Reference

Browse the command reference section below to find common commands for the Chameleon CTM-200 gateway.
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A
accelcond (set acceleration trigger condition) UPDATED
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 (set acceleration report)
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 (set sensor used for triggering longitudinal acceleration)
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
agpspde (configure Assisted GPS (A-GPS) using cellular device location based features)
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:
cmd agpspde 124.105.114.86 5412 0 3 0 2

2. Disable A-GPS feature:
cmd agpspde 0.0.0.0 0 0 1 0 1

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

apn (set carrier access-point name)
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
cmd apn
cmd apn internet.com
OK

2. Set APN
cmd apn newapn.com
OK
apply (apply network / firewall and other system configuration changes)
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
cmd lanip 192.168.2.0
cmd lannetmask 255.255.255.0
cmd apply
OK

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

autoconnect (auto network connection)
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:
/ # cmd autoconnect 1
OK

2. Query the current setting:
/ # cmd autoconnect
cmd autoconnect 0
OK
autopevent (turns on $PEVENT message reporting of trigger/event description)
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 (sets the reports to be used for mode 22 (auxillary interface)) NEW
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 (sets the termination characters for mode 22 (auxillary interface)) NEW
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)
B
boomreport (set the boom tracker report)
boomreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

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

boomreport requires the 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.
cmd boomreport 2
OK
cmd boomreport
cmd boomreport 2 0 0 0 0 0 0 0

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

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

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

C
can apply (set STM with values set in cmd engparam and can prot)
cmd can apply

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

Example:
cmd can engparam ffffe
cmd can prot 1
cmd can appy

See also: can engparam, can prot
can engparam (set which parameters are to be queried/reported )
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
can prot (enable/disable internal CAN and sets the protocol)
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 (erase approved ID list from CTM-200)
cardlistclear

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

Example:

cmd cardlistclear
OK

See also: cardlistload, cardlistsave

cardlistload (load approved ID list for swipe card interface)
cardlistload file-name url username passwd

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

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

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

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

cardlistsave (save approved ID list to non-volatile RAM)
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:

cmd cardlistsave
OK

See also: cardlistclear, cardlistload

cardlockload (load a swipe card lock script to the CTM-200)
cardlockload lock-script-file-name url username passwd

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

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

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

cardunlockload (load a swipe card unlock script to the CTM-200)
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 (set client mac address for modem mode with DHCP)
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 (configures the CTM-200 for automatic configuration capability)
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:

cmd mode 2
cmd gpsrep 1 0 3
cmd gpscond 1 1 30
cmd gpsremip 1 123.123.123.123
cmd gpsremport 1 5005
......
....
..
  • script-name the name of the configuration script to fetch/run
  • url 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 (command for configuration of protected values)
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

D
data (query count of data transmitted/received over wireless link)
data [0]

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

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

0 Set to 0 to reset

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

Examples:

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

2. Query the current link data count
cmd data
TX: 4 MB
RX: 2 MB
Total: 6 MB
OK

See also: ctm15x, datacond

datacond (wireless link total data count trigger condition)
datacond x

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

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

The default configuration upon cmd factory is cmd datacond 10.

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

2. Query the current link data trigger condition
cmd datacond
cmd datacond 10
OK

See also: data, datareport

datareport (set the link data report(s))
datareport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

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

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

Examples:

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

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

3. Disable link data count triggered reports
cmd datareport 0
OK
cmd datareport
cmd datareport 0 0 0 0 0 0 0 0
OK

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

device cell (configure cell device)
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:
cmd device cell AC306
cmd save
cmd pwrmode 2

2. Query the currently configured wireless device:
cmd device cell
cmd device cell AC598
OK

See also: apn, device_wifi

device cellnetwork (configure cell device to use a specified network type) NEW
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 (define device priority for Cell + Wi-Fi client configurations)
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 (configure Wi-Fi device)
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:
cmd device wifi SR71
cmd save
cmd pwrmode 2

2. Query the currently configured wireless device:
cmd device wifi
cmd device wifi SR71
OK

See also: apn, device_cell, wlanenable

dir (set NAM phone number, MDN, MIN)
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
cmd dir 1234567890 0987654321
OK

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

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

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

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

dmz (demilitarized zone (DMZ) feature)
dmz iii.iii.iii.iii

This command is used to set up the demilitarized zone (DMZ) feature of the CTM-200 that will let all packets go through the device's firewall to a selected computer. Note that port forwarding rules configured via cmd firewall are honored first and if no match is found then traffic is forwarded to the DMZ device.

If any of the CTM-200's remote configuration features are enabled (cmd rmttelnet, cmd rmtssh (R1.3.X and above), or cmd rmtweb), the DMZ feature will forward the enabled remote access (Telnet, SSH, or HTTP) traffic to the CTM-200 and forward all other traffic to the DMZ device.

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 local IP address of device that all packets are forwarded to (default: 0.0.0.0, which disables the DMZ feature).

Examples:

1. Set up all traffic to be forwarded to a device at 192.168.1.20, except remote Web configuration (TCP port 80) traffic and remote SSH (TCP port 22) traffic that are forwarded to the CTM-200.
cmd rmtweb 1
OK
cmd rmtssh 1
OK
cmd dmz 192.168.1.20
OK

2. Set up all traffic to be forwarded to a device at 192.168.1.20 including remote Telnet (TCP port 23) traffic, remote SSH (TCP port 22) traffic, and remote Web configuration (TCP port 80) traffic.
cmd dmz 192.168.1.20
OK

3. Disable the DMZ feature
cmd dmz 0.0.0.0
OK

4. Query the current DMZ configuration
cmd dmz
cmd dmz 192.168.1.20
OK

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

dnscheck (check valid DNS)
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.

cmd dnscheck 0
OK

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

dout (set/query digital outputs) UPDATED
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 (dynamic DNS)
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
cmd dyndns cypressdemo cypress cypresscamera2.dyndns.org
OK

2. Disable DYNDNS updates
cmd dyndns 0 0 0.0.0.0
OK

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

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

E
emailsrv (set email server)
emailsrv a.a.a.a

This command is used to set the IP address of the SMTP email server that will be used by the 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
cmd emailsrv 100.120.10.10
OK

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

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

enghours (calculate engine hours)
enghours n

Since total engine hours data is not available through standard OBD2 interface, Total engine hours must be calculated using other methods.
When a 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
cmd ctm15x
OK
cmd enghours 2501
OK

See also: ctm15x

enghrmode (used to configure enghours command)
enghrmode n

cmd enghrmode n
Where n:

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

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

esn (electronic serial number)
esn

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

Example:

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

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

ethernet (Enable/Disable Ethernet services)
ethernet x

This command is used to enable or disable the Ethernet services of the 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
cmd ctm15x
OK
cmd ethernet 0
OK

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

event dump (dump the event log file)
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:
Fri Sep 30 04:06:22 UTC 2011 [53]:POWER_UP
Fri Sep 30 04:06:27 UTC 2011 [58]:IGN_ON
Fri Sep 30 04:07:19 UTC 2011 [114]:CELL_ONLINE after 1 mins 1 secs offline
Fri Sep 30 05:05:24 UTC 2011 [3600]:HEALTH
Fri Sep 30 06:05:39 UTC 2011 [7200]:HEALTH
Fri Sep 30 07:05:39 UTC 2011 [10800]:HEALTH
Fri Sep 30 08:05:40 UTC 2011 [14400]:HEALTH
Fri Sep 30 09:05:40 UTC 2011 [18000]:HEALTH
Fri Sep 30 10:05:41 UTC 2011 [21600]:HEALTH
Fri Sep 30 11:05:42 UTC 2011 [25200]:HEALTH
Fri Sep 30 12:05:40 UTC 2011 [28800]:HEALTH
Fri Sep 30 13:05:44 UTC 2011 [32400]:HEALTH
Fri Sep 30 14:05:44 UTC 2011 [36000]:HEALTH

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 (interval between HEALTH status events)
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:
CTM200 : 356215040095550
[152038] Wed Sep 28 17:28:24 UTC 2011
HEALTH uptime 1 day, 18:13,
online 266 min 30 secs
event logclear (clear the event log file)
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 (set the event reporting level)
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 (set minimum time interval before reporting CELL_ONLINE event)
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 report (set which type of report to use for event reports) UPDATED

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.
F
firewall (firewall - port forwarding) UPDATED
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 serial console prompt)
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.
// only from the SSH/Telnet session
cmd freeconsole
OK

cmd pad
or
cmd modbusgw
OK

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

friends (set firewall friends list)
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
cmd friends 1 1.2.3.4 255.255.255.255
OK

2. Allow only incoming requests from the 1.2.3.x subnet to access the CTM-200
cmd friends 2 1.2.3.4 255.255.255.0
OK

3. Allow only incoming requests from the 1.2.3.x subnet to access the CTM-200. This is equivalent to Example #2 above.
cmd friends 2 1.2.3.0 255.255.255.0
OK

4. Disable the friends list entry and allow all IP addresses to access the CTM-200 (default)
cmd friends 1 0.0.0.0 0.0.0.0
OK

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

ftp server (enable/disable ftp server)
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 (configure GPIO for fuel calculation)
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 (set the fuel mode)
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 value)
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 (set the fuel rate distance for fuel rate calculation)
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)
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 (reset the fuel rate)
fuel rate reset

Resets the fuel rate value to 0.

Examples:
Resets the fuel rate.
cmd fuel rate reset
OK
fuel reset (reset the total fuel value)
fuel reset

Resets the fuel value to 0.

Example:
Resets the idle time.
cmd ctm15x
OK
cmd fuel reset
OK

A cmd save followed by a powercycle (cmd pwr mode 2) is required for this command to take effect.
G
geort acount (view Geo-Route allowed zone violation counter)
cmd geort acount

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

Example:
cmd geort acount

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
geort c2bn (convert Geo-Route route lists into CTM-200 format) UPDATED
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:
radius lon1 lat1 lon2 lat2 state
...
ex:
500 -122.991268 49.254447 -122.983114 49.245875 1
300 -122.983114 49.245875 -123.019163 49.258341 1
500 -123.019163 49.258341 -123.058302 49.250161 1

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
geort delete (delete (deactivate) Geo-Routes)
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:
/ # cmd geort delete all

To disable route 3:
/ # cmd geort delete 3

See also: geort acount, geort c2bin, geort enable, geort list, geort period, geort rcount, geort report, geort th, geort update
geort enable (enable/disable Geo-Route)
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
cmd geort enable 1

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
geort list (view routes being checked by Geo-Route)
cmd geort list

Display Geo-Routes being monitored.

Example:
/ # cmd geort list
1 1
2 1
3 1
4 0
5 0
6 0
7 0
8 0
9 0
10 0
11 0
12 0
13 0
14 0
15 0
16 0
17 0
18 0
19 0
20 0
21 0
22 0
23 0
24 0
25 0
26 0
27 0
28 0
29 1
30 0
31 0
32 1


See also: geort acount, geort c2bin, geort delete, geort enable, geort period, geort rcount, geort report, geort th, geort update
geort period (set how often Geo-Route checks for violation)
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
cmd geort period 10

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
geort rcount (view Geo-Route restricted zone violation counter)
cmd geort rcount

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

Example:
cmd geort rcount
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
geort report (set reports used for Geo-Route) UPDATED
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
cmd geort period 10
cmd geort report 1 2 999

Example messages:
$PGRT,101111,173834.00,A,AIN,1,49.253613,
-122.997253,000.6,153.0,354155040009270*2A

$PGRT,101111,173514.00,A,AOUT,0,49.253792,
-122.997681,000.5,150.0,354155040009270*6E

$PGRT,101111,173514.00,A,RIN,1,49.253792,
-122.997681,000.5,150.0,354155040009270*35

$PGRT,101111,173834.00,A,ROUT,0,49.253613,
-122.997253,000.6,153.0,354155040009270*71

$PGRT,101111,173554.00,A,ALRMR,1,49.253765,
-122.997597,000.5,148.0,354155040009270*21

$PGRT,101111,173634.00,A,ALRMA,0,49.253696,
-122.997513,000.4,133.0,354155040009270*3A


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
geort th (set Geo-Route violation threshold)
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
  2. cmd geort th 1 3

  3. To set Geo-Route to send an alarm after the vehicle is in a restricted zone for 2 times (checks) in a row
  4. cmd geort th 2 2
Example messages:
$PGRT,101111,173554.00,A,ALRMR,1,49.253765,
-122.997597,000.5,148.0,354155040009270*21

$PGRT,101111,173634.00,A,ALRMA,0,49.253696,
-122.997513,000.4,133.0,354155040009270*3A

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
geort update (add/update (activate) Geo-Routes)
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:
Download all Geo-Route files from ftp:
/ # cmd geort update all 192.168.1.20 kmo kmotest
Downloading Geo-Routes...
Verifying download...
Copying files...
Converting Geo-Routes...
Cleaning up...
Done!

Download specific Geo-Route from /grt directory
/ # cmd geort update 5 ftp://192.168.1.20/grt kmo kmotest
Downloading Geo-Routes...
Verifying download...
Copying files...
Converting Geo-Routes...
Cleaning up...
Done!

Locally:
If located in /tmp/ directory:
/ # cmd geort update 1 localhost
Copying files...
Converting Geo-Routes...
Cleaning up...
Done!

If located in /tmp/t2 directory:
/ # cmd geort update 2 localhost://tmp/t2
Copying files...
Converting Geo-Routes...
Cleaning up...
Done!

If located in /t2 directory:
/ # cmd geort update ALL localhost://t2
Copying files...
Converting Geo-Routes...
Cleaning up...
Done!

See also: geort acount, geort c2bin, geort delete, geort enable, geort list, geort period, geort rcount, geort report, geort th
gopad (enable either 1 or 2 instances of PAD)
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 (GPS report trigger for hard acceleration and deceleration events)
gpsaccel n a d

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

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

Examples:

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

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

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

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

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

Examples:

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

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

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

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

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

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

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

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

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

Examples:

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

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

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

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

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

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

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

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

gpsdata (display status of GPS input devices)
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

root@OpenWrt:~# cmd gpsinput 15
OK
root@OpenWrt:~# cmd gpsdata
GPS INPUT 1, CONNECTED, SELECTED
$GPGGA,212403.00,4915.3923,N,12259.8040,W,1,5,04.5,+00010,M,,M,,0000*55
$GPRMC,212403.00,A,4915.3923,N,12259.8040,W,000.0,180.0,051109,,*22

GPS INPUT 2, NOT CONNECTED
GPS INPUT 3, CONNECTED, NOT SELECTED
$GPGGA,212318.00,4915.3916,N,12259.8031,W,1,6,02.8,+00032,M,,M,,0000*50
$GPRMC,212318.00,A,4915.3916,N,12259.8031,W,000.0,000.0,051109,,*26

GPS INPUT 4, NOT CONNECTED
OK

See also: gpsinput, gpsparam

gpsdelmes (delete GPS message)
gpsdelmes n x

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

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

Examples:

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

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

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

gpsdgps (enable DGPS mode and SBAS) NEW
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 (GPS email address)
gpsemail n <email address>

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

Note that an email server is required – see emailsrv.

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

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

Examples:

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

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

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

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

gpsgga (GPS GGA message)
gpsgga

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

Example:

1. Return a current GPS NMEA format GGA message
cmd gpsgga
$GPGGA,215619.00,4948.7174,N,11928.6175,W,0,5,01.9,++00380,M,,M,,0000*58
OK
gpsinput (GPS input device, internal on board GPS module, external GPS device or cellular based A-GPS)
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:
gpsinput 9

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

gpslocip (GPS local IP address)
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
cmd gpslocip 1 192.168.1.21
OK

2. Query the remote IP address setting of all GPS reports
cmd gpslocip
cmd gpslocip 1 192.168.1.21
cmd gpslocip 2 192.168.1.22
OK

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


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

gpslocport (GPS local port)
gpslocport n xxxxx

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

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

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

Examples:

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

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

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

gpsmes (GPS messages)
gpsmes

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

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

gpsparam (GPS port configuration and priority)
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:

cmd gpsparam 3 2 /dev/ttyUSB0 4800 8 n 1 0 configure the modem USB port for accepting GPS data

cmd gpsparam 3 2 /dev/ttyS0 4800 8 n 1 0 configure the modem external serial port for accepting GPS data

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

gpspos (set fixed GPS position)
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):
cmd gpspos 1 49.256553 -122.996733
OK

2. Disable fixed GPS position mode but preserve the user-defined location:
cmd gpspos 0
OK

3. Disable fixed GPS position mode and clear the user-defined location:
cmd gpspos 0 0 0
OK

See also: gpsinput

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

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

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

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

Examples:

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

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

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

gpsremport (GPS remote port)
gpsremport n xxxxx

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

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

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

Examples:

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

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

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

gpsrep (GPS reporting)
gpsrep n l r s

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

n = 1 to 8 or report 11 GPS report number

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

cmd gpsrep 4 3 3
OK

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

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

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

gpsrmc (GPS RMC message)
gpsrmc

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

Example:

1. Return a current GPS NMEA format RMC message NMEA 0183 v2.0:
cmd nmeamode
cmd nmeamode 0
OK
cmd gpsrmc $GPRMC,215812.00,V,4948.7177,N,11928.6161,W,000.0,000.0,280409,,*38
OK

NMEA 0183 v3.0:
cmd nmeamode
cmd nmeamode 1
OK
cmd gpsrmc $GPRMC,014418.00,A,4915.3868,N,12259.8017,W,000.8,318.0,221210,,,A*4B
OK
gpssms (set destination of GPS SMS report)
gpssms n pppppppppp or <email address>

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

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

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

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

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

Examples:

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

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

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

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

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

gpstime (set priority of valid GPS as system time synchronization source)
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:
cmd gpstime 3
OK

See also: networktime, ntpserver, ntptime, timesync

H
  • No commands
I
idle cond (set the idle condition)
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 (set the idle mode)
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)
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 (set report for idle condition) NEW
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 (reset the idle time)
idle reset

Resets the idle time to 0.

Examples:
  1. Resets the idle time.
    cmd ctm15x
    OK
    cmd idle reset
    OK
idle time (set the idle time) UPDATED
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 (ignition report trigger conditions)
igncond n a

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

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

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

Examples:

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

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

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

ignreport (set ignition trigger report) UPDATED
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 (query input channels status)
input

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

This is a read only command.

Example:

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

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

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

n = 1 to 6 input channel number

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

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

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

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

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

Note: When configuring insetup with a digital input, the voltage threshold parameter is ignored. The 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
cmd insetup 2 D 0.0 P 1
OK

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

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

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

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

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

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

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

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

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

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

n = 1 to 8 IO report number

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

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

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

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

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

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

Examples:
cmd iocond 1 1 60 sends report #1 every 60 seconds
cmd iocond 2 1 60 1 sends report #2 every 60 seconds if input #1 is in alarm
cmd iocond 3 1 60 1 2 send report #3 every 60 seconds if inputs #1 and #2 are in alarm
cmd iocond 4 2 0 0 0 1 send report #4 whenever the IP address of the 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 (delete IO message)
iodelmes n x

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

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

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

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

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

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

n = 1 to 8 IO report number

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

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

Note that an email server is required – see emailsrv

Examples:

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

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

iolocip (IO local IP address)
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
cmd iolocip 1 192.168.1.21
OK

2. Query the remote IP address setting of all IO reports
cmd iolocip
cmd iolocip 1 192.168.1.21
cmd iolocip 2 192.168.1.22
OK

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


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

iolocport (IO local port)
iolocport n xxxxx

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

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

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

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

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

iomes (IO messages)
iomes

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

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

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

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

n = 1 to 8 IO report number

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

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

Examples:

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

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

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

ioremport (IO remote port)
ioremport n xxxxx

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

n = 1 to 8 IO report number

xxxxx = 0 to 65535 remote port number

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

Examples:

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

cmd ioremport queries the remote port setting of all IO reports

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

iorep (IO reporting)
iorep n l r s

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

n = 1 to 8 IO report number

l = 0 disables the local report (default)
l = 1 asynchronous NMEA or ULCP messages over RS232
l = 2 asynchronous NMEA or ULCP messages with a ULCP header over RS232
l = 3 in-band NMEA or ULCP messages in a UDP Packet over Ethernet
l = 4 in-band NMEA or ULCP messages with a ULCP header and in individual UDP packets over Ethernet
l = 5 in-band NMEA or ULCP messages in a TCP Packet over Ethernet
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 (set destination of IO SMS report)
iosms n pppppppppp or <email address>

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

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

n = 1 to 8 IO report number

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

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

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

Examples:

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

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

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

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

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

ipadr (IP address)
ipadr

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

This is a read only command.

Example:

1. Query the current IP address of the CTM-200
cmd ipadr
96.2.1.161
OK
ipsec (show all IPsec commands)
ipsec

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

Example:

/ # cmd ipsec
cmd ipsec enable
cmd ipsec genconf
cmd ipsec genpolicy
cmd ipsec gensa
cmd ipsec ikedhgroup
cmd ipsec ikeenc
cmd ipsec ikeexchange
cmd ipsec ikehash
cmd ipsec ikeinitial
cmd ipsec ikelifetime
cmd ipsec ikepassive
cmd ipsec natt
cmd ipsec nattkeepalive
cmd ipsec psk
cmd ipsec remgw
cmd ipsec remnet
cmd ipsec restrict
cmd ipsec saauth
cmd ipsec saenc
cmd ipsec salifetime
cmd ipsec sapfsgroup

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 (enable/disable IPsec)
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
/ # cmd ipsec enable 1
OK

2. Query the current setting:
/ # cmd ipsec enable
cmd ipsec enable 0
OK

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


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)
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 (set responder to generate IPsec security policy on new connection)
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
/ # cmd ipsec genpolicy 1
OK

2. Query the current setting:
/ # cmd ipsec genpolicy
cmd ipsec genpolicy 0
OK

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)
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
/ # cmd ipsec gensa
OK

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 (define IPsec IKE phase I Diffie-Hellman group)
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
/ # cmd ipsec ikedhgroup 14
OK

2. Query the current setting:
/ # cmd ipsec ikedhgroup
cmd ipsec ikedhgroup 2
OK

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 (define IPsec IKE phase I encryption algorithm)
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.
/ # cmd ipsec ikeenc des
OK

2. Query the current setting:
/ # cmd ipsec ikeenc
cmd ipsec ikeenc 3des
OK

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 (define IPsec IKE phase I exchange mode)
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:
/ # cmd ipsec ikeexchange aggressive
OK

2. Query the current setting:
/ # cmd ipsec ikeexchange
cmd ipsec ikeexchange main
OK

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 (define IPsec IKE phase I hash algorithm)
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.
/ # cmd ipsec ikehash md5
OK

2. Query the current setting:
/ # cmd ipsec ikehash
cmd ipsec ikehash sha1
OK

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 (define IPsec IKE phase I initial contact setting)
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.
/ # cmd ipsec ikeinitial 0
OK

2. Query the current setting:
/ # cmd ipsec ikeinitial
cmd ipsec ikeinital 1
OK

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 (define IPsec IKE phase I lifetime)
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):
/ # cmd ipsec ikelifetime 7200
OK

2. Query the current setting:
/ # cmd ipsec ikelifetime
cmd ipsec ikelifetime 3600
OK

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 (define IPsec IKE phase I peer role - initiator/responder)
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:
/ # cmd ipsec ikepassive 1
OK

2. Query the current setting:
/ # cmd ipsec ikepassive
cmd ipsec ikepassive 0
OK

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 (enable IPsec NAT traversal)
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:
/ # cmd ipsec natt 1
OK

2. Query the current setting:
/ # cmd ipsec natt
cmd ipsec natt 0
OK

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 (set NATT keepalive interval)
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):
/ # cmd ipsec nattkeepalive 300
OK

2. Query the current setting:
/ # cmd ipsec nattkeepalive
cmd ipsec nattkeepalive 3600
OK

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 (set IPsec pre-shared key)
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:
/ # cmd ipsec psk 1.2.3.4 testPSK1234
OK

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 (define IPsec remote gateway IP address)
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:
/ # cmd ipsec remgw 1.2.3.4
OK

2. Query the current setting:
/ # cmd ipsec remgw
cmd ipsec remgw 1.2.3.4
OK

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 (define IPsec remote subnet(s)) UPDATED
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:
/ # cmd ipsec remnet 1 192.168.2.0 24
OK

2. Delete IPsec remote subnet 1:
/ # cmd ipsec remnet 1 0
OK

3. Query the current setting:
/ # cmd ipsec remnet 1
cmd ipsec remnet 1 192.168.2.0 24
OK

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 (define restrictive access policy) UPDATED
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:
/ # cmd ipsec restrict 1
OK

2. Query the current setting:
/ # cmd ipsec restrict
cmd ipsec restrict 0
OK

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 (define IPsec ISAKMP phase II authentication algorithm)
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.
/ # cmd ipsec saauth md5
OK

2. Query the current setting:
/ # cmd ipsec saauth
cmd ipsec saauth sha1
OK

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 (define IPsec ISAKMP phase II encryption algorithm)
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.
/ # cmd ipsec saenc des
OK

2. Query the current setting:
/ # cmd ipsec saenc
cmd ipsec saenc 3des
OK

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 (define IPsec ISAKMP phase II lifetime)
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):
/ # cmd ipsec salifetime 7200
OK

2. Query the current setting:
/ # cmd ipsec salifetime
cmd ipsec salifetime 3600
OK

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 (define IPsec ISAKMP phase II perfect forward secrecy group)
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
/ # cmd ipsec sapfsgroup 14
OK

2. Query the current setting:
/ # cmd ipsec sapfsgroup
cmd ipsec sapfsgroup 2
OK

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)
ipsec show

Show IPsec configuration.
This is a read only command.

Example:

/ # cmd ipsec show
cmd ipsec enable 1
cmd ipsec genpolicy 0
cmd ipsec ikedhgroup 2
cmd ipsec ikeenc 3des
cmd ipsec ikeexchange main
cmd ipsec ikehash sha1
cmd ipsec ikeinitial 1
cmd ipsec ikelifetime 3600
cmd ipsec ikepassive 0
cmd ipsec natt 0
cmd ipsec nattkeepalive 20
cmd ipsec remgw 1.2.3.4
cmd ipsec remnet 1 192.168.2.0 24
cmd ipsec restrict 0
cmd ipsec saauth hmac_sha1
cmd ipsec saenc 3des
cmd ipsec salifetime 3600
cmd ipsec sapfsgroup 2


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

J
  • No commands
K
  • No commands
L
lanbridge (bridge LAN ports) NEW
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:
cmd lanbridge 1
cmd lanproto 0 static
cmd lanip 0 192.168.1.1
cmd lannetmask 0 255.255.255.0
cmd save
landhcp (LAN DHCP server settings)
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.
cmd landhcp 0 20 15
OK

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.
cmd lanip 1 192.168.10.1
OK
cmd landhcp 1 20 10
OK

3. Query current DHCP range and number of users
cmd landhcp
cmd landhcp 0 20 10
cmd landhcp 1 20 10
OK

See also: lanip, lannetmask, lanrepip

lanfriends (control ethernet access control using MAC addresses) NEW
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 (IP address of CTM-200 on LAN)
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
cmd lanip 1 192.168.10.1
OK

2. Set the LAN IP address of the eth1 port to 192.168.2.1 and netmask to 255.255.0.0
cmd lanip 1 192.168.2.1 255.255.0.0
OK

3. Query the LAN IP address
cmd lanip
cmd lanip 0 192.168.1.1 255.255.255.0
cmd lanip 1 192.168.2.1 255.255.255.0
OK

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 (Netmask of CTM-200 on LAN)
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
cmd lannetmask 1 255.255.0.0
OK

2. Query the LAN netmask of the CTM-200
cmd lannetmask
cmd lannetmask 0 255.255.255.0
cmd lannetmask 1 255.255.255.0
OK

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 (set interface prototype to static or dhcp)
lanproto <type>

Configure LAN interface protocol to use DHCP or a Static IP address.
static | dhcp
lanrepip (LAN IP address for local reporting)
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
cmd lanrepip 192.168.1.21
OK

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

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

M
mbusm add (add MODBUS slave in MODBUS master mode)
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:
# cmd mbusm add
OK
# cmd mbusm add 1 Serial A
OK
# cmd mbusm add 2 192.168.100.100
OK
# cmd mbusm add 3 192.168.100.101
OK
# cmd mbusm add
cmd mbusm add 1 Serial A
cmd mbusm add 2 192.168.100.100
cmd mbusm add 3 192.168.100.101
OK

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 (sets reporting conditions for MODBUS master mode)
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 (shows current MODBUS slave register values for MODBUS master mode)
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:
# cmd modbusmode 3
# cmd mode 6 0 0
# cmd mbusm add 2 192.168.100.100
# cmd mbusm poll 2 4 10 5 1000 1000 0
# cmd save
# cmd pwrmode 2
...REBOOTING...

# cmd mbusm data 2
0004: 000A 000B 000C 000D 000E 000F 0010 0011 0012 0013 <== In Hex Format
10 11 12 13 14 15 16 17 18 19 <== In Decimal Format
OK

0004 ==> the start register address from cmd mbusm poll
000A 000B 000C 000D 000E 000F 0010 0011 0012 0013 ==> the number of registers to be read is 10, register 4 to 13

See also: mbusm add, mbusm cond, mbusm del, mbusm exccond, mbusm excreport, mbusm poll, mbusm report
mbusm del (remove MODBUS slave in MODBUS master mode)
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 (sets condition to trigger MODBUS exception reports for MODBUS master mode )
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 (sets reports to be used for MODBUS exception triggered reports)
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 (sets polling MODBUS slaves while in MODBUS master mode )
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 (sets reports to be used for MODBUS master triggered reports)
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 (mobile IP)
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 (add a MODBUS TCP slave, serial slave or self slave, query MODBUS slave gateway list)
modbusadd

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

Example:
cmd modbusadd displays the MODBUS list


modbusadd id nnn.nnn.nnn.nnn

This command is used when the modem is being used as a MODBUS SLAVE device.
Adds a MODBUS TCP Slave. The listening port for TCP slaves is the port number configured using modbusport.
id = 1 to 247 MODBUS ID
nnn.nnn.nnn.nnn = 1.0.0.0 to 255.255.255.255 MODBUS slave IP address (IP address of MODBUS devices connected to the modem's ethernet port)


modbusadd id Serial m

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

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

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

Note2: For MODBUS RTU configuration to function properly d = 8 must be entered 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:

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

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

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


modbusadd id

Adds MODBUS self slave - only one is permitted.
id = 1 to 247 MODBUS ID

Examples:

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

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

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

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

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

modbusctm130 (enable backward compatibility with CTM-13X MODBUS messages over-the-air)
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 (delete MODBUS entry)
modbusdel n

Deletes an entry or all entries from the MODBUS list.

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

Examples:
cmd modbusdel 1 delete the entry with MODBUS ID 1
cmd modbusdel 0 delete all entries in the MODBUS list

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

modbusgw (manual MODBUS gateway initiation)
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
cmd freeconsole
Killed
OK
cmd modbusgw
OK

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

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

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

This command sets up the MODBUS ID to modem IP for each remote MODBUS slave device (i.e. another 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
cmd modbusidmap 1 123.1.2.3 502
OK

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

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

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

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

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

modbusmode (sets the MODBUS gateway mode)
modbusmode n

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

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

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

Examples:

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

2. Query the currently configured MODBUS gateway mode
cmd modbusmode
cmd modbusmode 1
OK

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


See also: mode

modbusport (sets the MODBUS port number)
modbusport xxxxx

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

xxxxx = 1 to 65535 MODBUS server port number

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

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

Examples:

1.Set the MODBUS port to 12345
cmd modbusport 12345
OK

2. Query the existing MODBUS port
cmd modbusport
cmd modbusport 502
OK

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


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

modbussecure (secure MODBUS for use with SSH tunneling)
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:
/ # cmd modbussecure 1
OK

2. Query the current setting:
/ # cmd modbussecure
cmd modbussecure 0
OK

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


See also: modbusctm130, modbusport

mode (sets connection mode) UPDATED
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
cmd mode
cmd mode 2 0 0

2. Set primary serial port to use PAD
cmd mode 4 0 0

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

modemdevice (configure modem device port)
modemdevice [ /dev/ttyUSBn ]

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

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

Example:

cmd modemdevice /dev/ttyUSB1
OK

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

Assigns a user configurable ID to the modem 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 (enable Modem Mode or Half Bridge mode)
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 (enable DHCP support with Modem Mode)
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 (add a redirect IP address) NEW
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 (delete a redirect IP address) NEW
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 (enable/disable message redirect application) NEW
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 (list redirect entries) NEW
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 (configure message redirect listening port) NEW
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 (restrict incoming redirect messages to a specified remote source IP) NEW
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
N
netwd (network watchdog)
netwd t n

Sets the network watchdog feature.
This feature is used to listen for incoming data traffic to make sure there is network connectivity.
If no data is received within the watchdog timer time out period (t * n), the 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.
cmd netwd 10 6
OK

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

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

2. Query the current netwd configuration
cmd netwd
cmd netwd 10 6
OK

See also: ping

networktime (set priority of cellular network time as system time synchronization source, Sierra Wireless data devices/modules only) UPDATED
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:
cmd networktime 1
OK

See also: gpstime, ntpserver, ntptime, timesync

nmeamode (set NMEA 0183 version for GPGLL and GPRMC sentences)
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
cmd nmeamode 1
OK

2. Query current NMEA 0183 version
cmd nmeamode
cmd nmeamode 0
OK
ntpserver (set URL or IP of NTP server for system time synchronization)
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:
cmd ntpserver 1.openwrt.pool.ntp.org
OK

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

ntptime (set priority of NTP client as system time synchronization source)
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:
cmd ntptime 1
OK

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

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

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

n = 1 to 8 OBD trigger number
b = 0 conditional operator for all following parameters: Off
b = 1 conditional operator for all following parameters: AND
b = 2 conditional operator for all following parameters: OR
t = 0 timeout disabled
t = 1 to 65535 timeout in seconds
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 (Display data obtained from OBDII transmitter)
obddata

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

This command is read-only.

Example:

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

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

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

obdreport requires the 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.
cmd obdreport 1 2
OK

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


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

obdsp (Sets protocol used by OBDII transmitter)
obdsp n

Sets the protocol used by the OBDII transmitter.

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

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

Examples:

1. Set the OBDII transmitter to use the J1939 protocol
cmd obdsp 10
OK

2. Query the current OBDII transmitter protocol
cmd obdsp
cmd obdsp 7
OK

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

odometer (GPS odometer)
odometer n

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

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

Examples:

1. Reset the GPS odometer value to 0
cmd ctm15x
OK
cmd odometer reset
OK

2. Reset the GPS odometer value to 0
cmd ctm15x
OK
cmd odometer 0
OK

3. Set the GPS odometer to 100000 km
cmd ctm15x
OK
cmd odometer 100000
OK

4. Query the current GPS odometer value in km
cmd odometer
1245 KM
OK

See also: ctm15x

orientation (Set device mounting orientation for use with accelerometer sensor)
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 (Over-The-Air Service Provisioning)
otasp

This command is used to perform automatic wireless network activation and updates any required network related files that are embedded in the wireless 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
cmd otasp
OK
P
pad clientport (PAD client port number for dialup emulation modes)
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
cmd pad clientport 5006
OK

2. Query the existing dialup emulation PAD client port
cmd pad clientport
cmd pad clientport 5006
OK

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 (PAD echo mode)
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
cmd pad echo 0
OK

2. Query the current PAD echo setting
cmd pad echo
cmd pad echo 1
OK

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 (PAD escape sequence)
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
cmd pad esc 12345
OK

2. Query the current PAD escape string
cmd pad esc
cmd pad esc +++
OK

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 (PAD escape guard time)
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
cmd pad esct 4
OK

2. Query the current PAD escape guard time
cmd pad esct
cmd pad esct 3
OK

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 (PAD forwarding character)
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
cmd pad fwdc 32 0
OK

2. sets the PAD forwarding character to ASCII <space> and remove the forwarding character before forwarding the packet
cmd pad fwdc 32 1
OK

3. Query the current PAD forwarding character
cmd pad fwdc
cmd pad fwdc 32 0
OK

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 (PAD forwarding length)
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
cmd pad fwdl 10
OK

2. Query the current PAD forwarding length setting
cmd pad fwdl
cmd pad fwdl 10
OK

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 (PAD forwarding time)
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
cmd pad fwdt 40
OK

2. Query the current PAD forwarding time
cmd pad fwdt
cmd pad fwdt 40
OK

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 (PAD IP address)
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
cmd pad ip 192.168.1.1
OK

2. Query the current PAD IP address
cmd pad ip
cmd pad ip 192.168.1.1
OK

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 (PAD mode)
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
cmd pad mode 1
OK

2. Query the current PAD mode
cmd pad mode
cmd pad mode 1
OK

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 (PAD postfix character)
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>
cmd pad pfc 10
OK

2. Query the current PAD postfix character
cmd pad pfc
cmd pad pfc none
OK

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 (PAD port number)
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
cmd pad port 5005
OK

2. Query the existing PAD port
cmd pad port
cmd pad port 5005
OK

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 (PAD reset)
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
cmd pad reset
OK


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 PAD server for use with SSH tunneling)
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:
/ # cmd pad secure 1
OK

2. Query the current setting:
/ # cmd pad secure
cmd pad secure 0
OK

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


See also: pad mode, pad port

pad svct (PAD server connection cut-off timer)
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
cmd pad svct 10
OK

2. Configure the PAD connection to be dropped after 60 seconds
cmd pad svct 15 60
OK

3. Query the current padsvct settings
cmd pad svct
cmd pad svct 15 0
OK

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 (set pendant panic report)
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
cmd panicreport 1
OK

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 (set CTM-200 to send pendant acknowledgment when panic report received)
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
cmd panicreportack 60
OK

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
cmd panicreportack
cmd panicreportack 60 15
OK

See also: mode, panicreport, reportscripts, wpanacktype

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

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

Up to 8 reports can be assigned to the pendantreport.

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

pendantreport requires the 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

cmd pendantreport 1
OK

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


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

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

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


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

pin (set 4-digit SIM card PIN code for cell devices )
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 (pings a specific IP address)
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
cmd ping 10 www.google.ca
OK

2. ping 66.102.7.147 every 15 seconds
cmd ping 15 66.102.7.147
OK

3. Disable ping
cmd ping 0 0.0.0.0
OK

4. Queries the CTM-200’s ping setting
cmd ping
cmd ping 15 66.102.7.147
OK

See also: netwd

pobda-pobdd (OBDII reports)

pobdx n1 [n2] [n3] [n4]

Configures the engine - vehicle diagnostic report messages.

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

x = a, b, c, d

n1 (n2, n3, n4 are optional parameters) = engine parameters as per 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 (serial port settings)
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 (Local Point to Point Protocol connection)
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
cmd ppp
OK

See also: landhcp, lanip, mode

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

Sets the password used for wireless network access via simple IP. This is often set to the electronic serial number (ESN) of the 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 (power up report trigger conditions)
pupcond n a

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

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

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

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

Examples:

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

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


See also: pupreport

pupreport (set power up report) UPDATED
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 (accelerometer/acceleration threshold)
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.

pwr geofence (geofence threshold)
pwr geofence lat lon rad mode

Configure the CTM-200 gateway to wake up based on a geofence.

lat - center point latitude in deg (-90.0 - 90.0)
lon - center point longitude in deg (-180.0 - 180.0)
rad - boundary radius (m) (1 - 65535)
rad = 0 => Disabled (default)
mode = 0 : Wake up once the fence is exited
mode = 1 : Wake up once the fence is entered
mode = 2 : Wake up once the fence is entered or exited (crossed)

Default: cmd pwr geofence 0 0 0 0

Examples:

1. Wake the gateway if it is moved more than 500m away from the specified location
cmd pwr geofence 49.256548 -122.996718 500 0

2. Wake the gateway if it is within 1km of the specified location
cmd pwr geofence 49.256548 -122.996718 1000 1

3. Wake the gateway if it crosses the 1500m radius boundary of the specified location
cmd pwr geofence 49.256548 -122.996718 1500 2

Note: If the wake event is NOT FALSE when the gateway enters minimum power mode, it needs to reach a FALSE state and then TRUE again before waking the gateway.
For example, if cmd pwr geofence 49.256548 -122.996718 500 0 is set, then the gateway needs to be outside the 500m radius first and then within the radius to trigger it to wake.

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

pwr mode (power mode)
pwr mode n

Controls the CTM-200’s power mode.

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

n = 2 will power cycle the gateway immediately

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

Example:
cmd pwr mode 2 this command will power cycle the CTM-200 gateway

Note: If using SMS commands to control/configure the CTM-200, cmd pwr mode 2 should only be issued via SMS on devices running r2.0.4.2540 or later.

pwr rtc (RTC (real-time clock) threshold)
pwr rtc u m

Configure the CTM-200's wake up condition based on RTC time.

u = UTC time of first wakeup
m = wakeup period in seconds
m = 0 Wake up on u only (once)

Default: cmd pwr rtc 0 0 (Disabled)

Examples:

1. To wake up gateway every 1 hr on the hour
cmd pwr rtc 0 3600

2. To wake up gateway only once a day
cmd pwr rtc 0 86400

3. To wake up gateway at a specific date & time (e.g. New Year's Eve at Sat, 31 Dec 2011 23:59:59 GMT)
cmd pwr rtc 1325375999 0

4. To wake up at a specific date & time and then periodically afterwards if gateway is in minimum power mode (e.g. New Year's Eve at Sat, 31 Dec 2011 23:59:59 GMT and then every 10 minutes if gateway is in minimum power mode)
cmd pwr rtc 1325375999 600

A cmd save is required for this command to take effect.
pwr sdwn (power shutdown)
pwr sdwn a ddddd

Places the CTM-200 gateway into shutdown mode or minimum power mode (blinking power LED) based on the state of the gateway's standby signal (ignition).
The ignition state is controlled by the "white" wire of the 3 wire power connection to the gateway.
To disable any ignition sense capability connect the "white" wire to the + Voltage "Red" wire.

Default is pwr sdwn 1 10 (gateway will switch off based on the standby (ignition) signal state changing with a 10 second delay before entering shutdown mode).

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

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

Examples:
1. Force the gateway to enter minimum power mode when the ignition has been inactive for 1 hr. The gateway will power back up when ignition has been turned on.
cmd pwr sdwn 1 3600

2. Returns the current settings
cmd pwr sdwn

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

pwr speedth (GPS speed threshold)
pwr speedth ss t

Configure the CTM-200's wake up condition based on GPS speed.

ss - speed threshold in kph (0-254)
t - time in seconds that speed has to be >= ss (0-254)

Default: cmd pwr speedth 0 0

Examples:

1. Force the gateway to wake when GPS speed is greater than 79km/h for more than 30 seconds
cmd pwr speedth 80 30

2. Returns the current settings
cmd pwr speedth

A cmd save is required for this command to take effect.
pwr temp (temperature threshold)
pwr temp l h m

Configure the CTM-200's wake up condition for temperature.

l - Low threshold in degrees Celsius (-40 to 85)
h - High threshold in degrees Celsius (-40 to 85)
m - mode
m=0 : Wake up on LOW to HIGH transition
m=1 : Wake up on HIGH to LOW transition
m=2 : Wake up on any transition
Note: If the temperature at the time the gateway goes into minimum power mode results in TRUE, the gateway will wait for it to become FALSE before waking up on TRUE.

Default: cmd pwr temp 0 0 0

Examples:

1. Wake up when the gateway transitions from above 30 degrees Celsius to under 10 degrees Celsius.
cmd pwr temp 10 30 1

2. Wake up when the gateway crosses 15 degrees Celsius (e.g. from >15 to <15, or vice versa)
cmd pwr temp 15 15 2

Note: Please note that if the wake event is NOT FALSE when the gateway enters minimum power mode, it needs to reach a FALSE state and then TRUE again before waking the gateway.
For example, if cmd pwr temp 10 30 1 is set, and if the temperature is lower than 30 degrees Celsius at the time the gateway goes into minimum power mode, the gateway will wait for it to go above 30 degrees Celsius first and will wake up next time it goes below 10 degrees Celsius.

A cmd save is required for this command to take effect.
pwr vcct (supply voltage threshold)
pwr vcct vv.v t

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

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

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

Examples:

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

2. Query the current voltage and time settings
cmd pwr vcct
cmd pwr vcct 9.0 10

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

pwr woe (power wake on event) UPDATED
pwr woe m t1 t2 t3 f

Configures what event will wake up the CTM-200 gateway (see list of wake up events below) and how long the gateway will stay awake after the event.
This is used to have the gateway in minimum power mode (< 2 mA) until it is required to communicate over the wireless network.

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

This command can also be used to configure scheduled power cycles without having to put the gateway into shutdown.

m = 0 disables the power wake on event operation
m = 1 enables the power wake on event operation

t1 = 0 disables the ON timer while ignition is OFF (stay on forever – pwr sdwn can be enabled to shutdown the gateway)
t1 = 1 to 65535 the ON time while ignition is OFF in minutes (the gateway will remain on for this time after ignition OFF is detected)

t2 = 0 disables the ON timer while ignition is ON or disabled (stay on forever)
t2 = 1 to 65535 the ON time while ignition is ON in minutes (the gateway will remain on for this time while ignition is detected ON or is disabled)

t3 = 0 disables the OFF timer - stay in shutdown mode forever or until an input alarm event (or standby signal if enabled in pwr sdwn) occurs
t3 = 1 to 1092 the OFF time in minutes - the time that the gateway will stay in shutdown if an input alarm event (or standby signal if enabled in pwr sdwn) does not occur
t3 = c power cycle the gateway instead of going into minimum power mode

f = 0 disables the input event trigger
f > 0 Bit mapped wake up events in hex as described (see below)

Notes:

  • Each enabled f bit will cause the application to configure the corresponding wake up event before going into minimum power mode
  • ON timer while ignition ON runs always
  • ON timer while ignition OFF runs only when ignition is OFF
  • ON timer while ignition OFF gets reset every time ignition is detected as ON

Wake Up Events
The following table lists all wake up events and corresponding configuration commands:

bit Value Description Configuration Command
1 00000002 Wake on ignition pwr sdwn
2 00000004 Wake on input 1 insetup
3 00000008 Wake on input 2 insetup
4 00000010 Wake on input 3 insetup
5 00000020 Wake on input 4 insetup
6 00000040 Wake on input 5 insetup
7 00000080 Wake on input 6 insetup
8 00000100 Wake on VCC pwr vcct
9 00000200 Wake on temperature pwr temp
10 00000400 Wake on accelerometer pwr accelt
11 00000800 Wake on GPS pwr geofence
12 00001000 Wake on timer pwr woe
13 00002000 Wake on RTC pwr rtc
14 00004000 Wake on GPS Speed pwr speedth
15 00008000 Wake on Man Down Pendant wpan stm 1

Wake up events can be combined by taking the hexadecimal sum of their values.

  • By default, the conditional operator for all configured wake up events is OR.
  • To configure the conditional operator for all configured wake up events as AND, add hexadecimal 80000000 (Important note: When using the AND conditional operator, the corresponding wake up events must be properly configured to ensure the gateway wakes up from minimum power mode.)
Default configuration is 0 0 0 10 0 (wake on event disabled).

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

Examples:

1. Configure the CTM-200 gateway to power cycle every 12 hours
cmd pwr woe 1 0 720 c 0
OK

2. Stay ON while ignition is ON and cycle 10 min ON, 50 min OFF while ignition is OFF.
cmd pwr woe 1 10 0 50 2
cmd pwr sdwn 1 10

3. Wake up every day at 9 AM and stay ON for 30 min, with the first wake up starting on February 01, 2011 9:00 AM.
cmd pwr woe 1 30 0 0 2000
cmd pwr rtc 1296579600 86400
cmd pwr sdwn 0 10

4. Wake up if moved more than 500 m away from the specified location or every 6 hours while ignition is OFF. Stay on for 10 min. Stay ON while ignition is ON.
cmd pwr woe 1 10 0 360 802
cmd pwr geofence 49.256548 -122.996718 500 0
cmd pwr sdwn 1 10

5. Power cycle every 12 hours while ignition is ON. Stay OFF while ignition is OFF.
cmd pwr woe 1 0 720 c 0
cmd pwr sdwn 1 10

6. Power up when a PANIC/MPANIC/FPANIC message is received from Man Down Pendants
cmd wpan stm 1
...configure rest of wpan i.e. panid, device id, etc.
cmd pwr woe 1 0 0 0 8000
cmd pwr mode 1 // to enter LPM immediately

7. Query the current configured parameters for wake on event
cmd pwr woe
cmd pwr woe 0 0 10 0 0
OK

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

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

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

Note:

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

n = 0 1xRTT only
n = 1 EV-DO only
n = 2 Auto Rate Select (hybrid mode) - default

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

Examples:

1. Set the network rate mode to 1xRTT only
cmd ratesel 0
OK

2. Query the current network rate mode of the device
cmd ratesel
cmd ratesel 0
OK
ratetmr (Rate Timer, Sierra Wireless CDMA/EVDO only)
ratetmr n

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

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

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

Examples:

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

2. Query the current network rate test timer setting
cmd ratetmr
cmd ratetmr 120
OK

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

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

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

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

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

Examples:

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

2. Query messages associated with report #4
cmd repaddmes 4
cmd repaddmes 4 80 82 3 30
OK

3. Query messages associated with all configured reports
cmd repaddmes
cmd repaddmes 1 80 82
cmd repaddmes 4 80 82 3 30
OK

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


See also: report messages, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype

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

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

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

Examples:

1. Delete message type #16 from report #1
cmd repdelmes 1 16
OK

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

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


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

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

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

Note that an email server is required – see emailsrv.

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

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

Examples:

1. Set the send to email address for report #1
cmd repemail 1 me@home.com
OK

2. Query the email address for report #1
cmd repemail 1
cmd repemail 1 me@home.com
OK

3. Query the email address for all reports
cmd repemail
cmd repemail 2 me@home.com
OK

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


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

repfiledelivery (configure delivery parameters for file-based reporting)
repfiledelivery n t rt username server-path port

Where
n - report number (1-999)
t - file upload time period [s] (0-65535) 0=disable upload
rt - file upload retry period if uploads fail (0-65535) 0=disable retries
username - ssh username
server-path - ssh server host:path definition
port - ssh server TCP/IP port number, usually 22

Firmware version R1.3.0 only: To complete file-based reporting configuration, do a cmd save and power cycle the modem.

Example:

1. Set file delivery for report 1
cmd repfiledelivery 1 60 10 report 199.199.199.99:~/reports 4222
OK

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


See also: repfilename, sshkey

repfiledir (configure main folder for file-based reporting)
repfiledir local-path

Sets the main folder for file-based reporting
local-path folder for data files generated for file-based reporting (default: /etc/reports)

Example:
  1. Set main folder for file-based reports to /media.
    cmd repfiledir /media/reports
    OK

  2. Query current file folder for file-based reporting.
    cmd repfiledir
    cmd repfiledir/etc/reports
    OK
A cmd save and power cycle is required for this command to take effect.

See also: repfiledelivery, repfilename, repfileout, repfilesize, repfiletimestamp, repfilezip, sshkey
repfilename (configure filename for file-based reporting)
repfilename n name

Sets the file prefix used for a file-based report.

n = 1 to 999 report number
name file prefix to be used

File reports are named using a concatenation of this prefix, the report number, the modem mac address, and a timestamp (UNIX format). eg. diginput-1-0010A1772797-1267216159

Firmware version R1.3.0 only: To complete file-based reporting configuration, power cycle the modem.

Example:

1. Set file name for report 1 to diginput.
cmd repfilename 1 diginput
OK

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


See also: repfiledelivery

repfileout (configure outbox folder for file-based reporting)
repfileout local-path

Sets the outbox folder for file-based reporting
local-path outbox folder for data files generated for file-based reporting (default: /etc/reports)

Example:
  1. Set outbox folder for file-based reports to /media.
    cmd repfileout /media/reports/outbox
    OK

  2. Query outbox file folder for file-based reporting.
    cmd repfileout
    cmd repfileout/etc/reports/outbox
    OK
A cmd save and power cycle is required for this command to take effect.

See also: repfiledelivery, repfiledir, repfilename, repfilesize, repfiletimestamp, repfilezip, sshkey
repfilesize (configure maximum file size for file-based reporting)
repfilesize kb

Sets the maximum file size for file-based reporting
kb = 1-1024 maximum file size in KB (Default value: 1024)

Example:
  1. Set maximum file size for file-based reporting to 2 KB.
    cmd repfilesize 2048
    OK

  2. Query maximum file size for file-based reporting.
    cmd repfilesize
    cmd repfilesize 1024
    OK
A cmd save and power cycle is required for this command to take effect.

See also: repfiledelivery, repfiledir, repfilename, repfileout, repfiletimestamp, repfilezip, sshkey
repfiletimestamp (configure timestamp added to data files for file-based reporting)
repfiletimestamp n

Sets the timestamp added to data files for file-based reporting.

n = 0 - No Timestamp added
n = 1 - UTC timestamp added (e.g. "<1285133850><LF>") (Default)
n = 2 - Formatted UTC timestamp added (e.g. "03/15/10 04:13:00<CR><LF>")
n = 3 - Formatted UTC timestamp added (e.g. "03/15/10 04:13:00 ,")
n = 4 - Formatted UTC timestamp added (e.g. "03/15/10 04:13:00 ")

Example:
  1. Set formatted UTC timestamp added to data file generated by file-based reporting.
    cmd repfiletimestamp 2
    OK

  2. Query type of timestamp added to file-based reports.
    cmd repfiletimestamp
    cmd repfiletimestamp 1
    OK
A cmd save and power cycle is required for this command to take effect.

See also: repfiledelivery, repfiledir, repfilename, repfileout, repfilesize, repfilezip, sshkey
repfilezip (configure compression of data files for file-based reporting)
repfilezip c

Enables or disables the ability to compress data files generated by the file-based reporting system using different formats. Data files will be output in a required format with file names ending with the proper file extension.

Where
c = 0 compression of data files = disabled (default)
c = 1 compression of data files = enabled GZIP format (.gz)
c = 2 compression of data files = enabled ZIP format (.zip)

The current status of compression of data files generated by the file-based reporting system can be queried by using the repfilezip command without parameters.

Firmware version R1.3.0 only: To complete file-based reporting configuration, do a cmd save and power cycle the modem.

Example:

1. Enable compression of file-based reporting data files using GZIP format.
cmd repfilezip 1
OK

2. Query the current state of compression of file-based reporting data files.
cmd repfilezip
0
OK

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


See also: repfiledelivery, repfilename, sshkey

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

replocip (configure report local IP address)
replocip iii.iii.iii.iii

Sets the IP address of the local server connected to the CTM-200’s LAN that the report will be sent to. Up to 999 reports may be configured.

n = 1 to 999 report number
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 local IP address to receive local reports in decimal (default: 0.0.0.0)

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

If a report has no replocip 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
cmd replocip 1 192.168.1.21
OK

2. Query the local IP address setting of all reports
cmd replocip
cmd replocip 1 192.168.1.21
cmd replocip 2 192.168.1.22
OK

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


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

replocport (configure report local port)
replocport n xxxxx

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

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

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

Examples:

1. Report #1 will be sent to local port 5005
cmd replocport 1 5005
OK

2. Query the local port setting of all reports
cmd replocport
cmd replocport 1 7000
OK

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


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

reportscripts (configure custom scripts to be triggered when reports are generated)
reportscripts n

This command enables custom scripts to be triggered when reports are generated.

n = 0 disable custom report triggered scripts (default)
n = 1 enable custom report triggered scripts

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

Custom scripts should be located in the directory /etc/reports/scripts, and must be named "reportN.sh" where N is

N = 1 to 999 for general reports 1 to 999
N = 1020 to 1027 GPS reports 1 to 8
N = 1040 to 1047 I/O reports 1 to 8

Custom scripts must be copied over to the CTM-200 via local scp.

Examples:

1. Enable custom report triggered scripts
cmd reportscripts 1
OK

2. Query the current configuration
cmd reportscripts
cmd reportscripts 0
OK
repremip (configure report remote IP address)
repremip n iii.iii.iii.iii

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

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

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

Examples:

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

2. Query the remote IP address setting of all reports
cmd repremip
cmd repremip 1 123.10.1.101
cmd repremip 2 199.99.99.99
OK

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


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

repremport (configure report remote port)
repremport n xxxxx

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

n = 1 to 999 report number
xxxxx = 0 to 65535 remote port number

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

Examples:

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

2. Query the remote port setting of all reports
cmd remport
cmd remport 1 5001
cmd remport 2 5005
OK

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


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

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

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

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

n = 1 to 999 report number

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

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

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

Examples:

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

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

3. Query the SMS destination for report #1
cmd repsms 1
cmd repsms 1 1234567890
OK

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

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


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

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

Sets the reporting type for local and remote servers.

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

n = 1 to 999 report number

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

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

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

Note:
1) For r = 7 (SMS reports), the total length of the report must not exceed 166 characters including <CR> and <LF>
2) For r = 8, 9 (Requiring ACK messages from the remote WAN server), both reporting types are valid in only mode=10, WPANGW driver

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

Examples:

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

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

3. Query the reporting methods for all reports
cmd reptype
cmd reptype 1 3 0 0
cmd reptype 2 3 0 0
cmd reptype 10 0 6 0
OK

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


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

restore (restores last saved configuration)
restore

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

Example:
cmd restore

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

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

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

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

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

Examples:

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

cmd rmtd queries the CTM-200’s rtmd setting

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

rmtssh (remote ssh access)
rmtssh n

Enables or disables remote SSH access to the CTM-200.
If enabled, it will be possible to access the CTM-200 with a SSH client, using the current IP address allocated to the CTM-200 by the network.

n = 0 remote access = disabled (default)
n = 1 remote access = enabled

The current status of remote SSH access can be queried by using the rmtssh command without parameters.

Examples:

cmd rmtssh 1 enables remote access to the CTM-200 using SSH
cmd rmtssh queries the current status of remote SSH access.

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

rmttelnet (remote telnet)
rmttelnet

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

n=0 remote telnet = disabled (default)
n=1 remote telnet = enabled

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

Examples:

cmd rmttelnet 1 sets the CTM-200 to respond to incoming telnet commands
cmd rmttelnet queries the CTM-200’s setting for remote telnet access

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

rmtweb (remote web access)
rmtweb n

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

n = 0 remote access = disabled (default)
n = 1 remote access = enabled

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

Examples:

cmd rmtweb 1 enables remote access to the CTM-200’s web pages
cmd rmtweb queries the current status of remote web

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

rssi (RF signal strength)
rssi

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

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

This is a read only command.

Example:

1. Query the current network signal strengths seen by the CTM-200
cmd rssi
EVDO: -98dBm
1xRTT: -99dBm
OK
S
saltreport (set salt-spreader report)
saltreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

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

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

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

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

Example:
cmd saltreport 2
cmd repaddmes 2 114
cmd save

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

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

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

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

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


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

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

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

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

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

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

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

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

o = 1 to 4 Output number. Default is 1
o = 5 Output on DSR on port 1 (CTM-200 only)

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

Examples:

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

cmd satbackup Queries the current satbackup configuration

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

save (saves configuration)
cmd save

Save CTM-200 configuration to non-volatile memory.

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

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

Example:

1. Save current configuration
cmd save
OK
sddetect (check for microSD card)
sddetect

Use this command to query status of SD card in CTM-200.
0 = no SD card detected, 1 = SD card detected

Example: with SD card
cmd sddetect
cmd sddetect 1
OK

Example: without SD card
cmd sddetect
cmd sddetect 0
OK
sendreport (generates and sends a "One-Shot" report upon execution of the command)
sendreport n x [x2][x3][x4]

Generates a "One-Shot" general report and uses the settings of report x to send the report. 4 messages can be included in a single report. If a report x already exists the contents of sendreport are appended to the pre-existing report.

Messages will be sent in a report in the same order that they are added. Optional message parameters are not required. eg. cmd sendreport 3 will send general report 3 with no additional messages.

GPS and IO reports can also be triggered using the general report offsets: eg. cmd sendreport 1040 will send ioreport.

ULCP header messages will be sent as individual UDP packets – NMEA format messages will be combined into a single UDP packet.

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

Examples:

1. Add message type #3-device ID and #16 – GPS NMEA GLL – to report #4
cmd sendreport 4 3 16
OK

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

See also: messages, repdelmes, repremip, repremport, reptype
showconfig (displays current configuration settings)
showconfig [-quiet <email address>]

Returns the current configurations of the CTM-200 gateway.

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

Using showconfig with the optional parameter -quiet <email address> will deliver the gateway's configuration settings to a specified email address. Note that an email server is required – see emailsrv.

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

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

cmd odometer
cmd smstext
cmd enghours
cmd data

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

cmd factory
cmd ratesel
cmd telnetpswd

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

Examples:

1. Return the current gateway configuration settings
cmd showconfig

2. Email the current gateway configuration settings to the specified address:
cmd showconfig -quiet me@home.com
showstate (displays modem state)
showstate

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

showstate returns the modem state:

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

Example:

# cmd showstate
Firmware Version:CTM15x R1.2.2 (rev. 1483)
ESN:09604890958
Modem ID:09604890958
Modem IP Address:68.182.130.226
Odometer:0 KM
Engine Hours:0.00 h
Output mode (RF Switch):0
SMS Text:
Wireless link data count:
TX: 0 MB
RX: 0 MB
Total: 0 MB
OK
sms fwdreport (configure forwarding of incoming SMS messages) NEW
sms fwdreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8]

This command sets the report(s) to be used for forwarding incoming SMS messages received by the CTM-200 gateway.

This feature can be used to configure the CTM-200 as an SMS gateway that forwards messages from SMS-enabled devices to the CTM-200's reporting types (e.g. local serial port, local/remote TCP or UDP servers, or email/SMS destinations).

Incoming SMS messages can be forwarded to up to 8 reports.

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

Notes:
  • The SMS sender's phone number is included in the forwarded SMS messages.
  • SMS configuration commands ($0 <ctm command> or $1 <ctm command> ) are not forwarded by this feature.
  • SMS features are only available for specific manufacturer, RF modules, cards or devices. Please contact Cypress Solutions for a complete list of products that support SMS functionality.
  • The CTM-200 needs to be connected to the network for the SMS forwarding system to work.
Examples:
  1. Forward incoming SMS messages to a UDP server
    cmd repremip 1 1.2.3.4
    cmd repremport 1 8888
    cmd reptype 1 0 3
    cmd sms fwdreport 1

  2. Forward incoming SMS messages to a TCP server
    cmd repremip 1 1.2.3.4
    cmd repremport 1 8888
    cmd reptype 1 0 5
    cmd sms fwdreport 1
    cmd tcppersist 1

  3. Forward incoming SMS messages to an email address (emailsrv provided by carrier is required)
    cmd emailsrv 1.2.3.4
    cmd repemail 1 me@home.com
    cmd reptype 1 0 6
    cmd sms fwdreport 1

  4. Query reports configured for incoming SMS forwarding
    cmd sms fwdreport
    cmd sms fwdreport 1 2 3
    OK
A cmd save and power cycle are required for this command to take effect.

See also: repaddmes, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype
smssend (send SMS message)
smssend

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

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

The CTM-200 needs to be connected to the network.

Example:
cmd smssend send the SMS message

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

Used to enter the text message of the SMS.

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

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

<string> text message (max 166 chars)

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

Example:

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


.<CR>

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

smsto (send SMS to)
smsto pppppppppp

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

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

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

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

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

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

smsview (SMS message view)
smsview

Querys the message entered via smstext command.

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

This is a read only command.

Example:
cmd smsview returns the text message to be sent

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

This command sets the store-and-forward delay time and minimum signal strength (RSSI) required before stored messages are forwarded. The delay time [t] is the number of seconds the modem must have a RF connection with signal strength greater than or equal to the defined threshold before stored messages are forwarded. Valid time range is 1 to 65535 seconds. Valid RSSI threshold should be a value between -95 and 0. The default is 20 seconds, -95 dBm.

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

Example:

  1. Set the delay time before forwarding SNF data to 60 seconds with signal strength >= -80 dBm
    cmd snfdelay 60 -80
    OK

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

snfflush (Store and Forward Flush)
snfflush

Flushes and resets store and forward NVRAM.

snflog (Store and Forward log)
snflog n

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

This is a read only command.

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

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

T:t where t is the total number of stored reports
F:f where f is the number of reports forwarded
N:n where n is the number of reports not yet forwarded

Examples:
cmd snflog 100 displays the first 100 SnF log entries
cmd snflog displays the SnF log status

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

spc (service provisioning code)
spc nnnnnn

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

nnnnnn 6-digit lock code

Example:
cmd spc 123456 set the CTM-200’s SPC to 123456

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

speedth (speed threshold for enabling RF module of the CTM-200)
speedth ss t

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

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

ss speed threshold(kph)
t time (seconds)

Example:

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

cmd speedth queries the current speed threshold conditions

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

sshkey (generate a ssh key)
sshkey [dss/rsa]

Generate a SSH public/private key pair.

dss Generate a 1024 bit DSS key pair
rsa Generate a 1024 bit RSA key pair

Example:

cmd sshkey dss
root@OpenWrt:~# cmd sshkey dss
Will output 1024 bit dss secret key to '/etc/dropbear/id_dss'
Generating key, this may take a while...
Public key portion is:
ssh-dss AAAAB3NzaC1kc3MAAACBAKV8x80K0wnyc4Ia/NiD0BTZLhPYVPO8FhB3kWzLOdB99Sy
QBgl6tXaYvPXT+rV24qzmJaNIDlwMAsJRxp86Jki/WogktrN1jjjl8bnwrvjvM1kCCmWf8SUry
Rhk+tvqCgQX1qk3CQsFE0JjU66Fk6+s5+Ng7ofigajDNCJYCDo7AAAAFQDDTQ9nonJwG5
xLxoOeHO21CDjOZwAAAIA6MxUSC34am0YmmiCAOUPa6Vy6SbJVhsffoBBVFkoDmTqkd
v/lMR4iP4Rhjb3rl27r+8wnlzorm5sKJGvhbLjLbQqlvv0aUiywmM31L5ZIIglq7adGJ6cLwIQ
KZ5+1Vt1Nx9MQiayD9vey5HCdgtS6OBENVOp4H7bWfqAOkuZnDAAAAIBd1f8d5aguW/
ySngmjH64MNyk7t8k9bmN+2kFS6szUd40EwjAHMTAK+Rgu4Q/tiXlVOq8qomCgfd2oEN
6KbiJDoqEYsRzCQ8AhCWfNEKiQd9X3Dw7Q8dRxD6Qx+Ro18ptklXIQtsURUrBWXJtetr0w
pihQnkhLtedu028o1+Ex6A== root@OpenWrt
Fingerprint: md5 6b:06:6e:f4:2e:0e:58:21:12:1d:f8:51:25:2a:a5:6d
OK

sshport (set CTM-200 ssh server port)
sshport [port]

Sets the port for ssh access (both local and remote).
A cmd apply, followed by cmd save and power cycle are required for this command to take effect.

port = 1 to 65535 port to be used for ssh (default: port 22)

The current ssh port setting can be queried by entering cmd sshport without parameters.

Example:
1. Set ssh port to 3322
cmd ssh 3322
OK
sshtimeout (ssh session idle timeout)
sshtimeout n

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

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

The current ssh timeout setting can be queried by entering sshtimeout without parameters.

Example:

1. Disable ssh timeout
cmd sshtimeout 0
OK
stm upgrade (upgrades STM/Mini Micro FW) UPDATED
stm upgrade f u n p

Updates the CTM200's Mini Micro FW.
The cmd stm upgrade command requires 4 parameters when accessing an FTP server, 2 parameters when accessing an HTTP server or scripts locally.

f - imagefile.tar the name of the file containing the firmware image
u - 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.
n - username username to access FTP server (ignored when url is prefixed by http:// or url is localhost)
p - password password to access FTP server (ignored when url is prefixed by http:// or url is localhost)

When localhost is specified as the url, the image file must be located in /tmp on the CTM-200.

Example:
  1. From Cypress FTP server:
    cmd stm upgrade CTM2xxMiniMicro-CRC-R99.bin.tar cypress.bc.ca cypress PASSWORD

    or

    cmd stm upgrade CTM2xxMiniMicro-CRC-R99.bin.tar ftp://cypress.bc.ca cypress PASSWORD

  2. From Cypress URL site:
    cmd stm upgrade CTM2xxMiniMicro-CRC-R158.bin.tar http://www.cypress.bc.ca/repository/openctm/eng13

    or

    cmd stm upgrade http://www.cypress.bc.ca/repository/openctm/eng13/CTM2xxMiniMicro-CRC-R158.bin.tar

  3. From the local folder, /tmp:
    cmd stm upgrade CTM2xxMiniMicro-CRC-R158.bin.tar localhost
    Note that CTM2xxMiniMicro-CRC-R158.bin.tar should be in /tmp folder
swipegpio (set iButton GPIO mapping) NEW
swipegpio n (CTM-200)

Sets the GPIO row to be used.

n = 0 Use GPIO's top row (inputs 3/5 and outputs 1/3)(default)
n = 1 Use GPIO's bottom row (inputs 4/6 and outputs 2/4)

Examples:
  1. Set CTM-200 to use GPIO's top row for iButton interface
    cmd swipemode 11
    OK
    cmd swipegpio 0
    OK

  2. Set CTM-200 to use GPIO's bottom row
    cmd swipegpio 1
    OK
A cmd save and a power cycle are required for this command to take effect.
swipemode (set swipe-card interface)
swipemode n

Sets the swipe card interface to be used with the CTM-200.

n = 0 Serial HID swipe card interface (default), requires cmd mode 9
n = 1 Serial iButton swipe card interface, requires cmd mode 9
n = 10 GPIO HID swipe card interface, works in any mode and takes priority in cmd mode 9

When swipemode is configured with n = 0 or n = 1, the command cmd mode 9 must be used. When swipemode is configured with n = 10, any mode can be used.

Note: In order to use swipemode 10, power management controller firmware version 105 must be loaded. To check this version cmd mmq 47 command can be issued and should return the value of 69. Contact Cypress Solutions for instructions on upgrading power management controller firmware.

Examples:

1. Set the CTM-200 to use the serial iButton swipe card interface
cmd mode 9
OK
cmd swipemode 1
OK

2. Set the CTM-200 to use the GPIO HID swipe card interface
cmd swipemode 10
OK

3. Query the currently configured swipe card interface
cmd swipemode
cmd swipemode 0
OK

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


See also: mode

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

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

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

The appended message contains the ID of the swipe card detected by the swipe card reader. mode must be configured correctly to allow the swipe card reader to communicate with the CTM-200. When using the redboot loader swipe card reader application to trigger remote reports, store and forward must be enabled for the report(s) assigned using swipereport.

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

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

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

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

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

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



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

syslog (system log)
syslog n

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

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

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

T
taipchecksum (enable/disable checksum in TAIP messages) NEW
taipchecksum n

Enables/disables checksum in Trimble ASCII Interface Protocol messages. Checksum field will be used in GPS TAIP PV/LN message.

Where n:
0: disable checksum in TAIP messages (default)
1: enable checksum in TAIP messages

Example:
  1. Enable checksum in TAIP messages
    cmd taipchecksum 1
    OK

    >RPV12016+4902565-1220996700028702;*7F<
This command takes effect immediately.

See also: taipid, taipuseid
taipid (set TAIP ID) NEW
taipid DDDD

Sets Trimble ASCII Interface Protocol ID. TAIP ID will be used in GPS TAIP PV/LN message.

DDDD a four-character alphanumeric code (default: "0000")

Example:
  1. Set TAIP ID as ‘Abc1’
    cmd taipid Abc1
    OK
This command takes effect immediately.

See also: taipchecksum, taipuseid
taipuseid (enable/disable reporting of ID in TAIP messages) NEW
taipuseid n

Enables/disables reporting of ID in Trimble ASCII Interface Protocol messages. TAIP ID will be used in GPS TAIP PV/LN message.

Where n:
0: disable reporting of ID in TAIP messages (default)
1: enable reporting of ID in TAIP messages

Example:
  1. Enable reporting of ID in TAIP messages
    cmd taipid Abc1
    OK

    cmd taipuseid 1
    OK

    >RPV15714+3739438-1220384601512612;ID=Abc1<
This command takes effect immediately.

See also: taipchecksum, taipid
tcppersist (set persistent TCP report connections)
tcppersist n

This command configures the CTM-200 to maintain persistent TCP connections for configured TCP reports.

n = 0 persistent connections for TCP reports = disabled (default)
n = 1 persistent connections for TCP reports = enabled

The current state of the command can be queried by using the tcppersist command without parameters.

Examples:
  1. Enable persistent connections for TCP reports
    cmd tcppersist 1
    OK

  2. Query the current setting for persistent TCP report connections
    cmd tcppersist
    cmd tcppersist 0
    OK
A cmd save and a power cycle are required for this command to take effect.
telnetport (telnet port)
telnetport n

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

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

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

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

Firmware version R1.3.0 only: To complete telnet port configuration, power cycle the modem.

Example:
1. Set telnet port to 33
cmd telnetport 33
OK

A cmd apply followed by a cmd save are required for this command to take effect.
See also: telnetpswd, telnettimeout

telnetpswd (password for telnet access)
telnetpswd n

Sets password for telnet access (both local and remote) and ssh access (both local and remote). ssh access is available in firmware version R1.3.0 only.

n a maximum of 40-character alpha-numeric password

Example:
1. Set telnet password to ‘cypress’
cmd telnetpswd cypress
OK

Firmware version R1.2.1 and below: A cmd save is required for this command to take effect.

Firmware version R1.3.0 only: This command takes effect immediately.


See also: telnetport, telnettimeout

telnettimeout (telnet timeout)
telnettimeout n

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

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

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

Example:

1. Disable telnet timeout
cmd telnettimeout 0
OK

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

timesync (set period for system time synchronization)
timesync

Set the period in seconds when the CTM-200's system time and the power management controller's time are synchronized with one or more external sources:

t = 0 to 65535 synchronization period in seconds (default: 3600 seconds)

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

Examples:
1. Update system time and power management controller time as fast as possible
cmd timesync 0
OK

2. Update system time and power management controller time every 10 seconds
cmd timesync 10
OK

See also: gpstime, networktime, ntpserver, ntptime

timezone (query/set system timezone)
timezone <tz>

cmd timezone is used to query and set the system timezone.
To query current timezone setting: cmd timezone
To set a timezone: cmd timezone <timezone> where <tz> is a valid timezone from this Time Zone list.

Example:
  1. Query timezone
    cmd timezone
    cmd timezone UTC
    OK

  2. Set timezone to PST
    cmd timezone PST8PDT
    OK

    A cmd save and reboot is required for this command to take effect.
U
univwd (configure universal watchdog)
univwd <mode> <url>/<report>

Configure the Universal Watchdog.

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

Examples:

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

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

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

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

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

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

upgradefw (upgrade firmware kernel image + root filesystem (rootfs))
upgradefw imagefile.tar url username passwd

Remote upgrade of the CTM-15X firmware (kernel and root filesystem images).

The command requires 5 parameters when accessing an FTP server, 3 parameters when accessing an HTTP server, or 3 parameters when accessing scripts locally.

imagefile.tar the name of the file containing the firmware image

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 url is localhost)

passwd password to access FTP server (ignored when url is prefixed by http:// or url is localhost)

When localhost is specified as the url, the image file must be located in /tmp on the modem.

Examples:

cmd upgradefw openctm-1.3.0-r1590.tar cypress.bc.ca guest guestpw where openctm-1.3.0-r1590.tar is the image 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 upgradefw openctm-1.3.0-r1590.tar localhost where openctm-1.3.0-r1590.tar is the image file, and /tmp is the location of the image file.

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

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

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

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

Examples:

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

2. Query current email server
cmd upgradesrv
cmd upgradesrv 209.121.68.211
OK
usepeerdns (enable/disable obtaining DNS nameserver IP addresses from carrier)
usepeerdns x

This command is used to enable or disable the CTM-200 gateway from obtaining its DNS nameserver IP addresses from the carrier when it connects to the network.

If specific DNS nameservers are to be used, this setting should be disabled. DNS nameserver IP addresses can be added from the main Network web page under the lan DNS servers section by entering the DNS nameserver IP address in the text field, clicking on the Add button, followed by clicking on the Save Changes to Page button followed by the Save Configuration button.

x = 0 disable obtaining DNS nameserver IP addresses from the carrier
x = 1 enable obtaining DNS nameserver IP addresses from the carrier (default)

Examples:
1. Disable obtaining DNS nameserver IP addresses from the carrier.
cmd usepeerdns 0
OK

This command takes effect immediately.

user (sets username used for wireless network access via simple IP)
user n

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

n a maximum of 40-character alpha-numeric username

A save operation is required.

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

A cmd apply followed by a cmd save are required for this command to take effect.
See also: mip, pswd

V
vcc (supply voltage)
vcc

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

Example:

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

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

n = 1 to 8 supply voltage level condition trigger
o=0 trigger disabled (default) o=1 trigger while supply voltage is below threshold
o=2 trigger while supply voltage is above threshold
o=3 trigger on transition (whenever supply voltage threshold is passed)
(above threshold->below threshold or below threshold->above threshold)

Optional parameters:
a.a = 6.0 to 36.0 threshold voltage, in volts (default = 9.0 V) (CTM-200)
a.a = 9.0 to 36.0 threshold voltage, in volts (default = 9.0 V) (CTM-15X)
mt = 0 to 65535 maximum reporting rate in seconds (minimum time between reports, default = 60s)

The current condition(s) can be queried by using the vcccond n command. If n is blank, all vcccond triggers will be queried.

Examples:

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

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

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

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

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

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

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

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

ver (firmware version)
ver

Queries the currently installed firmware version of the modem.

Example:

1. Query the current firmware version
cmd ver
CTM15x R1.2.0 (rev. 1140)
OK
vue ack (run the VUE client/server acknowledgement) NEW
vue ack

Configure VUE service to send an acknowledgement string to the VUE device management server.

<string> text string with no spaces

Examples:
  1. Send this_is_a_test to the VUE device management server.
    cmd vue ack this_is_a_test
Note: The payload of cmd vue ack <string> is send as a variable to the "Text1" parameter part of the Generic GpsGate device mapper. Text1 can be mapped to Monitor Status where so reports can be generated that provide diagnostics for device management commands.

A cmd save and a power cycle are required for this command to take effect.
vue port (configure TCP server port for device)
vue port n

Configure TCP server port for device used when VUE service is run in server mode.
n = 1 to 65535 port number of listening port, in decimal (TCP port 30175 default)

Examples:
  1. Set VUE service in server mode to listen on TCP port 12345:
    cmd vue port 12345
    OK

  2. Query the currently configured VUE server mode listening port:
    cmd vue port
    cmd vue port 30175
    OK
A cmd save and a power cycle are required for this command to take effect.

See also: vue remip, vue remport, vue service
vue pwrup (configure VUE client to run on power up) NEW
vue pwrup 0|1

Configure VUE client to run after device power up.

n = 0 : disabled
n = 1 : enabled (default)

Examples:
  1. Set VUE client to run once on power-up:
    cmd vue pwrup 1
    OK

  2. Query the currently configured VUE server mode listening port:
    cmd vue pwrup
    cmd vue pwrup 1
    OK
A cmd save and a power cycle are required for this command to take effect.

See also: vue remip, vue remport, vue service
vue remip (configure IP address of remote VUE server)
vue remip a.a.a.a

Configure IP address of remote VUE server. When the VUE service is run in client mode, this command sets the IP address of the remote VUE server that is periodically checked for any pending commands. When the VUE service is run in server mode, this command sets the IP address of the remote VUE server that is authorized to run commands.

a.a.a.a = 0.0.0.0 to 255.255.255.255 IP address of the authorized server. Default = 64.46.40.148
  • 0.0.0.0 disables all remote servers
  • 255.255.255.255 enables all remote servers
Examples:
  1. Set remote VUE server IP address to 1.2.3.4:
    cmd vue remip 1.2.3.4
    OK

  2. Query the currently configured remote VUE server IP address:
    cmd vue remip
    cmd vue remip 64.46.40.148
    OK
A cmd save is required for this command to take effect.

See also: vue remport, vue service
vue remport (configure TCP port number of remote VUE server)
vue remport n

Configure TCP port number of remote VUE server used when VUE service is run in client mode.
n = 1 to 65535 port number of remote VUE server, in decimal (TCP port 30175 default)[[BR]

Examples:
  1. Set VUE service in client mode to use TCP port 12345:
    cmd vue remport 12345
    OK

  2. Query the currently configured VUE client mode port:
    cmd vue remport
    cmd vue remport 30175
    OK
A cmd save is required for this command to take effect.

See also: vue remip, vue service
vue service (configure VUE service)
vue service n

Configure VUE service to support remote device management from a VUE server. The CTM device communicates with the VUE server over a TCP connection.

n = 1 set VUE service to run in client mode (default)
n = 2 set VUE service to run in server mode

n = 1 is used with CTM cellular devices that have non-routable IP addresses.
n = 2 is used with CTM cellular devices that have routable IP addresses.

Examples:
  1. Set CTM device to use VUE service in server mode:
    cmd vue service 2
    OK

  2. Query the currently configured VUE service mode:
    cmd vue service
    cmd vue service 1
    OK
A cmd save and a power cycle are required for this command to take effect.

See also: vue port, vue remip, vue remport
W
wifi ap | client channel (set the wireless channel)
wifi ap|client channel

Set the wifi channel for client or access point (AP)
ap|client configure ap or client channel must be a channel number between 1 and 11, auto is also a valid option for a wifi client.

Example:
  1. Set wifi AP channel to 11
    cmd wifi client channel 11
    OK
wifi ap | client encryption (sets the wireless encryption type)
wifi ap|client encryption <enctype>

Set wireless connection encryption type
ap|client configure AP or client enctype one of none, psk, psk2, tkip

Example:
  1. Set wifi AP encryption to psk2
    cmd wifi enctype ap psk2
    OK
wifi ap | client hwmode (set the wireless hardware mode)
wifi ap|client hwmode <mode>

Set the hardware mode for the wifi radio.
ap|client : configure AP or client
<mode> : mode is one of the following: 11n, 11ng, 11bg

Example:
  1. Set wifi client hwmode for 11ng
    cmd wifi client hwmode 11ng
    OK
wifi ap | client key (set the wireless key)
wifi ap|client key <pre-shared-key>

Set the pre-shared-key for an encrypted wifi configuration.
ap|client : configure AP or client
<pre-shared-key> : a passphrase between 8 and 64 characters in length

Example:
  1. Set wifi AP pre-shared key to 'CypressAccess'
    cmd wifi ap key CypressAccess
    OK
wifi ap | client ssid (sets the wireless SSID)
wifi ap|client ssid <SSID>

Set the SSID for the wifi connection.
ap|client : configure AP or client
<SSID> : SSID of wireless access point

Example:
  1. Set the wifi client SSID to CypressAP
    cmd wifi client ssid CypressAP
    OK
wifi country (set the wireless regulatory country code)
wifi client|ap country <country-code>

Set the regulatory domain for wifi radio communications.
ap|client: configure AP or client
<country-code> : Country code is a 2 character value chosen from the following list of country codes.

Example:
  1. Set wifi AP country for Canada
    cmd wifi ap country CA
    OK
wifi mac (query the wireless MAC address)
wifi mac

This command can be used to query the MAC address of the CTM-200 wireless radio.

Example:
cmd wifi mac
cmd wifi mac 00:19:70:61:d1:95
OK
wifi radiusport (configure the Port number for a Radius server)
wifi radiusport n

Set the port number for a wifi Radius authentication server
n = 0 to 65535 Radius server port number
The current Radius server port number can be queried by using cmd wifi radiusport.

Examples:
  1. Set the Radius server port to 5678
    cmd wifi radiusport 5678
    OK

  2. Query the wifi radiusport
    cmd wifi radiusport
    cmd wifi radiusport 5678
    OK
A cmd save and a power cycle are required for this command to take effect.
wifi radiussrv (configure the IP address for a Radius server)
wifi radiusserver iii.iii.iii.iii

Set the IP address for a wifi Radius authentication server
iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 Radius server IP address in decimal
The current Radius server IP address can be queried by using cmd wifi radiussrv.

Examples:
  1. Set the Radius server IP address to 199.99.22.21
    cmd wifi radiussrv 199.99.22.21
    OK

  2. Query the wifi radiusrv
    cmd wifi radiussrv
    cmd wifi radiussrv 199.99.22.21
    OK
A cmd save and a power cycle are required for this command to take effect.
wifi watchdog (configures wireless watchdog)
wifi watchdog n [t]

Enable/disable wifi watchdog.
n 0 = disabled; 1 = enabled
t watchdog threshold time in seconds, time must be in range 31 to 65535 (optional:default is 120 seconds).

Example:

1. Enable wifi watchdog with a 5 minute threshold
cmd wifi wd 1 300
OK
wlan dns (configure a DNS server for the wifi client interface)
wlan dns iii.iii.iii.iii

Set a DNS namerserver IP address for the CTM-200 wifi client interface (WLAN). This option is usually only required if the WLAN interface is configured to use a static IP address, see wlan proto.

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 DNS IP address in decimal (default: eth0: 192.168.1.1 and eth1: 192.168.2.1)

The current WLAN IP DNS address can be queried by using wlan dns.

Examples:
  1. Set the WLAN DNS namerserver IP address to 192.168.10.254
    cmd wlan dns 192.168.10.254
    OK

  2. Query the WLAN DNS nameserver IP address
    cmd wlan dns
    cmd wlan dns 192.168.10.254
    OK
A cmd save and a power cycle are required for this command to take effect.
wlan enable (configure dual-mode CTM-200 for cellular + wifi)
wlanenable n

Enable/disable wifi watchdog.

n = 0 Cell only
n = 1 Cell + Wifi Client
n = 2 Cell + Wifi Access Point
n = 3 Wifi Client only

Examples:

1. Enable wifi as Access Point (AP) on LAN
cmd wlanenable 2
OK

2. Use wifi only
cmd wlanenable 3
OK

Changing from cmd wlanenable 2 to any other mode, or from any other mode to cmd wlanenable 2 must be followed by a cmd apply OR a cmd save and power cycle.

wlan gw (configure a default gateway IP address for the wifi client interface)
wlan gw iii.iii.iii.iii

Set a default gateway IP address for the CTM-200 wifi client interface (WLAN).

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 gateway IP address in decimal (default: eth0: 192.168.1.1 and eth1: 192.168.2.1)
The current WLAN IP address can be queried by using wlan ip.

Note: cmd wlan gw should only be set if using cmd wlan proto static.

Examples:
  1. Set the WLAN default gateway IP address to 192.168.10.254
    cmd wlan gw 192.168.10.254
    OK

  2. Query the WLAN gateway IP address
    cmd wlan gw
    cmd wlan gw 192.168.10.254
    OK
A cmd save and a power cycle are required for this command to take effect.
wlan ip (configure a static IP address for the wifi client interface )
wlan ip iii.iii.iii.iii

Set a static IP address for the CTM-200 gateway's wifi client interface (WLAN).

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 WLAN IP address in decimal (default: eth0: 192.168.1.1 and eth1: 192.168.2.1)
The current WLAN IP address can be queried by using wlan ip.

Examples:
  1. Set the WLAN IP address to 192.168.10.1
    cmd wlan ip 192.168.10.1
    OK

  2. Query the WLAN IP address
    cmd wlan ip
    cmd wlan ip 192.168.10.1
    OK
A cmd save and a power cycle are required for this command to take effect.
wlan netmask (configure the IP address netmask for the wifi client interface)
wlan netmask iii.iii.iii.iii

Sets the netmask of the CTM-200 gateway's wifi client interface (WLAN).

iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 WLAN netmask (default: 255.255.255.0)
The current WLAN netmask can be queried by using wlan netmask.

Examples:
  1. Set the WLAN netmask of the CTM-200 gateway's wifi client to 255.255.255.0
    cmd wlan netmask 255.255.255.0
    OK

  2. Query the WLAN netmask of the CTM-200
    cmd wlan netmask
    cmd wlan netmask 255.255.255.0
    OK
A cmd save and a power cycle are required for this command to take effect.

See also: wlan ip
wlan proto (configure the network protocol for the wifi client interface)
wlan proto dhcp|static

Define the network protocol for the CTM-200 wifi client interface (WLAN) to use DHCP or static IP address.

dhcp|static dhcp or static option. Default is dhcp
The current WLAN protocol can be queried by using wlan proto.

Note: if static protocol is used, the following WLAN options must also be configured: IP address cmd wlan ip, netmask cmd wlan netmask, gateway cmd wlan gw. And optionally: cmd wlan dns.

Examples:
  1. Set the WLAN protocol to static
    cmd wlan proto static
    OK

  2. Query the WLAN protocol
    cmd wlan proto
    cmd wlan proto static
    OK
A cmd save and a power cycle are required for this command to take effect.
wpan acktype (Man Down Pendant acknowledgment type)
wpan acktype n

Assigns an acknowledgment type for the Work Alone system.
There are two acknowledgment types:

  • CTM-200
  • server

If a user initiates a ‘Man Down Emergency’ alert, the Pendant will provide the worker with either a positive acknowledgment or a negative acknowledgment.

n = m CTM-200 type acknowledgment (default)
n = s server type acknowledgment

Entering wpan acktype with no arguments returns the current command configuration.

A cmd save and a power cycle are required before either mode takes effect.

  • CTM-200 type acknowledgment:

A positive acknowledgment (ACK) means the CTM-200 has received the alert. If the Pendant has not received an acknowledgment from the CTM-200, the Pendant will continue to send PANIC/MPANIC messages until an acknowledgment(ACK) is received. (Pendant firmware V1.1 and later)

  • Server type acknowledgment:

A positive acknowledgment means that the server has received the alert from the CTM-200 and acknowledged back to the CTM-200 then to the Pendant. If the Pendant has not received an acknowledgment from the server, the Pendant will continue to send PANIC/MPANIC messages until it receives an acknowledgment(ACK). (Pendant firmware V1.1 and later)

Note: The remote server must also be configured to respond to messages from the CTM-200. The message format sent from the CTM-200 is as follows:
$PPEN,0013A200402CB498,13,PANIC*03

The acknowledgment that the CTM-200 expects from the server is as follows:
$PPQ,PAN,0013A200402CB498,13,ACK*36

The 16-digit hex number following the PPEN message is the Pendant ID and is unique to each Pendant.

Examples:

1. Configured as CTM-200 type acknowledgment
cmd wpan acktype m
OK

2. Configured as server type acknowledgment
cmd wpan acktype s
OK
wpan adddev (WPAN accessory add device id, query device id)
wpan adddev xx-xx-xx-xx-xx-xx-xx-xx

Adds a WPAN device ID to the CTM-200’s registered WPAN devices list. Up to 16 WPAN IDs can be entered.

xx-xx-xx-xx-xx-xx-xx-xx WPAN device ID (hex digits), hyphens are optional

Using wpan adddev without a device ID, queries all WPAN devices IDs currently registered in the CTM-200.

Note that the ID of FF-FF-FF-FF-FF-FF-FF-FF will allow any Pendant to talk through the CTM-200.

Example:

cmd wpan adddev 00-13-a2-00-40-08-58-5e add WPAN device with this ID to the registered devices list

cmd wpan adddev 0013a2004008585e above example with optional hyphens omitted

cmd wpan adddev queries all devices IDs

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


Note: the CTM-200 needs to be power cycled for the new settings to take effect.

wpan delall (WPAN accessory delete all device ids)
wpan delall

Deletes all WPAN device IDs from the CTM-200’s registered WPAN devices list.

Example:

cmd wpan delall deletes all WPAN devices from the registered devices list


Note that the CTM-200 needs to be power cycled for the new settings to take effect.

wpan deldev (WPAN accessory delete device id)
wpan deldev xx-xx-xx-xx-xx-xx-xx-xx

Deletes a WPAN device ID from the CTM-200’s registered WPAN devices list.

xx-xx-xx-xx-xx-xx-xx-xx WPAN device ID (hex digits), hyphens are optional

Example:

cmd wpan deldev 00-13-a2-00-40-08-58-5e delete WPAN device with this ID from the registered devices list

cmd wpan deldev 0013a2004008585e above example with optional hy[hens omitted

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


Note: the CTM-200 needs to be power cycled for the new settings to take effect.

wpan dist (configure WPAN Gateway distance report message) NEW
wpan dist n

Where
n = 0, disable distance report message (default)
n = 1, enable distance report message for PANIC, MPANIC and FPANIC

cmd wpan dist returns the current value

Example:
  1. / # cmd wpan dist 1
    OK
    / # cmd wpan dist
    cmd wpan dist 1
    OK
    / #
wpan panid (WPAN accessory set PAN id, query PAN id)
wpan panid xxxx

Set the WPAN PAN ID to communicate with the WPAN devices.

xxxx WPAN PAN ID (hex digits)

Using wpan panid without a PAN ID, queries the WPAN PAN ID currently configured in the CTM-200.

Example:

cmd wpan panid 2000 change the WPAN PAN ID to 0x2000
cmd wpan panid queries the current WPAN PAN ID


Note: A cmd save and a power cycle must occur for the new settings to take effect.

wpan pensrv (WPAN server for remote access to Man Down Pendant devices)
wpan pensrv x yyyy

Configure the listening protocol and port of the Pendant Server that provides remote access to Man Down Pendant devices.

x = 0 UDP protocol (default)
x = 1 TCP protocol
yyyy = 0 to 65535 port number of listening port, in decimal (0 = disabled, default)

Using wpan pensrv without arguments returns the currently configured protocol and port in the CTM-200

Note:

If the CTM-200 is currently in WPAN Gateway mode, mode 10, and any other LAN or firewall configuration commands are set after issuing the wpan pensrv command, then both a cmd save and a power cycle are required to resume proper remote access to Pendant devices through wpan pensrv.

Example:

cmd wpan pensrv 0 21001 change the Pendant Server to listen on UDP port 21001

cmd wpan pensrv 1 21002 change the Pendant Server to listen on TCP port 21002

cmd wpan pensrv queries the current Pendant Server settings

A cmd save and a power cycle must occur for the new settings to take effect.


See also: mode

wpan secure (secure WPAN server for use with SSH tunneling)
wpan secure

Secure access to the CTM-200's WPAN Pendant Server from the Internet.
If enabled, it will not be possible to remotely access the WPAN Pendant Server via the port specified in wpanpensrv 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 WPAN Pendant Server from Internet (default)
n = 1 secure - do not allow direct access to WPAN Pendant Server from Internet

The current status of the WPAN Pendant Server secure access setting can be queried by using the wpan secure command without parameters.

Examples:

1. Set the CTM-200 to secure access to WPAN Pendant Server from Internet:
/ # cmd pad secure 1
OK

2. Query the current setting:
/ # cmd pad secure
cmd pad secure 0
OK

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


See also: wpanpensrv

wpan stm (select internal gateway)
wpan stm n

Configure the CTM-200 to use the internal WPAN Gateway

n = 0 do not use internal WPAN Gateway (default)
n = 1 use internal WPAN Gateway

Examples:

1. Set the CTM-200 use the internal WPAN gateway for WPAN accessories:
/ # cmd wpan stm 1
OK

2. Query the current setting:
/ # cmd wpan stm
cmd wpan stm 0
OK

A cmd save followed by a power cycle is required for this command to take effect.
X
  • No commands
Y
  • No commands
Z
  • No commands
Subscribe to our
free newsletter