From cc4db2d183bb34ae52417d32e0cb7572580704dc Mon Sep 17 00:00:00 2001 From: Marcoske23 <103160819+Marcoske23@users.noreply.github.com> Date: Wed, 6 Jul 2022 20:12:32 -0500 Subject: [PATCH 1/4] Crear CleanState command. With getCleanState command cleanliness status response is received. {'ret': 'ok', 'resp': "", 'id': 'iJRD'} --- .../data_types/xml/commands/CleanState.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/advanced/data_types/xml/commands/CleanState.md diff --git a/docs/advanced/data_types/xml/commands/CleanState.md b/docs/advanced/data_types/xml/commands/CleanState.md new file mode 100644 index 0000000..781c695 --- /dev/null +++ b/docs/advanced/data_types/xml/commands/CleanState.md @@ -0,0 +1,46 @@ +--- +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: >- + [ + + ] +{% include 'advanced/data_types/commands-template.jinja2' %} From 67af40274128235a922796d648350099a8c6840f 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 01:18:33 +0000 Subject: [PATCH 2/4] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../data_types/xml/commands/CleanState.md | 87 ++++++++++--------- 1 file changed, 45 insertions(+), 42 deletions(-) diff --git a/docs/advanced/data_types/xml/commands/CleanState.md b/docs/advanced/data_types/xml/commands/CleanState.md index 781c695..922067c 100644 --- a/docs/advanced/data_types/xml/commands/CleanState.md +++ b/docs/advanced/data_types/xml/commands/CleanState.md @@ -1,46 +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: >- - [ - - ] -{% include 'advanced/data_types/commands-template.jinja2' %} +- 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: >- + [ + + ] + + {% include 'advanced/data_types/commands-template.jinja2' %} From aee47babaddd2d8e1c4fa3960faa88e132e7e697 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 06:04:42 +0000 Subject: [PATCH 3/4] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/advanced/data_types/xml/commands/CleanState.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/advanced/data_types/xml/commands/CleanState.md b/docs/advanced/data_types/xml/commands/CleanState.md index 922067c..67ee10f 100644 --- a/docs/advanced/data_types/xml/commands/CleanState.md +++ b/docs/advanced/data_types/xml/commands/CleanState.md @@ -19,7 +19,7 @@ commands: <<: &component_type type: description: The corresponding value for the component. -<<:*component_values + <<:*component_values auto: auto clean border: border clean spot: spot clean @@ -33,7 +33,7 @@ commands: <<: &component_type mode: description: The corresponding value for the component. -<<:*component_values + <<:*component_values R: unknown <<: &component_type t and a: @@ -41,9 +41,9 @@ commands: <<: \*component_values int: unknown - example: >- - [ - - ] + example: >- + [ + + ] {% include 'advanced/data_types/commands-template.jinja2' %} From 6c2404ca187648a1e2d7d8fd7b6aec7333702c2c Mon Sep 17 00:00:00 2001 From: Marcoske23 <103160819+Marcoske23@users.noreply.github.com> Date: Fri, 8 Jul 2022 14:09:46 -0500 Subject: [PATCH 4/4] Update CleanState.md --- docs/advanced/data_types/xml/commands/CleanState.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/advanced/data_types/xml/commands/CleanState.md b/docs/advanced/data_types/xml/commands/CleanState.md index 67ee10f..fbca6e0 100644 --- a/docs/advanced/data_types/xml/commands/CleanState.md +++ b/docs/advanced/data_types/xml/commands/CleanState.md @@ -3,7 +3,7 @@ data_type: xml commands: -- name: getCleanState +- name: GetCleanState description: Command to get information about clean state. response: arguments: