Skip to content
220 changes: 197 additions & 23 deletions docs/V1_API_COMMANDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Commands do not immediately make it to this page. You can find more commands [he

Commands can have multiple parameters that can change from one model to another.

* [app_amethyst_self_check](#app_amethyst_self_check)
* [app_charge](#app_charge)
* [app_get_dryer_setting](#app_get_dryer_setting)
* [app_get_init_status](#app_get_init_status)
Expand All @@ -26,12 +27,14 @@ Commands can have multiple parameters that can change from one model to another.
* [close_dnd_timer](#close_dnd_timer)
* [del_server_timer](#del_server_timer)
* [dnld_install_sound](#dnld_install_sound)
* [get_auto_delivery_cleaning_fluid](#get_auto_delivery_cleaning_fluid)
* [get_clean_sequence](#get_clean_sequence)
* [get_consumable](#get_consumable)
* [get_custom_mode](#get_custom_mode)
* [get_customize_clean_mode](#get_customize_clean_mode)
* [get_dnd_timer](#get_dnd_timer)
* [get_dust_collection_mode](#get_dust_collection_mode)
* [get_dust_collection_switch_status](#get_dust_collection_switch_status)
* [get_clean_follow_ground_material_status](#get_clean_follow_ground_material_status)
* [get_identify_furniture_status](#get_identify_furniture_status)
* [get_identify_ground_material_status](#get_identify_ground_material_status)
Expand All @@ -51,6 +54,7 @@ Commands can have multiple parameters that can change from one model to another.
* [get_turn_server](#get_turn_server)
* [get_valley_electricity_timer](#get_valley_electricity_timer)
* [get_wash_towel_mode](#get_wash_towel_mode)
* [get_wash_water_temperature](#get_wash_water_temperature)
* [load_multi_map](#load_multi_map)
* [name_segment](#name_segment)
* [reset_consumable](#reset_consumable)
Expand All @@ -61,11 +65,13 @@ Commands can have multiple parameters that can change from one model to another.
* [save_map](#save_map)
* [send_ice_to_robot](#send_ice_to_robot)
* [send_sdp_to_robot](#send_sdp_to_robot)
* [set_auto_delivery_cleaning_fluid](#set_auto_delivery_cleaning_fluid)
* [set_server_timer](#set_server_timer)
* [set_clean_motor_mode](#set_clean_motor_mode)
* [set_customize_clean_mode](#set_customize_clean_mode)
* [set_dnd_timer](#set_dnd_timer)
* [set_dust_collection_mode](#set_dust_collection_mode)
* [set_dust_collection_switch_status](#set_dust_collection_switch_status)
* [set_fds_endpoint](#set_fds_endpoint)
* [set_identify_furniture_status](#set_identify_furniture_status)
* [set_identify_ground_material_status](#set_identify_ground_material_status)
Expand All @@ -78,6 +84,7 @@ Commands can have multiple parameters that can change from one model to another.
* [set_timezone](#set_timezone)
* [set_valley_electricity_timer](#set_valley_electricity_timer)
* [set_wash_towel_mode](#set_wash_towel_mode)
* [set_wash_water_temperature](#set_wash_water_temperature)
* [set_water_box_custom_mode](#set_water_box_custom_mode)
* [start_camera_preview](#start_camera_preview)
* [start_edit_map](#start_edit_map)
Expand Down Expand Up @@ -248,13 +255,15 @@ Parameters: None

### app_stop_wash

Description: This stops washing the mop whiloe docked
Description: This stops washing the mop whiloe docked. It also stops a running wash tray self-clean
([app_amethyst_self_check](#app_amethyst_self_check)).

Parameters: None

**Supported devices:**

* Roborock S8 Pro Ultra: ✅
* Roborock Saros 10R: ✅

### app_goto_target

Expand Down Expand Up @@ -712,48 +721,48 @@ Parameters:

### get_smart_wash_params

Description: Returns the smartwash parameters
Description: Returns when the dock washes the mop during a clean (app: mop wash frequency)

Parameters: None

<!--
Not clear what this does
-->

Returns:

smart_wash: 0 is off, 1 is on
smart_wash: 0 by time, 1 by room, 2 new smart (only on devices with is_back_wash_new_smart_supported)

wash_interval: The interval in seconds between washes
wash_interval: The interval in seconds between washes when washing by time (app offers 600, 900, 1200, 1500; 600 to 3000 in steps of 300 on TopazS, TopazSV, TopazSPlus, TopazSC, TopazSPower and UltronSPlus)

Example:

```json
{'smart_wash': 0, 'wash_interval': 1200}
{'smart_wash': 1, 'wash_interval': 1200}
```

Source: Roborock Saros 10R

**Supported devices:**

* Roborock S8 Pro Ultra: ✅
* Roborock Saros 10R: ✅

### set_smart_wash_params

Description: Sets the smartwash parameters
Description: Sets when the dock washes the mop during a clean

Parameters:

smart_wash: 0 is off, 1 is on
smart_wash: 0 by time, 1 by room, 2 new smart (only on devices with is_back_wash_new_smart_supported)

wash_interval: The interval in seconds between washes
wash_interval: The interval in seconds between washes when washing by time: 600, 900, 1200 or 1500; 600 to 3000 in steps of 300 on TopazS, TopazSV, TopazSPlus, TopazSC, TopazSPower and UltronSPlus


`{'smart_wash': 0, 'wash_interval': 1200}`
`{'smart_wash': 1, 'wash_interval': 1200}`

Source: Roborock Saros 10R, Roborock app plugin

**Supported devices:**

* Roborock S8 Pro Ultra: ✅
* Roborock Saros 10R: ✅

## Cleaning history

Expand Down Expand Up @@ -1202,44 +1211,98 @@ Return example:

Source: Roborock S7 MaxV Ultra

Saros 10R return example:

```json
{'mode': 4}
```

**Supported devices:**

* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
* Roborock Saros 10R: ✅


### set_dust_collection_mode

Description:
Description: Set the dock dust collection mode.

Parameters:

### get_wash_towel_mode
mode: 0 smart, 1 light, 2 balanced, 3 strong, 4 max. The app offers 0, 1, 2 and 4.

Description:
Example:

```json
{'mode': 4}
```

Source: Roborock Saros 10R

**Supported devices:**

* Roborock Saros 10R: ✅

### get_dust_collection_switch_status

Description: Get how often the dock empties the dustbin automatically (app: auto-empty frequency).

Parameters: None

Returns:

wash_mode:
status: 0 off, 1 balanced, 2 high. Devices without new feature string bit 53 only use 0 (off) and 1 (on). Mirrors `auto_dust_collection` in `get_status`.

Return example:

```json
{'wash_mode': 1}
{'status': 2}
```

Source: Roborock S7 MaxV Ultra
Source: Roborock Saros 10R

**Supported devices:**

* Roborock Saros 10R: ✅

### set_dust_collection_switch_status

Description: Set how often the dock empties the dustbin automatically.

Parameters:

status: 0 off, 1 balanced, 2 high. Devices without new feature string bit 53 only use 0 (off) and 1 (on).

Example:

```json
{'status': 2}
```

Source: Roborock Saros 10R

**Supported devices:**

* Roborock Saros 10R: ✅

### get_wash_towel_mode

unknown = -9999
Description:

light = 0
Parameters: None

balanced = 1
Returns:

deep = 2
wash_mode: 0 light, 1 balanced, 2 deep, 8 super deep, 10 smart

Return example:

```json
{'wash_mode': 1}
```

Source: Roborock S7 MaxV Ultra; smart (10) seen on the Roborock Saros 10R


**Supported devices:**
Expand All @@ -1254,6 +1317,9 @@ Description: Sets the wash wash_towel_mode

Parameters: {'wash_mode': 2}

wash_mode: 0 light, 1 balanced, 2 deep, 8 super deep, 10 smart. Super deep and smart are offered only on
devices that support them.

Returns: ok or error

Source: S8 Pro Ultra
Expand All @@ -1263,6 +1329,114 @@ Source: S8 Pro Ultra
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅

### app_amethyst_self_check

Description: Start the self-clean of the dock's mop wash tray (app: tray self-cleaning). Offered on docks with a
self-cleaning wash carousel, such as the Saros 10R dock (dock type 16).

Parameters: None

Returns: ok or error

While it runs, `get_status` reports `state` 23 (washing the mop) and `wash_phase` 11, the same as when the
self-clean is started from the app. The dock needs clean water (`dock_error_status` 38, water empty, otherwise).
It ends by itself after about a minute; `app_stop_wash` stops it early, like the stop button in the app.

Source: Roborock Saros 10R, Roborock app plugin

**Supported devices:**

* Roborock Saros 10R: ✅

### get_wash_water_temperature

Description: Get the water temperature the dock uses to wash the mop (app: water temperature). Available on
washing docks of devices with the hot wash towel feature (`is_hot_wash_towel_supported`). Not available on the
PearlE Pro (a169/a170) unless the dock is a Shell2E Lite.

Parameters: None

Returns:

wash_water_temperature: 0 room temperature, 1 warm, 2 hot, 3 steam, 4 pet steam.
Docks offer 0 and 2; 1 only on docks with neither high temperature water nor steam; 3 only on steam docks.

Return example:

```json
{'wash_water_temperature': 2}
```

Source: Roborock Saros 10R

**Supported devices:**

* Roborock Saros 10R: ✅

### set_wash_water_temperature

Description: Set the water temperature the dock uses to wash the mop.

Parameters:

values: 0 room temperature, 1 warm, 2 hot, 3 steam, 4 pet steam.
The key differs from the one `get_wash_water_temperature` returns; `{'wash_water_temperature': 2}` is
rejected with -10007 invalid params.

Example:

```json
{'values': 2}
```

Source: Roborock Saros 10R

**Supported devices:**

* Roborock Saros 10R: ✅

### get_auto_delivery_cleaning_fluid

Description: Get how much cleaning fluid the dock adds automatically (app: cleaning fluid auto-delivery).

Parameters: None

Returns:

status: 0 off, 1 standard, 3 large. Code 2 is not used by the app.

Return example:

```json
{'status': 1}
```

Source: Roborock Saros 10R, Roborock app plugin

**Supported devices:**

* Roborock Saros 10R: ✅

### set_auto_delivery_cleaning_fluid

Description: Set how much cleaning fluid the dock adds automatically.

Parameters:

status: 0 off, 1 standard, 3 large.

Example:

```json
{'status': 1}
```

Source: Roborock Saros 10R, Roborock app plugin

**Supported devices:**

* Roborock Saros 10R: ✅

### get_collision_avoid_status

Description:
Expand Down
12 changes: 6 additions & 6 deletions docs/V1_DEVICE_FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,8 +200,8 @@ An array of integer feature IDs. Feature is supported if ID is present in the ar
### is_dust_collection_setting_supported
**Bit Mask:** `33554432` (bit 25)
**Feature:** Dust Collection Settings
**Description:** Options for auto-empty dock dust collection frequency and duration.
**Impact:** Configure when and how aggressively the dock empties the dustbin.
**Description:** The app loads and shows the dock's dust collection mode (`get_dust_collection_mode`) only with this feature. The auto-empty frequency and manual dust collection do not depend on it.
**Impact:** Gates `DustCollectionModeTrait`, together with `is_collect_dust_mode_supported` and a collecting dock.

---

Expand Down Expand Up @@ -762,8 +762,8 @@ These features are encoded as individual bits in the `new_feature_info_str` hex
### is_auto_collection_2_supported
**Bit Index:** 53
**Feature:** Auto-Empty 2.0
**Description:** Second generation auto-empty dock system.
**Impact:** Improved dustbin emptying with better suction and reliability.
**Description:** Second generation auto-empty dock system. With this feature the app offers an auto-empty frequency (off, balanced, high); without it, collecting docks only have an auto-empty on/off switch.
**Impact:** `DustCollectionTrait.frequency_options` includes `high` only with this feature.

---

Expand Down Expand Up @@ -1362,8 +1362,8 @@ These features are enabled/disabled based on specific device model whitelists or
### is_collect_dust_mode_supported
**Model Blacklist:** PEARL (all except PEARL)
**Feature:** Dust Collection Mode
**Description:** Auto-empty dock dust collection.
**Impact:** Automatic dustbin emptying at dock.
**Description:** Auto-empty dock dust collection mode. The app shows the dock's dust collection mode page only with this feature and a collecting dock. The auto-empty frequency and manual dust collection do not depend on it.
**Impact:** Gates `DustCollectionModeTrait`, together with `is_dust_collection_setting_supported` and a collecting dock.

---

Expand Down
Loading
Loading