Type Alias CommissioningControllerNodeOptions

CommissioningControllerNodeOptions: {
    attributeChangedCallback?: ((nodeId: NodeId, data: DecodedAttributeReportValue<any>) => void);
    autoSubscribe?: boolean;
    eventTriggeredCallback?: ((nodeId: NodeId, data: DecodedEventReportValue<any>) => void);
    stateInformationCallback?: ((nodeId: NodeId, state: NodeStateInformation) => void);
    subscribeMaxIntervalCeilingSeconds?: number;
    subscribeMinIntervalFloorSeconds?: number;
}

Type declaration

  • Optional ReadonlyattributeChangedCallback?: ((nodeId: NodeId, data: DecodedAttributeReportValue<any>) => void)

    Optional additional callback method which is called for each Attribute change reported by the device. Use this if subscribing to all relevant attributes is too much effort.

    Deprecated

    Please use the events.attributeChanged observable instead.

  • Optional ReadonlyautoSubscribe?: boolean

    Unless set to false all events and attributes are subscribed and value changes are reflected in the ClusterClient instances. With this reading attributes values is mostly looked up in the locally cached data. Additionally more features like reaction on shutdown event or endpoint structure changes (for bridges) are done internally automatically.

  • Optional ReadonlyeventTriggeredCallback?: ((nodeId: NodeId, data: DecodedEventReportValue<any>) => void)

    Optional additional callback method which is called for each Event reported by the device. Use this if subscribing to all relevant events is too much effort.

    Deprecated

    Please use the events.eventTriggered observable instead.

  • Optional ReadonlystateInformationCallback?: ((nodeId: NodeId, state: NodeStateInformation) => void)

    Optional callback method which is called when the state of the node changes. This can be used to detect when the node goes offline or comes back online.

    Deprecated

    Please use the events.nodeStateChanged observable and the extra events for structureCHanged and decomissioned instead.

  • Optional ReadonlysubscribeMaxIntervalCeilingSeconds?: number

    Maximum subscription interval when values are changed. This is also used as a keepalive mechanism to validate that the device is still available. matter.js tries to set meaningful values based on the device type, connection type and other details. So ideally do not set this parameter unless you know it better.

  • Optional ReadonlysubscribeMinIntervalFloorSeconds?: number

    Minimum subscription interval when values are changed. Default it is set to 1s. If the device is intermittently connected, the minimum interval is always set to 0s because required by Matter specs.

Settings

Member Visibility