zigbee-herdsman-converters
Version:
Collection of device converters to be used with zigbee-herdsman
445 lines • 20.5 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 exposes = __importStar(require("../lib/exposes"));
const m = __importStar(require("../lib/modernExtend"));
const reporting = __importStar(require("../lib/reporting"));
const utils = __importStar(require("../lib/utils"));
const e = exposes.presets;
const ea = exposes.access;
const _manufacturerOptions = { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V };
const plugwisePushForceLookup = {
0: "standard",
393216: "high",
458752: "very_high",
};
const plugwiseRadioStrengthLookup = {
0: "normal",
1: "high",
};
const plugwiseExtend = {
plugwiseHvacThermostatCluster: () => m.deviceAddCustomCluster("hvacThermostat", {
name: "hvacThermostat",
ID: zigbee_herdsman_1.Zcl.Clusters.hvacThermostat.ID,
attributes: {
plugwiseValvePosition: { name: "plugwiseValvePosition", ID: 0x4001, type: zigbee_herdsman_1.Zcl.DataType.UINT8 },
// plugwiseErrorStatus: {name: "plugwiseErrorStatus", ID: 0x4002, type: Zcl.DataType.??},
plugwiseCurrentHeatingSetpoint: { name: "plugwiseCurrentHeatingSetpoint", ID: 0x4003, type: zigbee_herdsman_1.Zcl.DataType.INT16 },
plugwiseTDiff: { name: "plugwiseTDiff", ID: 0x4008, type: zigbee_herdsman_1.Zcl.DataType.INT16 },
plugwisePushForce: { name: "plugwisePushForce", ID: 0x4012, type: zigbee_herdsman_1.Zcl.DataType.UINT32 },
plugwiseRadioStrength: { name: "plugwiseRadioStrength", ID: 0x4014, type: zigbee_herdsman_1.Zcl.DataType.BOOLEAN },
plugwiseExternalHeatDemand: {
name: "plugwiseExternalHeatDemand",
ID: 0xf000,
type: zigbee_herdsman_1.Zcl.DataType.UINT16,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
write: true,
},
plugwiseExternalHeatDemandTimeout: {
name: "plugwiseExternalHeatDemandTimeout",
ID: 0xf001,
type: zigbee_herdsman_1.Zcl.DataType.UINT16,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
write: true,
},
plugwiseBoilerWaterTemp: {
name: "plugwiseBoilerWaterTemp",
ID: 0xf002,
type: zigbee_herdsman_1.Zcl.DataType.INT16,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
},
plugwiseDhwTemp: {
name: "plugwiseDhwTemp",
ID: 0xf003,
type: zigbee_herdsman_1.Zcl.DataType.INT16,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
},
plugwiseReturnWaterTemp: {
name: "plugwiseReturnWaterTemp",
ID: 0xf004,
type: zigbee_herdsman_1.Zcl.DataType.INT16,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
},
plugwiseApplicationFaultCode: {
name: "plugwiseApplicationFaultCode",
ID: 0xf005,
type: zigbee_herdsman_1.Zcl.DataType.BITMAP8,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
},
plugwiseOemFaultCode: {
name: "plugwiseOemFaultCode",
ID: 0xf006,
type: zigbee_herdsman_1.Zcl.DataType.UINT8,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
},
plugwiseMaxDhwSetpoint: {
name: "plugwiseMaxDhwSetpoint",
ID: 0xf007,
type: zigbee_herdsman_1.Zcl.DataType.INT16,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
write: true,
},
plugwiseMaxBoilerSetpoint: {
name: "plugwiseMaxBoilerSetpoint",
ID: 0xf008,
type: zigbee_herdsman_1.Zcl.DataType.INT16,
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
write: true,
},
},
commands: {
plugwiseCalibrateValve: { name: "plugwiseCalibrateValve", ID: 0xa0, parameters: [] },
},
commandsResponse: {},
}),
boilerWaterTemperature: (args) => m.numeric({
name: "boiler_water_temperature",
cluster: "hvacThermostat",
attribute: "plugwiseBoilerWaterTemp",
description: "Boiler supply water temperature reported by OpenTherm.",
zigbeeCommandOptions: { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V },
access: "STATE",
unit: "°C",
scale: 100,
...args,
}),
dhwTemperature: (args) => m.numeric({
name: "dhw_temperature",
cluster: "hvacThermostat",
attribute: "plugwiseDhwTemp",
description: "Domestic hot water temperature reported by OpenTherm.",
zigbeeCommandOptions: { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V },
access: "STATE",
unit: "°C",
scale: 100,
...args,
}),
returnWaterTemperature: (args) => m.numeric({
name: "return_water_temperature",
cluster: "hvacThermostat",
attribute: "plugwiseReturnWaterTemp",
description: "Boiler return water temperature reported by OpenTherm.",
zigbeeCommandOptions: { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V },
access: "STATE",
unit: "°C",
scale: 100,
...args,
}),
applicationFaultCode: (args) => m.numeric({
name: "application_fault_code",
cluster: "hvacThermostat",
attribute: "plugwiseApplicationFaultCode",
description: "OpenTherm application fault bitmap (bit0=service_request, bit1=lockout_reset, bit2=low_water_pressure, bit3=gas_flame_fault, bit4=air_pressure_fault, bit5=water_over_temp).",
zigbeeCommandOptions: { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V },
access: "STATE",
valueMin: 0,
valueMax: 255,
reporting: false,
...args,
}),
oemFaultCode: (args) => m.numeric({
name: "oem_fault_code",
cluster: "hvacThermostat",
attribute: "plugwiseOemFaultCode",
description: "OpenTherm OEM-specific fault code.",
zigbeeCommandOptions: { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V },
access: "STATE",
valueMin: 0,
valueMax: 255,
reporting: false,
...args,
}),
applicationFaultCodeStatus: (args) => m.numeric({
name: "application_fault_status",
cluster: "hvacThermostat",
attribute: "plugwiseApplicationFaultCode",
description: "OpenTherm application fault status.",
zigbeeCommandOptions: { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V },
access: "STATE",
fzConvert: (model, msg, publish, options, meta) => {
if (msg.data.plugwiseApplicationFaultCode !== undefined) {
const value = msg.data.plugwiseApplicationFaultCode;
const activeFaults = [];
if ((value & (1 << 0)) > 0)
activeFaults.push("Service request");
if ((value & (1 << 1)) > 0)
activeFaults.push("Lockout reset");
if ((value & (1 << 2)) > 0)
activeFaults.push("Low water pressure");
if ((value & (1 << 3)) > 0)
activeFaults.push("Gas/flame fault");
if ((value & (1 << 4)) > 0)
activeFaults.push("Air pressure fault");
if ((value & (1 << 5)) > 0)
activeFaults.push("Water over-temperature");
return {
application_fault_status: activeFaults.length > 0 ? activeFaults.join(", ") : "None",
};
}
},
reporting: false,
...args,
}),
};
const fzLocal = {
plugwise_radiator_valve: {
cluster: "hvacThermostat",
type: ["attributeReport", "readResponse"],
convert: (model, msg, publish, options, meta) => {
const result = fz.thermostat.convert(model, msg, publish, options, meta);
// Reports pIHeatingDemand between 0 and 100 already
if (typeof msg.data.pIHeatingDemand === "number") {
result.pi_heating_demand = utils.precisionRound(msg.data.pIHeatingDemand, 0);
}
if (typeof msg.data.plugwiseCurrentHeatingSetpoint === "number") {
result.current_heating_setpoint = utils.precisionRound(msg.data.plugwiseCurrentHeatingSetpoint, 2) / 100;
}
if (typeof msg.data.plugwiseTDiff === "number") {
result.plugwise_t_diff = msg.data.plugwiseTDiff;
}
if (typeof msg.data[0x4002] === "number") {
result.error_status = msg.data[0x4002];
}
if (typeof msg.data.plugwiseValvePosition === "number") {
result.valve_position = msg.data.plugwiseValvePosition;
}
return result;
},
},
};
const tzLocal = {
plugwise_calibrate_valve: {
key: ["calibrate_valve"],
convertSet: async (entity, key, value, meta) => {
await entity.command("hvacThermostat", "plugwiseCalibrateValve", {}, { srcEndpoint: 11, disableDefaultResponse: true });
return { state: { calibrate_valve: value } };
},
},
plugwise_valve_position: {
key: ["plugwise_valve_position", "valve_position"],
convertSet: async (entity, key, value, meta) => {
// const payload = {plugwiseValvePosition: {value, type: 0x20}};
await entity.write("hvacThermostat", { plugwiseValvePosition: value }, { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V });
// Tom does not automatically send back updated value so ask for it
await entity.read("hvacThermostat", ["plugwiseValvePosition"], {
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
});
},
convertGet: async (entity, key, meta) => {
await entity.read("hvacThermostat", ["plugwiseValvePosition"], {
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
});
},
},
plugwise_push_force: {
key: ["plugwise_push_force", "force"],
convertSet: async (entity, key, value, meta) => {
const val = utils.getKey(plugwisePushForceLookup, value, value, Number);
await entity.write("hvacThermostat", { plugwisePushForce: val }, { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V });
},
convertGet: async (entity, key, meta) => {
await entity.read("hvacThermostat", ["plugwisePushForce"], {
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
});
},
},
plugwise_radio_strength: {
key: ["plugwise_radio_strength", "radio_strength"],
convertSet: async (entity, key, value, meta) => {
const val = utils.getKey(plugwiseRadioStrengthLookup, value, value, Number);
await entity.write("hvacThermostat", { plugwiseRadioStrength: val }, { manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V });
},
convertGet: async (entity, key, meta) => {
await entity.read("hvacThermostat", ["plugwiseRadioStrength"], {
manufacturerCode: zigbee_herdsman_1.Zcl.ManufacturerCode.PLUGWISE_B_V,
});
},
},
};
exports.definitions = [
{
zigbeeModel: ["160-01"],
model: "160-01",
vendor: "Plugwise",
description: "Plug power socket on/off with power consumption monitoring",
fromZigbee: [fz.on_off, fz.metering],
toZigbee: [tz.on_off],
configure: async (device, coordinatorEndpoint) => {
const endpoint = device.getEndpoint(1);
await reporting.bind(endpoint, coordinatorEndpoint, ["genOnOff", "seMetering"]);
await reporting.onOff(endpoint);
await reporting.readMeteringMultiplierDivisor(endpoint);
await reporting.instantaneousDemand(endpoint);
},
exposes: [e.switch(), e.power(), e.energy()],
},
{
zigbeeModel: ["106-03"],
model: "106-03",
vendor: "Plugwise",
description: "Tom thermostatic radiator valve",
extend: [plugwiseExtend.plugwiseHvacThermostatCluster()],
fromZigbee: [fz.temperature, fz.battery, fzLocal.plugwise_radiator_valve],
// system_mode and occupied_heating_setpoint is not supported: https://github.com/Koenkk/zigbee2mqtt.io/pull/1666
toZigbee: [
tz.thermostat_pi_heating_demand,
tzLocal.plugwise_valve_position,
tzLocal.plugwise_push_force,
tzLocal.plugwise_radio_strength,
tzLocal.plugwise_calibrate_valve,
],
configure: async (device, coordinatorEndpoint) => {
const endpoint = device.getEndpoint(1);
await reporting.bind(endpoint, coordinatorEndpoint, ["genBasic", "genPowerCfg", "hvacThermostat"]);
await reporting.batteryPercentageRemaining(endpoint);
await reporting.thermostatTemperature(endpoint);
await reporting.thermostatPIHeatingDemand(endpoint);
},
exposes: [
e.battery(),
e
.numeric("pi_heating_demand", ea.STATE_GET)
.withValueMin(0)
.withValueMax(100)
.withUnit("%")
.withDescription("Position of the valve (= demanded heat) where 0% is fully closed and 100% is fully open"),
e.numeric("local_temperature", ea.STATE).withUnit("°C").withDescription("Current temperature measured on the device"),
e
.numeric("valve_position", ea.ALL)
.withValueMin(0)
.withValueMax(100)
.withDescription("Directly control the radiator valve. The values range from 0 (valve closed) to 100 (valve fully open)"),
e
.enum("force", ea.ALL, ["standard", "high", "very_high"])
.withDescription("How hard the motor pushes the valve. The closer to the boiler, the higher the force needed"),
e.enum("radio_strength", ea.ALL, ["normal", "high"]).withDescription("Transmits with higher power when range is not sufficient"),
e.binary("calibrate_valve", ea.STATE_SET, "calibrate", "idle").withDescription("Calibrates valve on next wakeup"),
],
},
{
zigbeeModel: ["158-01"],
model: "158-01",
vendor: "Plugwise",
description: "Lisa zone thermostat",
extend: [
m.thermostat({
setpoints: { values: { occupiedHeatingSetpoint: { min: 0, max: 30, step: 0.5 } } },
systemMode: { values: ["off", "auto"] },
}),
m.battery(),
],
},
{
zigbeeModel: ["170-01"],
model: "170-01",
vendor: "Plugwise",
description: "Emma Wired Pro / Emma Wireless",
extend: [
plugwiseExtend.plugwiseHvacThermostatCluster(),
plugwiseExtend.applicationFaultCodeStatus(),
plugwiseExtend.oemFaultCode(),
m.temperature({
reporting: { min: "1_SECOND", max: 870, change: 0.1 },
}),
m.thermostat({
setpoints: {
values: {
occupiedCoolingSetpoint: { min: 0, max: 30, step: 0.5 },
occupiedHeatingSetpoint: { min: 5, max: 30, step: 0.5 },
},
configure: { reporting: { min: "1_SECOND", max: 870, change: 0.5 } },
},
runningState: {
values: ["idle", "heat", "cool"],
configure: { reporting: { min: "1_SECOND", max: 870, change: null } },
},
systemMode: {
values: ["off", "heat", "cool", "auto"],
configure: { reporting: { min: "1_SECOND", max: 870, change: null } },
},
localTemperatureCalibration: {
values: { min: -12.5, max: 12.5, step: 0.1 },
configure: { reporting: { min: "1_SECOND", max: 870, change: 0 } },
},
}),
m.humidity({
reporting: { min: "10_SECONDS", max: 870, change: 3 },
}),
m.numeric({
name: "outdoor_temperature",
cluster: "hvacThermostat",
attribute: "outdoorTemp",
description: "Outdoor temperature reported by thermostat.",
access: "STATE_GET",
unit: "°C",
scale: 100,
reporting: { min: "10_SECONDS", max: 870, change: 0.1 },
}),
plugwiseExtend.dhwTemperature({
reporting: { min: "1_MINUTE", max: 870, change: 0.1 },
}),
plugwiseExtend.returnWaterTemperature({
reporting: { min: "1_MINUTE", max: 870, change: 0.1 },
}),
plugwiseExtend.boilerWaterTemperature({
reporting: { min: "1_MINUTE", max: 870, change: 0.1 },
}),
m.numeric({
name: "boiler_setpoint",
cluster: "hvacThermostat",
attribute: "pIHeatingDemand",
description: "Intended boiler water temperature",
unit: "°C",
access: "STATE",
reporting: { min: "1_SECOND", max: 870, change: 1 },
}),
m.battery(),
m.enumLookup({
name: "keypad_lockout",
cluster: "hvacUserInterfaceCfg",
attribute: "keypadLockout",
lookup: { no_lockout: 0x00, level_1: 0x01, level_2: 0x02 },
description: "Keaypad lockout. No lockout — all buttons active. Level 1 — normal operation, menu blocked; setpoint change via slider still allowed. Level 2 — all buttons and slider blocked; only the hardware unlock sequence is accepted.",
reporting: { min: "1_SECOND", max: 870, change: null },
entityCategory: "config",
}),
],
},
];
//# sourceMappingURL=plugwise.js.map