Giter Site home page Giter Site logo

homeseer-alexa-smart-home's Introduction

HomeSeer Alexa Smart Home Skill API

Configure Environment Variables

Set the following environment variables on your AWS Lambda function:

  • HOMESEER_HOST: connected.homeseer.com
  • HOMESEER_USERNAME: Your username used to execute JSON API requests
  • HOMESEER_PASSWORD: Your password used to execute JSON API requests

Define Discoverable Devices

endpoints.json already has a couple of sample devices defined for reference. You can use this as a more thorough reference.

*note: the endpoints.json should define the endpoints[] array as the top-level object

A few notes about endpoint definitions:

  • endpointId: Can be anything, but should be unique. I name mine location1-location2-devicename
  • friendlyName: The name you want to use when referencing the device to Alexa. Can be the same name as defined in HS3 or something different.
  • description and manufacturer: These can be anything. They display in the Alexa app.
  • displayCategories: Should be one of these I believe this only used to display a graphic in the alexa app.
  • cookie: Must define a 'ref' property set to the ref of the device in HS3. cookie can also define a 'useLastLevel' boolean if you want the 'turnOn' command for dimmers to set the value to the dimmer's last on value.
  • capabilities: Define a capability block for each capability your device supports. For binary switches, this would be just PowerController. For dimmers, this would include both PowerController and BrightnessController. All devices should define the initial AlexaInterface and EndpointHealth
  • proactivelyReported: Should be set to false for all capability blocks until this skill supports async status reports.
The only, currently support capabilities are PowerController and BrightnessController.

Once configured, zip up the project and upload to your Lambda.

A test file exists in the test directory that you can run and test locally.

homeseer-alexa-smart-home's People

Contributors

shinynet avatar

Watchers

Mike Ryan avatar James Cloos 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.