Files
arduinoWebSockets/README.md
2016-01-29 13:28:05 +01:00

1.8 KiB

WebSocket Server and Client for Arduino

a WebSocket Server and Client for Arduino based on RFC6455.

Supported features of RFC6455
  • text frame
  • binary frame
  • connection close
  • ping
  • pong
Not supported features of RFC6455
  • continuation frame
Limitations
  • max input length is limited to the ram size and the WEBSOCKETS_MAX_DATA_SIZE define
  • max output length has no limit (the hardware is the limit)
  • Client send big frames with mask 0x00000000 (on AVR all frames)
Supported Hardware
  • ESP8266 Arduino for ESP8266
  • ATmega328 with Ethernet Shield (alpha)
  • ATmega328 with enc28j60 (alpha)
  • ATmega2560 with Ethernet Shield (alpha)
  • ATmega2560 with enc28j60 (alpha)

wss / SSL

supported for:

  • wss client on the ESP8266

ESP Async TCP

this libary can run in Async TCP mode on the ESP8266. the mode can be aktivated in the WebSockets.h (see WEBSOCKETS_NETWORK_TYPE define). the ESPAsyncTCP libary is required. Note: in this mode wss / SSL is not posible.

Issues

Submit issues to: https://github.com/Links2004/arduinoWebSockets/issues

Join the chat at https://gitter.im/Links2004/arduinoWebSockets

License and credits

The library is licensed under LGPLv2.1

libb64 written by Chris Venter. It is distributed under Public Domain see LICENSE.