doc: renamed project
This commit is contained in:
SylvanArnold
committed by
Sylvan Arnold
Sylvan Arnold
parent
244e516bd8
commit
32618389d1
703
pico-sensor/McuLib/src/McuTimeDate.h
Normal file
703
pico-sensor/McuLib/src/McuTimeDate.h
Normal file
@@ -0,0 +1,703 @@
|
||||
/* ###################################################################
|
||||
** This component module is generated by Processor Expert. Do not modify it.
|
||||
** Filename : McuTimeDate.h
|
||||
** Project : FRDM-K64F_Generator
|
||||
** Processor : MK64FN1M0VLL12
|
||||
** Component : GenericTimeDate
|
||||
** Version : Component 01.068, Driver 01.00, CPU db: 3.00.000
|
||||
** Compiler : GNU C Compiler
|
||||
** Date/Time : 2023-02-28, 09:38, # CodeGen: 794
|
||||
** Abstract :
|
||||
** Software date/time module.
|
||||
** Settings :
|
||||
** Component name : McuTimeDate
|
||||
** Software RTC : Enabled
|
||||
** Tick Time (ms) : 10
|
||||
** RTOS : Enabled
|
||||
** RTOS : McuRTOS
|
||||
** Hardware RTC : Enabled
|
||||
** Internal : Disabled
|
||||
** External RTC : Disabled
|
||||
** Set Time and Date :
|
||||
** Software RTC : yes
|
||||
** Internal RTC : no
|
||||
** External RTC : yes
|
||||
** Get Time and Date : Software RTC
|
||||
** Init() :
|
||||
** Defaults :
|
||||
** Time : 17:51:31
|
||||
** Date : 2019-08-01
|
||||
** Call Init() in startup : yes
|
||||
** Software RTC Initialization : Init from Defaults
|
||||
** System :
|
||||
** Critical Section : McuCriticalSection
|
||||
** SDK : McuLib
|
||||
** Shell : Enabled
|
||||
** Utility : McuUtility
|
||||
** Shell : McuShell
|
||||
** Contents :
|
||||
** AddTick - void McuTimeDate_AddTick(void);
|
||||
** AddTicks - void McuTimeDate_AddTicks(uint16_t nofTicks);
|
||||
** TicksToTime - uint8_t McuTimeDate_TicksToTime(uint32_t ticks, TIMEREC *time);
|
||||
** TimeToTicks - uint8_t McuTimeDate_TimeToTicks(TIMEREC *time, uint32_t *ticks);
|
||||
** CalculateDayOfWeek - uint8_t McuTimeDate_CalculateDayOfWeek(uint16_t Year, uint8_t Month, uint8_t...
|
||||
** SetTime - uint8_t McuTimeDate_SetTime(uint8_t Hour, uint8_t Min, uint8_t Sec, uint8_t...
|
||||
** GetTime - uint8_t McuTimeDate_GetTime(TIMEREC *time);
|
||||
** SetDate - uint8_t McuTimeDate_SetDate(uint16_t Year, uint8_t Month, uint8_t Day);
|
||||
** GetDate - uint8_t McuTimeDate_GetDate(DATEREC *date);
|
||||
** SetTimeDate - uint8_t McuTimeDate_SetTimeDate(TIMEREC *time, DATEREC *date);
|
||||
** GetTimeDate - uint8_t McuTimeDate_GetTimeDate(TIMEREC *time, DATEREC *date);
|
||||
** SetSWTimeDate - uint8_t McuTimeDate_SetSWTimeDate(TIMEREC *time, DATEREC *date);
|
||||
** GetSWTimeDate - uint8_t McuTimeDate_GetSWTimeDate(TIMEREC *time, DATEREC *date);
|
||||
** SetInternalRTCTimeDate - uint8_t McuTimeDate_SetInternalRTCTimeDate(TIMEREC *time, DATEREC *date);
|
||||
** GetInternalRTCTimeDate - uint8_t McuTimeDate_GetInternalRTCTimeDate(TIMEREC *time, DATEREC *date);
|
||||
** SyncWithInternalRTC - uint8_t McuTimeDate_SyncWithInternalRTC(void);
|
||||
** SyncSWtimeToInternalRTCsec - uint8_t McuTimeDate_SyncSWtimeToInternalRTCsec(void);
|
||||
** SetExternalRTCTimeDate - uint8_t McuTimeDate_SetExternalRTCTimeDate(TIMEREC *time, DATEREC *date);
|
||||
** GetExternalRTCTimeDate - uint8_t McuTimeDate_GetExternalRTCTimeDate(TIMEREC *time, DATEREC *date);
|
||||
** SyncWithExternalRTC - uint8_t McuTimeDate_SyncWithExternalRTC(void);
|
||||
** UnixSecondsToTimeDateCustom - void McuTimeDate_UnixSecondsToTimeDateCustom(int32_t seconds, int8_t...
|
||||
** UnixSecondsToTimeDate - void McuTimeDate_UnixSecondsToTimeDate(int32_t seconds, int8_t offset_hours,...
|
||||
** TimeDateToUnixSecondsCustom - int32_t McuTimeDate_TimeDateToUnixSecondsCustom(TIMEREC *time, DATEREC *date,...
|
||||
** TimeDateToUnixSeconds - int32_t McuTimeDate_TimeDateToUnixSeconds(TIMEREC *time, DATEREC *date,...
|
||||
** AddDateString - uint8_t McuTimeDate_AddDateString(uint8_t *buf, size_t bufSize, DATEREC...
|
||||
** AddTimeString - uint8_t McuTimeDate_AddTimeString(uint8_t *buf, size_t bufSize, TIMEREC...
|
||||
** ParseCommand - uint8_t McuTimeDate_ParseCommand(const unsigned char *cmd, bool *handled,...
|
||||
** Deinit - void McuTimeDate_Deinit(void);
|
||||
** Init - uint8_t McuTimeDate_Init(void);
|
||||
**
|
||||
** * Copyright (c) 2011-2023, Erich Styger
|
||||
** * Web: https://mcuoneclipse.com
|
||||
** * SourceForge: https://sourceforge.net/projects/mcuoneclipse
|
||||
** * Git: https://github.com/ErichStyger/McuOnEclipse_PEx
|
||||
** * All rights reserved.
|
||||
** *
|
||||
** * Redistribution and use in source and binary forms, with or without modification,
|
||||
** * are permitted provided that the following conditions are met:
|
||||
** *
|
||||
** * - Redistributions of source code must retain the above copyright notice, this list
|
||||
** * of conditions and the following disclaimer.
|
||||
** *
|
||||
** * - 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.
|
||||
** *
|
||||
** * 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.
|
||||
** ###################################################################*/
|
||||
/*!
|
||||
** @file McuTimeDate.h
|
||||
** @version 01.00
|
||||
** @brief
|
||||
** Software date/time module.
|
||||
*/
|
||||
/*!
|
||||
** @addtogroup McuTimeDate_module McuTimeDate module documentation
|
||||
** @{
|
||||
*/
|
||||
|
||||
#ifndef __McuTimeDate_H
|
||||
#define __McuTimeDate_H
|
||||
|
||||
/* MODULE McuTimeDate. */
|
||||
#include "McuLib.h" /* SDK and API used */
|
||||
#include "McuTimeDateconfig.h" /* configuration */
|
||||
|
||||
/* Include inherited components */
|
||||
#include "McuRTOS.h"
|
||||
#include "McuCriticalSection.h"
|
||||
#include "McuUtility.h"
|
||||
#include "McuLib.h"
|
||||
#include "McuShell.h"
|
||||
|
||||
#if McuTimeDate_CONFIG_USE_INTERNAL_HW_RTC_BEAN
|
||||
#define McuTimeDate_HAS_SEC100_IN_TIMEREC (0) /* Bean version have no Sec100! */
|
||||
#else
|
||||
#define McuTimeDate_HAS_SEC100_IN_TIMEREC (1) /* non-Bean version have Sec100 */
|
||||
#endif
|
||||
/* internal configuration for the API used: */
|
||||
#define McuTimeDate_CONFIG_USE_INTERNAL_HW_RTC_LDD (0) /* set to 1 if using HW RTC using LDD driver, 0 otherwise */
|
||||
#define McuTimeDate_CONFIG_USE_INTERNAL_HW_RTC_BEAN (0) /* set to 1 if using HW RTC using normal bean driver, 0 otherwise */
|
||||
|
||||
|
||||
#define McuTimeDate_PARSE_COMMAND_ENABLED McuTimeDate_CONFIG_PARSE_COMMAND_ENABLED
|
||||
|
||||
/* user events */
|
||||
#define McuTimeDate_ON_DATE_GET_EVENT 0 /* 1: enabled user event */
|
||||
#define McuTimeDate_ON_DATE_GET_EVENT_NAME McuTimeDate_OnDateGet /* name of user event*/
|
||||
#define McuTimeDate_ON_TIME_GET_EVENT 0 /* 1: enabled user event */
|
||||
#define McuTimeDate_ON_TIME_GET_EVENT_NAME McuTimeDate_OnTimeGet /* name of user event*/
|
||||
#define McuTimeDate_ON_DATE_SET_EVENT 0 /* 1: enabled user event */
|
||||
#define McuTimeDate_ON_DATE_SET_EVENT_NAME McuTimeDate_OnDateSet /* name of user event*/
|
||||
#define McuTimeDate_ON_TIME_SET_EVENT 0 /* 1: enabled user event */
|
||||
#define McuTimeDate_ON_TIME_SET_EVENT_NAME McuTimeDate_OnTimeSet /* name of user event*/
|
||||
|
||||
|
||||
#ifndef __BWUserType_TIMEREC
|
||||
#define __BWUserType_TIMEREC
|
||||
typedef struct { /* It contains actual number of hours, minutes, seconds and hundreth of seconds. */
|
||||
uint8_t Hour; /* hours (0 - 23) */
|
||||
uint8_t Min; /* minutes (0 - 59) */
|
||||
uint8_t Sec; /* seconds (0 - 59) */
|
||||
#if McuTimeDate_HAS_SEC100_IN_TIMEREC /* does not exist for Bean version */
|
||||
uint8_t Sec100; /* hundredth of seconds (0 - 99) */
|
||||
#endif
|
||||
} TIMEREC;
|
||||
#endif
|
||||
#ifndef __BWUserType_DATEREC
|
||||
#define __BWUserType_DATEREC
|
||||
typedef struct { /* It contains actual year, month, and day description. */
|
||||
uint16_t Year; /* years (1998 - 2099) */
|
||||
uint8_t Month; /* months (1 - 12) */
|
||||
uint8_t Day; /* days (1 - 31) */
|
||||
} DATEREC;
|
||||
#endif
|
||||
|
||||
#define McuTimeDate_TICK_TIME_MS McuTimeDate_CONFIG_TICK_TIME_MS /* period of AddTick() */
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
uint8_t McuTimeDate_SetTime(uint8_t Hour, uint8_t Min, uint8_t Sec, uint8_t Sec100);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : SetTime (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method sets a new actual time of the software RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** Hour - Hours (0 - 23)
|
||||
** Min - Minutes (0 - 59)
|
||||
** Sec - Seconds (0 - 59)
|
||||
** Sec100 - Hundredth of seconds (0 - 99)
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
void McuTimeDate_AddTick(void);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : AddTick (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Increments the tick counter of the software RTC. Needs to be
|
||||
** called periodically by the application to increase the time
|
||||
** tick count.
|
||||
** Parameters : None
|
||||
** Returns : Nothing
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_GetTime(TIMEREC *time);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : GetTime (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method returns current time from the software RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to the structure TIMEREC. It
|
||||
** contains actual number of hours, minutes,
|
||||
** seconds and hundredth of seconds.
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_SetDate(uint16_t Year, uint8_t Month, uint8_t Day);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : SetDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method sets a new actual date of the software RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** Year - Years (16-bit unsigned integer)
|
||||
** Month - Months (8-bit unsigned integer)
|
||||
** Day - Days (8-bit unsigned integer)
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_GetDate(DATEREC *date);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : GetDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method returns current date from the software RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * date - Pointer to DATEREC
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_Init(void);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : Init (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Initialization method
|
||||
** Parameters : None
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_ParseCommand(const unsigned char *cmd, bool *handled, const McuShell_StdIOType *io);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : ParseCommand (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Shell Command Line parser
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * cmd - Pointer to command line
|
||||
** * handled - Pointer to variable which tells if
|
||||
** the command has been handled or not
|
||||
** * io - Pointer to I/O structure
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
void McuTimeDate_Deinit(void);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : Deinit (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Deinitializes the driver.
|
||||
** Parameters : None
|
||||
** Returns : Nothing
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
void McuTimeDate_AddTicks(uint16_t nofTicks);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : AddTicks (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Same as AddTick(), but multiple ticks can be added in one
|
||||
** step.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** nofTicks - Number of ticks to be added
|
||||
** Returns : Nothing
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_TicksToTime(uint32_t ticks, TIMEREC *time);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : TicksToTime (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Transforms ticks into time information
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** ticks -
|
||||
** * time - Pointer where to store the time
|
||||
** information
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_TimeToTicks(TIMEREC *time, uint32_t *ticks);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : TimeToTicks (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Transforms time information into ticks
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer where to time information
|
||||
** * ticks - Pointer to where to store the ticks
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_SetInternalRTCTimeDate(TIMEREC *time, DATEREC *date);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : SetInternalRTCTimeDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method sets a new actual time and date of the internal
|
||||
** hardware RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to struct which contains the
|
||||
** time to be set. Can be NULL if time shall
|
||||
** not be set.
|
||||
** * date - Pointer to struct which contains the
|
||||
** date information to be set. Can be NULL if
|
||||
** date shall not be set.
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_GetInternalRTCTimeDate(TIMEREC *time, DATEREC *date);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : GetInternalRTCTimeDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method returns current time and date from the hardware
|
||||
** RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to the structure to return the
|
||||
** time. Can be NULL.
|
||||
** * date - Pointer to structure which returns the
|
||||
** date information. Can be NULL
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_CalculateDayOfWeek(uint16_t Year, uint8_t Month, uint8_t Day);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : CalculateDayOfWeek (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Returns the day of the week, Sunday starting as zero. Monday
|
||||
** is 1, ...
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** Year - Years (16-bit unsigned integer)
|
||||
** Month - Months (8-bit unsigned integer)
|
||||
** Day - Days (8-bit unsigned integer)
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_SetSWTimeDate(TIMEREC *time, DATEREC *date);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : SetSWTimeDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method sets a new actual time and date of the software
|
||||
** RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to struct which contains the
|
||||
** time to be set. Can be NULL if time shall
|
||||
** not be set.
|
||||
** * date - Pointer to struct which contains the
|
||||
** date information to be set. Can be NULL if
|
||||
** date shall not be set.
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_GetSWTimeDate(TIMEREC *time, DATEREC *date);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : GetSWTimeDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method returns current time and date from the software
|
||||
** RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to the structure to return the
|
||||
** time. Can be NULL.
|
||||
** * date - Pointer to structure which returns the
|
||||
** date information. Can be NULL
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_SyncWithInternalRTC(void);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : SyncWithInternalRTC (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Synchronizes the software RTC with date and time from the
|
||||
** internal hardware RTC
|
||||
** Parameters : None
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_SyncWithExternalRTC(void);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : SyncWithExternalRTC (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Synchronizes the software RTC with date and time from the
|
||||
** hardware RTC. Note that if that RTC interface requires
|
||||
** interrupts, this function should be called only when
|
||||
** interrupts are enabled.
|
||||
** Parameters : None
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_SetExternalRTCTimeDate(TIMEREC *time, DATEREC *date);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : SetExternalRTCTimeDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method sets a new actual time and date of the external
|
||||
** hardware RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to struct which contains the
|
||||
** time to be set. Can be NULL if time shall
|
||||
** not be set.
|
||||
** * date - Pointer to struct which contains the
|
||||
** date information to be set. Can be NULL if
|
||||
** date shall not be set.
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_GetExternalRTCTimeDate(TIMEREC *time, DATEREC *date);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : GetExternalRTCTimeDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method returns current time and date from the external
|
||||
** hardware RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to the structure to return the
|
||||
** time. Can be NULL.
|
||||
** * date - Pointer to structure which returns the
|
||||
** date information. Can be NULL
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_SetTimeDate(TIMEREC *time, DATEREC *date);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : SetTimeDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method sets a new actual time and date of the RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to struct which contains the
|
||||
** time to be set. Can be NULL if time shall
|
||||
** not be set.
|
||||
** * date - Pointer to struct which contains the
|
||||
** date information to be set. Can be NULL if
|
||||
** date shall not be set.
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_GetTimeDate(TIMEREC *time, DATEREC *date);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : GetTimeDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method returns current time and date from the RTC.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to the structure to return the
|
||||
** time. Can be NULL.
|
||||
** * date - Pointer to structure which returns the
|
||||
** date information. Can be NULL
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
void McuTimeDate_UnixSecondsToTimeDateCustom(int32_t seconds, int8_t offset_hours, TIMEREC *time, DATEREC *date, uint16_t baseYear);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : UnixSecondsToTimeDateCustom (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Transforms a given time/date into the Unix time stamp, with
|
||||
** the number of seconds from a starting date
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** seconds - Unix time stamp in seconds after
|
||||
** the given base year and base month
|
||||
** offset_hours - Optional time zone
|
||||
** offset, use 0 for no offset
|
||||
** * time - Pointer to TIMEREC struct where the
|
||||
** result is stored. Can be NULL.
|
||||
** * date - Pointer to DATEREC struct where the
|
||||
** result is stored. Can be NULL.
|
||||
** baseYear - Base year from which is used as
|
||||
** base to count the seconds, in YYYY format.
|
||||
** Returns : Nothing
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
int32_t McuTimeDate_TimeDateToUnixSecondsCustom(TIMEREC *time, DATEREC *date, int8_t offset_hours, uint16_t baseYear);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : TimeDateToUnixSecondsCustom (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Returns for a given time/date the corresponding UNIX time
|
||||
** stamp with a custom base date.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to TIMEREC which holds the time
|
||||
** to convert
|
||||
** * date - Pointer to DATEREC with the date to
|
||||
** convert
|
||||
** offset_hours - Optional number of
|
||||
** offset hours to adjust for the time zone.
|
||||
** Use 0 for no adjustment.
|
||||
** baseYear - Base year from which is used as
|
||||
** base to count the seconds, in YYYY format
|
||||
** Returns :
|
||||
** --- - number of seconds after given base
|
||||
** month/year
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
void McuTimeDate_UnixSecondsToTimeDate(int32_t seconds, int8_t offset_hours, TIMEREC *time, DATEREC *date);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : UnixSecondsToTimeDate (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Transforms a given time/date into the Unix time stamp, with
|
||||
** the number of seconds after 1-Jan-1970
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** seconds - Unix time stamp in seconds after
|
||||
** the given base year and base month
|
||||
** offset_hours - Optional time zone
|
||||
** offset, use 0 for no offset
|
||||
** * time - Pointer to TIMEREC struct where the
|
||||
** result is stored. Can be NULL.
|
||||
** * date - Pointer to DATEREC struct where the
|
||||
** result is stored. Can be NULL.
|
||||
** Returns : Nothing
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
int32_t McuTimeDate_TimeDateToUnixSeconds(TIMEREC *time, DATEREC *date, int8_t offset_hours);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : TimeDateToUnixSeconds (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Returns for a given time/date the corresponding UNIX time
|
||||
** stamp, starting at 1-Jan-1970.
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * time - Pointer to TIMEREC which holds the time
|
||||
** to convert
|
||||
** * date - Pointer to DATEREC with the date to
|
||||
** convert
|
||||
** offset_hours - Optional number of
|
||||
** offset hours to adjust for the time zone.
|
||||
** Use 0 for no adjustment.
|
||||
** Returns :
|
||||
** --- - number of seconds after given base
|
||||
** month/year
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_AddDateString(uint8_t *buf, size_t bufSize, DATEREC *date, uint8_t *format);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : AddDateString (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Adds a formatted date string to a buffer
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * buf - Pointer to zero terminated buffer where to
|
||||
** append the string
|
||||
** bufSize - Size of the buffer in bytes
|
||||
** * date - Pointer to date information
|
||||
** * format - Pointer to the format string.
|
||||
** Supported formats: "dd.mm.yyyy"
|
||||
** Returns :
|
||||
** --- - Error code, ERR_OK for no error
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_AddTimeString(uint8_t *buf, size_t bufSize, TIMEREC *time, uint8_t *format);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : AddTimeString (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** Adds a formatted time string to a buffer
|
||||
** Parameters :
|
||||
** NAME - DESCRIPTION
|
||||
** * buf - Pointer to zero terminated buffer where to
|
||||
** append the string
|
||||
** bufSize - Size of the buffer in bytes
|
||||
** * time - Pointer to time information
|
||||
** * format - Pointer to the format string.
|
||||
** Supported formats: "hh:mm.ss,cc"
|
||||
** Returns :
|
||||
** --- - Error code, ERR_OK for no error
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
uint8_t McuTimeDate_SyncSWtimeToInternalRTCsec(void);
|
||||
/*
|
||||
** ===================================================================
|
||||
** Method : SyncSWtimeToInternalRTCsec (component GenericTimeDate)
|
||||
**
|
||||
** Description :
|
||||
** This method synchronizes the software RTC with the internal
|
||||
** HW RTC. Because the internal RTC only counts seconds, we
|
||||
** sync on a second change.
|
||||
** Parameters : None
|
||||
** Returns :
|
||||
** --- - Error code
|
||||
** ===================================================================
|
||||
*/
|
||||
|
||||
/* END McuTimeDate. */
|
||||
|
||||
#endif
|
||||
/* ifndef __McuTimeDate_H */
|
||||
/*!
|
||||
** @}
|
||||
*/
|
||||
Reference in New Issue
Block a user