mirror of
https://github.com/esphome/esphome.git
synced 2025-03-25 03:58:23 +00:00
63 lines
1.6 KiB
C++
63 lines
1.6 KiB
C++
#pragma once
|
|
|
|
#include "esphome/core/component.h"
|
|
#include "esphome/core/entity_base.h"
|
|
#include "esphome/core/helpers.h"
|
|
#include "number_call.h"
|
|
#include "number_traits.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()); \
|
|
} \
|
|
if (!(obj)->traits.get_unit_of_measurement().empty()) { \
|
|
ESP_LOGCONFIG(TAG, "%s Unit of Measurement: '%s'", prefix, (obj)->traits.get_unit_of_measurement().c_str()); \
|
|
} \
|
|
}
|
|
|
|
class Number;
|
|
|
|
/** 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 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
|