Skip to content

Commit fb81547

Browse files
author
JChristensen
committed
Documentation edits.
1 parent 44706fb commit fb81547

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Arduino MCP79412 RTC Library v1.0 #
22
https://github.com/JChristensen/MCP79412RTC
33
LICENSE file
4-
Jack Christensen Mar 2012
4+
Jack Christensen Sep 2012
55

66
![CC BY-SA](http://mirrors.creativecommons.org/presskit/buttons/88x31/png/by-sa.png)
77
## CC BY-SA ##

MCP79412RTC.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ MCP79412RTC::MCP79412RTC()
3737
* Read the current time from the RTC and return it as a time_t value. *
3838
* Returns a zero value if RTC not present (I2C I/O error). *
3939
*----------------------------------------------------------------------*/
40-
time_t MCP79412RTC::get()
40+
time_t MCP79412RTC::get(void)
4141
{
4242
tmElements_t tm;
4343

ReadMe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ To use the **MCP79412RTC** library, the Time and Wire libraries must also be inc
5050

5151
###get(void)
5252
#####Description
53-
Reads the current date and time from the RTC and returns it as a *time_t* value.
53+
Reads the current date and time from the RTC and returns it as a *time_t* value. Returns zero if an I2C error occurs (RTC not present, etc.).
5454
#####Syntax
5555
`RTC.get();`
5656
#####Parameters
@@ -83,13 +83,13 @@ RTC.set(now()); //set the RTC from the system time
8383
8484
###read(tmElements_t &tm)
8585
#####Description
86-
Reads the current date and time from the RTC and returns it as a *tmElements_t* structure. See the [Arduino Time library](http://www.arduino.cc/playground/Code/Time) for details on the *tmElements_t* structure.
86+
Reads the current date and time from the RTC and returns it as a *tmElements_t* structure. Returns *false* if an I2C error occurs (RTC not present, etc.). See the [Arduino Time library](http://www.arduino.cc/playground/Code/Time) for details on the *tmElements_t* structure.
8787
#####Syntax
8888
`RTC.read(tm);`
8989
#####Parameters
9090
**tm:** Address of a *tmElements_t* structure to which the date and time are returned.
9191
#####Returns
92-
No function value returned. The date and time read from the RTC are returned to the **tm** parameter.
92+
False if an I2C error occurred, else true. The date and time read from the RTC are returned to the **tm** parameter.
9393
#####Example
9494
```c++
9595
tmElements_t tm;

0 commit comments

Comments
 (0)