mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
163 lines
3.9 KiB
C
163 lines
3.9 KiB
C
/*
|
|
* Copyright (C) 2020 Freie Universität Berlin
|
|
*
|
|
* This file is subject to the terms and conditions of the GNU Lesser
|
|
* General Public License v2.1. See the file LICENSE in the top level
|
|
* directory for more details.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup drivers_ds3231 DS3231 Real Time Clock
|
|
* @ingroup drivers_sensors
|
|
* @brief Driver for the Maxim DS3231 extremely accurate RTC
|
|
*
|
|
* # About
|
|
* This module implements a device driver for Maxim DS3231 RTC.
|
|
*
|
|
* # Implementation status
|
|
* The current implementation does only support reading and setting of time
|
|
* registers as well as reading the temperature register and configuring the
|
|
* aging offset.
|
|
*
|
|
* Setting alarms and configuring the square wave output is not yet supported.
|
|
*
|
|
* @{
|
|
* @file
|
|
* @brief Interface definition for the Maxim DS3231 RTC
|
|
*
|
|
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
|
|
*/
|
|
|
|
#ifndef DS3231_H
|
|
#define DS3231_H
|
|
|
|
#include <time.h>
|
|
#include <errno.h>
|
|
|
|
#include "periph/i2c.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Default address of DS3231 sensors
|
|
*/
|
|
#define DS3231_I2C_ADDR 0x68
|
|
|
|
/**
|
|
* @brief Configuration options
|
|
*/
|
|
enum {
|
|
DS3231_OPT_BAT_ENABLE = 0x01, /* enable backup battery on startup */
|
|
DS2321_OPT_32KHZ_ENABLE = 0x02, /* enable 32KHz output */
|
|
};
|
|
|
|
/**
|
|
* @brief Device descriptor for DS3231 devices
|
|
*/
|
|
typedef struct {
|
|
i2c_t bus; /**< I2C bus the device is connected to */
|
|
} ds3231_t;
|
|
|
|
/**
|
|
* @brief Set of configuration parameters for DS3231 devices
|
|
*/
|
|
typedef struct {
|
|
i2c_t bus; /**< I2C bus the device is connected to */
|
|
uint8_t opt; /**< additional options */
|
|
} ds3231_params_t;
|
|
|
|
/**
|
|
* @brief Initialize the given DS3231 device
|
|
*
|
|
* @param[out] dev device descriptor of the targeted device
|
|
* @param[in] params device configuration
|
|
*
|
|
* @return 0 on success
|
|
* @return -EIO if no DS3231 device was found
|
|
*/
|
|
int ds3231_init(ds3231_t *dev, const ds3231_params_t *params);
|
|
|
|
/**
|
|
* @brief Get date and time from the device
|
|
*
|
|
* @param[in] dev DS3231 device descriptor
|
|
* @param[out] time current date and time from on device
|
|
*
|
|
* @return 0 on success
|
|
* @return -EIO on I2C communication error
|
|
*/
|
|
int ds3231_get_time(const ds3231_t *dev, struct tm *time);
|
|
|
|
/**
|
|
* @brief Set date and time of the device
|
|
*
|
|
* @param[in] dev DS3231 device descriptor
|
|
* @param[in] time target date and time
|
|
*
|
|
* @return 0 on success
|
|
* @return -EIO on I2C communication error
|
|
*/
|
|
int ds3231_set_time(const ds3231_t *dev, const struct tm *time);
|
|
|
|
/**
|
|
* @brief Get the configured aging offset (see datasheet for more information)
|
|
*
|
|
* @param[in] dev DS3231 device descriptor
|
|
* @param[out] offset aging offset
|
|
*
|
|
* @return 0 on success
|
|
* @return -EIO on I2C communication error
|
|
*/
|
|
int ds3231_get_aging_offset(const ds3231_t *dev, int8_t *offset);
|
|
|
|
/**
|
|
* @brief Set the aging offset (see datasheet for more information)
|
|
*
|
|
* @param[in] dev DS3231 device descriptor
|
|
* @param[in] offset aging offset
|
|
*
|
|
* @return 0 on success
|
|
* @return -EIO on I2C communication error
|
|
*/
|
|
int ds3231_set_aging_offset(const ds3231_t *dev, int8_t offset);
|
|
|
|
/**
|
|
* @brief Get temperature from the device
|
|
*
|
|
* @param[in] dev DS3231 device descriptor
|
|
* @param[out] temp current value of the temperature register [in centi °C]
|
|
*
|
|
* @return 0 on success
|
|
* @return -EIO on I2C communication error
|
|
*/
|
|
int ds3231_get_temp(const ds3231_t *dev, int16_t *temp);
|
|
|
|
/**
|
|
* @brief Enable the backup battery
|
|
*
|
|
* @param[in] dev DS3231 device descriptor
|
|
*
|
|
* @return 0 on success
|
|
* @return -EIO on I2C communication error
|
|
*/
|
|
int ds3231_enable_bat(const ds3231_t *dev);
|
|
|
|
/**
|
|
* @brief Disable the backup battery
|
|
*
|
|
* @param[in] dev DS3231 device descriptor
|
|
*
|
|
* @return 0 on success
|
|
* @return -EIO on I2C communication error
|
|
*/
|
|
int ds3231_disable_bat(const ds3231_t *dev);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* DS3231_H */
|
|
/** @} */
|