Class ValveConfigurationAndControlServer

This is the default server implementation of ValveConfigurationAndControlBehavior.

Hierarchy (view full)

ValveConfigurationAndControlBehavior
- ValveConfigurationAndControlServer

Constructors

constructor

new ValveConfigurationAndControlServer(agent, backing): ValveConfigurationAndControlServer
Parameters
- agent: Agent
- backing: BehaviorBacking
Returns ValveConfigurationAndControlServer
Inherited from ValveConfigurationAndControlBehavior.constructor
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:198

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

`Readonly`events

events: EventEmitter & Omit<ClusterEvents<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    currentState$Changing: ClusterEvents.AttributeObservable<Attribute<null | ValveConfigurationAndControl.ValveState, any>>;
    defaultOpenDuration$Changing: ClusterEvents.AttributeObservable<WritableAttribute<null | number, any>>;
    openDuration$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    remainingDuration$Changing: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    targetState$Changing: ClusterEvents.AttributeObservable<Attribute<null | ValveConfigurationAndControl.ValveState, any>>;
} & {
    valveFault$Changing: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<TypeFromPartialBitSchema<{
        blocked: BitFlag;
        currentExceeded: BitFlag;
        generalFault: BitFlag;
        leaking: BitFlag;
        notConnected: BitFlag;
        shortCircuit: BitFlag;
    }>, any>>;
} & {
    currentState$Changed: ClusterEvents.AttributeObservable<Attribute<null | ValveConfigurationAndControl.ValveState, any>>;
    defaultOpenDuration$Changed: ClusterEvents.AttributeObservable<WritableAttribute<null | number, any>>;
    openDuration$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    remainingDuration$Changed: ClusterEvents.AttributeObservable<Attribute<null | number, any>>;
    targetState$Changed: ClusterEvents.AttributeObservable<Attribute<null | ValveConfigurationAndControl.ValveState, any>>;
} & {
    valveFault$Changed: undefined | ClusterEvents.AttributeObservable<OptionalAttribute<TypeFromPartialBitSchema<{
        blocked: BitFlag;
        currentExceeded: BitFlag;
        generalFault: BitFlag;
        leaking: BitFlag;
        notConnected: BitFlag;
        shortCircuit: BitFlag;
    }>, any>>;
} & {} & {
    valveFault?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        valveFault: FieldType<TypeFromPartialBitSchema<{
            blocked: BitFlag;
            currentExceeded: BitFlag;
            generalFault: BitFlag;
            leaking: BitFlag;
            notConnected: BitFlag;
            shortCircuit: BitFlag;
        }>>;
    }>, any>>;
    valveStateChanged?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
        valveLevel: OptionalFieldType<number>;
        valveState: FieldType<ValveConfigurationAndControl.ValveState>;
    }>, any>>;
}

Access the behavior's events.

Type declaration

Optional ReadonlyvalveFault?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
    valveFault: FieldType<TypeFromPartialBitSchema<{
        blocked: BitFlag;
        currentExceeded: BitFlag;
        generalFault: BitFlag;
        leaking: BitFlag;
        notConnected: BitFlag;
        shortCircuit: BitFlag;
    }>>;
}>, any>>
This event shall be generated when the valve registers or clears a fault, e.g. not being able to transition to the requested target level or state.

See
MatterSpecification.v13.Cluster § 4.6.9.2
Optional ReadonlyvalveStateChanged?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
valveLevel: OptionalFieldType<number>;
valveState: FieldType<ValveConfigurationAndControl.ValveState>;
}>, any>>
This event shall be generated when the valve state changed. For level changes, after the end of movement, for state changes when the new state has been reached.

See
MatterSpecification.v13.Cluster § 4.6.9.1

features

features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
level: BitFlag;
timeSync: BitFlag;
}>

Supported features as a flag object.

session

session: SecureSession

`Readonly`state

state: Omit<ClusterState.Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    currentState: null | ValveConfigurationAndControl.ValveState;
    defaultOpenDuration: null | number;
    openDuration: null | number;
    remainingDuration: null | number;
    targetState: null | ValveConfigurationAndControl.ValveState;
} & {
    valveFault?: TypeFromPartialBitSchema<{
        blocked: BitFlag;
        currentExceeded: BitFlag;
        generalFault: BitFlag;
        leaking: BitFlag;
        notConnected: BitFlag;
        shortCircuit: BitFlag;
    }>;
} & {} & {}

Access the behavior's state.

Type declaration

ReadonlycurrentState: null | ValveConfigurationAndControl.ValveState
Indicates the current state of the valve.

A value of null shall indicate that the current state is not known.

See
MatterSpecification.v13.Cluster § 4.6.7.5
ReadonlydefaultOpenDuration: null | number
Indicates the default duration, in seconds, for which the valve will remain open, if the OpenDuration field is not present in the Open command.

A value of null shall indicate the duration is not set, meaning that the valve will remain open until closed by the user or some other automation.

See
MatterSpecification.v13.Cluster § 4.6.7.2
ReadonlyopenDuration: null | number
Indicates the total duration, in seconds, for which the valve will remain open for this current opening.

A value of null shall indicate the duration is not set, meaning that the valve will remain open until closed by the user or some other automation.

See
MatterSpecification.v13.Cluster § 4.6.7.1
ReadonlyremainingDuration: null | number
Indicates the remaining duration, in seconds, until the valve closes. Null:

• When OpenDuration is null, or

• When the valve is closed.

The value of this attribute shall only be reported in the following cases:

• When it changes from null to any other value and vice versa, or

• When it changes to 0, or

• When it increases, or

• When the closing time changes.

Meaning that clients SHOULD NOT rely on the reporting of this attribute in order to keep track of the remaining duration, due to this attribute not being reported during regular countdown.

When reading this attribute it shall return the remaining duration, in seconds, until the valve closes.

When the value of this attribute counts down to 0, the valve shall automatically transition to its closed position. The behavior of transitioning to the closed position shall match the behavior described in the Close command.

See
MatterSpecification.v13.Cluster § 4.6.7.4
ReadonlytargetState: null | ValveConfigurationAndControl.ValveState
Indicates the target state, while changing the state, of the valve.

A value of null shall indicate that no target position is set, since the change in state is either done or failed.

See
MatterSpecification.v13.Cluster § 4.6.7.6

Type declaration

Optional ReadonlyvalveFault?: TypeFromPartialBitSchema<{
    blocked: BitFlag;
    currentExceeded: BitFlag;
    generalFault: BitFlag;
    leaking: BitFlag;
    notConnected: BitFlag;
    shortCircuit: BitFlag;
}>
Indicates any faults registered by the valve.

See
MatterSpecification.v13.Cluster § 4.6.7.10

`Static` `Readonly`cluster

cluster: ValveConfigurationAndControl.Cluster

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

`Static` `Readonly`defaults

defaults: ClusterState.Type<ValveConfigurationAndControl.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ValveConfigurationAndControlInterface>>

`Static` `Optional` `Readonly`dependencies

dependencies?: Iterable<Type, any, any>

`Static` `Readonly`early

early: boolean

`Static` `Readonly`Events

Events: ClusterEvents.Type<ValveConfigurationAndControl.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ValveConfigurationAndControlInterface>>

`Static` `Readonly`ExtensionInterface

ExtensionInterface: {}

`Static` `Readonly`id

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

`Static` `Readonly`Interface

Interface: ValveConfigurationAndControlInterface

`Static` `Readonly`Internal

Internal: (new () => {})

`Static` `Readonly`name

name: string

`Static` `Optional` `Readonly`schema

schema?: Schema

`Static` `Readonly`State

State: (new () => ClusterState.Type<ValveConfigurationAndControl.Cluster, Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior, ValveConfigurationAndControlInterface>>)

`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 ValveConfigurationAndControlBehavior.[asyncDispose]
- Defined in packages/node/src/behavior/Behavior.ts:206

asAdmin

asAdmin(fn): void
Parameters
- fn: (() => void)
  the elevated logic
  - - (): void
    - Returns void
Returns void
Inherited from ValveConfigurationAndControlBehavior.asAdmin
- Defined in packages/node/src/behavior/Behavior.ts:135

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 ValveConfigurationAndControlBehavior.assertAttributeEnabled
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:180

`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 ValveConfigurationAndControlBehavior.callback
- Defined in packages/node/src/behavior/Behavior.ts:234

close

close(): MaybePromise
This command is used to set the valve to its closed position.

Returns MaybePromise
See
MatterSpecification.v13.Cluster § 4.6.8.2
Inherited from ValveConfigurationAndControlBehavior.close
- Defined in packages/node/src/behaviors/valve-configuration-and-control/ValveConfigurationAndControlInterface.ts:26

initialize

initialize(_options?): MaybePromise
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.
Parameters
- Optional_options: {}
Returns MaybePromise
Inherited from ValveConfigurationAndControlBehavior.initialize
- Defined in packages/node/src/behavior/Behavior.ts:200

open

open(request): MaybePromise
This command is used to set the valve to its open position.
Parameters
- request: ValveConfigurationAndControl.OpenRequest
Returns MaybePromise
See
MatterSpecification.v13.Cluster § 4.6.8.1
Inherited from ValveConfigurationAndControlBehavior.open
- Defined in packages/node/src/behaviors/valve-configuration-and-control/ValveConfigurationAndControlInterface.ts:19

`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 ValveConfigurationAndControlBehavior.reactTo
- Defined in packages/node/src/behavior/Behavior.ts:220

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 ValveConfigurationAndControlBehavior.requireAttributeEnabled
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:168

toString

toString(): string
Returns string
Inherited from ValveConfigurationAndControlBehavior.toString
- Defined in packages/node/src/behavior/Behavior.ts:211

`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 ValveConfigurationAndControlBehavior.alter
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:251

`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 ValveConfigurationAndControlBehavior.enable
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:261

`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 ValveConfigurationAndControlBehavior.for
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:237

`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 ValveConfigurationAndControlBehavior.set
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:259

`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 ValveConfigurationAndControlBehavior.with
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:243

Class ValveConfigurationAndControlServer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ValveConfigurationAndControlServer

Properties

[reference]

agent

cluster

context

endpoint

env

Readonlyevents

Type declaration

Optional ReadonlyvalveFault?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{ valveFault: FieldType<TypeFromPartialBitSchema<{ blocked: BitFlag; currentExceeded: BitFlag; generalFault: BitFlag; leaking: BitFlag; notConnected: BitFlag; shortCircuit: BitFlag; }>>; }>, any>>

See

Optional ReadonlyvalveStateChanged?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{ valveLevel: OptionalFieldType<number>; valveState: FieldType<ValveConfigurationAndControl.ValveState>; }>, any>>

See

features

session

Readonlystate

Type declaration

ReadonlycurrentState: null | ValveConfigurationAndControl.ValveState

See

ReadonlydefaultOpenDuration: null | number

See

ReadonlyopenDuration: null | number

See

ReadonlyremainingDuration: null | number

See

ReadonlytargetState: null | ValveConfigurationAndControl.ValveState

See

Type declaration

Optional ReadonlyvalveFault?: TypeFromPartialBitSchema<{ blocked: BitFlag; currentExceeded: BitFlag; generalFault: BitFlag; leaking: BitFlag; notConnected: BitFlag; shortCircuit: BitFlag; }>

See

Static Readonlycluster

Static Readonlydefaults

Static Optional Readonlydependencies

Static Readonlyearly

Static ReadonlyEvents

Static ReadonlyExtensionInterface

Static Readonlyid

Static ReadonlyInterface

Static ReadonlyInternal

Static Readonlyname

Static Optional Readonlyschema

Static ReadonlyState

Static Readonlysupervisor

Staticsupports

Type declaration

Parameters

Returns boolean

Methods

[asyncDispose]

Returns MaybePromise

asAdmin

Parameters

Returns void

Returns void

assertAttributeEnabled

Type Parameters

Parameters

Returns void

Protectedcallback

Type Parameters

Parameters

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

Parameters

Returns undefined | R

close

Returns MaybePromise

See

initialize

Parameters

Returns MaybePromise

`Readonly`events

`Optional` `Readonly`valveFault?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
valveFault: FieldType<TypeFromPartialBitSchema<{
blocked: BitFlag;
currentExceeded: BitFlag;
generalFault: BitFlag;
leaking: BitFlag;
notConnected: BitFlag;
shortCircuit: BitFlag;
}>>;
}>, any>>

`Optional` `Readonly`valveStateChanged?: ClusterEvents.EventObservable<OptionalEvent<TypeFromFields<{
valveLevel: OptionalFieldType<number>;
valveState: FieldType<ValveConfigurationAndControl.ValveState>;
}>, any>>

`Readonly`state

`Readonly`currentState: null | ValveConfigurationAndControl.ValveState

`Readonly`defaultOpenDuration: null | number

`Readonly`openDuration: null | number

`Readonly`remainingDuration: null | number

`Readonly`targetState: null | ValveConfigurationAndControl.ValveState

`Optional` `Readonly`valveFault?: TypeFromPartialBitSchema<{
blocked: BitFlag;
currentExceeded: BitFlag;
generalFault: BitFlag;
leaking: BitFlag;
notConnected: BitFlag;
shortCircuit: BitFlag;
}>

`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`State

`Static` `Readonly`supervisor

`Static`supports

`Protected`callback

`Protected`reactTo

`Static`alter

`Static`enable

`Static`for

`Static`set

`Static`with