mirror of
https://github.com/esphome/esphome.git
synced 2025-03-21 10:08:15 +00:00
d9caab4108
Co-authored-by: Maurice Makaay <mmakaay1@xs4all.net> Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
45 lines
1.3 KiB
C++
45 lines
1.3 KiB
C++
#pragma once
|
|
|
|
#include "esphome/core/helpers.h"
|
|
|
|
namespace esphome {
|
|
namespace number {
|
|
|
|
enum NumberMode : uint8_t {
|
|
NUMBER_MODE_AUTO = 0,
|
|
NUMBER_MODE_BOX = 1,
|
|
NUMBER_MODE_SLIDER = 2,
|
|
};
|
|
|
|
class NumberTraits {
|
|
public:
|
|
// Set/get the number value boundaries.
|
|
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_; }
|
|
|
|
// Set/get the step size for incrementing or decrementing the number value.
|
|
void set_step(float step) { step_ = step; }
|
|
float get_step() const { return step_; }
|
|
|
|
/// Manually set the unit of measurement.
|
|
void set_unit_of_measurement(const std::string &unit_of_measurement);
|
|
/// Get the unit of measurement, using the manual override if set.
|
|
std::string get_unit_of_measurement();
|
|
|
|
// Set/get the frontend mode.
|
|
void set_mode(NumberMode mode) { this->mode_ = mode; }
|
|
NumberMode get_mode() const { return this->mode_; }
|
|
|
|
protected:
|
|
float min_value_ = NAN;
|
|
float max_value_ = NAN;
|
|
float step_ = NAN;
|
|
optional<std::string> unit_of_measurement_; ///< Unit of measurement override
|
|
NumberMode mode_{NUMBER_MODE_AUTO};
|
|
};
|
|
|
|
} // namespace number
|
|
} // namespace esphome
|