Loading ...
Loading ...
Loading ...
Protocol
Details
Connection
The HyperDeck Ethernet server listens on TCP port 9993.
Basic syntax
The HyperDeck protocol is a line oriented text protocol. Lines from the server will be separated by an ascii
CR LF sequence. Messages from the client may be separated by LF or CR LF.
New lines are represented in this document as a "↵" symbol.
Single line command syntax
Command parameters are usually optional. A command with no parameters is terminated with a new line:
{Command name}↵
If parameters are specified, the command name is followed by a colon, then pairs of parameter names and
values. Each parameter name is terminated with a colon character:
{Command name}: {Parameter}: {Value} {Parameter}: {Value} ...↵
Multiline command syntax
The HyperDeck protocol also supports an equivalent multiline syntax where each parameter-value pair is
entered on a new line. E.g.
{Command name}:↵
{P a r a m e t e r}: { Va lu e}↵
{P a r a m e t e r}: { Va lu e}↵
↵
Response syntax
Simple responses from the server consist of a three digit response code and descriptive text terminated by
a new line:
{Response code} {Response text}↵
If a response carries parameters, the response text is terminated with a colon, and parameter name and
value pairs follow on subsequent lines until a blank line is returned:
{Response code} {Response text}:↵
{P a r a m e t e r}: { Va lu e}↵
{P a r a m e t e r}: { Va lu e}↵
...
↵
Successful response codes
A simple acknowledgement of a command is indicated with a response code of 200:
200 ok↵
Other successful responses carry parameters and are indicated with response codes in the range of 201
to299.
484
Developer Information
Loading ...
Loading ...
Loading ...