Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KNXTunnelSocket

Hierarchy

  • EventEmitter
    • KNXTunnelSocket

Index

Constructors

constructor

Properties

Private _connectionCB

_connectionCB: (e?: Error) => void

Type declaration

    • Parameters

      Returns void

Private _connectionState

_connectionState: ConnectionState = ConnectionState.disconnected

Private _disconnectCB

_disconnectCB: (e?: Error) => void

Type declaration

    • Parameters

      Returns void

Private _host

_host: string

Private _knxClient

_knxClient: KNXClient

Private _monitoringBus

_monitoringBus: boolean

Private Readonly _options

Private _port

_port: number

Static KNXTunnelSocketEvents

KNXTunnelSocketEvents: KNXTunnelSocketEvents = KNXTunnelSocketEvents

Static Port

Port: number = KNX_CONSTANTS.KNX_PORT

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

channelID

  • get channelID(): number

Methods

Private _handleBusEvent

Private _init

  • _init(): void

Private _processDiscoredHost

  • _processDiscoredHost(rinfo: string): void

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

      local port

    • Default value host: string = "0.0.0.0"

      local IP

    Returns Promise<void>

Private checkConnectionState

  • checkConnectionState(): void

close

  • close(): void

connectAsync

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

    • host: string

      destination ip address

    • port: number

      destination port

    Returns Promise<void>

disconnectAsync

  • disconnectAsync(): Promise<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>

Private getInterfaceIPAddress

  • getInterfaceIPAddress(ifname: string): string

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

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

    • event: string | symbol

    Returns Function[]

monitorBus

  • monitorBus(): void

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

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[]

readAsync

  • readAsync(dstAddress: KNXAddress): Promise<Buffer>

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

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

startDiscovery

  • startDiscovery(ifaceName: string, port: number): Promise<void>
  • Start KNX gateway discovery

    emit

    discover

    Parameters

    • ifaceName: string
    • port: number

    Returns Promise<void>

stopBusMonitor

  • stopBusMonitor(): void

stopDiscovery

  • stopDiscovery(): void

writeAsync

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