Skip to content

Commit 6432172

Browse files
BroderickCarlinBroderickCarlin
authored
Merge pull request project-chip#534 from sagar-apple/upgrade_echo_server
Make the ESP32 Echo Server use Inet
2 parents 2ec6d8a + e5d59e0 commit 6432172

File tree

4 files changed

+209
-109
lines changed

4 files changed

+209
-109
lines changed

‎examples/wifi-echo/esp32/main/EchoClient.cpp

+115
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
/*
2+
*
3+
* Copyright (c) 2020 Project CHIP Authors
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, softwarEchoe
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
#include <string.h>
19+
#include <sys/param.h>
20+
#include "freertos/FreeRTOS.h"
21+
#include "freertos/task.h"
22+
#include "esp_system.h"
23+
#include "esp_wifi.h"
24+
#include "esp_event.h"
25+
#include "esp_log.h"
26+
#include "nvs_flash.h"
27+
#include "tcpip_adapter.h"
28+
29+
#include "lwip/err.h"
30+
#include "lwip/sockets.h"
31+
#include "lwip/sys.h"
32+
#include <lwip/netdb.h>
33+
34+
#define PORT CONFIG_ECHO_PORT
35+
#define RX_LEN 128
36+
#define ADDR_LEN 128
37+
38+
#define HOST_IP_ADDR CONFIG_ECHO_HOST_IP
39+
40+
static const char * TAG = "echo_client";
41+
static const char * PAYLOAD = "Message from echo client!";
42+
43+
static void udp_client_task(void * pvParameters)
44+
{
45+
char rx_buffer[RX_LEN];
46+
char host_ip[] = HOST_IP_ADDR;
47+
int addr_family = 0;
48+
int ip_protocol = 0;
49+
50+
while (1)
51+
{
52+
struct sockaddr_in dest_addr;
53+
dest_addr.sin_addr.s_addr = inet_addr(HOST_IP_ADDR);
54+
dest_addr.sin_family = AF_INET;
55+
dest_addr.sin_port = htons(PORT);
56+
addr_family = AF_INET;
57+
ip_protocol = IPPROTO_IP;
58+
59+
int sock = socket(addr_family, SOCK_DGRAM, ip_protocol);
60+
if (sock < 0)
61+
{
62+
ESP_LOGE(TAG, "Unable to create socket: errno %d", errno);
63+
break;
64+
}
65+
ESP_LOGI(TAG, "Socket created, sending to %s:%d", HOST_IP_ADDR, PORT);
66+
67+
while (1)
68+
{
69+
int err = sendto(sock, PAYLOAD, strlen(PAYLOAD), 0, (struct sockaddr *) &dest_addr, sizeof(dest_addr));
70+
if (err < 0)
71+
{
72+
ESP_LOGE(TAG, "Error occurred during sending: errno %d", errno);
73+
break;
74+
}
75+
ESP_LOGI(TAG, "Message sent");
76+
77+
struct sockaddr_in source_addr; // Large enough for both IPv4 or IPv6
78+
socklen_t socklen = sizeof(source_addr);
79+
int len = recvfrom(sock, rx_buffer, sizeof(rx_buffer) - 1, 0, (struct sockaddr *) &source_addr, &socklen);
80+
81+
// Error occurred during receiving
82+
if (len < 0)
83+
{
84+
ESP_LOGE(TAG, "recvfrom failed: errno %d", errno);
85+
continue;
86+
}
87+
// Data received
88+
else
89+
{
90+
rx_buffer[len] = 0; // Null-terminate whatever we received and treat like a string
91+
ESP_LOGI(TAG, "Received %d bytes from %s:", len, host_ip);
92+
if (strncmp(rx_buffer, PAYLOAD, strlen(PAYLOAD)) == 0)
93+
{
94+
ESP_LOGI(TAG, "Received expected message...");
95+
}
96+
}
97+
98+
vTaskDelay(5000 / portTICK_PERIOD_MS);
99+
}
100+
101+
if (sock != -1)
102+
{
103+
ESP_LOGE(TAG, "Shutting down socket and restarting...");
104+
shutdown(sock, 0);
105+
close(sock);
106+
}
107+
}
108+
vTaskDelete(NULL);
109+
}
110+
111+
// The echo client assumes the platform's networking has been setup already
112+
void startClient(void)
113+
{
114+
xTaskCreate(udp_client_task, "udp_client", 4096, (void *) AF_INET, 5, NULL);
115+
}

‎examples/wifi-echo/esp32/main/EchoServer.cpp

+75-99
Original file line numberDiff line numberDiff line change
@@ -31,125 +31,101 @@
3131
#include "lwip/sys.h"
3232
#include <lwip/netdb.h>
3333

34+
#include <inet/UDPEndPoint.h>
35+
#include <inet/InetError.h>
36+
#include <inet/InetLayer.h>
37+
#include <inet/IPAddress.h>
38+
#include <system/SystemPacketBuffer.h>
39+
#include <support/ErrorStr.h>
40+
#include <platform/CHIPDeviceLayer.h>
41+
3442
#define PORT CONFIG_ECHO_PORT
35-
#define RX_LEN 128
36-
#define ADDR_LEN 128
3743

38-
static const char * TAG = "echo server";
44+
static const char * TAG = "echo_server";
45+
46+
using namespace ::chip;
47+
using namespace ::chip::Inet;
3948

40-
static void udp_server_task(void * pvParameters)
49+
// UDP Endpoint Callbacks
50+
static void echo(IPEndPointBasis * endpoint, System::PacketBuffer * buffer, const IPPacketInfo * packet_info)
4151
{
42-
char rx_buffer[RX_LEN];
43-
char addr_str[ADDR_LEN];
44-
int addr_family = (int) pvParameters;
45-
int ip_protocol = 0;
46-
struct sockaddr_in6 dest_addr;
52+
bool status = endpoint != NULL && buffer != NULL && packet_info != NULL;
4753

48-
while (1)
54+
if (status)
4955
{
56+
char src_addr[INET_ADDRSTRLEN];
57+
char dest_addr[INET_ADDRSTRLEN];
5058

51-
if (addr_family == AF_INET)
52-
{
53-
struct sockaddr_in * dest_addr_ip4 = (struct sockaddr_in *) &dest_addr;
54-
dest_addr_ip4->sin_addr.s_addr = htonl(INADDR_ANY);
55-
dest_addr_ip4->sin_family = AF_INET;
56-
dest_addr_ip4->sin_port = htons(PORT);
57-
ip_protocol = IPPROTO_IP;
58-
}
59-
else if (addr_family == AF_INET6)
60-
{
61-
bzero(&dest_addr.sin6_addr.un, sizeof(dest_addr.sin6_addr.un));
62-
dest_addr.sin6_family = AF_INET6;
63-
dest_addr.sin6_port = htons(PORT);
64-
ip_protocol = IPPROTO_IPV6;
65-
}
59+
packet_info->SrcAddress.ToString(src_addr, sizeof(src_addr));
60+
packet_info->DestAddress.ToString(dest_addr, sizeof(dest_addr));
6661

67-
int sock = socket(addr_family, SOCK_DGRAM, ip_protocol);
68-
if (sock < 0)
69-
{
70-
ESP_LOGE(TAG, "Unable to create socket: errno %d", errno);
71-
break;
72-
}
73-
ESP_LOGI(TAG, "Socket created");
62+
ESP_LOGI(TAG, "UDP packet received from %s:%u to %s:%u (%zu bytes)", src_addr, packet_info->SrcPort, dest_addr,
63+
packet_info->DestPort, static_cast<size_t>(buffer->DataLength()));
7464

75-
#if defined(CONFIG_ECHO_IPV4) && defined(CONFIG_ECHO_IPV6)
76-
if (addr_family == AF_INET6)
77-
{
78-
// Note that by default IPV6 binds to both protocols, it is must be disabled
79-
// if both protocols used at the same time (used in CI)
80-
int opt = 1;
81-
setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
82-
setsockopt(sock, IPPROTO_IPV6, IPV6_V6ONLY, &opt, sizeof(opt));
83-
}
84-
#endif
65+
// attempt to print the incoming message
66+
char msg_buffer[buffer->DataLength() + 1];
67+
msg_buffer[buffer->DataLength()] = 0; // Null-terminate whatever we received and treat like a string...
68+
memcpy(msg_buffer, buffer->Start(), buffer->DataLength());
69+
ESP_LOGI(TAG, "Client sent: \"%s\"", msg_buffer);
8570

86-
int err = bind(sock, (struct sockaddr *) &dest_addr, sizeof(dest_addr));
87-
if (err < 0)
71+
// Attempt to echo back
72+
UDPEndPoint * udp_endpoint = static_cast<UDPEndPoint *>(endpoint);
73+
INET_ERROR err = udp_endpoint->SendTo(packet_info->SrcAddress, packet_info->SrcPort, buffer);
74+
if (err != INET_NO_ERROR)
8875
{
89-
ESP_LOGE(TAG, "Socket unable to bind: errno %d", errno);
90-
// Avoid looping hard if binding fails continuously
91-
vTaskDelay(50 / portTICK_PERIOD_MS);
92-
continue;
76+
ESP_LOGE(TAG, "Unable to echo back to client: %s", ErrorStr(err));
77+
// Note the failure status
78+
status = !status;
9379
}
94-
ESP_LOGI(TAG, "Socket bound, port %d", PORT);
95-
96-
while (1)
80+
else
9781
{
98-
99-
ESP_LOGI(TAG, "Waiting for data");
100-
struct sockaddr_in6 source_addr; // Large enough for both IPv4 or IPv6
101-
socklen_t socklen = sizeof(source_addr);
102-
int len = recvfrom(sock, rx_buffer, sizeof(rx_buffer) - 1, 0, (struct sockaddr *) &source_addr, &socklen);
103-
104-
// Error occurred during receiving
105-
if (len < 0)
106-
{
107-
ESP_LOGE(TAG, "recvfrom failed: errno %d", errno);
108-
break;
109-
}
110-
// Data received
111-
else
112-
{
113-
// Get the sender's ip address as string
114-
if (source_addr.sin6_family == PF_INET)
115-
{
116-
inet_ntoa_r(((struct sockaddr_in *) &source_addr)->sin_addr.s_addr, addr_str, sizeof(addr_str) - 1);
117-
}
118-
else if (source_addr.sin6_family == PF_INET6)
119-
{
120-
inet6_ntoa_r(source_addr.sin6_addr, addr_str, sizeof(addr_str) - 1);
121-
}
122-
123-
rx_buffer[len] = 0; // Null-terminate whatever we received and treat like a string...
124-
ESP_LOGI(TAG, "Received %d bytes from %s:", len, addr_str);
125-
ESP_LOGI(TAG, "%s", rx_buffer);
126-
127-
int err = sendto(sock, rx_buffer, len, 0, (struct sockaddr *) &source_addr, sizeof(source_addr));
128-
if (err < 0)
129-
{
130-
ESP_LOGE(TAG, "Error occurred during sending: errno %d", errno);
131-
break;
132-
}
133-
}
82+
ESP_LOGI(TAG, "Echo sent");
13483
}
84+
}
13585

136-
if (sock != -1)
86+
if (!status)
87+
{
88+
ESP_LOGE(TAG, "Received data but couldn't process it...");
89+
90+
// SendTo calls Free on the buffer without an AddRef, if SendTo was not called, free the buffer.
91+
if (buffer != NULL)
13792
{
138-
ESP_LOGE(TAG, "Shutting down socket and restarting...");
139-
shutdown(sock, 0);
140-
close(sock);
93+
System::PacketBuffer::Free(buffer);
14194
}
14295
}
143-
vTaskDelete(NULL);
96+
}
97+
98+
static void error(IPEndPointBasis * ep, INET_ERROR error, const IPPacketInfo * pi)
99+
{
100+
ESP_LOGE(TAG, "ERROR: %s\n Got UDP error", ErrorStr(error));
144101
}
145102

146103
// The echo server assumes the platform's networking has been setup already
147-
void startServer(void)
104+
void startServer(UDPEndPoint * endpoint)
148105
{
149-
#ifdef CONFIG_ECHO_IPV4
150-
xTaskCreate(udp_server_task, "udp_server", 4096, (void *) AF_INET, 5, NULL);
151-
#endif
152-
#ifdef CONFIG_ECHO_IPV6
153-
xTaskCreate(udp_server_task, "udp_server", 4096, (void *) AF_INET6, 5, NULL);
154-
#endif
106+
ESP_LOGI(TAG, "Trying to get Inet");
107+
INET_ERROR err = DeviceLayer::InetLayer.NewUDPEndPoint(&endpoint);
108+
if (err != INET_NO_ERROR)
109+
{
110+
ESP_LOGE(TAG, "ERROR: %s\n Couldn't create UDP Endpoint, server will not start.", ErrorStr(err));
111+
return;
112+
}
113+
114+
endpoint->OnMessageReceived = echo;
115+
endpoint->OnReceiveError = error;
116+
117+
err = endpoint->Bind(kIPAddressType_IPv4, IPAddress::Any, PORT);
118+
if (err != INET_NO_ERROR)
119+
{
120+
ESP_LOGE(TAG, "Socket unable to bind: Error %s", ErrorStr(err));
121+
return;
122+
}
123+
124+
err = endpoint->Listen();
125+
if (err != INET_NO_ERROR)
126+
{
127+
ESP_LOGE(TAG, "Socket unable to Listen: Error %s", ErrorStr(err));
128+
return;
129+
}
130+
ESP_LOGI(TAG, "Echo Server Listening on PORT:%d...", PORT);
155131
}

‎examples/wifi-echo/esp32/main/Kconfig.projbuild

+12-8
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,12 @@ menu "WiFi Echo Demo"
3535
bool "M5Stack"
3636
endchoice
3737

38-
config ECHO_IPV4
39-
bool "IPV4"
40-
default y
41-
42-
config ECHO_IPV6
43-
bool "IPV6"
44-
default n
45-
select EXAMPLE_CONNECT_IPV6
38+
config USE_ECHO_CLIENT
39+
bool "Enable the built-in Echo Client"
40+
default "y"
41+
help
42+
This enables a local FreeRTOS Echo Client so that the end-to-end echo server can be
43+
tested easily
4644

4745
config ECHO_PORT
4846
int "Port"
@@ -51,4 +49,10 @@ menu "WiFi Echo Demo"
5149
help
5250
Local port the example server will listen on.
5351

52+
config ECHO_HOST_IP
53+
string "IPV4 address"
54+
default "127.0.0.1"
55+
help
56+
The IPV4 Address of the ECHO Server.
57+
5458
endmenu

‎examples/wifi-echo/esp32/main/wifi-echo.cpp

+7-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@
3333
using namespace ::chip;
3434
using namespace ::chip::DeviceLayer;
3535

36-
extern void startServer(void);
36+
extern void startServer(UDPEndPoint * endpoint);
37+
extern void startClient(void);
3738

3839
#if CONFIG_DEVICE_TYPE_M5STACK
3940

@@ -150,7 +151,11 @@ extern "C" void app_main()
150151
statusLED.Init(STATUS_LED_GPIO_NUM);
151152

152153
// Start the Echo Server
153-
startServer();
154+
UDPEndPoint * sEndpoint = NULL;
155+
startServer(sEndpoint);
156+
#if CONFIG_USE_ECHO_CLIENT
157+
startClient();
158+
#endif
154159

155160
// Run the UI Loop
156161
while (true)

0 commit comments

Comments
 (0)