Device Traits
Stay organized with collections
Save and categorize content based on your preferences.
The functionality for device types comes from the traits that you add to each one.
Each device type has a number of recommended traits, but you can add whichever ones you
want.
| Name |
Device Traits |
Description |
Recommended Device Types |
| Brightness |
action.devices.traits.Brightness |
Absolute brightness setting is in a normalized range from 0 to
100 (individual lights may not support every point in the range based on their LED configuration). |
Light Guide |
| ColorSpectrum |
action.devices.traits.ColorSpectrum |
This applies to "full" color bulbs that take RGB color
ranges. Lights may have any combination of ColorSpectrum and
ColorTemperature; accent lights and LED strips may just have Spectrum,
whereas some reading bulbs just have Temperature. Basic bulbs, or dumb lights on smart plugs, have
neither. |
Light Guide |
| ColorTemperature |
action.devices.traits.ColorTemperature |
This applies to "warmth" bulbs that take a color point
in Kelvin. This is generally a separate modality from ColorSpectrum,
and there may be white points available via Temperature that cannot be reached by Spectrum. Based on
available traits, Google may pick the appropriate mode to use based on request and light type
(for example, Make the living room lights white might send Temperature commands to some bulbs
and Spectrum commands to LED strips). |
Light Guide |
| Dock |
action.devices.traits.Dock |
This trait is designed for self-mobile devices that can be commanded
to return for charging. |
Various appliances |
| OnOff |
action.devices.traits.OnOff |
The basic on and off functionality for any device that has binary
on and off, including plugs and switches as well as many future devices. |
Light Guide |
| StartStop |
action.devices.traits.StartStop |
Starting and stopping a device serves a similar function to
turning it on and off. Devices that inherit this trait function differently when turned on and when
started. Unlike devices that simply have an on and off state, some devices that can start and stop
are also able to pause while performing operation. |
Any - mostly appliances and vacuums and other things that have specific
activity behavior above and beyond power |
| TemperatureSetting |
action.devices.traits.TemperatureSetting |
This trait covers handling both temperature point and
modes. |
Thermostat Guide |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eDevice functionality is determined by assigned traits.\u003c/p\u003e\n"],["\u003cp\u003eEach device type has suggested traits, but you can customize them.\u003c/p\u003e\n"],["\u003cp\u003eTraits control actions like brightness, color, on/off state, and temperature.\u003c/p\u003e\n"],["\u003cp\u003eSome traits are recommended for specific device types, like lights or thermostats.\u003c/p\u003e\n"]]],["Device functionality is defined by added traits. Available traits include `Brightness` (0-100 range), `ColorSpectrum` (RGB), and `ColorTemperature` (Kelvin). `Dock` is for self-mobile devices returning for charging. `OnOff` provides basic on/off, while `StartStop` allows starting, stopping, and pausing. `TemperatureSetting` handles temperature points and modes. Each trait has recommended device types, but any combination can be used.\n"],null,["# Device Traits\n\nThe functionality for device types comes from the traits that you add to each one.\nEach device type has a number of recommended traits, but you can add whichever ones you\nwant.\n\n| Name | Device Traits | Description | Recommended Device Types |\n|--------------------------------------------------------------------------|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|\n| [Brightness](/assistant/sdk/reference/traits/brightness) | `action.devices.traits.Brightness` | Absolute brightness setting is in a normalized range from 0 to 100 (individual lights may not support every point in the range based on their LED configuration). | [Light Guide](/assistant/smarthome/guides/light) |\n| [ColorSpectrum](/assistant/sdk/reference/traits/colorspectrum) | `action.devices.traits.ColorSpectrum` | This applies to \"full\" color bulbs that take RGB color ranges. Lights may have any combination of ColorSpectrum and [ColorTemperature](/assistant/sdk/reference/traits/colortemperature); accent lights and LED strips may just have Spectrum, whereas some reading bulbs just have Temperature. Basic bulbs, or dumb lights on smart plugs, have neither. | [Light Guide](/assistant/smarthome/guides/light) |\n| [ColorTemperature](/assistant/sdk/reference/traits/colortemperature) | `action.devices.traits.ColorTemperature` | This applies to \"warmth\" bulbs that take a color point in Kelvin. This is generally a separate modality from [ColorSpectrum](/assistant/sdk/reference/traits/colorspectrum), and there may be white points available via Temperature that cannot be reached by Spectrum. Based on available traits, Google may pick the appropriate mode to use based on request and light type (for example, *Make the living room lights white* might send Temperature commands to some bulbs and Spectrum commands to LED strips). | [Light Guide](/assistant/smarthome/guides/light) |\n| [Dock](/assistant/sdk/reference/traits/dock) | `action.devices.traits.Dock` | This trait is designed for self-mobile devices that can be commanded to return for charging. | Various appliances |\n| [OnOff](/assistant/sdk/reference/traits/onoff) | `action.devices.traits.OnOff` | The basic on and off functionality for any device that has binary on and off, including plugs and switches as well as many future devices. | [Light Guide](/assistant/smarthome/guides/light) |\n| [StartStop](/assistant/sdk/reference/traits/startstop) | `action.devices.traits.StartStop` | Starting and stopping a device serves a similar function to turning it on and off. Devices that inherit this trait function differently when turned on and when started. Unlike devices that simply have an on and off state, some devices that can start and stop are also able to pause while performing operation. | Any - mostly appliances and vacuums and other things that have specific activity behavior above and beyond power |\n| [TemperatureSetting](/assistant/sdk/reference/traits/temperaturesetting) | `action.devices.traits.TemperatureSetting` | This trait covers handling both temperature point and modes. | [Thermostat Guide](/assistant/smarthome/guides/thermostat) |"]]
