Interface AggregatorEndpoint

This device type aggregates endpoints as a collection. Clusters on the endpoint indicating this device type provide functionality for the collection of descendent endpoints present in the PartsList of the endpoint’s descriptor, for example the Actions cluster.

The purpose of this device type is to aggregate functionality for a collection of endpoints. The definition of the collection or functionality is not defined here.

When using this device type as a collection of bridged nodes, please see the "Bridge" section in the System Model specification.

See

MatterSpecification.v13.Device § 11.2

interface AggregatorEndpoint {
    behaviors: {
        parts: typeof PartsBehavior;
    } & {
        index: typeof IndexBehavior;
    } & {
        parts: typeof PartsBehavior;
    } & {
        index: typeof IndexBehavior;
    };
    defaults: StateOf<{
        parts: typeof PartsBehavior;
    } & {
        index: typeof IndexBehavior;
    }>;
    deviceClass: DeviceClassification;
    deviceRevision: number;
    deviceType: DeviceTypeId;
    name: "Aggregator";
    requirements: typeof AggregatorRequirements;
    set(defaults: InputStateOf<{
        parts: typeof PartsBehavior;
    } & {
        index: typeof IndexBehavior;
    }>): With<For<{
        behaviors: {
            parts: typeof PartsBehavior;
        } & {
            index: typeof IndexBehavior;
        };
        deviceRevision: 1;
        deviceType: 14;
        name: "Aggregator";
        requirements: typeof AggregatorRequirements;
    }>, {
        parts: typeof PartsBehavior;
    } & {
        index: typeof IndexBehavior;
    }>;
    with<const BL>(...behaviors: BL): With<For<{
        behaviors: {
            parts: typeof PartsBehavior;
        } & {
            index: typeof IndexBehavior;
        };
        deviceRevision: 1;
        deviceType: 14;
        name: "Aggregator";
        requirements: typeof AggregatorRequirements;
    }>, With<{
        parts: typeof PartsBehavior;
    } & {
        index: typeof IndexBehavior;
    }, BL>>;
}

Hierarchy (view full)

Properties

behaviors defaults deviceClass deviceRevision deviceType name requirements

Methods

set with

Properties

behaviors

behaviors: {
    parts: typeof PartsBehavior;
} & {
    index: typeof IndexBehavior;
} & {
    parts: typeof PartsBehavior;
} & {
    index: typeof IndexBehavior;
}

defaults

defaults: StateOf<{
    parts: typeof PartsBehavior;
} & {
    index: typeof IndexBehavior;
}>

Access default state values.

deviceClass

deviceClass: DeviceClassification

deviceRevision

deviceRevision: number

deviceType

deviceType: DeviceTypeId

name

name

requirements

requirements: typeof AggregatorRequirements

Methods

set

  • set(defaults): With<For<{
        behaviors: {
            parts: typeof PartsBehavior;
        } & {
            index: typeof IndexBehavior;
        };
        deviceRevision: 1;
        deviceType: 14;
        name: "Aggregator";
        requirements: typeof AggregatorRequirements;
    }>, {
        parts: typeof PartsBehavior;
    } & {
        index: typeof IndexBehavior;
    }>

  • Define an endpoint like this one with different defaults. Only updates values present in the input object.

    Parameters

    Returns With<For<{
        behaviors: {
            parts: typeof PartsBehavior;
        } & {
            index: typeof IndexBehavior;
        };
        deviceRevision: 1;
        deviceType: 14;
        name: "Aggregator";
        requirements: typeof AggregatorRequirements;
    }>, {
        parts: typeof PartsBehavior;
    } & {
        index: typeof IndexBehavior;
    }>

with

  • with<const BL>(...behaviors): With<For<{
        behaviors: {
            parts: typeof PartsBehavior;
        } & {
            index: typeof IndexBehavior;
        };
        deviceRevision: 1;
        deviceType: 14;
        name: "Aggregator";
        requirements: typeof AggregatorRequirements;
    }>, With<{
        parts: typeof PartsBehavior;
    } & {
        index: typeof IndexBehavior;
    }, BL>>

  • Define an endpoint like this one with additional and/or replacement server behaviors.

    Type Parameters

    • const BL extends List

    Parameters

    • Rest...behaviors: BL

    Returns With<For<{
        behaviors: {
            parts: typeof PartsBehavior;
        } & {
            index: typeof IndexBehavior;
        };
        deviceRevision: 1;
        deviceType: 14;
        name: "Aggregator";
        requirements: typeof AggregatorRequirements;
    }>, With<{
        parts: typeof PartsBehavior;
    } & {
        index: typeof IndexBehavior;
    }, BL>>

Settings

Member Visibility

On This Page

Properties
Methods