Maxim Integrated / ds3231

Library for DS3231 RTC

Dependents:   ard2pmod DS3231demo DS3231demo_COM_Port_Output MAXREFDES99_RTC_Display ... more

DS3231 Component Page

ds3231.h@9:e57201ee8921, 2014-12-05 (annotated)

Committer:
j3
Date:
Fri Dec 05 22:31:35 2014 +0000
Revision:
9:e57201ee8921
Parent:
8:c7484a65fcea
Child:
10:3b55ed3f71d3
working on doxy format for mbed

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 0:b00c4699ae6f 1 /******************************************************************//**
j3 0:b00c4699ae6f 2 * @file ds3231.h
j3 0:b00c4699ae6f 3 *
j3 0:b00c4699ae6f 4 * @author Justin Jordan
j3 0:b00c4699ae6f 5 *
j3 0:b00c4699ae6f 6 * @version 0.0
j3 0:b00c4699ae6f 7 *
j3 0:b00c4699ae6f 8 * Started: 11NOV14
j3 0:b00c4699ae6f 9 *
j3 0:b00c4699ae6f 10 * Updated:
j3 0:b00c4699ae6f 11 *
j3 0:b00c4699ae6f 12 * @brief Header file for DS3231 class
j3 0:b00c4699ae6f 13 *
j3 0:b00c4699ae6f 14 ***********************************************************************
j3 0:b00c4699ae6f 15 *
j3 0:b00c4699ae6f 16 * @copyright
j3 0:b00c4699ae6f 17 * Copyright (C) 2013 Maxim Integrated Products, Inc., All Rights Reserved.
j3 0:b00c4699ae6f 18 *
j3 0:b00c4699ae6f 19 * Permission is hereby granted, free of charge, to any person obtaining a
j3 0:b00c4699ae6f 20 * copy of this software and associated documentation files (the "Software"),
j3 0:b00c4699ae6f 21 * to deal in the Software without restriction, including without limitation
j3 0:b00c4699ae6f 22 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 0:b00c4699ae6f 23 * and/or sell copies of the Software, and to permit persons to whom the
j3 0:b00c4699ae6f 24 * Software is furnished to do so, subject to the following conditions:
j3 0:b00c4699ae6f 25 *
j3 0:b00c4699ae6f 26 * The above copyright notice and this permission notice shall be included
j3 0:b00c4699ae6f 27 * in all copies or substantial portions of the Software.
j3 0:b00c4699ae6f 28 *
j3 0:b00c4699ae6f 29 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 0:b00c4699ae6f 30 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 0:b00c4699ae6f 31 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 0:b00c4699ae6f 32 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 0:b00c4699ae6f 33 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 0:b00c4699ae6f 34 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 0:b00c4699ae6f 35 * OTHER DEALINGS IN THE SOFTWARE.
j3 0:b00c4699ae6f 36 *
j3 0:b00c4699ae6f 37 * Except as contained in this notice, the name of Maxim Integrated
j3 0:b00c4699ae6f 38 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 0:b00c4699ae6f 39 * Products, Inc. Branding Policy.
j3 0:b00c4699ae6f 40 *
j3 0:b00c4699ae6f 41 * The mere transfer of this software does not imply any licenses
j3 0:b00c4699ae6f 42 * of trade secrets, proprietary technology, copyrights, patents,
j3 0:b00c4699ae6f 43 * trademarks, maskwork rights, or any other form of intellectual
j3 0:b00c4699ae6f 44 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 0:b00c4699ae6f 45 * ownership rights.
j3 0:b00c4699ae6f 46 **********************************************************************/
j3 0:b00c4699ae6f 47
j3 0:b00c4699ae6f 48
j3 0:b00c4699ae6f 49 #ifndef DS3231_H
j3 0:b00c4699ae6f 50 #define DS3231_H
j3 0:b00c4699ae6f 51
j3 0:b00c4699ae6f 52
j3 0:b00c4699ae6f 53 #include "mbed.h"
j3 0:b00c4699ae6f 54
j3 0:b00c4699ae6f 55
j3 3:312589d8185c 56 #define DS3231_I2C_ADRS 0x68
j3 0:b00c4699ae6f 57 #define I2C_WRITE 0
j3 0:b00c4699ae6f 58 #define I2C_READ 1
j3 0:b00c4699ae6f 59
j3 2:4e6e761c60f2 60 #define AM_PM (1 << 5)
j3 2:4e6e761c60f2 61 #define MODE (1 << 6)
j3 2:4e6e761c60f2 62 #define DY_DT (1 << 6)
j3 2:4e6e761c60f2 63 #define ALRM_MASK (1 << 7)
j3 0:b00c4699ae6f 64
j3 0:b00c4699ae6f 65 //control register bit masks
j3 0:b00c4699ae6f 66 #define A1IE (1 << 0)
j3 0:b00c4699ae6f 67 #define A2IE (1 << 1)
j3 0:b00c4699ae6f 68 #define INTCN (1 << 2)
j3 0:b00c4699ae6f 69 #define RS1 (1 << 3)
j3 0:b00c4699ae6f 70 #define RS2 (1 << 4)
j3 0:b00c4699ae6f 71 #define CONV (1 << 5)
j3 0:b00c4699ae6f 72 #define BBSQW (1 << 6)
j3 2:4e6e761c60f2 73 #define EOSC (1 << 7)
j3 0:b00c4699ae6f 74
j3 0:b00c4699ae6f 75 //status register bit masks
j3 0:b00c4699ae6f 76 #define A1F (1 << 0)
j3 0:b00c4699ae6f 77 #define A2F (1 << 1)
j3 0:b00c4699ae6f 78 #define BSY (1 << 2)
j3 0:b00c4699ae6f 79 #define EN32KHZ (1 << 3)
j3 0:b00c4699ae6f 80 #define OSF (1 << 7)
j3 9:e57201ee8921 81
j3 8:c7484a65fcea 82 /**
j3 9:e57201ee8921 83 * ds3231_regs_t - enumerated DS3231 registers
j3 8:c7484a65fcea 84 */
j3 0:b00c4699ae6f 85 typedef enum
j3 0:b00c4699ae6f 86 {
j3 0:b00c4699ae6f 87 SECONDS,
j3 0:b00c4699ae6f 88 MINUTES,
j3 0:b00c4699ae6f 89 HOURS,
j3 0:b00c4699ae6f 90 DAY,
j3 0:b00c4699ae6f 91 DATE,
j3 0:b00c4699ae6f 92 MONTH,
j3 0:b00c4699ae6f 93 YEAR,
j3 0:b00c4699ae6f 94 ALRM1_SECONDS,
j3 0:b00c4699ae6f 95 ALRM1_MINUTES,
j3 0:b00c4699ae6f 96 ALRM1_HOURS,
j3 0:b00c4699ae6f 97 ALRM1_DAY_DATE,
j3 0:b00c4699ae6f 98 ALRM2_MINUTES,
j3 0:b00c4699ae6f 99 ALRM2_HOURS,
j3 0:b00c4699ae6f 100 ALRM2_DAY_DATE,
j3 0:b00c4699ae6f 101 CONTROL,
j3 0:b00c4699ae6f 102 STATUS,
j3 0:b00c4699ae6f 103 AGING_OFFSET, //don't touch this register
j3 0:b00c4699ae6f 104 MSB_TEMP,
j3 0:b00c4699ae6f 105 LSB_TEMP
j3 0:b00c4699ae6f 106 }ds3231_regs_t;
j3 0:b00c4699ae6f 107
j3 0:b00c4699ae6f 108
j3 8:c7484a65fcea 109 /**
j3 8:c7484a65fcea 110 * ds3231_time_t - Struct for containing time data.
j3 8:c7484a65fcea 111 *
j3 8:c7484a65fcea 112 * Members:
j3 8:c7484a65fcea 113 *
j3 8:c7484a65fcea 114 * - uint8_t seconds - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 115 *
j3 8:c7484a65fcea 116 * - uint8_t minutes - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 117 *
j3 8:c7484a65fcea 118 * - uint8_t hours - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 119 *
j3 8:c7484a65fcea 120 * - bool am_pm - TRUE for PM, same logic as datasheet
j3 8:c7484a65fcea 121 *
j3 8:c7484a65fcea 122 * - bool mode - TRUE for 12 hour, same logic as datasheet
j3 8:c7484a65fcea 123 */
j3 0:b00c4699ae6f 124 typedef struct
j3 0:b00c4699ae6f 125 {
j3 9:e57201ee8921 126 uint8_t seconds;
j3 9:e57201ee8921 127 uint8_t minutes;
j3 9:e57201ee8921 128 uint8_t hours;
j3 9:e57201ee8921 129 bool am_pm;
j3 9:e57201ee8921 130 bool mode;
j3 0:b00c4699ae6f 131 }ds3231_time_t;
j3 0:b00c4699ae6f 132
j3 0:b00c4699ae6f 133
j3 8:c7484a65fcea 134 /**
j3 8:c7484a65fcea 135 * ds3231_calendar_t - Struct for containing calendar data.
j3 8:c7484a65fcea 136 *
j3 8:c7484a65fcea 137 * Members:
j3 8:c7484a65fcea 138 *
j3 8:c7484a65fcea 139 * - uint8_t day - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 140 *
j3 8:c7484a65fcea 141 * - uint8_t date - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 142 *
j3 8:c7484a65fcea 143 * - uint8_t month - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 144 *
j3 8:c7484a65fcea 145 * - uint8_t year - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 146 */
j3 0:b00c4699ae6f 147 typedef struct
j3 0:b00c4699ae6f 148 {
j3 9:e57201ee8921 149 uint8_t day;
j3 9:e57201ee8921 150 uint8_t date;
j3 9:e57201ee8921 151 uint8_t month;
j3 9:e57201ee8921 152 uint8_t year;
j3 0:b00c4699ae6f 153 }ds3231_calendar_t;
j3 0:b00c4699ae6f 154
j3 0:b00c4699ae6f 155
j3 8:c7484a65fcea 156 /**
j3 8:c7484a65fcea 157 * ds3231_alrm_t - Struct for containing alarm data.
j3 8:c7484a65fcea 158 *
j3 8:c7484a65fcea 159 * Members:
j3 8:c7484a65fcea 160 *
j3 8:c7484a65fcea 161 * - uint8_t seconds - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 162 *
j3 8:c7484a65fcea 163 * - uint8_t minutes - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 164 *
j3 8:c7484a65fcea 165 * - uint8_t hours - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 166 *
j3 8:c7484a65fcea 167 * - uint8_t day - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 168 *
j3 8:c7484a65fcea 169 * - uint8_t date - Use decimal value. Member fx's convert to BCD
j3 8:c7484a65fcea 170 *
j3 8:c7484a65fcea 171 * - bool am1 - Flag for setting alarm rate
j3 8:c7484a65fcea 172 *
j3 8:c7484a65fcea 173 * - bool am2 - Flag for setting alarm rate
j3 8:c7484a65fcea 174 *
j3 8:c7484a65fcea 175 * - bool am3 - Flag for setting alarm rate
j3 8:c7484a65fcea 176 *
j3 8:c7484a65fcea 177 * - bool am4 - Flag for setting alarm rate
j3 8:c7484a65fcea 178 *
j3 8:c7484a65fcea 179 * - bool am_pm - TRUE for PM, same logic as datasheet
j3 8:c7484a65fcea 180 *
j3 8:c7484a65fcea 181 * - bool mode - TRUE for 12 hour, same logic as datasheet
j3 8:c7484a65fcea 182 *
j3 8:c7484a65fcea 183 * - bool dy_dt - TRUE for Day, same logic as datasheet
j3 8:c7484a65fcea 184 */
j3 0:b00c4699ae6f 185 typedef struct
j3 0:b00c4699ae6f 186 {
j3 3:312589d8185c 187 //Seconds and am1 not used for alarm2
j3 9:e57201ee8921 188 uint8_t seconds;
j3 9:e57201ee8921 189 uint8_t minutes;
j3 9:e57201ee8921 190 uint8_t hours;
j3 9:e57201ee8921 191 uint8_t day;
j3 9:e57201ee8921 192 uint8_t date;
j3 3:312589d8185c 193 bool am1;
j3 2:4e6e761c60f2 194 bool am2;
j3 2:4e6e761c60f2 195 bool am3;
j3 2:4e6e761c60f2 196 bool am4;
j3 9:e57201ee8921 197 bool am_pm;
j3 9:e57201ee8921 198 bool mode;
j3 9:e57201ee8921 199 bool dy_dt;
j3 0:b00c4699ae6f 200 }ds3231_alrm_t;
j3 0:b00c4699ae6f 201
j3 0:b00c4699ae6f 202
j3 8:c7484a65fcea 203 /**
j3 8:c7484a65fcea 204 * ds3231_cntl_stat_t - Struct for containing control and status
j3 8:c7484a65fcea 205 * register data.
j3 8:c7484a65fcea 206 *
j3 8:c7484a65fcea 207 * Members:
j3 8:c7484a65fcea 208 *
j3 8:c7484a65fcea 209 * - uint8_t control - Binary data for read/write of control register
j3 8:c7484a65fcea 210 *
j3 8:c7484a65fcea 211 * - uint8_t status - Binary data for read/write of status register
j3 8:c7484a65fcea 212 */
j3 0:b00c4699ae6f 213 typedef struct
j3 0:b00c4699ae6f 214 {
j3 9:e57201ee8921 215 uint8_t control;
j3 9:e57201ee8921 216 uint8_t status;
j3 0:b00c4699ae6f 217 }ds3231_cntl_stat_t;
j3 9:e57201ee8921 218
j3 9:e57201ee8921 219
j3 0:b00c4699ae6f 220 /******************************************************************//**
j3 0:b00c4699ae6f 221 * Ds3231 Class
j3 0:b00c4699ae6f 222 **********************************************************************/
j3 1:c814af60fdbf 223 class Ds3231 : public I2C
j3 0:b00c4699ae6f 224 {
j3 0:b00c4699ae6f 225 uint8_t w_adrs, r_adrs;
j3 0:b00c4699ae6f 226
j3 2:4e6e761c60f2 227 /**********************************************************//**
j3 2:4e6e761c60f2 228 * Private mmber fx, converts unsigned char to BCD
j3 2:4e6e761c60f2 229 *
j3 2:4e6e761c60f2 230 * On Entry:
j3 2:4e6e761c60f2 231 * @param[in] data - 0-255
j3 2:4e6e761c60f2 232 *
j3 2:4e6e761c60f2 233 * On Exit:
j3 2:4e6e761c60f2 234 * @return bcd_result = BCD representation of data
j3 2:4e6e761c60f2 235 *
j3 2:4e6e761c60f2 236 **************************************************************/
j3 2:4e6e761c60f2 237 uint16_t uchar_2_bcd(uint8_t data);
j3 2:4e6e761c60f2 238
j3 2:4e6e761c60f2 239
j3 2:4e6e761c60f2 240 /**********************************************************//**
j3 2:4e6e761c60f2 241 * Private mmber fx, converts BCD to a uint8_t
j3 2:4e6e761c60f2 242 *
j3 2:4e6e761c60f2 243 * On Entry:
j3 2:4e6e761c60f2 244 * @param[in] bcd - 0-99
j3 2:4e6e761c60f2 245 *
j3 2:4e6e761c60f2 246 * On Exit:
j3 2:4e6e761c60f2 247 * @return rtn_val = integer rep. of BCD
j3 2:4e6e761c60f2 248 *
j3 2:4e6e761c60f2 249 **************************************************************/
j3 2:4e6e761c60f2 250 uint8_t bcd_2_uchar(uint8_t bcd);
j3 2:4e6e761c60f2 251
j3 0:b00c4699ae6f 252 public:
j3 9:e57201ee8921 253
j3 0:b00c4699ae6f 254 /**********************************************************//**
j3 0:b00c4699ae6f 255 * Constructor for Ds3231 Class
j3 0:b00c4699ae6f 256 *
j3 0:b00c4699ae6f 257 * On Entry:
j3 1:c814af60fdbf 258 * @param[in] sda - sda pin of I2C bus
j3 1:c814af60fdbf 259 * @param[in] scl - scl pin of I2C bus
j3 0:b00c4699ae6f 260 *
j3 0:b00c4699ae6f 261 * On Exit:
j3 0:b00c4699ae6f 262 * @return none
j3 0:b00c4699ae6f 263 *
j3 0:b00c4699ae6f 264 * Example:
j3 0:b00c4699ae6f 265 * @code
j3 0:b00c4699ae6f 266 *
j3 0:b00c4699ae6f 267 * //instantiate rtc object
j3 1:c814af60fdbf 268 * Ds3231 rtc(D14, D15);
j3 0:b00c4699ae6f 269 *
j3 0:b00c4699ae6f 270 * @endcode
j3 0:b00c4699ae6f 271 **************************************************************/
j3 1:c814af60fdbf 272 Ds3231(PinName sda, PinName scl);
j3 0:b00c4699ae6f 273
j3 0:b00c4699ae6f 274
j3 0:b00c4699ae6f 275 /**********************************************************//**
j3 0:b00c4699ae6f 276 * Sets the time on DS3231
j3 2:4e6e761c60f2 277 * Struct data is in integrer format, not BCD. Fx will convert
j3 2:4e6e761c60f2 278 * to BCD for you.
j3 0:b00c4699ae6f 279 *
j3 0:b00c4699ae6f 280 * On Entry:
j3 0:b00c4699ae6f 281 * @param[in] time - struct cotaining time data;
j3 0:b00c4699ae6f 282 *
j3 0:b00c4699ae6f 283 * On Exit:
j3 0:b00c4699ae6f 284 * @return return value = 0 on success, non-0 on failure
j3 0:b00c4699ae6f 285 *
j3 0:b00c4699ae6f 286 * Example:
j3 0:b00c4699ae6f 287 * @code
j3 0:b00c4699ae6f 288 *
j3 0:b00c4699ae6f 289 * //instantiate rtc object
j3 1:c814af60fdbf 290 * Ds3231 rtc(D14, D15);
j3 0:b00c4699ae6f 291 *
j3 4:0beb5e9ac927 292 * //time = 12:00:00 AM 12hr mode
j3 4:0beb5e9ac927 293 * ds3231_time_t time = {12, 0, 0, 0, 1}
j3 0:b00c4699ae6f 294 * uint16_t rtn_val;
j3 0:b00c4699ae6f 295 *
j3 0:b00c4699ae6f 296 * rtn_val = rtc.set_time(time);
j3 0:b00c4699ae6f 297 *
j3 0:b00c4699ae6f 298 * @endcode
j3 0:b00c4699ae6f 299 **************************************************************/
j3 0:b00c4699ae6f 300 uint16_t set_time(ds3231_time_t time);
j3 0:b00c4699ae6f 301
j3 0:b00c4699ae6f 302
j3 0:b00c4699ae6f 303 /**********************************************************//**
j3 0:b00c4699ae6f 304 * Sets the calendar on DS3231
j3 0:b00c4699ae6f 305 *
j3 0:b00c4699ae6f 306 * On Entry:
j3 3:312589d8185c 307 * @param[in] calendar - struct cotaining calendar data
j3 0:b00c4699ae6f 308 *
j3 0:b00c4699ae6f 309 * On Exit:
j3 0:b00c4699ae6f 310 * @return return value = 0 on success, non-0 on failure
j3 0:b00c4699ae6f 311 *
j3 0:b00c4699ae6f 312 * Example:
j3 0:b00c4699ae6f 313 * @code
j3 0:b00c4699ae6f 314 *
j3 0:b00c4699ae6f 315 * //instantiate rtc object
j3 1:c814af60fdbf 316 * Ds3231 rtc(D14, D15);
j3 0:b00c4699ae6f 317 *
j3 0:b00c4699ae6f 318 * //see datasheet for calendar format
j3 0:b00c4699ae6f 319 * ds3231_calendar_t calendar = {1, 1, 1, 0};
j3 0:b00c4699ae6f 320 * uint16_t rtn_val;
j3 0:b00c4699ae6f 321 *
j3 0:b00c4699ae6f 322 * rtn_val = rtc.set_calendar(calendar);
j3 0:b00c4699ae6f 323 *
j3 0:b00c4699ae6f 324 * @endcode
j3 0:b00c4699ae6f 325 **************************************************************/
j3 0:b00c4699ae6f 326 uint16_t set_calendar(ds3231_calendar_t calendar);
j3 0:b00c4699ae6f 327
j3 0:b00c4699ae6f 328
j3 0:b00c4699ae6f 329 /**********************************************************//**
j3 0:b00c4699ae6f 330 * Set either Alarm1 or Alarm2 of DS3231
j3 0:b00c4699ae6f 331 *
j3 0:b00c4699ae6f 332 * On Entry:
j3 0:b00c4699ae6f 333 * @param[in] alarm - struct cotaining alarm data
j3 3:312589d8185c 334 *
j3 0:b00c4699ae6f 335 * @param[in] one_r_two - TRUE for Alarm1 and FALSE for
j3 0:b00c4699ae6f 336 * Alarm2
j3 0:b00c4699ae6f 337 *
j3 0:b00c4699ae6f 338 * On Exit:
j3 0:b00c4699ae6f 339 * @return return value = 0 on success, non-0 on failure
j3 0:b00c4699ae6f 340 *
j3 0:b00c4699ae6f 341 * Example:
j3 0:b00c4699ae6f 342 * @code
j3 0:b00c4699ae6f 343 *
j3 0:b00c4699ae6f 344 * //instantiate rtc object
j3 1:c814af60fdbf 345 * Ds3231 rtc(D14, D15);
j3 0:b00c4699ae6f 346 *
j3 4:0beb5e9ac927 347 * //see ds3231.h for .members and datasheet for alarm format
j3 4:0beb5e9ac927 348 * ds3231_alrm_t alarm;
j3 0:b00c4699ae6f 349 * uint16_t rtn_val;
j3 0:b00c4699ae6f 350 *
j3 0:b00c4699ae6f 351 * rtn_val = rtc.set_alarm(alarm, FALSE);
j3 0:b00c4699ae6f 352 *
j3 0:b00c4699ae6f 353 * @endcode
j3 0:b00c4699ae6f 354 **************************************************************/
j3 0:b00c4699ae6f 355 uint16_t set_alarm(ds3231_alrm_t alarm, bool one_r_two);
j3 0:b00c4699ae6f 356
j3 0:b00c4699ae6f 357
j3 0:b00c4699ae6f 358 /**********************************************************//**
j3 0:b00c4699ae6f 359 * Set control and status registers of DS3231
j3 0:b00c4699ae6f 360 *
j3 0:b00c4699ae6f 361 * On Entry:
j3 0:b00c4699ae6f 362 * @param[in] data - Struct containing control and status
j3 0:b00c4699ae6f 363 * register data
j3 0:b00c4699ae6f 364 *
j3 0:b00c4699ae6f 365 * On Exit:
j3 0:b00c4699ae6f 366 * @return return value = 0 on success, non-0 on failure
j3 0:b00c4699ae6f 367 *
j3 0:b00c4699ae6f 368 * Example:
j3 0:b00c4699ae6f 369 * @code
j3 0:b00c4699ae6f 370 *
j3 0:b00c4699ae6f 371 * //instantiate rtc object
j3 1:c814af60fdbf 372 * Ds3231 rtc(D14, D15);
j3 0:b00c4699ae6f 373 *
j3 0:b00c4699ae6f 374 * //do not use 0xAA, see datasheet for appropriate data
j3 0:b00c4699ae6f 375 * ds3231_cntl_stat_t data = {0xAA, 0xAA};
j3 0:b00c4699ae6f 376 *
j3 0:b00c4699ae6f 377 * rtn_val = rtc.set_cntl_stat_reg(data);
j3 0:b00c4699ae6f 378 *
j3 0:b00c4699ae6f 379 * @endcode
j3 0:b00c4699ae6f 380 **************************************************************/
j3 0:b00c4699ae6f 381 uint16_t set_cntl_stat_reg(ds3231_cntl_stat_t data);
j3 0:b00c4699ae6f 382
j3 0:b00c4699ae6f 383
j3 0:b00c4699ae6f 384 /**********************************************************//**
j3 0:b00c4699ae6f 385 * Gets the time on DS3231
j3 0:b00c4699ae6f 386 *
j3 0:b00c4699ae6f 387 * On Entry:
j3 4:0beb5e9ac927 388 * @param[in] time - pointer to struct for storing time data
j3 0:b00c4699ae6f 389 *
j3 0:b00c4699ae6f 390 * On Exit:
j3 2:4e6e761c60f2 391 * @param[out] time - contains current integrer rtc time
j3 2:4e6e761c60f2 392 * data
j3 0:b00c4699ae6f 393 * @return return value = 0 on success, non-0 on failure
j3 0:b00c4699ae6f 394 *
j3 0:b00c4699ae6f 395 * Example:
j3 0:b00c4699ae6f 396 * @code
j3 0:b00c4699ae6f 397 *
j3 0:b00c4699ae6f 398 * //instantiate rtc object
j3 1:c814af60fdbf 399 * Ds3231 rtc(D14, D15);
j3 0:b00c4699ae6f 400 *
j3 4:0beb5e9ac927 401 * //time = 12:00:00 AM 12hr mode
j3 4:0beb5e9ac927 402 * ds3231_time_t time = {12, 0, 0, 0, 1}
j3 0:b00c4699ae6f 403 * uint16_t rtn_val;
j3 0:b00c4699ae6f 404 *
j3 3:312589d8185c 405 * rtn_val = rtc.get_time(&time);
j3 0:b00c4699ae6f 406 *
j3 0:b00c4699ae6f 407 * @endcode
j3 0:b00c4699ae6f 408 **************************************************************/
j3 2:4e6e761c60f2 409 uint16_t get_time(ds3231_time_t* time);
j3 0:b00c4699ae6f 410
j3 0:b00c4699ae6f 411
j3 0:b00c4699ae6f 412 /**********************************************************//**
j3 0:b00c4699ae6f 413 * Gets the calendar on DS3231
j3 0:b00c4699ae6f 414 *
j3 0:b00c4699ae6f 415 * On Entry:
j3 2:4e6e761c60f2 416 * @param[in] calendar - pointer to struct for storing
j3 4:0beb5e9ac927 417 * calendar data
j3 0:b00c4699ae6f 418 *
j3 0:b00c4699ae6f 419 * On Exit:
j3 2:4e6e761c60f2 420 * @param[out] calendar - contains current integer rtc
j3 2:4e6e761c60f2 421 * calendar data
j3 0:b00c4699ae6f 422 * @return return value = 0 on success, non-0 on failure
j3 0:b00c4699ae6f 423 *
j3 0:b00c4699ae6f 424 * Example:
j3 0:b00c4699ae6f 425 * @code
j3 0:b00c4699ae6f 426 *
j3 0:b00c4699ae6f 427 * //instantiate rtc object
j3 1:c814af60fdbf 428 * Ds3231 rtc(D14, D15);
j3 0:b00c4699ae6f 429 *
j3 0:b00c4699ae6f 430 * //see datasheet for calendar format
j3 0:b00c4699ae6f 431 * ds3231_calendar_t calendar = {1, 1, 1, 0};
j3 0:b00c4699ae6f 432 * uint16_t rtn_val;
j3 0:b00c4699ae6f 433 *
j3 3:312589d8185c 434 * rtn_val = rtc.get_calendar(&calendar);
j3 0:b00c4699ae6f 435 *
j3 0:b00c4699ae6f 436 * @endcode
j3 0:b00c4699ae6f 437 **************************************************************/
j3 2:4e6e761c60f2 438 uint16_t get_calendar(ds3231_calendar_t* calendar);
j3 0:b00c4699ae6f 439
j3 0:b00c4699ae6f 440
j3 0:b00c4699ae6f 441 /**********************************************************//**
j3 0:b00c4699ae6f 442 * Get either Alarm1 or Alarm2 of DS3231
j3 0:b00c4699ae6f 443 *
j3 0:b00c4699ae6f 444 * On Entry:
j3 2:4e6e761c60f2 445 * @param[in] alarm - pointer to struct for storing alarm
j3 2:4e6e761c60f2 446 * data;
j3 2:4e6e761c60f2 447 *
j3 0:b00c4699ae6f 448 * @param[in] one_r_two - TRUE for Alarm1 and FALSE for
j3 0:b00c4699ae6f 449 * Alarm2
j3 0:b00c4699ae6f 450 *
j3 0:b00c4699ae6f 451 * On Exit:
j3 2:4e6e761c60f2 452 * @param[out] alarm - contains integer alarm data
j3 0:b00c4699ae6f 453 * @return return value = 0 on success, non-0 on failure
j3 0:b00c4699ae6f 454 *
j3 0:b00c4699ae6f 455 * Example:
j3 0:b00c4699ae6f 456 * @code
j3 0:b00c4699ae6f 457 *
j3 0:b00c4699ae6f 458 * //instantiate rtc object
j3 1:c814af60fdbf 459 * Ds3231 rtc(D14, D15);
j3 0:b00c4699ae6f 460 *
j3 4:0beb5e9ac927 461 * //see ds3231.h for .members and datasheet for alarm format
j3 4:0beb5e9ac927 462 * ds3231_alrm_t alarm;
j3 0:b00c4699ae6f 463 * uint16_t rtn_val;
j3 0:b00c4699ae6f 464 *
j3 3:312589d8185c 465 * rtn_val = rtc.get_alarm(&alarm, FALSE);
j3 0:b00c4699ae6f 466 *
j3 0:b00c4699ae6f 467 * @endcode
j3 0:b00c4699ae6f 468 **************************************************************/
j3 2:4e6e761c60f2 469 uint16_t get_alarm(ds3231_alrm_t* alarm, bool one_r_two);
j3 0:b00c4699ae6f 470
j3 0:b00c4699ae6f 471
j3 0:b00c4699ae6f 472 /**********************************************************//**
j3 0:b00c4699ae6f 473 * Get control and status registers of DS3231
j3 0:b00c4699ae6f 474 *
j3 0:b00c4699ae6f 475 * On Entry:
j3 2:4e6e761c60f2 476 * @param[in] data - pointer to struct for storing control
j3 4:0beb5e9ac927 477 * and status register data
j3 0:b00c4699ae6f 478 *
j3 0:b00c4699ae6f 479 * On Exit:
j3 0:b00c4699ae6f 480 * @param[out] data - contains control and status registers
j3 0:b00c4699ae6f 481 * data
j3 0:b00c4699ae6f 482 * @return return value = 0 on success, non-0 on failure
j3 0:b00c4699ae6f 483 *
j3 0:b00c4699ae6f 484 * Example:
j3 0:b00c4699ae6f 485 * @code
j3 0:b00c4699ae6f 486 *
j3 0:b00c4699ae6f 487 * //instantiate rtc object
j3 1:c814af60fdbf 488 * Ds3231 rtc(D14, D15);
j3 0:b00c4699ae6f 489 *
j3 0:b00c4699ae6f 490 * //do not use 0xAA, see datasheet for appropriate data
j3 0:b00c4699ae6f 491 * ds3231_cntl_stat_t data = {0xAA, 0xAA};
j3 0:b00c4699ae6f 492 *
j3 3:312589d8185c 493 * rtn_val = rtc.get_cntl_stat_reg(&data);
j3 0:b00c4699ae6f 494 *
j3 0:b00c4699ae6f 495 * @endcode
j3 0:b00c4699ae6f 496 **************************************************************/
j3 2:4e6e761c60f2 497 uint16_t get_cntl_stat_reg(ds3231_cntl_stat_t* data);
j3 0:b00c4699ae6f 498
j3 0:b00c4699ae6f 499
j3 0:b00c4699ae6f 500 /**********************************************************//**
j3 0:b00c4699ae6f 501 * Get temperature data of DS3231
j3 0:b00c4699ae6f 502 *
j3 0:b00c4699ae6f 503 * On Entry:
j3 0:b00c4699ae6f 504 *
j3 0:b00c4699ae6f 505 * On Exit:
j3 2:4e6e761c60f2 506 * @return return value = raw temperature data
j3 0:b00c4699ae6f 507 *
j3 0:b00c4699ae6f 508 * Example:
j3 0:b00c4699ae6f 509 * @code
j3 0:b00c4699ae6f 510 *
j3 0:b00c4699ae6f 511 * //instantiate rtc object
j3 1:c814af60fdbf 512 * Ds3231 rtc(D14, D15);
j3 0:b00c4699ae6f 513 *
j3 0:b00c4699ae6f 514 * uint16_t temp;
j3 0:b00c4699ae6f 515 *
j3 2:4e6e761c60f2 516 * temp = rtc.get_temperature();
j3 0:b00c4699ae6f 517 *
j3 0:b00c4699ae6f 518 * @endcode
j3 0:b00c4699ae6f 519 **************************************************************/
j3 2:4e6e761c60f2 520 uint16_t get_temperature(void);
j3 0:b00c4699ae6f 521
j3 5:61dfe2690360 522
j3 5:61dfe2690360 523 /**********************************************************//**
j3 5:61dfe2690360 524 * Get epoch time based on current RTC time and date.
j3 5:61dfe2690360 525 * DS3231 must be configured and running before this fx is
j3 5:61dfe2690360 526 * called
j3 5:61dfe2690360 527 *
j3 5:61dfe2690360 528 * On Entry:
j3 5:61dfe2690360 529 *
j3 5:61dfe2690360 530 * On Exit:
j3 5:61dfe2690360 531 * @return return value = epoch time
j3 5:61dfe2690360 532 *
j3 5:61dfe2690360 533 * Example:
j3 5:61dfe2690360 534 * @code
j3 5:61dfe2690360 535 *
j3 5:61dfe2690360 536 * //instantiate rtc object
j3 5:61dfe2690360 537 * Ds3231 rtc(D14, D15);
j3 5:61dfe2690360 538 *
j3 5:61dfe2690360 539 * time_t epoch_time;
j3 5:61dfe2690360 540 *
j3 5:61dfe2690360 541 * epoch_time = rtc.get_epoch();
j3 5:61dfe2690360 542 *
j3 5:61dfe2690360 543 * @endcode
j3 5:61dfe2690360 544 **************************************************************/
j3 5:61dfe2690360 545 time_t get_epoch(void);
j3 5:61dfe2690360 546
j3 0:b00c4699ae6f 547 };
j3 0:b00c4699ae6f 548 #endif /* DS3231_H*/