@jstark/tplink-smarthome-api
    Preparing search index...

    Interface DiscoveryOptions

    interface DiscoveryOptions {
        address?: string;
        breakoutChildren?: boolean;
        broadcast?: string;
        deviceOptions?: DeviceOptionsDiscovery;
        devices?: DiscoveryDevice[];
        devicesUseDiscoveryPort?: boolean;
        deviceTypes?: ("plug" | "bulb")[];
        discoveryInterval?: number;
        discoveryTimeout?: number;
        excludeMacAddresses?: string[];
        filterCallback?: (sysInfo: Sysinfo) => boolean;
        macAddresses?: string[];
        offlineTolerance?: number;
        port?: number;
    }
    Index
    address? breakoutChildren? broadcast? deviceOptions? devices? devicesUseDiscoveryPort? deviceTypes? discoveryInterval? discoveryTimeout? excludeMacAddresses? filterCallback? macAddresses? offlineTolerance? port?
    address?: string

    address to bind udp socket

    breakoutChildren?: boolean

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

    true
    broadcast?: string

    broadcast address

    '255.255.255.255'
    deviceOptions?: DeviceOptionsDiscovery

    passed to device constructors

    devices?: DiscoveryDevice[]

    known devices to query instead of relying only on broadcast

    devicesUseDiscoveryPort?: boolean

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

    false
    deviceTypes?: ("plug" | "bulb")[]
    discoveryInterval?: number

    Interval in (ms)

    10000
    discoveryTimeout?: number

    Timeout in (ms)

    0
    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

    []
    filterCallback?: (sysInfo: Sysinfo) => boolean

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

    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

    []
    offlineTolerance?: number

    Number of consecutive missed replies to consider offline

    3
    port?: number

    port to bind udp socket

    Settings
    Member Visibility

    On This Page
    Properties