From 5af797f80c5beb498d217def2ae4e6377c5a17b2 Mon Sep 17 00:00:00 2001 From: Marcoske23 <103160819+Marcoske23@users.noreply.github.com> Date: Wed, 6 Jul 2022 20:22:56 -0500 Subject: [PATCH 1/5] Update clean.md Apparently spot and border only can stop. --- docs/advanced/data_types/xml/commands/clean.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/advanced/data_types/xml/commands/clean.md b/docs/advanced/data_types/xml/commands/clean.md index 332cb9f..b2e6f44 100644 --- a/docs/advanced/data_types/xml/commands/clean.md +++ b/docs/advanced/data_types/xml/commands/clean.md @@ -20,7 +20,7 @@ commands: description: clean action data_values: s: start - p: pause + p: pause [^4] r: resume h: stop speed: @@ -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 type cant pause, only stop. From 3bf6cf6a3621e1fc5703fcd30b99597defb04e40 Mon Sep 17 00:00:00 2001 From: Marcoske23 <103160819+Marcoske23@users.noreply.github.com> Date: Thu, 7 Jul 2022 01:22:06 -0500 Subject: [PATCH 2/5] Update clean.md --- docs/advanced/data_types/xml/commands/clean.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/advanced/data_types/xml/commands/clean.md b/docs/advanced/data_types/xml/commands/clean.md index b2e6f44..d998afa 100644 --- a/docs/advanced/data_types/xml/commands/clean.md +++ b/docs/advanced/data_types/xml/commands/clean.md @@ -39,4 +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 type cant pause, only stop. +[^4]: spot and border modes cannot be paused, they can only be stopped. From e2d20143ad36366b1c9275fe43eb78e0aac9b2f4 Mon Sep 17 00:00:00 2001 From: Marcoske23 <103160819+Marcoske23@users.noreply.github.com> Date: Thu, 7 Jul 2022 11:25:40 -0500 Subject: [PATCH 3/5] Create life_span.md Es muy similar al tipo JSON. En mi dispositivo solo cambia el "heap" a "dustcaseheap". --- .../data_types/xml/commands/life_span.md | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/advanced/data_types/xml/commands/life_span.md diff --git a/docs/advanced/data_types/xml/commands/life_span.md b/docs/advanced/data_types/xml/commands/life_span.md new file mode 100644 index 0000000..1838bb4 --- /dev/null +++ b/docs/advanced/data_types/xml/commands/life_span.md @@ -0,0 +1,37 @@ +--- +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: >- + + 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: >- + + + + additional: >- + !!! hint + + To calculate the percentage use `left/total`. + +{% include 'advanced/data_types/commands-template.jinja2' %} From b70920c6cb4841cb2aef63c7cd0a6aa923bc8cab Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 7 Jul 2022 16:26:30 +0000 Subject: [PATCH 4/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../data_types/xml/commands/life_span.md | 64 ++++++++++--------- 1 file changed, 33 insertions(+), 31 deletions(-) diff --git a/docs/advanced/data_types/xml/commands/life_span.md b/docs/advanced/data_types/xml/commands/life_span.md index 1838bb4..cae3319 100644 --- a/docs/advanced/data_types/xml/commands/life_span.md +++ b/docs/advanced/data_types/xml/commands/life_span.md @@ -1,37 +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: >- - - 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: >- - - - - additional: >- - !!! hint - To calculate the percentage use `left/total`. +- 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: >- + + 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: >- + + + + additional: >- + !!! hint + + To calculate the percentage use `left/total`. {% include 'advanced/data_types/commands-template.jinja2' %} From 5ab24fcbe9a48ac8231db11afc6915b50999acf5 Mon Sep 17 00:00:00 2001 From: Marcoske23 <103160819+Marcoske23@users.noreply.github.com> Date: Fri, 8 Jul 2022 11:56:51 -0500 Subject: [PATCH 5/5] Update clean.md Minimal modifications --- .../advanced/data_types/xml/commands/clean.md | 43 ++++++++++--------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/docs/advanced/data_types/xml/commands/clean.md b/docs/advanced/data_types/xml/commands/clean.md index d998afa..6bcf4a4 100644 --- a/docs/advanced/data_types/xml/commands/clean.md +++ b/docs/advanced/data_types/xml/commands/clean.md @@ -5,29 +5,32 @@ commands: description: Command to start a cleaning. request: arguments: - clean: + "[clean]": arguments: - type: + "[type]": description: clean mode - data_values: - auto: auto clean - border: border clean [^1] - spot: spot clean [^1] - SpotArea: spot area and custom area clean [^2] - singleroom: single room clean [^3] - stop: stop - act: + <<: &component_values + data_values: + auto: auto clean + border: border clean [^1] + spot: spot clean [^1] + SpotArea: spot area and custom area clean [^2] + singleroom: single room clean [^3] + stop: stop + "[act]": description: clean action - data_values: - s: start - p: pause [^4] - r: resume - h: stop - speed: + <<: &component_values + data_values: + s: start + p: pause [^4] + r: resume + h: stop + "[speed]": description: vacuum power - data_values: - standard: standard - strong: max + <<: &component_values + data_values: + standard: standard + strong: max additional: >- !!! info @@ -39,4 +42,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. +[^4]: Spot and border modes cannot be paused, they can only be stopped.