seisplotjs 3.0.0-alpha.1 | Documentation

seisplotjs

3.0.0-alpha.1

SEEDLINK4_PROTOCOL
MINISEED_2_FORMAT
MINISEED_3_FORMAT
SE_PACKET_SIGNATURE
SEPacket ▸
- Static members
- .parse
- Instance members
- #dataFormat
- #dataSubformat
- #payloadLength
- #sequence
- #stationId
- #_miniseed
- #_mseed3
- #_json
- #_rawPayload
- #isMiniseed
- #asMiniseed
- #isMiniseed3
- #asMiniseed3
SeedlinkConnection ▸
- Instance members
- #url
- #requestConfig
- #receivePacketFn
- #errorHandler
- #closeFn
- #webSocket
- #command
- #agent
- #agentVersion
- #setAgent
- #setTimeCommand
- #setOnError
- #setOnClose
- #connect
- #interactiveConnect
- #checkProto
- #close
- #handle
- #handleSEPacket
- #isConnected
- #sendHello
- #sendCmdArray
- #createCmdPromise

Need help reading this?

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

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: (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.

new SeedlinkConnection(url: string, requestConfig: Array<string>, receivePacketFn: function (packet: SEPacket): void, errorHandler: function (error: Error): void)

Parameters

url (string) websocket URL to connect to

requestConfig (Array<string>) an array of seedlink commands like: [ 'STATION JSC CO', 'SELECT 00BHZ.D' ]

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

errorHandler (function (error: Error): void)

Instance Members

▸ url

src/seedlink4.ts

url

Type: string

▸ requestConfig

src/seedlink4.ts

requestConfig

Type: Array<string>

▸ receivePacketFn

src/seedlink4.ts

receivePacketFn

Type: function (packet: SEPacket): void

▸ errorHandler

src/seedlink4.ts

errorHandler

Type: function (error: Error): void

▸ closeFn

src/seedlink4.ts

closeFn

Type: (null | function (close: CloseEvent): void)

▸ webSocket

src/seedlink4.ts

webSocket

Type: (null | WebSocket)

▸ command

src/seedlink4.ts

command

Type: string

▸ agent

src/seedlink4.ts

agent

Type: string

▸ agentVersion

src/seedlink4.ts

agentVersion

Type: string

▸ setAgent(agent)

src/seedlink4.ts

setAgent(agent: string)

Parameters

agent (string)

▸ setTimeCommand(startTime)

src/seedlink4.ts

setTimeCommand(startTime: DateTime)

Parameters

startTime (DateTime)

▸ setOnError(errorHandler)

src/seedlink4.ts

setOnError(errorHandler: function (error: Error): void)

Parameters

errorHandler (function (error: Error): void)

▸ setOnClose(closeFn)

src/seedlink4.ts

setOnClose(closeFn: function (close: CloseEvent): void)

Parameters

closeFn (function (close: CloseEvent): void)

▸ connect()

src/seedlink4.ts

connect()

▸ interactiveConnect()

src/seedlink4.ts

interactiveConnect(): Promise<SeedlinkConnection>

Returns

Promise<SeedlinkConnection>

▸ checkProto(lines)

src/seedlink4.ts

checkProto(lines: Array<string>): boolean

Parameters

lines (Array<string>)

Returns

boolean

▸ close()

src/seedlink4.ts

close(): void

Returns

void

▸ handle(event)

src/seedlink4.ts

handle(event: MessageEvent): void

Parameters

event (MessageEvent)

Returns

void

▸ handleSEPacket(event)

src/seedlink4.ts

handleSEPacket(event: MessageEvent): void

Parameters

event (MessageEvent)

Returns

void

▸ isConnected()

src/seedlink4.ts

isConnected(): boolean

Returns

boolean

▸ sendHello()

src/seedlink4.ts

Sends initial HELLO to server and waits for response.

sendHello(): Promise<Array<string>>

Returns

Promise<Array<string>>: Promise that resolves to the response from the server.

▸ sendCmdArray(cmd)

src/seedlink4.ts

Sends an array of commands, each as a Promise waiting for the 'OK' response before sending the next.

sendCmdArray(cmd: Array<string>): Promise<string>

Parameters

cmd (Array<string>) array of commands to send

Returns

Promise<string>: Promise that resolves to the 'OK' returned by the last command if successful, or rejects on the first failure.

▸ createCmdPromise(mycmd)

src/seedlink4.ts

creates a Promise that sends a command and waits resolved with the result.

createCmdPromise(mycmd: string): Promise<string>

Parameters

mycmd (string) command string to send.

Returns

Promise<string>: Promise that resolves to the reply from the server.