Giter Club home page Giter Club logo

homebridge-ailight's Introduction

No Maintenance Intended

homebridge-ailight is archived, as is the associated AiLight firmware. Go forth and fork homebridge-ailight if you like to improve it.

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.