mhop/tuya-mqtt
1
0
Fork 0
mirror of https://github.com/lehanspb/tuya-mqtt.git synced 2025-12-16 17:54:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Device/DPS commands

Browse Source 
* Add ability to set individual DPS values via <topic>/dps/<#>/command
* Can still use Tuya JSON via <topic>/dps/command
* Simple on/off sent to <topic>/command
* Brightness sent to <topic>/brightness_command
* Simple device type detection (currently only for sockets/switches/dimmers and non-RGB lights, other devices are unknown get DPS 1 on/off in state and all other values accessible via DPS
This commit is contained in:
tsightler
2020-09-22 01:01:43 -04:00
parent d8a24d4e6f
commit 1181f66c32
2 changed files with 184 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
tuya-device.js
View File

@@ -10,7 +10,8 @@ const debugColor = require('debug')('TuyAPI:device:color');
id: '03200240600194781244',
key: 'b8bdebab418f5b55',
ip: '192.168.178.45',
version: "3.3"
version: "3.3",
type: "<device_type>" <- "switch", "light", "dimmer", etc. Attempts autodetect if not defined
});
*/

196
tuya-mqtt.js
View File

@@ -6,26 +6,24 @@ const debug = require('debug')('TuyAPI:mqtt');
const debugColor = require('debug')('TuyAPI:mqtt:color');
const debugTuya = require('debug')('TuyAPI:mqtt:device');
const debugError = require('debug')('TuyAPI:mqtt:error');
var cleanup = require('./cleanup').Cleanup(onExit);
var CONFIG = undefined;
var mqtt_client = undefined;
function bmap(istate) {
return istate ? 'ON' : "OFF";
}
/*
* execute function on topic message
* Check if data is JSON or not
*/
function IsJsonString(text) {
if (/^[\],:{}\s]*$/.test(text.replace(/\\["\\\/bfnrtu]/g, '@').replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, ']').replace(/(?:^|:|,)(?:\s*\[)+/g, ''))) {
//the json is ok
return true;
function isJsonString (data){
try {
const parsedData = JSON.parse(data);
if (parsedData && typeof parsedData === "object") {
return parsedData;
}
}
catch (e) { }
return false;
}
};
/**
* get command from mqtt message
@@ -36,13 +34,13 @@ function IsJsonString(text) {
function getCommandFromMessage(_message) {
let command = _message
if (command != "1" && command != "0" && IsJsonString(command)) {
if (command != "1" && command != "0" && isJsonString(command)) {
debug("command is JSON");
command = JSON.parse(command);
} else {
if (command.toLowerCase() != "toggle") {
// convert simple commands (on, off, 1, 0) to TuyAPI-Commands
var convertString = command.toLowerCase() == "on" || command == "1" || command == 1 ? true : false;
const convertString = command.toLowerCase() == "on" || command == "1" || command == 1 ? true : false;
command = {
set: convertString
}
@@ -53,23 +51,42 @@ function getCommandFromMessage(_message) {
return command;
}
/**
* Publish current TuyaDevice state to MQTT-Topic
* @param {TuyaDevice} device
* @param {boolean} status
*/
function publishStatus(device, status) {
if (mqtt_client.connected == true) {
try {
let topic = CONFIG.topic + device.topicLevel + "/state";
mqtt_client.publish(topic, status, {
// Parse message
function parseDpsMessage(message) {
if (typeof message === "boolean" ) {
return message;
} else if (message === "true" || message === "false") {
return (message === "true") ? true : false
} else if (!isNaN(message)) {
return Number(message)
} else {
return message
}
}
function publishMQTT(topic, data) {
mqtt_client.publish(topic, data, {
retain: CONFIG.retain,
qos: CONFIG.qos
});
debugTuya("mqtt status updated to:" + topic + " -> " + status);
} catch (e) {
debugError(e);
}
function guessDeviceType(device, dps) {
keys = Object.keys(dps).length
if (keys === 2) {
if (typeof dps['1'] === "boolean" && dps['2'] >= 0 && dps['2'] <= 255) {
// A "dimmer" is a switch/light with brightness control only
device.options.type = "dimmer"
}
} else if (keys === 1) {
if (typeof dps['1'] === "boolean") {
// If it only has one value and it's a boolean, it's probably a switch/socket
device.options.type = "switch"
}
}
if (!device.options.type) {
device.options.type = "unknown"
}
}
@@ -77,6 +94,35 @@ function publishColorState(device, state) {
}
function publishDeviceTopics(device, dps) {
const baseTopic = CONFIG.topic + device.topicLevel
let state
let brightness_state
switch (device.options.type) {
case "switch":
case "unknown":
state = (dps['1']) ? 'ON' : 'OFF';
topic = baseTopic+"/state"
debugTuya("MQTT state ("+device.options.type+"): "+topic+" -> ", state);
publishMQTT(topic, state);
break;
case "dimmer":
if ('1' in dps) {
state = (dps['1']) ? 'ON' : 'OFF';
topic = baseTopic+"/state"
debugTuya("MQTT state ("+device.options.type+"): "+topic+" -> ", state);
publishMQTT(topic, state);
}
if ('2' in dps) {
brightness_state = JSON.stringify(dps['2']);
topic = baseTopic+"/brightness_state"
debugTuya("MQTT brightness ("+device.options.type+"): "+topic+" -> ", brightness_state);
publishMQTT(topic, brightness_state);
}
break;
}
}
/**
* publish all dps-values to topic
* @param {TuyaDevice} device
@@ -85,25 +131,28 @@ function publishColorState(device, state) {
function publishDPS(device, dps) {
if (mqtt_client.connected == true) {
try {
if (!device.options.type) {
guessDeviceType(device, dps)
}
const baseTopic = CONFIG.topic + device.topicLevel + "/dps";
const topic = baseTopic;
const topic = baseTopic + "/state"
const data = JSON.stringify(dps);
debugTuya("mqtt dps updated to:" + topic + " -> ", data);
mqtt_client.publish(topic, data, {
retain: CONFIG.retain,
qos: CONFIG.qos
// Publish raw DPS JSON data
debugTuya("MQTT DPS JSON (raw): " + topic + " -> ", data);
publishMQTT(topic, data);
// Publish dps/<#>/state value for each DPS
Object.keys(dps).forEach(function (key) {
const topic = baseTopic + "/" + key + "/state";
const data = JSON.stringify(dps[key]);
debugTuya("MQTT DPS"+key+": "+topic+" -> ", data);
publishMQTT(topic, data);
});
Object.keys(dps).forEach(function (key) {
const topic = baseTopic + "/" + key;
const data = JSON.stringify(dps[key]);
debugTuya("mqtt dps updated to:" + topic + " -> dps[" + key + "]", data);
mqtt_client.publish(topic, data, {
retain: CONFIG.retain,
qos: CONFIG.qos
});
});
publishDeviceTopics(device, dps)
} catch (e) {
debugError(e);
}
@@ -118,10 +167,6 @@ TuyaDevice.onAll('data', function (data) {
try {
if (typeof data.dps != "undefined") {
debugTuya('Data from device ' + this.tuyID + ' :', data);
var status = data.dps['1'];
if (typeof status != "undefined") {
publishStatus(this, bmap(status));
}
publishDPS(this, data.dps);
}
} catch (e) {
@@ -225,13 +270,16 @@ const main = async() => {
mqtt_client.on('message', function (topic, message) {
try {
message = message.toString();
splitTopic = topic.split("/");
let action = splitTopic[2];
let options = {
const splitTopic = topic.split("/");
const topicLength = splitTopic.length
const action = splitTopic[topicLength - 1];
const options = {
topicLevel: splitTopic[1]
}
debug("receive settings", JSON.stringify({
// If it looks like a valid command topic try to process it
if (action.includes("command")) {
debug("Receive settings", JSON.stringify({
topic: topic,
action: action,
message: message,
@@ -245,14 +293,15 @@ const main = async() => {
var device = params.device;
switch (action) {
case "command":
var command = getCommandFromMessage(message);
if (topicLength === 3) {
const command = getCommandFromMessage(message);
debug("Received command: ", command);
if (command == "toggle") {
device.switch(command).then((data) => {
debug("Set device status completed: ", data);
});
}
if (command.schema === true) {
if (command == "schema") {
// Trigger device schema update to update state
device.schema(command).then((data) => {
});
@@ -262,19 +311,58 @@ const main = async() => {
debug("Set device status completed: ", data);
});
}
} else if (topicLength === 4) {
if (isJsonString(message)) {
const command = getCommandFromMessage(message);
debug("Received command: ", command);
device.set(command).then((data) => {
debug("Set device status completed: ", data);
});
} else {
debug("DPS command topic requires Tuya style JSON value")
}
} else if (topicLength === 5) {
if (isJsonString(message)) {
debug("Individual DPS command topics require string value")
} else {
const dpsMessage = parseDpsMessage(message)
debug("Received DPS "+splitTopic[topicLength-2]+" command: ", message);
const command = {
dps: splitTopic[topicLength-2],
set: dpsMessage
}
device.set(command).then((data) => {
debug("Set device status completed: ", data);
});
}
}
break;
case "color":
var color = message.toLowerCase();
const color = message.toLowerCase();
debugColor("Set color: ", color);
device.setColor(color).then((data) => {
debug("Set device color completed: ", data);
});
break;
case "brightness_command":
if (message >= 0 && message <= 255) {
const brightness = {
dps: 2,
set: parseInt(message)
}
debug("Set brighness: ", message)
device.set(brightness).then((data) => {
debug("Set device brightness completed: ",data);
});
} else {
debug("Received invalid brightness value: " + message)
}
break;
}
}).catch((err) => {
debugError(err);
});
}
} catch (e) {
debugError(e);
}