Skip to content

Commit 5b8aa4f

Browse files
author
Jack Christensen
committed
Correct doc for calibWrite().
1 parent 68ea5a2 commit 5b8aa4f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

ReadMe.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -275,10 +275,11 @@ CALIBRATION, POWER FAILURE DETECTION, AND MISCELLANEOUS FUNCTIONS
275275

276276
--------------------------------------------------------------------------------
277277
calibWrite(int value) writes the given value to the RTC calibration register.
278-
This is an adjustment factor in PPM, and must be between -127 and 127.
278+
This is an adjustment factor in PPM, and must be between -127 and 127. Negative
279+
numbers cause the RTC to run faster, positive numbers cause it to run slower.
279280

280-
RTC.calibWrite(13); //makes the RTC run faster by 13 parts per million.
281-
RTC.calibWrite(-42); //makes the RTC run slower by 42 parts per million.
281+
RTC.calibWrite(13); //makes the RTC run slower by 13 parts per million.
282+
RTC.calibWrite(-42); //makes the RTC run faster by 42 parts per million.
282283

283284
--------------------------------------------------------------------------------
284285
calibRead(void) returns the value of the RTC calibration register.
@@ -333,3 +334,4 @@ idRead(byte *uniqueID) returns the 64-bit unique ID from the RTC into the given
333334

334335
byte buf[8];
335336
RTC.idRead(buf);
337+

0 commit comments

Comments
 (0)