doxygen/html/access_8h_source.html

/*

 * Copyright (c) 2017 Intel Corporation

 *

 * SPDX-License-Identifier: Apache-2.0

 */

#ifndef ZEPHYR_INCLUDE_BLUETOOTH_MESH_ACCESS_H_

#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_ACCESS_H_


#include <zephyr/sys/util.h>

#include <zephyr/settings/settings.h>

#include <zephyr/bluetooth/mesh/msg.h>


/* Internal macros used to initialize array members */

#define BT_MESH_KEY_UNUSED_ELT_(IDX, _) BT_MESH_KEY_UNUSED

#define BT_MESH_ADDR_UNASSIGNED_ELT_(IDX, _) BT_MESH_ADDR_UNASSIGNED

#define BT_MESH_UUID_UNASSIGNED_ELT_(IDX, _) NULL


#define BT_MESH_MODEL_KEYS_UNUSED(_keys)                        \

        { LISTIFY(_keys, BT_MESH_KEY_UNUSED_ELT_, (,)) }


#define BT_MESH_MODEL_GROUPS_UNASSIGNED(_grps)                  \

        { LISTIFY(_grps, BT_MESH_ADDR_UNASSIGNED_ELT_, (,)) }


#if CONFIG_BT_MESH_LABEL_COUNT > 0

#define BT_MESH_MODEL_UUIDS_UNASSIGNED()                        \

        .uuids = (const uint8_t *[]){ LISTIFY(CONFIG_BT_MESH_LABEL_COUNT, \

                                     BT_MESH_UUID_UNASSIGNED_ELT_, (,)) },

#else

#define BT_MESH_MODEL_UUIDS_UNASSIGNED()

#endif


#define BT_MESH_MODEL_RUNTIME_INIT(_user_data)                  \

        .rt = &(struct bt_mesh_model_rt_ctx){ .user_data = (_user_data) },


#ifdef __cplusplus

extern "C" {

#endif


#define BT_MESH_ADDR_UNASSIGNED    0x0000

#define BT_MESH_ADDR_ALL_NODES     0xffff

#define BT_MESH_ADDR_RELAYS        0xfffe

#define BT_MESH_ADDR_FRIENDS       0xfffd

#define BT_MESH_ADDR_PROXIES       0xfffc

#define BT_MESH_ADDR_DFW_NODES     0xfffb

#define BT_MESH_ADDR_IP_NODES      0xfffa

#define BT_MESH_ADDR_IP_BR_ROUTERS 0xfff9

#define BT_MESH_KEY_UNUSED        0xffff

#define BT_MESH_KEY_ANY           0xffff

#define BT_MESH_KEY_DEV           0xfffe

#define BT_MESH_KEY_DEV_LOCAL     BT_MESH_KEY_DEV

#define BT_MESH_KEY_DEV_REMOTE    0xfffd

#define BT_MESH_KEY_DEV_ANY       0xfffc

#define BT_MESH_ADDR_IS_UNICAST(addr) ((addr) && (addr) < 0x8000)

#define BT_MESH_ADDR_IS_GROUP(addr) ((addr) >= 0xc000 && (addr) < 0xff00)

#define BT_MESH_ADDR_IS_FIXED_GROUP(addr) ((addr) >= 0xff00 && (addr) < 0xffff)

#define BT_MESH_ADDR_IS_VIRTUAL(addr) ((addr) >= 0x8000 && (addr) < 0xc000)

#define BT_MESH_ADDR_IS_RFU(addr) ((addr) >= 0xff00 && (addr) <= 0xfff8)


#define BT_MESH_IS_DEV_KEY(key) (key == BT_MESH_KEY_DEV_LOCAL || \

                                 key == BT_MESH_KEY_DEV_REMOTE)


#define BT_MESH_APP_SEG_SDU_MAX   12


#define BT_MESH_APP_UNSEG_SDU_MAX 15


#if defined(CONFIG_BT_MESH_RX_SEG_MAX)

#define BT_MESH_RX_SEG_MAX CONFIG_BT_MESH_RX_SEG_MAX

#else

#define BT_MESH_RX_SEG_MAX 0

#endif


#if defined(CONFIG_BT_MESH_TX_SEG_MAX)

#define BT_MESH_TX_SEG_MAX CONFIG_BT_MESH_TX_SEG_MAX

#else

#define BT_MESH_TX_SEG_MAX 0

#endif


#define BT_MESH_TX_SDU_MAX        MAX((BT_MESH_TX_SEG_MAX *             \

                                       BT_MESH_APP_SEG_SDU_MAX),        \

                                      BT_MESH_APP_UNSEG_SDU_MAX)


#define BT_MESH_RX_SDU_MAX        MAX((BT_MESH_RX_SEG_MAX *             \

                                       BT_MESH_APP_SEG_SDU_MAX),        \

                                      BT_MESH_APP_UNSEG_SDU_MAX)


#define BT_MESH_ELEM(_loc, _mods, _vnd_mods)                            \

{                                                                       \

        .rt               = &(struct bt_mesh_elem_rt_ctx) { 0 },        \

        .loc              = (_loc),                                     \

        .model_count      = ARRAY_SIZE(_mods),                          \

        .vnd_model_count  = ARRAY_SIZE(_vnd_mods),                      \

        .models           = (_mods),                                    \

        .vnd_models       = (_vnd_mods),                                \

}


struct bt_mesh_elem {


        struct bt_mesh_elem_rt_ctx {

                uint16_t addr;

        } * const rt;


        const uint16_t loc;

        const uint8_t model_count;

        const uint8_t vnd_model_count;


        const struct bt_mesh_model * const models;

        const struct bt_mesh_model * const vnd_models;

};


#define BT_MESH_MODEL_ID_CFG_SRV                   0x0000

#define BT_MESH_MODEL_ID_CFG_CLI                   0x0001

#define BT_MESH_MODEL_ID_HEALTH_SRV                0x0002

#define BT_MESH_MODEL_ID_HEALTH_CLI                0x0003

#define BT_MESH_MODEL_ID_REMOTE_PROV_SRV           0x0004

#define BT_MESH_MODEL_ID_REMOTE_PROV_CLI           0x0005

#define BT_MESH_MODEL_ID_BRG_CFG_SRV               0x0008

#define BT_MESH_MODEL_ID_BRG_CFG_CLI               0x0009

#define BT_MESH_MODEL_ID_PRIV_BEACON_SRV           0x000a

#define BT_MESH_MODEL_ID_PRIV_BEACON_CLI           0x000b

#define BT_MESH_MODEL_ID_SAR_CFG_SRV               0x000e

#define BT_MESH_MODEL_ID_SAR_CFG_CLI               0x000f

#define BT_MESH_MODEL_ID_OP_AGG_SRV                0x0010

#define BT_MESH_MODEL_ID_OP_AGG_CLI                0x0011

#define BT_MESH_MODEL_ID_LARGE_COMP_DATA_SRV       0x0012

#define BT_MESH_MODEL_ID_LARGE_COMP_DATA_CLI       0x0013

#define BT_MESH_MODEL_ID_SOL_PDU_RPL_SRV           0x0014

#define BT_MESH_MODEL_ID_SOL_PDU_RPL_CLI           0x0015

#define BT_MESH_MODEL_ID_ON_DEMAND_PROXY_SRV       0x000c

#define BT_MESH_MODEL_ID_ON_DEMAND_PROXY_CLI       0x000d

#define BT_MESH_MODEL_ID_GEN_ONOFF_SRV             0x1000

#define BT_MESH_MODEL_ID_GEN_ONOFF_CLI             0x1001

#define BT_MESH_MODEL_ID_GEN_LEVEL_SRV             0x1002

#define BT_MESH_MODEL_ID_GEN_LEVEL_CLI             0x1003

#define BT_MESH_MODEL_ID_GEN_DEF_TRANS_TIME_SRV    0x1004

#define BT_MESH_MODEL_ID_GEN_DEF_TRANS_TIME_CLI    0x1005

#define BT_MESH_MODEL_ID_GEN_POWER_ONOFF_SRV       0x1006

#define BT_MESH_MODEL_ID_GEN_POWER_ONOFF_SETUP_SRV 0x1007

#define BT_MESH_MODEL_ID_GEN_POWER_ONOFF_CLI       0x1008

#define BT_MESH_MODEL_ID_GEN_POWER_LEVEL_SRV       0x1009

#define BT_MESH_MODEL_ID_GEN_POWER_LEVEL_SETUP_SRV 0x100a

#define BT_MESH_MODEL_ID_GEN_POWER_LEVEL_CLI       0x100b

#define BT_MESH_MODEL_ID_GEN_BATTERY_SRV           0x100c

#define BT_MESH_MODEL_ID_GEN_BATTERY_CLI           0x100d

#define BT_MESH_MODEL_ID_GEN_LOCATION_SRV          0x100e

#define BT_MESH_MODEL_ID_GEN_LOCATION_SETUPSRV     0x100f

#define BT_MESH_MODEL_ID_GEN_LOCATION_CLI          0x1010

#define BT_MESH_MODEL_ID_GEN_ADMIN_PROP_SRV        0x1011

#define BT_MESH_MODEL_ID_GEN_MANUFACTURER_PROP_SRV 0x1012

#define BT_MESH_MODEL_ID_GEN_USER_PROP_SRV         0x1013

#define BT_MESH_MODEL_ID_GEN_CLIENT_PROP_SRV       0x1014

#define BT_MESH_MODEL_ID_GEN_PROP_CLI              0x1015

#define BT_MESH_MODEL_ID_SENSOR_SRV                0x1100

#define BT_MESH_MODEL_ID_SENSOR_SETUP_SRV          0x1101

#define BT_MESH_MODEL_ID_SENSOR_CLI                0x1102

#define BT_MESH_MODEL_ID_TIME_SRV                  0x1200

#define BT_MESH_MODEL_ID_TIME_SETUP_SRV            0x1201

#define BT_MESH_MODEL_ID_TIME_CLI                  0x1202

#define BT_MESH_MODEL_ID_SCENE_SRV                 0x1203

#define BT_MESH_MODEL_ID_SCENE_SETUP_SRV           0x1204

#define BT_MESH_MODEL_ID_SCENE_CLI                 0x1205

#define BT_MESH_MODEL_ID_SCHEDULER_SRV             0x1206

#define BT_MESH_MODEL_ID_SCHEDULER_SETUP_SRV       0x1207

#define BT_MESH_MODEL_ID_SCHEDULER_CLI             0x1208

#define BT_MESH_MODEL_ID_LIGHT_LIGHTNESS_SRV       0x1300

#define BT_MESH_MODEL_ID_LIGHT_LIGHTNESS_SETUP_SRV 0x1301

#define BT_MESH_MODEL_ID_LIGHT_LIGHTNESS_CLI       0x1302

#define BT_MESH_MODEL_ID_LIGHT_CTL_SRV             0x1303

#define BT_MESH_MODEL_ID_LIGHT_CTL_SETUP_SRV       0x1304

#define BT_MESH_MODEL_ID_LIGHT_CTL_CLI             0x1305

#define BT_MESH_MODEL_ID_LIGHT_CTL_TEMP_SRV        0x1306

#define BT_MESH_MODEL_ID_LIGHT_HSL_SRV             0x1307

#define BT_MESH_MODEL_ID_LIGHT_HSL_SETUP_SRV       0x1308

#define BT_MESH_MODEL_ID_LIGHT_HSL_CLI             0x1309

#define BT_MESH_MODEL_ID_LIGHT_HSL_HUE_SRV         0x130a

#define BT_MESH_MODEL_ID_LIGHT_HSL_SAT_SRV         0x130b

#define BT_MESH_MODEL_ID_LIGHT_XYL_SRV             0x130c

#define BT_MESH_MODEL_ID_LIGHT_XYL_SETUP_SRV       0x130d

#define BT_MESH_MODEL_ID_LIGHT_XYL_CLI             0x130e

#define BT_MESH_MODEL_ID_LIGHT_LC_SRV              0x130f

#define BT_MESH_MODEL_ID_LIGHT_LC_SETUPSRV         0x1310

#define BT_MESH_MODEL_ID_LIGHT_LC_CLI              0x1311

#define BT_MESH_MODEL_ID_BLOB_SRV                  0x1400

#define BT_MESH_MODEL_ID_BLOB_CLI                  0x1401

#define BT_MESH_MODEL_ID_DFU_SRV                   0x1402

#define BT_MESH_MODEL_ID_DFU_CLI                   0x1403

#define BT_MESH_MODEL_ID_DFD_SRV                   0x1404

#define BT_MESH_MODEL_ID_DFD_CLI                   0x1405


struct bt_mesh_model_op {

        const uint32_t  opcode;


        const ssize_t len;


        int (*const func)(const struct bt_mesh_model *model,

                          struct bt_mesh_msg_ctx *ctx,

                          struct net_buf_simple *buf);

};


#define BT_MESH_MODEL_OP_1(b0) (b0)

#define BT_MESH_MODEL_OP_2(b0, b1) (((b0) << 8) | (b1))

#define BT_MESH_MODEL_OP_3(b0, cid) ((((b0) << 16) | 0xc00000) | (cid))


#define BT_MESH_LEN_EXACT(len) (-len)

#define BT_MESH_LEN_MIN(len) (len)


#define BT_MESH_MODEL_OP_END { 0, 0, NULL }


#if !defined(__cplusplus) || defined(__DOXYGEN__)


#define BT_MESH_MODEL_NO_OPS ((struct bt_mesh_model_op []) \

                              { BT_MESH_MODEL_OP_END })


#define BT_MESH_MODEL_NONE ((const struct bt_mesh_model []){})


#define BT_MESH_MODEL_CNT_CB(_id, _op, _pub, _user_data, _keys, _grps, _cb)     \

{                                                                               \

        .id = (_id),                                                            \

        BT_MESH_MODEL_RUNTIME_INIT(_user_data)                                  \

        .pub = _pub,                                                            \

        .keys = (uint16_t []) BT_MESH_MODEL_KEYS_UNUSED(_keys),                 \

        .keys_cnt = _keys,                                                      \

        .groups = (uint16_t []) BT_MESH_MODEL_GROUPS_UNASSIGNED(_grps),         \

        .groups_cnt = _grps,                                                    \

        BT_MESH_MODEL_UUIDS_UNASSIGNED()                                        \

        .op = _op,                                                              \

        .cb = _cb,                                                              \

}


#define BT_MESH_MODEL_CNT_VND_CB(_company, _id, _op, _pub, _user_data, _keys, _grps, _cb)       \

{                                                                                               \

        .vnd.company = (_company),                                                              \

        .vnd.id = (_id),                                                                        \

        BT_MESH_MODEL_RUNTIME_INIT(_user_data)                                                  \

        .op = _op,                                                                              \

        .pub = _pub,                                                                            \

        .keys = (uint16_t []) BT_MESH_MODEL_KEYS_UNUSED(_keys),                                 \

        .keys_cnt = _keys,                                                                      \

        .groups = (uint16_t []) BT_MESH_MODEL_GROUPS_UNASSIGNED(_grps),                         \

        .groups_cnt = _grps,                                                                    \

        BT_MESH_MODEL_UUIDS_UNASSIGNED()                                                        \

        .cb = _cb,                                                                              \

}


#define BT_MESH_MODEL_CB(_id, _op, _pub, _user_data, _cb)       \

        BT_MESH_MODEL_CNT_CB(_id, _op, _pub, _user_data,        \

                             CONFIG_BT_MESH_MODEL_KEY_COUNT,    \

                             CONFIG_BT_MESH_MODEL_GROUP_COUNT, _cb)


#if defined(CONFIG_BT_MESH_LARGE_COMP_DATA_SRV)

#define BT_MESH_MODEL_METADATA_CB(_id, _op, _pub, _user_data, _cb, _metadata)                    \

{                                                                            \

        .id = (_id),                                                         \

        BT_MESH_MODEL_RUNTIME_INIT(_user_data)                               \

        .pub = _pub,                                                         \

        .keys = (uint16_t []) BT_MESH_MODEL_KEYS_UNUSED(CONFIG_BT_MESH_MODEL_KEY_COUNT), \

        .keys_cnt = CONFIG_BT_MESH_MODEL_KEY_COUNT,                          \

        .groups = (uint16_t []) BT_MESH_MODEL_GROUPS_UNASSIGNED(CONFIG_BT_MESH_MODEL_GROUP_COUNT), \

        .groups_cnt = CONFIG_BT_MESH_MODEL_GROUP_COUNT,                      \

        BT_MESH_MODEL_UUIDS_UNASSIGNED()                                     \

        .op = _op,                                                           \

        .cb = _cb,                                                           \

        .metadata = _metadata,                                               \

}

#else


#define BT_MESH_MODEL_METADATA_CB(_id, _op, _pub, _user_data, _cb, _metadata)  \

        BT_MESH_MODEL_CB(_id, _op, _pub, _user_data, _cb)


#endif


#define BT_MESH_MODEL_VND_CB(_company, _id, _op, _pub, _user_data, _cb) \

        BT_MESH_MODEL_CNT_VND_CB(_company, _id, _op, _pub, _user_data,  \

                                 CONFIG_BT_MESH_MODEL_KEY_COUNT,        \

                                 CONFIG_BT_MESH_MODEL_GROUP_COUNT, _cb)


#if defined(CONFIG_BT_MESH_LARGE_COMP_DATA_SRV)

#define BT_MESH_MODEL_VND_METADATA_CB(_company, _id, _op, _pub, _user_data, _cb, _metadata)      \

{                                                                            \

        .vnd.company = (_company),                                           \

        .vnd.id = (_id),                                                     \

        BT_MESH_MODEL_RUNTIME_INIT(_user_data)                               \

        .op = _op,                                                           \

        .pub = _pub,                                                         \

        .keys = (uint16_t []) BT_MESH_MODEL_KEYS_UNUSED(CONFIG_BT_MESH_MODEL_KEY_COUNT), \

        .keys_cnt = CONFIG_BT_MESH_MODEL_KEY_COUNT,                          \

        .groups = (uint16_t []) BT_MESH_MODEL_GROUPS_UNASSIGNED(CONFIG_BT_MESH_MODEL_GROUP_COUNT), \

        .groups_cnt = CONFIG_BT_MESH_MODEL_GROUP_COUNT,                      \

        BT_MESH_MODEL_UUIDS_UNASSIGNED()                                     \

        .cb = _cb,                                                           \

        .metadata = _metadata,                                               \

}

#else


#define BT_MESH_MODEL_VND_METADATA_CB(_company, _id, _op, _pub, _user_data, _cb, _metadata)      \

        BT_MESH_MODEL_VND_CB(_company, _id, _op, _pub, _user_data, _cb)


#endif


#define BT_MESH_MODEL(_id, _op, _pub, _user_data)                              \

        BT_MESH_MODEL_CB(_id, _op, _pub, _user_data, NULL)


#define BT_MESH_MODEL_VND(_company, _id, _op, _pub, _user_data)                \

        BT_MESH_MODEL_VND_CB(_company, _id, _op, _pub, _user_data, NULL)


#endif /* !defined(__cplusplus) || defined(__DOXYGEN__) */


#define BT_MESH_TRANSMIT(count, int_ms) ((count) | (((int_ms / 10) - 1) << 3))


#define BT_MESH_TRANSMIT_COUNT(transmit) (((transmit) & (uint8_t)BIT_MASK(3)))


#define BT_MESH_TRANSMIT_INT(transmit) ((((transmit) >> 3) + 1) * 10)


#define BT_MESH_PUB_TRANSMIT(count, int_ms) BT_MESH_TRANSMIT(count,           \

                                                             (int_ms) / 5)


#define BT_MESH_PUB_TRANSMIT_COUNT(transmit) BT_MESH_TRANSMIT_COUNT(transmit)


#define BT_MESH_PUB_TRANSMIT_INT(transmit) ((((transmit) >> 3) + 1) * 50)


#define BT_MESH_PUB_MSG_TOTAL(pub) (BT_MESH_PUB_TRANSMIT_COUNT((pub)->retransmit) + 1)


#define BT_MESH_PUB_MSG_NUM(pub) (BT_MESH_PUB_TRANSMIT_COUNT((pub)->retransmit) + 1 - (pub)->count)


struct bt_mesh_model_pub {

        const struct bt_mesh_model *mod;


        uint16_t addr;

        const uint8_t *uuid;

        uint16_t key:12,

                 cred:1,

                 send_rel:1,

                 fast_period:1,

                 retr_update:1;

        uint8_t  ttl;

        uint8_t  retransmit;

        uint8_t  period;

        uint8_t  period_div:4,

                 count:4;

        uint8_t delayable:1;

        uint32_t period_start;

        struct net_buf_simple *msg;


        int (*update)(const struct bt_mesh_model *mod);


        struct k_work_delayable timer;

};


#define BT_MESH_MODEL_PUB_DEFINE(_name, _update, _msg_len) \

        NET_BUF_SIMPLE_DEFINE_STATIC(bt_mesh_pub_msg_##_name, _msg_len); \

        static struct bt_mesh_model_pub _name = { \

                .msg = &bt_mesh_pub_msg_##_name, \

                .update = _update, \

        }


struct bt_mesh_models_metadata_entry {

        /* Length of the metadata */

        const uint16_t len;


        /* ID of the metadata */

        const uint16_t id;


        /* Pointer to raw data */

        const void * const data;

};


#define BT_MESH_MODELS_METADATA_ENTRY(_len, _id, _data)                         \

        {                                                                      \

                .len = (_len), .id = _id, .data = _data,                       \

        }


#define BT_MESH_MODELS_METADATA_NONE NULL


#define BT_MESH_MODELS_METADATA_END { 0, 0, NULL }


struct bt_mesh_model_cb {

        int (*const settings_set)(const struct bt_mesh_model *model,

                                  const char *name, size_t len_rd,

                                  settings_read_cb read_cb, void *cb_arg);


        int (*const start)(const struct bt_mesh_model *model);


        int (*const init)(const struct bt_mesh_model *model);


        void (*const reset)(const struct bt_mesh_model *model);


        void (*const pending_store)(const struct bt_mesh_model *model);

};


struct bt_mesh_mod_id_vnd {

        uint16_t company;

        uint16_t id;

};


struct bt_mesh_model {

        union {

                const uint16_t id;

                const struct bt_mesh_mod_id_vnd vnd;

        };


        /* Model runtime information */


        struct bt_mesh_model_rt_ctx {

                uint8_t  elem_idx;   /* Belongs to Nth element */

                uint8_t  mod_idx;    /* Is the Nth model in the element */

                uint16_t flags;      /* Model flags for internal bookkeeping */


#ifdef CONFIG_BT_MESH_MODEL_EXTENSIONS

                /* Pointer to the next model in a model extension list. */

                const struct bt_mesh_model *next;

#endif

                void *user_data;

        } * const rt;


        struct bt_mesh_model_pub * const pub;


        uint16_t * const keys;

        const uint16_t keys_cnt;


        uint16_t * const groups;

        const uint16_t groups_cnt;


#if (CONFIG_BT_MESH_LABEL_COUNT > 0) || defined(__DOXYGEN__)

        const uint8_t ** const uuids;

#endif


        const struct bt_mesh_model_op * const op;


        const struct bt_mesh_model_cb * const cb;


#if defined(CONFIG_BT_MESH_LARGE_COMP_DATA_SRV) || defined(__DOXYGEN__)

        /* Pointer to the array of model metadata entries. */

        const struct bt_mesh_models_metadata_entry * const metadata;

#endif

};


struct bt_mesh_send_cb {

        void (*start)(uint16_t duration, int err, void *cb_data);

        void (*end)(int err, void *cb_data);

};


#define BT_MESH_TTL_DEFAULT 0xff


#define BT_MESH_TTL_MAX     0x7f


int bt_mesh_model_send(const struct bt_mesh_model *model,

                       struct bt_mesh_msg_ctx *ctx,

                       struct net_buf_simple *msg,

                       const struct bt_mesh_send_cb *cb,

                       void *cb_data);


int bt_mesh_model_publish(const struct bt_mesh_model *model);


static inline bool bt_mesh_model_pub_is_retransmission(const struct bt_mesh_model *model)

{

        return model->pub->count != BT_MESH_PUB_TRANSMIT_COUNT(model->pub->retransmit);

}


const struct bt_mesh_elem *bt_mesh_model_elem(const struct bt_mesh_model *mod);


const struct bt_mesh_model *bt_mesh_model_find(const struct bt_mesh_elem *elem,

                                               uint16_t id);


const struct bt_mesh_model *bt_mesh_model_find_vnd(const struct bt_mesh_elem *elem,

                                                   uint16_t company, uint16_t id);


static inline bool bt_mesh_model_in_primary(const struct bt_mesh_model *mod)

{

        return (mod->rt->elem_idx == 0);

}


int bt_mesh_model_data_store(const struct bt_mesh_model *mod, bool vnd,

                             const char *name, const void *data,

                             size_t data_len);


void bt_mesh_model_data_store_schedule(const struct bt_mesh_model *mod);


int bt_mesh_model_extend(const struct bt_mesh_model *extending_mod,

                         const struct bt_mesh_model *base_mod);


int bt_mesh_model_correspond(const struct bt_mesh_model *corresponding_mod,

                             const struct bt_mesh_model *base_mod);


bool bt_mesh_model_is_extended(const struct bt_mesh_model *model);


int bt_mesh_comp_change_prepare(void);


int bt_mesh_models_metadata_change_prepare(void);


struct bt_mesh_comp {

        uint16_t cid;

        uint16_t pid;

        uint16_t vid;

        size_t elem_count;

        const struct bt_mesh_elem *elem;

};


struct bt_mesh_comp2_record {

        uint16_t id;

        struct {

                uint8_t x;

                uint8_t y;

                uint8_t z;

        } version;

        uint8_t elem_offset_cnt;

        const uint8_t *elem_offset;

        uint16_t data_len;

        const void *data;

};


struct bt_mesh_comp2 {

        size_t record_cnt;

        const struct bt_mesh_comp2_record *record;

};


int bt_mesh_comp2_register(const struct bt_mesh_comp2 *comp2);


#ifdef __cplusplus

}

#endif


#endif /* ZEPHYR_INCLUDE_BLUETOOTH_MESH_ACCESS_H_ */

bt_mesh_model_correspond
int bt_mesh_model_correspond(const struct bt_mesh_model *corresponding_mod, const struct bt_mesh_model *base_mod)
Let a model correspond to another.

bt_mesh_model_publish
int bt_mesh_model_publish(const struct bt_mesh_model *model)
Send a model publication message.

bt_mesh_model_is_extended
bool bt_mesh_model_is_extended(const struct bt_mesh_model *model)
Check if model is extended by another model.

BT_MESH_PUB_TRANSMIT_COUNT
#define BT_MESH_PUB_TRANSMIT_COUNT(transmit)
Decode Publish Retransmit count from a given value.
Definition access.h:671

bt_mesh_model_pub_is_retransmission
static bool bt_mesh_model_pub_is_retransmission(const struct bt_mesh_model *model)
Check if a message is being retransmitted.
Definition access.h:1004

bt_mesh_models_metadata_change_prepare
int bt_mesh_models_metadata_change_prepare(void)
Indicate that the metadata will change on next bootup.

bt_mesh_model_data_store_schedule
void bt_mesh_model_data_store_schedule(const struct bt_mesh_model *mod)
Schedule the model's user data store in persistent storage.

bt_mesh_model_send
int bt_mesh_model_send(const struct bt_mesh_model *model, struct bt_mesh_msg_ctx *ctx, struct net_buf_simple *msg, const struct bt_mesh_send_cb *cb, void *cb_data)
Send an Access Layer message.

bt_mesh_comp2_register
int bt_mesh_comp2_register(const struct bt_mesh_comp2 *comp2)
Register composition data page 2 of the device.

bt_mesh_comp_change_prepare
int bt_mesh_comp_change_prepare(void)
Indicate that the composition data will change on next bootup.

bt_mesh_model_elem
const struct bt_mesh_elem * bt_mesh_model_elem(const struct bt_mesh_model *mod)
Get the element that a model belongs to.

bt_mesh_model_in_primary
static bool bt_mesh_model_in_primary(const struct bt_mesh_model *mod)
Get whether the model is in the primary element of the device.
Definition access.h:1046

bt_mesh_model_find_vnd
const struct bt_mesh_model * bt_mesh_model_find_vnd(const struct bt_mesh_elem *elem, uint16_t company, uint16_t id)
Find a vendor model.

bt_mesh_model_data_store
int bt_mesh_model_data_store(const struct bt_mesh_model *mod, bool vnd, const char *name, const void *data, size_t data_len)
Immediately store the model's user data in persistent storage.

bt_mesh_model_find
const struct bt_mesh_model * bt_mesh_model_find(const struct bt_mesh_elem *elem, uint16_t id)
Find a SIG model.

bt_mesh_model_extend
int bt_mesh_model_extend(const struct bt_mesh_model *extending_mod, const struct bt_mesh_model *base_mod)
Let a model extend another.

settings_read_cb
ssize_t(* settings_read_cb)(void *cb_arg, void *data, size_t len)
Function used to read the data from the settings storage in h_set handler implementations.
Definition settings.h:61

ssize_t
__SIZE_TYPE__ ssize_t
Definition types.h:28

msg.h
Message APIs.

settings.h

uint32_t
__UINT32_TYPE__ uint32_t
Definition stdint.h:90

uint8_t
__UINT8_TYPE__ uint8_t
Definition stdint.h:88

uint16_t
__UINT16_TYPE__ uint16_t
Definition stdint.h:89

bt_mesh_comp2_record
Composition data page 2 record.
Definition access.h:1165

bt_mesh_comp2_record::id
uint16_t id
Mesh profile ID.
Definition access.h:1167

bt_mesh_comp2_record::y
uint8_t y
Minor version.
Definition access.h:1173

bt_mesh_comp2_record::x
uint8_t x
Major version.
Definition access.h:1171

bt_mesh_comp2_record::elem_offset
const uint8_t * elem_offset
Element offset list.
Definition access.h:1180

bt_mesh_comp2_record::version
struct bt_mesh_comp2_record::@143 version
Mesh Profile Version.

bt_mesh_comp2_record::data_len
uint16_t data_len
Length of additional data.
Definition access.h:1182

bt_mesh_comp2_record::z
uint8_t z
Z version.
Definition access.h:1175

bt_mesh_comp2_record::data
const void * data
Additional data.
Definition access.h:1184

bt_mesh_comp2_record::elem_offset_cnt
uint8_t elem_offset_cnt
Element offset count.
Definition access.h:1178

bt_mesh_comp2
Node Composition data page 2.
Definition access.h:1188

bt_mesh_comp2::record_cnt
size_t record_cnt
The number of Mesh Profile records on a device.
Definition access.h:1190

bt_mesh_comp2::record
const struct bt_mesh_comp2_record * record
List of records.
Definition access.h:1192

bt_mesh_comp
Node Composition.
Definition access.h:1155

bt_mesh_comp::pid
uint16_t pid
Product ID.
Definition access.h:1157

bt_mesh_comp::cid
uint16_t cid
Company ID.
Definition access.h:1156

bt_mesh_comp::vid
uint16_t vid
Version ID.
Definition access.h:1158

bt_mesh_comp::elem
const struct bt_mesh_elem * elem
List of elements.
Definition access.h:1161

bt_mesh_comp::elem_count
size_t elem_count
The number of elements in this device.
Definition access.h:1160

bt_mesh_elem::bt_mesh_elem_rt_ctx
Mesh Element runtime information.
Definition access.h:156

bt_mesh_elem::bt_mesh_elem_rt_ctx::addr
uint16_t addr
Unicast Address.
Definition access.h:158

bt_mesh_elem
Abstraction that describes a Mesh Element.
Definition access.h:154

bt_mesh_elem::rt
struct bt_mesh_elem::bt_mesh_elem_rt_ctx rt

bt_mesh_elem::models
const struct bt_mesh_model *const models
The list of SIG models in this element.
Definition access.h:169

bt_mesh_elem::loc
const uint16_t loc
Location Descriptor (GATT Bluetooth Namespace Descriptors)
Definition access.h:162

bt_mesh_elem::model_count
const uint8_t model_count
The number of SIG models in this element.
Definition access.h:164

bt_mesh_elem::vnd_models
const struct bt_mesh_model *const vnd_models
The list of vendor models in this element.
Definition access.h:171

bt_mesh_elem::vnd_model_count
const uint8_t vnd_model_count
The number of vendor models in this element.
Definition access.h:166

bt_mesh_mod_id_vnd
Vendor model ID.
Definition access.h:883

bt_mesh_mod_id_vnd::company
uint16_t company
Vendor's company ID.
Definition access.h:885

bt_mesh_mod_id_vnd::id
uint16_t id
Model ID.
Definition access.h:887

bt_mesh_model::bt_mesh_model_rt_ctx
Definition access.h:900

bt_mesh_model::bt_mesh_model_rt_ctx::next
const struct bt_mesh_model * next
Definition access.h:907

bt_mesh_model::bt_mesh_model_rt_ctx::user_data
void * user_data
Model-specific user data.
Definition access.h:910

bt_mesh_model::bt_mesh_model_rt_ctx::mod_idx
uint8_t mod_idx
Definition access.h:902

bt_mesh_model::bt_mesh_model_rt_ctx::flags
uint16_t flags
Definition access.h:903

bt_mesh_model::bt_mesh_model_rt_ctx::elem_idx
uint8_t elem_idx
Definition access.h:901

bt_mesh_model_cb
Model callback functions.
Definition access.h:813

bt_mesh_model_cb::init
int(*const init)(const struct bt_mesh_model *model)
Model init callback.
Definition access.h:857

bt_mesh_model_cb::settings_set
int(*const settings_set)(const struct bt_mesh_model *model, const char *name, size_t len_rd, settings_read_cb read_cb, void *cb_arg)
Set value handler of user data tied to the model.
Definition access.h:827

bt_mesh_model_cb::reset
void(*const reset)(const struct bt_mesh_model *model)
Model reset callback.
Definition access.h:869

bt_mesh_model_cb::start
int(*const start)(const struct bt_mesh_model *model)
Callback called when the mesh is started.
Definition access.h:843

bt_mesh_model_cb::pending_store
void(*const pending_store)(const struct bt_mesh_model *model)
Callback used to store pending model's user data.
Definition access.h:879

bt_mesh_model_op
Model opcode handler.
Definition access.h:363

bt_mesh_model_op::opcode
const uint32_t opcode
OpCode encoded using the BT_MESH_MODEL_OP_* macros.
Definition access.h:365

bt_mesh_model_op::len
const ssize_t len
Message length.
Definition access.h:373

bt_mesh_model_op::func
int(*const func)(const struct bt_mesh_model *model, struct bt_mesh_msg_ctx *ctx, struct net_buf_simple *buf)
Handler function for this opcode.
Definition access.h:384

bt_mesh_model_pub
Model publication context.
Definition access.h:708

bt_mesh_model_pub::update
int(* update)(const struct bt_mesh_model *mod)
Callback for updating the publication buffer.
Definition access.h:757

bt_mesh_model_pub::key
uint16_t key
Publish AppKey Index.
Definition access.h:714

bt_mesh_model_pub::retr_update
uint16_t retr_update
Call update callback on every retransmission.
Definition access.h:718

bt_mesh_model_pub::delayable
uint8_t delayable
Use random delay for publishing.
Definition access.h:726

bt_mesh_model_pub::cred
uint16_t cred
Friendship Credentials Flag.
Definition access.h:715

bt_mesh_model_pub::retransmit
uint8_t retransmit
Retransmit Count & Interval Steps.
Definition access.h:721

bt_mesh_model_pub::addr
uint16_t addr
Publish Address.
Definition access.h:712

bt_mesh_model_pub::count
uint8_t count
Transmissions left.
Definition access.h:724

bt_mesh_model_pub::period_div
uint8_t period_div
Divisor for the Period.
Definition access.h:723

bt_mesh_model_pub::msg
struct net_buf_simple * msg
Publication buffer, containing the publication message.
Definition access.h:737

bt_mesh_model_pub::ttl
uint8_t ttl
Publish Time to Live.
Definition access.h:720

bt_mesh_model_pub::mod
const struct bt_mesh_model * mod
The model the context belongs to.
Definition access.h:710

bt_mesh_model_pub::period_start
uint32_t period_start
Start of the current period.
Definition access.h:728

bt_mesh_model_pub::send_rel
uint16_t send_rel
Force reliable sending (segment acks)
Definition access.h:716

bt_mesh_model_pub::fast_period
uint16_t fast_period
Use FastPeriodDivisor.
Definition access.h:717

bt_mesh_model_pub::uuid
const uint8_t * uuid
Label UUID if Publish Address is Virtual Address.
Definition access.h:713

bt_mesh_model_pub::period
uint8_t period
Publish Period.
Definition access.h:722

bt_mesh_model_pub::timer
struct k_work_delayable timer
Publish Period Timer.
Definition access.h:760

bt_mesh_model
Abstraction that describes a Mesh Model instance.
Definition access.h:891

bt_mesh_model::uuids
const uint8_t **const uuids
List of Label UUIDs the model is subscribed to.
Definition access.h:926

bt_mesh_model::vnd
const struct bt_mesh_mod_id_vnd vnd
Vendor model ID.
Definition access.h:896

bt_mesh_model::rt
struct bt_mesh_model::bt_mesh_model_rt_ctx rt

bt_mesh_model::groups
uint16_t *const groups
Subscription List (group or virtual addresses)
Definition access.h:921

bt_mesh_model::op
const struct bt_mesh_model_op *const op
Opcode handler list.
Definition access.h:930

bt_mesh_model::keys
uint16_t *const keys
AppKey List.
Definition access.h:917

bt_mesh_model::cb
const struct bt_mesh_model_cb *const cb
Model callback structure.
Definition access.h:933

bt_mesh_model::keys_cnt
const uint16_t keys_cnt
Definition access.h:918

bt_mesh_model::id
const uint16_t id
SIG model ID.
Definition access.h:894

bt_mesh_model::groups_cnt
const uint16_t groups_cnt
Definition access.h:922

bt_mesh_model::pub
struct bt_mesh_model_pub *const pub
Model Publication.
Definition access.h:914

bt_mesh_model::metadata
const struct bt_mesh_models_metadata_entry *const metadata
Definition access.h:937

bt_mesh_models_metadata_entry
Models Metadata Entry struct.
Definition access.h:782

bt_mesh_models_metadata_entry::len
const uint16_t len
Definition access.h:784

bt_mesh_models_metadata_entry::data
const void *const data
Definition access.h:790

bt_mesh_models_metadata_entry::id
const uint16_t id
Definition access.h:787

bt_mesh_msg_ctx
Message sending context.
Definition msg.h:76

bt_mesh_send_cb
Callback structure for monitoring model message sending.
Definition access.h:942

bt_mesh_send_cb::start
void(* start)(uint16_t duration, int err, void *cb_data)
Handler called at the start of the transmission.
Definition access.h:949

bt_mesh_send_cb::end
void(* end)(int err, void *cb_data)
Handler called at the end of the transmission.
Definition access.h:955

k_work_delayable
A structure used to submit work after a delay.
Definition kernel.h:3985

net_buf_simple
Simple network buffer representation.
Definition net_buf.h:89

util.h
Misc utilities.