OnOffTrait.OffWithEffectCommand

object OnOffTrait.OffWithEffectCommand : CommandDescriptor

Allow devices to be turned off using enhanced ways of fading.

See also
`offWithEffect`	Use this command from the `trait(OnOff)` method.

Summary

Nested types
`class OnOffTrait.OffWithEffectCommand.Request : ClusterStruct` The request payload for the OffWithEffect command.
`@HomeExperimentalApi enum OnOffTrait.OffWithEffectCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.

Public functions
`open Field?`	`@HomeExperimentalApi getCommandRequestFieldById(tagId: UInt)`
`open Field?`	`@HomeExperimentalApi getCommandRequestFieldByName(name: String)`

Public properties
`open String`	`commandId` Unique id corresponding to the command.

@HomeExperimentalApi
open fun getCommandRequestFieldById(tagId: UInt): Field?

@HomeExperimentalApi
open fun getCommandRequestFieldByName(name: String): Field?

open val commandId: String

Unique id corresponding to the command.

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 2025-10-23 UTC.

For devices
- Matter
  New IP-based smart home connectivity protocol that enables broad interoperability with many ecosystems
- Cloud-to-cloud
  Connect your cloud backend with the Smart Home API
- Find out which integration to build
  We’ll recommend an integration based on your device and needs
For apps, platforms & services
- Home APIs
  Access over 600M devices, hubs for Google Home and Matter infrastructure, and an automation engine powered by Google intelligence
Use cases
Business resources
Console
- Developer Console
- Support
- Stack Overflow
- Google Nest Community