Sony Bravia IP (2014-Present)

This driver is for the Sony Bravia KDL/XBR series televisions using Ethernet connectivity.

Special System Update Notes (Please read and understand before proceeding)

It is has been recommended by Sony that System Updates and Google Play Store updates are set to automatic. When updates are set to automatic, there are occasions where the end user will have to acknowledge and/or decline notification pop-up messages using the Cursor Key and Confirm commands in order to operate the TV beyond the notification. There is no way to automate the notification acknowledgements as not all notifications require the same control input for the notification to close.

RTI is NOT responsible for any burden that may impact the end user due to the notifications imposed by the Sony TV and RTI recommends that the Cursor Key and Confirm commands are readily available if the Sony TV remote is not available in order for the notification messages to be closed.

It is the responsibility of RTI dealer/integrator that this information be provided to the end user, and to show the end user how to exit out of any notifications imposed by the TV.

Tested Models and Firmware Versions

A Sony KDL-40W600B television with a software version of PKG2.303AAA was used during the initial development of this driver, but has not been thoroughly tested since the initial release.

Version 1.31 was tested with:

Model: XBR-55X850C

SW Version: PKG3.865.0136NAB

SVP4KDTV15_UC-user 6.0.1 MMB29V.S31 3.865 release-keys

Model: XBR-75X850C

SW Version: PKG3.865.0136NAB

SVP4KDTV15_UC-user 6.0.1 MMB29V.S31 3.865 release-keys

Model: XBR-55X850D

SW Version: PKG3.865.0136NAB

SVP4KDTV15_UC-user 6.01 MMB29V.S31 3.865 release-keys

Version 1.35 was tested with Version 9 firmware.

Model: FW-55BZ40H

Kernel Version: 4.9.125

BRAVIA_VH1_BB-user 9 PTT1.190515.001.S34 601441

- Special Notice - When updating the driver to version 1.31, the driver should attempt to re-authorize. If the driver does not re-authorize, it is recommended that the authorization be removed from the TV and a new authorization should be set up.

The location to manage registered devices on the TV is - Settings/Network/Home network/Remote device/Renderer/Registered devices.

Driver Compatibility

Sony KDL models after 2015 WILL NOT WORK with this driver!

Below are a known list of TV models that will and will not work with this driver. The general compatibility rule that applies for this driver is the TV must be an Android TV model with Ethernet.

If you are unsure whether a model is compatible or cannot get this driver working with a specific model, please try the Sony Simple IP driver available in the Driver Store on the RTI website at:

https://www.rticorp.com/dealer/driverstore

Models Supporting IP Control via this driver:

KDL-##(W)###(B) – works (2014 model)

KDL-##(W)###(C) – works (2015 model)

XBR-##(X)###(B-F) - works (2014-2018 models)

FW models are the European equivalent to the XBR models and are supported.

Models that DO NOT Support IP Control via this driver:

KDL-##(W)###(D) - do not work (2016 models)

KDL-##(R)###(B/C) – do not work (r series)

XBR-##(X)###(A) – do not work (2013 models)

Sony KDL models after 2015 WILL NOT WORK with this driver!

Displays supporting Version 9 Android TV or greater are supported.

Revision History
1.0 The Initial release of the driver.

1.1 Added Model/Year selection to driver.

Added compatible authorization routine for 2015 models.

Expanded Input acquisition and selection routines to cover HDMI inputs that may contain MHL or ARC appendices.

Adjusted IR Emulation code for compatibility with X8xxC models.

Added Refresh Authorization command.

1.2 Adjusted driver for use with displays that have no tuner connectivity or setup.

Adjustments for displays that may not report source information correctly.

Added enable/disable application capabilities/access through driver.

Adjustments for UDP Wake On LAN control using multiple driver instances.

Removed Pre-2014 selection from Model/Year configuration item.

Added Application Favorites capabilities.

Added an auto power on feature when a source or application favorite is selected.

Adjusted the event and variable for Unavailable to Application/Unavailable.

Automated Network Mask acquisition during driver initialization for 2014 models.

Updated sample file to include new features.

1.23 Added extra XPDiagnostics prints for Commands Sent at High Level setting.

Added extra XPDiagnostics prints for Responses at High Level setting.

Adjusted driver for when command indexing gets out of order.

Adjusted driver to ignore unsupported schemes during initialization for European model TVs.

Automated Refresh Authorization if a forbidden response is received while issuing a Power On.

Adjusted polling routine so authorization keypad visibility stays active until 60 second timeout occurs.

1.24 Adjusted Model/Year configuration setting to Power Up Settings.

Added WOL and Power On selection for Power Up Settings.

Adjusted routine for acquiring channel list information.

Removed extra XPDiagnostics prints from version 1.23 for improved performance if log is left on high level.

Adjusted command indexing for improved reliability.

1.25 Adjusted IR Emulation Enter command.

1.26 Reverted IR Emulation Enter command back to documented value.

Added IR Emulation Version configuration.

Adjusted netmask and WOL/broadcast routines for compatibility when WOL is required.

1.27 Defaulted Power Up Type to Power On Only because most TVs use this setting when setup properly.

Changed name of driver to Sony Bravia IP.

Updated Compatibility information and moved it to the top of the Get Info file.

1.29 Adjust cookie management to prevent null cookies from being stored.

1.30 Additional debugging code added for loss of control due to authorization issues.

1.31 Adjusted re-authorization routine when TV is powered off.

Added Daily Auto Refresh Authorization event with configurable 24 Hour Time.

1.32 Added Room Volume capabilities for ID APEX.

Defaulted Power Up Type to Power On Only when adding the driver to the system.

Adjusted Confirm function to Confirm/OK/Enter.

Removed IR Emulation - Numerics Enter function.

1.33 Adds additional parsing for HDMI inputs appended with (eARC/ARC).

Added APEX sample file.

1.34 Adds additional parsing for HDMI inputs that are 4k and/or 8k.

1.35 Adds additional parsing for more inputs that are available on 4k and/or 8k models.

Fixed variable booleans for Mute and Power so they properly show reversed state.

Tested driver with a Sony FW-55BZ40H display.

Power Up Type Settings

Power Up Type - Select the type of power on routine to use for the TV.

- WOL and Power On - entirely new setting that will issue the WOL packet followed by the power on command once the TV CPU is powered up (from suspend to sleep state).

- WOL Only - same as the previous 2014 mode setting

- Power On Only - same as the previous 2015 mode setting

It has been found that different model TVs from the same year/series may require different Power Up Type settings. It is recommended that the TV to be used is tested and verified for reliability before deployment.

Auto Refresh Authorization Settings

Auto Refresh Authorization Time - Enter the time of day the authorization should be refreshed. Formatting for the time MUST be in 24 hour format using HH:MM. The TV does not need to be on at the time of the authorization refresh, so it is recommended but not necessary to use a time where it is unlikely that the TV will be in use.

Note - The driver will print an error to XPDiagnostics if a valid cookie is not received, otherwise it will print to the low log level when the cookie changes and on the hour whether it has changed or not.

IR Emulation Settings

IR Emulation Version - Select the IR Emulation Version.

- Standard (C series and greater) - use for any model TV made from 2015 (C Series) and beyond.

- Old (B series) - use for TVs made in 2014 (B Series).

Connection Settings

Connection Type - Network (TCP) only.

TCP Address - Enter the IP Address assigned to the Sony Bravia KDL/XBR series television. It is recommended the television be set to a static IP via the Internet Setup menu of the television or by setting a MAC reservation in the network router.

TCP Port - The TCP port which the driver communicates with the Sony Bravia KDL/XBR series television. 80 is the default setting.

WOL Settings

MAC Address - Enter the MAC address of the Sony Bravia KDL/XBR series television. This setting is used for WOL/Power On operations. If this setting is incorrect, the television will not be able to be powered on using the Power On or Power Toggle driver commands.

Applications

Application State - Enable or disable driver access to online applications. When disabled, the driver will not acquire the applications and put them into a list for access from the user interface. The applications can still be accessed through the on screen home menu of the TV.

Applications Notes - Acquiring the application list will cause higher than normal CPU/Memory usage on the XP processor as there is currently no way to ask for the application list in stages. The default configuration of the Application State is set to Disabled in order to prevent systems from inadvertently acquiring the application list when not required.

If access to the applications through the applications list or application favorites is required, processor load balancing may be required.

Application Favorites (only available when Application State is enabled)

Force at Reboot - Enable or disable forcing configuration favorites. When enabled the driver will override any user stored presets upon reboot/initialization and replace them with the favorites entered in the driver configuration.

Favorite (1-10) - Enter the name of the application to be used for the specified favorite. The name in this field must match exactly with the name that shows up in the Applications List or in parenthesis of the Acquired Application printout in XPDiagnostics when set to low log level.

Example - Acquired Application (PlayStation Video) but could not match it with any App Favorites

In the Example, "PlayStation Video" (without quotes) would be the text that could be entered into a favorite field.

If all favorite fields are left blank and the Force at Reboot is disabled, the favorites can be stored on the fly by selecting and launching an application from the Application list, then by using the Save Favorite Application driver command, the favorite can be stored to the specified favorite. This selection is also stored into persistent memory for the specified favorite so that it can be recalled after a system reboot (with Force at Reboot disabled).

The driver will also update the favorite image and URL when a favorite is stored.

Favorites can be overwritten on the fly by repeating the selection from the list and the Save Favorite Application process.

Television Settings - pre version 9

The settings on the Sony Bravia KDL/XBR should be set as such for proper operation with the driver.

If not using MAC Address reservations in the router, the IP address should be set statically in the

Home\Settings\Network\Network Setup\Set up network connection\Expert\Wi-Fi Setup or Wired Setup menu of the television.

Home\Settings\Network\Home Network Setup\Remote Start = On

Home\Settings\Network\Home Network Setup\IP Control\Authentication = Normal

*Home\Settings\Network\Home Network Setup\IP Control\Simple IP Control = Off

External Inputs\Bravia sync settings\Bravia sync control = Off

External Inputs\Bravia sync settings\Device auto power off = Off

External Inputs\Bravia sync settings\TV auto power on = Off

Power/Eco/Power saving = Off

Power/Eco/Auto shut-off = Off

About/System update/Automatic software download = On

* It has been noted that some model TVs require Simple IP Control be turned on for IR Emulation to work. This issue is model specific and may not be required to be set to on.

** It has been noted that some model TVs may require the RS-232C control setting be set to Via serial port in order to prevent the TV from going into a deep sleep to where Power On commands no longer work even in instances using WOL.

Television Settings - version 9 or greater

Settings\Network & Internet\Remote start = On

Settings\Network & Internet\Remote device settings = On

Settings\Network & Internet\Home network setup\Renderer\Renderer function = On

Settings\Network & Internet\Home network setup\Renderer\Renderer access control\Automatic access permission = On

Settings\Network & Internet\Home network setup\IP control\Authentication = Normal

Settings\Network & Internet\Home network setup\IP control\Simple IP control = On

Settings\Network & Internet\Home network setup\IP control\Control4 = Off

Settings\Device Preferences\About\System software update\Automatically check for update = On

Driver Notes

- Macros with Select Source or Select Favorite commands MUST NOT contain the power on command from this driver. If the TV is off and a Select Source or Select Favorite function is executed, the driver will automatically issue a power on. The TV may not report the proper power status to the driver if it is issued a second power command during the warmup process.

- This driver only supports Ethernet control of the Sony Bravia KDL/XBR series television.

- If the driver shows as disconnected anytime the TV is shut down, the Power Up Type setting will likely need to be set to either the WOL Only setting or the WOL and Power On setting. If the WOL Only setting turns on the TV, then the WOL Only selection is correct. If the WOL Only setting does not turn the TV on, the WOL and Power On setting should be used.

- If the driver shows as connected even when the TV is turned off for extended periods of time, the Power On Only setting should be used. The WOL and Power On setting will work, but may cause delays in the powering on process of the TV.

- The driver must be authorized with the television in order for it to operate. If the driver is not authorized upon a power on of the television, the driver will force the television to start the authorization process. The authorization must be entered through the driver by use of the Authorization Keypad driver commands and variables. Please see include sample file/template for an example of how the authorization keypad should be setup. Authorization status is stored into persistent memory. If the authorization needs to be removed, it must be done through the television Network Settings menu.

- The driver initialization is executed the first time the television is powered on, authorized, and the WOL status has been activated. If already authorized, the initialization will execute after the television has been powered on and the WOL status has been activated.

- If the driver enters a disconnected state at any time, it will trigger a re-initialization of the driver the next time the TV is turned on or the connection is re-established. With TVs that enter a disconnected state any time the TV is turned off, the initialization routine will be re-activated.

- If the Application State is enabled, the driver will attempt to acquire the applications available on the television when the initialization routine is executed.

- There may be times when all supported applications are not available and a rescan of the applications is necessary. In cases as such, the television must first be scanned through its own menu system, at which point the Update Application List may be executed from the driver in order to acquire the application list changes.

- The driver will attempt to acquire the channel line up from the built in television tuner. If a channel scan is performed after the driver initializes the Update Channel List command may need to be executed in order to properly display the available channels in the channel list.

- A delayed command stack is written in the driver so that Set Volume, Mute, Select Source, and Select Favorite Application commands can be executed after the television reports it is powered on and the driver has finished any maintenance routines.

- If the driver is not authorized, the command stack will be disabled until the driver is authorized with the television.

- Selecting a source or favorite application while the TV is powered off will automatically issue a power on and put the source or favorite application into the delayed queue.

- IR Emulation, Channel, and Application specific commands are not available for use in the delayed command stack and will be ignored.

- The Refresh Authorization command is intended for use on the occasion a project file has been replaced with another, but the authorization was not removed from the TV. Many times in these instances the control system is still authorized with the TV, but the driver’s authorization flag is out of sync since it may have been cleared with the uploading of a different project file to the processor.

APEX Template Notes

This driver uses the "Cable/Satellite TV" template.