Cypress Chameleon CTM-15X Complete Manual

Download

Page 1

COMPLETE MANUAL

Model

Revision:

Chameleon CTM-15X

modem

Firmware 1.2.0

Revision 1.0

3066 Beta Avenue Burnaby, B.C. V5G 4K4 Phone: 604.294.4465 Fax: 604.294.4471 support@cypress.bc.ca

Page 2

Notice

Due to the nature of wireless communication the reception or transmission of data can never be guaranteed. Data may be delayed, corrupted or never received. Data transfer problems are rare with well-constructed and configured wireless networks used in conjunction with devices such as the CTM-15X wireless data device. Cypress Solutions Inc. accepts no responsibility for damages of any kind including but not limited to personal injury, death, or loss of property due to the delay or loss of data resulting from the use of the CTM-15X wireless data device.

Safety & hazards

Wireless transmitters can cause interference with some critical operation equipment. For this reason it is required that the RF portion of the CTM-15X Series wireless data device be turned off when in the vicinity of blasting operations, medical equipment, life support equipment, or any other equipment that is susceptible to radio interference. The CTM-15X series wireless data device must be turned off when onboard or in the vicinity of any aircraft. The FAA prohibits the use of wireless transmitter equipment at any time during aircraft flight.

2 0BActivating Your Modem

Regulatory restrictions

CAUTION: Any modifications to the CTM-15X series wireless data device not expressly authorized by Cypress Solutions Inc. may cause its regulatory approval status to become invalidated, thereby voiding your authority to use the product.

The CTM-15X series wireless data device contains a wireless device approved under FCC CFR 47 part

2.1091 and Industry Canada RSS-102 rules for operation as a mobile or fixed device with its specified antenna of gain ≤6dBi and from which a separation distance of at least 20cm (8”) must be maintained from all persons at all times and during all modes of operation. The antenna used must not be co-located or operated in conjunction with any other antenna or transmitter. These rules are in place to prevent any possible hazard due to personal exposure to electromagnetic radiation.

The CTM-15X series devices are designed to operate with approved wireless cards installed. These cards will have their own FCC and Industry Canada approval ID numbers. Contact Cypress Solutions for a complete updated list of supported Wireless cards/modules.

Electromagnetic Interference (EMI) – United States FCC Information

This equipment has been tested and found to comply with limits for a class A digital device, pursuant to part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference in a commercial installation. This equipment generates, uses, and can radiate radio frequency energy, and if not installed and used in accordance with the instructions, may cause harmful

Complete Manual: CTM-15X Firmware 1. 2.0

Page 3

interference to radio communication. However, there is no guarantee that harmful interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:

• reorient or relocate the receiving antenna

• increase the separation between the equipment and receiver

• connect the equipment into an outlet on a circuit different from that to which the receiver is

connected

• consult the dealer or an experienced radio/TV technician for help

Electromagnetic Interference (EMI) – Canada Information

This digital apparatus does not exceed the class A limits for radio noise emissions from digital apparatus as set out in the interference causing equipment standard entitles “Digital Apparatus”, ICES-003 of the Department of Communications.

3 0BActivating Your Modem

Cet appareil numérique respecte les limites de bruits radioélectriques applicables aux appareils numériques de Classe A prescrites dans la norme sur le matériel brouilleur: “Appareils Numériques”, NMB-003 édictée par le Ministre des Communications.

Trademarks

All brand or product names, trademarks, logos, etc. used in this manual are owned by their respective companies.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 4

Notice .......................................................................................................................................................... 2

Safety & hazards ......................................................................................................................................... 2

Regulatory restrictions ................................................................................................................................ 2

Electromagnetic Interference (EMI) – United States FCC Information....................................................... 2

Electromagnetic Interference (EMI) – Canada Information ....................................................................... 3

Trademarks ................................................................................................................................................. 3

1 Activating Your Modem .......................................................................................................................... 9

1.1 Gather Account Information .............................................................................................................. 9

1.1.1 CDMA/EV-DO devices ............................................................................................................... 9

1.1.2 GSM/GPRS/HSPA devices .......................................................................................................... 9

1.2 Embedded Web Page Activation ....................................................................................................... 9

1.2.1 Automatic Activation via Modem Embedded Web Browser .................................................... 9

4 0BActivating Your Modem

1.2.2 Manual Activation via Modem Embedded Web Browser ....................................................... 10

1.3 Command Line Activation ................................................................................................................ 10

1.3.1 Automatic Activation (OTASP) ................................................................................................ 11

1.3.2 Manual Activation ................................................................................................................... 11

2 Installing Your Modem .......................................................................................................................... 12

2.1 Mounting ......................................................................................................................................... 12

2.2 Connecting the Power Cable ............................................................................................................ 14

2.3 Connecting the Ethernet Cable ........................................................................................................ 14

2.4 Mounting and Attaching the Cell Antenna ...................................................................................... 14

2.5 Mounting and Attaching the GPS Antenna ...................................................................................... 15

2.6 Serial Data Cable Connection ........................................................................................................... 15

2.7 Connecting to the I/O Port ............................................................................................................... 15

2.7.1 Output Connection .................................................................................................................. 16

2.7.2 Input Connection ..................................................................................................................... 16

3 Operating Your Modem ........................................................................................................................ 17

3.1 Automatic Power Control ................................................................................................................ 17

3.2 Power Consumption ........................................................................................................................ 18

3.3 Device Reset ..................................................................................................................................... 18

3.4 LED Indicators .................................................................................................................................. 19

3.5 Making a Wireless Network Connection ......................................................................................... 20

3.6 GPS Operation .................................................................................................................................. 20

4 Connecting to a CTM-15X Modem Locally ............................................................................................ 21

Complete Manual: CTM-15X Firmware 1. 2.0

Page 5

4.1 Ethernet ........................................................................................................................................... 21

4.2 Telnet ............................................................................................................................................... 21

4.3 Browser ............................................................................................................................................ 22

4.4 Serial ................................................................................................................................................ 23

5 Connecting to a CTM-15X Modem Remotely ....................................................................................... 24

6 List of Commands .................................................................................................................................. 25

6.1.1 A .............................................................................................................................................. 25

6.1.2 B............................................................................................................................................... 25

6.1.3 C ............................................................................................................................................... 25

6.1.4 D .............................................................................................................................................. 25

6.1.5 E ............................................................................................................................................... 26

6.1.6 F ............................................................................................................................................... 26

5 0BActivating Your Modem

6.1.7 G .............................................................................................................................................. 26

6.1.8 I ................................................................................................................................................ 26

6.1.9 L ............................................................................................................................................... 27

6.1.10 M .......................................................................................................................................... 27

6.1.11 N........................................................................................................................................... 27

6.1.12 O .......................................................................................................................................... 27

6.1.13 P ........................................................................................................................................... 28

6.1.14 R ........................................................................................................................................... 28

6.1.15 S ........................................................................................................................................... 29

6.1.16 T ........................................................................................................................................... 29

6.1.17 U........................................................................................................................................... 29

6.1.18 V ........................................................................................................................................... 29

6.1.19 W.......................................................................................................................................... 30

7 Command Reference ............................................................................................................................ 31

7.1.1 “A” Commands ........................................................................................................................ 31

7.1.2 “B” Commands ........................................................................................................................ 31

7.1.3 “C” Commands ........................................................................................................................ 32

7.1.4 “D” Commands ........................................................................................................................ 33

7.1.5 “E” Commands ........................................................................................................................ 36

7.1.6 “F” Commands ........................................................................................................................ 38

7.1.7 “G” Commands ........................................................................................................................ 40

7.1.8 “I” Commands ......................................................................................................................... 49

Complete Manual: CTM-15X Firmware 1. 2.0

Page 6

7.1.9 “L” Commands......................................................................................................................... 58

7.1.10 “M” Commands ................................................................................................................... 61

7.1.11 “N” Commands .................................................................................................................... 68

7.1.12 “O” Commands .................................................................................................................... 69

7.1.13 “P” Commands..................................................................................................................... 74

7.1.14 “R” Commands .................................................................................................................... 90

7.1.15 “S” Commands ................................................................................................................... 100

7.1.16 “T” Commands ................................................................................................................... 110

7.1.17 “U” Commands .................................................................................................................. 111

7.1.18 “V” Commands .................................................................................................................. 113

7.1.19 “W” Commands ................................................................................................................. 115

8 Report Messages ................................................................................................................................. 120

6 0BActivating Your Modem

8.1 Message Type 03, PMID ................................................................................................................. 120

8.2 Message Type 16, $GPGLL ............................................................................................................. 121

8.3 Message Type 20, PIND ................................................................................................................. 121

8.4 Message Type 21 to 26, PINA ........................................................................................................ 122

8.5 Message Type 30, PCTM ................................................................................................................ 122

8.6 Message Type 40, ID= .................................................................................................................... 123

8.7 Message Type 80, $GPGGA ............................................................................................................ 123

8.8 Message Type 82, GPRMC ............................................................................................................. 124

8.9 Message Type 84, $GPGSA ............................................................................................................ 124

8.10 Message Type 85, ULCP binary position message with GPS coordinates ................................ 125

8.11 Message Type 88, ULCP message with Acceleration/Deceleration and GPS information ....... 125

8.12 Message Type 89, ULCP binary format, Modem ID/Firmware, Revision/Odometer value ...... 126

8.13 Message Type 90, ULCP binary format, Odometer value ......................................................... 126

8.14 Message Type 98, ULCP binary format, Digital Inputs plus GPS data ....................................... 127

8.15 Message Type 100, Trimble proprietary TAIP PV message ...................................................... 127

8.16 Message Type 101, Trimble Proprietary LN message ............................................................... 128

8.17 Message Type 112, ULCP binary format, Digital input and Output states, Modem ID and GPS data 128

8.18 Message Type 114, $PGPS ........................................................................................................ 129

8.19 Message Type 115, $PKML ....................................................................................................... 130

8.20 Message Type 116, $PPWR ....................................................................................................... 130

8.21 Message Type 117, $PRFI ......................................................................................................... 131

Complete Manual: CTM-15X Firmware 1. 2.0

Page 7

8.22 Message Type 117, $PRFI ......................................................................................................... 131

8.23 Message Type 118, $GPGSV ..................................................................................................... 132

8.24 Message Type 119, $POBDA ..................................................................................................... 132

8.25 Message Type 120, $POBDB ..................................................................................................... 133

8.26 Message Type 121, $POBDC ..................................................................................................... 133

8.27 Message Type 122, $POBDD ..................................................................................................... 134

8.28 Message Type 136, $PACCEL .................................................................................................... 134

8.29 Message Type 137, $PODO ....................................................................................................... 135

9 Email Message Format ........................................................................................................................ 135

10 MODBUS Messages ........................................................................................................................ 136

10.1 Read Digital Outputs ................................................................................................................. 136

10.2 Set Digital Output ..................................................................................................................... 137

7 0BActivating Your Modem

10.3 Read Digital Inputs .................................................................................................................... 137

10.4 Read Analog Inputs ................................................................................................................... 138

10.5 Error response .......................................................................................................................... 139

10.6 MODBUS TCP Messages ........................................................................................................... 139

11 ULCP Remote Configuration Messages.......................................................................................... 140

11.1 ULCP Message Format .............................................................................................................. 140

11.2 ULCP Remote Configuration Messages .................................................................................... 141

11.2.1 Set Digital Outputs ............................................................................................................. 141

11.2.2 NMEA GGA Query .............................................................................................................. 141

11.2.3 NMEA RMC Query ............................................................................................................. 141

11.2.4 ULCP Binary Position Query ............................................................................................... 142

11.2.5 Time Based Reporting ........................................................................................................ 142

11.2.6 Delta Position Based Reporting ......................................................................................... 143

11.3 Examples ................................................................................................................................... 144

11.3.1 1. Set all OUTPUT ports(1~4) on ........................................................................................ 144

11.3.2 2. Set Delta Position Based Reporting ............................................................................... 145

12 Technical Specifications ................................................................................................................. 145

12.1 FCC/IC Approvals ...................................................................................................................... 145

12.2 Temperature ............................................................................................................................. 145

12.3 Humidity ................................................................................................................................... 145

12.4 Vibration ................................................................................................................................... 146

12.5 Shock ......................................................................................................................................... 146

Complete Manual: CTM-15X Firmware 1. 2.0

Page 8

12.6 Sealing ....................................................................................................................................... 146

12.7 Material..................................................................................................................................... 146

12.8 Power Supply ............................................................................................................................ 146

12.9 Host Connectivity ...................................................................................................................... 146

12.10 I/O ............................................................................................................................................. 147

12.11 RF .............................................................................................................................................. 147

12.11.1 CDMA/EV-DO ..................................................................................................................... 147

12.11.2 GSM/GPRS/HSPA ............................................................................................................... 147

12.12 GPS ............................................................................................................................................ 147

12.13 Physical ..................................................................................................................................... 148

13 Technical Support .......................................................................................................................... 148

8 0BActivating Your Modem

Complete Manual: CTM-15X Firmware 1. 2.0

Page 9

1 Activating Your Modem

1.1 Gather Account Information

1.1.1 CDMA/EV-DO devices

For Sierra Wireless AC595/AC597/AC598/AC580 CDMA/EV-DO devices, the following information is typically required:

• Phone number (10-digit MDN)

• Lock code (6-digit CSL)

• User name (number@… format)

• Password

• Dial number (usually #777)

For all other manufacturer data devices and cards, network activation of the device must be done in a laptop prior to installing in the modem.

9 0BActivating Your Modem

1.1.2 GSM/GPRS/HSPA devices

For GSM/GPRS/HSPA devices, the following information is required:

• An activated SIM card needs to be installed in the Modem or data card

• cmd factory gsm must be entered

Note: TRU-install™ must be disabled on devices that support the TRU-install™ feature prior to installation into the modem, or activation will not be successful

1.2 Embedded Web Page Activation

Note: Activation via the modem Embedded web browser is supported only on Sierra Wireless AC595, AC597 Express Card, AC597/8 USB and AC580 data devices with the TRU-install™ feature disabled. For all

other devices, activate the device using a laptop

1.2.1 Automatic Activation via Modem Embedded Web Browser

On the OTASP (Over-The-Air Service Provisioning) page, click Initiate to start the OTASP processing, depending on the programming data on the modem card, one or more of the following messages will be displayed on the OTASP page’s status window:

• SPL Unlocked

• Authentication key has been updated

• Shared secrets data has been exchanged

Complete Manual: CTM-15X Firmware 1. 2.0

Page 10

• 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, the "OTASP Timeout" message and the "OTASP Disconnected" message will be displayed. To retry the OTASP process, click Initiate to re-start. When the OTASP process is complete and the provisioning parameters have been committed the "OTASP Disconnected" message will be displayed.

Click Initiate and cycle the power on the modem.

1.2.2 Manual Activation via Modem Embedded Web Browser

On the Activate page, enter the Lock code (CSL), the Phone number (MDN), and the Mobile Identification Number (MIN).

10 0BActivating Your Modem

CSL, MDN and MIN are all required to successfully activate the data device.

The MIN entry is provided to add support for the Wireless Number Portability (WNP). If you were provided with a MIN from your service provider then enter the 10-digit number in the MIN field and enter the Lock code (CSL). If you were not provided with a MIN then copy the 10-digit number for the MDN in the MIN field and enter the Lock code (CSL).

Click Submit and cycle the power on the modem.

1.3 Command Line Activation

Note 1: Command line activation can be via a local telnet session or console session via the modem serial interface

Note 2: Activation via the command line interface is supported only on Sierra Wireless AC595, AC597 Express Card, AC597/8 USB and AC580 data devices with the TRU-install™ feature disabled. For all other devices, activate the device using a laptop

There are two methods, OTASP is a single command entry and the simplest, if OTASP does not work follow the Manual Activation instructions.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 11

1.3.1 Automatic Activation (OTASP)

At # prompt, type the command:

cmd otasp and press Enter.

This command is used to perform automatic wireless network activation and updates any required network related files that are embedded in the wireless modem. The modem responds with one or more of the following messages:

• SPL Unlocked

• Authentication key has been exchanged

• Shared secrets data has been updated

• New NAM parameters have been downloaded

• New MDM has been downloaded

• IMSI has been downloaded

• PRL has been downloaded

11 0BActivating Your Modem

During updating, if any of the data is unsuccessful, the "OTASP Timeout" message and "OTASP Disconnected" message will be displayed. A progress message reading "OTASP Processing" will be displayed every 10 seconds. When the OTASP process has successfully completed and the provisioning parameters have been committed, a message "OTASP Disconnected" message will be displayed.

1.3.2 Manual Activation

At # prompt, type the following commands:

cmd spc pppppp where pppppp is the 6 digit lock code

cmd dir nnnnnnnnnn where nnnnnnnnnn is the 10 digit MDN phone number cmd pwrmode 2 power cycle the modem

The MIN entry is provided to add support for Wireless Number Portability (WNP) and also needs to be set

on the modem by entering the following commands:

If no MIN is provided use the MDN number provided.

cmd spc pppppp where pppppp is the 6 digit lock code cmd dir + nnnnnnnnnn where nnnnnnnnnn is the 10 digit MIN number cmd pwrmode 2 power cycle the modem

Complete Manual: CTM-15X Firmware 1. 2.0

Page 12

2 Installing Your Modem

2.1 Mounting

The CTM-15x is provided with a flexible mounting bracket that has eight 5mm mounting holes suitable for #10 screws. These may be used to screw or bolt the device to a suitable surface – take care not to overtighten these screws and damage the bracket. Once this has been installed in the required location the modem clips into the 4 tabs of the bracket. The bracket can be used as drill guide template. There are a total of 8 mounting holes, (2, 4 hole patterns, 2 x 5.5 and 1.75 x 3.75)

12 1BInstalling Your Modem

Complete Manual: CTM-15X Firmware 1. 2.0

Page 13

13 1BInstalling Your Modem

The modem can be installed in any orientation, but it is suggested that the modem not be mounted with the interconnect face directed upwards as this can allow liquids to enter the modem.

The modem should be mounted in an area where it is free from excessive dust and liquids.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 14

2.2 Connecting the Power Cable

The power cable has three wires: Red +V supply (+9 to +36VDC) Black 0V return White Standby (+V for operation, Off for standby) A 5 Amp “slow-blow” fuse is recommended in the +V supply line.

14 1BInstalling Your Modem

The operate/standby switch may, for example, be the accessory position on a vehicle ignition switch. In order to minimize the acquisition time of the GPS module in the CTM-15x at power on, it is recommended to keep the +V supply connected – this will provide the “keep-alive” power required by the GPS module to maintain its internal almanac.

2.3 Connecting the Ethernet Cable

Plug one end of a standard Ethernet patch cable into the CTM-15x Ethernet port, and the other end into the LAN device, PC or Ethernet peripheral. The Ethernet port is compatible with 10Base-T or 100Base-T

connection types.

2.4 Mounting and Attaching the Cell Antenna

The antenna used with the CTM-15x must be a type suitable for operation on the network for which the modem is activated. For CDMA/EV-DO/GPRS/HSPA networks this is typically a dual band 800 Mhz and 1900 Mhz antenna.

For optimum performance the antenna should be mounted in a vertical orientation as high up as possible and with clear line of sight in all directions. For regulatory purposes it must be mounted in such a position as to maintain a separation distance from any person of at least 20cm (8”).

Complete Manual: CTM-15X Firmware 1. 2.0

Page 15

RxD

Received Data (by DTE)

CTM-15x to PC

DTR

Data Terminal Ready

PC to CTM-15x

The modem antenna connector is a standard SMA female type that requires the antenna cable to use a male SMA connector. The CTM-15x can be provided with alternate antenna connector types – contact Cypress Solutions for details.

2.5 Mounting and Attaching the GPS Antenna

The GPS antenna used with the CTM-15x (with GPS) must be an active type with gain of at least 26dB and compatible with a 3.3 volt dc supply provided directly by the modem over the coax cable. The antenna

installation should typically be on an upper horizontal surface of a vehicle with a clear 360 degree view of

the sky.

The GPS antenna connector is a standard MCX type or SMA female depending on whether the CTM-15X modem is PC-CARD based or Express card/module/USB based. The CTM-15x can be provided with alternate antenna connector types – contact Cypress Solutions for details.

15 1BInstalling Your Modem

2.6 Serial Data Cable Connection

The serial data port is a standard DB9 female connector configured as Data Communication Equipment (DCE) and is wired as per the table below.

DB9 Pin Signal Name Direction

1 DCD Data Carrier Detect CTM-15x to PC

3 TxD Transmitted Data (by DTE) PC to CTM-15x

5 GND Signal Ground 6 DSR Data Set Ready CTM-15x to PC 7 RTS Request To Send PC to CTM-15x 8 CTS Clear To Send CTM-15x to PC 9 RI Ring Indicator CTM-15x to PC

Serial data ports on most computer equipment are configured as Data Terminal Equipment (DTE) with a

DB9 male connector. A standard serial data cable will allow for direct connection of the CTM-15x to most

computer and terminal equipment. In some cases it may be necessary to insert a “null modem” or “gender changer” in the serial data line in order to correctly connect between the devices.

2.7 Connecting to the I/O Port

The I/O port provides for the control of 4 external devices and for monitoring 6 external sensors.

Connections are made via the 12 position connector.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 16

OUT1 OUT3 OUT GND IN1 IN3 IN5

1 3 5 7 9 11 2 4 6 8 10 12

OUT2 OUT4 GND IN2 IN4 IN6

2.7.1 Output Connection

The 4 outputs are configured as “open drain” which means that they can be directly connected to

energize external relays, lamps or other DC devices.

Maximum supply voltage is 36 volts, with a maximum load current of 500mA.

Recommended wire gauge for use with the connector is 16AWG. Note that the OUT GND connection is referenced to the modem’s supply ground.

16 1BInstalling Your Modem

2.7.2 Input Connection

The 6 inputs may be configured in the modem for monitoring a digital DC voltage state or an analog DC

voltage.

For digital state monitoring the minimum input voltage is 0 volts while the maximum is 36 volts.

The threshold detection voltage is 2.5 volts with 1 volt of hysteresis. Note that the IN GND connection is referenced to the modem’s supply ground.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 17

For analog voltage monitoring the measurement range is 0 to +10 volts with 10mV resolution. The input

can withstand up to 36 volts. Note that the IN GND connection is referenced to the modem’s supply

ground.

17 2BOperating Your Modem

3 Operating Your Modem

3.1 Automatic Power Control

The supply voltage must be a minimum of 9VDC for the CTM-15x to operate. With the power applied it will power-up in its operating mode.

Note: In some vehicle operation, when starting the engine the vehicle supply voltage will dip below 9VDC momentarily. This will cause the modem to reset as the power dips below 9VDC. If continual operation is required, contact Cypress Solutions for an accessory power regulator that plugs in-line with the modem power supply. This power regulator will prevent unnecessary resets.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 18

Shutdown

Only the modem’s power

The device will go back into operation mode when the

Power Consumption

Weak RF

Strong RF

Weak RF

Strong RF

The CTM-15x Chameleon device has two power modes:

Mode Description Mode change event

Operation In this mode the device is fully

powered up and ready to receive or make network connections

The device will go back into shutdown mode when the ignition/standby signal is deactivated or upon expiry of the power ON timer as configured.

18 2BOperating Your Modem

management circuits are operating.

ignition/standby signal is activated, an input event occurs, or upon expiry of the power OFF timer as configured.

The CTM-15x can be configured to remain on for a defined period after the standby/ignition signal has been turned off. This enables the modem to continue sending position reports or be used for data operations even after the vehicle ignition has been switched off – e.g. for short duration driver breaks.

When in its power shutdown mode the modem may be configured to resume full operation by either the standby/ignition signal becoming active, an input event occurring, or the power OFF timer expiring.

3.2 Power Consumption

The power consumption of the CTM-15x modem will depend on its supply voltage, its current operating function and its RF environment.

The following table is provided to assist application integrators in defining the power requirements for their specific application.

signal(12V)

Shutdown Mode 1.5mA typical 1.5mA typical 2.0mA typical 2.0mA typical Downloading (Receive

450mA max 350mA max 220mA max 195mA max

data) Uploading (Transmit

500mA max 390mA max 260mA max 210mA max

data)

3.3 Device Reset

The CTM-15X modem may be manually reset via the front panel using a <1mm diameter (0.04”) wire tool (a standard paper clip). This can be used to cause the modem to reset its operation, or to enter its

standby power mode.

reset: Press and hold for 0.25 to 1 second

Complete Manual: CTM-15X Firmware 1. 2.0

signal(12V)

signal(24V)

Page 19

CELL

status of the device on

device is connected

N/A

device is not

shutdown: Press and hold for 2 to 5 seconds (the PWR LED will go off at the 2-second mark). Press again for more than 0.25 second to return to operating mode.

3.4 LED Indicators

There are five LED indicators on the CTM-15x top. These are used to show the status and operation of the device.

19 2BOperating Your Modem

For Sierra Wireless/Kyocera Wireless CDMA/EV-DO data devices or modules:

LED Description Solid Blinking Off

PWR Power status of the

device

CELL status of the device on

the wireless network

TX/RX data is being

transmitted or received

GPS status of the GPS

module

full operating mode and able to connect

receiving a signal greater than or equal

device is in shutdown mode

receiving a signal less than -95dBm

to -95dBm N/A Data is being

transmitted or received

GPS module has obtained a valid

GPS module does not have a valid position fix

the device has no power

device is not detecting a valid RF signal

no data is being transmitted or received

position fix

3G indicates the type of

wireless data connection

EV-DO Rev A (typical downlink 450 to

800kbps)

EV-DO Rev 0 (typical

downlink 400 to 700

kbps)

1xRTT (typical

downlink 40 to 100 kbps)

For Sierra Wireless HSPA, Novatel Wireless, Option or other Manufacturer devices:

LED Description Solid Blinking Off

PWR Power status of the

device

the wireless network

Complete Manual: CTM-15X Firmware 1. 2.0

full operating mode and able to connect

to the wireless network

device is in shutdown mode

the device has no power

connected to the wireless network

Page 20

20 2BOperating Your Modem

TX/RX data is being

transmitted or received

GPS status of the GPS

module

3G indicates the type of

N/A Data is being

transmitted or

received GPS module has obtained a valid position fix

GPS module does not

have a valid position

fix N/A N/A N/A)

no data is being transmitted or received

wireless data connection

3.5 Making a Wireless Network Connection

The CTM-15X will attempt to connect to the wireless network whenever power is applied, when configured with cmd mode 2 (default)

If no wireless network connection is available the IP address will be given as 0.0.0.0. This can be queried using cmd ipadr For Sierra Wireless RF devices, wireless signal strength information can be queried using cmd rssi. These values for both 1x and EV-DO are given in dBm with range typically -60dBm (very good) to

-105dBm (weak).

With the wireless network connection active you may now open Windows® applications that will make use of this connection – this includes email, web browsers, and VPN connections.

3.6 GPS Operation

The GPS module in the CTM-15X Modem will continuously track the unit’s position whenever power is applied and the GPS antenna has a clear view of the sky. The time taken for the module to achieve a valid positional fix is determined by the previous state of the unit:

For a “cold” start (after all power is applied to the modem) the acquisition time typically will be less than 50 seconds.

For a “warm” start (standby power is maintained to the CTM-15x) the acquisition time will typically be less than 38 seconds.

For reacquisition (after the GPS module has temporarily lost signal) the time to acquire a valid position fix

is typically less than 2 seconds.

The GPS information can be sent by the device as a message in any of the configured reports.

The GPS receiver uses the WGS-84 datum.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 21

4 Connecting to a CTM-15X Modem Locally

The CTM-15X modem has 2 interface ports available for configuration:

• Ethernet

• Serial

4.1 Ethernet

The ethernet port supports a telnet session and an internet browser session. Note: If your PC or Laptop is part of an existing network, you may have to disable/reconfigure your existing network settings.

4.2 Telnet

21 3BConnecting to a CTM-15X Modem Locally

With the device powered up and connected directly to a PC with an Ethernet cable, access the command

prompt: Start/All Programs/Accessories/Command Prompt Enter the command: telnet 192.168.1.1 (this is the local IP address of the CTM-15x )

The CTM-15x will respond with its login prompt:

Complete Manual: CTM-15X Firmware 1. 2.0

Page 22

At the login prompt, type in admin (default user name). At the password prompt type in Chameleon (default password, case sensitive).

A # prompt will be displayed indicating you now have access to the device command line interface:

22 3BConnecting to a CTM-15X Modem Locally

4.3 Browser

Open an internet browser and enter the address:

http://192.168.1.1

The browser will redirect to a web page requiring a username and password. At the login prompt, type in admin (default user name). At the password prompt type in Chameleon (default password, case sensitive). After successful login you will have access to a web browser based configuration. Notes:

• Not all device functionality is supported by the web browser interface. To access all device

commands please use the command line interface.

• The embedded web server can only be used with a single client session at any time.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 23

• Only 1 I/O input signal can be set from the embedded web page.

• Both GPS and IO report web pages are limited and cannot set all conditions, including minimum

time between reports.

4.4 Serial

With the device powered up and connected directly to a PC or Laptop with a serial cable, start up a terminal emulation program such as Windows HyperTerminal or similar application. Configure the terminal emulation program with the following parameters:

• Data rate: 115,200 baud

• Data bits: 8

• Parity: None

• Stop bits: 1

• Flow control: None

Note: The above settings are the device default settings; they can be configured using the cmd port command.

Press the Enter key to return the # prompt:

23 3BConnecting to a CTM-15X Modem Locally

Complete Manual: CTM-15X Firmware 1. 2.0

Page 24

5 Connecting to a CTM-15X Modem Remotely

Please note:

• It is highly recommended to test all device configuration and operation before deploying devices

to remote locations.

• Not all wireless networks offer "public" IP addresses that are remotely accessible, some are

firewall protected to allow access from either the same IP pool only or restricted IP addresses. Contact your wireless network provider or administrator to determine what options are available.

• Some networks will force device IP addresses to change at regular intervals. Without proper

configuration, this could cause a remote device to become inaccessible if the device IP address is not known. The CTM-15X can be configured to send a message when its IP address changes using this command: cmd iocond

• Embedded wireless radio modules must be activated before deploying to remote locations

• Incorrectly configuring the device could cause the device to become inaccessible, take care when

issuing commands via a remote session.

There are 4 ways to configure a CTM-15X remotely:

• Telnet (most flexible, allows access to the complete repository of remote commands)

• Device Embedded Web Page (provides access to a limited sub-set of device commands, used

typically for quick configuration of basic commands)

• SMS (Allows commands to be sent to the modem via SMS, this command only applies to devices

with embedded Sierra Wireless CDMA/EV-DO revision A cards,USB modems or modules)

• ULCP (Allows configuration of digital outputs only using ULCP binary format)

• For telnet to work with a remote device cmd rmttelnet 1 must be set.

For access to the Device embedded web page, cmd rmtweb 1 must be set.

Telnet and Device Embedded Web Page Configuration Follow the directions for telnet configuration listed in How To Connect to a CTM-15X Modem - Locally

and substitute 192.168.1.1 with the known IP address of the remote device.

SMS configuration No configuration of the CTM-15X is required for the modem to accept SMS commands. The commands via SMS feature is supported only on CTM15x modems installed with Sierra Wireless cards and running firmware release R1.2.0. This feature is built into the firmware and no additional modem configuration is required to enable commands via SMS.

CTM-15X commands may be issued via a SMS text message sent from a mobile phone or from a cell phone carrier’s web site for execution on the CTM15x modem upon receiving the SMS message. One or more commands may be included in the body of a SMS text message up to a maximum message size of

166 characters. The destination of such a SMS message is the phone number of the modem, which may

be obtained by entering cmd dir from a Telnet or serial port console session.

24 4BConnecting to a CTM-15X Modem Remotely

Complete Manual: CTM-15X Firmware 1. 2.0

Page 25

Message format for CTM15x commands via SMS: NNNN:<command> <parameters> … NNNN:<command> <parameters> … (up to 166 characters) Where:

NNNN is the last 4 digits of the modem's ESN <command> is the command to be executed. cmd should not be included in <command> and commands

do not have to be separated by a linefeed (<CR><LF>)

<parameters> are the parameters for each command

Example: If the last 4 digits of the modem’s ESN are 1234 Two commands separated by a space in SMS message 1234:gpsremip 2 123.456.78.900 1234:save

Three commands separated by <CR><LF> for each line of the SMS message: 1234:gpsremip 2 123.456.78.900 1234:gpsremport 2 15000 1234:save

ULCP configuration

ULCP configuration is performed by sending properly formatted binary messages to port 6100 of the remotely connected device. see ULCP Remote Configuration Messages for message format.

25 5BList of Commands

6 List of Commands

6.1.1 A

apn (set carrier access-point name) (see pg. 31)

6.1.2 B

boomreport (set the boom tracker report) (see pg. 31)

6.1.3 C

confupgrade (configures the modem for automatic configuration capability) (see pg. 32) ctmsts (CTM status) (see pg. 33)

6.1.4 D

dir (set NAM phone number,MDN,MIN) (see pg. 33) dout (digital outputs) (see pg. 34)

Complete Manual: CTM-15X Firmware 1. 2.0

Page 26

dyndns (dynamic DNS) (see pg. 35)

6.1.5 E

emailsrv (set email server) (see pg. 36) enghours (calculate engine hours) (see pg. 36) enghrmode (used to configure enghours command) (see pg. 37) esn (electronic serial number) (see pg. 37) ethernet (Enable/Disable Ethernet services) (see pg. 38)

6.1.6 F

factory (restores modem settings to factory default settings) (see pg. 38) firewall (Firewall – Port forwarding) (see pg. 39)

26 5BList of Commands

6.1.7 G

gpsaccel (GPS report trigger for hard acceleration and deceleration events) (see pg. 40) gpsaddmes (add GPS messages to a report) (see pg. 40) gpscond (GPS report trigger conditions) (see pg. 41) gpsdelmes (delete GPS message) (see pg. 43) gpsemail (GPS email address) (see pg. 43) gpsgga (GPS GGA message) (see pg. 44) gpslocport (GPS local port) (see pg. 44) gpsmes (GPS messages) (see pg. 45) gpsremip (GPS remote IP) (see pg. 45) gpsremport (GPS remote port) (see pg. 46) gpsrep (GPS reporting) (see pg. 46) gpsrmc (GPS RMC message) (see pg. 48) gpssms (set destination of GPS SMS report) (see pg. 48)

6.1.8 I

igncond (ignition report trigger conditions) (see pg. 49) ignreport (set ignition trigger report) (see pg. 50) input (query input channels status) (see pg. 50) insetup (input setup) (see pg. 51) ioaddmes (add IO message) (see pg. 52) iocond (IO report trigger conditions) (see pg. 52) iodelmes (delete IO message) (see pg. 53) ioemail (IO email address) (see pg. 54) iolocport (IO local port) (see pg. 54) iomes (IO messages) (see pg. 54) ioremip (IO remote IP address) (see pg. 55)

Complete Manual: CTM-15X Firmware 1. 2.0

Page 27

ioremport (IO remote port) (see pg. 55) iorep (IO reporting) (see pg. 56) iosms (set destination of IO SMS report) (see pg. 57) ipadr (IP address) (see pg. 57)

6.1.9 L

landhcp (LAN DHCP server settings) (see pg. 58) landns (LAN DNS nameserver settings) (see pg. 58) lanip (IP address of modem on LAN) (see pg. 59) lannetmask (Netmask of modem on LAN) (see pg. 60) lanrepip (LAN IP address for local reporting) (see pg. 60)

27 5BList of Commands

6.1.10 M

mip (mobile IP) (see pg. 58) modbusadd (add MODBUS TCP slave, serial slave or self slave, query MODBUS slave gateway list) (pg. 61) modbusctm130 (enable backward compatibility with CTM13x MODBUS messages over-the-air) (pg. 63) modbusdel (delete MODBUS entry) (see pg. 63) modbusidmap (set up MODBUS ID to modem IP:port map) (see pg. 64) modbusmode (sets the MODBUS gateway mode) (see pg. 65) modbusport (sets the MODBUS port number) (see pg. 66) mode (sets connection mode) (see pg. 66) modemid (assign modem ID) (see pg. 67)

6.1.11 N

netwd (Network watchdog) (see pg. 68)

6.1.12 O

obdcond (OBD report trigger conditions) (see pg. 69) obddata (Display data obtained from OBDII transmitter) (see pg. 71) obdreport (Set report for OBD trigger) (see pg. 71) obdsp (Sets protocol used by OBDII transmitter) (see pg. 72) odometer (GPS odometer) (see pg. 73) otasp (Over-The-Air Service Provisioning) (see pg. 73)

Complete Manual: CTM-15X Firmware 1. 2.0

Page 28

6.1.13 P

pad (manual PAD initiation) (see pg. 74) padecho (PAD echo mode) (see pg. 75) padesc (PAD escape sequence) (see pg. 75) padesct (PAD escape guard time) (see pg. 76) padfwdc (PAD forwarding character) (see pg. 76) padfwdl (PAD forwarding length) (see pg. 77) padfwdt (PAD forwarding time) (see pg. 78) padip (PAD IP address) (see pg. 78) padmode (PAD mode) (see pg. 79) padport (PAD port number) (see pg. 80) padreset (PAD reset) (see pg. 81) padsvct (PAD server connection cut-off timer) (see pg. 81) pendantreport (set pendant report) (see pg. 82) ping (pings a specific IP address) (see pg. 83) pobda-pobdd (OBDII reports) (see pg. 83) port (serial port settings) (see pg. 84) ppp (Local Point to Point Protocol connection) (see pg. 85) pswd (sets password used for wireless network access via simple IP) (see pg. 85) pupcond (power up report trigger conditions) (see pg. 86) pupreport (set power up report) (see pg. 86) pwrmode (power mode) (see pg. 86) pwrsdwn (power shutdown) (see pg. 87) pwrvcct (supply voltage threshold) (see pg. 88) pwrwoe (power wake on event) (see pg. 89)

28 5BList of Commands

6.1.14 R

ratesel (Rate select for selected data devices/modules only) (see pg. 90) ratetmr (Rate Timer, Sierra Wireless CDMA/EVDO only ? ) (see pg. 91) repaddmes (add messages to a report configuration, display report configuration messages) (see pg. 91) repdelmes (delete messages from a report configuration) (see pg. 92) repemail (configure report email address) (see pg. 93) replocport (configure report local port) (see pg. 94) repremip (configure report remote IP address) (see pg. 94) repremport (configure report remote port) (see pg. 95) repsms (configure report SMS address) (see pg. 96) reptype (configure local and remote report types, store-and-forward) (see pg. 97) restore (restores last saved configuration) (see pg. 98) rmtd (reverse telnet connection) (see pg. 98) rmttelnet (remote telnet) (see pg. 99) rmtweb (Remote web access) (see pg. 99) rssi (RF signal strength) (see pg. 100)

Complete Manual: CTM-15X Firmware 1. 2.0

Page 29

6.1.15 S

saltreport (set salt-spreader report) (see pg. 100) satbackup (switch to backup satellite modem) (see pg. 101) save (saves configuration) (see pg. 102) showconfig (displays current configuration settings) (see pg. 102) showstate (displays modem state) (see pg. 103) singlepc (single pc mode) (see pg. 104) smssend (send SMS message) (see pg. 104) smstext (SMS text message) (see pg. 105) smsto (send SMS to) (see pg. 105) smsview (SMS message view) (see pg. 106) snfdelay (Store and Forward delay period before SNF starts) (see pg. 106) snfflush (Store and Forward Flush) (see pg. 107) snflog (Store and Forward log) (see pg. 107) spc (service provisioning code) (see pg. 107) speedth (speed threshold for enabling RF module of the modem) (see pg. 108) swipereport (set swipe-card report) (see pg. 108) syslog (system log) (see pg. 109)

29 5BList of Commands

6.1.16 T

telnetport (telnet port) (see pg. 110) telnetpswd (password for telnet access) (see pg. 110) telnettimeout (telnet timeout) (see pg. 111)

6.1.17 U

univwd (configure universal watchdog) (see pg. 111) univwdtimer (set universal watchdog timer interval) (see pg. 112) upgradesrv (set authorized IP for remote admin) (see pg. 112) user (sets username used for wireless network access via simple IP) (see pg. 113)

6.1.18 V

vcc (supply voltage) (see pg. 113) vcccond (supply voltage level report trigger conditions) (see pg. 114) vccreport (set supply voltage level report) (see pg. 114) ver (firmware version) (see pg. 115)

Complete Manual: CTM-15X Firmware 1. 2.0

Page 30

6.1.19 W

webpswd (password for web access) (see pg. 115) wifiwd (configures Wi-Fi Watchdog) (see pg. 116) wpanacktype (Man Down Pendant acknowledgement type) (see pg. 116) wpanadddev (WPAN accessory add device id, query device id) (see pg. 117) wpandelall (WPAN accessory delete all device ids) (see pg. 118) wpandeldev (WPAN accessory delete device id) (see pg. 118) wpanpanid (WPAN accessory set PAN id, query PAN id) (see pg. 118)

30 5BList of Commands

Complete Manual: CTM-15X Firmware 1. 2.0

Page 31

7 Command Reference

Each command is entered as:

cmd <command> <parameters>

Use a space between all parameters (no commas or other characters). Use cmd save to save modified values to non-volatile memory.

7.1.1 “A” Commands

apn <name-of-apn>

This command configures the APN(Access Point Name) for a modem. This command is only applicable to

GSM/GPRS/HSPA devices.

cmd apn

Examples:

1. Query current APN

will query current APN value

31 6BCommand Reference

cmd apn cmd apn internet.com OK

2. Set APN

cmd apn newapn.com OK

return to list of commands

7.1.2 “B” Commands

boomreport [n]

This command sets the report to be used for boom-tracker triggered reports.

n = 0 disables the report n = 1 to 999 report number boomreport requires the modem to be listening for traffic from the WPAN gateway, this requires cmd

mode 10 to be configured.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 32

Examples:

1. Use report #2 for boom-tracker triggered reports.

cmd boomreport 2 OK

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

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

return to list of commands

32 6BCommand Reference

7.1.3 “C” Commands

confupgrade script-name url username passwd

Configures the modem for over-the-air configuration by means of a custom configuration script retrieved from a defined ftp server. The command has one form, which requires 4 parameters: The script file is a text file containing modem commands used to configure a modem: For example:

cmd mode 2 cmd gpsrep 1 0 3 cmd gpscond 1 1 30 cmd gpsremip 1 123.123.123.123 cmd gpsremport 1 5005

......

....

script-name the name of the configuration script to fetch/run url the address of the ftp site (e.g. cypress.bc.ca) can also be an IP address username username to access ftp server passwd password to access ftp server

For example: 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

return to list of commands

Complete Manual: CTM-15X Firmware 1. 2.0

Page 33

ctmsts n

This command is used to configure the reporting mode of the modems status report. This status report is controlled by GPS report #11 use gpsrep, gpslocport, gpsremip, and gpsremport to configure the reporting destination.

Default destinations are: local port 6102; remote IP 0.0.0.0, remote port 6102. This report sends messages #03 (Modem ID), #30 (Network status), #80 (NMEA GGA), and #82 (NMEA RMC).

These messages can be imported and displayed using the Chameleon Viewer software utility running on a local or remote PC. The report is sent every 10 seconds.

n = 0 status reporting: disabled (default) n = 1 local reporting only (cmd gpsrep 1 1 3 0 – to enable local reporting) The current setting for the modem’s status report can be queried by using the ctmsts command without parameters

Examples: cmd ctmsts 1 switches on local status reporting cmd ctmsts queries the current configuration of status reporting A cmd save is required for this command to take effect.

return to list of commands

33 6BCommand Reference

7.1.4 “D” Commands

dir pppppppppp [qqqqqqqqqq]

This command sets the NAM (Number Assignment Module) value for the modem. It is a 10-digit phone number assigned to the modem by the service provider. Use the spc command to unlock the modem first. The NAM value may be queried by using the dir command without parameters. This command also sets the MIN (Mobile Identification Number) value for the modem. It is a 10-digit number assigned to the modem by the service provider. Use the spc command to unlock the modem first. pppppppppp 10-digit phone number (MDN) to be assigned to the modem or “+” if only MIN is to be assigned Optional Parameter: qqqqqqqqqq 10-digit phone number (MIN) to be assigned to the modem Note: Previous firmware versions included cmd min for setting the MIN value of the modem. However, cmd min has been replaced by cmd dir. Using cmd dir as shown one of the examples below are the only ways to set the MIN value of the modem.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 34

Examples:

1. Set the modem’s MDN and MIN

cmd dir 1234567890 0987654321 OK

2. Set the modem’s 10-digit number (MDN)

cmd dir 5551234567 OK

3. Set the modem’s 10-digit number (MIN)

cmd dir + 0987654321 OK

4. Query the modem’s currently assigned phone number (MDN)

34 6BCommand Reference

cmd dir cmd dir 6049998888 OK

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

http://en.wikipedia.org/wiki/Number_Assignment_Module http://en.wikipedia.org/wiki/MIN

return to list of commands

dout n x

This command is used to set the state of each of the all outputs. There are four outputs in total. n = 1 to 4 output channel number x = 0 sets output to off x = 1 sets output to on The current settings can be queried by using the dout command without parameters.

Examples:

1. Set output #2 ON

cmd dout 2 1 OK

2. Query the state of all four outputs

cmd dout cmd dout 1 0 cmd dout 2 1

Complete Manual: CTM-15X Firmware 1. 2.0

Page 35

cmd dout 3 0 cmd dout 4 0

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

return to list of commands

dyndns text1 text2 text3

This command configures the modem to perform regular updates to the Dynamic Domain Name Service. This feature creates an alias from a dynamic IP address to a static hostname allowing the modem to be more easily accessed over the Internet for remote configuration or for end application. For this feature, the modem requires a public IP address. By default this feature is disabled - “, ,”. 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 modem. For instructions on clearing the IP address associated with the hostname, please refer to DYNDNS documentation for details on using the offline hostname feature.

Examples:

1. Set the user name and password and the domain name

35 6BCommand Reference

cmd dyndns cypressdemo cypress cypresscamera2.dyndns.org OK

2. Disable DYNDNS updates

cmd dyndns 0 0 0.0.0.0 OK

3. Query the modem’s setting for this setting

cmd dyndns cmd dyndns cypressdemo cypress cypresscamera2.dyndns.org OK

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 36

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

return to list of commands

7.1.5 “E” Commands

emailsrv a.a.a.a

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

0.0.0.0 The current email server IP address can be queried by using the emailsrv without parameters.

Examples:

1. Set the email server IP address to 100.120.10.10

36 6BCommand Reference

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.

return to list of commands

enghours xxxx n

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

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 37

xxxx last 4 digits of the ESN of the modem. 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.

Note that ESN is available on some card models only and is set to 0000000000 in all other cases.

Examples:

1. Set the engine hours to 2501 for a modem with an ESN 55555551234

cmd enghours 1234 2501 OK

return to list of commands

37 6BCommand Reference

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.

return to list of commands

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 38

cmd esn 12345678901 OK

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

return to list of commands

ethernet x

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

x = 0 disable Ethernet services x = 1 enable Ethernet services

Examples:

1. Disable Ethernet services

38 6BCommand Reference

cmd ethernet 0 OK

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

return to list of commands

7.1.6 “F” Commands

factory

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

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

Example:

1. Restore modem to factory configuration

Complete Manual: CTM-15X Firmware 1. 2.0

Page 39

cmd factory OK

return to list of commands

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

This command is used to setup the port forwarding configuration of the modem. Up to 10 port forwarding configurations can be set.

The local IP address will default to 192.168.1.X, where X is extracted from iii.iii.iii.iii and 192.168.1 is

extracted from the IP address in the LAN Configuration setting.

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

The current port forward settings can be queried by using firewall without parameters. Note that LAN IP addresses used in port forwarding rules must match the LAN subnet as configured using lanip, lannetmask, and lanrepip.

Examples:

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

39 6BCommand Reference

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 40

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

return to list of commands

7.1.7 “G” Commands

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

40 6BCommand Reference

cmd gpsaccel 7 10 -10 OK

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

return to list of commands

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 CTM-15X message list

Examples:

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 41

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

return to list of commands

41 6BCommand Reference

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 42

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

42 6BCommand Reference

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.

return to list of commands

Complete Manual: CTM-15X Firmware 1. 2.0

Page 43

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, gpslocport, gpsremip, gpsremport, gpsemail, gpssms

43 6BCommand Reference

return to list of commands

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 44

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

44 6BCommand Reference

return to list of commands

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

return to list of commands

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 45

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, gpslocport, gpsremip, gpsemail, gpssms

return to list of commands

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

45 6BCommand Reference

return to list of commands

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 46

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

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

return to list of commands

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

46 6BCommand Reference

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

return to list of commands

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 47

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

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

Note: For r = 7 (SMS reports), the total length of the report must not exceed 166 characters including <CR> and <LF> The current report type configuration for a GPS report can be queried by using gpsrep n where n is the report number. If n is omitted, all reports will be queried.

Examples:

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

47 6BCommand Reference

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 48

return to list of commands

gpsrmc

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

Example:

1. Return a current GPS NMEA format GGA message

cmd gpsrmc $GPRMC,215812.00,V,4948.7177,N,11928.6161,W,000.0,000.0,280409,,*38 OK

48 6BCommand Reference

return to list of commands

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

Complete Manual: CTM-15X Firmware 1. 2.0

Page 49

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.

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

return to list of commands

49 6BCommand Reference

7.1.8 “I” Commands

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.

Complete Manual: CTM-15X Firmware 1. 2.0

Page 50

cmd igncond 2 3 OK

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

Cypress Chameleon CTM-15X Complete Manual

Specifications and Main Features

Frequently Asked Questions

User Manual