From 5533a3580171785bedf5177085312a949fbf4c9d Mon Sep 17 00:00:00 2001 From: Rocka84 Date: Thu, 6 Jun 2024 22:22:58 +0200 Subject: [PATCH] updated/fixed README and examples --- components/jiecang_desk_controller/README.md | 20 +++++++++++-------- .../example_basic.yaml | 8 ++++++-- .../jiecang_desk_controller/example_full.yaml | 8 ++++++-- 3 files changed, 24 insertions(+), 12 deletions(-) diff --git a/components/jiecang_desk_controller/README.md b/components/jiecang_desk_controller/README.md index 32c3964..73386a0 100644 --- a/components/jiecang_desk_controller/README.md +++ b/components/jiecang_desk_controller/README.md @@ -100,8 +100,12 @@ jiecang_desk_controller: height: name: "Height" buttons: - step_up: - name: "Step up" + move_up: + name: "Move up" + move_down: + name: "Move down" + stop: + name: "Stop" position1: name: "Position 1" @@ -145,10 +149,10 @@ height | current height of the desk button | description --------------|--------------------------- -step_up | step_up desk by one step (~14mm) -step_down | step_down desk by one step (~14mm) -move_up | move up -move_down | move down +step_up | move up desk by one step (~14mm) +step_down | move down desk by one step (~14mm) +move_up | move up until stopped +move_down | move down until stopped stop | stop movement of desk position1 | move to 1st stored height position2 | move to 2nd stored height @@ -162,8 +166,8 @@ lambda method | description ----------------------------------|--------------------------- `id(my_desk).step_up()` | step_up desk by one step (~14mm) `id(my_desk).step_down()` | step_down desk by one step (~14mm) -`id(my_desk).move_up(height)` | move up -`id(my_desk).move_down(height)` | move down +`id(my_desk).move_up()` | move up +`id(my_desk).move_down()` | move down `id(my_desk).stop()` | stop movement of desk `id(my_desk).goto_position(pos)` | move to stored height `pos` `id(my_desk).save_position(pos)` | save current height to position `pos` diff --git a/components/jiecang_desk_controller/example_basic.yaml b/components/jiecang_desk_controller/example_basic.yaml index 61c9e05..dc44217 100644 --- a/components/jiecang_desk_controller/example_basic.yaml +++ b/components/jiecang_desk_controller/example_basic.yaml @@ -30,12 +30,16 @@ logger: jiecang_desk_controller: id: my_desk buttons: + move_up: + name: "Move up" + move_down: + name: "Move down" + stop: + name: "Stop" step_up: name: "Step up" step_down: name: "Step down" - stop: - name: "Stop" position1: name: "Position 1" position2: diff --git a/components/jiecang_desk_controller/example_full.yaml b/components/jiecang_desk_controller/example_full.yaml index 9279718..3647a94 100644 --- a/components/jiecang_desk_controller/example_full.yaml +++ b/components/jiecang_desk_controller/example_full.yaml @@ -50,12 +50,16 @@ jiecang_desk_controller: position4: name: "Position 4" buttons: + move_up: + name: "Move up" + move_down: + name: "Move down" + stop: + name: "Stop" step_up: name: "Step up" step_down: name: "Step down" - stop: - name: "Stop" position1: name: "Position 1" position2: