homebridge-ailight

0.1.3 • Public • Published

Homebridge AiLight Plugin

Homebridge plugin for the AiLight firmware

This is an accessory plugin for Homebridge allowing to manage and control light bulbs that use the AiLight firmware.

The plugin makes itself available to Homekit as a Lightbulb Accessory with the following characteristics:

  • Characteristic.On
  • Characteristic.Brightness
  • Characteristic.Hue
  • Characteristic.Saturation

Current Stable Release: v0.1.3 (Please read the changelog for detailed information).

Requirements

This plugin communicates to your device via the REST API exposed by AiLight itself. As such you need to have v0.5.0 or higher of AiLight uploaded to your device. Furthermore, the REST API needs to be enabled. Please refer to REST API instructions of AiLight how to set this up.

Installation

Assuming you have already Homebridge installed, install this plugin as follows:

npm install -g homebridge-ailight

Configuration

The Homebridge AiLight Plugin registers itself as AiLight, with the following configuration options:

Option Description
name A friendly description of your device (e.g. "Bedroom Light")
hostname The hostname or IP address of your device
apikey The API Key defined in your AiLight settings of your device

Example config.json

{
  "bridge": {
    "name": "Homebridge",
    "username": "CC:22:3D:E3:CE:30",
    "port": 51826,
    "pin": "031-45-154"
  },
  "description": "This is an example configuration file with the AiLight plugin added.",
  "accessories": [
    {
      "accessory": "AiLight",
      "name": "Bedroom Light",
      "hostname": "<YOUR_AILIGHT_IP_ADDRESS_OR_HOSTNAME_HERE>",
      "apikey": "<YOUR_AILIGHT_API_KEY_HERE>"
    }
  ],
  "platforms": [
  ]
}

Bugs and Feedback

For bugs, questions and discussions, please use the Github Issues.

Contributing

Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on Github :) Create Github Issues for bugs and new features and comment on the ones you are interested in.

Credits and License

The Homebridge-AiLight plugin is open-sourced software licensed under the MIT license. For the full copyright and license information, please see the file that was distributed with this source code.

Package Sidebar

Install

npm i homebridge-ailight

Weekly Downloads

0

Version

0.1.3

License

MIT

Unpacked Size

13.7 kB

Total Files

5

Last publish

Collaborators

  • stelgenhof