OVMS3-idf/components/bt/esp_ble_mesh/mesh_core/include/cfg_cli.h

/** @file
 *  @brief Bluetooth Mesh Configuration Client Model APIs.
 */

/*
 * Copyright (c) 2017 Intel Corporation
 * Additional Copyright (c) 2018 Espressif Systems (Shanghai) PTE LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef _BLE_MESH_CFG_CLI_H_
#define _BLE_MESH_CFG_CLI_H_

#include "client_common.h"

/**
 * @brief Bluetooth Mesh
 * @defgroup bt_mesh_cfg_cli Bluetooth Mesh Configuration Client Model
 * @ingroup bt_mesh
 * @{
 */

/* Config client model common structure */
typedef bt_mesh_client_user_data_t      bt_mesh_config_client_t;
typedef bt_mesh_client_internal_data_t  config_internal_data_t;

extern const struct bt_mesh_model_op bt_mesh_cfg_cli_op[];

#define BLE_MESH_MODEL_CFG_CLI(cli_data)            \
        BLE_MESH_MODEL(BLE_MESH_MODEL_ID_CFG_CLI,   \
            bt_mesh_cfg_cli_op, NULL, cli_data)

int bt_mesh_cfg_comp_data_get(struct bt_mesh_msg_ctx *ctx, u8_t page);

int bt_mesh_cfg_beacon_get(struct bt_mesh_msg_ctx *ctx);

int bt_mesh_cfg_beacon_set(struct bt_mesh_msg_ctx *ctx, u8_t val);

int bt_mesh_cfg_ttl_get(struct bt_mesh_msg_ctx *ctx);

int bt_mesh_cfg_ttl_set(struct bt_mesh_msg_ctx *ctx, u8_t val);

int bt_mesh_cfg_friend_get(struct bt_mesh_msg_ctx *ctx);

int bt_mesh_cfg_friend_set(struct bt_mesh_msg_ctx *ctx, u8_t val);

int bt_mesh_cfg_gatt_proxy_get(struct bt_mesh_msg_ctx *ctx);

int bt_mesh_cfg_gatt_proxy_set(struct bt_mesh_msg_ctx *ctx, u8_t val);

int bt_mesh_cfg_relay_get(struct bt_mesh_msg_ctx *ctx);

int bt_mesh_cfg_relay_set(struct bt_mesh_msg_ctx *ctx, u8_t new_relay, u8_t new_transmit);

int bt_mesh_cfg_net_key_add(struct bt_mesh_msg_ctx *ctx, u16_t key_net_idx,
                            const u8_t net_key[16]);

int bt_mesh_cfg_app_key_add(struct bt_mesh_msg_ctx *ctx, u16_t key_net_idx,
                            u16_t key_app_idx, const u8_t app_key[16]);

int bt_mesh_cfg_mod_app_bind(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                             u16_t mod_app_idx, u16_t mod_id, u16_t cid);

struct bt_mesh_cfg_mod_pub {
    u16_t addr;
    u16_t app_idx;
    bool  cred_flag;
    u8_t  ttl;
    u8_t  period;
    u8_t  transmit;
};

int bt_mesh_cfg_mod_pub_get(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                            u16_t mod_id, u16_t cid);

int bt_mesh_cfg_mod_pub_set(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                            u16_t mod_id, u16_t cid,
                            struct bt_mesh_cfg_mod_pub *pub);

int bt_mesh_cfg_mod_sub_add(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                            u16_t sub_addr, u16_t mod_id, u16_t cid);

int bt_mesh_cfg_mod_sub_del(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                            u16_t sub_addr, u16_t mod_id, u16_t cid);

int bt_mesh_cfg_mod_sub_overwrite(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                                  u16_t sub_addr, u16_t mod_id, u16_t cid);

int bt_mesh_cfg_mod_sub_va_add(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                               const u8_t label[16], u16_t mod_id, u16_t cid);

int bt_mesh_cfg_mod_sub_va_del(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                               const u8_t label[16], u16_t mod_id, u16_t cid);

int bt_mesh_cfg_mod_sub_va_overwrite(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                                     const u8_t label[16], u16_t mod_id, u16_t cid);

struct bt_mesh_cfg_hb_sub {
    u16_t src;
    u16_t dst;
    u8_t  period;
};

int bt_mesh_cfg_hb_sub_set(struct bt_mesh_msg_ctx *ctx,
                           struct bt_mesh_cfg_hb_sub *sub);

int bt_mesh_cfg_hb_sub_get(struct bt_mesh_msg_ctx *ctx);

struct bt_mesh_cfg_hb_pub {
    u16_t dst;
    u8_t  count;
    u8_t  period;
    u8_t  ttl;
    u16_t feat;
    u16_t net_idx;
};

int bt_mesh_cfg_hb_pub_set(struct bt_mesh_msg_ctx *ctx,
                           const struct bt_mesh_cfg_hb_pub *pub);

int bt_mesh_cfg_hb_pub_get(struct bt_mesh_msg_ctx *ctx);

int bt_mesh_cfg_node_reset(struct bt_mesh_msg_ctx *ctx);

s32_t bt_mesh_cfg_cli_timeout_get(void);
void bt_mesh_cfg_cli_timeout_set(s32_t timeout);

/* Configuration Client Status Message Context */

struct bt_mesh_cfg_comp_data_status {
    u8_t page;
    struct net_buf_simple *comp_data;
};

struct bt_mesh_cfg_relay_status {
    u8_t relay;
    u8_t retransmit;
};

struct bt_mesh_cfg_netkey_status {
    u8_t  status;
    u16_t net_idx;
};

struct bt_mesh_cfg_appkey_status {
    u8_t  status;
    u16_t net_idx;
    u16_t app_idx;
};

struct bt_mesh_cfg_mod_app_status {
    u8_t  status;
    u16_t elem_addr;
    u16_t app_idx;
    u16_t cid;
    u16_t mod_id;
};

struct bt_mesh_cfg_mod_pub_status {
    u8_t  status;
    u16_t elem_addr;
    u16_t addr;
    u16_t app_idx;
    bool  cred_flag;
    u8_t  ttl;
    u8_t  period;
    u8_t  transmit;
    u16_t cid;
    u16_t mod_id;
};

struct bt_mesh_cfg_mod_sub_status {
    u8_t  status;
    u16_t elem_addr;
    u16_t sub_addr;
    u16_t cid;
    u16_t mod_id;
};

struct bt_mesh_cfg_hb_sub_status {
    u8_t  status;
    u16_t src;
    u16_t dst;
    u8_t  period;
    u8_t  count;
    u8_t  min;
    u8_t  max;
};

struct bt_mesh_cfg_hb_pub_status {
    u8_t  status;
    u16_t dst;
    u8_t  count;
    u8_t  period;
    u8_t  ttl;
    u16_t feat;
    u16_t net_idx;
};

struct bt_mesh_cfg_mod_sub_list {
    u8_t  status;
    u16_t elem_addr;
    u16_t cid;
    u16_t mod_id;
    struct net_buf_simple *addr;
};

struct bt_mesh_cfg_net_key_list {
    struct net_buf_simple *net_idx;
};

struct bt_mesh_cfg_app_key_list {
    u8_t  status;
    u16_t net_idx;
    struct net_buf_simple *app_idx;
};

struct bt_mesh_cfg_node_id_status {
    u8_t  status;
    u16_t net_idx;
    u8_t  identity;
};

struct bt_mesh_cfg_mod_app_list {
    u8_t  status;
    u16_t elem_addr;
    u16_t cid;
    u16_t mod_id;
    struct net_buf_simple *app_idx;
};

struct bt_mesh_cfg_key_refresh_status {
    u8_t  status;
    u16_t net_idx;
    u8_t  phase;
};

struct bt_mesh_cfg_lpn_pollto_status {
    u16_t lpn_addr;
    s32_t timeout;
};

int bt_mesh_cfg_mod_pub_va_set(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                               u16_t mod_id, u16_t cid, const u8_t label[16],
                               struct bt_mesh_cfg_mod_pub *pub);

int bt_mesh_cfg_mod_sub_del_all(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                                u16_t mod_id, u16_t cid);

int bt_mesh_cfg_mod_sub_get(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr, u16_t mod_id);

int bt_mesh_cfg_mod_sub_get_vnd(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                                u16_t mod_id, u16_t cid);

int bt_mesh_cfg_net_key_update(struct bt_mesh_msg_ctx *ctx, u16_t net_idx,
                               const u8_t net_key[16]);

int bt_mesh_cfg_net_key_delete(struct bt_mesh_msg_ctx *ctx, u16_t net_idx);

int bt_mesh_cfg_net_key_get(struct bt_mesh_msg_ctx *ctx);

int bt_mesh_cfg_app_key_update(struct bt_mesh_msg_ctx *ctx, u16_t net_idx,
                               u16_t app_idx, const u8_t app_key[16]);

int bt_mesh_cfg_app_key_delete(struct bt_mesh_msg_ctx *ctx, u16_t net_idx, u16_t app_idx);

int bt_mesh_cfg_app_key_get(struct bt_mesh_msg_ctx *ctx, u16_t net_idx);

int bt_mesh_cfg_node_identity_get(struct bt_mesh_msg_ctx *ctx, u16_t net_idx);

int bt_mesh_cfg_node_identity_set(struct bt_mesh_msg_ctx *ctx, u16_t net_idx, u8_t identity);

int bt_mesh_cfg_mod_app_unbind(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                               u16_t app_idx, u16_t mod_id, u16_t cid);

int bt_mesh_cfg_mod_app_get(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr, u16_t mod_id);

int bt_mesh_cfg_mod_app_get_vnd(struct bt_mesh_msg_ctx *ctx, u16_t elem_addr,
                                u16_t mod_id, u16_t cid);

int bt_mesh_cfg_kr_phase_get(struct bt_mesh_msg_ctx *ctx, u16_t net_idx);

int bt_mesh_cfg_kr_phase_set(struct bt_mesh_msg_ctx *ctx, u16_t net_idx, u8_t transition);

int bt_mesh_cfg_lpn_timeout_get(struct bt_mesh_msg_ctx *ctx, u16_t lpn_addr);

int bt_mesh_cfg_net_transmit_get(struct bt_mesh_msg_ctx *ctx);

int bt_mesh_cfg_net_transmit_set(struct bt_mesh_msg_ctx *ctx, u8_t transmit);

/**
 * @}
 */

#endif /* __BLE_MESH_CFG_CLI_H */