knx.ts 1.0.8 → 1.0.11

package/dist/@types/interfaces/DPTs.d.ts

@@ -3,7 +3,7 @@ export interface DPT1 {
 }
 export interface DPT2 {
     control: 0 | 1;
-    valueDpt2: 0 | 1;
+    value: 0 | 1;
 }
 export interface DPT3 {
     control: 0 | 1;
@@ -13,29 +13,29 @@ export interface DPT4 {
     char: string;
 }
 export interface DPT5 {
-    valueDpt5: number;
+    value: number;
 }
 export interface DPT5001 {
-    valueDpt5001: number;
+    value: number;
 }
 export interface DPT5002 {
-    valueDpt5002: number;
+    value: number;
 }
 export interface DPT6 {
-    valueDpt6: number;
+    value: number;
 }
 export interface DPT6020 {
     status: 0 | 1;
     mode: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
 }
 export interface DPT7 {
-    valueDpt7: number;
+    value: number;
 }
 export interface DPT8 {
-    valueDpt8: number;
+    value: number;
 }
 export interface DPT9 {
-    valueDpt9: number;
+    value: number;
 }
 export interface DPT10001 {
     day: number;
@@ -49,13 +49,13 @@ export interface DPT11001 {
     year: number;
 }
 export interface DPT12001 {
-    valueDpt12001: number;
+    value: number;
 }
 export interface DPT13001 {
-    valueDpt13001: number;
+    value: number;
 }
 export interface DPT14 {
-    valueDpt14: number;
+    value: number;
 }
 export interface DPT15 {
     D6: number;
@@ -77,17 +77,17 @@ export interface DPT16002 {
     hex: string;
 }
 export interface DPT20 {
-    valueDpt20: number;
+    value: number;
 }
 export interface DPT27001 {
     mask: number;
     status: number;
 }
 export interface DPT28001 {
-    textDpt28001: string;
+    value: string;
 }
 export interface DPT29 {
-    valueDpt29: bigint;
+    value: bigint;
 }
 export interface DPT238600 {
     BF: 0 | 1;

package/dist/@types/interfaces/ServiceMessage.d.ts

@@ -3,7 +3,10 @@ export interface DescribeEstructure {
      * Proporciona una descripción legible del estado actual de las propiedades del sistema.
      * @returns Un objeto que describe el estado de cada propiedad.
      */
-    describe(): Record<string, string | number | Buffer | Record<string, any>>;
+    describe(): {
+        obj: string;
+        [key: string]: string | number | Buffer | boolean | Record<string, any>;
+    };
 }
 export interface ServiceMessage extends DescribeEstructure {
     /** Write the service to the buffer */

package/dist/@types/interfaces/connection.d.ts

@@ -1,5 +1,6 @@
 import pino from "pino";
 import { ConnectionType } from "../../core/enum/KNXnetIPEnum";
+import { CEMIInstance } from "../../core/CEMI";
 /**
  * Options for configuring a KNX Tunneling connection.
  */
@@ -29,12 +30,30 @@ export interface KNXTunnelingOptions extends KNXnetIPOptions {
      */
     maxQueueSize?: number;
 }
-export interface KNXnetIPServerOptions extends Omit<KNXnetIPOptions, "ip" | "port"> {
+export interface KNXnetIPServerOptions extends Omit<KNXnetIPOptions, "ip"> {
+    /**
+     * IP for Multicast
+     */
     ip?: string;
+    /**
+     * Port for listening to Tunneling clients
+     */
     port?: number;
+    /**
+     * Individual address for KNXnetIpServer
+     */
     individualAddress?: string;
+    /**
+     * MAC address for the KNXnetIP
+     */
     serialNumber?: Buffer;
+    /**
+     * The name displayed to other KNXnetIP devices or applications such as ETS.
+     */
     friendlyName?: string;
+    /**
+     * MAC address for the KNXnetIP
+     */
     macAddress?: string;
     /**
      * Defines the client address pool for KNXnet/IP Tunneling connections (e.g. "15.15.10:10" or "1.1.1:5").
@@ -67,15 +86,21 @@ export interface ExternalManagerOptions {
     /**
      * Optional configuration for a physical TPUART connection.
      */
-    tpuart?: TPUARTOptions;
+    tpuart?: {
+        individualAddress?: string;
+    } & Omit<TPUARTOptions, "individualAddress">;
     /**
      * Optional list of outbound KNX IP Tunneling client connections.
      */
-    tunneling?: KNXTunnelingOptions[];
+    tunneling?: {
+        individualAddress?: string;
+    } & Omit<KNXTunnelingOptions, "individualAddress">[];
     /**
      * Optional configuration for a physical KNX USB connection.
      */
-    usb?: KNXUSBOptions;
+    usb?: {
+        individualAddress?: string;
+    } & Omit<KNXUSBOptions, "individualAddress">;
     /**
      * Pino logger configuration for the Router bridge.
      */
@@ -116,8 +141,14 @@ export interface KNXLoggerOptions extends pino.LoggerOptions {
     logKeepCount?: number;
 }
 export interface KNXnetIPOptions {
+    /**
+     * IP address of the KNXnetIP server
+     */
     ip: string;
-    port: number;
+    /**
+     * Port of the KNXnetIP server
+     */
+    port?: number;
     localIp?: string;
     localPort?: number;
     /**
@@ -204,3 +235,7 @@ export interface KNXDiscoveredDevice {
     macAddress: string;
     friendlyName: string;
 }
+export interface IndicationRouterLink {
+    src: string;
+    msg: CEMIInstance;
+}

package/dist/@types/interfaces/servers.d.ts

@@ -1,6 +1,7 @@
 import { KNXService } from "../../connection/KNXService";
+import { Router } from "../../connection/Router";
 export interface MQTTGatewayOptions {
-    knxContext: KNXService;
+    knxContext: KNXService | Router;
     embeddedBroker?: {
         port: number;
         host?: string;
@@ -11,8 +12,9 @@ export interface MQTTGatewayOptions {
     topicPrefix?: string;
 }
 export interface WebSocketGatewayOptions {
+    host: string;
     port: number;
-    knxContext: KNXService;
+    knxContext: KNXService | Router;
 }
 export interface WSClientPayload {
     action: "read" | "query" | "write" | "config_dpt" | "subscribe" | "unsubscribe";

package/dist/connection/KNXTunneling.js

@@ -43,6 +43,7 @@ class KNXTunneling extends KNXService_1.KNXService {
         if (!this.options.connectionType) {
             this.options.connectionType = KNXnetIPEnum_1.ConnectionType.TUNNEL_CONNECTION;
         }
+        this.options.port = options.port || 3671;
         this.MAX_QUEUE_SIZE = options.maxQueueSize || 100;
         this.logger = this.logger.child({ module: "TunnelClient" });
     }

package/dist/connection/KNXnetIPServer.js

@@ -50,6 +50,8 @@ class KNXnetIPServer extends KNXService_1.KNXService {
         // Set defaults for discovery if not provided
         const routingOptions = this.options;
         const netInfo = (0, localIp_1.getNetworkInfo)();
+        this.options.ip = options.ip || "224.0.23.12";
+        this.options.port = options.port || 3671;
         this.options.localIp = options.localIp || netInfo.address;
         routingOptions.individualAddress = options.individualAddress || "15.15.0";
         this.individualAddress = routingOptions.individualAddress;
@@ -62,7 +64,7 @@ class KNXnetIPServer extends KNXService_1.KNXService {
         if (!options.serialNumber) {
             // eslint-disable-next-line no-useless-escape
             const macBuf = Buffer.from(netInfo.mac.replace(/[:\-]/g, ""), "hex");
-            const port = options.port || 3671;
+            const port = this.options.port;
             const serial = Buffer.from(macBuf);
             serial[0] ^= (port >> 8) & 0xff;
             serial[1] ^= port & 0xff;
@@ -76,7 +78,7 @@ class KNXnetIPServer extends KNXService_1.KNXService {
         routingOptions.routingDelay = options.routingDelay ?? 20;
         if (routingOptions.MAX_PENDING_REQUESTS_PER_CLIENT)
             this.MAX_PENDING_REQUESTS_PER_CLIENT = routingOptions.MAX_PENDING_REQUESTS_PER_CLIENT;
-        this.logger.info(`Initialized on ${this.options.localIp}:${options.port || 3671}`);
+        this.logger.info(`Initialized on ${this.options.localIp}:${this.options.port}`);
         this.logger.info(`Serial Number: ${routingOptions.serialNumber.toString("hex").toUpperCase()}`);
         const serverIA = KNXHelper_1.KNXHelper.GetAddress(routingOptions.individualAddress, ".").readUInt16BE();
         this.serverIAInt = serverIA;
@@ -123,7 +125,7 @@ class KNXnetIPServer extends KNXService_1.KNXService {
                         try {
                             socket.addMembership(this.options.ip, this.options.localIp);
                             joinedInterfaces.add(this.options.localIp);
-                            this.logger.info(`Joined multicast on primary interface (${this.options.localIp})`);
+                            this.logger.info(`Joined multicast on primary interface (${this.options.ip})`);
                             // eslint-disable-next-line @typescript-eslint/no-unused-vars
                         }
                         catch (e) {

package/dist/connection/Router.js

@@ -61,7 +61,8 @@ class Router extends events_1.EventEmitter {
             options.tunneling.forEach((c) => {
                 // * Tunneling doesn't support individualAddress, is assigned by the tunnel connection
                 // c.individualAddress = this.routerAddress;
-                this.registerLink(`IP Tunneling: ${c.ip}:${c.port}`, new KNXTunneling_1.KNXTunneling(c));
+                const client = new KNXTunneling_1.KNXTunneling(c);
+                this.registerLink(`IP Tunneling: ${client.options.ip}:${client.options.port}`, client);
             });
         }
         if (options.usb) {
@@ -175,7 +176,7 @@ class Router extends events_1.EventEmitter {
         // If packet is destined for the router itself, consume it and don't route
         if (!isGroup && dest === this.routerAddress) {
             this.logger.debug({ src: data.sourceAddress }, "Packet consumed by router local address");
-            this.emit("indication_link", { src: source.constructor.name, msg: data });
+            this.emit("indication_link", { src: keySource, msg: data });
             return;
         }
         // Selective Routing (IA)
@@ -188,7 +189,7 @@ class Router extends events_1.EventEmitter {
                     });
                 }
                 // Send to upper layers (KNXnet/IP server core)
-                this.emit("indication_link", { src: source.constructor.name, msg: data });
+                this.emit("indication_link", { src: keySource, msg: data });
                 return; // Do not flood
             }
             // If target is unknown, knxd broadcasts it to all interfaces
@@ -209,7 +210,7 @@ class Router extends events_1.EventEmitter {
             this.sendToLink(link, data);
         }
         // Notify upper layers
-        this.emit("indication_link", { src: source.constructor.name, msg: data });
+        this.emit("indication_link", { src: keySource, msg: data });
     }
     /**
      * Evaluates if a message should be sent to a link based on configured filters.
@@ -281,8 +282,8 @@ class Router extends events_1.EventEmitter {
     async read(destination) {
         const cf1 = new ControlField_1.ControlField(0xbc);
         const cf2 = new ControlFieldExtended_1.ExtendedControlField(0xe0);
-        const tpdu = new TPDU_1.TPDU(new TPCI_1.TPCI(TPCI_1.TPCIType.T_DATA_GROUP_PDU), new APDU_1.APDU(new TPCI_1.TPCI(TPCI_1.TPCIType.T_DATA_GROUP_PDU), new APCI_1.APCI(APCIEnum_1.APCIEnum.A_GroupValue_Read_Protocol_Data_Unit), Buffer.alloc(0), true), Buffer.alloc(0));
-        const cemi = new CEMI_1.CEMI.DataLinkLayerCEMI["L_Data.req"](null, cf1, cf2, this.routerAddress, destination, tpdu);
+        const tpdu = new TPDU_1.TPDU(new TPCI_1.TPCI(TPCI_1.TPCIType.T_DATA_GROUP_PDU), new APDU_1.APDU(new TPCI_1.TPCI(TPCI_1.TPCIType.T_DATA_GROUP_PDU), new APCI_1.APCI(APCIEnum_1.APCIEnum.A_GroupValue_Read_Protocol_Data_Unit), Buffer.alloc(1), true), Buffer.alloc(1));
+        const cemi = new CEMI_1.CEMI.DataLinkLayerCEMI["L_Data.req"](null, cf1, cf2, "0.0.0", destination, tpdu);
         this.logger.debug({ service: cemi.constructor.name }, "Sending GroupValue_Read");
         return this.send(cemi);
     }