ESPHome  2024.2.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::gps::GPSTime Class Reference

#include <gps_time.h>

Inheritance diagram for esphome::gps::GPSTime:
esphome::time::RealTimeClock esphome::gps::GPSListener esphome::PollingComponent esphome::Component

Public Member Functions

void update () override
void on_update (TinyGPSPlus &tiny_gps) override
- Public Member Functions inherited from esphome::time::RealTimeClock
 RealTimeClock ()
void set_timezone (const std::string &tz)
 Set the time zone. More...
std::string get_timezone ()
 Get the time zone currently in use. More...
ESPTime now ()
 Get the time in the currently defined timezone. More...
ESPTime utcnow ()
 Get the time without any time zone or DST corrections. More...
time_t timestamp_now ()
 Get the current time as the UTC epoch since January 1st 1970. More...
void call_setup () override
void add_on_time_sync_callback (std::function< void()> callback)
- 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 void loop ()
 This method will be called repeatedly. More...
virtual void dump_config ()
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 ()
bool is_ready ()
virtual bool can_proceed ()
bool status_has_warning ()
bool status_has_error ()
void status_set_warning ()
void status_set_error ()
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...
- Public Member Functions inherited from esphome::gps::GPSListener
TinyGPSPlus & get_tiny_gps ()

Protected Member Functions

void from_tiny_gps_ (TinyGPSPlus &tiny_gps)
- Protected Member Functions inherited from esphome::time::RealTimeClock
void synchronize_epoch_ (uint32_t epoch)
 Report a unix epoch as current time. More...
void apply_timezone_ ()
- 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

bool has_time_ {false}
- Protected Attributes inherited from esphome::time::RealTimeClock
std::string timezone_ {}
CallbackManager< void()> time_sync_callback_
- 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}
- Protected Attributes inherited from esphome::gps::GPSListener
friend GPS

Detailed Description

Definition at line 12 of file gps_time.h.

Member Function Documentation

◆ from_tiny_gps_()

void esphome::gps::GPSTime::from_tiny_gps_ ( TinyGPSPlus &  tiny_gps)

Definition at line 11 of file gps_time.cpp.

◆ on_update()

void esphome::gps::GPSTime::on_update ( TinyGPSPlus &  tiny_gps)

Implements esphome::gps::GPSListener.

Definition at line 15 of file gps_time.h.

◆ update()

void esphome::gps::GPSTime::update ( )

Implements esphome::PollingComponent.

Definition at line 14 of file gps_time.h.

Field Documentation

◆ has_time_

bool esphome::gps::GPSTime::has_time_ {false}

Definition at line 22 of file gps_time.h.

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