zigbee-clusters 2.8.2 → 2.9.0

package/index.d.ts

@@ -1829,6 +1829,87 @@ export const WindowCoveringCluster: {
   COMMANDS: unknown;
 };
 
+export const ZIGBEE_PROFILE_ID: {
+  INDUSTRIAL_PLANT_MONITORING: 257;
+  HOME_AUTOMATION: 260;
+  COMMERCIAL_BUILDING_AUTOMATION: 261;
+  TELECOM_APPLICATIONS: 263;
+  PERSONAL_HOME_AND_HOSPITAL_CARE: 264;
+  ADVANCED_METERING_INITIATIVE: 265;
+};
+
+export const ZIGBEE_DEVICE_ID: {
+  GENERIC: {
+    ON_OFF_SWITCH: 0;
+    LEVEL_CONTROL_SWITCH: 1;
+    ON_OFF_OUTPUT: 2;
+    LEVEL_CONTROLLABLE_OUTPUT: 3;
+    SCENE_SELECTOR: 4;
+    CONFIGURATION_TOOL: 5;
+    REMOTE_CONTROL: 6;
+    COMBINED_INTERFACE: 7;
+    RANGE_EXTENDER: 8;
+    MAINS_POWER_OUTLET: 9;
+    DOOR_LOCK: 10;
+    DOOR_LOCK_CONTROLLER: 11;
+    SIMPLE_SENSOR: 12;
+    CONSUMPTION_AWARENESS_DEVICE: 13;
+    HOME_GATEWAY: 80;
+    SMART_PLUG: 81;
+    WHITE_GOODS: 82;
+    METER_INTERFACE: 83;
+  };
+  LIGHTING: {
+    ON_OFF_LIGHT: 256;
+    DIMMABLE_LIGHT: 257;
+    COLOR_DIMMABLE_LIGHT: 258;
+    ON_OFF_LIGHT_SWITCH: 259;
+    DIMMER_SWITCH: 260;
+    COLOR_DIMMER_SWITCH: 261;
+    LIGHT_SENSOR: 262;
+    OCCUPANCY_SENSOR: 263;
+  };
+  CLOSURES: {
+    SHADE: 512;
+    SHADE_CONTROLLER: 513;
+    WINDOW_COVERING_DEVICE: 514;
+    WINDOW_COVERING_CONTROLLER: 515;
+  };
+  HVAC: {
+    HEATING_COOLING_UNIT: 768;
+    THERMOSTAT: 769;
+    TEMPERATURE_SENSOR: 770;
+    PUMP: 771;
+    PUMP_CONTROLLER: 772;
+    PRESSURE_SENSOR: 773;
+    FLOW_SENSOR: 774;
+  };
+  INTRUDER_ALARM_SYSTEMS: {
+    IAS_CONTROL_INDICATING_EQUIPMENT: 1024;
+    IAS_ANCILLARY_CONTROL_EQUIPMENT: 1025;
+    IAS_ZONE: 1026;
+    IAS_WARNING_DEVICE: 1027;
+  };
+};
+
+export const IAS_ZONE_TYPE: {
+  STANDARD_CIE: 0;
+  MOTION_SENSOR: 13;
+  CONTACT_SWITCH: 21;
+  FIRE_SENSOR: 40;
+  WATER_SENSOR: 42;
+  CARBON_MONOXIDE_SENSOR: 43;
+  PERSONAL_EMERGENCY_DEVICE: 44;
+  VIBRATION_MOVEMENT_SENSOR: 45;
+  REMOTE_CONTROL: 271;
+  KEY_FOB: 277;
+  KEYPAD: 541;
+  STANDARD_WARNING_DEVICE: 549;
+  GLASS_BREAK_SENSOR: 550;
+  SECURITY_REPEATER: 553;
+  INVALID_ZONE_TYPE: 65535;
+};
+
 declare const _default: {
   ZCLNode: typeof ZCLNode;
   CLUSTER: typeof CLUSTER;
@@ -1878,5 +1959,8 @@ declare const _default: {
   TimeCluster: typeof TimeCluster;
   TouchLinkCluster: typeof TouchLinkCluster;
   WindowCoveringCluster: typeof WindowCoveringCluster;
+  ZIGBEE_PROFILE_ID: typeof ZIGBEE_PROFILE_ID;
+  ZIGBEE_DEVICE_ID: typeof ZIGBEE_DEVICE_ID;
+  IAS_ZONE_TYPE: typeof IAS_ZONE_TYPE;
 };
 export default _default;

package/index.js

@@ -44,6 +44,8 @@ const {
   ZCLStruct,
 } = zclTypes;
 
+const { ZIGBEE_PROFILE_ID, ZIGBEE_DEVICE_ID, IAS_ZONE_TYPE } = require('./lib/constants');
+
 module.exports = {
   Cluster,
   BoundCluster,
@@ -55,4 +57,7 @@ module.exports = {
   ZCLStruct,
   ...Clusters,
   debug,
+  ZIGBEE_PROFILE_ID,
+  ZIGBEE_DEVICE_ID,
+  IAS_ZONE_TYPE,
 };

package/lib/constants.js

@@ -0,0 +1,97 @@
+'use strict';
+
+/**
+ * Zigbee Profile IDs from the ZCL specification.
+ */
+const ZIGBEE_PROFILE_ID = {
+  INDUSTRIAL_PLANT_MONITORING: 0x0101,
+  HOME_AUTOMATION: 0x0104,
+  COMMERCIAL_BUILDING_AUTOMATION: 0x0105,
+  TELECOM_APPLICATIONS: 0x0107,
+  PERSONAL_HOME_AND_HOSPITAL_CARE: 0x0108,
+  ADVANCED_METERING_INITIATIVE: 0x0109,
+};
+
+/**
+ * Zigbee Device IDs from the ZCL specification.
+ */
+const ZIGBEE_DEVICE_ID = {
+  GENERIC: {
+    ON_OFF_SWITCH: 0x0000,
+    LEVEL_CONTROL_SWITCH: 0x0001,
+    ON_OFF_OUTPUT: 0x0002,
+    LEVEL_CONTROLLABLE_OUTPUT: 0x0003,
+    SCENE_SELECTOR: 0x0004,
+    CONFIGURATION_TOOL: 0x0005,
+    REMOTE_CONTROL: 0x0006,
+    COMBINED_INTERFACE: 0x0007,
+    RANGE_EXTENDER: 0x0008,
+    MAINS_POWER_OUTLET: 0x0009,
+    DOOR_LOCK: 0x000a,
+    DOOR_LOCK_CONTROLLER: 0x000b,
+    SIMPLE_SENSOR: 0x000c,
+    CONSUMPTION_AWARENESS_DEVICE: 0x000d,
+    HOME_GATEWAY: 0x0050,
+    SMART_PLUG: 0x0051,
+    WHITE_GOODS: 0x0052,
+    METER_INTERFACE: 0x0053,
+  },
+  LIGHTING: {
+    ON_OFF_LIGHT: 0x0100,
+    DIMMABLE_LIGHT: 0x0101,
+    COLOR_DIMMABLE_LIGHT: 0x0102,
+    ON_OFF_LIGHT_SWITCH: 0x0103,
+    DIMMER_SWITCH: 0x0104,
+    COLOR_DIMMER_SWITCH: 0x0105,
+    LIGHT_SENSOR: 0x0106,
+    OCCUPANCY_SENSOR: 0x0107,
+  },
+  CLOSURES: {
+    SHADE: 0x0200,
+    SHADE_CONTROLLER: 0x0201,
+    WINDOW_COVERING_DEVICE: 0x0202,
+    WINDOW_COVERING_CONTROLLER: 0x0203,
+  },
+  HVAC: {
+    HEATING_COOLING_UNIT: 0x0300,
+    THERMOSTAT: 0x0301,
+    TEMPERATURE_SENSOR: 0x0302,
+    PUMP: 0x0303,
+    PUMP_CONTROLLER: 0x0304,
+    PRESSURE_SENSOR: 0x0305,
+    FLOW_SENSOR: 0x0306,
+  },
+  INTRUDER_ALARM_SYSTEMS: {
+    IAS_CONTROL_INDICATING_EQUIPMENT: 0x0400,
+    IAS_ANCILLARY_CONTROL_EQUIPMENT: 0x0401,
+    IAS_ZONE: 0x0402,
+    IAS_WARNING_DEVICE: 0x0403,
+  },
+};
+
+/**
+ * IAS Zone Type values from the ZCL specification (IAS Zone cluster, zoneType attribute).
+ */
+const IAS_ZONE_TYPE = {
+  STANDARD_CIE: 0x0000,
+  MOTION_SENSOR: 0x000d,
+  CONTACT_SWITCH: 0x0015,
+  FIRE_SENSOR: 0x0028,
+  WATER_SENSOR: 0x002a,
+  CARBON_MONOXIDE_SENSOR: 0x002b,
+  PERSONAL_EMERGENCY_DEVICE: 0x002c,
+  VIBRATION_MOVEMENT_SENSOR: 0x002d,
+  REMOTE_CONTROL: 0x010f,
+  KEY_FOB: 0x0115,
+  KEYPAD: 0x021d,
+  STANDARD_WARNING_DEVICE: 0x0225,
+  GLASS_BREAK_SENSOR: 0x0226,
+  SECURITY_REPEATER: 0x0229,
+  INVALID_ZONE_TYPE: 0xffff,
+};
+
+module.exports = {
+  ZIGBEE_PROFILE_ID,
+  ZIGBEE_DEVICE_ID,
+  IAS_ZONE_TYPE,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zigbee-clusters",
-  "version": "2.8.2",
+  "version": "2.9.0",
   "description": "Zigbee Cluster Library for Node.js",
   "main": "index.js",
   "types": "index.d.ts",

package/scripts/generate-types.js

@@ -217,7 +217,22 @@ function generateClusterInterface(cluster) {
  * }>} clusterDefinitions - Array of CLUSTER definitions used to generate typed CLUSTER exports
  * @returns {string} Complete TypeScript definitions file
  */
-function generateTypesFile(clusters, clusterDefinitions) {
+function generateConstantObject(obj, indent = 2) {
+  const lines = [];
+  const pad = ' '.repeat(indent);
+  for (const [key, value] of Object.entries(obj)) {
+    if (typeof value === 'object' && value !== null) {
+      lines.push(`${pad}${key}: {`);
+      lines.push(generateConstantObject(value, indent + 2));
+      lines.push(`${pad}};`);
+    } else {
+      lines.push(`${pad}${key}: ${typeof value === 'number' ? value : JSON.stringify(value)};`);
+    }
+  }
+  return lines.join('\n');
+}
+
+function generateTypesFile(clusters, clusterDefinitions, constants) {
   const lines = [];
 
   // Header
@@ -400,6 +415,16 @@ export const CLUSTER: {
     lines.push('};');
   }
 
+  // Export constants
+  if (constants) {
+    for (const [name, value] of Object.entries(constants)) {
+      lines.push('');
+      lines.push(`export const ${name}: {`);
+      lines.push(generateConstantObject(value));
+      lines.push('};');
+    }
+  }
+
   lines.push('');
   lines.push('declare const _default: {');
   lines.push('  ZCLNode: typeof ZCLNode;');
@@ -408,6 +433,11 @@ export const CLUSTER: {
     const exportName = cluster.exportName || toInterfaceName(cluster);
     lines.push(`  ${exportName}: typeof ${exportName};`);
   }
+  if (constants) {
+    for (const name of Object.keys(constants)) {
+      lines.push(`  ${name}: typeof ${name};`);
+    }
+  }
   lines.push('};');
   lines.push('export default _default;');
 
@@ -448,8 +478,12 @@ function main() {
     }))
     .sort((a, b) => a.constantName.localeCompare(b.constantName));
 
+  // Load constants
+  const { ZIGBEE_PROFILE_ID, ZIGBEE_DEVICE_ID, IAS_ZONE_TYPE } = require('../lib/constants');
+  const constants = { ZIGBEE_PROFILE_ID, ZIGBEE_DEVICE_ID, IAS_ZONE_TYPE };
+
   console.log(`\nGenerating ${OUTPUT_FILE}...`);
-  const output = generateTypesFile(clusters, clusterDefinitions);
+  const output = generateTypesFile(clusters, clusterDefinitions, constants);
   fs.writeFileSync(OUTPUT_FILE, output);
 
   console.log(`Done! Generated types for ${clusters.length} clusters.`);