1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
|
# Api commands
This page is still under construction. All of the following are the commands we have reverse engineered. It is not an exhaustive list of all the possible commands.
Commands do not immediately make it to this page. You can find more commands [here](https://github.com/humbertogontijo/python-roborock/blob/main/roborock/roborock_typing.py#L18)
Commands can have multiple parameters that can change from one model to another.
* [app_charge](#app_charge)
* [app_get_dryer_setting](#app_get_dryer_setting)
* [app_get_init_status](#app_get_init_status)
* [app_pause](#app_pause)
* [app_rc_end](#app_rc_end)
* [app_rc_move](#app_rc_move)
* [app_rc_start](#app_rc_start)
* [app_rc_stop](#app_rc_stop)
* [app_segment_clean](#app_segment_clean)
* [app_set_dryer_setting](#app_set_dryer_setting)
* [app_start_collect_dust](#app_start_collect_dust)
* [app_start_wash](#app_start_wash)
* [app_start](#app_start)
* [app_stop_collect_dust](#app_stop_collect_dust)
* [app_stop_wash](#app_stop_wash)
* [app_stop](#app_stop)
* [change_sound_volume](#change_sound_volume)
* [close_dnd_timer](#close_dnd_timer)
* [del_server_timer](#del_server_timer)
* [dnld_install_sound](#dnld_install_sound)
* [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_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)
* [get_led_status](#get_led_status)
* [get_map_v1](#get_map_v1)
* [get_multi_map](#get_multi_map)
* [get_multi_maps_list](#get_multi_maps_list)
* [get_network_info](#get_network_info)
* [get_prop](#get_prop)
* [get_room_mapping](#get_room_mapping)
* [get_scenes_valid_tids](#get_scenes_valid_tids)
* [get_serial_number](#get_serial_number)
* [get_smart_wash_params](#get_smart_wash_params)
* [get_sound_progress](#get_sound_progress)
* [get_status](#get_status)
* [get_timezone](#get_timezone)
* [get_turn_server](#get_turn_server)
* [get_valley_electricity_timer](#get_valley_electricity_timer)
* [get_wash_towel_mode](#get_wash_towel_mode)
* [load_multi_map](#load_multi_map)
* [name_segment](#name_segment)
* [reset_consumable](#reset_consumable)
* [resume_segment_clean](#resume_segment_clean)
* [resume_zoned_clean](#resume_zoned_clean)
* [retry_request](#retry_request)
* [reunion_scenes](#reunion_scenes)
* [save_map](#save_map)
* [send_ice_to_robot](#send_ice_to_robot)
* [send_sdp_to_robot](#send_sdp_to_robot)
* [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_fds_endpoint](#set_fds_endpoint)
* [set_identify_furniture_status](#set_identify_furniture_status)
* [set_identify_ground_material_status](#set_identify_ground_material_status)
* [set_led_status](#set_led_status)
* [set_mop_mode](#set_mop_mode)
* [set_scenes_segments](#set_scenes_segments)
* [set_scenes_zones](#set_scenes_zones)
* [set_segment_ground_material](#set_segment_ground_material)
* [set_smart_wash_params](#set_smart_wash_params)
* [set_timezone](#set_timezone)
* [set_valley_electricity_timer](#set_valley_electricity_timer)
* [set_wash_towel_mode](#set_wash_towel_mode)
* [set_water_box_custom_mode](#set_water_box_custom_mode)
* [start_camera_preview](#start_camera_preview)
* [start_edit_map](#start_edit_map)
* [start_voice_chat](#start_voice_chat)
* [start_wash_then_charge](#start_wash_then_charge)
* [stop_camera_preview](#stop_camera_preview)
* [stop_segment_clean](#stop_segment_clean)
* [test_sound_volume](#test_sound_volume)
* [upd_server_timer](#upd_server_timer)
## Robot status
### get_status
Description: Returns the current status of the vacuum
Parameters: None
Returns:
msg_ver:
msg_seq:
state:
battery: Battery level of your device.
clean_time: Total clean time in hours.
clean_area: Total clean area in meters.
error_code:
map_reset:
in_cleaning:
in_returning:
in_fresh_state:
lab_status:
water_box_status:
back_type:
wash_phase:
wash_ready:
fan_power:
dnd_enabled:
map_status:
is_locating:
lock_status:
water_box_mode:
water_box_carriage_status:
mop_forbidden_enable:
camera_status:
is_exploring:
home_sec_status:
home_sec_enable_password:
adbumper_status:
water_shortage_status:
dock_type:
dust_collection_status:
auto_dust_collection:
avoid_count:
mop_mode:
debug_mode:
collision_avoid_status:
switch_map_mode:
dock_error_status:
charge_status:
unsave_map_reason:
unsave_map_flag:
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
## App vacuum control
### app_start
Description:
Parameters:
### app_pause
Description: This pauses the vacuum's current task
Parameters: None
Returns ok or error
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### app_stop
Description:
Parameters:
### app_start_collect_dust
Description: This empties the bin while docked
Parameters: None
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### app_stop_collect_dust
Description: This stops the emptying of the dust bin while docked
Parameters: None
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### app_start_wash
Description: This washes the mop while docked
Parameters: None
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### app_stop_wash
Description: This stops washing the mop whiloe docked
Parameters: None
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### app_goto_target
Description: Got to target
Parameters:
- X coordinate as integer (e.g.: 23450)
- Y coordinate as integer (e.g.: 16450)
Returns ok or error
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### app_charge
Description: This tells your vacuum to go back to the dock and charge.
Parameters: None
Returns : ok or error
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
## App status
### app_get_init_status
Description: Returns details on the app being used to interact with Roborock servers ?? In this case the app is backend supporting the HA integration ?
Parameters: None
Returns:
local_info:
name: Name of the app
bom: Version of the app
location: Location of the app
language: Language of the app
wifiplan: Wifi plan of the app
timezone: Timezone of the app
logserver: Log server of the app
featureset: Featureset of the app
feature_info: List of features
new_feature_info: New feature info
Return example:
```json
{'local_info': {'name': 'custom_A.03.0342_CE', 'bom': 'A.03.0342', 'location': 'de', 'language': 'en', 'wifiplan': '', 'timezone': 'Europe/Berlin', 'logserver': 'awsde0.fds.api.xiaomi.com', 'featureset': 3}, 'feature_info': [111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125], 'new_feature_info': 2247395306799103, 'new_feature_info_str': '00000008009EFFFE'}
```
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
## App dryer settings
### app_get_dryer_setting
Description: Get dock dryer settings.
Parameters: None
Returns:
status:
on:
cliff_on:
cliff_off
count:
dry_time: Duration dryer remains on in seconds.
off:
cliff_on:
cliff_off:
count:
Return example:
```json
{'status': 1, 'on': {'cliff_on': 1, 'cliff_off': 1, 'count': 10, 'dry_time': 7200}, 'off': {'cliff_on': 2, 'cliff_off': 1, 'count': 10}}
```
Source: Roborock S7 MaxV Ultra
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### app_set_dryer_setting
Description: Set the time for the dryer to run
Parameters: '{"status":1,"on":{"dry_time":14400}}'
dry_time is the time in seconds the dryer will run for
Returns ok or error
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
## App remote control
### app_rc_start
Description: Starts remote control.
Parameters: None
Returns ok or error
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### app_rc_move
Description: Moves the robot in the direction specified
Parameters: To be documented
Returns ok or error
<!--
Need to document the parameters - will need to explore the app to find out what they are
-->
### app_rc_stop
Description: Stops the remote control
Parameters: None
Returns ok or error
<!--
Assume stop stops a move ?? Need to check
-->
### app_rc_end
Description: Ends the remote control task
Parameters:
Returns ok or error
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
## App other
### app_set_smart_cliff_forbidden
Description:
Parameters:
### app_spot
Description:
Parameters:
### app_stat
Description: This returns the current status of the vacuum
Parameters: None
Returns: ok or error
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### app_wakeup_robot
Description:
Parameters:
### app_zoned_clean
Description: Starts a zone clean
Parameters:
<!--
Us this the last known zone
-->
Returns: ok or error
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
## Segments and Zones
### app_segment_clean
Description: This starts a segment clean and repeats it the number of times specified.
Parameters: An array of segments to clean. Each segment is an integer with the segment id and the number of times to clean it. For example, to clean segment 18 twice, the parameter would be
`[{'segments': [18], 'repeat': 2}]`
<!-- Comment: The segment id can be obtained from the initial data returned on login -->
Command:
`roborock -d command --device_id deviceIdRedacted --cmd app_segment_clean --params '[{"segments": [17,19], "repeat": 2}]'`
Returns ok or error
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### set_segment_ground_material
Description: Sets the groud material for the segment
Parameters: "{'data':[[22,3,0]]}"
Returns ok or error
### name_segment
Description:
Parameters: To be determined
<!--
Need to work out parameter format
Does this allow us to name a segment ?
-->
### resume_segment_clean
Description:
Parameters:
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### stop_segment_clean
Description:
Parameters:
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### set_scenes_zones
Description:
Parameters:
### set_scenes_segments
Description:
Parameters:
### get_scenes_valid_tids
Description: To be confirmed
Parameters: None
<!--
Appears to be associated with rooms ??
-->
Returns:
```json
[{'tid': '1699679077347', 'map_flag': 0, 'segs': [{'sid': 24}, {'sid': 20}, {'sid': 22}, {'sid': 18}]}, {'tid': '1699679236553', 'map_flag': 0, 'segs': [{'sid': 24}, {'sid': 20}, {'sid': 22}]}, {'tid': '1699679386045', 'map_flag': 0, 'segs': [{'sid': 16}, {'sid': 19}, {'sid': 17}]}, {'tid': '1699679335823', 'map_flag': 0, 'segs': [{'sid': 19}, {'sid': 16}, {'sid': 17}]}]
```
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### resume_zoned_clean
Description:
Parameters:
### reunion_scenes
Description:
Parameters:
## Camera
### start_camera_preview
Description:
Parameters:
**Supported devices:**
* Roborock S8 Pro Ultra: ❌
### stop_camera_preview
Description:
Parameters:
**Supported devices:**
* Roborock S8 Pro Ultra: ❌
### get_camera_status
Description: Get camera status.
Parameters: None
Returns: 3457
387 Roborock S8 Pro Ultra
Source: Roborock S7 MaxV Ultra
### set_camera_status
Description:
Parameters:
### start_voice_chat
Description:
Parameters:
**Supported devices:**
* Roborock S8 Pro Ultra: ❌
## Clean modes
### get_carpet_clean_mode
Description: Get carpet clean mode.
Parameters:
Returns:
carpet_clean_mode: Enumeration for carpet clean mode.
Return example:
```json
{'carpet_clean_mode': 3}
```
Source: Roborock S7 MaxV Ultra
### set_carpet_clean_mode
Description:
Parameters:
### get_carpet_mode
Description:
Parameters: None
Returns:
enable:
current_integral:
current_high:
current_low:
stall_time:
Return example:
```json
{'enable': 1, 'current_integral': 450, 'current_high': 500, 'current_low': 400, 'stall_time': 10}
```
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### set_carpet_mode
Description:
Parameters:
### get_smart_wash_params
Description: Returns the smartwash parameters
Parameters: None
<!--
Not clear what this does
-->
Returns:
smart_wash: 0 is off, 1 is on
wash_interval: The interval in seconds between washes
Example:
```json
{'smart_wash': 0, 'wash_interval': 1200}
```
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### set_smart_wash_params
Description: Sets the smartwash parameters
Parameters:
smart_wash: 0 is off, 1 is on
wash_interval: The interval in seconds between washes
`{'smart_wash': 0, 'wash_interval': 1200}`
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
## Cleaning history
### get_clean_record
Description:
Parameters: To be determined
### get_clean_record_map
Description:
Parameters:
### get_clean_sequence
Description:
Parameters:
### get_clean_summary
Description: Get a summary of cleaning history.
Parameters: None
Returns:
clean_time:
clean_area:
clean_count:
dust_collection_count:
records:
Return example:
```json
{'clean_time': 568146, 'clean_area': 8816865000, 'clean_count': 178, 'dust_collection_count': 172, 'records': [1689740211, 1689555788, 1689259450, 1688999113, 1688852350, 1688693213, 1688692357, 1688614354, 1688613280, 1688606676, 1688325265, 1688174717, 1688149381, 1688092832, 1688001593, 1687921414, 1687890618, 1687743256, 1687655018, 1687631444]}
```
Source: Roborock S7 MaxV Ultra
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### get_mop_template_params_summary
Description:
Parameters:
**Supported devices:**
* Roborock S8 Pro Ultra: ❌
## Child lock
### get_child_lock_status
Description: This gets the child lock status of the device. 0 is off, 1 is on.
Parameters: None
Returns:
lock_status:
Return example:
```json
{'lock_status': 0}
```
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### set_child_lock_status
Description: This sets the child lock status of the device.
Parameters: '{"lock_status" :0}'
Returns: ok
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
## Consumables
### get_consumable
Description: This gets the status of all of the consumables for your device.
Parameters: None
Returns:
main_brush_work_time: This is the amount of time the main brush has been used in seconds since it was last replaced
side_brush_work_time: This is the amount of time the side brush has been used in seconds since it was last replaced
filter_work_time: This is the amount of time the air filter inside the vacuum has been used in seconds since it was last replaced
filter_element_work_time:
sensor_dirty_time: This is the amount of time since you have cleaned the sensors on the bottom of your vacuum.
strainer_work_times:
dust_collection_work_times:
cleaning_brush_work_times:
Return examples:
```json
{'main_brush_work_time': 14151, 'side_brush_work_time': 41638, 'filter_work_time': 14151, 'filter_element_work_time': 0, 'sensor_dirty_time': 41522, 'strainer_work_times': 44, 'dust_collection_work_times': 19, 'cleaning_brush_work_times': 44}
```
### reset_consumable
Description:
Parameters: List of consumables to reset. For example, to reset consumables 'strainer_work_times' and 'sensor_dirty_time' the parameter would be
`['strainer_work_times', 'sensor_dirty_time']`
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
## Custom modes
### get_custom_mode
Description: It returns the current custom mode.
Parameters: None
Returns:
integer value of the current custom mode
Return example:
```
102
```
<!--
Not clear what a custom mode is = will explore
-->
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### set_custom_mode
Description:
Parameters:
### get_customize_clean_mode
Description:
Parameters:
### set_customize_clean_mode
Description:
Parameters:
## Furniture and ground material
### get_identify_furniture_status
Description:
Parameters:
<!--
Does not return anything for S8 Pro Ultra when docked may require vacumm to be cleaning
-->
### set_identify_furniture_status
Description:
Parameters:
<!--
Method not known for S8 Pro Ultra
-->
### get_identify_ground_material_status
Description:
Parameters:
<!--
Does not return anything for S8 Pro Ultra when docked may require vacumm to be cleaning
-->
### set_identify_ground_material_status
Description:
Parameters:
<!--
Method not known for S8 Pro Ultra
-->
## LEDs
### get_flow_led_status
Description:
Parameters:
### set_flow_led_status
Description:
Parameters:
### get_led_status
Description: Returns the LED status. If disabled the indicator light will turn off 1 minute after fully charged
Parameters:
Returns:
led_status: 0 is off, 1 is on
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### set_led_status
Description: Sets the LED status. If disabled the indicator light will turn off 1 minute after fully charged
Parameters: ????
<!--
Need to work out parameter format
-->
## Maps
### get_multi_map
Description:
Parameters:
Comment: Response timed out for S8 Pro Ultra
<!--
times out after 4 secs
-->
### get_multi_maps_list
Description: Returns a list of map information stored on the device.
Parameters: None required
Returns:
max_multi_map:
max_bak_map:
multi_map_count:
map_info:
mapFlag:
add_time:
length:
name:
bak_maps:
mapFlag:
add_time:
Return example:
```json
{'max_multi_map': 4, 'max_bak_map': 1, 'multi_map_count': 2, 'map_info': [{'mapFlag': 0, 'add_time': 1699919699, 'length': 4, 'name': 'Home', 'bak_maps': [{'mapFlag': 4, 'add_time': 1699823921}]}, {'mapFlag': 1, 'add_time': 1699828035, 'length': 13, 'name': 'Boys bathroom', 'bak_maps': [{'mapFlag': 5, 'add_time': 1699828035}]}]}
```
Source: S8 Pro Ultra
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### get_map_v1
Description: Returns the map
Parameters: Unknown
Comment: Returns a map in a format that is not yet understood by me
<!--
Explore what parameters it may take
Extend code to return byte stream ?
-->
### start_edit_map
Description:
Parameters:
### get_room_mapping
Description: Returns a list of rooms, ids as discovered by
Parameters: None
Returns:
room_id
Return example:
```json
[[16, '14731399', 12], [17, '2220009', 2], [18, '2219688', 12], [19, '2219685', 9], [20, '2219691', 12], [21, '2431758', 12], [22, '2219677', 13], [23, '2312548', 12], [24, '2219678', 14], [25, '2219686', 15], [26, '2219772', 12], [27, '14768755', 12]]
```
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### load_multi_map
Description:
Parameters: number (the floor/map index)
<!--
Need to work out parameter format
-->
### save_map
Description:
Parameters:
## Operating modes
### get_mop_mode
Description: Get mop mode.
Parameters: None
Returns: Enumeration for mop mode. 300
Example for S8 Pro Ultra:
standard = 300
deep = 301
deep_plus = 303
fast = 304
custom = 302
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### set_mop_mode
Description: Set mop mode.
Parameters: mop_mode 300
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### set_clean_motor_mode
Description:
Parameters:
### get_dust_collection_mode
Description:
Parameters: None
Returns:
mode:
Return example:
```json
{'mode': 0}
```
Source: Roborock S7 MaxV Ultra
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### set_dust_collection_mode
Description:
Parameters:
### get_wash_towel_mode
Description:
Parameters: None
Returns:
wash_mode:
Return example:
```json
{'wash_mode': 1}
```
Source: Roborock S7 MaxV Ultra
unknown = -9999
light = 0
balanced = 1
deep = 2
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### set_wash_towel_mode
Description: Sets the wash wash_towel_mode
Parameters: {'wash_mode': 2}
Returns: ok or error
Source: S8 Pro Ultra
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### get_collision_avoid_status
Description:
Parameters: None
Returns:
status:
Return example:
```json
{'status': 1}
```
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### set_collision_avoid_status
Description: Update collision avoid status.
Parameters: '{"status" :1}'
Returns:
ok
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### start_wash_then_charge
Description:
Parameters:
<!--
While this returns ok on the S8 Pro Ultra it does not appear to do anything
-->
### switch_water_mark
Description:
Parameters:
**Supported devices:**
* Roborock S8 Pro Ultra: ❌
<!--
Not found for S8 Pro Ultra
-->
## System information
### get_network_info
Description: Get the device's network information.
Parameters: None
Returns:
ssid: SSID of the wirelness network the device is connected to.
ip: IP address of the device.
mac: MAC address of the device.
bssid: BSSID of the device.
rssi: RSSI of the device.
Return example:
```json
{'ssid': 'My WiFi Network', 'ip': '192.168.1.29', 'mac': 'a0:2b:47:3d:24:51', 'bssid': '18:3b:1a:23:41:3c', 'rssi': -32}
```
Source: Roborock S7 MaxV Ultra
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### get_serial_number
Description: Get serial number of the vacuum.
Parameters: None
Returns:
serial_number: Serial number of the vacuum.
Return example:
```json
{'serial_number': 'B16EVD12345678'}
```
Source: Roborock S7 MaxV Ultra
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### get_prop
Description: Generic get property command
Parameters: The property to get
Example:
roborock -d command --device_id aHiddenDeviceId --cmd get_prop --params '["battery"]'
Comment : This example returns the same as get_status. Initial testing has shown that not all get commands are supported by this method
### get_turn_server
Description:
Parameters:
<!--
Not found for S8 Pro Ultra
-->
**Supported devices:**
* Roborock S8 Pro Ultra: ❌
### enable_log_upload
Description:
Parameters:
### find_me
Description: This makes your vacuum speak so you can find it.
Parameters: None
### upd_server_timer
Description:
Parameters:
### get_homesec_connect_status
Description:
Parameters:
**Supported devices:**
* Roborock S8 Pro Ultra: ❌
### set_fds_endpoint
Description:
Parameters:
### send_ice_to_robot
Description:
Parameters:
### send_sdp_to_robot
Description:
Parameters:
### get_device_ice
<!--
This doeas not appear to be supported on S8 Pro Ultra
-->
Description:
Parameters:
**Supported devices:**
* Roborock S8 Pro Ultra: ❌
### get_device_sdp
Description:
Parameters:
**Supported devices:**
* Roborock S8 Pro Ultra: ❌
### retry_request
Description:
Parameters:
## Timers
### del_server_timer
Description:
Parameters:
### dnd_timer
### get_dnd_timer
Description: Gets the do not disturb timer
start_hour: The hour you want dnd to start
start_minute: The minute you want dnd to start
end_hour: The hour you want dnd to be turned off
end_minute: The minute you want dnd to be turned off
enabled: If the switch is currently turned on in the app for DnD
Parameters: None
### set_dnd_timer
Description:
Parameters:
### close_dnd_timer
Description: This disables the dnd timer
Parameters: None
### get_server_timer
Description:
Parameters:
### set_server_timer
Description:
Parameters:
### get_timezone
Description: Get the device's time zone.
Parameters: None
Returns: Time zone by the TZ identifier (e.g., America/Los_Angeles)
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### set_timezone
Description: Sets the device's time zone
Parameters:
## Sound
### get_sound_volume
Description: Returns the volume of the sound played by the vacuum
Parameters: None
Returns:
volume: The volume of the sound played by the vacuum
Example:
72
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### change_sound_volume
Description: Sets the volume of the sound played by the vacuum
Parameters: volume
Returns: ok or error
`roborock -d command --device_id aHiddenDeviceId --cmd change_sound_volume --params 72`
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### test_sound_volume
Description: Plays a sound on the vacumm to identity volume
Parameters: None
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### get_sound_progress
Description:
Parameters:
Returns:
```json
{'sid_in_progress': 0, 'progress': 0, 'state': 0, 'error': 0}
```
<!--
Is this where the vacumm is currently located ?
-->
### get_current_sound
<!--
Is this an app setting ?
-->
Description:
Parameters:
Return example:
```json
{'sid_in_use': 122, 'sid_version': 1, 'sid_in_progress': 0, 'location': 'de', 'bom': 'A.03.0342', 'language': 'en', 'msg_ver': 2}
```
**Supported devices:**
* Roborock S7 MaxV Ultra: ✅
* Roborock S8 Pro Ultra: ✅
### dnld_install_sound
Description:
Parameters:
## Off peak charging
### get_valley_electricity_timer
Description: Get valley electricity timer.
Parameters: None
Returns:
start_hour: The hour you want valley electricity to start
start_minute: The minute you want valley electricity to start
end_hour: The hour you want valley electricity to be turned off
end_minute: The minute you want valley electricity to be turned off
enabled: If the switch is currently turned on in the app for valley electricity
```json
{'start_hour': 0, 'start_minute': 0, 'end_hour': 0, 'end_minute': 0, 'enabled': 0}
```
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### set_valley_electricity_timer
Description: Sets the valley electricity timer
Parameters:
start_hour: The hour you want valley electricity to start
start_minute: The minute you want valley electricity to start
end_hour: The hour you want valley electricity to be turned off
end_minute: The minute you want valley electricity to be turned off
enabled: If the switch is currently turned on in the app for valley electricity
Example:
```json
{'start_hour': 0, 'start_minute': 0, 'end_hour': 0, 'end_minute': 0, 'enabled': 0}
```
<!--
This does not appear to have any effect on the S8 Pro Ultra - Params accepted however no affect ??
-->
**Supported devices:**
* Roborock S8 Pro Ultra: ❓
## Water box mode
### get_water_box_custom_mode
Description: Get water box mode.
Parameters: None
Returns: Enumeration for water box mode. 203
<!--
Not clear what this does - require Enumeration
-->
### get_clean_follow_ground_material_status
Description:
Parameters: None
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
### set_water_box_custom_mode
Description: Set the water box mode.
Parameters: {'water_box_mode': 203}
Returns: ok or error
<!--
Not clear what this does - require Enumeration
-->
**Supported devices:**
* Roborock S8 Pro Ultra: ✅
|