Skip to content
Homebridge plugin for Yeelights - special focus on supporting features of ceiling lights
TypeScript JavaScript
Branch: master
Clone or download
Pull request Compare This branch is even with cellcortex:master.
Latest commit 8c39f12 Jan 19, 2020

README.md

Welcome to homebridge-yeelighter 👋

Version License: MIT Twitter: cellcortex

Yeelight support for Homebridge: https://github.com/nfarina/homebridge with particular focus on supporting the special features of ceiling lights.

There are many plugins for Yeelight already. This one is unique (so far) in supporting the background light that some yeelights have and also has a diffent approach to the moonlight mode (exposed as just another range for brightness).

If a light supports a background light, it will show up as a secondary service in the light accessory. If a light supports moonlight mode, the brightness will be adjusted so that the lower 50% are reserved for moonlight brightness and the upper 50% are using the "normal" mode. While this makes it simple to control the moonlight mode, it has the small drawback that setting the color-temperature will only work when in the normal light mode. I could not find an API to set the color temperature of the moonlight.

🏠 Homepage

Prerequisites

  • node >=10.0.0
  • homebridge >=0.2.0

Installation

You might want to update npm through: $ sudo npm -g i npm@latest

Install homebridge through: $ sudo npm -g i homebridge

Follow the instructions on GitHub to create a config.json in ~/.homebridge, as described;

Install the homebridge-hue plugin through: $ sudo npm -g i homebridge-yeelighter

Edit ~/.homebridge/config.json and add the yeelighter platform provided by homebridge-yeelighter, see Configuration;

Configuration

In homebridge's config.json you need to specify homebridge-yeelighter as a platform plugin. Furthermore, you need to specify what you want to expose to HomeKit. The simplest form is show below. This will enable the plugin and add all lights with their detected configuration to homekit.

"platforms": [
  {
    "platform": "yeelighter"
    "name": "Yeelighter"
  }
]

The plugin supports setting the configuration through homebridge-config-ui-x.

You can use the override array to override the automatic configuration of the lights. An example for disabling the light with id 0x00000000deadbeef and enabling moonlight and disabling background for 0x0000000012345678:

"platforms": [
  {
    "platform": "yeelighter"
    "name": "Yeelighter"
    "override": [
      {
        "id": "0x00000000deadbeef",
        "ignored": true
      },
      {
        "id": "0x0000000012345678",
        "background": false,
        "moonlight": true
      }
    ]
  }
]

Optional per light configuration:

  • id: string (mandatory) - the id of the light (as reported in the device config of homebridge)
  • name?: string (optional) - the name to be used in log messages
  • color?: boolean (optional) - this light is full RGB color
  • backgroundLight?: boolean (optional) - this light has a secondary color mood light
  • nightLight?: boolean (optional) - this light supports moonlight mode
  • log?: boolean (optional) - enalbe detailed logging for this light
  • offOnDisconnect?: boolean (optional) - switch the light off in homekit when it disconnects (this is for people with old-school wall switches)
  • colorTemperature?: { min: number, max: number } (optional) - colorTemperature limits in kelvin

Setting up the lights

Make sure to enable "LAN control" for the lights you want to control. This is done in the Yeelight app either when setting up the light or in the lights settings which hide behind the ⏏ - button.

There are existing configurations for a number of lights. If your light is not supported, it will hopefully fall back to a decent fallback configuration. You can use the settings to fine-tune it. In those cases, it would be great if you could open a ticket in the issues page including the homebridge logs for the light being setup so the configuration can be added for future users.

Author

👤 Thomas Kroeber

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

You can’t perform that action at this time.