seisplotjs 3.1.3 | Documentation

SEEDLINK4_PROTOCOL

src/seedlink4.ts

SEEDLINK4_PROTOCOL

Type: string

MINISEED_2_FORMAT

src/seedlink4.ts

MINISEED_2_FORMAT

Type: string

MINISEED_3_FORMAT

src/seedlink4.ts

MINISEED_3_FORMAT

Type: string

SE_PACKET_SIGNATURE

src/seedlink4.ts

SE_PACKET_SIGNATURE

Type: string

END_COMMAND

src/seedlink4.ts

END_COMMAND

Type: string

ENDFETCH_COMMAND

src/seedlink4.ts

ENDFETCH_COMMAND

Type: string

AUTH_COMMAND

src/seedlink4.ts

AUTH_COMMAND

Type: string

BYE_COMMAND

src/seedlink4.ts

BYE_COMMAND

Type: string

DATA_COMMAND

src/seedlink4.ts

DATA_COMMAND

Type: string

HELLO_COMMAND

src/seedlink4.ts

HELLO_COMMAND

Type: string

INFO_COMMAND

src/seedlink4.ts

INFO_COMMAND

Type: string

SELECT_COMMAND

src/seedlink4.ts

SELECT_COMMAND

Type: string

SLPROTO_COMMAND

src/seedlink4.ts

SLPROTO_COMMAND

Type: string

STATION_COMMAND

src/seedlink4.ts

STATION_COMMAND

Type: string

USERAGENT_COMMAND

src/seedlink4.ts

USERAGENT_COMMAND

Type: string

SEPacket

src/seedlink4.ts

new SEPacket(dataFormat: string, dataSubformat: string, payloadLength: number, sequence: bigint, stationId: string)

Parameters

dataFormat (string)

dataSubformat (string)

payloadLength (number)

sequence (bigint)

stationId (string)

Static Members

▸ parse(data)

src/seedlink4.ts

parse(data: ArrayBuffer): SEPacket

Parameters

data (ArrayBuffer)

Returns

SEPacket

Instance Members

▸ dataFormat

src/seedlink4.ts

dataFormat

Type: string

▸ dataSubformat

src/seedlink4.ts

dataSubformat

Type: string

▸ payloadLength

src/seedlink4.ts

payloadLength

Type: number

▸ sequence

src/seedlink4.ts

sequence

Type: bigint

▸ stationId

src/seedlink4.ts

stationId

Type: string

▸ _miniseed

src/seedlink4.ts

_miniseed

Type: (DataRecord | null)

▸ _mseed3

src/seedlink4.ts

_mseed3

Type: (MSeed3Record | null)

▸ _json

src/seedlink4.ts

_json

Type: (Record<string, any> | null)

▸ _rawPayload

src/seedlink4.ts

_rawPayload

Type: (DataView | null)

▸ isMiniseed()

src/seedlink4.ts

is this packet a miniseed packet

isMiniseed(): boolean

Returns

boolean: true if it is miniseed

▸ asMiniseed()

src/seedlink4.ts

Parsed payload as a miniseed data record, if the streamid ends with '/MSEED', null otherwise.

asMiniseed(): (miniseed.DataRecord | null)

Returns

(miniseed.DataRecord | null): miniseed DataRecord or null

▸ isMiniseed3()

src/seedlink4.ts

is this packet a miniseed3 packet

isMiniseed3(): boolean

Returns

boolean: true if it is miniseed3

▸ asMiniseed3()

src/seedlink4.ts

Parsed payload as a miniseed3 data record, if the data format is 3, null otherwise.

asMiniseed3(): (mseed3.MSeed3Record | null)

Returns

(mseed3.MSeed3Record | null): miniseed3 DataRecord or null

SeedlinkConnection

src/seedlink4.ts

A seedlink websocket connection to the given url. The connection is not made until the connect() method is called. Note this cannot connect directly to a native TCP socket, instead it sends the seedlink protocol over a websocket. Currently only the IRIS ringserver, https://github.com/iris-edu/ringserver, supports websockets, but it may be possible to use thrid party tools to proxy the websocket to a TCP seedlink socket.

The spec is available via the FDSN, https://www.fdsn.org/publications/

Note as of 2023, this is largely untested as there are now servers available to test against.

new SeedlinkConnection(url: string, requestConfig: Array<string>, receivePacketFn: function (packet: SEPacket): void, errorHandler: function (error: Error): void, closeFn: any, webSocket: any, endCommand: any, agent: any, agentVersion: any)

Parameters

url (string) websocket URL to connect to

requestConfig (Array<string>) an array of seedlink commands like: [ 'STATION CO_JSC', 'SELECT 00_B_H_Z' ]

receivePacketFn (function (packet: SEPacket): void) the callback function that will be invoked for each seedlink packet received.

errorHandler (function (error: Error): void) callback function for errors

closeFn (any) callback function for closing connection

webSocket (any) optional web socket connection

endCommand (any) handshake ending command, either END or ENDFETCH

agent (any) agent identifier

agentVersion (any) agent version

Instance Members

▸ url