Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Feb 4, 2023. It is now read-only.

Asynchronous WebServer Library for RASPBERRY_PI_PICO_W using CYW43439 WiFi with arduino-pico core. This library, which is relied on AsyncTCP_RP2040W, is part of a series of advanced Async libraries for RP2040W, such as AsyncTCP_RP2040W, AsyncUDP_RP2040W, AsyncWebServer_RP2040W, AsyncHTTPRequest_RP2040W, AsyncHTTPSRequest_RP2040W, etc. Now can di…

License

NotificationsYou must be signed in to change notification settings

khoih-prog/AsyncWebServer_RP2040W

Repository files navigation

arduino-library-badgeGitHub releasecontributions welcomeGitHub issues

Donate to my libraries using BuyMeACoffee

Table of contents

Important Note from v1.4.0

The newv1.4.0+ has added a new and powerful feature to useLittleFS functions, such as AsyncFSWebServer

Check these new examples

  1. AsyncFSWebServer
  2. AsyncFSWebServer_Complex

Important Note from v1.2.0

The newv1.2.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

and these new examples

  1. Async_AdvancedWebServer_MemoryIssues_Send_CString
  2. Async_AdvancedWebServer_MemoryIssues_SendArduinoString

If using Arduino String, to send a buffer around 30 KBytes, the usedMax Heap is around75,264 bytes

If using CString in regular memory, with the same 30 KBytes, the usedMax Heap is around44,000 bytes, saving around a buffer size (30 KBytes)

This is very critical in use-cases where sendingvery large data is necessary, withoutheap-allocation-error.

  1. The traditional function used to sendArduino String is

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 about3 times of the String size

  1. To useCString with copying while sending. Use function

voidsend(int code,const String& contentType,constchar *content,bool nonDetructiveSend =true);// RSMOD

voidsend(int code,const String& contentType,constchar *content,bool nonDetructiveSend =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 thisunefficient way.

  1. To useCString without copying while sending. Use function

voidsend(int code,const String& contentType,constchar *content,bool nonDetructiveSend =true);// RSMOD

voidsend(int code,const String& contentType,constchar *content,bool nonDetructiveSend =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

Features

This library is based on, modified from:

  1. Hristo Gochkov's ESPAsyncWebServer

to apply the better and fasterasynchronous feature of thepowerfulESPAsyncWebServer Library intoRASPBERRY_PI_PICO_W. ThusAsyncWebServer_RP2040W is part of a series of advanced Async libraries, such as AsyncTCP_RP2040W, AsyncUDP_RP2040W, AsyncWebServer_RP2040W, AsyncHTTPRequest_RP2040W, AsyncHTTPSRequest_RP2040W, etc. to be written or modified to supportRASPBERRY_PI_PICO_W, usingCYW43439 WiFi.

Why Async is better

  • 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

Currently supported Boards

  1. RASPBERRY_PI_PICO_W with CYW43439 WiFi usingarduino-pico core v2.4.0+

Prerequisites

  1. Arduino IDE 1.8.19+ for Arduino.GitHub release
  2. Earle Philhower's arduino-pico core v2.7.1+ forRASPBERRY_PI_PICO_W with CYW43439 WiFi, etc.GitHub release
  3. AsyncTCP_RP2040W library v1.1.0+ for RASPBERRY_PI_PICO_W with CYW43439 WiFi.GitHub release
  4. AsyncMQTT_Generic library v1.8.1+ to use with some examples.GitHub release

Installation

Use Arduino Library Manager

The best and easiest way is to useArduino Library Manager. Search forAsyncWebServer_RP2040W, then select / install the latest version. You can also use this linkarduino-library-badge for more detailed instructions.

Manual Install

  1. Navigate toAsyncWebServer_RP2040W page.
  2. Download the latest releaseAsyncWebServer_RP2040W-main.zip.
  3. Extract the zip file toAsyncWebServer_RP2040W-main directory
  4. Copy the wholeAsyncWebServer_RP2040W-main folder to Arduino libraries' directory such as~/Arduino/libraries/.

VS Code & PlatformIO:

  1. InstallVS Code
  2. InstallPlatformIO
  3. InstallAsyncWebServer_RP2040W library by usingLibrary Manager. Search forAsyncWebServer_RP2040W inPlatform.io Author's Libraries
  4. 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

Important things to remember

  • This is fully asynchronous server and as such does not run on theloop() thread.
  • You can not useyield() 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

Principles of operation

The Async Web server

  • Listens for connections
  • Wraps the new clients intoRequest
  • Keeps track of clients and cleans memory
  • ManagesRewrites and apply them on the request url
  • ManagesHandlers and attaches them to Requests

Request Life Cycle

  • TCP connection is received by the server
  • The connection is wrapped insideRequest object
  • When the request head is received (type, url, get params, http version and host),the server goes through allRewrites (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 onethatcanHandle the given request. If none are found, the default(catch-all) handler is attached.
  • The rest of the request is received, calling thehandleUpload orhandleBody methods of theHandler if they are needed (POST+File/Body)
  • When the whole request is parsed, the result is given to thehandleRequest method of theHandler and is ready to be responded to
  • In thehandleRequest method, to theRequest is attached aResponse object (see below) that will serve the response data back to the client
  • When theResponse is sent, the client is closed and freed from the memory

Rewrites and how do they work

  • TheRewrites are used to rewrite the request url and/or inject get parameters for a specific request url path.
  • AllRewrites are evaluated on the request in the order they have been added to the server.
  • TheRewrite will change the request url only if the request url (excluding get parameters) is fully matchthe rewrite url, and when the optionalFilter callback return true.
  • Setting aFilter to theRewrite enables 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.
  • TheRewrite can specify a target url with optional get parameters, e.g./to-url?with=params

Handlers and how do they work

  • TheHandlers are used for executing specific actions to particular requests
  • OneHandler instance can be attached to any request and lives together with the server
  • Setting aFilter to theHandler enables 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.
  • ThecanHandle method is used for handler specific control on whether the requests can be handledand for declaring any interesting headers that theRequest should parse. Decision can be based on requestmethod, request url, http version, request host/port/target host and get parameters
  • Once aHandler is attached to givenRequest (canHandle returned true)thatHandler takes care to receive any file/data upload and attach aResponseonce theRequest has been fully parsed
  • Handlers are evaluated in the order they are attached to the server. ThecanHandle is called onlyif theFilter that was set to theHandler return true.
  • The firstHandler that can handle the request is selected, not furtherFilter andcanHandle are called.

Responses and how do they work

  • TheResponse objects are used to send the response data back to the client
  • TheResponse object lives with theRequest and 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

Template processing

  • AsyncWebServer_RP2040W 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 Variables

Common Variables

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"

Headers

//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());}

GET, POST and FILE parameters

//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");

JSON body handling with ArduinoJson

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);

Responses

Redirect to another URL

//to local urlrequest->redirect("/login");//to external urlrequest->redirect("http://esp8266.com");

Basic response with HTTP Code

request->send(404);//Sends 404 File Not Found

Basic response with HTTP Code and extra headers

AsyncWebServerResponse *response = request->beginResponse(404);//Sends 404 File Not Foundresponse->addHeader("Server","AsyncWebServer_RP2040W");request->send(response);

Basic response with string content

request->send(200,"text/plain","Hello World!");

Basic response with string content and extra headers

AsyncWebServerResponse *response = request->beginResponse(200,"text/plain","Hello World!");response->addHeader("Server","AsyncWebServer");request->send(response);

Respond with content coming from a Stream

//read 12 bytes from Serial and send them as Content Type text/plainrequest->send(Serial,"text/plain",12);

Respond with content coming from a Stream and extra headers

//read 12 bytes from Serial and send them as Content Type text/plainAsyncWebServerResponse *response = request->beginResponse(Serial,"text/plain",12);response->addHeader("Server","AsyncWebServer_RP2040W");request->send(response);

Respond with content coming from a Stream containing templates

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);

Respond with content coming from a Stream containing templates and extra headers

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_RP2040W");request->send(response);

Respond with content using a callback

//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);});

Respond with content using a callback and extra headers

//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_RP2040W");request->send(response);

Respond with content using a callback containing templates

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);

Respond with content using a callback containing templates and extra headers

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_RP2040W");request->send(response);

Chunked 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_RP2040W");request->send(response);

Chunked Response containing templates

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_RP2040W");request->send(response);

Print to response

AsyncResponseStream *response = request->beginResponseStream("text/html");response->addHeader("Server","AsyncWebServer_RP2040W");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);

ArduinoJson Basic 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);

ArduinoJson Advanced 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);

Param Rewrite With Matching

It is possible to rewrite the request url with parameter matchg. Here is an example with one parameter:Rewrite for example "/radio/{frequence}" -> "/radio?f={frequence}"

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/{frequence}","/radio?f={frequence}") );

Using filters

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.

Bad Responses

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

Respond with content using a callback without content length to HTTP/1.0 clients

//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);});

Async WebSocket Plugin

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

Async WebSocket Event

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");        }      }    }  }}

Methods for sending data to a socket client

//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);

Direct access to web socket message buffer

When sending awebsocket 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 anArduinoJson 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);    }  }}

Limiting the number of web socket clients

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();}

Async Event Source Plugin

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.

Setup Event Source on the server

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());  }}

Setup Event Source in the browser

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);}

Remove handlers and rewrites

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();

Setting up the server

#if !( defined(ARDUINO_RASPBERRY_PI_PICO_W) )  #error For RASPBERRY_PI_PICO_W only#endif#include<AsyncWebServer_RP2040W.h>char ssid[] ="your_ssid";// your network SSID (name)char pass[] ="12345678";// your network password (use for WPA, or use as key for WEP), length must be 8+int status = WL_IDLE_STATUS;AsyncWebServerserver(80);#defineLED_OFF             LOW#defineLED_ON              HIGH#defineBUFFER_SIZE64char temp[BUFFER_SIZE];voidhandleRoot(AsyncWebServerRequest *request){digitalWrite(LED_BUILTIN, LED_ON);snprintf(temp, BUFFER_SIZE -1,"Hello from Async_HelloServer on %s\n", BOARD_NAME);  request->send(200,"text/plain", temp);digitalWrite(LED_BUILTIN, LED_OFF);}voidhandleNotFound(AsyncWebServerRequest *request){digitalWrite(LED_BUILTIN, LED_ON);    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_BUILTIN, LED_OFF);}voidprintWifiStatus(){// print the SSID of the network you're attached to:  Serial.print("SSID:");  Serial.println(WiFi.SSID());// print your board's IP address:  IPAddress ip = WiFi.localIP();  Serial.print("Local IP Address:");  Serial.println(ip);// print the received signal strength:long rssi = WiFi.RSSI();  Serial.print("signal strength (RSSI):");  Serial.print(rssi);  Serial.println(" dBm");}voidsetup(){pinMode(LED_BUILTIN, OUTPUT);digitalWrite(LED_BUILTIN, LED_OFF);  Serial.begin(115200);while (!Serial);delay(200);  Serial.print("\nStart Async_HelloServer on"); Serial.print(BOARD_NAME);  Serial.print(" with"); Serial.println(SHIELD_TYPE);  Serial.println(ASYNCTCP_RP2040W_VERSION);  Serial.println(ASYNC_WEBSERVER_RP2040W_VERSION);///////////////////////////////////// check for the WiFi module:if (WiFi.status() == WL_NO_MODULE)  {    Serial.println("Communication with WiFi module failed!");// don't continuewhile (true);  }  Serial.print(F("Connecting to SSID:"));  Serial.println(ssid);  status = WiFi.begin(ssid, pass);delay(1000);// attempt to connect to WiFi networkwhile ( status != WL_CONNECTED)  {delay(500);// Connect to WPA/WPA2 network    status = WiFi.status();  }printWifiStatus();///////////////////////////////////  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(WiFi.localIP());}voidheartBeatPrint(){staticint num =1;  Serial.print(F("."));if (num ==80)  {    Serial.println();    num =1;  }elseif (num++ %10 ==0)  {    Serial.print(F(""));  }}voidcheck_status(){staticunsignedlong checkstatus_timeout =0;#defineSTATUS_CHECK_INTERVAL10000L// Send status report every STATUS_REPORT_INTERVAL (60) seconds: we don't need to send updates frequently if there is no status change.if ((millis() > checkstatus_timeout) || (checkstatus_timeout ==0))  {heartBeatPrint();    checkstatus_timeout =millis() + STATUS_CHECK_INTERVAL;  }}voidloop(){check_status();}

Setup global and class functions as request handlers

#if !( defined(ARDUINO_RASPBERRY_PI_PICO_W) )  #error For RASPBERRY_PI_PICO_W only#endif#include<Arduino.h>#include<AsyncWebServer_RP2040W.h>char ssid[] ="your_ssid";// your network SSID (name)char pass[] ="12345678";// your network password (use for WPA, or use as key for WEP), length must be 8+int status = WL_IDLE_STATUS;#include<functional>...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() {}

Methods for controlling websocket connections

// Disable client connections if it was activatedif ( ws.enabled() )  ws.enable(false);// enable client connections if it was disabledif ( !ws.enabled() )  ws.enable(true);

Adding Default Headers

In some cases, such as when working withCORS, 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).TheDefaultHeaders 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);  }});

Path variable

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\{xxxx}\hardware\xxxx\{version}\platform.local.txt

Linux: ~/.arduino15/packages/{xxxx}/hardware/{xxxx}/{version}/platform.local.txt

Add/Update the following line:

compiler.cpp.extra_flags=-DDASYNCWEBSERVER_REGEX

For 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.

Examples

  1. Async_AdvancedWebServer
  2. Async_HelloServer
  3. Async_HelloServer2
  4. Async_HttpBasicAuth
  5. Async_PostServer
  6. MQTTClient_Auth
  7. MQTTClient_Basic
  8. MQTT_ThingStream
  9. WebClient
  10. WebClientRepeating
  11. Async_AdvancedWebServer_Country
  12. Async_AdvancedWebServer_favicon
  13. Async_AdvancedWebServer_MemoryIssues_SendArduinoString
  14. Async_AdvancedWebServer_MemoryIssues_Send_CString
  15. Async_WebSocketsServer
  16. Async_WebSocketsServer_Xtreme
  17. AsyncFSWebServer
  18. AsyncFSWebServer_Complex
  19. Async_AdvancedWebServer_SendChunked
  20. AsyncWebServer_SendChunked
  21. AsyncWebServer_MQTT_RP2040WNew
  22. Async_AdvancedWebServer_SendChunked_MQTTNew

// See the list of country codes in
// https://github.com/earlephilhower/cyw43-driver/blob/02533c10a018c6550e9f66f7699e21356f5e4609/src/cyw43_country.h#L59-L111
// To modify https://github.com/earlephilhower/arduino-pico/blob/master/variants/rpipicow/picow_init.cpp
// Check https://github.com/khoih-prog/AsyncWebServer_RP2040W/issues/3#issuecomment-1255676644
#if !( defined(ARDUINO_RASPBERRY_PI_PICO_W) )
#error For RASPBERRY_PI_PICO_W only
#endif
#define_RP2040W_AWS_LOGLEVEL_1
///////////////////////////////////////////////////////////////////
#include<pico/cyw43_arch.h>
///////////////////////////////////////////////////////////////////
#include<AsyncWebServer_RP2040W.h>
char ssid[] ="your_ssid";// your network SSID (name)
char pass[] ="12345678";// your network password (use for WPA, or use as key for WEP), length must be 8+
int status = WL_IDLE_STATUS;
AsyncWebServerserver(80);
int reqCount =0;// number of requests received
#defineLED_OFF LOW
#defineLED_ON HIGH
#defineBUFFER_SIZE512
char temp[BUFFER_SIZE];
voidhandleRoot(AsyncWebServerRequest *request)
{
staticuint32_t pageCount =0;
staticuint32_t maxfreeHeap =0;
staticuint32_t minFreeHeap =0xFFFFFFFF;
uint32_t curFreeHeap = rp2040.getFreeHeap();
if (maxfreeHeap < curFreeHeap)
maxfreeHeap = curFreeHeap;
if (minFreeHeap > curFreeHeap)
minFreeHeap = curFreeHeap;
digitalWrite(LED_BUILTIN, LED_ON);
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_RP2040W!</h2>\
<h3>running WiFi on %s</h3>\
<p>Uptime: %d d %02d:%02d:%02d, pageCount: %lu</p>\
<p>Heap Free: %lu, Max: %lu, Min: %lu</p>\
<img src=\"/test.svg\" />\
</body>\
</html>", BOARD_NAME, BOARD_NAME, day, hr %24, min %60, sec %60, ++pageCount, curFreeHeap, maxfreeHeap, minFreeHeap);
request->send(200,"text/html", temp);
digitalWrite(LED_BUILTIN, LED_OFF);
}
voidhandleNotFound(AsyncWebServerRequest *request)
{
digitalWrite(LED_BUILTIN, LED_ON);
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_BUILTIN, LED_OFF);
}
voiddrawGraph(AsyncWebServerRequest *request)
{
String out;
out.reserve(4000);
char temp[70];
digitalWrite(LED_BUILTIN, LED_ON);
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);
digitalWrite(LED_BUILTIN, LED_OFF);
}
voidprintWifiStatus()
{
// print the SSID of the network you're attached to:
Serial.print("SSID:");
Serial.println(WiFi.SSID());
// print your board's IP address:
IPAddress ip = WiFi.localIP();
Serial.print("Local IP Address:");
Serial.println(ip);
// print your board's country code
// #define CYW43_COUNTRY(A, B, REV) ((unsigned char)(A) | ((unsigned char)(B) << 8) | ((REV) << 16))
uint32_t myCountryCode =cyw43_arch_get_country_code();
char countryCode[3] = {0,0,0 };
countryCode[0] = myCountryCode &0xFF;
countryCode[1] = (myCountryCode >>8) &0xFF;
Serial.print("Country code:");
Serial.println(countryCode);
}
voidsetup()
{
pinMode(LED_BUILTIN, OUTPUT);
digitalWrite(LED_BUILTIN, LED_OFF);
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(ASYNCTCP_RP2040W_VERSION);
Serial.println(ASYNC_WEBSERVER_RP2040W_VERSION);
///////////////////////////////////
// check for the WiFi module:
if (WiFi.status() == WL_NO_MODULE)
{
Serial.println("Communication with WiFi module failed!");
// don't continue
while (true);
}
Serial.print(F("Connecting to SSID:"));
Serial.println(ssid);
status = WiFi.begin(ssid, pass);
delay(1000);
// attempt to connect to WiFi network
while ( status != WL_CONNECTED)
{
delay(500);
// Connect to WPA/WPA2 network
status = WiFi.status();
}
printWifiStatus();
///////////////////////////////////
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("AsyncWebServer is @ IP :"));
Serial.println(WiFi.localIP());
}
voidheartBeatPrint()
{
staticint num =1;
Serial.print(F("."));
if (num ==80)
{
Serial.println();
num =1;
}
elseif (num++ %10 ==0)
{
Serial.print(F(""));
}
}
voidcheck_status()
{
staticunsignedlong checkstatus_timeout =0;
#defineSTATUS_CHECK_INTERVAL10000L
// Send status report every STATUS_REPORT_INTERVAL (60) seconds: we don't need to send updates frequently if there is no status change.
if ((millis() > checkstatus_timeout) || (checkstatus_timeout ==0))
{
heartBeatPrint();
checkstatus_timeout =millis() + STATUS_CHECK_INTERVAL;
}
}
voidloop()
{
check_status();
}

You can access the Async Advanced WebServer @ the server IP

Debug Terminal Output Samples

1. Async_AdvancedWebServer on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is the debug terminal when running exampleAsync_AdvancedWebServer onRASPBERRY_PI_PICO_W using CYW43439 WiFi to demonstrate the operation of AsyncWebServer_RP2040W, based on thisAsyncTCP_RP2040W Library

Start Async_AdvancedWebServer on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.180Country code: CA         <================ Country code CAfor CYW43_COUNTRY_CANADAHTTP EthernetWebServer is @ IP :192.168.2.180.......... .......... .......... .......... .......... .......... .......... .................... .......... .......... .......... .......... ...

2. WebClient on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is debug terminal output when running exampleWebClient onRASPBERRY_PI_PICO_W using CYW43439 WiFi

Start WebClient on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.180Country code: CA         <================ Country code CAfor CYW43_COUNTRY_CANADAStarting connection to server...Connected to serverHTTP/1.1200 OKDate: Tue,16 Aug202201:06:29 GMTContent-Type: text/plainContent-Length:2263Connection: closex-amz-id-2: eCCq3bjp3ZIWsEqS9Timqjnr4liaTs2BY2giqfjPt5fRD9UPsPHZgIkhWMmbgfXHm7Rp6g1V1EE=x-amz-request-id: V2X8BFCZS6E01EA4Last-Modified: Wed,23 Feb202214:56:42 GMTETag:"667cf48afcc12c38c8c1637947a04224"CF-Cache-Status: DYNAMICReport-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=VUTYgtuhcRcBq%2F%2Bj6oRv60yx72aRGR6Z0yNupDNmxvSYpiwM6bHwRA8Xteiu3GM0pjxLcOGB5apbpNOkljur%2FuuNTU%2FnfcLZZc8zF7i8nrDyeplpCRDuJ9oz0HCZKSI%3D"}],"group":"cf-nel","max_age":604800}NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}Server: cloudflareCF-RAY: 73b64482ad06a1e0-YYZalt-svc: h3=":443"; ma=86400, h3-29=":443"; ma=86400           `:;;;,`                      .:;;:.                   .;;;;;;;;;;;`                :;;;;;;;;;;:     TM       `;;;;;;;;;;;;;;;`            :;;;;;;;;;;;;;;;           :;;;;;;;;;;;;;;;;;;         `;;;;;;;;;;;;;;;;;;         ;;;;;;;;;;;;;;;;;;;;;       .;;;;;;;;;;;;;;;;;;;;       ;;;;;;;;:`   `;;;;;;;;;     ,;;;;;;;;.`   .;;;;;;;;     .;;;;;;,         :;;;;;;;   .;;;;;;;          ;;;;;;;    ;;;;;;             ;;;;;;;  ;;;;;;,            ;;;;;;.  ,;;;;;               ;;;;;;.;;;;;;`              ;;;;;;  ;;;;;.                ;;;;;;;;;;;`      ```       ;;;;;` ;;;;;                  ;;;;;;;;;,       ;;;       .;;;;;`;;;;:                  `;;;;;;;;        ;;;        ;;;;;,;;;;`    `,,,,,,,,      ;;;;;;;      .,,;;;,,,     ;;;;;:;;;;`    .;;;;;;;;       ;;;;;,      :;;;;;;;;     ;;;;;:;;;;`    .;;;;;;;;      `;;;;;;      :;;;;;;;;     ;;;;;.;;;;.                   ;;;;;;;.        ;;;        ;;;;; ;;;;;                  ;;;;;;;;;        ;;;        ;;;;; ;;;;;                 .;;;;;;;;;;       ;;;       ;;;;;, ;;;;;;               `;;;;;;;;;;;;                ;;;;;  `;;;;;,             .;;;;;; ;;;;;;;              ;;;;;;   ;;;;;;:           :;;;;;;.  ;;;;;;;            ;;;;;;     ;;;;;;;`       .;;;;;;;,    ;;;;;;;;        ;;;;;;;:      ;;;;;;;;;:,:;;;;;;;;;:      ;;;;;;;;;;:,;;;;;;;;;;       `;;;;;;;;;;;;;;;;;;;.        ;;;;;;;;;;;;;;;;;;;;          ;;;;;;;;;;;;;;;;;           :;;;;;;;;;;;;;;;;:            ,;;;;;;;;;;;;;,              ;;;;;;;;;;;;;;                .;;;;;;;;;`                  ,;;;;;;;;:                                                                                                                                                                                                                                                 ;;;   ;;;;;`  ;;;;:  .;;  ;; ,;;;;;, ;;. `;,  ;;;;       ;;;   ;;:;;;  ;;;;;; .;;  ;; ,;;;;;: ;;; `;, ;;;:;;     ,;:;   ;;  ;;  ;;  ;; .;;  ;;   ,;,   ;;;,`;, ;;  ;;     ;; ;:  ;;  ;;  ;;  ;; .;;  ;;   ,;,   ;;;;`;, ;;  ;;.    ;: ;;  ;;;;;:  ;;  ;; .;;  ;;   ,;,   ;;`;;;, ;;  ;;`   ,;;;;;  ;;`;;   ;;  ;; .;;  ;;   ,;,   ;; ;;;, ;;  ;;    ;;  ,;, ;; .;;  ;;;;;:  ;;;;;: ,;;;;;: ;;  ;;, ;;;;;;    ;;   ;; ;;  ;;` ;;;;.   `;;;:  ,;;;;;, ;;  ;;,  ;;;;   Disconnecting from server...

3. MQTTClient_Auth on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is debug terminal output when running exampleMQTTClient_Auth onRASPBERRY_PI_PICO_W using CYW43439 WiFi

Start MQTTClient_Auth on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.180Country code: CA         <================ Country code CAfor CYW43_COUNTRY_CANADAAttempting MQTT connection to broker.emqx.io...connectedMessage Send : MQTT_Pub => Hello from MQTTClient_Auth on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiMessage arrived [MQTT_Pub] Hello from MQTTClient_Auth on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiMessage Send : MQTT_Pub => Hello from MQTTClient_Auth on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiMessage arrived [MQTT_Pub] Hello from MQTTClient_Auth on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFi

4. MQTTClient_Basic on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is debug terminal output when running exampleMQTTClient_Basic onRASPBERRY_PI_PICO_W using CYW43439 WiFi

Start MQTTClient_Basic on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.180Country code: CA         <================ Country code CAfor CYW43_COUNTRY_CANADAAttempting MQTT connection to broker.emqx.io...connectedMessage Send : MQTT_Pub => Hello from MQTTClient_Basic on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiMessage arrived [MQTT_Pub] Hello from MQTTClient_Basic on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiMessage Send : MQTT_Pub => Hello from MQTTClient_Basic on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiMessage arrived [MQTT_Pub] Hello from MQTTClient_Basic on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiMessage Send : MQTT_Pub => Hello from MQTTClient_Basic on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFi

5. MQTT_ThingStream on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is debug terminal output when running exampleMQTT_ThingStream onRASPBERRY_PI_PICO_W using CYW43439 WiFi

Start MQTT_ThingStream on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.180Country code: CA         <================ Country code CAfor CYW43_COUNTRY_CANADA***************************************RP2040W_Pub***************************************Attempting MQTT connection to broker.emqx.io...connectedPublished connection message successfully!Subscribed to: RP2040W_SubMQTT Message Send : RP2040W_Pub => Hello from MQTT_ThingStream on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiMQTT Message receive [RP2040W_Pub] Hello from MQTT_ThingStream on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiMQTT Message Send : RP2040W_Pub => Hello from MQTT_ThingStream on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiMQTT Message receive [RP2040W_Pub] Hello from MQTT_ThingStream on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFi

6. Async_AdvancedWebServer_Country on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is the debug terminal when running exampleAsync_AdvancedWebServer_Country onRASPBERRY_PI_PICO_W using CYW43439 WiFi to demonstrate the operation of AsyncWebServer_RP2040W, based on thisAsyncTCP_RP2040W Library and to display programmedcountry-code

Start Async_AdvancedWebServer_Country on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.180Country code: CA         <================ Country code CAfor CYW43_COUNTRY_CANADAHTTP EthernetWebServer is @ IP :192.168.2.180....

Chrome, Vivaldi and Firefox running simultaneously

Only Firefox running

7. Async_AdvancedWebServer_favicon on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is the debug terminal when running exampleAsync_AdvancedWebServer_favicon onRASPBERRY_PI_PICO_W using CYW43439 WiFi to demonstrate the operation of AsyncWebServer_RP2040W, based on thisAsyncTCP_RP2040W Library and to displayfavicon.ico, which many browsers are interested.

14:22:06.632 -> Start Async_AdvancedWebServer_favicon on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFi14:22:06.632 -> AsyncTCP_RP2040W v1.1.014:22:06.632 -> AsyncWebServer_RP2040W v1.5.014:22:06.632 -> Connecting to SSID: HueNet114:22:13.328 -> SSID: HueNet114:22:13.328 -> Local IP Address:192.168.2.18014:22:13.328 -> Country code: XX14:22:13.328 -> HTTP EthernetWebServer is @ IP :192.168.2.18014:22:13.328 -> .......... .......... .......... .......... .......... .......... .......... ..........14:35:53.414 -> .......... .......... .......... .......... ...

You can see thefavicon.ico at the upper left corner

On Chrome

On Firefox

8. Async_AdvancedWebServer_MemoryIssues_Send_CString on RASPBERRY_PI_PICO_W

Following is the debug terminal and screen shot when running exampleAsync_AdvancedWebServer_MemoryIssues_Send_CString onRASPBERRY_PI_PICO_W to demonstrate the new and powerfulHEAP-saving feature

Using CString ===> small heap (44,000 bytes)
Start Async_AdvancedWebServer_MemoryIssues_Send_CString on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.74Country code: XXHTTP EthernetWebServer is @ IP :192.168.2.74HEAP DATA - Pre Create Arduino String  Cur heap:193000  Free heap:150928  Max heap:42072.75264HEAP DATA - Pre Send  Cur heap:193000  Free heap:149176  Max heap:43824HEAP DATA - Post Send  Cur heap:193000  Free heap:149016  Max heap:43984.HEAP DATA - Post Send  Cur heap:193000  Free heap:149000  Max heap:44000.......... .......... .......... ........Out String Length=31247.. .......... .......... .......... ..........

While using Arduino String, the HEAP usage is very large

Async_AdvancedWebServer_MemoryIssues_SendArduinoString ===> very large heap (75,264 bytes)

Start Async_AdvancedWebServer_MemoryIssues_SendArduinoString on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.74Country code: XXHTTP EthernetWebServer is @ IP :192.168.2.74HEAP DATA - Pre Create Arduino String  Cur heap:193256  Free heap:191192  Max heap:2064.HEAP DATA - Pre Send  Cur heap:193256  Free heap:149432  Max heap:43824HEAP DATA - Post Send  Cur heap:193256  Free heap:118024  Max heap:75232HEAP DATA - Post Send  Cur heap:193256  Free heap:117992  Max heap:75264....... .......... .......... .................... .......... .......... ........Out String Length=31247.. .......... .

You can access the Async Advanced WebServers at the displayed server IP, e.g.192.168.2.74

9. Async_WebSocketsServer on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is debug terminal output when running exampleAsync_WebSocketsServer onRASPBERRY_PI_PICO_W using CYW43439 WiFi. The WSClient is using the providedWSClient.py

Starting Async_WebSocketsServer on RASPBERRY_PI_PICO_WAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.77ws[Server: /ws][ClientID:1] WSClient connectedws[Server: /ws][ClientID:2] WSClient connectedws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:1] WSClient disconnectedws[Server: /ws][ClientID:3] WSClient connectedws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Serverws[Server: /ws][ClientID:2] text-message[len:13]: Hello, Server

You can access the Async_WebSockets Servers at the displayed server IP, e.g.192.168.2.77

10. Async_WebSocketsServer_Xtreme on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is debug terminal output when running exampleAsync_WebSocketsServer_Xtreme onRASPBERRY_PI_PICO_W using CYW43439 WiFi.

Starting Async_WebSocketsServer_Xtreme on RASPBERRY_PI_PICO_WAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.77

You can access the Async_WebSockets Servers at the displayed server IP, e.g.192.168.2.77

11. AsyncFSWebServer_Complex on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is debug terminal output when running exampleAsyncFSWebServer_Complex onRASPBERRY_PI_PICO_W using CYW43439 WiFi.

Start AsyncFSWebServer_Complex on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.77Opening / directoryFS File: CanadaFlag_1.png, size:40.25KBFS File: CanadaFlag_2.png, size:8.12KBFS File: CanadaFlag_3.jpg, size:10.89KBFS File: css, size:0BFS File: edit.htm.gz, size:4.02KBFS File: favicon.ico, size:1.12KBFS File: graphs.js.gz, size:1.92KBFS File: index.htm, size:3.63KBFS File: js, size:0BAsyncWebServer started @192.168.2.77Open http://192.168.2.77/edit to see the file browserAsyncFSEditor::handleRequest: Sending AsyncWebServerResponse

You can access the Async_WebSockets Servers at the displayed server IP, e.g.192.168.2.77

12. Async_AdvancedWebServer_SendChunked on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is debug terminal output when running exampleAsync_AdvancedWebServer_SendChunked onRASPBERRY_PI_PICO_W using CYW43439 WiFi, to demo how to usebeginChunkedResponse() to send largehtml in chunks

Start Async_AdvancedWebServer_SendChunked on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.77Country code: XXAsyncWebServer is @ IP :192.168.2.77.[AWS] Total length to send in chunks =31259[AWS] Bytes sent in chunk =11556[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =8031[AWS] Bytes sent in chunk =0[AWS] Total length to send in chunks =31279[AWS] Bytes sent in chunk =11556[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =8051[AWS] Bytes sent in chunk =0

You can access the AsyncWebServer_RP2040W at the displayed server IP, e.g.192.168.2.77

13. AsyncWebServer_SendChunked on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is debug terminal output when running exampleAsyncWebServer_SendChunked onRASPBERRY_PI_PICO_W using CYW43439 WiFi, to demo how to usebeginChunkedResponse() to send largehtml in chunks

Start AsyncWebServer_SendChunked on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0Connecting to SSID: HueNet1SSID: HueNet1Local IP Address:192.168.2.77Country code: XXAsyncWebServer is @ IP :192.168.2.77.[AWS] Total length to send in chunks =47387[AWS] Bytes sent in chunk =11560[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =811[AWS] Bytes sent in chunk =0.[AWS] Total length to send in chunks =47387[AWS] Bytes sent in chunk =11560[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =811[AWS] Bytes sent in chunk =0[AWS] Total length to send in chunks =47387[AWS] Bytes sent in chunk =11560[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =811[AWS] Bytes sent in chunk =0.[AWS] Total length to send in chunks =47387[AWS] Bytes sent in chunk =11560[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =811[AWS] Bytes sent in chunk =0[AWS] Total length to send in chunks =47387[AWS] Bytes sent in chunk =11560[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =11672[AWS] Bytes sent in chunk =811[AWS] Bytes sent in chunk =0.[AWS] Total length to send in chunks =47387[AWS] Bytes sent in chunk =11560...... ...

14. Async_AdvancedWebServer_SendChunked_MQTT on RASPBERRY_PI_PICO_W using CYW43439 WiFi

Following is debug terminal output when running exampleAsync_AdvancedWebServer_SendChunked_MQTT onRASPBERRY_PI_PICO_W using CYW43439 WiFi, to demo how to useAsyncWebServer_RP2040W andAsyncMQTT_Generic libraries together

Start Async_AdvancedWebServer_SendChunked_MQTT on RASPBERRY_PI_PICO_W with RP2040W CYW43439 WiFiAsyncTCP_RP2040W v1.1.0AsyncWebServer_RP2040W v1.5.0AsyncMQTT_Generic v1.8.1for RP2040W CYW43439 WiFiConnecting to SSID: HueNetSSID: HueNetLocal IP Address:192.168.2.128Country code: XXConnecting to MQTT...AsyncWebServer is @ IP :192.168.2.128.Connected to MQTT broker: broker.emqx.io, port:1883PubTopic: async-mqtt/RP2040W_Pub************************************************Session present:0Subscribing at QoS2, packetId:1Publishing at QoS0Publishing at QoS1, packetId:2Publishing at QoS2, packetId:3************************************************Subscribe acknowledged.  packetId:1  qos:2Publish received.  topic: async-mqtt/RP2040W_Pub  message: RP2040W Test3  qos:2  dup:0  retain:1  len:13  index:0  total:13Publish acknowledged.  packetId:2Publish received.  topic: async-mqtt/RP2040W_Pub  message: RP2040W Test1  qos:0  dup:0  retain:0  len:13  index:0  total:13Publish received.  topic: async-mqtt/RP2040W_Pub  message: RP2040W Test2  qos:1  dup:0  retain:0  len:13  index:0  total:13Publish received.  topic: async-mqtt/RP2040W_Pub  message: RP2040W Test3  qos:2  dup:0  retain:0  len:13  index:0  total:13Publish acknowledged.  packetId:3...Publish received.  topic: async-mqtt/RP2040W_Pub  message: RP2040W Test2  qos:1  dup:1  retain:0  len:13  index:0  total:13..Disconnected from MQTT..... .......... .

You can access the AsyncWebServer_RP2040W at the displayed server IP, e.g.192.168.2.128

Debug

Debug is enabled by default on Serial.

You can also change the debugging level_RP2040W_AWS_LOGLEVEL_ from 0 to 4 in the librarycpp files

#define_RP2040W_AWS_LOGLEVEL_1

Troubleshooting

If you get compilation errors, more often than not, you may need to install a newer version of Arduino IDE, the Arduinoarduino-pico core or depending libraries.

Sometimes, the library will only work if you update thearduino-pico core to the latest version because I'm always using the latest cores /libraries.

Issues

Submit issues to:AsyncWebServer_RP2040W issues

TO DO

  1. Fix bug. Add enhancement

DONE

  1. Add support toRASPBERRY_PI_PICO_W usingCYW43439 WiFi
  2. Add Table of Contents
  3. Modify examples to displaycountry-code
  4. Add tempo method to modifyarduino-pico core to changecountry-code
  5. Fix issue with slow browsers or network. CheckTarget stops responding after variable time when using Firefox on Windows 10 #3
  6. Add functions and exampleAsync_AdvancedWebServer_favicon to supportfavicon.ico
  7. Support usingCString to save heap to sendvery large data. Checkrequest->send(200, textPlainStr, jsonChartDataCharStr); - Without using String Class - to save heap #8
  8. Fixcrash when usingAsyncWebSockets server and add exampleAsync_WebSocketsServer to demo the AsyncWebSockets Server with a PythonWSClient.py
  9. Improve robustness of AsyncWebSockets server. CheckAsyncWebSocketServer_RP2040W crashes with "[AWS] ERROR: Too many messages queued" #6 and add exampleAsync_WebSocketsServer_Xtreme to demo the nearly highest possible WebSockets Server speed
  10. AddLittleFS functions such asAsyncFSWebServer
  11. Add examplesAsync_AdvancedWebServer_SendChunked andAsyncWebServer_SendChunked to demo how to usebeginChunkedResponse() to send largehtml in chunks
  12. Add examplesAsync_AdvancedWebServer_SendChunked_MQTT andAsyncWebServer_MQTT_RP2040W to demo how to useAsyncWebServer_RP2040W andAsyncMQTT_Generic libraries together
  13. ImproveREADME.md so that links can be used in other sites, such asPIO

Contributions and Thanks

  1. Based on and modified fromHristo Gochkov's ESPAsyncWebServer. Many thanks toHristo Gochkov for greatESPAsyncWebServer Library
  2. Thanks torevell1 to
  1. Thanks tosalasidis akars77can to discuss and make the followingmarvellous PRs inPortenta_H7_AsyncWebServer library
  1. Thanks todrmue to report the bugs in
  1. Thanks toroma2580 to report and help fix the bug in
me-no-dev
⭐️⭐️ Hristo Gochkov
revell1
revell1
salasidis
⭐️ salasidis
drmue
drmue
roma2580
>⭐️ roma2580

Contributing

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

License

  • The library is licensed underGPLv3

Copyright

Copyright 2022- Khoi Hoang

About

Asynchronous WebServer Library for RASPBERRY_PI_PICO_W using CYW43439 WiFi with arduino-pico core. This library, which is relied on AsyncTCP_RP2040W, is part of a series of advanced Async libraries for RP2040W, such as AsyncTCP_RP2040W, AsyncUDP_RP2040W, AsyncWebServer_RP2040W, AsyncHTTPRequest_RP2040W, AsyncHTTPSRequest_RP2040W, etc. Now can di…

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published
[8]ページ先頭
©2009-2025 Movatter.jp