cts.h

Go to the documentation of this file.

 
#ifndef CTS_H_
#define CTS_H_
 
#include <stdint.h>
#include <ble_service.h>
#include <svc_types.h>
 
#define CTS_ADJUST_REASON_VALID_VALUES_MASK     (CTS_AR_NO_CHANGE                       | \
                                                 CTS_AR_CHANGE_OF_DST                   | \
                                                 CTS_AR_MANUAL_TIME_UPDATE              | \
                                                 CTS_AR_EXTERNAL_REFERENCE_TIME_UPDATE  | \
                                                 CTS_AR_CHANGE_OF_TIME_ZONE)
 
enum cts_error {
        CTS_ERROR_DATA_FIELD_IGNORED = ATT_ERROR_APPLICATION_ERROR,
};
 
typedef enum {
        CTS_AR_NO_CHANGE = 0,
        CTS_AR_MANUAL_TIME_UPDATE = 1,
        CTS_AR_EXTERNAL_REFERENCE_TIME_UPDATE = 2,
        CTS_AR_CHANGE_OF_TIME_ZONE = 4,
        CTS_AR_CHANGE_OF_DST = 8
} cts_adjust_reason_t;
 
typedef enum {
        CTS_DST_STANDARD_TIME = 0,
        CTS_DST_HALF_AN_HOUR_DAYLIGH_TIME = 2,
        CTS_DST_DAYLIGHT_TIME = 4,
        CTS_DST_DOUBLE_DAYLIGHT_TIME = 8,
        CTS_DST_UNKNOWN = 255
} cts_dst_t;
 
typedef enum {
        CTS_RTS_UNKNOWN = 0,
        CTS_RTS_NTP = 1,
        CTS_RTS_GPS = 2,
        CTS_RTS_RADIO_TIME_SIGNAL = 3,
        CTS_RTS_MANUAL = 4,
        CTS_RTS_ATOMIC_CLOCK = 5,
        CTS_RTS_CELULAR_NETOWRK = 6,
} cts_ref_time_source_t;
 
typedef struct {
        svc_date_time_t     date_time;
        uint8_t             day_of_week;        
        uint8_t             fractions_256;      
        cts_adjust_reason_t adjust_reason;
} cts_current_time_t;
 
typedef struct {
        /*
         * values for \p time_zone as definied by specification
         * helper function cts_get_time_zone() can be used to calculate value
         */
        int8_t    time_zone;
        cts_dst_t dst;
} cts_local_time_info_t;
 
typedef struct {
        cts_ref_time_source_t   source;
        uint8_t                 accuracy;
        uint8_t                 days_since_update;
        uint8_t                 hours_since_update;
} cts_ref_time_info_t;
 
typedef void (* cts_get_time_cb_t) (ble_service_t *svc, uint16_t conn_idx);
 
typedef void (* cts_set_time_cb_t) (ble_service_t *svc, uint16_t conn_idx,
                                                                const cts_current_time_t *time);
 
typedef void (* cts_set_local_time_info_cb_t) (ble_service_t *svc, uint16_t conn_idx,
                                                                const cts_local_time_info_t *info);
 
typedef void (* cts_get_ref_time_info_cb_t) (ble_service_t *svc, uint16_t conn_idx);
 
typedef struct {
        cts_get_time_cb_t get_time;
 
        cts_set_time_cb_t set_time;
 
        cts_set_local_time_info_cb_t set_local_time_info;
 
        cts_get_ref_time_info_cb_t get_ref_time_info;
} cts_callbacks_t;
 
ble_service_t *cts_init(const cts_local_time_info_t *info, const cts_callbacks_t *cb);
 
void cts_notify_time(ble_service_t *svc, uint16_t conn_idx, const cts_current_time_t *time);
 
void cts_notify_time_all(ble_service_t *svc, const cts_current_time_t *time);
 
void cts_set_local_time_info(ble_service_t *svc, const cts_local_time_info_t *info);
 
void cts_get_time_cfm(ble_service_t *svc, uint16_t conn_idx, att_error_t status,
                                                                const cts_current_time_t *time);
 
void cts_set_time_cfm(ble_service_t *svc, uint16_t conn_idx, att_error_t status);
 
void cts_set_local_time_info_cfm(ble_service_t *svc, uint16_t conn_idx, att_error_t status);
 
void cts_get_ref_time_info_cfm(ble_service_t *svc, uint16_t conn_idx, att_error_t status,
                                                                const cts_ref_time_info_t *info);
 
__STATIC_INLINE int8_t cts_get_time_zone(int8_t h, uint8_t m)
{
        return h * 4 + (m / 15) * (h < 0 ? -1 : 1);
}
 
__STATIC_INLINE bool cts_get_time_zone_offset(int8_t tz, int8_t *h, int8_t *m)
{
        if (tz == -128) {
                return false;
        }
 
        if (h) {
                *h = tz / 4;
        }
 
        if (m) {
                *m = (tz % 4) * 15;
        }
 
        return true;
}
 
__STATIC_INLINE bool cts_is_current_time_valid(const cts_current_time_t *time)
{
        return (((time->date_time.year >= 1582) && (time->date_time.year <= 9999))
                        || (time->date_time.year == 0)) &&
                (time->date_time.month <= 12) && (time->date_time.day <= 31) &&
                (time->date_time.hours <= 23) && (time->date_time.minutes <= 59) &&
                (time->date_time.seconds <= 59) && (time->day_of_week <= 7);
}
 
__STATIC_INLINE bool cts_is_local_time_info_valid(const cts_local_time_info_t *info)
{
        return (((info->time_zone >= -48) && (info->time_zone <= 56)) || (info->time_zone == -128)) &&
                                                        (info->dst >= 0) && (info->dst <= 8);
}
 
#endif /* CTS_H_ */