ESPHome  2024.10.2
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::mqtt::MQTTPublishJsonAction< Ts > Class Template Reference

#include <mqtt_client.h>

Inheritance diagram for esphome::mqtt::MQTTPublishJsonAction< Ts >:
esphome::Action< Ts... >

Public Member Functions

 MQTTPublishJsonAction (MQTTClientComponent *parent)
 
 TEMPLATABLE_VALUE (std::string, topic) TEMPLATABLE_VALUE(uint8_t
 
qos TEMPLATABLE_VALUE (bool, retain) void set_payload(std
 
void play (Ts... x) override
 
- Public Member Functions inherited from esphome::Action< Ts... >
virtual void play_complex (Ts... x)
 
virtual void stop_complex ()
 
virtual bool is_running ()
 Check if this or any of the following actions are currently running. More...
 
int num_running_total ()
 The total number of actions that are currently running in this plus any of the following actions in the chain. More...
 

Protected Member Functions

void encode_ (Ts... x, JsonObject root)
 
- Protected Member Functions inherited from esphome::Action< Ts... >
void play_next_ (Ts... x)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple, seq< S... >)
 
void play_next_tuple_ (const std::tuple< Ts... > &tuple)
 
virtual void stop ()
 
void stop_next_ ()
 
bool is_running_next_ ()
 

Protected Attributes

std::function< void(Ts..., JsonObject)> payload_
 
MQTTClientComponentparent_
 
- Protected Attributes inherited from esphome::Action< Ts... >
friend ActionList< Ts... >
 
Action< Ts... > * next_
 
int num_running_
 The number of instances of this sequence in the list of actions that is currently being executed. More...
 

Detailed Description

template<typename... Ts>
class esphome::mqtt::MQTTPublishJsonAction< Ts >

Definition at line 385 of file mqtt_client.h.

Constructor & Destructor Documentation

◆ MQTTPublishJsonAction()

template<typename... Ts>
esphome::mqtt::MQTTPublishJsonAction< Ts >::MQTTPublishJsonAction ( MQTTClientComponent parent)
inline

Definition at line 387 of file mqtt_client.h.

Member Function Documentation

◆ encode_()

template<typename... Ts>
void esphome::mqtt::MQTTPublishJsonAction< Ts >::encode_ ( Ts...  x,
JsonObject  root 
)
inlineprotected

Definition at line 403 of file mqtt_client.h.

◆ play()

template<typename... Ts>
void esphome::mqtt::MQTTPublishJsonAction< Ts >::play ( Ts...  x)
inlineoverridevirtual

Implements esphome::Action< Ts... >.

Definition at line 394 of file mqtt_client.h.

◆ TEMPLATABLE_VALUE() [1/2]

template<typename... Ts>
esphome::mqtt::MQTTPublishJsonAction< Ts >::TEMPLATABLE_VALUE ( std::string  ,
topic   
)

◆ TEMPLATABLE_VALUE() [2/2]

template<typename... Ts>
qos esphome::mqtt::MQTTPublishJsonAction< Ts >::TEMPLATABLE_VALUE ( bool  ,
retain   
)
inline

Definition at line 390 of file mqtt_client.h.

Field Documentation

◆ parent_

template<typename... Ts>
MQTTClientComponent* esphome::mqtt::MQTTPublishJsonAction< Ts >::parent_
protected

Definition at line 405 of file mqtt_client.h.

◆ payload_

template<typename... Ts>
std::function<void(Ts..., JsonObject)> esphome::mqtt::MQTTPublishJsonAction< Ts >::payload_
protected

Definition at line 404 of file mqtt_client.h.


The documentation for this class was generated from the following file: