1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Copyright (c) 2014 Intel Corporation.
*
* Adapted from Seeed Studio library:
* https://github.com/Seeed-Studio/RTC_DS1307
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#pragma once
#include <string>
#include <mraa/i2c.hpp>
#define DS1307_I2C_BUS 0
#define DS1307_I2C_ADDR 0x68
// Days of the week
#define DS1307_DAY_MON 1
#define DS1307_DAY_TUE 2
#define DS1307_DAY_WED 3
#define DS1307_DAY_THU 4
#define DS1307_DAY_FRI 5
#define DS1307_DAY_SAT 6
#define DS1307_DAY_SUN 7
namespace upm {
/**
* @brief DS1307 Real-Time Clock library
* @defgroup ds1307 libupm-ds1307
* @ingroup seeed i2c time
*/
/**
* @library ds1307
* @sensor ds1307
* @comname Grove RTC (Real-Time Clock)
* @altname DS1307 RTC
* @type time
* @man seeed
* @con i2c
*
* @brief API for the DS1307 Real-Time CLock
*
* UPM module for the DS1307-based real-time clock. The clock can provide information
* about seconds, minutes, hours, day of the week, day of the month,
* month, and year. It can operate in either a 24-hour or a 12-hour format.
* This device can also output a square wave at 1Khz, 4Khz, 8Khz, and 32Khz.
* However, this capability is not implemented in this module.
*
* @image html ds1307.jpg
* @snippet ds1307.cxx Interesting
*/
class DS1307 {
public:
/**
* DS1307 constructor
*
* @param bus I2C bus to use
*/
DS1307(int bus);
/**
* Loads all the time values
*
* @return True if time data loaded successfully
*/
bool loadTime();
/**
* Sets the time. You should call loadTime() beforehand to
* maintain consistency
*
* @return True if time is set successfully
*/
bool setTime();
/**
* Enables an oscillator on the clock.
*
* @return 0 (mraa::SUCCESS) if successful; non-zero otherwise
*/
mraa::Result enableClock();
/**
* Disables the oscillator on the clock. This prevents the clock
* from updating any time/date values
*
* @return 0 (mraa::SUCCESS) if successful; non-zero otherwise
*/
mraa::Result disableClock();
/**
* Writes value(s) into registers
*
* @param reg Register location to start writing into
* @param buffer Buffer for data storage
* @param len Number of bytes to write
* @return 0 (mraa::SUCCESS) if successful; non-zero otherwise
*/
mraa::Result writeBytes(uint8_t reg, uint8_t *buffer, int len);
/**
* Reads value(s) from registers
*
* @param reg Register location to start reading from
* @param buffer Buffer for data storage
* @param len Number of bytes to read
* @return Number of bytes read
*/
int readBytes(uint8_t reg, uint8_t *buffer, int len);
/**
* Converts a BCD value into decimal
*
* @param val BCD value to convert
* @return Converted decimal value
*/
unsigned int bcdToDec(uint8_t val);
/**
* Converts a decimal value into BCD
*
* @param val Decimal value to convert
* @return Converted BCD value
*/
uint8_t decToBcd(unsigned int val);
// These variables store the time data loaded with loadTime(), and
// are the source of data when setTime() is called. It is a
// good idea to call loadTime() to set up the current values before
// calling setTime() to ensure RTC data is consistent
/**
* Holds seconds
*/
unsigned int seconds;
/**
* Holds minutes
*/
unsigned int minutes;
/**
* Holds hours; 1-12 in the am/pm format, 0-23 otherwise
*/
unsigned int hours;
/**
* Holds a day of the week; 1-7, where 1 is Sunday
*/
unsigned int dayOfWeek;
/**
* Holds a day of the month, 1-31
*/
unsigned int dayOfMonth;
/**
* Holds a month, 1-12
*/
unsigned int month;
/**
* Holds a year, 0-99
*/
unsigned int year;
/**
* True if the am/pm format is used, false otherwise
*/
bool amPmMode;
/**
* For the am/pm format, it is true if it's pm, false otherwise
*/
bool pm;
private:
mraa::I2c m_i2c;
};
}
|
