ESPHome
2024.12.4
|
#include <modbus_switch.h>
Public Types | |
using | transform_func_t = std::function< optional< bool >(ModbusSwitch *, bool, const std::vector< uint8_t > &)> |
using | write_transform_func_t = std::function< optional< bool >(ModbusSwitch *, bool, std::vector< uint8_t > &)> |
Public Member Functions | |
ModbusSwitch (ModbusRegisterType register_type, uint16_t start_address, uint8_t offset, uint32_t bitmask, uint16_t skip_updates, bool force_new_range) | |
void | setup () override |
void | write_state (bool state) override |
void | dump_config () override |
void | set_state (bool state) |
void | parse_and_publish (const std::vector< uint8_t > &data) override |
void | set_parent (ModbusController *parent) |
void | set_template (transform_func_t &&f) |
void | set_write_template (write_transform_func_t &&f) |
void | set_use_write_mutiple (bool use_write_multiple) |
![]() | |
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... | |
![]() | |
Switch () | |
void | publish_state (bool state) |
Publish a state to the front-end from the back-end. More... | |
void | turn_on () |
Turn this switch on. More... | |
void | turn_off () |
Turn this switch off. More... | |
void | toggle () |
Toggle this switch. More... | |
void | set_inverted (bool inverted) |
Set whether the state should be treated as inverted. More... | |
void | add_on_state_callback (std::function< void(bool)> &&callback) |
Set callback for state changes. More... | |
optional< bool > | get_initial_state () |
Returns the initial state of the switch, as persisted previously, or empty if never persisted. More... | |
optional< bool > | get_initial_state_with_restore_mode () |
Returns the initial state of the switch, after applying restore mode rules. More... | |
virtual bool | assumed_state () |
Return whether this switch uses an assumed state - i.e. More... | |
bool | is_inverted () const |
void | set_restore_mode (SwitchRestoreMode restore_mode) |
![]() | |
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) |
![]() | |
std::string | get_device_class () |
Get the device class, using the manual override if set. More... | |
void | set_device_class (const char *device_class) |
Manually set the device class. More... | |
![]() | |
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) |
Additional Inherited Members | |
![]() | |
bool | state |
The current reported state of the binary sensor. More... | |
SwitchRestoreMode | restore_mode {SWITCH_RESTORE_DEFAULT_OFF} |
Indicates whether or not state is to be retrieved from flash and how. More... | |
![]() | |
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} |
![]() | |
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... | |
![]() | |
virtual uint32_t | hash_base () |
The hash_base() function has been deprecated. More... | |
void | calc_object_id_ () |
Definition at line 12 of file modbus_switch.h.
using esphome::modbus_controller::ModbusSwitch::transform_func_t = std::function<optional<bool>(ModbusSwitch *, bool, const std::vector<uint8_t> &)> |
Definition at line 36 of file modbus_switch.h.
using esphome::modbus_controller::ModbusSwitch::write_transform_func_t = std::function<optional<bool>(ModbusSwitch *, bool, std::vector<uint8_t> &)> |
Definition at line 37 of file modbus_switch.h.
|
inline |
Definition at line 14 of file modbus_switch.h.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 20 of file modbus_switch.cpp.
|
overridevirtual |
Implements esphome::modbus_controller::SensorItem.
Definition at line 22 of file modbus_switch.cpp.
|
inline |
Definition at line 34 of file modbus_switch.h.
|
inline |
Definition at line 32 of file modbus_switch.h.
|
inline |
Definition at line 38 of file modbus_switch.h.
|
inline |
Definition at line 40 of file modbus_switch.h.
|
inline |
Definition at line 39 of file modbus_switch.h.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 9 of file modbus_switch.cpp.
|
overridevirtual |
Implements esphome::switch_::Switch.
Definition at line 51 of file modbus_switch.cpp.
|
protected |
Definition at line 43 of file modbus_switch.h.
|
protected |
Definition at line 45 of file modbus_switch.h.
|
protected |
Definition at line 44 of file modbus_switch.h.
|
protected |
Definition at line 46 of file modbus_switch.h.