Protocol reference¶
OWS implements the waveform part of the Winston Wave Server protocol and the Earthworm wave server commands that Winston clients use. This page is for people writing their own clients; Swarm, Earthworm and ObsPy need none of it.
Connection¶
TCP, port 16032 by default (
LISTEN_PORT). No login.Each request is one line of text ending with a newline. The answer starts with a line of text; some answers continue with binary data.
<REQ_ID>is any word you choose. OWS repeats it at the start of the answer, so you can match answers to requests.One connection can carry many requests, one after the other.
Commands¶
Command |
Request |
Answer |
|---|---|---|
|
|
|
|
|
The channel list with each channel’s start and end time (Unix time). With |
|
|
The channel list in Winston’s format; start and end times in J2K seconds. |
|
|
Raw samples as Earthworm TRACEBUF2 packets. Times in Unix seconds. |
|
|
Samples as text. Times in Unix seconds. |
|
|
One binary wave record (big-endian), zlib-compressed if |
|
|
Minimum and maximum per second, for helicorders (big-endian doubles), zlib-compressed if |
Times¶
Unix seconds: seconds since 1970-01-01 00:00:00 UTC, with decimals.
J2K seconds: seconds since 2000-01-01 12:00:00 UTC, with decimals. J2K = Unix − 946728000.
Not supported¶
STATUS, GETSCNLRSAMRAW (server-side resampling), GETSCNRAW, GETSCN, GETPIN, MENUPIN and
MENUSCNL. OWS answers unknown commands by closing the connection. OWS only serves waveforms: it doesn’t store
data sent to it, and it has no instrument response, event or metadata services.