Anniversary Sale · up to 80% off all librariesEnds Nov 9Shop now
SOFTTDocs

Upgrading to WebSerial Pro

Move an existing project from WebSerial Lite to WebSerial Pro, or from WebSerial Pro v1 to WebSerial Pro v2.

WebSerial Pro feature. This functionality is available only in the commercial edition of WebSerial.

This page describes the changes required to move an existing project to WebSerial Pro v2, either from WebSerial Lite or from WebSerial Pro v1.

From WebSerial Lite

WebSerial Pro exposes the same WebSerial object and API as WebSerial Lite. After you install WebSerial Pro, replace the include in your sketch:

// Before
#include <WebSerial.h>

// After
#include <WebSerialPro.h>

WebSerial Pro supports ESP8266 and ESP32. RP2040 and RP2350 are supported by WebSerial Lite only.

From WebSerial Pro v1

Update the dependencies

WebSerial Pro v2 uses different forks of its dependencies. Replace your existing dependencies with the versions listed in Installation.

Rename the global object

The global object is now named WebSerial instead of WebSerialPro. Rename all calls accordingly.

// Before
WebSerialPro.print("Hello");

// After
WebSerial.print("Hello");

Call WebSerial.loop()

Add WebSerial.loop() to your loop() function, and keep loop() free of blocking code.

void loop() {
  // ...
  WebSerial.loop();
}

Rename the message callback

The message callback has been renamed from msgCallback() to onMessage(). See Callbacks.

On this page