Git Product home page Git Product logo

homeassistant-template's Introduction

Creating a HomeAssistant integration is a tedious and frustrating, but ultimately rewarding, experience. This template aims to make the process straightforward, without requiring you to learn the HomeAssistant architecture from the ground up.

Assumptions

This is an opinionated template, which means it make some assumptions.

  • Each entry in your integration's configuration will represent one physical device (i.e. your integration_type in manifest.json will be 'device')
  • You want to poll your device for data at regular intervals (i.e. your iot_class in mainifest.json ends with '_polling')
  • You want to configure the integration using the UI (i.e. users are not required to manually edit configuration.yaml)

Usage

Manifest

  • Set iot_class in manifest.json to either cloud_polling or local_polling
  • Add your Python 3rd party library requirements to manifest.json

Configuration

Platforms

  • The platform types you will use should in the PLATFORMS list in init.py

IOT Class

  • If iot_class ends with *_polling, then you should use a DataUpdateCoordinator

See: https://developers.home-assistant.io/docs/creating_integration_manifest/#iot-class

homeassistant-template's People

Contributors

alangibson avatar

Watchers

 avatar  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.