knx.ts 1.0.0

package/dist/core/KNXAddInfoTypes.d.ts

@@ -0,0 +1,225 @@
+import { Buffer } from "buffer";
+import { Status } from "./SystemStatus";
+/**
+ * Interfaz base para todos los tipos de AddInfo.
+ * Define las propiedades y métodos comunes.
+ */
+interface IAddInfoType {
+    /** El identificador de tipo (p.ej., 0x02, 0x06). */
+    readonly typeId: number;
+    /** La longitud de los *datos* (sin incluir el Type ID y el octeto de Longitud). */
+    readonly dataLength: number;
+    /**
+     * Genera un Buffer que representa la estructura completa de AddInfo,
+     * incluyendo Type ID, Length y los datos.
+     * @returns Un Buffer listo para ser enviado.
+     */
+    getBuffer(): Buffer;
+}
+/**
+ * Clase base abstracta para ayudar a implementar IAddInfoType.
+ */
+export declare abstract class AddInfoBase implements IAddInfoType {
+    protected _typeId: number;
+    protected _dataLength: number;
+    constructor(typeId: number, dataLength: number);
+    get typeId(): number;
+    get dataLength(): number;
+    get totalLength(): number;
+    abstract getBuffer(): Buffer;
+    /**
+     * Ayudante para parsear el header del buffer en los constructores hijos.
+     * @param buffer El buffer de entrada completo (comenzando con Type ID).
+     * @param expectedType El Type ID esperado para esta clase.
+     * @param expectedLength La longitud de datos fija esperada (para tipos de longitud no variable).
+     * @returns El Buffer que contiene solo la porción de *datos*.
+     */
+    protected static parseDataBuffer(buffer: Buffer, expectedType: number, expectedLength?: number): Buffer;
+}
+export declare class PLMediumInfo extends AddInfoBase {
+    static readonly TYPE_ID = 1;
+    static readonly DATA_LENGTH = 2;
+    constructor(buffer?: Buffer);
+    private _domainAddress;
+    set domainAddress(value: Buffer);
+    get domainAddress(): Buffer;
+    getBuffer(): Buffer;
+}
+/**
+ * Implementación de AddInfoType 02h: RF medium information.
+ * Longitud de datos: 8 octetos.
+ */
+export declare class RFMediumInformation extends AddInfoBase {
+    private _rfInfo;
+    private _serialNumberOrDoA;
+    private _lfn;
+    static readonly TYPE_ID = 2;
+    static readonly DATA_LENGTH = 8;
+    constructor(buffer?: Buffer);
+    get routeLastFlag(): boolean;
+    set routeLastFlag(value: boolean);
+    get rssi(): number;
+    set rssi(value: number);
+    get retransmitterRssi(): number;
+    set retransmitterRssi(value: number);
+    get batteryState(): boolean;
+    set batteryState(value: boolean);
+    get unidirFlag(): boolean;
+    set unidirFlag(value: boolean);
+    get serialNumberOrDoA(): Buffer;
+    set serialNumberOrDoA(value: Buffer);
+    get lfn(): number;
+    set lfn(value: number);
+    getBuffer(): Buffer;
+}
+/**
+ * Implementación de AddInfoType 06h: Extended relative timestamp.
+ * Longitud de datos: 4 octetos.
+ */
+export declare class ExtendedRelativeTimestamp extends AddInfoBase {
+    private _timestamp;
+    static readonly TYPE_ID = 6;
+    static readonly DATA_LENGTH = 4;
+    constructor(buffer?: Buffer);
+    get timestamp(): number;
+    set timestamp(value: number);
+    getBuffer(): Buffer;
+}
+/**
+ * Implementación de AddInfoType 07h: BiBat information.
+ * Longitud de datos: 2 octetos.
+ */
+export declare class BiBatInformation extends AddInfoBase {
+    private _bibatCtrl;
+    private _bibatBlock;
+    static readonly TYPE_ID = 7;
+    static readonly DATA_LENGTH = 2;
+    constructor(buffer?: Buffer);
+    get bibatCtrl(): number;
+    set bibatCtrl(value: number);
+    get bibatBlock(): number;
+    set bibatBlock(value: number);
+    getBuffer(): Buffer;
+}
+/**
+ * Implementación de AddInfoType 08h: RF Multi information.
+ * Longitud de datos: 4 octetos.
+ */
+export declare class RFMultiInformation extends AddInfoBase {
+    private _transmissionFrequency;
+    private _callChannel;
+    private _physicalAcknowledge;
+    private _receptionFrequency;
+    static readonly TYPE_ID = 8;
+    static readonly DATA_LENGTH = 4;
+    constructor(buffer?: Buffer);
+    get transmissionFrequency(): number;
+    set transmissionFrequency(value: number);
+    get fastCallChannel(): number;
+    set fastCallChannel(value: number);
+    get slowCallChannel(): number;
+    set slowCallChannel(value: number);
+    get physicalAcknowledge(): number;
+    set physicalAcknowledge(value: number);
+    get receptionFrequency(): number;
+    set receptionFrequency(value: number);
+    getBuffer(): Buffer;
+}
+/**
+ * Implementación de AddInfoType 09h: Preamble and postamble.
+ * Longitud de datos: 3 octetos.
+ */
+export declare class PreambleAndPostamble extends AddInfoBase {
+    private _preambleLength;
+    private _postambleLength;
+    static readonly TYPE_ID = 9;
+    static readonly DATA_LENGTH = 3;
+    constructor(buffer?: Buffer);
+    get preambleLength(): number;
+    set preambleLength(value: number);
+    get postambleLength(): number;
+    set postambleLength(value: number);
+    getBuffer(): Buffer;
+}
+interface IRfFastAck {
+    status: number;
+    info: number;
+}
+/**
+ * Implementación de AddInfoType 0Ah: RF Fast ack information.
+ * Longitud de datos: Variable (N * 2 octetos).
+ */
+export declare class RFFastACKInformation extends AddInfoBase {
+    private _fastAcks;
+    static readonly TYPE_ID = 10;
+    constructor(buffer?: Buffer);
+    getFastAcks(): IRfFastAck[];
+    setFastAcks(acks: IRfFastAck[]): void;
+    addFastAck(ack: IRfFastAck): void;
+    getBuffer(): Buffer;
+}
+/**
+ * Implementación de AddInfoType FEh: Manufacturer specific data.
+ * Longitud de datos: Variable (N + 3 octetos).
+ */
+export declare class ManufacturerSpecificData extends AddInfoBase {
+    private _manufacturerId;
+    private _subfunction;
+    private _data;
+    static readonly TYPE_ID = 254;
+    static readonly MIN_DATA_LENGTH = 3;
+    constructor(buffer?: Buffer);
+    get manufacturerId(): number;
+    set manufacturerId(value: number);
+    get subfunction(): number;
+    set subfunction(value: number);
+    get data(): Buffer;
+    set data(value: Buffer);
+    getBuffer(): Buffer;
+}
+/**
+ * 4.1.4.3.1 AddInfo-Type 03h: Busmonitor Status Info
+ * Longitud de datos: 1 octeto.
+ * Utiliza la clase Status existente para la gestión de bits.
+ */
+export declare class BusmonitorStatusInfo extends AddInfoBase {
+    static readonly TYPE_ID = 3;
+    static readonly DATA_LENGTH = 1;
+    private _status;
+    constructor(buffer?: Buffer);
+    /**
+     * Devuelve la instancia interna de Status para manipulación directa.
+     */
+    get status(): Status;
+    set status(value: Status);
+    getBuffer(): Buffer;
+}
+/**
+ * Implementación de AddInfoType 04h: Timestamp Relative.
+ * Longitud de datos: 2 octetos.
+ * Representa una marca de tiempo relativa (generalmente en ms o ticks desde el último evento).
+ */
+export declare class TimestampRelative extends AddInfoBase {
+    private _timestamp;
+    static readonly TYPE_ID = 4;
+    static readonly DATA_LENGTH = 2;
+    constructor(buffer?: Buffer);
+    get timestamp(): number;
+    set timestamp(value: number);
+    getBuffer(): Buffer;
+}
+/**
+ * Implementación de AddInfoType 05h: Time Delay Until Sending.
+ * Longitud de datos: 2 octetos.
+ * Define un retardo antes de enviar la trama al medio.
+ */
+export declare class TimeDelayUntilSending extends AddInfoBase {
+    private _delay;
+    static readonly TYPE_ID = 5;
+    static readonly DATA_LENGTH = 2;
+    constructor(buffer?: Buffer);
+    get delay(): number;
+    set delay(value: number);
+    getBuffer(): Buffer;
+}
+export {};