README

Sony BRAVIA

Node.js module for discovering and controlling Sony BRAVIA Android TVs. This module allows you retrieve all the available service protocol API methods and invoke any of them. All methods return a Promise.

Setup

TV Setup

Turn on your TV
On the TV go to Settings > Network > Home network setup > Remote device/Renderer > On
On the TV go to Settings > Network > Home network setup > IP Control > Authentication > Normal and Pre-Shared Key
On the TV go to Settings > Network > Home network setup > Remote device/Renderer > Simple IP Control > On

Optional:

On the TV go to Settings > Network > Home network setup > Remote device/Renderer > Enter Pre-Shared Key > 0000 (or whatever you want your PSK Key to be)

Install with NPM

sudo npm install @seydx/bravia@beta -g

Discovery

const Bravia = require('@seydx/bravia');
const bravia = new Bravia();

async function discover () {
  try {
    // Attempts to discover any Sony Bravia TVs.
    const devices = await bravia.discover();
    
    for (const device in devices) {
      console.log(devices[device]);
    }
  } catch (error) {
    console.error(error);    
  }
}

Authentication

Connect to TV via PSK

// Connects to a Bravia TV at 192.168.1.2:80 with the PSK 0000.
const Bravia = require('@seydx/bravia');

const bravia = new Bravia({host: '192.168.1.2', port: 80, psk: '0000'});

Connect to TV via PIN

To use the API with the PIN procedure, your credentials must first be created. Afterwards this credentials can be used to send further requests.

// Connects to a Bravia TV at 192.168.1.2:80 and create your credentials.
const Bravia = require('@seydx/bravia');

const name = 'MyTV'; // Default: '@seydx/bravia'
const bravia = new Bravia({name: name, host: '192.168.1.2', port: 80, pin: true});

async function example(){
  try {
    const credentials = await bravia.pair();
    console.log(credentials)
  } catch(error) {
    console.log(error);
  }
}

The PIN displayed on the TV must then be entered in the terminal. This will generate a credentials <Object> like this:

{
  name: 'MyTV',
  uuid: 'e9812807-d394-407c-b657-c89a98804e65',
  token: 'A0B9B9D7580466F22EE8F8EA148863774ACCE203',
  expires: 'Fr., 26 Apr. 2009 21:42:48 GMT+00:00'
}

With these credentials u can call the API without any authentication procedure

// Connects to a Bravia TV at 192.168.1.2:80 with Application Name and UUID.
const Bravia = require('@seydx/bravia');

const credentials = {
  name: 'MyTV',
  uuid: 'e9812807-d394-407c-b657-c89a98804e65',
  token: 'A0B9B9D7580466F22EE8F8EA148863774ACCE203',
  expires: 'Fr., 26 Apr. 2009 21:42:48 GMT+00:00'
}

const bravia = new Bravia({host: '192.168.1.2', port: 80, ...credentials});

Alternatively, the credentials can also be created using the built-in CLI. See #CLI

Usage

Service Protocol APIs

async function api(){
  try {
    // Retrieves all the system method types and versions.
    const methods = await bravia.describe();
    console.log(methods);
    
    // Retrieves all the available IRCC commands from the TV.
    const commands = await bravia.exec('system', 'getRemoteControllerInfo');
    console.log(commands);
    
    // Queries the volume info.
    const volume = await bravia.exec('audio', 'getVolumeInformation');
    console.log(volume);
    
    // Sets the speaker volume level to 50%.
    await bravia.exec('audio', 'setAudioVolume', '1.0', { target: 'speaker', volume: '50' });
  } catch(error) {
    console.log(error);
  }
}

Send IRCC Code

async function ircc(){
  try {
    // Retrieves all the available IRCC commands from the TV.
    const commands = await bravia.getIRCCCodes();
    
    // Sends an IRCC code signal by name.
    await bravia.execCommand('Mute');
    
    // Sends an IRCC code signal by value.
    await bravia.execCommand('AAAAAQAAAAEAAAAUAw==');
    
    // Sends multiple IRCC code signals by name and/or value. Change delay to alter time between each command sent.
    const delay = 350 //in milliseconds (Default: 350)
    
    await bravia.execCommand(['Hdmi1', 'AAAAAgAAABoAAABaAw==', 'Hdmi2', 'AAAAAgAAABoAAABbAw=='], delay);
  } catch(error) {
    console.log(error);
  }
}

Turn on TV

The TV can easily be switched on via "Wake on LAN" or directly through the API. For WOL you need to enable WOL under TV settings.

Note: Only the screen from TVs in "PRO" mode can be switched ON with Wake-on-LAN. If your TV is in "NORMAL" mode and in standby, you need to enable the Rest API with WOL to perform API calls.

More info: https://pro-bravia.sony.net/develop/integrate/ip-control/index.html#wake-on-lan

async function turnOnTV(){
  try {
    // Optional (Default values)
    const options = {
      subnet: '255.255.255.255',
      num_packets: 10,
      interval: 100
    }

    // Turn on TV through Wake on LAN (WOL)
    await bravia.wake('33:7F:62:9F:7B:70', options)
    
    // Turn on TV through API
    await bravia.exec('system', 'setPowerStatus', '1.0', { status: true })
  } catch(error) {
    console.log(error);
  }
}

Command line tool

The bravia cli support following commands:

pair <host> -p -n: Pair with a Bravia TV or refresh existing token (PIN Authentication)
- <host> (required): Bravia TV ip address.
- -p, --port (optional): Bravia TV port (Default: 80)
- -n, --name (optional): Custom name (Used for PIN Authentication, Default: '@seydx/bravia')
methods <host> -p: Retrieves all the system method types and versions
- <host> (required): Bravia TV ip address.
- -p, --port (optional): Bravia TV port (Default: 80)
exec <host> <protocol> <service> <version> <command> -p -n: Execute API call
- <host> (required): Bravia TV ip address.
- <protocol> (required): API Protocol (Endpoint)
- <service> (required): API Service
- <version> (optional): API Service Version (Default: '1.0')
- <command> (optional): API Command (Default: {})
- -p, --port (optional): Bravia TV port (Default: 80)
- -n, --name (optional): Custom name (Used for PIN Authentication, Default: '@seydx/bravia')
- --psk (optional): Pre-Shared Key (if not set, PIN authentication will be used)
discover: Discover alls your TVs in network

Example usage for PIN Authentication

bravia pair 192.168.178.55 -p 80 -n MyTv