hal_rtc.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** 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,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES 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 _HAL_RTC_H
#define _HAL_RTC_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#define HAL_RTC_LIMIT_SECONDS 60
#define HAL_RTC_LIMIT_MINUTES 60
#define HAL_RTC_LIMIT_HOURS   24
 
#include "hal_ll_rtc.h"
 
typedef enum
{
    HAL_RTC_SUCCESS = 0,       
    HAL_RTC_TIME_FORMAT_ERROR, 
    HAL_RTC_ERROR = (-1)       
} hal_rtc_err_t;
 
typedef struct
{
    uint8_t hour;   // 2-digit format - support values from 00 to 23
    uint8_t minute; // 2-digit format - support values from 00 to 59
    uint8_t second; // 2-digit format - support values from 00 to 59
} hal_rtc_time_t;
 
void hal_rtc_init();
 
err_t hal_rtc_start();
 
err_t hal_rtc_stop();
 
err_t hal_rtc_reset();
 
err_t hal_rtc_set_time( hal_rtc_time_t *time );
 
err_t hal_rtc_get_time( hal_rtc_time_t *time );
 
void hal_rtc_system_reset();
 
 // halrtcgroup
 // halgroup
 // pergroup
 
#ifdef __cplusplus
}
#endif
 
#endif // HAL_RTC_H