node-red-contrib-homekit-mqtt
Version:
Node-RED nodes to simulate Apple HomeKit devices
333 lines (280 loc) • 13.3 kB
JavaScript
/**
* NodeRED HomeKit MQTT
* Copyright (C) 2017 Michael Jacobsen / Marius Schmeding.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
**/
module.exports = function (RED) {
'use strict'
var API = require('./lib/api.js')(RED)
var HapNodeJS = require('hap-nodejs')
var HK = require('./lib/common_functions.js')
var Accessory = HapNodeJS.Accessory
var Service = HapNodeJS.Service
var Characteristic = HapNodeJS.Characteristic
var uuid = HapNodeJS.uuid
function HAPSmokeSensorNode(config) {
RED.nodes.createNode(this, config)
// MQTT properties
this.qos = 0
this.retain = false
this.nodename = config.nodename
this.dataId = config.dataid
this.wdt = -1
this.wdtStatus = -1
this.alive = null
this.lastVal = {}
this.rpccnt = 1
if (config.wdt > 0) {
this.wdt = config.wdt * 1000
}
this.client = config.client
this.clientConn = RED.nodes.getNode(this.client)
if (!this.clientConn) {
this.error(RED._("msgbus-v2.errors.missing-config"))
return
}
// HomeKit properties
this.name = config.name
this.serviceName = config.serviceName
this.outletinuse = config.outletinuse
this.configNode = RED.nodes.getNode(config.accessory)
// generate UUID from node id
var subtypeUUID = uuid.generate(this.id)
// add service
var accessory = this.configNode.accessory
var service = null
try {
// this might fail if node is being restarted (!)
service = accessory.addService(Service[this.serviceName], this.name, subtypeUUID)
} catch(err) {
RED.log.debug("HAPSmokeSensorNode(): service already exists")
service = accessory.getService(subtypeUUID)
}
var node = this
// the pinCode should be shown to the user until interaction with iOS client starts
node.status({fill: 'yellow', shape: 'ring', text: node.configNode.pinCode})
if (this.clientConn) {
node.clientConn.register(this)
node.clientConn.startAliveTimer(node)
} else {
RED.log.error("HAPSmokeSensorNode(): no clientConn")
}
// which characteristics are supported?
var supported = { read: [], write: []}
var allCharacteristics = service.characteristics.concat(service.optionalCharacteristics)
allCharacteristics.map(function (characteristic, index) {
var cKey = characteristic.displayName.replace(/ /g, '')
if (characteristic.props.perms.indexOf('pw') > -1) {
supported.read.push(cKey)
}
if ((characteristic.props.perms.indexOf('pr') + characteristic.props.perms.indexOf('ev')) > -2) {
supported.write.push(cKey)
}
})
//
// set defaults
//
service.setCharacteristic(Characteristic["StatusActive"], node.statusactive)
if (node.statusfault > -1) {
service.setCharacteristic(Characteristic["StatusFault"], node.statusfault)
}
if (node.statustampered > -1) {
service.setCharacteristic(Characteristic["StatusTampered"], node.statustampered)
}
if (node.statuslowbattery > -1) {
service.setCharacteristic(Characteristic["StatusLowBattery"], node.statuslowbattery)
}
//
// incoming regular updates from device
//
this.clientConn.updateSubscribe(this.nodename, this.dataId, this.qos, function(topic, payload, packet) {
RED.log.debug("HAPSmokeSensorNode(updateSubscribe): payload = " + payload.toString())
node.clientConn.startAliveTimer(node)
try {
var obj = JSON.parse(payload)
if (obj.hasOwnProperty('smokedetected')) {
service.setCharacteristic(Characteristic["SmokeDetected"], obj.smokedetected)
RED.log.debug("HAPSmokeSensorNode(updateSubscribe): smokedetected = " + obj.smokedetected)
}
if (obj.hasOwnProperty('statusactive')) {
service.setCharacteristic(Characteristic["StatusActive"], obj.statusactive)
RED.log.debug("HAPSmokeSensorNode(updateSubscribe): statusactive = " + obj.statusactive)
}
if (obj.hasOwnProperty('statusfault')) {
service.setCharacteristic(Characteristic["StatusFault"], obj.statusfault)
RED.log.debug("HAPSmokeSensorNode(updateSubscribe): statusfault = " + obj.statusfault)
}
if (obj.hasOwnProperty('statustampered')) {
service.setCharacteristic(Characteristic["StatusTampered"], obj.statustampered)
RED.log.debug("HAPSmokeSensorNode(updateSubscribe): statustampered = " + obj.statustampered)
}
if (obj.hasOwnProperty('statuslowbattery')) {
service.setCharacteristic(Characteristic["StatusLowBattery"], obj.statuslowbattery)
RED.log.debug("HAPSmokeSensorNode(updateSubscribe): statuslowbattery = " + obj.statuslowbattery)
}
} catch(err) {
RED.log.error("malformed object: " + payload.toString())
}
}, this.id)
//
// emit message when value changes (sent from HomeKit)
//
service.on('characteristic-change', function (info) {
var key = info.characteristic.displayName.replace(/ /g, '')
RED.log.debug("HAPSmokeSensorNode(characteristic-change): key = " + key + ", value = " + info.newValue)
node.status({fill: 'yellow', shape: 'dot', text: key + ': ' + info.newValue})
setTimeout(function () { node.status({}) }, 3000)
var msg = { payload: {}}
msg.manufacturer = node.configNode.manufacturer
msg.serialno = node.configNode.serialNo
msg.model = node.configNode.model
msg.name = node.configNode.name
msg.format = info.characteristic.props.format
msg.payload = HK.FormatValue(info.characteristic.props.format, info.newValue)
msg.topic = HK.CreateOutTopic(node.nodename, node.dataId, key)
if (msg.payload == null) {
RED.log.warn("Unable to format value")
return
}
if (msg.format == Characteristic.Formats.INT) {
msg.format = "uint8"
}
var l = node.clientConn.timeNowString()
var msgLog = {
topic: "log",
payload: l + " > " + node.nodename + ", " + node.dataId + ": " + key + " = " + msg.payload
}
//
// send message on the right output
//
switch (key) {
case "SmokeDetected":
RED.log.debug("HAPSmokeSensorNode(characteristic-change): SmokeDetected")
break
case "StatusActive":
RED.log.debug("HAPSmokeSensorNode(characteristic-change): StatusActive")
break
case "StatusFault":
RED.log.debug("HAPSmokeSensorNode(characteristic-change): StatusFault")
break
case "StatusTampered":
RED.log.debug("HAPSmokeSensorNode(characteristic-change): StatusTampered")
break
case "StatusLowBattery":
RED.log.debug("HAPSmokeSensorNode(characteristic-change): StatusLowBattery")
break
default:
RED.log.warn("Unknown characteristics '" + key + "'")
return
}
node.send([msg, msgLog, null])
})
//
// RPC replies coming from MQTT
//
this.rpcReply = function(reply) {
RED.log.debug("HAPSmokeSensorNode(rpcReply)" + JSON.stringify(reply))
node.clientConn.startAliveTimer(node)
}
//
// device online/offline transitions
//
this.online = function(status) {
RED.log.debug("HAPSmokeSensorNode(online): " + status)
if (status == false) {
service.setCharacteristic(Characteristic["StatusFault"], 1)
}
}
//
// respond to inputs from NodeRED
//
this.on('input', function (msg) {
var characteristic
var val
if (!msg.hasOwnProperty('topic')) {
RED.log.warn('Invalid message (topic missing)')
return
} else if (!msg.hasOwnProperty('payload')) {
RED.log.warn('Invalid message (payload missing)')
return
} else {
//
// deal with the msg.topic
//
if (msg.topic.toUpperCase() == "SMOKEDETECTED") {
characteristic = "SmokeDetected"
} else if (msg.topic.toUpperCase() == "STATUSACTIVE") {
characteristic = "StatusActive"
} else if (msg.topic.toUpperCase() == "STATUSFAULT") {
characteristic = "StatusFault"
} else if (msg.topic.toUpperCase() == "STATUSTAMPERED") {
characteristic = "StatusTampered"
} else if (msg.topic.toUpperCase() == "STATUSLOWBATTERY") {
characteristic = "StatusLowBattery"
} else {
if (msg.payload.hasOwnProperty('Smokedetected')) {
RED.log.debug("HAPSmokeSensorNode(input): smokedetected")
service.setCharacteristic(Characteristic["SmokeDetected"], msg.payload.smokedetected)
}
if (msg.payload.hasOwnProperty('statusactive')) {
RED.log.debug("HAPSmokeSensorNode(input): statusactive")
service.setCharacteristic(Characteristic["StatusActive"], msg.payload.statusactive)
}
if (msg.payload.hasOwnProperty('statusfault')) {
RED.log.debug("HAPSmokeSensorNode(input): statusfault")
service.setCharacteristic(Characteristic["StatusFault"], msg.payload.statusfault)
}
if (msg.payload.hasOwnProperty('statustampered')) {
RED.log.debug("HAPSmokeSensorNode(input): statustampered")
service.setCharacteristic(Characteristic["StatusTampered"], msg.payload.statustampered)
}
if (msg.payload.hasOwnProperty('statuslowbattery')) {
RED.log.debug("HAPSmokeSensorNode(input): statuslowbattery")
service.setCharacteristic(Characteristic["StatusLowBattery"], msg.payload.statuslowbattery)
}
return
}
//
// deal with the msg.payload
//
val = HK.FormatValue(service.getCharacteristic(Characteristic[characteristic]).props.format, msg.payload)
if (val == null) {
RED.log.warn("Unable to format value")
return
}
}
if (supported.write.indexOf(characteristic) < 0) {
RED.log.warn("Characteristic " + characteristic + " cannot be written to")
} else {
// send to HomeKit
if (service.getCharacteristic(Characteristic[characteristic]).value != val) {
service.setCharacteristic(Characteristic[characteristic], val)
}
}
})
this.on('close', function(removed, done) {
accessory.removeService(service)
if (node.clientConn) {
node.clientConn.deregister(node, done)
}
if (removed) {
// This node has been deleted
} else {
// This node is being restarted
}
})
}
RED.nodes.registerType('homekit-smokesensor-v2', HAPSmokeSensorNode)
}