mirror of
https://github.com/Threnklyn/esphome-dev.git
synced 2026-05-23 06:08:30 +02:00
Paul Monigatti
471b82f727
* Renamed Nameable to EntityBase (cpp) * Renamed NAMEABLE_SCHEMA to ENTITY_BASE_SCHEMA (Python) * Renamed cg.Nameable to cg.EntityBase (Python) * Remove redundant use of CONF_NAME from esp32_touch * Remove redundant use of CONF_NAME from mcp3008 * Updated test * Moved EntityBase from Component.h and Component.cpp * Added icon property to EntityBase * Added CONF_ICON to ENTITY_BASE_SCHEMA and added setup_entity function to cpp_helpers * Added MQTT component getters for icon and disabled_by_default * Lint * Removed icon field from MQTT components * Code generation now uses setup_entity to setENTITY_BASE_SCHEMA fields * Removed unused import * Added cstdint include * Optimisation: don't set icon if it is empty * Remove icon from NumberTraits and SelectTraits * Removed unused import * Integration and Total Daily Energy sensors now inherit icons from their parents during code generation * Minor comment correction * Removed redundant icon-handling code from sensor, switch, and text_sensor * Update esphome/components/tsl2591/tsl2591.h Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl> * Added icon property to binary sensor, climate, cover, and fan component tests * Added icons for Binary Sensor, Climate, Cover, Fan, and Light to API * Consolidated EntityBase fields in MQTT components Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl>
60 lines
1.7 KiB
C++
60 lines
1.7 KiB
C++
#pragma once
|
|
|
|
#include "esphome/core/defines.h"
|
|
|
|
#ifdef USE_MQTT
|
|
#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;
|
|
|
|
protected:
|
|
/// Override for MQTTComponent, returns "sensor".
|
|
std::string component_type() const override;
|
|
const EntityBase *get_entity() 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
|
|
#endif // USE_MQTT
|