ESPHome  2024.6.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
esphome::modbus_controller::ModbusNumber Class Reference

#include <modbus_number.h>

Inheritance diagram for esphome::modbus_controller::ModbusNumber:
esphome::number::Number esphome::Component esphome::modbus_controller::SensorItem esphome::EntityBase

Public Types

using transform_func_t = std::function< optional< float >(ModbusNumber *, float, const std::vector< uint8_t > &)>
using write_transform_func_t = std::function< optional< float >(ModbusNumber *, float, std::vector< uint16_t > &)>

Public Member Functions

 ModbusNumber (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 dump_config () override
void parse_and_publish (const std::vector< uint8_t > &data) override
float get_setup_priority () const override
void set_parent (ModbusController *parent)
void set_write_multiply (float factor)
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)
- Public Member Functions inherited from esphome::number::Number
void publish_state (float state)
NumberCall make_call ()
void add_on_state_callback (std::function< void(float)> &&callback)
bool has_state () const
 Return whether this number has gotten a full state yet. More...
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_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::Component
virtual void setup ()
 Where the component's initialization should happen. More...
virtual void loop ()
 This method will be called repeatedly. 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::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 Member Functions

void control (float value) override
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
void calc_object_id_ ()
- 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 Attributes

optional< transform_func_ttransform_func_
optional< write_transform_func_twrite_transform_func_
float multiply_by_ {1.0}
bool use_write_multiple_ {false}
- Protected Attributes inherited from esphome::number::Number
CallbackManager< void(float)> 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}
- 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}

Additional Inherited Members

- Data Fields inherited from esphome::number::Number
float state
NumberTraits traits
- Data Fields inherited from esphome::modbus_controller::SensorItem
ModbusRegisterType register_type
SensorValueType sensor_value_type
uint16_t start_address
uint32_t bitmask
uint8_t offset
uint8_t register_count
uint8_t response_bytes {0}
uint16_t skip_updates
std::vector< uint8_t > custom_data {}
bool force_new_range {false}

Detailed Description

Definition at line 14 of file modbus_number.h.

Member Typedef Documentation

◆ transform_func_t

using esphome::modbus_controller::ModbusNumber::transform_func_t = std::function<optional<float>(ModbusNumber *, float, const std::vector<uint8_t> &)>

Definition at line 34 of file modbus_number.h.

◆ write_transform_func_t

using esphome::modbus_controller::ModbusNumber::write_transform_func_t = std::function<optional<float>(ModbusNumber *, float, std::vector<uint16_t> &)>

Definition at line 35 of file modbus_number.h.

Constructor & Destructor Documentation

◆ ModbusNumber()

esphome::modbus_controller::ModbusNumber::ModbusNumber ( 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 

Definition at line 16 of file modbus_number.h.

Member Function Documentation

◆ control()

void esphome::modbus_controller::ModbusNumber::control ( float  value)

Implements esphome::number::Number.

Definition at line 28 of file modbus_number.cpp.

◆ dump_config()

void esphome::modbus_controller::ModbusNumber::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 83 of file modbus_number.cpp.

◆ get_setup_priority()

float esphome::modbus_controller::ModbusNumber::get_setup_priority ( ) const

Reimplemented from esphome::Component.

Definition at line 30 of file modbus_number.h.

◆ parse_and_publish()

void esphome::modbus_controller::ModbusNumber::parse_and_publish ( const std::vector< uint8_t > &  data)

Implements esphome::modbus_controller::SensorItem.

Definition at line 10 of file modbus_number.cpp.

◆ set_parent()

void esphome::modbus_controller::ModbusNumber::set_parent ( ModbusController parent)

Definition at line 31 of file modbus_number.h.

◆ set_template()

void esphome::modbus_controller::ModbusNumber::set_template ( transform_func_t &&  f)

Definition at line 36 of file modbus_number.h.

◆ set_use_write_mutiple()

void esphome::modbus_controller::ModbusNumber::set_use_write_mutiple ( bool  use_write_multiple)

Definition at line 38 of file modbus_number.h.

◆ set_write_multiply()

void esphome::modbus_controller::ModbusNumber::set_write_multiply ( float  factor)

Definition at line 32 of file modbus_number.h.

◆ set_write_template()

void esphome::modbus_controller::ModbusNumber::set_write_template ( write_transform_func_t &&  f)

Definition at line 37 of file modbus_number.h.

Field Documentation

◆ multiply_by_

float esphome::modbus_controller::ModbusNumber::multiply_by_ {1.0}

Definition at line 45 of file modbus_number.h.

◆ parent_

ModbusController* esphome::modbus_controller::ModbusNumber::parent_

Definition at line 44 of file modbus_number.h.

◆ transform_func_

optional<transform_func_t> esphome::modbus_controller::ModbusNumber::transform_func_

Definition at line 42 of file modbus_number.h.

◆ use_write_multiple_

bool esphome::modbus_controller::ModbusNumber::use_write_multiple_ {false}

Definition at line 46 of file modbus_number.h.

◆ write_transform_func_

optional<write_transform_func_t> esphome::modbus_controller::ModbusNumber::write_transform_func_

Definition at line 43 of file modbus_number.h.

The documentation for this class was generated from the following files: