README.esp8266.md

   1 ESP8266 lws port
   2 ----------------
   3
   4 lws can now work well on the ESP8266.
   5
   6 You should get the ESP8266 Espressif SDK-based project here
   7
   8 https://github.com/lws-team/esplws
   9
  10 which includes lws as an "app" in the build.  The project provides full AP-based setup over the web, and once the device has been configured to associate to a local AP, a separate station vhost with the lws test protocols.
  11
  12 Instructions for building that are here
  13
  14 https://github.com/lws-team/esplws/blob/master/README.md
  15
  16 There are also instructions there for how to remove the test apps from the build and customize your own station content.
  17
  18
  19 Information about lws integration on ESP8266
  20 --------------------------------------------
  21
  22 The following existing lws features are used to make a nice integration:
  23
  24  - vhosts: there are separate vhosts for the configuration AP mode and the normal station mode.
  25
  26  - file_ops: the lws file operations are overridden and handled by a ROMFS parser
  27
  28  - mounts: mounts are used to serve files automatically from the ROMFS
  29
  30  - plugins: standalone protocol plugins are included into the build, so there are clean individual implementations for each protocol, while everything is statically linked
  31
  32  - lws stability and security features like bytewise parsers, sophisticated timeouts, http/1.1 keepalive support
  33
  34