mirror of
https://github.com/esphome/esphome.git
synced 2025-02-24 13:58:14 +00:00
471b82f727
* Renamed Nameable to EntityBase (cpp) * Renamed NAMEABLE_SCHEMA to ENTITY_BASE_SCHEMA (Python) * Renamed cg.Nameable to cg.EntityBase (Python) * Remove redundant use of CONF_NAME from esp32_touch * Remove redundant use of CONF_NAME from mcp3008 * Updated test * Moved EntityBase from Component.h and Component.cpp * Added icon property to EntityBase * Added CONF_ICON to ENTITY_BASE_SCHEMA and added setup_entity function to cpp_helpers * Added MQTT component getters for icon and disabled_by_default * Lint * Removed icon field from MQTT components * Code generation now uses setup_entity to setENTITY_BASE_SCHEMA fields * Removed unused import * Added cstdint include * Optimisation: don't set icon if it is empty * Remove icon from NumberTraits and SelectTraits * Removed unused import * Integration and Total Daily Energy sensors now inherit icons from their parents during code generation * Minor comment correction * Removed redundant icon-handling code from sensor, switch, and text_sensor * Update esphome/components/tsl2591/tsl2591.h Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl> * Added icon property to binary sensor, climate, cover, and fan component tests * Added icons for Binary Sensor, Climate, Cover, Fan, and Light to API * Consolidated EntityBase fields in MQTT components Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl>
90 lines
2.2 KiB
C++
90 lines
2.2 KiB
C++
#pragma once
|
|
|
|
#include "esphome/core/component.h"
|
|
#include "esphome/core/entity_base.h"
|
|
#include "esphome/core/helpers.h"
|
|
|
|
namespace esphome {
|
|
namespace number {
|
|
|
|
#define LOG_NUMBER(prefix, type, obj) \
|
|
if ((obj) != nullptr) { \
|
|
ESP_LOGCONFIG(TAG, "%s%s '%s'", prefix, LOG_STR_LITERAL(type), (obj)->get_name().c_str()); \
|
|
if (!(obj)->get_icon().empty()) { \
|
|
ESP_LOGCONFIG(TAG, "%s Icon: '%s'", prefix, (obj)->get_icon().c_str()); \
|
|
} \
|
|
}
|
|
|
|
class Number;
|
|
|
|
class NumberCall {
|
|
public:
|
|
explicit NumberCall(Number *parent) : parent_(parent) {}
|
|
void perform();
|
|
|
|
NumberCall &set_value(float value) {
|
|
value_ = value;
|
|
return *this;
|
|
}
|
|
const optional<float> &get_value() const { return value_; }
|
|
|
|
protected:
|
|
Number *const parent_;
|
|
optional<float> value_;
|
|
};
|
|
|
|
class NumberTraits {
|
|
public:
|
|
void set_min_value(float min_value) { min_value_ = min_value; }
|
|
float get_min_value() const { return min_value_; }
|
|
void set_max_value(float max_value) { max_value_ = max_value; }
|
|
float get_max_value() const { return max_value_; }
|
|
void set_step(float step) { step_ = step; }
|
|
float get_step() const { return step_; }
|
|
|
|
protected:
|
|
float min_value_ = NAN;
|
|
float max_value_ = NAN;
|
|
float step_ = NAN;
|
|
};
|
|
|
|
/** Base-class for all numbers.
|
|
*
|
|
* A number can use publish_state to send out a new value.
|
|
*/
|
|
class Number : public EntityBase {
|
|
public:
|
|
float state;
|
|
|
|
void publish_state(float state);
|
|
|
|
NumberCall make_call() { return NumberCall(this); }
|
|
void set(float value) { make_call().set_value(value).perform(); }
|
|
|
|
void add_on_state_callback(std::function<void(float)> &&callback);
|
|
|
|
NumberTraits traits;
|
|
|
|
/// Return whether this number has gotten a full state yet.
|
|
bool has_state() const { return has_state_; }
|
|
|
|
protected:
|
|
friend class NumberCall;
|
|
|
|
/** Set the value of the number, this is a virtual method that each number integration must implement.
|
|
*
|
|
* This method is called by the NumberCall.
|
|
*
|
|
* @param value The value as validated by the NumberCall.
|
|
*/
|
|
virtual void control(float value) = 0;
|
|
|
|
uint32_t hash_base() override;
|
|
|
|
CallbackManager<void(float)> state_callback_;
|
|
bool has_state_{false};
|
|
};
|
|
|
|
} // namespace number
|
|
} // namespace esphome
|