Interface DishwasherModeBehavior

interface DishwasherModeBehavior {
    [reference]: Datasource<StateType>;
    agent: Agent;
    changeToMode: ClusterInterface.MethodForCommand<Command<TypeFromFields<{
        newMode: FieldType<number>;
    }>, void, any>>;
    cluster: never;
    context: ActionContext;
    endpoint: Endpoint<Empty>;
    env: Environment;
    events: EventEmitter & Omit<Events, never> & {
        currentMode$Changing: ClusterEvents.AttributeObservable<Attribute<number, any>>;
        onMode$Changing: ClusterEvents.AttributeObservable<WritableAttribute<number, any>>;
        startUpMode$Changing: ClusterEvents.AttributeObservable<WritableAttribute<number, any>>;
        supportedModes$Changing: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromFields<{
            label: FieldType<string>;
            mode: FieldType<number>;
            modeTags: FieldType<TypeFromFields<{
                mfgCode: ...;
                value: ...;
            }>[]>;
        }>[], any>>;
    } & {} & {
        currentMode$Changed: ClusterEvents.AttributeObservable<Attribute<number, any>>;
        onMode$Changed: ClusterEvents.AttributeObservable<WritableAttribute<number, any>>;
        startUpMode$Changed: ClusterEvents.AttributeObservable<WritableAttribute<number, any>>;
        supportedModes$Changed: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromFields<{
            label: FieldType<string>;
            mode: FieldType<number>;
            modeTags: FieldType<TypeFromFields<{
                mfgCode: ...;
                value: ...;
            }>[]>;
        }>[], any>>;
    } & {} & {} & {};
    features: TypeFromBitSchema<{
        onOff: BitFlag;
    }>;
    session: SecureSession;
    state: Omit<{}, never> & {
        currentMode: number;
        onMode: number;
        startUpMode: number;
    } & {} & {
        supportedModes: TypeFromFields<{
            label: FieldType<string>;
            mode: FieldType<number>;
            modeTags: FieldType<TypeFromFields<{
                mfgCode: OptionalFieldType<VendorId>;
                value: FieldType<number>;
            }>[]>;
        }>[];
    } & {};
    [asyncDispose](): MaybePromise;
    asAdmin(fn: (() => void)): void;
    assertAttributeEnabled<This, K>(this: This, attributeName: K): void;
    callback<A, R>(reactor: Reactor<A, R>, options?: Reactor.Options): ((...args: A) => undefined | R);
    initialize(_options?: {}): MaybePromise;
    reactTo<O>(observable: O, reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>, options?: Reactor.Options): void;
    requireAttributeEnabled<This, K>(this: This, attributeName: K): Exclude<This["state"][K], undefined>;
    toString(): string;
    State: any;
}

Hierarchy (view full)

Properties

[reference] agent changeToMode cluster context endpoint env events features session state

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback initialize reactTo requireAttributeEnabled toString

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

ReadonlychangeToMode

changeToMode: ClusterInterface.MethodForCommand<Command<TypeFromFields<{
    newMode: FieldType<number>;
}>, void, any>>

This command is used to change device modes.

On receipt of this command the device shall respond with a ChangeToModeResponse command.

See

MatterSpecification.v13.Cluster § 1.10.7.1

cluster

cluster: never

The implemented cluster.

context

context: ActionContext

endpoint

endpoint: Endpoint<Empty>

env

env: Environment

Readonlyevents

events: EventEmitter & Omit<Events, never> & {
    currentMode$Changing: ClusterEvents.AttributeObservable<Attribute<number, any>>;
    onMode$Changing: ClusterEvents.AttributeObservable<WritableAttribute<number, any>>;
    startUpMode$Changing: ClusterEvents.AttributeObservable<WritableAttribute<number, any>>;
    supportedModes$Changing: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromFields<{
        label: FieldType<string>;
        mode: FieldType<number>;
        modeTags: FieldType<TypeFromFields<{
            mfgCode: ...;
            value: ...;
        }>[]>;
    }>[], any>>;
} & {} & {
    currentMode$Changed: ClusterEvents.AttributeObservable<Attribute<number, any>>;
    onMode$Changed: ClusterEvents.AttributeObservable<WritableAttribute<number, any>>;
    startUpMode$Changed: ClusterEvents.AttributeObservable<WritableAttribute<number, any>>;
    supportedModes$Changed: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromFields<{
        label: FieldType<string>;
        mode: FieldType<number>;
        modeTags: FieldType<TypeFromFields<{
            mfgCode: ...;
            value: ...;
        }>[]>;
    }>[], any>>;
} & {} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{
    onOff: BitFlag;
}>

Supported features as a flag object.

Type declaration

  • ReadonlyonOff: BitFlag

    OnOff

    This feature creates a dependency between an OnOff cluster instance and this cluster instance on the same endpoint. See OnMode for more information.

    See

    MatterSpecification.v13.Cluster § 1.10.4.1

session

session: SecureSession

Readonlystate

state: Omit<{}, never> & {
    currentMode: number;
    onMode: number;
    startUpMode: number;
} & {} & {
    supportedModes: TypeFromFields<{
        label: FieldType<string>;
        mode: FieldType<number>;
        modeTags: FieldType<TypeFromFields<{
            mfgCode: OptionalFieldType<VendorId>;
            value: FieldType<number>;
        }>[]>;
    }>[];
} & {}

Access the behavior's state.

Type declaration

  • ReadonlycurrentMode: number

    See

    MatterSpecification.v13.Cluster § 8.3.5

  • ReadonlyonMode: number

    See

    MatterSpecification.v13.Cluster § 8.3.5

  • ReadonlystartUpMode: number

    If this attribute is supported, the device SHOULD initially set this to one of the supported modes that has the Normal tag associated with it. See the Mode Base cluster specification for full details about the StartUpMode attribute.

    See

    MatterSpecification.v13.Cluster § 8.3.5.1

Type declaration

Methods

[asyncDispose]

  • [asyncDispose](): MaybePromise

  • Release resources. This is the public API for releasing application resources held by behaviors in internal state.

    Returns MaybePromise

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

assertAttributeEnabled

  • assertAttributeEnabled<This, K>(this, attributeName): void

  • Type Parameters

    • This extends Behavior
    • K extends string | number | symbol

    Parameters

    • this: This
    • attributeName: K

    Returns void

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(_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

    ProtectedreactTo

    • 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

      Parameters

      Returns void

    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>

    toString

    • toString(): string

    • Description used in diagnostic messages.

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods