homebridge-mculed

Homebridge Plugin for NodeMCU Based ws2812/sm16703p led strip controller for RGB+W led strips

NOTICE: I'm in the process of deprecating my usage of this plugin.

And in the process of migrating all my devices to the Tasmota firmware and the homebridge-tasmota plugin. With the transition I'm not changing my devices, just flashing them with Tasmota.

If someone wants to take over ownership of this codebase and repository, please let me know.

Table of Contents

• NOTICE: I'm in the process of deprecating my usage of this plugin.
• Table of Contents
• Design Concept
• Backlog and Roadmap
  • Backlog - plugin
  • Backlog - nodemcu
  • Roadmap
• Supported configurations/devices
• Installation - homebridge-mculed
• Configuration - homebridge-mculed
• Provisioning/Configuration - NodeMCU
• API Documentation
• Credits

Design Concept

• Realtime device communications via WebSockets, and device discovery via mDNS
• Nodemcu creates a websocket server
• Nodemcu advertises websocket server onto network via mDNS
• Plugin discovers server by watching for mDNS advertisement
• NodeMCU sends message to plugin containing device config
• Plugin creates HK accessory for device ( Have ability to alias sensor name in config.json )
• Nodemcu sends device state changes in realtime to plugin via WebSockets
• OTA nodeMCU provisioning

Backlog and Roadmap

Backlog - plugin

• [x] Migrate from mDNS to bonjour
• [x] Plugin has a circular json issue in accessory, likely timeout
• [x] After reboot of the device, socket connection does not re-establish
• [x] Implement websocket ping
• [x] Websocket socket level events in Plugin
• [x] Not responding for closed socket
• [x] Handle device not turned on
• [x] Identify method and reset button needs rework
• [x] Complete plugin documentation
• [x] Aliases don't appear to work
• [x] Add a Christmas button to rotate thru primary colors

Backlog - nodemcu

• [x] OTA nodeMCU code provisioning
• [x] Initial lua code load via script
• [x] Websocket socket level events in NodeMCU
• [x] NodeMCU Memory leak from closed socket connections
• [x] Implement websocket pong
• [x] Program second button to flip primary colors
• [x] Remove excessive prints in nodeMCU code
• [x] Watchdog timer, what should it do - Reset after 5 minutes without HB connection
• [x] What should the LED's do in a power cycle?
• [x] Get a case with push button's
• [x] Create schematic for nodeMCU
• [x] Create layout for perfboard
• [x] Power nodemcu with DC-DC Step down from the 24V power supply
• [x] Create a board level layout to use on a perf board
• [x] Construct production unit
• [x] Complete nodemcu documentation
• [x] Power off LED strip via MOSFET -- Not possible
• [ ] Revisit perfboard layout, break perf board between nodemcu and output section, and rotate output section 90 degrees
• [ ] Build 3 more units cottage porch lights, xmas 1 and xmas 2

Roadmap

• [ ] Collapse the OTA Update server to nodeJS

Supported configurations/devices

• [x] Costco LED Strip - Intertek 4005244 - This strip is based on the sm16703p LED controller chip

Installation - homebridge-mculed

sudo npm install -g homebridge-mculed

Configuration - homebridge-mculed

{
    "platform": "mculed",
    "name": "mculed",
    "aliases": {
      "NODE-AC5812": "Kitchen Sink"
    }
  }

• aliases - Friendly names for your sensor's

Provisioning/Configuration - NodeMCU

See README in lua directory

API Documentation

Credits

• TerryE and Marcelstoer - For nodemcu/lua OTA updates - https://github.com/nodemcu/nodemcu-firmware/tree/master/lua_examples/luaOTA
• Frank Edelhaeuser - Borrowed lua mDNS Discovery code, and updated to support NodeMCU
• creationix - Borrowed LUA WebSocket Server code - https://github.com/creationix/nodemcu-webide/tree/master/mcu