xref: /btstack/src/mesh/mesh_configuration_client.h (revision f2ca42dfa8727a13ba9db535d0f82645147781ed)

/*
 * Copyright (C) 2019 BlueKitchen GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 * 4. Any redistribution, use, or modification is done solely for
 *    personal benefit and not for any commercial purpose or for
 *    monetary gain.
 *
 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * Please inquire about commercial licensing options at
 * [email protected]
 *
 */

#ifndef __MESH_CONFIGURATION_CLIENT_H
#define __MESH_CONFIGURATION_CLIENT_H

#include <stdint.h>

#include "mesh/mesh_access.h"

#ifdef __cplusplus
extern "C"
{
#endif


typedef struct {
    const uint8_t * models;
    uint16_t size;
    uint16_t offset;

    uint32_t id;
} mesh_model_id_iterator_t;

typedef struct {
    const uint8_t * elements;
    uint16_t size;
    uint16_t offset;

    uint16_t loc;

    mesh_model_id_iterator_t sig_model_iterator;
    mesh_model_id_iterator_t vendor_model_iterator;
} mesh_composite_data_iterator_t;

typedef struct {
    uint16_t publish_address_unicast;
    uint8_t  publish_address_virtual[16];
    uint16_t appkey_index;
    uint8_t  credential_flag;
    uint8_t  publish_ttl;
    uint8_t  publish_period;
    uint8_t  publish_retransmit_count;
    uint8_t  publish_retransmit_interval_steps;
} mesh_publication_model_config_t;

/**
 * @brief Initialize iterator for element descriptions list from Composition data in MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA event
 * @param iterator
 * @param elements
 * @param size
 */
void mesh_composition_data_iterator_init(mesh_composite_data_iterator_t * iterator, const uint8_t * elements, uint16_t size);

/**
 * @brief Check if there is another element description in the list
 * @param iterator
 * @return has_next_element
 */
bool mesh_composition_data_iterator_has_next_element(mesh_composite_data_iterator_t * iterator);

/**
 * @brief Select the next element
 * @param iterator
 */
void mesh_composition_data_iterator_next_element(mesh_composite_data_iterator_t * iterator);

/**
 * @brief Get the element location descriptor for the current element
 * @param iterator
 * @return loc
 */
uint16_t mesh_composition_data_iterator_element_loc(mesh_composite_data_iterator_t * iterator);

/**
 * @brief Check if there is another SIG model in current element
 * @param iterator
 * @return has_next_sig_model
 */
bool mesh_composition_data_iterator_has_next_sig_model(mesh_composite_data_iterator_t * iterator);

/**
 * @brief Select the next SIG model
 * @param iterator
 */
void mesh_composition_data_iterator_next_sig_model(mesh_composite_data_iterator_t * iterator);

/**
 * @brief Get the SIG model ID for the current SIG model of the current element
 * @param iterator
 * @return loc
 */
uint16_t mesh_composition_data_iterator_sig_model_id(mesh_composite_data_iterator_t * iterator);


/**
 * @brief Check if there is another vendor model in current element
 * @param iterator
 * @return has_next_vendor_model
 */
bool mesh_composition_data_iterator_has_next_vendor_model(mesh_composite_data_iterator_t * iterator);

/**
 * @brief Select the next VVendor model
 * @param iterator
 */
void mesh_composition_data_iterator_next_vendor_model(mesh_composite_data_iterator_t * iterator);

/**
 * @brief Get the Vendor model ID for the current vendor model of the current element
 * @param iterator
 * @return loc
 */
uint32_t mesh_composition_data_iterator_vendor_model_id(mesh_composite_data_iterator_t * iterator);

/**
 * @brief Get field page from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
 * @param event packet
 * @return page
 * @note: btstack_type 1
 */
uint8_t mesh_subevent_configuration_composition_data_get_page(const uint8_t * event);

/**
 * @brief Get field cid from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
 * @param event packet
 * @return cid
 * @note: btstack_type 2
 */
uint16_t mesh_subevent_configuration_composition_data_get_cid(const uint8_t * event);

/**
 * @brief Get field pid from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
 * @param event packet
 * @return pid
 * @note: btstack_type 2
 */
uint16_t mesh_subevent_configuration_composition_data_get_pid(const uint8_t * event);

/**
 * @brief Get field vid from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
 * @param event packet
 * @return vid
 * @note: btstack_type 2
 */
uint16_t mesh_subevent_configuration_composition_data_get_vid(const uint8_t * event);

/**
 * @brief Get field crpl from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
 * @param event packet
 * @return crpl
 * @note: btstack_type 2
 */
uint16_t mesh_subevent_configuration_composition_data_get_crpl(const uint8_t * event);

/**
 * @brief Get field features from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
 * @param event packet
 * @return features
 * @note: btstack_type 2
 */
uint16_t mesh_subevent_configuration_composition_data_get_features(const uint8_t * event);

/**
 * @brief Get number elements from event MESH_SUBEVENT_CONFIGURATION_COMPOSITION_DATA
 **/
uint16_t mesh_subevent_configuration_composition_data_get_num_elements(const uint8_t * event, uint16_t size);


/**
 * @brief Register packet handler
 * @param configuration_client_model
 * @param events_packet_handler
 */
void mesh_configuration_client_register_packet_handler(mesh_model_t *configuration_client_model, btstack_packet_handler_t events_packet_handler);

/**
 * @brief Get the current Secure Network Beacon state of a node.
 * @param mesh_model
 * @param dest
 * @param netkey_index
 * @param appkey_index
 * @return status       ERROR_CODE_SUCCESS if successful, otherwise BTSTACK_MEMORY_ALLOC_FAILED or ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE
 */
uint8_t mesh_configuration_client_send_beacon_get(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index);

/**
 * @brief Get the current Secure Network Beacon state of a node.
 * @param mesh_model
 * @param dest
 * @param netkey_index
 * @param appkey_index
 * @param Beacon        0x01 The node is broadcasting a Secure Network beacon, 0x00 broadcastinis  off
 * @return status       ERROR_CODE_SUCCESS if successful, otherwise BTSTACK_MEMORY_ALLOC_FAILED or ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE
 */
uint8_t mesh_configuration_client_send_beacon_set(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, uint8_t beacon);

/**
 * @brief Read one page of the Composition Data.
 * @param mesh_model
 * @param dest
 * @param netkey_index
 * @param appkey_index
 * @param page          Page number of the Composition Data
 * @return status       ERROR_CODE_SUCCESS if successful, otherwise BTSTACK_MEMORY_ALLOC_FAILED or ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE
 */
uint8_t mesh_configuration_client_send_composition_data_get(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, uint8_t page);

/**
 * @brief Get the current Default TTL state of a node
 * @param mesh_model
 * @param dest
 * @param netkey_index
 * @param appkey_index
 * @return status       ERROR_CODE_SUCCESS if successful, otherwise BTSTACK_MEMORY_ALLOC_FAILED or ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE
 */
uint8_t mesh_configuration_client_send_default_ttl_get(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index);

/**
 * @brief Set Default TTL state of a node
 * @param mesh_model
 * @param dest
 * @param netkey_index
 * @param appkey_index
 * @param ttl           allowed values: 0x00, 0x02–0x7F
 * @return status       ERROR_CODE_SUCCESS if successful, otherwise BTSTACK_MEMORY_ALLOC_FAILED or ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE
 */
uint8_t mesh_configuration_client_send_default_ttl_set(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, uint8_t ttl);

/**
 * @brief Get the current Default GATT proxy state of a node
 * @param mesh_model
 * @param dest
 * @param netkey_index
 * @param appkey_index
 * @return status       ERROR_CODE_SUCCESS if successful, otherwise BTSTACK_MEMORY_ALLOC_FAILED or ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE
 */
uint8_t mesh_configuration_client_send_default_gatt_proxy_state_get(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index);

/**
 * @brief Set Default GATT proxy state of a node
 * @param mesh_model
 * @param dest
 * @param netkey_index
 * @param appkey_index
 * @param gatt_proxy_state        0 - the proxy feature is supported and disabled, 1 - supported and enabled, 2 - not supported
 * @return status       ERROR_CODE_SUCCESS if successful, otherwise BTSTACK_MEMORY_ALLOC_FAILED or ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE
 */
uint8_t mesh_configuration_client_send_default_gatt_proxy_state_set(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, uint8_t gatt_proxy_state);

/**
 * @brief Get the publish address and parameters of an outgoing message that originates from a model
 * @param mesh_model
 * @param dest         element_address
 * @param netkey_index
 * @param appkey_index
 * @param model_id
 * @return status       ERROR_CODE_SUCCESS if successful, otherwise BTSTACK_MEMORY_ALLOC_FAILED or ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE
 */
uint8_t mesh_configuration_client_send_model_publication_get(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, uint32_t model_id);

/**
 * @brief Set the Model Publication state of an outgoing message that originates from a model.
 * @param mesh_model
 * @param dest         element_address
 * @param netkey_index
 * @param appkey_index
 * @param model_id
 * @param publication_config
 * @return status       ERROR_CODE_SUCCESS if successful, otherwise BTSTACK_MEMORY_ALLOC_FAILED or ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE
 */
uint8_t mesh_configuration_client_send_model_publication_set(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, uint32_t model_id, mesh_publication_model_config_t * publication_config);

/**
 * @brief Set the Model Publication state of an outgoing message that originates from a model.
 * @param mesh_model
 * @param dest         element_address
 * @param netkey_index
 * @param appkey_index
 * @param model_id
 * @param publication_config
 * @return status       ERROR_CODE_SUCCESS if successful, otherwise BTSTACK_MEMORY_ALLOC_FAILED or ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE
 */
uint8_t mesh_configuration_client_send_model_publication_virtual_address_set(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, uint32_t model_id, mesh_publication_model_config_t * publication_config);

#ifdef __cplusplus
} /* end of extern "C" */
#endif

#endif