|
| | ModbusSensor (ModbusRegisterType register_type, uint16_t start_address, uint8_t offset, uint32_t bitmask, SensorValueType value_type, int register_count, uint16_t skip_updates, bool force_new_range) |
| |
| void | parse_and_publish (const std::vector< uint8_t > &data) override |
| |
| void | dump_config () override |
| |
| void | set_template (transform_func_t &&f) |
| |
| virtual void | setup () |
| | Where the component's initialization should happen.
|
| |
| virtual void | loop () |
| | This method will be called repeatedly.
|
| |
| virtual float | get_setup_priority () const |
| | priority of setup().
|
| |
| float | get_actual_setup_priority () const |
| |
| void | set_setup_priority (float priority) |
| |
| virtual float | get_loop_priority () const |
| | priority of loop().
|
| |
| void | call () |
| |
| virtual void | on_shutdown () |
| |
| virtual void | on_safe_shutdown () |
| |
| virtual bool | teardown () |
| | Called during teardown to allow component to gracefully finish operations.
|
| |
| virtual void | on_powerdown () |
| | Called after teardown is complete to power down hardware.
|
| |
| uint8_t | get_component_state () const |
| |
| void | reset_to_construction_state () |
| | Reset this component back to the construction state to allow setup to run again.
|
| |
| bool | is_in_loop_state () const |
| | Check if this component has completed setup and is in the loop state.
|
| |
| virtual void | mark_failed () |
| | Mark this component as failed.
|
| |
| void | mark_failed (const char *message) |
| |
| void | disable_loop () |
| | Disable this component's loop.
|
| |
| void | enable_loop () |
| | Enable this component's loop.
|
| |
| void | enable_loop_soon_any_context () |
| | Thread and ISR-safe version of enable_loop() that can be called from any context.
|
| |
| 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=nullptr) |
| |
| void | status_set_warning (const LogString *message) |
| |
| void | status_set_error (const char *message=nullptr) |
| |
| 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 LogString *source) |
| | Set where this component was loaded from for some debug messages.
|
| |
| const LogString * | get_component_log_str () const |
| | Get the integration where this component was declared as a LogString for logging.
|
| |
| bool | should_warn_of_blocking (uint32_t blocking_time) |
| |
| | Sensor () |
| |
| int8_t | get_accuracy_decimals () |
| | Get the accuracy in decimals, using the manual override if set.
|
| |
| void | set_accuracy_decimals (int8_t accuracy_decimals) |
| | Manually set the accuracy in decimals.
|
| |
| StateClass | get_state_class () |
| | Get the state class, using the manual override if set.
|
| |
| void | set_state_class (StateClass state_class) |
| | Manually set the state class.
|
| |
| bool | get_force_update () const |
| | Get whether force update mode is enabled.
|
| |
| void | set_force_update (bool force_update) |
| | Set force update mode.
|
| |
| void | add_filter (Filter *filter) |
| | Add a filter to the filter chain. Will be appended to the back.
|
| |
| void | add_filters (const std::vector< Filter * > &filters) |
| | Add a list of vectors to the back of the filter chain.
|
| |
| void | set_filters (const std::vector< Filter * > &filters) |
| | Clear the filters and replace them by filters.
|
| |
| void | clear_filters () |
| | Clear the entire filter chain.
|
| |
| float | get_state () const |
| | Getter-syntax for .state.
|
| |
| float | get_raw_state () const |
| | Getter-syntax for .raw_state.
|
| |
| void | publish_state (float state) |
| | Publish a new state to the front-end.
|
| |
| void | add_on_state_callback (std::function< void(float)> &&callback) |
| | Add a callback that will be called every time a filtered value arrives.
|
| |
| void | add_on_raw_state_callback (std::function< void(float)> &&callback) |
| | Add a callback that will be called every time the sensor sends a raw value.
|
| |
| void | internal_send_state_to_frontend (float state) |
| |
| 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) |
| |
| StringRef | get_icon_ref () const |
| |
| uint32_t | get_device_id () const |
| |
| void | set_device (Device *device) |
| |
| bool | has_state () const |
| |
| void | set_has_state (bool state) |
| |
| uint32_t | get_preference_hash () |
| | Get a unique hash for storing preferences/settings for this entity.
|
| |
| std::string | get_device_class () |
| | Get the device class, using the manual override if set.
|
| |
| void | set_device_class (const char *device_class) |
| | Manually set the device class.
|
| |
| StringRef | get_device_class_ref () const |
| | Get the device class as StringRef.
|
| |
| std::string | get_unit_of_measurement () |
| | Get the unit of measurement, using the manual override if set.
|
| |
| void | set_unit_of_measurement (const char *unit_of_measurement) |
| | Manually set the unit of measurement.
|
| |
| StringRef | get_unit_of_measurement_ref () const |
| | Get the unit of measurement as StringRef.
|
| |
| 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) |
| |
|
| float | state |
| | This member variable stores the last state that has passed through all filters.
|
| |
| float | raw_state |
| | This member variable stores the current raw state of the sensor, without any filters applied.
|
| |
| 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_component_state_ (uint8_t state) |
| | Helper to set component state (clears state bits and sets new state)
|
| |
| void | set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a unique name.
|
| |
| void | set_interval (const char *name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a const char* name.
|
| |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| |
| bool | cancel_interval (const std::string &name) |
| | Cancel an interval function.
|
| |
| bool | cancel_interval (const char *name) |
| |
| 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.
|
| |
| 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.
|
| |
| void | set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a unique name.
|
| |
| void | set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a const char* name.
|
| |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| |
| bool | cancel_timeout (const std::string &name) |
| | Cancel a timeout function.
|
| |
| bool | cancel_timeout (const char *name) |
| |
| void | defer (const std::string &name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| void | defer (const char *name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call with a const char* name.
|
| |
| void | defer (std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| bool | cancel_defer (const std::string &name) |
| | Cancel a defer callback using the specified name, name must not be empty.
|
| |
| StringRef | get_object_id_ref_for_api_ () const |
| |
| virtual uint32_t | hash_base () |
| | The hash_base() function has been deprecated.
|
| |
| void | calc_object_id_ () |
| |
| bool | is_object_id_dynamic_ () const |
| | Check if the object_id is dynamic (changes with MAC suffix)
|
| |
Definition at line 12 of file modbus_sensor.h.
Public Member Functions inherited from esphome::Component
1.12.0