b19671e0d4
1. BLE Mesh Core
* Provisioning: Node Role
* PB-ADV and PB-GATT
* Authentication OOB
* Provisioning: Provisioner Role
* PB-ADV and PB-GATT
* Authentication OOB
* Networking
* Relay
* Segmentation and Reassembly
* Key Refresh
* IV Update
* Proxy Support
* Multiple Client Models Run Simultaneously
* Support multiple client models send packets to different nodes simultaneously
* No blocking between client model and server
* NVS Storage
* Store BLE Mesh node related information in flash
* Store BLE Mesh Provisioner related information in flash
2. BLE Mesh Models
* Foundation Models
* Configuration Server Model
* Configuration Client Model
* Health Server Model
* Health Client Model
* Generic
* Generic OnOff Server
* Generic OnOff Client
* Generic Level Server
* Generic Level Client
* Generic Default Transition Time Server
* Generic Default Transition Time Client
* Generic Power OnOff Server
* Generic Power OnOff Setup Server
* Generic Power OnOff Client
* Generic Power Level Server
* Generic Power Level Setup Server
* Generic Power Level Client
* Generic Battery Server
* Generic Battery Client
* Generic Location Server
* Generic Location Setup Server
* Generic Location Client
* Generic Admin Property Server
* Generic Manufacturer Property Server
* Generic User Property Server
* Generic Client Property Server
* Generic Property Client
* Sensor Server Model
* Sensor Server
* Sensor Setup Server
* Sensor Client
* Time and Scenes
* Time Server
* Time Setup Server
* Time Client
* Scene Server
* Scene Setup Server
* Scene Client
* Scheduler Server
* Scheduler Setup Server
* Scheduler Client
* Lighting
* Light Lightness Server
* Light Lightness Setup Server
* Light Lightness Client
* Light CTL Server
* Light CTL Setup Server
* Light CTL Client
* Light CTL Temperature Server
* Light HSL Server
* Light HSL Setup Server
* Light HSL Client
* Light HSL Hue Server
* Light HSL Saturation Server
* Light xyL Server
* Light xyL Setup Server
* Light xyL Client
* Light LC Server
* Light LC Setup Server
* Light LC Client
3. BLE Mesh Applications
* BLE Mesh Node
* OnOff Client Example
* OnOff Server Example
* BLE Mesh Provisioner
* Example
* Fast Provisioning
* Vendor Fast Prov Server Model
* Vendor Fast Prov Client Model
* Examples
* Wi-Fi & BLE Mesh Coexistence
* Example
* BLE Mesh Console Commands
* Examples
108 lines
4 KiB
C
108 lines
4 KiB
C
// Copyright 2017-2019 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef _ESP_BLE_MESH_LOCAL_DATA_OPERATION_API_H_
|
|
#define _ESP_BLE_MESH_LOCAL_DATA_OPERATION_API_H_
|
|
|
|
#include "esp_ble_mesh_defs.h"
|
|
|
|
/**
|
|
* @brief Get the model publish period, the unit is ms.
|
|
*
|
|
* @param[in] model: Model instance pointer.
|
|
*
|
|
* @return Publish period value on success, 0 or (negative) error code from errno.h on failure.
|
|
*
|
|
*/
|
|
int32_t esp_ble_mesh_get_model_publish_period(esp_ble_mesh_model_t *model);
|
|
|
|
/**
|
|
* @brief Get the address of the primary element.
|
|
*
|
|
* @return Address of the primary element on success, or
|
|
* ESP_BLE_MESH_ADDR_UNASSIGNED on failure which means the device has not been provisioned.
|
|
*
|
|
*/
|
|
uint16_t esp_ble_mesh_get_primary_element_address(void);
|
|
|
|
/**
|
|
* @brief Check if the model has subscribed to the given group address.
|
|
* Note: E.g., once a status message is received and the destination address
|
|
* is a group address, the model uses this API to check if it is successfully subscribed
|
|
* to the given group address.
|
|
*
|
|
* @param[in] model: Pointer to the model.
|
|
* @param[in] group_addr: Group address.
|
|
*
|
|
* @return Pointer to the group address within the Subscription List of the model on success, or
|
|
* NULL on failure which means the model has not subscribed to the given group address.
|
|
* Note: With the pointer to the group address returned, you can reset the group address
|
|
* to 0x0000 in order to unsubscribe the model from the group.
|
|
*
|
|
*/
|
|
uint16_t *esp_ble_mesh_is_model_subscribed_to_group(esp_ble_mesh_model_t *model, uint16_t group_addr);
|
|
|
|
/**
|
|
* @brief Find the BLE Mesh element pointer via the element address.
|
|
*
|
|
* @param[in] element_addr: Element address.
|
|
*
|
|
* @return Pointer to the element on success, or NULL on failure.
|
|
*
|
|
*/
|
|
esp_ble_mesh_elem_t *esp_ble_mesh_find_element(uint16_t element_addr);
|
|
|
|
/**
|
|
* @brief Get the number of elements that have been registered.
|
|
*
|
|
* @return Number of elements.
|
|
*
|
|
*/
|
|
uint8_t esp_ble_mesh_get_element_count(void);
|
|
|
|
/**
|
|
* @brief Find the Vendor specific model with the given element,
|
|
* the company ID and the Vendor Model ID.
|
|
*
|
|
* @param[in] element: Element to which the model belongs.
|
|
* @param[in] company_id: A 16-bit company identifier assigned by the Bluetooth SIG.
|
|
* @param[in] model_id: A 16-bit vendor-assigned model identifier.
|
|
*
|
|
* @return Pointer to the Vendor Model on success, or NULL on failure which means the Vendor Model is not found.
|
|
*
|
|
*/
|
|
esp_ble_mesh_model_t *esp_ble_mesh_find_vendor_model(const esp_ble_mesh_elem_t *element,
|
|
uint16_t company_id, uint16_t model_id);
|
|
|
|
/**
|
|
* @brief Find the SIG model with the given element and Model id.
|
|
*
|
|
* @param[in] element: Element to which the model belongs.
|
|
* @param[in] model_id: SIG model identifier.
|
|
*
|
|
* @return Pointer to the SIG Model on success, or NULL on failure which means the SIG Model is not found.
|
|
*
|
|
*/
|
|
esp_ble_mesh_model_t *esp_ble_mesh_find_sig_model(const esp_ble_mesh_elem_t *element, uint16_t model_id);
|
|
|
|
/**
|
|
* @brief Get the Composition data which has been registered.
|
|
*
|
|
* @return Pointer to the Composition data on success, or NULL on failure which means the Composition data is not initialized.
|
|
*
|
|
*/
|
|
const esp_ble_mesh_comp_t *esp_ble_mesh_get_composition_data(void);
|
|
|
|
#endif /* _ESP_BLE_MESH_LOCAL_DATA_OPERATION_API_H_ */
|