ESPHome  2024.7.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::sim800l::Sim800LComponent Class Reference

#include <sim800l.h>

Inheritance diagram for esphome::sim800l::Sim800LComponent:
esphome::uart::UARTDevice esphome::PollingComponent esphome::Component

Public Member Functions

void update () override
 Retrieve the latest sensor values. This operation takes approximately 16ms. More...
void loop () override
void dump_config () override
void set_registered_binary_sensor (binary_sensor::BinarySensor *registered_binary_sensor)
void set_rssi_sensor (sensor::Sensor *rssi_sensor)
void add_on_sms_received_callback (std::function< void(std::string, std::string)> callback)
void add_on_incoming_call_callback (std::function< void(std::string)> callback)
void add_on_call_connected_callback (std::function< void()> callback)
void add_on_call_disconnected_callback (std::function< void()> callback)
void add_on_ussd_received_callback (std::function< void(std::string)> callback)
void send_sms (const std::string &recipient, const std::string &message)
void send_ussd (const std::string &ussd_code)
void dial (const std::string &recipient)
void connect ()
void disconnect ()
- Public Member Functions inherited from esphome::uart::UARTDevice
 UARTDevice ()=default
 UARTDevice (UARTComponent *parent)
void set_uart_parent (UARTComponent *parent)
void write_byte (uint8_t data)
void write_array (const uint8_t *data, size_t len)
void write_array (const std::vector< uint8_t > &data)
template<size_t N>
void write_array (const std::array< uint8_t, N > &data)
void write_str (const char *str)
bool read_byte (uint8_t *data)
bool peek_byte (uint8_t *data)
bool read_array (uint8_t *data, size_t len)
template<size_t N>
optional< std::array< uint8_t, N > > read_array ()
int available ()
void flush ()
int read ()
size_t write (uint8_t data)
int peek ()
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
void call_setup () override
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
void start_poller ()
void stop_poller ()
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
virtual float get_setup_priority () const
 priority of setup(). More...
float get_actual_setup_priority () const
void set_setup_priority (float priority)
virtual float get_loop_priority () const
 priority of loop(). More...
void call ()
virtual void on_shutdown ()
virtual void on_safe_shutdown ()
uint32_t get_component_state () const
virtual void mark_failed ()
 Mark this component as failed. More...
bool is_failed () const
bool is_ready () const
virtual bool can_proceed ()
bool status_has_warning () const
bool status_has_error () const
void status_set_warning (const char *message="unspecified")
void status_set_error (const char *message="unspecified")
void status_clear_warning ()
void status_clear_error ()
void status_momentary_warning (const std::string &name, uint32_t length=5000)
void status_momentary_error (const std::string &name, uint32_t length=5000)
bool has_overridden_loop () const
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...

Protected Member Functions

void send_cmd_ (const std::string &message)
void parse_cmd_ (std::string message)
void set_registered_ (bool registered)
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
virtual void call_dump_config ()
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
void set_interval (uint32_t interval, std::function< void()> &&f)
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
void set_timeout (uint32_t timeout, std::function< void()> &&f)
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...

Protected Attributes

binary_sensor::BinarySensorregistered_binary_sensor_ {nullptr}
sensor::Sensorrssi_sensor_ {nullptr}
std::string sender_
std::string message_
char read_buffer_ [SIM800L_READ_BUFFER_LENGTH]
size_t read_pos_ {0}
uint8_t parse_index_ {0}
uint8_t watch_dog_ {0}
bool expect_ack_ {false}
sim800l::State state_ {STATE_IDLE}
bool registered_ {false}
std::string recipient_
std::string outgoing_message_
std::string ussd_
bool send_pending_
bool dial_pending_
bool connect_pending_
bool disconnect_pending_
bool send_ussd_pending_
uint8_t call_state_ {6}
CallbackManager< void(std::string, std::string)> sms_received_callback_
CallbackManager< void(std::string)> incoming_call_callback_
CallbackManager< void()> call_connected_callback_
CallbackManager< void()> call_disconnected_callback_
CallbackManager< void(std::string)> ussd_received_callback_
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
float setup_priority_override_ {NAN}
const char * component_source_ {nullptr}

Detailed Description

Definition at line 50 of file sim800l.h.

Member Function Documentation

◆ add_on_call_connected_callback()

void esphome::sim800l::Sim800LComponent::add_on_call_connected_callback ( std::function< void()>  callback)

Definition at line 70 of file sim800l.h.

◆ add_on_call_disconnected_callback()

void esphome::sim800l::Sim800LComponent::add_on_call_disconnected_callback ( std::function< void()>  callback)

Definition at line 73 of file sim800l.h.

◆ add_on_incoming_call_callback()

void esphome::sim800l::Sim800LComponent::add_on_incoming_call_callback ( std::function< void(std::string)>  callback)

Definition at line 67 of file sim800l.h.

◆ add_on_sms_received_callback()

void esphome::sim800l::Sim800LComponent::add_on_sms_received_callback ( std::function< void(std::string, std::string)>  callback)

Definition at line 64 of file sim800l.h.

◆ add_on_ussd_received_callback()

void esphome::sim800l::Sim800LComponent::add_on_ussd_received_callback ( std::function< void(std::string)>  callback)

Definition at line 76 of file sim800l.h.

◆ connect()

void esphome::sim800l::Sim800LComponent::connect ( )

Definition at line 477 of file sim800l.cpp.

◆ dial()

void esphome::sim800l::Sim800LComponent::dial ( const std::string &  recipient)

Definition at line 473 of file sim800l.cpp.

◆ disconnect()

void esphome::sim800l::Sim800LComponent::disconnect ( )

Definition at line 478 of file sim800l.cpp.

◆ dump_config()

void esphome::sim800l::Sim800LComponent::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 464 of file sim800l.cpp.

◆ loop()

void esphome::sim800l::Sim800LComponent::loop ( )

Reimplemented from esphome::Component.

Definition at line 417 of file sim800l.cpp.

◆ parse_cmd_()

void esphome::sim800l::Sim800LComponent::parse_cmd_ ( std::string  message)

Definition at line 69 of file sim800l.cpp.

◆ send_cmd_()

void esphome::sim800l::Sim800LComponent::send_cmd_ ( const std::string &  message)

Definition at line 61 of file sim800l.cpp.

◆ send_sms()

void esphome::sim800l::Sim800LComponent::send_sms ( const std::string &  recipient,
const std::string &  message 

Definition at line 452 of file sim800l.cpp.

◆ send_ussd()

void esphome::sim800l::Sim800LComponent::send_ussd ( const std::string &  ussd_code)

Definition at line 458 of file sim800l.cpp.

◆ set_registered_()

void esphome::sim800l::Sim800LComponent::set_registered_ ( bool  registered)

Definition at line 480 of file sim800l.cpp.

◆ set_registered_binary_sensor()

void esphome::sim800l::Sim800LComponent::set_registered_binary_sensor ( binary_sensor::BinarySensor registered_binary_sensor)

Definition at line 57 of file sim800l.h.

◆ set_rssi_sensor()

void esphome::sim800l::Sim800LComponent::set_rssi_sensor ( sensor::Sensor rssi_sensor)

Definition at line 62 of file sim800l.h.

◆ update()

void esphome::sim800l::Sim800LComponent::update ( )

Retrieve the latest sensor values. This operation takes approximately 16ms.

Implements esphome::PollingComponent.

Definition at line 13 of file sim800l.cpp.

Field Documentation

◆ call_connected_callback_

CallbackManager<void()> esphome::sim800l::Sim800LComponent::call_connected_callback_

Definition at line 119 of file sim800l.h.

◆ call_disconnected_callback_

CallbackManager<void()> esphome::sim800l::Sim800LComponent::call_disconnected_callback_

Definition at line 120 of file sim800l.h.

◆ call_state_

uint8_t esphome::sim800l::Sim800LComponent::call_state_ {6}

Definition at line 115 of file sim800l.h.

◆ connect_pending_

bool esphome::sim800l::Sim800LComponent::connect_pending_

Definition at line 112 of file sim800l.h.

◆ dial_pending_

bool esphome::sim800l::Sim800LComponent::dial_pending_

Definition at line 111 of file sim800l.h.

◆ disconnect_pending_

bool esphome::sim800l::Sim800LComponent::disconnect_pending_

Definition at line 113 of file sim800l.h.

◆ expect_ack_

bool esphome::sim800l::Sim800LComponent::expect_ack_ {false}

Definition at line 103 of file sim800l.h.

◆ incoming_call_callback_

CallbackManager<void(std::string)> esphome::sim800l::Sim800LComponent::incoming_call_callback_

Definition at line 118 of file sim800l.h.

◆ message_

std::string esphome::sim800l::Sim800LComponent::message_

Definition at line 98 of file sim800l.h.

◆ outgoing_message_

std::string esphome::sim800l::Sim800LComponent::outgoing_message_

Definition at line 108 of file sim800l.h.

◆ parse_index_

uint8_t esphome::sim800l::Sim800LComponent::parse_index_ {0}

Definition at line 101 of file sim800l.h.

◆ read_buffer_

char esphome::sim800l::Sim800LComponent::read_buffer_[SIM800L_READ_BUFFER_LENGTH]

Definition at line 99 of file sim800l.h.

◆ read_pos_

size_t esphome::sim800l::Sim800LComponent::read_pos_ {0}

Definition at line 100 of file sim800l.h.

◆ recipient_

std::string esphome::sim800l::Sim800LComponent::recipient_

Definition at line 107 of file sim800l.h.

◆ registered_

bool esphome::sim800l::Sim800LComponent::registered_ {false}

Definition at line 105 of file sim800l.h.

◆ registered_binary_sensor_

binary_sensor::BinarySensor* esphome::sim800l::Sim800LComponent::registered_binary_sensor_ {nullptr}

Definition at line 91 of file sim800l.h.

◆ rssi_sensor_

sensor::Sensor* esphome::sim800l::Sim800LComponent::rssi_sensor_ {nullptr}

Definition at line 95 of file sim800l.h.

◆ send_pending_

bool esphome::sim800l::Sim800LComponent::send_pending_

Definition at line 110 of file sim800l.h.

◆ send_ussd_pending_

bool esphome::sim800l::Sim800LComponent::send_ussd_pending_

Definition at line 114 of file sim800l.h.

◆ sender_

std::string esphome::sim800l::Sim800LComponent::sender_

Definition at line 97 of file sim800l.h.

◆ sms_received_callback_

CallbackManager<void(std::string, std::string)> esphome::sim800l::Sim800LComponent::sms_received_callback_

Definition at line 117 of file sim800l.h.

◆ state_

sim800l::State esphome::sim800l::Sim800LComponent::state_ {STATE_IDLE}

Definition at line 104 of file sim800l.h.

◆ ussd_

std::string esphome::sim800l::Sim800LComponent::ussd_

Definition at line 109 of file sim800l.h.

◆ ussd_received_callback_

CallbackManager<void(std::string)> esphome::sim800l::Sim800LComponent::ussd_received_callback_

Definition at line 121 of file sim800l.h.

◆ watch_dog_

uint8_t esphome::sim800l::Sim800LComponent::watch_dog_ {0}

Definition at line 102 of file sim800l.h.

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