hello
- Command
hello- Area
- basics
- Profile
- mandatory
- Response
- details of the display and its capabilities
hello is the only place where a controlling program learns what it is dealing
with. It should be the first request on a connection, but it is not a
precondition for the other commands: anyone who merely wants to set an idle
screen may do so without preamble.
Request#
{"v":1,"cmd":"hello","client":{"name":"Library software","version":"15.2","lang":"en"}}
| Field | Required | Content |
|---|---|---|
client.name |
no | name of the controlling program, for the log |
client.version |
no | its version |
client.lang |
no | language the controlling program works in |
auth.token |
no | agreed secret, see operation |
Response#
{"v":1,"ok":true,"result":{
"server":"Display program","version":"0.2.0","proto":[1],
"caps":["session","idle","message","venue","monitor","config","lifecycle"],
"lang":["de","en","uk"],
"limits":{"items":50,"line":8192}}}
| Field | Required | Content |
|---|---|---|
server |
yes | name of the display |
version |
yes | its version |
proto |
yes | list of supported protocol versions, e.g. [1] |
caps |
yes | areas present, see commands |
lang |
no | languages the display can word things in |
limits.items |
no | maximum number of entries in items per request |
limits.line |
no | largest line length that can be processed, in bytes |
What a controlling program does with it#
caps is the basis of every decision: without message no notices are sent;
without session an idle screen is about all that comes into question. A
controlling program remembers the answer and does not ask again before every
request.
Anyone who merely wants to know whether an area exists at all will find the same information in the identification file (see operation) – without connecting, and even while the display is not running.