Appendix IV. config.txt 仕様

Estimated reading time: 3 minutes

config.txt は、BRAVIA Signage Player の設定ファイルです。本ファイルを USB メモリーのルートフォルダに保存し、BRAVIA Signage Player がインストールされたディスプレイの USB ポートに接続すると、config.txt に記載した設定に基づき設定されます。ここでは、config.txt 仕様について説明します。

ファイル形式

JSON フォーマットで記載し、ファイル保存時のエンコーディングは UTF-8 で作成を行ってください。
なお Byte Order Mark が付与された config.txt について、一部のディスプレイでは利用することができず、USB メモリーを接続しても BRAVIA Signage Player の設定画面が起動しないことがあります。ご利用のテキストエディタの種類に応じ、保存時に Byte Order Mark を付与するようなものがありますので config.txt の作成や編集においてはご注意ください。

設定値仕様

config.txt に設定する設定項目は以下のとおりです。

項目名			型	指定	説明
settings			Object	必須	BRAVIA Signage Player に関する設定を表します。
	server		String	必須	BRAVIA Signage Server の URL を "http://[サーバー PC のアドレス]:[ポート番号]" の形式で指定します。例) http://192.168.100.100:8080 設定できるURLの最大長は 160 文字です。160 文字を超えた部分は切り捨てられます。
	tv-name		Number	必須	管理 Web アプリで表示されるディスプレイの名前を指定します。(ディスプレイに付けた名前はあとから管理 Web アプリから変更することができます。) 設定できる文字列の最大長は 20 文字です。20 文字を超えた部分は切り捨てられます。" (半角ダブルクォート) と \ (半角円記号) 以外の任意のユニコード文字を指定することができます。
	connection-error		Object	任意	BRAVIA Signage Player から BRAVIA Signage Server への接続エラーに関する設定を表します。
		initial-timeout	Number	任意	BRAVIA Signage Player　の初回設定時 (初回接続時) において、接続エラーを判断するまでのタイムアウト(秒)を指定します。省略時の値は、60 秒となります。
		timeout	Number	任意	接続エラーを判断するまでのタイムアウト(秒)を指定します。"-1" を指定した場合はタイムアウトなしとなり、接続エラーの画面が出力されることはありません。"60" 未満の場合は 60 秒が設定されます。省略時の値は、300 秒となります。なお、BRAVIA Signage Server と Player の接続状況に応じ指定した時間より 1～2 分程度、エラー画面の表示が遅れることがあります。
		reboot	Boolean	任意	接続エラー時にディスプレイを再起動するかどうかを指定します。 true: 接続エラー時、ディスプレイにエラー画面を表示せず再起動します。 false: 接続エラー時、ディスプレイにエラー画面を表示します。省略時の値は、falseとなります。
	override		Boolean	任意	USB メモリーを挿入した時に、BRAVIA Signage Player に既に設定されている server と tv-name の値をUSBメモリに保存したソフトウェア設定ファイルで強制的に上書きするかどうかを指定します。 true: USB メモリーに保存したソフトウェア設定ファイルの内容を強制的に BRAVIA Signage Player に設定します。管理 Web アプリからディスプレイの名前を変更した場合もソフトウェア設定ファイルの内容で上書きされます。 false: BRAVIA Signage Player に既に設定されている server と tv-name の値が使用されます。管理 Web アプリで変更した値がそのまま使用されます。省略時の値は、false となります。なお初回設定時は値によらず true に設定した場合の動作となります。
	ssl-authentication		Boolean	任意	サーバとの SSL 通信時、サーバ証明書を検証するかどうかを指定します。 true: 証明書の検証を有効 false: 証明書の検証を無効省略時の値は、falseとなります。
	connection		Object	任意	BRAVIA Signage Server との通信プロトコルに関する設定を表します。
		transports	Array	任意	BRAVIA Signage Server との通信で利用する接続プロトコルを指定します。 websocket のみを指定: BRAVIA Signage Server との通信において websocket を利用します。 polling のみを指定: BRAVIA Signage Server との通信において HTTP Long Polling を利用します。両方を指定: BRAVIA Signage Server との通信において、原則 websocket が利用されますが、何らかの理由により websocket を利用できない場合は HTTP Loing Polling を利用します。省略時の値は、websocket を利用します。
	pre-shared-key		String	任意	ディスプレイ本体に設定された Pre-Shared キーの値を指定します。ディスプレイに Pre-Shared キーが設定されている場合のみ指定してください。
version			String	必須	本設定ファイルのバージョンを指定します。"1" を指定します。

config.txt のサンプル

以下に作成例を示します。

作成例 (1)
BRAVIA Signage Player は BRAVIA Signage Server に接続できない場合に、300 秒でタイムアウトし、エラーが画面が表示されます。

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

作成例 (2)
BRAVIA Signage Player は BRAVIA Signage Server と接続が切れても、エラー画面を表示せず、ダウンロードされたコンテンツとスケジュールで再生を続けます。

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

作成例 (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"
}