zigbee-herdsman-converters
Version:
Collection of device converters to be used with zigbee-herdsman
952 lines • 107 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.definitions = void 0;
const zigbee_herdsman_1 = require("zigbee-herdsman");
const fz = __importStar(require("../converters/fromZigbee"));
const tz = __importStar(require("../converters/toZigbee"));
const constants = __importStar(require("../lib/constants"));
const exposes = __importStar(require("../lib/exposes"));
const logger_1 = require("../lib/logger");
const m = __importStar(require("../lib/modernExtend"));
const reporting = __importStar(require("../lib/reporting"));
const utils = __importStar(require("../lib/utils"));
const utils_1 = require("../lib/utils");
const e = exposes.presets;
const ea = exposes.access;
const manuSinope = { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.SINOPE_TECHNOLOGIES };
const sinopeExtend = {
addManuSpecificSinopeCluster: () => m.deviceAddCustomCluster("manuSpecificSinope", {
name: "manuSpecificSinope",
ID: 0xff01,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.SINOPE_TECHNOLOGIES,
attributes: {
// attribute ID :1's readable
keypadLockout: { name: "keypadLockout", ID: 0x0002, type: zigbee_herdsman_1.Zcl.DataType.ENUM8, write: true, max: 0xff },
// 'firmware number': {ID: 3, type: Zcl.DataType.UNKNOWN}, write: true,
firmwareVersion: { name: "firmwareVersion", ID: 0x0004, type: zigbee_herdsman_1.Zcl.DataType.CHAR_STR, write: true },
outdoorTempToDisplay: { name: "outdoorTempToDisplay", ID: 0x0010, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, max: 0xffff },
outdoorTempToDisplayTimeout: { name: "outdoorTempToDisplayTimeout", ID: 0x0011, type: zigbee_herdsman_1.Zcl.DataType.UINT16, write: true, max: 0xffff },
secondScreenBehavior: { name: "secondScreenBehavior", ID: 0x0012, type: zigbee_herdsman_1.Zcl.DataType.ENUM8, write: true, max: 0xff }, // auto:0,setpoint:1,outside:2
currentTimeToDisplay: { name: "currentTimeToDisplay", ID: 0x0020, type: zigbee_herdsman_1.Zcl.DataType.UINT32, write: true, max: 0xffffffff },
ledIntensityOn: { name: "ledIntensityOn", ID: 0x0052, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff },
ledIntensityOff: { name: "ledIntensityOff", ID: 0x0053, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff },
ledColorOn: { name: "ledColorOn", ID: 0x0050, type: zigbee_herdsman_1.Zcl.DataType.UINT24, write: true, max: 0xffffff }, // inversed hex BBGGRR
ledColorOff: { name: "ledColorOff", ID: 0x0051, type: zigbee_herdsman_1.Zcl.DataType.UINT24, write: true, max: 0xffffff },
onLedIntensity: { name: "onLedIntensity", ID: 0x0052, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff }, // percent
offLedIntensity: { name: "offLedIntensity", ID: 0x0053, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff }, // percent
actionReport: { name: "actionReport", ID: 0x0054, type: zigbee_herdsman_1.Zcl.DataType.ENUM8, write: true, max: 0xff }, // singleTapUp: 1,2, doubleTapUp: 1,4, singleTapDown: 17,18, doubleTapDown: 17,20
minimumBrightness: { name: "minimumBrightness", ID: 0x0055, type: zigbee_herdsman_1.Zcl.DataType.UINT16, write: true, max: 0xffff },
connectedLoadRM: { name: "connectedLoadRM", ID: 0x0060, type: zigbee_herdsman_1.Zcl.DataType.UINT16, write: true, max: 0xffff }, // unit watt/hr for Calypso RM3500 & Load Controller RM3250
currentLoad: { name: "currentLoad", ID: 0x0070, type: zigbee_herdsman_1.Zcl.DataType.BITMAP8, write: true }, // related to ecoMode(s)
ecoMode: { name: "ecoMode", ID: 0x0071, type: zigbee_herdsman_1.Zcl.DataType.INT8, write: true, min: -128, max: 127, default: -128 }, // -100-0-100%
ecoMode1: { name: "ecoMode1", ID: 0x0072, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff, default: 0xff }, // 0-99
ecoMode2: { name: "ecoMode2", ID: 0x0073, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff, default: 0xff }, // 0-100
unknown: { name: "unknown", ID: 0x0075, type: zigbee_herdsman_1.Zcl.DataType.BITMAP32, write: true, max: 0xffffffff }, // RW *testing*
drConfigWaterTempMin: { name: "drConfigWaterTempMin", ID: 0x0076, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff }, // value 45 or 0
drConfigWaterTempTime: { name: "drConfigWaterTempTime", ID: 0x0077, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff, default: 2 }, // default 2
drWTTimeOn: { name: "drWTTimeOn", ID: 0x0078, type: zigbee_herdsman_1.Zcl.DataType.UINT16, write: true, max: 0xffff },
unknown1: { name: "unknown1", ID: 0x0080, type: zigbee_herdsman_1.Zcl.DataType.UINT32, max: 0xffffffff }, // readOnly stringNumber *testing*
dimmerTimmer: { name: "dimmerTimmer", ID: 0x00a0, type: zigbee_herdsman_1.Zcl.DataType.UINT32, write: true, max: 0xffffffff },
unknown2: { name: "unknown2", ID: 0x0100, type: zigbee_herdsman_1.Zcl.DataType.UINT8, max: 0xff }, // readOnly *testing*
floorControlMode: { name: "floorControlMode", ID: 0x0105, type: zigbee_herdsman_1.Zcl.DataType.ENUM8, write: true, max: 0xff }, // airFloorMode
auxOutputMode: { name: "auxOutputMode", ID: 0x0106, type: zigbee_herdsman_1.Zcl.DataType.ENUM8, write: true, max: 0xff },
floorTemperature: { name: "floorTemperature", ID: 0x0107, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, max: 0xffff },
ambiantMaxHeatSetpointLimit: { name: "ambiantMaxHeatSetpointLimit", ID: 0x0108, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, max: 0xffff },
floorMinHeatSetpointLimit: { name: "floorMinHeatSetpointLimit", ID: 0x0109, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, max: 0xffff },
floorMaxHeatSetpointLimit: { name: "floorMaxHeatSetpointLimit", ID: 0x010a, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, max: 0xffff },
temperatureSensor: { name: "temperatureSensor", ID: 0x010b, type: zigbee_herdsman_1.Zcl.DataType.ENUM8, write: true, max: 0xff },
floorLimitStatus: { name: "floorLimitStatus", ID: 0x010c, type: zigbee_herdsman_1.Zcl.DataType.ENUM8, write: true, max: 0xff },
roomTemperature: { name: "roomTemperature", ID: 0x010d, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, max: 0xffff },
timeFormatToDisplay: { name: "timeFormatToDisplay", ID: 0x0114, type: zigbee_herdsman_1.Zcl.DataType.ENUM8, write: true, max: 0xff },
GFCiStatus: { name: "GFCiStatus", ID: 0x0115, type: zigbee_herdsman_1.Zcl.DataType.ENUM8, write: true, max: 0xff },
auxConnectedLoad: { name: "auxConnectedLoad", ID: 0x0118, type: zigbee_herdsman_1.Zcl.DataType.UINT16, write: true, max: 0xff },
connectedLoad: { name: "connectedLoad", ID: 0x0119, type: zigbee_herdsman_1.Zcl.DataType.UINT16, write: true, max: 0xffff },
pumpProtection: { name: "pumpProtection", ID: 0x0128, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff },
unknown3: { name: "unknown3", ID: 0x012a, type: zigbee_herdsman_1.Zcl.DataType.ENUM8, write: true, max: 0xff, default: 60 }, // RW 5,10,15,20,30,60 *testing*
currentSetpoint: { name: "currentSetpoint", ID: 0x012b, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, max: 0xffff }, // W:to ocuppiedHeatSetpoint, R:depends of sinopeOccupancy
// attribute ID: 300's readable, returns a buffer
reportLocalTemperature: { name: "reportLocalTemperature", ID: 0x012d, type: zigbee_herdsman_1.Zcl.DataType.INT16, write: true, min: -32768, max: 32767 },
// attribute ID: 512's readable
flowMeterConfig: { name: "flowMeterConfig", ID: 0x0240, type: zigbee_herdsman_1.Zcl.DataType.ARRAY, write: true },
coldLoadPickupStatus: { name: "coldLoadPickupStatus", ID: 0x0283, type: zigbee_herdsman_1.Zcl.DataType.UINT8, write: true, max: 0xff },
},
commands: {},
commandsResponse: {},
}),
addSinopeHvacThermostatCluster: () => m.deviceAddCustomCluster("hvacThermostat", {
name: "hvacThermostat",
ID: zigbee_herdsman_1.Zcl.Clusters.hvacThermostat.ID,
attributes: {
sinopeOccupancy: {
name: "sinopeOccupancy",
ID: 0x0400,
type: zigbee_herdsman_1.Zcl.DataType.ENUM8,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.SINOPE_TECHNOLOGIES,
write: true,
max: 0xff,
},
sinopeMainCycleOutput: {
name: "sinopeMainCycleOutput",
ID: 0x0401,
type: zigbee_herdsman_1.Zcl.DataType.UINT16,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.SINOPE_TECHNOLOGIES,
write: true,
max: 0xffff,
},
sinopeBacklight: {
name: "sinopeBacklight",
ID: 0x0402,
type: zigbee_herdsman_1.Zcl.DataType.ENUM8,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.SINOPE_TECHNOLOGIES,
write: true,
max: 0xff,
},
sinopeAuxCycleOutput: {
name: "sinopeAuxCycleOutput",
ID: 0x0404,
type: zigbee_herdsman_1.Zcl.DataType.UINT16,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.SINOPE_TECHNOLOGIES,
write: true,
max: 0xffff,
},
},
commands: {},
commandsResponse: {},
}),
};
const fzLocal = {
ias_water_leak_alarm: {
// RM3500ZB specific
cluster: "ssIasZone",
type: ["commandStatusChangeNotification", "attributeReport", "readResponse"],
convert: (model, msg, publish, options, meta) => {
const zoneStatus = "zonestatus" in msg.data ? msg.data.zonestatus : msg.data.zoneStatus;
return {
water_leak: (zoneStatus & 1) > 0,
tamper: (zoneStatus & (1 << 2)) > 0,
};
},
},
thermostat: {
cluster: "hvacThermostat",
type: ["attributeReport", "readResponse"],
convert: (model, msg, publish, options, meta) => {
// @ts-expect-error ignore
delete msg.running_state;
const result = {};
const occupancyLookup = { 0: "unoccupied", 1: "occupied" };
const cycleOutputLookup = { 15: "15_sec", 300: "5_min", 600: "10_min", 900: "15_min", 1200: "20_min", 1800: "30_min", 65535: "off" };
if (msg.data["1024"] !== undefined) {
result.thermostat_occupancy = utils.getFromLookup(msg.data["1024"], occupancyLookup);
}
if (msg.data.sinopeOccupancy !== undefined) {
result.thermostat_occupancy = utils.getFromLookup(msg.data.sinopeOccupancy, occupancyLookup);
}
if (msg.data["1025"] !== undefined) {
result.main_cycle_output = utils.getFromLookup(msg.data["1025"], cycleOutputLookup);
}
if (msg.data.sinopeMainCycleOutput !== undefined) {
result.main_cycle_output = utils.getFromLookup(msg.data.sinopeMainCycleOutput, cycleOutputLookup);
}
if (msg.data["1026"] !== undefined) {
const lookup = utils.getMetaValue(msg.endpoint, model, "sinopeAlternateBacklightAutoDim", "allEqual", false)
? { 0: "on_demand", 1: "off", 2: "sensing" }
: { 0: "on_demand", 1: "sensing", 2: "off" };
result.backlight_auto_dim = utils.getFromLookup(msg.data["1026"], lookup);
}
if (msg.data.sinopeBacklight !== undefined) {
const lookup = utils.getMetaValue(msg.endpoint, model, "sinopeAlternateBacklightAutoDim", "allEqual", false)
? { 0: "on_demand", 1: "off", 2: "sensing" }
: { 0: "on_demand", 1: "sensing", 2: "off" };
result.backlight_auto_dim = utils.getFromLookup(msg.data.sinopeBacklight, lookup);
}
if (msg.data["1028"] !== undefined) {
result.aux_cycle_output = utils.getFromLookup(msg.data["1028"], cycleOutputLookup);
}
if (msg.data.localTemp !== undefined) {
result.local_temperature = (0, utils_1.precisionRound)(msg.data.localTemp, 2) / 100;
if (model.model === "TH1300ZB") {
// floorTemperature and roomTemperature do not support configureReporting;
// piggyback on local_temperature reports to keep values in sync.
msg.endpoint
.read("manuSpecificSinope", ["floorTemperature", "roomTemperature"], manuSinope)
.catch((e) => logger_1.logger.debug(`TH1300ZB: failed to read floor/room temperature: ${e}`, "sinope"));
}
}
if (msg.data.localTemperatureCalibration !== undefined) {
result.local_temperature_calibration = (0, utils_1.precisionRound)(msg.data.localTemperatureCalibration, 2) / 10;
}
if (msg.data.outdoorTemp !== undefined) {
result.outdoor_temperature = (0, utils_1.precisionRound)(msg.data.outdoorTemp, 2) / 100;
}
if (msg.data.occupiedHeatingSetpoint !== undefined) {
result.occupied_heating_setpoint = (0, utils_1.precisionRound)(msg.data.occupiedHeatingSetpoint, 2) / 100;
}
if (msg.data.unoccupiedHeatingSetpoint !== undefined) {
result.unoccupied_heating_setpoint = (0, utils_1.precisionRound)(msg.data.unoccupiedHeatingSetpoint, 2) / 100;
}
if (msg.data.occupiedCoolingSetpoint !== undefined) {
result.occupied_cooling_setpoint = (0, utils_1.precisionRound)(msg.data.occupiedCoolingSetpoint, 2) / 100;
}
if (msg.data.unoccupiedCoolingSetpoint !== undefined) {
result.unoccupied_cooling_setpoint = (0, utils_1.precisionRound)(msg.data.unoccupiedCoolingSetpoint, 2) / 100;
}
if (msg.data.ctrlSeqeOfOper !== undefined) {
result.control_sequence_of_operation = utils.getFromLookup(msg.data.ctrlSeqeOfOper, constants.thermostatControlSequenceOfOperations);
}
if (msg.data.systemMode !== undefined) {
result.system_mode = utils.getFromLookup(msg.data.systemMode, constants.thermostatSystemModes);
}
if (msg.data.pIHeatingDemand !== undefined) {
result.pi_heating_demand = (0, utils_1.precisionRound)(msg.data.pIHeatingDemand, 0);
}
if (msg.data.minHeatSetpointLimit !== undefined) {
result.min_heat_setpoint_limit = (0, utils_1.precisionRound)(msg.data.minHeatSetpointLimit, 2) / 100;
}
if (msg.data.maxHeatSetpointLimit !== undefined) {
result.max_heat_setpoint_limit = (0, utils_1.precisionRound)(msg.data.maxHeatSetpointLimit, 2) / 100;
}
if (msg.data.absMinHeatSetpointLimit !== undefined) {
result.abs_min_heat_setpoint_limit = (0, utils_1.precisionRound)(msg.data.absMinHeatSetpointLimit, 2) / 100;
}
if (msg.data.absMaxHeatSetpointLimit !== undefined) {
result.abs_max_heat_setpoint_limit = (0, utils_1.precisionRound)(msg.data.absMaxHeatSetpointLimit, 2) / 100;
}
if (msg.data.pIHeatingDemand !== undefined) {
result.running_state = msg.data.pIHeatingDemand >= 10 ? "heat" : "idle";
}
return result;
},
},
tank_level: {
cluster: "genAnalogInput",
type: ["attributeReport", "readResponse"],
convert: (model, msg, publish, options, meta) => {
const result = {};
if (msg.data.presentValue !== undefined) {
let x = msg.data.presentValue;
if (x === -1) {
result.tank_level = 0;
}
else {
const xMin = 110;
const xMax = 406;
const delta = 46;
if (delta <= x && x <= 70) {
x = delta;
}
if (0 <= x && x <= delta) {
x = x + 360;
}
const y = (x - xMin) / (xMax - xMin);
const lowerLimit = 10;
const upperLimit = 80;
const valueRange = upperLimit - lowerLimit;
const pct = y * valueRange + lowerLimit;
result.tank_level = utils.precisionRound(pct, 2);
}
}
return result;
},
},
sinope: {
cluster: "manuSpecificSinope",
type: ["attributeReport", "readResponse"],
convert: (model, msg, publish, options, meta) => {
const result = {};
if (msg.data.GFCiStatus !== undefined) {
const lookup = { 0: "off", 1: "on" };
result.gfci_status = utils.getFromLookup(msg.data.GFCiStatus, lookup);
}
if (msg.data.floorLimitStatus !== undefined) {
const lookup = { 0: "off", 1: "on" };
result.floor_limit_status = utils.getFromLookup(msg.data.floorLimitStatus, lookup);
}
if (msg.data.secondScreenBehavior !== undefined) {
const lookup = { 0: "auto", 1: "setpoint", 2: "outdoor temp" };
result.second_display_mode = utils.getFromLookup(msg.data.secondScreenBehavior, lookup);
}
if (msg.data.outdoorTempToDisplayTimeout !== undefined) {
result.outdoor_temperature_timeout = msg.data.outdoorTempToDisplayTimeout;
// DEPRECATED: Use Second Display Mode or control via set outdoorTempToDisplayTimeout
result.enable_outdoor_temperature = msg.data.outdoorTempToDisplayTimeout === 12 ? "OFF" : "ON";
}
if (msg.data.outdoorTempToDisplay !== undefined) {
result.thermostat_outdoor_temperature = (0, utils_1.precisionRound)(msg.data.outdoorTempToDisplay, 2) / 100;
}
if (msg.data.currentTimeToDisplay !== undefined) {
result.current_time_to_display = msg.data.currentTimeToDisplay;
}
if (msg.data.floorControlMode !== undefined) {
const lookup = { 1: "ambiant", 2: "floor" };
result.floor_control_mode = utils.getFromLookup(msg.data.floorControlMode, lookup);
}
if (msg.data.ambiantMaxHeatSetpointLimit !== undefined) {
result.ambiant_max_heat_setpoint = msg.data.ambiantMaxHeatSetpointLimit / 100.0;
if (result.ambiant_max_heat_setpoint === -327.68) {
result.ambiant_max_heat_setpoint = "off";
}
}
if (msg.data.floorMinHeatSetpointLimit !== undefined) {
result.floor_min_heat_setpoint = msg.data.floorMinHeatSetpointLimit / 100.0;
if (result.floor_min_heat_setpoint === -327.68) {
result.floor_min_heat_setpoint = "off";
}
}
if (msg.data.floorMaxHeatSetpointLimit !== undefined) {
result.floor_max_heat_setpoint = msg.data.floorMaxHeatSetpointLimit / 100.0;
if (result.floor_max_heat_setpoint === -327.68) {
result.floor_max_heat_setpoint = "off";
}
}
if (msg.data.temperatureSensor !== undefined) {
const lookup = { 0: "10k", 1: "12k" };
result.floor_temperature_sensor = utils.getFromLookup(msg.data.temperatureSensor, lookup);
}
if (msg.data.floorTemperature !== undefined) {
result.floor_temperature = (0, utils_1.precisionRound)(msg.data.floorTemperature, 2) / 100;
}
if (msg.data.roomTemperature !== undefined) {
result.room_temperature = (0, utils_1.precisionRound)(msg.data.roomTemperature, 2) / 100;
}
if (msg.data.timeFormatToDisplay !== undefined) {
const lookup = { 0: "24h", 1: "12h" };
result.time_format = utils.getFromLookup(msg.data.timeFormatToDisplay, lookup);
}
if (msg.data.connectedLoad !== undefined) {
result.connected_load = msg.data.connectedLoad;
}
if (msg.data.auxConnectedLoad !== undefined) {
result.aux_connected_load = msg.data.auxConnectedLoad;
if (result.aux_connected_load === 65535) {
result.aux_connected_load = "disabled";
}
}
if (msg.data.pumpProtection !== undefined) {
result.pump_protection = msg.data.pumpProtection === 1 ? "ON" : "OFF";
}
if (msg.data.dimmerTimmer !== undefined) {
result.timer_seconds = msg.data.dimmerTimmer;
}
if (msg.data.ledIntensityOn !== undefined) {
result.led_intensity_on = msg.data.ledIntensityOn;
}
if (msg.data.ledIntensityOff !== undefined) {
result.led_intensity_off = msg.data.ledIntensityOff;
}
if (msg.data.minimumBrightness !== undefined) {
result.minimum_brightness = msg.data.minimumBrightness;
}
if (msg.data.actionReport !== undefined) {
const lookup = {
1: "up_clickdown",
2: "up_single",
3: "up_hold",
4: "up_double",
17: "down_clickdown",
18: "down_single",
19: "down_hold",
20: "down_double",
};
result.action = utils.getFromLookup(msg.data.actionReport, lookup);
}
if (msg.data.keypadLockout !== undefined) {
const lookup = { 0: "unlock", 1: "lock" };
result.keypad_lockout = utils.getFromLookup(msg.data.keypadLockout, lookup);
}
if (msg.data.drConfigWaterTempMin !== undefined) {
result.low_water_temp_protection = msg.data.drConfigWaterTempMin;
}
if (msg.data.ecoMode !== undefined) {
result.eco_mode = (msg.data.ecoMode ?? -128) / 10;
}
return result;
},
},
};
const tzLocal = {
thermostat_occupancy: {
key: ["thermostat_occupancy"],
convertSet: async (entity, key, value, meta) => {
const lookup = { 0: "unoccupied", 1: "occupied" };
const sinopeOccupancy = utils.getKey(lookup, value, value, Number);
await entity.write("hvacThermostat", { sinopeOccupancy }, manuSinope);
return { state: { thermostat_occupancy: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("hvacThermostat", ["sinopeOccupancy"], manuSinope);
},
},
backlight_autodim: {
key: ["backlight_auto_dim"],
convertSet: async (entity, key, value, meta) => {
const sinopeBacklightParam = utils.getMetaValue(entity, meta.mapped, "sinopeAlternateBacklightAutoDim", "allEqual", false)
? { 0: "on_demand", 1: "off", 2: "sensing" }
: { 0: "on_demand", 1: "sensing", 2: "off" };
const sinopeBacklight = utils.getKey(sinopeBacklightParam, value, value, Number);
await entity.write("hvacThermostat", { sinopeBacklight }, manuSinope);
return { state: { backlight_auto_dim: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("hvacThermostat", ["sinopeBacklight"], manuSinope);
},
},
main_cycle_output: {
key: ["main_cycle_output"],
convertSet: async (entity, key, value, meta) => {
const lookup = { "15_sec": 15, "5_min": 300, "10_min": 600, "15_min": 900, "20_min": 1200, "30_min": 1800 };
await entity.write("hvacThermostat", { sinopeMainCycleOutput: utils.getFromLookup(value, lookup) }, manuSinope);
return { state: { main_cycle_output: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("hvacThermostat", ["sinopeMainCycleOutput"], manuSinope);
},
},
aux_cycle_output: {
// TH1400ZB specific
key: ["aux_cycle_output"],
convertSet: async (entity, key, value, meta) => {
const lookup = { off: 65535, "15_sec": 15, "5_min": 300, "10_min": 600, "15_min": 900, "20_min": 1200, "30_min": 1800 };
await entity.write("hvacThermostat", { sinopeAuxCycleOutput: utils.getFromLookup(value, lookup) });
return { state: { aux_cycle_output: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("hvacThermostat", ["sinopeAuxCycleOutput"]);
},
},
enable_outdoor_temperature: {
// DEPRECATED: Use Second Display Mode or control via the timeout
key: ["enable_outdoor_temperature"],
convertSet: async (entity, key, value, meta) => {
utils.assertString(value);
if (value.toLowerCase() === "on") {
await entity.write("manuSpecificSinope", { outdoorTempToDisplayTimeout: 10800 }, manuSinope);
}
else if (value.toLowerCase() === "off") {
// set timer to 12 sec in order to disable outdoor temperature
await entity.write("manuSpecificSinope", { outdoorTempToDisplayTimeout: 12 }, manuSinope);
}
return { state: { enable_outdoor_temperature: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["outdoorTempToDisplayTimeout"], manuSinope);
},
},
second_display_mode: {
key: ["second_display_mode"],
convertSet: async (entity, key, value, meta) => {
const lookup = { auto: 0, setpoint: 1, "outdoor temp": 2 };
await entity.write("manuSpecificSinope", {
secondScreenBehavior: utils.getFromLookup(value, lookup),
});
return { state: { second_display_mode: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["secondScreenBehavior"]);
},
},
thermostat_outdoor_temperature: {
key: ["thermostat_outdoor_temperature"],
convertSet: async (entity, key, value, meta) => {
const number = utils.toNumber(value);
if (number >= -99.5 && number <= 99.5) {
await entity.write("manuSpecificSinope", { outdoorTempToDisplay: number * 100 }, manuSinope);
}
return { state: { thermostat_outdoor_temperature: number } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["outdoorTempToDisplay"], manuSinope);
},
},
outdoor_temperature_timeout: {
key: ["outdoor_temperature_timeout"],
convertSet: async (entity, key, value, meta) => {
const number = utils.toNumber(value);
if (number >= 30 && number <= 64800) {
await entity.write("manuSpecificSinope", { outdoorTempToDisplayTimeout: number });
return { state: { outdoor_temperature_timeout: number } };
}
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["outdoorTempToDisplayTimeout"]);
},
},
thermostat_time: {
key: ["thermostat_time"],
convertSet: async (entity, key, value, meta) => {
if (value === "") {
const thermostatDate = new Date();
const thermostatTimeSec = thermostatDate.getTime() / 1000;
const thermostatTimezoneOffsetSec = thermostatDate.getTimezoneOffset() * 60;
const currentTimeToDisplay = Math.round(thermostatTimeSec - thermostatTimezoneOffsetSec - 946684800);
await entity.write("manuSpecificSinope", { currentTimeToDisplay }, manuSinope);
}
else if (value !== "") {
await entity.write("manuSpecificSinope", { currentTimeToDisplay: value }, manuSinope);
}
},
},
floor_control_mode: {
// TH1300ZB and TH1400ZB specific
key: ["floor_control_mode"],
convertSet: async (entity, key, value, meta) => {
if (typeof value !== "string") {
return;
}
const lookup = { ambiant: 1, floor: 2 };
value = value.toLowerCase();
// @ts-expect-error ignore
if (lookup[value] !== undefined) {
await entity.write("manuSpecificSinope", {
floorControlMode: utils.getFromLookup(value, lookup),
});
}
return { state: { floor_control_mode: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["floorControlMode"]);
},
},
ambiant_max_heat_setpoint: {
// TH1300ZB and TH1400ZB specific
key: ["ambiant_max_heat_setpoint"],
convertSet: async (entity, key, value, meta) => {
// @ts-expect-error ignore
if ((value >= 5 && value <= 36) || value === "off") {
await entity.write("manuSpecificSinope", {
ambiantMaxHeatSetpointLimit: value === "off" ? -32768 : value * 100,
});
return { state: { ambiant_max_heat_setpoint: value } };
}
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["ambiantMaxHeatSetpointLimit"]);
},
},
floor_min_heat_setpoint: {
// TH1300ZB and TH1400ZB specific
key: ["floor_min_heat_setpoint"],
convertSet: async (entity, key, value, meta) => {
// @ts-expect-error ignore
if ((value >= 5 && value <= 34) || value === "off") {
await entity.write("manuSpecificSinope", {
floorMinHeatSetpointLimit: value === "off" ? -32768 : value * 100,
});
return { state: { floor_min_heat_setpoint: value } };
}
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["floorMinHeatSetpointLimit"]);
},
},
floor_max_heat_setpoint: {
// TH1300ZB and TH1400ZB specific
key: ["floor_max_heat_setpoint"],
convertSet: async (entity, key, value, meta) => {
// @ts-expect-error ignore
if ((value >= 7 && value <= 36) || value === "off") {
await entity.write("manuSpecificSinope", {
floorMaxHeatSetpointLimit: value === "off" ? -32768 : value * 100,
});
return { state: { floor_max_heat_setpoint: value } };
}
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["floorMaxHeatSetpointLimit"]);
},
},
temperature_sensor: {
// TH1300ZB and TH1400ZB specific
key: ["floor_temperature_sensor"],
convertSet: async (entity, key, value, meta) => {
if (typeof value !== "string") {
return;
}
const lookup = { "10k": 0, "12k": 1 };
value = value.toLowerCase();
// @ts-expect-error ignore
if (lookup[value] !== undefined) {
await entity.write("manuSpecificSinope", {
temperatureSensor: utils.getFromLookup(value, lookup),
});
}
return { state: { floor_temperature_sensor: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["temperatureSensor"]);
},
},
time_format: {
key: ["time_format"],
convertSet: async (entity, key, value, meta) => {
await entity.write("manuSpecificSinope", { timeFormatToDisplay: utils.getFromLookup(value, { "24h": 0, "12h": 1 }) }, manuSinope);
return { state: { time_format: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["timeFormatToDisplay"], manuSinope);
},
},
connected_load: {
// TH1400ZB and SW2500ZB
key: ["connected_load"],
convertSet: async (entity, key, value, meta) => {
await entity.write("manuSpecificSinope", { connectedLoad: value });
return { state: { connected_load: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["connectedLoad"]);
},
},
aux_connected_load: {
// TH1400ZB specific
key: ["aux_connected_load"],
convertSet: async (entity, key, value, meta) => {
await entity.write("manuSpecificSinope", { auxConnectedLoad: value });
return { state: { aux_connected_load: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["auxConnectedLoad"]);
},
},
pump_protection: {
// TH1400ZB specific
key: ["pump_protection"],
convertSet: async (entity, key, value, meta) => {
utils.assertString(value);
if (value.toLowerCase() === "on") {
await entity.write("manuSpecificSinope", { pumpProtection: 1 });
}
else if (value.toLowerCase() === "off") {
await entity.write("manuSpecificSinope", { pumpProtection: 255 });
}
return { state: { pump_protection: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["pumpProtection"]);
},
},
led_intensity_on: {
// DM25x0ZB and SW2500ZB
key: ["led_intensity_on"],
convertSet: async (entity, key, value, meta) => {
const number = utils.toNumber(value);
if (number >= 0 && number <= 100) {
await entity.write("manuSpecificSinope", { ledIntensityOn: number });
}
return { state: { led_intensity_on: number } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["ledIntensityOn"]);
},
},
led_intensity_off: {
// DM25x0ZB and SW2500ZB
key: ["led_intensity_off"],
convertSet: async (entity, key, value, meta) => {
const number = utils.toNumber(value);
if (number >= 0 && number <= 100) {
await entity.write("manuSpecificSinope", { ledIntensityOff: number });
}
return { state: { led_intensity_off: number } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["ledIntensityOff"]);
},
},
led_color_on: {
// DM25x0ZB and SW2500ZB
key: ["led_color_on"],
convertSet: async (entity, key, value, meta) => {
const r = value.r >= 0 && value.r <= 255 ? value.r : 0;
const g = value.g >= 0 && value.g <= 255 ? value.g : 0;
const b = value.b >= 0 && value.b <= 255 ? value.b : 0;
const valueHex = r + g * 256 + b * 256 ** 2;
await entity.write("manuSpecificSinope", { ledColorOn: valueHex });
},
},
led_color_off: {
// DM25x0ZB and SW2500ZB
key: ["led_color_off"],
convertSet: async (entity, key, value, meta) => {
const r = value.r >= 0 && value.r <= 255 ? value.r : 0;
const g = value.g >= 0 && value.g <= 255 ? value.g : 0;
const b = value.b >= 0 && value.b <= 255 ? value.b : 0;
const valueHex = r + g * 256 + b * 256 ** 2;
await entity.write("manuSpecificSinope", { ledColorOff: valueHex });
},
},
minimum_brightness: {
// DM25x0ZB
key: ["minimum_brightness"],
convertSet: async (entity, key, value, meta) => {
const number = utils.toNumber(value);
if (number >= 0 && number <= 3000) {
await entity.write("manuSpecificSinope", { minimumBrightness: number });
}
return { state: { minimumBrightness: number } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["minimumBrightness"]);
},
},
timer_seconds: {
// DM25x0ZB and SW2500ZB
key: ["timer_seconds"],
convertSet: async (entity, key, value, meta) => {
const number = utils.toNumber(value);
if (number >= 0 && number <= 65535) {
await entity.write("manuSpecificSinope", { dimmerTimmer: number });
}
return { state: { timer_seconds: number } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["dimmerTimmer"]);
},
},
keypad_lockout: {
// SW2500ZB
key: ["keypad_lockout"],
convertSet: async (entity, key, value, meta) => {
const lookup = { unlock: 0, lock: 1 };
await entity.write("manuSpecificSinope", { keypadLockout: utils.getFromLookup(value, lookup) });
return { state: { keypad_lockout: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["keypadLockout"]);
},
},
low_water_temp_protection: {
// RM3500ZB specific
key: ["low_water_temp_protection"],
convertSet: async (entity, key, value, meta) => {
await entity.write("manuSpecificSinope", { drConfigWaterTempMin: value });
return { state: { low_water_temp_protection: value } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["drConfigWaterTempMin"]);
},
},
eco_mode: {
key: ["eco_mode"],
convertSet: async (entity, key, value, meta) => {
const defaultedValue = value ?? -12.8;
await entity.write("manuSpecificSinope", { ecoMode: defaultedValue * 10 });
return { state: { eco_mode: defaultedValue } };
},
convertGet: async (entity, key, meta) => {
await entity.read("manuSpecificSinope", ["ecoMode"]);
},
},
};
exports.definitions = [
{
zigbeeModel: ["HP6000ZB-GE", "HP6000ZB-HS", "HP6000ZB-MA"],
model: "HP6000ZB",
vendor: "Sinopé",
description: "Mini-split air conditioner interface",
extend: [sinopeExtend.addManuSpecificSinopeCluster()],
fromZigbee: [
fz.fan,
{
cluster: "hvacThermostat",
type: ["attributeReport", "readResponse"],
convert: (model, msg, publish, options, meta) => {
const result = {};
if (Object.hasOwn(msg.data, "localTemp")) {
result.local_temperature = Number.parseFloat((msg.data["localTemp"] / 100).toFixed(1));
}
if (Object.hasOwn(msg.data, "systemMode")) {
const modeLookup = { 0: "off", 3: "cool", 4: "heat", 6: "fan_only", 8: "dry" };
result.system_mode = modeLookup[msg.data["systemMode"]];
}
// Unified setpoint to prevent "Range" UI issues in Home Assistant
if (Object.hasOwn(msg.data, "occupiedHeatingSetpoint") || Object.hasOwn(msg.data, "occupiedCoolingSetpoint")) {
const val = msg.data["occupiedHeatingSetpoint"] || msg.data["occupiedCoolingSetpoint"];
result.occupied_heating_setpoint = Number.parseFloat((val / 100).toFixed(1));
}
return result;
},
},
{
cluster: "manuSpecificSinope",
type: ["attributeReport", "readResponse"],
convert: (model, msg, publish, options, meta) => {
const result = {};
if (msg.data["610"] !== undefined)
result.swing_mode = msg.data["610"] === 1 ? "ON" : "OFF";
if (msg.data["613"] !== undefined)
result.display_led = msg.data["613"] === 1 ? "ON" : "OFF";
if (msg.data["currentSetpoint"] !== undefined) {
result.occupied_heating_setpoint = Number.parseFloat((msg.data["currentSetpoint"] / 100).toFixed(1));
}
return result;
},
},
],
toZigbee: [
tz.thermostat_local_temperature,
tz.thermostat_system_mode,
tz.fan_mode,
{
key: ["occupied_heating_setpoint"],
convertSet: async (entity, key, value, meta) => {
const temp = Math.round(Number(value) * 100);
await entity.write("manuSpecificSinope", { currentSetpoint: temp }, { manufacturerCode: 0x119c });
return { state: { occupied_heating_setpoint: value } };
},
},
{
key: ["swing_mode"],
convertSet: async (entity, key, value, meta) => {
const val = value === "ON" ? 1 : 0;
await entity.write("manuSpecificSinope", { 610: { value: val, type: 0x30 } }, { manufacturerCode: 0x119c });
return { state: { swing_mode: value } };
},
},
{
key: ["display_led"],
convertSet: async (entity, key, value, meta) => {
const val = value === "ON" ? 1 : 0;
await entity.write("manuSpecificSinope", { 613: { value: val, type: 0x30 } }, { manufacturerCode: 0x119c });
return { state: { display_led: value } };
},
},
],
exposes: [
e
.climate()
.withLocalTemperature()
.withSetpoint("occupied_heating_setpoint", 16, 30, 1)
.withSystemMode(["off", "heat", "cool", "dry", "fan_only"])
.withFanMode(["low", "medium", "high", "auto"]),
e.binary("swing_mode", ea.ALL, "ON", "OFF").withDescription("Vertical Swing"),
e.binary("display_led", ea.ALL, "ON", "OFF").withDescription("Display LED"),
],
configure: async (device, coordinatorEndpoint) => {
const endpoint = device.getEndpoint(1);
const binds = ["hvacThermostat", "hvacFanCtrl", "manuSpecificSinope"];
await reporting.bind(endpoint, coordinatorEndpoint, binds);
await reporting.thermostatTemperature(endpoint);
await reporting.thermostatSystemMode(endpoint);
await endpoint.configureReporting("manuSpecificSinope", [
{
attribute: "currentSetpoint",
minimumReportInterval: 1,
maximumReportInterval: 3600,
reportableChange: 10,
},
], { manufacturerCode: 0x119c });
},
},
{
zigbeeModel: ["TH1123ZB"],
model: "TH1123ZB",
vendor: "Sinopé",
description: "Zigbee line volt thermostat",
extend: [sinopeExtend.addManuSpecificSinopeCluster(), sinopeExtend.addSinopeHvacThermostatCluster(), m.electricityMeter()],
fromZigbee: [fzLocal.thermostat, fzLocal.sinope, fz.hvac_user_interface, fz.ignore_temperature_report],
toZigbee: [
tz.thermostat_local_temperature,
tz.thermostat_occupied_heating_setpoint,
tz.thermostat_unoccupied_heating_setpoint,
tz.thermostat_temperature_display_mode,
tz.thermostat_keypad_lockout,
tz.thermostat_system_mode,
tzLocal.backlight_autodim,
tzLocal.thermostat_time,
tzLocal.time_format,
tzLocal.enable_outdoor_temperature,
tzLocal.second_display_mode,
tzLocal.thermostat_outdoor_temperature,
tzLocal.outdoor_temperature_timeout,
tzLocal.thermostat_occupancy,
tzLocal.main_cycle_output,
tzLocal.eco_mode,
],
exposes: [
e
.climate()
.withSetpoint("occupied_heating_setpoint", 5, 30, 0.5)
.withSetpoint("unoccupied_heating_setpoint", 5, 30, 0.5)
.withLocalTemperature()
.withSystemMode(["off", "heat"], ea.ALL, "Mode of the thermostat")
.withPiHeatingDemand()
.withRunningState(["idle", "heat"], ea.STATE),
e.enum("thermostat_occupancy", ea.ALL, ["unoccupied", "occupied"]).withDescription("Occupancy state of the thermostat"),
e
.enum("second_display_mode", ea.ALL, ["auto", "setpoint", "outdoor temp"])
.withDescription('Displays the outdoor temperature and then returns to the set point in "auto" mode, or clears ' +
'in "outdoor temp" mode when expired.'),
e
.numeric("thermostat_outdoor_temperature", ea.ALL)
.withUnit("°C")
.withValueMin(-99.5)
.withValueMax(99.5)
.withValueStep(0.5)
.withDescription("Outdoor temperature for the secondary display"),
e
.numeric("outdoor_temperature_timeout", ea.ALL)
.withUnit("s")
.withValueMin(30)
.withValueMax(64800)
.withPreset("15 min", 900, "15 minutes")
.withPreset("30 min", 1800, "30 minutes")
.withPreset("1 hour", 3600, "1 hour")
.withDescription("Time in seconds after which the outdoor temperature is considered to have expired"),
e
.binary("enable_outdoor_temperature", ea.ALL, "ON", "OFF")
.withDescription("DEPRECATED: Use second_display_mode or control via outdoor_temperature_timeout"),
e
.enum("temperature_display_mode", ea.ALL, ["celsius", "fahrenheit"])
.withDescription("The temperature format displayed on the thermostat screen"),
e.enum("time_format", ea.ALL, ["24h", "12h"]).withDescription("The time format featured on the thermostat display"),
e.enum("backlight_auto_dim", ea.ALL, ["on_demand", "sensing"]).withDescription("Control backlight dimming behavior"),
e.enum("keypad_lockout", ea.ALL, ["unlock", "lock1"]).withDescription("Enables or disables the device’s buttons"),
e.enum("main_cycle_output", ea.ALL, ["15_sec", "15_min"]).withDescription("The length of the control cycle: 15_sec=normal 15_min=fan"),
e
.numeric("eco_mode", ea.ALL)
.withUnit("°C")
.withValueMin(-10)
.withValueMax(10)
.withValueStep(0.5)
.withDescription("Adjusts temperature setpoint to fulfill demand response")
.withPreset("disabled", -12.8, "Disables the eco mode"),
],
configure: async (device, coordinatorEndpoint) => {
const endpoint = device.getEndpoint(1);
const binds = [
"genBasic",
"