Skip to content
This repository has been archived by the owner on Jul 27, 2023. It is now read-only.

gerardag/person-entity-card

Repository files navigation

Person

Build

Person is a plugin which allows users to add "Person" entity in order to show the location with a beautiful integration.

Preview Image

Install

HACS

This card is available in HACS (Home Assistant Community Store)

Manual install

  1. Download and copy person-entity-card-bundle.js from the latest release into your config/www directory.
  2. Add a reference to person-entity-card-bundle.js inside your ui-lovelace.yaml or through the raw config editor interface.
resources:
  - url: /hacsfiles/person-entity-card/person-entity-card-bundle.js
    type: module

CLI install

  1. Move into your config/www directory
  2. Download person-entity-card-bundle.js
$ wget https://github.com/gerardag/person-entity-card/releases/download//person-entity-card-bundle.js
  1. Add a reference to person-entity-card-bundle.js inside your ui-lovelace.yaml or through the raw config editor gui.
resources:
  - url: /hacsfiles/person-entity-card/person-entity-card-bundle.js
    type: module

Using the card

Card options

Name Type Default Description
type string required custom:person-entity-card
entities object required The entity_id from an entity or entities you want to track.
title string optional Small title above the entities.
centerd boolean false Center person cards into container
showAtHome boolean false You can force to show people when they are home.
disableAction boolean false You can disable tap_action for desired entties

Example usage

You need to add the card into your view .yaml file. The code below shows how to use within multiple persons:

- type: "custom:person-entity-card"
  entities:
    - person.gerard
    - person.bar
    - person.foo

Advanced usage

You can force to show cards although you are at home. To do that you need to add showAtHome set to true in card configuration. Also, you can add a title for your cards group:

- type: "custom:person-entity-card"
  centered: true
  showAtHome: true
  disableAction: true
  title: Pin Pals
  entities:
    - person.gerard
    - person.bar
    - person.foo

Problems

If you are getting "Custom element doesn't exist: person-entity-card", or are running an older browser try replacing type: module with type: js in the resource reference in your ui-lovelace.yaml or in the raw config editor.

License

This project is under the MIT license.

About

Minimalist plugin which allows users to add person entity in order to show the location with a beutiful and clean interface.

Topics

Resources

License

Stars

Watchers

Forks