iCE3 3G User Guide V1.19

Transcription

iCE3 3G User Guide V1.19
3
iCE 3G
User Guide
For Software
Version: V2.80+
(Requires Firmware
Version: V2.80+)
Amendments
Issue 1
Issue 2
Version 1.00
Version 1.05
15th November 2007
26th November 2007
Issue 3
Issue 4
Issue 5
Version 1.10
Version 1.14
Version 1.17
12th December 2007
28th March 2008
1st May 2008
Issue 6
Issue 7
Version 1.19
Version 1.30
17th June 2008
16th November 2009
Issue 8
*Draft
Version 2.03
7th May 2010
Issue 9
Version 2.10
18th June 2010
Issue 10
Version 2.30
Preliminary
17th November 2010
Issue 11
Version 2.35
21st December 2010
Issue 12
Version 2.50
1st June 2011
Issue 13
Version 2.80
22nd April 2013
First issue. Preliminary only.
Revised terminal menus, added network clock sync, extended status LED
functionality.
First production release version
Added CSD terminal mode access information.
 Minimum RSSI requirement reduced from 7 to 1. (Section 5.1).
 Added AT^ITRM terminal access code. (Section 6.2.2).
 Status LED flash differentiated between low signal and initialising modem.
(Section 5.1).
 Added background logging of initial clock sync, RSSI, IP & CSD
connections, received SMS commands and terminal sessions. (Section 10).
Added terminal echo option. (Section 6.2.8)

Added new special AT commands:
^ISMS (single command SMS message send)
^ICLK (Read iCE3 clock).
^IINT(Set call-in on interval in minutes)

Added new SMS command “int” to set scheduler interval via SMS.

Expanded the information returned in SMS RQ response.

Added comms address mode that uses serial number.

Added dual base support option.

Updated software/firmware upgrade procedure to describe using the
iLink automatic update mode.
Major update for new hardware (PCB Rev 1.2) but with backwards compatibility
with previous PCB. Includes I/O and datalogging function.
Note: Legacy CSD support is no longer available in the later version (PCB
revision 1.2, from serial number AE1-1581+). It is not supported by the new
modem module. This mode is also being phased out by network providers.
*Current consumption with the new modem is being optimised and this document
will be officially released with the confirmed values.

Added extra power save mode (partial) and power management
scheduler. Section 3.4.4.

Added standalone host mode. Section 5.3.4.

Expanded datalogging to emulate functionality of iRIS 150 with
processing modes and alarm options. Section 3.4.5.

Added extra status LED flash sequence for Full Save power mode.
Section 5.1.

Added SMS message forwarding mode. Section 6.2.8.

TCP Server and UDP mode support. Section 6.2.7.

Expanded firmware/software upgrade procedure. Section 13.

Enforced security code on IP terminal access. Section 6.2.1.

Altered clock factor parameter to control clock sync from modem.
Section 6.2.12 .

Additional status LED flash sequences. Section 5.1.

New menu options:
- Digital input as connection trigger source. Section 6.2.7.
- Automatic connect-on-start mode. Section 6.2.11.

Added new sensor source - (6) f.p register. Section 6.2.14.

Added new SMS command. ^IVAL (write value to sensor source).
Section 9.6.

Added source indication of clock synchronisation to terminal main
menu date/time. Section 6.2.4.

Added wire colours as text to I/O diagram to avoid confusion when
user guide printed in black and white. Figure 2.



Added AT^IRSI command. (Section 9.4)
Added reference to Digital Input LED (Sections 2.3 and 5.2)
Added Declaration of Conformity
Disclaimer
Under no circumstances will iQuest (NZ) Ltd be liable or responsible for any consequential damage or loss that may arise from the use
of this product.
All examples and diagrams shown in this manual and any supplied configuration examples are intended as a guide to understanding
this product, not to guarantee operation. iQuest (NZ) Ltd accepts no responsibility for use of this product based on this information or
these examples. Owing to the wide variety of possible applications of this product, you must satisfy yourself as to its suitability to your
specific application.
© 2007-2013, iQuest (NZ) Ltd.
All rights reserved.
This publication, or any part of it, and any software accompanying it may not be copied, photocopied, reproduced, translated or
communicated to any third party, or reduced to electronic medium without prior written permission from iQuest (NZ) Ltd.
Contents
1 Declaration of Conformity ................................................................................................................. 1
2 Introduction ......................................................................................................................................... 2
2.1 About this Manual .......................................................................................................................... 2
2.2 Support ........................................................................................................................................... 2
2.3 Hardware Versions ......................................................................................................................... 2
3 Overview .............................................................................................................................................. 3
3.1 General Characteristics.................................................................................................................. 3
3.2 Typical Applications ....................................................................................................................... 3
3.3 Technical Specifications................................................................................................................. 3
3.4 Key Features .................................................................................................................................. 4
3.4.1 Terminal Configuration ............................................................................................................ 4
3.4.2 Wireless Internet (IP) Connectivity .......................................................................................... 4
3.4.3 Static and Dynamic IP addressing .......................................................................................... 4
3.4.4 Power Management ................................................................................................................ 4
3.4.5 Data Logging ........................................................................................................................... 5
3.4.6 Alarm Processing .................................................................................................................... 5
4 Installation ........................................................................................................................................... 6
4.1 Removing / fitting the SIM card ...................................................................................................... 6
4.2 External Power Supply ................................................................................................................... 6
4.3 Power Supply + I/O Connector ...................................................................................................... 6
4.4 RS232 Connector ........................................................................................................................... 7
4.5 Antenna Connection....................................................................................................................... 7
4.6 Setting the Real Time Clock .......................................................................................................... 7
4.7 Recommended Deployment Procedure ......................................................................................... 8
5 Operation ............................................................................................................................................. 9
5.1 Status LED Indicator ...................................................................................................................... 9
5.1.1 Host Port Speed Display ......................................................................................................... 9
5.2 Digital Input LED Indicator ............................................................................................................. 9
5.3 Host Device Type settings and operation .................................................................................... 10
5.3.1 Normal (Type=0) ................................................................................................................... 10
5.3.2 Campbell Scientific Array Based Logger (Type=1) ............................................................... 10
5.3.3 Unidata (Type=2)................................................................................................................... 10
5.3.4 Standalone (Type=3) ............................................................................................................. 10
6 Terminal Configuration .................................................................................................................... 11
6.1 Terminal Cfg ................................................................................................................................. 11
6.2 Terminal Menus ........................................................................................................................... 13
6.2.1 IP Terminal Security Code .................................................................................................... 13
6.2.2 Invoking the Terminal ............................................................................................................ 13
6.2.3 Menu Structure ...................................................................................................................... 14
6.2.4 Main Menu (Level 1) .............................................................................................................. 14
6.2.5 Power Management Cfg (Level 2) ........................................................................................ 15
6.2.6 Power Schedule Cfg (Level 3)............................................................................................... 16
6.2.7 Comms Cfg (Level 2) ............................................................................................................ 17
6.2.8 Host Port Cfg (Level 3) .......................................................................................................... 19
6.2.9 3G Cfg (Level 3) .................................................................................................................... 20
6.2.10 Phone List (Level 3) ............................................................................................................ 23
6.2.11 Comms Schedule Cfg (Level 4) .......................................................................................... 23
6.2.12 Date/Time Cfg (Level 2) ...................................................................................................... 25
6.2.13 Datalogging Cfg (Level 2).................................................................................................... 26
6.2.14 Sensor Cfg (Level 3) ........................................................................................................... 27
6.2.15 Alarm Selection (Level 4) .................................................................................................... 29
6.2.16 Alarm Cfg (Level 5) ............................................................................................................. 30
6.2.17 Miscellaneous Cfg (Level 2) ................................................................................................ 31
7 CSD (Dial-up) Operation................................................................................................................... 31
8 SMS (Text) Commands..................................................................................................................... 32
3
8.1 Request iCE Information (RQ) .................................................................................................... 32
8.2 Go On-Line (GOL)........................................................................................................................ 32
8.3 Set the Scheduler On Interval (INT) ............................................................................................. 32
9 Host Commands ............................................................................................................................... 33
9.1 Go On-Line (AT^IGOL) ................................................................................................................ 33
3
9.2 Request iCE Real-Time Clock (AT^ICLK)................................................................................... 33
9.3 Send manual SMS message (AT^ISMS) ..................................................................................... 33
3
9.4 Request iCE Received Signal Indication (AT^IRSI) .................................................................... 33
9.5 Set the Scheduler Call-In Interval (AT^IINT) ................................................................................ 34
9.6 Set a Sensor Source Value for Logging (AT^IVAL) ..................................................................... 34
10 Data Logging ................................................................................................................................... 35
10.1.1 Overview.............................................................................................................................. 35
10.1.2 Logging Internal Parameters ............................................................................................... 35
10.1.3 Diagnostic Logging .............................................................................................................. 35
10.1.4 Logged Data Array Identification ......................................................................................... 36
10.2 Unloading Logged Data ............................................................................................................. 37
11 Troubleshooting ............................................................................................................................. 39
3
11.1 iCE will not respond in RS232 terminal (configuration) mode .................................................. 39
11.2 Unable to connect to the remote TCP or UDP server ................................................................ 39
3
11.3 iCE will not respond to SMS requests ...................................................................................... 39
3
11.4 iCE will not answer CSD data calls .......................................................................................... 39
12 Host (RS232) Port - Cable Connections ....................................................................................... 40
12.1 Standard (Non-handshake) Device (No cable label) ................................................................. 40
12.2 Campbell Scientific Array Based Datalogger (Cable label – “CSIU”) ........................................ 40
12.3 Unidata Logger – Standard (Cable label – “UNI1”) .................................................................... 41
12.4 Unidata Logger – In NIWA enclosure (Cable label – “UNI2”) .................................................... 41
12.5 NIWA Datalogger (with Unidata engine) (Cable label – “UNI3”) ................................................ 42
13 Firmware/Software Upgrade Procedure ....................................................................................... 43
13.1 Overview .................................................................................................................................... 43
13.2 File Naming Conventions ........................................................................................................... 43
3
13.2.1 iCE Executive Firmware. .................................................................................................... 43
3
13.2.2 iCE Application Software. .................................................................................................. 43
13.2.3 Wavecom Module OpenAT® Application (iCE3 Serial No AE1-1581+ only) ...................... 43
3
13.3 iCE Automated Upgrade Procedure ......................................................................................... 44
14 User Notes ....................................................................................................................................... 49
Tables & Figures
Table 1 - Hardware Version Differences ........................................................................................................... 2
Table 2 – RS232 Connector Pin Functions ....................................................................................................... 7
Table 3 - Status LED Indication Modes ............................................................................................................. 9
Table 4 - RS232 Host Port Speed Indication .................................................................................................... 9
Table 5 - Last Clock Synchronising Source..................................................................................................... 15
Table 6 - Sensor Sources ................................................................................................................................ 27
Table 7 - Sensor Modes .................................................................................................................................. 28
Table 8 - Sensor Logging Flags ...................................................................................................................... 28
Table 9 - Logged Data Array ID Definitions ..................................................................................................... 36
Figure 1 - SIM Card Lock................................................................................................................................... 6
Figure 2 - Power Supply I/O Connector and Cable ........................................................................................... 6
Figure 3 - RS232 Connector Pin View............................................................................................................... 7
Figure 4 - Terminal Menu Structure ................................................................................................................. 14
Figure 5 - Scheduled Modem Power Mode Example ...................................................................................... 16
Figure 6 - Scheduled Comms Connection Example ....................................................................................... 24
Figure 7 - Standard Device Cable ................................................................................................................... 40
Figure 8 - CSI Array Based Datalogger Cable ................................................................................................ 40
Figure 9 - Unidata Standard Datalogger Cable ............................................................................................... 41
Figure 10 - Unidata (NIWA Variant) Datalogger Cable ................................................................................... 41
Figure 11 - NIWA Logger Family Datalogger Cable ........................................................................................ 42
iCE3 3G User Guide
1 Declaration of Conformity
iQuest(NZ) Ltd
Waikato Innovation Park
Ruakura Road, Hamilton 3214
New Zealand
Ph: +64 7 8570810
Fax: +64 7 8570811
We,
of
in accordance with the following Directives:
2004/108/EC
The Electromagnetic Compatibility Directive
Standards met:
BS EN 55022:2010: Incorporating Corrigendum No. 1 and Amendments Nos. 1 & 2
Information Technology Equipment –
Radio Disturbance Characteristics –
Limits and Methods of Measurement
BS EN 55024:2010: Incorporating Amendments Nos. 1 & 2
Information Technology Equipment –
Immunity Characteristics –
Limits and Methods of Measurement
FCC Code of Federal Regulations 47: Telecommunication
Part 15 – Radio Frequency Devices
Subpart A – General
Subpart B – Unintentional Radiators
I hereby declare that the equipment named above has been designed to comply with the relevant sections of
the above referenced standards and all products supplied under this Declaration will be identical to the
sample tested.
Signed:
Name:
Position:
Place:
Date:
1
David Richards
Managing Director
Hamilton
20/09/2012
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
2 Introduction
2.1 About this Manual
3
This manual is intended as a detailed guide for the HSDPA (3G) compatible iCE installation, configuration
and operation.
This manual is also available online in PDF format at www.iquest.co.nz
Throughout this document, small icons are used to identify additional information. These are as follows:
NOTE:
Indicates extra detail to expand the current discussion.
WARNING:
Describes something that may cause problems if not heeded.
2.2 Support
3
Additional technical support for the iCE 3G is available by contacting:
iQuest (NZ) Ltd
PO Box 15169
Dinsdale
Hamilton 3243
NEW ZEALAND
Tel:
+64 7 857-0810
Fax:
+64 7 857-0811
Email: [email protected]
For latest information and software updates, visit the iQuest (NZ) Ltd web site at www.iquest.co.nz.
Access to the client area on the website requires a log-in which is can also be used to access
the iQuest forum. Self-registration is available by visiting the website home page.
2.3 Hardware Versions
A significant hardware upgrade occurred from PCB revision 1.2, serial number AE1-1581 onwards. This
included a different modem module and the inclusion of some local external I/O, enabling autonomous data
logging for small specialised applications.
The firmware and software releases (V2.00+) are fully compatible with the earlier units as the hardware
version is automatically detected. The only limitation is that the datalogging of real I/O will result in logged
values of zero as there is no hardware to support the feature. RSSI logging will work correctly on all units.
This table shows the differences between the hardware versions.
PCB Rev
1.1
1.2
1.3
Serial Number
Up to AE1-1580
From AE1-1581
to AE1-2775
From AE1-2776
Wireless Modem
Maxon MM6280E OEM
Wavecom Q26 Extreme
Wavecom Q26 Extreme
External I/O
None.
1 x digital, 1 x analogue, 1 x supply voltage.
No digital input LED.
1 x digital, 1 x analogue, 1 x supply voltage.
Red digital input LED on front panel.
Table 1 - Hardware Version Differences
2
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
3 Overview
3.1 General Characteristics
3
The iCE (iQuest Circuit Extender) has been designed as a cost effective, low power, self-contained circuit
extender to enable communication with equipment over a wireless (3G) network connection. Typical devices
3
that the iCE can be used to interface with include dataloggers, PLCs etc.
3
The iCE unit comes standard with a d.c power lead. A host device (RS232) cable pre-wired for one of three
different host device types (see Section 12) is available as an optional accessory. The SMA antenna
connector allows the use of a small stubby antenna (optional accessory) or alternatively, a coaxial cable to a
higher gain external antenna for use in areas where signal strength is low.
3.2 Typical Applications
3
The iCE can be used in a number of applications, including:


Wireless IP telemetry and circuit extension to third party devices
Wireless IP / RS232 serial gateway to multi-drop networks
3
The iCE provides an effective means for the migration of legacy dialup telemetry networks to more cost3
effective wireless IP communications over 3G. By simply replacing existing dialup modems with an iCE ,
you can have virtually any logger type telemetered over the 3G network. If you are using a HydroTel
3
telemetry system, the iCE can be configured to call-in and be downloaded using a dynamic IP address
which further simplifies the deployment. See Section 3.4.3 for more details.
3.3 Technical Specifications
Dimensions:
84mm x 63mm x 31mm (WxHxD),
Mass:
105g
Digital I/O:
1 x Digital Input
- 30Vdc maximum input, switch to 0Vdc to activate.
- May require external debounce components for some applications.
Analog I/O:
1 x 12 bit uni-polar Analog input. Range 0-5000mV. Input impedance 103kΩ.
Referenced to 0V common. Internal measurements available for monitoring are:
 Supply Voltage
 Received Signal Strength (RSSI) in dBm
3
 iCE internal temperature.
Power Supply:
External 5-32Vdc supply.
Power Consumption:
Average 3 mA @ 13.8V. “Full Save” power mode, standalone with no RS232.
Average 5 mA @ 13.8V. “Full Save” power mode with active RS232 terminal.
Average 21 mA @ 13.8V. Idle in “Partial Save” power mode, 3-wire RS232.
Average 28 mA @ 13.8V. Idle in “No Save” power mode.
Average 60 mA @ 13.8V. Passive on-line in UDP or TCP server listening mode.
Average 120 mA @ 13.8V. Active on-line with an active TCP or CSD session.
Actual current is dependent on the modem state; data traffic quantity
and relative signal strength (i.e. transmit power required).
Comms Interfaces:
1x RS232 high density DB15, variable speed, DCE configuration.
1x Integral 3G wireless modem.
Environmental:
Operating Temperature: -20C to +70C.
Humidity:
Maximum 95%, non-condensing.
3
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
3.4 Key Features
3.4.1 Terminal Configuration
All configuration and set-up parameters are modified via a standard ASCII terminal connected to the RS232
serial interface. This means that the user can configure the device without needing to have specialised
configuration software installed on their computer specifically for this purpose. It is also possible to configure
the device remotely via a CSD (dial-up) session from the wireless network. See Section 7 for details on this
mode.
3.4.2 Wireless Internet (IP) Connectivity
Wireless Internet connectivity is provided via the on-board modem. Through this interface, data packets can
be transferred to and from the host (RS232) port. To facilitate IP connectivity, a suitably activated SIM card
must be installed in the device. It is also necessary to program the unit with appropriate settings via a
terminal connected to the host (RS232) serial interface.
3
The iCE communicates over the wireless network using TCP/IP or UDP protocol via a single data port. The
device supports ASCII and binary communication to a wide range of iQuest and third party equipment. It
also supports consecutive connection to two separate base servers.
3.4.3 Static and Dynamic IP addressing
3
The iCE supports both static (fixed) and dynamic IP address modes. Whether the mode is static or dynamic
is set by the service provider and the SIM card supplied by them.
3
Static IP addressing allows the iCE to work with any mix of software or device, as each end of the 3G link
knows the IP address of the other end. However, this mode usually requires a dedicated APN or else an
additional ongoing cost for a static IP on a wide area network.
Dynamic IP addressing requires that HydroTel™ is installed at the remote (base) location. In this mode, the
3
iCE initiates the connection, typically via the Internet and sends a special call-in packet to the base.
3
HydroTel™ then captures the IP address that was allocated to the iCE for that session and uses it for all
3.
ongoing communication with the host device attached to the iCE
The advantage of dynamic IP addressing is the ability to have low cost IP connectivity to any device
supported by HydroTel™. This can be achieved by a simple Internet connection via a local service provider.
3
The embedded microcontroller in the iCE manages the IP session establishment and maintenance,
meaning that the host device does not need any special intelligence of its own.
3.4.4 Power Management
3
The iCE supports three distinct power management modes which are listed below. The power save function
also has a scheduler which allows the unit to automatically switch from the lowest power state (full power
save) to higher level with an active state where it can receive SMS messages and/or remote IP connections.
Please refer to Section 0 for details on the Power Scheduler.
No Save
With power management disabled, the internal wireless modem is maintained in a powered on state even
when an IP or CSD session is not currently active. While in this state, regular signal strength measurements
are made and it is possible to interrogate the internal modem using the AT command set via a terminal
connected to the serial interface. The unit is also able to receive and respond to SMS messages when in an
idle state.
4
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Partial Save
This mode requires that a three-wire RS232 connection be used (Rx/Tx and Gnd only). If a full
RS232 connection with handshaking lines (specifically DTR) is used, the unit will operate at a similar
power level to the “No Save” mode.
In partial power management mode, the internal wireless modem is maintained in a powered on state even
when an IP or CSD session is not currently active just like “No Save”. However, in this mode, no signal
strength measurements are made except just prior to a connection being made. This minimises the modem’s
power requirements by making use of its automatic UART shutdown function.
It is possible to interrogate the internal modem using the AT command set via a terminal connected to the
serial interface. The unit is also able to receive and respond to SMS messages when idle in this mode.
Full Power Save
When power management is set to “Full Save” power mode, the internal wireless modem remains in a
powered off state until the power level is raised by the power scheduler or an IP session is activated via the
comms scheduler.
While the modem is in this full-save state, it is not possible to obtain signal strength
measurements or interrogate the modem via the AT command set using the Modem Terminal
mode. It will also not answer CSD calls, respond to SMS or accept incoming IP connections.
3.4.5 Data Logging
The iCE3 supports the logging of data from four virtual sensors, plus a further three internal data sources
(supply voltage, RSSI and internal temperature).
3
Please refer to Section 10 for a detailed description of the datalogging capabilities of the iCE .
3.4.6 Alarm Processing
Each virtual sensor can be checked for two separate alarm conditions. Each alarm has separate trigger and
reset levels, as well as an activation delay or accumulation period depending upon the data type. If an alarm
is triggered it will initiate an IP connection in the same way as the Comms Scheduler or a manual request via
the RS232 port (AT^IGOL command) or an SMS message (GOL) initiates a connection.
5
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
4 Installation
4.1 Removing / fitting the SIM card
3
Important! Ensure the iCE is depowered before attempting to fit or remove the SIM card. Also,
3
if the SIM card lock is not engaged (moved fully to the right), the iCE will not operate correctly.
Figure 1 - SIM Card Lock
To fit the SIM card, check that the SIM card lock is fully to the left (unlocked). Insert the card with the gold
contacts facing upwards and the edge with the chamfered corner facing the unit. Push the card fully into the
slot until it clicks into place. Slide the lock fully to the right to engage it.
To remove the SIM card, slide the SIM card lock to the left (unlocked). Then press the SIM card inwards
slightly. This will release the latch and allow the card to be extracted from the SIM card carrier.
4.2 External Power Supply
3
The iCE does not have an internal battery and therefore requires an external power supply. It will accept
any external dc power source ranging from 5 to 32Vdc. In the later model, this can be logged on a regular
basis and made available via telemetry for system health monitoring. See Section 4.3 below for details on
the power supply connection which is part of the I/O connector.
Although the average current consumption is reasonably low, it is important that the power supply is capable
of delivering the high current peaks that wireless modems are capable of drawing. To this end, iQuest
recommends that a gel-cell type battery be used to power the unit, with appropriate trickle charging from a
suitable source. In normal operation, the host device is likely to have a suitable power supply available.
4.3 Power Supply + I/O Connector
On the later hardware revision, the digital and analogue I/O share the power supply connector. The
connections are via two flying leads. On earlier hardware units, the two I/O pins are unused. The pin
designations of the power supply and I/O connector are shown in the diagram below.
+Vin
Analog In
Gnd
Digital In
4-core circular 7/0.2 cable
Vin (Red)
Gnd (Black)
Ain (Blue)
Din (White)
Figure 2 - Power Supply I/O Connector and Cable
6
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
4.4 RS232 Connector
3
The iCE has a high-density DB15 male RS232 connector. The pin designation are shown in the table
below.
Pin
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Function
DCD (Data Carrier Detect)
TXD (Transmit Data In)
Not used
Not used
Not used
RXD (Receive Data Out)
DSR (Data Set Ready Out)
DTR (Data Terminal Ready In)
GND (Signal Ground)
Not used
CTS (Clear To Send Out)
RTS (Request To Send In)
RI (Ring Indicator Out)
Not used
Not used
Type
OUT
IN
5
OUT
OUT
IN
6
10
15
OUT
IN
OUT
1
11
Figure 3 - RS232 Connector Pin View
Table 2 – RS232 Connector Pin Functions
4.5 Antenna Connection
3
The iCE has a standard SMA antenna connector. For installations with a good signal level, a small rightangle ground plane independent stubby antenna will provide good results. Such antennae are available
from iQuest or other suppliers. This attaches directly to the SMA connector on the front of the unit. In areas
of marginal coverage, iQuest recommend using an external higher gain antenna.
4.6 Setting the Real Time Clock
3
If the iCE will be used in scheduled connection mode (by using the communication scheduler), the internal
clock will need to be checked and if necessary, set correctly after installation on site and all other
configuration has been completed. In normal operation, the clock will automatically synchronise to the
wireless network time shortly after power up, however a facility to manually set the clock is also provided.
Section 0- Setting the Real Time Clock contains details on checking and optionally setting the date and time.
3
This step is required because the clock is reset to a default time when the iCE has been
depowered for any reason. The iCE3 makes an attempt to get the best time reference in this
case.
st
If there is no logged data available, the clock will be set to (1 January 2008 @ 00:00:00). If logger
data is available, the iCE3 will set its clock to a time/date one second past the time stamp of the last
record. It does this as it has no idea of how long it has been since the record was logged.
This at least keeps logged data records in chronological order. Note that the schedulers (power
and/or comms connections) will still work if the clock has not been synchronised, they will just not
be synchronised to the correct time of day. Please refer to Section 0 for more details on using the
Scheduled Power Mode or Section 6.2.11 for more details on using the Scheduled Connection Mode.
7
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
4.7 Recommended Deployment Procedure
8

Obtain and install the SIM card from your preferred service provider. Ensure that the SIM card lock
is fully engaged. See Section 4.1 for details on fitting the SIM card.

Connect an antenna and power supply to the iCE .

Using a standard cable (see Section 12.1 for details); connect a computer with a suitable terminal
program such as iLink or HyperTerminal®.

Configure the iCE completely before taking it into the field for installation. Use the typical
configuration at the end of this document as a guide.

If using the datalogging function, configure and check the operation of the real-world inputs if
possible.

If used in conjunction with HydroTel™, configure the logger and site in HydroTel™ for the
installation, including the chosen communication address. This must match the address in the
3
3
iCE when used in scheduled (call-in) mode. Note that the iCE can be configured to
automatically set its address based on its serial number with an optional offset. See Section 6.2.7.

Test it on-line. If necessary use the manual connection initiation command (”AT^IGOL”) to force a
connection if waiting for the scheduler is not an option. See Section 6.2.4.

Take the iCE to site and install it. Take a suitable computer (laptop) and standard cable to allow
testing and further configuration on-site if needed.

As the iCE will usually be used in scheduled connection mode, the final step is to check the internal
clock. Normally, this will be synchronised to the network time after acquiring the network. Use the
standard cable and terminal program on the computer to check and if necessary, set this. See
Sections 4.6 and 0 for information on the clock.

Finally, make sure the correct cable is securely connected to the host device.

If possible check that the system works properly end to end, including communication with the host
device.
3
3
3
3
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
5 Operation
5.1 Status LED Indicator
3
The iCE has a single blue LED mounted on the front panel. This indicates the current device status and is
useful for diagnostic purposes. The various LED indicator states are as follows:
Condition
Idle in full power save mode. Modem off.
Modem is being initialised.
Not connected, but has good signal strength
IP connection is being established.
Waiting for a RS232 host device to respond. Only
applies to host types CSI Array or Unidata..
Connected to the Primary base.
Connected to the Secondary base.
Acting as a listening TCP server.
No or very low signal strength.
Custom RS232 communications.
Status LED Indication
Single 100ms flash every 5 seconds
Constantly on.
Single 100ms flash every 2 seconds.
Three 100ms flashes every 2 seconds.
Flashes rapidly every 100ms. Very fast 50/50.
State
Idle in Full Power Save mode. Modem off.
Initialising modem.
Idle with adequate signal.
Connecting.
Waiting for RS232 host device response.
Connected to Primary Base.
Connected to Secondary Base.
Listening TCP server active
Idle with insufficient or no signal.
Custom RS232 comms mode active.
One Second
One Second
(This mode has a five second duration)
Short 100ms flash followed by a longer 500ms flash.
500ms flash followed by a short 100ms flash
Flashes every 500ms consistently. Fast 50/50
1.5 seconds on every 2 seconds. 75/25
1 second on every 2 seconds. Slowest 50/50.
Table 3 - Status LED Indication Modes
5.1.1 Host Port Speed Display
3
To assist with determining the correct terminal setting required to connect to the iCE , the status LED is
3
used to display the currently programmed host port speed. This happens when the iCE is first powered up
and the LED will show a series of flashes indicating the host port speed setting. This sequence is repeated
three times before the normal status LED mode commences. The numbers of flashes shown are:
Number of Status LED Flashes
1
2
3
4
5
6
Host Port Speed
1200 bps
2400 bps
4800 bps
9600 bps
19200 bps
38400 bps
Table 4 - RS232 Host Port Speed Indication
5.2 Digital Input LED Indicator
3
iCE units from hardware revision 1.3+ have a red LED that illuminates when the digital input is active.
9
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
5.3 Host Device Type settings and operation
The following modes are configured via the Host Device Type, option 2 in the Host Port Cfg terminal menu.
Please refer to Section 6.2.8 for more details.
5.3.1 Normal (Type=0)
Typical Settings
DFC=0
DTO=20
Forwarding on character disabled.
Forwarding after 200ms of no more characters from host.
Host Port Communication and Handshaking
3
On receipt of a data packet, the iCE will immediately forward it to the host via the RS232 port. The
handshaking lines are completely ignored. Conversely, characters that are received from the host are stored
until either a matching character is detected (if the forwarding character is not zero) or else no more
characters have been received for the forwarding timeout period. The packet is then sent to the remote IP
address.
5.3.2 Campbell Scientific Array Based Logger (Type=1)
This mode is used for the older CSI array based loggers such as the CR10/CR10X.
Typical Settings
DFC=0
DTO=20
Forwarding on a particular character is disabled.
Forwarding after 200ms if no further characters from host.
Host Port Communication and Handshaking
3
On receipt of a data packet, the iCE will assert its CTS line (which is connected to the logger’s RING line). If
3
the logger’s ME line is not active, the iCE then waits until the logger responds (by raising its ME line). The
3
iCE will then output a series of carriage return characters until the logger detects the selected host port
speed and returns a prompt (*).
3
When the iCE determines that the logger is active and at the correct communication speed it will send the
received data packet on to the logger. In reply mode, characters that are received from the datalogger are
stored until no more characters are received for the forwarding timeout period. The reply packet is then sent
back to the remote IP address.
5.3.3 Unidata (Type=2)
Typical Settings
DFC=13
DTO=0
Forwarding on character is enabled on carriage return (13)
Forwarding on time is disabled.
Host Port Communication and Handshaking
3
On receipt of a data packet, the iCE will assert its CTS line (which is connected to the logger’s RTS line).
3
3
The iCE then waits until the logger scans and returns a * prompt. The iCE then sends the received data
packet to the logger. In reply, characters that are received from the datalogger are stored until a forwarding
character (normally a carriage return) is received. The reply packet is then sent back to the remote IP
address.
5.3.4 Standalone (Type=3)
Typical Settings
DFC=0
DTO=20
Forwarding on a particular character is disabled.
Forwarding after 200ms if no further characters from host.
Host Port Communication and Handshaking
3
In this mode, the iCE does not link the wireless connection to its RS232 port at all. All data packets are
3
deemed to be for the iCE itself and it behaves through the wireless connection just as if it were being
communicated to via its RS232 port.
10
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
6 Terminal Configuration
3
The iCE set up and configuration is achieved by a terminal connected to the host (RS232) serial port.
3
The iCE will not automatically output the main menu when terminal mode is entered. This is
to prevent unwanted data being sent into the attached host device’s RS232 port. To access
the terminal, it must be enabled by entering the unlock command AT^ITRM. At any point, the
terminal menus can be refreshed by entering the refresh command (“R” or “r”) followed by
Enter. The terminal mode will time out after 2 minutes of inactivity.
The following sections describe how to set up a terminal connection and the menu options that are available
whilst connected.
®
®
This description assumes a computer running a version of the Microsoft Windows operating system is
®
being used and the descriptions below relate to the standard Windows terminal emulator application,
HyperTerminal™. Other types of computer and terminal emulators may also be used, but details on the setup required are outside the scope of this document.
3
A suitable cable to connect the iCE host (RS232) port to the computer is required. This
should be wired as shown in Section 12.1 (Standard Devices).
6.1 Terminal Cfg
Start Windows® HyperTerminal™ and create a new connection called “3G iCE3”.
properties as shown in the dialog boxes below.
Set your terminal
3
If you have connected the iCE to any port other than COM1, make an appropriate selection from the
“Connect using” combo box.
11
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
3
The iCE RS232 serial port is set by default to a speed of 9600 bps, 8 data bits, 1 stop bit and no parity.
Flow control is not required.
Click this button
to access the
ASCII setup
form
12
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Enable echo
Set line pacing delay
3
Because the iCE does not echo any received characters by default, it is recommended that you enable
“Echo typed characters locally” otherwise you will not see the characters that you type in at the terminal.
However, if required the iCE3 can be configured to echo incoming characters by enabling this feature using
the menu option. See Section 6.2.8.
Set the “Line delay” time to 500ms for pacing the input from text
files, if this method is used for setting up a unit from a common template.
6.2 Terminal Menus
6.2.1 IP Terminal Security Code
3
The iCE enforces the use of a text-based security code (of up to 10 characters) when connecting to the unit
via IP (TCP or UDP). This is used to prevent unauthorised access to the terminal. It is not applied to the
RS232 terminal access as any user accessing this is deemed to be trusted.
The code is set using iLink registered to “Administrator” level. If the code is empty, a hard-coded default of
“extend” is substituted. When the terminal is first enabled, a prompt message is shown and the code must
be entered before the terminal becomes fully available.
The security code is case-sensitive. The code cannot be viewed or changed except by an authorised
user using iLink which is registered to Administrator level.
> Enter Security Code (max 10)=
6.2.2 Invoking the Terminal
To prevent spurious text strings from the host device on the RS232 port accidentally invoking the terminal
and possibly corrupting the configuration, a guard string command must be entered to enter the terminal
mode from the RS232 port. Entering anything apart from the correct string will redisplay the standard prompt:
Use AT^ITRM to enter terminal mode.
>
The guard string is AT^ITRM and may be entered in either upper or lower case. i.e. AT^ITRM or at^itrm.
If the terminal is unused for 2 minutes, it is automatically closed and the following message is displayed.
Terminal closed after 2 mins of inactivity.
Use AT^ITRM to enter terminal mode again.
13
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
6.2.3 Menu Structure
Throughout the terminal menus, there are two things to remember:


Menu option 0 (zero) always returns you to the menu above the current menu level.
Entering “r” or “R” for a menu option will refresh the current menu without selecting anything. This is
also used to display the menu when a terminal session is first established or resumed.
3
When a terminal session has been established with the iCE , you will be presented with the main menu. To
make a menu selection, type a number followed by <Enter>. Invalid menu selections will result in the
display of an error message on the terminal. The current value of any settable item is enclosed in square
braces e.g. [1234].
Level1
Main Menu
Level2
Level3
Power Management
Power Schedule Cfg
Comms Cfg
Host Port Cfg
3G Cfg
Level4
Comms Schedule Cfg
3G Module Info
Date/Time Cfg
Datalogging Cfg
Sensor Selection
Miscellaneous
Initialize
Figure 4 - Terminal Menu Structure
6.2.4 Main Menu (Level 1)
The first menu displayed is the Main Menu. From here, you can make the following choices:
*
1
2
3
4
5
6
iCE3 3G (AE1-1581 F2.31 S2.32 O1.04)
Site Name [My Site Name]
Power Management
Comms
Date/Time [17 Nov 2010, 16:37:07 H]
Datalogging
Miscellaneous
(Use AT^IGOL to manually initiate IP connection)
>
The first line lists the Model (Serial Number, Firmware version, Software version and OpenAT version)
Option 1 - Site Name
Select this option to enter a name for the site. This is not used except as part of a SMS reply string when
requested by the RQ command. This function can be useful to determine the site, time/date and RSSI at a
given 3G network phone number. See Section 8.1 for details on the “RQ” SMS command.
Option 2 - Power
Select this option to display the Power Management configuration menu.
Option 3 - Comms
Select this option to display the Comms configuration menu.
14
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Option 4 – Date/Time
Select this option to access the Real Time Clock configuration menu. The current date and time is displayed
3
as well as a character showing the source of the most recent clock synchronisation. The iCE will seek the
highest quality clock sync source after a restart. This indication is useful to confirm the clock sync status.
?
L
R
N
U
H
Source
Not yet synchronised
Last logged sample date/time.
RS232 host device (this is only available from some host devices
and is dependent on custom software to request the date/time).
Network time (from wireless modem). This is controlled by the clock
factor setting. See Section 6.2.12.
User - via a terminal session or iLink
HydroTel.
Table 5 - Last Clock Synchronising Source
Option 5 - Datalogging
Select this option to configure the datalogging functions.
On units prior to serial number AE1-1581, attempting to log the digital or analogue input will
return values of zero as there is no hardware support for these physical inputs on board.
Option 6 – Miscellaneous
Select this option to display the Miscellaneous configuration menu.
AT^IGOL manual connection command
Entering this command will immediately initiate an IP connection to the wireless network. Once connected, it
will remain on-line for the duration time configured in the Comms Scheduler. See Section 6.2.11.
6.2.5 Power Management Cfg (Level 2)
3
The power management configuration menu allows the configuration of the iCE power management
settings. This function also has a scheduler which allows a further level of control over the modem
activation. The scheduler status is shown with the mode. The scheduler is deemed to be active if the
duration setting is not zero.
*
0
1
2
>
Power Cfg
Exit
Mode [Partial Save. No Schedule]
Schedule
Option 0 - Exit
Select this option to return to the Main Menu.
Option 1 - Mode
Select this option to set the power management save level for the unit. Options are 0=No Save, 1=Partial
Save and 2=Full Save. See Section 3.4.4 for more details on the three power save options.
Option 2 - Schedule
Select this option to enter the Power Schedule configuration menu.
15
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
6.2.6 Power Schedule Cfg (Level 3)
A sub-menu is provided to configure the modem power schedule.
The schedule defines when and for how long the modem is taken from a forced “full power save” mode to
the currently selected power save mode (typically “no save” or “partial save”). If the scheduler is disabled
(duration is zero), the selected power save mode is maintained permanently. If the selected power save
mode is also set to “Full Save”, then the scheduler is effectively disabled as it will not result in any change in
power save mode. A warning is displayed next to the mode if this is the case.
*
0
1
2
3
4
5
>
Power Schedule Cfg
Exit
Start Time [0600]
End Time [1800]
Duration [300 sec]
On Interval [60 min]
Off Interval [0 min]
Option 0
Select this option to return to the Main menu.
Option 1
3
When this option is selected you will be prompted to enter the time at which the iCE will switch from a forced
“Full Save” power mode to the selected power save mode as defined in Option 1 in the Power Management
configuration menu.
> Start Time (HHNN)=
Option 2
3
When this option is selected you will be prompted to enter the time at which the iCE will cease switching out
of “Full Save” power mode.
> Stop Time (HHNN)=
In this example, the modem is enabled to go to the “No Save” level once per hour (on interval = 60 minutes),
for a time of 5 minutes (duration = 300 seconds) starting at 6:00am and ceasing after 6pm. Set the start time
to 00:00 (0000) and end time to 23:59 (2359) for the on/off cycle to apply regularly throughout the complete
day.
NOTE: In this example, the “on” time is from 6am to 6pm. The “off” time is from midnight to 6am and then
from 6pm to midnight. Activations during these two times may be configured differently using the on interval
and off interval settings described below. See Options 4 and 5.
Figure 5 - Scheduled Modem Power Mode Example
16
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Option 3
When this option is selected you will be prompted to enter the length of time in seconds that you want the
3
iCE to maintain the modem in the selected power mode. The minimum value for this setting is 60 seconds.
> Duration (sec)=
Option 4
When this option is selected, you are prompted to enter the length of time in minutes between each
successive power mode change when the time is in the “on” period. I.e. between the start and end times.
> On Interval(min)=
Option 5
When this option is selected, you will be prompted to enter the length of time in minutes between each
successive modem power mode change when the time is in the “off” period. I.e. before the start time or after
the end time. This setting will normally be 0 (no activity in the off period), but this option does allow a
different activation rate to be configured if required.
> Off Interval(min)=
6.2.7 Comms Cfg (Level 2)
3
The comms configuration menu is the starting point for configuring all iCE communication settings:
*
0
1
2
3
4
5
6
7
>
Comms Cfg
Exit
Address [5001] (AE1-1001 +4000)
Host Port Cfg
3G Cfg
Phone List
Callback [0: IP, 0:TCP]
Digital Input Connect Trigger [No]
Modem Terminal
Option 0 - Exit
Select this option to return to the Main Menu.
Option 1 -Address
When this option is selected you will be prompted to enter the iQuest protocol communication address for
the device. The first choice is whether the address should be obtained automatically from the device’s serial
number.
> Use Serial Num as Address. Enable (0:No 1:Yes)=
If this mode is enabled, then an optional offset can now be entered. Using offsets can be used to categorise
units into regions for example.
The serial number plus the offset must still result in an address within the allowable range of 132767.
> Address Offset=
If the automatic serial number mode is not enabled, the menu will go direct to the manual address input
prompt.
> Address=
17
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
When using a manual address, enter a value between 1 and 32767 (the factory default is 1). This address is
used to identify the unit in all iQuest protocol communication and must be unique on a HydroTel™
communications interface.
An address of 0 is reserved for the base station (e.g. HydroTel™) and must not be
3
3
programmed into the iCE . The iCE will always respond to an address of -3 (which is a
special universal address) no matter what its own address is.
Option 2
Select this option to enter the Host Port configuration menu.
Option 3
Select this option to enter the 3G communication configuration menu.
Option 4
Select this option to enter the Phone List menu.
Option 5
This option selects the mode that is used when a connection is initiated (by scheduler, manual terminal
mode command (AT^IGOL) or an alarm trigger.
Only communication option 0 (IP) is supported. However, a second setting on this menu allows the IP mode
to be configured. There are two options for this:
0: TCP. This is similar to the TCP Client mode in earlier software in that connections originated from the
3
3
iCE are still of the TCP client type. However, when the client session ends, the iCE switches mode to
become a listening TCP server which can then accept incoming connections. This feature provides a
3
substitute method of accessing the iCE or host device on an ad hoc basis to replace CSD which is not
available with the later (Wavecom) units. For older units with a Maxon modem (serial number AE1-1580
and earlier), the unit will also accept incoming CSD (dial-up) calls if the network still supports this service.
3
1: UDP. This mode emulates the earlier GPRS iCE model which used UDP protocol for bidirectional
communication.
> Connection (0:IP)=
> IP Mode (0:TCP 1:UDP)=
Option 6
Enabling this option will allow an external signal to initiate an IP connection sequence. To achieve this, the
digital input is activated by is pulling the input down to 0V (GND).
> Digital Input Connect Trigger
This mode should NOT be enabled if the digital input is used as a datalogging source with a regular
pulse rate such as a water meter. Otherwise the iCE3 will connect often. However this mode can be
useful as a connection option for event based installations with infrequent input activation.
18
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Option 7
By using this terminal mode, it is possible to perform two distinct functions depending on the state of the
internal modem. If the terminal is available, this message is displayed.
> Terminal Mode active. Press <ESC> and then <Enter> to exit.
If the internal modem is powered down (because “Full Save” mode is selected) then terminal mode is
unavailable and this message will appear.
> Wireless module inactive. Terminal is unavailable.
Assuming the modem is active, the two scenarios are as follows:

If the internal modem is powered up, but an IP or CSD session is not in progress, then it is possible
to interact with the modem using the standard AT command set.

If the internal modem is powered up and an IP or CSD session is currently in progress, then it is
possible to interact with a terminal at the remote end of the connection.
When using transparent terminal mode you must press the <Enter> key after each command or message
you wish to send. Press ESC then Enter to exit the modem terminal session and return to the communication
menu.
6.2.8 Host Port Cfg (Level 3)
This menu covers the various RS232 Host Port configuration items.
*
0
1
2
3
4
5
6
>
Host Port Cfg
Exit
Host Device Type [0: Standard]
Host Port Speed [4: 9600 bps]
Data Forward Character [0]
Data Forward Timeout [20ms]
Terminal Echo [Yes]
SMS Message Forward [No]
Option 1
This option defines the type of device connected to the RS232 host port. Please refer to Section 5.3 for more
information on the host modes.
> Host Device Type (0=Standard, 1=CSI Array, 2=Unidata, 3=Standalone)=
Option 2
This option configures the RS232 port speed to use when the device is not in terminal mode and is
connected to the host device. The default is 4 (9600bps). To determine the programmed host port speed if
this is unknown, the current setting is displayed as a series of status LED flashes on power up. See Section
5.1.1 for information on the host port speed indication.
> Host Port Speed (1=1200, 2=2400, 3=4800, 4=9600, 5=19200, 6=38400 bps)=
Option 3
This option defines the ASCII character that if received from the host will initiate the forwarding of the data
packet. Range is 0-255. Setting this parameter to zero will disable the forwarding on character mode.
In
this situation, use the forwarding after data timeout function (Option 4 below).
> Data Forwarding Character (0-255)=
19
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Option4
3
This option defines the data gap time (in milliseconds x10) after which the iCE will forward the data packet
to the remote destination. This mode should be used for binary data packets as used by iQuest products
and Campbell Scientific Inc dataloggers (both array and PakBus types).
The allowable range is 0-255 (0  2.55 seconds). If this parameter is set to zero, then data will not be
forwarded unless a forwarding character is defined using the Option 3 above.
> Data Forwarding Timeout (0-255)=
Option 5
This option enables or disables the echoing of characters received from the RS232 port when the unit is in
terminal mode.
> Enable Terminal echo? Enable (0:No 1:Yes)=
Option 6
3
If this option is enabled, then any incoming SMS messages received by the iCE are forwarded to the RS232
port. This will allow a capable host device to process and use the SMS and if necessary respond using the
3
AT^ISMS command. The iCE will still examine all messages and action them if required.
> SMS Message Forward? (0:No 1:Yes) =
6.2.9 3G Cfg (Level 3)
The 3G set-up menu configures the wireless IP connection settings.
*
0
1
2
3
4
5
6
7
8
>
3G Cfg
Exit
APN [telstra.internet]
Login [[email protected],]
SIM PIN [0]
Dual Base mode [No]
Primary Base
[203.190.210.84,7781]
Secondary Base [0.0.0.0,0]
Schedule
3G Module Info
Option 0
Select this option to return to the Comms Cfg menu.
Option 1
When this option is selected you will be prompted to enter an APN (Access Point Name).
> APN=
Enter the APN allocated by your network provider (e.g. telstra.internet).
20
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Option 2
This option is where the network login parameters (user name and password) are configured. When this
option is selected you will be prompted firstly to enter a user name, then a password. Many providers do not
require any login credentials, in which case these parameters should be set to empty.
Press Esc then Enter to enter a completely empty string.
> User Name=
Enter the user name required by your wireless network provider.
> Password=
Enter the password required by your wireless network provider.
Option 3
When the SIM card used has a PIN code enabled for security purposes, use this option to set it. If a PIN
code is not required, enter zero (0) for this setting.
If a SIM PIN is required and an incorrect PIN is entered, the unit will not operate correctly.
Also, if a SIM PIN is not required and a PIN is configured, it may lock the SIM card out due to
multiple attempts to use an invalid PIN number.
Option 4
3
When this mode is enabled and the secondary IP settings are configured, the iCE will make a connection to
both bases in sequence for each connection event (scheduler or manually triggered).
Option 5
When this option is selected you will be prompted to enter an IP address and then a TCP port to use for the
primary base connection. This is the primary destination IP address used for unsolicited binary calls and also
host data traffic once the link is established.
> Primary IP=
Enter the primary IP address that you will connect to. Next, you will be prompted to enter a port number to
use for the primary connection.
> Primary Port=
Option 6
When this option is selected you will be prompted to enter an optional IP address and then a TCP port to use
for secondary communication if dual-base mode is enabled.
> Secondary IP=
Enter the secondary IP address the device will attempt to connect to. If this is not required, you can set the
IP address to 0.0.0.0. Finally, you will be prompted to enter a port number to use for secondary
communication.
> Secondary Port=
Enter a non-zero port number if this mode is to be used, otherwise set it to zero.
Option 7
Select this option to display the Comms Schedule configuration menu.
21
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Option 8
Select this option to display the current module identification parameters, status and signal strength. After
listing the status information, this option then provides a running diagnostic log of communication with the
wireless modem.
Example Status Information:
Type:
IMSI:
IMEI:
RSSI:
LIP:
Wavecom
530011101843665
351919030019844
-76 dBm,0
0.0.0.0
IMSI:
IMEI:
International Mobile Subscriber Information. This is derived from the SIM card
International Mobile Equipment Identifier. This is stored in the wireless module at the factory and
uniquely identifies the hardware by manufacturer and serial number.
RSSI: This displays the Received Signal Strength Indication in units of dBm. This is useful for determining
the strength of the signal. A value of 0 indicates that the RSSI value is not available.
3
The iCE will not attempt to connect to the network if the RSSI is 0 or less than -113dBm.
3
LIP:
The last local IP address that was allocated to the iCE when it was last online.
Example diagnostic information. This will differ between units with either the earlier (Maxon module)
or the later (Wavecom module).
The < character indicates data received from the modem and the > character indicates data
sent to the modem.
The current communication state is shown with a preceding STATE: message that includes
several additional diagnostic e.g. PM1 SR0 TC0 TE0 TM0 LC0 LS0 PB CT3600. These are:
-
PM Actual Power Management level being used. 0=No Save, 1=Partial Save, 2 = Full Save.
SR Sync Request. (0 = clock in sync, 1=need clock sync from network)
TC Terminal Connected. Terminal is connected (but not necessarily enabled).
TE Terminal Enabled. Terminal is enabled and usable.
TM Transparent Mode. The iCE3 is connected and is in transparent mode.
LC Link Control. Requested link control (to the modem module). (Wavecom only).
LS Link State. Actual link state (from modem module). (Wavecom only).
PB Current base (host) that is (or will be) connected. PB=Primary, SB=Secondary.
CT Connection Timer. Connection time remaining. Set to duration when not connected.
Maxon module diagnostics: Serial numbers <= AE1-1580
12:13:40
STATE: Ready 1 0 P
12:13:45
STATE: Ready PM1 SR0 TC0 TE0 TM0 PB CT3600
12:13:45 > AT$$RFINFO=1
12:13:45 < <CH:1062, R-71, T+0, RSCP:-75, PSC:379, ECIO:-4, RSSI:76>
12:13:45 < OK
Wavecom module diagnostics: Serial numbers >= AE1-1581
16:42:35
STATE: Ready 1 0 P
16:42:40
STATE: Ready PM1 SR0 TC0 TE0 TM0 LC0 LS0 PB CT3600
16:42:40 > AT+CSQ
16:42:40 < +CSQ: 13,0 [-76 dBm]
22
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
6.2.10 Phone List (Level 3)
The Phone List menu is the where the primary and secondary phone numbers are configured. This mode is
3
for future support for SMS messages initiated by the iCE itself. Therefore, these are not used at present.
NOTE: The usual method for sending SMS messages is for the host device to use the AT^ISMS command
which also defines the destination phone number.
*
0
1
2
Phone List
Exit
Pri Phone No [+6475551234]
Sec Phone No [+6475551234]
Option 0
Select this option to return to the Comms Cfg menu.
Option 1
When this option is selected you will be prompted to enter the primary SMS phone number.
> Pri Phone No=
3
Enter the number of the primary telephone number that the iCE should send to.
Option 2
When this option is selected you will be prompted to enter the secondary SMS phone number.
> Sec Phone No=
6.2.11 Comms Schedule Cfg (Level 4)
A schedule set-up menu is provided to configure the IP connection schedule.
3
The schedule defines when and for how long client (iCE initiated) connections are initiated. These
connections can also be triggered by an “AT^IGOL” command via the RS232 port or a “GOL” request via
SMS.
*
0
1
2
3
4
5
Comms Schedule Cfg
Exit
Start Time [0000]
End Time [2359]
Duration [120 sec]
On Interval [60 min]
Off Interval [0 min]
Either (in TCP mode)
6 TCP Server Duration [10 min]
or (in UDP mode)
6 Inhibit UDP Announcement [No]
7 Connect on Start
>
Option 0
Select this option to return to the Comms Cfg menu.
Option 1
3
When this option is selected you will be prompted to enter the time at which the iCE is allowed to start
establishing client IP sessions.
> Start Time (HHNN)=
23
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Option 2
3
When this option is selected you will be prompted to enter the time at which the iCE must stop establishing
wireless IP sessions.
> Stop Time (HHNN)=
In this example, the wireless IP link is established once per hour (frequency = 60 minutes), for a time of 5
minutes (duration = 300 seconds) starting at 6:00am and ceasing after 6pm. Set the start time to 00:00
(0000) and end time to 23:59 (2359) for the on/off cycle to apply regularly throughout the complete day.
NOTE: In this example, the “on” time is from 6am to 6pm. The “off” time is from midnight to 6am and from
6pm to midnight. These two times may be configured differently using the on interval and off interval settings
described below. See options 4 and 5.
Figure 6 - Scheduled Comms Connection Example
Option 3
When this option is selected you will be prompted to enter the length of time in seconds that you want the
3
iCE to keep each wireless IP session active. The minimum value for this setting is 60 seconds.
> Duration (sec)=
Option 4
When this option is selected, you will be prompted to enter the length of time in minutes between each
successive IP session being established when the time is in the “on” period. I.e. between the start and end
times.
> On Interval(min)=
Option 5
When this option is selected, you will be prompted to enter the length of time in minutes between each
successive wireless IP session being established when the time is in the “off” period. I.e. before the start time
or after the end time. This setting will normally be 0 (no activity), but this option allows a different connection
rate to be configured if required.
> Off Interval(min)=
Option 6
This option differs depending on the IP mode (TCP or UDP) that is configured.
3
TCP Mode: This allows control over the amount of time the iCE will remain active as a listening TCP server
after any client connections (primary and optionally, secondary) have been completed. Setting this to 0 will
3
disable the TCP server mode and in this scenario emulates the older iCE 3G software. Otherwise, the unit
will remain active and able to accept an incoming TCP client connection from an accepted IP address.
> TCP Server Duration (min)=
24
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
3
UDP Mode: This allows control over whether the iCE will send a call-in (announcement packet) when a
scheduled connection is made. In installations where very lengthy connection times are required, where the
host device is "polled", then a call-in packet on connection is generally not required.
> Inhibit UDP Announcement
Any UDP connection initiated by an alarm activation, received SMS "GOL" command, RS232
AT^IGOL command or a digital input trigger will always send a call-in packet.
6.2.12 Date/Time Cfg (Level 2)
The Date/Time Cfg menu is where the various time functions are configured. These include date, time of
day and time zone offset.
*
0
1
2
3
4
5
6
>
Date/Time Cfg
Exit
Date [27 Apr 2010]
Time [14:14:50]
Date Format [0: d Mth yyyy]
Time Offset [UTC +12hrs]
Use Daylight Saving [No]
Clock Trim [0]
Option 1
When this option is selected you will be prompted to enter the current local date as a string containing four
digits for year, two digits for month and two digits for day. All 8 digits must be entered.
> Date (YYYYMMDD)=
Option 2
When this option is selected you will be prompted to enter the current local time as a string containing two
digits for hour, two digits for minute and two digits for second. All 6 digits must be entered.
> Time (HHMMSS)=
Option 3
3
When this option is selected you will be prompted to select the date format as used by the iCE . Enter a
number to select the desired format.
> Date Format
(0=d mmm yyyy, 1=d/m/yyyy, 2=d/m/yy, 3=m/d/yy, 4=m/d/yyyy)=
Option 4
3
When this option is selected you will be prompted to enter the offset of the iCE ’s local time with respect to
UTC (GMT). This is used for international time correction if the data is forwarded to the iQuest Global Data
Network. For example, enter +12 for NZST or –8 for PST and so on.
> Time Offset=
Option 5
3
This option determines whether daylight saving should be used by the iCE real time clock.
25
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
For this to work, the UTC offset must be able to be obtained from the network time sync. As
this feature is network dependent, it cannot be guaranteed and therefore any host device
function using a clock read obtained from the AT^ICLK? command should be treated with
caution as the time may be out by an hour from that expected. See Section 9.2 for details on
using the clock read command.
Assuming the UTC offset is available, then if this parameter is set to 0 (no), then the unit will run in standard
time all year round. If the setting is 1 (yes), then the clock will follow the local daylight saving status.
> Use Daylight Saving. Enable (0:No 1:Yes)=
Option 6
3
This option allows control over the iCE real time clock. If the factor is set to zero (default), the wireless
modem is used as the primary clock sync source. The modem is typically synchronised to the network time,
so is a useful time source.
However, where the network does nor provide a clock sync facility, the modem's real time clock is likely to be
useless as a clock source. In this case, the factor should be set to non-zero value, typically 1 which will
3
prevent the iCE using the modem's clock.
3
Should the iCE clock drift (lose or gain) over a long time, the factor can be adjusted to give fine control of
the clock to minimise drift.
> Clock Factor (-25 to +25 0=Network sync) =
6.2.13 Datalogging Cfg (Level 2)
The Datalogging configuration menu contains the settings for the integrated datalogging function that is
provided in software version from 2.03+. The current datalogging End Of Data pointer (EOD) is also
displayed here.
* Datalogging Cfg
(EOD Ptr: 168)
0 Exit
1 Sensor1 [Dis]
2 Sensor2 [Dis]
3 Sensor3 [Dis]
4 Sensor4 [Dis]
5 Volts Log [ 60 mins]
6 RSSI Log [0 Dis]
7 Temp Log [0 Dis]
8 Diag Logging [No]
9 Totaliser
>
Option 0
Select this option to return to the main menu.
Option 1
Select this option to display the set-up menu for Sensor 1.
Option 2
Select this option to display the set-up menu for Sensor 2.
Option 3
Select this option to display the set-up menu for Sensor 3.
Option 4
Select this option to display the set-up menu for Sensor 4.
26
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Options 5-7
When this option is selected you will be prompted to enter a regular logging rate for the relevant parameter.
Enter a value between 1 and 1440. Set this parameter to zero to disable logging for the parameter.
> xxx Logging Rate (1-1440 mins, 0 to disable)=0
Option 8
This option enables or disables the diagnostic logging of system events. 0 will disable the diagnostic
function; any other value will enable it.
The RSSI is automatically logged when certain events occur for diagnostic purposes. See
Section 10.1.3, Diagnostic Logging for more detail.
Option 9
This allows the running total of the digital input totaliser to be viewed and adjusted if desired to match for
example, a water meter.
6.2.14 Sensor Cfg (Level 3)
The Sensor Cfg menu is used to configure each of the four main virtual sensors. Refer to the datalogging
features (Section 3.4.5) of this manual for a discussion on virtual sensors. This menu also shows the current
scaled measurement value for this sensor
* Sensor 1 Cfg
(Now: 1.9620)
0 Exit
1 Source [1: Analog]
2 Name [Water Lvl]
3 Mode [Instant]
4 Multiplier [
0.001]
5 Offset [
0.0000]
6 Reject [ 0.000]
7 Log Rate [15 min],Log Mult[1000]
8 Alarms
>
Option 0
Select this option to return to the main Sensor Cfg menu.
Option 1
When this option is selected you will be prompted to enter a number representing the source from which the
virtual sensor should acquire its data. Use zero to disable the sensor. A list of the valid data sources is
shown in the following table.
> Source (0..5)=
Source Description
0
Unused / disabled
1
Analogue Input
2
Pulse Counter on Digital Input
3
Auto Pulse Counter on Digital Input
4
Frequency Counter on Digital In
5
Database Location
6
Floating-Point Database Location
Raw Range
N/A
0 to 5000
0 to 1
0 to 1
0 to 5000Hz
-32768 to 32767
Multiplier
N/A
Offset
N/A
Log Multiplier
N/A
Table 6 - Sensor Sources
Option 2
When this option is selected you will be prompted to enter a name for the sensor (maximum 10 characters).
This name is used to identify the unloaded data.
> Name (max 10)=
27
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Option 3
When this option is selected you will be prompted to enter a number representing the processing mode.
> Mode (0..3)=
Valid modes are:
Mode Name
0
Instant
1
Full Period Average
2
Event
3
4
Scalar Average
(for Wind Direction)
One Minute Average
Description
Logs only the most recent sample
Logs the average of all samples taken over logging period
(Only valid for pulse input sources) Logs non-zero samples.
If the logging rate is 0, then any pulse is logged immediately.
If the logging rate is > 0, then the total accumulated in the period is
logged only if it is not zero. In this mode, if there was no sample
logged at the last log time, a zero sample is also logged, time
stamped with last log time/date. This is required for time series
management purposes.
Logs the average of all samples taken over the logging period, but
uses scalar calculations to calculate the average.
Logs the average of all samples taken over last minute prior to
logging
Table 7 - Sensor Modes
After selecting the mode, you will then be prompted to configure the extended datalogging options by
entering in a number that represents a set of option “flags”.
> Flags (+1:Min +2:Max +4:Dev +8:Flow or Total)=
The number entered is the sum of the extended logging options you want to enable. See the table
below for a listing of all the valid options.
Flag Value 1:
Flag Value 2:
Flag Value 4:
Flag Value 8:
or
Flag Value
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Log Minimum Value sampled in log period
Log Maximum Value sampled in log period
Log Standard Deviation of samples in log period (not currently supported)
Log calculated Flow Rate over log period (only a sensor with a pulse source 2 or 3)
Log Accumulated Volume over log period (only for sensors with a frequency source 4)
Description
No additional logging
Log Minimum
Log Maximum
Log Minimum and Maximum
Log Standard Deviation
Log Minimum and Standard Deviation
Log Maximum and Standard Deviation
Log Minimum, Maximum and Standard Deviation
Log Flow Rate or Total
Log Minimum and Flow Rate or Total
Log Maximum and Flow Rate or Total
Log Minimum, Maximum and Flow Rate or Total
Log Standard Deviation and Flow Rate or Total
Log Minimum, Standard Deviation and Flow Rate or Total
Log Maximum, Standard Deviation and Flow Rate or Total
Log Minimum, Maximum, Standard Deviation and Flow Rate or Total
Table 8 - Sensor Logging Flags
Option 4
When this option is selected you will be prompted to enter a scaling multiplier. This multiplier is used to
convert the raw input into engineering units.
> Multiplier=
28
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Option 5
When this option is selected you will be prompted to enter a scaling offset. This offset is added to the scaled
engineering value.
> Offset=
Option 6
This option is used to enter a simple rejection value. If this is zero, all values will be accepted and logged. If
this value is a positive number, any value equal to or above this will be ignored and the last “good” value
retained. If this value is a negative number, any value equal to or below this will be ignored and the last
“good” value retained.
> Reject=
Option 7
This option is a chained menu (has two parameters). When this option is first selected you will be prompted
to enter a logging rate (in minutes) for the sensor.
> Log Rate=
If you wish to log digital data on change of state you can enter a value of 0. If this parameter is left at 0 for
analogue sources, they will not be logged.
The second part of this option is to enter a logging multiplier to convert from engineering units to an integer
value to storage in the logging memory.
> Log Multiplier=
For example, if you need to log a measurement that is accurate to two decimal places you will need to enter
a logging multiplier of 100.
IMPORTANT NOTE: Care needs to be taken in the selection of an appropriate logging multiplier
3
because the iCE stores data as signed 16-bit integer values (range from -32768 to 32767). This
means that the maximum scaled value multiplied by the logging multiplier must not exceed
32767. If it does, the values will limit at that point and data will be lost.
Option 8
Select this option to display the Alarm Selection menu for the sensor.
6.2.15 Alarm Selection (Level 4)
Use the Alarm Selection menu to decide which of the two alarms you want to configure. You can see at a
glance from this menu which alarms are enabled.
*
0
1
2
>
Alarm Selection
Exit
Alarm #1 (Enabled)
Alarm #2 (Disabled)
Option 0
Select this option to return to the Sensor Cfg menu.
Option 1
Select this option to view the set-up menu for Alarm 1.
Option 2
Select this option to view the set-up menu for Alarm 2.
29
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
6.2.16 Alarm Cfg (Level 5)
The alarm set-up menu is the place to configure each sensor alarm.
*
0
1
2
3
4
>
Alarm 1 Cfg
Exit
Enable [No]
Trigger [
0.00]
Reset [
0.00]
Duration [0min]
Option 0
Select this option to return to the Alarm Selection menu.
Option 1
When this option is selected you will be prompted to enable/disable the alarm.
> Enable (0:No 1:Yes)=
Enter a value of 0 to disable the alarm. Enter a value of 1 to enable it.
Option 2
When this option is selected you will be prompted to enter a trigger level for the alarm.
> Trigger=
Enter a value in engineering units that you want to use as the trigger point for the alarm. When the scaled
value exceeds this limit the alarm will become active.
Option 3
When this option is selected you will be prompted to enter a reset level for the alarm.
> Reset=
Enter a value in engineering units that you want to use as the reset point for the alarm. When the scaled
value falls below this limit the alarm will be deactivated. If the reset level is set to a value greater than the
trigger level then the alarm is reverse acting. This mode is normally used for low voltage or low water level
type alarms.
Option 4
When this option is selected you will be prompted to enter a time in seconds to delay alarm activation. This
can be used to implement hysteresis for analogue data sources. If the data source is one of the internal
counters then this time is used to totalise individual sample values. If the total over the given alarm duration
is above the trigger level then an alarm is generated. Typically this feature is used for rainfall alarms.
> Duration (min)=
30
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
6.2.17 Miscellaneous Cfg (Level 2)
The Miscellaneous configuration menu contains any settings not provided in the other menus.
version, the only option available is the initialisation function.
As at this
* Miscellaneous Cfg
0 Exit
1 Initialize
>
Option 1
This option allows you to initialise the unit before deployment. This resets the totaliser and also the logging
memory. This is useful to eliminate invalid samples that may have been logged prior to commissioning or if
the unit has been reconfigured and deployed in a different location. Type ‘init’ (in lower case, without the
quotes), at the prompt to confirm this action.
> Type 'init' to initialise the unit=
The unit will acknowledge the request as shown and return to the main menu.
Unit has been initialised.
Totaliser and pointers reset.
7 CSD (Dial-up) Operation
3
Legacy CSD support is no longer available in the later version of the iCE (PCB revision 1.2,
from serial number AE1-1581+). This is because it is not supported by the new Wavecom
modem module. This service type is being progressively phased out by network providers.
This update to the iCE3 software (from V2.30+) allows ad-hoc TCP client connections to be
3
made to the iCE in lieu of CSD. The Callback IP sub-mode needs to be set to 1 (TCP Server)
in this case. Refer to Section 6.2.7 for more detail on setting the mode.
However, for earlier models operating on a network that still provides CSD, the following notes will be
informative.
3
The iCE will answer a CSD (dial-up) call when the appropriate service is enabled on the account. To enable
this mode, the CSD service must be added to the account for the SIM card installed in the unit. A second
number is allocated and it is this number that should be used when calling the unit from a dial-up modem.
In Australia, contact Telstra Wireless Support in Australia to activate the CSD service using code 2620.
3
In CSD mode, the iCE will normally act as a standard modem and pass incoming data between the RS232
port and the wireless network.
3
To break this transparent pass-through mode and divert the connection to the iCE itself (for terminal
configuration mode), use the special escape sequence of three minus characters (---) entered in quick
3
succession. When this is issued, the iCE will output the main menu and then respond to commands from
the remote end in exactly the same way that it does through the RS232 port. To terminate this mode the
CSD connection must be dropped.
The reason the --- sequence is required rather than the standard +++ is because the CSD link
is established through an intermediate modem and this device will intercept the Hayes
3
standard escape sequence rather than passing it through to the iCE .
31
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
8 SMS (Text) Commands
3
The iCE is capable of responding to text commands received as SMS messages. This feature allows, for
example the unit to be sent a text message to ascertain its status, change a setting or to be put in on-line.
3
The commands are not case sensitive. If an invalid command is sent to the iCE it will reply with an invalid
command message.
3
If the iCE is already on-line with an IP session, the processing of the SMS message will be
delayed until it disconnects from the IP session.
The three SMS commands supported are:
8.1 Request iCE3 Information (RQ)
3
If the message “RQ” is received, the iCE will reply to the sender with a message showing basic iCE
information. The parameters returned are:







3
3
iCE date/time,
Site name
Serial number
Last logged value of any “sensor” that is enabled.
Supply Volts
3
iCE internal temperature
RSSI. Last measured signal strength in dBm.
An example SMS response message to this command is:
12:13:26 > 11 Jun 2010 12:13:26,Site=My Site Name,S/No=AE1-1752, Rainfall=0.0,tot=12.5, Water Lvl= 1.657,Volts= 13.62,Temp=
19.9,RSSI=-71dBm
The sensor value is the last logged value, not the current value. If a particular sensor has not
logged at all (log rate is set to zero), then the last logged value returned in the SMS message
will be 0.
8.2 Go On-Line (GOL)
3
If the SMS command “GOL” is received the iCE will immediately initiate a client IP connection sequence as
if it was triggered by the scheduler or a manual command through the RS232 port terminal. It will remain online for the duration configured in the scheduler.
3
The iCE will not send a reply to this SMS command. This allows an automated connection
request to be sent by SMS and the initiation of the client IP connection is deemed to be an
acknowledgement of the command.
8.3 Set the Scheduler On Interval (INT)
3
If the SMS command “INT=x” is received the iCE will extract the parameter (x). If this is valid, the value will
be used to update the On Interval in the Comms Scheduler. See Section 6.2.11.
This gives an external user or service the ability to change the call-in interval (cadence or frequency). The
interval parameter must be between 2 and 1440 minutes.
If SMS message forwarding is enabled, the sender’s number and the actual message is sent out the RS232
port in this format. SMS: “Senders Number”,”Message”
32
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
E.g.
SMS: “+64211234567”,”This is a test message”
9 Host Commands
To allow an intelligent host device to directly perform a small number of actions, there are four special AT
commands that the iCE3 will execute immediately without having to invoke the terminal menu.
These commands are only accepted by the iCE3 when it is idle (not on an IP or CSD
connection). If it is on-line, any data received on the RS232 port is transparently forwarded to
the remote base.
9.1 Go On-Line (AT^IGOL)
3
If the command “AT^IGOL” is received the iCE will immediately initiate an IP connection sequence as if it
was triggered by the scheduler or by a “GOL” SMS command. It will remain on-line for the duration
configured in the scheduler settings.
9.2 Request iCE3 Real-Time Clock (AT^ICLK)
3
If the command AT^ICLK? is received, the iCE will respond with its current date and time in a format that will
allow simple parsing of the elements by the host.
th
E.g. for a clock date/time of 16 November 2009 at 12:34:56
AT^ICLK?
^ICLK: 2009,11,16,12,34,54
OK
Using this command to synchronise the clock in the host device should be done with care and
validity checks. The time may be out by an hour from what is expected depending on the
network time sync and the local daylight saving zone status. It is recommended only the
minutes and seconds values be used.
9.3 Send manual SMS message (AT^ISMS)
This command allow the ad hoc sending of SMS messages by the host device which can be useful for site
initiated alarms direct to personnel. It can be used in conjunction with the SMS message forwarding option
where incoming messages are made available to the host device. See Section 6.2.8.
3
When the command “AT^ISMS” is received the iCE will then check for and use two parameter strings. The
first string is the destination phone number to send the message to and the second string is the message
text. Both strings must be encapsulated in quotes (“).
3
If the message is sent successfully, the iCE will respond with an OK otherwise it will return an ERROR
response. E.g.
AT^ISMS=”+6421763953”,”This is a test message from an iCE3”
OK
9.4 Request iCE3 Received Signal Indication (AT^IRSI)
3
If the command AT^IRSI? is received, the iCE will respond with the current RSSI value (in dBM).
AT^IRSI?
^IRSI: -73
OK
33
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
9.5 Set the Scheduler Call-In Interval (AT^IINT)
This command can be used to check update the On Interval setting in the Comms Scheduler. See Section
6.2.11. This gives the host the ability to dynamically change the call-in interval (cadence or frequency) based
on certain criteria. If setting the interval, the value parameter must be between 2 and 1440 minutes.
E.g.
Set interval
AT^IINT=180
OK
Read interval AT^IINT?
AT^IINT: 60
OK
9.6 Set a Sensor Source Value for Logging (AT^IVAL)
This command can be used by an intelligent host device to set the value that can be used for a logging
source. The command has two parameters. The first is the sensor number to set the value for (1-4). The
second is the actual value to set.
E.g. This will set the floating point source value for sensor 1 to 123.45
AT^IVAL=1,123.45
OK
The command will result in an ERROR response if the sensor number is invalid or the input value can’t be
decoded.
34
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
10 Data Logging
10.1.1 Overview
3
The iCE has an internal data store capable of holding 4096 time-stamped samples. This data is stored in a
circular buffer in which the oldest records are overwritten when the buffer is full.
3
To enable this, the iCE has four virtual “sensors” that may be configured to use a range of sources. These
sources may be from the real hardware I/O or alternatively from virtual database locations (registers) for
future applications that may for example update these via a special program.
Each of the four virtual sensors can obtain information from one of the following six data sources:






Analog Input
Pulse Counter attached to the Digital Input
Simulated Pulse Counter enabled by the Digital Input
Frequency Counter attached to the Digital Input
Internal Integer Database Location (for values obtained via user script or communications link)
Internal F.P Location (for values obtained via AT^IVAL command). See Section 9.6.
Each sensor can be set up to scale the raw data source into engineering units through the application of a
multiplier and offset (slope and constant). The scaled value can be logged to non-volatile memory at rates
between once per minute to once per hour or immediately in true event mode for pulse inputs.
As all logged data is stored in integer format, a logging multiplier is applied to the scaled
value to maintain resolution. See Section 6.2.14, Option 7 for details on configuring the
logging multiplier on a sensor.
It is also possible to configure a sensor to also log derived values such as minimum, maximum, standard
deviation (all source types) or a calculated flow rate or volume (pulse type sources only). See the next
section and also Section 6.2.14 for further details on configuring these extended logging features as part of
the Sensor Cfg menus.
3
The data logging time stamps will not be accurate until the iCE real-time clock is valid (i.e. has
been synchronised manually or from the network). However, all events will be in the correct
chronological order as the clock is first initialised to a time one second after the timestamp latest
logged sample in the event of a restart.
10.1.2 Logging Internal Parameters
There are three internal parameters that may be logged aside from the four “free-format” sensors described
above. These are supply voltage, RSSI and internal temperature. These may be logged at a rate between 1
and 1440 minutes (24 hours) if required by enabling them in the Datalogging Configuration menu.
10.1.3 Diagnostic Logging
There is also a “diagnostic” logging function. If this function is enabled, several system events are
automatically logged along with the RSSI (signal strength) value that was available at the time of the event
occurring. The logging of RSSI in this case works in conjunction with any periodic logging of this parameter.
See the next section for the identifiers that are applied to the diagnostic events.
35
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
10.1.4 Logged Data Array Identification
The parameters that are able to be logged and their associated array ID codes are as follows:
Sensor sources selected that require hardware support (analogue, digital or supply volts) are
only valid in later hardware (serial numbers from AE1-1581). In earlier units the value logged for
these will be zero.
The diagnostic logging events are shaded. These only occur if diagnostic logging is enabled.
Array ID
0
1
2
3
4
5&6
7
8
9
51
52
53
54
55
56
57
Function
Cold or warm start. Note. The time stamp will not be exact, but will be in the correct
chronological order with respect to the other logged data records.
Sensor 1
Sensor 2
Sensor 3
Sensor 4
Unused at present
3
Supply voltage. This is the voltage measured on the dc input to the iCE
Received Signal Strength Indication (RSSI). This is in dBm.
3
iCE internal temperature. This is in degC.
Initial clock sync obtained from wireless network or user (following a cold or warm start).
IP connection was successfully established. This includes PPP and PCP socket.
IP connection failed at the PPP stage (connecting to the wireless network).
IP connection failed at the socket stage (connecting to the TCP server at the base).
CSD (dial-up) connection was successfully established. NOTE: CSD only possible on
earlier units (serial number up to AE1-1580).
SMS text message was received.
Terminal session was invoked with AT^ITRM command via RS232 port.
Table 9 - Logged Data Array ID Definitions
Each virtual sensor’s logged data is identified by an array ID number. For the primary logged data, the ID is
the sensor number itself. For the optional supplementary data (min, max, deviation, flow/vol), the array ID
has an offset added to the sensor number that it is derived from. These ID offsets are as follows:
Minimum:
Maximum:
Deviation:
Flow/Vol
+10
+20
+30
+40
For example, Sensor 4 has been configured to log the average value, plus the maximum and standard
deviation. Three data arrays will be logged for this sensor at each logging interval with IDs of 4, 24 and 34
respectively. In HydroTel these require point identifiers of 4/0, 24/0 and 34/0 respectively.
Array 0 (zero) is a special array identifier and is used a system event log. Currently this is
only used to log a restart (either at the initial connection of power, on a watchdog reset or a
user program start after an upgrade). The logged value in this case is always zero. In
HydroTel the identifier for this item is 0/0.
36
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
10.2 Unloading Logged Data
3
1. Ensure that you are connected to the iCE .
2. Click the Unload icon on the main tool bar.
3. This will start up a wizard to guide you through the unload process.
This process is described in the following section: Step 1 – Introduction
The first step contains some information about the unload process. Just click the Next button to proceed to
Step 2. The settings that were used the last time that an unload was carried out are stored in the iLink
profile.
Step 2 - Specify Filename
Enter or browse to a file where the data is to be stored. This can be a new or existing file. A default
filename and folder is suggested and can be modified or replaced to suit. If the file specified already exists,
you have the option in Step 3 to overwrite the file append the data to the end of the existing file. If the file
does not exist, you will be taken directly to Step 4.
Step 3 - Append or Overwrite
If the file selected in Step 2 already exists, so you must select whether to overwrite the file or append the
data to the end of the existing file. Warning: If you choose to overwrite the file, the original contents of the
file will be lost.
Step 4 – Output Format
Select the desired output format for the logged samples. For details of the two available formats, and
example output files, refer to “Output Formats”.
37
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Step 5 - Date Format
Select the date format from the options presented. All samples in the output file will be prefixed with their
respective date/time stamp using the format specified.
Step 6 - Auto-Sync Logger
3
iLink can automatically synchronise the iCE clock to match the current computer time and date after the
unload is complete. To do this, check the box before clicking Next.
This function is not recommended for normal use as computer clocks are often incorrect or
3
may use daylight time when the iCE is set to use standard time.
Step 7 - Select Sample Range
3
The default setting is to unload all logged data from the iCE . However, it is possible to unload a subset of
the logged data if required. When the screen is presented, iLink will automatically query the datalogger to
determine the SOD (Start of Data Pointer) and EOD (End of Data Pointer). These values specify the start
and end range of logged data. If you are unloading the device on a regular basis and keeping track of the
latest data pointer reached on each unload, then you may wish to amend the SOD value to match the EOD
from the last unload. To do this, uncheck the box (Unload All) and then enter the required SOD and EOD
values before clicking Next.
Step 8 - Confirm Settings
The settings you have entered are summarized and displayed on the final confirmation screen. If the
settings are correct, click Next to carry out the unload. If you need to change any settings click the Back
button to review and edit individual settings. If you wish iLink to automatically display the unloaded data file
after the unload is complete, check the ‘View data file after unload’ box. This will invoke the standard
application for files of type .csv and is often Microsoft® Excel.
Even if a .csv file extension is provided, a raw array based .dat file with no header is also
created which is useful in some circumstances where a direct copy of the raw (unscaled)
logged data is required.
Step 9 - Do Unload
Whilst iLink is unloading the samples from the datalogger, a progress bar indicates the status of the unload.
Once the unload has finished, a dialog will be displayed indicating the number of samples unloaded and
processed. Click on OK to close the dialog box. The wizard will close and the main datalogger details
screen will be displayed. If you selected “Display File After Unload” in Step 8, the output file will be displayed
automatically using the default program associated with a .csv format e.g. Excel.
38
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
11 Troubleshooting
This section offers some possible answers to common installation and/or configuration issues.
11.1 iCE3 will not respond in RS232 terminal (configuration) mode
Prompt:
Port Speed:
Connection:
3
When the iCE is in terminal mode through the either the RS232 port or via a CSD link, the
current menu can be refreshed by using “R” or “r” command. Try entering an R, then Enter to
attempt to refresh the menu.
In the case of RS232, the computer port speed setting must match the speed configured in
3
3
the iCE . If you are unsure of the port speed, de-power and re-power the iCE and check the
status LED for port speed indication. See Section 5.1.1.
3
If the iCE is connected on an IP session, the RS232 terminal mode is unavailable. To
disconnect from the IP session and return the unit to idle, thereby activating terminal mode,
use the standard modem AT escape sequence (+++). NOTE: In the case of CSD dial-up
sessions, the terminal mode is invoked by a different sequence (---). See Section 7 on CSD
dial-up access for more details.
11.2 Unable to connect to the remote TCP or UDP server
SIM Card:
SIM PIN:
APN:
Signal:
IP Settings:
TCP Server:
Check the SIM card is active and the account is in credit (if prepay).
Check the PIN code for the SIM card is correctly configured in the 3G Cfg menu.
The unit must be configured for a valid APN that must also match the SIM account APN.
3
The iCE will not attempt to connect if the RSSI is 0 or les than -113dBm. Use a higher gain
antenna if the signal strength is marginal.
3
The iCE will not attempt to connect unless the primary IP and port are defined. I.e. the IP
address is valid and the port is non-zero.
The remote server is not available. Check that the TCP server is operational and configured
correctly and also that the necessary firewall access is enabled for the TCP port and the
3
complete dynamic IP address range that the iCE could be allocated by the network.
11.3 iCE3 will not respond to SMS requests
SIM Card:
SIM PIN:
Power Mode:
Connection:
Signal:
Check the SIM card is active and the account is in credit (if prepay).
Check the PIN code for the SIM card is correctly configured in the 3G Cfg menu.
If Full Power Save is selected, the wireless modem is disabled and will not respond.
3
If the iCE is connected on an IP (3G) session, the SMS feature is unavailable at that time;
however the message will be replied to when unit returns to idle. Configure the scheduled IP
connection to minimise the time that SMS is unavailable.
3
The iCE may not respond if the signal strength (RSSI) is very low. Use a higher gain
antenna if the signal strength is marginal.
11.4 iCE3 will not answer CSD data calls
Hardware:
Legacy CSD support is no longer available in the later version (PCB revision 1.2, from
serial number AE1-1581+). This is because it is not supported by the new modem
module. Also, this mode is being progressively phased out by network providers.
For earlier units and where the network provider still supports CSD, check the following:
SIM Card:
Check the SIM card is active and the account is in credit (if prepay). Also that CSD is
enabled (Telstra account code 2620 in Australia).
SIM PIN:
Check the PIN code for the SIM card is correctly configured in the 3G Cfg menu.
Power Mode: If Full Power Save mode is selected, the wireless modem is disabled and will not respond.
3
Connection: If the iCE is connected on an IP (3G) session, the CSD feature is unavailable. Configure
the scheduled IP connection to minimise the time that CSD is unavailable.
3
Signal:
The iCE may not respond if the signal strength (RSSI) is very low. Use a higher gain
antenna if the signal strength is marginal.
39
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
12 Host (RS232) Port - Cable Connections
12.1 Standard (Non-handshake) Device (No cable label)
This cable is for devices that do not require any special handshaking or prompt character recognition and are
fitted with a DTE configured DB9 female connector. Such devices include the iQuest iCE3 150 datalogger,
Campbell Scientific PakBus loggers and PLCs. See Section 5.3.1 for typical settings for this host type.
A cable of this type is required when configuring the unit from a PC using HyperTerminal® or other terminal
program. See Section 3.4.1 for more details on using the terminal mode for configuring the device.
iCE3
DB15 (M)
Std Device
DB9 (F)
SCREEN
FRAME GND
TXD (IN)
2
3 TXD (OUT)
RXD (OUT)
6
2 RXD (IN)
0V (SIGNAL)
9
5 OV (SIGNAL)
CTS (OUT)
11
8 CTS (IN)
RTS (IN)
12
7 RTS (OUT)
Figure 7 - Standard Device Cable
12.2 Campbell Scientific Array Based Datalogger (Cable label – “CSIU”)
This cable is used for Campbell Scientific array based dataloggers such as the CR10x, CR500 etc. The
3
cable includes the necessary components to match the differing voltage levels between the iCE RS232 port
and the CSI datalogger’s serial port. It also handles both IP and CSD (dial-up) connections. See Section
5.3.2 for typical settings for this host type.
iCE3
DB15 (M)
CSI Datalogger
DB9 (M)
FRAME GND
TXD (IN)
SCREEN
9 TXD (OUT)
2
1N4148
2K2
RXD (OUT)
6
4 RXD (IN)
0V (SIGNAL)
9
2 OV (SIGNAL)
1N4148
CTS (OUT)
11
DCD (OUT)
1
RTS (IN)
12
1N4148
2K2
3 RING (IN)
5 ME (OUT)
Figure 8 - CSI Array Based Datalogger Cable
40
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
12.3 Unidata Logger – Standard (Cable label – “UNI1”)
3
This cable connects directly from the iCE to a standard Unidata Star logger fitted with a DB25 female
computer connector. This diagram assumes the DTE speed is set to 9600 baud as none of the baud rate
setting links on the Unidata’s DB25 are connected. See Section 5.3.3 for typical settings for this host type.
iCE3
DB15 (M)
Unidata
DB25 (M)
SCREEN
FRAME GND
TXD (IN)
2
3 RXD (OUT)
RXD (OUT)
6
2 TXD (IN)
0V (SIGNAL)
9
7 OV (SIGNAL)
CTS (OUT)
11
4 RTS (IN)
RTS (IN)
12
6 DSR (OUT)
Figure 9 - Unidata Standard Datalogger Cable
12.4 Unidata Logger – In NIWA enclosure (Cable label – “UNI2”)
This cable is used for Unidata dataloggers that have been installed in a NIWA pre-wired plastic enclosure
and fitted with a DB9 female connector. Note that these enclosures have pins 2 and 3 of the DB9 reversed
when compared to a NIWA Unidata engine based datalogger such as the HydroLogger. See Section 5.3.3
for typical settings for this host type.
Unidata
(NIWA Variant)
DB9 (M)
iCE3
DB15 (M)
SCREEN
FRAME GND
TXD (IN)
2
3 RXD (OUT)
RXD (OUT)
6
2 TXD (IN)
0V (SIGNAL)
9
5 OV (SIGNAL)
CTS (OUT)
11
7 RTS (IN)
RTS (IN)
12
6 DSR (OUT)
Figure 10 - Unidata (NIWA Variant) Datalogger Cable
41
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
12.5 NIWA Datalogger (with Unidata engine) (Cable label – “UNI3”)
This cable variant is required to connect to the NIWA range of dataloggers such as the “HydroLogger”.
These devices are equipped with the Unidata logging engine and connection is via a DB9 female connector.
See Section 5.3.3 for typical settings for this host type.
NIWA Datalogger
(Unidata engine)
DB9 (M)
iCE3
DB15 (M)
SCREEN
FRAME GND
TXD (IN)
2
2 RXD (OUT)
RXD (OUT)
6
3 TXD (IN)
0V (SIGNAL)
9
5 OV (SIGNAL)
CTS (OUT)
11
7 RTS (IN)
RTS (IN)
12
6 DSR (OUT)
Figure 11 - NIWA Logger Family Datalogger Cable
42
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
13 Firmware/Software Upgrade Procedure
13.1 Overview
3
This section describes the procedure to use when upgrading the firmware/software components in an iCE .
The upgrade procedure has been carried out many times without issue. However, because the
process does involve erasing and reprogramming of flash memory, it is important that a good,
3
securely connected power supply is provided to the iCE throughout the upgrade process.
13.2 File Naming Conventions
13.2.1 iCE3 Executive Firmware.
3
The “Firmware” in the iCE is analogous to the operating system in a PC. It is the Firmware that contains all
the low level functions and library routines used by the Application Software.
3
The iCE firmware is available as a single file for downloading and flash upgrading using iLink. The upgrade
file is in the format:
iCE3_3G_xxx.fls where xxx is the firmware version
e.g.
3
iCE3_3G_230.fls
iCE 3G Firmware, Version Vi/2.30
The default repository for the firmware files is the “Firmware” folder under iLink.
13.2.2 iCE3 Application Software.
3
The “Application Software” in the iCE is analogous to an application such as Word® on a PC. It is the
software that contains the general functionality of the iCE3. This comes in two sections or “banks” (due to the
3
memory configuration of the iCE ) but runs as it were one single program.
The software upgrade files for Banks 1 and 2 are in the format:
iCE3_3G_Std_xxx_y.ic3 where:
3G
Std
xxx
y
is the wireless module type (3G)
is the program variant
is the software version
is the program bank that this file should be loaded into
e.g. iCE3_3G_Std_230_1.ic3
iCE3 3G Software, Version 2.30, Bank 1
The default repository for the program files is the “Programs” folder under iLink.
13.2.3 Wavecom Module OpenAT® Application (iCE3 Serial No AE1-1581+ only)
The iQuest OpenAT® application runs in the Wavecom wireless module and manages the IP connectivity.
This application is available as a single file for downloading using iLink. The upgrade file is in the format:
iCE3_3G_OpenAT_104.dwl where xxx is the OpenAT® application version
e.g.
iCE3_3G_OpenAT_104.dwl
3
iCE 3G OpenAT® Application, Version 1.04
The default repository for the OpenAT® file is the “Firmware” folder under iLink.
43
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
13.3 iCE3 Automated Upgrade Procedure
iLink (version 3.6+) has an automated firmware/software upgrade tool. This tool includes several
checks to confirm the validity of the components being installed.
For units equipped with a Wavecom wireless module (from serial number AE1-1581+), iLink (version
3.9+) can be used to upgrade the embedded OpenAT® application in this device.
The automated upgrade tool can do both the firmware and software upgrades (and if applicable, the
Wavecom application) in one process, saving considerable time and effort. However, it is most common to
3
just upgrade the iCE software, so the default mode is set for software only. Including the firmware or the
OpenAT® application in the upgrade requires the manual enabling of the appropriate checkboxes.
3
Upgrading the iCE firmware results in the logged data being erased. In normal practice, this
not an issue but it is strongly recommended that the data be unloaded before upgrading the
3
firmware. Upgrading either the iCE software or Wavecom OpenAT® does not affect the logged
data.
For clarity, the example given I the following pages shows a full, automatic firmware, software and
Wavecom OpenAT® application upgrade for a Wavecom equipped unit.
44

Make sure the required upgrade files are available on the computer. Ideally these should be located
in the default deployment folders listed above in Section 13.2.

Connect to the iCE using iLink.

Go to the Program Device screen via the [Tools][Program Device] menu option or by clicking the
[Program] button on the toolbar.
3
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
45

Select any one of the two upgrade software program files using the [Browse] button. The [Automated
Upgrade Tool] button will become enabled if the software file exists. See note on the next page
showing the default software file selection.

If upgrading the firmware, first enable the [Include Firmware in automatic upgrade] checkbox and
then select the new firmware file using the firmware [Browse] button. See note on the next page
showing the default firmware file selection.

If upgrading the OpenAT® application,select the file using the [Browse] button. The [Automated
Upgrade Tool] button will become enabled if the application file exists. See note on the next page
showing the default OpenAT® application file selection.
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
Software files are stored in the default programs folder …\iLink\Programs and are identified by the
filename extension .ic3. The modem type in the file name must be correct. Select either one of the
files.
Firmware files are stored in the default firmware folder …\iLink\Firmware and are identified by the
3
filename extension .fls. Select the correct firmware file to download to the iCE .
If upgrading the Wavecom OpenAT® application, the download file is stored in the default firmware
folder …\iLink\Firmware and is identified by the filename extension .dwl. Select the correct
3
OpenAT® file to download to the iCE .
46
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide

Click the [Automated Upgrade Tool] button. The Program Configuration form will appear. This form
allows you to reconfirm the program validity (variant and version) as well as select customised
program variants. The example form below shows the standard program V2.30.
For custom program variants, enable the “Custom” checkbox and enter the custom program name
as supplied by iQuest.

47
Click the [OK] button to continue. The upgrade components are validated and if successful a
confirmation dialog is shown. Click [Yes] to continue. Otherwise correct the problem and try again.
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide

Before the upgrade is initiated, you will be prompted about whether the device should be cleared
before upgrading. By default, this is “No” as it will result in clearing the logger configuration and if
applicable, any logged data. However, if the difference between the old program and the new one is
significant, doing this step is recommended. iQuest will provide advice on whether this should be
done in the program release notes.

After the device is cleared, or if the clearing step is skipped, the upgrade process will begin and run
automatically through the firmware (if selected) and software upload stages. The progress status is
displayed as the upgrade progresses.
If the OpenAT® application is to be upgraded, then several steps will occur as the communication
path is prepared to allow direct connection to the module.
If the process is cancelled or fails for any reason, the following dialog will appear. The whole
3
process should be repeated to ensure that the iCE is completely upgraded before deployment.

48
3
When the upgrade is complete this dialog will be displayed. Click [Yes] to start the iCE software
program.
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]
iCE3 3G User Guide
14 User Notes
49
iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]