Documentsplayer-server-communication

Player-server communication

Players keep a live connection to the server and report in at regular intervals.

The player keeps a persistent WebSocket connection to the server. This applies to all player types: Raspberry Pi, Android and Amazon Signage Stick. Older Pi players use socket.io, which the server still supports. Media files are downloaded over HTTPS, not over this connection.

Status

  1. The player reports its status as soon as it connects, then repeats every "Player reporting interval" minutes.
  2. You set that interval in Settings. The default is 5 minutes and the minimum is 3. See Settings.
  3. The server replies with the group configuration.
  4. If a deploy happened while the player was disconnected, the player downloads the new content at that point.

Online and offline

  1. The connection is checked with a ping every 30 seconds and is re-established automatically.
  2. The server shows a player as offline if it has not reported for 15 minutes.

See Screens for all player statuses.

Deploy

  1. Pressing Deploy sends a sync immediately to all online players in the group.
  2. Offline players sync when they reconnect.

See also How does player communicate with server and Connectivity needs for the player (firewall).