esphome/esphome/components/power_supply/power_supply.h
Otto Winter f811b1157c
Updates for 1.13 (#546)
* Update CI matcher

* Check Executable bit

* Quicklint

* Updates

* Allow pm1.0 and pm10.0 for PMS5003ST

Fixes https://github.com/esphome/feature-requests/issues/225

* PowerSupplyRequester

* Lint

* Include debug data in generated main.cpp

* Updates

* Auto-select bit_depth

* Updates
2019-05-12 23:04:36 +02:00

64 lines
1.6 KiB
C++

#pragma once
#include "esphome/core/component.h"
#include "esphome/core/esphal.h"
namespace esphome {
namespace power_supply {
class PowerSupply : public Component {
public:
void set_pin(GPIOPin *pin) { pin_ = pin; }
void set_enable_time(uint32_t enable_time) { enable_time_ = enable_time; }
void set_keep_on_time(uint32_t keep_on_time) { keep_on_time_ = keep_on_time; }
/// Is this power supply currently on?
bool is_enabled() const;
/// Request high power mode. Use unrequest_high_power() to remove this request.
void request_high_power();
/// Un-request high power mode.
void unrequest_high_power();
// ========== INTERNAL METHODS ==========
// (In most use cases you won't need these)
/// Register callbacks.
void setup() override;
void dump_config() override;
/// Hardware setup priority (+1).
float get_setup_priority() const override;
void on_shutdown() override;
protected:
GPIOPin *pin_;
bool enabled_{false};
uint32_t enable_time_;
uint32_t keep_on_time_;
int16_t active_requests_{0}; // use signed integer to make catching negative requests easier.
};
class PowerSupplyRequester {
public:
void set_parent(PowerSupply *parent) { parent_ = parent; }
void request() {
if (!this->requested_ && this->parent_ != nullptr) {
this->parent_->request_high_power();
this->requested_ = true;
}
}
void unrequest() {
if (this->requested_ && this->parent_ != nullptr) {
this->parent_->unrequest_high_power();
this->requested_ = false;
}
}
protected:
PowerSupply *parent_{nullptr};
bool requested_{false};
};
} // namespace power_supply
} // namespace esphome