@seydx/bravia

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 -g

Discovery

const Bravia = require('bravia');

// The time in seconds for the bravia discovery to scan for.
let timeout = 5;

async function example () {

  try {
  
    // Attempts to discover any Sony Bravia TVs.
    const devices = await Bravia.discover(timeout);
    
    for (let 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.
let 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.
let bravia = new Bravia({host: '192.168.1.2', port: 80, pin: true});

async function example(){

  try {
  
    // Generate credentials
    const credentials = await bravia.pair({name: 'MyTV'});
    
    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.
let bravia = new Bravia({host: '192.168.1.2', port: 80, name: 'MyTV', uuid: 'e9812807-d394-407c-b657-c89a98804e65'});

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

Command line tool

Alternatively you can create the credentials via the built-in CLI.

The bravia cli support following command:

• pair: Pair with an Bravia TV

The bravia cli support following arguments:

• <host>: The address of your Bravia TV

The bravia cli support following options:

• -n, --name: Name for the app (Default Bravia)
• -p, --port: The port of your Bravia TV (Default: 80)
• -t, --timeout: The amount of time (in seconds) to wait for the response (Default 5s)

Example usage:

bravia pair 192.168.178.55 -p 80 -n MyTv -t 5

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

name:  MyTv
uuid:  20879d92-1234-4ba3-a4ce-9a8444c71fa7
token: FD53E55779F964702178CDEBF71E3BA51A6D3A5D
expires: Fr., 26 Apr. 2009 21:42:48 GMT+00:00

Usage

Service Protocol APIs

async function example(){

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

}

If you want to execute a command and make sure that the TV is on so that the command to be executed can work, you can use:

async function example(){

  try {
    
    let turnOn = true;
    
    // Sets the speaker volume level to 50%.
    await bravia.audio.invoke('setAudioVolume', '1.0', { target: 'speaker', volume: '50' }, turnOn);
    
  } catch(error) {
  
    console.log(error);
  
  }

}

Send IRCC Code

async function example(){

  try {
  
    // Retrieves all the available IRCC commands from the TV.
    const commands = await bravia.getIRCCCodes();
    
    // Sends an IRCC code signal by name.
    await bravia.send('Mute');
    
    // Sends an IRCC code signal by value.
    await bravia.send('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.send(['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.

async function example(){

  try {
  
    // Optional (Default values)
    const options = {
      address: '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, true)
    
    // Turn on TV through API
    await bravia.wake()
    
  } catch(error) {
  
    console.log(error);
  
  }

}