Interface Cluster

This Cluster serves two purposes towards a Node communicating with a Bridge:

• Indicate that the functionality on the Endpoint where it is placed (and its Parts) is bridged from a non-Matter technology, and

• Provide a centralized collection of attributes that the Node may collect to aid in conveying information regarding the Bridged Device to a user, such as the vendor name, the model name, or user-assigned name.

This cluster shall be exposed by a Bridge on the Endpoint representing each Bridged Device. When the functionality of a Bridged Device is represented using a set of Endpoints, this cluster shall only be exposed on the Endpoint which is at the top of the hierarchy for the functionality of that Bridged Device.

This cluster shall NOT be used on an endpoint that is not in the Descriptor cluster PartsList of an endpoint with an Aggregator device type.

This cluster has been derived from the Basic Information Cluster, and provides generic information about the Bridged Device. Not all of the attributes in the Basic Information Cluster are relevant for a Bridged Device (e.g. ProductID since it is not a Matter device). For other attributes, the information which is listed as Mandatory for the Basic Information Cluster, may not be available when the Bridged Device does not provide it to the Bridge, and the Bridge has no other means to determine it. For such cases where the information for a particular attribute is not available, the Bridge SHOULD NOT include the attribute in the cluster for this Bridged Device. See below for Conformance details.

See

MatterSpecification.v13.Core § 9.13

interface Cluster {
    attributes: Merge<{
        hardwareVersion: OptionalFixedAttribute<number, any>;
        hardwareVersionString: OptionalFixedAttribute<string, any>;
        manufacturingDate: OptionalFixedAttribute<string, any>;
        nodeLabel: OptionalWritableAttribute<string, any>;
        partNumber: OptionalFixedAttribute<string, any>;
        productAppearance: OptionalFixedAttribute<TypeFromFields<{
            finish: FieldType<BasicInformation.ProductFinish>;
            primaryColor: FieldType<null | BasicInformation.Color>;
        }>, any>;
        productLabel: OptionalFixedAttribute<string, any>;
        productName: OptionalFixedAttribute<string, any>;
        productUrl: OptionalFixedAttribute<string, any>;
        reachable: Attribute<boolean, any>;
        serialNumber: OptionalFixedAttribute<string, any>;
        softwareVersion: OptionalFixedAttribute<number, any>;
        softwareVersionString: OptionalFixedAttribute<string, any>;
        uniqueId: OptionalFixedAttribute<string, any>;
        vendorId: OptionalFixedAttribute<VendorId, any>;
        vendorName: OptionalFixedAttribute<string, any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {};
    events: {
        leave: OptionalEvent<void, any>;
        reachableChanged: Event<TypeFromFields<{
            reachableNewValue: FieldType<boolean>;
        }>, any>;
        shutDown: OptionalEvent<void, any>;
        startUp: OptionalEvent<TypeFromFields<{
            softwareVersion: FieldType<number>;
        }>, any>;
    };
    extensions: undefined;
    features: {};
    id: Branded<57, "ClusterId">;
    name: "BridgedDeviceBasicInformation";
    revision: 3;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            hardwareVersion: OptionalFixedAttribute<number, any>;
            hardwareVersionString: OptionalFixedAttribute<string, any>;
            manufacturingDate: OptionalFixedAttribute<string, any>;
            nodeLabel: OptionalWritableAttribute<string, any>;
            partNumber: OptionalFixedAttribute<string, any>;
            productAppearance: OptionalFixedAttribute<TypeFromFields<{
                finish: FieldType<BasicInformation.ProductFinish>;
                primaryColor: FieldType<null | BasicInformation.Color>;
            }>, any>;
            productLabel: OptionalFixedAttribute<string, any>;
            productName: OptionalFixedAttribute<string, any>;
            productUrl: OptionalFixedAttribute<string, any>;
            reachable: Attribute<boolean, any>;
            serialNumber: OptionalFixedAttribute<string, any>;
            softwareVersion: OptionalFixedAttribute<number, any>;
            softwareVersionString: OptionalFixedAttribute<string, any>;
            uniqueId: OptionalFixedAttribute<string, any>;
            vendorId: OptionalFixedAttribute<VendorId, any>;
            vendorName: OptionalFixedAttribute<string, any>;
        };
        events: {
            leave: OptionalEvent<void, any>;
            reachableChanged: Event<TypeFromFields<{
                reachableNewValue: FieldType<boolean>;
            }>, any>;
            shutDown: OptionalEvent<void, any>;
            startUp: OptionalEvent<TypeFromFields<{
                softwareVersion: FieldType<number>;
            }>, any>;
        };
        id: 57;
        name: "BridgedDeviceBasicInformation";
        revision: 3;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            hardwareVersion: OptionalFixedAttribute<number, any>;
            hardwareVersionString: OptionalFixedAttribute<string, any>;
            manufacturingDate: OptionalFixedAttribute<string, any>;
            nodeLabel: OptionalWritableAttribute<string, any>;
            partNumber: OptionalFixedAttribute<string, any>;
            productAppearance: OptionalFixedAttribute<TypeFromFields<{
                finish: FieldType<BasicInformation.ProductFinish>;
                primaryColor: FieldType<null | BasicInformation.Color>;
            }>, any>;
            productLabel: OptionalFixedAttribute<string, any>;
            productName: OptionalFixedAttribute<string, any>;
            productUrl: OptionalFixedAttribute<string, any>;
            reachable: Attribute<boolean, any>;
            serialNumber: OptionalFixedAttribute<string, any>;
            softwareVersion: OptionalFixedAttribute<number, any>;
            softwareVersionString: OptionalFixedAttribute<string, any>;
            uniqueId: OptionalFixedAttribute<string, any>;
            vendorId: OptionalFixedAttribute<VendorId, any>;
            vendorName: OptionalFixedAttribute<string, any>;
        };
        events: {
            leave: OptionalEvent<void, any>;
            reachableChanged: Event<TypeFromFields<{
                reachableNewValue: FieldType<boolean>;
            }>, any>;
            shutDown: OptionalEvent<void, any>;
            startUp: OptionalEvent<TypeFromFields<{
                softwareVersion: FieldType<number>;
            }>, any>;
        };
        id: 57;
        name: "BridgedDeviceBasicInformation";
        revision: 3;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            hardwareVersion: OptionalFixedAttribute<number, any>;
            hardwareVersionString: OptionalFixedAttribute<string, any>;
            manufacturingDate: OptionalFixedAttribute<string, any>;
            nodeLabel: OptionalWritableAttribute<string, any>;
            partNumber: OptionalFixedAttribute<string, any>;
            productAppearance: OptionalFixedAttribute<TypeFromFields<{
                finish: FieldType<BasicInformation.ProductFinish>;
                primaryColor: FieldType<null | BasicInformation.Color>;
            }>, any>;
            productLabel: OptionalFixedAttribute<string, any>;
            productName: OptionalFixedAttribute<string, any>;
            productUrl: OptionalFixedAttribute<string, any>;
            reachable: Attribute<boolean, any>;
            serialNumber: OptionalFixedAttribute<string, any>;
            softwareVersion: OptionalFixedAttribute<number, any>;
            softwareVersionString: OptionalFixedAttribute<string, any>;
            uniqueId: OptionalFixedAttribute<string, any>;
            vendorId: OptionalFixedAttribute<VendorId, any>;
            vendorName: OptionalFixedAttribute<string, any>;
        };
        events: {
            leave: OptionalEvent<void, any>;
            reachableChanged: Event<TypeFromFields<{
                reachableNewValue: FieldType<boolean>;
            }>, any>;
            shutDown: OptionalEvent<void, any>;
            startUp: OptionalEvent<TypeFromFields<{
                softwareVersion: FieldType<number>;
            }>, any>;
        };
        id: 57;
        name: "BridgedDeviceBasicInformation";
        revision: 3;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            hardwareVersion: OptionalFixedAttribute<number, any>;
            hardwareVersionString: OptionalFixedAttribute<string, any>;
            manufacturingDate: OptionalFixedAttribute<string, any>;
            nodeLabel: OptionalWritableAttribute<string, any>;
            partNumber: OptionalFixedAttribute<string, any>;
            productAppearance: OptionalFixedAttribute<TypeFromFields<{
                finish: FieldType<BasicInformation.ProductFinish>;
                primaryColor: FieldType<null | BasicInformation.Color>;
            }>, any>;
            productLabel: OptionalFixedAttribute<string, any>;
            productName: OptionalFixedAttribute<string, any>;
            productUrl: OptionalFixedAttribute<string, any>;
            reachable: Attribute<boolean, any>;
            serialNumber: OptionalFixedAttribute<string, any>;
            softwareVersion: OptionalFixedAttribute<number, any>;
            softwareVersionString: OptionalFixedAttribute<string, any>;
            uniqueId: OptionalFixedAttribute<string, any>;
            vendorId: OptionalFixedAttribute<VendorId, any>;
            vendorName: OptionalFixedAttribute<string, any>;
        };
        events: {
            leave: OptionalEvent<void, any>;
            reachableChanged: Event<TypeFromFields<{
                reachableNewValue: FieldType<boolean>;
            }>, any>;
            shutDown: OptionalEvent<void, any>;
            startUp: OptionalEvent<TypeFromFields<{
                softwareVersion: FieldType<number>;
            }>, any>;
        };
        id: 57;
        name: "BridgedDeviceBasicInformation";
        revision: 3;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    hardwareVersion: OptionalFixedAttribute<number, any>;
    hardwareVersionString: OptionalFixedAttribute<string, any>;
    manufacturingDate: OptionalFixedAttribute<string, any>;
    nodeLabel: OptionalWritableAttribute<string, any>;
    partNumber: OptionalFixedAttribute<string, any>;
    productAppearance: OptionalFixedAttribute<TypeFromFields<{
        finish: FieldType<BasicInformation.ProductFinish>;
        primaryColor: FieldType<null | BasicInformation.Color>;
    }>, any>;
    productLabel: OptionalFixedAttribute<string, any>;
    productName: OptionalFixedAttribute<string, any>;
    productUrl: OptionalFixedAttribute<string, any>;
    reachable: Attribute<boolean, any>;
    serialNumber: OptionalFixedAttribute<string, any>;
    softwareVersion: OptionalFixedAttribute<number, any>;
    softwareVersionString: OptionalFixedAttribute<string, any>;
    uniqueId: OptionalFixedAttribute<string, any>;
    vendorId: OptionalFixedAttribute<VendorId, any>;
    vendorName: OptionalFixedAttribute<string, any>;
}, GlobalAttributes<{}>>

Type declaration

base

base: undefined

commands

commands: {}

events

events: {
    leave: OptionalEvent<void, any>;
    reachableChanged: Event<TypeFromFields<{
        reachableNewValue: FieldType<boolean>;
    }>, any>;
    shutDown: OptionalEvent<void, any>;
    startUp: OptionalEvent<TypeFromFields<{
        softwareVersion: FieldType<number>;
    }>, any>;
}

Type declaration

  • Readonlyleave: OptionalEvent<void, any>

    The Leave event SHOULD be generated by the bridge when it detects that the associated device has left the non-Matter network.

    NOTE

    The FabricIndex field has the X conformance, indicating it shall NOT be present. This event, in the context of Bridged Device Basic Information cluster, has no usable fields, but the original Basic Information cluster’s field definition is kept for completeness.

    See

    MatterSpecification.v13.Core § 9.13.5.1

  • ReadonlyreachableChanged: Event<TypeFromFields<{
        reachableNewValue: FieldType<boolean>;
    }>, any>

    This event shall be generated when there is a change in the Reachable attribute. Its purpose is to provide an indication towards interested parties that the reachability of a bridged device (over the non-Matter network) has changed, so they may take appropriate action.

    After (re)start of a bridge this event may be generated.

    See

    MatterSpecification.v13.Core § 9.13.5.2

  • ReadonlyshutDown: OptionalEvent<void, any>

    See

    MatterSpecification.v13.Core § 9.13.5

  • ReadonlystartUp: OptionalEvent<TypeFromFields<{
        softwareVersion: FieldType<number>;
    }>, any>

    See

    MatterSpecification.v13.Core § 9.13.5

extensions

extensions: undefined

features

features: {}

id

id: Branded<57, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

set

with

Settings

Member Visibility

On This Page

Properties
Methods