Links2004/arduinoWebSockets
1
0
Fork 1
mirror of https://github.com/Links2004/arduinoWebSockets.git synced 2025-07-12 23:16:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
Markus Sattler
2015-05-24 16:02:22 +02:00
parent e1e6280e82
commit 0cdf22f5ac
1 changed files with 32 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,3 +1,33 @@
# arduinoWebSockets
WebSocket Server and Client for Arduino
===========================================
a WebSocket Server and Client for arduino based on RFC6455
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 masked frames always with mask 0x00000000 (open todo)
##### Supported Hardware #####
- ESP8266 [Arduino for ESP8266](https://github.com/Links2004/Arduino)
- ATmega328 with Ethernet Shield (planed)
- ATmega328 with enc28j60 (planed)
### Issues ###
Submit issues to: https://github.com/Links2004/arduinoWebSockets/issues
### License and credits ###
The library is licensed under LGPLv2.1.
[libb64](http://libb64.sourceforge.net/) written by Chris Venter. It is distributed under Public Domain see [LICENSE](https://github.com/Links2004/arduinoWebSockets/blob/master/src/libb64/LICENSE).