knx.ts 1.0.2 → 1.0.4

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

@@ -1,4 +1,4 @@
-import { LoggerOptions } from "pino";
+import pino from "pino";
 import { ConnectionType } from "../../core/enum/KNXnetIPEnum";
 /**
  * Options for configuring a KNX Tunneling connection.
@@ -29,7 +29,9 @@ export interface KNXTunnelingOptions extends KNXnetIPOptions {
      */
     maxQueueSize?: number;
 }
-export interface KNXnetIPServerOptions extends KNXnetIPOptions {
+export interface KNXnetIPServerOptions extends Omit<KNXnetIPOptions, "ip" | "port"> {
+    ip?: string;
+    port?: number;
     individualAddress?: string;
     serialNumber?: Buffer;
     friendlyName?: string;
@@ -46,10 +48,6 @@ export interface KNXnetIPServerOptions extends KNXnetIPOptions {
      * Setting this to a lower value can increase performance but may flood slow KNX segments.
      */
     routingDelay?: number;
-    /**
-     * Optional configuration for bridging to external connections (TPUART, Tunneling).
-     */
-    externals?: ExternalManagerOptions;
     /**
      * It abruptly stops a Tunneling client connection if it exceeds this limit of request messages per second; this is done to prevent performance degradation (the default is 100); to disable it, set it to less than 1
      */
@@ -62,6 +60,10 @@ export interface KNXnetIPServerOptions extends KNXnetIPOptions {
     useAllInterfaces?: boolean;
 }
 export interface ExternalManagerOptions {
+    /**
+     * Optional configuration for a KNXnetIPServer
+     */
+    knxNetIpServer?: KNXnetIPServerOptions;
     /**
      * Optional configuration for a physical TPUART connection.
      */
@@ -70,12 +72,16 @@ export interface ExternalManagerOptions {
      * Optional list of outbound KNX IP Tunneling client connections.
      */
     tunneling?: KNXTunnelingOptions[];
+    /**
+     * Optional configuration for a physical KNX USB connection.
+     */
+    usb?: KNXUSBOptions;
     /**
      * Pino logger configuration for the Router bridge.
      */
-    logOptions?: LoggerOptions;
+    logOptions?: KNXLoggerOptions;
 }
-export interface KNXLoggerOptions extends LoggerOptions {
+export interface KNXLoggerOptions extends pino.LoggerOptions {
     /**
      * Use pino-pretty but it's slow
      */
@@ -110,8 +116,8 @@ export interface KNXLoggerOptions extends LoggerOptions {
     logKeepCount?: number;
 }
 export interface KNXnetIPOptions {
-    ip?: string;
-    port?: number;
+    ip: string;
+    port: number;
     localIp?: string;
     localPort?: number;
     /**
@@ -119,15 +125,15 @@ export interface KNXnetIPOptions {
      */
     logOptions?: KNXLoggerOptions;
 }
-export interface TPUARTOptions extends KNXnetIPOptions {
+export interface TPUARTOptions {
     /**
      * The serial port path (e.g., "/dev/ttyS0" or "COM3").
      */
     path: string;
     /**
-     * Optional physical address to assign to the TPUART chip (e.g., "1.1.255").
+     * Physical address to assign to the TPUART chip (e.g., "1.1.255").
      */
-    individualAddress?: string;
+    individualAddress: string;
     /**
      * If true, the TPUART will send an ACK for all group telegrams.
      */
@@ -136,4 +142,65 @@ export interface TPUARTOptions extends KNXnetIPOptions {
      * If true, the TPUART will send an ACK for all individual telegrams.
      */
     ackIndividual?: boolean;
+    /**
+     * Pino logger configuration.
+     */
+    logOptions?: KNXLoggerOptions;
+}
+export interface RouterConnOptions extends ExternalManagerOptions {
+    routerAddress: string;
+    /**
+     * Filtering IP addresses from KNXnetIP to other interfaces such as TPUART or USB
+     */
+    toLocalFilter?: {
+        individualAddress?: {
+            addresses: string[];
+            individualAddressToLocalFilterPolicie: "discard all" | "accept only";
+        };
+        groupAddress?: {
+            addresses: string[];
+            groupAddressToLocalFilterPolicie: "discard all" | "accept only";
+        };
+    };
+    /**
+     * Filtering addresses from interfaces such as TP UART or USB to KNXnet IP
+     */
+    toIpFilter?: {
+        individualAddress?: {
+            addresses: string[];
+            individualAddressToIpFilterPolicie: "discard all" | "accept only";
+        };
+        groupAddress?: {
+            addresses: string[];
+            groupAddressToIpFilterPolicie: "discard all" | "accept only";
+        };
+    };
+}
+export interface KNXUSBOptions {
+    path?: string;
+    vendorId?: number;
+    productId?: number;
+    individualAddress: string;
+    /**
+     * Pino logger configuration.
+     */
+    logOptions?: KNXLoggerOptions;
+}
+export type AllConnectionOptions = TPUARTOptions | KNXUSBOptions | KNXnetIPServerOptions | KNXTunnelingOptions;
+/**
+ * Interface for a discovered KNXnet/IP device.
+ */
+export interface KNXDiscoveredDevice {
+    ip: string;
+    port: number;
+    knxMediumRaw: number;
+    knxMedium: string;
+    deviceStatusRaw: number;
+    deviceStatus: string;
+    individualAddress: number;
+    projectInstallationId: number;
+    serialNumber: Buffer;
+    routingMulticastAddress: string;
+    macAddress: string;
+    friendlyName: string;
 }

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

@@ -0,0 +1,18 @@
+import { KNXnetIPServer } from "../../connection/KNXnetIPServer";
+import { KNXService } from "../../connection/KNXService";
+import { Router } from "../../connection/Router";
+export interface MQTTGatewayOptions {
+    knxContext: Router | KNXnetIPServer;
+    embeddedBroker?: {
+        port: number;
+        host?: string;
+    };
+    brokerUrl?: string;
+    mqttUsername?: string;
+    mqttPassword?: string;
+    topicPrefix?: string;
+}
+export interface WebSocketGatewayOptions {
+    port: number;
+    knxContext: KNXService;
+}

package/dist/@types/interfaces/servers.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/connection/KNXService.d.ts

@@ -1,35 +1,31 @@
 import { EventEmitter } from "events";
 import dgram from "dgram";
 import net from "net";
-import { SRP } from "../core/KNXnetIPStructures";
-import { ServiceMessage } from "../@types/interfaces/ServiceMessage";
 import { KnxDataEncoder } from "../core/data/KNXDataEncode";
+import { CEMIInstance } from "../core/CEMI";
 import { AllDpts } from "../@types/types/AllDpts";
-import { KNXnetIPOptions, KNXnetIPServerOptions, KNXTunnelingOptions, TPUARTOptions } from "../@types/interfaces/connection";
+import { AllConnectionOptions } from "../@types/interfaces/connection";
 import { Logger } from "pino";
-export declare abstract class KNXService extends EventEmitter {
+export declare abstract class KNXService<TOptions extends AllConnectionOptions = AllConnectionOptions> extends EventEmitter {
     protected socket: dgram.Socket | net.Socket | null;
-    readonly options: KNXnetIPOptions | KNXnetIPServerOptions | KNXTunnelingOptions | TPUARTOptions;
+    readonly options: TOptions;
     protected _transport: "UDP" | "TCP";
     protected logger: Logger;
-    constructor(options?: KNXnetIPOptions | KNXnetIPServerOptions | KNXTunnelingOptions | TPUARTOptions);
-    abstract connect(): Promise<void>;
-    abstract disconnect(): void;
-    abstract send(data: Buffer | ServiceMessage): Promise<void>;
+    individualAddress: string;
+    constructor(options?: TOptions);
     /**
-     * Optional: Enable or disable busmonitor mode.
+     * Start the connection
      */
-    setBusmonitor?(enabled: boolean): Promise<void>;
+    abstract connect(): Promise<void>;
     /**
-     * Optional: Overriden by links that support selective routing (knxd pattern).
-     * Return false to block a specific group address.
+     * Safe disconnection of the connection
      */
-    shouldFilterGroup?(groupAddress: string): boolean;
+    abstract disconnect(): void;
     /**
-     * Optional: Overriden by links that support selective routing (knxd pattern).
-     * Return false to block a specific individual address.
+     * Send a telegram
+     * @param data A data buffer CEMI or EMI or an instance of a CEMI message
      */
-    shouldFilterIA?(individualAddress: string): boolean;
+    abstract send(data: Buffer | CEMIInstance): Promise<void>;
     /**
      * Send a GroupValue_Write telegram to a group address.
      * @param destination The group address (e.g., "1/1/1")
@@ -42,17 +38,4 @@ export declare abstract class KNXService extends EventEmitter {
      * @param destination The group address (e.g., "1/1/1")
      */
     read(destination: string): Promise<void>;
-    /**
-     * Discovery Process (Search Request)
-     */
-    static discover(timeout?: number, localIp?: string): Promise<any[]>;
-    /**
-     * Extended Discovery Process (Search Request Extended)
-     * Allows searching with filters (SRPs).
-     */
-    static discoverExtended(srps: SRP[], timeout?: number, localIp?: string): Promise<any[]>;
-    /**
-     * Description Request (Self Description)   * Queries a specific device for its capabilities.
-     */
-    describe(): Promise<any>;
 }

package/dist/connection/KNXService.js

@@ -1,14 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KNXService = void 0;
 const events_1 = require("events");
-const dgram_1 = __importDefault(require("dgram"));
-const KNXnetIPHeader_1 = require("../core/KNXnetIPHeader");
-const KNXnetIPStructures_1 = require("../core/KNXnetIPStructures");
-const KNXnetIPEnum_1 = require("../core/enum/KNXnetIPEnum");
 const localIp_1 = require("../utils/localIp");
 const KNXDataEncode_1 = require("../core/data/KNXDataEncode");
 const CEMI_1 = require("../core/CEMI");
@@ -20,19 +13,15 @@ const APDU_1 = require("../core/layers/data/APDU");
 const APCI_1 = require("../core/layers/interfaces/APCI");
 const APCIEnum_1 = require("../core/enum/APCIEnum");
 const Logger_1 = require("../utils/Logger");
-const KNXnetIPServer_1 = require("./KNXnetIPServer");
-const KNXHelper_1 = require("../utils/KNXHelper");
-const InvalidKnxAddresExeption_1 = require("../errors/InvalidKnxAddresExeption");
 class KNXService extends events_1.EventEmitter {
     socket = null;
     options;
     _transport = "UDP";
     logger;
+    individualAddress = "1.0.1";
     constructor(options = {}) {
         super();
         this.options = {
-            ip: "224.0.23.12",
-            port: 3671,
             localIp: (0, localIp_1.getLocalIP)(),
             localPort: 0,
             ...options,
@@ -71,20 +60,10 @@ class KNXService extends events_1.EventEmitter {
         else {
             throw new Error("Cannot encode value without DPT or basic type (boolean/number/Buffer)");
         }
-        let cf2Value = 0;
-        if (KNXHelper_1.KNXHelper.isValidGroupAddress(destination)) {
-            cf2Value = 0xe0;
-        }
-        else if (KNXHelper_1.KNXHelper.isValidIndividualAddress(destination)) {
-            cf2Value = 0x60;
-        }
-        else {
-            throw new InvalidKnxAddresExeption_1.InvalidKnxAddressException(`This address ${destination} is not valid`);
-        }
         const cf1 = new ControlField_1.ControlField(0xbc);
-        const cf2 = new ControlFieldExtended_1.ExtendedControlField(cf2Value);
+        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_Write_Protocol_Data_Unit), data, isShort), data);
-        const cemi = new CEMI_1.CEMI.DataLinkLayerCEMI["L_Data.req"](null, cf1, cf2, this instanceof KNXnetIPServer_1.KNXnetIPServer ? this.individualAddress : "0.0.0", destination, tpdu);
+        const cemi = new CEMI_1.CEMI.DataLinkLayerCEMI["L_Data.req"](null, cf1, cf2, this.individualAddress, destination, tpdu);
         this.logger.debug({ service: cemi.constructor.name }, "Sending GroupValue_Write");
         return this.send(cemi);
     }
@@ -95,148 +74,9 @@ class KNXService 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)), Buffer.alloc(0));
+        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)), Buffer.alloc(1));
         const cemi = new CEMI_1.CEMI.DataLinkLayerCEMI["L_Data.req"](null, cf1, cf2, "0.0.0", destination, tpdu);
         return this.send(cemi);
     }
-    /**
-     * Discovery Process (Search Request)
-     */
-    static async discover(timeout = 3000, localIp) {
-        return new Promise((resolve, reject) => {
-            const socket = dgram_1.default.createSocket("udp4");
-            const devices = [];
-            const _localIp = localIp || (0, localIp_1.getLocalIP)();
-            socket.on("message", (msg, rinfo) => {
-                try {
-                    const header = KNXnetIPHeader_1.KNXnetIPHeader.fromBuffer(msg);
-                    if (header.serviceType === KNXnetIPEnum_1.KNXnetIPServiceType.SEARCH_RESPONSE) {
-                        const hpaiData = msg.subarray(6, 14);
-                        const hpai = KNXnetIPStructures_1.HPAI.fromBuffer(hpaiData);
-                        // Parse DIBs starting from byte 14
-                        const dibs = [];
-                        let offset = 14;
-                        while (offset < msg.length) {
-                            const dibLen = msg.readUInt8(offset);
-                            if (offset + dibLen > msg.length)
-                                break;
-                            const dibBuffer = msg.subarray(offset, offset + dibLen);
-                            dibs.push(KNXnetIPStructures_1.DIB.fromBuffer(dibBuffer));
-                            offset += dibLen;
-                        }
-                        devices.push({
-                            ip: hpai.ipAddress,
-                            port: hpai.port,
-                            dibs,
-                        });
-                    }
-                }
-                catch (e) {
-                    // Ignore malformed packets
-                }
-            });
-            socket.bind(() => {
-                const localHPAI = new KNXnetIPStructures_1.HPAI(KNXnetIPEnum_1.HostProtocolCode.IPV4_UDP, _localIp, socket.address().port);
-                const header = new KNXnetIPHeader_1.KNXnetIPHeader(KNXnetIPEnum_1.KNXnetIPServiceType.SEARCH_REQUEST, 0);
-                const hpaiBuffer = localHPAI.toBuffer();
-                header.totalLength = header.toBuffer().length + hpaiBuffer.length;
-                const packet = Buffer.concat([header.toBuffer(), hpaiBuffer]);
-                // Send to Multicast Address
-                socket.send(packet, 3671, "224.0.23.12");
-                setTimeout(() => {
-                    socket.close();
-                    resolve(devices);
-                }, timeout);
-            });
-        });
-    }
-    /**
-     * Extended Discovery Process (Search Request Extended)
-     * Allows searching with filters (SRPs).
-     */
-    static async discoverExtended(srps, timeout = 3000, localIp) {
-        return new Promise((resolve, reject) => {
-            const socket = dgram_1.default.createSocket("udp4");
-            const devices = [];
-            const _localIp = localIp || (0, localIp_1.getLocalIP)();
-            socket.on("message", (msg, rinfo) => {
-                try {
-                    const header = KNXnetIPHeader_1.KNXnetIPHeader.fromBuffer(msg);
-                    if (header.serviceType === KNXnetIPEnum_1.KNXnetIPServiceType.SEARCH_RESPONSE ||
-                        header.serviceType === KNXnetIPEnum_1.KNXnetIPServiceType.SEARCH_RESPONSE_EXTENDED) {
-                        // Extract IP/Port from HPAI
-                        const hpai = KNXnetIPStructures_1.HPAI.fromBuffer(msg.subarray(6, 14));
-                        const dibs = [];
-                        let offset = 14;
-                        while (offset < msg.length) {
-                            const dibLen = msg.readUInt8(offset);
-                            if (dibLen === 0)
-                                break;
-                            dibs.push(KNXnetIPStructures_1.DIB.fromBuffer(msg.subarray(offset, offset + dibLen)));
-                            offset += dibLen;
-                        }
-                        devices.push({ ip: hpai.ipAddress, port: hpai.port, dibs });
-                    }
-                }
-                catch (e) { }
-            });
-            socket.bind(() => {
-                const localHPAI = new KNXnetIPStructures_1.HPAI(KNXnetIPEnum_1.HostProtocolCode.IPV4_UDP, _localIp, socket.address().port);
-                const header = new KNXnetIPHeader_1.KNXnetIPHeader(KNXnetIPEnum_1.KNXnetIPServiceType.SEARCH_REQUEST_EXTENDED, 0);
-                const hpaiBuf = localHPAI.toBuffer();
-                const srpBufs = srps.map((s) => s.toBuffer());
-                const body = Buffer.concat([hpaiBuf, ...srpBufs]);
-                header.totalLength = 6 + body.length;
-                socket.send(Buffer.concat([header.toBuffer(), body]), 3671, "224.0.23.12");
-                setTimeout(() => {
-                    socket.close();
-                    resolve(devices);
-                }, timeout);
-            });
-        });
-    }
-    /**
-     * Description Request (Self Description)   * Queries a specific device for its capabilities.
-     */
-    async describe() {
-        return new Promise((resolve, reject) => {
-            // Description is usually connectionless via UDP on the Control Endpoint
-            const descSocket = dgram_1.default.createSocket("udp4");
-            const targetIp = this.options.ip;
-            const targetPort = this.options.port;
-            const timeout = setTimeout(() => {
-                descSocket.close();
-                reject(new Error("Description request timed out"));
-            }, 2000);
-            descSocket.on("message", (msg) => {
-                try {
-                    const header = KNXnetIPHeader_1.KNXnetIPHeader.fromBuffer(msg);
-                    if (header.serviceType === KNXnetIPEnum_1.KNXnetIPServiceType.DESCRIPTION_RESPONSE) {
-                        clearTimeout(timeout);
-                        // Similar parsing logic as Discovery
-                        const dibs = [];
-                        let offset = 6; // Header length
-                        while (offset < msg.length) {
-                            const dibLen = msg.readUInt8(offset);
-                            const dibBuffer = msg.subarray(offset, offset + dibLen);
-                            dibs.push(KNXnetIPStructures_1.DIB.fromBuffer(dibBuffer));
-                            offset += dibLen;
-                        }
-                        descSocket.close();
-                        resolve({ dibs });
-                    }
-                }
-                catch (e) { }
-            });
-            descSocket.bind(() => {
-                const localHPAI = new KNXnetIPStructures_1.HPAI(KNXnetIPEnum_1.HostProtocolCode.IPV4_UDP, this.options.localIp, descSocket.address().port);
-                const header = new KNXnetIPHeader_1.KNXnetIPHeader(KNXnetIPEnum_1.KNXnetIPServiceType.DESCRIPTION_REQUEST, 0);
-                const hpaiBuffer = localHPAI.toBuffer();
-                header.totalLength = 6 + hpaiBuffer.length;
-                const packet = Buffer.concat([header.toBuffer(), hpaiBuffer]);
-                descSocket.send(packet, targetPort, targetIp);
-            });
-        });
-    }
 }
 exports.KNXService = KNXService;

package/dist/connection/KNXTunneling.d.ts

@@ -1,18 +1,18 @@
 import { KNXService } from "./KNXService";
-import { ServiceMessage } from "../@types/interfaces/ServiceMessage";
+import { CEMIInstance } from "../core/CEMI";
 import { KNXTunnelingOptions } from "../@types/interfaces/connection";
 /**
  * Handles KNXnet/IP Tunneling connections for point-to-point communication with a KNX gateway.
  * This class manages the connection state, sequence numbering for reliable delivery,
  * heartbeat monitoring (ConnectionState), and message queuing over both UDP and TCP transports.
  */
-export declare class KNXTunneling extends KNXService {
+export declare class KNXTunneling extends KNXService<KNXTunnelingOptions> {
     private channelId;
     private sequenceNumber;
     private rxSequenceNumber;
     private isConnected;
     private tcpBuffer;
-    assignedAddress: number;
+    individualAddress: string;
     private heartbeatTimer;
     private heartbeatFailures;
     private heartbeatRetryTimer;
@@ -29,7 +29,7 @@ export declare class KNXTunneling extends KNXService {
     private sendConnectRequest;
     disconnect(): void;
     private closeSocket;
-    send(cemi: ServiceMessage | Buffer): Promise<void>;
+    send(cemi: CEMIInstance | Buffer): Promise<void>;
     private processQueue;
     private handleAckTimeout;
     getFeature(featureId: number): Promise<Buffer>;