Files
hsb/S - Software/0 - HSB MRTS Kathode-MCP/3 - Implementation/0 - Code/Platform/inc/rtc.h
dvl 15ab232e82 Doxygen update
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@427 05563f52-14a8-4384-a975-3d1654cca0fa
2018-01-15 11:04:24 +00:00

100 lines
2.5 KiB
C

// -----------------------------------------------------------------------------
/// @file rtc.h
/// @brief File description
// -----------------------------------------------------------------------------
// Micro-Key bv
// Industrieweg 28, 9804 TG Noordhorn
// Postbus 92, 9800 AB Zuidhorn
// The Netherlands
// Tel: +31 594 503020
// Fax: +31 594 505825
// Email: support@microkey.nl
// Web: www.microkey.nl
// -----------------------------------------------------------------------------
/// $Revision$
/// $Author$
/// $Date$
// (c) 2015 Micro-Key bv
// -----------------------------------------------------------------------------
/**
* %Rtc implementation
* \defgroup Rtc Package Rtc
* \ingroup Platform
* @{
*/
#ifndef INC_RTC_H_
#define INC_RTC_H_
// -----------------------------------------------------------------------------
// Include files
// -----------------------------------------------------------------------------
#include "FreeRTOS.h"
#include "stm32f10x.h"
#include "Observable.h"
// -----------------------------------------------------------------------------
// Constant and macro definitions
// -----------------------------------------------------------------------------
// -----------------------------------------------------------------------------
// Type definitions.
// -----------------------------------------------------------------------------
struct Time
{
int hours;
int minutes;
int seconds;
};
struct Rtc
{
struct Observable observable;
};
// -----------------------------------------------------------------------------
// Function declarations
// -----------------------------------------------------------------------------
/** ----------------------------------------------------------------------------
* RTC_construct
* Constructor of the RealTime Clock
*
* @return ErrorStatus
*
* @todo
* -----------------------------------------------------------------------------
*/
extern ErrorStatus RTC_construct(struct Rtc* self);
/** ----------------------------------------------------------------------------
* RTC_getObservable
* Description of function
*
* @param self
*
* @return struct Observable*
*
* @todo
* -----------------------------------------------------------------------------
*/
extern struct Observable* RTC_getObservable(struct Rtc* self);
extern void RTC_calculateTimeFromSeconds(uint32_t seconds, struct Time* time);
#endif /* INC_RTC_H_ */
/** @} */