DocsSDKsLibraries

SDKs

Libraries that do the protocol for you: register once, keep credentials, reconnect politely, buffer while offline and confirm commands. Pick the one for your board or language.

ESP32 / ArduinoBeta 0.9

For ESP32 boards. TLS WebSocket, credentials in NVS, an offline buffer and firmware updates.

Library Manager → WbsktRead the README
.NETBeta 0.9

For Raspberry Pi, PCs and servers. The reference implementation of the protocol.

dotnet add package Wbskt --prereleaseRead the README
PythonBeta 0.9

For Raspberry Pi and scripts. asyncio, the same behaviour as the others.

pip install wbsktRead the README

Hello, WBSKT

The same few lines in each: connect with a name and a policy PIN, send a reading, take a command.

#include <WiFi.h>
#include <Wbskt.h>

WbsktClient wbskt("greenhouse-sensor", "483920");

void setup() {
  WiFi.begin("home-wifi", "wifi-password");
  wbskt.onMessage([](const WbsktMessage& message) {
    if (strcmp(message.type, "heater") == 0) {
      switchHeater(message.payload["on"]);
    }
  });
  wbskt.begin();
}

void loop() {
  wbskt.loop();
  static unsigned long last = 0;
  if (millis() - last < 10000) return;
  last = millis();
  JsonDocument reading;
  reading["celsius"] = readTemperature();
  wbskt.send("temperature", reading);
}
using Wbskt;

await using var wbskt = new WbsktClient("greenhouse-sensor", "483920");

wbskt.OnMessageReceived += (type, payload, commandId) =>
{
    if (type == "heater") heater.Switch(payload);
};

await wbskt.StartAsync();

while (true)
{
    await wbskt.SendAsync("temperature", new { celsius = ReadTemperature() });
    await Task.Delay(TimeSpan.FromSeconds(10));
}
import time
from wbskt import WbsktClient

client = WbsktClient("greenhouse-sensor", policy_pin="483920")

def handle(message):
    if message.type == "heater":
        heater.switch(message.payload["on"])

client.on_message = handle
client.start()

while True:
    client.send("temperature", {"celsius": read_temperature()})
    time.sleep(10)

What each one does

FeatureESP32 / Arduino.NETPython
Readings and commandsYesYesYes
State and capabilitiesYesYesYes
Confirms commands, refuses expired onesYesYesYes
Offline buffer, sent in orderYes, sized in bytesYes, 1,000 messagesYes, 1,000 messages
Firmware updates (OTA)YesNoNo

Another language?

Anything that speaks HTTPS and WebSocket can be a client. Follow the client protocol, then run the shared conformance tests against your client to check it behaves like the SDKs.

Self-hostingEvery SDK takes a server address, so it works the same against your own WBSKT install.