MAN-EAM-0001

Platinum Firmware for CMG-EAM, DAS, NAM and DCM

Operator's GuidePart No. MAN-EAM-0001

Designed and manufactured byGralp Systems Limited3 Midas House, Calleva ParkAldermaston RG7 8EAEngland

Proprietary Notice: The information in this manual is proprietary to Gralp Systems Limited and may not be copied or distributed outside the approved recipient's organisation without the approval of Gralp Systems Limited. Gralp Systems Limited shall not be liable for technical or editorial errors or omissions made herein, nor for incidental or consequential damages resulting from the furnishing, performance, or usage of this material.

Issue C 2010-11-18

CMG-EAM (Platinum Firmware)

Table of Contents

1 Introduction..............................................................................................................61.1 A Note on Terminology.....................................................................................8

1.1.1 Sensor.........................................................................................................81.1.2 Digitiser.......................................................................................................81.1.3 Digital Sensor or Digital Instrument..........................................................9

1.2 Hardware Overview...........................................................................................91.3 Software Overview..........................................................................................101.4 Typical Applications.......................................................................................11

1.4.1 Autonomous remote data-logger..............................................................111.4.2 Protocol Converter....................................................................................111.4.3 Array Concentrator...................................................................................121.4.4 Resilient Networking................................................................................131.4.5 CD1.1 Networking....................................................................................14

1.5 Document Conventions...................................................................................14

2 First Steps............................................................................................................... 152.1 Connecting to the Serial Port..........................................................................152.2 Connecting to the network port......................................................................17

2.2.1 DHCP-assigned addresses........................................................................182.2.2 Assigning a static IP address....................................................................192.2.3 Connecting to the web interface..............................................................192.2.4 Connecting using SSH.............................................................................21

2.3 Changing the password...................................................................................24

3 Configuration System Overview............................................................................273.1 Using the configuration system via the web interface...................................273.2 Using the command-line configuration system..............................................30

3.2.1 Text entry fields.......................................................................................323.2.2 Check-boxes..............................................................................................333.2.3 Drop-down menus....................................................................................333.2.4 Using forms..............................................................................................34

3.3 Configuration Management.............................................................................363.3.1 Saving a configuration.............................................................................373.3.2 Deleting a saved configuration.................................................................373.3.3 Restoring a configuration.........................................................................38

4 Firmware Upgrades................................................................................................404.1 Determining the current firmware level.........................................................404.2 Upgrade Methods.............................................................................................41

4.2.1 Upgrading via the internet.......................................................................41

2 Issue C

Operator's Guide

4.2.2 Upgrading from a local mirror.................................................................424.2.3 Upgrading from a USB storage device.....................................................46

4.3 Upgrade Types.................................................................................................494.3.1 Standard upgrade.....................................................................................494.3.2 Upgrade and restore defaults...................................................................504.3.3 Upgrade and force factory defaults..........................................................51

4.4 Upgrade logs....................................................................................................51

5 Data Handling Overview.......................................................................................52

6 Configuring Networking........................................................................................556.1 Configuring physical network interfaces........................................................55

6.1.1 Configurable parameters in standard mode............................................566.1.2 Configurable parameters in expert mode................................................58

6.2 Virtual network (VLAN) interfaces.................................................................616.2.1 Configurable parameters in standard mode............................................636.2.2 Configurable parameters in expert mode................................................64

6.3 Network Time Protocol (NTP).........................................................................646.3.1 Configurable parameters in standard mode............................................656.3.2 Configurable parameters in expert mode................................................66

6.4 Email configuration.........................................................................................666.4.1 Configurable parameters..........................................................................67

6.5 Configuring the SSH Server............................................................................676.5.1 Configuring sshd via the web interface...................................................686.5.2 Configuring sshd from the command line...............................................69

6.6 Working with PPP............................................................................................696.6.1 Setting up a PPP Connection...................................................................696.6.2 Monitoring a PPP connection..................................................................72

6.7 Configuring TCP to serial converters..............................................................746.7.1 Simple server mode..................................................................................756.7.2 Simple client mode..................................................................................77

7 Digitiser Configuration...........................................................................................787.1 Configuring Digitisers using the web interface..............................................787.2 Configuring digitisers from the command line...............................................89

8 Digitiser Synchronisation......................................................................................908.1 RTSTATUS packets.........................................................................................908.2 Using NTP with CMG-DAS units....................................................................918.3 Using GPS with Authenticated Digitisers.......................................................918.4 Using NTP with Authenticated Digitisers......................................................938.5 Configuring NMEA as an NTP clock source...................................................938.6 Configuring NMEA output..............................................................................94

November 2010 3


9 Receiving Data........................................................................................................979.1 GCF from serial devices...................................................................................979.2 BRP - GCF From Network Devices................................................................101

9.2.1 Configurable parameters in standard mode..........................................1029.2.2 Configurable parameters in expert mode..............................................103

9.3 Data from Scream! servers.............................................................................104

10 Recording and Retrieving Data..........................................................................10710.1 Preparing removable drives.........................................................................10710.2 Recording data.............................................................................................109

10.2.1 Configurable parameters in standard mode........................................11010.2.2 Configurable parameters in expert mode............................................11210.2.3 File name escape sequences.................................................................115

10.3 Retrieving data.............................................................................................11710.3.1 Retrieving data from the removable drive...........................................11710.3.2 Reading the removable drive on other computers..............................127

11 Transmitting Data..............................................................................................12811.1 GCF BRP Network Server............................................................................128

11.1.1 Configurable parameters in standard mode........................................12911.1.2 Configurable parameters in expert mode............................................131

11.2 GCF Scream Server......................................................................................13311.2.1 Configurable parameters in standard mode........................................13411.2.2 Configurable parameters in expert mode............................................137

11.3 SEEDlink......................................................................................................13811.3.1 The GDI Mini-SEED compressor.........................................................13811.3.2 The SEEDlink server............................................................................142

11.4 Gralp Seismic Monitoring System............................................................14511.4.1 Configurable parameters in standard mode........................................14511.4.2 Configurable parameters in expert mode............................................147

11.5 Quick Seismic Characteristic Data..............................................................14811.5.1 Configurable parameters in standard mode........................................14911.5.2 Configurable parameters in expert mode............................................150

11.6 WIN Sender..................................................................................................15111.6.1 Configurable parameters in standard mode........................................15211.6.2 Configurable parameters in expert mode............................................154

12 Building Networks..............................................................................................15512.1 GDI-link........................................................................................................155

12.1.1 The GDI-link transmitter......................................................................15512.1.2 The GDI link receiver...........................................................................158

12.2 Gralp Secure TCP Multiplexer..................................................................16112.2.1 The GSTM Client..................................................................................16112.2.2 The GSTM Server.................................................................................164

4 Issue C

Operator's Guide

13 Monitoring Operations.......................................................................................16813.1 Diagnostics and the Summary menu..........................................................168

13.1.1 System Status.......................................................................................16813.1.2 System Log............................................................................................16913.1.3 Incoming Data......................................................................................17013.1.4 Version and Serial Numbers................................................................171

13.2 The Control Menu.......................................................................................17113.2.1 Digital I/O (power control and anti-tamper monitoring).....................17113.2.2 Digitiser/Sensor Control.......................................................................17313.2.3 Rebooting..............................................................................................18113.2.4 Services.................................................................................................18113.2.5 RAID Array Services............................................................................182

13.3 Tools Menu..................................................................................................18213.3.1 Passwords.............................................................................................18213.3.2 GCF Audit Log Viewer.........................................................................18213.3.3 GDI Channels Display..........................................................................185

14 Appendices......................................................................................................... 18914.1 Setting the System Identity (Hostname).....................................................18914.2 Authenticated Digitisers..............................................................................190

14.2.1 Internal Connections............................................................................19114.2.2 Variable Gain Inputs............................................................................19314.2.3 USB operations.....................................................................................196

14.3 Connector pin-outs......................................................................................19814.3.1 Peli-case: PORTs A, B, C......................................................................19814.3.2 Peli-case: DATA OUT port...................................................................19914.3.3 Peli-case: USB.......................................................................................20014.3.4 Peli-case: NETWORK...........................................................................20114.3.5 Peli-case: Console.................................................................................20214.3.6 Cylinder: GPIO.....................................................................................20314.3.7 Cylinder: GPS.......................................................................................20414.3.8 Cylinder: USB.......................................................................................20514.3.9 Cylinder: Power....................................................................................20614.3.10 Cylinder: Ethernet..............................................................................20714.3.11 Cylinder: Data.....................................................................................20814.3.12 Cylinder: SENSOR A & B...................................................................20914.3.13 Cylinder: Auxiliary Input...................................................................210

14.4 Using Minicom............................................................................................211

15 Revision history..................................................................................................214

November 2010 5


1 IntroductionThe CMG-EAM (Embedded Acquisition Module) is a versatile module intended to integrate one or more seismic sensors with various communications systems. It can also act as a stand-alone data recorder or as a communications hub in larger networks.

This document describes the configuration and operation of Platinum Firmware, which is the native firmware of CMG-EAMs, CMG-NAMs and CMG-DAS units. CMG-DCMs can be upgraded to run Platinum firmware: for such units, once upgraded, this manual should be used instead of MAN-DCM-0001.

The CMG-DCM is a stand-alone communications module equipped with a removable hard drive (located under the lid), three bi-directional serial ports and support for external USB storage devices and Ethernet networking. Some CMG-DCMs were embedded into CMG-DAS units such as the DM24S3DCM (see below).

The CMG-EAM is the next generation CMG-DCM and includes totally re-designed electronics. It provides all the above facilities along with an extra serial port (designated for console use), a battery-backed real-time clock, current, voltage and tamper-line monitoring plus an optional encryption/authentication module.

The CMG-EAM is available in a variety of packages including Peli-case (as shown above), borehole, ocean-bottom and metal tube (steel or aluminium) versions (top left).

CMG-EAMs are also supplied embedded into CMG-DAS units such as the DM24S6EAM.

6 Issue C

Operator's Guide

The CMG-NAM (Network Appliance Module) is a rack-mountable device intended to complement data communications networks using CMG-EAMs, and contains more interfaces, processing power and storage. The CMG-NAM is intended for use in a data centre and consumes more power than the CMG-EAM, which was designed specifically to be a low power device.

The CMG-DAS range of products combine the flagship CMG-DM24 analogue-to-digital converter with the communications, storage and protocol flexibility of the CMG-EAM in a single package.

They are available in numerous packages, including Peli-case, steel or aluminium tubes and sensor-top versions.

All of these units are Linux-based devices but no Linux knowledge is required. The use of Linux provides a high degree of flexibility: additional functionality can often be added on request contact Gralp Systems for further information.

November 2010 7


1.1 A Note on TerminologyGralp Systems Ltd are aware that various common technical terms have acquired subtly different meanings for different audiences. The following terms are used consistently within this document and are intended to have the meanings given below:

1.1.1 Sensor

By sensor, we mean a seismometer (accelerometer or velocimeter) or other transducing instrument (e.g. geophone or hydrophone) with analogue outputs - i.e. where a continuously varying voltage is used to represent the magnitude of the quantity being measured.

An example of a sensor is the CMG-3T true broadband seismometer, depicted on the right in standard configuration.

1.1.2 Digitiser

By digitiser, we mean an electronic device designed to accept analogue inputs from one or more sensors and, using sampling techniques, convert these analogue signals into streams of numerical data, which are then stored or transmitted digitally.

An example of a digitiser is the CMG-DM24 shown on the right in standard form and, on the left, packaged for borehole operation.

8 Issue C

Operator's Guide

1.1.3 Digital Sensor or Digital Instrument

By Digital Sensor or Digital Instrument, we mean a single unit combining the functions of both sensor and digitiser - with the meanings defined above.

Within this document, the term digital sensor is used in the context of either digital inputs - which may usefully be connected to either digitisers or digital sensors - or configuration dialogues which can be used to configure both stand-alone digitisers or the digitiser modules embedded within digital sensors.

An example of a digital sensor is the CMG-3TD true broadband digital seismometer, shown on the left in standard configuration and, on the right, in bore-hole format.

1.2 Hardware OverviewPlatinum firmware runs on CMG-EAMs, CMG-NAMs, CMG-DASs and CMG-DCMs. CMG-DCM units (Mk2x and above) shipped with earlier firmware can be field-upgraded to run Platinum firmware either over the internet, from a local computer or from a USB data storage device.

The CMG-EAM is based upon an Intel PXA270 32-bit processor running at 312MHz with 64Mb of RAM and 512Mb of on-board flash. The amount of flash memory can be increased with the use of Gralp plug-in flash modules. The CMG-EAM has 100Base-TX Ethernet, up to 8 serial ports for connecting to external devices and several USB ports.

The CMG-DCM uses an Intel SA1100 (StrongArm) 32-bit processor running at 220MHz with 64Mb of RAM and 192Mb of on-board flash. The CMG-DCM has up to 7 serial ports for external devices and 10Base-T Ethernet.

The CMG-NAM is a flexible platform but is generally based upon a VIA C7 processor with 512Mb of RAM and various options for local storage, including RAID arrays. It has 100Base-TX Ethernet.

November 2010 9


1.3 Software OverviewThe Platinum firmware is very flexible and can be configured to perform many tasks. An overview of its capabilities is presented here:

Data acquisition:

Data can be acquired in various formats via Ethernet or serial ports.

Recording:

Data can be recorded to removable disk in various formats. Recording initially occurs to internal flash, which is flushed to removable disk when full or on demand. This minimises power usage;

The removable disk can be removed at any time without data loss.

Data forwarding:

GCF output via serial port or TCP stream;

GCF output via Scream Server (TCP/UDP);

Gralp Data Interconnect (GDI), used for interchanging data both between CMG-EAMs and between CMG-EAMs and CMG-NAMs;

CD1.1 output;

WIN output;

QSCD (Quick Seismic Characteristic Data; designed by KIGAM) output;

GSMS (Gralp Seismic Monitoring System) output.

Network communication:

The CMG-EAM has a built-in wired Ethernet connection;

Modem support (Iridium, GPRS, etc.);

10 Issue C

Operator's Guide

Support for multiple redundant network links to increase resilience;

Other connectivity options, such as wireless Ethernet (IEEE802.11) and Bluetooth can be added on request, please contact Gralp sales for more information.

Processing:

Various types of data processing can be carried out by the CMG-EAM. Please contact Gralp sales for more information.

Section 5 gives a description of how data is handled within the CMG-EAM.

1.4 Typical Applications

1.4.1 Autonomous remote data-logger

In this application, depicted below, a CMG-EAM is used to collect data from a digital instrument (or analogue instrument and digitiser) and store it on its hard drive. The low power consumption and high storage capacity of the CMG-EAM makes it ideal for this purpose.

Where appropriate, the battery supply can be augmented with a solar panel and the CMG-EAM is capable of interfacing with and monitoring the associated charge controller.

If it is desired to contact the CMG-EAM for monitoring or urgent data download purposes, the unit can be fitted with a GPRS or satellite modem, allowing remote connectivity.

1.4.2 Protocol Converter

The CMG-EAM can be deployed as a protocol converter: the wide variety of output formats and connectivity options make it ideal for

November 2010 11


this application. In the illustration above, a digital instrument's GCF output is retransmitted as SEEDLink data over Ethernet.

1.4.3 Array Concentrator

The CMG-EAM is well suited to combining the data from a number of instruments in an array and retransmitting them over a single link (serial or network).

If the output link is over a network, all three serial ports of a standard CMG-EAM (including the DATA OUT port) are available for connection to digitisers or digital instruments, allowing up to eighteen channels to be aggregated. An arbitrary number of CMG-EAMs may be chained together, allowing for even more extensive arrangements.

12 Issue C

Operator's Guide

1.4.4 Resilient Networking

Platinum firmware includes a number of ways to implement network resilience. For example, the GSTM protocol (for communication between Platinum units) allows data to be routed over a low-cost but unreliable DSL network with automatic switch-over to a higher-cost satellite link only when the DSL network is unavailable. The failed link is regularly retried and, when communication is re-established, the data are re-routed back to the lower cost link.

It is also possible to use data filtering (by channel name and/or sample rate) in such a way that, should it become necessary to use the higher-cost link, only high priority data (e.g. samples resulting from an activated trigger) are sent across this link while lower priority data are enqueued until the low-cost link becomes available again.

November 2010 13


1.4.5 CD1.1 Networking

Platinum firmware has support for CD1.1 frame generation and forwarding with strong encryption and authentication provided by an optional embedded Spyrus hardware encryption device, allowing CMG-EAMs and CMG-NAMs to form the basis of a secure CD1.1 network.

1.5 Document ConventionsThroughout this manual, examples are given of command-line interactions. In all such examples, a fixed-width typeface will be used:

Example of the fixed-width typeface used.

Commands that you are required to type will be shown in bold:

Example of the fixed-width, bold-face typeface.

Where data that you type may vary depending on your individual configuration, such as parameters to commands, these data are additionally shown in italics:

Example of the fixed-width, bold-faced, italic typeface.

Putting these together into a single example:

System prompt: user input with variable parameters

14 Issue C

Operator's Guide

2 First StepsThe CMG-EAM can be configured and monitored either over an Ethernet network or via a serial (RS232) line. Network access is preferred. The configuration interface as accessible using a web browser or, in character mode, using ssh or over a serial connection from a terminal emulator.

All models are fitted with at least one network port which can be automatically configured using DHCP. If DHCP is not available, serial access is required in order to set up the network parameters.

The CMG-EAM has four serial ports, any of which can be configured for this purpose, although the 'D' connector located under the lid is a dedicated console port.

The CMG-DCM has three serial ports: the port labelled DATA OUT is normally used for console access and a combined serial and power cable is provided for this purpose.

The hardware fitted to CMG-NAMs varies but one serial port will usually be designated as the console port.

2.1 Connecting to the Serial PortThe CMG-EAM's console port is a 9-pin 'D' connector (with DCE wiring) located under its lid. It can be connected via a serial (RS232) modem cable (i.e. pins 2 (RxD), 3 (TxD) and 5 (ground) connected straight through) to a serial terminal or to a PC running either Scream! or terminal emulation software. The default settings for this port are as follows:

38,400 baud;

8 data bits, no parity, 1 stop bit (8N1); and

No flow control.

These settings are not configurable, preventing accidental lock-out due to inadvertent changing of the port settings.

The CMG-DCM does not have a dedicated console port: the DATA OUT port is normally used for console access. A combined power and serial cable is provided with both CMG-EAMs and CMG-DCMs for connection to this port.

November 2010 15


The DATA OUT port can be connected to a serial terminal or PC running either Scream! or terminal emulation software. The default settings for this port are as follows:

115,200 baud;

8 data bits, no parity, 1 stop bit (8N1); and

No flow control.

Once you have connected the serial cable, you can run a terminal emulator to interact with the CMG-EAM. Under Windows you are advised to use the terminal emulator shipped with Scream! v4.5, although HyperTerminal can be used. Under Unix or Linux, Miquel van Smoorenburg's minicom terminal emulator (more details from http://alioth.debian.org/projects/minicom) is recommended, although most terminal emulators can be used. An extract from Minicom's user manual is reproduced in Section 14.4, on page 211.

Once connected, press the key until you see the login prompt.

You should log in as root, which is the standard Unix superuser. The password is set to rootme when shipped from the factory. To log in, type root and press enter. When prompted for the password, type rootme (nothing will be echoed while you are typing) and press . You will then be presented with a shell prompt, which will accept commands:

eam999 login: rootPassword: rootmeeam999 ~ #

The output may vary slightly due to the configuration of the unit. In particular, the hostname (eam999 in this example) will be different.

Some applications on the CMG-EAM use a system called ncurses, which allows graphical interfaces to be implemented on text-only terminals. This requires the applications to know the type of terminal

16 Issue C

Note: these settings can be changed and, indeed, the port re-configured for a different purpose, preventing console access.

Note: If a terminal session has just been closed, it can take up to 10 seconds for a new session to start.

Operator's Guide

from which they are being accessed. The terminal type is stored in an environment variable called TERM, which is queried with the command

eam999 ~ # echo $TERMvt100eam999 ~ #

(note the use of the $ sign when accessing the value of this variable) and set with the command

eam999 ~ #: export TERM=vt100

No spaces should be used around the '=' sign.

The CMG-EAM is aware of around thirty different terminal types and uses the terminfo system to support them (so you can add your own types, if you need). Files describing each terminal type are stored under the directory (folder) /usr/share/terminfo in sub-directories named after the initial letter of the terminal name.

Some settings for specific applications are:

SSH under Unix, or puTTY under Windows (running in SSH mode): no action required - the SSH protocol sets the TERM environment variable automatically.

Minicom under Unix: no change. Minicom emulates a vt100-style terminal and automatically maps the keystrokes and display sequences for the actual terminal you are using, so the default TERM setting of vt100 is correct.

HyperTerminal under Windows: choose the File menu option Settings, and ensure that the terminal type is set to VT100. HyperTerminal will then emulate a vt100-style terminal, which will match the default TERM of vt100 on the CMG-EAM.

These settings will provide the best results for the listed applications. Note that when connecting with SSH from, for example, an xtermwindow, use of the mouse for menu navigation is supported.

2.2 Connecting to the network portTo use the network port, you must first set up a network address. Some networks use the Dynamic Host Configuration Protocol (DHCP) to automatically assign network addresses; others need manual configuration (normally referred to as static addressing). Before you

November 2010 17


can access the CMG-EAM over a network, you must set (for static addresses) or discover (if you use DHCP) its IP address.

2.2.1 DHCP-assigned addresses

If your network uses DHCP to assign addresses, connect the CMG-EAM to the network and reboot it by turning the power off and on again Your network administrator may then be able to tell you the address that has been assigned to the CMG-EAM but, if not, you can connect via a serial port and issue the ip command:

eam999 ~ # ip addr show eth02: eth0: mtu 1500 qdisc pfifo_fast qlen 1000 link/ether 00:50:c2:40:54:75 brd ff:ff:ff:ff:ff:ff inet 192.168.0.101/24 brd 192.168.1.255 scope global eth0 inet6 fe80::250:c2ff:fe40:5475/64 scope link valid_lft forever preferred_lft forever eam999 ~ #

The key things to look for here are the adapter status and the IP address. The first line of the output should contain the word UP, confirming that the adaptor has been enabled. The IP address that has been assigned is shown on the line beginning inet - in this case, it is 192.168.0.101 (with a netmask of 24-bits indicated by /24).

When using DHCP, it is recommended that the DHCP administrator allocates a fixed IP address to the CMG-EAM's MAC address in order to avoid unexpected address changes.

18 Issue C

Note: With an IP version 6 network, the IP address will be on a line beginning inet6. In practice, most networks today are still IPv4, as in the above example.

Note: If you are setting up a unit in the laboratory for subsequent deployment in the field, you can set up the final network address using the web interface and over-ride it with a temporary, static network address using the command line. The web-configured address will take effect when the unit is next rebooted.

Operator's Guide

2.2.2 Assigning a static IP address

If the network you are connecting to does not use DHCP, you must first connect via a serial port in order to configure a static IP address. Connect the CMG-EAM to the network and power-cycle it before proceeding: its network interface will not be enabled unless it sees a network at boot.

Once logged in, issue the following command:

eam999 ~ # ip addr add 192.168.0.1/24 dev eth0

You can change the IP address to anything you wish. It must be specified in CIDR format where the actual address is followed by the number of bits of the network mask. The above example uses 192.168.0.1 with a netmask of 255.255.255.0 (24 bits of network address). A PC connected to this network could communicate with the CMG-EAM if it was configured to use an IP address of (for example) 192.168.0.2 with a matching netmask of 255.255.255.0.

If you wish to connect to the CMG-EAM from a PC, they must either both have the same network address (usually the first three numbers of the IP address) or be able to connect to each other via routers. In the latter case, you will need to tell the CMG-EAM the address of its default router. Issue the command:

eam999 ~ #iprouteadddefaultvia192.168.0.254

substituting the address of your network's default router in place of the address shown.

2.2.3 Connecting to the web interface

The CMG-EAM provides a web (HTTP) interface which is intended to be used for most configuration and control tasks. This is the recommended way of controlling the CMG-EAM.

November 2010 19

Note: Both the static IP address and any route configured in this way are temporary and will persist only until the CMG-EAM is rebooted or powered off. Refer to section 6.1 on page 55 for information about configuring permanent static IP addresses and routes.


Once the IP address of the CMG-EAM has been set or determined, you can connect to its web-server. Simply type http:// followed by the IP address of the unit into your web browser's address bar (e.g. http://192.168.0.1 ). You should be prompted for a user-name and password. The user-name is root and the initial password, as shipped, is rootme (the same as on the command line).

If you are connecting to the CMG-EAM over a network that you consider insecure, it is recommended that you use the HTTPS (secure HTTP) protocol, which uses TLS to encrypt the link. Simply change the http:// prefix to https:// in the browser's address bar. Most browsers will complain that the certificate cannot be verified: This is not a problem: simply press the accept button to proceed. The link will then be encrypted and nobody will be able to sniff the wire in an attempt to discover passwords and other data.

Once connected and logged in, you will be presented with the main summary screen. This contains general information about the status and health of the CMG-EAM:

The exact contents and layout of this screen will vary depending on the configuration of both the EAM and of any attached hardware.

20 Issue C

Operator's Guide

If the browser fails to connect, the most likely explanation is that the machine running the browser does not have working network communications to and from the CMG-EAM. This can be verified by pinging the IP address of the browser from the command line of the CMG_CMG-EAM:

eam999 ~ # ping -c3 192.168.0.2PING 192.168.0.2 (192.168.0.2): 56 data bytes 64 bytes from 192.168.0.2: seq=0 ttl=63 time=2.284 ms 64 bytes from 192.168.0.2: seq=1 ttl=63 time=1.129 ms 64 bytes from 192.168.0.2: seq=2 ttl=63 time=1.944 ms --- 192.168.42.1 ping statistics --- 3 packets transmitted, 3 packets received, 0% packet loss round-trip min/avg/max = 1.129/1.785/2.284 ms eam999 ~ #

To resolve this class of problem, ensure that the cables are functioning (which can be verified by checking the diagnostic lights on most switches/hubs) and double-check that the PC and CMG-EAM are on the same subnet (which means the netmasks must match and the first sections as defined by the netmask - of the IP addresses must match). The website http://en.wikipedia.org/wiki/IP_address has some useful information for those for whom sub-networking is unfamiliar.

2.2.4 Connecting using SSH

SSH (secure shell) is the most flexible way to control a CMG-EAM, but it is less friendly than using the web interface. It is possible to configure more advanced operations using SSH but the majority of control and configuration tasks can be achieved most easily through the web interface.

SSH is shipped as standard with most Linux distributions and is available for Windows as part of PuTTY, available for free from http://www.chiark.greenend.org.uk/~sgtatham/putty/

The next section will discuss the use of the ssh command-line utility; PuTTY-specific details are provided in the section after.

2.2.4.1 SSH connections using the ssh program

To use SSH, you must know or discover the IP address of the unit, as described in the previous section. Once you have the IP address, issue the SSH command on the PC you are using:

mypc$ ssh [email protected]

Replace 192.168.0.1 with the IP address of the CMG-EAM.

November 2010 21


The first time you use SSH to connect to a host, you will be asked to verify the host key. This can be ignored the first time but, if you are ever asked this again, it means that either the host key of the CMG-EAM has changed perhaps because of a firmware upgrade or there is a network address conflict or, worse, a security problem on your network.

user@mypc:~$ ssh [email protected] The authenticity of host '192.168.0.1 (192.168.0.1)' can't be established. RSA key fingerprint is 62:a6:70:29:d4:1a:db:5a:75:6e:96:13:54:f5:a9:d9. Are you sure you want to continue connecting (yes/no)? yesWarning: Permanently added '192.168.0.1' (RSA) to the list of known hosts. [email protected]'s password: eam999 ~ #

You will be prompted for a password; the default password is rootme. Note that no characters will be echoed to the screen as you type the password.

Once connected, you will be presented with a shell prompt which is ready to accept commands.

When you are finished with your SSH session and want to disconnect, enter exit at the command line, or type a D character. There are a number of escape sequences for controlling the session, all of which begin with a tilde ('~') so, if you need to send a tilde character to the CMG-EAM, type two tildes consecutively. For more information, see the section on Escape Characters in the SSH manual page at http://manwiki.net/index.php/1:ssh

2.2.4.2 SSH connections using PuTTY

To use PuTTY, you must know or discover the IP address of the unit, as described in the previous section. Once you have the IP address, start PuTTY by choosing it from the Start menu or double-clicking on its icon. You will be presented with the following screen:

22 Issue C

Note: If you plan to use ssh regularly to communicate with a CMG-EAM, you can configure the system to bypass the password prompt from a list of pre-authorised computer/user combinations. This involves generating a unique key-pair (for the user and PC which will access the CMG-EAM) and then copying the public half of the key-pair to the CMG-EAM. This is documented at http://suso.org/docs/shell/ssh.sdf

Operator's Guide

Enter the IP address of the CMG-EAM into the Host Name (or IP address) box, check that SSH is selected as the Connection type and then click the button.

The first time you use SSH to connect to a host, you will be asked to verify the host key:

This can be ignored the first time (simply click to dismiss the dialogue) but, if you are ever asked this again, it means that either the host key of the CMG-EAM has changed perhaps because of a

November 2010 23


firmware upgrade or there is a network address conflict or, worse, a security problem on your network.

You will now be prompted for a login name: the default is root. - type this at the prompt and hit . You will next be prompted for a password; the default password is rootme. Note that no characters will be echoed to the screen as you type the password.

Once connected, you will be presented with a shell prompt which is ready to accept commands. The shell prompt contains the CMG-EAM's serial number.

When you are finished with your SSH session and want to disconnect, type exit at the command line, or + .

2.3 Changing the passwordAccess to a Platinum system is password-protected. As shipped, the user name is root and the password is rootme. The same password is used for both login and web authorisation. In the majority of cases, there is no need to alter the password from the default setting.

24 Issue C

Note: If you plan to use ssh regularly to communicate with a CMG-EAM, you can configure the system to bypass the password prompt from a list of pre-authorised computer/user combinations. This involves generating a unique key-pair (for the user and PC which will access the CMG-EAM) and then copying the public half of the key-pair to the CMG-EAM. This is implemented using the PuTTYgen and Pageant programs: see section 6.5 on page 67 and the help facility within PuTTY for more information.

Operator's Guide

Where security is a concern - for example, where systems may be left connected to the internet for any significant period - you may wish to change the password. In this case, you should also use secure HTTP to access the web interface rather than the more common http. To do this, prefix the URL to the device with the https: protocol specifier rather than http:. For example, if you can access your system as http://192.168.0.1, you can also use https://192.168.0.1and this will prevent your new password from being retrieved by eavesdroppers.

There is much information available on-line for choosing a strong password, for example: http://tinyurl.com/strongpws.

Selecting Passwords from the Tools menu takes you to a screen from which you can change the password used for both command-line access and for the web interface.

Currently, the only user configured on a CMG-EAM is root. The password is changed immediately but the built-in web-server can continue to use the old password for some time after a change. If this is a problem, the web service can be restarted from the Services page (see section 13.2.4 on page 181) by clicking the Restart button for the httpd service.

To change the password from the command line, issue the command passwd: You will be prompted twice for the desired new password:

eam2010 ~ # passwdNew password: Repeat: Password changed.eam2010 ~ #

November 2010 25


26 Issue C

Note: There is no way to recover a lost password and it is very awkward (although not impossible) to regain access to a system without a password. Despite much conventional wisdom, you may be safer writing the password down and storing it in a physically secure place rather than risk forgetting it.

If you do lose your password, please contact Gralp Systems' technical support team for advice.

Operator's Guide

3 Configuration System OverviewAll key configuration tasks can be carried out either from the command line, using the gconfig tool, or vi the web interface, using the Configuration All options menu item. Both these methods invoke the same underlying software and present identical navigation and parameter options.

The web interface presents some additional options. Some of these are merely short-cuts into the main configuration system while others offer additional monitoring information. Configuration of attached digitisers can be carried out using the web interface but not from the CMG-EAM's command line (although access to the digitiser's command line is available).

The command-line interface also supports a number of advanced facilities which are not available via the main configuration system: these are mostly diagnostic tools which are not required for normal operation.

3.1 Using the configuration system via the web interfaceThe web interface to the configuration system is split into two frames.

The left-hand frame contains the system ID above a menu while the right-hand frame displays sub-menus, input forms and display screens. When a sub-menu has been used, the top of the right-hand frame shows the menu options that have been selected in order to reach the current screen. These options are hyper-linked and can be used to return to previous screens.

November 2010 27


In the example shown below, the operator has clicked on All options in the left-hand menu (in the Configuration section) and then chosen Networking from a right-hand pane sub-menu and then eth0 from the resulting right-hand pane sub-menu.

The All options item from the Configuration section of the left-hand menu is referred to simply as Configuration and this is also the entry point for the command-line interface to the configuration system. This page can be reached from almost every point in the system by clicking on the button displayed at the bottom of most right-hand pane forms.

In some cases, the same screen can be reached by a variety of routes. For example, the screen above can be reached (with two fewer clicks) by selecting the Interfaces short-cut from the Networking section of the left-hand pane menu and then clicking through to eth0. The links at the top of the right-hand pane will not reflect the fact that a short-cut has been taken.

Most of the configuration forms have on-line help available. This can be turned on for the current page by clicking the button displayed at the bottom of the form. The help text will appear in blue, interleaved with the form itself.

Many of the configuration forms have two modes, simple and expert. They display, by default, only the parameters most likely to be used. For example, the network interface form mentioned above does not normally display IP aliasing parameters. When access is required to these additional features, they can be displayed by clicking

28 Issue C

Operator's Guide

the button displayed at the bottom of the form. They can be hidden again by clicking on the button.

In all cases, any changes made to the contents of the forms only exist in the browser until they are sent to the CMG-EAM using the button.

User input to the forms can often only be validated after submission. Where invalid parameters have been detected, this is signalled back to the operator by redrawing the same form with extra text, in red, added. The number of errors is displayed at the top of the form:

The actual error messages are displayed next to the fields whose contents have offended:

Throughout the remainder of this manual, screen-shots of the configuration system's web interface will normally omit the left-hand pane, as in the two illustrations above.

November 2010 29


3.2 Using the command-line configuration systemAll of the configuration facilities available under the All options menu item (in the left-hand menu of the web interface) are also available from a text-based GUI tool called gconfig (Gralp Configurator). This can be accessed either by using a serial link or, over the network, by using ssh.

Connection via a serial link is discussed in section 2.1 on page 15 and connecting over Ethernet is described in section 2.2 on page 17. The use of ssh is covered in section 2.2.4 on page 21.

For optimal display, you must let the CMG_EAM know what type of terminal or emulator you are using. This is done by setting the terminal type as an environment variable using the command:

eam999 ~ # export TERM=TERM_TYPE

The value of the TERM variable, TERM_TYPE, depends upon the terminal emulator you are using and should be chosen as follows:

Emulator in use TERM setting

ssh under Unix No action required - the ssh protocol sets the TERM environment variable automatically.

PuTTY(insshmode) under Windows

No action required - the ssh protocol sets the TERM environment variable automatically.

PuTTY will default to xterm emulation, allowing the mouse to be used within gconfig.

Minicom under Unix Minicom emulates a vt100-style terminal and automatically maps the keystrokes and display sequences for the actual terminal you are using, so the default TERM setting of vt100 is correct.

HyperTerminal under Windows

Using the File menu option Settings, ensure that the terminal type is set to VT100. HyperTerminal will then emulate a vt100-style terminal, which will match the default TERM of vt100 on the CMG-EAM.

Scream! Scream! versions before 4.5 do not support the required screen-drawing control codes so its use with gconfig is not recommended.

30 Issue C

Operator's Guide

When you enter the gconfig command, the initial screen looks like this:

The gconfig interface can be navigated entirely using the keyboard but, if you use xterm (or your terminal emulator supports an xterm mode) you can use your mouse to select menu items, input fields and items from drop-down menus. The scroll-wheel is not currently supported, so you need to use the keyboard to access second and subsequent pages of multi-page forms.

gconfig displays menus and forms. The screen-shot above is an example of a menu. The following table shows the navigation keys that are available for use with menus:

Keystroke Used for...

, or Cursor to next item

or Cursor to previous item

Select item under cursor

or Move to the next page of a multi-page menu

or Move to the previous page of a multi-page menu

Go to the home menu or, if there already, exit gconfig.

November 2010 31


The four words enclosed in chevrons at the bottom of the above screen-shot,

act as push-buttons. They are always present at the bottom of each gconfig screen, although they change slightly according to the context. To invoke the action associated with any of them, move the cursor to it and press the key.

In the example, all options other than are disabled and this is indicated by the colour coding. If you select an item from a menu which leads to a sub-menu, the option changes to and invoking it will then take you back to the top-level menu.

Selecting a menu item will lead you either to another menu or to a form. Forms are composed of editable fields, which are either:

Text-entry fields, into which the operator can type textual parameters. Text-entry fields are identified by surrounding braces: '[' and ']';

Check-boxes, where the operator has a yes/no choice. Check-boxes are identified by surrounding guillemots: '{' and '}'; or

Drop-down menus, where the operator must choose one option from a list. Drop-down menus are identified by surrounding chevrons: ''.

To move between fields, use the , or keys.

3.2.1 Text entry fields

To edit the contents of a text-entry field, place the cursor on the field, using the , or keys, and start typing. Characters typed are always inserted at the current cursor position i.e. existing characters are never over-typed. The whole field is shown with a black background, as seen below, and the cursor is identifiable as a pale block.

32 Issue C

Operator's Guide

The and keys move the cursor within the field and the

key deletes characters to the left of the cursor. When you are

satisfied with the new value, the and keys allow you to move to the previous and next fields, respectively.

3.2.2 Check-boxes

To change the setting of a check-box, place the cursor on the field, using the , or keys, and use the

key to toggle between selected and not

selected. When you are satisfied with the new value, the and keys allow you to move to the previous and next fields, respectively.

When the value is yes, enabled or otherwise selected, the field is shown with an 'X' in it:

When the value is no, disabled or otherwise de-selected, the field is shown as blank:

3.2.3 Drop-down menus

To change the setting of a drop-down menu field, place the cursor on the field, using the , or keys, and activate the menu by

using the key.

November 2010 33


While the menu is active, you can move between options using the the , , , and keys: the currently selected option is

shown highlighted. When the desired option is selected, press the key again to confirm the choice and de-activate the menu.

3.2.4 Using forms

Most of the configuration forms have on-line help available. This can be turned on for the current page by using the button displayed at the bottom of the form. The help text will appear in blue, interleaved with the form itself. Help can also be activated using the

key.

Many of the configuration forms have two modes, simple and expert. They display, by default, only the parameters most likely to be used. For example, the network interface form does not normally display IP aliasing parameters. When access is required to these additional features, they can be displayed by using the button displayed at the bottom of the form. They can be hidden again by using the button. It is also possible to toggle between simple and expert mode using the key.

Some forms are too large to fit in a single page. In this case, an indicator appears at the top right of the screen. For example, the network interface configuration form, in expert mode, takes three pages to display:

To move to subsequent pages, you can use either the or the key.

To return to previous pages, you can use or .

When all required fields have been set to the desired values, the changes can be enacted by using the button or the key.

34 Issue C

Operator's Guide

It is possible to leave any form by using the button ( or the key) but, if you have made changes to the contents of any fields, the system will warn you that you will lose your changes if you continue.

It offers an opportunity to return to the form:

Select to ignore any parameters that you have altered and continue to the home menu or select to review the form and, if desired, submit it before navigating away from it.

The following table provides a summary of all keystrokes that can be used when filling or navigating forms:

Keystrokes used in forms

Keystroke Used for...

or Cursor to next field or, if in activated drop-down menu field, next item in drop-down menu

Cursor to next field or, if in text field, move edit cursor rightwards

Cursor to previous field or, if in activated drop-down menu field, next item in drop-down

Cursor to previous field or, if in text field, move edit cursor leftwards

November 2010 35


Keystrokes used in forms

Activate or deactivate list field or bottom-line button

Toggle check-box

Go to the home menu or, if there already, exit gconfig.

Display help text

Show expert mode fields

Submit the current form

or Move to the next page of a multi-page form

or Move to the previous page of a multi-page form

3.3 Configuration ManagementThe CMG-EAM has a comprehensive configuration management system that allows both complete configurations and individual classes of configuration information, such as data processing and networking, to be saved individually and merged during restoration.

This feature can be very useful when multiple CMG-EAMs are to be configured for a project. In a typical array with a central communications hub arrangement, only two data processing configurations need be created: one for the hub and one for an array element. The latter can then be copied from CMG-EAM to CMG-EAM to avoid having to configure each unit individually. Network configurations need be created for each element of the array and for the hub but these can all be created and stored on a single CMG-EAM. If the complete set of stored configurations is then copied to each machine and to any hot spares, then every CMG-EAM becomes rapidly interchangeable: all that is required to deploy a unit is to restore the correct data processing configuration (hub or element) and then restore the appropriate network configuration.

Configuration files can also be backed up and stored on different sites to provide a disaster management resource.

36 Issue C

Operator's Guide

3.3.1 Saving a configuration

From the Configuration section of the main menu, select Save/Restore. The following screen appears:

To save a configuration, use the check-boxes to select which elements you wish to include, enter a descriptive name in the Description field and click on Save configuration. The configuration is saved onto the CMG-EAM and will appear in the list of saved configurations at the top of the page.

If you are using the web interface, you can download this configuration to the computer running the browser by clicking the Download button in the list of saved configurations at the top of the page.

3.3.2 Deleting a saved configuration

If a configuration has been saved in error or a saved configuration is no longer required, it can be deleted using the above screen. Each saved configuration in the Restore table has an associated Delete button in the Actions column. Clicking the button deletes the associated configuration.

November 2010 37


3.3.3 Restoring a configuration

The same screen is used for restoring a configuration. Simply select the required saved configuration from the list at the top of the page and hit the restore button. The following screen appears:

The date and time at which the configuration was saved is shown; in the example above, this is the 13th of July, 2009 at 15:59. The name of the configuration is also given; in the example above, this is test.

Even if a configuration was saved with all modules selected, it is possible to restore only a subset of configuration information. Select what you wish to restore by ticking or clearing the appropriate check-boxes.

Unless you are recovering from, say, a corrupted device, you should leave the Restore type set to User files restore.

Click the Restore configuration button to load the configuration values from the saved data into the CMG-EAM's files. Depending on the significance of the changes between the saved configuration and the previous, active configuration, you may need to stop and restart a number of services (see Services in section 13.2.4 on page 181) or reboot the unit completely (see section 13.2.3 on page 181) before all your changes will come into effect.

If you have a reasonable working knowledge of the service configuration files used internally by the CMG-EAM, you may find the

38 Issue C

Operator's Guide

dry run facility useful. Clicking the Dry run restoration button produces a list of files that would be over-written - but without actually making any changes. This is also a useful tool for exploring the effects of different configuration classes.

November 2010 39


4 Firmware UpgradesPlatinum firmware is regularly updated to provide extra features, improve performance and, occasionally, to correct errors. The upgrade process is fast, simple and can be carried out remotely using either the web or command-line interface.

The upgrade process makes use of the rsync protocol which uses an elegant and efficient algorithm to, effectively, transfer only the differences between revisions; even within individual files. This significantly reduces the time required, compared to traditional upgrade methods.

4.1 Determining the current firmware levelFrom the web interface, select Version and serial numbers from the Summary section of the left-hand-pane menu.

40 Issue C

Note: This procedure does not upgrade the firmware of connected or embedded digitisers, which should be upgraded using the dataterminal command as documented in section 13.2.2.2 on page 177.

Operator's Guide

The same information can be obtained at the command line by using gconfig and selecting Version and serial number information. If you just want quick access to the software build number, this is contained in the file /etc/build.version, which can be read with the command:

eam2243 ~ # cat /etc/build.version # Overall build version BUILD_LABEL="platinum-stable" BUILD_VERSION="3012" eam2243 ~ #

The version, in this case, can be seen to be 3012.

4.2 Upgrade MethodsIn order to be upgraded, the unit needs access to the latest version of the firmware. If an internet connection is available, Gralp Systems Ltd's software repository can be used. This is described in section 4.2.1.

If a number of units share a common network but that network is not connected to the internet, you can make you own copy of the software repository on a PC or laptop, which can be connected the network either permanently or temporarily, and use that as the upgrade source. This is described in section 4.2.2.

If one or more units to be upgraded but internet access is not available, the new firmware can be copied to a USB storage device, such as a memory stick, and the upgrade performed from that. This is described in section 4.2.3.

4.2.1 Upgrading via the internet

In order to upgrade over the internet from Gralp Systems Ltd's software repository, the unit must have its networking properly configured. In particular, a DNS (Domain Name Service) server and a default gateway (or defined route) must both be configured. It is advisable to check these before proceeding.

To check for correct configuration of both of these items, issue the command:

ping -c3 rsync.guralp.com

This will send three echo request packets to the GSL upgrade server and listen for responses. If both the DNS server and the correct gateway (router) are configured, the output will look like this:

November 2010 41


eam2010 ~ # ping -c3 rsync.guralp.com PING rsync.guralp.com (80.68.92.160): 56 data bytes 64 bytes from 80.68.92.160: seq=0 ttl=55 time=58.280 ms 64 bytes from 80.68.92.160: seq=1 ttl=55 time=66.845 ms 64 bytes from 80.68.92.160: seq=2 ttl=55 time=56.413 ms

--- rsync.guralp.com ping statistics --- 3 packets transmitted, 3 packets received, 0% packet loss round-trip min/avg/max = 56.413/60.512/66.845 ms eam2010 ~ #

If the DNS server is correctly configured but the gateway is not correctly configured, the output will look like this:

eam2010 ~ # ping -c3 rsync.guralp.com PING rsync.guralp.com (80.68.92.160): 56 data bytes ping: sendto: Network is unreachable eam2010 ~ #

If you are using DHCP, it is advisable to correct this problem by reconfiguring the DHCP server to supply the correct route. If you are using static addressing, enter the address of the internet gateway router in the Default route (gateway) field of the network interface configuration form. See section 6.1.2 no page 58 for more details.

If the DNS server is not configured correctly (or at all), the output will look like this:

eam2010 ~ # ping -c3 rsync.guralp.com ping: bad address 'rsync.guralp.com' eam2010 ~ #

If you are using DHCP, it is advisable to correct this problem by reconfiguring the DHCP server to supply the correct name-server details. If you are using static addressing, enter the address of a suitable DNS server in the Nameserver field of the network interface configuration form (only available in expert mode). See section 6.1.2 no page 58 for more details.

Once the network has been checked, you can proceed to upgrade the unit by following the instructions in section 4.3 on page 49.

4.2.2 Upgrading from a local mirror

Setting up a mirror involves three steps:

Downloading the mirror content;

Setting up a local rsync server; and

Configuring the client EAMs to use the new server.

42 Issue C

Operator's Guide

The procedure differs depending on the operating system of the local mirror server.

4.2.2.1 Instructions for Linux/Unix computers

Downloading the mirror content

The mirror can occupy a significant amount of disk space, depending on the which architectures you need to support. See the sections for each architecture (below) for the current space requirements. You should pick a disk partition with ample space in which to store your own copy. In order to simplify the download, we recommend that you start with an empty directory each time. If you wish to make a fresh copy after a new firmware release, it is much easier to create this in an empty directory than to "update" an existing mirror. You can keep multiple, simultaneous versions of the firmware if you wish and tell each EAM which version to use when upgrading.

The server on which you create the mirror should have access to the internet during the download step but does not need internet access while it is acting as an upgrade server. It does, of course, need to be accessible by your networked EAMs. It is possible to create the mirror content on a removable disk attached to an internet-connected computer and then move the disk to a different computer when it is to be served.

Create the mirror directory and use the cd command to make it your current directory. As root, enter one or more of the following command sequences to download the mirror content. Each sequence downloads the files for a particular architecture. If you know, for example, that you will never want to upgrade a CMG-NAM64, you can omit the commands for this architecture.

CMG-DCMs

This architecture currently requires around 50MB of disk space for the mirror.

GSLSRC=rsync.guralp.com/platinum-stable/CMG-DCM-mk2x rsync -EgHloprtv --exclude resolv.conf rsync://$GSLSRC .

November 2010 43

Note: Be careful not to omit the final . or the space before it in the rsync commands below.


CMG-EAMs


GSLSRC=rsync.guralp.com/platinum-stable/CMG-DCM-mk4 rsync -EgHloprtv --exclude resolv.conf rsync://$GSLSRC .

CMG-NAMs


GSLSRC=rsync.guralp.com/platinum-stable/CMG-NAM rsync -EgHloprtv --exclude resolv.conf rsync://$GSLSRC .

CMG-NAM64s


GSLSRC=rsync.guralp.com/platinum-stable/CMG-NAM64 rsync -EgHloprtv --exclude resolv.conf rsync://$GSLSRC .

Setting up a local rsync server

Your local rsync server is configured by creating the file /etc/rsyncd.conf. If the serving host already runs an rsync server, you should modify this file (basically, add an extra module) in order to allow access from the EAMs to the mirror directory: we assume that you have the knowledge to do this without further assistance. This section covers setting up a new, dedicated rsync server.

You will need to choose a TCP port number which will not conflict with another service on your network. The port number should be greater than 1024 in order to avoid additional complexity. Consult your network administrator for an available port or simply try 61616 and, if you get an error saying that the port is in use when you attempt to start the server, choose a different random number in the range 49152 - 65535. 61616 will be used in the following example and should be replaced with the port number you have chosen or been allocated. If there are firewalls between your server and the EAMs, you will need to open channels through them for this port.

You will also need to choose a module name for the server. This can be any descriptive string but, for simplicity, it is best to stick to numbers, lower-case letters and hyphens (-). The name platinum

44 Issue C

Operator's Guide

localmirror has been used in the following example and should be replaced with the module name you have chosen.

Create the file /etc/rsyncd.conf with the following contents:

port = 61616 [platinum-local-mirror] path = /path/to/your/local/mirror/directory comment = GSL-EAM firmware numeric ids = yes log file = /path/to/writeable/log/file timeout = 600 hosts allow = *

Consult the manual page for rsyncd.conf(5) for details of further options that you can use in this file, including security improvements that you may wish to put in place. This is available on-line at http://man-wiki.net/index.php/5:rsyncd.conf.

Once the /etc/rsyncd.conf file is ready, you can start the rsync server with the command

sudo rsync --daemon

If you want to run the rsync server permanently, it is possible to start it via inetd, xinetd or an rc script. Consult the manual page for rsyncd.conf(5) for further details.

Configuring the upgrade system to use the new server

The standard upgrade source must be over-ridden: on each unit to be upgraded, create the file /etc/conf.d/upgrade.local with the following content:

RSYNC_HOST="address.of.my.server" RSYNC_PORT="61616" RSYNC_MODULE="platinum-local-mirror"

replacing:

address.of.my.server with the DNS name or IP address of the mirror server;

61616 with the port number you chose earlier; and

platinumlocalmirror with the module name you chose earlier;

November 2010 45


The EAMs can now be updated from the mirror by following the instructions in section 4.3 on page 49. Note that the files /etc/conf.d/upgrade.local on each EAM will not be disturbed by the upgrade process and, so, only need to be created once.

4.2.2.2 Instructions for Windows computers

The procedure for building a mirror site on a windows computer is essentially the same as for Linux/Unix, although the rsync program (and the cygwin library needed to run it) typically need to be installed and additional steps are required to run rsync as a service (or daemon, in Linux terminology). Instructions for setting up rsync in daemon mode under Windows are available on-line from http://www.samba.org/rsync/nt.html.

Once rsync is running as a daemon, you can follow the Unix/Linux instructions for setting up the mirror and client EAMs. Remember to retain the lines

use chroot = false strict modes = false

at the top of /etc/rsyncd.conf on the server.

If you use Windows Firewall, you may need to configure it to allow incoming access to the port number that you have chosen.

4.2.3 Upgrading from a USB storage device

For situations where it is either impossible or undesirable to upgrade over a network, Gralp Systems Ltd can supply the latest Platinum firmware on a USB memory stick, along with an appropriate adaptor cable, part number CAS-DCM-0038.

The adapter cable is required when upgrading the firmware of a CMG-DCM, a CMG-EAM and most CMG-DAS units but not when upgrading a CMG-NAM.

You will need both physical access and command-line access to the device being upgraded. Command-line access may be via ssh or a serial connection.

46 Issue C

Operator's Guide

If you are upgrading a CMG-DCM, CMG-DAS or CMG-EAM, connect the adapter cable to the USB socket of the unit and plug the firmware pod into the adapter cable;

If you are upgrading a CMG-NAM, plug the firmware pod directly into a USB socket on the unit. Please note that, depending on the internal cable layout of your NAM, it may be necessary to connect the firmware pod to a USB port on the back of the device (near the network socket) rather than to one on its front panel.

The upgrade procedure consists of either three or four steps:

1. CMG-EAM hardware only: power up the USB ports;

2. Connect the firmware pod;

3. Mount the filesystem; then

4. Run the upgrade.

Each of these steps is now described in detail:

Power up the USB ports

This step only needs to be carried out on CMG-EAM hardware. The hardware for CMG-DCMs, CMG-NAMs and CMG-DAS units do not have control over the 5V USB supply and, on these units, power is always provided to the USB ports.

Depending on the revision of CMG-EAM firmware installed before the upgrade, there are three possible commands for powering up the USB ports.

Ignoring any error messages, enter these commands at the terminal:

echo 1 > /sys/class/gpio/USBpowerB/level ioline -L USBA_power -o 1 ioline -L USBB_power -o 1

November 2010 47

Note: Using the wrong command is completely harmless and merely results in an error message, so it is easiest - and perfectly safe - to simply enter all three commands at the terminal


Connect the firmware pod

If you are upgrading a CMG-EAM, CMG-DAS or CMG-DCM, the supplied cable (CAS-DCM-0038) should be attached to the 6-pin mil-spec USB connector of the module. The firmware pod is then connected to the end of this cable.

A CMG-NAM unit has standard USB sockets and these can be used to directly connect the firmware pod. Please note that, depending on internal cable layout, it may be necessary to connect the firmware pod to a USB socket on the back of the device (near the network socket) rather than to one on its front panel.

Once connected, it will take a few seconds for the device to be scanned and registered by the operating system. You can confirm this by looking for USB mass storage registration entries in the system logfile, /var/log/messages.

Mount the filesystem

Once the firmware pod is conected and registered, the filesystem should be mounted by entering the following command:

mount -t ext2 -o ro /dev/disk/by-label/Pt-firmware /mnt

Run upgrade script

Once the filesystem is mounted, you can run the upgrade script. This is not the same script that is used for network upgrades but it takes the same optional arguments. These arguments are documented in section 4.3 on page 49, which should be read before proceeding.

Once you have decided which argument, if any, you wish to use, run the script with the command:

/mnt/upgrade optional_argument

Ensure there are no error messages and then reboot the device. Once the unit has rebooted, the upgrade process is then complete.

48 Issue C

Note: Some early Platinum releases only had ext3 filesystem support. If this is the case, the above command will result in an "Invalid argument" error message. If this occurs, simply change ext2 in the above command to ext3.

Operator's Guide

4.3 Upgrade TypesThere are three different types of upgrade, each of which is described below. When upgrading via the web interface the desired type is selected by pressing the appropriate button. When upgrading directly from the command line or from a USB storage device, the required type is selected by the use or omission of command-line arguments.

4.3.1 Standard upgrade

The standard upgrade brings the firmware to the latest revision while respecting and preserving all configuration settings.

To perform a standard upgrade using the web interface, select Firmware from the Tools menu. The following screen is displayed:

Press the upgrade button and watch the screen for any error messages.

To perform the same upgrade from the command line, simply enter the command

eam999 ~ # upgrade

with no arguments, watch the screen for any error messages and then reboot to complete the process.

November 2010 49

Technical Note: All files on the hard drive are left untouched, as are any files in the directories /home, /root, /var and /usr/local. In addition, any file with an extension of .local will be preserved: this is the mechanism by which most configuration settings are safeguarded.


4.3.2 Upgrade and restore defaults

The standard upgrade respects and preserves user configuration settings. In some circumstances it may be necessary to overwrite these settings and return all configuration settings to their factory defaults. The unit is not completely restored to factory condition: this allows for the possibility of implementing customisations and user-developed scripts which persist across upgrades.

To restore defaults while upgrading using the web interface, select Firmware from the Tools menu as before but then press the Advanced options button. The following screen is displayed:

The first button, Upgrade, does exactly the same as the similar button on the previous screen. The Upgrade (restore defaults) button performs the action described in this section.

To perform this action from the command line, invoke the upgrade script with the argument restoredefaults:

eam999 ~ # upgrade --restore-defaults

Watch the screen for any error messages and then reboot the unit to complete the process.

50 Issue C

Technical Note: All files on the hard drive are left untouched, as are any files in the directories /home, /root, /var and /usr/local. Files with the extension .local are deleted.

Operator's Guide

4.3.3 Upgrade and force factory defaults

The third upgrade option effectively wipes everything other than the hard drive while installing the new revision, leaving the unit as it would be delivered. Avoid using this option if you have made any customisations to your unit or installed any scripts. If in doubt, please consult Gralp Systems Ltd technical support for advice before proceeding. Conversely, if you have made changes which you believe have adversely affected the unit but are having trouble undoing them, this option lets you start with a clean slate.

To invoke this option from the web interface, select Firmware from the Tools menu but then press the Advanced options button. From the resulting screen, press the Upgrade (force factory settings) button. Watch the screen for any error messages and then reboot the unit to complete the process.

To perform this action from the command line, invoke the upgrade script with the argument forcefactorysettings:

eam999 ~ # upgrade --force-factory-settings

Watch the screen for any error messages and then reboot the unit to complete the process.

4.4 Upgrade logsThe upgrade process stores all progress and error messages in the file /var/log/upgrade.log. If you suspect that there has been a problem with an upgrade or you wish to have full details of what has changed, you can inspect this file by issuing the command

eam999 ~ # less /var/log/upgrade.log

You can scroll forward through the file simply by pressing the key. For more control, you can move

forward and backwards, line by line, with the and keys or,

page by page, with the and keys.

The key should be used to return to the command line.

If you wish to obtain a copy of this log file, it can be copied from the system to an external computer either via the serial port (see section 10.3.1.3 on page 124) or over the network (see section 10.3.1.2 on page 120).

November 2010 51


5 Data Handling OverviewThe data handling system of the CMG-EAM is very flexible, due to its modular software architecture. All data flowing through the CMG-EAM is routed through a single multiplexor module called gdibase. This communicates directly with all input modules, which handle the various incoming data streams, and all output modules, which convert the data into the required formats. All incoming data is stored and accessed internally in an intermediate format, regardless of the format in which it was originally received.

The diagram below shows the basic internal organisation of the CMG-EAM, ignoring the CD1.1 subsystem.

The multiplexor makes incoming data available to the output modules. These come in two flavours: simple modules (such as those for WIN, GSMS and QSCD) simply convert the data streams and output them in the required format; other modules maintain a ring-buffer which is used to, for example, satisfy BRP back-fill requests. The ring-buffers use the NAND flash memory. These output modules also send data to gdirecord, which handles all hard disk writing requests, regardless of format.

52 Issue C

Note: The sole exception to this is incoming CD1.1 data which, for reasons related to frame signing (an authentication technology), do not pass through gdibase. CD1.1 data-handling and the associated system configuration are covered in a separate manual, MAN-EAM-1100, which is available for download from www.guralp.com.

Operator's Guide

The gdibase and gdirecord programs are designed to be stateless, so that the data on the disk are always consistent. This means the system is tolerant of the power or disk being removed at any time.

Any number of input modules can be configured to acquire data in any supported format from any source, simultaneously. These modules convert their data and pass it to the multiplexor. Data can be acquired in any of the following formats, from multiple sources:

BRP via serial lines;

Scream via 100BaseTX Ethernet or ppp;

GDI-link via 100BaseTX Ethernet or ppp; and

CD1.1

The architecture has been designed to support the addition of extra formats simply by adding input modules. Please contact Gralp Systems if you have requirements which are currently unsupported.

Any number of output modules can be configured to send data in any supported format to any destination. The following data formats are supported:

GCF output via serial port or TCP stream;

GCF output via Scream (TCP or UDP);

GDI (Gralp Data Interconnect);

GDI-link;

CD1.1;

WIN format output;

QSCD - Quick Seismic Characteristic Data (designed by KIGAM) output; and

GSMS (Gralp Seismic Monitoring System) output.

In the default, factory configuration, the CMG-EAM is configured to receive serial GCF input on all of its serial ports except Data Out. There is a single chain of data through the multiplexor to a Scream server. Data are also recorded to disk in GCF format. This is shown in the following diagram:

November 2010 53


The gdi2gcf module, know as the GCF compressor, is responsible for re-blocking GDI sampl

MAN-EAM-0001

Documents

digital sensor

hardware overview

software overview

configuration system

digital instrument

serial port

network port

resilient networking