time_srv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BT_MESH_TIME_SRV_H__
#define BT_MESH_TIME_SRV_H__
 
#include <bluetooth/mesh/time.h>
#include <bluetooth/mesh/model_types.h>
#include <time.h>
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct bt_mesh_time_srv;
struct tm;
 
#define BT_MESH_TIME_SRV_INIT(_time_update_cb)                                 \
        {                                                                      \
                .time_update_cb = _time_update_cb,                             \
                .pub = { .update = _bt_mesh_time_srv_update_handler,           \
                         .msg = NET_BUF_SIMPLE(BT_MESH_MODEL_BUF_LEN(          \
                                 BT_MESH_TIME_OP_TIME_SET,                     \
                                 BT_MESH_TIME_MSG_LEN_TIME_SET)) },            \
        }
 
#define BT_MESH_MODEL_TIME_SRV(_srv, ...)                                      \
        BT_MESH_MODEL_METADATA_CB(                                             \
                BT_MESH_MODEL_ID_TIME_SRV, _bt_mesh_time_srv_op, &(_srv)->pub, \
                BT_MESH_MODEL_USER_DATA(struct bt_mesh_time_srv, _srv),        \
                &_bt_mesh_time_srv_cb, __VA_ARGS__),                           \
        BT_MESH_MODEL_CB(BT_MESH_MODEL_ID_TIME_SETUP_SRV,                      \
                _bt_mesh_time_setup_srv_op,                                    \
                &(_srv)->setup_pub,                                            \
                BT_MESH_MODEL_USER_DATA(                                       \
                struct bt_mesh_time_srv, _srv),                                \
                &_bt_mesh_time_setup_srv_cb)
 
#define BT_MESH_CLOCK_ACCURACY_METADATA_ID 0x0007
 
#define BT_MESH_TIMEKEEPING_RESERVE_METADATA_ID 0x0008
 
#define BT_MESH_CLOCK_ACCURACY_METADATA(clock_accuracy)                                            \
        BT_MESH_MODELS_METADATA_ENTRY(3, BT_MESH_CLOCK_ACCURACY_METADATA_ID,                       \
                                      ((uint8_t[]){BT_BYTES_LIST_LE24(clock_accuracy)}))
 
#define BT_MESH_TIMEKEEPING_RESERVE_METADATA(timekeeping_reserve)                                  \
        BT_MESH_MODELS_METADATA_ENTRY(3, BT_MESH_TIMEKEEPING_RESERVE_METADATA_ID,                  \
                                      ((uint8_t[]){BT_BYTES_LIST_LE24(timekeeping_reserve)}))
 
enum bt_mesh_time_update_types {
        BT_MESH_TIME_SRV_STATUS_UPDATE,
        BT_MESH_TIME_SRV_SET_UPDATE,
        BT_MESH_TIME_SRV_ZONE_UPDATE,
        BT_MESH_TIME_SRV_UTC_UPDATE,
};
 
struct bt_mesh_time_srv_data {
        /* State at last sync point */
        struct {
                /* Device uptime at last sync point */
                int64_t uptime;
                /* Time status at last sync point */
                struct bt_mesh_time_status status;
        } sync;
        /* Zone change update context */
        struct bt_mesh_time_zone_change time_zone_change;
        /* UTC-delta change update context */
        struct bt_mesh_time_tai_utc_change tai_utc_change;
        /* The Time Role of the Server instance */
        enum bt_mesh_time_role role;
        /* The timestamp of the last published Time Status. */
        int64_t timestamp;
};
 
struct bt_mesh_time_srv {
        const struct bt_mesh_model *model;
        struct bt_mesh_model_pub pub;
        struct bt_mesh_model_pub setup_pub;
        struct bt_mesh_msg_ack_ctx ack_ctx;
        struct bt_mesh_time_srv_data data;
        struct k_work_delayable status_delay;
        bool is_unsolicited;
        uint8_t cached_ttl;
 
        void (*const time_update_cb)(struct bt_mesh_time_srv *srv,
                                     struct bt_mesh_msg_ctx *ctx,
                                     enum bt_mesh_time_update_types type);
};
 
int bt_mesh_time_srv_time_status_send(struct bt_mesh_time_srv *srv,
                                      struct bt_mesh_msg_ctx *ctx);
 
int bt_mesh_time_srv_status(struct bt_mesh_time_srv *srv, uint64_t uptime,
                            struct bt_mesh_time_status *status);
 
int64_t bt_mesh_time_srv_mktime(struct bt_mesh_time_srv *srv, struct tm *timeptr);
 
struct tm *bt_mesh_time_srv_localtime_r(struct bt_mesh_time_srv *srv,
                                        int64_t uptime, struct tm *timeptr);
 
struct tm *bt_mesh_time_srv_localtime(struct bt_mesh_time_srv *srv,
                                      int64_t uptime);
 
uint64_t bt_mesh_time_srv_uncertainty_get(struct bt_mesh_time_srv *srv,
                                       int64_t uptime);
 
void bt_mesh_time_srv_time_set(struct bt_mesh_time_srv *srv, int64_t uptime,
                               const struct bt_mesh_time_status *status);
 
void bt_mesh_time_srv_time_zone_change_set(
        struct bt_mesh_time_srv *srv,
        const struct bt_mesh_time_zone_change *data);
 
void bt_mesh_time_srv_tai_utc_change_set(
        struct bt_mesh_time_srv *srv,
        const struct bt_mesh_time_tai_utc_change *data);
 
void bt_mesh_time_srv_role_set(struct bt_mesh_time_srv *srv,
                               enum bt_mesh_time_role role);
 
extern const struct bt_mesh_model_op _bt_mesh_time_srv_op[];
extern const struct bt_mesh_model_op _bt_mesh_time_setup_srv_op[];
extern const struct bt_mesh_model_cb _bt_mesh_time_srv_cb;
extern const struct bt_mesh_model_cb _bt_mesh_time_setup_srv_cb;
int _bt_mesh_time_srv_update_handler(const struct bt_mesh_model *model);
#ifdef __cplusplus
}
#endif
 
#endif /* BT_MESH_TIME_SRV_H__ */