Skip to content

Commit 7d46a4a

Browse files
chshuchshu
committed
Merge branch 'example_connect/thread' into 'master'
feat(protocol_examples_common): Add Thread connect to support Thread for the protocol examples See merge request espressif/esp-idf!34892
2 parents ad42627 + 3d06889 commit 7d46a4a

File tree

9 files changed

+354
-10
lines changed

9 files changed

+354
-10
lines changed

‎examples/common_components/protocol_examples_common/CMakeLists.txt‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,18 @@ if(CONFIG_EXAMPLE_CONNECT_ETHERNET)
2222
list(APPEND srcs "eth_connect.c")
2323
endif()
2424

25+
if(CONFIG_EXAMPLE_CONNECT_THREAD)
26+
list(APPEND srcs "thread_connect.c")
27+
endif()
28+
2529
if(CONFIG_EXAMPLE_CONNECT_PPP)
2630
list(APPEND srcs "ppp_connect.c")
2731
endif()
2832

2933

3034
idf_component_register(SRCS "${srcs}"
3135
INCLUDE_DIRS "include"
32-
PRIV_REQUIRES esp_netif esp_driver_gpio esp_driver_uart esp_wifi vfs console esp_eth)
36+
PRIV_REQUIRES esp_netif esp_driver_gpio esp_driver_uart esp_wifi vfs console esp_eth openthread)
3337

3438
if(CONFIG_EXAMPLE_PROVIDE_WIFI_CONSOLE_CMD)
3539
idf_component_optional_requires(PRIVATE console)
@@ -39,6 +43,10 @@ if(CONFIG_EXAMPLE_CONNECT_ETHERNET)
3943
idf_component_optional_requires(PUBLIC esp_eth)
4044
endif()
4145

46+
if(CONFIG_EXAMPLE_CONNECT_THREAD)
47+
idf_component_optional_requires(PRIVATE openthread)
48+
endif()
49+
4250
if(CONFIG_EXAMPLE_CONNECT_PPP)
4351
idf_component_optional_requires(PRIVATE esp_tinyusb espressif__esp_tinyusb)
4452
endif()

‎examples/common_components/protocol_examples_common/Kconfig.projbuild‎

Lines changed: 74 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menu "Example Connection Configuration"
77
depends on !IDF_TARGET_LINUX && (SOC_WIFI_SUPPORTED || ESP_WIFI_REMOTE_ENABLED || ESP_HOST_WIFI_ENABLED)
88
default y if SOC_WIFI_SUPPORTED
99
help
10-
Protocol examples can use Wi-Fi and/or Ethernet to connect to the network.
10+
Protocol examples can use Wi-Fi, Ethernet and/or Thread to connect to the network.
1111
Choose this option to connect with WiFi
1212

1313
if EXAMPLE_CONNECT_WIFI
@@ -119,9 +119,9 @@ menu "Example Connection Configuration"
119119
config EXAMPLE_CONNECT_ETHERNET
120120
bool "connect using Ethernet interface"
121121
depends on !IDF_TARGET_LINUX
122-
default y if !EXAMPLE_CONNECT_WIFI
122+
default y if !EXAMPLE_CONNECT_WIFI && !EXAMPLE_CONNECT_THREAD
123123
help
124-
Protocol examples can use Wi-Fi and/or Ethernet to connect to the network.
124+
Protocol examples can use Wi-Fi, Ethernet and/or Thread to connect to the network.
125125
Choose this option to connect with Ethernet
126126

127127
if EXAMPLE_CONNECT_ETHERNET
@@ -381,13 +381,83 @@ menu "Example Connection Configuration"
381381

382382
endif # EXAMPLE_CONNECT_PPP
383383

384+
config EXAMPLE_CONNECT_THREAD
385+
bool "Connect using Thread interface"
386+
depends on !IDF_TARGET_LINUX && OPENTHREAD_ENABLED
387+
default y if SOC_IEEE802154_SUPPORTED
388+
select EXAMPLE_CONNECT_IPV6
389+
help
390+
Protocol examples can use Wi-Fi, Ethernet and/or Thread to connect to the network.
391+
Choose this option to connect with Thread.
392+
The operational active dataset of the Thread network can be configured in openthread
393+
component at '->Components->OpenThread->Thread Core Features->Thread Operational Dataset'
394+
395+
if EXAMPLE_CONNECT_THREAD
396+
config EXAMPLE_THREAD_TASK_STACK_SIZE
397+
int "Example Thread task stack size"
398+
default 8192
399+
help
400+
Thread task stack size
401+
402+
menu "Radio Spinel Options"
403+
depends on OPENTHREAD_RADIO_SPINEL_UART || OPENTHREAD_RADIO_SPINEL_SPI
404+
405+
config EXAMPLE_THREAD_UART_RX_PIN
406+
depends on OPENTHREAD_RADIO_SPINEL_UART
407+
int "Uart Rx Pin"
408+
default 17
409+
410+
config EXAMPLE_THREAD_UART_TX_PIN
411+
depends on OPENTHREAD_RADIO_SPINEL_UART
412+
int "Uart Tx pin"
413+
default 18
414+
415+
config EXAMPLE_THREAD_UART_BAUD
416+
depends on OPENTHREAD_RADIO_SPINEL_UART
417+
int "Uart baud rate"
418+
default 460800
419+
420+
config EXAMPLE_THREAD_UART_PORT
421+
depends on OPENTHREAD_RADIO_SPINEL_UART
422+
int "Uart port"
423+
default 1
424+
425+
config EXAMPLE_THREAD_SPI_CS_PIN
426+
depends on OPENTHREAD_RADIO_SPINEL_SPI
427+
int "SPI CS Pin"
428+
default 10
429+
430+
config EXAMPLE_THREAD_SPI_SCLK_PIN
431+
depends on OPENTHREAD_RADIO_SPINEL_SPI
432+
int "SPI SCLK Pin"
433+
default 12
434+
435+
config EXAMPLE_THREAD_SPI_MISO_PIN
436+
depends on OPENTHREAD_RADIO_SPINEL_SPI
437+
int "SPI MISO Pin"
438+
default 13
439+
440+
config EXAMPLE_THREAD_SPI_MOSI_PIN
441+
depends on OPENTHREAD_RADIO_SPINEL_SPI
442+
int "SPI MOSI Pin"
443+
default 11
444+
445+
config EXAMPLE_THREAD_SPI_INTR_PIN
446+
depends on OPENTHREAD_RADIO_SPINEL_SPI
447+
int "SPI Interrupt Pin"
448+
default 8
449+
endmenu
450+
451+
endif
452+
384453
config EXAMPLE_CONNECT_IPV4
385454
bool
386455
depends on LWIP_IPV4
456+
default n if EXAMPLE_CONNECT_THREAD
387457
default y
388458

389459
config EXAMPLE_CONNECT_IPV6
390-
depends on EXAMPLE_CONNECT_WIFI || EXAMPLE_CONNECT_ETHERNET || EXAMPLE_CONNECT_PPP
460+
depends on EXAMPLE_CONNECT_WIFI || EXAMPLE_CONNECT_ETHERNET || EXAMPLE_CONNECT_PPP || EXAMPLE_CONNECT_THREAD
391461
bool "Obtain IPv6 address"
392462
default y
393463
select LWIP_IPV6

‎examples/common_components/protocol_examples_common/README.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This component implements the most common connection methods for ESP32 boards. I
44

55
## How to use this component
66

7-
Choose the preferred interface (WiFi, Ethernet, PPPoS) to connect to the network and configure the interface.
7+
Choose the preferred interface (WiFi, Ethernet, Thread, PPPoS) to connect to the network and configure the interface.
88

99
It is possible to enable multiple interfaces simultaneously making the connection phase to block until all the chosen interfaces acquire IP addresses.
1010
It is also possible to disable all interfaces, skipping the connection phase altogether.
@@ -23,6 +23,14 @@ Choose WiFi connection method (for chipsets that support it) and configure basic
2323

2424
Choose Ethernet connection if your board supports it. The most common settings is using Espressif Ethernet Kit, which is also the recommended HW for this selection. You can also select an SPI ethernet device (if your chipset doesn't support internal EMAC or if you prefer). It is also possible to use OpenCores Ethernet MAC if you're running the example under QEMU.
2525

26+
### Thread
27+
28+
Choose Thread connection if your board supports IEEE802.15.4 native radio or works with [OpenThread RCP](../../openthread/ot_rcp/README.md). You can configure the Thread network at menuconfig '->Components->OpenThread->Thread Core Features->Thread Operational Dataset'.
29+
30+
If the Thread end-device joins a Thread network with a Thread Border Router that has the NAT64 feature enabled, the end-device can access the Internet with the standard DNS APIs after configuring the following properties:
31+
* Enable DNS64 client ('->Components->OpenThread->Thread Core Features->Enable DNS64 client')
32+
* Enable custom DNS external resolve Hook ('->Components->LWIP->Hooks->DNS external resolve Hook->Custom implementation')
33+
2634
### PPP
2735

2836
Point to point connection method creates a simple IP tunnel to the counterpart device (running PPP server), typically a Linux machine with pppd service. We currently support only PPP over Serial (using UART or USB CDC). This is useful for simple testing of networking layers, but with some additional configuration on the server side, we could simulate standard model of internet connectivity. The PPP server could be also represented by a cellular modem device with pre-configured connectivity and already switched to PPP mode (this setup is not very flexible though, so we suggest using a standard modem library implementing commands and modes, e.g. [esp_modem](https://components.espressif.com/component/espressif/esp_modem) ).

‎examples/common_components/protocol_examples_common/connect.c‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
2+
* SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
33
*
44
* SPDX-License-Identifier: Unlicense OR CC0-1.0
55
*/
@@ -35,7 +35,7 @@ const char *example_ipv6_addr_types_to_str[6] = {
3535

3636
/**
3737
* @brief Checks the netif description if it contains specified prefix.
38-
* All netifs created withing common connect component are prefixed with the module TAG,
38+
* All netifs created within common connect component are prefixed with the module TAG,
3939
* so it returns true if the specified netif is owned by this module
4040
*/
4141
bool example_is_our_netif(const char *prefix, esp_netif_t *netif)
@@ -61,7 +61,7 @@ static esp_err_t print_all_ips_tcpip(void* ctx)
6161
while ((netif = esp_netif_next_unsafe(netif)) != NULL) {
6262
if (example_is_our_netif(prefix, netif)) {
6363
ESP_LOGI(TAG, "Connected to %s", esp_netif_get_desc(netif));
64-
#if CONFIG_LWIP_IPV4
64+
#if CONFIG_EXAMPLE_CONNECT_IPV4
6565
esp_netif_ip_info_t ip;
6666
ESP_ERROR_CHECK(esp_netif_get_ip_info(netif, &ip));
6767

@@ -101,6 +101,12 @@ esp_err_t example_connect(void)
101101
}
102102
ESP_ERROR_CHECK(esp_register_shutdown_handler(&example_wifi_shutdown));
103103
#endif
104+
#if CONFIG_EXAMPLE_CONNECT_THREAD
105+
if (example_thread_connect() != ESP_OK) {
106+
return ESP_FAIL;
107+
}
108+
ESP_ERROR_CHECK(esp_register_shutdown_handler(&example_thread_shutdown));
109+
#endif
104110
#if CONFIG_EXAMPLE_CONNECT_PPP
105111
if (example_ppp_connect() != ESP_OK) {
106112
return ESP_FAIL;
@@ -116,6 +122,10 @@ esp_err_t example_connect(void)
116122
example_print_all_netif_ips(EXAMPLE_NETIF_DESC_STA);
117123
#endif
118124

125+
#if CONFIG_EXAMPLE_CONNECT_THREAD
126+
example_print_all_netif_ips(EXAMPLE_NETIF_DESC_THREAD);
127+
#endif
128+
119129
#if CONFIG_EXAMPLE_CONNECT_PPP
120130
example_print_all_netif_ips(EXAMPLE_NETIF_DESC_PPP);
121131
#endif

‎examples/common_components/protocol_examples_common/include/example_common_private.h‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*
44
* SPDX-License-Identifier: Unlicense OR CC0-1.0
55
*/
6-
/* Private Funtions of protocol example common */
6+
/* Private Functions of protocol example common */
77

88
#pragma once
99

@@ -45,6 +45,8 @@ void example_wifi_shutdown(void);
4545
esp_err_t example_wifi_connect(void);
4646
void example_ethernet_shutdown(void);
4747
esp_err_t example_ethernet_connect(void);
48+
void example_thread_shutdown(void);
49+
esp_err_t example_thread_connect(void);
4850
esp_err_t example_ppp_connect(void);
4951
void example_ppp_start(void);
5052
void example_ppp_shutdown(void);

‎examples/common_components/protocol_examples_common/include/protocol_examples_common.h‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ extern "C" {
3131
#define EXAMPLE_NETIF_DESC_ETH "example_netif_eth"
3232
#endif
3333

34+
#if CONFIG_EXAMPLE_CONNECT_THREAD
35+
#define EXAMPLE_NETIF_DESC_THREAD "example_netif_thread"
36+
#endif
37+
3438
#if CONFIG_EXAMPLE_CONNECT_PPP
3539
#define EXAMPLE_NETIF_DESC_PPP "example_netif_ppp"
3640
#endif
@@ -74,6 +78,9 @@ extern "C" {
7478
#elif CONFIG_EXAMPLE_CONNECT_WIFI
7579
#define EXAMPLE_INTERFACE get_example_netif_from_desc(EXAMPLE_NETIF_DESC_STA)
7680
#define get_example_netif() get_example_netif_from_desc(EXAMPLE_NETIF_DESC_STA)
81+
#elif CONFIG_EXAMPLE_CONNECT_THREAD
82+
#define EXAMPLE_INTERFACE get_example_netif_from_desc(EXAMPLE_NETIF_DESC_THREAD)
83+
#define get_example_netif() get_example_netif_from_desc(EXAMPLE_NETIF_DESC_THREAD)
7784
#elif CONFIG_EXAMPLE_CONNECT_PPP
7885
#define EXAMPLE_INTERFACE get_example_netif_from_desc(EXAMPLE_NETIF_DESC_PPP)
7986
#define get_example_netif() get_example_netif_from_desc(EXAMPLE_NETIF_DESC_PPP)

‎examples/common_components/protocol_examples_common/include/protocol_examples_thread_config.h‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
/*
2+
* Thread configurations for protocol examples
3+
*
4+
* SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
5+
*
6+
* SPDX-License-Identifier: Unlicense OR CC0-1.0
7+
*/
8+
#pragma once
9+
10+
#include <sdkconfig.h>
11+
12+
#include <esp_openthread_types.h>
13+
14+
#ifdef CONFIG_OPENTHREAD_RADIO_NATIVE
15+
#define ESP_OPENTHREAD_DEFAULT_RADIO_CONFIG() \
16+
{ \
17+
.radio_mode = RADIO_MODE_NATIVE, \
18+
}
19+
20+
#elif defined(CONFIG_OPENTHREAD_RADIO_SPINEL_UART)
21+
#define ESP_OPENTHREAD_DEFAULT_RADIO_CONFIG() \
22+
{ \
23+
.radio_mode = RADIO_MODE_UART_RCP, \
24+
.radio_uart_config = \
25+
{ \
26+
.port = CONFIG_EXAMPLE_THREAD_UART_PORT, \
27+
.uart_config = \
28+
{ \
29+
.baud_rate = CONFIG_EXAMPLE_THREAD_UART_BAUD, \
30+
.data_bits = UART_DATA_8_BITS, \
31+
.parity = UART_PARITY_DISABLE, \
32+
.stop_bits = UART_STOP_BITS_1, \
33+
.flow_ctrl = UART_HW_FLOWCTRL_DISABLE, \
34+
.rx_flow_ctrl_thresh = 0, \
35+
.source_clk = UART_SCLK_DEFAULT, \
36+
}, \
37+
.rx_pin = CONFIG_EXAMPLE_THREAD_UART_RX_PIN, \
38+
.tx_pin = CONFIG_EXAMPLE_THREAD_UART_TX_PIN, \
39+
}, \
40+
}
41+
#elif defined(CONFIG_OPENTHREAD_RADIO_SPINEL_SPI)
42+
#define ESP_OPENTHREAD_DEFAULT_RADIO_CONFIG() \
43+
{ \
44+
.radio_mode = RADIO_MODE_SPI_RCP, \
45+
.radio_spi_config = \
46+
{ \
47+
.host_device = SPI2_HOST, \
48+
.dma_channel = 2, \
49+
.spi_interface = \
50+
{ \
51+
.mosi_io_num = CONFIG_EXAMPLE_THREAD_SPI_MOSI_PIN, \
52+
.miso_io_num = CONFIG_EXAMPLE_THREAD_SPI_MISO_PIN, \
53+
.sclk_io_num = CONFIG_EXAMPLE_THREAD_SPI_SCLK_PIN, \
54+
.quadwp_io_num = -1, \
55+
.quadhd_io_num = -1, \
56+
}, \
57+
.spi_device = \
58+
{ \
59+
.cs_ena_pretrans = 2, \
60+
.input_delay_ns = 100, \
61+
.mode = 0, \
62+
.clock_speed_hz = 2500 * 1000, \
63+
.spics_io_num = CONFIG_EXAMPLE_THREAD_SPI_CS_PIN, \
64+
.queue_size = 5, \
65+
}, \
66+
.intr_pin = CONFIG_EXAMPLE_THREAD_SPI_INTR_PIN, \
67+
}, \
68+
}
69+
#endif
70+
71+
#if CONFIG_OPENTHREAD_CONSOLE_TYPE_UART
72+
#define ESP_OPENTHREAD_DEFAULT_HOST_CONFIG() \
73+
{ \
74+
.host_connection_mode = HOST_CONNECTION_MODE_CLI_UART, \
75+
.host_uart_config = \
76+
{ \
77+
.port = 0, \
78+
.uart_config = \
79+
{ \
80+
.baud_rate = 115200, \
81+
.data_bits = UART_DATA_8_BITS, \
82+
.parity = UART_PARITY_DISABLE, \
83+
.stop_bits = UART_STOP_BITS_1, \
84+
.flow_ctrl = UART_HW_FLOWCTRL_DISABLE, \
85+
.rx_flow_ctrl_thresh = 0, \
86+
.source_clk = UART_SCLK_DEFAULT, \
87+
}, \
88+
.rx_pin = UART_PIN_NO_CHANGE, \
89+
.tx_pin = UART_PIN_NO_CHANGE, \
90+
}, \
91+
}
92+
#elif CONFIG_OPENTHREAD_CONSOLE_TYPE_USB_SERIAL_JTAG
93+
#define ESP_OPENTHREAD_DEFAULT_HOST_CONFIG() \
94+
{ \
95+
.host_connection_mode = HOST_CONNECTION_MODE_CLI_USB, \
96+
.host_usb_config = USB_SERIAL_JTAG_DRIVER_CONFIG_DEFAULT(), \
97+
}
98+
#endif
99+
100+
#define ESP_OPENTHREAD_DEFAULT_PORT_CONFIG() \
101+
{ \
102+
.storage_partition_name = "nvs", \
103+
.netif_queue_size = 10, \
104+
.task_queue_size = 10, \
105+
}

0 commit comments

Comments
 (0)