# Smart Home Bathtub Guide

`action.devices.types.BATHTUB` - Bathtubs can be filled and drained, possibly to particular levels if the bathtub supports it.

This type indicates that the device gets the Bathtub icon and some related
synonyms and aliases.

## Device capabilities

Refer to the corresponding trait documentation for
implementation details, such as attributes and states that your service should support, and how to
build EXECUTE and QUERY responses.

### Recommended traits

These traits are recommended, if applicable to your device.
However, you are free to mix and match from all available traits to best match your existing
product functionality.

- [`action.devices.traits.Fill`](https://developers.home.google.com/cloud-to-cloud/traits/fill)
- [`action.devices.traits.TemperatureControl`](https://developers.home.google.com/cloud-to-cloud/traits/temperaturecontrol)
- [`action.devices.traits.StartStop`](https://developers.home.google.com/cloud-to-cloud/traits/startstop)

## Example device: Simple bathtub

This section contains example intent payloads representing a common "Bathtub"
based on the device type and traits above. If you add or remove traits in your implementation,
modify your responses accordingly to reflect those changes.

### Sample SYNC response

Request

```
{
  "requestId": "6894439706274654512",
  "inputs": [
    {
      "intent": "action.devices.SYNC"
    }
  ]
}
```
Response

```
{
  "requestId": "6894439706274654512",
  "payload": {
    "agentUserId": "user123",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.BATHTUB",
        "traits": [
          "action.devices.traits.Fill",
          "action.devices.traits.TemperatureControl",
          "action.devices.traits.OnOff",
          "action.devices.traits.StartStop"
        ],
        "name": {
          "name": "Simple bathtub"
        },
        "willReportState": true,
        "attributes": {
          "availableFillLevels": {
            "levels": [
              {
                "level_name": "half_key",
                "level_values": [
                  {
                    "level_synonym": [
                      "Half",
                      "Halfway",
                      "One half"
                    ],
                    "lang": "en"
                  }
                ]
              }
            ],
            "ordered": false
          },
          "temperatureRange": {
            "minThresholdCelsius": 25,
            "maxThresholdCelsius": 100
          },
          "temperatureUnitForUX": "F"
        },
        "deviceInfo": {
          "manufacturer": "smart-home-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        }
      }
    ]
  }
}
```

### Sample QUERY response

Request

```
{
  "requestId": "6894439706274654514",
  "inputs": [
    {
      "intent": "action.devices.QUERY",
      "payload": {
        "devices": [
          {
            "id": "123"
          }
        ]
      }
    }
  ]
}
```
Response

```
{
  "requestId": "6894439706274654514",
  "payload": {
    "devices": {
      "123": {
        "status": "SUCCESS",
        "online": true,
        "on": false,
        "currentFillLevel": "half_key",
        "isFilled": true,
        "temperatureSetpointCelsius": 30,
        "isRunning": true,
        "isPaused": false
      }
    }
  }
}
```

### Sample EXECUTE commands

#### Fill

For additional details on the command parameters,
see the [`action.devices.traits.Fill`](https://developers.home.google.com/cloud-to-cloud/traits/fill#action.devices.commands.fill) reference.

> [!NOTE]
> For commands which have a naturally longer process time, please use the `PENDING` status in the EXECUTE response and follow-up with the [ReportStateAndNotification API](https://developers.home.google.com/cloud-to-cloud/integration/notifications#send-notification) when the command has been completed.

Request

```
{
  "requestId": "6894439706274654516",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.Fill",
                "params": {
                  "fill": true,
                  "fillLevel": "half_key"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
```
Response

```
{
  "requestId": "6894439706274654516",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "PENDING",
        "states": {
          "online": true,
          "on": true,
          "currentFillLevel": "half_key"
        }
      }
    ]
  }
}
```

#### SetTemperature

For additional details on the command parameters,
see the [`action.devices.traits.TemperatureControl`](https://developers.home.google.com/cloud-to-cloud/traits/temperaturecontrol#action.devices.commands.settemperature) reference.
Request

```
{
  "requestId": "6894439706274654520",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.SetTemperature",
                "params": {
                  "temperature": 40
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
```
Response

```
{
  "requestId": "6894439706274654520",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "temperatureSetpointCelsius": 40
        }
      }
    ]
  }
}
```

#### OnOff

For additional details on the command parameters,
see the [`action.devices.traits.OnOff`](https://developers.home.google.com/cloud-to-cloud/traits/onoff#action.devices.commands.onoff) reference.
Request

```
{
  "requestId": "6894439706274654518",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.OnOff",
                "params": {
                  "on": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
```
Response

```
{
  "requestId": "6894439706274654518",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "SUCCESS",
        "states": {
          "online": true,
          "on": true
        }
      }
    ]
  }
}
```

#### StartStop

For additional details on the command parameters,
see the [`action.devices.traits.StartStop`](https://developers.home.google.com/cloud-to-cloud/traits/startstop#action.devices.commands.startstop) reference.

> [!NOTE]
> For commands which have a naturally longer process time, please use the `PENDING` status in the EXECUTE response and follow-up with the [ReportStateAndNotification API](https://developers.home.google.com/cloud-to-cloud/integration/notifications#send-notification) when the command has been completed.

Request

```
{
  "requestId": "6894439706274654522",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.StartStop",
                "params": {
                  "start": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
```
Response

```
{
  "requestId": "6894439706274654522",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "PENDING",
        "states": {
          "online": true,
          "isRunning": true,
          "isPaused": false
        }
      }
    ]
  }
}
```

#### PauseUnpause

For additional details on the command parameters,
see the [`action.devices.traits.StartStop`](https://developers.home.google.com/cloud-to-cloud/traits/startstop#action.devices.commands.pauseunpause) reference.

> [!NOTE]
> For commands which have a naturally longer process time, please use the `PENDING` status in the EXECUTE response and follow-up with the [ReportStateAndNotification API](https://developers.home.google.com/cloud-to-cloud/integration/notifications#send-notification) when the command has been completed.

Request

```
{
  "requestId": "6894439706274654524",
  "inputs": [
    {
      "intent": "action.devices.EXECUTE",
      "payload": {
        "commands": [
          {
            "devices": [
              {
                "id": "123"
              }
            ],
            "execution": [
              {
                "command": "action.devices.commands.PauseUnpause",
                "params": {
                  "pause": true
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
```
Response

```
{
  "requestId": "6894439706274654524",
  "payload": {
    "commands": [
      {
        "ids": [
          "123"
        ],
        "status": "PENDING",
        "states": {
          "online": true,
          "isRunning": false,
          "isPaused": true
        }
      }
    ]
  }
}
```

## Device ERRORS

See the full list of [errors and exceptions](https://developers.home.google.com/cloud-to-cloud/intents/errors-exceptions).