mirror of
https://github.com/esphome/esphome.git
synced 2024-12-02 11:44:13 +01:00
6682c43dfa
## Description: Move esphome-core codebase into esphome (and a bunch of other refactors). See https://github.com/esphome/feature-requests/issues/97 Yes this is a shit ton of work and no there's no way to automate it :( But it will be worth it 👍 Progress: - Core support (file copy etc): 80% - Base Abstractions (light, switch): ~50% - Integrations: ~10% - Working? Yes, (but only with ported components). Other refactors: - Moves all codegen related stuff into a single class: `esphome.codegen` (imported as `cg`) - Rework coroutine syntax - Move from `component/platform.py` to `domain/component.py` structure as with HA - Move all defaults out of C++ and into config validation. - Remove `make_...` helpers from Application class. Reason: Merge conflicts with every single new integration. - Pointer Variables are stored globally instead of locally in setup(). Reason: stack size limit. Future work: - Rework const.py - Move all `CONF_...` into a conf class (usage `conf.UPDATE_INTERVAL` vs `CONF_UPDATE_INTERVAL`). Reason: Less convoluted import block - Enable loading from `custom_components` folder. **Related issue (if applicable):** https://github.com/esphome/feature-requests/issues/97 **Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):** esphome/esphome-docs#<esphome-docs PR number goes here> ## Checklist: - [ ] The code change is tested and works locally. - [ ] Tests have been added to verify that the new code works (under `tests/` folder). If user exposed functionality or configuration variables are added/changed: - [ ] Documentation added/updated in [esphomedocs](https://github.com/OttoWinter/esphomedocs).
60 lines
1.7 KiB
C++
60 lines
1.7 KiB
C++
#pragma once
|
|
|
|
#include "esphome/core/defines.h"
|
|
|
|
#ifdef USE_SENSOR
|
|
|
|
#include "esphome/components/sensor/sensor.h"
|
|
#include "mqtt_component.h"
|
|
|
|
namespace esphome {
|
|
namespace mqtt {
|
|
|
|
class MQTTSensorComponent : public mqtt::MQTTComponent {
|
|
public:
|
|
/** Construct this MQTTSensorComponent instance with the provided friendly_name and sensor
|
|
*
|
|
* Note the sensor is never stored and is only used for initializing some values of this class.
|
|
* If sensor is nullptr, then automatic initialization of these fields is disabled.
|
|
*
|
|
* @param sensor The sensor, this can be null to disable automatic setup.
|
|
*/
|
|
explicit MQTTSensorComponent(sensor::Sensor *sensor);
|
|
|
|
/// Setup an expiry, 0 disables it
|
|
void set_expire_after(uint32_t expire_after);
|
|
/// Disable Home Assistant value expiry.
|
|
void disable_expire_after();
|
|
|
|
void send_discovery(JsonObject &root, mqtt::SendDiscoveryConfig &config) override;
|
|
|
|
// ========== INTERNAL METHODS ==========
|
|
// (In most use cases you won't need these)
|
|
/// Override setup.
|
|
void setup() override;
|
|
|
|
void dump_config() override;
|
|
|
|
/// Get the expire_after in milliseconds used for Home Assistant discovery, first checks override.
|
|
uint32_t get_expire_after() const;
|
|
|
|
bool publish_state(float value);
|
|
bool send_initial_state() override;
|
|
bool is_internal() override;
|
|
|
|
protected:
|
|
/// Override for MQTTComponent, returns "sensor".
|
|
std::string component_type() const override;
|
|
|
|
std::string friendly_name() const override;
|
|
|
|
std::string unique_id() override;
|
|
|
|
sensor::Sensor *sensor_;
|
|
optional<uint32_t> expire_after_; // Override the expire after advertised to Home Assistant
|
|
};
|
|
|
|
} // namespace mqtt
|
|
} // namespace esphome
|
|
|
|
#endif
|