Code Monkey home page Code Monkey logo

homebridge-functor's Introduction

homebridge-functor

wercker status

Sometimes you just want to connect something simple to HomeKit (or Alexa). homebridge-functor allows you to do this with "middleware-like" configuration. You just list out your devices, point them to the functions that implement getter/setters for the properties, and you're done. The library is Promise-aware, so you can use fancy ES7 async/await to make it look better.

// mySwitch.js
export async function getPower(device) {
    await Promise.delay(1); // This is just a simulation
    console.log(`getPower called for ${device.name}`);
    return true;
}

export async function setPower(device, value) {
    await Promise.delay(1);
    console.log(`setPower ${value} called for ${device.name}`);
    return;
}

And the corresponding portion of HomeKit config.json

{
  "platform": "Functor",
  "devices": [{
      "name": "Fake Switch",
      "serial": "12345678",
      "module": "func:./mySwitch.js"
  }, {
      "name": "Other Fake Switch",
      "serial": "212345678",
      "getPower": "func:./mySwitch.js#getPower",
      "setPower": "func:./mySwitch.js#setPower"
  }]
}

Now you can say "Hey Siri, turn the fake switch on." The two devices above are just two ways of expressing the same thing; the first being a monolithic module that implements all the events, the second being one function at a time. You can also specify event handlers (only the onCreate event exists so far).

homebridge-functor's People

Contributors

djmax avatar

Watchers

 avatar

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.