feedc0de/ArduinoTime
1
0
Fork 0
forked from PaulStoffregen/Time
Code Pull Requests Activity

Merge pull request #72 from halx4/master

Browse Source 
corrected minor typos in readme.md
This commit is contained in:
Paul Stoffregen
2017-12-13 05:02:51 -08:00
committed by GitHub
parent 0473efe605 2ad08f3bca
commit 75089afd3a
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Readme.md
View File

@ -3,7 +3,7 @@
Time is a library that provides timekeeping functionality for Arduino. Time is a library that provides timekeeping functionality for Arduino.
The code is derived from the Playground DateTime library but is updated The code is derived from the Playground DateTime library but is updated
to provide an API that is more flexable and easier to use. to provide an API that is more flexible and easier to use.
A primary goal was to enable date and time functionality that can be used with A primary goal was to enable date and time functionality that can be used with
a variety of external time sources with minimum differences required in sketch logic. a variety of external time sources with minimum differences required in sketch logic.
@ -26,7 +26,7 @@ month(); // the month now (1-12)
year(); // the full four digit year: (2009, 2010 etc) year(); // the full four digit year: (2009, 2010 etc)
``` ```
there are also functions to return the hour in 12 hour format there are also functions to return the hour in 12-hour format
```c ```c
hourFormat12(); // the hour now in 12 hour format hourFormat12(); // the hour now in 12 hour format
@ -39,7 +39,7 @@ now(); // returns the current time as seconds since Jan 1 1970
The time and date functions can take an optional parameter for the time. This prevents The time and date functions can take an optional parameter for the time. This prevents
errors if the time rolls over between elements. For example, if a new minute begins errors if the time rolls over between elements. For example, if a new minute begins
between getting the minute and second, the values will be inconsistent. Using the between getting the minute and second, the values will be inconsistent. Using the
following functions eliminates this probglem following functions eliminates this problem
```c ```c
time_t t = now(); // store the current time in time variable t time_t t = now(); // store the current time in time variable t
@ -61,12 +61,12 @@ setTime(hr,min,sec,day,mnth,yr); // alternative to above, yr is 2 or 4 digit yr
adjustTime(adjustment); // adjust system time by adding the adjustment value adjustTime(adjustment); // adjust system time by adding the adjustment value
timeStatus(); // indicates if time has been set and recently synchronized timeStatus(); // indicates if time has been set and recently synchronized
// returns one of the following enumerations: // returns one of the following enumerations:
timeNotSet // the time has never been set, the clock started at Jan 1 1970 timeNotSet // the time has never been set, the clock started on Jan 1, 1970
timeNeedsSync // the time had been set but a sync attempt did not succeed timeNeedsSync // the time had been set but a sync attempt did not succeed
timeSet // the time is set and is synced timeSet // the time is set and is synced
``` ```
Time and Date values are not valid if the status is timeNotSet. Otherwise values can be used but Time and Date values are not valid if the status is timeNotSet. Otherwise, values can be used but
the returned time may have drifted if the status is timeNeedsSync. the returned time may have drifted if the status is timeNeedsSync.
```c ```c
@ -100,7 +100,7 @@ illustrating how the library can be used with various time sources:
- `TimeRTCSet` is similar to the above and adds the ability to set the Real Time Clock - `TimeRTCSet` is similar to the above and adds the ability to set the Real Time Clock
- `TimeRTCLog` demonstrates how to calculate the difference between times. - `TimeRTCLog` demonstrates how to calculate the difference between times.
It is a vary simple logger application that monitors events on digtial pins It is a very simple logger application that monitors events on digital pins
and prints (to the serial port) the time of an event and the time period since and prints (to the serial port) the time of an event and the time period since
the previous event. the previous event.
@ -121,15 +121,15 @@ Changes in the Time library API:
- time elements are functions returning `int` (they are variables in DateTime) - time elements are functions returning `int` (they are variables in DateTime)
- Years start from 1970 - Years start from 1970
- days of the week and months start from 1 (they start from 0 in DateTime) - days of the week and months start from 1 (they start from 0 in DateTime)
- DateStrings do not require a seperate library - DateStrings do not require a separate library
- time elements can be accessed non-atomically (in DateTime they are always atomic) - time elements can be accessed non-atomically (in DateTime they are always atomic)
- function added to automatically sync time with extrnal source - function added to automatically sync time with external source
- `localTime` and `maketime` parameters changed, `localTime` renamed to `breakTime` - `localTime` and `maketime` parameters changed, `localTime` renamed to `breakTime`
## Technical notes: ## Technical notes:
Internal system time is based on the standard Unix `time_t`. Internal system time is based on the standard Unix `time_t`.
The value is the number of seconds since Jan 1 1970. The value is the number of seconds since Jan 1, 1970.
System time begins at zero when the sketch starts. System time begins at zero when the sketch starts.
The internal time can be automatically synchronized at regular intervals to an external time source. The internal time can be automatically synchronized at regular intervals to an external time source.
@ -152,4 +152,4 @@ makeTime(&tm); // return time_t from elements stored in tm struct
``` ```
The DS1307RTC library included in the download provides an example of how a time provider The DS1307RTC library included in the download provides an example of how a time provider
can use the low level functions to interface with the Time library. can use the low-level functions to interface with the Time library.