sensor_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_SENSOR_CLI_H__
#define BT_MESH_SENSOR_CLI_H__
 
#include <bluetooth/mesh/sensor.h>
#include <bluetooth/mesh/model_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct bt_mesh_sensor_cli_handlers;
 
#define BT_MESH_SENSOR_CLI_INIT(_handlers)                                     \
        {                                                                      \
                .cb = _handlers,                                               \
        }
 
#define BT_MESH_MODEL_SENSOR_CLI(_cli)                                         \
        BT_MESH_MODEL_CB(BT_MESH_MODEL_ID_SENSOR_CLI, _bt_mesh_sensor_cli_op,  \
                         &(_cli)->pub,                                         \
                         BT_MESH_MODEL_USER_DATA(struct bt_mesh_sensor_cli,    \
                                                 _cli),                        \
                         &_bt_mesh_sensor_cli_cb)
 
struct bt_mesh_sensor_cli {
        const struct bt_mesh_model *model;
        struct bt_mesh_model_pub pub;
        /* Publication buffer */
        struct net_buf_simple pub_buf;
        /* Publication data */
        uint8_t pub_data[MAX(
                BT_MESH_MODEL_BUF_LEN(BT_MESH_SENSOR_OP_CADENCE_SET,
                                      BT_MESH_SENSOR_MSG_MAXLEN_CADENCE_SET),
                BT_MESH_MODEL_BUF_LEN(BT_MESH_SENSOR_OP_SETTING_SET,
                                      BT_MESH_SENSOR_MSG_MAXLEN_SETTING_SET))];
        struct bt_mesh_msg_ack_ctx ack_ctx;
        const struct bt_mesh_sensor_cli_handlers *cb;
};
 
struct bt_mesh_sensor_cadence_status {
        uint8_t fast_period_div;
        uint8_t min_int;
        struct bt_mesh_sensor_threshold threshold;
};
 
#if !defined(CONFIG_BT_MESH_SENSOR_USE_LEGACY_SENSOR_VALUE) || defined(__DOXYGEN__)
struct bt_mesh_sensor_setting_status {
        const struct bt_mesh_sensor_type *type;
        struct bt_mesh_sensor_value value[CONFIG_BT_MESH_SENSOR_CHANNELS_MAX];
        bool writable;
};
 
struct bt_mesh_sensor_series_entry {
        struct bt_mesh_sensor_column column;
        struct bt_mesh_sensor_value value[CONFIG_BT_MESH_SENSOR_CHANNELS_MAX];
};
 
struct bt_mesh_sensor_info {
        uint16_t id;
        struct bt_mesh_sensor_descriptor descriptor;
};
 
struct bt_mesh_sensor_data {
        const struct bt_mesh_sensor_type *type;
        struct bt_mesh_sensor_value value[CONFIG_BT_MESH_SENSOR_CHANNELS_MAX];
};
 
union bt_mesh_sensor_column_key {
        struct bt_mesh_sensor_value sensor_value;
        uint16_t index;
};
 
struct bt_mesh_sensor_cli_handlers {
        void (*data)(struct bt_mesh_sensor_cli *cli,
                     struct bt_mesh_msg_ctx *ctx,
                     const struct bt_mesh_sensor_type *sensor,
                     const struct bt_mesh_sensor_value *value);
 
        void (*sensor)(struct bt_mesh_sensor_cli *cli,
                       struct bt_mesh_msg_ctx *ctx,
                       const struct bt_mesh_sensor_info *sensor);
 
        void (*cadence)(struct bt_mesh_sensor_cli *cli,
                        struct bt_mesh_msg_ctx *ctx,
                        const struct bt_mesh_sensor_type *sensor,
                        const struct bt_mesh_sensor_cadence_status *cadence);
 
        void (*settings)(struct bt_mesh_sensor_cli *cli,
                         struct bt_mesh_msg_ctx *ctx,
                         const struct bt_mesh_sensor_type *sensor,
                         const uint16_t *ids, uint32_t count);
 
        void (*setting_status)(
                struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
                const struct bt_mesh_sensor_type *sensor,
                const struct bt_mesh_sensor_setting_status *setting);
 
        void (*series_entry)(struct bt_mesh_sensor_cli *cli,
                             struct bt_mesh_msg_ctx *ctx,
                             const struct bt_mesh_sensor_type *sensor,
                             uint8_t index, uint8_t count,
                             const struct bt_mesh_sensor_series_entry *entry);
 
        void (*unknown_type)(struct bt_mesh_sensor_cli *cli,
                             struct bt_mesh_msg_ctx *ctx, uint16_t id,
                             uint32_t opcode);
};
 
int bt_mesh_sensor_cli_setting_set(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        const struct bt_mesh_sensor_type *setting,
        const struct bt_mesh_sensor_value *value,
        struct bt_mesh_sensor_setting_status *rsp);
 
int bt_mesh_sensor_cli_setting_set_unack(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        const struct bt_mesh_sensor_type *setting,
        const struct bt_mesh_sensor_value *value);
 
int bt_mesh_sensor_cli_get(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        struct bt_mesh_sensor_value *rsp);
 
int bt_mesh_sensor_cli_series_entry_get(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        const union bt_mesh_sensor_column_key *column,
        struct bt_mesh_sensor_series_entry *rsp);
 
int bt_mesh_sensor_cli_series_entries_get(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        const union bt_mesh_sensor_column_key *range_start,
        const union bt_mesh_sensor_column_key *range_end,
        struct bt_mesh_sensor_series_entry *rsp, uint32_t *count);
#else /* defined(CONFIG_BT_MESH_SENSOR_USE_LEGACY_SENSOR_VALUE) */
struct bt_mesh_sensor_setting_status {
        const struct bt_mesh_sensor_type *type;
        struct sensor_value value[CONFIG_BT_MESH_SENSOR_CHANNELS_MAX];
        bool writable;
};
 
struct bt_mesh_sensor_series_entry {
        struct bt_mesh_sensor_column column;
        struct sensor_value value[CONFIG_BT_MESH_SENSOR_CHANNELS_MAX];
};
 
struct bt_mesh_sensor_info {
        uint16_t id;
        struct bt_mesh_sensor_descriptor descriptor;
};
 
struct bt_mesh_sensor_data {
        const struct bt_mesh_sensor_type *type;
        struct sensor_value value[CONFIG_BT_MESH_SENSOR_CHANNELS_MAX];
};
 
struct bt_mesh_sensor_cli_handlers {
        void (*data)(struct bt_mesh_sensor_cli *cli,
                     struct bt_mesh_msg_ctx *ctx,
                     const struct bt_mesh_sensor_type *sensor,
                     const struct sensor_value *value);
 
        void (*sensor)(struct bt_mesh_sensor_cli *cli,
                       struct bt_mesh_msg_ctx *ctx,
                       const struct bt_mesh_sensor_info *sensor);
 
        void (*cadence)(struct bt_mesh_sensor_cli *cli,
                        struct bt_mesh_msg_ctx *ctx,
                        const struct bt_mesh_sensor_type *sensor,
                        const struct bt_mesh_sensor_cadence_status *cadence);
 
        void (*settings)(struct bt_mesh_sensor_cli *cli,
                         struct bt_mesh_msg_ctx *ctx,
                         const struct bt_mesh_sensor_type *sensor,
                         const uint16_t *ids, uint32_t count);
 
        void (*setting_status)(
                struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
                const struct bt_mesh_sensor_type *sensor,
                const struct bt_mesh_sensor_setting_status *setting);
 
        void (*series_entry)(struct bt_mesh_sensor_cli *cli,
                             struct bt_mesh_msg_ctx *ctx,
                             const struct bt_mesh_sensor_type *sensor,
                             uint8_t index, uint8_t count,
                             const struct bt_mesh_sensor_series_entry *entry);
 
        void (*unknown_type)(struct bt_mesh_sensor_cli *cli,
                             struct bt_mesh_msg_ctx *ctx, uint16_t id,
                             uint32_t opcode);
};
 
int bt_mesh_sensor_cli_setting_set(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        const struct bt_mesh_sensor_type *setting,
        const struct sensor_value *value,
        struct bt_mesh_sensor_setting_status *rsp);
 
int bt_mesh_sensor_cli_setting_set_unack(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        const struct bt_mesh_sensor_type *setting,
        const struct sensor_value *value);
 
int bt_mesh_sensor_cli_get(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        struct sensor_value *rsp);
 
int bt_mesh_sensor_cli_series_entry_get(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        const struct bt_mesh_sensor_column *column,
        struct bt_mesh_sensor_series_entry *rsp);
 
int bt_mesh_sensor_cli_series_entries_get(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        const struct bt_mesh_sensor_column *range,
        struct bt_mesh_sensor_series_entry *rsp, uint32_t *count);
#endif /* !defined(CONFIG_BT_MESH_SENSOR_USE_LEGACY_SENSOR_VALUE) */
 
int bt_mesh_sensor_cli_desc_all_get(struct bt_mesh_sensor_cli *cli,
                                    struct bt_mesh_msg_ctx *ctx,
                                    struct bt_mesh_sensor_info *sensors,
                                    uint32_t *count);
 
int bt_mesh_sensor_cli_desc_get(struct bt_mesh_sensor_cli *cli,
                                struct bt_mesh_msg_ctx *ctx,
                                const struct bt_mesh_sensor_type *sensor,
                                struct bt_mesh_sensor_descriptor *rsp);
 
int bt_mesh_sensor_cli_cadence_get(struct bt_mesh_sensor_cli *cli,
                                   struct bt_mesh_msg_ctx *ctx,
                                   const struct bt_mesh_sensor_type *sensor,
                                   struct bt_mesh_sensor_cadence_status *rsp);
 
int bt_mesh_sensor_cli_cadence_set(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        const struct bt_mesh_sensor_cadence_status *cadence,
        struct bt_mesh_sensor_cadence_status *rsp);
 
int bt_mesh_sensor_cli_cadence_set_unack(
        struct bt_mesh_sensor_cli *cli, struct bt_mesh_msg_ctx *ctx,
        const struct bt_mesh_sensor_type *sensor,
        const struct bt_mesh_sensor_cadence_status *cadence);
 
int bt_mesh_sensor_cli_settings_get(struct bt_mesh_sensor_cli *cli,
                                    struct bt_mesh_msg_ctx *ctx,
                                    const struct bt_mesh_sensor_type *sensor,
                                    uint16_t *ids, uint32_t *count);
 
int bt_mesh_sensor_cli_setting_get(struct bt_mesh_sensor_cli *cli,
                                   struct bt_mesh_msg_ctx *ctx,
                                   const struct bt_mesh_sensor_type *sensor,
                                   const struct bt_mesh_sensor_type *setting,
                                   struct bt_mesh_sensor_setting_status *rsp);
 
int bt_mesh_sensor_cli_all_get(struct bt_mesh_sensor_cli *cli,
                               struct bt_mesh_msg_ctx *ctx,
                               struct bt_mesh_sensor_data *sensors,
                               uint32_t *count);
 
extern const struct bt_mesh_model_op _bt_mesh_sensor_cli_op[];
extern const struct bt_mesh_model_cb _bt_mesh_sensor_cli_cb;
#ifdef __cplusplus
}
#endif
 
#endif /* BT_MESH_SENSOR_CLI_H__ */