ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include "esp_netif.h"
#include "esp_netif_types.h"
#include "esp_openthread.h"
#include "esp_openthread_spinel.h"
#include "openthread/instance.h"
esp_openthread_set_backbone_netif(esp_netif_t *);
esp_openthread_border_router_init();
esp_openthread_border_router_deinit();
esp_openthread_get_backbone_netif();
esp_openthread_set_meshcop_instance_name(const char *);
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/openthread/include/esp_openthread_border_router.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2021-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #pragma once #include "esp_netif.h" #include "esp_netif_types.h" #include "esp_openthread.h" #include "esp_openthread_spinel.h" #include "openthread/instance.h"5 includes #ifdef __cplusplus extern "C" { #endif /** * @brief Sets the backbone interface used for border routing. * * @note This function must be called before esp_openthread_init * * @param[in] backbone_netif The backbone network interface (WiFi or ethernet) * *//* ... */ void esp_openthread_set_backbone_netif(esp_netif_t *backbone_netif); /** * @brief Initializes the border router features of OpenThread. * * @note Calling this function will make the device behave as an OpenThread * border router. Kconfig option CONFIG_OPENTHREAD_BORDER_ROUTER is required. * * @return * - ESP_OK on success * - ESP_ERR_NOT_SUPPORTED if feature not supported * - ESP_ERR_INVALID_STATE if already initialized * - ESP_FIAL on other failures * *//* ... */ esp_err_t esp_openthread_border_router_init(void); /** * @brief Deinitializes the border router features of OpenThread. * * @return * - ESP_OK on success * - ESP_ERR_INVALID_STATE if not initialized * - ESP_FIAL on other failures * *//* ... */ esp_err_t esp_openthread_border_router_deinit(void); /** * @brief Gets the backbone interface of OpenThread border router. * * @return * The backbone interface or NULL if border router not initialized. * *//* ... */ esp_netif_t *esp_openthread_get_backbone_netif(void); /** * @brief Sets the meshcop(e) instance name. * * @note This function can only be called before `esp_openthread_border_router_init`. * If `instance_name` is NULL, then the service will use the hostname as instance name. * * @param[in] instance_name The instance name, can be `NULL`. * * @return * - ESP_OK on success * - ESP_FAIL if fail to initialize RCP * *//* ... */ esp_err_t esp_openthread_set_meshcop_instance_name(const char *instance_name); #ifdef __cplusplus }{...} #endif
Details
Show:
from
Types: Columns: