mikroSDK Reference Manual
drv_rtc.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2024 MikroElektronika d.o.o.
4 ** Contact: https://www.mikroe.com/contact
5 **
6 ** This file is part of the mikroSDK package
7 **
8 ** Commercial License Usage
9 **
10 ** Licensees holding valid commercial NECTO compilers AI licenses may use this
11 ** file in accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The MikroElektronika Company.
14 ** For licensing terms and conditions see
15 ** https://www.mikroe.com/legal/software-license-agreement.
16 ** For further information use the contact form at
17 ** https://www.mikroe.com/contact.
18 **
19 **
20 ** GNU Lesser General Public License Usage
21 **
22 ** Alternatively, this file may be used for
23 ** non-commercial projects under the terms of the GNU Lesser
24 ** General Public License version 3 as published by the Free Software
25 ** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
26 **
27 ** The above copyright notice and this permission notice shall be
28 ** included in all copies or substantial portions of the Software.
29 **
30 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
31 ** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
32 ** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
33 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
34 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
35 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
36 ** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
37 **
38 ****************************************************************************/
44 #ifndef _DRV_RTC_H
45 #define _DRV_RTC_H
46 
47 #ifdef __cplusplus
48 extern "C"{
49 #endif
50 
51 #include "hal_rtc.h"
52 
56 typedef enum
57 {
59  RTC_ERROR = (-1)
60 } rtc_err_t;
61 
80 typedef struct
81 {
82  uint8_t hour;
83  uint8_t minute;
84  uint8_t second;
85 } rtc_time_t;
86 
146 void rtc_init();
147 
170 err_t rtc_start();
171 
194 err_t rtc_stop();
195 
218 err_t rtc_reset();
219 
247 err_t rtc_set_time( rtc_time_t *time );
248 
270 err_t rtc_get_time( rtc_time_t *time );
271 
292 void rtc_system_reset();
293  // drvrtcgroup // drvgroup // pergroup
297 
298 #ifdef __cplusplus
299 }
300 #endif
301 
302 #endif //DRV_RTC_H
rtc_reset
err_t rtc_reset()
Reset the RTC module.
rtc_system_reset
void rtc_system_reset()
Preforms system reset.
rtc_time_t
Structure representing the RTC time.
Definition: drv_rtc.h:79
rtc_err_t
rtc_err_t
Definition: drv_rtc.h:55
rtc_start
err_t rtc_start()
Start the RTC module.
RTC_SUCCESS
Definition: drv_rtc.h:57
RTC_ERROR
Definition: drv_rtc.h:58
rtc_get_time
err_t rtc_get_time(rtc_time_t *time)
Get time from RTC module.
rtc_set_time
err_t rtc_set_time(rtc_time_t *time)
Configure time of RTC module.
rtc_init
void rtc_init()
Initialize the RTC module.
err_t
int32_t err_t
Definition: hal_target.h:63
rtc_stop
err_t rtc_stop()
Stop the RTC module.