Interface RoomAirConditionerDevice

This defines conformance to the Room Air Conditioner device type.

A Room Air Conditioner is a device with the primary function of controlling the air temperature in a single room.

RoomAirConditionerDevice requires Thermostat cluster but Thermostat is not added by default because you must select the features your device supports. You can add manually using RoomAirConditionerDevice.with().

See

MatterSpecification.v13.Device § 13.3

interface RoomAirConditionerDevice {
    behaviors: {
        identify: typeof IdentifyServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
    };
    defaults: StateOf<{
        identify: typeof IdentifyServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
    }>;
    deviceClass: DeviceClassification;
    deviceRevision: number;
    deviceType: DeviceTypeId;
    name: "RoomAirConditioner";
    requirements: typeof RoomAirConditionerRequirements;
    set(defaults: InputStateOf<{
        identify: typeof IdentifyServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
    }>): With<For<{
        behaviors: {
            identify: typeof IdentifyServer;
        } & {
            onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
        };
        deviceRevision: 2;
        deviceType: 114;
        name: "RoomAirConditioner";
        requirements: typeof RoomAirConditionerRequirements;
    }>, {
        identify: typeof IdentifyServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
    }>;
    with<const BL>(...behaviors: BL): With<For<{
        behaviors: {
            identify: typeof IdentifyServer;
        } & {
            onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
        };
        deviceRevision: 2;
        deviceType: 114;
        name: "RoomAirConditioner";
        requirements: typeof RoomAirConditionerRequirements;
    }>, With<{
        identify: typeof IdentifyServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
    }, BL>>;
}

Hierarchy (view full)

Identity<typeof RoomAirConditionerDeviceDefinition>
- RoomAirConditionerDevice

Index

Properties

behaviors defaults deviceClass deviceRevision deviceType name requirements

Methods

set with

Properties

behaviors

behaviors: {
identify: typeof IdentifyServer;
} & {
onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
}

defaults

defaults: StateOf<{
identify: typeof IdentifyServer;
} & {
onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
}>

Access default state values.

deviceClass

deviceClass: DeviceClassification

deviceRevision

deviceRevision: number

deviceType

deviceType: DeviceTypeId

name

requirements

requirements: typeof RoomAirConditionerRequirements

Methods

set

set(defaults): With<For<{
    behaviors: {
        identify: typeof IdentifyServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
    };
    deviceRevision: 2;
    deviceType: 114;
    name: "RoomAirConditioner";
    requirements: typeof RoomAirConditionerRequirements;
}>, {
    identify: typeof IdentifyServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
}>
Define an endpoint like this one with different defaults. Only updates values present in the input object.
Parameters
- defaults: InputStateOf<{
  identify: typeof IdentifyServer;
  } & {
  onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
  }>
Returns With<For<{
    behaviors: {
        identify: typeof IdentifyServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
    };
    deviceRevision: 2;
    deviceType: 114;
    name: "RoomAirConditioner";
    requirements: typeof RoomAirConditionerRequirements;
}>, {
    identify: typeof IdentifyServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
}>
Inherited from Identity.set
- Defined in packages/node/src/endpoint/type/MutableEndpoint.ts:94

with

with<const BL>(...behaviors): With<For<{
    behaviors: {
        identify: typeof IdentifyServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
    };
    deviceRevision: 2;
    deviceType: 114;
    name: "RoomAirConditioner";
    requirements: typeof RoomAirConditionerRequirements;
}>, With<{
    identify: typeof IdentifyServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
}, 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: {
        identify: typeof IdentifyServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
    };
    deviceRevision: 2;
    deviceType: 114;
    name: "RoomAirConditioner";
    requirements: typeof RoomAirConditionerRequirements;
}>, With<{
    identify: typeof IdentifyServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["DeadFrontBehavior"]>, typeof OnOffServer, OnOffInterface>;
}, BL>>
Inherited from Identity.with
- Defined in packages/node/src/endpoint/type/MutableEndpoint.ts:99

Interface RoomAirConditionerDevice

See

Hierarchy (view full)

Index

Properties

Methods

Properties

behaviors

defaults

deviceClass

deviceRevision

deviceType

name

requirements

Methods

set

Parameters

with

Type Parameters

Parameters

Settings

On This Page