Giter Site home page Giter Site logo

jamesrodda / homebridge-mihomegateway Goto Github PK

View Code? Open in Web Editor NEW
11.0 5.0 2.0 336 KB

A homebridge plugin for connecting the MiHome gateway to HomeKit

License: Apache License 2.0

TypeScript 100.00%
homebridge homebridge-plugin energenie mihome homekit

homebridge-mihomegateway's Introduction

MiHome Gateway Platform Plugin

verified-by-homebridge

Energenie MiHome gateway plugin for Homebridge.

Installation

  1. Install Homebridge using: npm install -g homebridge
  2. Install this plugin using: npm install -g homebridge-mihomegateway
  3. Update your configuration file. See the sample below.

Updating

  • npm update -g homebridge-mihomegateway

Configuration

Currently, the setup is a bit convoluted - sorry about that!

This will all be automated in upcoming releases but for now a bit of manual work is required.

Sample Configuration

"platforms": [{
    "name": "MiHome Gateway",
    "platform": "MiHomeGateway",
    "username": "",
    "password": ""
}]
  • name - a friendly label for the MiHome gateway
  • platform - must be set to MiHomeGateway
  • username - call the register user service to create a new api user
  • password - the password you used to register with (your password is only used for one initial authentication call - subsequent calls will use the api key obtained during authentication)
  • token - [optional] the api key token obtained during authentication
  • baseUrl - [optional] an override for the MiHome API URL

TODO

  • Add additional device types (currently only supports light switches)
  • Automate registration

Credits

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.