Interface OnOffLightDevice

The On/Off Light is a lighting device that is capable of being switched on or off by means of a bound controller device such as an On/Off Light Switch or a Dimmer Switch. In addition, an on/off light is also capable of being switched by means of a bound occupancy sensor.

See

MatterSpecification.v13.Device § 4.1

interface OnOffLightDevice {
    behaviors: {
        identify: Type<WithAlterations<Identify.Cluster, {
            commands: {
                triggerEffect: {
                    optional: false;
                };
            };
        }>, typeof IdentifyServer, IdentifyInterface>;
    } & {
        groups: typeof GroupsServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
    } & {
        identify: Type<WithAlterations<Identify.Cluster, {
            commands: {
                triggerEffect: {
                    optional: false;
                };
            };
        }>, typeof IdentifyServer, IdentifyInterface>;
    } & {
        groups: typeof GroupsServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
    };
    defaults: StateOf<{
        identify: Type<WithAlterations<Identify.Cluster, {
            commands: {
                triggerEffect: {
                    optional: false;
                };
            };
        }>, typeof IdentifyServer, IdentifyInterface>;
    } & {
        groups: typeof GroupsServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
    }>;
    deviceClass: DeviceClassification;
    deviceRevision: number;
    deviceType: DeviceTypeId;
    name: "OnOffLight";
    requirements: typeof OnOffLightRequirements;
    set(defaults: InputStateOf<{
        identify: Type<WithAlterations<Identify.Cluster, {
            commands: {
                triggerEffect: {
                    optional: false;
                };
            };
        }>, typeof IdentifyServer, IdentifyInterface>;
    } & {
        groups: typeof GroupsServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
    }>): With<For<{
        behaviors: {
            identify: Type<WithAlterations<Identify.Cluster, {
                commands: {
                    triggerEffect: {
                        optional: false;
                    };
                };
            }>, typeof IdentifyServer, IdentifyInterface>;
        } & {
            groups: typeof GroupsServer;
        } & {
            onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
        };
        deviceRevision: 3;
        deviceType: 256;
        name: "OnOffLight";
        requirements: typeof OnOffLightRequirements;
    }>, {
        identify: Type<WithAlterations<Identify.Cluster, {
            commands: {
                triggerEffect: {
                    optional: false;
                };
            };
        }>, typeof IdentifyServer, IdentifyInterface>;
    } & {
        groups: typeof GroupsServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
    }>;
    with<const BL>(...behaviors: BL): With<For<{
        behaviors: {
            identify: Type<WithAlterations<Identify.Cluster, {
                commands: {
                    triggerEffect: {
                        optional: false;
                    };
                };
            }>, typeof IdentifyServer, IdentifyInterface>;
        } & {
            groups: typeof GroupsServer;
        } & {
            onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
        };
        deviceRevision: 3;
        deviceType: 256;
        name: "OnOffLight";
        requirements: typeof OnOffLightRequirements;
    }>, With<{
        identify: Type<WithAlterations<Identify.Cluster, {
            commands: {
                triggerEffect: {
                    optional: false;
                };
            };
        }>, typeof IdentifyServer, IdentifyInterface>;
    } & {
        groups: typeof GroupsServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
    }, BL>>;
}

Hierarchy (view full)

Identity<typeof OnOffLightDeviceDefinition>
- OnOffLightDevice

Index

Properties

behaviors defaults deviceClass deviceRevision deviceType name requirements

Methods

set with

Properties

behaviors

behaviors: {
    identify: Type<WithAlterations<Identify.Cluster, {
        commands: {
            triggerEffect: {
                optional: false;
            };
        };
    }>, typeof IdentifyServer, IdentifyInterface>;
} & {
    groups: typeof GroupsServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
} & {
    identify: Type<WithAlterations<Identify.Cluster, {
        commands: {
            triggerEffect: {
                optional: false;
            };
        };
    }>, typeof IdentifyServer, IdentifyInterface>;
} & {
    groups: typeof GroupsServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
}

defaults

defaults: StateOf<{
    identify: Type<WithAlterations<Identify.Cluster, {
        commands: {
            triggerEffect: {
                optional: false;
            };
        };
    }>, typeof IdentifyServer, IdentifyInterface>;
} & {
    groups: typeof GroupsServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
}>

Access default state values.

deviceClass

deviceClass: DeviceClassification

deviceRevision

deviceRevision: number

deviceType

deviceType: DeviceTypeId

name

requirements

requirements: typeof OnOffLightRequirements

Methods

set

set(defaults): With<For<{
    behaviors: {
        identify: Type<WithAlterations<Identify.Cluster, {
            commands: {
                triggerEffect: {
                    optional: false;
                };
            };
        }>, typeof IdentifyServer, IdentifyInterface>;
    } & {
        groups: typeof GroupsServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
    };
    deviceRevision: 3;
    deviceType: 256;
    name: "OnOffLight";
    requirements: typeof OnOffLightRequirements;
}>, {
    identify: Type<WithAlterations<Identify.Cluster, {
        commands: {
            triggerEffect: {
                optional: false;
            };
        };
    }>, typeof IdentifyServer, IdentifyInterface>;
} & {
    groups: typeof GroupsServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
}>
Define an endpoint like this one with different defaults. Only updates values present in the input object.
Parameters
- defaults: InputStateOf<{
      identify: Type<WithAlterations<Identify.Cluster, {
          commands: {
              triggerEffect: {
                  optional: false;
              };
          };
      }>, typeof IdentifyServer, IdentifyInterface>;
  } & {
      groups: typeof GroupsServer;
  } & {
      onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
  }>
Returns With<For<{
    behaviors: {
        identify: Type<WithAlterations<Identify.Cluster, {
            commands: {
                triggerEffect: {
                    optional: false;
                };
            };
        }>, typeof IdentifyServer, IdentifyInterface>;
    } & {
        groups: typeof GroupsServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
    };
    deviceRevision: 3;
    deviceType: 256;
    name: "OnOffLight";
    requirements: typeof OnOffLightRequirements;
}>, {
    identify: Type<WithAlterations<Identify.Cluster, {
        commands: {
            triggerEffect: {
                optional: false;
            };
        };
    }>, typeof IdentifyServer, IdentifyInterface>;
} & {
    groups: typeof GroupsServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
}>
Inherited from Identity.set
- Defined in packages/node/dist/esm/endpoint/type/MutableEndpoint.d.ts:39

with

with<const BL>(...behaviors): With<For<{
    behaviors: {
        identify: Type<WithAlterations<Identify.Cluster, {
            commands: {
                triggerEffect: {
                    optional: false;
                };
            };
        }>, typeof IdentifyServer, IdentifyInterface>;
    } & {
        groups: typeof GroupsServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
    };
    deviceRevision: 3;
    deviceType: 256;
    name: "OnOffLight";
    requirements: typeof OnOffLightRequirements;
}>, With<{
    identify: Type<WithAlterations<Identify.Cluster, {
        commands: {
            triggerEffect: {
                optional: false;
            };
        };
    }>, typeof IdentifyServer, IdentifyInterface>;
} & {
    groups: typeof GroupsServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, 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: Type<WithAlterations<Identify.Cluster, {
            commands: {
                triggerEffect: {
                    optional: false;
                };
            };
        }>, typeof IdentifyServer, IdentifyInterface>;
    } & {
        groups: typeof GroupsServer;
    } & {
        onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
    };
    deviceRevision: 3;
    deviceType: 256;
    name: "OnOffLight";
    requirements: typeof OnOffLightRequirements;
}>, With<{
    identify: Type<WithAlterations<Identify.Cluster, {
        commands: {
            triggerEffect: {
                optional: false;
            };
        };
    }>, typeof IdentifyServer, IdentifyInterface>;
} & {
    groups: typeof GroupsServer;
} & {
    onOff: Type<WithFeatures<WithFeatures<OnOff.Cluster, readonly [Lighting]>, readonly ["Lighting"]>, typeof OnOffServer, OnOffInterface>;
}, BL>>
Inherited from Identity.with
- Defined in packages/node/dist/esm/endpoint/type/MutableEndpoint.d.ts:43

Interface OnOffLightDevice

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