Overview

Estimated reading time: 5 minutes

This part provides a first step in utilizing IP control functions mainly for solution providers and engineers to develop their own systems with BRAVIA Professional Display.

The BRAVIA Professional Display platform provides IP control functions that enable users to utilize many display functions like input source change via IP. The both of HTML5 Web Applications and Android APK Applications on BRAVIA Professional Display can send IP Control commands to BRAVIA Professional Display(s), and IP-enabled external devices also can do it.

Supported Protocols

The BRAVIA Professional Display platform supports the following Sony’s original IP control protocols in accordance with various purposes.

Protocols OSI Layer Format Auth Description
REST API HTTP JSON-RPC Yes It can send commands via IP to control BRAVIA Professional Display. It’s general for web developers and easy to use, then it is used in many use cases.
IRCC-IP HTTP SOAP Yes “IRCC-IP” means “InfraRed Compatible Control over Internet Protocol”. It can send command codes of IR remote commander via IP.
Simple IP control TCP Fixed-size Byte Stream N/A It supports only typical functions. All commands defined in it are available in REST API or IRCC-IP.

What you can do with IP control

  • Fundamental/Advanced functions can be executed via IP
Function REST API IRCC-IP Simple IP control
Input change/channel change setPlayContent N/A setInput
Audio volume control setAudioMute/setAudioVolume N/A setAudioMute/setAudioVolume
Setting configuration setSceneSetting N/A setSceneSetting
IR remote command emulation N/A YES YES
Power state monitoring/management getPowerStatus/setPowerStatus N/A getPowerStatus/setPowerStatus
Launch/Terminate application setActiveApp/terminateApps N/A N/A

and more

  • Multiple device control [REST API] [IRCC-IP]
    • You can select target BRAVIAs by managing the IP addresses.
  • Authentication [REST API] [IRCC-IP]
    • You can prohibit unexpected commands with the authentication mechanism.
  • Combination with your HTML5/Android application [REST API] [IRCC-IP]
    • You can assign any commands to the custom layout button of your application.
    • You can send any commands through your application via local network.
  • All functions are enabled by Web Standard Technology with the exception of command definition itself.

TIPS:

How to check IP Address of BRAVIA Professional Display

  1. [HOME] Settings
  2. Network
  3. Advanced settings
  4. Network status
  5. IP address

IP Control Authentication

For security reasons, authentication is required for REST API and IRCC-IP.

Settings on BRAVIA Professional Display:

  1. Authentication method

    1. [HOME] Settings
    2. Network
    3. Home network setup
    4. IP control
    5. Authentication
    • None[1]: No authentication is required to access BRAVIA
    • Normal: A PIN-based authentication is required to access to BRAVIA
    • Pre-Shared Key[1]: A fixed secret string based authentication is required to access BRAVIA
    • Normal and Pre-Shared Key: Either a PIN based authentication or a fixed string authentication is required to access BRAVIA

    [1] These options are only available in Pro settings mode.

    Normally “Pre-Shared Key” is used for BRAVIA professional use, or “None” for managed network.

  2. Pre-Shared Key (This setting is only available when Authentication method is “Pre-Shared Key” or “Normal and Pre-Shared Key”)

    1. [HOME] Settings
    2. Network
    3. Home network setup
    4. IP control
    5. Pre-Shared Key

    Pre-Shared Key is User-defined secret key used for access control of IP control function. Any Pre-Shared Key string is acceptable.

  3. Enable remote device control

    1. [HOME] Settings
    2. Network
    3. Home network setup
    4. Renderer
    5. Renderer function
    6. Enable
    [Default: Enable]

Settings on client side:

The Pre-Shared Key string which you input into BRAVIA Professional Display has to be added to the HTTP Request header of REST API and IRCC-IP by using the X-Auth-PSK custom header.

X-Auth-PSK: [Pre-Shared Key]

See the details for HTTP request and response:

Wake-on-LAN

BRAVIA Professional Display supports Wake-on-LAN (WoL). When it is in standby mode, it can’t receive REST API nor IRCC-IP commands because the HTTP server is not running. Then if you want to use it, you have to turn on it first by using Wake-on-LAN.

  • Send the WoL magic packet several times until REST API/IRCC-IP is enabled.
  • In “Normal mode”, you need to call the setPowerStatus REST API to turn the BRAVIA Professional Display on after REST API is available because the BRAVIA Professional Display does NOT switch to the “Screen On” state automatically with the Wake-on-LAN.
  • In “Pro mode”, the BRAVIA Professional Display will switch to the “Screen On” state automatically with the Wake-on-LAN, but you need to send the WoL magic packet several times until REST API is enabled.

You can retrieve the MAC address by calling the getSystemInformation REST API so that you can prepare the Wake-on-LAN magic packet dynamically.

The Wake-on-LAN is disabled by default. It’s necessary to enable it if you want to use it.

    1. [Home] Settings
    2. Network
    3. Remote start
    'On' [Default: Off]
  • or REST API: setWolMode
Last modified: 6 Feb 2019