Commit a9eda782 authored by Matteo Quintiliani's avatar Matteo Quintiliani

Starting from nmxp_dap_0_3_0

git-svn-id: file:///home/quintiliani/svncopy/nmxptool/trunk@106 3cd66e75-5955-46cb-a940-c26e5fc5497d
parent ab085d14
This diff is collapsed.
Installation Instructions
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
2006 Free Software Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Basic Installation
Briefly, the shell commands `./configure; make; make install' should
configure, build, and install this package. The following
more-detailed instructions are generic; see the `README' file for
instructions specific to this package.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. Caching is
disabled by default to prevent problems with accidental use of stale
cache files.
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `' (or `') is used to create
`configure' by a program called `autoconf'. You need `' if
you want to change it or regenerate `configure' using a newer version
of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system.
Running `configure' might take a while. While running, it prints
some messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
Some systems require unusual options for compilation or linking that the
`configure' script does not know about. Run `./configure --help' for
details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c99 CFLAGS=-g LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you can use GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
With a non-GNU `make', it is safer to compile the package for one
architecture at a time in the source code directory. After you have
installed the package for one architecture, use `make distclean' before
reconfiguring for another architecture.
Installation Names
By default, `make install' installs the package's commands under
`/usr/local/bin', include files under `/usr/local/include', etc. You
can specify an installation prefix other than `/usr/local' by giving
`configure' the option `--prefix=PREFIX'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
PREFIX as the prefix for installing programs and libraries.
Documentation and other data files still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=DIR' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
There may be some features `configure' cannot figure out automatically,
but needs to determine by the type of machine the package will run on.
Usually, assuming the package is built to be run on the _same_
architectures, `configure' can figure that out, but if it prints a
message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
where SYSTEM can have one of these forms:
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the option `--target=TYPE' to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
If you want to set default values for `configure' scripts to share, you
can create a site shell script called `' that gives default
values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/' if it exists, then
`PREFIX/etc/' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
causes the specified `gcc' to be used as the C compiler (unless it is
overridden in the site shell script).
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
an Autoconf bug. Until the bug is fixed you can use this workaround:
CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
`configure' Invocation
`configure' recognizes the following options to control how it operates.
Print a summary of the options to `configure', and exit.
Print the version of Autoconf used to generate the `configure'
script, and exit.
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
Alias for `--cache-file=config.cache'.
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.
# mtheo
dist_doc_DATA = README
autoheader && aclocal && autoconf && automake -a -c
# -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.
dnl Name your program here
m4_define([full_package_name], [nmxptool])
dnl These three define the plug-in version number
m4_define([major_version], [0])
m4_define([minor_version], [3])
m4_define([micro_version], [0])
m4_define([bug_report_address], [])
AC_INIT([full_package_name], [version], [bug_report_address])
AM_INIT_AUTOMAKE([full_package_name], [version])
# Checks for programs.
# Checks for libraries.
# AC_CHECK_LIB([mseed], [msr_init], [], [AC_MSG_ERROR([library mseed is not installed!])])
AC_CHECK_LIB([mseed], [msr_init], [], [AC_MSG_WARN([
Library libmseed not found!
Capability about management of mini-SEED will not available!
AC_CHECK_LIB([nmxp], [nmxp_openSocket], [], [AC_MSG_ERROR([library nmxp is not installed!])])
# Checks for header files.
AC_CHECK_HEADERS([stdint.h stdlib.h string.h])
AC_CHECK_HEADER(libmseed.h, [], [AC_MSG_WARN([
Header file <libmseed.h> not found!
Capability about management of mini-SEED will not available!
AC_CHECK_HEADER(nmxp.h, [], [AC_MSG_ERROR([header file <nmxp.h> is required])])
# Checks for files.
# TODO optional
AC_CHECK_FILES([./src/seedlink_plugin.c ./src/seedlink_plugin.h], [], AC_MSG_ERROR([seedlink plug-in sources not found!]))
# Checks for typedefs, structures, and compiler characteristics.
# Checks for library functions.
AC_CHECK_FUNCS([memset strchr strdup])
bin_PROGRAMS = nmxptool
# TODO optional
seedlinkplugin_sources = seedlink_plugin.c
nmxptool_SOURCES = nmxptool.c nmxptool_getoptlong.c \
#noinst_HEADERS = gdu.h
# man page
# man_MANS = gdu.1x
# # we want these in the dist tarball
# EXTRA_DIST = back.xpm reload.xpm root.xpm \
# home.xpm stop.xpm about.xpm gdu.1x
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <nmxp.h>
#include "nmxptool_getoptlong.h"
#include "config.h"
#include "plugin.h"
int main (int argc, char **argv) {
int naqssock;
NMXP_CHAN_LIST *channelList;
NMXP_CHAN_LIST *channelList_subset;
uint32_t connection_time;
int request_SOCKET_OK;
int i_chan;
void *buffer;
uint32_t length;
int ret;
FILE *outfile = NULL;
char filename[500];
char *station_code = NULL, *channel_code = NULL;
/* Mini-SEED variables */
NMXP_DATA_SEED data_seed;
/* Init mini-SEED variables */
nmxp_log(-1, 0);
/* Initialize params from argument values */
if(nmxptool_getopt_long(argc, argv, &params) != 0) {
return 1;
/* Check consistency of params */
if(nmxptool_check_params(&params) != 0) {
return 1;
/* List available channels on server */
if(params.flag_listchannels) {
channelList = nmxp_getAvailableChannelList(params.hostname, params.portnumberpds, NMXP_DATA_TIMESERIES);
return 1;
/* Get list of available channels and get a subset list of params.channels */
channelList = nmxp_getAvailableChannelList(params.hostname, params.portnumberpds, NMXP_DATA_TIMESERIES);
channelList_subset = nmxp_chan_subset(channelList, NMXP_DATA_TIMESERIES, params.channels);
/* Check if some channel already exists */
if(channelList_subset->number <= 0) {
nmxp_log(1, 0, "Channels not found!\n");
return 1;
/* Free the complete channel list */
if(channelList) {
channelList = NULL;
/* ************************************************************** */
/* Start subscription protocol "DATA ACCESS PROTOCOL" version 1.0 */
/* ************************************************************** */
/* DAP Step 1: Open a socket */
if( (naqssock = nmxp_openSocket(params.hostname, params.portnumberdap)) == NMXP_SOCKET_ERROR) {
nmxp_log(1, 0, "Error opening socket!\n");
return 1;
/* DAP Step 2: Read connection time */
if(nmxp_readConnectionTime(naqssock, &connection_time) != NMXP_SOCKET_OK) {
nmxp_log(1, 0, "Error reading connection time from server!\n");
return 1;
/* DAP Step 3: Send a ConnectRequest */
if(nmxp_sendConnectRequest(naqssock, params.datas_username, params.datas_password, connection_time) != NMXP_SOCKET_OK) {
nmxp_log(1, 0, "Error sending connect request!\n");
return 1;
/* DAP Step 4: Wait for a Ready message */
if(nmxp_waitReady(naqssock) != NMXP_SOCKET_OK) {
nmxp_log(1, 0, "Error waiting Ready message!\n");
return 1;
/* Start loop for sending requests */
while(request_SOCKET_OK == NMXP_SOCKET_OK && i_chan < channelList_subset->number) {
/* DAP Step 5: Send Data Request */
request_SOCKET_OK = nmxp_sendDataRequest(naqssock, channelList_subset->channel[i_chan].key, params.start_time, params.end_time);
if(request_SOCKET_OK == NMXP_SOCKET_OK) {
if(params.flag_writefile) {
/* Open output file */
sprintf(filename, "%s.%s.%d.%d.%d.nmx", ( : DEFAULT_NETWORK, channelList_subset->channel[i_chan].name, channelList_subset->channel[i_chan].key, params.start_time, params.end_time);
outfile = fopen(filename, "w");
if(!outfile) {
nmxp_log(1, 0, "Can not to open file %s!", filename);
if(params.flag_writeseed) {
/* Open output Mini-SEED file */
sprintf(data_seed.filename_mseed, "%s.%s.%d.%d.%d.miniseed", ( : DEFAULT_NETWORK, channelList_subset->channel[i_chan].name, channelList_subset->channel[i_chan].key, params.start_time, params.end_time);
data_seed.outfile_mseed = fopen(data_seed.filename_mseed, "w");
if(!data_seed.outfile_mseed) {
nmxp_log(1, 0, "Can not to open file %s!", data_seed.filename_mseed);
if(params.flag_writefile && outfile) {
/* Compute SNCL line */
/* Separate station_code and channel_code */
station_code = NULL;
channel_code = NULL;
station_code = strdup(channelList_subset->channel[i_chan].name);
if ( (channel_code = strchr(station_code, '.')) == NULL ) {
nmxp_log(1,0, "Channel name not in STA.CHAN format: %s\n", station_code);
if(channel_code) {
*channel_code++ = '\0';
if(station_code) {
/* Write SNCL line */
fprintf(outfile, "%s.%s.%s.%s\n", station_code, ( : DEFAULT_NETWORK, channel_code, (params.location)? params.location : "");
/* DAP Step 6: Receive Data until receiving a Ready message */
ret = nmxp_receiveMessage(naqssock, &type, &buffer, &length);
nmxp_log(0, 1, "ret = %d, type = %d\n", ret, type);
while(ret == NMXP_SOCKET_OK && type != NMXP_MSG_READY) {
/* Process a packet and return value in NMXP_DATA_PROCESS structure */
pd = nmxp_processCompressedDataFunc(buffer, length, channelList_subset);
/* Write Mini-SEED record */
if(params.flag_writeseed) {
nmxp_data_msr_pack(pd, &data_seed);
/* Send data to SeedLink Server */
if(params.flag_writeseedlink) {
/* TODO Set values */
const int usec_correction = 0;
const int timing_quality = 100;
send_raw_depoch(pd->station, pd->channel, pd->time, usec_correction, timing_quality,
pd->pDataPtr, pd->nSamp);
/* Log contents of last packet */
if(params.flag_writefile && outfile) {
/* Write buffer to the output file */
if(outfile && buffer && length > 0) {
int length_int = length;
nmxp_data_swap_4b((int32_t *) &length_int);
fwrite(&length_int, sizeof(length_int), 1, outfile);
fwrite(buffer, length, 1, outfile);
if(buffer) {
/* Receive Data */
ret = nmxp_receiveMessage(naqssock, &type, &buffer, &length);
nmxp_log(0, 1, "ret = %d, type = %d\n", ret, type);
if(params.flag_writefile && outfile) {
/* Close output file */
if(params.flag_writeseed && data_seed.outfile_mseed) {
/* Close output Mini-SEED file */
/* DAP Step 7: Repeat steps 5 and 6 for each data request */
/* DAP Step 8: Send a Terminate message (optional) */
nmxp_sendTerminateSubscription(naqssock, NMXP_SHUTDOWN_NORMAL, "Bye!");
/* DAP Step 9: Close the socket */
/* ************************************************************ */
/* End subscription protocol "DATA ACCESS PROTOCOL" version 1.0 */
/* ************************************************************ */
return 0;
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include "config.h"
#include "nmxp.h"
#include "nmxptool_getoptlong.h"
void nmxptool_usage(struct option long_options[])
%s %s, Nanometrics Data Access Protocol 1.0 tool\n\n\
Usage: %s -H hostname -C channellist -s date -e date [...]\n\
%s -H hostname --listchannels [...]\n\
Required arguments:\n\
-H, --hostname=HOST Nanometrics hostname.\n\
-C, --channels=LIST Channel list STA1.CHAN1,STA2.CHAN2,...\n\
-s, --start_time=DATE Start time in date format.\n\
-e, --end_time=DATE End time in date format.\n\
DATE can be in formats:\n\
<date>,<time> | <date>\n\
<date> = yyyy/mm/dd | yyy.jjj\n\
<time> = hh:mm:ss | hh:mm\n\
Optional arguments:\n\
-P, --portpds=PORT NaqsServer port number (default 28000).\n\
-D, --portdap=PORT DataServer port number (default 28002).\n\
-N, --network=NET Network code for writing file (default %s).\n\
-L, --location=LOC Location code for writing file.\n\
-u, --username=USER DataServer username.\n\
-p, --password=PASS DataServer password.\n\
-v, --verbose Be verbose.\n\
-q, --quiet Quiet (almost no output).\n\
-l, --listchannels Output list of channel available on NaqsServer.\n",
-m, --writeseed Pack received data in Mini-SEED records and append to a file.\n");
-w, --writefile Write received data to a file.\n");
-k, --seedlink Send received data to SeedLink (SL-plugin).\n");
-h, --help Print this help.\n\
Mail bug reports and suggestions to <%s>.\n",
if(long_options) {
int i=0;
while(long_options[i].name) {
printf("%s %d %d %d %c\n", long_options[i].name, long_options[i].has_arg, (long_options[i].flag)? *(long_options[i].flag) : 0, long_options[i].val, long_options[i].val);
int nmxptool_getopt_long(int argc, char **argv, NMXP_DAP_PARAMS *params)
struct option long_options[] =
/* These options set a flag. */