key_collector.cpp

Go to the documentation of this file.

#include "key_collector.h"
#include "esphome/core/hal.h"
#include "esphome/core/log.h"
 
namespace esphome::key_collector {
 
ESPHOME_LOG_TAG(TAG, "key_collector");
 
void KeyCollector::loop() {
  if ((this->timeout_ == 0) || this->result_.empty() || (millis() - this->last_key_time_ < this->timeout_))
    return;
  this->timeout_callbacks_.call(this->result_, this->start_key_);
  this->clear();
}
 
void KeyCollector::dump_config() {
#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_CONFIG
  ESP_LOGCONFIG(TAG, "Key Collector:");
  if (this->min_length_ > 0) {
    ESP_LOGCONFIG(TAG, "  min length: %d", this->min_length_);
  }
  if (this->max_length_ > 0) {
    ESP_LOGCONFIG(TAG, "  max length: %d", this->max_length_);
  }
  if (!this->back_keys_.empty()) {
    ESP_LOGCONFIG(TAG, "  erase keys '%s'", this->back_keys_.c_str());
  }
  if (!this->clear_keys_.empty()) {
    ESP_LOGCONFIG(TAG, "  clear keys '%s'", this->clear_keys_.c_str());
  }
  if (!this->start_keys_.empty()) {
    ESP_LOGCONFIG(TAG, "  start keys '%s'", this->start_keys_.c_str());
  }
  if (!this->end_keys_.empty()) {
    ESP_LOGCONFIG(TAG,
                  "  end keys '%s'\n"
                  "  end key is required: %s",
                  this->end_keys_.c_str(), ONOFF(this->end_key_required_));
  }
  if (!this->allowed_keys_.empty()) {
    ESP_LOGCONFIG(TAG, "  allowed keys '%s'", this->allowed_keys_.c_str());
  }
  if (this->timeout_ > 0) {
    ESP_LOGCONFIG(TAG, "  entry timeout: %0.1f", this->timeout_ / 1000.0);
  }
#endif
}
 
void KeyCollector::add_provider(key_provider::KeyProvider *provider) {
  provider->add_on_key_callback([this](uint8_t key) { this->send_key(key); });
}
 
void KeyCollector::set_enabled(bool enabled) {
  this->enabled_ = enabled;
  if (!enabled) {
    this->clear(false);
  }
}
 
void KeyCollector::clear(bool progress_update) {
  auto had_state = !this->result_.empty() || this->start_key_ != 0;
  this->result_.clear();
  this->start_key_ = 0;
  if (progress_update && had_state) {
    this->progress_callbacks_.call(this->result_, 0);
  }
  this->disable_loop();
}
 
void KeyCollector::send_key(uint8_t key) {
  if (!this->enabled_)
    return;
  this->last_key_time_ = millis();
  if (!this->start_keys_.empty() && !this->start_key_) {
    if (this->start_keys_.find(key) != std::string::npos) {
      this->start_key_ = key;
      this->progress_callbacks_.call(this->result_, this->start_key_);
    }
    return;
  }
  if (this->back_keys_.find(key) != std::string::npos) {
    if (!this->result_.empty()) {
      this->result_.pop_back();
      this->progress_callbacks_.call(this->result_, this->start_key_);
    }
    return;
  }
  if (this->clear_keys_.find(key) != std::string::npos) {
    this->clear();
    return;
  }
  if (this->end_keys_.find(key) != std::string::npos) {
    if ((this->min_length_ == 0) || (this->result_.size() >= this->min_length_)) {
      this->result_callbacks_.call(this->result_, this->start_key_, key);
      this->clear();
    }
    return;
  }
  if (!this->allowed_keys_.empty() && this->allowed_keys_.find(key) == std::string::npos)
    return;
  if ((this->max_length_ == 0) || (this->result_.size() < this->max_length_)) {
    if (this->result_.empty())
      this->enable_loop();
    this->result_.push_back(key);
  }
  if ((this->max_length_ > 0) && (this->result_.size() == this->max_length_) && (!this->end_key_required_)) {
    this->result_callbacks_.call(this->result_, this->start_key_, 0);
    this->clear(false);
  }
  this->progress_callbacks_.call(this->result_, this->start_key_);
}
 
}  // namespace esphome::key_collector