Added javadoc comments

Author: marqdevx

src/utility/RTC/PCF8563T.cpp

@@ -28,7 +28,7 @@
 #define PCF8563T_MONTHS_REG     0x07
 #define PCF8563T_YEARS_REG      0x08
 
-// allarm management
+// allarm managemet
 #define PCF8563T_MINUTE_ALARM_REG 0x09
 #define PCF8563T_MINUTE_ALARM_AE_M_MASK 0x80
 #define PCF8563T_MINUTE_ALARM_ON 0x7F
@@ -49,10 +49,20 @@
 #define PCF8563T_STATUS_2_CLEAR_INT 0xF7
 #define PCF8563T_STATUS_2_INT_OFF 0x7d
 
+/**
+ *  Object constructor
+ *  
+ */   
 PCF8563TClass::PCF8563TClass()
 {
 }
 
+/**
+ *  Start the communication with the RTC
+ *  
+ *  @return true if the RTC Controller is on the I2C bus, false in case it is not in the bus.
+ * 
+ */   
 bool PCF8563TClass::begin()
 {
   Wire1.begin(); // join i2c bus
@@ -64,12 +74,22 @@ bool PCF8563TClass::begin()
   return false;
 }
 
+/**
+ *  Set Year number
+ *  
+ *  @param years  Year's number
+ */   
 void PCF8563TClass::setYears(uint8_t years) { 
   uint8_t dec = years / 10;
   uint8_t unit = years - (dec * 10);
   writeByte(PCF8563T_YEARS_REG, ((dec << 4) + unit));
 }
 
+/**
+ *  Set Month number
+ *  
+ *  @param months Month's number (0 to 12)
+ */   
 void PCF8563TClass::setMonths(uint8_t months) {
   uint8_t offset = 0;
   if (months > 9) {
@@ -78,35 +98,65 @@ void PCF8563TClass::setMonths(uint8_t months) {
   writeByte(PCF8563T_MONTHS_REG, months + offset);
 }
 
+/**
+ *  Set Day number
+ *  
+ *  @param days day's number
+ */   
 void PCF8563TClass::setDays(uint8_t days) {
   uint8_t dec = days / 10;
   uint8_t unit = days - (dec * 10);
   writeByte(PCF8563T_DAYS_REG, ((dec << 4) + unit));
 }
 
+/**
+ *  Set Hour
+ *  
+ *  @param hours  hour number
+ */   
 void PCF8563TClass::setHours(uint8_t hours) { 
   uint8_t dec = hours / 10;
   uint8_t unit = hours - (dec * 10);
   writeByte(PCF8563T_HOURS_REG, ((dec << 4) + unit)); //check formula on datasheet val + 6 * (val / 10)
 }
 
+/**
+ *  Set Minute
+ *  
+ *  @param minutes  minute number
+ */   
 void PCF8563TClass::setMinutes(uint8_t minutes) {
   uint8_t dec = minutes / 10;
   uint8_t unit = minutes - (dec * 10);
   writeByte(PCF8563T_MINUTES_REG, ((dec << 4) + unit));
 }
 
+/**
+ *  Set Second number
+ *  
+ *  @param seconds  Second number
+ */   
 void PCF8563TClass::setSeconds(uint8_t seconds) {
   uint8_t dec = seconds / 10;
   uint8_t unit = seconds - (dec * 10);
   writeByte(PCF8563T_VL_SECONDS_REG, ((dec << 4) + unit));
 }
 
+/**
+ *  Get Year number
+ *  
+ *  @return number of years
+ */   
 uint8_t PCF8563TClass::getYears() {
   uint8_t years = readByte(PCF8563T_YEARS_REG);
   return (years & 0x0F) + ((years >> 4)*10);
 }
 
+/**
+ *  Get Month number
+ *  
+ *  @return number of month
+ */
 uint8_t PCF8563TClass::getMonths() {
   uint8_t months = readByte(PCF8563T_MONTHS_REG) & 0x1F;
   if(months > 9) {
@@ -116,27 +166,50 @@ uint8_t PCF8563TClass::getMonths() {
   }
 }
 
+/**
+ *  Get Day number
+ *  
+ *  @return number of days
+ */
 uint8_t PCF8563TClass::getDays() {
   uint8_t days = readByte(PCF8563T_DAYS_REG);
   return (days & 0x0F) + ((days >> 4)*10);
 }
 
+/**
+ *  Get Hour number
+ *  
+ *  @return number of hours
+ */
 uint8_t PCF8563TClass::getHours() {
   uint8_t hours = readByte(PCF8563T_HOURS_REG) & 0x3F;
   return (hours & 0x0F) + ((hours >> 4)*10);
 }
 
+/**
+ *  Get Minute number
+ *  
+ *  @return number of minutes
+ */
 uint8_t PCF8563TClass::getMinutes() {
   uint8_t minutes = (readByte(PCF8563T_MINUTES_REG)) & 0x7F ;
   return (minutes & 0x0F) + ((minutes >> 4)*10);
 }
 
+/**
+ *  Get Second number
+ *  
+ *  @return number of seconds
+ */
 uint8_t PCF8563TClass::getSeconds() {
   uint8_t seconds = readByte(PCF8563T_VL_SECONDS_REG) & 0x7F;
   return (seconds & 0x0F) + ((seconds >> 4)*10);
 }
 
-
+/**
+ *  Set time by epoch
+ *  
+ */   
 void PCF8563TClass::setEpoch() {
   struct tm time;
   time.tm_sec = getSeconds();
@@ -150,6 +223,11 @@ void PCF8563TClass::setEpoch() {
   set_time(seconds);
 }
 
+/**
+ *  Set time by epoch
+ *  
+ *  @param seconds  number of seconds
+ */    
 void PCF8563TClass::setEpoch(time_t seconds) {
   struct tm time;
   _rtc_localtime(seconds, &time, RTC_FULL_LEAP_YEAR_SUPPORT);
@@ -163,7 +241,16 @@ void PCF8563TClass::setEpoch(time_t seconds) {
   set_time(seconds);
 }
 
-
+/**
+ *  Set time by epoch
+ *  
+ *  @param years  number of years
+ *  @param mohths number of months
+ *  @param days number of days
+ *  @param hours  number of hours
+ *  @param minutes number of minutes
+ *  @param seconds  number of seconds
+ */   
 void PCF8563TClass::setEpoch(uint8_t years, uint8_t months, uint8_t days, uint8_t hours, uint8_t minutes, uint8_t seconds) {
   struct tm time;
   time_t utcsec;
@@ -179,6 +266,11 @@ void PCF8563TClass::setEpoch(uint8_t years, uint8_t months, uint8_t days, uint8_
   set_time(utcsec);
 }
 
+/**
+ *  Get epoch number, convert real time to difference between actual time and epoch(Unix time)
+ *  
+ *  @return number of seconds after Unix time
+ */   
 time_t PCF8563TClass::getEpoch() {
   struct tm time;
   time_t seconds;
@@ -194,47 +286,87 @@ time_t PCF8563TClass::getEpoch() {
   return seconds;
 }
 
+/**
+ *  Enable alarm mode
+ *  
+ */   
 void PCF8563TClass::enableAlarm() {
   writeByte(PCF8563T_STATUS_2_REG, (readByte(PCF8563T_STATUS_2_REG) & PCF8563T_STATUS_2_CLEAR_INT) | PCF8563T_STATUS_2_AIE_MASK);
 }
 
+/**
+ *  Disable alarm mode
+ *  
+ */   
 void PCF8563TClass::disableAlarm() {
    writeByte(PCF8563T_STATUS_2_REG, (readByte(PCF8563T_STATUS_2_REG) & PCF8563T_STATUS_2_INT_OFF));
 }
 
+/**
+ *  Clear alarm status
+ *  
+ */   
 void PCF8563TClass::clearAlarm() {
   writeByte(PCF8563T_STATUS_2_REG, (readByte(PCF8563T_STATUS_2_REG) & PCF8563T_STATUS_2_CLEAR_INT) | PCF8563T_STATUS_2_AIE_MASK);
 }
 
+/**
+ *  Set alarm's minute
+ *  
+ *  @param minutes  minute number for the Aarm
+ *  @return none
+ */   
 void PCF8563TClass::setMinuteAlarm(uint8_t minutes) {
   uint8_t dec = minutes / 10;
   uint8_t unit = minutes - (dec * 10);
   uint8_t min_alarm = PCF8563T_MINUTE_ALARM_ON & ((dec << 4) + unit);
   writeByte(PCF8563T_MINUTE_ALARM_REG , min_alarm);
 }
 
+/**
+ *  Disable and clear the minute of the Alarm
+ *  
+ */   
 void PCF8563TClass::disableMinuteAlarm() {
   writeByte(PCF8563T_MINUTE_ALARM_REG, readByte(PCF8563T_MINUTE_ALARM_REG) | PCF8563T_MINUTE_ALARM_AE_M_MASK);
 }
 
+/**
+ *  Set Alarm's hour
+ *  
+ *  @param hours  hour number for the Alarm
+ */   
 void PCF8563TClass::setHourAlarm(uint8_t hours) {
   uint8_t dec = hours / 10;
   uint8_t unit = hours - (dec * 10);
   uint8_t hour_alarm = PCF8563T_HOUR_ALARM_AE_H_MASK & ((dec << 4) + unit);
   writeByte(PCF8563T_HOURS_REG, hour_alarm); //check formula on datasheet val + 6 * (val / 10)
 }
 
+/**
+ *  Disable and clear the hour of the Alarm
+ *  
+ */   
 void PCF8563TClass::disableHourAlarm() {
   writeByte(PCF8563T_HOUR_ALARM_REG, readByte(PCF8563T_HOUR_ALARM_REG) | PCF8563T_HOUR_ALARM_AE_H_MASK);
 }
 
+/**
+ *  Set Alarm's day
+ *  
+ *  @param days day number for the Alarm
+ */   
 void PCF8563TClass::setDayAlarm(uint8_t days) {
   uint8_t dec = days / 10;
   uint8_t unit = days - (dec * 10);
    uint8_t day_alarm = PCF8563T_DAY_ALARM_ON & ((dec << 4) + unit);
   writeByte(PCF8563T_DAY_ALARM_REG, day_alarm);
 }
 
+/**
+ *  Disable and clear the day of the Alarm
+ *  
+ */   
 void PCF8563TClass::disableDayAlarm() {
   writeByte(PCF8563T_DAY_ALARM_REG, readByte(PCF8563T_DAY_ALARM_REG) | PCF8563T_DAY_ALARM_AE_D_MASK );
 }