Giter VIP home page Giter VIP logo

homeseer's Introduction

HomeSeer HS3 Custom Component for Home Assistant

Supported Devices

Z-Wave devices of the following types should create entities in Home Assistant:

  • Z-Wave Barrier Operator (as Home Assistant cover)
  • Z-Wave Battery (as Home Assistant sensor)
  • Z-Wave Door Lock (as Home Assistant lock)
  • Z-Wave Sensor Binary (as Home Assistant binary sensor)
  • Z-Wave Switch (as Home Assistant switch)
  • Z-Wave Switch Binary (as Home Assistant switch)
  • Z-Wave Switch Multilevel (as Home Assistant light)
  • Z-Wave Central Scene (as Home Assistant event - see below)

HomeSeer Events will be created as Home Assistant scenes (triggering the scene in Home Assistant will run the HomeSeer event).

Central Scene devices

HomeSeer devices of the type "Z-Wave Central Scene" will not create an entity in Home Assistant; instead, when a Central Scene device is updated in HomeSeer, this component will fire an event on the Home Assistant event bus which can be used in Automations.

event_type: homeseer_event
event_data:

  • id: Device Ref of the Central Scene device in HomeSeer.
  • event: Numeric value of the Central Scene device in HomeSeer for a given event.

Install

  1. Enable the ASCII connection in HomeSeer (required to receive device updates in Home Assistant).
  2. Create the directory custom_components inside your Home Assistant config directory.
  3. cd into the custom_components directory and do git clone https://github.com/marthoc/homeseer.
  4. Add the below config to your configuration.yaml and restart Home Assistant.
  5. Problems with certain devices (i.e. not supported yet) will be reported in the debug logs for the component/pyHS3.

Upgrade

  1. Stop Home Assistant
  2. cd into the custom_components/homeseer directory and do git pull.
  3. Start Home Assistant

configuration.yaml example

homeseer:
  host:  192.168.1.10
  http_port: 80
  ascii_port: 11000
  username: default
  password: default
  location_names: False
  allow_events: True
Parameter Description Required/Optional
host IP address of the HomeSeer HS3 HomeTroller Required
port HTTP port of the HomeTroller Optional, default 80
ascii_port ASCII port of the HomeTroller Optional, default 11000
username Username of the user to connect to the HomeTroller Optional, default "default"
password Password of the user to connect to the HomeTroller Optional, default "default"
location_names Append location2 + location to device name (see below) Optional, default False
allow_events Create Home Assistant scenes for HomeSeer events Optional, default True

location_names

By default entities will be named only the name of the device in HomeSeer. If you want the location2 + location fields to be appended to the name, set location_names to True.

Example:

  • HomeSeer location2 "Main Floor"
  • HomeSeer location "Living Room"
  • HomeSeer device name "Lamp"

Result:

  • location_names = False: Home Assistant entity will be called "Lamp"
  • location_names = True: Home Assistant entity will be called "Main Floor Living Room Lamp"

homeseer's People

Contributors

marthoc avatar

Watchers

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.