ESPHome  2022.1.1
Data Structures | Public Member Functions | Protected Member Functions | Protected Attributes
esphome::ds1307::DS1307Component Class Reference

#include <ds1307.h>

Inheritance diagram for esphome::ds1307::DS1307Component:
esphome::time::RealTimeClock esphome::i2c::I2CDevice esphome::PollingComponent esphome::Component

Data Structures

union  DS1307Reg
 

Public Member Functions

void setup () override
 
void update () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void read_time ()
 
void write_time ()
 
- 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...
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. 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 ()
 
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::i2c::I2CDevice
 I2CDevice ()=default
 
void set_i2c_address (uint8_t address)
 
void set_i2c_bus (I2CBus *bus)
 
I2CRegister reg (uint8_t a_register)
 
ErrorCode read (uint8_t *data, size_t len)
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len)
 
ErrorCode write (const uint8_t *data, uint8_t len)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len)
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Member Functions

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

union esphome::ds1307::DS1307Component::DS1307Reg ds1307_
 
- 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::i2c::I2CDevice
uint8_t address_ {0x00}
 
I2CBusbus_ {nullptr}
 

Detailed Description

Definition at line 10 of file ds1307.h.

Member Function Documentation

◆ dump_config()

void esphome::ds1307::DS1307Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file ds1307.cpp.

◆ get_setup_priority()

float esphome::ds1307::DS1307Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 30 of file ds1307.cpp.

◆ read_rtc_()

bool esphome::ds1307::DS1307Component::read_rtc_ ( )
protected

Definition at line 80 of file ds1307.cpp.

◆ read_time()

void esphome::ds1307::DS1307Component::read_time ( )

Definition at line 32 of file ds1307.cpp.

◆ setup()

void esphome::ds1307::DS1307Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file ds1307.cpp.

◆ update()

void esphome::ds1307::DS1307Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 19 of file ds1307.cpp.

◆ write_rtc_()

bool esphome::ds1307::DS1307Component::write_rtc_ ( )
protected

Definition at line 93 of file ds1307.cpp.

◆ write_time()

void esphome::ds1307::DS1307Component::write_time ( )

Definition at line 56 of file ds1307.cpp.

Field Documentation

◆ ds1307_

union esphome::ds1307::DS1307Component::DS1307Reg esphome::ds1307::DS1307Component::ds1307_
protected

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