ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
modbus_output.h
Go to the documentation of this file.
1#pragma once
2
5
6#include <vector>
7
9
10class ModbusFloatOutput final : public output::FloatOutput, public SensorItem, public WriterEntity {
11 public:
12 ModbusFloatOutput(uint16_t start_address, uint8_t offset, SensorValueType value_type) {
14 // A byte offset folds into the address as whole registers; odd offsets are rejected at validation.
15 this->set_address(start_address + offset / 2);
17 this->bitmask = 0xFFFFFFFF;
18 this->sensor_value_type = value_type;
19 }
20
21 void set_parent(ModbusController *parent) { this->set_controller_(parent); }
22 void set_write_multiply(float factor) { this->multiply_by_ = factor; }
23 // Do nothing
24 void parse_and_publish(std::span<const uint8_t> data) override {};
25
26 using write_transform_func_t = optional<float> (*)(ModbusFloatOutput *, float, modbus::RegisterValues &);
28 void set_use_write_mutiple(bool use_write_multiple) { this->use_write_multiple_ = use_write_multiple; }
29
30 protected:
31 void write_state(float value) override;
32 optional<write_transform_func_t> write_transform_func_{nullopt};
33
34 float multiply_by_{1.0};
36};
37
38class ModbusBinaryOutput final : public output::BinaryOutput, public SensorItem, public WriterEntity {
39 public:
42 // A coil offset is a coil count; fold it into the address.
43 this->set_address(start_address + offset);
44 this->bitmask = 0xFFFFFFFF;
47 }
48
49 void set_parent(ModbusController *parent) { this->set_controller_(parent); }
50 // Do nothing
51 void parse_and_publish(std::span<const uint8_t> data) override {};
52
55 void set_use_write_mutiple(bool use_write_multiple) { this->use_write_multiple_ = use_write_multiple; }
56
57 protected:
58 void write_state(bool state) override;
59 optional<write_transform_func_t> write_transform_func_{nullopt};
60
62};
63
64} // namespace esphome::modbus_controller
Minimal static vector - saves memory by avoiding std::vector overhead.
Definition helpers.h:304
void set_use_write_mutiple(bool use_write_multiple)
void parse_and_publish(std::span< const uint8_t > data) override
optional< bool >(*)(ModbusBinaryOutput *, bool, modbus::helpers::PduBuffer &) write_transform_func_t
void set_parent(ModbusController *parent)
optional< write_transform_func_t > write_transform_func_
void set_write_template(write_transform_func_t f)
ModbusBinaryOutput(uint16_t start_address, uint8_t offset)
ModbusFloatOutput(uint16_t start_address, uint8_t offset, SensorValueType value_type)
void write_state(float value) override
Write a value to the device.
optional< write_transform_func_t > write_transform_func_
void set_write_template(write_transform_func_t f)
void parse_and_publish(std::span< const uint8_t > data) override
void set_use_write_mutiple(bool use_write_multiple)
void set_parent(ModbusController *parent)
optional< float >(*)(ModbusFloatOutput *, float, modbus::RegisterValues &) write_transform_func_t
void set_address(uint16_t address)
Sets the configured address, and points the range base at it.
void set_offset_from_start_address(uint8_t offset)
Records the offset as configured, and seeds the resolved position with it.
uint8_t offset
Position of this sensor's data within its range's response - a byte offset for registers,...
Gives a writer entity the write API of the WriterDevice it owns.
void set_controller_(ModbusController *controller)
Base class for all output components that can output a variable level, like PWM.
bool state
Definition fan.h:2
const std::vector< uint8_t > & data
uint32_t value
Definition hal.cpp:41