Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CleanState command #158

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/advanced/data_types/xml/commands/CleanState.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---

data_type: xml
commands:

- name: GetCleanState
description: Command to get information about clean state.
response:
arguments:
"[clean]":
description: A list with a result object for each requested component.
arguments:
<<: &component_type
speed:
description: The corresponding value for the component.
<<: *component_values
strong: max force of vacuum
auto: min force of vacuum
<<: &component_type
type:
description: The corresponding value for the component.
<<:*component_values
auto: auto clean
border: border clean
spot: spot clean
<<: &component_type
st:
description: The corresponding value for the component.
<<: *component_values
p: pause
h: stop
s: start
<<: &component_type
mode:
description: The corresponding value for the component.
<<:*component_values
R: unknown
<<: &component_type
t and a:
description: unknown.
<<: \*component_values
int: unknown

example: >-
[
<clean type='auto' speed='standard' st='h' mode='R' t='100' a='100'/>
]

{% include 'advanced/data_types/commands-template.jinja2' %}