07_01_ControlSystemStudio

Control System Studio

DataBrowser

#button {
    border: none;
}

This is a
piece of code
in a block

This too

Method	Description
archiver.info	description
archiver.archives	description
archiver.names	Description
archiver.values	description

archiver.info

A the fields

Field (node)	Description
ver	Version number. The first released software uses ’1’.
desc	Cute description that one can print
how	Array of strings with a description of the request methods supported for ’how’ in the archiver.values() call.
stat	Array of strings with a description of the “status” part of the values returned by the archiver.values() call
sevr	Array of structures with a description of the “severity” part of the values returned by the archiver.values() call

archiver.archives

Field (node)	Description
key	A numeric key that is used by the following routines to select the archive
name	A description of the archive that one could e.g. use in a drop-down selector in a GUI application for allowing the user to select an archive.
path	The path to the index file, valid on the file system where the data server runs. It might be meaningful to a few users who want to know exactly where the data resides, but it is seldom essential for XML-RPC clients to look at this

archiver.names

Request

Field (node)	Description
key
pattern

Field (node)	Description
name
start_sec
start_nano
end_sec
end_nano

archiver.values

Field (node)	Type	Description
key	int32	A numeric key that is used by the following routines to select the archive
how	int32	The parameter ”how” determines how the raw values of the various channels get arranged to meet the requested time range and count
name	string	The channel name. Result[i].name should match name[i] of the request, so this is a waste of electrons, but it’s sure convenient to have the name in the result, and we’re talking XML-RPC, so forget about the electrons.
meta	structure	The meta information for the channel.
type	int32	Describes the data type of this channel’s value
count	int32	Describes the array size of this channel’s values, using 1 for scalar values. Note that even scalar values are returned as an array with one element!
values	structure	This is an array where each entry is a structure

Meta information

Field (node)	Type	Description
type	int32
states	string[]
disp_high	double
disp_low	double
alarm_high	double
alarm_low	double
warn_high	double
warn_low	double
prec	int
units	string

Values structure

Field (node)	Type	Description
stat	int32
sevr	int32
secs	int32
nano	int 32
value	type

The type info

Name	Value	Description
string	0
enum	1
int	2
double	3

Name	Value	Description
raw	0	Get raw data from timeseries, starting w/ ’start’, up to either ’end’ time or max. ’count’ samples
spreadsheet	1	Get data that is filled or staircase-interpolated, starting w/ ’start’, up to either ’end’ time or max. ’count’ samples (see 2.7.3). For each channel, the same number of values is returned. The time stamps of the samples match accross channels, so that one can print the samples for each channel as columns in a spreadsheet. If a spreadsheet cell is empty because the channel does not have any useful value for that point in time, a status/severity of UDF/INVALID is returned (Tables 5.2 and 5.1).
averaged	2	Get averaged data from the archive, starting w/ ’start’, up to either ’end’ time or max. ’count’ samples (see 2.7.4). The data is averaged within bins whose size is determined by of (end-start)/count, so you should expect to get close to ’count’ values which cover ’start’ to ’end’. Again refer to section 2.7
plot binning	3	Uses the plot-binning method based on ’count’ bins.
linear	4	Get linearly interpolated data from the archive, starting w/ ’start’, up to either ’end’ time or max. ’count’ samples (see 2.7.4). The data is interpolated onto time slots which are multiples of (end-start)/count, so you should expect to get close to ’count’ values which cover ’start’ to ’end’. Again refer to section 2.7.

Links