fix formatting for maidesite desk

This commit is contained in:
ElVit 2025-11-28 08:52:42 +01:00
parent ee4bf34083
commit 921eb6387e
12 changed files with 678 additions and 725 deletions

View File

@ -4,21 +4,22 @@ from esphome import pins
from esphome.components import uart
from esphome.const import CONF_ID
CODEOWNERS = ['@elvit']
CODEOWNERS = ["@elvit"]
MULTICONF = True
DEPENDENCIES = ['uart']
DEPENDENCIES = ["uart"]
CONF_MAIDESITE_DESK_ID = "maidesite_desk"
CONF_LOG_UART_MSG = "log_uart_msg"
maidesite_desk_ns = cg.esphome_ns.namespace('maidesite_desk')
MaidesiteDeskComponent = maidesite_desk_ns.class_('MaidesiteDeskComponent', cg.Component, uart.UARTDevice)
maidesite_desk_ns = cg.esphome_ns.namespace("maidesite_desk")
MaidesiteDeskComponent = maidesite_desk_ns.class_(
"MaidesiteDeskComponent", cg.Component, uart.UARTDevice
)
CONFIG_SCHEMA = (
cv.Schema(
{
cv.GenerateID(): cv.declare_id(MaidesiteDeskComponent),
cv.Optional(CONF_LOG_UART_MSG, default=False): cv.boolean,
}
)
@ -26,6 +27,7 @@ CONFIG_SCHEMA = (
.extend(cv.COMPONENT_SCHEMA)
)
async def to_code(config):
var = cg.new_Pvariable(config[CONF_ID])
await cg.register_component(var, config)

View File

@ -6,7 +6,6 @@ from esphome.const import (
)
from .. import CONF_MAIDESITE_DESK_ID, MaidesiteDeskComponent, maidesite_desk_ns
CONF_STEP_UP = "step_up"
CONF_STEP_DOWN = "step_down"
CONF_STOP = "stop"
@ -37,12 +36,13 @@ TYPES = [
CONF_SAVE_M4,
]
MaidesiteDeskButton = maidesite_desk_ns.class_("MaidesiteDeskButton", button.Button, cg.Component)
MaidesiteDeskButton = maidesite_desk_ns.class_(
"MaidesiteDeskButton", button.Button, cg.Component
)
CONFIG_SCHEMA = cv.Schema(
{
cv.GenerateID(CONF_MAIDESITE_DESK_ID): cv.use_id(MaidesiteDeskComponent),
cv.Optional(CONF_STEP_UP): button.button_schema(
MaidesiteDeskButton,
),
@ -89,6 +89,7 @@ CONFIG_SCHEMA = cv.Schema(
}
).extend(cv.COMPONENT_SCHEMA)
async def to_code(config):
hub = await cg.get_variable(config[CONF_MAIDESITE_DESK_ID])
for index, key in enumerate(TYPES):

View File

@ -1,22 +1,17 @@
#include "maidesite_desk_button.h"
#include "esphome/core/log.h"
namespace esphome {
namespace maidesite_desk {
static const char* const TAG = "maidesite_desk.button";
namespace esphome
{
namespace maidesite_desk
{
static const char *const TAG = "maidesite_desk.button";
void MaidesiteDeskButton::dump_config()
{
void MaidesiteDeskButton::dump_config() {
LOG_BUTTON("", "Maidesite Desk Button", this);
delay(10);
}
}
void MaidesiteDeskButton::press_action()
{
void MaidesiteDeskButton::press_action() {
this->parent_->button_press_action(this);
}
} // namespace maidesite_desk
}
} // namespace maidesite_desk
} // namespace esphome

View File

@ -3,21 +3,19 @@
#include "esphome/core/component.h"
#include "../maidesite_desk.h"
namespace esphome
{
namespace maidesite_desk
{
class MaidesiteDeskButton : public button::Button, public Component, public Parented<MaidesiteDeskComponent>
{
namespace esphome {
namespace maidesite_desk {
class MaidesiteDeskButton : public button::Button, public Component, public Parented<MaidesiteDeskComponent> {
public:
MaidesiteDeskButton() = default;
void dump_config() override;
void set_id(int id) { this->id_ = id; }
void set_id(int id) {
this->id_ = id;
}
protected:
void press_action() override;
int id_;
};
} // namespace maidesite_desk
};
} // namespace maidesite_desk
} // namespace esphome

View File

@ -1,30 +1,24 @@
#include "maidesite_desk.h"
namespace esphome {
namespace maidesite_desk {
static const char* const TAG = "maidesite_desk";
namespace esphome
{
namespace maidesite_desk
{
static const char *const TAG = "maidesite_desk";
void MaidesiteDeskComponent::dump_config()
{
void MaidesiteDeskComponent::dump_config() {
ESP_LOGCONFIG(TAG, "Maidesite Desk");
delay(10);
}
}
void MaidesiteDeskComponent::setup()
{
void MaidesiteDeskComponent::setup() {
ESP_LOGCONFIG(TAG, "Setting up Maidesite Desk ...");
delay(10);
this->check_uart_settings(9600);
this->request_physical_limits();
this->request_limits();
this->request_settings();
}
}
void MaidesiteDeskComponent::loop()
{
void MaidesiteDeskComponent::loop() {
// This is a very simple method of receiving messages from the desk.
// It will fail on messages that contain the value 0x7E in their payload.
// But it is super simple and works for the messages we care about.
@ -33,13 +27,11 @@ namespace esphome
// checksum: sum of [command], [param_count] and all [param]s
uint8_t oneByte;
while (this->available())
{
while (this->available()) {
this->read_byte(&oneByte);
// Message shall start with 0xF2, if not skip this byte
if (!this->response_receiving_)
{
if (!this->response_receiving_) {
if (oneByte != 0xF2)
continue;
this->response_receiving_ = true;
@ -48,8 +40,7 @@ namespace esphome
this->response_message_.push_back(oneByte);
// Discard message if 2. byte is not 0xF2
if (this->response_message_.size() == 2 && oneByte != 0xF2)
{
if (this->response_message_.size() == 2 && oneByte != 0xF2) {
ESP_LOGW(TAG, "Invalid response message: 2. byte is 0x%02X but expexted is 0xF2", oneByte);
delay(10);
this->response_message_.clear();
@ -57,8 +48,7 @@ namespace esphome
continue;
}
// Discard message if it is too long
if (this->response_message_.size() > 10)
{
if (this->response_message_.size() > 10) {
ESP_LOGW(TAG, "Response message too long: expected not more than 10 bytes");
delay(10);
this->response_message_.clear();
@ -67,42 +57,38 @@ namespace esphome
}
// Decode message if message is complete (last byte shall be 0x7E)
if (oneByte == 0x7E)
{
if (oneByte == 0x7E) {
this->log_uart_hex("<<<", this->response_message_, ',');
this->decode_response(this->response_message_);
this->response_message_.clear();
this->response_receiving_ = false;
}
}
}
}
void MaidesiteDeskComponent::log_uart_hex(std::string prefix, std::vector<uint8_t> bytes, uint8_t separator)
{
if (this->log_uart_msg_ == false) return;
void MaidesiteDeskComponent::log_uart_hex(std::string prefix, std::vector<uint8_t> bytes, uint8_t separator) {
if (this->log_uart_msg_ == false)
return;
std::string logStr;
char buffer[5];
for (size_t i = 0; i < bytes.size(); i++)
{
if (i > 0) logStr += separator;
for (size_t i = 0; i < bytes.size(); i++) {
if (i > 0)
logStr += separator;
sprintf(buffer, "%02X", bytes[i]);
logStr += buffer;
}
for (size_t i = 0; i < logStr.length(); i += UART_LOG_CHUNK_SIZE)
{
for (size_t i = 0; i < logStr.length(); i += UART_LOG_CHUNK_SIZE) {
ESP_LOGI(TAG, "%s %s", prefix.c_str(), logStr.substr(i, UART_LOG_CHUNK_SIZE).c_str());
delay(10);
}
}
}
void MaidesiteDeskComponent::decode_response(std::vector<uint8_t> message)
{
void MaidesiteDeskComponent::decode_response(std::vector<uint8_t> message) {
// ToDo: Add checksum check
switch (message[2])
{
switch (message[2]) {
case 0x01:
ESP_LOGI(TAG, "Set height to 0x%0X%0X", message[4], message[5]);
delay(10);
@ -118,25 +104,25 @@ namespace esphome
this->height_abs_number_->publish_state(this->current_height_);
if (this->height_pct_sensor_ != nullptr && limit_max_ != 0)
this->height_pct_sensor_->publish_state((this->current_height_ - this->limit_min_) / (this->limit_max_ - this->limit_min_) * 100);
this->height_pct_sensor_->publish_state((this->current_height_ - this->limit_min_) /
(this->limit_max_ - this->limit_min_) * 100);
if (this->height_pct_number_ != nullptr && limit_max_ != 0)
this->height_pct_number_->publish_state(roundf((this->current_height_ - this->limit_min_) / (this->limit_max_ - this->limit_min_) * 1000) / 10);
this->height_pct_number_->publish_state(
roundf((this->current_height_ - this->limit_min_) / (this->limit_max_ - this->limit_min_) * 1000) / 10);
break;
case 0x20:
ESP_LOGI(TAG, "Set limits to 0x%0X max=%i min=%i", message[4], (message[5] & 1), (message[4] >> 4));
delay(10);
if ((message[4] & 1) == 0)
{ // low nibble 0 -> no max limit, use physical_max_
if ((message[4] & 1) == 0) { // low nibble 0 -> no max limit, use physical_max_
this->limit_max_ = this->physical_max_;
if (this->height_max_sensor_ != nullptr)
this->height_max_sensor_->publish_state(this->limit_max_);
if (height_abs_number_ != nullptr)
this->height_abs_number_->traits.set_max_value(this->limit_max_);
}
if ((message[4] >> 4) == 0)
{ // high nibble 0 -> no min limit, use physical_min_
if ((message[4] >> 4) == 0) { // high nibble 0 -> no min limit, use physical_min_
this->limit_min_ = this->physical_min_;
if (this->height_min_sensor_ != nullptr)
this->height_min_sensor_->publish_state(limit_min_);
@ -146,7 +132,8 @@ namespace esphome
break;
case 0x07:
ESP_LOGI(TAG, "Set physical limits to min=0x%02X%02X max=0x%02X%02X", message[4], message[5], message[6], message[7]);
ESP_LOGI(TAG, "Set physical limits to min=0x%02X%02X max=0x%02X%02X", message[4], message[5], message[6],
message[7]);
delay(10);
this->physical_max_ = this->byte2float(message[4], message[5]);
@ -217,56 +204,49 @@ namespace esphome
ESP_LOGI(TAG, "Received unknown message");
delay(10);
}
}
}
float MaidesiteDeskComponent::byte2float(int high, int low)
{
float MaidesiteDeskComponent::byte2float(int high, int low) {
return static_cast<float>((high << 8) + low) / 10;
}
}
// Write message:
// format: 0xF1 0xF1 [command] [param_count] [[param] ...] [checksum] 0x7E
// checksum: sum of [command], [param_count] and all [param]s
void MaidesiteDeskComponent::send_simple_command(unsigned char cmd)
{
// Write message:
// format: 0xF1 0xF1 [command] [param_count] [[param] ...] [checksum] 0x7E
// checksum: sum of [command], [param_count] and all [param]s
void MaidesiteDeskComponent::send_simple_command(unsigned char cmd) {
this->request_message_.clear();
this->request_message_.insert(this->request_message_.end(), { 0xF1, 0xF1, cmd, 0x00, cmd, 0x7E });
this->request_message_.insert(this->request_message_.end(), {0xF1, 0xF1, cmd, 0x00, cmd, 0x7E});
this->write_array(this->request_message_);
this->log_uart_hex(">>>", this->request_message_, ',');
delay(100); // NOLINT
}
}
void MaidesiteDeskComponent::send_2byte_command(unsigned char cmd, unsigned char high_byte, unsigned char low_byte)
{
void MaidesiteDeskComponent::send_2byte_command(unsigned char cmd, unsigned char high_byte, unsigned char low_byte) {
// ToDo: make one function of send_simple_command and send_2byte_command
unsigned char checksum = cmd + 2 + high_byte + low_byte;
this->request_message_.clear();
this->request_message_.insert(this->request_message_.end(), { 0xF1, 0xF1, cmd, 0x02, high_byte, low_byte, checksum, 0x7E });
this->request_message_.insert(this->request_message_.end(),
{0xF1, 0xF1, cmd, 0x02, high_byte, low_byte, checksum, 0x7E});
this->write_array(this->request_message_);
this->log_uart_hex(">>>", this->request_message_, ',');
delay(100); // NOLINT
}
}
void MaidesiteDeskComponent::step_up()
{
void MaidesiteDeskComponent::step_up() {
this->send_simple_command(0x01);
}
}
void MaidesiteDeskComponent::step_down()
{
void MaidesiteDeskComponent::step_down() {
this->send_simple_command(0x02);
}
}
void MaidesiteDeskComponent::stop()
{
void MaidesiteDeskComponent::stop() {
this->send_simple_command(0x2B);
}
}
void MaidesiteDeskComponent::goto_mem_position(int pos)
{
switch (pos)
{
void MaidesiteDeskComponent::goto_mem_position(int pos) {
switch (pos) {
case 1:
this->send_simple_command(0x05);
break;
@ -280,12 +260,10 @@ namespace esphome
this->send_simple_command(0x28);
break;
}
}
}
void MaidesiteDeskComponent::save_mem_position(int pos)
{
switch (pos)
{
void MaidesiteDeskComponent::save_mem_position(int pos) {
switch (pos) {
case 1:
this->send_simple_command(0x03);
break;
@ -299,50 +277,42 @@ namespace esphome
this->send_simple_command(0x26);
break;
}
}
}
void MaidesiteDeskComponent::request_physical_limits()
{
void MaidesiteDeskComponent::request_physical_limits() {
this->send_simple_command(0x0C);
}
}
void MaidesiteDeskComponent::request_limits()
{
void MaidesiteDeskComponent::request_limits() {
this->send_simple_command(0x20);
}
}
void MaidesiteDeskComponent::request_settings()
{
void MaidesiteDeskComponent::request_settings() {
this->send_simple_command(0x07);
}
}
void MaidesiteDeskComponent::request_move_to()
{
void MaidesiteDeskComponent::request_move_to() {
this->send_simple_command(0x1B);
}
}
void MaidesiteDeskComponent::goto_max_position()
{
void MaidesiteDeskComponent::goto_max_position() {
this->goto_height(limit_max_);
}
}
void MaidesiteDeskComponent::goto_min_position()
{
void MaidesiteDeskComponent::goto_min_position() {
this->goto_height(limit_min_);
}
}
void MaidesiteDeskComponent::goto_height(float height)
{
void MaidesiteDeskComponent::goto_height(float height) {
unsigned char high_byte = ((int)height * 10) >> 8;
unsigned char low_byte = ((int)height * 10) & 0xFF;
this->send_2byte_command(0x80, high_byte, low_byte);
this->request_move_to();
}
}
#ifdef USE_BUTTON
void MaidesiteDeskComponent::button_press_action(button::Button* object)
{
void MaidesiteDeskComponent::button_press_action(button::Button* object) {
if (object == step_up_button_)
this->step_up();
else if (object == step_down_button_)
@ -361,37 +331,29 @@ namespace esphome
this->goto_mem_position(3);
else if (object == goto_m4_button_)
this->goto_mem_position(4);
else if (object == save_m1_button_)
{
else if (object == save_m1_button_) {
this->save_mem_position(1);
this->request_settings();
}
else if (object == save_m2_button_)
{
} else if (object == save_m2_button_) {
this->save_mem_position(2);
this->request_settings();
}
else if (object == save_m3_button_)
{
} else if (object == save_m3_button_) {
this->save_mem_position(3);
this->request_settings();
}
else if (object == save_m4_button_)
{
} else if (object == save_m4_button_) {
this->save_mem_position(4);
this->request_settings();
}
}
}
#endif
#ifdef USE_NUMBER
void MaidesiteDeskComponent::number_control(number::Number* object, float value)
{
void MaidesiteDeskComponent::number_control(number::Number* object, float value) {
if (object == height_abs_number_)
this->goto_height(value);
else if (object == height_pct_number_)
if (limit_max_ > 0 && limit_max_ > limit_min_)
this->goto_height((limit_max_ - limit_min_) * value / 100 + limit_min_);
}
}
#endif
} // namespace maidesite_desk
} // namespace maidesite_desk
} // namespace esphome

View File

@ -17,14 +17,10 @@
#define UART_LOG_CHUNK_SIZE 153
namespace esphome {
namespace maidesite_desk {
namespace esphome
{
namespace maidesite_desk
{
class MaidesiteDeskComponent : public Component, public uart::UARTDevice
{
class MaidesiteDeskComponent : public Component, public uart::UARTDevice {
public:
#ifdef USE_SENSOR
SUB_SENSOR(unit);
@ -64,12 +60,16 @@ namespace esphome
MaidesiteDeskComponent() = default;
// base class functions
float get_setup_priority() const override { return setup_priority::LATE; }
float get_setup_priority() const override {
return setup_priority::LATE;
}
void dump_config() override;
void setup() override;
void loop() override;
// option functions
void set_log_uart_msg(bool enable) { this->log_uart_msg_ = enable; }
void set_log_uart_msg(bool enable) {
this->log_uart_msg_ = enable;
}
// functions to use in lambdas
void request_physical_limits();
void request_limits();
@ -96,19 +96,19 @@ namespace esphome
void log_uart_hex(std::string prefix, std::vector<uint8_t> bytes, uint8_t separator);
// options variables
bool log_uart_msg_ { false };
bool log_uart_msg_{false};
// uart message variables
std::vector<uint8_t> request_message_;
uint8_t response_payload_length_;
uint8_t request_payload_length_;
bool response_receiving_ { false };
bool request_receiving_ { false };
bool response_receiving_{false};
bool request_receiving_{false};
// sensor variables
float current_height_ = 0;
float limit_min_ = 0;
float limit_max_ = 0;
float physical_min_ = 0;
float physical_max_ = 0;
};
} // namespace maidesite_desk
};
} // namespace maidesite_desk
} // namespace esphome

View File

@ -7,7 +7,6 @@ from esphome.const import (
)
from .. import CONF_MAIDESITE_DESK_ID, MaidesiteDeskComponent, maidesite_desk_ns
CONF_HEIGHT_ABS = "height_abs"
CONF_HEIGHT_PCT = "height_pct"
@ -17,16 +16,25 @@ TYPES = [
]
CONF_NUMBERS = [
[ 0, 120, .2, ],
[ 0, 100, .1, ],
[
0,
120,
0.2,
],
[
0,
100,
0.1,
],
]
MaidesiteDeskNumber = maidesite_desk_ns.class_("MaidesiteDeskNumber", number.Number, cg.Component)
MaidesiteDeskNumber = maidesite_desk_ns.class_(
"MaidesiteDeskNumber", number.Number, cg.Component
)
CONFIG_SCHEMA = cv.Schema(
{
cv.GenerateID(CONF_MAIDESITE_DESK_ID): cv.use_id(MaidesiteDeskComponent),
cv.Optional(CONF_HEIGHT_ABS): number.number_schema(
MaidesiteDeskNumber,
unit_of_measurement=UNIT_CENTIMETER,
@ -38,6 +46,7 @@ CONFIG_SCHEMA = cv.Schema(
}
).extend(cv.COMPONENT_SCHEMA)
async def to_code(config):
hub = await cg.get_variable(config[CONF_MAIDESITE_DESK_ID])
for index, key in enumerate(TYPES):
@ -46,7 +55,7 @@ async def to_code(config):
child_config,
min_value=CONF_NUMBERS[index][0],
max_value=CONF_NUMBERS[index][1],
step=CONF_NUMBERS[index][2]
step=CONF_NUMBERS[index][2],
)
await cg.register_component(var, child_config)
await cg.register_parented(var, config[CONF_MAIDESITE_DESK_ID])

View File

@ -1,23 +1,18 @@
#include "maidesite_desk_number.h"
#include "esphome/core/log.h"
namespace esphome {
namespace maidesite_desk {
static const char* const TAG = "maidesite_desk.number";
namespace esphome
{
namespace maidesite_desk
{
static const char *const TAG = "maidesite_desk.number";
void MaidesiteDeskNumber::dump_config()
{
void MaidesiteDeskNumber::dump_config() {
LOG_NUMBER("", "Maidesite Desk Number", this);
delay(10);
}
}
void MaidesiteDeskNumber::control(float value)
{
void MaidesiteDeskNumber::control(float value) {
this->publish_state(value);
this->parent_->number_control(this, value);
}
} // namespace maidesite_desk
}
} // namespace maidesite_desk
} // namespace esphome

View File

@ -3,21 +3,19 @@
#include "esphome/core/component.h"
#include "../maidesite_desk.h"
namespace esphome
{
namespace maidesite_desk
{
class MaidesiteDeskNumber : public number::Number, public Component, public Parented<MaidesiteDeskComponent>
{
namespace esphome {
namespace maidesite_desk {
class MaidesiteDeskNumber : public number::Number, public Component, public Parented<MaidesiteDeskComponent> {
public:
MaidesiteDeskNumber() = default;
void dump_config() override;
void set_id(int id) { this->id_ = id; }
void set_id(int id) {
this->id_ = id;
}
protected:
void control(float value) override;
int id_;
};
} // namespace maidesite_desk
};
} // namespace maidesite_desk
} // namespace esphome

View File

@ -29,14 +29,14 @@ TYPES = [
CONF_POSITION_M4,
]
MaidesiteDeskSensor = maidesite_desk_ns.class_("MaidesiteDeskSensor", sensor.Sensor, cg.Component)
MaidesiteDeskSensor = maidesite_desk_ns.class_(
"MaidesiteDeskSensor", sensor.Sensor, cg.Component
)
CONFIG_SCHEMA = cv.Schema(
{
cv.GenerateID(CONF_MAIDESITE_DESK_ID): cv.use_id(MaidesiteDeskComponent),
cv.Optional(CONF_UNIT): sensor.sensor_schema(),
cv.Optional(CONF_HEIGHT_ABS): sensor.sensor_schema(
MaidesiteDeskSensor,
accuracy_decimals=2,
@ -80,6 +80,7 @@ CONFIG_SCHEMA = cv.Schema(
}
).extend(cv.COMPONENT_SCHEMA)
async def to_code(config):
hub = await cg.get_variable(config[CONF_MAIDESITE_DESK_ID])
for key in TYPES:

View File

@ -1,17 +1,13 @@
#include "maidesite_desk_sensor.h"
#include "esphome/core/log.h"
namespace esphome {
namespace maidesite_desk {
static const char* const TAG = "maidesite_desk.sensor";
namespace esphome
{
namespace maidesite_desk
{
static const char *const TAG = "maidesite_desk.sensor";
void MaidesiteDeskSensor::dump_config()
{
void MaidesiteDeskSensor::dump_config() {
LOG_SENSOR("", "Maidesite Desk Sensor", this);
delay(10);
}
} // namespace maidesite_desk
}
} // namespace maidesite_desk
} // namespace esphome

View File

@ -3,16 +3,12 @@
#include "esphome/core/component.h"
#include "../maidesite_desk.h"
namespace esphome
{
namespace maidesite_desk
{
class MaidesiteDeskSensor : public sensor::Sensor, public Component, public Parented<MaidesiteDeskComponent>
{
namespace esphome {
namespace maidesite_desk {
class MaidesiteDeskSensor : public sensor::Sensor, public Component, public Parented<MaidesiteDeskComponent> {
public:
MaidesiteDeskSensor() = default;
void dump_config() override;
};
} // namespace maidesite_desk
};
} // namespace maidesite_desk
} // namespace esphome