├── .gitattributes ├── .github └── dependabot.yml ├── .gitignore ├── .markdownlint.yaml ├── .pre-commit-config.yaml ├── .readthedocs.yml ├── .yamllint ├── LICENSE ├── README.md ├── docs ├── advanced │ ├── data_types │ │ ├── json │ │ │ ├── commands │ │ │ │ ├── advanced_mode.md │ │ │ │ ├── auto_empty.md │ │ │ │ ├── break_point.md │ │ │ │ ├── carpet_pressure.md │ │ │ │ ├── clean_count.md │ │ │ │ ├── general.md │ │ │ │ ├── index.md │ │ │ │ ├── life_span.md │ │ │ │ ├── map.md │ │ │ │ ├── multimap_state.md │ │ │ │ ├── net_info.md │ │ │ │ ├── ota.md │ │ │ │ ├── play_sound.md │ │ │ │ ├── relocate.md │ │ │ │ ├── sleep_mode.md │ │ │ │ ├── speed.md │ │ │ │ ├── stats.md │ │ │ │ ├── true_detect.md │ │ │ │ ├── volume.md │ │ │ │ └── water.md │ │ │ └── messages │ │ │ │ ├── general.md │ │ │ │ ├── index.md │ │ │ │ ├── map.md │ │ │ │ └── stats.md │ │ └── xml │ │ │ ├── commands │ │ │ ├── GetBatteryState.md │ │ │ ├── GetChargeState.md │ │ │ ├── clean.md │ │ │ ├── cleanSpeed.md │ │ │ ├── general.md │ │ │ ├── index.md │ │ │ ├── life_span.md │ │ │ ├── playSound.md │ │ │ └── waterlevel.md │ │ │ └── messages │ │ │ ├── general.md │ │ │ └── index.md │ └── protocols │ │ ├── mqtt.md │ │ ├── rest.md │ │ └── xmpp.md ├── assets │ └── images │ │ ├── custom_vacuum_card.jpg │ │ ├── deebot950.svg │ │ ├── deebot950_Inkscape.svg │ │ └── ui-advanced.gif ├── home │ ├── faq.md │ ├── models.md │ └── projects.md ├── index.md └── integrations │ └── home-assistant │ ├── entities.md │ ├── events.md │ ├── examples │ ├── commands.md │ └── ui │ │ ├── advanced.md │ │ └── simple.md │ ├── index.md │ ├── issues.md │ ├── migration.md │ ├── misc.md │ ├── services.md │ └── setup.md ├── include ├── advanced │ ├── data_types │ │ ├── commands-template.jinja2 │ │ ├── commands-template.md │ │ ├── json │ │ │ └── message.md │ │ ├── messages-template.jinja2 │ │ └── messages-template.md │ └── protocols │ │ └── data_type.md └── helpers.jinja2 ├── mkdocs.yml ├── plugins └── children_with_subtitle.py ├── requirements-dev.txt └── requirements.txt /.gitattributes: -------------------------------------------------------------------------------- 1 | text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | # Maintain dependencies for GitHub Actions 4 | - package-ecosystem: "github-actions" 5 | directory: "/" 6 | schedule: 7 | interval: "daily" 8 | 9 | # Maintain dependencies for pip 10 | - package-ecosystem: "pip" 11 | directory: "/" 12 | schedule: 13 | interval: "daily" 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | pythonenv* 3 | venv 4 | .venv 5 | .coverage 6 | .idea 7 | .mypy_cache 8 | .pytest_cache 9 | site 10 | -------------------------------------------------------------------------------- /.markdownlint.yaml: -------------------------------------------------------------------------------- 1 | # Default state for all rules 2 | default: true 3 | MD013: false 4 | MD024: false 5 | MD033: false 6 | MD041: false 7 | MD046: false 8 | MD053: false 9 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/pre-commit/mirrors-prettier 3 | rev: v3.0.0-alpha.9-for-vscode 4 | hooks: 5 | - id: prettier 6 | exclude: ".*.jinja2$" 7 | - repo: https://github.com/igorshubovych/markdownlint-cli 8 | rev: v0.34.0 9 | hooks: 10 | - id: markdownlint 11 | args: 12 | - "--fix" 13 | exclude: ".*.jinja2$" 14 | - repo: https://github.com/codespell-project/codespell 15 | rev: v2.2.4 16 | hooks: 17 | - id: codespell 18 | args: 19 | - --ignore-words-list=deebot 20 | - --skip="./.*,*.csv,*.json" 21 | - --quiet-level=2 22 | exclude_types: [csv, json] 23 | - repo: https://github.com/pre-commit/pre-commit-hooks 24 | rev: v4.4.0 25 | hooks: 26 | - id: check-merge-conflict 27 | - id: detect-private-key 28 | - id: no-commit-to-branch 29 | - id: requirements-txt-fixer 30 | - repo: https://github.com/adrienverge/yamllint.git 31 | rev: v1.31.0 32 | hooks: 33 | - id: yamllint 34 | -------------------------------------------------------------------------------- /.readthedocs.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | 3 | build: 4 | os: ubuntu-20.04 5 | tools: 6 | python: "3.9" 7 | 8 | mkdocs: 9 | configuration: mkdocs.yml 10 | fail_on_warning: true 11 | 12 | python: 13 | install: 14 | - requirements: requirements.txt 15 | -------------------------------------------------------------------------------- /.yamllint: -------------------------------------------------------------------------------- 1 | rules: 2 | braces: 3 | level: error 4 | min-spaces-inside: 0 5 | max-spaces-inside: 1 6 | min-spaces-inside-empty: -1 7 | max-spaces-inside-empty: -1 8 | brackets: 9 | level: error 10 | min-spaces-inside: 0 11 | max-spaces-inside: 0 12 | min-spaces-inside-empty: -1 13 | max-spaces-inside-empty: -1 14 | colons: 15 | level: error 16 | max-spaces-before: 0 17 | max-spaces-after: 1 18 | commas: 19 | level: error 20 | max-spaces-before: 0 21 | min-spaces-after: 1 22 | max-spaces-after: 1 23 | comments: 24 | level: error 25 | require-starting-space: true 26 | min-spaces-from-content: 2 27 | comments-indentation: 28 | level: error 29 | document-end: 30 | level: error 31 | present: false 32 | document-start: 33 | level: error 34 | present: false 35 | empty-lines: 36 | level: error 37 | max: 1 38 | max-start: 0 39 | max-end: 1 40 | hyphens: 41 | level: error 42 | max-spaces-after: 1 43 | indentation: 44 | level: error 45 | spaces: 2 46 | indent-sequences: true 47 | check-multi-line-strings: false 48 | key-duplicates: 49 | level: error 50 | line-length: disable 51 | new-line-at-end-of-file: 52 | level: error 53 | new-lines: 54 | level: error 55 | type: unix 56 | trailing-spaces: 57 | level: error 58 | truthy: 59 | disable 60 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Documentation 2 | 3 | This repo is the source for the unofficial [Deebot documentation](https://deebot.readthedocs.io/). 4 | 5 | This documentation is unofficial, and is not sponsored, owned or endorsed by Ecovacs (Robotics). 6 | 7 | ## How to contribute 8 | 9 | To add a new link on the navigation panel you need to edit the `mkdocs.yml` file in the root of the repo. There is a guide for building the navbar [on the mkdocs wiki](https://www.mkdocs.org/user-guide/configuration/#nav) 10 | 11 | To add a new document: 12 | 13 | - Navigate to the directory where it will be hosted. 14 | - Create the file using a URL friendly filename. 15 | - Edit your document using Markdown, there are loads of resources available for the correct syntax. 16 | 17 | ## Testing your changes 18 | 19 | When working on this repo, it is advised that you review your changes locally before committing them. The `mkdocs serve` command can be used to live preview your changes (as you type) on your local machine. 20 | 21 | Please make sure you fork the repo and change the clone URL in the example below for your fork: 22 | 23 | - Linux Mint / Ubuntu 18.04 LTS / 19.10 / 20.04 LTS: 24 | 25 | - Preparations (only required once): 26 | 27 | ```bash 28 | git clone https://github.com/YOUR-USERNAME/docs 29 | cd docs 30 | sudo apt install python3-pip 31 | sudo pip3 install -r requirements.txt 32 | ``` 33 | 34 | - Running the docs server: 35 | 36 | ```bash 37 | mkdocs serve --dev-addr 0.0.0.0:8000 38 | ``` 39 | 40 | - Fedora Linux instructions (tested on Fedora Linux 28): 41 | 42 | - Preparations (only required once): 43 | 44 | ```bash 45 | git clone https://github.com/YOUR-USERNAME/docs 46 | cd docs 47 | pip install --user -r requirements.txt 48 | ``` 49 | 50 | - Running the docs server: 51 | 52 | ```bash 53 | mkdocs serve --dev-addr 0.0.0.0:8000 54 | ``` 55 | 56 | - Docker instructions: 57 | 58 | - One-shot run: 59 | 60 | ```bash 61 | docker run -v `pwd`:/opt/app/ -w /opt/app/ -p 8000:8000 -it nikolaik/python-nodejs:python3.7-nodejs12 \ 62 | sh -c "pip install --user -r requirements.txt && \ 63 | /root/.local/bin/mkdocs build && \ 64 | npm ci && \ 65 | npm test && \ 66 | /root/.local/bin/mkdocs serve --dev-addr 0.0.0.0:8000" 67 | ``` 68 | 69 | After these commands, the current branch is accessible through your favorite browser at 70 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/advanced_mode.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getAdvancedMode 5 | description: Check if the advanced mode is activated. 6 | response: 7 | arguments: 8 | enable: "`1` if enabled otherwise `0`" 9 | <<: &example 10 | example: >- 11 | { 12 | "enable": 1 13 | } 14 | - name: setAdvancedMode 15 | description: Command to enable/disable the advanced mode. 16 | request: 17 | arguments: 18 | enable: "`1` to enable; `0` to disable" 19 | <<: *example 20 | --- 21 | 22 | {% include 'advanced/data_types/commands-template.jinja2' %} 23 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/auto_empty.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getAutoEmpty 5 | description: Check if the auto empty mode for the Auto Empty Station is activated. 6 | response: 7 | arguments: 8 | enable: "`1` if enabled otherwise `0`" 9 | <<: &example 10 | example: >- 11 | { 12 | "enable": 1 13 | } 14 | - name: setAutoEmpty 15 | description: Command to set the auto empty mode (permanently stored) or to manually empty dust bin. 16 | request: 17 | arguments: 18 | enable: "`1` to enable; `0` to disable emptying dustbin after a cleaning job" 19 | act: "`start` for manual emptying the dust bin" 20 | example: >- 21 | { 22 | "act": "start" 23 | } 24 | additional: >- 25 | !!! warning 26 | 27 | **The arguments are exclusive, meaning you can only specify one at the time!** Either `enable` or `act` 28 | --- 29 | 30 | {% include 'advanced/data_types/commands-template.jinja2' %} 31 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/break_point.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getBreakPoint 5 | description: Check if continuous cleaning is activated. 6 | response: 7 | arguments: 8 | enable: "`1` if enabled otherwise `0`" 9 | <<: &example 10 | example: >- 11 | { 12 | "enable": 1 13 | } 14 | - name: setBreakPoint 15 | description: Command to enable/disabled continuous cleaning. 16 | request: 17 | arguments: 18 | enable: "`1` to enable; `0` to disable" 19 | <<: *example 20 | --- 21 | 22 | {% include 'advanced/data_types/commands-template.jinja2' %} 23 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/carpet_pressure.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getCarpertPressure 5 | description: Check if automatically increase fan speed to maximum if carpet is detected, is activated. 6 | request: 7 | <<: &typo 8 | additional: >- 9 | !!! warning 10 | 11 | The typo in the command is intended as ecovacs as done it, when specifying this command. 12 | response: 13 | arguments: 14 | enable: "`1` if enabled otherwise `0`" 15 | <<: &example 16 | example: >- 17 | { 18 | "enable": 1 19 | } 20 | - name: setCarpertPressure 21 | description: Command to enable/disabled to automatically increase fan speed to maximum if carpet is detected. 22 | request: 23 | arguments: 24 | enable: "`1` to enable; `0` to disable" 25 | <<: *example 26 | <<: *typo 27 | --- 28 | 29 | {% include 'advanced/data_types/commands-template.jinja2' %} 30 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/clean_count.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getCleanCount 5 | description: Get the permanently stored setting for number of cleaning cycles for auto clean. 6 | response: 7 | arguments: 8 | count: the number of cleanings 9 | <<: &example 10 | example: >- 11 | { 12 | "count": 2 13 | } 14 | - name: setCleanCount 15 | description: Command to set the number of cleaning cycles for auto clean (permanently stored). 16 | request: 17 | arguments: 18 | count: the number of cleanings 19 | <<: *example 20 | --- 21 | 22 | {% include 'advanced/data_types/commands-template.jinja2' %} 23 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/general.md: -------------------------------------------------------------------------------- 1 | # Commands 2 | 3 | ## Request 4 | 5 | Here only the command request object will be described. 6 | More information about sending commands can be found under [api](../../../protocols/rest.md#request). 7 | 8 | ```json 9 | { 10 | "header": { 11 | "pri": "1", 12 | "ts": 1635497684, 13 | "tzm": 480, 14 | "ver": "0.0.50" 15 | }, 16 | "body": { 17 | "data": "[args]" 18 | } 19 | } 20 | ``` 21 | 22 | ### Description 23 | 24 | - `header`: header object, values are constant except `ts` 25 | - `ts`: current timestamp 26 | - `tz`: time zone 27 | - `ver`: version 28 | - `body`: Missing, when command has no args 29 | - `data`: object with the command arguments. 30 | 31 | ## Response 32 | 33 | Here only the command response object will be described. 34 | More information about sending commands can be found under [api](../../../protocols/rest.md#response). 35 | 36 | {% set description_header = "###" %} 37 | {% include 'advanced/data_types/json/message.md' %} 38 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/index.md: -------------------------------------------------------------------------------- 1 | # Commands 2 | 3 | A command can be send via [rest](../../../protocols/rest.md). 4 | General information about commands can be found [here](general.md). 5 | 6 | The currently documented commands are: 7 | 8 | {childrenWithSubtitle} 9 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/life_span.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getLifeSpan 5 | description: Command to get information about accessories components. 6 | request: 7 | arguments: 8 | "[component]": 9 | description: A list with corresponding value for the components. Multiple values possible 10 | <<: &component_values 11 | data_values: 12 | brush: main brush 13 | sideBrush: side brush 14 | heap: filter 15 | unitCare: other components [^1] 16 | dModule: unknown [^1] 17 | example: >- 18 | [ 19 | "sideBrush", 20 | "brush", 21 | "heap" 22 | ] 23 | response: 24 | arguments: 25 | "[result]": 26 | description: A list with a result object for each requested component. 27 | arguments: 28 | <<: &component_type 29 | type: 30 | description: The corresponding value for the component. 31 | <<: *component_values 32 | left: Remaining lifetime in minutes 33 | total: Total lifetime in minutes 34 | example: >- 35 | [ 36 | { "type": "sideBrush", "left": 0, "total": 9000 }, 37 | { "type": "brush", "left": 10873, "total": 18000 }, 38 | { "type": "heap", "left": 73, "total": 7200 } 39 | ] 40 | additional: >- 41 | !!! hint 42 | 43 | To calculate the percentage use `left/total`. 44 | 45 | - name: resetLifeSpan 46 | description: Command to reset an accessories component. 47 | request: 48 | arguments: 49 | <<: *component_type 50 | example: >- 51 | { 52 | "type": "sideBrush" 53 | } 54 | --- 55 | 56 | {% include 'advanced/data_types/commands-template.jinja2' %} 57 | 58 | [^1]: Only available for some newer models (e.g. T8/T9 series) 59 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/map.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getCachedMapInfo 5 | description: Command to get information about all maps. 6 | response: 7 | arguments: 8 | info: 9 | description: A list of map objects 10 | arguments: 11 | mid: Map id 12 | index: internal index 13 | using: "`1` means currently used map. Otherwise `0`" 14 | built: "`1` means map is built; Complete clean was done and bot returned successfully to charging station" 15 | name: Name of map set by the user 16 | example: >- 17 | { 18 | "enable": 1, 19 | "info": [ 20 | { 21 | "mid": "199390082", 22 | "index": 0, 23 | "status": 1, 24 | "using": 1, 25 | "built": 1, 26 | "name": "Erdgeschoss" 27 | }, 28 | { 29 | "mid": "722607162", 30 | "index": 3, 31 | "status": 0, 32 | "using": 0, 33 | "built": 0, 34 | "name": "" 35 | } 36 | ] 37 | } 38 | - name: getMapSubSet 39 | description: Command to get map subset information. 40 | request: 41 | arguments: 42 | msid: Map set id 43 | <<: &arguments 44 | mid: Map id 45 | type: 46 | description: The type of map set 47 | data_values: 48 | ar: Rooms 49 | vw: Virtual walls 50 | mw: No mopping zones 51 | mssid: Map subset id [^1] 52 | example: >- 53 | { 54 | "mid": "199390082", 55 | "msid": "8", 56 | "type": "ar", 57 | "mssid": "17" 58 | } 59 | response: 60 | arguments: 61 | <<: *arguments 62 | value: List of coordinates 63 | subtype: Room type [^1] 64 | connections: Connections to other rooms [^1] 65 | example: >- 66 | { 67 | "type": "ar", 68 | "mssid": "12", 69 | "value": "-2700,-7450;-2700,-6750;-2550,-6650;...", 70 | "subtype": "12", 71 | "connections": "17,14,10,11,13,7", 72 | "mid": "199390082" 73 | } 74 | - name: clearMap 75 | description: Clear/reset the map 76 | request: 77 | arguments: 78 | mid: Map id 79 | type: 80 | description: Which type should be cleared 81 | data_values: 82 | all: All types will be cleared. In other words the complete map is cleared. 83 | example: >- 84 | { 85 | "mid": "353140366", 86 | "type": "all" 87 | } 88 | --- 89 | 90 | {% include 'advanced/data_types/commands-template.jinja2' %} 91 | 92 | [^1]: Only present when `type` = `ar` 93 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/multimap_state.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getMultiMapState 5 | description: Check if multiple maps are activated 6 | response: 7 | arguments: 8 | enable: "`1` if enabled otherwise `0`" 9 | <<: &example 10 | example: >- 11 | { 12 | "enable": 1 13 | } 14 | - name: setMultiMapState 15 | description: Command to enable/disabled multiple maps. 16 | request: 17 | arguments: 18 | enable: "`1` to enable; `0` to disable" 19 | <<: *example 20 | --- 21 | 22 | {% include 'advanced/data_types/commands-template.jinja2' %} 23 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/net_info.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getNetInfo 5 | description: Command to get some network related information. 6 | response: 7 | arguments: 8 | ip: The ip address of the robot 9 | mac: The mac address of the robot 10 | ssid: the service set identifier (network name) of the Wi-Fi 11 | rssi: the received signal strength indication (signal strength) 12 | example: >- 13 | { 14 | "ip": "192.168.0.88", 15 | "mac": "00:80:41:AE:FD:7E", 16 | "ssid": "someRandomNetworkName", 17 | "rssi": "-62" 18 | } 19 | --- 20 | 21 | {% include 'advanced/data_types/commands-template.jinja2' %} 22 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/ota.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getOta 5 | description: Command to get information about the over the air update. 6 | response: 7 | arguments: 8 | status: 9 | description: The status 10 | data_values: 11 | idle: Idle 12 | ver: Firmware version 13 | example: >- 14 | { 15 | "isForce": 0, 16 | "progress": 0, 17 | "result": 0, 18 | "status": "idle", 19 | "ver": "1.8.2" 20 | } 21 | --- 22 | 23 | {% include 'advanced/data_types/commands-template.jinja2' %} 24 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/play_sound.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: playSound 5 | description: Command to play a sound or voice report. 6 | request: 7 | arguments: 8 | sid: The ID of the sound 9 | example: >- 10 | { 11 | "sid": 30 12 | } 13 | additional: >- 14 | !!! info "Available sound IDs" 15 | 16 | For a list of available sound IDs see 17 | [here](https://github.com/mrbungle64/ecovacs-deebot.js/wiki/playSound#available-sound-ids) 18 | --- 19 | 20 | {% include 'advanced/data_types/commands-template.jinja2' %} 21 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/relocate.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: setRelocationState 5 | description: Locating the position of the bot. 6 | request: 7 | arguments: 8 | mode: "manu" 9 | example: >- 10 | { 11 | "mode": "manu" 12 | } 13 | --- 14 | 15 | {% include 'advanced/data_types/commands-template.jinja2' %} 16 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/sleep_mode.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getSleep 5 | description: Check if the sleep mode is activated. 6 | response: 7 | arguments: 8 | enable: "`1` if enabled otherwise `0`" 9 | <<: &example 10 | example: >- 11 | { 12 | "enable": 1 13 | } 14 | --- 15 | 16 | {% include 'advanced/data_types/commands-template.jinja2' %} 17 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/speed.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getSpeed 5 | description: Command to get vacuum power level. 6 | response: 7 | arguments: 8 | speed: 9 | description: The current vacuum power level. 10 | <<: &amount_values 11 | data_values: 12 | 1000: quiet 13 | 0: standard 14 | 1: max 15 | 2: max+ 16 | example: >- 17 | { 18 | "speed": 1 19 | } 20 | - name: setSpeed 21 | description: Command to set the vacuum power level. 22 | request: 23 | arguments: 24 | speed: 25 | description: The vacuum power level 26 | <<: *amount_values 27 | example: >- 28 | { 29 | "speed": 1 30 | } 31 | --- 32 | 33 | {% include 'advanced/data_types/commands-template.jinja2' %} 34 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/stats.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getStats 5 | description: Command to get information about the last or ongoing cleaning job. 6 | response: 7 | arguments: 8 | area: The cleaned area in m² 9 | time: The elapsed time since starting this job in seconds 10 | cid: Cleaning id 11 | start: Datetime, when clean job was started 12 | type: The cleaning type 13 | example: >- 14 | { 15 | "area": 36, 16 | "time": 2063, 17 | "cid": "111", 18 | "start": "1297462509", 19 | "type": "spotArea" 20 | } 21 | --- 22 | 23 | {% include 'advanced/data_types/commands-template.jinja2' %} 24 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/true_detect.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getTrueDetect 5 | description: Check if "TrueDetect 3D" is activated. 6 | response: 7 | arguments: 8 | enable: "`1` if enabled otherwise `0`" 9 | <<: &example 10 | example: >- 11 | { 12 | "enable": 1 13 | } 14 | - name: setTrueDetect 15 | description: Command to enable/disable the "TrueDetect 3D" mode. 16 | request: 17 | arguments: 18 | enable: "`1` to enable; `0` to disable" 19 | <<: *example 20 | --- 21 | 22 | {% include 'advanced/data_types/commands-template.jinja2' %} 23 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/volume.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getVolume 5 | description: Command to get information about the volume. 6 | response: 7 | arguments: 8 | total: The maximum supported level 9 | volume: The current set level 10 | example: >- 11 | { 12 | "total": 10, 13 | "volume": 10 14 | } 15 | - name: setVolume 16 | description: Command to set the volume. 17 | request: 18 | arguments: 19 | volume: The level to set the volume to it 20 | example: >- 21 | { 22 | "volume": 10 23 | } 24 | --- 25 | 26 | {% include 'advanced/data_types/commands-template.jinja2' %} 27 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/commands/water.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | commands: 4 | - name: getWaterInfo 5 | description: Command to get water information. 6 | response: 7 | arguments: 8 | enable: Indicates if mop is attached. Should be interpreted as boolean. 9 | amount: 10 | description: The amount, which is currently set. 11 | <<: &amount_values 12 | data_values: 13 | 1: low 14 | 2: medium 15 | 3: high 16 | 4: ultra high 17 | example: >- 18 | { 19 | "enable": 0, 20 | "amount": 4 21 | } 22 | - name: setWaterInfo 23 | description: Command to set the water amount. 24 | request: 25 | arguments: 26 | amount: 27 | description: The water amount 28 | <<: *amount_values 29 | example: >- 30 | { 31 | "amount": 4 32 | } 33 | --- 34 | 35 | {% include 'advanced/data_types/commands-template.jinja2' %} 36 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/messages/general.md: -------------------------------------------------------------------------------- 1 | # Messages 2 | 3 | A message looks like: 4 | 5 | {% set description_header = "##" %} 6 | {% include 'advanced/data_types/json/message.md' %} 7 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/messages/index.md: -------------------------------------------------------------------------------- 1 | # Messages 2 | 3 | A message can be received via [mqtt](../../../protocols/mqtt.md). 4 | General information about messages can be found [here](general.md). 5 | 6 | The currently documented messages are: 7 | 8 | {childrenWithSubtitle} 9 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/messages/map.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | messages: 4 | - name: onMapSet 5 | receive: 6 | - on the start of a cleaning job, if there are map set changes 7 | arguments: 8 | mid: Map id 9 | type: 10 | description: The type of map set 11 | data_values: 12 | ar: Rooms 13 | vw: Virtual walls 14 | mw: No mopping zones 15 | msid: Map set id. Only present when `type` = `ar` 16 | subsets: 17 | arguments: 18 | "[subset]": 19 | description: List of subset 20 | arguments: 21 | mssid: Map subset id 22 | example: >- 23 | { 24 | "type": "ar", 25 | "mid": "199390082", 26 | "msid": "8", 27 | "subsets": [ 28 | { "mssid": "7" }, 29 | { "mssid": "12" }, 30 | { "mssid": "17" }, 31 | { "mssid": "14" }, 32 | { "mssid": "10" }, 33 | { "mssid": "11" }, 34 | { "mssid": "13" } 35 | ] 36 | } 37 | --- 38 | 39 | {% include 'advanced/data_types/messages-template.jinja2' %} 40 | -------------------------------------------------------------------------------- /docs/advanced/data_types/json/messages/stats.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: json 3 | messages: 4 | - name: onStats 5 | receive: 6 | - during a cleaning job on each cleaned m² 7 | arguments: 8 | area: The cleaned area in m² 9 | time: The elapsed time since starting this job in seconds 10 | cid: Cleaning id 11 | start: Datetime, when clean job was started 12 | type: The cleaning type 13 | example: >- 14 | { 15 | "area": 36, 16 | "time": 2063, 17 | "cid": "111", 18 | "start": "1297462509", 19 | "type": "spotArea" 20 | } 21 | - name: reportStats 22 | receive: 23 | - on the start of a cleaning job 24 | - on the end (stop) of a cleaning job 25 | arguments: 26 | cid: Cleaning job id 27 | type: Cleaning type 28 | stop: 29 | data_values: 30 | 0: Job started 31 | 1: Job finished 32 | area: The cleaned area in m² [^1] 33 | time: The cleaning time in seconds [^1] 34 | start: datetime, when clean job was started [^1] 35 | content: The map-sub-set (room) ids, which should be cleaned by this job [^1] 36 | stopReason: 37 | description: The stop reason [^1] 38 | data_values: 39 | 1: finished normally 40 | 2: stopped manually 41 | 3: finished with warnings (e.g. one room not cleaned as it was blocked) 42 | example: >- 43 | { 44 | "cid": "1319392469", 45 | "type": "spotArea", 46 | "stop": 1, 47 | "mapCount": 15, 48 | "area": 0, 49 | "time": 7, 50 | "start": "1297811709", 51 | "content": "7,12,11,14", 52 | "stopReason": 2 53 | } 54 | --- 55 | 56 | {% include 'advanced/data_types/messages-template.jinja2' %} 57 | 58 | [^1]: Only present at the end of the cleaning job. 59 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/commands/GetBatteryState.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: xml 3 | commands: 4 | - name: GetBatteryInfo 5 | description: Command to obtain battery state. 6 | response: 7 | arguments: 8 | "[battery]": 9 | arguments: 10 | "[power]": 11 | description: battery level 12 | <<: &component_values 13 | data_values: 14 | 000-100: percentage of battery remaining 15 | example: 16 | --- 17 | 18 | {% include 'advanced/data_types/commands-template.jinja2' %} 19 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/commands/GetChargeState.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: xml 3 | commands: 4 | - name: GetChargeState 5 | description: Command to obtain charge state. 6 | response: 7 | arguments: 8 | "[type]": 9 | description: charging mode 10 | <<: &component_values 11 | data_values: 12 | SlotCharging: charging 13 | Going: returning 14 | Idle: cleaning 15 | example: 16 | --- 17 | 18 | {% include 'advanced/data_types/commands-template.jinja2' %} 19 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/commands/clean.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: xml 3 | commands: 4 | - name: Clean 5 | description: Command to start a cleaning. 6 | request: 7 | arguments: 8 | clean: 9 | arguments: 10 | type: 11 | description: clean mode 12 | data_values: 13 | auto: auto clean 14 | border: border clean [^1] 15 | spot: spot clean [^1] 16 | SpotArea: spot area and custom area clean [^2] 17 | singleroom: single room clean [^3] 18 | stop: stop 19 | act: 20 | description: clean action 21 | data_values: 22 | s: start 23 | p: pause 24 | r: resume 25 | h: stop 26 | speed: 27 | description: vacuum power 28 | data_values: 29 | standard: standard 30 | strong: max 31 | additional: >- 32 | !!! info 33 | 34 | `speed` is only necessary for a few models (e.g. Deebot 710 series) 35 | --- 36 | 37 | {% include 'advanced/data_types/commands-template.jinja2' %} 38 | 39 | [^1]: Models without mapping functionality only 40 | [^2]: Models with mapping functionality only 41 | [^3]: Models with single room cleaning mode only 42 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/commands/cleanSpeed.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: xml 3 | commands: 4 | - name: GetCleanSpeed 5 | description: Command to get vacuum power. 6 | response: 7 | arguments: 8 | speed: 9 | description: The vacuum power, which is currently set. 10 | <<: &amount_values 11 | data_values: 12 | standard: standard 13 | strong: max 14 | - name: SetCleanSpeed 15 | description: Command to set the vacuum power. 16 | request: 17 | arguments: 18 | speed: 19 | description: The vacuum power 20 | <<: *amount_values 21 | --- 22 | 23 | {% include 'advanced/data_types/commands-template.jinja2' %} 24 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/commands/general.md: -------------------------------------------------------------------------------- 1 | # Commands 2 | 3 | Here only the payload will be described. 4 | More information about sending commands can be found under the respective protocol: 5 | 6 | - commands: 7 | - [REST](../../../protocols/rest.md#request) 8 | - [XMPP](../../../protocols/xmpp.md#request) 9 | - "broadcast" messages (response only): 10 | - [MQTT](../../../protocols/mqtt.md#request) 11 | 12 | ## Request 13 | 14 | ```xml 15 | 16 | ``` 17 | 18 | ## Response 19 | 20 | ```xml 21 | 22 | ``` 23 | 24 | ### Request and response description 25 | 26 | - `cmdName`: command name 27 | - `sampleAttribute`: a sample attribute (e.g. `act`) 28 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/commands/index.md: -------------------------------------------------------------------------------- 1 | # Commands 2 | 3 | All commands described further are listed below. 4 | 5 | {childrenWithSubtitle} 6 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/commands/life_span.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: XML 3 | commands: 4 | - name: GetLifeSpan 5 | description: Command to get information about accessories components. 6 | request: 7 | arguments: 8 | "[type]": 9 | description: A list with corresponding value for the components. 10 | <<: &component_values 11 | data_values: 12 | Brush: main brush 13 | SideBrush: side brush 14 | DustCaseHeap: filter 15 | 16 | example: >- 17 | 18 | response: 19 | arguments: 20 | "[result]": 21 | description: A list with a result object for each requested component. 22 | arguments: 23 | <<: &component_type 24 | type: 25 | description: The corresponding value for the component. 26 | <<: *component_values 27 | left: Remaining lifetime in minutes 28 | total: Total lifetime in minutes 29 | example: >- 30 | 31 | 32 | 33 | additional: >- 34 | !!! hint 35 | 36 | To calculate the percentage use `left/total`. 37 | --- 38 | 39 | {% include 'advanced/data_types/commands-template.jinja2' %} 40 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/commands/playSound.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: xml 3 | commands: 4 | - name: playSound 5 | description: Command to play a sound or voice report. 6 | request: 7 | arguments: 8 | sid: The ID of the sound 9 | additional: >- 10 | !!! info "Available sound IDs" 11 | 12 | For a list of available sound IDs see 13 | [here](https://github.com/mrbungle64/ecovacs-deebot.js/wiki/playSound#available-sound-ids) 14 | --- 15 | 16 | {% include 'advanced/data_types/commands-template.jinja2' %} 17 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/commands/waterlevel.md: -------------------------------------------------------------------------------- 1 | --- 2 | data_type: xml 3 | commands: 4 | - name: GetWaterPermeability 5 | description: Command to get water level. 6 | response: 7 | arguments: 8 | v: 9 | description: The amount, which is currently set. 10 | <<: &amount_values 11 | data_values: 12 | 1: low 13 | 2: medium 14 | 3: high 15 | 4: ultra high 16 | - name: SetWaterPermeability 17 | description: Command to set the water level. 18 | request: 19 | arguments: 20 | v: 21 | description: The water amount 22 | <<: *amount_values 23 | --- 24 | 25 | {% include 'advanced/data_types/commands-template.jinja2' %} 26 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/messages/general.md: -------------------------------------------------------------------------------- 1 | # Messages 2 | 3 | A message looks like: 4 | 5 | ```xml 6 | 7 | 8 | 9 | ``` 10 | 11 | ??? example "XML example with `CleanReport` message" 12 | 13 | This example message was published on `iot/atr/CleanReport/[did]/[class]/[resource]/x` for a Deebot 901 device. 14 | 15 | ```xml 16 | 17 | 18 | 19 | ``` 20 | -------------------------------------------------------------------------------- /docs/advanced/data_types/xml/messages/index.md: -------------------------------------------------------------------------------- 1 | # Messages 2 | 3 | A message can be received via [mqtt](../../../protocols/mqtt.md). 4 | 5 | The currently documented messages are: 6 | 7 | {childrenWithSubtitle} 8 | -------------------------------------------------------------------------------- /docs/advanced/protocols/mqtt.md: -------------------------------------------------------------------------------- 1 | # MQTT 2 | 3 | It is possible to subscribe for "broadcast" messages sent out asynchronous from the bot 4 | on the channel `iot/atr`. 5 | The advantage for these messages is, that the robot is informing us, when some data 6 | changed, instead that we need to poll the data continuously. 7 | 8 | The schema is the following: 9 | 10 | `iot/atr/[command name]/[did]/[class]/[resource]/[data type]` 11 | 12 | - `command name`: the command name 13 | - `did`: the id of the vacuum 14 | - `class`: the class (model) of the vacuum 15 | - `resource`: the resource of the vacuum 16 | - `data type`: data type 17 | 18 | {% include 'advanced/protocols/data_type.md' %} 19 | 20 | More information can be found under the respective data type: 21 | 22 | - [json](../data_types/json/messages/index.md) 23 | - [xml](../data_types/xml/messages/index.md) 24 | 25 | ??? example "Json-example with `reportStats` message" 26 | 27 | The following message was published on `iot/atr/reportStats/[did]/[class]/[resource]/j`: 28 | 29 | ```json 30 | { 31 | "header": { 32 | "pri": 1, 33 | "tzm": 480, 34 | "ts": "1297811721698", 35 | "ver": "0.0.1", 36 | "fwVer": "1.8.2", 37 | "hwVer": "0.1.1" 38 | }, 39 | "body": { 40 | "data": { 41 | "cid": "1319392469", 42 | "type": "spotArea", 43 | "stop": 1, 44 | "mapCount": 15, 45 | "area": 0, 46 | "time": 7, 47 | "start": "1297811709", 48 | "content": "7,12,11,14", 49 | "stopReason": 2 50 | } 51 | } 52 | } 53 | ``` 54 | -------------------------------------------------------------------------------- /docs/advanced/protocols/rest.md: -------------------------------------------------------------------------------- 1 | # REST 2 | 3 | This pages describes the general part of the used rest api. 4 | 5 | ## Request 6 | 7 | A command request look in general like: 8 | 9 | ```json 10 | { 11 | "cmdName": "[commandName]", 12 | "payload": "[payload]", 13 | "payloadType": "[payloadType]", 14 | "auth": { 15 | "realm": "ecouser.net", 16 | "resource": "[resource]", 17 | "token": "[token]", 18 | "userid": "[userid]", 19 | "with": "users" 20 | }, 21 | "td": "q", 22 | "toId": "[toId]", 23 | "toRes": "[toRes]", 24 | "toType": "[toType]" 25 | } 26 | ``` 27 | 28 | ### Description 29 | 30 | - `cmdName`: command name 31 | - `payload`: command request object. Will be described in the respective payload type 32 | - [json commands](../data_types/json/commands/index.md) 33 | - [xml commands](../data_types/xml/commands/index.md) 34 | - `payloadType`: 35 | 36 | {% include 'advanced/protocols/data_type.md' %} 37 | 38 | - `auth`: the authentication object 39 | - `td`: Specifier if request or response 40 | 41 | | Value | Description | 42 | | ----- | ----------- | 43 | | q | request | 44 | 45 | - `toId`: Did of vacuum 46 | - `toRes`: Resource of vacuum 47 | - `toType`: class (model) of vacuum (e.g. `ls1ok3`) 48 | 49 | ## Response 50 | 51 | In general a response looks like: 52 | 53 | ```json 54 | { 55 | "id": "[id]", 56 | "ret": "ok", 57 | "resp": "[Command response]" 58 | } 59 | ``` 60 | 61 | ### Description 62 | 63 | - `id`: Request id 64 | - `ret`: status 65 | 66 | | Value | Description | 67 | | ----- | ------------------------------------------------------- | 68 | | ok | command response was retrieved successfully from vacuum | 69 | | fail | some error happen. e.g. vacuum did not respond | 70 | 71 | - `resp`: command response. Can be missing if the command is only executing something. 72 | Will be described in the respective payload type 73 | -------------------------------------------------------------------------------- /docs/advanced/protocols/xmpp.md: -------------------------------------------------------------------------------- 1 | # XMPP 2 | 3 | ## Request 4 | 5 | A command request look in general like: 6 | 7 | ```xml 8 | 9 | 10 | 11 | 12 | 13 | ``` 14 | 15 | ### Request description 16 | 17 | - `id`: id 18 | - `toId`: did of the vacuum 19 | - `toType`: class (model) of vacuum (e.g. `115`) 20 | - `user`: user id given by Ecovacs API 21 | - `toRes`: resource of the vacuum 22 | - `type`: always `set` 23 | - payload (see also data type [XML](../data_types/xml/commands/general.md#request-and-response-description)): 24 | - `cmdName`: command name 25 | - `randomid`: somewhat random string with 8 chars 26 | 27 | ## Response 28 | 29 | In general a response looks like: 30 | 31 | ```xml 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | ``` 40 | 41 | ### Response description 42 | 43 | - `toId`: did of the vacuum 44 | - `toType`: class (model) of vacuum (e.g. `115`) 45 | - `user`: user id given by Ecovacs API 46 | - `toRes`: resource of the vacuum 47 | - `type`: always `set` 48 | - `id`: id 49 | - `ret`: status 50 | - `randomid`: random id that was sent (see [Request description](#request-description)) 51 | - payload (see also data type [XML](../data_types/xml/commands/general.md#request-and-response-description)): 52 | - `cmdName`: command that was sent 53 | - `sampleAttribute`: a sample attribute (e.g. `act`) 54 | -------------------------------------------------------------------------------- /docs/assets/images/custom_vacuum_card.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DeebotUniverse/docs/d9a6be59f178e767f89148828534fe2259c4d2da/docs/assets/images/custom_vacuum_card.jpg -------------------------------------------------------------------------------- /docs/assets/images/deebot950.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | DEEBOT 16 | 17 | 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/assets/images/deebot950_Inkscape.svg: -------------------------------------------------------------------------------- 1 | 2 | 17 | 19 | 20 | 22 | image/svg+xml 23 | 25 | 26 | 27 | 28 | 29 | 31 | 38 | 39 | 60 | 65 | 74 | 78 | 87 | 95 | 100 | 105 | 114 | DEEBOT 126 | 131 | 136 | 137 | 138 | 139 | -------------------------------------------------------------------------------- /docs/assets/images/ui-advanced.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DeebotUniverse/docs/d9a6be59f178e767f89148828534fe2259c4d2da/docs/assets/images/ui-advanced.gif -------------------------------------------------------------------------------- /docs/home/faq.md: -------------------------------------------------------------------------------- 1 | # Frequently asked questions 2 | 3 | ## Model support 4 | 5 | ### Is my device supported? 6 | 7 | Please check [this list](models.md) of models to see if your device is supported. 8 | -------------------------------------------------------------------------------- /docs/home/models.md: -------------------------------------------------------------------------------- 1 | # Model support 2 | 3 | !!! attention "Important notice" 4 | 5 | We do not provide support that is the same, equal, or similar to manufacturer support 6 | because we are in no way affiliated with ECOVACS nor is it sponsored or endorsed by ECOVACS 7 | 8 | ## :material-language-python: deebot-client 9 | 10 | Used by [Deebot for Home Assistant](https://github.com/DeebotUniverse/Deebot-4-Home-Assistant) 11 | 12 | | Model | status | Protocol | Data type | 13 | | ----------------------- | :------------------------------: | --------- | --------- | 14 | | Deebot OZMO 920 | :material-check: | REST/MQTT | JSON | 15 | | Deebot OZMO 950 | :fontawesome-solid-check-double: | REST/MQTT | JSON | 16 | | Deebot OZMO T5 | :material-check: | REST/MQTT | JSON | 17 | | Deebot (OZMO) T8 series | :material-check: | REST/MQTT | JSON | 18 | | Deebot T9 series | :material-check: | REST/MQTT | JSON | 19 | | Deebot N8 series | :material-check: | REST/MQTT | JSON | 20 | | Deebot U2 series | | REST/MQTT | JSON | 21 | | Deebot X1 Omni | :material-progress-check: | REST/MQTT | JSON | 22 | 23 | ## :material-language-javascript: ecovacs-deebot.js 24 | 25 | Used by [Ecovacs Deebot adapter](https://github.com/mrbungle64/ioBroker.ecovacs-deebot) and [various others](projects.md#ecovacs-deebotjs) 26 | 27 | | Model | status | Protocol | Data type | 28 | | ----------------------- | :------------------------------: | --------- | --------- | 29 | | Deebot 500/501 | :material-check: | | | 30 | | Deebot 600/601/605 | :material-check: | REST/MQTT | XML | 31 | | Deebot 710/711/711s | :material-check: | REST/MQTT | XML | 32 | | Deebot 900/901 | :fontawesome-solid-check-double: | REST/MQTT | XML | 33 | | Deebot OZMO Slim 10/11 | :material-check: | REST/MQTT | XML | 34 | | Deebot OZMO 610 | :material-check: | XMPP | XML | 35 | | Deebot OZMO 900/905 | :material-check: | REST/MQTT | XML | 36 | | Deebot OZMO 920 | :fontawesome-solid-check-double: | REST/MQTT | JSON | 37 | | Deebot OZMO 930 | :fontawesome-solid-check-double: | XMPP | XML | 38 | | Deebot OZMO 950 | :fontawesome-solid-check-double: | REST/MQTT | JSON | 39 | | Deebot OZMO T5 | :material-check: | REST/MQTT | JSON | 40 | | Deebot (OZMO) T8 series | :material-check: | REST/MQTT | JSON | 41 | | Deebot T9 series | :material-check: | REST/MQTT | JSON | 42 | | Deebot M88 | :material-check: | XMPP | XML | 43 | | Deebot N8 series | :material-check: | REST/MQTT | JSON | 44 | | Deebot N79 series | :material-check: | XMPP | XML | 45 | | Deebot U2 series | :material-progress-check: | REST/MQTT | JSON | 46 | | Deebot Slim 2 | :fontawesome-solid-check-double: | XMPP | XML | 47 | | Deebot X1 Omni | :material-check: | REST/MQTT | JSON | 48 | 49 | ## Legend 50 | 51 | | Icon | Description | 52 | | -------------------------------- | --------------------------------------------------------------------------------------- | 53 | | :fontawesome-solid-check-double: | Confirmed to work flawlessly and at least one of the main developers owns such a device | 54 | | :material-check: | Confirmed to work properly | 55 | | :material-progress-check: | Confirmed to work partially | 56 | | :material-close: | Currently no support | 57 | | | No status or info available. Feedback is welcome | 58 | -------------------------------------------------------------------------------- /docs/home/projects.md: -------------------------------------------------------------------------------- 1 | # Projects 2 | 3 | ## :material-language-python: deebot-client 4 | 5 | [deebot-client](https://github.com/DeebotUniverse/client.py) is a python library and is used by the following projects: 6 | 7 | - :material-home-assistant: [Deebot for Home Assistant](https://github.com/DeebotUniverse/Deebot-4-Home-Assistant) (Home Assistant) 8 | 9 | 10 | ## :material-language-javascript: ecovacs-deebot.js 11 | 12 | [ecovacs-deebot.js](https://github.com/mrbungle64/ecovacs-deebot.js) is a Javascript/Node.js library and is used by the following projects: 13 | 14 | - :material-iobroker: [Ecovacs Deebot adapter](https://github.com/mrbungle64/ioBroker.ecovacs-deebot) (ioBroker) 15 | - :material-home-automation: [node-red-contrib-ecovacs-deebot](https://github.com/mrbungle64/node-red-contrib-ecovacs-deebot) (Node-RED) 16 | - :material-home-automation: [homebridge-deebot](https://github.com/bwp91/homebridge-deebot) (Homebridge) 17 | - :material-home-automation: [homebridge-deebotecovacs](https://github.com/nicoduj/homebridge-deebotEcovacs) (Homebridge) 18 | - :material-home-automation: [pimatic-deebot](https://github.com/bertreb/pimatic-deebot) (Pimatic) 19 | - :material-home-automation: [Ecovacs Deebot](https://github.com/Aybert59/com.messiant.ecovacs) (Homey) 20 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | # Welcome to documentation for Deebot Universe projects 2 | 3 | [DeebotUniverse](https://github.com/DeebotUniverse) is a collection of Open Source projects and documentation related to Deebot devices from Ecovacs. 4 | 5 | ## Disclaimer 6 | 7 | This documentation is unofficial, and is not sponsored, owned or endorsed by ECOVACS Robotics (ECOVACS). 8 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/entities.md: -------------------------------------------------------------------------------- 1 | --- 2 | ignore_macros: true 3 | --- 4 | 5 | # Entities 6 | 7 | Here you can find a short description for all entities created by this component. 8 | All exposed entities have the following naming schema: 9 | 10 | `[domain].[robot name]_[entity name]` 11 | 12 | E.g. `binary_sensor.susi_mop_attached` 13 | 14 | !!! attention 15 | 16 | Except the **vacuum** entity, all others are disabled by default. 17 | You should only enable the required ones. 18 | 19 | ??? tip "Attributes as entities" 20 | 21 | With [templates](https://www.home-assistant.io/integrations/template/) any attributes can be made as entity. 22 | 23 | Example: 24 | 25 | ```yaml 26 | template: 27 | - sensor: 28 | - name: "Vacuum fan speed" 29 | state: "{{ states.vacuum.YOUR_ROBOT_NAME.attributes['fan_speed'] }}" 30 | ``` 31 | 32 | !!! info 33 | 34 | The entities are split by their domains. In other words the domain is the header name :wink: 35 | 36 | ## Binary sensor 37 | 38 | | Name | Description | 39 | | -------------- | -------------------------------- | 40 | | `mop_attached` | Specifies if the mop is attached | 41 | 42 | ## Camera 43 | 44 | | Name | Description | 45 | | ---------- | --------------------------------- | 46 | | `live_map` | The live map (similar to the App) | 47 | 48 | ## Number 49 | 50 | | Name | Description | 51 | | -------- | -------------- | 52 | | `volume` | Set the volume | 53 | 54 | ## Select 55 | 56 | | Name | Description | 57 | | -------------- | ----------------------------------------- | 58 | | `water_amount` | Set the water amount used during cleaning | 59 | 60 | ## Sensor 61 | 62 | | Name | Description | 63 | | ----------------------- | -------------------------------------------------------------------- | 64 | | `last_cleaning_job` | Information about the last cleaning. Details [below](#last-cleaning) | 65 | | `last_error` | Last error Details [below](#last-error) | 66 | | `life_span_brush` | % left of main brush | 67 | | `life_span_filter` | % left of filter | 68 | | `life_span_side_brush` | % left of side brushes | 69 | | `stats_area` | cleaned area of last/current cleaning job | 70 | | `stats_time` | elapsed time of last/current cleaning job | 71 | | `stats_type` | type of last/current cleaning job | 72 | | `stats_total_area` | total cleaned area | 73 | | `stats_total_time` | total cleaning time | 74 | | `stats_total_cleanings` | total cleanings | 75 | 76 | ### Last cleaning 77 | 78 | - `state`: Holding the status/stop reason 79 | - `attributes` 80 | - `timestamp`: Timestamp, when the job was started 81 | - `image_url`: Url to the map image. Hosted on the servers 82 | - `type`: cleaning type 83 | - `area`: cleaned area 84 | - `duration`: duration in minutes 85 | 86 | ### Last error 87 | 88 | - `state`: error code 89 | - `attributes.description`: Description for the error code, if available 90 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/events.md: -------------------------------------------------------------------------------- 1 | # Events 2 | 3 | The integration currently fires the following events: 4 | 5 | ## `deebot_cleaning_job` 6 | 7 | Will be fired on start and end of a cleaning job and has the following structure: 8 | 9 | - `cleaning_id`: cleaning id 10 | - `status`: status of job 11 | - `type`: cleaning type 12 | 13 | The following keys are only available at the end of a cleaning: 14 | 15 | - `area`: cleaned area 16 | - `content`: Depends on the `type` 17 | - Ids of the rooms, when `type=spotArea` 18 | - Coordinates when `type=customArea` 19 | - `time`: duration in seconds 20 | 21 | !!! note 22 | 23 | When `status=finished` than the content can be trusted to be cleaned. Otherwise we cannot be sure. 24 | The vacuum unfortunately only sends this inaccurate status. 25 | 26 | ## `deebot_custom_command` 27 | 28 | !!! warning "Only for advanced users" 29 | 30 | The reason for this event is only to give advanced users the possibility to 31 | try/use a command, which is not implemented yet. 32 | 33 | This integration supports also sending "raw" commands to the vacuum. 34 | If your model supports the command and a response will be received, it will be fired with this event. 35 | The event data depends on which command was send. 36 | 37 | Some commands are documented under [advanced](../../../advanced/data_types/json/commands/). 38 | 39 | ### Example `getLifeSpan` 40 | 41 | To send a custom command, we use the service [`vacuum.send_command`](https://www.home-assistant.io/integrations/vacuum/#service-vacuumsend_command). 42 | From the [`getLifeSpan` documentation](../../../advanced/data_types/json/commands/life_span#getlifespan), we get the following information: 43 | 44 | - command name is `getLifeSpan` 45 | - the arguments is a list of components from which we want to get the life span. 46 | 47 | With the above information, we can write a similar service call: 48 | My vacuum only supports a subset of the documented components. 49 | 50 | ```yaml 51 | service: vacuum.send_command 52 | target: 53 | entity_id: vacuum.YOUR_ROBOT_NAME 54 | data: 55 | command: getLifeSpan 56 | params: 57 | - sideBrush 58 | - brush 59 | - heap 60 | ``` 61 | 62 | After executing the command the event `deebot_custom_command` is fired will a similar response: 63 | 64 | !!! tip 65 | 66 | The interesting part is normally inside `response->body->data`, if data present. 67 | 68 | ```json 69 | { 70 | "event_type": "deebot_custom_command", 71 | "data": { 72 | "name": "getLifeSpan", 73 | "response": { 74 | "header": { 75 | "pri": 1, 76 | "tzm": 480, 77 | "ts": "1312811509056", 78 | "ver": "0.0.1", 79 | "fwVer": "1.8.2", 80 | "hwVer": "0.1.1" 81 | }, 82 | "body": { 83 | "code": 0, 84 | "msg": "ok", 85 | "data": [ 86 | { 87 | "type": "sideBrush", 88 | "left": 2378, 89 | "total": 9000 90 | }, 91 | { 92 | "type": "brush", 93 | "left": 6569, 94 | "total": 18000 95 | }, 96 | { 97 | "type": "heap", 98 | "left": 3348, 99 | "total": 7200 100 | } 101 | ] 102 | } 103 | } 104 | }, 105 | "origin": "LOCAL", 106 | "time_fired": "2022-04-24T22:30:57.187634+00:00", 107 | "context": { 108 | "id": "[REMOVED]", 109 | "parent_id": null, 110 | "user_id": null 111 | } 112 | } 113 | ``` 114 | 115 | As specified in the docs, the unit of `left` is minutes, meaning e.g. I can use the brush for another 6569 minutes. 116 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/examples/commands.md: -------------------------------------------------------------------------------- 1 | # Example commands 2 | 3 | All `vacuum` services offered by Home Assistant are described in their [docs](https://www.home-assistant.io/integrations/vacuum/#component-services). 4 | 5 | Below some more advanced examples: 6 | 7 | ## Relocate Robot 8 | 9 | ```yaml 10 | service: vacuum.send_command 11 | target: 12 | entity_id: vacuum.YOUR_ROBOT_NAME 13 | data: 14 | command: relocate 15 | ``` 16 | 17 | ## Clean only certain rooms 18 | 19 | You can clean certain area by specify it in rooms params, you can find room number under vacuum attributes 20 | 21 | ```yaml 22 | service: vacuum.send_command 23 | target: 24 | entity_id: vacuum.YOUR_ROBOT_NAME 25 | data: 26 | command: spot_area 27 | params: 28 | rooms: 10,14 29 | cleanings: 1 30 | ``` 31 | 32 | ## Clean custom area 33 | 34 | ```yaml 35 | service: vacuum.send_command 36 | target: 37 | entity_id: vacuum.YOUR_ROBOT_NAME 38 | data: 39 | command: custom_area 40 | params: 41 | coordinates: -1339,-1511,296,-2587 42 | ``` 43 | 44 | !!! tip 45 | 46 | To find out the correct coordinates use the following steps: 47 | 48 | 1. Use the app to send the vacuum to a custom area 49 | 2. Use the dev tools to listen for the event `deebot_cleaning_job`, which will be fired at the start/end of a cleaning job 50 | 3. At the end of the job you can find your coordinates under `data->content` 51 | 52 | Also the coordinates will be logged on `debug`. After activating debug logs, you can search your logs for `Last custom area values (x1,y1,x2,y2):` to get the coordinates. 53 | 54 | ## Custom commands 55 | 56 | !!! warning "Only for advanced users" 57 | 58 | The reason for this use case is only to give advanced users the possibility to 59 | try/use a command, which is not implemented yet. 60 | 61 | More information can be found under [deebot_custom_command](../events.md#deebotcustomcommand) 62 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/examples/ui/advanced.md: -------------------------------------------------------------------------------- 1 | --- 2 | ignore_macros: true 3 | --- 4 | 5 | # UI advanced example 6 | 7 | Main feature is ability to specify via UI the order of the cleaned rooms. 8 | Thanks to @aidbish for the initial idea. 9 | 10 | ![Preview](../../../../assets/images/ui-advanced.gif) 11 | 12 | ## Setup 13 | 14 | For this setup to work, you need some custom components (all available via HACS) 15 | 16 | - [Vacuum-card](https://github.com/denysdovhan/vacuum-card) 17 | - [Button-card](https://github.com/custom-cards/button-card) 18 | 19 | ## Configuration 20 | 21 | Below you can find the snippets for this example including the backend configuration. 22 | Adjust it for your needs. 23 | 24 | !!! todo 25 | 26 | Please change the of the entities accordingly. My vacuum has the name _"susi"_. 27 | Search for this name :) 28 | 29 | ## Backend (configuration.yaml) 30 | 31 | ```yaml 32 | script: 33 | deebot_clean: 34 | description: Start a deebot cleaning task 35 | variables: 36 | queue: input_text.deebot_susi_queue 37 | vacuum_bot: vacuum.susi 38 | sequence: 39 | - alias: Get room numbers 40 | variables: 41 | # See for appending to list 42 | # https://github.com/home-assistant/core/issues/33678#issuecomment-609424851 43 | rooms: >- 44 | {%- set queue_split = states(queue).split(",") -%} 45 | {%- set rooms = state_attr(vacuum_bot, "rooms")-%} 46 | {%- set data = namespace(rooms=[]) -%} 47 | {%- for room_name in queue_split -%} 48 | {%- set data.rooms = data.rooms + [rooms[room_name]] -%} 49 | {%- endfor -%} 50 | {{ data.rooms | join(",") }} 51 | - alias: Send cleaning job to vacuum 52 | service: vacuum.send_command 53 | data: 54 | entity_id: "{{ vacuum_bot }}" 55 | command: spot_area 56 | params: 57 | rooms: "{{ rooms }}" 58 | cleanings: 1 59 | 60 | deebot_room_queue: 61 | description: Add/Remove a room from the queue 62 | fields: 63 | queue: 64 | description: The queue variable 65 | example: input_text.deebot_susi_queue 66 | room: 67 | description: Room, which should be removed or added 68 | example: kitchen 69 | sequence: 70 | - service: input_text.set_value 71 | target: 72 | entity_id: "{{ queue }}" 73 | data: 74 | value: >- 75 | {%- set queue_state = states(queue) -%} 76 | {%- set queue_split = queue_state.split(",") -%} 77 | {%- if queue_state | length == 0 -%} 78 | {{ room }} 79 | {%- elif room in queue_split -%} 80 | {{ queue_split | reject("eq", room) | list | join(",")}} 81 | {%- else -%} 82 | {{ (queue_split + [room]) | join(",") }} 83 | {%- endif -%} 84 | 85 | automation: 86 | - alias: Staubsauger Zimmer resetieren 87 | trigger: 88 | - platform: event 89 | event_type: deebot_cleaning_job 90 | event_data: 91 | status: finished 92 | condition: [] 93 | action: 94 | - alias: Reset room queue 95 | service: input_text.set_value 96 | target: 97 | entity_id: input_text.deebot_susi_queue 98 | data: 99 | value: "" 100 | mode: single 101 | 102 | recorder: 103 | exclude: 104 | entities: 105 | - input_text.deebot_susi_queue 106 | - script.deebot_room_queue 107 | entity_globs: 108 | - sensor.deebot_*_queue_* 109 | 110 | input_text: 111 | deebot_susi_queue: 112 | name: Susi Raum Reihenfolge 113 | max: 255 # Current max limit. See https://www.home-assistant.io/integrations/input_text/#max 114 | 115 | # Room name comes from the integration to match attribute names 116 | template: 117 | unique_id: deebot_susi_queue 118 | trigger: 119 | - platform: state 120 | entity_id: input_text.deebot_susi_queue 121 | sensor: 122 | # Add for each room the following. Change room_name accordingly 123 | - unique_id: deebot_susi_queue_living_room 124 | name: deebot_susi_queue_living_room 125 | # room_name must match the room name provided by the vacuum 126 | state: > 127 | {% set room_name = "living_room" %} 128 | {% set queue = trigger.to_state.state.split(",") %} 129 | {{ queue.index(room_name)+1 if room_name in queue else 0 }} 130 | ``` 131 | 132 | ### UI configuration 133 | 134 | In the UI we use button card templates to reduce duplicate code. More information can be found in their [documentation](https://github.com/custom-cards/button-card#Configuration-Templates). 135 | 136 | ```yaml 137 | button_card_templates: 138 | vacuum_service: 139 | color: var(--text-color) 140 | entity: vacuum.susi # change me 141 | tap_action: 142 | action: call-service 143 | service_data: 144 | entity_id: vacuum.susi # change me 145 | lock: 146 | enabled: | 147 | [[[ return variables.enabled ]]] 148 | exemptions: [] 149 | styles: 150 | card: 151 | - height: 80px 152 | lock: 153 | - color: var(--primary-text-color) 154 | state: 155 | - operator: template 156 | value: | 157 | [[[ return variables.enabled ]]] 158 | styles: 159 | card: 160 | - color: var(--disabled-text-color) 161 | vacuum_room: 162 | color: var(--text-color) 163 | variables: 164 | # change me 165 | lock_enabled: > 166 | [[[ return ['cleaning', 'paused'].includes(states['vacuum.susi'].state) 167 | ]]] 168 | state: 169 | - operator: template 170 | value: | 171 | [[[ return variables.lock_enabled && entity.state == 0 ]]] 172 | styles: 173 | card: 174 | - color: var(--disabled-text-color) 175 | - styles: 176 | card: 177 | - background-color: var(--primary-color) 178 | operator: ">=" 179 | value: 1 180 | styles: 181 | card: 182 | - font-size: 12px 183 | grid: 184 | - position: relative 185 | custom_fields: 186 | order: 187 | - display: | 188 | [[[ 189 | if (entity.state == "0") 190 | return "none"; 191 | return "block"; 192 | ]]] 193 | - position: absolute 194 | - left: 5% 195 | - top: 5% 196 | - height: 20px 197 | - width: 20px 198 | - font-size: 20px 199 | - font-weight: bold 200 | - line-height: 20px 201 | custom_fields: 202 | order: | 203 | [[[ return entity.state ]]] 204 | tap_action: 205 | action: call-service 206 | service: script.deebot_room_queue 207 | service_data: 208 | queue: input_text.deebot_susi_queue 209 | lock: 210 | enabled: | 211 | [[[ return variables.lock_enabled ]]] 212 | exemptions: [] 213 | ``` 214 | 215 | Below the actual card configuration 216 | 217 | ```yaml 218 | type: vertical-stack 219 | cards: 220 | - type: custom:vacuum-card 221 | entity: vacuum.susi # change me 222 | stats: 223 | default: 224 | - entity_id: sensor.susi_life_span_brush # change me 225 | unit: "%" 226 | subtitle: Hauptbürste 227 | - entity_id: sensor.susi_life_span_side_brush # change me 228 | unit: "%" 229 | subtitle: Seitenbürsten 230 | - entity_id: sensor.susi_life_span_filter # change me 231 | unit: "%" 232 | subtitle: Filter 233 | cleaning: 234 | - entity_id: sensor.susi_stats_area # change me 235 | unit: m² 236 | subtitle: Geputzte Fläche 237 | - entity_id: sensor.susi_stats_time # change me 238 | unit: Minuten 239 | subtitle: Reinigungsdauer 240 | show_status: true 241 | show_toolbar: false 242 | compact_view: true 243 | - type: custom:button-card 244 | color: auto-no-temperature 245 | name: Räume zum Putzen auswählen 246 | styles: 247 | card: 248 | - font-size: 18px 249 | - height: 30px 250 | name: 251 | - color: var(--primary-color) 252 | - type: horizontal-stack 253 | cards: 254 | # Add the following chard for each room. Change values accordingly 255 | - type: custom:button-card 256 | template: vacuum_room 257 | entity: sensor.deebot_susi_queue_living_room # change me 258 | icon: mdi:sofa 259 | name: Wohnzimmer 260 | tap_action: 261 | service_data: 262 | room: living_room # change me 263 | 264 | - type: horizontal-stack 265 | cards: 266 | - type: conditional 267 | conditions: 268 | - entity: vacuum.susi # change me 269 | state_not: cleaning 270 | - entity: vacuum.susi # change me 271 | state_not: paused 272 | card: 273 | type: custom:button-card 274 | template: vacuum_service 275 | icon: mdi:play 276 | name: Start 277 | tap_action: 278 | action: call-service 279 | service: script.deebot_clean 280 | variables: 281 | # change me 282 | enabled: | 283 | [[[ 284 | return ((!states['input_text.deebot_susi_queue'].state || 285 | states['input_text.deebot_susi_queue'].state.length === 0) 286 | && ['docked', 'idle', 'error', 'returning'].includes(entity.state)) 287 | ]]] 288 | - type: conditional 289 | conditions: 290 | - entity: vacuum.susi # change me 291 | state: cleaning 292 | card: 293 | type: custom:button-card 294 | color: auto 295 | icon: mdi:pause 296 | name: Pause 297 | tap_action: 298 | action: call-service 299 | service: vacuum.pause 300 | service_data: 301 | entity_id: vacuum.susi # change me 302 | styles: 303 | card: 304 | - height: 80px 305 | - background-color: var(-color) 306 | - type: conditional 307 | conditions: 308 | - entity: vacuum.susi # change me 309 | state: paused 310 | card: 311 | type: custom:button-card 312 | color: auto 313 | icon: mdi:play-pause 314 | name: Weiter 315 | tap_action: 316 | action: call-service 317 | service: vacuum.start 318 | service_data: 319 | entity_id: vacuum.susi # change me 320 | styles: 321 | card: 322 | - height: 80px 323 | - background-color: var(-color) 324 | - type: custom:button-card 325 | template: vacuum_service 326 | icon: mdi:stop 327 | name: Stop 328 | tap_action: 329 | service: vacuum.stop 330 | variables: 331 | enabled: | 332 | [[[ 333 | return !(['cleaning', 'paused', 'returning'].includes(entity.state)) 334 | ]]] 335 | - type: horizontal-stack 336 | cards: 337 | - type: custom:button-card 338 | template: vacuum_service 339 | icon: mdi:home-map-marker 340 | name: Zurück zur Ladestation 341 | tap_action: 342 | service: vacuum.return_to_base 343 | variables: 344 | enabled: | 345 | [[[ 346 | return ['docked', 'returning'].includes(entity.state) 347 | ]]] 348 | - type: custom:button-card 349 | color: auto 350 | icon: mdi:map-marker 351 | name: Lokalisieren 352 | tap_action: 353 | action: call-service 354 | service: vacuum.locate 355 | service_data: 356 | entity_id: vacuum.susi # change me 357 | styles: 358 | card: 359 | - height: 80px 360 | - background-color: var(-color) 361 | - type: picture-entity 362 | entity: camera.susi_live_map # change me 363 | tap_action: 364 | action: none 365 | hold_action: 366 | action: none 367 | show_state: false 368 | show_name: false 369 | ``` 370 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/examples/ui/simple.md: -------------------------------------------------------------------------------- 1 | # Simple 2 | 3 | For this example we need the following cards: 4 | 5 | - [vacuum-card](https://github.com/denysdovhan/vacuum-card) 6 | 7 | ## Configuration 8 | 9 | ```yaml 10 | type: "custom:vacuum-card" 11 | entity: vacuum.YOURROBOTNAME 12 | image: default 13 | compact_view: false 14 | show_name: true 15 | show_toolbar: true 16 | show_status: true 17 | stats: 18 | default: 19 | - entity_id: sensor.YOURROBOTNAME_sidebrush 20 | unit: "%" 21 | subtitle: Side Brush 22 | - entity_id: sensor.YOURROBOTNAME_brush 23 | unit: "%" 24 | subtitle: Main Brush 25 | - entity_id: sensor.YOURROBOTNAME_heap 26 | unit: "%" 27 | subtitle: Heap 28 | cleaning: 29 | - entity_id: sensor.YOURROBOTNAME_stats_area 30 | unit: m2 31 | subtitle: Area 32 | - entity_id: sensor.YOURROBOTNAME_stats_time 33 | unit: min 34 | subtitle: Time 35 | shortcuts: 36 | - service: script.CLEAN_LIVINGROOM 37 | icon: "mdi:sofa" 38 | - service: script.CLEAN_BEDROOM 39 | icon: "mdi:bed-empty" 40 | - service: script.CLEAN_ALL 41 | icon: "mdi:robot-vacuum-variant" 42 | map: camera.ROBOTNAME_liveMap 43 | ``` 44 | 45 | Something like this should be the result: 46 | 47 | ![Preview](../../../../assets/images/custom_vacuum_card.jpg) 48 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/index.md: -------------------------------------------------------------------------------- 1 | # Deebot 4 Home Assistant 2 | 3 | Here you find the documentation about the Home Assistant integration [Deebot 4 Home Assistant](https://github.com/DeebotUniverse/Deebot-4-Home-Assistant). 4 | With this Home Assistant Custom Component you'll be able to 5 | 6 | - play/pause 7 | - locate 8 | - send to home 9 | - clean[auto|map|area] 10 | - track live map 11 | - sensors 12 | - and much more... 13 | 14 | ## Supported models 15 | 16 | The supported models can be found under [models](../../home/models.md) under the section `deebot-client`. 17 | 18 | ## Thanks 19 | 20 | My heartfelt thanks to: 21 | 22 | - [Deebot-for-Home-Assistant](https://github.com/And3rsL/Deebot-for-Home-Assistant), After all, this is a Deebot-for-Home-Assistant fork :) 23 | - [integration template](https://github.com/custom-components/integration_blueprint), a template for HA integrations 24 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/issues.md: -------------------------------------------------------------------------------- 1 | # Issues 2 | 3 | If you have an issue with [Deebot 4 Home Assistant](https://github.com/DeebotUniverse/Deebot-4-Home-Assistant) component, please create a [GitHub Issue](https://github.com/DeebotUniverse/Deebot-4-Home-Assistant/issues/new/choose) and include your Home Assistant logs in the report. 4 | To get full debug output from both the deebot integration and the underlying deebot-client library, place this in your `configuration.yaml` file: 5 | 6 | ```yaml 7 | logger: 8 | logs: 9 | homeassistant.components.vacuum: debug 10 | custom_components.deebot: debug 11 | deebot_client: debug 12 | ``` 13 | 14 | More information can be found in the [HA logger documentation](https://www.home-assistant.io/integrations/logger/). 15 | 16 | !!! warning 17 | 18 | Doing this will cause your authentication token to visible in your log files. 19 | Be sure to remove any tokens and other authentication details from your log before posting them in an issue. 20 | 21 | !!! info 22 | 23 | If you have multiple vacuums please add the logs only for the relevant one. 24 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/migration.md: -------------------------------------------------------------------------------- 1 | # Migration from [And3rsL/Deebot-for-Home-Assistant](https://github.com/And3rsL/Deebot-for-Home-Assistant) 2 | 3 | Unfortunately Andrea is not any more active and I don't have the required privileges to do certain changes. 4 | So I decided to fork the project under a new organization [DeebotUniverse](https://github.com/DeebotUniverse). 5 | 6 | !!! warning 7 | 8 | Please read the complete migration until the end before performing some actions. 9 | 10 | ## Breaking changes 11 | 12 | !!! note 13 | 14 | This migration describes the breaking changes versus the version `0.1.1`. 15 | For other versions please read the release notes. 16 | 17 | ### Camera 18 | 19 | The live map was renamed to have a consistent naming schema. 20 | 21 | `camera.RBOTNAME_livemap` -> `camera.RBOTNAME_live_map` 22 | 23 | ### Last cleaning 24 | 25 | In the old component only the image of the last cleaning job was available. 26 | The new sensor [last_cleaning](entities.md#last-cleaning) has a lot more information. 27 | The image url can be found as attribute of the new sensor `last_cleaning`. 28 | 29 | ### Life span sensors 30 | 31 | Life span sensor are renamed to group them together: 32 | 33 | - `sensor.ROBOTNAME_brush` -> `sensor.ROBOTNAME_life_span_brush` 34 | - `sensor.ROBOTNAME_heap` -> `sensor.ROBOTNAME_life_span_filter` 35 | - `sensor.ROBOTNAME_sidebrush` -> `sensor.ROBOTNAME_life_span_side_brush` 36 | 37 | ### Vacuum room attributes 38 | 39 | Room attributes are now group under one attribute `rooms`. 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 58 | 67 | 68 | 69 |
BeforeAfter
51 | ```yaml 52 | room_living_room: 7 53 | room_bedroom: 17 54 | room_bathroom: 14 55 | room_kitchen: 11 56 | ``` 57 | 59 | ```yaml 60 | rooms: 61 | living_room: 7 62 | bedroom: 17 63 | bathroom: 14 64 | kitchen: 11 65 | ``` 66 |
70 | 71 | !!! note 72 | 73 | If you are using the advanced UI example, you need to update it accordingly. Backend and frontend changes are required. 74 | Please compare it with the [updated version](examples/ui/advanced.md). 75 | 76 | ### Water amount 77 | 78 | The water amount (old level) is now available as select entity. Made it easy to know all available values and change it directly in the UI. 79 | 80 | `sensor.ROBOTNAME_water_level` -> `select.ROBOTNAME_water_amount` 81 | 82 | ### Removed 83 | 84 | - `sensor.ROBOTNAME_stats_start`: The start time can be identified via Home Assistant when the vacuum change state. Also in some cases the start time had a random time zone, so it was not really helpful. 85 | - `sensor.ROBOTNAME_stats_cid`: The id on the stats command is different from the id of the same cleaning job on the rest of the commands. 86 | 87 | Please use the new event [deebot_cleaning_job](events.md#deebot_cleaning_job) instead. 88 | 89 | ## Steps 90 | 91 | !!! note 92 | 93 | At least Home Assistant `2021.11.0` is required to use the integration, because entity categories are introduced in that version. 94 | 95 | 1. Verify that you are running at least HA `2021.11.0`. If not please update first 96 | 2. Remove all configuration of _Deebot for Home Assistant_ 97 | 3. Uninstall _Deebot **for** Home Assistant_ (via Hacs) 98 | 4. Install _Deebot **4** Home Assistant_ (via Hacs) 99 | 5. Restart Home Assistant 100 | 6. Start adding all config entries again 101 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/misc.md: -------------------------------------------------------------------------------- 1 | # Misc 2 | 3 | The following svg of the Deebot Ozmo 950 can be found under [images](../../assets/images/deebot950.svg). 4 | 5 | ![SVG Deebot Ozmo 950](../../assets/images/deebot950.svg){: style="height:100px"} 6 | 7 | ## Custom commands 8 | 9 | !!! warning "Only for advanced users" 10 | 11 | The reason for these command is only to give advanced users the possibility to 12 | try/use a command, which is not implemented yet. 13 | 14 | For more information see event [`deebot_custom_command`](events.md#deebotcustomcommand). 15 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/services.md: -------------------------------------------------------------------------------- 1 | # Services 2 | 3 | The integration adds the following services: 4 | 5 | ## `deebot.refresh` 6 | 7 | Service to manually refresh parts of the vacuum. 8 | 9 | Parameters: 10 | 11 | - `service`: `deebot.refresh` 12 | - `target.entity_id`: Entity id of vacuum 13 | - `data.category`: Category, which should be refreshed. Following are supported: 14 | - Status 15 | - Error 16 | - Fan speed 17 | - Clean logs 18 | - Water 19 | - Battery 20 | - Stats 21 | - Life spans 22 | - Rooms 23 | - Map 24 | 25 | ??? example 26 | 27 | ```yaml 28 | service: deebot.refresh 29 | data: 30 | category: Status 31 | target: 32 | entity_id: vacuum.YOUR_ROBOT_NAME 33 | ``` 34 | -------------------------------------------------------------------------------- /docs/integrations/home-assistant/setup.md: -------------------------------------------------------------------------------- 1 | # Setup 2 | 3 | ## Installation 4 | 5 | You can install the integration in two different ways: 6 | 7 | ### Hacs (Preferred) 8 | 9 | 1. Install [HACS](https://hacs.xyz) 10 | 2. In HACS: Go to Integrations and search and install **Deebot 4 Home Assistant** 11 | 3. Restart Home Assistant 12 | 13 | ### Manual 14 | 15 | 1. Go to the [integration releases](https://github.com/DeebotUniverse/Deebot-4-Home-Assistant/releases) 16 | 2. Download `deebot.zip` and extract into the folder `custom_components` of your Home Assistant instance. 17 | 3. Restart Home Assistant 18 | 19 | !!! tip 20 | 21 | If possible please use the installation via Hacs, as Hacs will inform you when a new release is available. 22 | 23 | ## Configuration 24 | 25 | 1. [![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=deebot) 26 | 27 | Click on the button above or go to HA Settings -> Integration -> Add -> Deebot 4 Home Assistant. 28 | 29 | 2. Configure 30 | - **Country:** Iso two-letter code. A list can be found [here](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). 31 | - **Continent:** Iso two-letter code. If your continent code is not working, please fallback to `ww`. 32 | 33 | !!! attention "Password" 34 | 35 | There are some issues during the password encoding. Using some special characters (e.g.`, -`) in your password does not work. 36 | 37 | !!! info "Chinese server configuration" 38 | 39 | For chinese server username you require "short id" and password. Short id look like "EXXXXXX". 40 | Don't use your mobile phone number, it won't work. 41 | 42 | Since these servers are in China and unless you are close to China, don't expect very fast response. 43 | -------------------------------------------------------------------------------- /include/advanced/data_types/commands-template.jinja2: -------------------------------------------------------------------------------- 1 | {% from 'helpers.jinja2' import list_arguments, add_additional, example %} 2 | 3 | # {{ title | default(page.title) }} 4 | 5 | {%- for command in commands %} 6 | 7 | ## `{{ command.name}}` 8 | 9 | {{ command.description }} 10 | 11 | ### Request 12 | 13 | Only the name and the payload arguments will be described. General information can be found 14 | under [Command General](general.md#request). 15 | 16 | - Name: `{{ command.name}}` 17 | 18 | {%- if command.request is defined and command.request.arguments is defined %} 19 | - Payload arguments: 20 | {{ list_arguments(command.request.arguments, 1) }} 21 | {% if command.request.example is defined %} 22 | {{ example(command.request.example, data_type, "Example payload") }} 23 | {% endif %} 24 | {% else %} 25 | - Payload arguments: None 26 | {% endif %} 27 | 28 | {%- if command.request is defined %} 29 | {{ add_additional(command.request) }} 30 | {% endif %} 31 | 32 | ### Response 33 | 34 | {% if command.response is defined and command.response.arguments is defined%} 35 | Only the `data` object will be described here. 36 | To get information about the whole response, please refer to 37 | [Command General](general.md#response). 38 | 39 | The `data` object contains the following arguments: 40 | 41 | {{ list_arguments(command.response.arguments) }} 42 | {% if command.response.example is defined %} 43 | {{ example(command.response.example, data_type, "Example response") }} 44 | {% endif %} 45 | 46 | {% else %} 47 | No specific response expected, as this is a executing command. 48 | General information about responses can be found under 49 | [rest](../../../protocols/rest.md#response). 50 | {% endif %} 51 | 52 | {%- if command.response is defined %} 53 | {{ add_additional(command.response) }} 54 | {% endif %} 55 | 56 | {%- endfor %} -------------------------------------------------------------------------------- /include/advanced/data_types/commands-template.md: -------------------------------------------------------------------------------- 1 | # Commands template 2 | 3 | This template is expecting the following variables: 4 | 5 | - `data_type`: The datatype to format the code blocks. 6 | - `commands`: The commands to render. Each command should have the following schema: 7 | - `name`: command name 8 | - `description`: command description 9 | - `request`: _Optional_ The request object 10 | - `arguments`: Request arguments as dict, currently this two options are supported 11 | - `[arguments name]`: `[description]` 12 | - `[arguments name]`: 13 | - `description`: arguments description 14 | - `data_values`: _Optional_ Dictionary describing all possible values 15 | - `arguments`: _Optional_ Arguments dictionary 16 | - `example`: _Optional_ an example, will be formatted which the provided data_type 17 | - `additional`: _Optional_ Additional markdown to be rendered 18 | - `response`: _Optional_ The response object. Same schema as request 19 | -------------------------------------------------------------------------------- /include/advanced/data_types/json/message.md: -------------------------------------------------------------------------------- 1 | ```json 2 | { 3 | "header": { 4 | "pri": 1, 5 | "tzm": 480, 6 | "ts": "1297811721698", 7 | "ver": "0.0.1", 8 | "fwVer": "1.8.2", 9 | "hwVer": "0.1.1" 10 | }, 11 | "body": { 12 | "data": "[data]" 13 | } 14 | } 15 | ``` 16 | 17 | {{ description_header }} Description 18 | 19 | - `header` 20 | - `ts`: timestamp 21 | - `ver`: protocol version 22 | - `fwVer`: firmware version 23 | - `hwVer`: hardware version 24 | - `body` 25 | - `data`: Holding the actual data. See specific description 26 | -------------------------------------------------------------------------------- /include/advanced/data_types/messages-template.jinja2: -------------------------------------------------------------------------------- 1 | {% from 'helpers.jinja2' import list_arguments, add_additional, example %} 2 | 3 | # {{ title | default(page.title) }} 4 | 5 | {%- for message in messages %} 6 | 7 | ## `{{ message.name}}` 8 | 9 | This message can be received: 10 | {% for entry in message.receive %} 11 | - {{ entry }} 12 | {%- endfor %} 13 | 14 | Only the `data` object will be described here. 15 | To get information about the whole message, please refer to 16 | [General](general.md) 17 | 18 | The `data` object contains the following arguments: 19 | 20 | {{ list_arguments(message.arguments) }} 21 | 22 | {{ example(message.example, data_type, "Example response") }} 23 | 24 | {{ add_additional(message) }} 25 | 26 | {%- endfor %} -------------------------------------------------------------------------------- /include/advanced/data_types/messages-template.md: -------------------------------------------------------------------------------- 1 | # Messages template 2 | 3 | This template is expecting the following variables: 4 | 5 | - `data_type`: The datatype to format the code blocks. 6 | - `messages`: The commands to render. Each command should have the following schema: 7 | - `name`: command name 8 | - `receive`: List, when this message can be received 9 | - `arguments`: Request arguments as dict, currently this two options are supported 10 | - `[arguments name]`: `[description]` 11 | - `[arguments name]`: 12 | - `description`: arguments description 13 | - `data_values`: _Optional_ Dictionary describing all possible values 14 | - `arguments`: _Optional_ Arguments dictionary 15 | - `example`: _Optional_ an example, will be formatted which the provided data_type 16 | - `additional`: _Optional_ Additional markdown to be rendered 17 | -------------------------------------------------------------------------------- /include/advanced/protocols/data_type.md: -------------------------------------------------------------------------------- 1 | | Value | Description | 2 | | ----- | ----------- | 3 | | x | xml | 4 | | j | json | 5 | -------------------------------------------------------------------------------- /include/helpers.jinja2: -------------------------------------------------------------------------------- 1 | {% macro list_arguments(arguments, initial_depth=0) -%} 2 | {% for key, object in arguments.items() recursive %} 3 | {%- set description = "" %} 4 | {%- if object is string %} 5 | {%- set description = object %} 6 | {%- elif object is mapping %} 7 | {%- set description = object.description %} 8 | {%- endif %} 9 | {{ " " * (loop.depth0 + initial_depth) }}- `{{ key }}`: {{ description }} 10 | {%- if object is mapping %} 11 | {%- if object.data_values is defined %} 12 | 13 | {{ " " * (loop.depth0 + initial_depth + 1) }}| Value | Description | 14 | {{ " " * (loop.depth0 + initial_depth + 1) }}| ----- | ----------- | 15 | {%- for key, value in object.data_values.items() %} 16 | {{ " " * (loop.depth0 + initial_depth + 1) }}| {{ key }} | {{ value }} | 17 | {%- endfor %} 18 | {% elif object.arguments is defined %} 19 | {{ loop(object.arguments.items()) }} 20 | {%- endif %} 21 | {%- endif %} 22 | {%- endfor %} 23 | {%- endmacro %} 24 | 25 | 26 | 27 | {% macro add_additional(object) -%} 28 | {% if object.additional is defined %} 29 | {{ object.additional }} 30 | {% endif %} 31 | {%- endmacro %} 32 | 33 | 34 | 35 | {% macro example(code, data_type, title="example") %} 36 | 37 | !!! example "{{ title }}" 38 | 39 | ```{{ data_type }} 40 | {{ code | replace("\n","\n ") }} 41 | ``` 42 | 43 | {% endmacro %} -------------------------------------------------------------------------------- /mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: DeebotUniverse 2 | site_description: Docs for Open Source projects related to Deebot devices from Ecovacs - but we are in no way affiliated with ECOVACS Robotics (ECOVACS) 3 | 4 | repo_url: https://github.com/DeebotUniverse/docs 5 | edit_uri: blob/main/docs/ 6 | 7 | theme: 8 | name: material 9 | icon: 10 | logo: material/robot-vacuum 11 | repo: fontawesome/brands/github 12 | palette: 13 | - media: "(prefers-color-scheme: light)" 14 | scheme: default 15 | primary: indigo 16 | accent: indigo 17 | toggle: 18 | icon: material/weather-night 19 | name: Switch to dark mode 20 | - media: "(prefers-color-scheme: dark)" 21 | scheme: slate 22 | primary: red 23 | accent: red 24 | toggle: 25 | icon: material/weather-sunny 26 | name: Switch to light mode 27 | features: 28 | - navigation.indexes 29 | - navigation.instant 30 | - navigation.tabs 31 | - navigation.top 32 | - search.suggest 33 | 34 | markdown_extensions: 35 | - admonition 36 | - attr_list 37 | - footnotes 38 | - mdx_truly_sane_lists 39 | - meta 40 | - tables 41 | - toc: 42 | permalink: true 43 | permalink_title: Anchor link to this section for reference 44 | - pymdownx.betterem 45 | - pymdownx.emoji: 46 | emoji_index: !!python/name:materialx.emoji.twemoji 47 | emoji_generator: !!python/name:materialx.emoji.to_svg 48 | - pymdownx.details 49 | - pymdownx.highlight 50 | - pymdownx.superfences 51 | 52 | plugins: 53 | # https://github.com/fralau/mkdocs_macros_plugin 54 | - macros: 55 | include_dir: include 56 | - search 57 | # https://github.com/aklajnert/mkdocs-simple-hooks 58 | - mkdocs-simple-hooks: 59 | hooks: 60 | on_post_page: "plugins.children_with_subtitle:insert_children_with_subtitle" 61 | 62 | nav: 63 | - Home: 64 | - index.md 65 | - Projects: home/projects.md 66 | - Models: home/models.md 67 | - FAQ: home/faq.md 68 | - Integrations: 69 | - Home Assistant: 70 | - integrations/home-assistant/index.md 71 | - Setup: integrations/home-assistant/setup.md 72 | - Entities: integrations/home-assistant/entities.md 73 | - Events: integrations/home-assistant/events.md 74 | - Services: integrations/home-assistant/services.md 75 | - Issues: integrations/home-assistant/issues.md 76 | - Misc: integrations/home-assistant/misc.md 77 | - Examples: 78 | - Commands: integrations/home-assistant/examples/commands.md 79 | - UI: 80 | - Simple: integrations/home-assistant/examples/ui/simple.md 81 | - Advanced: integrations/home-assistant/examples/ui/advanced.md 82 | - Migration: integrations/home-assistant/migration.md 83 | - Advanced: 84 | - Protocols: 85 | - MQTT: advanced/protocols/mqtt.md 86 | - REST: advanced/protocols/rest.md 87 | - XMPP: advanced/protocols/xmpp.md 88 | - Data types: 89 | - JSON: 90 | - Commands: 91 | - advanced/data_types/json/commands/index.md 92 | - General: advanced/data_types/json/commands/general.md 93 | - Advanced mode: advanced/data_types/json/commands/advanced_mode.md 94 | - Auto empty: advanced/data_types/json/commands/auto_empty.md 95 | - Break point: advanced/data_types/json/commands/break_point.md 96 | - Carpet pressure: advanced/data_types/json/commands/carpet_pressure.md 97 | - Clean count: advanced/data_types/json/commands/clean_count.md 98 | - Life span: advanced/data_types/json/commands/life_span.md 99 | - Map: advanced/data_types/json/commands/map.md 100 | - Multimap state: advanced/data_types/json/commands/multimap_state.md 101 | - Net info: advanced/data_types/json/commands/net_info.md 102 | - Over the air update: advanced/data_types/json/commands/ota.md 103 | - Play sound: advanced/data_types/json/commands/play_sound.md 104 | - Relocate: advanced/data_types/json/commands/relocate.md 105 | - Speed: advanced/data_types/json/commands/speed.md 106 | - Sleep mode: advanced/data_types/json/commands/sleep_mode.md 107 | - Stats: advanced/data_types/json/commands/stats.md 108 | - True detect: advanced/data_types/json/commands/true_detect.md 109 | - Volume: advanced/data_types/json/commands/volume.md 110 | - Water: advanced/data_types/json/commands/water.md 111 | - Messages: 112 | - advanced/data_types/json/messages/index.md 113 | - General: advanced/data_types/json/messages/general.md 114 | - Map: advanced/data_types/json/messages/map.md 115 | - Stats: advanced/data_types/json/messages/stats.md 116 | - XML: 117 | - Commands: 118 | - advanced/data_types/xml/commands/index.md 119 | - General: advanced/data_types/xml/commands/general.md 120 | - Clean: advanced/data_types/xml/commands/clean.md 121 | - Clean speed: advanced/data_types/xml/commands/cleanSpeed.md 122 | - Play sound: advanced/data_types/xml/commands/playSound.md 123 | - Water: advanced/data_types/xml/commands/waterlevel.md 124 | - Messages: 125 | - advanced/data_types/xml/messages/index.md 126 | - General: advanced/data_types/xml/messages/general.md 127 | -------------------------------------------------------------------------------- /plugins/children_with_subtitle.py: -------------------------------------------------------------------------------- 1 | from typing import List 2 | 3 | from mkdocs.structure.pages import Page 4 | from mkdocs.structure.toc import AnchorLink 5 | from mkdocs.utils import normalize_url 6 | 7 | import logging 8 | 9 | _LOGGER = logging.getLogger("mkdocs.plugins." + __name__) 10 | 11 | _KEY = "{childrenWithSubtitle}" 12 | 13 | 14 | def insert_children_with_subtitle(output, page: Page, config): 15 | if _KEY in output: 16 | if not page.parent: 17 | _LOGGER.warning("Page has no parent. Stopping!") 18 | return output 19 | 20 | children: List[Page] = [child for child in page.parent.children if child is not page] 21 | return output.replace(_KEY, _format_links(children, page)) 22 | 23 | 24 | def _format_links(items: List[Page], page: Page): 25 | result = "
    " 26 | 27 | for item in items: 28 | if item.title == "General" or not item.toc: 29 | continue 30 | 31 | result += f"
  • {item.title}
      " 32 | 33 | entry: AnchorLink 34 | for entry in item.toc.items[0].children: 35 | url = normalize_url(item.url, page) 36 | result += f"
    • {entry.title}
      • " 37 | 38 | result += "
    • " 39 | 40 | result += "
" 41 | return result 42 | -------------------------------------------------------------------------------- /requirements-dev.txt: -------------------------------------------------------------------------------- 1 | -r requirements.txt 2 | 3 | pre-commit 4 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | mdx_truly_sane_lists==1.3 2 | mkdocs===1.4.2 3 | mkdocs-macros-plugin==0.7.0 4 | mkdocs-material==9.1.11 5 | mkdocs-simple-hooks==0.1.5 6 | --------------------------------------------------------------------------------