/lovelace-github-entity-row

GitHub repository sensor data on entity rows in Home Assistant's Lovelace UI

Primary LanguageJavaScriptMIT LicenseMIT

github-entity-row

Show GitHub repository sensor data on entity rows in Home Assistant's Lovelace UI

GH-release GH-downloads GH-last-commit GH-code-size hacs_badge

NOTE: This is not a standalone lovelace card, but a row element for the entities card.

Installation

Add github-entity-row.js to your <config>/www/ folder and add the following to the configuration.yaml file:

lovelace:
  resources:
    - url: /local/github-entity-row.js?v=2.1.0
      type: module

OR install using HACS and add this (if in YAML mode):

lovelace:
  resources:
    - url: /hacsfiles/lovelace-github-entity-row/github-entity-row.js
      type: module

The above configuration can be managed in the Configuration -> Dashboards -> Resources panel when not using YAML mode.

Configuration

Name Type Default Description
type string Required custom:github-entity-row
repo string Required Your GitHub repository path
sensor string <user>_<repo> Specify a custom sensor entity (optional)
name string repo Override repository name
icon string mdi:github Override default entity icon

The repo field needs to exactly match your GitHub user and repository path, i.e. benct/lovelace-github-entity-row.

If you rename the sensor entity IDs from the GitHub integration, you can specify the updated sensor ID with the sensor field (without the domain and type suffix). For example, if the integration exposes sensor.custom_sensor_id_latest_release, you should specify custom_sensor_id.

Migrate to version 2

The GitHub integration was changed in HA version 2022.2.0 to include several sensors for each GitHub repository. If you are using the latest HA installation, you need to upgrade to version >2.0.0 of this card. The main change is that the entity field has been replaced by user and repo (user removed in 2.1.0). You might also need to manually enable the following sensors from your GitHub integration; Stars, Issues and Pull Requests.

Example

github-entity-row

type: entities
title: GitHub
entities:
  - type: custom:github-entity-row
    repo: benct/home-assistant-config
    name: HA Config
  - type: custom:github-entity-row
    repo: benct/lovelace-github-entity-row
    icon: mdi:github
  - type: custom:github-entity-row
    repo: benct/lovelace-multiple-entity-row
  - type: custom:github-entity-row
    repo: benct/lovelace-xiaomi-vacuum-card

My cards

xiaomi-vacuum-card | multiple-entity-row | github-entity-row | battery-entity-row | attribute-entity-row

BMC