Interface WaitForNodeOnlineParams

interface WaitForNodeOnlineParams {
    groupId: string;
    nodeId: string;
    pollIntervalMs?: number;
    subgroupIds?: string[];
    timeoutMs?: number;
    user: ESPRMNeoUser;
}

Properties

groupId nodeId pollIntervalMs? subgroupIds? timeoutMs? user

Properties

groupId

groupId: string

Group the node was associated with during provisioning (drives shadow name).

nodeId

nodeId: string

OptionalpollIntervalMs

pollIntervalMs?: number

Shadow GET poll interval. Default: DEFAULT_NODE_ONLINE_POLL_INTERVAL_MS.

OptionalsubgroupIds

subgroupIds?: string[]

Subgroup (room/CG) ids that currently contain the node. Omitted or empty ⇒ home-only shadow params-{groupId} (legacy callers). When set, shadow is params-{groupId}-{sortedSubgroupIds}.

OptionaltimeoutMs

timeoutMs?: number

user

user: ESPRMNeoUser

Logged-in user; used to connect MQTT if not already connected.

Settings

Member Visibility

On This Page

Properties