ETM ETM9120-1, ETM9140-1 Configuration Tool User Manual
UMTS/GSM/GPRS Terminal – ETM9140-1
GSM/GPRS Terminal – ETM9120-1
Features:
◩ 3G (HSPA+/UMTS) Connectivity – ETM9140-1 only
◩ 2G (GSM/GPRS) Connectivity
◩ Standard RS232 9DF serial port
◩ 5v to 35v power input on RJ12 connector
◩ 7 x I/O’s on RJ45 connector
◩ FME M antenna connector
◩ Sleep Mode for reduced power consumption
◩ User configurable via configuration tool
ETM9120 9140 Configuration Tool Userguide201406RV001
Configuration Tool Userguide
Page 2 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
Contents
Contents ............................................................................................................................................ 2
Document .......................................................................................................................................... 4
History ........................................................................................................................................... 4
Relevant Documents ..................................................................................................................... 4
Abbreviation .................................................................................................................................. 4
Introduction ....................................................................................................................................... 5
Overview. ...................................................................................................................................... 5
Nomenclature ................................................................................................................................ 5
Using the Configuration tool .............................................................................................................. 5
Installation ..................................................................................................................................... 5
Initial Start-up and Programming ................................................................................................... 6
Saving, reading and writing configuration files .............................................................................. 7
File (Menu Option) ......................................................................................................................... 7
Alarm / Message Tab ........................................................................................................................ 8
SMS phone numbers and user ID ................................................................................................. 8
Latest Incoming SMS .................................................................................................................... 8
Unit ID added to messages ........................................................................................................... 8
Use incoming security filter ........................................................................................................... 9
Maximum number of SMSs per day allowed to be sent ................................................................ 9
Alarm Messages ............................................................................................................................ 9
I/O Settings ..................................................................................................................................... 10
IO 1 & 2 ........................................................................................................................................... 10
Delay before alarm is activated ................................................................................................... 10
Alarm restore delay ..................................................................................................................... 11
ET-cmd ........................................................................................................................................ 11
SMS Alarm .................................................................................................................................. 11
UMTS/GPRS Alarm ..................................................................................................................... 11
UDP Server Selection ................................................................................................................. 11
IO 3,4,5,6,7 ..................................................................................................................................... 11
Analogue Alarm Input .................................................................................................................. 11
A/D Cal Param ............................................................................................................................ 12
Power In Tab ................................................................................................................................... 12
Power Source Monitor ................................................................................................................. 12
Delay before alarm is activated ................................................................................................... 12
Alarm restore delay ..................................................................................................................... 12
ET-cmd ........................................................................................................................................ 12
SMS Alarm .................................................................................................................................. 12
UMTS/GPRS Alarm ..................................................................................................................... 12
UDP Server Selection ................................................................................................................. 13
Settings Tab .................................................................................................................................... 14
UMTS/GPRS Module <--> MCU and MCU <--> Port .............................................................. 14
Flow Control ................................................................................................................................ 14
EEPROM Storage Area ............................................................................................................... 14
Instructions on Correctly Setting the Baud Rate ......................................................................... 14
SettingtheInternalModulesBaudRate.................................................................................................15
Normal/Typical Start Sequence ................................................................................................... 17
Internet Tab ..................................................................................................................................... 18
Remote server ............................................................................................................................. 18
Local Server ................................................................................................................................ 18
Use Protocol ................................................................................................................................ 18
Firewall ........................................................................................................................................ 18
Transparency .............................................................................................................................. 18
ISP Dial up Login ......................................................................................................................... 19
Page 3 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
Connect to ISP or Server ............................................................................................................ 20
Data Transfer Tab ........................................................................................................................... 21
Setting the SWT Timers .............................................................................................................. 21
Functional Timing Description ..................................................................................................... 22
Heart Beat package ..................................................................................................................... 23
Ping Sending ............................................................................................................................... 23
Analogue Values ......................................................................................................................... 24
Server ............................................................................................................................................. 24
Terminal .......................................................................................................................................... 25
Entering command mode ............................................................................................................ 25
Send – commands ...................................................................................................................... 25
Set RTC ....................................................................................................................................... 25
Reprogram Using CSD ................................................................................................................ 25
Main Init .......................................................................................................................................... 26
Default Mode ............................................................................................................................... 26
Miscellaneous .............................................................................................................................. 26
Init AT-Command Table .............................................................................................................. 27
Low Power Sleep Mode (SWT5) ................................................................................................. 27
ConsiderationswhenusingLowPowerSleepMode..............................................................................27
Active profile: ............................................................................................................................... 29
Logging Tab .................................................................................................................................... 31
Data Logging ............................................................................................................................... 31
Pulse Counting Transition ........................................................................................................... 31
Channels to Log .......................................................................................................................... 31
Wakeup Timer 1 Settings (SWT1) ............................................................................................... 31
Logging slots available ................................................................................................................ 32
Logged Data ................................................................................................................................ 32
Hardware Description ..................................................................................................................... 33
Power Supply .............................................................................................................................. 33
RJ45 I/O Connector ..................................................................................................................... 33
I/O Connector pins ...................................................................................................................... 34
Serial (RS232) Port ......................................................................................................................... 34
Antenna ........................................................................................................................................... 34
SIM Card ......................................................................................................................................... 35
SIMPin.....................................................................................................................................................35
Indicator Lights ................................................................................................................................ 36
Low Power Mode (LPM) Example/Description ............................................................................... 37
Real time Clock and reference date ................................................................................................ 39
Reference Date Description ........................................................................................................ 39
Real Time Clock Description ....................................................................................................... 39
I/O 7 Toggling ................................................................................................................................. 40
Calibration of Analogue Inputs ........................................................................................................ 42
Equipment we need: .................................................................................................................... 42
Procedure: ................................................................................................................................... 42
Querying/Programming the Modem Using ET Commands ............................................................. 45
Page 4 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
Document
History
Revision Date Issued By Description
V001 30th April 2014 Patrick Paffard First Issue
Relevant Documents
The documents listed below are useful for the understanding of this document.
Document ID/No. Title
2005-0001 57 ETM Modems ET Communication Spec
2003-0003 16 ETM Modems TCP UDP Port Configuration Spec
2005-0001 17 ETM Modems TCP UDP Protocol Spec
ETM9140 9120 Quick Start
Guide 201405RV01
ETM9120 9140 Quick Start Guide
IO Board Brochure
201405RV01
IO Board Brochure
Abbreviation
Abbreviation Used Description
EEPROM Electrical Erasable Program Read Only Memory
UART Universal Asynchrony Receive Transmit
CR Carriage Return
LF Line Feed
CT Configuration Tool
MCU Microcontroller
RTC Real Time Clock
RD Reference Date
BPS Bits per second
WIRELESS MODEM ETM9120-1 OR ETM9140-1
GSM/GPRS/UMTS Wireless
Page 5 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
Introduction
This document describes the operation of two ETM modems and therefore within this document
both types of product are referred to with the generic term of ‘wireless modem’ and wherever there
is a distinction required between the two there a clearly identified header will be shown for each
type of product;
Overview.
The ETM9xxx-xxx range of products are industrial terminals designed for M2M (Machine to
Machine) communications. With 3G &/or 2G options they provide the ideal communication, alarm
or control platform for GSM, GPRS, UMTS or SMS applications.
Nomenclature
The ETM9120-1 variants incorporate the Cinterion TC63i engine and are intended for worldwide
use (network and regulatory approvals permitting).
The ETM9140-1 variants incorporate the Cinterion PH8-P and are intended for worldwide use
(network and regulatory approvals permitting).
Terminal Nomenclature/History
Model Comment Module Installed
ETM9120 Variants
ETM9120-1 First Release TC63i
ETM9140 Variants
ETM9140-1 First Release PH8-P
This document refers to GSM/GPRS by the generic term ‘wireless’ and so you should
remember that the ETM 9120-1 wireless modem cannot access UMTS/HSDPA services.
This document refers to GSM/GPRS/UMTS/HSDPA by the generic term ‘wireless’ and so you
should remember that the ETM 9140-1 wireless modem can access GSM/GPRS/UMTS
services.
The wireless modem is equipped with an EEPROM that is programmed with an application image
supporting the required operation and functions of the wireless modem.
The data configured within the EEPROM is for alarm messages, telephone numbers, port input
and output status, baud rate, id numbers and user passwords.
A configuration tool is used to read-write to the modem to program specific functionality, it is very
important to ensure the correct version of the tool is utilised when reading or writing to/from the
modem.
Using the Configuration tool
Installation
The Configuration Tool can be copied to any folder on a suitable PC’s hard drive. It consists of only
one file and does not need to be installed. Depending on your use of the tool there may (over a
period of time) be configuration files, with an etx extension, created and these files can be saved in
any location. The tool itself may create a single ini file which should be left in the same directory as
the configuration tool for continued easy operation of the tool.
Page 6 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
The wireless modem should be connected to the PC with a standard 9 pin serial (pc to modem)
cable – the wireless modem is configured as a DCE (Data Communication Equipment). New PC’s
and particularly laptops may need to utilise a USB-Serial converter to provide a serial port.
Initial Start-up and Programming
When the unit starts up and is connected to a terminal window and Escape is pressed (see below)
the version of the configuration tool will be shown as follows, check you have the correct
configuration tool for the unit – if you do not then contact ETM and request the appropriate version
or visit the support section of ETM’s website.
When you power up the wireless modem to do any configuration you MUST follow these steps if
you are unfamiliar with the operation of the Configuration Tool:
Start the configuration tool.
Chose the correct communications port ( using the Set COM Port button to select a port other
than the one chosen by the Configuration Tool ) – ensure the port is set for a baud rate of
115200 (it must be at this speed to be programmed in ESC mode).
Confirm that the port opens (the indicator MUST show ‘OPEN’ for your chosen port).
Click on the Terminal Tab.
Click into the black terminal window so that you see a flashing white cursor.
Power up the wireless modem - remember to plug the power into the correct socket, it is the
one next to the antenna lead, plugging the power connector into the I/O connector can
damage it, if this happens you may need to return the wireless modem for repair.
Immediately after powering up the modem press the ESC key on the keyboard, you should
only need to press it 3 or 4 times, after a short period you should see an ‘Escape Pressed’
message from the wireless modem – if you don’t and instead you see a ‘MS:^SYSSTART’
message then repeat the process again. Without the ‘Escape Pressed’ message being
displayed you CANNOT perform any configuration on the wireless modem (while it is possible
to use the Configuration Tool once the wireless modem has fully started up this may not be
possible if the wireless modem has not yet been fully configured).
NOTE: You can also check ‘Send <ESC> on SYSTEM START’ (the Configuration Tool to will
automatically send an ESC character when it sees the SYSTEM START message) in the
bottom right hand corner of the Configuration Tool (but this doesn’t work with some USB to
Serial adapters) – if you check this remember to uncheck it again when you restart the modem
after any programming changes, otherwise you may inadvertently leave the modem in
programming mode rather than run mode.
In this example the
appropriate
configuration tool is
CT0600
Caution
Do not try to program/configure a
unit with the wrong version of the
configuration tool.
Page 7 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
You are now ready to use the configuration tool to make changes to the wireless modem.
Once you are familiar with the Configuration Tool you can shorten the procedure, if the
wireless modem is already live/working, by simply reading and writing the configuration without
restarting the wireless modem and pressing the ESC key. Note if any changes are made to the
modem you should power cycle or software reset (ET&SR) the modem to ensure that any new
mode of operation ( based on your configuration changes ) comes into effect. If you make no
changes, only reading the configuration, you do not need to restart the modem.
Settings can be saved to a file on your PC. If you need to configure another ETM9XXX-XXX
with the same settings this file can be loaded into the configuration tool and written to any
additional units that require the same settings.
Saving, reading and writing configuration files
File (Menu Option)
Select “File – Open” to open an existing configuration file.
Select “File – Save” to save a configuration file after you have read an existing configuration
from a device or when you have manually entered a configuration.
The configuration tool’s current settings can be written to the wireless modem by selecting
“WRITE MEMORY” – this is the button with the RED text.
Note: You cannot perform a write operation if you have not opened an existing configuration
file or performed a read operation.
To read the current settings of the wireless modem select “READ MEMORY” – this is the
button with the BLUE text.
“ComPort <Open> or <Closed>” can be used to control whether or not the communications
port is opened (You must have the communications port open to connect in any way to the
wireless modem).
The Port Open/Close feature allows you to leave the configuration tool open but not connected to
the serial port in case you need to use another communications application such as
HyperTerminal
.
The selected baud rate for the COM port is displayed in brackets when the port is opened.
Note: If the unit is busy a read or write may fail and a popup will inform you of the error, this is
usually because the unit is in normal/operational mode. You can retry the read or write but if it
continues to fails then put the unit into programming or ESC mode (see above).
Caution
Take care not to over-write a previously
configured unit with a default or other
incorrect configuration
We suggest reading back after making any
changes to confirm they have been
correctl
y
entered
Page 8 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
Alarm / Message Tab
The unit can send messages based on inputs to up to 5 mobile users.
SMS phone numbers and user ID
SMS Central is taken from the SIM-card and cannot be changed.
Number 1 – 5 lists the recipients of the alarm messages, i.e. +6141xyyyzzz
Note: It is our recommendation that you use the full international number in any entry.
Latest Incoming SMS
“Phone Number” shows the last number to send a valid message
“Date and Time” shows when the last valid message was received
Note: You can use these two entries to determine if there is a problem sending SMSs to the
wireless modem…. If you don’t see your SMS displayed it may be because your SMS is not
being delivered or because of an SMS formatting issue.
SMS formatting issues will affect you if you use a phone to send an SMS that has extra
characters inserted. As an example one type of phone will insert a variable line of dashes at
the top and bottom of an SMS and the wireless modem cannot then determine where, within
the SMS, the real content starts and so the SMS is rejected.
To diagnose whether or not the SMS has formatting issue you can send a test message from
your phone to another type of phone and see if there are extra characters OR call your
distributor and they may be able to give you a test number to send to and they could then let
you know whether the content and format of your messages is acceptable.
Unit ID added to messages
If you select “Use SIM Phone Book (Phone number 1) as User ID” the ID of the unit will be
whatever number is configured in that slot.
Note: This does not change the number from which any SMS is sent – it simply identifies the
device in the text area of any data sent.
If you select “Use SIM Card ID as User ID” the units ID will be the ID of the SIM.
See note above about the ID
Page 9 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
If you want to enter a textual ID then enter it into the text box and uncheck the two checkboxes
above
You have forty (40) characters available and we suggest that you use the shortest practical ID
possible as there are only 160 characters available in an SMS and if you use 40 characters for
the ID this leaves only 120 characters for the content of the SMS which may limit the
information that can be sent.
When entering a specific ID you should not use punctuation characters – to guarantee that you
don’t affect the field positioning of any data being sent by the 9900 you should never use a
comma in the Device ID. If you have a comma in the Device ID you will effectively add a new
field to any data sent as the data is delimited with commas by default.
Use incoming security filter
You may restrict the users that can access the unit, users sending SMSs to the 9900 to control
configurable options or to return current statuses by selecting “Use incoming SMS security
filter”
Maximum number of SMSs per day allowed to be sent
To prevent a large number of SMSs being sent due to an invalid configuration or an unstable
input/system state you may limit the maximum SMSs sent in a single 24 hour period. This 24
hour period starts at the time the wireless modem is powered and is not based on any specific
time.
See the Delay
and Alarm Restore Delay description (within the individual I/Os) for other ways
to limit invalid sending.
If the wireless modem exceeds the maximum allowed SMSs in a single 24 hour period then
any alert that is triggered will still generate a message to the serial port (and will send a TCP
or UDP alert if configured) but no SMSs will be sent until the current 24 hour period expires.
There is no indication available of when the current 24 hour period expires.
Alarm Messages
Append Alarm status allows you to chose whether or not to add the status (High or Low) to the
alert message – by default you would normally enable this.
Append Unit ID allows you to choose whether or not to add the Unit Id to the alert message.
Page 10 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
I/O Settings
7 x I/O’s configurable as digital, analogue or pulse are available on the RJ45 connector, pin
allocations are as shown below.
Pin Function Looking at Modem Socket
1 Configurable as:
◩ Digital Input: LL<0.5V, HL>2.5V, Max Input 50VDC
◩ Digital Output: LL0V, HL3V,0.1mA
◩ Pulse Input: LL<0.5V, HL>2.5V, Max Input 50VDC
2 Configurable as:
◩ Digital Input: LL<0.5V, HL>2.5V, Max Input 50VDC
◩ Digital Output: LL0V, HL3V,0.1mA
◩ Pulse Input (I/O8): LL<0.5V, HL>2.5V, Max Input 50VDC
3 Configurable as:
◩ Digital Input: LL<0.5V, HL>2.5V, Max Input 50VDC
◩ Digital Output: LL0V, HL3V,0.1mA
◩ Pulse Input (I/O9): LL<0.5V, HL>2.5V, Max Input 50VDC
◩ Analogue Input: 0-2.5VDC, Max Input 50VDC
4 Configurable as:
◩ Digital Input: LL<0.5V, HL>2.5V, Max Input 50VDC
◩ Digital Output: LL0V, HL3V,0.1mA
◩ Analogue Input: 0-2.5VDC, Max Input 50VDC
5 Configurable as:
◩ Digital Input: LL<0.5V, HL>2.5V, Max Input 50VDC
◩ Digital Output: LL0V, HL3V,0.1mA
◩ Analogue Input: 0-2.5VDC, Max Input 50VDC
6 Configurable as:
◩ Digital Input: LL<0.5V, HL>2.5V, Max Input 50VDC
◩ Digital Output: LL0V, HL3V,0.1mA
◩ Analogue Input: 0-2.5VDC, Max Input 50VDC
7 Configurable as:
◩ Digital Input: LL<0.5V, HL>2.5V, Max Input 50VDC
◩ Digital Output: LL0V, HL3V,0.1mA
◩ Analogue Input: 0-2.5VDC, Max Input 50VDC
IO7 can also be used as a „toggled“ output in combination with the ETM IO board
to provide switched sensor power supply – contact ETM for more details
8 GND
IO 1 & 2
Delay before alarm is activated
Is recommended to reduce the incidence of multiple SMS being sent in the event of
chattering/bouncing contacts
Caution
Take care to ensure that only
the correct connectors are
used or mechanical damage
to the pins may result.
12345678
Caution
SMS Alarm - Never tick a
blank number as this will
cause the modem to try to
repeatedly send an alarm to a
non-existent number
Page 11 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
Alarm restore delay
Stops additional alarm messages occurring within X (in this case 600) seconds of original
event
ET-cmd
Allows for the internal sending of an ET command which could be used to change a timer or
turn on/off an output as the result of an alarm trigger on an input
SMS Alarm
Is used to indicate which, if any, phone numbers to use for sending SMS alarms related to this
input.
Never tick a blank number as this will cause the modem to try to repeatedly send an alarm to a
non-existent number
UMTS/GPRS Alarm
Allows for the sending of any alarm via TCP to server address and port nominated in the
Internet Tab
UDP Server Selection
Allows for the sending of alarms via UDP
In the Alarm / Message Tab a limit can be set on the number of SMS sent in every 24 hour period,
see previous page.
IO 3,4,5,6,7
These IOs can be set to Analogue as well as digital,
Analogue Alarm Input
Allows for high level, low level or both with hysteresis. Do not use the “Use self adjusted Alarm
level with deviation from reference, when alarm is activated” option without consulting ETM.
Hysteresis can be set, this is useful in eliminating nuisance alarms resulting from analogue
values fluctuating above and below the alarm setpoint causing multiple alarms to be sent.
Page 12 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
A/D Cal Param
Shows the current calibration/scaling parameters for the input, refer section on calibration for
more information
IO7 can be used to toggle when logging occurs as a signal to switch power supply to a sensor,
refer logging section for more details
Power In Tab
The unit can send an alarm when the units supply voltage level has fallen below a specific level.
This can be used as a warning for backup battery, solar or mains power failure applications.
Power Source Monitor
Is typically used for internal battery versions and as such is not applicable to most applications
and should be ignored.
Delay before alarm is activated
It is recommended that this is always used for battery alarm applications to ensure nuisance
alarms are not generated.
Alarm restore delay
We do not recommend using this feature for most battery/mains power alarm applications.
ET-cmd
Allows for the internal sending of an ET command which could be used to change a timer or
turn on/off an output as the result of a low voltage alarm
SMS Alarm
Is used to indicate which, if any, phone numbers to use for sending SMS alarms related to this
input.
Never tick a blank number as this will cause the modem to try to repeatedly send an alarm to a
non-existent number
UMTS/GPRS Alarm
Allows for the sending of any alarm via TCP to server address and port nominated in the
Internet Tab
Page 13 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
UDP Server Selection
Allows for the sending of alarms via UDP
Page 14 of 46 For Support Contact +61-2-9956-7377
Or support@etmpacific.com.au
ETM9120 9140 Configuration Tool Userguide201406RV001
Settings Tab
UMTS/GPRS Module <--> MCU and MCU <--> Port
UMTS/GPRS Module <--> MCU should match MCU <--> Port.
MCU <--> Port sets the serial port on the wireless modem and should be adjusted to suit your
device connected to the port.
Flow Control
Currently, only CTS Flow Control is supported
EEPROM Storage Area
Currently, this should be configured to ‘Config Area’
Instructions on Correctly Setting the Baud Rate
The baud rate of the ETM9xxx-xxx modem needs to be set as above with both the
UMTS/GPRS<>Module and MCU<>Port Settings being the same plus the internal engine/module
(TC63i/PH8-P) must be set to the same baud rate using AT+IPR command.
Loading...