Manual
Transcription
Manual
3 iCE FX Basic User Guide For Software Version: 1.00 (Requires Firmware Version: Vy/1.00+) Amendments Revision History Issue 1 Version 1.00 nd 2 Dec 2013 Preliminary release of Basic User Guide. 3 Adapted from the iCE 3G Reference Guide V2.80. 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-2014, 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 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 Alternative Wireless Connectivity (SMS or FTP)..................................................................... 4 3.4.4 Static and Dynamic IP addressing .......................................................................................... 4 3.4.5 Power Management ................................................................................................................ 4 3.4.6 Data Logging ........................................................................................................................... 5 3.4.7 Alarm Processing .................................................................................................................... 5 3 3 4 iCE 3G and iCE FX Comparison ..................................................................................................... 6 5 Installation ........................................................................................................................................... 7 5.1 Removing / fitting the SIM card ...................................................................................................... 7 5.2 External Power Supply ................................................................................................................... 7 5.3 Power Supply + I/O Connector ...................................................................................................... 7 5.4 RS232 Connector ........................................................................................................................... 8 5.5 Antenna Connection....................................................................................................................... 8 5.6 Setting the Real Time Clock .......................................................................................................... 8 5.7 Recommended Deployment Procedure ......................................................................................... 9 6 Operation ........................................................................................................................................... 10 6.1 Status LED Indicator .................................................................................................................... 10 6.1.1 Host Port Speed Display ....................................................................................................... 10 6.2 Digital Input LED Indicator ........................................................................................................... 10 6.3 Host Device Type settings and operation .................................................................................... 11 6.3.1 Normal (Type=0) ................................................................................................................... 11 6.3.2 Campbell Scientific Array Based Logger (Type=1) ............................................................... 11 6.3.3 Unidata (Type=2)................................................................................................................... 11 6.3.4 Standalone (Type=3) ............................................................................................................. 11 7 Terminal Configuration .................................................................................................................... 12 7.1 Terminal Security Code................................................................................................................ 13 7.2 Terminal Menus ........................................................................................................................... 13 7.2.1 Main Menu (Level 1) .............................................................................................................. 14 8 SMS (Text) Commands..................................................................................................................... 16 3 8.1 Request iCE Information (RQ) .................................................................................................... 16 8.2 Go On-Line (GOL)........................................................................................................................ 16 8.3 Set the Scheduler On Interval (INT) ............................................................................................. 16 9 Host Commands ............................................................................................................................... 17 9.1 Go On-Line (AT^IGOL) ................................................................................................................ 17 3 9.2 Request iCE Real-Time Clock (AT^ICLK)................................................................................... 17 9.3 Send manual SMS message (AT^ISMS) ..................................................................................... 17 3 9.4 Request iCE Received Signal Indication (AT^IRSI) .................................................................... 17 9.5 Set the Scheduler Call-In Interval (AT^IINT) ................................................................................ 18 9.6 Set a Sensor Source Value for Logging (AT^IVAL) ..................................................................... 18 10 Data Logging ................................................................................................................................... 19 10.1.1 Overview.............................................................................................................................. 19 10.1.2 Logging Internal Parameters ............................................................................................... 19 10.1.3 Diagnostic Logging .............................................................................................................. 19 10.1.4 Logged Data Array Identification ......................................................................................... 20 10.2 Unloading Logged Data ............................................................................................................. 21 11 Troubleshooting ............................................................................................................................. 22 3 11.1 iCE will not respond in RS232 terminal (configuration) mode .................................................. 22 11.2 Unable to connect to the remote TCP or UDP server ................................................................ 22 3 11.3 iCE will not respond to SMS requests ...................................................................................... 22 12 Host (RS232) Port - Cable Connections ....................................................................................... 23 12.1 Standard (Non-handshake) Device (No cable label) ................................................................. 23 12.2 Campbell Scientific Array Based Datalogger (Cable label – “CSIU”) ........................................ 23 12.3 Unidata Logger – Standard (Cable label – “UNI1”) .................................................................... 24 12.4 Unidata Logger – In NIWA enclosure (Cable label – “UNI2”) .................................................... 24 12.5 NIWA Datalogger (with Unidata engine) (Cable label – “UNI3”) ................................................ 25 13 Firmware/Software Upgrade Procedure ....................................................................................... 26 13.1 Overview .................................................................................................................................... 26 13.2 File Naming Conventions ........................................................................................................... 26 3 13.2.1 iCE FX Executive Firmware. .............................................................................................. 26 3 13.2.2 iCE FX Application Software. ............................................................................................. 26 13.2.3 Sierra Wireless Module OpenAT® Application ................................................................... 26 3 13.3 iCE FX Automated Upgrade Procedure ................................................................................... 27 14 User Notes ....................................................................................................................................... 28 Tables & Figures Table 1 – RS232 Connector Pin Functions ....................................................................................................... 8 Table 2 - Status LED Indication Modes ........................................................................................................... 10 Table 3 - RS232 Host Port Speed Indication .................................................................................................. 10 Table 4 - Logged Data Array ID Definitions ..................................................................................................... 20 Figure 1 - SIM Card Lock................................................................................................................................... 7 Figure 2 - Power Supply I/O Connector and Cable ........................................................................................... 7 Figure 3 - RS232 Connector Pin View............................................................................................................... 8 Figure 4 - RS232 Cable Pin Designations ....................................................................................................... 12 Figure 5 - Terminal Menu Structure ................................................................................................................. 13 Figure 6 - Standard Device Cable ................................................................................................................... 23 Figure 7 - CSI Array Based Datalogger Cable ................................................................................................ 23 Figure 8 - Unidata Standard Datalogger Cable ............................................................................................... 24 Figure 9 - Unidata (NIWA Variant) Datalogger Cable ..................................................................................... 24 Figure 10 - NIWA Logger Family Datalogger Cable ........................................................................................ 25 iCE3 FX 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 FX User Guide 2 Introduction 2.1 About this Manual 3 This manual is intended as a detailed guide for the iCE FX 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 FX 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 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 3 Overview 3.1 General Characteristics 3 The iCE FX (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 3 devices that the iCE FX can be used to interface with include dataloggers, PLCs etc. 3 The iCE FX 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 123) 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 FX 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 FX 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 FX, you can have virtually any logger type telemetered over the 3G network. If you are using a HydroTel 3 telemetry system, the iCE FX can be configured to call-in and be downloaded using a dynamic IP address which further simplifies the deployment. See Section 3.4.4 for more details. 3.3 Technical Specifications Dimensions: 82mm x 63mm x 30mm (WxHxD), Mass: 184g 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 FX internal temperature. Power Supply: External 5-32Vdc supply. Power Consumption: Average 5 mA @ 13.8V. “Full Save” power mode with active RS232 terminal. Average 12 mA @ 13.8V. Idle in “Partial Save” power mode, 3-wire RS232. Average 50 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: -10C to +70C. 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 FX User Guide 3.4 Key Features 3.4.1 Terminal Configuration A small number of diagnostic and initialisation options are available via a standard ASCII terminal connected 3 to the RS232 serial interface. In previous model (iCE 3G) nearly all the configuration was also done using the terminal. This has been removed because of the increased features of the FX and data unloading is done using the iQuest logger support application, iLink 2012. Refer to Section 7 for details on the terminal options. 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 FX 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 Alternative Wireless Connectivity (SMS or FTP) Another wireless connection mode other than IP is also possible on all hardware variants. This is SMS (Short Message Service). As with the IP mode described above, using the SMS service requires a SIM card with the SMS service enabled by the service provider. The SMS option works by sending a pre-set text message to up to ten destination cell phones or SMS receivers. This message contains the site identification and the current values of all enabled sensors. See Section Error! Reference source not found.(Text) Commands for more information on using the SMS feature. Finally, FTP file transfer is provided for installations requiring a stand-alone data uploads. 3.4.4 Static and Dynamic IP addressing 3 The iCE FX 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 FX 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 FX 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 FX for that session and uses it for all 3 ongoing communication with the host device attached to the iCE FX. 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 FX manages the IP session establishment and maintenance, meaning that the host device does not need any special intelligence of its own. 3.4.5 Power Management 3 The iCE FX supports four 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. 4 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 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. 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. RS232 Only This mode is provided for applications where the internal modem is not used and telemetry is achieved by a data radio or modem connected to the RS232 port. When in this mode, the RS232 port is used for all callback communication. 3.4.6 Data Logging 3 The iCE FX supports the logging of data from six virtual sensors, plus a further three internal data sources (supply voltage, RSSI and internal temperature). 3 Please refer to Section 11 for a detailed description of the datalogging capabilities of the iCE FX. 3.4.7 Alarm Processing Each virtual sensor can be checked for up to six 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 FX User Guide 4 iCE3 3G and iCE3 FX Comparison 3 The iCE FX is a new model based on the iCE3 3G hardware but with a new Sierra Wireless modem module, expanded logged data storage and an enhanced firmware/software set which allows the fundamental datalogging format as floating-point built around a new IEEE-745 2008 compliant library. NOTE: The legacy iCE3 3G cannot be converted to an iCE3 FX as it lacks some key hardware components. 3 3 Key differences between iCE 3G and iCE FX • • • • • • • • • • • • • • • 6 Datalogging memory expanded from 32KB to 8MB Standard IEEE-754-2008 compliant Floating Point library. Datalogging sample values are floating-point. Logging multiplier removed. All timestamping is in UTC to enhance use internationally. Configuration via text terminal removed and only basic terminal diagnostics supported. Default RS232 port speed increased from 9600 to 38400bps. Logging sensor channels increased from four to six. Sensor logging rate can be different when alarm(s) on that sensor are active. All schedules have separate on/off/alarm intervals. Totalisers: YTD (Year To Date) and Last Year. Settable roll-over time (daily) or date (yearly). Capable of native FTP file transfer (CSV format) to one or two destinations. Analogue input range now settable. Sensor display format is settable (number of decimal places). Multi-language support for internal date/times etc. Five supported (EN, DE, FR, ES, PT) Secure and reliable OTA (Over The Air) firmware and software upgrades now possible. iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 5 Installation 5.1 Removing / fitting the SIM card 3 Important! Ensure the iCE FX 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 FX 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. 5.2 External Power Supply 3 The iCE FX 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 5.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. 5.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 7 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 5.4 RS232 Connector 3 The iCE FX 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 1 – RS232 Connector Pin Functions 5.5 Antenna Connection 3 The iCE FX 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. 5.6 Setting the Real Time Clock 3 If the iCE FX 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. 3 This step is required because the clock is reset to a default time when the iCE FX has been depowered for any reason. The iCE3 FX 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 2012 @ 00:00:00). If logger data is available, the iCE3 FX 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 6.2.6 for more details on using the Scheduled Power Mode. 8 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 5.7 Recommended Deployment Procedure 9 Obtain and install the SIM card from your preferred service provider. Ensure that the SIM card lock is fully engaged. See Section 5.1 for details on fitting the SIM card. Connect an antenna and power supply to the iCE FX. Using a standard cable connect a computer with a suitable terminal program such as iLink or HyperTerminal®. Configure the iCE FX 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 FX when used in scheduled (call-in) mode. Note that the iCE FX can be configured to automatically set its address based on its serial number with an optional offset. 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 9.1. Take the iCE FX 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 FX 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 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 FX User Guide 6 Operation 6.1 Status LED Indicator 3 The iCE FX 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 2 - Status LED Indication Modes 6.1.1 Host Port Speed Display 3 To assist with determining the correct terminal setting required to connect to the iCE FX, 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 3 - RS232 Host Port Speed Indication 6.2 Digital Input LED Indicator 3 iCE FX units have a red LED that illuminates when the digital input is active. 10 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 6.3 Host Device Type settings and operation The following are the 4 different Host Device Types. 6.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 FX 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. 6.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 FX 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 FX 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. 6.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 FX then waits until the logger scans and returns a * prompt. The iCE FX 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. 6.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 FX does not link the wireless connection to its RS232 port at all. All data packets are 3 deemed to be for the iCE FX itself and it behaves through the wireless connection just as if it were being communicated to via its RS232 port. 11 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 7 Terminal Configuration 3 For diagnostic and initial commissioning purposes, the iCE FX supports a simple terminal connected to the host (RS232) serial port. 3 The iCE FX 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). The iRIS RS232 port is a DTE (Data Terminal Equipment) configured port and is identical in pin-out and signal allocation to that of an IBM compatible PC’s RS232 port. Therefore the cable required is the same as that for computer-to-computer communication and is termed a null-modem cable. These are available from most electronics retailers if required. To access the iRIS diagnostic terminal a full null-modem cable (wired as shown below) between a communication port (e.g. COM1) on your computer and the RS232 port of the iRIS. The null modem cable configuration has the three main signal pairs crossed over. These pairs are TXD/RXD, RTS/CTS and DTR/DSR. The signal ground (SG) line is connected straight through. The CD and RI lines are unused. The iRIS RS232 serial port is set by default to a speed of 115200bps, 8 data bits, 1 stop bit and no parity. Flow control is not required. Computer DB9F 1 2 3 4 5 6 7 8 9 CD RXD TXD DTR SG DSR RTS CTS RI iRIS DB9F CD TXD RXD DSR SG DTR CTS RTS RI 1 3 2 6 5 4 8 7 9 Figure 4 - RS232 Cable Pin Designations 12 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 7.1 Terminal Security Code 3 The iCE FX supports the use of a text-based security code (of up to 10 characters) that may be used to prevent unauthorised access to the terminal menus. If used, the code is set using iLink 2012 that is registered to “Administrator” level. If it is empty, the terminal is immediately available as soon as the RS232 connection is made. If the code has been set, then a prompt message is shown and the code must be entered before the terminal becomes 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)= 7.2 Terminal Menus Throughout all the terminal menus, there are two common entry codes. Menu option 0 (zero) always returns you to the level above your current position. Entering “r” or “R” when in a menu being prompted for an option will refresh the menu without selecting anything. When a terminal session has been established with the iRIS through the RS232 port 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 each settable item is enclosed in square braces e.g. [1234]. Level1 Level2 Level3 Level4 Level5 Main Menu Totals Modem Diagnostics Modem Terminal Initialise Figure 5 - Terminal Menu Structure 13 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 7.2.1 Main Menu (Level 1) The first menu displayed is the Main Menu. From here, you can make the following choices: iRIS 350FX Cellular(W) AG4-1234, F1.0, S1.0, O1.10 My Site Name 1 2 3 4 > Totals Modem Diagnostics Modem Terminal Miscellaneous Option 1 – Totalisers This menu option provides access to the four totalisers which are associated with each of the digital I/O channels. A sub menu displays the current totals and also provides a means of either resetting all totals for the channel or setting the running total to match a flow meter. * Totaliser Last Year: Year To Date: Yesterday: Today: Running: Cfg 3457765.0 96339.0 1337.2 149.7 158823.0 0 Exit 1 Reset All Totals 2 Edit Running Total > Option 1 reset ALL totals. Option 2 is only possible if the totals have been cleared and is intended only as an initialization task when the logger is first commissioned. Option 2 - Modem Diagnostics Select this option to display the current modem 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. Please see the next section for more details on the diagnostics that are available in this menu option. Modem Diagnostics Example Status Information: Modem Diagnostics. Enter 0 to exit Modem: Version: IMEI: IMSI: LIP: RSSI: Status: > 09:13:00 14 Sierra Wireless (W) R7.44.0.201007221223.Q26EX001 1608904 072210 12:23 351919030231951 530011102111028 10.236.7.252 -83 dBm BER: 0 Connected STATE: Connected PM1 SR0 LC1 LS1 PB CT60 CW179 LT60 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide IMEI: International Mobile Equipment Identifier. This is stored in the wireless module at the factory and uniquely identifies the hardware by manufacturer and serial number. IMSI: International Mobile Subscriber Information. This is obtained from the SIM card LIP: The last local IP address that was allocated to the iRIS when it was last online. 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. The iRIS will not attempt to connect to the network if the RSSI is 0 or less than -113dBm. Example diagnostic information. 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) LC Link Control. Requested link control (to the modem module). LS Link State. Actual link state (from modem module). 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. CW Connection Watchdog. Time before a hard reset of the modem is done. Is 3 times the comms schedule interval. E.g. interval = 60 mins invokes reset if no connection in 3 hrs. LT TCP Server Listening Time (TCP mode only). Option 3 - Modem Terminal 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, the terminal mode is unavailable and this message will appear: > Wireless module inactive. Terminal unavailable. Assuming the modem is active, the two scenarios are as follows: If the internal modem is powered up, but an IP 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 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> followed by <Enter> to exit the modem terminal session and return to the communication menu. Option 4 – Initialise This option is used to initialise the unit. This is generally done just after installation as part of the commissioning process to eliminate any test or residual data or totals. It resets the memory pointers to zero and also resets all totalisers. To ensure this task is not accidentally invoked, a specific string must be typed in order to execute the initialisation process. > Type 'init' to initialise the unit 15 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 8 SMS (Text) Commands 3 The iCE FX 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 FX it will reply with an invalid command message. 3 If the iCE FX 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 3 If the message “RQ” is received, the iCE FX will reply to the sender with a message showing basic iCE FX information. The parameters returned are: 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 loggedl (log rate 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 FX 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 on-line for the duration configured in the scheduler. 3 The iCE FX 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 FX will extract the parameter (x). If this is valid, the value will be used to update the On Interval in the Comms Scheduler. 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” E.g. 16 SMS: “+64211234567”,”This is a test message” iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 9 Host Commands To allow an intelligent host device to directly perform a small number of actions, there are four special AT 3 commands that the iCE FX will execute immediately without having to invoke the terminal menu. 3 These commands are only accepted by the iCE FX 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 FX 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 FX 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. 3 When the command “AT^ISMS” is received the iCE FX 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 FX 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 FX will respond with the current RSSI value (in dBM). AT^IRSI? ^IRSI: -73 OK 17 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX 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. 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-6). 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. 18 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 10 Data Logging 10.1.1 Overview 3 The iCE FX has an internal data store capable of holding over a million 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 FX has six 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: Analogue Input Pulse Counter attached to the Digital Input Simulated Pulse Counter enabled by the Digital Input Frequency Counter attached to the Digital Input Change of State on 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). 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. 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 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 FX 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. 19 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX 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 61 62 63 64 65 66 67 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 Sensor 5 Sensor 6 3 Supply voltage. This is the voltage measured on the dc input to the iCE FX Received Signal Strength Indication (RSSI). This is in dBm. 3 iCE FX 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 4 - 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: Diagnostic logging Flow/Vol +20 +40 (60-69) +80 For example, Sensor 4 has been configured to log the average value, plus the maximumThree data arrays will be logged for this sensor at each logging interval with IDs of 4, 44 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. 20 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 10.2 Unloading Logged Data 3 1. Connect to the iCE FX using iLink 2012. 2. Choose Manual, Automatic or “Unload all Data” option from the ‘Unload’ options on the main tool bar. The Automatic unload option unloads the logged data automatically since the last unload process while the Manual option enables you to enter the new start of data pointer and unloads the data manually. The “Unload All data” option will cause all logged data to be unloaded from the logger. 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. 21 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX 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 6.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 8 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 less 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: 22 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. iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX 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 6.3 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 6 - 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 6.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 7 - CSI Array Based Datalogger Cable 23 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX 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 6.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 8 - 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 6.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 9 - Unidata (NIWA Variant) Datalogger Cable 24 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX 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 6.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 10 - NIWA Logger Family Datalogger Cable 25 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX 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 FX Executive Firmware. 3 The “Firmware” in the iCE FX 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 FX firmware is available as a single file for downloading and flash upgrading using iLink 2012. The upgrade file is in the format: iCE3FX_xxx.ice3fx where xxx is the firmware version e.g. 3 iCE3FX_100.ice3fx iCE FX Firmware, Version Vi/1.00 13.2.2 iCE3 FX Application Software. 3 The “Application Software” in the iCE FX is analogous to an application such as Word® on a PC. It is the 3 software that contains the general functionality of the iCE FX. This comes in three sections or “banks” (due 3 to the memory configuration of the iCE ) but runs as it were one single program. The software upgrade files for Banks 1, 2 and 3 are in the format: iCE3FX_Cellular_Std_xxx_y.ice3fx where: Cellular is the communication mode (always “cellular” for this device) Std is the program variant xxx is the software version y is the program bank that this file should be loaded into e.g. iCEFX_Cellular_Std_110_1.ice3fx iCE3 FX Software, Version 1.10, Bank 1 13.2.3 Sierra Wireless Module OpenAT® Application The iQuest OpenAT® application runs in the Sierra Wireless modem module and manages the IP connectivity. This application is available as a single file for downloading using iLink 2012. The upgrade file is in the format: iCE3FX_OpenAT_120.dwl where xxx is the OpenAT® application version e.g. 26 iCE3FX_OpenAT_120.dwl 3 iCE FX Open AT® Application, Version 1.20 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 13.3 iCE3 FX Automated Upgrade Procedure iLink 2012 has an automated firmware/software upgrade tool. This tool includes several checks to confirm the validity of the components being installed. It can also be used to upgrade the embedded OpenAT® application in this device. For clarity, the example given in the following pages shows a full, automatic firmware, software and OpenAT® application upgrade. Make sure the required upgrade files are available on the computer. Ideally these should be located in C:\Program Data\iQuest\iLink2\Programs. Connect to the iCE FX using iLink 2012. Go to the Program screen via the [Configuration][Program] menu option or by clicking the [Program] button on the toolbar. Click the Auto Upgrade button on the toolbar. The iLink 2012 will automatically detect the variant and type of the device and these fields will be populated with the appropriate configuration. If required, please select a different configuration from the drop down list and click OK. Click Yes to the warning messages in order to confirm the software and firmware upgrade. The progress of the upgrade can be seen on the status bar. Once the process is completed, you can see a message saying "Upgrade completed successfully" on the status bar and the iLink 2012 window will show the current software status of the device. 3 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 FX is completely upgraded before deployment. 27 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected] iCE3 FX User Guide 14 User Notes 28 iQuest (NZ) Ltd - PO Box 15169, Hamilton, New Zealand Tel: +64 7 857 0810 Fax: +64 7 857 0811 Email: [email protected]