Interface DiscoveryOptions

Hierarchy

  • DiscoveryOptions

Properties

address? breakoutChildren? broadcast? deviceOptions? deviceTypes? devices? devicesUseDiscoveryPort? discoveryInterval? discoveryTimeout? excludeMacAddresses? filterCallback? macAddresses? offlineTolerance? port?

Properties

Optional address

address?: string

address to bind udp socket

Optional breakoutChildren

breakoutChildren?: boolean

if device has multiple outlets, create a separate plug for each outlet, otherwise create a plug for the main device

Default Value

true

Optional broadcast

broadcast?: string

broadcast address

Default Value

'255.255.255.255'

Optional deviceOptions

deviceOptions?: DeviceOptionsDiscovery

passed to device constructors

Optional deviceTypes

deviceTypes?: ("plug" | "bulb")[]

Optional devices

devices?: DiscoveryDevice[]

known devices to query instead of relying only on broadcast

Optional devicesUseDiscoveryPort

devicesUseDiscoveryPort?: boolean

Set device port to the port it responded with to the discovery ping

Default Value

false

Optional discoveryInterval

discoveryInterval?: number

Interval in (ms)

Default Value

10000

Optional discoveryTimeout

discoveryTimeout?: number

Timeout in (ms)

Default Value

0

Optional excludeMacAddresses

excludeMacAddresses?: string[]

MAC will be normalized, comparison will be done after removing special characters (:,-, etc.) and case insensitive, glob style *, and ? in pattern are supported

Default Value

[]

Optional filterCallback

filterCallback?: ((sysInfo) => boolean)

Type declaration

    • (sysInfo): boolean

    • called with fn(sysInfo), return truthy value to include device

      Parameters

      Returns boolean

Optional macAddresses

macAddresses?: string[]

MAC will be normalized, comparison will be done after removing special characters (:,-, etc.) and case insensitive, glob style *, and ? in pattern are supported

Default Value

[]

Optional offlineTolerance

offlineTolerance?: number

Number of consecutive missed replies to consider offline

Default Value

3

Optional port

port?: number

port to bind udp socket

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc