homebridge-freeathome-local-kdljns/src/accessories/BuschJaegerAccessory.js

Platform Plugin to manage free@home accessories via HomeBridge using local API

/**
 * BuschJaegerAccessory
 */

var Service, Characteristic, BuschJaegerApPlatform;

function BuschJaegerAccessory(platform, Service, Characteristic, actuator, channel = null, mapping = null) {
    this.platform = platform;
    this.actuator = actuator;

    this.serial = actuator['serialNumber'];
    this.typeId = actuator['deviceId'];

    this.channel = channel ? this.removeChannelPrefix(channel) : null;

    if (this.channel) {
        this.uuid_base = this.serial + 'ch' + this.channel;
    } else {
        this.channel = '0000'
        this.uuid_base = this.serial;
    }

    this.model = actuator['typeName'] + ' (ch' + this.channel + ', ' + this.typeId + ')';
    this.name = this.getChannelAttribute("displayName");

    if (!this.name) {
        this.name = this.model
    }

    this.pendingUpdates = [];

    this.mapping = null;

    this.platform.log('initialising actuator ' + this.name + ' with uuid ' + this.uuid_base);

    this.services = {}

    this.Characteristic = Characteristic;
    this.hapService = Service;

    var informationService = new Service.AccessoryInformation();

    informationService
        .setCharacteristic(Characteristic.Manufacturer, "Busch-Jaeger")
        .setCharacteristic(Characteristic.Model, this.model)
        .setCharacteristic(Characteristic.Name, this.name)
        .setCharacteristic(Characteristic.SerialNumber, this.serial);

    this.services.information = informationService;

    if (this.platform.updateInterval && this.platform.updateInterval > 0) {
        this.interval = this.platform.updateInterval;
    }

}

BuschJaegerAccessory.prototype = {
    getServices: function() {
        return Object.keys(this.services).map(function(key) {
            return this.services[key];
        }.bind(this))
    },

    getValue: function(channelNo, datapoint) {
        let channel = 'ch' + channelNo;

        if (channel in this.platform.actuatorInfo[this.serial]['channels']) {
            let ach = this.platform.actuatorInfo[this.serial]['channels'][channel]
            if(ach['datapoints'] && datapoint in ach['datapoints']) {
                return ach['datapoints'][datapoint];
            }else
            if(ach['outputs'] && datapoint in ach['outputs']) {
                return ach['outputs'][datapoint].value;
            }else
            if(ach['inputs'] && datapoint in ach['inputs']) {
                return ach['inputs'][datapoint].value;
            }
           
        }
        
        return null;
    },

    setValue: function(channelNo, datapoint, value = null) {
        let channel = 'ch' + channelNo;

        this.platform.setDatapoint(this.serial, channel, datapoint, value);
    },

    update: function(channel = null, datapoint, value = null) {
        this.platform.log('Updating accessory *' + this.name + '* with uuid ' + this.uuid_base + "/" +datapoint + "/" + value.value);

        this.processPendingUpdates(channel, datapoint, value);

        this.updateCharacteristics();
    },

    removeChannelPrefix: function(channel) {
        return channel.replace('ch','');
    },

    waitForUpdate: function(callback, channel, datapoint, value = null, timeout = 5) {
        var self = this
        this.pendingUpdates.push({
            'channel': channel,
            'datapoint': datapoint,
            'value': value,
            'callback': callback,
            'persist': timeout == -1
        });

        if (timeout > 0) {
            setTimeout(function () {
                // We don't need the timeout on local API, in the future a reinit of any disconnected WS session might be more stable
                if(!self.platform.config.isLocalAPI) {
                    self.processPendingUpdates(channel, datapoint, value, true);
                }
            }, timeout * 1000);
        }
    },

    processPendingUpdates: function(channel, datapoint, value = null, error = false) {
        for (let i = 0; i < this.pendingUpdates.length; i++) {
            let update = this.pendingUpdates[i];
            if ((update['channel'] && update['channel'] == channel) || (update['channel'] === null && channel === null)) {
                if (update['datapoint'] == datapoint) {
                    if (update['value'] === null || update['value'] == value) {
                        if (!update['persist']) {
                            this.pendingUpdates.splice(i, 1);
                        }

                        if (error) {
                            update['callback']("SysAp did not respond in time...");
                            this.platform.log("SysAp did not respond in time: " + [channel, datapoint, value].join('/'));
                            this.platform.log("If this issue persists please try to login as the API user in the free@home UI. The SysAp might disable websocket notifications if the connection is idle for too long.");
                            this.platform.log("See: https://github.com/henry-spanka/homebridge-freeathome#tips--tricks");
                        } else {
                            update['callback'](null, value);
                        }
                    } else {
                        continue;
                    }
                }
            }
        }
    },

    getChannelAttribute: function(attribute) {
        if ('channels' in this.actuator && ("ch" + this.channel) in this.actuator['channels']) {
            return this.actuator['channels']["ch" + this.channel][attribute];
        } else {
            return undefined;
        }
    }

}

module.exports = {
    BuschJaegerAccessory: BuschJaegerAccessory
}