From 592c7acc4c7a2bf78a2a385acc064580ddc2f254 Mon Sep 17 00:00:00 2001 From: Peter Barker Date: Fri, 16 Aug 2019 12:33:33 +1000 Subject: [PATCH] AP_RTC: add clarifying comment on get_time_utc --- libraries/AP_RTC/AP_RTC.cpp | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/libraries/AP_RTC/AP_RTC.cpp b/libraries/AP_RTC/AP_RTC.cpp index 6aa820507c..eb503469c5 100644 --- a/libraries/AP_RTC/AP_RTC.cpp +++ b/libraries/AP_RTC/AP_RTC.cpp @@ -95,8 +95,12 @@ bool AP_RTC::get_system_clock_utc(uint8_t &hour, uint8_t &min, uint8_t &sec, uin return true; } -// get milliseconds from now to a target time of day expressed as hour, min, sec, ms -// match starts from first value that is not -1. I.e. specifying hour=-1, minutes=10 will ignore the hour and return time until 10 minutes past 12am (utc) +// get milliseconds from now to a target time of day expressed as +// hour, min, sec, ms. Match starts from first value that is not +// -1. I.e. specifying hour=-1, minutes=10 will ignore the hour and +// return time until 10 minutes past 12am (utc) NOTE: if this time has +// just past then you can expect a return value of roughly 86340000 - +// the number of milliseconds in a day. uint32_t AP_RTC::get_time_utc(int32_t hour, int32_t min, int32_t sec, int32_t ms) { // determine highest value specified (0=none, 1=ms, 2=sec, 3=min, 4=hour)