Skip to content

Commit 592c7ac

Browse files
committed
AP_RTC: add clarifying comment on get_time_utc
1 parent 46c8800 commit 592c7ac

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

libraries/AP_RTC/AP_RTC.cpp

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,12 @@ bool AP_RTC::get_system_clock_utc(uint8_t &hour, uint8_t &min, uint8_t &sec, uin
9595
return true;
9696
}
9797

98-
// get milliseconds from now to a target time of day expressed as hour, min, sec, ms
99-
// 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)
98+
// get milliseconds from now to a target time of day expressed as
99+
// hour, min, sec, ms. Match starts from first value that is not
100+
// -1. I.e. specifying hour=-1, minutes=10 will ignore the hour and
101+
// return time until 10 minutes past 12am (utc) NOTE: if this time has
102+
// just past then you can expect a return value of roughly 86340000 -
103+
// the number of milliseconds in a day.
100104
uint32_t AP_RTC::get_time_utc(int32_t hour, int32_t min, int32_t sec, int32_t ms)
101105
{
102106
// determine highest value specified (0=none, 1=ms, 2=sec, 3=min, 4=hour)

0 commit comments

Comments
 (0)