Support new sensor changes from GitHub integration

Author: benct

README.md

@@ -1,4 +1,5 @@
 # github-entity-row
+
 Show GitHub repository sensor data on entity rows in Home Assistant's Lovelace UI
 
 [![GH-release](https://img.shields.io/github/v/release/benct/lovelace-github-entity-row.svg?style=flat-square)](https://github.com/benct/lovelace-github-entity-row/releases)
@@ -7,12 +8,14 @@ Show GitHub repository sensor data on entity rows in Home Assistant's Lovelace U
 [![GH-code-size](https://img.shields.io/github/languages/code-size/benct/lovelace-github-entity-row.svg?color=red&style=flat-square)](https://github.com/benct/lovelace-github-entity-row)
 [![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=flat-square)](https://github.com/hacs)
 
-**NOTE:** This is not a standalone lovelace card, but a row element for the [entities](https://www.home-assistant.io/lovelace/entities/) card.
+**NOTE:** This is not a standalone lovelace card, but a row element for
+the [entities](https://www.home-assistant.io/lovelace/entities/) card.
 
 ## Installation
 
 Add [github-entity-row.js](https://raw.githubusercontent.com/benct/lovelace-github-entity-row/master/github-entity-row.js)
 to your `<config>/www/` folder and add the following to the `configuration.yaml` file:
+
 ```yaml
 lovelace:
   resources:
@@ -21,24 +24,39 @@ lovelace:
 ```
 
 _OR_ install using [HACS](https://hacs.xyz/) and add this (if in YAML mode):
+
 ```yaml
 lovelace:
   resources:
     - url: /hacsfiles/lovelace-github-entity-row/github-entity-row.js
       type: module
 ```
 
-The above configuration can be managed directly in the Configuration -> Lovelace Dashboards -> Resources panel when not using YAML mode,
-or added by clicking the "Add to lovelace" button on the HACS dashboard after installing the plugin.
+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`
-| entity | string | **Required** | `sensor.my_github_repository`
-| name | string | `friendly_name` | Override entity friendly name
-| icon | string | `mdi:github-circle` | Override default entity icon
+| Name   | Type   | Default         | Description                               |
+|--------|--------|-----------------|-------------------------------------------|
+| type   | string | **Required**    | `custom:github-entity-row`                |
+| user   | string | **Required**    | Your GitHub user name                     |
+| repo   | string | **Required**    | Your GitHub repository                    |
+| 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 `user` and `repo` fields need to exactly match your GitHub user and repository names. 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](https://www.home-assistant.io/integrations/github/) 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`. You
+might also need to manually enable the following sensors from your GitHub integration; `Stars`, `Issues`
+and `Pull Requests`.
 
 ## Example
 
@@ -49,24 +67,19 @@ type: entities
 title: GitHub
 entities:
   - type: custom:github-entity-row
-    entity: sensor.home_assistant_config
+    user: benct
+    repo: home-assistant-config
+    name: HA Config
   - type: custom:github-entity-row
-    entity: sensor.lovelace_github_entity_row
+    user: benct
+    repo: lovelace-github-entity-row
+    icon: mdi:github
   - type: custom:github-entity-row
-    entity: sensor.lovelace_xiaomi_vacuum_card
-```
-
-Usage with [auto-entities](https://github.com/thomasloven/lovelace-auto-entities) card:
-```yaml
-type: custom:auto-entities
-card:
-  type: entities
-filter:
-  include:
-    - entity_id: sensor.github*   # or use other matchers
-      options:
-        type: custom:github-entity-row
-        <github-entity-row options>
+    user: benct
+    repo: lovelace-multiple-entity-row
+  - type: custom:github-entity-row
+    user: benct
+    repo: lovelace-xiaomi-vacuum-card
 ```
 
 ## My cards

github-entity-row.js

@@ -25,15 +25,15 @@ class GithubEntityRow extends Polymer.Element {
             <div class="flex">
               <div class="entity" on-click="issues"  title="Open issues">
                 <ha-icon class="icon" icon="mdi:alert-circle-outline"></ha-icon>
-                <span>[[stateObj.attributes.open_issues]]</span>
+                <span>[[stateObjIssues.state]]</span>
               </div>
               <div class="entity" on-click="pulls" title="Open pull requests">
                 <ha-icon class="icon" icon="mdi:source-pull"></ha-icon>
-                <span>[[stateObj.attributes.open_pull_requests]]</span>
+                <span>[[stateObjPRs.state]]</span>
               </div>
               <div class="entity" on-click="stars" title="Stargazers">
                 <ha-icon class="icon" icon="mdi:star"></ha-icon>
-                <span>[[stateObj.attributes.stargazers]]</span>
+                <span>[[stateObjStars.state]]</span>
               </div>
             </div>
           </hui-generic-entity-row>
@@ -46,21 +46,34 @@ class GithubEntityRow extends Polymer.Element {
 
     goto(event, path) {
         event.stopPropagation();
-        window.open(`https://github.com/${this.stateObj.attributes.path}/${path}`);
+        window.open(`https://github.com/${this._config.user}/${this._config.repo}/${path}`);
     }
 
     setConfig(config) {
-        if (!config.entity) throw new Error('Please define an entity.');
-        if (config.entity.split('.')[0] !== 'sensor') throw new Error('Please define a GitHub sensor entity.');
+        if (!config.user || !config.repo) throw new Error('Please define a GitHub user and repository.');
 
-        this._config = config;
+        const sensor = config.sensor || `${config.user}_${config.repo}`.replaceAll('-', '_');
+        this._config = {
+            ...config,
+            name: config.name || config.repo,
+            icon: config.icon || 'mdi:github',
+            sensor: sensor,
+            entity: `sensor.${sensor}_issues`, // required by ha-generic-entity-row
+        };
+    }
+
+    getStateObject(hass, sensor, suffix) {
+        const entity = `sensor.${sensor}_${suffix}`;
+        return entity in hass.states ? hass.states[entity] : null;
     }
 
     set hass(hass) {
         this._hass = hass;
 
         if (hass && this._config) {
-            this.stateObj = this._config.entity in hass.states ? hass.states[this._config.entity] : null;
+            this.stateObjStars = this.getStateObject(hass, this._config.sensor, 'stars');
+            this.stateObjIssues = this.getStateObject(hass, this._config.sensor, 'issues');
+            this.stateObjPRs = this.getStateObject(hass, this._config.sensor, 'pull_requests');
         }
     }
 }