View Source GoogleApi.HomeGraph.V1.Model.Device (google_api_home_graph v0.13.0)

Third-party device definition.

Attributes

  • attributes (type: map(), default: nil) - Attributes for the traits supported by the device.
  • customData (type: map(), default: nil) - Custom device attributes stored in Home Graph and provided to your smart home Action in each QUERY and EXECUTE intent. Data in this object has a few constraints: No sensitive information, including but not limited to Personally Identifiable Information.
  • deviceInfo (type: GoogleApi.HomeGraph.V1.Model.DeviceInfo.t, default: nil) - Device manufacturer, model, hardware version, and software version.
  • id (type: String.t, default: nil) - Third-party device ID.
  • name (type: GoogleApi.HomeGraph.V1.Model.DeviceNames.t, default: nil) - Names given to this device by your smart home Action.
  • notificationSupportedByAgent (type: boolean(), default: nil) - Indicates whether your smart home Action will report notifications to Google for this device via ReportStateAndNotification. If your smart home Action enables users to control device notifications, you should update this field and call RequestSyncDevices.
  • otherDeviceIds (type: list(GoogleApi.HomeGraph.V1.Model.AgentOtherDeviceId.t), default: nil) - Alternate IDs associated with this device. This is used to identify cloud synced devices enabled for local fulfillment.
  • roomHint (type: String.t, default: nil) - Suggested name for the room where this device is installed. Google attempts to use this value during user setup.
  • structureHint (type: String.t, default: nil) - Suggested name for the structure where this device is installed. Google attempts to use this value during user setup.
  • traits (type: list(String.t), default: nil) - Traits supported by the device. See device traits.
  • type (type: String.t, default: nil) - Hardware type of the device. See device types.
  • willReportState (type: boolean(), default: nil) - Indicates whether your smart home Action will report state of this device to Google via ReportStateAndNotification.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.HomeGraph.V1.Model.Device{
  attributes: map() | nil,
  customData: map() | nil,
  deviceInfo: GoogleApi.HomeGraph.V1.Model.DeviceInfo.t() | nil,
  id: String.t() | nil,
  name: GoogleApi.HomeGraph.V1.Model.DeviceNames.t() | nil,
  notificationSupportedByAgent: boolean() | nil,
  otherDeviceIds: [GoogleApi.HomeGraph.V1.Model.AgentOtherDeviceId.t()] | nil,
  roomHint: String.t() | nil,
  structureHint: String.t() | nil,
  traits: [String.t()] | nil,
  type: String.t() | nil,
  willReportState: boolean() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.