scene_cli.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BT_MESH_SCENE_CLI_H__
#define BT_MESH_SCENE_CLI_H__
 
#include <bluetooth/mesh/scene.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct bt_mesh_scene_cli;
 
#define BT_MESH_MODEL_SCENE_CLI(_cli)                                          \
        BT_MESH_MODEL_CB(BT_MESH_MODEL_ID_SCENE_CLI, _bt_mesh_scene_cli_op,    \
                         &(_cli)->pub,                                         \
                         BT_MESH_MODEL_USER_DATA(struct bt_mesh_scene_cli,     \
                                                 _cli),                        \
                         &_bt_mesh_scene_cli_cb)
 
struct bt_mesh_scene_register {
        enum bt_mesh_scene_status status;
        uint16_t current;
        size_t count;
        __packed uint16_t *scenes;
};
 
struct bt_mesh_scene_cli {
        void (*status)(struct bt_mesh_scene_cli *cli,
                       struct bt_mesh_msg_ctx *ctx,
                       const struct bt_mesh_scene_state *state);
 
        void (*scene_register)(struct bt_mesh_scene_cli *cli,
                               struct bt_mesh_msg_ctx *ctx,
                               const struct bt_mesh_scene_register *reg);
 
        /* Composition data entry pointer. */
        const struct bt_mesh_model *model;
        /* Model publication parameters. */
        struct bt_mesh_model_pub pub;
        /* Publication message */
        struct net_buf_simple pub_msg;
        /* Publication message buffer. */
        uint8_t buf[BT_MESH_MODEL_BUF_LEN(BT_MESH_SCENE_OP_RECALL,
                                          BT_MESH_SCENE_MSG_MAXLEN_RECALL)];
        /* Ack context */
        struct bt_mesh_msg_ack_ctx ack_ctx;
        /* Transaction ID */
        uint8_t tid;
};
 
int bt_mesh_scene_cli_get(struct bt_mesh_scene_cli *cli,
                          struct bt_mesh_msg_ctx *ctx,
                          struct bt_mesh_scene_state *rsp);
 
int bt_mesh_scene_cli_register_get(struct bt_mesh_scene_cli *cli,
                                   struct bt_mesh_msg_ctx *ctx,
                                   struct bt_mesh_scene_register *rsp);
 
int bt_mesh_scene_cli_store(struct bt_mesh_scene_cli *cli,
                            struct bt_mesh_msg_ctx *ctx, uint16_t scene,
                            struct bt_mesh_scene_register *rsp);
 
int bt_mesh_scene_cli_store_unack(struct bt_mesh_scene_cli *cli,
                                  struct bt_mesh_msg_ctx *ctx, uint16_t scene);
 
int bt_mesh_scene_cli_delete(struct bt_mesh_scene_cli *cli,
                             struct bt_mesh_msg_ctx *ctx, uint16_t scene,
                             struct bt_mesh_scene_register *rsp);
 
int bt_mesh_scene_cli_delete_unack(struct bt_mesh_scene_cli *cli,
                                   struct bt_mesh_msg_ctx *ctx, uint16_t scene);
 
int bt_mesh_scene_cli_recall(struct bt_mesh_scene_cli *cli,
                             struct bt_mesh_msg_ctx *ctx, uint16_t scene,
                             const struct bt_mesh_model_transition *transition,
                             struct bt_mesh_scene_state *rsp);
 
int bt_mesh_scene_cli_recall_unack(
        struct bt_mesh_scene_cli *cli, struct bt_mesh_msg_ctx *ctx,
        uint16_t scene, const struct bt_mesh_model_transition *transition);
 
extern const struct bt_mesh_model_op _bt_mesh_scene_cli_op[];
extern const struct bt_mesh_model_cb _bt_mesh_scene_cli_cb;
#ifdef __cplusplus
}
#endif
 
#endif /* BT_MESH_SCENE_CLI_H__ */