COMPLETE MANUAL Model Revision Chameleon CTM-15X Modem Firmware 1.3.0 Revision D 3066 Beta Avenue Burnaby, B.C. Phone: 604.294.4465 Fax: 604.294.4471 support@cypress.bc.
Revision Control Revision Control Description Revision Date New 1.3.
Table of Contents Table of Contents Revision Control .............................................................................................................................................. 2 Table of Contents ............................................................................................................................................ 3 1 2 Notice ...........................................................................................................................................
Table of Contents 5 4.3 Device Reset .................................................................................................................................... 18 4.4 LED Indicators .................................................................................................................................. 19 4.5 Making a Wireless Network Connection ......................................................................................... 20 4.6 GPS Operation .........................
Table of Contents 9 8.1.4 “D” Commands ......................................................................................................................... 39 8.1.5 “E” Commands ......................................................................................................................... 46 8.1.6 “F” Commands.......................................................................................................................... 48 8.1.7 “G” Commands ................................
Table of Contents 9.18 Message Type 101, Trimble Proprietary LN message ................................................................. 163 9.19 data Message Type 112, ULCP binary format, Digital input and Output states, Modem ID and GPS 163 9.20 Message Type 114, $PGPS ........................................................................................................... 164 9.21 Message Type 115, $PKML ..........................................................................................
Table of Contents 12.2.8 Delta Position Based Reporting ............................................................................................ 180 12.2.9 Download Script Files ........................................................................................................... 181 12.2.10 Trigger Reports ................................................................................................................... 182 12.3 13 Examples .................................................
Notice 1 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.
Activating Your Modem interference to radio communication. However, there is no guarantee that harmful interference will not occur in a particular installation.
Activating Your Modem 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. 2.1.
Activating Your Modem 2.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). 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).
Installing Your Modem IMSI has been downloaded PRL has been downloaded 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. 2.3.
Installing 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. © 2010 Cypress Solutions Open CTM (Revision D) Complete Manual: CTM-15X Firmware 1.3.
Installing Your Modem 3.1 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. The operate/standby switch may, for example, be the accessory position on a vehicle ignition switch.
Installing Your Modem 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. 3.4 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.
Installing Your Modem OUT1 1 2 OUT2 OUT3 3 4 OUT4 OUT GND 5 6 GND IN1 7 8 IN2 IN3 9 10 IN4 IN5 11 12 IN6 3.6.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. 3.6.
Operating Your Modem 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. 4 Operating Your Modem 4.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.
Operating Your Modem The CTM-15X Chameleon device has two power modes: Mode Description Mode change event Operation In this mode the device is fully The device will go back into shutdown mode when the powered up and ready to receive ignition/standby signal is deactivated or upon expiry of or make network connections the power ON timer as configured.
Operating Your Modem Reset: Press and hold for 0.25 to 1 second 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. 4.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.
Operating Your Modem For Novatel Wireless, Option or other Manufacturer devices: LED Description Solid Blinking PWR Power status of the full operating mode and device is in shutdown device able to connect mode CELL status of the device on device is connected to N/A the wireless network the wireless network TX/RX data is being transmitted or received GPS status of the GPS module or external GPS device (only firmware version R1.3.
Connecting to a CTM-15X Modem Locally 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.
Connecting to a CTM-15X Modem Locally The CTM-15x will respond with its login prompt: 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: © 2010 Cypress Solutions Open CTM (Revision D) Complete Manual: CTM-15X Firmware 1.3.
Connecting to a CTM-15X Modem Locally 5.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.
Connecting to a CTM-15X Modem Remotely 6 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.
Connecting to a CTM-15X Modem Remotely 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.
List of Commands 7 List of Commands 7.1.1 A agpspde (configure Assisted GPS (A-GPS) using cellular device location based features) (see pg. 32) apn (set carrier access-point name) (see pg. 33) apply (apply network / firewall and other system configuration changes) (see pg. 33) 7.1.2 B boomreport (set the boom tracker report) (see pg. 34) 7.1.3 C cardlistclear (erase approved ID list from modem) (see pg. 35) cardlistload (load approved ID list for swipe card interface) (see pg.
List of Commands 7.1.6 F firewall (Firewall – Port forwarding) (see pg. 48) freeconsole (kill serial console prompt) (see pg. 49) friends (set firewall friends list) (see pg. 49) 7.1.7 G gpsaccel (GPS report trigger for hard acceleration and deceleration events) (see pg. 51) gpsaddmes (add GPS messages to a report) (see pg. 51) gpscond (GPS report trigger conditions) (see pg. 52) gpsdata (display status of GPS input devices) (see pg. 54) gpsdelmes (delete GPS message) (see pg.
List of Commands 7.1.9 L landhcp (LAN DHCP server settings) (see pg. 72) lanip (IP address of modem on LAN) (see pg. 73) lannetmask (Netmask of modem on LAN) (see pg. 74) lanrepip (LAN IP address for local reporting) (see pg. 75) 7.1.10 M mip (mobile IP) (see pg. 75) modbusadd (add MODBUS TCP slave, serial slave or self slave, query MODBUS slave gateway list) (pg. 76) modbusctm130 (enable backward compatibility with CTM13x MODBUS messages over-the-air) (pg. 79) modbusdel (delete MODBUS entry) (see pg.
List of Commands odometer (GPS odometer) (see pg. 93) otasp (Over-The-Air Service Provisioning) (see pg. 94) 7.1.13 P pad (manual PAD initiation) (see pg. 95) padclientport (see pg. 95) padecho (PAD echo mode) (see pg. 95) padesc (PAD escape sequence) (see pg. 97) padesct (PAD escape guard time) (see pg. 97) padfwdc (PAD forwarding character) (see pg. 98) padfwdl (PAD forwarding length) (see pg. 99) padfwdt (PAD forwarding time) (see pg. 100) padip (PAD IP address) (see pg.
List of Commands replocport (configure report local port) (see pg. 120) reportscripts (configure custom scripts to be triggered when reports are generated) (see pg. 121) repremip (configure report remote IP address) (see pg. 122) repremport (configure report remote port) (see pg. 122) repsms (configure report SMS address) (see pg. 123) reptype (configure local and remote report types, store-and-forward) (see pg. 124) restore (restores last saved configuration) (see pg.
List of Commands 7.1.17 U univwd (configure universal watchdog) (see pg. 142) univwdtimer (set universal watchdog timer interval) (see pg. 143) upgradefw (upgrade firmware kernel image + root filesystem (rootfs)) (see pg. 143) upgradesrv (set authorized IP for remote admin) (see pg. 143) usepeerdns (enable/disable obtaining DNS nameserver IP addresses from carrier) (see pg. 144) user (sets username used for wireless network access via simple IP) (see pg. 145) 7.1.18 V vcc (supply voltage) (see pg.
Command Reference 8 Command Reference Each command is entered as: cmd Use a space between all parameters (no commas or other characters). Use cmd save to save modified values to non-volatile memory. 8.1.1 “A” Commands agpspde 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.
Command Reference A cmd save and a powercycle is required for this command to take effect. return to list of commands apn This command configures the APN(Access Point Name) for a modem. 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 return to list of commands apply This command applies changes to network and firewall settings.
Command Reference cmd pswd cmd firewall cmd telnetport cmd ethernet Examples: 1. Set the LAN subnet cmd lanip 192.168.2.0 cmd lannetmask 255.255.255.0 cmd apply OK return to list of commands 8.1.2 “B” Commands boomreport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8] This command sets the report(s) to be used for boom-tracker triggered reports.
Command Reference 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 return to list of commands 8.1.3 “C” Commands cardlistclear Removes list of approved swipe-card IDs from modem.
Command Reference 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 return to list of commands cardlistsave Store a list of approved swipe-card IDs for use by redboot loader swipe card reader application.
Command Reference return to list of commands cardunlockload lock-script-file-name url username passwd This command is used to load the custom unlock script associated with the swipe card interface.
Command Reference See also: modemmode, modemmodedhcp return to list of 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 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 modem commands used to configure a modem.
Command Reference 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 modem cmd confupgrade action.sh localhost will execute the script /etc/config/action.sh on the modem return to list of commands ctm15x This command is used to enable a reset of protected configuration values.
Command Reference 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 return to list of commands 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.
Command Reference 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.
Command Reference pppppppppp 10-digit phone number (MDN) to be assigned to the modem or “+” if only MIN is to be assigned Optional Parameter: qqqqqqqqqq 10-digit phone number (MIN) to be assigned to the modem Note: Previous firmware versions included cmd min for setting the MIN value of the modem. However, cmd min has been replaced by cmd dir. Using cmd dir as shown one of the examples below are the only ways to set the MIN value of the modem. Examples: 1.
Command Reference If any of the modem'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 modem 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.
Command Reference After 5 reconnects have been attempted every 30 secs, and the modem still gets an invalid DNS, the modem 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.
Command Reference 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 - “, ,”.
Command Reference 8.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.
Command Reference See also: ctm15x return to list of commands 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.
Command Reference ethernet x This command is used to enable or disable the Ethernet services of the modem. Ethernet services are enabled by default whenever a cmd factory is issued. x = 0 disable Ethernet services x = 1 enable Ethernet services Examples: 1. Disable Ethernet services cmd ctm15x OK cmd ethernet 0 OK A cmd apply followed by a cmd save are required for this command to take effect. See also: ctm15x return to list of commands 8.1.6 “F” Commands firewall n eeeee lllll t iii.iii.iii.
Command Reference 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.
Command Reference friends n x.x.x.x y.y.y.y This command is used to setup the modem'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 modem. This feature controls access to the following modem features: MODBUS PAD ULCP Remote SSH access (R1.3.
Command Reference A cmd apply followed by a cmd save are required for this command to take effect. return to list of commands 8.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.
Command Reference 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 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.
Command Reference 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.
Command Reference 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.
Command Reference return to list of commands gpsemail n 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.
Command Reference 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 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.
Command Reference 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, gpslocport, gpsremip, gpsemail, gpssms return to list of commands gpsmes Displays all messages associated with each GPS report. This command is read only.
Command Reference 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.
Command Reference 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 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.
Command Reference 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.
Command Reference 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 forw
Command Reference 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.
Command Reference 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.
Command Reference 8.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.
Command Reference n = 1 to 8 ignition trigger condition r = 1 to 999 report number r = 0 disables the report Example: 1. Set report #2 for ignition trigger condition #1. cmd ignreport 1 2 OK A cmd save is required for this command to take effect. See also: igncond, repaddmes, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype return to list of commands input Reads the value and state of all inputs. There are a total of six inputs.
Command Reference 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.
Command Reference 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.
Command Reference cmd iocond 3 1 60 1 2 send report #3 every 60 seconds if inputs #1 and #2 are in alarm cmd iocond 4 2 0 0 0 1 send report #4 whenever the IP address of the modem changes – this indicates that it has made a new network connection cmd iocond 5 2 60 0 3 0 10 send report #5 every 60 seconds or while input #3 is in alarm but with a maximum report rate of one every 10 seconds cmd iocond 6 1 0 6 0 0 10 send report #6 only while input #6 is in alarm but with a maximum report rate of one every 10
Command Reference 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. return to list of commands 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.
Command Reference 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.
Command Reference 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 me
Command Reference 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 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.
Command Reference 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.
Command Reference 1. Set the LAN IP address of the modem to 192.168.10.1 cmd lanip 192.168.10.1 OK 2. Query the LAN IP address of the modem cmd lanip cmd lanip 192.168.1.1 OK A cmd apply followed by a cmd save and a power cycle are required for this command to take effect. After taking effect, local Telnet should be accessed via the IP address specified in the command. See also: landhcp, landns, lannetmask, lanrepip return to list of commands lannetmask iii.iii.iii.
Command Reference http://en.wikipedia.org/wiki/Netmask return to list of commands lanrepip iii.iii.iii.iii Sets the IP address of the local server connected to the modem’s LAN that will receive local reports. iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 LAN IP address to receive local reports in decimal (default: 192.168.1.20) This command requires a cmd save and power cycle to take effect. The LAN IP address of the server currently used to receive local reports can be queried by using lanrepip.
Command Reference 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 return to list of commands 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.
Command Reference 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.
Command Reference 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.
Command Reference return to list of commands modbusctm130 n Enables MODBUS backward compatibility with the CTM13x by using MODBUS RTU encapsulated in UDP packets for messages transmitted/received over-the-air. The CTM13x modems only use MODBUS RTU over UDP as the over-the-air protocol for communicating between other modems configured as MODBUS master and slave gateways.
Command Reference 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.
Command Reference 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 OK 123.1.2.4 502 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.
Command Reference 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 return to list of commands modbusport xxxxx Sets the listening port number for the MODBUS server and the listening port number for MODBUS TCP slaves. Default is 502.
Command Reference return to list of commands mode n Sets the required connection mode of the modem. n = 1 manual connection n = 2 auto connect to the network (default) n = 3 auto connect to the network and go directly into PPP mode (only supported on firmware version R1.2.
Command Reference cmd mode 2 OK A cmd save is required for this command to take effect. return to list of commands 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 return to list of commands modemid Assigns a user configurable ID to the modem.
Command Reference 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.
Command Reference 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.
Command Reference 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.
Command Reference 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.
Command Reference Example: 1. Use an alternate NTP server: cmd ntpserver 1.openwrt.pool.ntp.org OK See also: gpstime, mode, networktime, ntptime, timesync return to list of commands 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 modem to be configured in a mode other than manual connection mode (not in cmd mode 1).
Command Reference b = 1 conditional operator for all following parameters: AND b = 2 conditional operator for all following parameters: OR t = 0 timeout disabled t = 1 to 65535 timeout in seconds mt = 0 to 65535 maximum reporting rate in seconds (minimum time between reports) Optional parameters: trigx trigger parameter x enclosed in single quotes and without spaces in between, in the form 'pid^val' where: pid = p1 to pb engine parameters as per OBD2/J1939 Parameters Table except for p4 and id ^ - > trigge
Command Reference cmd obdcond 4 1 0 15 'p1<10.00' 'p2=0.00' 'p7=0.00' 'p8=-40.00' OK 5. Query all the trigger conditions used for OBD reports cmd obdcond cmd obdcond 2 1 30 5 'p1=0.0' cmd obdcond 3 2 60 5 'p1>0' 'p2>2000' OK 6. Query the parameters for OBD trigger condition #3 cmd obdcond 3 cmd obdcond 3 2 60 5 'p1>0' 'p2>2000' OK A cmd save is required for this command to take effect.
Command Reference obdreport [n] [r] This command sets the report to be used for a OBD triggered report. n = 1 to 8 number of the OBD trigger condition r = 1 to 999 report number r = 0 disables the report obdreport requires the modem to be listening for traffic from the WPAN gateway, this requires cmd mode 10 to be configured. Example: 1. Set report #2 for OBD triggered report #1. cmd obdreport 1 2 OK A cmd save is required for this command to take effect.
Command Reference 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.
Command Reference 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 return to list of commands otasp This command is used to perform automatic wireless network activation and updates any required network related files that are embedded in the wireless modem.
Command Reference return to list of commands 8.1.13 “P” Commands pad Initiates a packet data connection. Use this to initiate a manual PAD connection 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 4 to put the modem in permanent PAD mode (enter PAD automatically after a power cycle). Example: 1.
Command Reference OK 2. Query the existing dialup emulation PAD client port cmd padclientport cmd padclientport 5006 OK A cmd save is required for this command to take effect. See also: pad, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padmode, padport, padreset, padsvct return to list of commands padecho n Sets the PAD echo mode – if echo is enabled then all data sent to the modem on its RS232 port by an external device is echoed back to that device.
Command Reference padesc Sets the PAD escape sequence used to return to command line mode. Default is +++. When using the escape sequence it is necessary to wait the guard time (padesct) before entering data Enter only the escape sequence (do not enter any other characters including or ) If PAD forwarding time (padfwdt) is set there will be a delay until the escape characters are forwarded. The guard time (padesct) must also be honored, to allow the modem to escape from PAD mode.
Command Reference Examples: 1. Set the PAD escape guard time to 4 seconds cmd padesct 4 OK 2. Query the current PAD escape guard time cmd padesct cmd padesct 3 OK A cmd save is required for this command to take effect. See also: pad, padecho, padesc, padfwdc, padfwdl, padfwdt, padip, padmode, padport, padreset, padsvct return to list of commands padfwdc x r Sets the PAD forwarding character and to remove the forwarding character before forwarding the packet (optional).
Command Reference OK 3. Query the current PAD forwarding character cmd padfwdc cmd padfwdc 32 0 OK A cmd save is required for this command to take effect. See also: pad, padecho, padesc, padesct, padfwdl, padfwdt, padip, padmode, padpfc, padport, padreset, padsvct return to list of commands padfwdl x Sets the maximum PAD packet length. Default = 40. If 0 is specified then every character is sent immediately.
Command Reference padfwdt x Sets the PAD forwarding time. Default = 1 second. If 0 is specified then this disables the forwarding timer and every character will be sent immediately. x = 0 to 255 PAD forwarding time in increments of 50ms The current PAD forwarding time can be queried by using the padfwdt command without parameters. Examples: 1. Set the PAD forwarding time to 2 seconds cmd padfwdt 40 OK 2.
Command Reference cmd padip cmd padip 192.168.1.1 OK A cmd save is required for this command to take effect. See also: pad, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt , padmode, padport, padreset, padsvct return to list of commands padmode x Sets the PAD mode. x = 0 start up UDP PAD mode. The modem will revert to server mode once the connection is closed. (default) x = 1 start up TCP PAD mode. The modem will revert to server mode once the connection is closed.
Command Reference 2. Query the current PAD mode cmd padmode cmd padmode 1 OK A cmd save is required for this command to take effect. See also: pad, padclientport, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padport, padreset, padsvct return to list of commands padpfc 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.
Command Reference padport xxxxx Sets the remote PAD port number. This is the listening port if the modem is in PAD server mode. Default is 5005. xxxxx = 0 to 65535 remote PAD port number The current PAD port number can be queried by entering the padport command without parameters. Note: If the modem is currently in PAD mode and any other LAN or firewall configuration commands are set after issuing the padport command, then both a cmd save and a power cycle are required to resume proper PAD operation.
Command Reference cmd padreset OK See also: pad, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padmode, padport, padsvct return to list of commands padsvct n [c] Sets the PAD server connection timeout. If no data is sent or received within this timeout value, the PAD connection will be dropped and the modem will return to server mode.
Command Reference See also: pad, padecho, padesc, padesct, padfwdc, padfwdl, padfwdt, padip, padmode, padport, padreset return to list of commands 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.
Command Reference panicreportack t This command will set the modem 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 modem must be configured with wpanacktype set to server type acknowledgment and with panicreport.
Command Reference The modem must be configured using the commands wpanadddev and wpanacktype and wpanpanid for pendantreport to function properly. Example: use report 1 for pendant triggered reports cmd pendantreport 1 OK A cmd save is required for this command to take effect. Pendant report is triggered by any message received from the pendant.
Command Reference 2. ping 66.102.7.147 every 15 seconds cmd ping 15 66.102.7.147 OK 3. Disable ping cmd ping 0 0.0.0.0 OK 4. Queries the modem’s ping setting cmd ping cmd ping 15 66.102.7.147 OK See also: netwd return to list of commands 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.
Command Reference port n d p s f Configures the modem’s serial port baud rate and data format. After implementing this command it will be necessary to change the baud rate of the host application to match the new configuration.
Command Reference Provide the connected device a PPP connection through the serial port. After the modem is powered up, enter the cmd ppp command and disconnect from the terminal program. Use a Windows Dial Up Network (DUN) connection to connect to the modem. 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.
Command Reference 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.
Command Reference A cmd save is required for this command to take effect. See also: pupcond, repaddmes, repdelmes, repemail, replocport, repremip, repremport, repsms, reptype return to list of commands pwrmode n Controls the modem’s power mode. n = 1 puts the modem in shutdown mode - it can be woken up either by a power cycle, an input alarm event if configured, or a configured periodic wakeup, see pwrwoe.
Command Reference cmd pwrsdwn 1 3600 this will cause the modem to power down when the standby signal (ignition) has been inactive for 1 hour. The modem will power back up when the standby signal becomes active with no delay. cmd pwrsdwn returns the current settings of enable/disable and delay time A cmd save is required for this command to take effect. return to list of commands pwrvcct vv.v t Controls the supply voltage below which the modem will automatically go into shutdown mode (blinking power LED).
Command Reference pwrwoe m t1 t2 i Configures what event will wake the modem up (input alarm event or timer expire) and how long the modem will stay awake after the event. This is used to have the modem in minimum power mode(< 2 mA) until it is required to communicate over the wireless network. If it is required to have the modem start its shutdown mode immediately (without waiting for timer t1 to expire) than use the pwrmode command to put the modem into shutdown with immediate effect.
Command Reference cmd pwrwoe 1 60 c 0 OK 4. QUery the current configured parameters for wake on event cmd pwrwoe cmd pwrwoe 0 0 10 0 OK A cmd save is required for this command to take effect. return to list of commands 8.1.14 “R” Commands ratesel n Sets the required network rate mode (CDMA vs. EV-DO) of the device. This command is not valid for GSM/GPRS/HSPA devices. Note: Prior to using the cmd ratesel command, use cmd mode to verify that the modem is in manual connection mode=1.
Command Reference ratetmr n Sets the required network rate test timer of the device. This is used to configure the modem to test for an available EV-DO network while it is in a 1xRTT connection. This command is valid for Sierra Wireless CDMA/EV-DO data devices and modules only. n = 0 disable the timer (default) n = 1 to 65535 time in seconds.
Command Reference 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.
Command Reference repemail n 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 = 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.
Command Reference 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.
Command Reference 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 (.
Command Reference 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.
Command Reference 2. Query the current configuration cmd reportscripts cmd reportscripts 0 OK return to list of commands 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.
Command Reference 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 report cmd remport 1 5001 cmd remport 2 5005 OK A cmd save is required for this command to take effect.
Command Reference 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.
Command Reference r = 5 in-band NMEA or ULCP messages in a TCP Packet r = 6 email reports r = 7 SMS reports s = 0 disables the store and forward of report s = 1 enables the store and forward of report Note: For r = 7 (SMS reports), the total length of the report must not exceed 166 characters including and 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.
Command Reference Example: cmd restore return to list of commands rmtd iii.iii.iii.iii xxxx Configures the modem to perform a reverse telnet connection to an IP address and port. The modem tries to connect periodically until a connection is established. By default this is disabled with IP 0.0.0.0 and port 0. iii.iii.iii.iii = 0.0.0.0 to 255.255.255.255 remote IP address. 0.0.0.0 = disabled (default) xxxxx = 0 to 65535 remote port number.
Command Reference A cmd apply followed by a cmd save are required for this command to take effect. return to list of commands rmttelnet This command configures the modem to respond to incoming telnet commands over the wireless network. The modem must be connected to a wireless network. n=0 remote telnet = disabled (default) n=1 remote telnet = enabled The current state of remote telnet setting can be queried by using the rmttelnet command without parameters.
Command Reference rssi This command queries to the current wireless network signal strength seen by the modem for both the 1x and EV-DO networks. The values are given in dBm in the range, for example: -105dBm (poor), to -60dBm (excellent). Note: This command is not supported by all wireless network cards and modules. This is a read only command. Example: 1. Query the current network signal strengths seen by the modem cmd rssi EVDO: -98dBm 1xRTT: -99dBm OK return to list of commands 8.1.
Command Reference Report output: $PGPS,000000.00,V,0000.0000,N,00000.0000,E,000.0,000.0,000000,+00000,0,0960489 0958*42 $PGPS,000000.00,V,0000.0000,N,00000.0000,E,000.0,000.0,000000,+00000,0,1312131 41516171819202122232425262728293031*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.
Command Reference 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. return to list of commands save Save modem configuration to non-volatile memory.
Command Reference 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.
Command Reference Engine Hours:0.00 h Output mode (RF Switch):0 SMS Destination Number: SMS Text: Wireless link data count: TX: 0 MB RX: 0 MB Total: 0 MB OK return to list of commands singlepc n Sets the modem’s DHCP allocation of IP addresses. If enabled, the modem’s DCHP server will only allocate one IP address. This single IP address assigned by the modem will be 192.168.1.20.
Command Reference smssend Used to SEND the previously setup SMS message (smsto and smstext). Note: SMS features are only available for specific manufacturer, RF modules, cards or devices. Please contact Cypress Solutions for a complete list of products that support SMS functionality. The modem needs to be connected to the network. Example: cmd smssend send the SMS message return to list of commands smstext Used to enter the text message of the SMS.
Command Reference 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.
Command Reference A cmd save is required for this command to take effect. return to list of commands snfflush Flushes and resets store and forward NVRAM. return to list of commands 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.
Command Reference The 6-digit lock code is used by the modem’s embedded module to compare against the pre-loaded 6digit CSL. This number will be provided by the service provider at the time of service activation. nnnnnn 6-digit lock code Example: cmd spc 123456 set the modem’s SPC to 123456 A cmd save is required for this command to take effect. return to list of commands speedth ss t Sets the speed threshold for automatically enabling the RF module of the modem when it has been previously disabled.
Command Reference 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...
Command Reference 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 return to list of commands swipemode n Sets the swipe card interface to be used with the modem.
Command Reference A cmd save and a power cycle are required for this command to take effect. See also: mode return to list of commands swipereport [r1] [r2] [r3] [r4] [r5] [r6] [r7] [r8] This command sets the report(s) to be used for swipe card reader triggered reports.
Command Reference See also: mode, reptype, repremport, repremip, replocport, repemail, repsms, repaddmes return to list of commands syslog n Provides a mechanism to retrieve the log of system events recorded by the modem. Log events include network connects and disconnects. Note that the system log is stored in volatile memory so it will be lost when power is cycled on the modem. n = 0 to 65535 number of system log records to return.
Command Reference cmd telnetport 33 OK A cmd apply followed by a cmd save are required for this command to take effect. See also: telnetpswd, telnettimeout return to list of commands 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.
Command Reference A cmd save is required for this command to take effect.
Command Reference 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 cmd cmd cmd cmd cmd repremip 1 209.121.68.211 repremport 1 7002 reptype 1 0 3 repaddmes 3 univwd 3 1 save A cmd save is required for this command to take effect.
Command Reference 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.
Command Reference 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 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.
Command Reference Returns the current value of the modem’s supply voltage. This is a read only command. Example: 1. Query the supply voltage in xx.xx ASCII format cmd vcc 11.99V OK return to list of commands 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.
Command Reference See also: vccreport return to list of commands 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.
Command Reference 8.1.19 “W” Commands wifiwd n [t] Enable/disable Wi-Fi 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 Wi-Fi watchdog with a 5 minute threshold cmd wifiwd 1 300 OK return to list of commands wpanacktype n Assigns an acknowledgment type for the Work Alone system. There are two acknowledgment types: modem server Note: CTM-15X Modem firmware 1.2.
Command Reference The remote server must also be configured to respond to messages from the modem. The message format sent from the modem is as follows: $PPEN,0013A200402CB498,13,PANIC*03 The acknowledgment that the modem expects from the server is as follows: $PPQ,PAN,0013A200402CB498,13,ACK*36 The 16-digit hex number following the PPEN message is the Pendant ID and is unique to each pendant. Examples: 1. Configured as modem type acknowledgment cmd wpanacktype m OK 2.
Command Reference wpandelall Deletes all WPAN device IDs from the Chameleon Modem’s registered WPAN devices list. Example: cmd wpandelall deletes all WPAN devices from the registered devices list Note that the modem needs to be power cycled for the new settings to take effect. return to list of commands wpandeldev xx-xx-xx-xx-xx-xx-xx-xx Deletes a WPAN device ID from the Chameleon Modem’s registered WPAN devices list.
Report Messages cmd wpanpanid queries the current WPAN PAN ID Note: A cmd save and a power cycle must occur for the new settings to take effect. return to list of commands wpanpensrv x yyyy Configure the listening protocol and port of the Pendant Server that provides remote access to Man Down Pendant devices.
Report Messages Decimal ID 03 16 20 21 22 23 24 25 26 30 31 40 80 82 84 85 88 89 90 92 98 100 101 112 114 115 116 117 118 119 120 121 122 136 137 Message description Modem ID, proprietary NMEA message-$PMID GPS NMEA GLL message- $GPGLL Digital Input States, proprietary NMEA message- $PIND Analog Input #1 status, proprietary NMEA message- $PINA Analog Input #2 status, proprietary NMEA message- $PINA Analog Input #3 status, proprietary NMEA message- $PINA Analog Input #4 status, proprietary NMEA message- $P
Report Messages Message format is: $PMID,xxxxxxxxxxx,yyyyyyyyyyy*hh Where: xxxxxxxxxxx is the modem’s unique 11 digit ESN (CDMA/EV-DO devices only) or 15-digit IMEI (GSM/GPRS/HSPA devices only) yyyyyyyyyyy is the modem’s ID as set by the user (maximum 15 characters) hh is the message checksum Example: With CDMA/EV-DO wireless device installed, serial number is ESN: $PMID,09604890968,09604890968*10 With GSM/GPRS/HSPA wireless device installed, serial number is IMEI: $PMID,359475021717716,3594750217
Report Messages NMEA 0183 v3.0: $GPGLL,4915.3920,N,12259.8072,W,222414.00,A,A*79 9.3 Message Type 20, PIND Proprietary NMEA message containing the digital state of the six inputs on the CTM-15x modem and a counter that keeps tracks of the number of times Input 1 has been triggered. Message format is: $PIND,abcdef,nnnnn*hh Where: abcdef is the current digital state of inputs 1 through 6: 0 = low; 1 = high nnnnn is the counter for the number ticks from input 1; Counter max 65535; Max tick frequency is 40Hz.
Report Messages $PINA,3,0.00*3B $PINA,4,0.00*3C $PINA,5,0.00*3D $PINA,6,0.00*3E 9.5 Message Type 30, PCTM Proprietary NMEA message containing the current wireless network (e.g. cellular network, Wi-Fi network) status. Note: If used with Store and Forward the network status parameters will be invalid. Cellular network message format $PCTM,-xxxdBm,-yyydBm,zzzzz,b,s,r,nnn.nnn.nnn.nnn*hh Where: xxx is the current EV-DO network signal strength, or HSPA network signal strength (firmware version R1.3.
Report Messages hh is the message checksum Examples: EV-DO: $PCTM,-87dBm,-100dBm,16422,1,3,1,96.1.5.204*0B HSPA (firmware version R1.3.0 and above only): $PCTM,-90dBm,-0dBm,0,0,6,1,10.163.78.249*33 Wi-Fi: $PCTM,IEEE802.11abg,cypress dBm,192.168.100.202*53 ,00:24:A5:AD:61:4F,18dBm,70/70,-22dBm,n/a 9.6 Message Type 31, PDATA Proprietary NMEA message containing the values of data transmitted and received over the wireless data link.
Report Messages nnnnn is the PAD port number bbbbbb is the serial port’s baud rate ttt is the PAD type, UDP or TCP Example: ID=7788282538,5005,9600,UDP 9.8 Message Type 80, $GPGGA Standard NMEA message containing time, GPS latitude and longitude, satellite status information and altitude. Message format is: $GPGGA,hhmmss.ss,llll.llll,a,yyyyy.yyyy,b,c,d,ee.e,sfffff,M,,M,,0000*hh Where: hhmmss.ss is the UTC time in hours, minutes, seconds, and decimal seconds llll.
Report Messages Where: hhmmss.ss is the UTC time in hours, minutes, seconds, and decimal seconds v is the data validity flag: A = valid current data, B = valid stored data, V = invalid current data, W = invalid stored data llll.llll is the position latitude in degrees, minutes and decimal minutes a is N(orth) or S(outh) yyyyy.yyyy is the position longitude in degrees and decimal degrees b is E(ast) or W(est) ccc.c is the horizontal velocity in knots ddd.
Report Messages Example: $GPGSA,A,1,11,11,20,23,32,16,00,00,00,00,00,00,03.1,02.4,02.0*03 9.
Report Messages Hex 4 bytes 4 bytes 2 bytes 2 bytes 4 bytes 1 byte 1 byte 1 to 11 bytes Description Normalized latitude (RMC latitude x 100,000) Normalized longitude (RMC longitude x 100,000) Speed in km/h Acceleration/Deceleration in km/h/s x 10 Time (based on number of seconds since 00:00:00 January 1st 1970 GPS data validity: 0x”A” = valid; 0x”V” = invalid; 0x”B” = buffered valid; 0x”W” = buffered invalid.
Report Messages Note: ULCP binary messages should not be used for local serial report mode 1 and 2 in applications where timed message delivery is critical. 9.15 Message Type 92, ULCP binary format, Wireless Link TX/RX Data Count with Modem ID Header: 0x5C 0xSS 0x06 0x00 0x00 0xNN 0x0000 Where NN is the message length - dependent on the Modem ID string length.
Report Messages Hex 4 bytes 4 bytes 2 bytes 2 bytes 1 byte 1 byte 1 byte 1 byte 2 bytes 2 bytes 4 bytes 1 byte 0x00 0x00 0x00 Description Normalized latitude (RMC latitude x 100,000) Normalized longitude (RMC longitude x 100,000) Speed in knots Heading GPS data validity: 0x”A” = valid; 0x”V” = invalid Number of satellites used for position fix Position type (from GGA message) Digital input state (0=off, 1=on): bit 0 = input #1, bit 1 = input #2…bit 5 = input #6, bit 6 = RF switch box output mode (1 = RF o
Report Messages 9.18 Message Type 101, Trimble Proprietary LN message This is the standard TAIP LN response message of format: >RLNAAAAABBBSCCDDDDDDDSEEEFFFFFFFSGGGGGGHHIIIJSKKKLMMMNOOPPQQ……PPQQRRRRRRRR RRXT< Where: AAAAA.BBB is the GPS time in seconds and decimal seconds S is + or – SCC.DDDDDDD is the Latitude in degrees and decimal degrees SEEE.FFFFFFF is the Longitude in degrees and decimal degrees SGGGGGG.HH is the altitude above mean sea level in feet and decimal feet III.
Report Messages Hex 4 bytes 4 bytes 2 bytes 2 bytes 1 byte 1 byte 1 byte 1 byte 2 bytes 2 bytes 4 bytes 1 byte 0x00 0x00 0x00 1 to 11 bytes Description Normalized latitude (RMC latitude x 100,000) Normalized longitude (RMC longitude x 100,000) Speed in knots Heading GPS data validity: 0x”A” = valid; 0x”V” = invalid Number of satellites used for position fix Position type (from GGA message) Digital input state (0= off, 1=on): bit 0 = input #1, bit 1 = input #2…bit 5 = input #6, bit 6 = RF switch box output
Report Messages s is sign + or – for altitude above or below mean sea level eeeee is the altitude in metres f is the number of satellites in use (range 0 to 8) ggggggggggg is the modems ID (padded with zeros at end if < 11 characters) hh is the message checksum Example: $PGPS,224820.00,A,4915.3897,N,12259.8031,W,000.0,000.0,200409,+00007,6,0960489 0968*4F 9.21 Message Type 115, $PKML Proprietary NMEA message very similar to message 114 with the only difference being the format of the modem ID field.
Report Messages 9.22 Message Type 116, $PPWR Proprietary NMEA message providing the modem’s current supply voltage (Vcc), standby signal/ignition status (on or off), and the internal temperature. Message format is: $PPWR,vv.vv,i,tt*hh Where: vv.vv is the modem supply voltage in volts. i is the standby signal/ignition status: 0 = off; 1 = on. tt is the modem’s internal temperature in degrees Celsius. hh is the message checksum Example: $PPWR,14.12,1,43*37 9.
Report Messages Message format is: $PRFI,aaaaa,rdBm,tdBm,b,c,e,s*hh Where: aaaaa is the network System ID (SID) r is the current EVDO RSSI value t is the current TX power adjust value b is the band class: 0 = 800MHz; 1 = 1900MHz c is the current center channel number e is the current Ec/Io value s is the current Slot Cycle Index (SCI) hh is the message checksum Example: $PRFI,16422,-81dBm,-0dBm,1,255,8,2*22 9.
Report Messages 9.26 Message Type 119, $POBDA Proprietary NMEA message containing OBD II information captured from a vehicle. There are 4 available messages for reporting OBD II/J1939 data, each message can return information on up to 4 parameters based on the OBDII/J1939 parameters table. Message format is: $POBDA,v,px=xxxxxx,[px=xxxxxx],[px=xxxxxx],[px=xxxxxx]*hh Note: the number and type of px values are based on the configuration of pobda thru pobdd commands.
Report Messages Message format is: $POBDC,v,px=xxxxxx,[px=xxxxxx],[px=xxxxxx],[px=xxxxxx]*hh Note: the number and type of px values are based on the configuration of pobda thru pobdd commands. Where: v is the data validity flag: A = valid current data, B = valid stored data, V = invalid current data, W = invalid stored data px=xxxxx is the parameter ID px followed by the value of the parameter xxxxx hh is the message checksum Example: $POBDC,V*20 9.
Report Messages Where: hhmmss.ss is the UTC time in hours, minutes, seconds, and decimal seconds llll.llll is the position latitude in degrees, minutes and decimal minutes a is N(orth) or S(outh) yyyyy.yyyy is the position longitude in degrees, minutes and decimal minutes b is E(ast) or W(est) vvv.v is the velocity in km/h uuu.u is the acceleration/deceleration in km/h/s ddmmyy is the day, month and year ggggggggggg is the modems ID hh is the message checksum Example: $PACCEL,225623.00,4915.3907,N,12259.
Email Message Format Note: This message type, 255, is for specific customers. ULCP binary messages should not be used for local serial report mode 1 and 2 in applications where timed message delivery is critical. Example: To send the string, "TEST" Send "0xFF 01 06 00 00 04 00 00 54 45 53 54" 10 Email Message Format E-mail reporting is configured in the following manner: emailsrv sets the mail server the modem will use to relay the email message.
MODBUS Messages 11 MODBUS Messages The CTM-15x modem can be used in MODBUS mode for SCADA applications. This allows the modem to operate as a simple SCADA device that can understand and format MODBUS messages based on various modem parameters, such as inputs and outputs, device information and GPS position. The modem can simultaneously support a MODBUS slave gateway connection. The modem can be configured to "read" and "write" MODBUS messages using the mode command and modbusadd commands.
MODBUS Messages Where: 0xSS is the current state of the 4 digital outputs Bit 0 represents output #1 Bit 1 represents output !#2 Bit 2 represents output #3 Bit 3 represents output #4 11.2 Set Digital Output In MODBUS term this is called “write coil” and has function code 0x05.
MODBUS Messages Bit 2 represents output #3 Bit 3 represents output #4 Bit 4 represents output #5 Bit 5 represents output #6 11.4 Read Analog Inputs In MODBUS term this is called “read input registers” and has function code 0x04.
MODBUS Messages Reg.
ULCP Remote Configuration Messages Parameter MODBUS ID Function code Data 12 Format 0xNN 1 byte, range 1 to 247 0xNN 1 byte defined by MODBUS protocol 0xNN……0xNN Variable size dependant on function code ULCP Remote Configuration Messages The modem may be remotely configured by sending it ULCP configuration messages. Configuration messages are sent as UDP packets to port 6100 of the modem. © 2010 Cypress Solutions Open CTM (Revision D) Complete Manual: CTM-15X Firmware 1.3.
ULCP Remote Configuration Messages 12.1 ULCP Message Format Hex 0xPP Description Packet type – defines the message type: 0x59 = Set output 0x5B = Execute application-specific script 0x50 = NMEA GGA query 0x52 = NMEA RMC query 0x55 = GPS ULCP binary data query 0x56 = Delta-based GPS report query and setting 0x57 = Time-based GPS report query and setting 0xSS Sequence number – incremented for each message.
ULCP Remote Configuration Messages Response message body: None. 12.2.2 Execute Application-Specific Script Request header: 0x5B 0xSS 0x02 0x00 0x00 0x08 0x0000 Request message body: Hex 1 byte Description 0x00 = Execute application-specific script 0; 0x01 = Execute application-specific script 1 0x00000000000000 Not used If the command was not successful then no response is sent. Response header: 0x5B 0xSS 0x03 0x00 0x00 0x00 0xNNNN Where NNNN is the password. Response message body: None. 12.2.
ULCP Remote Configuration Messages 12.2.5 ULCP Binary Position Query Request header: 0x55 0xSS 0x00 0x00 0x00 0x00 0x0000 Request message body: None. If the command was not successful then no response is sent. Response header: 0x55 0xSS 0x01 0x00 0x00 0x18 0xNNNN Where NNNN is the password. Response message body: Refer to Message Type 85 ULCP binary format GPS data message GPSULCPP0S. 12.2.6 Wireless Link Data Count Query Request header: 0x5C 0xSS 0x00 0x00 0x00 0x08 0x0000 Request message body: None.
ULCP Remote Configuration Messages save; 1 = save to NV memory. Bit 2 is used to select the report destination IP address: when bit2 is 1 = use the IP address(destination UDP Port number) configured above; when bit2 is 0 = use the IP address(fixed UDP Port number 6101) of this incoming setup message. Bit 3 is used to select the message mode: 1 = ASCII mode (no ULCP header); 0 = with ULCP header Number of messages to report Message list: up to 8 messages may be specified.
ULCP Remote Configuration Messages 2 bytes 2 bytes 1 byte 1 byte 8 bytes Maximum report time: sets a timer to send reports if the unit has not moved the set distance Minimum report time: sets a minimum time between reports Control flags: Bit 0 is used to make time based reporting active: 1 = active; 0 = inactive (switch off the start-up reporting) Bit 1 is used to save this configuration to NV memory, but currently not supported: 0 = do not save; 1 = save to NV memory.
ULCP Remote Configuration Messages Parameter script-name delimeter1 url delimeter2 username delimeter3 passwd Length 0 to W bytes 1 byte - 0x2C(,) 1 to X bytes 1 byte - 0x2C(,) 0 to Y bytes 1 byte - 0x2C(,) 0 to Z bytes Where the sum of W, X, Y and Z is not over 252 to make 0xLL not exceed the maximum, 0xFF. If the command was not successful then no response is sent. Response header: 0x5E 0xSS 0x03 0x00 0x00 0xLL 0xNNNN Where NNNN is the password.
ULCP Remote Configuration Messages Note 2: For remote reporting type r = 4, appended NMEA messages will be combined into a single ULCP packet with message type 0xFF (255) for ULCP custom messages. 12.3 Examples 1. Set all OUTPUT ports (1~4) on Send the following packet to the modem through the UDP port number 6100 0x59 01 02 00 00 08 00 00 FF FF FF FF 00 00 00 00 The response packet will come from the UDP port number 6101 2. Set Delta Position Based Reporting Destination IP/Port: 192.168.1.
Technical Specifications //To trigger report number 1 padding message 82 and 80 Send the following packet to the modem remote ip through the UDP port number 6100. 0x5F 01 02 00 00 12 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 52 50 The response packet will come from the UDP port number 6100. 13 Technical Specifications The Chameleon range of wireless data modems are subject to regular feature enhancement. Cellular wireless networks are constantly changing and enhancing their capabilities.
Technical Specifications 13.5 Shock 40G, 11msec MIL-STD 810F Method 516-I, saw-tooth wave 13.6 Sealing IP41 Protection against objects greater than 1 mm and vertically dripping water 13.7 Material Case 6061 High strength Aluminum with high impact ABS chassis Mounting Bracket Oil & Solvent resistant automotive grade Elastomer mounting bracket 13.
Technical Specifications Report format NMEA, ULCP,MODBUS 13.11 RF 13.11.1 CDMA/EV-DO Cellular / 800 Mhz Transmit 824-849 MHz Receive 868-894 MHz PCS / 1900 Mhz Transmit 1850 to 1910 MHz Receive 1930 to 1990 MHz Receive Diversity (both bands) CDMA IS98F compliant SMA or TNC, 50 ohm connector, +23.5 dBm max 13.11.2 GSM/GPRS/HSPA Cellular 850/1900 850/900MHz GSM/GPRS/EDGE 1800/1900 MHz GSM/GPRS/EDGE SMA or TNC, 50 ohm connector, +24 dBm max 13.12 GPS Type 12 channel, continuous tracking Accuracy <2.
Technical Support Weight 500 grams 14 Technical Support For information about your CDMA network account, please contact your Network Operator: have the ESN and telephone number of the modem available to provide on the call. www.cypress.bc.ca Cypress Solutions Service Support Group 1.877.985.2878 or 604.294.4465 9.00am to 5.00pm PST www.cypress.bc.ca support@cypress.bc.ca © 2010 Cypress Solutions Open CTM (Revision D) Complete Manual: CTM-15X Firmware 1.3.
