Skip to content

Commit 44706fb

Browse files
author
JChristensen
committed
Minor ReadMe update
1 parent 42748ae commit 44706fb

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

ReadMe.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
#Arduino MCP79412 RTC Library v1.0
1+
# Arduino MCP79412 RTC Library v1.0 #
22
https://github.com/JChristensen/MCP79412RTC
33
ReadMe file
44
Jack Christensen Sep 2012
55

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

8-
##Introduction
8+
## Introduction ##
99
**MCP79412RTC** is an Arduino library that supports the Microchip MCP79412 Real-Time Clock/Calendar. It is intended to be used with the [Arduino Time library] (http://www.arduino.cc/playground/Code/Time).
1010

1111
The **MCP79412RTC** library is a drop-in replacement for the **DS1307RTC** library by Michael Margolis that is supplied with the [Arduino Time library](http://www.arduino.cc/playground/Code/Time). To change from using a DS1307 RTC to an MCP79412 RTC, it is only necessary to use `#include <MCP79412RTC.h>` instead of `#include <DS1307RTC.h>`.
@@ -18,14 +18,14 @@ The **MCP79412RTC** library also implements methods to support the additional fe
1818
The [Microchip MCP79412 Product Page](http://goo.gl/SHfKe0) for specs, datasheet, etc.
1919
MCP79412 breakout boards are available at [my Tindie Store](http://goo.gl/UzAVcZ)
2020

21-
##Installation
21+
## Installation ##
2222
To use the **MCP79412RTC** library:
2323
- Go to https://github.com/JChristensen/MCP79412RTC, click the **Download ZIP** button and save the ZIP file to a convenient location on your PC.
2424
- Uncompress the downloaded file. This will result in a folder containing all the files for the library, that has a name that includes the branch name, usually **MCP79412RTC-master**.
2525
- Rename the folder to just **MCP79412RTC**.
2626
- Copy the renamed folder to the Arduino sketchbook\libraries folder.
2727

28-
##Examples
28+
## Examples ##
2929
The following example sketches are included with the **MCP79412RTC** library:
3030
- **rtcSet1:** Set the RTC date and time using a hard-coded value in the sketch.
3131
- **rtcSet2:** Similar to **rtcSet1**, a different way to hard-code the date and time.
@@ -36,7 +36,7 @@ The following example sketches are included with the **MCP79412RTC** library:
3636
- **PowerOutageLogger:** A comprehensive example that implements a power failure logger using the MCP79412's ability to capture power down and power up times. Power failure events are logged to the MCP79412's SRAM. Output is to the Arduino serial monitor.
3737
- **tiny79412_KnockBang:** Demonstrates interfacing an ATtiny45/85 to the MCP79412.
3838

39-
#Usage notes
39+
## Usage notes ##
4040
Similar to the **DS1307RTC** library, the **MCP79412RTC** library instantiates an RTC object; the user does not need to do this.
4141

4242
To use the **MCP79412RTC** library, the Time and Wire libraries must also be included. For brevity, these includes are not repeated in the examples below:
@@ -46,7 +46,7 @@ To use the **MCP79412RTC** library, the Time and Wire libraries must also be inc
4646
#include <Wire.h> //http://arduino.cc/en/Reference/Wire (included with Arduino IDE)
4747
```
4848

49-
##Methods for setting and reading the time
49+
## Methods for setting and reading the time ##
5050

5151
###get(void)
5252
#####Description
@@ -139,7 +139,7 @@ else
139139
//do something else
140140
```
141141

142-
##Methods for reading and writing static RAM (SRAM)
142+
## Methods for reading and writing static RAM (SRAM) ##
143143
The MCP79412 RTC has 64 bytes of battery-backed SRAM that can be read and written with the following methods using addresses between 0 and 63. Addresses passed to these functions are constrained to the valid range by an AND function.
144144

145145
###sramWrite(byte addr, byte value)
@@ -208,7 +208,7 @@ byte buf[8];
208208
RTC.sramRead(56, buf, 8);
209209
```
210210

211-
##Methods for Reading and writing EEPROM
211+
## Methods for Reading and writing EEPROM ##
212212
The MCP79412 RTC has 128 bytes of non-volatile EEPROM that can be read and written with the following methods using addresses between 0 and 127. Addresses passed to these functions are constrained to the valid range by an AND function.
213213

214214
EEPROM is paged memory with a page size of 8 bytes; when writing multiple bytes, this this limits the number of bytes that can be written at one time to 8. Page writes must start on a page boundary.
@@ -279,7 +279,7 @@ byte buf[8];
279279
RTC.eepromRead(120, buf, 8);
280280
```
281281

282-
##Alarm methods
282+
## Alarm methods ##
283283
The MCP79412 RTC has two alarms (Alarm-0 and Alarm-1) that can be used separately or simultaneously. When an alarm is triggered, a flag is set in the RTC that can be detected with the `alarm()` function below. Optionally, the RTC's Multi-Function Pin (MFP) can be driven to either a low or high logic level when an alarm is triggered. When using the MFP with both alarms, be sure to read the comments on the `alarmPolarity()` function below.
284284

285285
###setAlarm(byte alarmNumber, time_t alarmTime)
@@ -362,7 +362,7 @@ None.
362362
RTC.alarmPolarity(HIGH); //drives MFP high when an alarm is triggered
363363
```
364364

365-
##Calibration, power failure, and other methods
365+
## Calibration, power failure, and other methods ##
366366

367367
###calibWrite(int value)
368368
#####Description

0 commit comments

Comments
 (0)