blob: 804a7f44ebef78be85072f08f2e70192b59770c8 [file] [log] [blame]
/**
*
* Copyright (c) 2020 Project CHIP Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
*
* Copyright (c) 2020 Silicon Labs
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/***************************************************************************/
/**
* @file
* @brief
*******************************************************************************
******************************************************************************/
#pragma once
#define SECONDS_IN_MINUTE 60
#define SECONDS_IN_HOUR 3600
#define SECONDS_IN_DAY (SECONDS_IN_MINUTE * 60 * 24)
#define SECONDS_IN_WEEK (SECONDS_IN_DAY * 7)
#define DURATION_FOREVER_U32 0xFFFFFFFFU
/**
* @brief ZCL Date comparison function.
* The results are undefined for dates that contain the do not care value
* in any of the subfields.
* @return -1, if val1 is smaller
* 0, if they are the same
* 1, if val2 is smaller
*/
int8_t emberAfCompareDates(EmberAfDate * date1, EmberAfDate * date2);
/**
* @brief function that copies a ZigBee Date into a buffer
*/
void emberAfCopyDate(uint8_t * data, uint16_t index, EmberAfDate * src);
/**
* @brief Decode the given uint32_t into a ZCL Date object where
* the uint32_t is formatted as follows:
*
* (0xFF000000 & value) = year
* (0x00FF0000 & value) = month
* (0x0000FF00 & value) = day of month
* (0x000000FF & value) = day of week
*
*/
void emberAfDecodeDate(uint32_t src, EmberAfDate * dest);
/**
* @brief Encode and return the given ZCL Date object as an uint32_t.
* Refer to emberAFDecodeDate for details on how the information is stored
* within an uint32_t.
*/
uint32_t emberAfEncodeDate(EmberAfDate * date);
/**
* @brief Fills the a time structure based on the passed UTC time.
*
*/
void emberAfFillTimeStructFromUtc(uint32_t utcTime, EmberAfTimeStruct * returnTime);
/**
* @brief Returns the number of days in the month specified in the EmberAfTimeStruct.
*
*/
uint8_t emberAfGetNumberDaysInMonth(EmberAfTimeStruct * time);
/**
* @brief Calculate a UTC time from the passed time structure.
*
*/
uint32_t emberAfGetUtcFromTimeStruct(EmberAfTimeStruct * time);
/**
* @brief Determine the week day (Monday=0 ... Sunday=6) based on
* a specified UTC time.
*/
uint8_t emberAfGetWeekdayFromUtc(uint32_t utcTime);
/**
* @brief Sets current time.
* Convenience function for setting the time to a value.
* If the time server cluster is implemented on this device,
* then this call will be passed along to the time cluster server
* which will update the time. Otherwise the emberAfSetTimeCallback
* is called, which in the case of the stub does nothing.
*
* @param utcTime A ZigBee time, the number of seconds since the
* year 2000.
*/
void emberAfSetTime(uint32_t utcTime);
/**
* @brief Retrieves current time.
*
* Convienience function for retrieving the current time.
* If the time server cluster is implemented, then the time
* is retrieved from that cluster's time attribute. Otherwise,
* the emberAfGetCurrentTimeCallback is called.
*
* A real time is expected to in the ZigBee time format, the number
* of seconds since the year 2000.
*/
uint32_t emberAfGetCurrentTime(void);
/**
* @brief Prints time.
*
* Convenience function for all clusters to print time.
* This function expects to be passed a ZigBee time which
* is the number of seconds since the year 2000. If
* EMBER_AF_PRINT_CORE is defined, this function will print
* a human readable time from the passed value. If not, this
* function will print nothing.
*
* @param utcTime A ZigBee time, the number of seconds since the
* year 2000.
*/
void emberAfPrintTime(uint32_t utcTime);
/**
* @brief Prints the time in ISO 8601 format
* yyyy-mm-dd hh:mm:ss
*
* @param utcTime A ZigBee time, the number of seconds since the
* year 2000.
*/
void emberAfPrintTimeIsoFormat(uint32_t utcTime);