Giter VIP home page Giter VIP logo

lovelace-floorplan's Introduction

lovelace-floorplan

Floorplan for Lovelace is here!

Quick Start

1) Installation

To get started, copy the following files to the www/floorplan folder of your Home Assistant installation (right-click on each file to save directly to disk):

2) Floorplan image

You'll then need an SVG file of your floorplan, and a CSS file for styling. You can use the samples provided to get started. Copy them to the www/floorplan/examples/simple folder of your Home Assistant installation:

In the SVG file, rename the element IDs to match the entitiy IDs you have in your Home Assistant installation.

3) Adding to Lovelace

Add the following to the resources: section of your Lovelace config.

resources:
  - type: module
    url: /local/floorplan/floorplan-card.js?v=1.1.14

You can then start adding floorplan cards to your Lovelace config. Under entities:, make sure to add the entity IDs which you want to use in the floorplan:

  - cards:
      - config:
          image: /local/floorplan/examples/simple/simple.svg?v=1.1.14
          rules:
            - entities:
                - binary_sensor.main_bedroom
                - binary_sensor.living_area
                - binary_sensor.double_garage
              states:
                - class: 'binary-sensor-off'
                  state: 'off'
                - class: 'binary-sensor-on'
                  state: 'on'
          stylesheet: /local/floorplan/examples/simple/simple.css?v=1.1.14
        title: Simple Floorplan
        type: 'custom:floorplan-card'
    icon: 'mdi:floor-plan'
    id: system
    title: Floorplan

Note: If you're using the Lovelace editor that is built into the user interface, click on the three dots in the upper-right corner of the screen and select Configure UI. Then click on the three dots again and select Raw config editor. Then you'll be able to add the resources and card described above.

4) Try some examples

To get started with some fully working examples, try some of the floorplans below:

lovelace-floorplan's People

Contributors

domy5 avatar kwdavidson avatar nathanfiscus avatar pkozul 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.