led_clock-old/lib/rtc_ds1307.h

/* This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
/** @file rtc_ds1307.h
 *  @author King Kévin <kingkevin@cuvoodoo.info>
 *  @date 2016
 *  @brief this library handles communication with the I2C RTC IC Maxim DS1307
 *  @todo control register and user RAM are not handled
 *  peripherals used: I2C @ref rtc_ds1307_i2c
 */
#pragma once

/** @brief setup communication with RTC IC
 *  configure the I2C port defined in the sources
 */
void rtc_setup(void);
/** @brief verify if oscillator is disabled
 *  @return if oscillator is disabled
 */
bool rtc_oscillator_disabled(void);
/** @brief read seconds from RTC IC
 *  @return the number of seconds (0-59) of the current time
 */
uint8_t rtc_read_seconds(void);
/** @brief read minutes from RTC IC
 *  @return the number of minutes (0-59) of the current time
 */
uint8_t rtc_read_minutes(void);
/** @brief read hours from RTC IC
 *  @return the number of hours (0-23) of the current time
 */
uint8_t rtc_read_hours(void);
/** @brief read day from RTC IC
 *  @return the day (1-7) of the current time, 1 being Sunday
 */
uint8_t rtc_read_day(void);
/** @brief read date from RTC IC
 *  @return the date (day of the month, 1-31) of the current time
 */
uint8_t rtc_read_date(void);
/** @brief read month from RTC IC
 *  @return the month (1-12) of the current time
 */
uint8_t rtc_read_month(void);
/** @brief read year from RTC IC
 *  @return the year (2000-2099) of the current time
 */
uint16_t rtc_read_year(void);
/** @brief read time from RTC IC
 *  @return array of {seconds, minutes, hours, day, date, month, year} as defined above
 */
uint16_t* rtc_read_time(void);
/** @brief disable RTC IC oscillator
 */
void rtc_oscillator_disable(void);
/** @brief enable RTC IC oscillator
 */
void rtc_oscillator_enable(void);
/** @brief write seconds into RTC IC
 *  @return the number of seconds (0-59)
 */
void rtc_write_seconds(uint8_t seconds);