Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

homebridge-k5s-rgb-light

1.0.2 • Public • Published

K5S RGB LED Plugin for Homebridge

This plugin will create a new light accessory with On, Hue, Saturation, and Brightness characteristics. Updates from HomeKit are processed by the plugin and converted to RGB before being sent out over MQTT on a topic of your choosing. This allows you to easily build your own RGB light controller that can interact with HomeKit and Siri.

This plugin leverages the homebridge-mqtt-base library to implement the MQTT communication.

Prerequisite

  1. Something to run Homebridge and an MQTT Broker on (Raspberry Pis are great for this)
  2. An network connected device that can act as an MQTT client (I use Photons)
  3. Homebridge
  4. An MQTT broker (I use Mosquitto)

Example Homebridge config

{
  "bridge": {
    "name": "Homebridge",
    "username": "CC:22:3D:E3:CE:30",
    "port": 51826,
    "pin": "031-45-154"
  },
  "description": "Example configuration",
  "ports": {
    "start": 52100,
    "end": 52150
  },
  "accessories": [{
    "accessory": "K5SRGBLight",
    "name": "LED Strip",
    "host": "10.0.1.24",
    "inboundTopic": "/example-light/inbound",
    "outboundTopic": "/example-light/outbound"
  }],
  "platforms": []
}

Parameters

  • host (String) the hostname of the MQTT broker
  • inboundTopic (String) the topic used to emit from the accessory to HomeKit
  • outboundTopic (String) the topic used to emit from HomeKit to the accessory

MQTT Interface

The plugin will send a JSON payload with red, green, and blue fields to the topic specified in outboundTopic.

To update the plugin's (and HomeKit's) state from the outside, send a JSON payload of the same structure to the topic specified in inboundTopic.

{ "red": 0, "green": 0, "blue": 255 }

All colors can be a float between 0 and 255.

Install

npm i homebridge-k5s-rgb-light

DownloadsWeekly Downloads

2

Version

1.0.2

License

MIT

Unpacked Size

12.5 kB

Total Files

12

Last publish

Collaborators

  • avatar