Appendix IV. config.txt specification

Estimated reading time: 5 minutes

config.txt is the setting file of BRAVIA Signage Player. When you copy this file to the root folder of USB flash memory and insert it to the USB port of the display to which BRAVIA Signage Player installed, this player is set in accordance with settings configured in config.txt. This section describes the specifications of config.txt.

File format

The format of this config.txt must be JSON, and the encoding format must be UTF-8.
It should be noted that some displays do not read config.txt with Byte Order Mark and BRAVIA Signage Player may not start. Because there are some general text editors that apply Byte Order Mark when editing and saving, be careful when editing and saving config.txt.

Settings

Settings in config.txt is as follows:

Items			Type		Descriptions
settings			Object	Required	Indicates the configurations for BRAVIA Signage Player.
	server		String	Required	Configure BRAVIA Signage Server URL as http://[server ip address]:[port]. e.g. http://192.168.100.100:8080 The max string length is 160 characters. If it exceeds 161, the exceeded characters are removed.
	tv-name		Number	Required	Configure display's name displayed on the Operation Web Application. (It should be noted that you can change display's name from the Operation Web Application.) The max string length is 20 characters. If it exceeds 21, the exceeded characters are removed. In addition, you can use any Unicode character excluding " and \.
	connection-error		Object	Optional	Indicates the configurations for the connection from BRAVIA Signage Player to BRAVIA Signage Server.
		initial-timeout	Number	Optional	Configure timeout (sec) when BRAVIA Signage Player connects to BRAVIA Signage Server for the first time. This is for the first setup of BRAVIA Signage Player. If it is not configured in config.txt, initial timeout is 60 seconds.
		timeout	Number	Optional	Configure timeout (sec) when BRAVIA Signage Player connects to BRAVIA Signage Server. If "-1" is specified, configure as no timeout. In that case, connection error message is not shown on the screen. If "59" or under is specified, timeout is 60 seconds. If it is not configured in config.txt, timeout is 300 seconds.
		reboot	Boolean	Optional	Configure whether display reboots or not when timeout occurs. true: Displays the error message if timeout occurs. false: Does not display the error message if timeout occurs. If it is not configured in config.txt, this is configured as false.
	override		Boolean	Optional	Configure whether or not to override the configuration ("server" and "tv-name") when inserting USB memory with config.txt. true: Overrides in accordance with config.txt in the USB memory. Even if you change display’s name from the Operation Web Application, it is overwritten. false: It is not overwritten even if a USB memory with config.txt is inserted. If it is not configured in config.txt, this is configured as false. And in only initial setup, even if false, this is configured as true.
	ssl-authentication		Boolean	Optional	When connected to a server with SSL, configure whether or not BRAVIA Signage Player verifies the SSL certificate. true: enables verification false: disables verification If it is not configured in config.txt, this is configured as false
	connection		Object	Optional	Indicates the configurations for connection protocol from BRAVIA Signage Player to BRAVIA Signage Server.
		transports	Array	Optional	Configure the connection protocol from BRAVIA Signage Player to BRAVIA Signage Server. only "websocket": use websocket only "polling": use HTTP Long Polling both "websocket" and "polling": basically use "websocket", but use HTTP Long Polling if websocket is unavailable for some reason. If it is not configured in config.txt, this is configured as "websocket".
	pre-shared-key		String	Optional	Configure the Pre-Shared key value set to display. This configuration is used only when the Pre-Shared Key is configured on display.
version			String	Required	Indicates this config.txt version. Configure "1".

Example of config.txt

Some examples of config.txt are as follows:

config.txt example (1)
BRAVIA Signage Player times out in 300 seconds and displays the error message, if it can’t connect to BRAVIA Signage Server.

{
  "settings" : {
      "server" : "http://example.com:8080",
      "tv-name" : "Signage-001",
      "connection-error" : {
          "timeout" : 300,
          "reboot" : false
      },
      "override" : false
  },
  "version" : "1"
}

config.txt example (2)
BRAVIA Signage Player never displays the error message and continues to play downloaded schedules and contents, if it can’t connect to BRAVIA Signage Server.

{
  "settings" : {
      "server" : "http://example.com:8080/",
      "tv-name" : "Signage-001",
      "connection-error" : {
          "timeout" : -1,
          "reboot" : false
      },
      "override" : false
  },
  "version" : "1"
}

config.txt example (3)

{
  "settings" : {
      "server" : "http://example.com:8080",
      "tv-name" : "Signage-001",
      "connection-error" : {
          "initial-timeout" : 120,
          "timeout" : 300,
          "reboot" : true
      },
      "override" : true,
      "ssl-authentication" : true,
      "connection" : {
          "transports" : ["websocket", "polling"]
      },
      "pre-shared-key" : "1234"
  },
  "version" : "1"
}