ESP32 - WebSocket
En este tutorial, aprenderemos qué es WebSocket, por qué necesitamos usarlo para controlar el ESP32 de forma suave y cómo usar WebSocket con ESP32. En un ejemplo práctico, aprenderemos cómo crear una aplicación de chat entre el navegador web y el ESP32, lo que te permitirá:
- Escribe un mensaje en la ventana de chat del navegador web y envíalo al ESP32. Puedes adaptar esto para controlar el ESP32.
- Recibe mensajes en tiempo real desde el ESP32. Puedes adaptar esto para monitorear el ESP32 en tiempo real.
Hardware Requerido
Or you can buy the following kits:
| 1 | × | DIYables ESP32 Starter Kit (ESP32 included) | |
| 1 | × | DIYables Sensor Kit (30 sensors/displays) | |
| 1 | × | DIYables Sensor Kit (18 sensors/displays) |
Divulgación: Algunos de los enlaces proporcionados en esta sección son enlaces de afiliado de Amazon. Podemos recibir una comisión por las compras realizadas a través de estos enlaces sin costo adicional para usted. Apreciamos su apoyo.
¿Qué es ESP32 Websocket?
Ahora, podrías estar preguntándote: '¿Qué es WebSocket?' Es bastante simple: WebSocket es una tecnología que permite que un navegador web hable directamente con un servidor web en tiempo real.
- Sin WebSocket, tienes que actualizar la página web para obtener actualizaciones. Eso no es muy conveniente.
- Con WebSocket, la página web y el servidor permanecen conectados todo el tiempo. Esto significa que pueden compartir información instantáneamente sin necesidad de recargar la página.
Probablemente te encuentres con WebSocket en aplicaciones web de uso diario, como juegos en línea, mensajería instantánea y actualizaciones del mercado de valores.
¿Por qué necesitamos WebSocket para controlar el ESP32 de forma fluida?
Imagina que quieres controlar tu coche teledirigido usando una interfaz web en tu teléfono o computadora. Sin WebSocket, cada vez que quieras cambiar la dirección o la velocidad del coche, tendrías que actualizar la página web. Es como tener que pulsar un botón de recarga cada vez que quieras que tu comando llegue al coche.
Ahora, con WebSocket, es como tener una conexión continua y directa entre tu teléfono o computadora y el coche. Ya no necesitas actualizar la página cada vez que quieras dirigir el coche o ajustar su velocidad. Es como si el coche estuviera siempre atento a tus comandos en tiempo real, sin retrasos causados por la recarga constante de la página.
En general, WebSocket te permite:
- Enviar datos desde el navegador web al ESP32 sin recargar la página web.
- Enviar datos desde el ESP32 al navegador web sin recargar la página web.
Esto facilita la comunicación bidireccional en tiempo real.
Beneficios de WebSocket con ESP32:
- Control en tiempo real: WebSocket permite una comunicación instantánea con el ESP32, asegurando respuestas rápidas a los comandos para una experiencia de usuario fluida.
- Conexión persistente: Mantener un enlace continuo sin actualizar la página de control, creando una línea de comunicación siempre lista para instrucciones inmediatas.
- Eficiencia: Experimenta respuestas rápidas sin necesidad de recargar la página de forma constante, mejorando la satisfacción general del usuario y la eficiencia.
Chat web con ESP32 a través de WebSocket
El contenido de la página web (HTML, CSS, JavaScript) se almacena por separado en un archivo index.h. Por lo tanto, tendremos dos archivos de código en el IDE de Arduino:
- Un archivo .ino con código para ESP32, que crea un servidor web y un servidor WebSocket
- Un archivo .h, que contiene el contenido de la página web
Pasos R\u00e1pidos
- Si es la primera vez que usas ESP32, consulta cómo configurar el entorno para ESP32 en Arduino IDE.
- Conecta la placa ESP32 a tu PC mediante un cable micro USB.
- Abre el IDE de Arduino en tu PC.
- Selecciona la placa ESP32 correcta (p. ej. ESP32 Dev Module) y el puerto COM.
- Abre el Gestor de Bibliotecas haciendo clic en el icono Gestor de Bibliotecas en la barra de navegación izquierda del IDE de Arduino.
- Busca “DIYables ESP32 WebServer”, luego encuentra la biblioteca Web Server creada por DIYables.
- Haz clic en el botón Instalar para instalar la biblioteca Web Server.
- En el IDE de Arduino, crea un nuevo sketch, dale un nombre, por ejemplo, newbiely.com.ino
- Copia el código de abajo y ábrelo con el IDE de Arduino
/*
* Este código de ESP32 fue desarrollado por es.newbiely.com
* Este código de ESP32 se proporciona al público sin ninguna restricción.
* Para tutoriales completos y diagramas de cableado, visite:
* https://es.newbiely.com/tutorials/esp32/esp32-websocket
*/
#include <DIYables_ESP32_WebServer.h>
#include "index.h"
// WiFi credentials
const char WIFI_SSID[] = "YOUR_WIFI_SSID";
const char WIFI_PASSWORD[] = "YOUR_WIFI_PASSWORD";
// Create web server instance
DIYables_ESP32_WebServer server;
DIYables_ESP32_WebSocket* webSocket;
// Web Page handlers
void handleHome(WiFiClient& client, const String& method, const String& request, const QueryParams& params, const String& jsonData) {
// HTML_CONTENT from the index.h file
server.sendResponse(client, HTML_CONTENT);
}
// WebSocket event handlers
void onWebSocketOpen(net::WebSocket& ws) {
Serial.println("New WebSocket connection");
// Send welcome message
const char welcome[] = "Connected to ESP32 WebSocket Server!";
}
void onWebSocketMessage(net::WebSocket& ws, const net::WebSocket::DataType dataType, const char* message, uint16_t length) {
Serial.print("WebSocket Received (");
Serial.print(length);
Serial.print(" bytes): ");
Serial.println(message);
// Broadcast response to all connected clients using the library
if (webSocket != nullptr) {
String response = "Received: " + String((char*)message);
webSocket->broadcastTXT(response);
Serial.print("WebSocket sent (");
Serial.print(response.length());
Serial.print(" bytes): ");
Serial.println(response);
}
}
void onWebSocketClose(net::WebSocket& ws, const net::WebSocket::CloseCode code, const char* reason, uint16_t length) {
Serial.println("WebSocket client disconnected");
}
void setup() {
Serial.begin(9600);
delay(1000);
Serial.println("ESP32 Web Server and WebSocket Server");
// Configure web server routes
server.addRoute("/", handleHome);
// Start web server with WiFi connection
server.begin(WIFI_SSID, WIFI_PASSWORD);
// Enable WebSocket functionality
webSocket = server.enableWebSocket(81);
if (webSocket != nullptr) {
// Set up WebSocket event handlers
webSocket->onOpen(onWebSocketOpen);
webSocket->onMessage(onWebSocketMessage);
webSocket->onClose(onWebSocketClose);
} else {
Serial.println("Failed to start WebSocket server");
}
}
void loop() {
// Then handle HTTP requests
server.handleClient();
// Handle WebSocket
server.handleWebSocket();
}
- Modifica la información de WiFi (SSID y contraseña) en el código para que coincida con tus credenciales de red.
- Crea el archivo index.h en el IDE de Arduino haciendo:
- Haz clic en el botón justo debajo del icono del monitor serie y elige Nueva pestaña, o usa las teclas Ctrl+Shift+N.
- Escribe el nombre del archivo index.h y haz clic en el OK botón
- Copia el código de abajo y pégalo en index.h.
- Ahora tienes el código en dos archivos: newbiely.com.ino y index.h
- Haz clic en el botón Subir en el IDE de Arduino para subir el código al ESP32.
- Abre el Monitor Serial
- Consulta el resultado en el Monitor Serial.
- Tome nota de la dirección IP que se muestra y escriba esta dirección en la barra de direcciones de un navegador web en su teléfono inteligente o PC.
- Verá la página web tal como se muestra a continuación:
- Haz clic en el botón CONECTAR para conectar la página web al ESP32 mediante WebSocket.
- Escribe algunas palabras y envíalas al ESP32.
- Verás la respuesta del ESP32.
- Si modificas el contenido HTML en el index.h y no tocas nada en el archivo newbiely.com.ino, cuando compiles y cargues el código al ESP32, el IDE de Arduino no actualizará el contenido HTML.
- Para que el IDE de Arduino actualice el contenido HTML en este caso, realiza un cambio en el archivo newbiely.com.ino (p. ej., agregar una línea en blanco, añadir un comentario...).
/*
* Este código de ESP32 fue desarrollado por es.newbiely.com
* Este código de ESP32 se proporciona al público sin ninguna restricción.
* Para tutoriales completos y diagramas de cableado, visite:
* https://es.newbiely.com/tutorials/esp32/esp32-websocket
*/
const char *HTML_CONTENT = R"=====(
<!DOCTYPE html>
<!-- saved from url=(0019)http://192.168.0.2/ -->
<html><head><meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<title>ESP32 WebSocket</title>
<meta name="viewport" content="width=device-width, initial-scale=0.7">
<link rel="icon" href="https://diyables.io/images/page/diyables.svg">
<style>
/* Add some basic styling for the chat window */
body {
font-size: 16px;
}
.chat-container {
width: 400px;
margin: 0 auto;
padding: 10px;
}
.chat-messages {
height: 250px;
overflow-y: auto;
border: 1px solid #444;
padding: 5px;
margin-bottom: 5px;
}
.user-input {
display: flex;
margin-bottom: 20px;
}
.user-input input {
flex: 1;
border: 1px solid #444;
padding: 5px;
}
.user-input button {
margin-left: 5px;
background-color: #007bff;
color: #fff;
border: none;
padding: 5px 10px;
cursor: pointer;
}
.websocket {
display: flex;
align-items: center;
margin-bottom: 5px;
}
.websocket button {
background-color: #007bff;
color: #fff;
border: none;
padding: 5px 10px;
cursor: pointer;
}
.websocket .label {
margin-left: auto;
}
</style>
<script>
var ws;
var wsm_max_len = 4096; /* bigger length causes uart0 buffer overflow with low speed smart device */
function update_text(text) {
var chat_messages = document.getElementById("chat-messages");
chat_messages.innerHTML += text + '<br>';
chat_messages.scrollTop = chat_messages.scrollHeight;
}
function send_onclick() {
if(ws != null) {
var message = document.getElementById("message").value;
if (message) {
document.getElementById("message").value = "";
ws.send(message + "\n");
update_text('<span style="color:navy">' + message + '</span>');
// You can send the message to the server or process it as needed
}
}
}
function connect_onclick() {
if(ws == null) {
ws = new WebSocket("ws://" + window.location.host + ":81");
document.getElementById("ws_state").innerHTML = "CONNECTING";
ws.onopen = ws_onopen;
ws.onclose = ws_onclose;
ws.onmessage = ws_onmessage;
} else
ws.close();
}
function ws_onopen() {
document.getElementById("ws_state").innerHTML = "<span style='color:blue'>CONNECTED</span>";
document.getElementById("bt_connect").innerHTML = "Disconnect";
document.getElementById("chat-messages").innerHTML = "";
}
function ws_onclose() {
document.getElementById("ws_state").innerHTML = "<span style='color:gray'>CLOSED</span>";
document.getElementById("bt_connect").innerHTML = "Connect";
ws.onopen = null;
ws.onclose = null;
ws.onmessage = null;
ws = null;
}
function ws_onmessage(e_msg) {
e_msg = e_msg || window.event; // MessageEvent
console.log(e_msg.data);
update_text('<span style="color:blue">' + e_msg.data + '</span>');
}
</script>
</head>
<body>
<div class="chat-container">
<h2>ESP32 WebSocket</h2>
<div class="websocket">
<button class="connect-button" id="bt_connect" onclick="connect_onclick()">Connect</button>
<span class="label">WebSocket: <span id="ws_state"><span style="color:blue">CLOSED</span></span></span>
</div>
<div class="chat-messages" id="chat-messages"></div>
<div class="user-input">
<input type="text" id="message" placeholder="Type your message...">
<button onclick="send_onclick()">Send</button>
</div>
<div class="sponsor">Sponsored by <a href="https://amazon.com/diyables">DIYables</a></div>
</div>
</body></html>
)=====";
COM6
Connecting to WiFi...
Connected to WiFi
ESP32 Web Server's IP address IP address: 192.168.0.2
Autoscroll
Clear output
9600 baud
Newline
※ Nota:
Explicación del código línea por línea
El código ESP32 anterior contiene una explicación línea por línea. Por favor, lea los comentarios en el código.
Cómo funciona el sistema
El código para ESP32 funciona creando tanto un servidor web como un servidor WebSocket. El proceso se desarrolla de la siguiente manera:
- Cuando introduces la dirección IP del ESP32 en un navegador web, se realiza una solicitud de la página web (Interfaz de usuario) desde el ESP32.
- El servidor web del ESP32 responde transmitiendo el contenido de la página web (HTML, CSS, JavaScript).
- Posteriormente, tu navegador web muestra la página.
- Cuando haces clic en el botón CONECTAR, el código JavaScript incrustado en la página web establece una conexión WebSocket con el servidor WebSocket en el ESP32.
- Con la conexión WebSocket establecida, cuando escribes algo y haces clic en el botón ENVIAR, el código JavaScript envía ese texto al ESP32 a través de la conexión WebSocket en segundo plano.
- Al recibir el valor del ángulo, el servidor WebSocket envía de vuelta una respuesta a la página web.
Puedes aprender otros ejemplos de WebSocket para ESP32 a continuación: