dsc-itv2-client 1.0.20 → 1.0.22

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dsc-itv2-client",
   "author": "fajitacat",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "description": "Reverse engineered DSC ITV2 Protocol Client Library for TL280R Communicator - Monitor and control DSC alarm panels",
   "main": "src/index.js",
   "type": "module",

package/src/ITV2Client.js

@@ -210,13 +210,26 @@ export class ITV2Client extends EventEmitter {
     // ==================== Authentication Methods ====================
 
     /**
-     * Authenticate with access code to enable privileged commands (0x0400)
-     * May be required before status queries work
+     * Authenticate with access code - simple format (0x0400)
+     * Uses 6-digit ASCII format matching interactive CLI
+     * @param {string} code - User/master code (e.g., "5555")
+     */
+    authenticate(code) {
+        if (!this._checkEstablished()) return;
+        const codeStr = (code || this.masterCode).toString().padStart(6, '0').slice(0, 6);
+        const payload = Buffer.from(codeStr, 'ascii');
+        const packet = this.session.buildCommand(0x0400, payload);
+        this._sendPacket(packet);
+    }
+
+    /**
+     * Authenticate with access code - extended format (0x0400)
+     * Includes partition and access level metadata
      * @param {number} partition - Partition number (1-8, or 0 for all)
      * @param {string} code - User/master code (e.g., "5555")
      * @param {number} accessLevel - 0=User, 1=Installer, 2=Master
      */
-    authenticate(partition = 1, code, accessLevel = 0) {
+    authenticateExtended(partition = 1, code, accessLevel = 0) {
         if (!this._checkEstablished()) return;
         const packet = this.session.buildAccessLevelEnter(
             code || this.masterCode,

package/src/itv2-session.js

@@ -756,67 +756,121 @@ export class ITv2Session {
     return this.buildCommand(CMD.REQUEST_ACCESS, payload);
   }
 
+  // ==================== VarBytes Encoding ====================
+
   /**
-   * Build status request command
-   * @param {number} statusType - Type of status to request:
-   *   0x10 = Global Status (0x0810)
-   *   0x11 = Zone Status (0x0811)
-   *   0x12 = Partition Status (0x0812)
-   *   0x13 = Zone Bypass Status (0x0813)
-   *   0x14 = System Trouble Status (0x0814)
-   *   0x15 = Alarm Memory Info (0x0815)
-   *   0x16 = Bus Status (0x0816)
-   *   0x17 = Trouble Detail (0x0817)
-   *   0x19 = Door Chime Status (0x0819)
-   * @param {number} partitionOrZone - Partition or zone number (0 = all)
+   * Encode a value as VarBytes (DSC protocol variable-length integer)
+   * Format: [length byte][value bytes in little-endian]
+   * @param {number} value - Value to encode
+   * @returns {Buffer} - VarBytes encoded buffer
    */
-  buildStatusRequest(statusType, partitionOrZone = 0) {
-    // Payload: [status type byte][partition/zone number]
-    const payload = Buffer.from([statusType, partitionOrZone]);
+  encodeVarBytes(value) {
+    if (value < 0x100) {
+      // 1 byte value
+      return Buffer.from([0x01, value & 0xFF]);
+    } else if (value < 0x10000) {
+      // 2 byte value (little-endian)
+      return Buffer.from([0x02, value & 0xFF, (value >> 8) & 0xFF]);
+    } else if (value < 0x1000000) {
+      // 3 byte value (little-endian)
+      return Buffer.from([0x03, value & 0xFF, (value >> 8) & 0xFF, (value >> 16) & 0xFF]);
+    } else {
+      // 4 byte value (little-endian)
+      return Buffer.from([0x04, value & 0xFF, (value >> 8) & 0xFF, (value >> 16) & 0xFF, (value >> 24) & 0xFF]);
+    }
+  }
+
+  // ==================== 0x0800 Command Request Wrapper ====================
+
+  /**
+   * Build a 0x0800 Command Request wrapper
+   * This wraps inner commands for status queries - required by the DSC protocol
+   * Format: [AppSeqNum 1B][CommandToRequest 2B LE][InnerPayload...]
+   * @param {number} innerCommand - The command code to request (e.g., 0x0811)
+   * @param {Buffer} innerPayload - The payload for the inner command
+   * @returns {Buffer} - Complete packet ready to send
+   */
+  buildCommandRequest(innerCommand, innerPayload = Buffer.alloc(0)) {
+    // Get next application sequence number
+    const appSeq = this.appSequence;
+    this.appSequence = (this.appSequence + 1) & 0xFF;
+
+    // Build 0x0800 payload: [AppSeqNum][CommandToRequest LE][InnerPayload]
+    const payload = Buffer.alloc(3 + innerPayload.length);
+    payload[0] = appSeq;
+    payload.writeUInt16LE(innerCommand, 1);  // Command in little-endian
+    innerPayload.copy(payload, 3);
+
+    this.log(`[Session] Building 0x0800 Command Request: innerCmd=0x${innerCommand.toString(16)}, appSeq=${appSeq}`);
+    this.log(`[Session] Inner payload: ${innerPayload.toString('hex')}`);
+
     return this.buildCommand(CMD.STATUS_REQUEST, payload);
   }
 
+  // ==================== Status Query Methods (0x0800 Wrapped) ====================
+
   /**
-   * Build global status request
+   * Build global status request (0x0810 wrapped in 0x0800)
    */
   buildGlobalStatusRequest() {
-    // Send GLOBAL_STATUS (0x0810) command directly, not wrapped in STATUS_REQUEST
-    return this.buildCommand(CMD.GLOBAL_STATUS);
+    // 0x0810 has no payload
+    return this.buildCommandRequest(CMD.GLOBAL_STATUS, Buffer.alloc(0));
   }
 
   /**
-   * Build zone status request
-   * @param {number} zone - Zone number (0 = all zones)
+   * Build zone status request (0x0811 wrapped in 0x0800)
+   * @param {number} startZone - Starting zone number (0 = first zone)
+   * @param {number} numZones - Number of zones to query (default 128)
    */
-  buildZoneStatusRequest(zone = 0) {
-    // Send ZONE_STATUS (0x0811) command directly with zone number
-    const payload = zone > 0 ? Buffer.from([zone]) : Buffer.alloc(0);
-    return this.buildCommand(CMD.ZONE_STATUS, payload);
+  buildZoneStatusRequest(startZone = 0, numZones = 128) {
+    // 0x0811 payload: [ZoneNumber VarBytes][NumberOfZones VarBytes]
+    const zoneBytes = this.encodeVarBytes(startZone);
+    const countBytes = this.encodeVarBytes(numZones);
+    const payload = Buffer.concat([zoneBytes, countBytes]);
+    return this.buildCommandRequest(CMD.ZONE_STATUS, payload);
   }
 
   /**
-   * Build partition status request
+   * Build partition status request (0x0812 wrapped in 0x0800)
    * @param {number} partition - Partition number (0 = all partitions)
+   * @param {number} numPartitions - Number of partitions to query (default 8)
    */
-  buildPartitionStatusRequest(partition = 0) {
-    // Send PARTITION_STATUS (0x0812) command directly with partition number
-    const payload = partition > 0 ? Buffer.from([partition]) : Buffer.alloc(0);
-    return this.buildCommand(CMD.PARTITION_STATUS, payload);
+  buildPartitionStatusRequest(partition = 0, numPartitions = 8) {
+    // 0x0812 payload: [Partition VarBytes][NumberOfPartitions VarBytes]
+    const partBytes = this.encodeVarBytes(partition);
+    const countBytes = this.encodeVarBytes(numPartitions);
+    const payload = Buffer.concat([partBytes, countBytes]);
+    return this.buildCommandRequest(CMD.PARTITION_STATUS, payload);
   }
 
   /**
-   * Build zone bypass status request
+   * Build zone bypass status request (0x0813 wrapped in 0x0800)
    * @param {number} zone - Zone number (0 = all zones)
+   * @param {number} numZones - Number of zones (default 128)
    */
-  buildZoneBypassStatusRequest(zone = 0) {
-    return this.buildStatusRequest(0x13, zone);
+  buildZoneBypassStatusRequest(zone = 0, numZones = 128) {
+    const zoneBytes = this.encodeVarBytes(zone);
+    const countBytes = this.encodeVarBytes(numZones);
+    const payload = Buffer.concat([zoneBytes, countBytes]);
+    return this.buildCommandRequest(CMD.ZONE_BYPASS_STATUS, payload);
   }
 
   /**
-   * Build system trouble status request
+   * Build system trouble status request (0x0814 wrapped in 0x0800)
    */
   buildTroubleStatusRequest() {
-    return this.buildStatusRequest(0x14, 0);
+    // 0x0814 typically has no payload or minimal payload
+    return this.buildCommandRequest(CMD.SYSTEM_TROUBLE_STATUS, Buffer.alloc(0));
+  }
+
+  /**
+   * Build status request command (legacy - simple format)
+   * @deprecated Use buildCommandRequest() with specific inner commands instead
+   */
+  buildStatusRequest(statusType, partitionOrZone = 0) {
+    // Legacy format - kept for backwards compatibility
+    const payload = Buffer.from([statusType, partitionOrZone]);
+    return this.buildCommand(CMD.STATUS_REQUEST, payload);
   }
 
   /**