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

Update clean.md #159

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 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
3 changes: 2 additions & 1 deletion docs/advanced/data_types/xml/commands/clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ commands:
description: clean action
data_values:
s: start
p: pause
p: pause [^4]
r: resume
h: stop
speed:
Expand All @@ -39,3 +39,4 @@ commands:
[^1]: Models without mapping functionality only
[^2]: Models with mapping functionality only
[^3]: Models with single room cleaning mode only
[^4]: spot and border modes cannot be paused, they can only be stopped.
39 changes: 39 additions & 0 deletions docs/advanced/data_types/xml/commands/life_span.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---

data_type: xml
commands:

- name: getLifeSpan
description: Command to get information about accessories components.
request:
arguments:
"[component]":
description: A list with corresponding value for the components. Multiple values possible
<<: &component_values
data_values:
brush: main brush
sideBrush: side brush
dustcaseheap: filter
example: >-
<ctl type="Brush" />
response:
arguments:
"[result]":
description: A list with a result object for each requested component.
arguments:
<<: &component_type
type:
description: The corresponding value for the component.
<<: \*component_values
left: Remaining lifetime in minutes
total: Total lifetime in minutes
example: >-
<ctl ret='ok' type='Brush' left='13858' total='18000'/>
<ctl ret='ok' type='SideBrush' left='04858' total='9000'/>
<ctl ret='ok' type='DustCaseHeap' left='03058' total='7200'/>
additional: >-
!!! hint

To calculate the percentage use `left/total`.

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