Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KNXClient

Hierarchy

  • EventEmitter
    • KNXClient

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _awaitingResponseType

_awaitingResponseType: number

Private _channelID

_channelID: number

Private _clientSocket

_clientSocket: Socket

Private _clientTunnelSeqNumber

_clientTunnelSeqNumber: number = 0

Private _connectionState

_connectionState: STATE

Private _discovery_timer

_discovery_timer: Timeout

Private _heartbeatFailures

_heartbeatFailures: number

Private _heartbeatRunning

_heartbeatRunning: boolean

Private _heartbeatTimer

_heartbeatTimer: Timeout

Private _host

_host: string

Private Readonly _options

_options: KNXSocketOptions

Private _peerHost

_peerHost: string

Private _peerPort

_peerPort: number

Private _pendingTunnelAnswer

_pendingTunnelAnswer: Map<string, PendingAnswer>

Private _port

_port: number

Private _timer

_timer: Timeout

Private _tunnelReqTimer

_tunnelReqTimer: Map<number, Timeout>

max_HeartbeatFailures

max_HeartbeatFailures: number

Static KNXClientEvents

KNXClientEvents: KNXClientEvents = KNXClientEvents

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

channelID

  • get channelID(): number

Methods

Private _getSeqNumber

  • _getSeqNumber(): number

Private _handleResponse

Private _incSeqNumber

  • _incSeqNumber(seq?: number): number

Private _keyFromCEMIMessage

  • _keyFromCEMIMessage(cEMIMessage: LDataReq): string

Private _processInboundMessage

  • _processInboundMessage(msg: Buffer, rinfo: SocketInfo): void

Private _runHeartbeat

  • _runHeartbeat(): void

Private _sendConnectRequestMessage

  • _sendConnectRequestMessage(host: string, port: number, cri: CRI): void

Private _sendConnectionStateRequestMessage

  • _sendConnectionStateRequestMessage(host: string, port: number, channelID: number): void

  • Parameters

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

    Returns void

Private _sendDescriptionRequestMessage

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

Private _sendDisconnectRequestMessage

  • _sendDisconnectRequestMessage(host: string, port: number, channelID: number): void

  • Parameters

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

    Returns void

Private _sendDisconnectResponseMessage

  • _sendDisconnectResponseMessage(host: string, port: number, channelID: number, status?: ConnectionStatus): void

Private _sendSearchRequestMessage

  • _sendSearchRequestMessage(): void

Private _setTimerAndCallback

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

bindSocketPortAsync

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

  • Parameters

    • Default value port: number = KNX_CONSTANTS.KNX_PORT
    • Default value host: string = "0.0.0.0"

    Returns Promise<void>

close

  • close(): void

disconnect

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

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getConnectionStatus

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

getDescription

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

getMaxListeners

  • getMaxListeners(): number

  • Returns number

isConnected

  • isConnected(): boolean

isDiscoveryRunning

  • isDiscoveryRunning(): boolean

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

openTunnelConnection

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

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

send

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

sendReadRequest

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

  • Parameters

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

        • Parameters

          • e: Error
          • Optional d: Buffer

          Returns void

    • Optional host: string
    • Optional port: number

    Returns void

sendWriteRequest

Private setDisconnected

  • setDisconnected(host: string, port: number, channelID: number): void

  • Parameters

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

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

startDiscovery

  • startDiscovery(): void

startHeartBeat

  • startHeartBeat(): void

stopDiscovery

  • stopDiscovery(): void

stopHeartBeat

  • stopHeartBeat(): void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc