Usage

Generally either

import * as seedlink from 'seisplotjs-seedlink'
seedlink.xxxx

or

import * as seisplotjs from 'seisplotjs'
seisplotjs.seedlink.xxxx

Core Functionality

Core functions for using the Seedlink, Datalink and related services

RingserverConnection

src/ringserver-web.js
new RingserverConnection(host: string, port: number)
Parameters
host (string)
port (number)
Instance Members
host(value)
port(value)
pullId()
pullStreamIds(level, matchPattern)
pullStreams(matchPattern)
pullRaw(url)
formBaseURL()
formIdURL()
formStreamsURL(queryParams)
formStreamIdsURL(queryParams)

DataLinkConnection

src/datalink.js
new DataLinkConnection(url: string, packetHandler: function (packet: DataLinkPacket): void, errorHandler: function (error: Error): void)
Parameters
url (string)
packetHandler (function (packet: DataLinkPacket): void)
errorHandler (function (error: Error): void)
Instance Members
mode
packetHandler
errorHandler
serverId
clientIdNum
username
responseResolve
responseReject
webSocket
connect()
stream()
endStream()
close()
sendId()
encodeDLCommand(command, dataString)
sendDLCommand(command, dataString)
awaitDLCommand(command, dataString)
handle(wsEvent)
handleError(error)

SeedlinkConnection

src/seedlink.js
new SeedlinkConnection(url: string, requestConfig: Array<string>, receiveMiniseedFn: function (packet: SequencedDataRecord): void, errorFn: function (error: Error): void)
Parameters
url (string)
requestConfig (Array<string>)
receiveMiniseedFn (function (packet: SequencedDataRecord): void)
errorFn (function (error: Error): void)
Instance Members
requestConfig
receiveMiniseedFn
errorFn
webSocket
command
setTimeCommand(startDate)
connect()
close()
handle(event)
handleMiniseed(event)
sendHello(webSocket)
sendCmdArray(webSocket, cmd)
createCmdPromise(webSocket, mycmd)

stationsFromStreams

src/ringserver-web.js
stationsFromStreams(streams: Array<StreamStat>): Array<StreamStat>
Parameters
streams (Array<StreamStat>)
Returns
Array<StreamStat>

Core Classes and Constants

Core classes returned from the above functions.

SequencedDataRecord

src/seedlink.js
SequencedDataRecord

Type: {rawsequence: string, sequence: number, miniseed: miniseed.DataRecord}

Properties
rawsequence (string)
sequence (number)
miniseed (miniseed.DataRecord)
IRIS_HOST

Type: string

src/seedlink.js
SEEDLINK_PROTOCOL

Type: string

src/datalink.js
DATALINK_PROTOCOL

Type: string

RingserverVersion

src/ringserver-web.js
RingserverVersion

Type: {ringserverVersion: string, serverId: string}

Properties
ringserverVersion (string)
serverId (string)
QUERY_MODE

Type: string

STREAM_MODE

src/datalink.js
STREAM_MODE

Type: string

MAX_PROC_NUM

src/datalink.js
MAX_PROC_NUM

USER_BROWSER

src/datalink.js
USER_BROWSER

Type: string

ERROR

Type: string

PACKET

Type: string

STREAM

Type: string

ENDSTREAM

Type: string

MSEED_TYPE

Type: string

NSLCType

Type: {type: string, networkCode: string, stationCode: string, locationCode: string, channelCode: string}

Properties
type (string)
networkCode (string)
stationCode (string)
locationCode (string)
channelCode (string)
StreamsResult

Type: {accessTime: moment, streams: Array<StreamStat>}

Properties
accessTime (moment)
streams (Array<StreamStat>)
new StreamStat(key: string, start: moment, end: moment)
Parameters
key (string)
start (moment)
end (moment)
Instance Members
startRaw
endRaw
calcLatency(accessTime)

DataLinkPacket

src/datalink.js
new DataLinkPacket(header: string, dataview: DataView)
Parameters
header (string)
dataview (DataView)
Instance Members
header
streamId
pktid
hppackettime
hppacketstart
hppacketend
dataSize
miniseed

Re-export

Re-exporting imported modules for easier reuse.

miniseed
miniseed
moment
RSVP
RSVP
RSVP

Other/Private

Stuff I forgot to put in the TOC.

hasArgs(value: any): boolean
Parameters
value (any)
Returns
boolean

hasNoArgs

src/util.js
hasNoArgs(value: any): boolean
Parameters
value (any)
Returns
boolean

isStringArg

src/util.js
isStringArg(value: any): boolean
Parameters
value (any)
Returns
boolean

isNumArg

src/util.js
isNumArg(value: any): boolean
Parameters
value (any)
Returns
boolean

dataViewToString

src/util.js
dataViewToString(dataView: DataView)
Parameters
dataView (DataView)
nslcSplit(id: string): NSLCType
Parameters
id (string)
Returns
NSLCType
isDef(v: any): boolean
Parameters
v (any)
Returns
boolean