Skip to content

Commit

Permalink
correction of typos
Browse files Browse the repository at this point in the history
  • Loading branch information
hasenradball committed Dec 5, 2023
1 parent 6a70f96 commit 3f5c47c
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Documentation/Alarms.md
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ bool checkIfAlarm(byte Alarm);

NOTE TO PROGRAMMERS: this version of the method always overwrites the value of the alarm flag to zero. An alternate version, below, allows programs an option to preserve the value of the flag in the DS3231.

It may be desirable to do so in programs that re-use a single alarm repeatedly.
It may be desirable to do so in programs that reuse a single alarm repeatedly.

The flag value is returned to the program, where it may be assigned to a program variable for later evaluation and use.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/Utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ An algorithm is developed to divide the 65,536 interrupts into ten, nearly-equal

Dividing by other values can be approached similarly. The program writer would need to work out the applicable numbers of steps and interval lengths.

Comments in the example provide additional documentaiton.
Comments in the example provide additional documentation.

```
#include <DS3231-RTC.h>
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You do have to install the Library in your Arduino IDE environment before you ca
This library was based on the master branch of [NorthernWidget/DS3231](https://github.com/NorthernWidget/DS3231) Library in Oct/2023. It was reworked and refractured with respect of the following main topics:
* using standardized functions of the `time.h` library.
* introduce a `struct tm` which holds all relevant date and time values.
* restrucure comments, so that syntax highlighting works fine.
* restructure comments, so that syntax highlighting works fine.
* add a `strf_DateTime()` function with can be used to print a user specific(self defined) DateTime string easily.

## Contents
Expand Down Expand Up @@ -86,7 +86,7 @@ The Library incorporates two other classes to assist with managing `date` and `t
* `DateTime` class enables a object for managing date and time data.
* `RTClib` class institutes a convenient `RTClib::now()` function for receiving a date/time snapshot, as a DateTime object, from the DS3231 device.

The `DateTime` class can be instanciated by a specific date and time in three different ways:
The `DateTime` class can be instantiated by a specific date and time in three different ways:

* 1.) by distinct values for:<br>
year, month, day, hour, minute and second
Expand All @@ -97,7 +97,7 @@ year, month, day, hour, minute and second

* 3.) by giving a separate `const char *` string for Date and Time like:<br>
`"Feb 16 2022"` and `"14:05:00"`<br>
This can be also achived by usage on the precomoiler Tags `__DATE__` and `__TIME__`.
This can be also achieved by usage on the precompiler Tags `__DATE__` and `__TIME__`.



Expand Down Expand Up @@ -293,7 +293,7 @@ The function returns a DateTime object. To use it in your program, declare a Dat
The value of `currentMoment` can then be accessed as either:
* getting an unsigned integer containing the number of seconds since a certain reference date (Unix-Time or Y2K-Time)
* distinct values out of the `struct tm` for Year, Month, Day, Date, Hour, Minute, Second etc...<br>
see [Definiton of struct tm](https://en.cppreference.com/w/c/chrono/tm).
see [Definition of struct tm](https://en.cppreference.com/w/c/chrono/tm).

[back to the list of functions](#functions)<br>
[back to top](#ds3231-rtc-library)
Expand Down
8 changes: 4 additions & 4 deletions extras/bytemap/bytemap.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ struct bits3231 {
unsigned :1; // skip high bit
// 01h time minutes 00 - 59
unsigned timeMin:4; // minutes digit 0 - 9
unsigned timeMin10:3; // tens of minuts digit 0 - 5
unsigned timeMin10:3; // tens of minutes digit 0 - 5
unsigned: 1; // skip high bit
// 02h time hour 1 - 12 or 0 - 23
unsigned timeHour:4; // hours digit 0 - 9
Expand Down Expand Up @@ -35,7 +35,7 @@ struct bits3231 {
unsigned A1M1:1; // Alarm 1 Bit 1
// 08h Alarm 1 minutes 00 - 59
unsigned A1Min:4; // minutes digit 0 - 9
unsigned A1Min10:3; // tens of minuts digit 0 - 5
unsigned A1Min10:3; // tens of minutes digit 0 - 5
unsigned: A1M2; // Alarm 1 Bit 2
// 09h Alarm 1 hour 1 - 12 or 0 - 23
unsigned A1Hour:4; // hours digit 0 - 9
Expand All @@ -53,7 +53,7 @@ struct bits3231 {
//
// 0Bh Alarm 2 minutes 00 - 59
unsigned A2Min:4; // minutes digit 0 - 9
unsigned A2Min10:3; // tens of minuts digit 0 - 5
unsigned A2Min10:3; // tens of minutes digit 0 - 5
unsigned: A2M2; // Alarm 2 Bit 2
// 0Ch Alarm 2 hour 1 - 12 or 0 - 23
unsigned A2Hour:4; // hours digit 0 - 9
Expand All @@ -73,7 +73,7 @@ struct bits3231 {
unsigned RS2:1; // set square wave frequency
unsigned RS1:1; // set square wave frequency
unsigned INTCN:1; // interrupt control, high enables interrupt output
unsigned A2IE:1; // enbable interrupt on A2 match
unsigned A2IE:1; // enable interrupt on A2 match
unsigned A1IE:1; // enable interrupt on A1 match
// 0Fh Device control / status register
unsigned OSF:1; // oscillator stop flag
Expand Down

0 comments on commit 3f5c47c

Please sign in to comment.