mirror of
https://github.com/esphome/esphome.git
synced 2024-09-29 04:18:20 +02:00
867fecd157
* Update light state when transformer has finished * Revert writing direct to output * Correct handling of zero-length light transformers * Allow transformers to handle zero-length transitions, and check more boundary conditions when transitioning back to start state * Removed log.h * Fixed race condition between LightFlashTransformer.apply() and is_finished() * clang-format * Step progress from 0.0f to 1.0f at t=start_time for zero-length transforms to avoid divide-by-zero
60 lines
1.8 KiB
C++
60 lines
1.8 KiB
C++
#pragma once
|
|
|
|
#include "esphome/core/helpers.h"
|
|
#include "esphome/core/hal.h"
|
|
#include "light_color_values.h"
|
|
|
|
namespace esphome {
|
|
namespace light {
|
|
|
|
/// Base class for all light color transformers, such as transitions or flashes.
|
|
class LightTransformer {
|
|
public:
|
|
virtual ~LightTransformer() = default;
|
|
|
|
void setup(const LightColorValues &start_values, const LightColorValues &target_values, uint32_t length) {
|
|
this->start_time_ = millis();
|
|
this->length_ = length;
|
|
this->start_values_ = start_values;
|
|
this->target_values_ = target_values;
|
|
this->start();
|
|
}
|
|
|
|
/// Indicates whether this transformation is finished.
|
|
virtual bool is_finished() { return this->get_progress_() >= 1.0f; }
|
|
|
|
/// This will be called before the transition is started.
|
|
virtual void start() {}
|
|
|
|
/// This will be called while the transformer is active to apply the transition to the light. Can either write to the
|
|
/// light directly, or return LightColorValues that will be applied.
|
|
virtual optional<LightColorValues> apply() = 0;
|
|
|
|
/// This will be called after transition is finished.
|
|
virtual void stop() {}
|
|
|
|
const LightColorValues &get_start_values() const { return this->start_values_; }
|
|
|
|
const LightColorValues &get_target_values() const { return this->target_values_; }
|
|
|
|
protected:
|
|
/// The progress of this transition, on a scale of 0 to 1.
|
|
float get_progress_() {
|
|
uint32_t now = esphome::millis();
|
|
if (now < this->start_time_)
|
|
return 0.0f;
|
|
if (now >= this->start_time_ + this->length_)
|
|
return 1.0f;
|
|
|
|
return clamp((now - this->start_time_) / float(this->length_), 0.0f, 1.0f);
|
|
}
|
|
|
|
uint32_t start_time_;
|
|
uint32_t length_;
|
|
LightColorValues start_values_;
|
|
LightColorValues target_values_;
|
|
};
|
|
|
|
} // namespace light
|
|
} // namespace esphome
|