|
DS3231 v0.6.1
An ESP-IDF driver for the DS3231 RTC
|
Public API for the DS3231 RTC driver. More...
#include <time.h>#include <stdbool.h>#include "driver/i2c_master.h"#include "esp_err.h"Go to the source code of this file.
Macros | |
| #define | DS3231_I2C_ADDR_DEFAULT 0x68 |
| #define | DS3231_I2C_CLK_SPEED 100000UL |
| #define | DS3231_TIMEOUT_MS 50 |
| #define | DS3231_LOCK_TIMEOUT_MS 1000 |
Typedefs | |
| typedef void * | ds3231_handle_t |
| Handle of a DS3231 device. | |
Functions | |
| esp_err_t | ds3231_create (i2c_master_bus_handle_t i2c_bus, ds3231_handle_t *ds3231_handle) |
| Initialize device handle. | |
| void | ds3231_delete (ds3231_handle_t ds3231_handle) |
| Free device handle. | |
| esp_err_t | ds3231_get_time_valid (ds3231_handle_t ds3231_handle, bool *time_valid) |
| Check validity of the time module saved. | |
| esp_err_t | ds3231_osc_battery_get_status (ds3231_handle_t ds3231_handle, bool *enabled) |
| Check whether the oscillator is enabled when running on battery or not. | |
| esp_err_t | ds3231_osc_battery_set_status (ds3231_handle_t ds3231_handle, bool enabled) |
| Enable or disable the oscillator when running on battery. | |
| esp_err_t | ds3231_get_time_format (ds3231_handle_t ds3231_handle, ds3231_time_format_t *timeformat) |
| Get the current time format. | |
| esp_err_t | ds3231_set_time (ds3231_handle_t ds3231_handle, struct tm timeinfo, ds3231_time_format_t format) |
| Set current date time. | |
| esp_err_t | ds3231_get_time (ds3231_handle_t ds3231_handle, struct tm *timeinfo, ds3231_time_format_t *format) |
| Get the current date and time. | |
| esp_err_t | ds3231_get_temperature (ds3231_handle_t ds3231_handle, float *temp) |
| Read temperature from the chip. | |
| esp_err_t | ds3231_get_aging (ds3231_handle_t ds3231_handle, int8_t *age) |
| Get the aging offset. | |
| esp_err_t | ds3231_set_aging (ds3231_handle_t ds3231_handle, int8_t age) |
| Set the aging offset. | |
| esp_err_t | ds3231_squarewave_set_freq (ds3231_handle_t ds3231_handle, ds3231_squarewave_freq_t freq) |
| Set square wave frequency. | |
| esp_err_t | ds3231_squarewave_get_freq (ds3231_handle_t ds3231_handle, ds3231_squarewave_freq_t *freq) |
| Get square wave frequency. | |
| esp_err_t | ds3231_squarewave_enable (ds3231_handle_t ds3231_handle) |
| Enable generating of the square wave. | |
| esp_err_t | ds3231_squarewave_disable (ds3231_handle_t ds3231_handle) |
| Disable generating of the square wave. | |
| esp_err_t | ds3231_squarewave_battery_enable (ds3231_handle_t ds3231_handle) |
| Allow the device to run the square wave when powered from the battery. | |
| esp_err_t | ds3231_squarewave_battery_disable (ds3231_handle_t ds3231_handle) |
| Disallow the device to run the square wave when powered from the battery. | |
| esp_err_t | ds3231_squarewave_32khz_enable (ds3231_handle_t ds3231_handle) |
| Enable 32 kHz output. | |
| esp_err_t | ds3231_squarewave_32khz_disable (ds3231_handle_t ds3231_handle) |
| Disable 32 kHz output. | |
| esp_err_t | ds3231_alarm_interr_get_status (ds3231_handle_t ds3231_handle, ds3231_alarms_t *interr) |
| Get which alarm interrupts are enabled. | |
| esp_err_t | ds3231_alarm1_interr_enable (ds3231_handle_t ds3231_handle) |
| Enable interrupts for alarm 1. | |
| esp_err_t | ds3231_alarm1_interr_disable (ds3231_handle_t ds3231_handle) |
| Disable interrupts for alarm 1. | |
| esp_err_t | ds3231_alarm1_get_time (ds3231_handle_t ds3231_handle, ds3231_alarm1_match_t *interr, struct tm *timeinfo, ds3231_time_format_t *format) |
| Read alarm 1 config (match mode and alarm time). | |
| esp_err_t | ds3231_alarm1_set_time (ds3231_handle_t ds3231_handle, ds3231_alarm1_match_t interr, struct tm timeinfo, ds3231_time_format_t format) |
| Set the time of interrupt. | |
| esp_err_t | ds3231_alarm2_get_time (ds3231_handle_t ds3231_handle, ds3231_alarm2_match_t *interr, struct tm *timeinfo, ds3231_time_format_t *format) |
| Read alarm 2 config (match mode and alarm time). | |
| esp_err_t | ds3231_alarm2_set_time (ds3231_handle_t ds3231_handle, ds3231_alarm2_match_t interr, struct tm timeinfo, ds3231_time_format_t format) |
| Set the time of interrupt. | |
| esp_err_t | ds3231_alarm2_interr_enable (ds3231_handle_t ds3231_handle) |
| Enable interrupts for alarm 2. | |
| esp_err_t | ds3231_alarm2_interr_disable (ds3231_handle_t ds3231_handle) |
| Disable interrupts for alarm 2. | |
| esp_err_t | ds3231_alarm_get_flags (ds3231_handle_t ds3231_handle, ds3231_alarm_flags_t *interr) |
| Get the flags of which alarm was triggered. | |
| esp_err_t | ds3231_alarm_clear_flags (ds3231_handle_t ds3231_handle, ds3231_alarm_flags_t interr) |
| Clear interrupt flags. | |
Public API for the DS3231 RTC driver.
Match mode of alarm 1.
Match mode of alarm 2.
| enum ds3231_alarm_flags_t |
| enum ds3231_alarms_t |
| enum ds3231_time_format_t |
| esp_err_t ds3231_alarm1_get_time | ( | ds3231_handle_t | ds3231_handle, |
| ds3231_alarm1_match_t * | interr, | ||
| struct tm * | timeinfo, | ||
| ds3231_time_format_t * | format ) |
Read alarm 1 config (match mode and alarm time).
| [in] | ds3231_handle | Device handle |
| [out] | interr | Alarm match mode |
| [out] | timeinfo | the tm structure for time |
| [out] | format | Format in which the alarm hour is stored in the device. May be NULL |
| esp_err_t ds3231_alarm1_interr_disable | ( | ds3231_handle_t | ds3231_handle | ) |
Disable interrupts for alarm 1.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_alarm1_interr_enable | ( | ds3231_handle_t | ds3231_handle | ) |
Enable interrupts for alarm 1.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_alarm1_set_time | ( | ds3231_handle_t | ds3231_handle, |
| ds3231_alarm1_match_t | interr, | ||
| struct tm | timeinfo, | ||
| ds3231_time_format_t | format ) |
Set the time of interrupt.
| [in] | ds3231_handle | Device handle |
| [in] | interr | Necessary interrupt matches |
| [in] | timeinfo | the tm structure for time |
| [in] | format | Format in which the alarm hour is stored in the device |
| esp_err_t ds3231_alarm2_get_time | ( | ds3231_handle_t | ds3231_handle, |
| ds3231_alarm2_match_t * | interr, | ||
| struct tm * | timeinfo, | ||
| ds3231_time_format_t * | format ) |
Read alarm 2 config (match mode and alarm time).
| [in] | ds3231_handle | Device handle |
| [out] | interr | Alarm match mode |
| [out] | timeinfo | the tm structure for time |
| [out] | format | Format in which the alarm hour is stored in the device. May be NULL |
| esp_err_t ds3231_alarm2_interr_disable | ( | ds3231_handle_t | ds3231_handle | ) |
Disable interrupts for alarm 2.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_alarm2_interr_enable | ( | ds3231_handle_t | ds3231_handle | ) |
Enable interrupts for alarm 2.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_alarm2_set_time | ( | ds3231_handle_t | ds3231_handle, |
| ds3231_alarm2_match_t | interr, | ||
| struct tm | timeinfo, | ||
| ds3231_time_format_t | format ) |
Set the time of interrupt.
| [in] | ds3231_handle | Device handle |
| [in] | interr | Necessary interrupt matches |
| [in] | timeinfo | the tm structure for time |
| [in] | format | Format in which the alarm hour is stored in the device |
| esp_err_t ds3231_alarm_clear_flags | ( | ds3231_handle_t | ds3231_handle, |
| ds3231_alarm_flags_t | interr ) |
Clear interrupt flags.
| [in] | ds3231_handle | Device handle |
| [in] | interr | Flags to clear |
| esp_err_t ds3231_alarm_get_flags | ( | ds3231_handle_t | ds3231_handle, |
| ds3231_alarm_flags_t * | interr ) |
Get the flags of which alarm was triggered.
| [in] | ds3231_handle | Device handle |
| [out] | interr | Flag of the occurred interrupt |
| esp_err_t ds3231_alarm_interr_get_status | ( | ds3231_handle_t | ds3231_handle, |
| ds3231_alarms_t * | interr ) |
Get which alarm interrupts are enabled.
| [in] | ds3231_handle | Device handle |
| [out] | interr | Get the enabled alarm interrupt |
| esp_err_t ds3231_create | ( | i2c_master_bus_handle_t | i2c_bus, |
| ds3231_handle_t * | ds3231_handle ) |
Initialize device handle.
| [in] | i2c_bus | I2C bus handle |
| [out] | ds3231_handle | Device handle |
| void ds3231_delete | ( | ds3231_handle_t | ds3231_handle | ) |
Free device handle.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_get_aging | ( | ds3231_handle_t | ds3231_handle, |
| int8_t * | age ) |
Get the aging offset.
| [in] | ds3231_handle | Device handle |
| [out] | age | Aging offset |
| esp_err_t ds3231_get_temperature | ( | ds3231_handle_t | ds3231_handle, |
| float * | temp ) |
Read temperature from the chip.
| [in] | ds3231_handle | Device handle |
| [out] | temp | Temperature, Celsius |
| esp_err_t ds3231_get_time | ( | ds3231_handle_t | ds3231_handle, |
| struct tm * | timeinfo, | ||
| ds3231_time_format_t * | format ) |
Get the current date and time.
| [in] | ds3231_handle | Device handle |
| [out] | timeinfo | Date and time read from the device. Uses tm_sec, tm_min, tm_hour, tm_mday, tm_mon, tm_year and tm_wday |
| [out] | format | Format in which the time is stored in the device. May be NULL |
| esp_err_t ds3231_get_time_format | ( | ds3231_handle_t | ds3231_handle, |
| ds3231_time_format_t * | timeformat ) |
Get the current time format.
| [in] | ds3231_handle | Device handle |
| [out] | timeformat | Format of time |
| esp_err_t ds3231_get_time_valid | ( | ds3231_handle_t | ds3231_handle, |
| bool * | time_valid ) |
Check validity of the time module saved.
| [in] | ds3231_handle | Device handle |
| [out] | time_valid | True if time is valid, false if not |
| esp_err_t ds3231_osc_battery_get_status | ( | ds3231_handle_t | ds3231_handle, |
| bool * | enabled ) |
Check whether the oscillator is enabled when running on battery or not.
| [in] | ds3231_handle | Device handle |
| [out] | enabled | True if the oscillator is running on battery, false if it stops |
| esp_err_t ds3231_osc_battery_set_status | ( | ds3231_handle_t | ds3231_handle, |
| bool | enabled ) |
Enable or disable the oscillator when running on battery.
| [in] | ds3231_handle | Device handle |
| [in] | enabled | True to keep the oscillator running on battery, false to stop |
| esp_err_t ds3231_set_aging | ( | ds3231_handle_t | ds3231_handle, |
| int8_t | age ) |
Set the aging offset.
| [in] | ds3231_handle | Device handle |
| [in] | age | Aging offset in range -128..127 |
| esp_err_t ds3231_set_time | ( | ds3231_handle_t | ds3231_handle, |
| struct tm | timeinfo, | ||
| ds3231_time_format_t | format ) |
Set current date time.
| [in] | ds3231_handle | Device handle |
| [in] | timeinfo | Date and time to set. Uses tm_sec, tm_min, tm_hour, tm_mday, tm_mon, tm_year and tm_wday. tm_hour must be 0-23 in 24-hour format and 1-12 in 12-hour format |
| [in] | format | Format in which the time is stored in the device |
| esp_err_t ds3231_squarewave_32khz_disable | ( | ds3231_handle_t | ds3231_handle | ) |
Disable 32 kHz output.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_squarewave_32khz_enable | ( | ds3231_handle_t | ds3231_handle | ) |
Enable 32 kHz output.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_squarewave_battery_disable | ( | ds3231_handle_t | ds3231_handle | ) |
Disallow the device to run the square wave when powered from the battery.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_squarewave_battery_enable | ( | ds3231_handle_t | ds3231_handle | ) |
Allow the device to run the square wave when powered from the battery.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_squarewave_disable | ( | ds3231_handle_t | ds3231_handle | ) |
Disable generating of the square wave.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_squarewave_enable | ( | ds3231_handle_t | ds3231_handle | ) |
Enable generating of the square wave.
| [in] | ds3231_handle | Device handle |
| esp_err_t ds3231_squarewave_get_freq | ( | ds3231_handle_t | ds3231_handle, |
| ds3231_squarewave_freq_t * | freq ) |
Get square wave frequency.
| [in] | ds3231_handle | Device handle |
| [out] | freq | Frequency read from the device |
| esp_err_t ds3231_squarewave_set_freq | ( | ds3231_handle_t | ds3231_handle, |
| ds3231_squarewave_freq_t | freq ) |
Set square wave frequency.
| [in] | ds3231_handle | Device handle |
| [in] | freq | Frequency to set |