seisplotjs.seedlink 2.0.0

seisplotjs.seedlink

2.0.0

SEEDLINK_PROTOCOL
SequencedDataRecord
SeedlinkConnection ▸
- Instance members
- #url
- #requestConfig
- #receiveMiniseedFn
- #errorFn
- #closeFn
- #webSocket
- #command
- #setTimeCommand
- #setOnError
- #setOnClose
- #connect
- #close
- #handle
- #handleMiniseed
- #isConnected
- #sendHello
- #sendCmdArray
- #createCmdPromise

Need help reading this?

SEEDLINK_PROTOCOL

src/seedlink.js

SEEDLINK_PROTOCOL

Type: string

SequencedDataRecord

src/seedlink.js

SequencedDataRecord

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

Properties

rawsequence (string)

sequence (number)

miniseed (miniseed.DataRecord)

SeedlinkConnection

src/seedlink.js

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>, receiveMiniseedFn: function (packet: SequencedDataRecord): void, errorFn: 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' ]
</pre></code>


      
        
          
            receiveMiniseedFn (function (packet: SequencedDataRecord): void)
	    the callback function that
will be invoked for each seedlink packet received
which contains 'sequence', a sequence number
and 'miniseed', a single miniseed record.

          
          
        
      
        
          
            errorFn (function (error: Error): void)


  

  

  

  

  

  

  
    Instance Members
    
  
    
      
        
            ▸
            url
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    url
  
    
      Type:
      string
    
  
  

  
  
  
  
  
  

  

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            requestConfig
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    requestConfig
  
    
      Type:
      Array<string>
    
  
  

  
  
  
  
  
  

  

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            receiveMiniseedFn
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    receiveMiniseedFn
  
    
      Type:
      function (packet: SequencedDataRecord): void
    
  
  

  
  
  
  
  
  

  

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            errorFn
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    errorFn
  
    
      Type:
      function (error: Error): void
    
  
  

  
  
  
  
  
  

  

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            closeFn
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

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

  
  
  
  
  
  

  

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            webSocket
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    webSocket
  
    
      Type:
      (null | WebSocket)
    
  
  

  
  
  
  
  
  

  

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            command
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    command
  
    
      Type:
      string
    
  
  

  
  
  
  
  
  

  

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            setTimeCommand(startTime)
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    setTimeCommand(startTime: moment)
  
  

  
  
  
  
  
  

  
    Parameters
    
      
        
          
            startTime (moment)
	    
          
          
        
      
    
  

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            setOnError(errorFn)
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

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

  
  
  
  
  
  

  
    Parameters
    
      
        
          
            errorFn (function (error: Error): void)
	    
          
          
        
      
    
  

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            setOnClose(closeFn)
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

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

  
  
  
  
  
  

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

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            connect()
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    connect()
  
  

  
  
  
  
  
  

  

  

  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            close()
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    close(): void
  
  

  
  
  
  
  
  

  

  

  
    
      Returns
      void
    
  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            handle(event)
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    handle(event: MessageEvent): void
  
  

  
  
  
  
  
  

  
    Parameters
    
      
        
          
            event (MessageEvent)
	    
          
          
        
      
    
  

  

  
    
      Returns
      void
    
  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            handleMiniseed(event)
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    handleMiniseed(event: MessageEvent): void
  
  

  
  
  
  
  
  

  
    Parameters
    
      
        
          
            event (MessageEvent)
	    
          
          
        
      
    
  

  

  
    
      Returns
      void
    
  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            isConnected()
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  
    isConnected(): boolean
  
  

  
  
  
  
  
  

  

  

  
    
      Returns
      boolean
    
  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            sendHello()
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  Sends initial HELLO to server and waits for response.

    sendHello(): Promise<string>
  
  

  
  
  
  
  
  

  

  

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

      
    
  

  

  

  

  

  

  


      
    
  
    
      
        
            ▸
            sendCmdArray(cmd)
        
      
      
        

  
  
    
    
      
      src/seedlink.js
      
    
  
  

  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/seedlink.js
      
    
  
  

  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.