Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IKNXClient

Hierarchy

  • IKNXClient

Implemented by

Index

Properties

Methods

Properties

bindSocketPortAsync

bindSocketPortAsync: (port: number, host: string) => Promise<void>

Type declaration

    • (port: number, host: string): Promise<void>

    • Parameters

      • port: number
      • host: string

      Returns Promise<void>

send

send: (knxPacket: KNXPacket, host?: string, port?: number) => void

Type declaration

    • (knxPacket: KNXPacket, host?: string, port?: number): void

    • Parameters

      • knxPacket: KNXPacket
      • Optional host: string
      • Optional port: number

      Returns void

sendReadRequest

sendReadRequest: (srcAddress: KNXAddress, dstAddress: KNXAddress, cb?: (e: Error, d?: Buffer) => void, host?: string, port?: number) => void

Type declaration

    • Parameters

      • srcAddress: KNXAddress
      • dstAddress: KNXAddress
      • Optional cb: (e: Error, d?: Buffer) => void
          • (e: Error, d?: Buffer): void

          • Parameters

            • e: Error
            • Optional d: Buffer

            Returns void

      • Optional host: string
      • Optional port: number

      Returns void

sendWriteRequest

sendWriteRequest: (srcAddress: KNXAddress, dstAddress: KNXAddress, data: KNXDataBuffer, cb?: (e: Error) => void, host?: string, port?: number) => void

Type declaration

Methods

close

  • close(): void

  • Returns void

disconnect

  • disconnect(host: string, port: number, channelID?: number): void

  • Parameters

    • host: string
    • port: number
    • Optional channelID: number

    Returns void

getConnectionStatus

  • getConnectionStatus(host: string, port: number, _channelID?: number): void

  • Parameters

    • host: string
    • port: number
    • Optional _channelID: number

    Returns void

getDescription

  • getDescription(host: string, port: number): void

  • Parameters

    • host: string
    • port: number

    Returns void

isConnected

  • isConnected(): boolean

  • Returns boolean

isDiscoveryRunning

  • isDiscoveryRunning(): boolean

  • Returns boolean

openTunnelConnection

  • openTunnelConnection(host: string, port: number, knxLayer: TunnelTypes): void

  • Parameters

    Returns void

startDiscovery

  • startDiscovery(): void

  • Returns void

startHeartBeat

  • startHeartBeat(): void

  • Returns void

stopDiscovery

  • stopDiscovery(): void

  • Returns void

stopHeartBeat

  • stopHeartBeat(): void

  • Returns void

Generated using TypeDoc