RTClibrary (community library)

Summary

A fork of Jeelab's fantastic RTC library A fork of Jeelab's fantastic RTC library

Example Build Testing

Library Read Me

This content is provided by the library maintainer and has not been validated or approved.

RTClibrary

A Particle library for RTClibrary

Welcome to your library!

To get started, modify the sources in src. Rename the example folder inside examples to a more meaningful name and add additional examples in separate folders.

To compile your example you can use particle compile examples/usage command in Particle CLI or use our Desktop IDE.

Libraries can also depend on other libraries. To add a dependency use particle library add or library management in Desktop IDE.

After the library is done you can upload it with particle library upload or Upload command in the IDE. This will create a private (only visible by you) library that you can use in other projects. If you wish to make your library public, use particle library publish or Publish command.

TODO: update this README

Usage

Connect XYZ hardware, add the RTClibrary library to your project and follow this simple example:

#include "RTClibrary.h"
RTClibrary rTClibrary;

void setup() {
rTClibrary.begin();
}

void loop() {
rTClibrary.process();
}

See the examples folder for more details.

Documentation

TODO: Describe RTClibrary

Contributing

Here's how you can make changes to this library and eventually contribute those changes back.

To get started, clone the library from GitHub to your local machine.

Change the name of the library in library.properties to something different. You can add your name at then end.

Modify the sources in and with the new behavior.

To compile an example, use particle compile examples/usage command in Particle CLI or use our Desktop IDE.

After your changes are done you can upload them with particle library upload or Upload command in the IDE. This will create a private (only visible by you) library that you can use in other projects. Do particle library add RTClibrary_myname to add the library to a project on your machine or add the RTClibrary_myname library to a project on the Web IDE or Desktop IDE.

At this point, you can create a GitHub pull request with your changes to the original library.

If you wish to make your library public, use particle library publish or Publish command.

LICENSE

Copyright 2018 Adafruit

Licensed under the license

This is a fork of JeeLab's fantastic real time clock library for Arduino.

For details on using this library with an RTC module like the DS1307, PCF8523, or DS3231, see the guide at: https://learn.adafruit.com/ds1307-real-time-clock-breakout-board-kit/overview

To download. click the DOWNLOADS button to the right, and rename the uncompressed folder RTClib.

Place the RTClib folder in your arduinosketchfolder/libraries/ folder. You may need to create the libraries subfolder if its your first library. Restart the IDE.

Please note that dayOfTheWeek() ranges from 0 to 6 inclusive with 0 being 'Sunday'

Compatibility

• ATmega328 @ 16MHz : Arduino UNO, Adafruit Pro Trinket 5V, Adafruit Metro 328, Adafruit Metro Mini
• ATmega328 @ 12MHz : Adafruit Pro Trinket 3V
• ATmega32u4 @ 16MHz : Arduino Leonardo, Arduino Micro, Arduino Yun, Teensy 2.0
• ATmega32u4 @ 8MHz : Adafruit Flora, Bluefruit Micro
• ESP8266 : Adafruit Huzzah
• ATmega2560 @ 16MHz : Arduino Mega
• ATSAM3X8E : Arduino Due
• ATSAM21D : Arduino Zero, M0 Pro
• ATtiny85 @ 16MHz : Adafruit Trinket 5V
• ATtiny85 @ 8MHz : Adafruit Gemma, Arduino Gemma, Adafruit Trinket 3V

Browse Library Files