Skip to content

Latest commit

 

History

History
118 lines (79 loc) · 6.79 KB

README.md

File metadata and controls

118 lines (79 loc) · 6.79 KB
Raw

McLighting v3 - The ESP8266 based multi-client lighting gadget

Gitter Build Status License: MIT version

McLighting (the multi-client lighting gadget) is a very cheap internet-controllable lighting solution based on the famous ESP8266 microcontroller and WS2811/2812 led strips. It features among other things a web-interface, a REST-API and a websocket connector.

Because of it's open architecture and APIs it's easy to build new clients for different platforms (iOS, Android, Windows Universal Apps, Siri/Cortana integration, ...).

Demo video WebClient

Demo video Apple Homekit integration

The Hardware

The project is based on the ESP8266 and WD2811/WS2812 LED strips. There are many variations of the ESP chip out there, but for beginners we suggest a NodeMCU dev board, as these are as "plug 'n' play"as it can get. A standalone ESP8266 or an Adafruit Huzzah should work too.

The RGB LED strips are also available in many different flavours (as strips or as standalone LEDs) and can easily be chained.

For a detailed explanation see our wiki: Hardware

Software installation

You can read how to get started on the software side of this project again in out wiki: Software installation

Used Libraries

This project uses libraries and code by different authors:

  • esp8266 tested with version 2.7.4

  • WiFiManager by tzapu (tested with version 0.15.0)

  • WS2812FX by kitesurfer1404 (tested with version 1.3.1) included in code.

  • WebSockets by Links2004 (tested with version 2.3.0)

  • Adafruit NeoPixel by adafruit (tested with 1.7.0)

  • Optional: PubSubClient by knolleary (tested with 2.8.0) Only when you have activated MQTT in definitions.h.

  • Optional: Brzo I2C by pazko-zh (tested with 1.3.3) Only when you have activated GY33 in definitions.h.

  • Optional: FastLed by FastLED (tested with 3.3.3) Only when you have activated custom animations in definitions.h.

  • Optional: IRremoteESP8266 by crankyoldgit (tested with 2.7.12) Only when you have activated IR-Remote in definitions.h.

The sketch also uses the following built-in library:

Parts of the code were taken or inspired by the following sources:

Thank you to all the authors for distributing their software that way. I hope I didn't miss any sources and mentioned every author. In case I forgot someone please let me know and I will fix it.

Todos

  • Redesign of Code and bump to V3
  • Customer profile to define segments of (in)active areas on the strip Issue
  • Additional clients
  • If no wifi, at least enable button mode.
  • Also enable McLighting in Wifi AP mode.
  • Search a non-blocking alternative for wifiManager
  • Multiple buttons/GPIO Inputs. Issue
  • Music visualizer / Bring back ArtNet Issue
  • Display version and parameters (Number of LEDs, definition settings, ..) in the web UI Issue
  • Remove old / wrong EEPROM settings completely [Issue] EEPROM saving discarded
  • Support multiple strips and control them separately or together Issue
  • Support for up to ten segments
  • Removal of LEGACY_ANIMATIONS
  • Include ws2812fx library to code due to modifications in library
  • Add TV, E1.31 and AUTO to CUSTOM_WS2812FX_ANIMATIONS
  • Save status: Added saving of status 'AUTO'. Issue
  • EXPERIMENTAL: Added transition feature on changing values of color brightness and speed. ATTENTION! Does not work properly for all WS2812fx effects. Can be set via UI or REST-API.
  • Added Custom Animation 'Gradient': Issue
  • Make number of pixels, MQTT and PIN configurable via front end Issue and Issue
  • Bundle webpages instead of SPIFFS Issue
  • IR remote support issue
  • MQTT support
  • Save favourite effects? Issue
  • OTA update Issue
  • Fix issue with websockets connection problems
  • Switch to the NeoPixelBus library
  • Use the led strip for status information in connection phase
  • Enhance the documentation
  • Stability improvements
  • RGBW mode Issue
  • Add called command to response Issue
  • Button control Issue
  • Retain last state Issue
  • Make a set of NodeRed nodes.

Licence

MIT

Disclaimer

You use this project at your own risk. This is not a solution that should be used in productive environments, but this code and guide could give you a quick start for your own experiments. Please keep also in mind that there are currently some security features missing.

More information will be added as soon as I clean up the code and complete documentation.