- Notifications
You must be signed in to change notification settings - Fork8
Async HTTP/WebSocket Server Library for Teensy 4.1 using QNEthernet. This library is one of the Async libraries to support T4.1, such as AsyncHTTPRequest_Generic, AsyncHTTPSRequest_Generic, AsyncMQTT_Generic, AsyncWebServer_Teensy41, AsyncUDP_Teensy41, AsyncDNSServer_Teensy41, etc. Now supporting using CString to save heap to send very large data
License
khoih-prog/AsyncWebServer_Teensy41
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
- Table of contents
- Important Note from v1.6.0
- Why do we need this AsyncWebServer_Teensy41 library
- Changelog
- Prerequisites
- Installation
- Packages' Patches
- Important things to remember
- Principles of operation
- Request Variables
- Responses
- Redirect to another URL
- Basic response with HTTP Code
- Basic response with HTTP Code and extra headers
- Basic response with string content
- Basic response with string content and extra headers
- Respond with content coming from a Stream
- Respond with content coming from a Stream and extra headers
- Respond with content coming from a Stream containing templates
- Respond with content coming from a Stream containing templates and extra headers
- Respond with content using a callback
- Respond with content using a callback and extra headers
- Respond with content using a callback containing templates
- Respond with content using a callback containing templates and extra headers
- Chunked Response
- Chunked Response containing templates
- Print to response
- ArduinoJson Basic Response
- ArduinoJson Advanced Response
- Param Rewrite With Matching
- Using filters
- Bad Responses
- Async WebSocket Plugin
- Async Event Source Plugin
- Remove handlers and rewrites
- Setting up the server
- Examples
- 1. Async_AdvancedWebServer
- 2. Async_HelloServer
- 3. Async_HelloServer2
- 4. Async_HttpBasicAuth
- 5. AsyncMultiWebServer
- 6. Async_PostServer
- 7. Async_RegexPatterns
- 8. Async_SimpleWebServer
- 9.MQTTClient_Auth
- 10.MQTTClient_Basic
- 11.MQTT_ThingStream
- 12. WebClient
- 13. WebClientRepeating
- 14. Async_AdvancedWebServer_favicon
- 15. Async_AdvancedWebServer_MemoryIssues_SendArduinoString
- 16. Async_AdvancedWebServer_MemoryIssues_Send_CString
- 17. Async_AdvancedWebServer_SendChunked
- 18. AsyncWebServer_SendChunked
- 19. Async_WebSocketsServerNew
- Example Async_AdvancedWebServer
- Debug Terminal Output Samples
- 1. Async_AdvancedWebServer on Teensy4.1 QNEthernet
- 2. WebClient on Teensy4.1 QNEthernet
- 3. MQTTClient_Auth on Teensy4.1 QNEthernet
- 4. MQTTClient_Basic on Teensy4.1 QNEthernet
- 5. MQTT_ThingStream on Teensy4.1 QNEthernet
- 6. Async_AdvancedWebServer_MemoryIssues_Send_CString on Teensy4.1 QNEthernet
- 7. Async_AdvancedWebServer_SendChunked on Teensy4.1 QNEthernet
- 8. AsyncWebServer_SendChunked on Teensy4.1 QNEthernet
- 9. Async_WebSocketsServer on Teensy4.1 QNEthernet
- Debug
- Troubleshooting
- Issues
- TO DO
- DONE
- Contributions and Thanks
- Contributing
- License
- Copyright
The newv1.6.0+ has added a new and powerful feature to permit usingCString to save heap to sendvery large data.
Check themarvelleous PRs of@salasidis inPortenta_H7_AsyncWebServer library
- request->send(200, textPlainStr, jsonChartDataCharStr); - Without using String Class - to save heap #8
- All memmove() removed - string no longer destroyed #11
and these new examples
- Async_AdvancedWebServer_MemoryIssues_Send_CString
- Async_AdvancedWebServer_MemoryIssues_SendArduinoString
If using Arduino String, to send a buffer around 11 KBytes, the usedMax Heap is around65,536 bytes
If using CString in regular memory, with the larger 31 KBytes, the usedMax Heap is around61,440 bytes
This is very critical in use-cases where sendingvery large data is necessary, withoutheap-allocation-error.
- The traditional function used to send
Arduino Stringis
| voidsend(int code,const String& contentType = String(),const String& content = String()); |
voidsend(int code,const String& contentType = String(),const String& content = String());
such as
request->send(200, textPlainStr, ArduinoStr);
The required additional HEAP is about2 times of the String size
- To use
CStringwith copying while sending. Use function
| voidsend(int code,const String& contentType,constchar *content,bool nonCopyingSend =true);// RSMOD |
voidsend(int code,const String& contentType,constchar *content,bool nonCopyingSend =true);// RSMOD
such as
request->send(200, textPlainStr, cStr);
The required additional HEAP is also about2 times of the CString size because ofunnecessary copies of the CString in HEAP. Avoid thisinefficient way.
- To use
CStringwithout copying while sending. Use function
| voidsend(int code,const String& contentType,constchar *content,bool nonCopyingSend =true);// RSMOD |
voidsend(int code,const String& contentType,constchar *content,bool nonCopyingSend =true);// RSMOD
such as
request->send(200, textPlainStr, cStr,false);
The required additional HEAP is about1 times of the CString size. This way is the best andmost efficient way to use by avoiding ofunnecessary copies of the CString in HEAP
Why do we need thisAsyncWebServer_Teensy41 library
This library is based on, modified from:
to apply the better and fasterasynchronous feature of thepowerfulESPAsyncWebServer Library intoTeensy 4.1 using built-in QNEthernet
- Using asynchronous network means that you can handlemore than one connection at the same time
- You are called once the request is ready and parsed
- When you send the response, you areimmediately ready to handle other connections while the server is taking care of sending the response in the background
- Speed is OMG
- Easy to use API, HTTP Basic and Digest MD5 Authentication (default), ChunkedResponse
- Easily extensible to handleany type of content
- Supports Continue 100
- Async WebSocket plugin offering different locations without extra servers or ports
- Async EventSource (Server-Sent Events) plugin to send events to the browser
- URL Rewrite plugin for conditional and permanent url rewrites
- ServeStatic plugin that supports cache, Last-Modified, default index and more
- Simple template processing engine to handle templates
- Teensy 4.1 using QNEthernet Library
Arduino IDE 1.8.19+for Arduino.Teensy core v1.57+for Teensy 4.1.QNEthernet Library version v0.26.0+for Teensy 4.1 built-in EthernetTeensy41_AsyncTCP library v1.1.0+to useTeensy 4.1 using QNEthernet Library.
The best and easiest way is to useArduino Library Manager. Search forAsyncWebServer_Teensy41, then select / install the latest version. You can also use this link for more detailed instructions.
- Navigate toAsyncWebServer_Teensy41 page.
- Download the latest release
AsyncWebServer_Teensy41-main.zip. - Extract the zip file to
AsyncWebServer_Teensy41-maindirectory - Copy the whole
AsyncWebServer_Teensy41-mainfolder to Arduino libraries' directory such as~/Arduino/libraries/.
- InstallVS Code
- InstallPlatformIO
- InstallAsyncWebServer_Teensy41 library by usingLibrary Manager. Search forAsyncWebServer_Teensy41 inPlatform.io Author's Libraries
- Use includedplatformio.ini file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples atProject Configuration File
To be able to compile and run on Teensy boards, you have to copy the files inPackages_Patches for Teensy directory into Teensy hardware directory (./arduino-1.8.19/hardware/teensy/avr/boards.txt).
Supposing the Arduino version is 1.8.19. These files must be copied into the directory:
./arduino-1.8.19/hardware/teensy/avr/boards.txt./arduino-1.8.19/hardware/teensy/avr/cores/teensy/Stream.h./arduino-1.8.19/hardware/teensy/avr/cores/teensy3/Stream.h./arduino-1.8.19/hardware/teensy/avr/cores/teensy4/Stream.h
Whenever a new version is installed, remember to copy this file into the new version directory. For example, new version is x.yy.zzThese files must be copied into the directory:
./arduino-x.yy.zz/hardware/teensy/avr/boards.txt./arduino-x.yy.zz/hardware/teensy/avr/cores/teensy/Stream.h./arduino-x.yy.zz/hardware/teensy/avr/cores/teensy3/Stream.h./arduino-x.yy.zz/hardware/teensy/avr/cores/teensy4/Stream.h
- This is fully asynchronous server and as such does not run on the loop thread.
- You can not use
yield()ordelay()or any function that uses them inside the callbacks - The server is smart enough to know when to close the connection and free resources
- You can not send more than one response to a single request
- Listens for connections
- Wraps the new clients into
Request - Keeps track of clients and cleans memory
- Manages
Rewritesand apply them on the request url - Manages
Handlersand attaches them to Requests
- TCP connection is received by the server
- The connection is wrapped inside
Requestobject - When the request head is received (type, url, get params, http version and host),the server goes through all
Rewrites(in the order they were added) to rewrite the url and inject query parameters,next, it goes through all attachedHandlers(in the order they were added) trying to find onethatcanHandlethe given request. If none are found, the default(catch-all) handler is attached. - The rest of the request is received, calling the
handleUploadorhandleBodymethods of theHandlerif they are needed (POST+File/Body) - When the whole request is parsed, the result is given to the
handleRequestmethod of theHandlerand is ready to be responded to - In the
handleRequestmethod, to theRequestis attached aResponseobject (see below) that will serve the response data back to the client - When the
Responseis sent, the client is closed and freed from the memory
- The
Rewritesare used to rewrite the request url and/or inject get parameters for a specific request url path. - All
Rewritesare evaluated on the request in the order they have been added to the server. - The
Rewritewill change the request url only if the request url (excluding get parameters) is fully matchthe rewrite url, and when the optionalFiltercallback return true. - Setting a
Filterto theRewriteenables to control when to apply the rewrite, decision can be based onrequest url, http version, request host/port/target host, get parameters or the request client's localIP or remoteIP. - The
Rewritecan specify a target url with optional get parameters, e.g./to-url?with=params
- The
Handlersare used for executing specific actions to particular requests - One
Handlerinstance can be attached to any request and lives together with the server - Setting a
Filterto theHandlerenables to control when to apply the handler, decision can be based onrequest url, http version, request host/port/target host, get parameters or the request client's localIP or remoteIP. - The
canHandlemethod is used for handler specific control on whether the requests can be handledand for declaring any interesting headers that theRequestshould parse. Decision can be based on requestmethod, request url, http version, request host/port/target host and get parameters - Once a
Handleris attached to givenRequest(canHandlereturned true)thatHandlertakes care to receive any file/data upload and attach aResponseonce theRequesthas been fully parsed Handlersare evaluated in the order they are attached to the server. ThecanHandleis called onlyif theFilterthat was set to theHandlerreturn true.- The first
Handlerthat can handle the request is selected, not furtherFilterandcanHandleare called.
- The
Responseobjects are used to send the response data back to the client - The
Responseobject lives with theRequestand is freed on end or disconnect - Different techniques are used depending on the response type to send the data in packetsreturning back almost immediately and sending the next packet when this one is received.Any time in between is spent to run the user loop and handle other network packets
- Responding asynchronously is probably the most difficult thing for most to understand
- Many different options exist for the user to make responding a background task
- AsyncWebServer_Teensy41 contains simple template processing engine.
- Template processing can be added to most response types.
- Currently it supports only replacing template placeholders with actual values. No conditional processing, cycles, etc.
- Placeholders are delimited with
%symbols. Like this:%TEMPLATE_PLACEHOLDER%. - It works by extracting placeholder name from response text and passing it to user provided function which should return actual value to be used instead of placeholder.
- Since it's user provided function, it is possible for library users to implement conditional processing and cycles themselves.
- Since it's impossible to know the actual response size after template processing step in advance (and, therefore, to include it in response headers), the response becomeschunked.
request->version();// uint8_t: 0 = HTTP/1.0, 1 = HTTP/1.1request->method();// enum: HTTP_GET, HTTP_POST, HTTP_DELETE, HTTP_PUT, HTTP_PATCH, HTTP_HEAD, HTTP_OPTIONSrequest->url();// String: URL of the request (not including host, port or GET parameters)request->host();// String: The requested host (can be used for virtual hosting)request->contentType();// String: ContentType of the request (not available in Handler::canHandle)request->contentLength();// size_t: ContentLength of the request (not available in Handler::canHandle)request->multipart();// bool: True if the request has content type "multipart"
//List all collected headersint headers = request->headers();int i;for (i=0;i<headers;i++){ AsyncWebHeader* h = request->getHeader(i); Serial.printf("HEADER[%s]: %s\n", h->name().c_str(), h->value().c_str());}//get specific header by nameif (request->hasHeader("MyHeader")){ AsyncWebHeader* h = request->getHeader("MyHeader"); Serial.printf("MyHeader: %s\n", h->value().c_str());}//List all collected headers (Compatibility)int headers = request->headers();int i;for (i=0;i<headers;i++){ Serial.printf("HEADER[%s]: %s\n", request->headerName(i).c_str(), request->header(i).c_str());}//get specific header by name (Compatibility)if (request->hasHeader("MyHeader")){ Serial.printf("MyHeader: %s\n", request->header("MyHeader").c_str());}
//List all parametersint params = request->params();for (int i=0;i<params;i++){ AsyncWebParameter* p = request->getParam(i);if (p->isFile()) {//p->isPost() is also true Serial.printf("FILE[%s]: %s, size: %u\n", p->name().c_str(), p->value().c_str(), p->size()); }elseif (p->isPost()) { Serial.printf("POST[%s]: %s\n", p->name().c_str(), p->value().c_str()); }else { Serial.printf("GET[%s]: %s\n", p->name().c_str(), p->value().c_str()); }}//Check if GET parameter existsif (request->hasParam("download")) AsyncWebParameter* p = request->getParam("download");//Check if POST (but not File) parameter existsif (request->hasParam("download",true)) AsyncWebParameter* p = request->getParam("download",true);//Check if FILE was uploadedif (request->hasParam("download",true,true)) AsyncWebParameter* p = request->getParam("download",true,true);//List all parameters (Compatibility)int args = request->args();for (int i=0;i<args;i++){ Serial.printf("ARG[%s]: %s\n", request->argName(i).c_str(), request->arg(i).c_str());}//Check if parameter exists (Compatibility)if (request->hasArg("download")) String arg = request->arg("download");
Endpoints which consume JSON can use a special handler to get ready to use JSON data in the request callback:
#include"AsyncJson.h"#include"ArduinoJson.h"AsyncCallbackJsonWebHandler* handler =new AsyncCallbackJsonWebHandler("/rest/endpoint", [](AsyncWebServerRequest *request, JsonVariant &json) { JsonObject& jsonObj = json.as<JsonObject>();// ...});server.addHandler(handler);
//to local urlrequest->redirect("/login");//to external urlrequest->redirect("http://esp8266.com");
request->send(404);//Sends 404 File Not Found
AsyncWebServerResponse *response = request->beginResponse(404);//Sends 404 File Not Foundresponse->addHeader("Server","AsyncWebServer_Teensy41");request->send(response);
request->send(200,"text/plain","Hello World!");
AsyncWebServerResponse *response = request->beginResponse(200,"text/plain","Hello World!");response->addHeader("Server","AsyncWebServer");request->send(response);
//read 12 bytes from Serial and send them as Content Type text/plainrequest->send(Serial,"text/plain",12);
//read 12 bytes from Serial and send them as Content Type text/plainAsyncWebServerResponse *response = request->beginResponse(Serial,"text/plain",12);response->addHeader("Server","AsyncWebServer_Teensy41");request->send(response);
Stringprocessor(const String& var){if (var =="HELLO_FROM_TEMPLATE")returnF("Hello world!");returnString();}// ...//read 12 bytes from Serial and send them as Content Type text/plainrequest->send(Serial,"text/plain",12, processor);
Stringprocessor(const String& var){if (var =="HELLO_FROM_TEMPLATE")returnF("Hello world!");returnString();}// ...//read 12 bytes from Serial and send them as Content Type text/plainAsyncWebServerResponse *response = request->beginResponse(Serial,"text/plain",12, processor);response->addHeader("Server","AsyncWebServer_Teensy41");request->send(response);
//send 128 bytes as plain textrequest->send("text/plain",128, [](uint8_t *buffer,size_t maxLen,size_t index) -> size_t {//Write up to "maxLen" bytes into "buffer" and return the amount written.//index equals the amount of bytes that have been already sent//You will not be asked for more bytes once the content length has been reached.//Keep in mind that you can not delay or yield waiting for more data!//Send what you currently have and you will be asked for more againreturn mySource.read(buffer, maxLen);});
//send 128 bytes as plain textAsyncWebServerResponse *response = request->beginResponse("text/plain",128, [](uint8_t *buffer,size_t maxLen,size_t index) -> size_t {//Write up to "maxLen" bytes into "buffer" and return the amount written.//index equals the amount of bytes that have been already sent//You will not be asked for more bytes once the content length has been reached.//Keep in mind that you can not delay or yield waiting for more data!//Send what you currently have and you will be asked for more againreturn mySource.read(buffer, maxLen);});response->addHeader("Server","AsyncWebServer_Teensy41");request->send(response);
Stringprocessor(const String& var){if (var =="HELLO_FROM_TEMPLATE")returnF("Hello world!");returnString();}// ...//send 128 bytes as plain textrequest->send("text/plain",128, [](uint8_t *buffer,size_t maxLen,size_t index) -> size_t {//Write up to "maxLen" bytes into "buffer" and return the amount written.//index equals the amount of bytes that have been already sent//You will not be asked for more bytes once the content length has been reached.//Keep in mind that you can not delay or yield waiting for more data!//Send what you currently have and you will be asked for more againreturn mySource.read(buffer, maxLen);}, processor);
Stringprocessor(const String& var){if (var =="HELLO_FROM_TEMPLATE")returnF("Hello world!");returnString();}// ...//send 128 bytes as plain textAsyncWebServerResponse *response = request->beginResponse("text/plain",128, [](uint8_t *buffer,size_t maxLen,size_t index) -> size_t {//Write up to "maxLen" bytes into "buffer" and return the amount written.//index equals the amount of bytes that have been already sent//You will not be asked for more bytes once the content length has been reached.//Keep in mind that you can not delay or yield waiting for more data!//Send what you currently have and you will be asked for more againreturn mySource.read(buffer, maxLen);}, processor);response->addHeader("Server","AsyncWebServer_Teensy41");request->send(response);
Used when content length is unknown. Works best if the client supports HTTP/1.1
AsyncWebServerResponse *response = request->beginChunkedResponse("text/plain", [](uint8_t *buffer,size_t maxLen,size_t index) -> size_t {//Write up to "maxLen" bytes into "buffer" and return the amount written.//index equals the amount of bytes that have been already sent//You will be asked for more data until 0 is returned//Keep in mind that you can not delay or yield waiting for more data!return mySource.read(buffer, maxLen);});response->addHeader("Server","AsyncWebServer_Teensy41");request->send(response);
Used when content length is unknown. Works best if the client supports HTTP/1.1
Stringprocessor(const String& var){if (var =="HELLO_FROM_TEMPLATE")returnF("Hello world!");returnString();}// ...AsyncWebServerResponse *response = request->beginChunkedResponse("text/plain", [](uint8_t *buffer,size_t maxLen,size_t index) -> size_t {//Write up to "maxLen" bytes into "buffer" and return the amount written.//index equals the amount of bytes that have been already sent//You will be asked for more data until 0 is returned//Keep in mind that you can not delay or yield waiting for more data!return mySource.read(buffer, maxLen);}, processor);response->addHeader("Server","AsyncWebServer_Teensy41");request->send(response);
AsyncResponseStream *response = request->beginResponseStream("text/html");response->addHeader("Server","AsyncWebServer_Teensy41");response->printf("<!DOCTYPE html><html><head><title>Webpage at %s</title></head><body>", request->url().c_str());response->print("<h2>Hello");response->print(request->client()->remoteIP());response->print("</h2>");response->print("<h3>General</h3>");response->print("<ul>");response->printf("<li>Version: HTTP/1.%u</li>", request->version());response->printf("<li>Method: %s</li>", request->methodToString());response->printf("<li>URL: %s</li>", request->url().c_str());response->printf("<li>Host: %s</li>", request->host().c_str());response->printf("<li>ContentType: %s</li>", request->contentType().c_str());response->printf("<li>ContentLength: %u</li>", request->contentLength());response->printf("<li>Multipart: %s</li>", request->multipart()?"true":"false");response->print("</ul>");response->print("<h3>Headers</h3>");response->print("<ul>");int headers = request->headers();for (int i=0;i<headers;i++){ AsyncWebHeader* h = request->getHeader(i); response->printf("<li>%s: %s</li>", h->name().c_str(), h->value().c_str());}response->print("</ul>");response->print("<h3>Parameters</h3>");response->print("<ul>");int params = request->params();for (int i=0;i<params;i++){ AsyncWebParameter* p = request->getParam(i);if (p->isFile()) { response->printf("<li>FILE[%s]: %s, size: %u</li>", p->name().c_str(), p->value().c_str(), p->size()); }elseif (p->isPost()) { response->printf("<li>POST[%s]: %s</li>", p->name().c_str(), p->value().c_str()); }else { response->printf("<li>GET[%s]: %s</li>", p->name().c_str(), p->value().c_str()); }}response->print("</ul>");response->print("</body></html>");//send the response lastrequest->send(response);
This way of sending Json is great for when the result isbelow 4KB
#include"AsyncJson.h"#include"ArduinoJson.h"AsyncResponseStream *response = request->beginResponseStream("application/json");DynamicJsonBuffer jsonBuffer;JsonObject &root = jsonBuffer.createObject();root["heap"] = ESP.getFreeHeap();root["ssid"] = WiFi.SSID();root.printTo(*response);request->send(response);
This response can handle reallylarge Json objects (tested to 40KB)
There isn't any noticeable speed decrease for small results with the method above
Since ArduinoJson does not allow reading parts of the string, the whole Json has to be passed every time achunks needs to be sent, which shows speed decrease proportional to the resulting json packets
#include"AsyncJson.h"#include"ArduinoJson.h"AsyncJsonResponse * response =new AsyncJsonResponse();response->addHeader("Server","AsyncWebServer");JsonObject& root = response->getRoot();root["IP"] = Ethernet.localIP();response->setLength();request->send(response);
It is possible to rewrite the request url with parameter matching. Here is an example with one parameter:Rewrite for example "/radio/{frequency}" -> "/radio?f={frequency}"
classOneParamRewrite :publicAsyncWebRewrite{protected: String _urlPrefix;int _paramIndex; String _paramsBackup;public:OneParamRewrite(constchar* from,constchar* to) : AsyncWebRewrite(from, to) { _paramIndex = _from.indexOf('{');if ( _paramIndex >=0 && _from.endsWith("}")) { _urlPrefix = _from.substring(0, _paramIndex);int index = _params.indexOf('{');if (index >=0) { _params = _params.substring(0, index); } }else { _urlPrefix = _from; } _paramsBackup = _params; }boolmatch(AsyncWebServerRequest *request)override {if (request->url().startsWith(_urlPrefix)) {if (_paramIndex >=0) { _params = _paramsBackup + request->url().substring(_paramIndex); }else { _params = _paramsBackup; }returntrue; }else {returnfalse; } }};
Usage:
server.addRewrite(new OneParamRewrite("/radio/{frequency}","/radio?f={frequency}") );
Filters can be set toRewrite orHandler in order to control when to apply the rewrite and consider the handler.A filter is a callback function that evaluates the request and return a booleantrue to include the itemorfalse to exclude it.
Some responses are implemented, but you should not use them, because they do not conform to HTTP.The following example will lead to unclean close of the connection and more time wastedthan providing the length of the content
//This is used as fallback for chunked responses to HTTP/1.0 Clientsrequest->send("text/plain",0, [](uint8_t *buffer,size_t maxLen,size_t index) -> size_t {//Write up to "maxLen" bytes into "buffer" and return the amount written.//You will be asked for more data until 0 is returned//Keep in mind that you can not delay or yield waiting for more data!return mySource.read(buffer, maxLen);});
The server includes a web socket plugin which lets you define different WebSocket locations to connect towithout starting another listening service or using different port
voidonEvent(AsyncWebSocket * server, AsyncWebSocketClient * client, AwsEventType type,void * arg,uint8_t *data,size_t len){if (type == WS_EVT_CONNECT) {//client connected Serial.printf("ws[%s][%u] connect\n", server->url(), client->id()); client->printf("Hello Client %u :)", client->id()); client->ping(); }elseif (type == WS_EVT_DISCONNECT) {//client disconnected Serial.printf("ws[%s][%u] disconnect: %u\n", server->url(), client->id()); }elseif (type == WS_EVT_ERROR) {//error was received from the other end Serial.printf("ws[%s][%u] error(%u): %s\n", server->url(), client->id(), *((uint16_t*)arg), (char*)data); }elseif (type == WS_EVT_PONG) {//pong message was received (in response to a ping request maybe) Serial.printf("ws[%s][%u] pong[%u]: %s\n", server->url(), client->id(), len, (len)?(char*)data:""); }elseif (type == WS_EVT_DATA) {//data packet AwsFrameInfo * info = (AwsFrameInfo*)arg;if (info->final && info->index ==0 && info->len == len) {//the whole message is in a single frame and we got all of it's data Serial.printf("ws[%s][%u] %s-message[%llu]:", server->url(), client->id(), (info->opcode == WS_TEXT)?"text":"binary", info->len);if (info->opcode == WS_TEXT) { data[len] =0; Serial.printf("%s\n", (char*)data); }else {for (size_t i=0; i < info->len; i++) { Serial.printf("%02x", data[i]); } Serial.printf("\n"); }if (info->opcode == WS_TEXT) client->text("I got your text message");else client->binary("I got your binary message"); }else {//message is comprised of multiple frames or the frame is split into multiple packetsif (info->index ==0) {if (info->num ==0) Serial.printf("ws[%s][%u] %s-message start\n", server->url(), client->id(), (info->message_opcode == WS_TEXT)?"text":"binary"); Serial.printf("ws[%s][%u] frame[%u] start[%llu]\n", server->url(), client->id(), info->num, info->len); } Serial.printf("ws[%s][%u] frame[%u] %s[%llu - %llu]:", server->url(), client->id(), info->num, (info->message_opcode == WS_TEXT)?"text":"binary", info->index, info->index + len);if (info->message_opcode == WS_TEXT) { data[len] =0; Serial.printf("%s\n", (char*)data); }else {for (size_t i=0; i < len; i++){ Serial.printf("%02x", data[i]); } Serial.printf("\n"); }if ((info->index + len) == info->len) { Serial.printf("ws[%s][%u] frame[%u] end[%llu]\n", server->url(), client->id(), info->num, info->len);if (info->final) { Serial.printf("ws[%s][%u] %s-message end\n", server->url(), client->id(), (info->message_opcode == WS_TEXT)?"text":"binary");if (info->message_opcode == WS_TEXT) client->text("I got your text message");else client->binary("I got your binary message"); } } } }}
//Server methodsAsyncWebSocketws("/ws");//printf to a clientws.printf((uint32_t)client_id, arguments...);//printf to all clientsws.printfAll(arguments...);//send text to a clientws.text((uint32_t)client_id, (char*)text);ws.text((uint32_t)client_id, (uint8_t*)text, (size_t)len);//send text to all clientsws.textAll((char*)text);ws.textAll((uint8_t*)text, (size_t)len);//send binary to a clientws.binary((uint32_t)client_id, (char*)binary);ws.binary((uint32_t)client_id, (uint8_t*)binary, (size_t)len);ws.binary((uint32_t)client_id, flash_binary,4);//send binary to all clientsws.binaryAll((char*)binary);ws.binaryAll((uint8_t*)binary, (size_t)len);//HTTP Authenticate before switch to Websocket protocolws.setAuthentication("user","pass");//client methodsAsyncWebSocketClient * client;//printfclient->printf(arguments...);//send textclient->text((char*)text);client->text((uint8_t*)text, (size_t)len);//send binaryclient->binary((char*)binary);client->binary((uint8_t*)binary, (size_t)len);
When sending a web socket message using the above methods a buffer is created. Under certain circumstances you might want to manipulate or populate this buffer directly from your application, for example to prevent unnecessary duplications of the data. This example below shows how to create a buffer and print data to it from an ArduinoJson object then send it.
voidsendDataWs(AsyncWebSocketClient * client){ DynamicJsonBuffer jsonBuffer; JsonObject& root = jsonBuffer.createObject(); root["a"] ="abc"; root["b"] ="abcd"; root["c"] ="abcde"; root["d"] ="abcdef"; root["e"] ="abcdefg";size_t len = root.measureLength(); AsyncWebSocketMessageBuffer * buffer = ws.makeBuffer(len);// creates a buffer (len + 1) for you.if (buffer) { root.printTo((char *)buffer->get(), len +1);if (client) { client->text(buffer); }else { ws.textAll(buffer); } }}
Browsers sometimes do not correctly close the websocket connection, even when theclose() function is called in javascript. This will eventually exhaust the web server's resources and will cause the server to crash. Periodically calling thecleanClients() function from the mainloop() function limits the number of clients by closing the oldest client when the maximum number of clients has been exceeded. This can called be every cycle, however, if you wish to use less power, then calling as infrequently as once per second is sufficient.
voidloop(){ ws.cleanupClients();}
The server includesEventSource (Server-Sent Events) plugin which can be used to send short text events to the browser.Difference betweenEventSource andWebSockets is thatEventSource is single direction, text-only protocol.
AsyncWebServerserver(80);AsyncEventSourceevents("/events");voidsetup(){// setup ...... events.onConnect([](AsyncEventSourceClient *client) {if (client->lastId()) { Serial.printf("Client reconnected! Last message ID that it got is: %u\n", client->lastId()); }//send event with message "hello!", id current millis// and set reconnect delay to 1 second client->send("hello!",NULL,millis(),1000); });//HTTP Basic authentication events.setAuthentication("user","pass"); server.addHandler(&events);// setup ......}voidloop(){if (eventTriggered){// your logic here//send event "myevent" events.send("my event content","myevent",millis()); }}
if(!!window.EventSource){varsource=newEventSource('/events');source.addEventListener('open',function(e){console.log("Events Connected");},false);source.addEventListener('error',function(e){if(e.target.readyState!=EventSource.OPEN){console.log("Events Disconnected");}},false);source.addEventListener('message',function(e){console.log("message",e.data);},false);source.addEventListener('myevent',function(e){console.log("myevent",e.data);},false);}
Server goes through handlers in same order as they were added. You can't simple add handler with same path to override them.To remove handler:
// save callback for particular URL pathauto handler = server.on("/some/path", [](AsyncWebServerRequest *request){//do something useful});// when you don't need handler anymore remove itserver.removeHandler(&handler);// same with rewritesserver.removeRewrite(&someRewrite);server.onNotFound([](AsyncWebServerRequest *request){ request->send(404);});// remove server.onNotFound handlerserver.onNotFound(NULL);// remove all rewrites, handlers and onNotFound/onFileUpload/onRequestBody callbacksserver.reset();
| #if !( defined(CORE_TEENSY) && defined(__IMXRT1062__) && defined(ARDUINO_TEENSY41) ) | |
| #error Only Teensy 4.1 supported | |
| #endif | |
| // Debug Level from 0 to 4 | |
| #define_TEENSY41_ASYNC_TCP_LOGLEVEL_1 | |
| #define_AWS_TEENSY41_LOGLEVEL_1 | |
| #defineSHIELD_TYPE"Teensy4.1 QNEthernet" | |
| #if (_AWS_TEENSY41_LOGLEVEL_ > 3) | |
| #warning Using QNEthernet lib for Teensy 4.1. Must also use Teensy Packages Patch or error | |
| #endif | |
| #defineUSING_DHCPtrue | |
| //#define USING_DHCP false | |
| #if !USING_DHCP | |
| // Set the static IP address to use if the DHCP fails to assign | |
| IPAddressmyIP(192,168,2,222); | |
| IPAddressmyNetmask(255,255,255,0); | |
| IPAddressmyGW(192,168,2,1); | |
| //IPAddress mydnsServer(192, 168, 2, 1); | |
| IPAddressmydnsServer(8,8,8,8); | |
| #endif | |
| #include"QNEthernet.h"// https://github.com/ssilverman/QNEthernet | |
| usingnamespaceqindesign::network; | |
| #include<AsyncWebServer_Teensy41.h> | |
| AsyncWebServerserver(80); | |
| constint led =13; | |
| voidhandleRoot(AsyncWebServerRequest *request) | |
| { | |
| digitalWrite(led,1); | |
| request->send(200,"text/plain",String("Hello from AsyncWebServer_Teensy41 on") + BOARD_NAME ); | |
| digitalWrite(led,0); | |
| } | |
| voidhandleNotFound(AsyncWebServerRequest *request) | |
| { | |
| digitalWrite(led,1); | |
| String message ="File Not Found\n\n"; | |
| message +="URI:"; | |
| //message += server.uri(); | |
| message += request->url(); | |
| message +="\nMethod:"; | |
| message += (request->method() == HTTP_GET) ?"GET" :"POST"; | |
| message +="\nArguments:"; | |
| message += request->args(); | |
| message +="\n"; | |
| for (uint8_t i =0; i < request->args(); i++) | |
| { | |
| message +="" + request->argName(i) +":" + request->arg(i) +"\n"; | |
| } | |
| request->send(404,"text/plain", message); | |
| digitalWrite(led,0); | |
| } | |
| voidsetup() | |
| { | |
| pinMode(led, OUTPUT); | |
| digitalWrite(led,0); | |
| Serial.begin(115200); | |
| while (!Serial &&millis() <5000); | |
| delay(200); | |
| Serial.print("\nStart Async_HelloServer on"); Serial.print(BOARD_NAME); | |
| Serial.print(" with"); Serial.println(SHIELD_TYPE); | |
| Serial.println(ASYNC_WEBSERVER_TEENSY41_VERSION); | |
| delay(500); | |
| #if USING_DHCP | |
| // Start the Ethernet connection, using DHCP | |
| Serial.print("Initialize Ethernet using DHCP =>"); | |
| Ethernet.begin(); | |
| #else | |
| // Start the Ethernet connection, using static IP | |
| Serial.print("Initialize Ethernet using static IP =>"); | |
| Ethernet.begin(myIP, myNetmask, myGW); | |
| Ethernet.setDNSServerIP(mydnsServer); | |
| #endif | |
| if (!Ethernet.waitForLocalIP(5000)) | |
| { | |
| Serial.println(F("Failed to configure Ethernet")); | |
| if (!Ethernet.linkStatus()) | |
| { | |
| Serial.println(F("Ethernet cable is not connected.")); | |
| } | |
| // Stay here forever | |
| while (true) | |
| { | |
| delay(1); | |
| } | |
| } | |
| else | |
| { | |
| Serial.print(F("Connected! IP address:")); Serial.println(Ethernet.localIP()); | |
| } | |
| #if USING_DHCP | |
| delay(1000); | |
| #else | |
| delay(2000); | |
| #endif | |
| server.on("/", HTTP_GET, [](AsyncWebServerRequest * request) | |
| { | |
| handleRoot(request); | |
| }); | |
| server.on("/inline", [](AsyncWebServerRequest * request) | |
| { | |
| request->send(200,"text/plain","This works as well"); | |
| }); | |
| server.onNotFound(handleNotFound); | |
| server.begin(); | |
| Serial.print(F("HTTP EthernetWebServer is @ IP :")); | |
| Serial.println(Ethernet.localIP()); | |
| } | |
| voidloop() | |
| { | |
| } |
#include"QNEthernet.h"// https://github.com/ssilverman/QNEthernetusingnamespaceqindesign::network;#include<AsyncWebServer_Teensy41.h>AsyncWebServerserver(80);...voidhandleRequest(AsyncWebServerRequest *request){}classWebClass {public : AsyncWebServer classWebServer = AsyncWebServer(81);WebClass(){};voidclassRequest (AsyncWebServerRequest *request){}voidbegin() {// attach global request handler classWebServer.on("/example", HTTP_ANY, handleRequest);// attach class request handler classWebServer.on("/example", HTTP_ANY,std::bind(&WebClass::classRequest,this, std::placeholders::_1)); }};AsyncWebServerglobalWebServer(80);WebClass webClassInstance;voidsetup() {// attach global request handler globalWebServer.on("/example", HTTP_ANY, handleRequest);// attach class request handler globalWebServer.on("/example", HTTP_ANY,std::bind(&WebClass::classRequest, webClassInstance, std::placeholders::_1));}voidloop() {}
// Disable client connections if it was activatedif ( ws.enabled() ) ws.enable(false);// enable client connections if it was disabledif ( !ws.enabled() ) ws.enable(true);
In some cases, such as when working with CORS, or with some sort of custom authentication system,you might need to define a header that should get added to all responses (including static, websocket and EventSource).The DefaultHeaders singleton allows you to do this.
Example:
DefaultHeaders::Instance().addHeader("Access-Control-Allow-Origin","*");webServer.begin();
NOTE: You will still need to respond to the OPTIONS method for CORS pre-flight in most cases. (unless you are only using GET)
This is one option:
webServer.onNotFound([](AsyncWebServerRequest *request) {if (request->method() == HTTP_OPTIONS) { request->send(200); }else { request->send(404); }});With path variable you can create a custom regex rule for a specific parameter in a route.For example we want asensorId parameter in a route rule to match only a integer.
server.on("^\\/sensor\\/([0-9]+)$", HTTP_GET, [] (AsyncWebServerRequest *request) { String sensorId = request->pathArg(0); });
NOTE: All regex patterns starts with^ and ends with$
To enable thePath variable support, you have to define the buildflag-DASYNCWEBSERVER_REGEX.
For Arduino IDE create/updateplatform.local.txt:
Windows: C:\Users(username)\AppData\Local\Arduino15\packages\{espxxxx}\hardware\espxxxx\{version}\platform.local.txt
Linux: ~/.arduino15/packages/{espxxxx}/hardware/{espxxxx}/{version}/platform.local.txt
Add/Update the following line:
compiler.cpp.extra_flags=-DDASYNCWEBSERVER_REGEXFor platformio modifyplatformio.ini:
[env:myboard]build_flags = -DASYNCWEBSERVER_REGEX
NOTE: By enablingASYNCWEBSERVER_REGEX,<regex> will be included. This will add an 100k to your binary.
- Async_AdvancedWebServer
- Async_HelloServer
- Async_HelloServer2
- Async_HttpBasicAuth
- AsyncMultiWebServer
- Async_PostServer
- Async_RegexPatterns
- Async_SimpleWebServer
- MQTTClient_Auth
- MQTTClient_Basic
- MQTT_ThingStream
- WebClient
- WebClientRepeating
- Async_AdvancedWebServer_favicon
- Async_AdvancedWebServer_MemoryIssues_SendArduinoString
- Async_AdvancedWebServer_MemoryIssues_Send_CString
- Async_AdvancedWebServer_SendChunked
- AsyncWebServer_SendChunked
- Async_WebSocketsServerNew
ExampleAsync_AdvancedWebServer
AsyncWebServer_Teensy41/examples/Async_AdvancedWebServer/Async_AdvancedWebServer.ino
Lines 41 to 242 inba10e85
| #if !( defined(CORE_TEENSY) && defined(__IMXRT1062__) && defined(ARDUINO_TEENSY41) ) | |
| #error Only Teensy 4.1 supported | |
| #endif | |
| // Debug Level from 0 to 4 | |
| #define_TEENSY41_ASYNC_TCP_LOGLEVEL_1 | |
| #define_AWS_TEENSY41_LOGLEVEL_1 | |
| #defineSHIELD_TYPE"Teensy4.1 QNEthernet" | |
| #if (_AWS_TEENSY41_LOGLEVEL_ > 3) | |
| #warning Using QNEthernet lib for Teensy 4.1. Must also use Teensy Packages Patch or error | |
| #endif | |
| #defineUSING_DHCPtrue | |
| //#define USING_DHCP false | |
| #if !USING_DHCP | |
| // Set the static IP address to use if the DHCP fails to assign | |
| IPAddressmyIP(192,168,2,222); | |
| IPAddressmyNetmask(255,255,255,0); | |
| IPAddressmyGW(192,168,2,1); | |
| //IPAddress mydnsServer(192, 168, 2, 1); | |
| IPAddressmydnsServer(8,8,8,8); | |
| #endif | |
| #include"QNEthernet.h"// https://github.com/ssilverman/QNEthernet | |
| usingnamespaceqindesign::network; | |
| #include<AsyncWebServer_Teensy41.h> | |
| AsyncWebServerserver(80); | |
| int reqCount =0;// number of requests received | |
| constint led =13; | |
| voidhandleRoot(AsyncWebServerRequest *request) | |
| { | |
| digitalWrite(led,1); | |
| #defineBUFFER_SIZE400 | |
| char temp[BUFFER_SIZE]; | |
| int sec =millis() /1000; | |
| int min = sec /60; | |
| int hr = min /60; | |
| int day = hr /24; | |
| snprintf(temp, BUFFER_SIZE -1, | |
| "<html>\ | |
| <head>\ | |
| <meta http-equiv='refresh' content='5'/>\ | |
| <title>AsyncWebServer-%s</title>\ | |
| <style>\ | |
| body { background-color: #cccccc; font-family: Arial, Helvetica, Sans-Serif; Color: #000088; }\ | |
| </style>\ | |
| </head>\ | |
| <body>\ | |
| <h2>AsyncWebServer_Teensy41!</h2>\ | |
| <h3>running on %s</h3>\ | |
| <p>Uptime: %d d %02d:%02d:%02d</p>\ | |
| <img src=\"/test.svg\" />\ | |
| </body>\ | |
| </html>", BOARD_NAME, BOARD_NAME, day, hr %24, min %60, sec %60); | |
| request->send(200,"text/html", temp); | |
| digitalWrite(led,0); | |
| } | |
| voidhandleNotFound(AsyncWebServerRequest *request) | |
| { | |
| digitalWrite(led,1); | |
| String message ="File Not Found\n\n"; | |
| message +="URI:"; | |
| message += request->url(); | |
| message +="\nMethod:"; | |
| message += (request->method() == HTTP_GET) ?"GET" :"POST"; | |
| message +="\nArguments:"; | |
| message += request->args(); | |
| message +="\n"; | |
| for (uint8_t i =0; i < request->args(); i++) | |
| { | |
| message +="" + request->argName(i) +":" + request->arg(i) +"\n"; | |
| } | |
| request->send(404,"text/plain", message); | |
| digitalWrite(led,0); | |
| } | |
| voiddrawGraph(AsyncWebServerRequest *request) | |
| { | |
| String out; | |
| out.reserve(4000); | |
| char temp[70]; | |
| out +="<svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" width=\"310\" height=\"150\">\n"; | |
| out +="<rect width=\"310\" height=\"150\" fill=\"rgb(250, 230, 210)\" stroke-width=\"2\" stroke=\"rgb(0, 0, 0)\" />\n"; | |
| out +="<g stroke=\"blue\">\n"; | |
| int y =rand() %130; | |
| for (int x =10; x <300; x +=10) | |
| { | |
| int y2 =rand() %130; | |
| sprintf(temp,"<line x1=\"%d\" y1=\"%d\" x2=\"%d\" y2=\"%d\" stroke-width=\"2\" />\n", x,140 - y, x +10,140 - y2); | |
| out += temp; | |
| y = y2; | |
| } | |
| out +="</g>\n</svg>\n"; | |
| request->send(200,"image/svg+xml", out); | |
| } | |
| voidsetup() | |
| { | |
| pinMode(led, OUTPUT); | |
| digitalWrite(led,0); | |
| Serial.begin(115200); | |
| while (!Serial &&millis() <5000); | |
| delay(200); | |
| Serial.print("\nStart Async_AdvancedWebServer on"); | |
| Serial.print(BOARD_NAME); | |
| Serial.print(" with"); | |
| Serial.println(SHIELD_TYPE); | |
| Serial.println(ASYNC_WEBSERVER_TEENSY41_VERSION); | |
| delay(500); | |
| #if USING_DHCP | |
| // Start the Ethernet connection, using DHCP | |
| Serial.print("Initialize Ethernet using DHCP =>"); | |
| Ethernet.begin(); | |
| #else | |
| // Start the Ethernet connection, using static IP | |
| Serial.print("Initialize Ethernet using static IP =>"); | |
| Ethernet.begin(myIP, myNetmask, myGW); | |
| Ethernet.setDNSServerIP(mydnsServer); | |
| #endif | |
| if (!Ethernet.waitForLocalIP(5000)) | |
| { | |
| Serial.println(F("Failed to configure Ethernet")); | |
| if (!Ethernet.linkStatus()) | |
| { | |
| Serial.println(F("Ethernet cable is not connected.")); | |
| } | |
| // Stay here forever | |
| while (true) | |
| { | |
| delay(1); | |
| } | |
| } | |
| else | |
| { | |
| Serial.print(F("Connected! IP address:")); | |
| Serial.println(Ethernet.localIP()); | |
| } | |
| #if USING_DHCP | |
| delay(1000); | |
| #else | |
| delay(2000); | |
| #endif | |
| server.on("/", HTTP_GET, [](AsyncWebServerRequest * request) | |
| { | |
| handleRoot(request); | |
| }); | |
| server.on("/test.svg", HTTP_GET, [](AsyncWebServerRequest * request) | |
| { | |
| drawGraph(request); | |
| }); | |
| server.on("/inline", [](AsyncWebServerRequest * request) | |
| { | |
| request->send(200,"text/plain","This works as well"); | |
| }); | |
| server.onNotFound(handleNotFound); | |
| server.begin(); | |
| Serial.print(F("HTTP EthernetWebServer is @ IP :")); | |
| Serial.println(Ethernet.localIP()); | |
| } | |
| voidloop() | |
| { | |
| } |
You can access the Async Advanced WebServer @ the server IP
or usingAsync_AdvancedWebServer_favicon withfavicon
Following are debug terminal output and screen shots when running exampleAsync_AdvancedWebServer on Teensy4.1 using Built-in Ethernet and QNEthernet Library demonstrate the operation of AsyncWebServer.
Start Async_AdvancedWebServer on TEENSY4.1 with Teensy4.1 QNEthernetAsyncWebServer_Teensy41 v1.7.0Initialize Ethernetusing DHCP => Connected! IP address:192.168.2.107HTTP EthernetWebServer is @ IP :192.168.2.107
Following is debug terminal output when running exampleWebClient on Teensy4.1 using Built-in Ethernet and QNEthernet Library.
Start WebClient on TEENSY4.1 with Teensy4.1 QNEthernetAsyncWebServer_Teensy41 v1.7.0Initialize Ethernetusing DHCP => Connected! IP address:192.168.2.107Starting connection to server...Connected to serverHTTP/1.1200 OKServer: nginx/1.4.2Date: Fri,18 Mar202214:44:27 GMTContent-Type: text/plainContent-Length:2317Last-Modified: Thu,24 Feb202211:33:32 GMTConnection: closeVary: Accept-EncodingETag:"62176d0c-90d"Accept-Ranges: bytesPlease use http://arduino.tips/asciilogo.txt via HTTP `:;;;,` .:;;:. .;;;;;;;;;;;` :;;;;;;;;;;: TM `;;;;;;;;;;;;;;;` :;;;;;;;;;;;;;;; :;;;;;;;;;;;;;;;;;; `;;;;;;;;;;;;;;;;;; ;;;;;;;;;;;;;;;;;;;;; .;;;;;;;;;;;;;;;;;;;; ;;;;;;;;:` `;;;;;;;;; ,;;;;;;;;.` .;;;;;;;; .;;;;;;, :;;;;;;; .;;;;;;; ;;;;;;; ;;;;;; ;;;;;;; ;;;;;;, ;;;;;;. ,;;;;; ;;;;;;.;;;;;;` ;;;;;; ;;;;;. ;;;;;;;;;;;` ``` ;;;;;` ;;;;; ;;;;;;;;;, ;;; .;;;;;`;;;;: `;;;;;;;; ;;; ;;;;;,;;;;` `,,,,,,,, ;;;;;;; .,,;;;,,, ;;;;;:;;;;` .;;;;;;;; ;;;;;, :;;;;;;;; ;;;;;:;;;;` .;;;;;;;; `;;;;;; :;;;;;;;; ;;;;;.;;;;. ;;;;;;;. ;;; ;;;;; ;;;;; ;;;;;;;;; ;;; ;;;;; ;;;;; .;;;;;;;;;; ;;; ;;;;;, ;;;;;; `;;;;;;;;;;;; ;;;;; `;;;;;, .;;;;;; ;;;;;;; ;;;;;; ;;;;;;: :;;;;;;. ;;;;;;; ;;;;;; ;;;;;;;` .;;;;;;;, ;;;;;;;; ;;;;;;;: ;;;;;;;;;:,:;;;;;;;;;: ;;;;;;;;;;:,;;;;;;;;;; `;;;;;;;;;;;;;;;;;;;. ;;;;;;;;;;;;;;;;;;;; ;;;;;;;;;;;;;;;;; :;;;;;;;;;;;;;;;;: ,;;;;;;;;;;;;;, ;;;;;;;;;;;;;; .;;;;;;;;;` ,;;;;;;;;: ;;; ;;;;;` ;;;;: .;; ;; ,;;;;;, ;;. `;, ;;;; ;;; ;;:;;; ;;;;;; .;; ;; ,;;;;;: ;;; `;, ;;;:;; ,;:; ;; ;; ;; ;; .;; ;; ,;, ;;;,`;, ;; ;; ;; ;: ;; ;; ;; ;; .;; ;; ,;, ;;;;`;, ;; ;;. ;: ;; ;;;;;: ;; ;; .;; ;; ,;, ;;`;;;, ;; ;;` ,;;;;; ;;`;; ;; ;; .;; ;; ,;, ;; ;;;, ;; ;; ;; ,;, ;; .;; ;;;;;: ;;;;;: ,;;;;;: ;; ;;, ;;;;;; ;; ;; ;; ;;` ;;;;. `;;;: ,;;;;;, ;; ;;, ;;;; Disconnecting from server...
Following is debug terminal output when running exampleMQTTClient_Auth on Teensy4.1 using Built-in Ethernet and QNEthernet Library.
Start MQTTClient_Auth on TEENSY4.1 with Teensy4.1 QNEthernetAsyncWebServer_Teensy41 v1.7.0Initialize Ethernetusing DHCP => Connected! IP address:192.168.2.107Attempting MQTT connection to broker.emqx.io...connectedMessage Send : MQTT_Pub => Hello from MQTTClient_Auth on TEENSY4.1 with Teensy4.1 QNEthernetMessage arrived [MQTT_Pub] Hello from MQTTClient_Auth on TEENSY4.1 with Teensy4.1 QNEthernetMessage Send : MQTT_Pub => Hello from MQTTClient_Auth on TEENSY4.1 with Teensy4.1 QNEthernetMessage arrived [MQTT_Pub] Hello from MQTTClient_Auth on TEENSY4.1 with Teensy4.1 QNEthernetMessage Send : MQTT_Pub => Hello from MQTTClient_Auth on TEENSY4.1 with Teensy4.1 QNEthernetMessage arrived [MQTT_Pub] Hello from MQTTClient_Auth on TEENSY4.1 with Teensy4.1 QNEthernet
Following is debug terminal output when running exampleMQTTClient_Basic on Teensy4.1 using Built-in Ethernet and QNEthernet Library.
Start MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetAsyncWebServer_Teensy41 v1.7.0Initialize Ethernetusing DHCP => Connected! IP address:192.168.2.107Attempting MQTT connection to broker.emqx.io...connectedMessage Send : MQTT_Pub => Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage arrived [MQTT_Pub] Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage Send : MQTT_Pub => Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage arrived [MQTT_Pub] Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage Send : MQTT_Pub => Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage arrived [MQTT_Pub] Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage Send : MQTT_Pub => Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage arrived [MQTT_Pub] Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage Send : MQTT_Pub => Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage arrived [MQTT_Pub] Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage Send : MQTT_Pub => Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage arrived [MQTT_Pub] Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage Send : MQTT_Pub => Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernetMessage arrived [MQTT_Pub] Hello from MQTTClient_Basic on TEENSY4.1 with Teensy4.1 QNEthernet
Following is debug terminal output when running exampleMQTT_ThingStream on Teensy4.1 using Built-in Ethernet and QNEthernet Library.
Start MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernetAsyncWebServer_Teensy41 v1.7.0Initialize Ethernetusing DHCP => Connected! IP address:192.168.2.107***************************************Teensy41_Pub***************************************Attempting MQTT connection to broker.emqx.io...connectedPublished connection message successfully!Subscribed to: Teensy41_SubMQTT Message Send : Teensy41_Pub => Hello from MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernetMQTT Message receive [Teensy41_Pub] Hello from MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernetMQTT Message Send : Teensy41_Pub => Hello from MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernetMQTT Message receive [Teensy41_Pub] Hello from MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernetMQTT Message Send : Teensy41_Pub => Hello from MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernetMQTT Message receive [Teensy41_Pub] Hello from MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernetMQTT Message Send : Teensy41_Pub => Hello from MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernetMQTT Message receive [Teensy41_Pub] Hello from MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernetMQTT Message Send : Teensy41_Pub => Hello from MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernetMQTT Message receive [Teensy41_Pub] Hello from MQTT_ThingStream on TEENSY4.1 with Teensy4.1 QNEthernet
Following is the debug terminal and screen shot when running exampleAsync_AdvancedWebServer_MemoryIssues_Send_CString, onTeensy4.1 QNEthernet, to demonstrate the new and powerfulHEAP-saving feature
Start Async_AdvancedWebServer_MemoryIssues_Send_CString on TEENSY4.1 with Teensy4.1 QNEthernetAsyncWebServer_Teensy41 v1.7.0HEAP DATA - Start => Free heap:483328 Used heap:0Initialize Ethernetusing DHCP => Connected! IP address:192.168.2.83HTTP EthernetWebServer is @ IP :192.168.2.83HEAP DATA - Pre Create Arduino String Free heap:442368 Used heap:40960.HEAP DATA - Pre Send Free heap:438272 Used heap:45056HEAP DATA - Post Send Free heap:421888 Used heap:61440......Out String Length=31243.....
While usingArduino String, the HEAP usage is very large
Async_AdvancedWebServer_MemoryIssues_SendArduinoString ===> larger heap (65,536 bytes) while buffer len is only 12K Bytes
Start Async_AdvancedWebServer_MemoryIssues_SendArduinoString on TEENSY4.1 with Teensy4.1 QNEthernetAsyncWebServer_Teensy41 v1.7.0HEAP DATA - Start => Free heap:483328 Used heap:0Initialize Ethernetusing DHCP => Connected! IP address:192.168.2.83HTTP EthernetWebServer is @ IP :192.168.2.83.HEAP DATA - Pre Send Free heap:438272 Used heap:45056HEAP DATA - Post Send Free heap:417792 Used heap:65536......Out String Length=11191... ...Out String Length=11233....... Out String Length=11192.......Out String Length=11204... ...Out String Length=11214
You can access the Async Advanced WebServers at the displayed server IP, e.g.192.168.2.83
Following is debug terminal output when running exampleAsync_AdvancedWebServer_SendChunked onTeensy4.1 using Built-in Ethernet andQNEthernet Library, to demo how to usebeginChunkedResponse() to send largehtml in chunks
Start Async_AdvancedWebServer_SendChunked on TEENSY4.1 with Teensy4.1 QNEthernetAsyncWebServer_Teensy41 v1.7.0Initialize Ethernetusing DHCP => Connected! IP address:192.168.2.92AsyncWebServer is @ IP :192.168.2.92.[AWS] Total length to send in chunks =31235[AWS] Bytes sent in chunk =5716[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =2191[AWS] Bytes sent in chunk =0[AWS] Total length to send in chunks =31238[AWS] Bytes sent in chunk =5716[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =2194[AWS] Bytes sent in chunk =0.[AWS] Total length to send in chunks =31243[AWS] Bytes sent in chunk =5716[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =2199[AWS] Bytes sent in chunk =0[AWS] Total length to send in chunks =31263[AWS] Bytes sent in chunk =5716[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832.[AWS] Total length to send in chunks =31233[AWS] Bytes sent in chunk =5716[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =2189[AWS] Bytes sent in chunk =0[AWS] Total length to send in chunks =31226[AWS] Bytes sent in chunk =5716[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =2182[AWS] Bytes sent in chunk =0
You can access the Async Advanced WebServers @ the server IP
Following is debug terminal output when running exampleAsyncWebServer_SendChunked onTeensy4.1 using Built-in Ethernet andQNEthernet Library, to demo how to usebeginChunkedResponse() to send largehtml in chunks
Start AsyncWebServer_SendChunked on TEENSY4.1 with Teensy4.1 QNEthernetAsyncWebServer_Teensy41 v1.7.0Initialize Ethernetusing DHCP => Connected! IP address:192.168.2.92AsyncWebServer is @ IP :192.168.2.92.[AWS] Total length to send in chunks =46302[AWS] Bytes sent in chunk =5720[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5590[AWS] Bytes sent in chunk =0[AWS] Total length to send in chunks =46302[AWS] Bytes sent in chunk =5720[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5590[AWS] Bytes sent in chunk =0.[AWS] Total length to send in chunks =46302[AWS] Bytes sent in chunk =5720[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5590[AWS] Bytes sent in chunk =0[AWS] Total length to send in chunks =46302[AWS] Bytes sent in chunk =5720[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5832[AWS] Bytes sent in chunk =5590[AWS] Bytes sent in chunk =0
Following is debug terminal output when running exampleAsync_WebSocketsServer onTeensy4.1 using Built-in Ethernet andQNEthernet Library, to demo how to use to demo how to useAsync_WebSockets. The Client is usingWSClient.py
Starting Async_WebSocketsServer on TEENSY4.1 with Teensy4.1 QNEthernetAsyncWebServer_Teensy41 v1.7.0Initialize Ethernetusing DHCP => Connected! IP address:192.168.2.119ws[Server: /ws][ClientID:1] WSClient connectedws[Server: /ws][ClientID:1] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:1] WSClient disconnectedws[Server: /ws][ClientID:2] WSClient connectedws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] WSClient disconnectedws[Server: /ws][ClientID:3] WSClient connectedws[Server: /ws][ClientID:3] text-message[len:13]: Hello, Server
Debug is enabled by default on Serial. Debug Level from 0 to 4. To disable, change theAWS_TEENSY41_LOGLEVEL to 0
// Use this to output debug msgs to Serial#defineASYNCWEBSERVER_TEENSY41_DEBUG_PORT Serial// Debug Level from 0 to 4#define_TEENSY41_ASYNC_TCP_LOGLEVEL_1#define_AWS_TEENSY41_LOGLEVEL_1
If you get compilation errors, more often than not, you may need to install a newer version of Arduino IDE, the ArduinoTeensyduino core or depending libraries.
Sometimes, the library will only work if you update theTeensyduino core to the latest version because I'm always using the latest cores /libraries.
Submit issues to:AsyncWebServer_Teensy41 issues
- Fix bug. Add enhancement
- Initial porting and coding forTeensy 4.1 using built-in QNEthernet
- Add more examples.
- Add debugging features.
- Add Authentication support (MD5, SHA1).
- Add Table-of-Contents and Version String
- Fix issue with slow browsers or network. CheckTarget stops responding after variable time when using Firefox on Windows 10 #3
- Add functions and example
Async_AdvancedWebServer_faviconto supportfavicon.ico - Support using
CStringto save heap to sendvery large data. Checkrequest->send(200, textPlainStr, jsonChartDataCharStr); - Without using String Class - to save heap #8 - Add examplesAsync_AdvancedWebServer_SendChunked andAsyncWebServer_SendChunked to demo how to use
beginChunkedResponse()to send largehtmlin chunks - Use
allman astyleand addutils - Add examplesAsync_WebSocketsServer to demo how to use
Async_WebSockets - Fix
onUpload bug. CheckAsyncWebServer_Teensy41 bug onUpload
- Based on and modified fromHristo Gochkov's ESPAsyncWebServer. Many thanks toHristo Gochkov for greatESPAsyncWebServer Library
- Thanks tosalasidis akars77can to discuss and make the following
marvellousPRs inPortenta_H7_AsyncWebServer library
- request->send(200, textPlainStr, jsonChartDataCharStr); - Without using String Class - to save heap #8, leading to
v1.6.0to support usingCStringto save heap to sendvery large data - All memmove() removed - string no longer destroyed #11, leading to
v1.6.0to removememmove()and not to destroy String anymore
- Thanks toE. van Putten /Shuptuu to make the following PR inFix file upload handler by adjusting function signatures #9 leading to
v1.7.0
![]() ⭐️⭐️ Hristo Gochkov | ![]() ⭐️ salasidis | ![]() E. van Putten |
If you want to contribute to this project:
- Report bugs and errors
- Ask for enhancements
- Create issues and pull requests
- Tell other people about this library
- The library is licensed underGPLv3
Copyright (c) 2016- Hristo Gochkov
Copyright (c) 2022- Khoi Hoang
About
Async HTTP/WebSocket Server Library for Teensy 4.1 using QNEthernet. This library is one of the Async libraries to support T4.1, such as AsyncHTTPRequest_Generic, AsyncHTTPSRequest_Generic, AsyncMQTT_Generic, AsyncWebServer_Teensy41, AsyncUDP_Teensy41, AsyncDNSServer_Teensy41, etc. Now supporting using CString to save heap to send very large data
Topics
Resources
License
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors3
Uh oh!
There was an error while loading.Please reload this page.






