### Install specific release

Source: https://dv.tasshack.com/installation/manually

Downloads and runs the installation script for a specific version by passing the version number as an argument. Replace <version> with the desired release tag.

```bash
wget -O - https://raw.githubusercontent.com/Tasshack/dreame-vacuum/master/install | bash -s -- <version>
```

--------------------------------

### Install latest release

Source: https://dv.tasshack.com/installation/manually

Downloads and runs the installation script for the latest release of the Dreame Vacuum integration. Requires a bash shell and network access to GitHub.

```bash
wget -O - https://raw.githubusercontent.com/Tasshack/dreame-vacuum/master/install | bash -
```

--------------------------------

### dreame_vacuum.vacuum_install_voice_pack

Source: https://dv.tasshack.com/guide/services/vacuum-services

Installs an official voice pack. This service is mentioned in the source but no parameters or examples are provided.

```APIDOC
## dreame_vacuum.vacuum_install_voice_pack

### Description
Install an official voice pack.

### Service
`dreame_vacuum.vacuum_install_voice_pack`

### Notes
- No additional details are provided in the source.
```

--------------------------------

### Dreame Vacuum YAML Configuration Example

Source: https://dv.tasshack.com/configuration-options

Configuration example for the Dreame Vacuum integration. Shows local connection settings (host, token) and cloud connection settings (username, password, country, prefer_cloud). The prefer_cloud option is only available for Xiaomi Home accounts. Also includes dvc_key and notification options.

```yaml
dreame_vacuum:
  # Local connection
  host: 192.168.1.100
  token: b2a1c3d4e5f6a7b8c9d0e1f2a3b4c5d6

  # Cloud connection
  username: your@email.com
  password: your_password
  country: de
  prefer_cloud: true # Only available on Xiaomi Home

  # Options available regardless of connection type
  dvc_key: 123e4567-e89b-42d3-a456-426614174000
  notify:
    - information
    - warning
    - error
```

--------------------------------

### Start Shortcut: dreame_vacuum.vacuum_start_shortcut

Source: https://dv.tasshack.com/guide/services/vacuum-services

Starts a shortcut task created on the official App. Shortcut ids are between 25 and 128 and can be acquired from the 'shortcuts' attribute. Device does not respond while the station is draining or self repairing/testing.

```yaml
service: dreame_vacuum.vacuum_start_shortcut
data:
  shortcut_id: 32
target:
  entity_id: vacuum.vacuum
```

--------------------------------

### Current Map Obstacle Proxy Example

Source: https://dv.tasshack.com/guide/map-support/obstacles

Example URL for fetching an obstacle photo from the current map. Uses the camera_map_obstacle_proxy endpoint with token, index, and crop parameters.

```text
http://local.homeassistant/api/camera_map_obstacle_proxy/camera.vacuum_map?token=5df93cfcf8ecc23fa17b233ca938cc52f41e2b17a46ca291865be3f9ba64d89b&index=2&crop=1
```

--------------------------------

### Camera History Map Proxy URL Example

Source: https://dv.tasshack.com/guide/map-support/history

Example URL for the camera_history_map_proxy endpoint. Returns 404 if the requested history map does not exist.

```text
http://local.homeassistant/api/camera_history_map_proxy/camera.vacuum_map?token=5df93cfcf8ecc23fa17b233ca938cc52f41e2b17a46ca291865be3f9ba64d89b&index=5
```

--------------------------------

### History Map Obstacle Proxy Example

Source: https://dv.tasshack.com/guide/map-support/obstacles

Example URL for fetching an obstacle photo from a history map. Uses the camera_map_obstacle_history_proxy endpoint with token, history_index, and index parameters.

```text
http://local.homeassistant/api/camera_map_obstacle_history_proxy/camera.vacuum_map?token=5df93cfcf8ecc23fa17b233ca938cc52f41e2b17a46ca291865be3f9ba64d89b&history_index=2&index=3
```

--------------------------------

### Example API URL for WiFi Map Proxy

Source: https://dv.tasshack.com/guide/map-support/wifi-map

Example URL for the camera_wifi_map_proxy endpoint. The token is obtained from the camera entity attributes. Returns 404 if the requested map does not exist.

```text
http://local.homeassistant/api/camera_wifi_map_proxy/camera.vacuum_map?token=5df93cfcf8ecc23fa17b233ca938cc52f41e2b17a46ca291865be3f9ba64d89b&index=1
```

--------------------------------

### Start auto emptying via send_command

Source: https://dv.tasshack.com/guide/services/vacuum-services

Sends a raw command to start auto emptying. This service is experimental and not recommended for end users.

```yaml
service: vacuum.send_command
data:
    entity_id: vacuum.vacuum
    command: action
    params: 
        did: "15.1"
        siid: 15
        aiid: 1
        in: []
```

--------------------------------

### dreame_vacuum.vacuum_start_shortcut

Source: https://dv.tasshack.com/guide/services/vacuum-services

Starts a shortcut task that is created on the official App. Shortcut ids can be acquired from the `shortcuts` attribute of the vacuum entity.

```APIDOC
## dreame_vacuum.vacuum_start_shortcut

### Description
Start a shortcut task that is created on the official App.

### Service
`dreame_vacuum.vacuum_start_shortcut`

### Parameters
- **shortcut_id** (number) - Required - ID of the shortcut to start. Valid ids are between 25 and 128.

### Notes
- Shortcuts are only available on supported devices.
- Integration also creates a button entity for every shortcut as `button.{vacuum_name}_shortcut_{shortcut_id}`.
- Device does not respond while the station is draining or self repairing/testing.

### Example
```yaml
service: dreame_vacuum.vacuum_start_shortcut
data:
  shortcut_id: 32
target:
  entity_id: vacuum.vacuum
```
```

--------------------------------

### Set global cleaning mode and start a full clean

Source: https://dv.tasshack.com/guide/more/faq

Home Assistant script that sets the global cleaning mode to 'Sweeping and mopping' using the select entity, then starts a full clean with the vacuum.start service. Replace 'robot_vacuum' with your device's entity name.

```yaml
alias: "Full clean with specific mode"
sequence:
  - service: select.select_option
    target:
      entity_id: select.robot_vacuum_cleaning_mode
    data:
      option: "Sweeping and mopping"
  - service: vacuum.start
    target:
      entity_id: vacuum.robot_vacuum
```

--------------------------------

### dreame_vacuum.vacuum_follow_path

Source: https://dv.tasshack.com/guide/services/vacuum-services

Starts a cruising path job that visits the given coordinates one by one and returns to the dock. This service is only available on devices with the cruising feature and requires live camera streaming to be active.

```APIDOC
## dreame_vacuum.vacuum_follow_path

### Description
Start a cruising path job that visits the given coordinates one by one and returns to the dock.

### Service
`dreame_vacuum.vacuum_follow_path`

### Parameters
- **points** (array of [x, y] pairs) - Optional - List of coordinates to visit. If omitted, saved cruise points of the current map are used. Only the first 20 points are sent to the device.

### Notes
- Only available on devices with the cruising feature.
- Live camera streaming must be active; otherwise the robot ignores the request.
- Battery level must be at least 15% and device does not respond while the station is draining or self repairing/testing.

### Examples
```yaml
service: dreame_vacuum.vacuum_follow_path
data:
  points:
    - - 819
      - -263
    - - 2001
      - -3050
    - - 542
      - 515
target:
  entity_id: vacuum.vacuum
```

```yaml
service: dreame_vacuum.vacuum_follow_path
target:
  entity_id: vacuum.vacuum
```
```

--------------------------------

### Follow Path: dreame_vacuum.vacuum_follow_path (three points)

Source: https://dv.tasshack.com/guide/services/vacuum-services

Starts a cruising path job visiting the given coordinates one by one and returns to the dock. Requires live camera streaming active from the official App; only first 20 points are sent and each must be inside the map. Battery must be at least 15%.

```yaml
service: dreame_vacuum.vacuum_follow_path
data:
  points:
    - - 819
      - -263
    - - 2001
      - -3050
    - - 542
      - 515
target:
  entity_id: vacuum.vacuum
```

--------------------------------

### dreame_vacuum.vacuum_clean_spot

Source: https://dv.tasshack.com/guide/services/vacuum-services

Starts cleaning of selected spots with optional customized cleaning parameters such as repeats.

```APIDOC
## dreame_vacuum.vacuum_clean_spot

### Description
Start selected spot cleaning with optional customized cleaning parameters.

### Service
`dreame_vacuum.vacuum_clean_spot`

### Parameters
- **points** (list of numbers or list of lists) - Required - Spot coordinates. Each spot is a list of two numbers: [x, y]. Can be a single spot or a list of spots.
- **repeats** (integer or list of integers) - Optional - Number of cleaning repeats. Can be a single integer applied to all spots, or a list matching each spot.

### Notes
- Spot cleaning feature is only available for Xiaomi/Mijia branded robots but it works with the Dreame devices too.
- Point coordinates can be acquired with Xiaomi Vacuum Map Card.
- This service does not accept a `cleaning_mode` parameter.

### Examples

#### Clean selected spot
```yaml
service: dreame_vacuum.vacuum_clean_spot
data:
  points: 
    - 819
    - -263
target:
  entity_id: vacuum.vacuum
```

#### Clean multiple spots
```yaml
service: dreame_vacuum.vacuum_clean_spot
data:
  points: 
    - - 819
      - -263
    - - 2001
      - -3050
target:
  entity_id: vacuum.vacuum
```

#### Clean selected spot two times
```yaml
service: dreame_vacuum.vacuum_clean_spot
data:
  points: 
    - 819
    - -263
  repeats: 2
target:
  entity_id: vacuum.vacuum
```

#### Clean first spot two times second spot three times
```yaml
service: dreame_vacuum.vacuum_clean_spot
data:
  points: 
    - - 819
      - -263
    - - 2001
      - -3050
  repeats: 
    - 2
    - 3
target:
  entity_id: vacuum.vacuum
```
```

--------------------------------

### Enable tight mopping and disable carpet boost

Source: https://dv.tasshack.com/guide/services/vacuum-services

Sends a raw command to set properties: enable tight mopping pattern and disable carpet boost.

```yaml
service: vacuum.send_command
data:
    entity_id: vacuum.vacuum
    command: set_properties
    params: 
      - did: "4.29"
        siid: 4
        piid: 29
        value: 1
      - did: "4.12"
        siid: 4
        piid: 12
        value: 0
```

--------------------------------

### dreame_vacuum.vacuum_clean_zone

Source: https://dv.tasshack.com/guide/services/vacuum-services

Starts cleaning of selected zones with optional customized cleaning parameters such as repeats.

```APIDOC
## dreame_vacuum.vacuum_clean_zone

### Description
Start selected zone cleaning with optional customized cleaning parameters.

### Service
`dreame_vacuum.vacuum_clean_zone`

### Parameters
- **zone** (list of numbers or list of lists) - Required - Zone coordinates. Each zone is a list of four numbers: [x1, y1, x2, y2]. Can be a single zone or a list of zones.
- **repeats** (integer or list of integers) - Optional - Number of cleaning repeats. Can be a single integer applied to all zones, or a list matching each zone.

### Notes
- Zone coordinates can be acquired with Xiaomi Vacuum Map Card.
- This service does not accept a `cleaning_mode` parameter.

### Examples

#### Clean selected zone
```yaml
service: dreame_vacuum.vacuum_clean_zone
data:
  zone: 
    - 819
    - -263
    - 4424
    - 2105
target:
  entity_id: vacuum.vacuum
```

#### Clean multiple zones
```yaml
service: dreame_vacuum.vacuum_clean_zone
data:
  zone: 
    - - 819
      - -263
      - 4424
      - 2105
    - - 2001
      - -3050
      - 542
      - 515
target:
  entity_id: vacuum.vacuum
```

#### Clean selected zone two times
```yaml
service: dreame_vacuum.vacuum_clean_zone
data:
  zone: 
    - 819
    - -263
    - 4424
    - 2105
  repeats: 2
target:
  entity_id: vacuum.vacuum
```

#### Clean first zone two times second zone three times
```yaml
service: dreame_vacuum.vacuum_clean_zone
data:
  zone: 
    - - 819
      - -263
      - 4424
      - 2105
    - - 2001
      - -3050
      - 542
      - 515
  repeats: 
    - 2
    - 3
target:
  entity_id: vacuum.vacuum
```
```

--------------------------------

### Set custom cleaning for rooms 1 and 5

Source: https://dv.tasshack.com/guide/services/vacuum-services

Sets custom cleaning parameters for rooms 1 and 5: fan speed quiet and turbo, water level low and medium, repeats 2 and 1. Settings for all rooms must be passed as a list.

```yaml
service: dreame_vacuum.vacuum_set_custom_cleaning
data:
    segment_id: 
      - 1
      - 5
    suction_level: 
      - 0
      - 3
    water_volume: 
      - 1
      - 2
    repeats: 
      - 2
      - 1
target:
    entity_id: vacuum.vacuum
```

--------------------------------

### Enable customized cleaning, set per-room modes, and start room cleaning

Source: https://dv.tasshack.com/guide/more/faq

Home Assistant script that enables customized cleaning, sets different cleaning modes for room 1 and room 2, then starts cleaning those rooms. Uses switch.turn_on, select.select_option, and dreame_vacuum.vacuum_clean_segment services. Replace 'robot_vacuum' with your device's entity name.

```yaml
alias: "Customized room cleaning"
sequence:
  - service: switch.turn_on
    target:
      entity_id: switch.robot_vacuum_customized_cleaning
  - service: select.select_option
    target:
      entity_id: select.robot_vacuum_room_1_cleaning_mode
    data:
      option: "Sweeping"
  - service: select.select_option
    target:
      entity_id: select.robot_vacuum_room_2_cleaning_mode
    data:
      option: "Mopping"
  - service: dreame_vacuum.vacuum_clean_segment
    target:
      entity_id: vacuum.robot_vacuum
    data:
      segments:
        - 1
        - 2
```

--------------------------------

### Vacuum Card YAML Configuration

Source: https://dv.tasshack.com/guide/dashboard/vacuum-card

Example configuration for the Vacuum Card, including entity, map, stats, and shortcuts. The stats section defines default and cleaning attributes with units and subtitles. Shortcuts trigger vacuum cleaning services for specific segments.

```yaml
type: custom:vacuum-card
entity: # Your vacuum entity
map: # Map Entity
map_refresh: 1
stats:
  default:
    - attribute: filter_left
      unit: '%'
      subtitle: Filter
    - attribute: side_brush_left
      unit: '%'
      subtitle: Side brush
    - attribute: main_brush_left
      unit: '%'
      subtitle: Main brush
    - attribute: sensor_dirty_left
      unit: '%'
      subtitle: Sensors
  cleaning:
    - attribute: cleaned_area
      unit: m2
      subtitle: Cleaned area
    - attribute: cleaning_time
      unit: min
      subtitle: Cleaning time
shortcuts:
  - name: Clean Room 1
    service: dreame_vacuum.vacuum_clean_segment
    service_data:
      entity_id: # Your vacuum entity
      segments: 1
    icon: mdi:sofa
  - name: Clean Room 2
    service: dreame_vacuum.vacuum_clean_segment
    service_data:
      entity_id: # Your vacuum entity
      segments: 2
    icon: mdi:bed-empty
  - name: Clean Room 3
    service: dreame_vacuum.vacuum_clean_segment
    service_data:
      entity_id: # Your vacuum entity
      segments: 3
    icon: mdi:silverware-fork-knife
```

--------------------------------

### dreame_vacuum.vacuum_clean_segment

Source: https://dv.tasshack.com/guide/services/vacuum-services

Starts cleaning of selected rooms (segments) with optional customized cleaning parameters such as repeats and suction level.

```APIDOC
## dreame_vacuum.vacuum_clean_segment

### Description
Start selected room cleaning with optional customized cleaning parameters.

### Service
`dreame_vacuum.vacuum_clean_segment`

### Parameters
- **segments** (integer or list of integers) - Required - Room segment IDs to clean. Can be a single integer or a list.
- **repeats** (integer or list of integers) - Optional - Number of cleaning repeats. Can be a single integer applied to all segments, or a list matching each segment.
- **suction_level** (string or list of strings) - Optional - Fan speed level. Can be a single value applied to all segments, or a list matching each segment.

### Notes
- If using integration with map feature, segment IDs can be acquired from vacuum entity attributes.
- Cleaning parameters and cleaning sequence are ignored by the device when `customized_cleaning` or `cleaning_sequence` is enabled.
- This service does not accept a `cleaning_mode` parameter.

### Examples

#### Clean room 3
```yaml
service: dreame_vacuum.vacuum_clean_segment
data:
  segments: 3
target:
  entity_id: vacuum.vacuum
```

#### Clean room 3 and 5
```yaml
service: dreame_vacuum.vacuum_clean_segment
data:
  segments:
    - 3
    - 5
target:
  entity_id: vacuum.vacuum
```

#### Clean room 3 and 5 two times
```yaml
service: dreame_vacuum.vacuum_clean_segment
data:
  segments:
    - 3
    - 5
  repeats: 2
target:
  entity_id: vacuum.vacuum
```

#### Clean room 2 two times and 5 one time
```yaml
service: dreame_vacuum.vacuum_clean_segment
data:
  segments:
    - 3
    - 5
  repeats: 
    - 2
    - 1
target:
  entity_id: vacuum.vacuum
```

#### Clean room 3 and 5 with high fan speed
```yaml
service: dreame_vacuum.vacuum_clean_segment
data:
  segments:
    - 3
    - 5
  suction_level: "high"
target:
  entity_id: vacuum.vacuum
```

#### Clean room 3 with high fan speed and 5 with quiet fan speed
```yaml
service: dreame_vacuum.vacuum_clean_segment
data:
  segments:
    - 3
    - 5
  suction_level: 
    - "high"
    - "quiet"
target:
  entity_id: vacuum.vacuum
```
```

--------------------------------

### Select map service example (YAML)

Source: https://dv.tasshack.com/guide/services/map-services

Changes the currently selected map to the map with id 27. Only possible if multi-floor map is enabled. The robot will end any active job when the map is changed.

```yaml
service: dreame_vacuum.vacuum_select_map
data:
    map_id: 27
target:
    entity_id: vacuum.vacuum
```

--------------------------------

### Map Recovery Image Endpoint URL

Source: https://dv.tasshack.com/guide/map-support/recovery

Example URL for the camera_map_recovery_proxy endpoint. Returns 404 if the requested map does not exist.

```text
`http://local.homeassistant/api/camera_map_recovery_proxy/camera.vacuum_map?token=5df93cfcf8ecc23fa17b233ca938cc52f41e2b17a46ca291865be3f9ba64d89b&index=1&info=0`
```

--------------------------------

### Picture Entity card YAML configuration

Source: https://dv.tasshack.com/guide/dashboard/picture-entity-card

Use this YAML configuration in Home Assistant to display the live map. Replace 'Your vacuum entity' and 'Your camera entity' with your actual entity IDs. The card shows the camera image in live view and disables tap and hold actions.

```yaml
type: picture-entity
entity: # Your vacuum entity
camera_image: # Your camera entity
show_state: false
show_name: false
camera_view: live
tap_action:
  action: none
hold_action:
  action: none
```