homebridge-mqtt-blinds-tasmota/index.js

A homebridge plugin to control tasmota blinds via mqtt

var mqtt = require("mqtt");
var Service, Characteristic;

module.exports = function(homebridge) {
	Service = homebridge.hap.Service;
	Characteristic = homebridge.hap.Characteristic;

	homebridge.registerAccessory("homebridge-mqtt-blinds-tasmota", "mqtt-blinds-tasmota", MqttBlindsTasmotaAccessory);
}

function MqttBlindsTasmotaAccessory(log, config) {
	// GLOBAL vars
	this.log = log;

	// CONFIG vars
	this.name = config["name"];
	this.manufacturer = config['manufacturer'] || "";
	this.model = config['model'] || "";
	this.serialNumberMAC = config['serialNumberMAC'] || "";

	// MQTT vars
	this.mqttUrl = config["mqttBrokerUrl"];
	this.mqttUsername = config["mqttUsername"];
	this.mqttPassword = config["mqttPassword"];
	this.mqttClientId = 'mqttjs_' + Math.random().toString(16).substr(2, 8);

	// Tasmota vars
	this.mqttTopic = config["mqttTopic"];
	this.mqttShutterIndex = config["mqttShutterIndex"] || "1";
	this.mqttResultTopic = config["mqttResultTopic"] || 'stat/' + this.mqttTopic + '/RESULT';
	this.mqttCommandTopic = config["mqttCommandTopic"] || 'cmnd/' + this.mqttTopic + '/ShutterPosition' + this.mqttShutterIndex;
	this.mqttTeleTopic = config["mqttTeleTopic"] || 'tele/' + this.mqttTopic + '/SENSOR';
	this.mqttShutterName = config["mqttShutterName"]  || "Shutter" + this.mqttShutterIndex;

	// MQTT options
	this.mqttOptions = {
		keepalive: 10,
		clientId: this.mqttClientId,
		protocolId: 'MQTT',
		protocolVersion: 4,
		clean: true,
		reconnectPeriod: 1000,
		connectTimeout: 30 * 1000,
		username: this.mqttUsername,
		password: this.mqttPassword,
		rejectUnauthorized: false
	};

	// STATE vars
	this.lastPosition = 100; // last known position of the blinds (open)
	this.currentPositionState = 2; // stopped by default
	this.currentTargetPosition = this.lastPosition; // same as last known position

	// MQTT handling
	this.mqttClient = mqtt.connect(this.mqttUrl, this.mqttOptions);
	var that = this;
	this.mqttClient.on('error', function() {
		that.log('Error event on MQTT');
	});

	this.mqttClient.on('connect', function() {
		that.log('MQTT is running');
	});

	this.mqttClient.on('message', function(topic, message) {

		// this callback can be called from both the STAT topic and the TELE topic
		// JSON format is nearly the same, eg:
		//  - TELE : {"Time":"2020-09-12T13:55:32","Shutter1":{"Position":0,"Direction":0,"Target":0},"Shutter2":{"Position":0,"Direction":0,"Target":0}}
		//  - STAT : {"Shutter2":{"Position":100,"Direction":0,"Target":100}}
		message = JSON.parse(message.toString('utf-8'));
		if (message.hasOwnProperty(that.mqttShutterName)) {

			if (message[that.mqttShutterName].hasOwnProperty('Position')) {
				// update CurrentPosition
				that.lastPosition = parseInt(message[that.mqttShutterName]["Position"]);
				that.service.getCharacteristic(Characteristic.CurrentPosition).updateValue(that.lastPosition);
				that.log("Updated CurrentPosition: %s", that.lastPosition);
			}

			if (message[that.mqttShutterName].hasOwnProperty('Direction')) {
				// update PositionState (open = 0 = DECREASING, close = 1 = INCREASING, stop = 2 = STOPPED)
				switch(parseInt(message[that.mqttShutterName]["Direction"])) {
					case -1:
						that.currentPositionState = 0
						that.service.getCharacteristic(Characteristic.PositionState).updateValue(that.currentPositionState);
						that.log("Updated PositionState: %s", that.currentPositionState);
						break
					case 1:
						that.currentPositionState = 1
						that.service.getCharacteristic(Characteristic.PositionState).updateValue(that.currentPositionState);
						that.log("Updated PositionState: %s", that.currentPositionState);
						break
					case 0:
						that.currentPositionState = 2
						that.service.getCharacteristic(Characteristic.PositionState).updateValue(that.currentPositionState);
						that.log("Updated PositionState: %s", that.currentPositionState);
						break
					default:
						that.log("Unknown direction: %s", direction);
				}
			}

			if (message[that.mqttShutterName].hasOwnProperty('Target')) {
				// update TargetPosition
				that.currentTargetPosition = parseInt(message[that.mqttShutterName]["Target"])
				that.service.getCharacteristic(Characteristic.TargetPosition).updateValue(that.currentTargetPosition);
				that.log("Updated TargetPosition: %s", that.currentTargetPosition);
			}
		}
	});

	// MQTT subscribed
	this.mqttClient.subscribe(that.mqttResultTopic);
	this.mqttClient.subscribe(that.mqttTeleTopic);

	// register the service and provide the functions
	this.service = new Service.WindowCovering(this.name);

	// the current position (0-100%)
	this.service
		.getCharacteristic(Characteristic.CurrentPosition)
		.on('get', this.getCurrentPosition.bind(this));

	// the position state (0 = DECREASING, 1 = INCREASING, 2 = STOPPED)
	this.service
		.getCharacteristic(Characteristic.PositionState)
		.on('get', this.getPositionState.bind(this));

	// the target position (0-100%)
	this.service
		.getCharacteristic(Characteristic.TargetPosition)
		.on('get', this.getTargetPosition.bind(this))
		.on('set', this.setTargetPosition.bind(this));

	// send an empty MQTT command to get the initial state
	this.mqttClient.publish(this.mqttCommandTopic, null, this.mqttOptions);

}


// Apple homekit handlers
MqttBlindsTasmotaAccessory.prototype.getCurrentPosition = function(callback) {
	this.log("Requested CurrentPosition: %s", this.lastPosition);
	callback(null, this.lastPosition);
}

MqttBlindsTasmotaAccessory.prototype.getPositionState = function(callback) {
	this.log("Requested PositionState: %s", this.currentPositionState);
	callback(null, this.currentPositionState);
}

MqttBlindsTasmotaAccessory.prototype.getTargetPosition = function(callback) {
	this.log("Requested TargetPosition: %s", this.currentTargetPosition);
	callback(null, this.currentTargetPosition);
}

MqttBlindsTasmotaAccessory.prototype.setTargetPosition = function(pos, callback) {
	this.log("Set TargetPosition: %s", pos);
	this.mqttClient.publish(this.mqttCommandTopic, pos.toString(), this.mqttOptions);
	callback(null);
}

MqttBlindsTasmotaAccessory.prototype.getServices = function() {
	var informationService = new Service.AccessoryInformation();

	informationService
		.setCharacteristic(Characteristic.Name, this.name)
		.setCharacteristic(Characteristic.Manufacturer, this.manufacturer)
		.setCharacteristic(Characteristic.Model, this.model)
		.setCharacteristic(Characteristic.SerialNumber, this.serialNumberMAC);

	return [informationService, this.service];
}