Pseudo real-time clock using Ticker interruption, also implements time() and set_time() for platforms that don't (such as mBuino)
Fork of PseudoRTC by
PseudoRTC.h
- Committer:
- maxint
- Date:
- 2015-08-03
- Revision:
- 3:c8bfeb8a2989
- Parent:
- 2:7d153bc7403f
File content as of revision 3:c8bfeb8a2989:
/* Copyright (c) 2014 Shigenori Inoue, MIT License * * Permission is hereby granted, free of charge, to any person obtaining a copy of this software * and associated documentation files (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, publish, distribute, * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all copies or * substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef __PseudoRTC__ #define __PseudoRTC__ #include "mbed.h" /** Example: * @code * #include "mbed.h" * #include "PseudoRTC.h" * * PseudoRTC c; * * main() * { * time_t seconds; * char buffer[32]; * c.set_time(1256729737); // Set RTC time to Wed, 28 Oct 2009 11:35:37 (NOW WORKING ON mBuino) * * seconds=c.time(NULL); * printf("Time as seconds since January 1, 1970 = %d\r\n", seconds); * printf("Time as a basic string = %s\r", ctime(&seconds)); // ctime includes \n * strftime(buffer, 32, "%I:%M %p", localtime(&seconds)); * printf("Time as a custom formatted string = %s\r\n", buffer); * * c.setTime(2014, 09, 20, 21, 05, 30); // Second example: September 20, 2014, 21:05:30 * while(true) { * printf("%04d/%02d/%02d %02d:%02d:%02d\r\m", c.getYear(), c.getMonth(), c.getDay(), c.getHour(), c.getMinute(), c.getSecond()); * wait(1); * } * } * @endcode */ class PseudoRTC { public: /** Create a pseudo real-time clock */ PseudoRTC(void); ~PseudoRTC(void); /** Set time in the pseudo real-time clock * @param y Year * @param mo Month (1-12) * @param d Day (1-31) * @param h Hour (0-23) * @param m Minute (0-59) * @param s Second (0-59) */ void setTime(int y, int mo, int d, int h, int mi, int s); /** Set the time using a unix timestamp value (the number of seconds since January 1, 1970) * @param thetime unix time as time_t */ void set_time(time_t thetime); /** Get the unix timestamp value (the number of seconds since January 1, 1970) * @param timer Pointer to the time_t variable * @return time_t current timestamp */ time_t time(time_t *timer); /** add (or subtract) some seconds to the rtc to adjust time as needed * @param nSec number of seconds to add or subtract * @return time_t current timestamp */ time_t addSeconds(int nSec); /** Get the year value */ int getYear(void); /** Get the month value */ int getMonth(void); /** Get the day value */ int getDay(void); /** Get the hour value */ int getHour(void); /** Get the minute value */ int getMinute(void); /** Get the second value */ int getSecond(void); private: int year; int month; int day; int hour; int minute; int second; time_t unixtime; Ticker t; time_t toUnixTime(void); void tictoc(void); }; #endif