homebridge/platforms/Sonos.js

var types = require("hap-nodejs/accessories/types.js");
var sonos = require('sonos');

function SonosPlatform(log, config){
    this.log = log;
    this.config = config;
    this.name = config["name"];
    this.playVolume = config["play_volume"];
    // timeout for device discovery
    this.discoveryTimeout = (config.deviceDiscoveryTimeout || 10)*1000; // assume 10sec as a default
}

SonosPlatform.prototype = {
    accessories: function(callback) {
        this.log("Fetching Sonos devices.");
        var that = this;
        
        // track found devices so we don't add duplicates
        var roomNamesFound = {};
        
        // collector array for the devices from callbacks
        var devicesFound = [];
        // tell the sonos callbacks if timeout already occured
        var timeout = false;
        
        // the timeout event will push the accessories back
        setTimeout(function(){
            timeout=true;
            callback(devicesFound);
        }, this.discoveryTimeout);
        
        
        sonos.search(function (device) {
            that.log("Found device at " + device.host);

            device.deviceDescription(function (err, description) {
                if (description["zoneType"] != '11' && description["zoneType"] != '8' && description["zoneType"] != '4') { // 8 is the Sonos SUB, 4 is the Sonos Bridge
                    var roomName = description["roomName"];
                    
                    if (!roomNamesFound[roomName]) {
                        roomNamesFound[roomName] = true;
                        that.log("Found playable device - " + roomName);
                        if (timeout) {
                            that.log("Ignored: Discovered after timeout (Set deviceDiscoveryTimeout parameter in Sonos section of config.json)");
                        }
                        // device is an instance of sonos.Sonos
                        var accessory = new SonosAccessory(that.log, that.config, device, description);
                        // add it to the collector array
                        devicesFound.push(accessory);
                    }
                    else {
                        that.log("Ignoring playable device with duplicate room name - " + roomName);
                    }
                }
            });
        });
    }
};

function SonosAccessory(log, config, device, description) {
    this.log = log;
    this.config = config;
    this.device = device;
    this.description = description;
    
    this.name = this.description["roomName"] + " " + this.config["name"];
    this.serviceName = this.description["roomName"] + " Speakers";
    this.playVolume = this.config["play_volume"];
}

SonosAccessory.prototype = {

    setPlaying: function(playing) {

        if (!this.device) {
            this.log("No device found (yet?)");
            return;
        }

        var that = this;

        if (playing) {
            this.device.play(function(err, success) {
                that.log("Playback attempt with success: " + success);
            });

            if (this.playVolume) {
                this.device.setVolume(this.playVolume, function(err, success) {
                    if (!err) {
                        that.log("Set volume to " + that.playVolume);
                    }
                    else {
                        that.log("Problem setting volume: " + err);
                    }
                });
            }
        }
        else {
            this.device.stop(function(err, success) {
                that.log("Stop attempt with success: " + success);
            });
        }
    },

    getServices: function() {
        var that = this;
        return [{
            sType: types.ACCESSORY_INFORMATION_STYPE,
            characteristics: [{
                cType: types.NAME_CTYPE,
                onUpdate: null,
                perms: ["pr"],
                format: "string",
                initialValue: this.name,
                supportEvents: false,
                supportBonjour: false,
                manfDescription: "Name of the accessory",
                designedMaxLength: 255
            },{
                cType: types.MANUFACTURER_CTYPE,
                onUpdate: null,
                perms: ["pr"],
                format: "string",
                initialValue: "Sonos",
                supportEvents: false,
                supportBonjour: false,
                manfDescription: "Manufacturer",
                designedMaxLength: 255
            },{
                cType: types.MODEL_CTYPE,
                onUpdate: null,
                perms: ["pr"],
                format: "string",
                initialValue: "Rev-1",
                supportEvents: false,
                supportBonjour: false,
                manfDescription: "Model",
                designedMaxLength: 255
            },{
                cType: types.SERIAL_NUMBER_CTYPE,
                onUpdate: null,
                perms: ["pr"],
                format: "string",
                initialValue: "A1S2NASF88EW",
                supportEvents: false,
                supportBonjour: false,
                manfDescription: "SN",
                designedMaxLength: 255
            },{
                cType: types.IDENTIFY_CTYPE,
                onUpdate: null,
                perms: ["pw"],
                format: "bool",
                initialValue: false,
                supportEvents: false,
                supportBonjour: false,
                manfDescription: "Identify Accessory",
                designedMaxLength: 1
            }]
        },{
            sType: types.SWITCH_STYPE,
            characteristics: [{
                cType: types.NAME_CTYPE,
                onUpdate: null,
                perms: ["pr"],
                format: "string",
                initialValue: this.serviceName,
                supportEvents: false,
                supportBonjour: false,
                manfDescription: "Name of service",
                designedMaxLength: 255
            },{
                cType: types.POWER_STATE_CTYPE,
                onUpdate: function(value) { that.setPlaying(value); },
                perms: ["pw","pr","ev"],
                format: "bool",
                initialValue: false,
                supportEvents: false,
                supportBonjour: false,
                manfDescription: "Change the playback state of the sonos",
                designedMaxLength: 1
            }]
        }];
    }
};

module.exports.accessory = SonosAccessory;
module.exports.platform = SonosPlatform;