Class BridgedDeviceBasicInformationServer

This is the default server implementation of BridgedDeviceBasicInformationBehavior.

All attributes are optional except for the "reachable" attribute.

Hierarchy (view full)

BridgedDeviceBasicInformationBehavior
- BridgedDeviceBasicInformationServer

Constructors

constructor

new BridgedDeviceBasicInformationServer(agent, backing): BridgedDeviceBasicInformationServer
Parameters
- agent: Agent
- backing: BehaviorBacking
Returns BridgedDeviceBasicInformationServer
Inherited from BridgedDeviceBasicInformationBehavior.constructor
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:119

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

`Readonly`events

events: EventEmitter & Omit<Events, never> & {
    reachable$Changing: ClusterEvents.AttributeObservable<Attribute<boolean, any>>;
} & {
    hardwareVersion$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<number, any>>;
    hardwareVersionString$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    manufacturingDate$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    nodeLabel$Changing: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<string, any>>;
    partNumber$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    productAppearance$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<TypeFromFields<{
        finish: FieldType<BasicInformation.ProductFinish>;
        primaryColor: FieldType<null | BasicInformation.Color>;
    }>, any>>;
    productLabel$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    productName$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    productUrl$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    serialNumber$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    softwareVersion$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<number, any>>;
    softwareVersionString$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    uniqueId$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    vendorId$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<VendorId, any>>;
    vendorName$Changing: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
} & {
    reachable$Changed: ClusterEvents.AttributeObservable<Attribute<boolean, any>>;
} & {
    hardwareVersion$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<number, any>>;
    hardwareVersionString$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    manufacturingDate$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    nodeLabel$Changed: undefined | ClusterEvents.AttributeObservable<OptionalWritableAttribute<string, any>>;
    partNumber$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    productAppearance$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<TypeFromFields<{
        finish: FieldType<BasicInformation.ProductFinish>;
        primaryColor: FieldType<null | BasicInformation.Color>;
    }>, any>>;
    productLabel$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    productName$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    productUrl$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    serialNumber$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    softwareVersion$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<number, any>>;
    softwareVersionString$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    uniqueId$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
    vendorId$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<VendorId, any>>;
    vendorName$Changed: undefined | ClusterEvents.AttributeObservable<OptionalFixedAttribute<string, any>>;
} & {
    reachableChanged: ClusterEvents.EventObservable<Event<TypeFromFields<{
        reachableNewValue: FieldType<boolean>;
    }>, any>>;
} & {
    leave?: ClusterEvents.EventObservable<OptionalEvent<void, any>>;
    shutDown?: ClusterEvents.EventObservable<OptionalEvent<void, any>>;
    startUp?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        softwareVersion: FieldType<number>;
    }>, any>>;
}

Access the behavior's events.

Type declaration

ReadonlyreachableChanged: ClusterEvents.EventObservable<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

Type declaration

Optional Readonlyleave?: ClusterEvents.EventObservable<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
Optional ReadonlyshutDown?: ClusterEvents.EventObservable<OptionalEvent<void, any>>
See
MatterSpecification.v13.Core § 9.13.5
Optional ReadonlystartUp?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
softwareVersion: FieldType<number>;
}>, any>>
See
MatterSpecification.v13.Core § 9.13.5

features

features: TypeFromBitSchema<{}>

Supported features as a flag object.

session

session: SecureSession

`Readonly`state

state: Omit<{}, never> & {
    reachable: boolean;
} & {
    nodeLabel?: string;
} & {} & {
    hardwareVersion?: number;
    hardwareVersionString?: string;
    manufacturingDate?: string;
    partNumber?: string;
    productAppearance?: TypeFromFields<{
        finish: FieldType<BasicInformation.ProductFinish>;
        primaryColor: FieldType<null | BasicInformation.Color>;
    }>;
    productLabel?: string;
    productName?: string;
    productUrl?: string;
    serialNumber?: string;
    softwareVersion?: number;
    softwareVersionString?: string;
    uniqueId?: string;
    vendorId?: VendorId;
    vendorName?: string;
}

Access the behavior's state.

Type declaration

Readonlyreachable: boolean
See
MatterSpecification.v13.Core § 9.13.4

Type declaration

Optional ReadonlynodeLabel?: string
See
MatterSpecification.v13.Core § 9.13.4

Type declaration

Optional ReadonlyhardwareVersion?: number
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlyhardwareVersionString?: string
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlymanufacturingDate?: string
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlypartNumber?: string
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlyproductAppearance?: TypeFromFields<{
finish: FieldType<BasicInformation.ProductFinish>;
primaryColor: FieldType<null | BasicInformation.Color>;
}>
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlyproductLabel?: string
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlyproductName?: string
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlyproductUrl?: string
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlyserialNumber?: string
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlysoftwareVersion?: number
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlysoftwareVersionString?: string
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlyuniqueId?: string
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlyvendorId?: VendorId
See
MatterSpecification.v13.Core § 9.13.4
Optional ReadonlyvendorName?: string
See
MatterSpecification.v13.Core § 9.13.4

`Static` `Readonly`cluster

cluster: BridgedDeviceBasicInformation.Cluster

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

`Static` `Readonly`defaults

defaults: ClusterState.Type<BridgedDeviceBasicInformation.Cluster, typeof ClusterBehavior>

`Static` `Optional` `Readonly`dependencies

dependencies?: Iterable<Type, any, any>

`Static` `Readonly`early

early: boolean

`Static` `Readonly`Events

Events: ClusterEvents.Type<BridgedDeviceBasicInformation.Cluster, typeof ClusterBehavior>

`Static` `Readonly`ExtensionInterface

ExtensionInterface: {}

`Static` `Readonly`id

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

`Static` `Readonly`Interface

Interface: {
components: never[];
}

`Static` `Readonly`Internal

Internal: (new () => {})

Type declaration

- new (): {}
- Implementation of internal state. Subclasses may override to extend.
  
  Returns {}

`Static` `Readonly`name

name: string

`Static` `Optional` `Readonly`schema

schema?: Schema

`Static` `Readonly`supervisor

supervisor: RootSupervisor

`Static`supports

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

Type declaration

- (other): boolean
- Does this behavior support functionality of a specific implementation?
  Parameters
  - other: Type
  Returns boolean

Methods

[asyncDispose]

[asyncDispose](): MaybePromise
Release resources. This is the public API for releasing application resources held by behaviors in internal state.

Returns MaybePromise
Inherited from BridgedDeviceBasicInformationBehavior.[asyncDispose]
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:115

asAdmin

asAdmin(fn): void
Execute logic with elevated privileges.

The provided function executes with privileges escalated to offline mode. This is not commonly necessary.

Elevated logic effectively ignores ACLs so should be used with care.

Note that interactions with the behavior will remain elevated until the synchronous completion of this call. You should only elevate privileges for synchronous logic.
Parameters
- fn: (() => void)
  the elevated logic
  - - (): void
    - Returns void
Returns void
Inherited from BridgedDeviceBasicInformationBehavior.asAdmin
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:77

assertAttributeEnabled

assertAttributeEnabled<This, K>(this, attributeName): void
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns void
Inherited from BridgedDeviceBasicInformationBehavior.assertAttributeEnabled
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:112

`Protected`callback

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
- reactor: Reactor<A, R>
- Optionaloptions: Reactor.Options
Returns ((...args: A) => undefined | R)
- - (...args): undefined | R
  - Parameters
    - Rest...args: A
    Returns undefined | R
Inherited from BridgedDeviceBasicInformationBehavior.callback
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:132

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>
Overrides BridgedDeviceBasicInformationBehavior.initialize
- Defined in packages/node/dist/esm/behaviors/bridged-device-basic-information/BridgedDeviceBasicInformationServer.d.ts:14

`Protected`reactTo

reactTo<O>(observable, reactor, options?): void
Install a Reactor.

Important: The reactor MUST be a real JS function - arrow functions will not work!
Type Parameters
- O extends Observable<any[], any>
Parameters
- observable: O
- reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>
- Optionaloptions: Reactor.Options
Returns void
Inherited from BridgedDeviceBasicInformationBehavior.reactTo
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:125

requireAttributeEnabled

requireAttributeEnabled<This, K>(this, attributeName): Exclude<This["state"][K], undefined>
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns Exclude<This["state"][K], undefined>
Inherited from BridgedDeviceBasicInformationBehavior.requireAttributeEnabled
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:111

toString

toString(): string
Description used in diagnostic messages.

Returns string
Inherited from BridgedDeviceBasicInformationBehavior.toString
- Defined in packages/node/dist/esm/behavior/Behavior.d.ts:119

`Static`alter

alter<This, const AlterationsT>(this, alterations): Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const AlterationsT extends Alterations<This["cluster"]>
Parameters
- this: This
- alterations: AlterationsT
Returns Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from BridgedDeviceBasicInformationBehavior.alter
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:142

`Static`enable

enable<This, const FlagsT>(this, flags): Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FlagsT extends ElementFlags<This["cluster"]>
Parameters
- this: This
- flags: FlagsT
Returns Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Inherited from BridgedDeviceBasicInformationBehavior.enable
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:144

`Static`for

for<This, const ClusterT>(this, cluster, schema?): Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const ClusterT extends ClusterType
Parameters
- this: This
- cluster: ClusterT
- Optionalschema: Schema
Returns Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Inherited from BridgedDeviceBasicInformationBehavior.for
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:140

`Static`set

set<This>(this, defaults): This
Type Parameters
- This extends Type
Parameters
- this: This
- defaults: Partial<RelaxTypes<InstanceType<This["State"]>>>
Returns This
Inherited from BridgedDeviceBasicInformationBehavior.set
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:143

`Static`with

with<This, const FeaturesT>(this, ...features): Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FeaturesT extends FeatureSelection<This["cluster"]>
Parameters
- this: This
- Rest...features: FeaturesT
Returns Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from BridgedDeviceBasicInformationBehavior.with
- Defined in packages/node/dist/esm/behavior/cluster/ClusterBehavior.d.ts:141

Class BridgedDeviceBasicInformationServer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BridgedDeviceBasicInformationServer

Properties

[reference]

agent

cluster

context

endpoint

env

Readonlyevents

Type declaration

ReadonlyreachableChanged: ClusterEvents.EventObservable<Event<TypeFromFields<{ reachableNewValue: FieldType<boolean>; }>, any>>

See

Type declaration

Optional Readonlyleave?: ClusterEvents.EventObservable<OptionalEvent<void, any>>

See

Optional ReadonlyshutDown?: ClusterEvents.EventObservable<OptionalEvent<void, any>>

See

Optional ReadonlystartUp?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{ softwareVersion: FieldType<number>; }>, any>>

See

features

session

Readonlystate

Type declaration

Readonlyreachable: boolean

See

Type declaration

Optional ReadonlynodeLabel?: string

See

Type declaration

Optional ReadonlyhardwareVersion?: number

See

Optional ReadonlyhardwareVersionString?: string

See

Optional ReadonlymanufacturingDate?: string

See

Optional ReadonlypartNumber?: string

See

Optional ReadonlyproductAppearance?: TypeFromFields<{ finish: FieldType<BasicInformation.ProductFinish>; primaryColor: FieldType<null | BasicInformation.Color>; }>

See

Optional ReadonlyproductLabel?: string

See

Optional ReadonlyproductName?: string

See

Optional ReadonlyproductUrl?: string

See

Optional ReadonlyserialNumber?: string

See

Optional ReadonlysoftwareVersion?: number

See

Optional ReadonlysoftwareVersionString?: string

See

Optional ReadonlyuniqueId?: string

See

Optional ReadonlyvendorId?: VendorId

See

Optional ReadonlyvendorName?: string

See

Static Readonlycluster

Static Readonlydefaults

Static Optional Readonlydependencies

Static Readonlyearly

Static ReadonlyEvents

Static ReadonlyExtensionInterface

Static Readonlyid

Static ReadonlyInterface

Static ReadonlyInternal

Type declaration

Returns {}

Static Readonlyname

Static Optional Readonlyschema

Static Readonlysupervisor

`Readonly`events

`Readonly`reachableChanged: ClusterEvents.EventObservable<Event<TypeFromFields<{
reachableNewValue: FieldType<boolean>;
}>, any>>

`Optional` `Readonly`leave?: ClusterEvents.EventObservable<OptionalEvent<void, any>>

`Optional` `Readonly`shutDown?: ClusterEvents.EventObservable<OptionalEvent<void, any>>

`Optional` `Readonly`startUp?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
softwareVersion: FieldType<number>;
}>, any>>

`Readonly`state

`Readonly`reachable: boolean

`Optional` `Readonly`nodeLabel?: string

`Optional` `Readonly`hardwareVersion?: number

`Optional` `Readonly`hardwareVersionString?: string

`Optional` `Readonly`manufacturingDate?: string

`Optional` `Readonly`partNumber?: string

`Optional` `Readonly`productAppearance?: TypeFromFields<{
finish: FieldType<BasicInformation.ProductFinish>;
primaryColor: FieldType<null | BasicInformation.Color>;
}>

`Optional` `Readonly`productLabel?: string

`Optional` `Readonly`productName?: string

`Optional` `Readonly`productUrl?: string

`Optional` `Readonly`serialNumber?: string

`Optional` `Readonly`softwareVersion?: number

`Optional` `Readonly`softwareVersionString?: string

`Optional` `Readonly`uniqueId?: string

`Optional` `Readonly`vendorId?: VendorId

`Optional` `Readonly`vendorName?: string

`Static` `Readonly`cluster

`Static` `Readonly`defaults

`Static` `Optional` `Readonly`dependencies

`Static` `Readonly`early

`Static` `Readonly`Events

`Static` `Readonly`ExtensionInterface

`Static` `Readonly`id

`Static` `Readonly`Interface

`Static` `Readonly`Internal

`Static` `Readonly`name

`Static` `Optional` `Readonly`schema

`Static` `Readonly`supervisor

`Static`supports

`Protected`callback

`Protected`reactTo

`Static`alter

`Static`enable

`Static`for

`Static`set

`Static`with