Class PowerTopologyServerLogic

This is the default server implementation of PowerTopologyBehavior.

The Matter specification requires the PowerTopology cluster to support features we do not enable by default. You should use PowerTopologyServer.with to specialize the class for the features your implementation supports.

The default implementation verifies that the active endpoints are a subset of the available endpoints when the SetTopology and DynamicPowerFlow features are used.

Hierarchy

  • PowerTopologyBase
    • PowerTopologyServerLogic

Constructors

constructor

Properties

[reference] agent cluster context endpoint env events features session state cluster defaults dependencies? early Events ExtensionInterface id Interface Internal name schema? State supervisor supports

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback initialize reactTo requireAttributeEnabled toString alter enable for set with

Constructors

constructor

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

context

context: ActionContext

endpoint

endpoint: Endpoint<Empty>

env

env: Environment

Readonlyevents

events: EventEmitter & Omit<ClusterEvents<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<(...)[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<(...)[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, typeof ClusterBehavior>, never> & {
    activeEndpoints$Changing: ClusterEvents.AttributeObservable<Attribute<EndpointNumber[], any>>;
    availableEndpoints$Changing: ClusterEvents.AttributeObservable<FixedAttribute<EndpointNumber[], any>>;
} & {} & {
    activeEndpoints$Changed: ClusterEvents.AttributeObservable<Attribute<EndpointNumber[], any>>;
    availableEndpoints$Changed: ClusterEvents.AttributeObservable<FixedAttribute<EndpointNumber[], any>>;
} & {} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{
    dynamicPowerFlow: BitFlag;
    nodeTopology: BitFlag;
    setTopology: BitFlag;
    treeTopology: BitFlag;
}>

Supported features as a flag object.

Type declaration

  • ReadonlydynamicPowerFlow: BitFlag

    DynamicPowerFlow

    The specified set of endpoints may change

  • ReadonlynodeTopology: BitFlag

    NodeTopology

    This endpoint provides or consumes power to/from the entire node

  • ReadonlysetTopology: BitFlag

    SetTopology

    This endpoint provides or consumes power to/from a specified set of endpoints

  • ReadonlytreeTopology: BitFlag

    TreeTopology

    This endpoint provides or consumes power to/from itself and its child endpoints

session

session: SecureSession

Readonlystate

state: Omit<ClusterState.Type<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<(...)[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<(...)[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, typeof ClusterBehavior>, never> & {
    activeEndpoints: EndpointNumber[];
} & {} & {
    availableEndpoints: EndpointNumber[];
} & {}

Access the behavior's state.

Type declaration

  • ReadonlyactiveEndpoints: EndpointNumber[]

    Indicates the current list of endpoints currently providing or consuming power to or from the endpoint hosting this server. This list shall be a subset of the value of the AvailableEndpoints attribute.

    See

    MatterSpecification.v13.Core § 11.8.5.2

Type declaration

  • ReadonlyavailableEndpoints: EndpointNumber[]

    Indicates the list of endpoints capable of providing power to and/or consuming power from the endpoint hosting this server.

    See

    MatterSpecification.v13.Core § 11.8.5.1

Static Readonlycluster

cluster: WithFeatures<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<EndpointNumber[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<EndpointNumber[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, readonly [SetTopology, DynamicPowerFlow]>

Base cluster state include all attribute values but may be extended by subclasses.

Static Readonlydefaults

defaults: ClusterState.Type<WithFeatures<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<EndpointNumber[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<EndpointNumber[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, readonly [SetTopology, DynamicPowerFlow]>, Type<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<EndpointNumber[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<EndpointNumber[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, typeof ClusterBehavior, {
    components: never[];
}>>

Static Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Static Readonlyearly

early: boolean

Static ReadonlyEvents

Events: ClusterEvents.Type<WithFeatures<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<EndpointNumber[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<EndpointNumber[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, readonly [SetTopology, DynamicPowerFlow]>, Type<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<EndpointNumber[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<EndpointNumber[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, typeof ClusterBehavior, {
    components: never[];
}>>

Static ReadonlyExtensionInterface

ExtensionInterface: {}

Static Readonlyid

id

The behavior ID for ClusterBehaviors is the name of the cluster.

Static ReadonlyInterface

Interface: {
    components: never[];
}

Static ReadonlyInternal

Internal: (new () => {})

Static Readonlyname

name: string

Static Optional Readonlyschema

schema?: Schema

Static ReadonlyState

State: (new () => ClusterState.Type<WithFeatures<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<(...)[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<(...)[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, readonly [SetTopology, DynamicPowerFlow]>, Type<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<(...)[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<(...)[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, typeof ClusterBehavior, {
    components: never[];
}>>)

Static Readonlysupervisor

supervisor: RootSupervisor

Staticsupports

supports: ((other: Type) => boolean)

Type declaration

    • (other): boolean

    • Does this behavior support functionality of a specific implementation?

      Parameters

      Returns boolean

Methods

[asyncDispose]

asAdmin

assertAttributeEnabled

Protectedcallback

  • callback<A, R>(reactor, options?): ((...args: A) => undefined | R)

  • Create a generic callback function that has the same properties as a Reactor.

    Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!

    Type Parameters

    • A extends any[]
    • R

    Parameters

    Returns ((...args: A) => undefined | R)

      • (...args): undefined | R

      • Parameters

        • Rest...args: A

        Returns undefined | R

initialize

  • initialize(): Promise<void>

  • Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

    This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

    Returns Promise<void>

ProtectedreactTo

requireAttributeEnabled

toString

Staticalter

Staticenable

Staticfor

Staticset

Staticwith

Settings

Member Visibility

On This Page

Constructors
Properties
Methods