homebridge
    Preparing search index...

    Variable deviceTypesConst

    deviceTypes: {
        AirQualitySensor: With<
            For<{}>,
            With<
                {} & {},
                readonly [
                    Type<
                        typeof AirQualityServer,
                        WithSupportedFeatures<
                            AirQuality,
                            { extremelyPoor: true; fair: true; moderate: true; veryPoor: true },
                        >,
                        Concrete,
                        new () => {},
                        "airQuality",
                    >,
                ],
            >,
            {},
        >;
        BatteryStorage: BatteryStorageDevice;
        BridgedNode: BridgedNodeEndpoint;
        Closure: With<
            For<{}>,
            With<
                {} & {},
                readonly [
                    Type<
                        typeof DefaultClosureControlServer,
                        WithSupportedFeatures<
                            ClosureControl,
                            {
                                calibration: false;
                                instantaneous: false;
                                manuallyOperable: false;
                                motionLatching: false;
                                pedestrian: false;
                                positioning: true;
                                protection: false;
                                speed: false;
                                ventilation: false;
                            },
                        >,
                        Concrete,
                        new () => {},
                        "closureControl",
                    >,
                ],
            >,
            {},
        >;
        ColorTemperatureLight: ColorTemperatureLightDevice;
        ContactSensor: ContactSensorDevice;
        DeviceEnergyManagement: With<
            For<{}>,
            With<
                {},
                readonly [
                    Type<
                        typeof DefaultDeviceEnergyManagementServer,
                        WithSupportedFeatures<
                            WithSupportedFeatures<
                                DeviceEnergyManagement,
                                {
                                    constraintBasedAdjustment: true;
                                    forecastAdjustment: true;
                                    pausable: true;
                                    powerAdjustment: true;
                                    powerForecastReporting: true;
                                    startTimeAdjustment: true;
                                    stateForecastReporting: false;
                                },
                            >,
                            {
                                constraintBasedAdjustment: false;
                                forecastAdjustment: false;
                                pausable: false;
                                powerAdjustment: false;
                                powerForecastReporting: false;
                                startTimeAdjustment: false;
                                stateForecastReporting: false;
                            },
                        >,
                        Concrete,
                        new () => {},
                        "deviceEnergyManagement",
                    >,
                ],
            >,
            {},
        >;
        DimmableLight: DimmableLightDevice;
        DimmableOutlet: DimmablePlugInUnitDevice;
        DoorLock: DoorLockDevice;
        ElectricalEnergyTariff: ElectricalEnergyTariffDevice;
        ElectricalMeter: ElectricalMeterDevice;
        ElectricalSensor: ElectricalSensorEndpoint;
        ElectricalUtilityMeter: ElectricalUtilityMeterDevice;
        EnergyEvse: With<
            For<{}>,
            With<
                {} & {},
                readonly [
                    Type<
                        typeof DefaultEnergyEvseServer,
                        WithSupportedFeatures<
                            WithSupportedFeatures<
                                EnergyEvse,
                                {
                                    chargingPreferences: true;
                                    plugAndCharge: true;
                                    rfid: true;
                                    soCReporting: true;
                                    v2X: true;
                                },
                            >,
                            {
                                chargingPreferences: false;
                                plugAndCharge: false;
                                rfid: false;
                                soCReporting: false;
                                v2X: false;
                            },
                        >,
                        Concrete,
                        new () => {},
                        "energyEvse",
                    >,
                ],
            >,
            {},
        >;
        ExtendedColorLight: ExtendedColorLightDevice;
        Fan: FanDevice;
        GenericSwitch: With<
            For<{}>,
            With<
                {},
                readonly [
                    Type<
                        typeof SwitchServer,
                        WithSupportedFeatures<
                            WithSupportedFeatures<WithSupportedFeatures<Switch, {}>, {}>,
                            {
                                actionSwitch: false;
                                latchingSwitch: false;
                                momentarySwitch: true;
                                momentarySwitchLongPress: true;
                                momentarySwitchMultiPress: true;
                                momentarySwitchRelease: true;
                            },
                        >,
                        Concrete,
                        typeof Internal,
                        "switch",
                    >,
                ],
            >,
            {},
        >;
        HumiditySensor: HumiditySensorDevice;
        LeakSensor: WaterLeakDetectorDevice;
        LightSensor: LightSensorDevice;
        MediaPlayer: With<
            For<{}>,
            With<
                {} & {} & {},
                readonly [
                    typeof DefaultMediaPlaybackServer,
                    typeof DefaultKeypadInputServer,
                ],
            >,
            {},
        >;
        MotionSensor: With<
            For<{}>,
            With<
                {},
                readonly [
                    Type<
                        typeof OccupancySensingServer,
                        WithSupportedFeatures<
                            OccupancySensing,
                            {
                                activeInfrared: false;
                                occupancyEvent: true;
                                other: false;
                                passiveInfrared: true;
                                physicalContact: false;
                                radar: false;
                                rfSensing: false;
                                ultrasonic: false;
                                vision: false;
                            },
                        >,
                        Concrete,
                        new () => {},
                        "occupancySensing",
                    >,
                ],
            >,
            {},
        >;
        OnOffLight: OnOffLightDevice;
        OnOffOutlet: OnOffPlugInUnitDevice;
        OnOffSwitch: OnOffLightSwitchDevice;
        PowerSource: PowerSourceEndpoint;
        Pump: With<
            For<{}>,
            With<
                {} & {},
                readonly [
                    Type<
                        typeof PumpConfigurationAndControlServer,
                        WithSupportedFeatures<
                            PumpConfigurationAndControl,
                            {
                                automatic: false;
                                compensatedPressure: false;
                                constantFlow: false;
                                constantPressure: false;
                                constantSpeed: true;
                                constantTemperature: false;
                                localOperation: false;
                            },
                        >,
                        Concrete,
                        new () => {},
                        "pumpConfigurationAndControl",
                    >,
                ],
            >,
            {},
        >;
        RoboticVacuumCleaner: RoboticVacuumCleanerDevice;
        RoomAirConditioner: With<
            For<{}>,
            With<
                {} & {},
                readonly [
                    Type<
                        typeof ThermostatServer,
                        WithSupportedFeatures<
                            WithSupportedFeatures<WithSupportedFeatures<Thermostat, {}>, {}>,
                            {
                                autoMode: false;
                                cooling: true;
                                events: false;
                                heating: true;
                                localTemperatureNotExposed: false;
                                matterScheduleConfiguration: false;
                                occupancy: false;
                                presets: false;
                                setback: false;
                                thermostatSuggestions: false;
                            },
                        >,
                        Concrete,
                        typeof Internal,
                        "thermostat",
                    >,
                ],
            >,
            {},
        >;
        SmokeSensor: SmokeCoAlarmDevice;
        SolarPower: SolarPowerDevice;
        Speaker: SpeakerDevice;
        TemperatureSensor: TemperatureSensorDevice;
        Thermostat: ThermostatDevice;
        WaterHeater: With<
            For<{}>,
            With<
                {} & {} & {},
                readonly [
                    Type<
                        Type<
                            typeof ThermostatServer,
                            WithSupportedFeatures<
                                WithSupportedFeatures<WithSupportedFeatures<Thermostat, {}>, {}>,
                                {},
                            >,
                            Concrete,
                            typeof Internal,
                            "thermostat",
                        >,
                        WithSupportedFeatures<
                            WithSupportedFeatures<
                                WithSupportedFeatures<WithSupportedFeatures<Thermostat, {}>, {}>,
                                {},
                            >,
                            {
                                autoMode: false;
                                cooling: false;
                                events: false;
                                heating: true;
                                localTemperatureNotExposed: false;
                                matterScheduleConfiguration: false;
                                occupancy: false;
                                presets: false;
                                setback: false;
                                thermostatSuggestions: false;
                            },
                        >,
                        Concrete,
                        typeof Internal,
                        "thermostat",
                    >,
                    typeof DefaultWaterHeaterManagementServer,
                ],
            >,
            {},
        >;
        WaterValve: With<
            For<{}>,
            With<{} & {}, readonly [typeof DefaultValveConfigurationAndControlServer]>,
            {},
        >;
        WindowCovering: WindowCoveringDevice;
    } = ...

    Friendly device type names for the Plugin API Maps simplified names to actual Matter.js device types

    Type Declaration

    • ReadonlyAirQualitySensor: With<
          For<{}>,
          With<
              {} & {},
              readonly [
                  Type<
                      typeof AirQualityServer,
                      WithSupportedFeatures<
                          AirQuality,
                          { extremelyPoor: true; fair: true; moderate: true; veryPoor: true },
                      >,
                      Concrete,
                      new () => {},
                      "airQuality",
                  >,
              ],
          >,
          {},
      >
    • ReadonlyBatteryStorage: BatteryStorageDevice
    • ReadonlyBridgedNode: BridgedNodeEndpoint
    • ReadonlyClosure: With<
          For<{}>,
          With<
              {} & {},
              readonly [
                  Type<
                      typeof DefaultClosureControlServer,
                      WithSupportedFeatures<
                          ClosureControl,
                          {
                              calibration: false;
                              instantaneous: false;
                              manuallyOperable: false;
                              motionLatching: false;
                              pedestrian: false;
                              positioning: true;
                              protection: false;
                              speed: false;
                              ventilation: false;
                          },
                      >,
                      Concrete,
                      new () => {},
                      "closureControl",
                  >,
              ],
          >,
          {},
      >
    • ReadonlyColorTemperatureLight: ColorTemperatureLightDevice
    • ReadonlyContactSensor: ContactSensorDevice
    • ReadonlyDeviceEnergyManagement: With<
          For<{}>,
          With<
              {},
              readonly [
                  Type<
                      typeof DefaultDeviceEnergyManagementServer,
                      WithSupportedFeatures<
                          WithSupportedFeatures<
                              DeviceEnergyManagement,
                              {
                                  constraintBasedAdjustment: true;
                                  forecastAdjustment: true;
                                  pausable: true;
                                  powerAdjustment: true;
                                  powerForecastReporting: true;
                                  startTimeAdjustment: true;
                                  stateForecastReporting: false;
                              },
                          >,
                          {
                              constraintBasedAdjustment: false;
                              forecastAdjustment: false;
                              pausable: false;
                              powerAdjustment: false;
                              powerForecastReporting: false;
                              startTimeAdjustment: false;
                              stateForecastReporting: false;
                          },
                      >,
                      Concrete,
                      new () => {},
                      "deviceEnergyManagement",
                  >,
              ],
          >,
          {},
      >
    • ReadonlyDimmableLight: DimmableLightDevice
    • ReadonlyDimmableOutlet: DimmablePlugInUnitDevice
    • ReadonlyDoorLock: DoorLockDevice
    • ReadonlyElectricalEnergyTariff: ElectricalEnergyTariffDevice
    • ReadonlyElectricalMeter: ElectricalMeterDevice
    • ReadonlyElectricalSensor: ElectricalSensorEndpoint
    • ReadonlyElectricalUtilityMeter: ElectricalUtilityMeterDevice
    • ReadonlyEnergyEvse: With<
          For<{}>,
          With<
              {} & {},
              readonly [
                  Type<
                      typeof DefaultEnergyEvseServer,
                      WithSupportedFeatures<
                          WithSupportedFeatures<
                              EnergyEvse,
                              {
                                  chargingPreferences: true;
                                  plugAndCharge: true;
                                  rfid: true;
                                  soCReporting: true;
                                  v2X: true;
                              },
                          >,
                          {
                              chargingPreferences: false;
                              plugAndCharge: false;
                              rfid: false;
                              soCReporting: false;
                              v2X: false;
                          },
                      >,
                      Concrete,
                      new () => {},
                      "energyEvse",
                  >,
              ],
          >,
          {},
      >
    • ReadonlyExtendedColorLight: ExtendedColorLightDevice
    • ReadonlyFan: FanDevice
    • ReadonlyGenericSwitch: With<
          For<{}>,
          With<
              {},
              readonly [
                  Type<
                      typeof SwitchServer,
                      WithSupportedFeatures<
                          WithSupportedFeatures<WithSupportedFeatures<Switch, {}>, {}>,
                          {
                              actionSwitch: false;
                              latchingSwitch: false;
                              momentarySwitch: true;
                              momentarySwitchLongPress: true;
                              momentarySwitchMultiPress: true;
                              momentarySwitchRelease: true;
                          },
                      >,
                      Concrete,
                      typeof Internal,
                      "switch",
                  >,
              ],
          >,
          {},
      >
    • ReadonlyHumiditySensor: HumiditySensorDevice
    • ReadonlyLeakSensor: WaterLeakDetectorDevice
    • ReadonlyLightSensor: LightSensorDevice
    • ReadonlyMediaPlayer: With<
          For<{}>,
          With<
              {} & {} & {},
              readonly [
                  typeof DefaultMediaPlaybackServer,
                  typeof DefaultKeypadInputServer,
              ],
          >,
          {},
      >
    • ReadonlyMotionSensor: With<
          For<{}>,
          With<
              {},
              readonly [
                  Type<
                      typeof OccupancySensingServer,
                      WithSupportedFeatures<
                          OccupancySensing,
                          {
                              activeInfrared: false;
                              occupancyEvent: true;
                              other: false;
                              passiveInfrared: true;
                              physicalContact: false;
                              radar: false;
                              rfSensing: false;
                              ultrasonic: false;
                              vision: false;
                          },
                      >,
                      Concrete,
                      new () => {},
                      "occupancySensing",
                  >,
              ],
          >,
          {},
      >
    • ReadonlyOnOffLight: OnOffLightDevice
    • ReadonlyOnOffOutlet: OnOffPlugInUnitDevice
    • ReadonlyOnOffSwitch: OnOffLightSwitchDevice
    • ReadonlyPowerSource: PowerSourceEndpoint
    • ReadonlyPump: With<
          For<{}>,
          With<
              {} & {},
              readonly [
                  Type<
                      typeof PumpConfigurationAndControlServer,
                      WithSupportedFeatures<
                          PumpConfigurationAndControl,
                          {
                              automatic: false;
                              compensatedPressure: false;
                              constantFlow: false;
                              constantPressure: false;
                              constantSpeed: true;
                              constantTemperature: false;
                              localOperation: false;
                          },
                      >,
                      Concrete,
                      new () => {},
                      "pumpConfigurationAndControl",
                  >,
              ],
          >,
          {},
      >
    • ReadonlyRoboticVacuumCleaner: RoboticVacuumCleanerDevice
    • ReadonlyRoomAirConditioner: With<
          For<{}>,
          With<
              {} & {},
              readonly [
                  Type<
                      typeof ThermostatServer,
                      WithSupportedFeatures<
                          WithSupportedFeatures<WithSupportedFeatures<Thermostat, {}>, {}>,
                          {
                              autoMode: false;
                              cooling: true;
                              events: false;
                              heating: true;
                              localTemperatureNotExposed: false;
                              matterScheduleConfiguration: false;
                              occupancy: false;
                              presets: false;
                              setback: false;
                              thermostatSuggestions: false;
                          },
                      >,
                      Concrete,
                      typeof Internal,
                      "thermostat",
                  >,
              ],
          >,
          {},
      >
    • ReadonlySmokeSensor: SmokeCoAlarmDevice
    • ReadonlySolarPower: SolarPowerDevice
    • ReadonlySpeaker: SpeakerDevice
    • ReadonlyTemperatureSensor: TemperatureSensorDevice
    • ReadonlyThermostat: ThermostatDevice
    • ReadonlyWaterHeater: With<
          For<{}>,
          With<
              {} & {} & {},
              readonly [
                  Type<
                      Type<
                          typeof ThermostatServer,
                          WithSupportedFeatures<
                              WithSupportedFeatures<WithSupportedFeatures<Thermostat, {}>, {}>,
                              {},
                          >,
                          Concrete,
                          typeof Internal,
                          "thermostat",
                      >,
                      WithSupportedFeatures<
                          WithSupportedFeatures<
                              WithSupportedFeatures<WithSupportedFeatures<Thermostat, {}>, {}>,
                              {},
                          >,
                          {
                              autoMode: false;
                              cooling: false;
                              events: false;
                              heating: true;
                              localTemperatureNotExposed: false;
                              matterScheduleConfiguration: false;
                              occupancy: false;
                              presets: false;
                              setback: false;
                              thermostatSuggestions: false;
                          },
                      >,
                      Concrete,
                      typeof Internal,
                      "thermostat",
                  >,
                  typeof DefaultWaterHeaterManagementServer,
              ],
          >,
          {},
      >
    • ReadonlyWaterValve: With<
          For<{}>,
          With<{} & {}, readonly [typeof DefaultValveConfigurationAndControlServer]>,
          {},
      >
    • ReadonlyWindowCovering: WindowCoveringDevice