diff --git a/components/jiecang_desk_controller/README.md b/components/jiecang_desk_controller/README.md index bfb0a91..32c3964 100644 --- a/components/jiecang_desk_controller/README.md +++ b/components/jiecang_desk_controller/README.md @@ -100,14 +100,14 @@ jiecang_desk_controller: height: name: "Height" buttons: - raise: - name: "Raise" + step_up: + name: "Step up" position1: name: "Position 1" button: - platform: template - name: "Lower" + name: "Step down" on_press: lambda: "id(my_desk).goto_height(84.0);" ``` @@ -145,8 +145,8 @@ height | current height of the desk button | description --------------|--------------------------- -raise | raise desk by one step (~14mm) -lower | lower desk by one step (~14mm) +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 stop | stop movement of desk @@ -160,8 +160,8 @@ save_position | press position button afterwards to store current height to that lambda method | description ----------------------------------|--------------------------- -`id(my_desk).raise()` | raise desk by one step (~14mm) -`id(my_desk).lower()` | lower desk by one step (~14mm) +`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).stop()` | stop movement of desk diff --git a/components/jiecang_desk_controller/__init__.py b/components/jiecang_desk_controller/__init__.py index e8d2119..f0ec16d 100644 --- a/components/jiecang_desk_controller/__init__.py +++ b/components/jiecang_desk_controller/__init__.py @@ -18,8 +18,8 @@ CONF_SENSORS = "sensors" CONF_BUTTONS = "buttons" CONF_NUMBERS = "numbers" CONF_UNIT = "unit" -CONF_RAISE = "raise" -CONF_LOWER = "lower" +CONF_STEP_UP = "step_up" +CONF_STEP_DOWN = "step_down" CONF_STOP = "stop" CONF_HEIGHT_MIN = "height_min" CONF_HEIGHT_MAX = "height_max" @@ -34,8 +34,8 @@ CONF_MOVE_DOWN = "move_down" button_constants = {} -button_constants[CONF_RAISE] = 0 -button_constants[CONF_LOWER] = 1 +button_constants[CONF_STEP_UP] = 0 +button_constants[CONF_STEP_DOWN] = 1 button_constants[CONF_STOP] = 2 button_constants[CONF_POSITION1] = 3 button_constants[CONF_POSITION2] = 4 @@ -45,6 +45,13 @@ button_constants[CONF_SAVE_POSITION] = 7 button_constants[CONF_MOVE_UP] = 8 button_constants[CONF_MOVE_DOWN] = 9 +# Backward compatibility +CONF_RAISE = "raise" +CONF_LOWER = "lower" +button_constants[CONF_RAISE] = button_constants[CONF_STEP_UP] +button_constants[CONF_LOWER] = button_constants[CONF_STEP_DOWN] + + number_constants = {} number_constants[CONF_HEIGHT] = 0 number_constants[CONF_HEIGHT_PCT] = 1 @@ -101,8 +108,8 @@ CONFIG_SCHEMA = cv.COMPONENT_SCHEMA.extend({ }), }), cv.Optional(CONF_BUTTONS): cv.Schema({ - cv.Optional(CONF_RAISE): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), - cv.Optional(CONF_LOWER): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), + cv.Optional(CONF_STEP_UP): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), + cv.Optional(CONF_STEP_DOWN): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), cv.Optional(CONF_STOP): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), cv.Optional(CONF_POSITION1): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), cv.Optional(CONF_POSITION2): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), @@ -111,6 +118,9 @@ CONFIG_SCHEMA = cv.COMPONENT_SCHEMA.extend({ cv.Optional(CONF_SAVE_POSITION): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), cv.Optional(CONF_MOVE_UP): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), cv.Optional(CONF_MOVE_DOWN): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), + # Backward compatibility + cv.Optional(CONF_RAISE): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), + cv.Optional(CONF_LOWER): button.BUTTON_SCHEMA.extend({cv.GenerateID(): cv.declare_id(JiecangDeskButton)}), }), }).extend(uart.UART_DEVICE_SCHEMA) diff --git a/components/jiecang_desk_controller/example_basic.yaml b/components/jiecang_desk_controller/example_basic.yaml index b123c12..61c9e05 100644 --- a/components/jiecang_desk_controller/example_basic.yaml +++ b/components/jiecang_desk_controller/example_basic.yaml @@ -30,10 +30,10 @@ logger: jiecang_desk_controller: id: my_desk buttons: - raise: - name: "Raise" - lower: - name: "Lower" + step_up: + name: "Step up" + step_down: + name: "Step down" stop: name: "Stop" position1: diff --git a/components/jiecang_desk_controller/example_full.yaml b/components/jiecang_desk_controller/example_full.yaml index 386b0a4..9279718 100644 --- a/components/jiecang_desk_controller/example_full.yaml +++ b/components/jiecang_desk_controller/example_full.yaml @@ -50,10 +50,10 @@ jiecang_desk_controller: position4: name: "Position 4" buttons: - raise: - name: "Raise" - lower: - name: "Lower" + step_up: + name: "Step up" + step_down: + name: "Step down" stop: name: "Stop" position1: @@ -79,13 +79,13 @@ jiecang_desk_controller: ## lambda usage # button: # - platform: template -# name: "Raise" +# name: "Step up" # on_press: -# lambda: "id(my_desk).raise();" +# lambda: "id(my_desk).step_up();" # - platform: template -# name: "Lower" +# name: "Step down" # on_press: -# lambda: "id(my_desk).lower();" +# lambda: "id(my_desk).step_down();" # - platform: template # name: "Stop" # on_press: diff --git a/components/jiecang_desk_controller/jiecang_desk_controller.cpp b/components/jiecang_desk_controller/jiecang_desk_controller.cpp index f7167df..225f0d1 100644 --- a/components/jiecang_desk_controller/jiecang_desk_controller.cpp +++ b/components/jiecang_desk_controller/jiecang_desk_controller.cpp @@ -145,11 +145,11 @@ namespace esphome { btn->add_on_press_callback([this, action]() { this->button_press_action(action); }); } - void JiecangDeskController::raise() { + void JiecangDeskController::step_up() { send_simple_command(0x01); } - void JiecangDeskController::lower() { + void JiecangDeskController::step_down() { send_simple_command(0x02); } @@ -224,11 +224,11 @@ namespace esphome { void JiecangDeskController::button_press_action(int action) { ESP_LOGV("JiecangDeskController", "button_press_action %i", action); switch (action) { - case BUTTON_RAISE: - raise(); + case BUTTON_STEP_UP: + step_up(); break; - case BUTTON_LOWER: - lower(); + case BUTTON_STEP_DOWN: + step_down(); break; case BUTTON_STOP: stop(); diff --git a/components/jiecang_desk_controller/jiecang_desk_controller.h b/components/jiecang_desk_controller/jiecang_desk_controller.h index 56a1058..4f0a6ef 100644 --- a/components/jiecang_desk_controller/jiecang_desk_controller.h +++ b/components/jiecang_desk_controller/jiecang_desk_controller.h @@ -9,8 +9,8 @@ #include "esphome/core/log.h" #include "jiecang_desk_number.h" -#define BUTTON_RAISE 0 -#define BUTTON_LOWER 1 +#define BUTTON_STEP_UP 0 +#define BUTTON_STEP_DOWN 1 #define BUTTON_STOP 2 #define BUTTON_POSITION1 3 #define BUTTON_POSITION2 4 @@ -57,8 +57,8 @@ namespace esphome { void add_button(button::Button *btn, int action); void add_number(JiecangDeskNumber *number, int type); - void raise(); - void lower(); + void step_up(); + void step_down(); void stop(); void goto_position(int pos); void save_position(int pos);