The foxBMS secondary mcu API documentation
rtc.h File Reference

Headers for the driver for the real time clock. More...

#include "rtc_cfg.h"
Include dependency graph for rtc.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  RTC_RESETSOURCE_s
 
struct  RTC_STATUS_s
 

Functions

void RTC_Init (void)
 initializes rtc module More...
 
void RTC_setTime (RTC_TimeTypeDef *time)
 sets RTC time More...
 
void RTC_getTime (RTC_TimeTypeDef *time)
 gets RTC time More...
 
void RTC_setDate (RTC_DateTypeDef *date)
 sets RTC date More...
 
void RTC_getDate (RTC_DateTypeDef *date)
 gets RTC date More...
 
uint32_t RTC_getUnixTime (void)
 
uint32_t RTC_convertRTCtoUnixTime (RTC_TimeTypeDef *time, RTC_DateTypeDef *date)
 

Variables

RTC_HandleTypeDef hrtc
 
RTC_STATUS_s main_state
 

Detailed Description

Headers for the driver for the real time clock.

BSD 3-Clause License Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

″This product uses parts of foxBMS®″

″This product includes parts of foxBMS®″

″This product is derived from foxBMS®″

Author
foxBMS Team
Date
20.10.2015 (date of creation)
Module-prefix RTC

Function Documentation

◆ RTC_convertRTCtoUnixTime()

uint32_t RTC_convertRTCtoUnixTime ( RTC_TimeTypeDef *  time,
RTC_DateTypeDef *  date 
)

◆ RTC_getDate()

void RTC_getDate ( RTC_DateTypeDef *  date)

gets RTC date

◆ RTC_getTime()

void RTC_getTime ( RTC_TimeTypeDef *  time)

gets RTC time

◆ RTC_getUnixTime()

uint32_t RTC_getUnixTime ( void  )
Here is the call graph for this function:

◆ RTC_Init()

void RTC_Init ( void  )

initializes rtc module

◆ RTC_setDate()

void RTC_setDate ( RTC_DateTypeDef *  date)

sets RTC date

◆ RTC_setTime()

void RTC_setTime ( RTC_TimeTypeDef *  time)

sets RTC time

Variable Documentation

◆ hrtc

RTC_HandleTypeDef hrtc

◆ main_state

RTC_STATUS_s main_state