DeviceType

abstract class DeviceType : HomeObjectType, TraitProvider, HasEvents

AggregatorDevice

A device that aggregates endpoints as a collection.

AirPurifierDevice

A device that is designed to clean the air in a room.

AirQualitySensorDevice

A device that is able to monitor and measure various parameters related to ambient air quality in indoor and outdoor environments.

BasicVideoPlayerDevice

A device that is able to play media to a physical output or to a display screen which is part of the device.

CastingVideoClientDevice

A device that is able to launch content on a remote device, for example, a smart speaker or a content provider's phone app.

CastingVideoPlayerDevice

A device that is able to play media to a physical output or to a display screen which is part of the device, and is able to launch content.

ColorDimmerSwitchDevice

A device that is able to control a lighting device by adjusting its color temperature and intensity.

ColorTemperatureLightDevice

A lighting device that is capable of being switched on or off, the intensity of its light adjusted, and its color temperature adjusted.

ContactSensorDevice

A device that detects whether an object, such as a door or window, is opened or closed.

ContentAppDevice

A device that represents an application built by a content provider.

ControlBridgeDevice

A controller device that when bound to a lighting device is capable of being used to switch the device on or off, adjust the intensity of the light, and adjust the color of the light being emitted.

CookSurfaceDevice

A device that represents a heating object on a cooking or other similar device.

CooktopDevice

A device that represents a cooking surface with one or more heating elements.

DeviceEnergyManagementDevice
DimmableLightDevice

A lighting device that is capable of being switched on or off, the intensity of its light adjusted, and being switched by means of a bound occupancy sensor.

DimmablePlugInUnitDevice

A device that is capable of being switched on or off and have its level adjusted by means of a bound controller device such as a Dimmer Switch or a Color Dimmer Switch.

DimmerSwitchDevice

A device that is capable of switching a device on or off and controlling the intensity of the light.

DishwasherDevice

A device that washes dishes, cutlery, and other items associated with food preparation and consumption.

DoorLockControllerDevice

A device that is capable of controlling a door lock.

DoorLockDevice

A device used to secure a door, which can be actuated either by means of a manual or a remote method.

ElectricalSensorDevice
EnergyEvseDevice

A device that is capable of charging an electric or plug-in hybrid vehicle.

ExtendedColorLightDevice

A lighting device that is capable of being switched on or off, the intensity of its light adjusted, its color temperature adjusted, and being switched by means of a bound occupancy sensor.

ExtractorHoodDevice

A device that that is generally installed above a stove or cooktop to reduce odors and smoke by extracting the air.

FanDevice

A device that features a fan and supports multiple modes and variable speed.

FlowSensorDevice

A device that measures and reports the flow rate of a fluid.

GenericSwitchDevice

A device that is capable of being switched on or off, either by latching (such as a rocker) or by momentary (such as a push button).

GoogleAirCoolerDevice

A device that allows temperature cooling and humidity control.

GoogleAudioVideoReceiverDevice

A device that takes audio input (for example, HDMI, optical, and RCA) and outputs sound to one or more speakers.

GoogleAutoDevice
GoogleBathtubDevice

A device that can be filled and drained, possibly to particular levels if the bathtub supports it.

GoogleBlenderDevice

A kitchen appliance device used to stir, chop, or mix food.

GoogleBoilerDevice

A device consisting of a closed vessel and heat source, in which steam or other vapor is generated from water to supply heat.

GoogleChargerDevice

A device that charges electrical storage batteries.

GoogleClosetDevice

A device consisting of a small enclosed area that is used for storing items.

GoogleCoffeeMakerDevice

A kitchen applicance device that makes coffee.

GoogleControlPanelDevice

A device that is capable of configuring and controlling other devices.

GoogleDehydratorDevice

A kitchen appliance device that is used to dehydrate foods such as fruit and vegetables.

GoogleDoorDevice

A device consisting of a solid, movable barrier that controls access to an entrance, a closet, a cabinet, and so forth.

GoogleDoorbellDevice

A device actuated by a button outside a door that makes an audible and/or visual signal, used to request the attention of a person who is somewhere on the other side of the door.

GoogleDrawerDevice

A device consisting of a sliding, lidless, horizontal compartment that may be drawn out from a piece of furniture or a wall in order to gain access to it.

GoogleFaucetDevice

A device that controls the flow of liquid.

GoogleFreezerDevice

A temperature-managing device which may be adjusted to various mode settings, and may allow temperature monitoring.

GoogleFryerDevice

A kitchen appliance device that cooks food by frying it.

GoogleGameConsoleDevice

A device used to manage and play video games.

GoogleGarageDevice

A device consisting of a solid, movable barrier that controls access to a garage.

GoogleGateDevice

A device consisting of a solid, movable barrier that controls access to an outside area through a fence or wall.

GoogleGrillDevice

A device that is used to cook food on a grate by applying direct heat from below.

GoogleKettleDevice

A device that boils water for use in hot beverages such as tea.

GoogleMopDevice

A device that is used to clean floors by dampening and scrubbing them.

GoogleMowerDevice

A device used to trim a lawn to a uniform height.

GoogleMulticookerDevice

A device used to cook food using various methods including slow cooking, sauteing, steaming, or pressure cooking, typically while unattended.

GoogleNetworkDevice

A device representing a group of router nodes or a mesh network controlled as a single entity rather than as individual devices.

GooglePergolaDevice

A device consisting of an arbor formed of horizontal trelliswork supported on columns or posts that can be opened and closed, potentially in more than one direction.

GooglePetFeederDevice

A device that automatically dispenses food to house pets such as cats and dogs.

GooglePressureCookerDevice

A kitchen appliance device that cooks food quickly at a high temperature using steam under pressure.

GoogleRouterDevice

A network device that controls network traffic between two or more different networks.

GoogleSecuritySystemDevice

A device that monitors one or more sensors in a building and can raise an alert if a sensor detects unexpected activity.

GoogleSetTopBoxDevice

A device connected to a TV that is used to access digital video channels.

GoogleShowerDevice

A device consisting of an area where water is sprayed on the body for the purpse of washing.

GoogleSoundbarDevice

An all-in-one audio device that is often used in conjunction with a TV and has a bar form factor.

GoogleSousVideDevice

A kitchen appliance device used to cook foods in a vacuum at comparatively low temperatures.

GoogleSprinklerDevice

A device used to distribute water evenly across an area such as a garden.

GoogleStandmixerDevice

A kitchen appliance device used to blend dry and liquid ingredients to make batter or dough.

GoogleStreamingBoxDevice

A device connected to a TV that is used to access digital streaming services for media and music, often used in conjunction with a display such as a TV.

GoogleStreamingSoundbarDevice

A device consisting of a combination of speaker and streaming stick or box that provides a streaming experience in addition to soundbar capabilities.

GoogleStreamingStickDevice

A device having a small stick-like form factor, usually powered by a USB or HDMI cable, that is connected to a display such as a TV and is used to access digital streaming services for media and music.

GoogleTVDevice

A device that combines a tuner, display, and loudspeakers for the purpose of viewing and hearing media.

GoogleWaterPurifierDevice

A device that filters and purifies water.

GoogleWaterSoftenerDevice

A device that removes minerals from water.

GoogleWindowDevice

A transparent device that allows light into a structure.

GoogleYogurtmakerDevice

A kitchen appliance device that makes yogurt.

HeatingCoolingUnitDevice

A device capable of heating or cooling a space in a home.

HumiditySensorDevice

A device that reports humidity measurements.

LaundryDryerDevice

A device capable of drying laundry items.

LaundryWasherDevice

A device capable of laundering consumer items.

LightSensorDevice

A measurement and sensing device that is capable of measuring and reporting the intensity of light (illuminance) to which the sensor is being subjected.

MicrowaveOvenDevice

A device that uses microwaves to heat food and beverages.

ModeSelectDevice

A device that can be set to one of several predefined values.

OccupancySensorDevice

A measurement and sensing device that is capable of measuring and reporting the occupancy state in a designated area.

OnOffLightDevice

A lighting device that is capable of being switched on or off.

OnOffPluginUnitDevice

A 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.

OnOffSensorDevice

A measurement and sensing device that, when bound to a lighting device, is capable of being used to switch the device on or off.

OvenDevice

A device that contains one or more cabinets, and optionally a cooktop, and is capable of heating food.

PowerSourceDevice

A device that provides energy to operate or charge other equipment.

PressureSensorDevice

A device that measures and reports the pressure of a fluid.

PumpControllerDevice

A device that is capable of configuring and controlling a pump.

PumpDevice

A device typically used to pump fluids like water that may have variable speed.

RainSensorDevice

A device that reports the presence of rain.

RefrigeratorDevice

A device containing one or more cabinets capable of chilling or freezing food.

RoboticVacuumCleanerDevice

A device that autonomously cleans floors and carpets by vacuuming dirt and debris.

RoomAirConditionerDevice

A device with the primary function of controlling the air temperature in a single room.

SpeakerDevice

An audio or video device is capable of having its volume controlled and can be muted or unmuted.

TemperatureControlledCabinetDevice

A device that represents a single cabinet for chilling or freezing food in a refrigerator, freezer, wine chiller or other similar device.

TemperatureSensorDevice

A device that reports measurements of temperature.

ThermostatDevice

A device that is capable of having either built-in or separate sensors for temperature, humidity or occupancy, and allows the desired temperature to be set.

UnknownDeviceType

Represents an unknown DeviceType.

VideoRemoteControlDevice

A device that can control a video player, for example, a traditional universal remote control.

WaterFreezeDetectorDevice

A device that reports the potential of water freezing.

WaterLeakDetectorDevice

A device that reports the presence of a water leak.

WaterValveDevice

A device that is capable of configuring and controlling the flow of water.

WindowCoveringControllerDevice

A device that is capable of controlling an automatic window covering.

WindowCoveringDevice

A device that covers a window and is capable of being raised or tilted.


Abstract base class for all generated DeviceType classes.

For example, com.google.home.matter.standard.DimmableLightDevice.

Summary

Nested types

Public constructors

DeviceType(traitProvider: TraitProvider, eventProvider: HasEvents)

Public functions

open operator Boolean
equals(other: Any?)
open Int

Public properties

abstract DeviceTypeFactory<DeviceType>
abstract DeviceType.Metadata

Protected properties

TraitProvider

Extension functions

Collection<LocalityType>

Returns all distinct data source localities of this device type's traits.

Inherited functions

open Flow<Event>

Gets a flow of all Events available for the object.

open Flow<T>
<T : Event> events(event: EventFactory<T>)

Gets a flow of a specific Event.

open Flow<Event>
<T : Trait> events(trait: TraitFactory<T>)

Gets a flow of all Events by this Trait.

open T?
<T : Trait> trait(traitFactory: TraitFactory<T>)

Access a specific trait on the provider given a caller-provided TraitFactory.

open Set<Trait>

Given a similar accessible trait set as the function above, returns a subset of those traits that are present in the associated HomeConfig.factoryRegistry union'ed with those already known to the extended sub-class (e.g specific DeviceType that is aware of the set of TraitFactorys specified in its type definition).

Inherited properties

abstract Collection<Trait>

This property is deprecated. This member is deprecated please use the traits() API.

Public constructors

DeviceType

DeviceType(traitProvider: TraitProvider, eventProvider: HasEvents)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

factory

abstract val factoryDeviceTypeFactory<DeviceType>

metadata

abstract val metadataDeviceType.Metadata

Protected properties

traitProvider

protected val traitProviderTraitProvider

Extension functions

getLocalityTypes

fun DeviceType.getLocalityTypes(): Collection<LocalityType>

Returns all distinct data source localities of this device type's traits.