Sensor_RTC

module for Real Time Clock More...

Collaboration diagram for Sensor_RTC:

Classes
struct	RTC_TimeTypeDef
	Time structure for RTC module. More...
struct	RTC_DateTypeDef
	Date structure for RTC module. More...

Macros
#define	RTC_HandleTypeDef   void
	Dummy datatype in simulation mode.

Functions
void	time_init (void *rtc_handle, uint16_t time_format)
	Initialization of RTC module. More...
SensorID_t *	get_tsensor_id (uint8_t index)
	Return sensor ID. More...
RecordDescriptor_t	time_getType ()
	Return type specification for RTC module. More...
SensorValue_t *	get_time_value ()
	Read prepared value from RTC module. More...
void	time_reset (void)
	Do nothing.
void	time_doMeasure (void)
	Do nothing.
uint8_t	time_count (void)
	Return number of sensors in this peripheral. More...

Variables
SensorInterface_t	timeSensor
SensorID_t	time_sid
volatile RecordDescriptor_t	timeFormatDescriptor
SensorValue_t	time_data
SensorInterface_t	timeSensor

Detailed Description

module for Real Time Clock

Function Documentation

get_time_value()

SensorValue_t * get_time_value

(

)

Read prepared value from RTC module.

Returns

get_tsensor_id()

SensorID_t * get_tsensor_id

(

uint8_t

index

)

Return sensor ID.

This ID is generated by SW.

Parameters

index

unused.

Returns

pointer to data structure with sensor ID.

time_count()

uint8_t time_count

(

void

)

Return number of sensors in this peripheral.

Returns

1

time_getType()

RecordDescriptor_t time_getType

(

)

Return type specification for RTC module.

Returns

RTC sensor module type

time_init()

void time_init	(	void *	rtc_handle,
		uint16_t	time_format
	)

Initialization of RTC module.

Supported formats: SENSOR_TYPE_TIME_BINARY_4B, SENSOR_TYPE_TIME_BCD_6B

Parameters

rtc_handle	pointer to initialized RTC_HandleTypeDef structure or NULL in simulation mode.
time_format	required output format (SENSOR_TYPE_TIME_BINARY, SENSOR_TYPE_TIME_BCD)

Variable Documentation

timeSensor

SensorInterface_t timeSensor

Initial value:

= {
        &time_init,
        &time_reset,
        &get_tsensor_id,
        &time_getType,
        &time_doMeasure,
        &get_time_value,
        &time_count,
}