OpenRTX/openrtx/include/core/datetime.h

79 wiersze
2.8 KiB
C

/***************************************************************************
* Copyright (C) 2022 - 2023 by Federico Amedeo Izzo IU2NUO, *
* Niccolò Izzo IU2KIN *
* Frederik Saraci IU2NRO *
* Silvano Seva IU2KWO *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#ifndef DATETIME_H
#define DATETIME_H
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* \brief Date and time type
*
* Data type representing current date and time, optimized for minimum space
* occupancy.
*/
typedef struct
{
int8_t hour; // Hours (0-23)
int8_t minute; // Minutes (0-59)
int8_t second; // Seconds (0-59)
int8_t day; // Day of the week (1-7)
int8_t date; // Day of the month (1-31)
int8_t month; // Month (1-12)
uint8_t year; // Year (0-99)
}
datetime_t;
/**
* Convert from UTC time to local time, given the destination timezone.
*
* @param utc_time: UTC time.
* @param timezone: destination time zone.
* @return converted local time.
*/
datetime_t utcToLocalTime(const datetime_t utc_time, const int8_t timezone);
/**
* Convert local time to UTC, given the source timezone.
*
* @param local_time: local time.
* @param timezone: source time zone.
* @return converted UTC time.
*/
datetime_t localTimeToUtc(const datetime_t local_time, const int8_t timezone);
/**
* Adjust the values of the members of datetime_t if they are off-range or if
* they have values that do not match the date described by the other members.
*
* @param time: pointer to a datetime_t struct.
*/
void realignTimeInfo(datetime_t *time);
#ifdef __cplusplus
}
#endif
#endif /* DATATYPES_H */