ESPHome
2024.12.2
|
#include <modbus_select.h>
Public Types | |
using | transform_func_t = std::function< optional< std::string >(ModbusSelect *const, int64_t, const std::vector< uint8_t > &)> |
using | write_transform_func_t = std::function< optional< int64_t >(ModbusSelect *const, const std::string &, int64_t, std::vector< uint16_t > &)> |
Public Member Functions | |
ModbusSelect (SensorValueType sensor_value_type, uint16_t start_address, uint8_t register_count, uint16_t skip_updates, bool force_new_range, std::vector< int64_t > mapping) | |
void | set_parent (ModbusController *const parent) |
void | set_use_write_mutiple (bool use_write_multiple) |
void | set_optimistic (bool optimistic) |
void | set_template (transform_func_t &&f) |
void | set_write_template (write_transform_func_t &&f) |
void | dump_config () override |
void | parse_and_publish (const std::vector< uint8_t > &data) override |
void | control (const std::string &value) override |
Public Member Functions inherited from esphome::Component | |
virtual void | setup () |
Where the component's initialization should happen. More... | |
virtual void | loop () |
This method will be called repeatedly. More... | |
virtual float | get_setup_priority () const |
priority of setup(). More... | |
float | get_actual_setup_priority () const |
void | set_setup_priority (float priority) |
virtual float | get_loop_priority () const |
priority of loop(). More... | |
void | call () |
virtual void | on_shutdown () |
virtual void | on_safe_shutdown () |
uint32_t | get_component_state () const |
virtual void | mark_failed () |
Mark this component as failed. More... | |
bool | is_failed () const |
bool | is_ready () const |
virtual bool | can_proceed () |
bool | status_has_warning () const |
bool | status_has_error () const |
void | status_set_warning (const char *message="unspecified") |
void | status_set_error (const char *message="unspecified") |
void | status_clear_warning () |
void | status_clear_error () |
void | status_momentary_warning (const std::string &name, uint32_t length=5000) |
void | status_momentary_error (const std::string &name, uint32_t length=5000) |
bool | has_overridden_loop () const |
void | set_component_source (const char *source) |
Set where this component was loaded from for some debug messages. More... | |
const char * | get_component_source () const |
Get the integration where this component was declared as a string. More... | |
Public Member Functions inherited from esphome::select::Select | |
void | publish_state (const std::string &state) |
bool | has_state () const |
Return whether this select component has gotten a full state yet. More... | |
SelectCall | make_call () |
Instantiate a SelectCall object to modify this select component's state. More... | |
bool | has_option (const std::string &option) const |
Return whether this select component contains the provided option. More... | |
bool | has_index (size_t index) const |
Return whether this select component contains the provided index offset. More... | |
size_t | size () const |
Return the number of options in this select component. More... | |
optional< size_t > | index_of (const std::string &option) const |
Find the (optional) index offset of the provided option value. More... | |
optional< size_t > | active_index () const |
Return the (optional) index offset of the currently active option. More... | |
optional< std::string > | at (size_t index) const |
Return the (optional) option value at the provided index offset. More... | |
void | add_on_state_callback (std::function< void(std::string, size_t)> &&callback) |
Public Member Functions inherited from esphome::EntityBase | |
const StringRef & | get_name () const |
void | set_name (const char *name) |
bool | has_own_name () const |
std::string | get_object_id () const |
void | set_object_id (const char *object_id) |
uint32_t | get_object_id_hash () |
bool | is_internal () const |
void | set_internal (bool internal) |
bool | is_disabled_by_default () const |
void | set_disabled_by_default (bool disabled_by_default) |
EntityCategory | get_entity_category () const |
void | set_entity_category (EntityCategory entity_category) |
std::string | get_icon () const |
void | set_icon (const char *icon) |
Public Member Functions inherited from esphome::modbus_controller::SensorItem | |
void | set_custom_data (const std::vector< uint8_t > &data) |
virtual size_t | get_register_size () const |
void | set_register_size (uint8_t register_size) |
Protected Attributes | |
std::vector< int64_t > | mapping_ {} |
ModbusController * | parent_ {nullptr} |
bool | use_write_multiple_ {false} |
bool | optimistic_ {false} |
optional< transform_func_t > | transform_func_ {nullopt} |
optional< write_transform_func_t > | write_transform_func_ {nullopt} |
Protected Attributes inherited from esphome::Component | |
uint32_t | component_state_ {0x0000} |
State of this component. More... | |
float | setup_priority_override_ {NAN} |
const char * | component_source_ {nullptr} |
Protected Attributes inherited from esphome::select::Select | |
CallbackManager< void(std::string, size_t)> | state_callback_ |
bool | has_state_ {false} |
Protected Attributes inherited from esphome::EntityBase | |
StringRef | name_ |
const char * | object_id_c_str_ {nullptr} |
const char * | icon_c_str_ {nullptr} |
uint32_t | object_id_hash_ |
bool | has_own_name_ {false} |
bool | internal_ {false} |
bool | disabled_by_default_ {false} |
EntityCategory | entity_category_ {ENTITY_CATEGORY_NONE} |
Additional Inherited Members | |
Data Fields inherited from esphome::select::Select | |
std::string | state |
SelectTraits | traits |
Data Fields inherited from esphome::modbus_controller::SensorItem | |
ModbusRegisterType | register_type {ModbusRegisterType::CUSTOM} |
SensorValueType | sensor_value_type {SensorValueType::RAW} |
uint16_t | start_address {0} |
uint32_t | bitmask {0} |
uint8_t | offset {0} |
uint8_t | register_count {0} |
uint8_t | response_bytes {0} |
uint16_t | skip_updates {0} |
std::vector< uint8_t > | custom_data {} |
bool | force_new_range {false} |
Protected Member Functions inherited from esphome::Component | |
virtual void | call_loop () |
virtual void | call_setup () |
virtual void | call_dump_config () |
void | set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f) |
Set an interval function with a unique name. More... | |
void | set_interval (uint32_t interval, std::function< void()> &&f) |
bool | cancel_interval (const std::string &name) |
Cancel an interval function. More... | |
void | set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f) |
Set an retry function with a unique name. More... | |
void | set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f) |
bool | cancel_retry (const std::string &name) |
Cancel a retry function. More... | |
void | set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f) |
Set a timeout function with a unique name. More... | |
void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
bool | cancel_timeout (const std::string &name) |
Cancel a timeout function. More... | |
void | defer (const std::string &name, std::function< void()> &&f) |
Defer a callback to the next loop() call. More... | |
void | defer (std::function< void()> &&f) |
Defer a callback to the next loop() call. More... | |
bool | cancel_defer (const std::string &name) |
Cancel a defer callback using the specified name, name must not be empty. More... | |
Protected Member Functions inherited from esphome::EntityBase | |
virtual uint32_t | hash_base () |
The hash_base() function has been deprecated. More... | |
void | calc_object_id_ () |
Definition at line 13 of file modbus_select.h.
using esphome::modbus_controller::ModbusSelect::transform_func_t = std::function<optional<std::string>(ModbusSelect *const, int64_t, const std::vector<uint8_t> &)> |
Definition at line 30 of file modbus_select.h.
using esphome::modbus_controller::ModbusSelect::write_transform_func_t = std::function<optional<int64_t>(ModbusSelect *const, const std::string &, int64_t, std::vector<uint16_t> &)> |
Definition at line 32 of file modbus_select.h.
|
inline |
Definition at line 15 of file modbus_select.h.
|
overridevirtual |
Implements esphome::select::Select.
Definition at line 43 of file modbus_select.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 9 of file modbus_select.cpp.
|
overridevirtual |
Implements esphome::modbus_controller::SensorItem.
Definition at line 11 of file modbus_select.cpp.
|
inline |
Definition at line 36 of file modbus_select.h.
|
inline |
Definition at line 34 of file modbus_select.h.
|
inline |
Definition at line 37 of file modbus_select.h.
|
inline |
Definition at line 35 of file modbus_select.h.
|
inline |
Definition at line 38 of file modbus_select.h.
|
protected |
Definition at line 45 of file modbus_select.h.
|
protected |
Definition at line 48 of file modbus_select.h.
|
protected |
Definition at line 46 of file modbus_select.h.
|
protected |
Definition at line 49 of file modbus_select.h.
|
protected |
Definition at line 47 of file modbus_select.h.
|
protected |
Definition at line 50 of file modbus_select.h.