Allow customizing display name for energy device (#20033)

* Allow customizing display name for energy device

* use display name in device settings list

src/data/energy.ts

@@ -95,6 +95,7 @@ export type EnergySolarForecasts = {
 export interface DeviceConsumptionEnergyPreference {
   // This is an ever increasing value
   stat_consumption: string;
+  name?: string;
 }
 
 export interface FlowFromGridSourceEnergyPreference {

src/panels/config/energy/components/ha-energy-device-settings.ts

@@ -1,5 +1,5 @@
 import "@material/mwc-button/mwc-button";
-import { mdiDelete, mdiDevices } from "@mdi/js";
+import { mdiDelete, mdiDevices, mdiPencil } from "@mdi/js";
 import { CSSResultGroup, html, LitElement, TemplateResult } from "lit";
 import { customElement, property } from "lit/decorators";
 import { fireEvent } from "../../../../common/dom/fire_event";
@@ -83,18 +83,24 @@ export class EnergyDeviceSettings extends LitElement {
           ${this.preferences.device_consumption.map((device) => {
             const entityState = this.hass.states[device.stat_consumption];
             return html`
-              <div class="row">
+              <div class="row" .device=${device}>
                 <ha-state-icon
                   .hass=${this.hass}
                   .stateObj=${entityState}
                 ></ha-state-icon>
                 <span class="content"
-                  >${getStatisticLabel(
+                  >${device.name ||
+                  getStatisticLabel(
                     this.hass,
                     device.stat_consumption,
                     this.statsMetadata?.[device.stat_consumption]
                   )}</span
                 >
+                <ha-icon-button
+                  .label=${this.hass.localize("ui.common.edit")}
+                  @click=${this._editDevice}
+                  .path=${mdiPencil}
+                ></ha-icon-button>
                 <ha-icon-button
                   .label=${this.hass.localize("ui.common.delete")}
                   @click=${this._deleteDevice}
@@ -117,6 +123,24 @@ export class EnergyDeviceSettings extends LitElement {
     `;
   }
 
+  private _editDevice(ev) {
+    const origDevice: DeviceConsumptionEnergyPreference =
+      ev.currentTarget.closest(".row").device;
+    showEnergySettingsDeviceDialog(this, {
+      device: { ...origDevice },
+      device_consumptions: this.preferences
+        .device_consumption as DeviceConsumptionEnergyPreference[],
+      saveCallback: async (newDevice) => {
+        await this._savePreferences({
+          ...this.preferences,
+          device_consumption: this.preferences.device_consumption.map((d) =>
+            d === origDevice ? newDevice : d
+          ),
+        });
+      },
+    });
+  }
+
   private _addDevice() {
     showEnergySettingsDeviceDialog(this, {
       device_consumptions: this.preferences

src/panels/config/energy/dialogs/dialog-energy-device-settings.ts

@@ -44,9 +44,10 @@ export class DialogEnergyDeviceSettings
     this._energy_units = (
       await getSensorDeviceClassConvertibleUnits(this.hass, "energy")
     ).units;
-    this._excludeList = this._params.device_consumptions.map(
+    this._device = this._params.device;
-      (entry) => entry.stat_consumption
+    this._excludeList = this._params.device_consumptions
-    );
+      .map((entry) => entry.stat_consumption)
+      .filter((id) => id !== this._device?.stat_consumption);
   }
 
   public closeDialog(): void {
@@ -88,6 +89,7 @@ export class DialogEnergyDeviceSettings
           .hass=${this.hass}
           .helpMissingEntityUrl=${energyStatisticHelpUrl}
           .includeUnitClass=${energyUnitClasses}
+          .value=${this._device?.stat_consumption}
           .label=${this.hass.localize(
             "ui.panel.config.energy.device_consumption.dialog.device_consumption_energy"
           )}
@@ -96,6 +98,17 @@ export class DialogEnergyDeviceSettings
           dialogInitialFocus
         ></ha-statistic-picker>
 
+        <ha-textfield
+          .label=${this.hass.localize(
+            "ui.panel.config.energy.device_consumption.dialog.display_name"
+          )}
+          type="text"
+          .disabled=${!this._device}
+          .value=${this._device?.name || ""}
+          @change=${this._nameChanged}
+        >
+        </ha-textfield>
+
         <mwc-button @click=${this.closeDialog} slot="secondaryAction">
           ${this.hass.localize("ui.common.cancel")}
         </mwc-button>
@@ -118,6 +131,17 @@ export class DialogEnergyDeviceSettings
     this._device = { stat_consumption: ev.detail.value };
   }
 
+  private _nameChanged(ev) {
+    const newDevice = {
+      ...this._device!,
+      name: ev.target!.value,
+    } as DeviceConsumptionEnergyPreference;
+    if (!newDevice.name) {
+      delete newDevice.name;
+    }
+    this._device = newDevice;
+  }
+
   private async _save() {
     try {
       await this._params!.saveCallback(this._device!);
@@ -134,6 +158,10 @@ export class DialogEnergyDeviceSettings
         ha-statistic-picker {
           width: 100%;
         }
+        ha-textfield {
+          margin-top: 16px;
+          width: 100%;
+        }
       `,
     ];
   }

src/panels/config/energy/dialogs/show-dialogs-energy.ts

@@ -70,6 +70,7 @@ export interface EnergySettingsWaterDialogParams {
 }
 
 export interface EnergySettingsDeviceDialogParams {
+  device?: DeviceConsumptionEnergyPreference;
   device_consumptions: DeviceConsumptionEnergyPreference[];
   saveCallback: (device: DeviceConsumptionEnergyPreference) => Promise<void>;
 }

src/panels/lovelace/cards/energy/hui-energy-devices-detail-graph-card.ts

@@ -333,11 +333,13 @@ export class HuiEnergyDevicesDetailGraphCard
       );
 
       data.push({
-        label: getStatisticLabel(
+        label:
-          this.hass,
+          source.name ||
-          source.stat_consumption,
+          getStatisticLabel(
-          statisticsMetaData[source.stat_consumption]
+            this.hass,
-        ),
+            source.stat_consumption,
+            statisticsMetaData[source.stat_consumption]
+          ),
         hidden:
           this._hiddenStats.has(source.stat_consumption) || itemExceedsMax,
         borderColor: compare ? color + "7F" : color,

src/panels/lovelace/cards/energy/hui-energy-devices-graph-card.ts

@@ -127,11 +127,7 @@ export class HuiEnergyDevicesGraphCard
               const statisticId = (
                 this._chartData.datasets[0].data[index] as ScatterDataPoint
               ).y;
-              return getStatisticLabel(
+              return this.getDeviceName(statisticId as any as string);
-                this.hass,
-                statisticId as any,
-                this._data?.statsMetadata[statisticId]
-              );
             },
           },
         },
@@ -149,11 +145,7 @@ export class HuiEnergyDevicesGraphCard
           callbacks: {
             title: (item) => {
               const statisticId = item[0].label;
-              return getStatisticLabel(
+              return this.getDeviceName(statisticId);
-                this.hass,
-                statisticId,
-                this._data?.statsMetadata[statisticId]
-              );
             },
             label: (context) =>
               `${context.dataset.label}: ${formatNumber(
@@ -181,6 +173,19 @@ export class HuiEnergyDevicesGraphCard
     })
   );
 
+  private getDeviceName(statisticId: string): string {
+    return (
+      this._data?.prefs.device_consumption.find(
+        (d) => d.stat_consumption === statisticId
+      )?.name ||
+      getStatisticLabel(
+        this.hass,
+        statisticId,
+        this._data?.statsMetadata[statisticId]
+      )
+    );
+  }
+
   private async _getStatistics(energyData: EnergyData): Promise<void> {
     const data = energyData.stats;
     const compareData = energyData.statsCompare;

src/translations/en.json

@@ -2243,6 +2243,7 @@
             "add_device": "Add device",
             "dialog": {
               "header": "Add a device",
+              "display_name": "Display name",
               "device_consumption_energy": "Device consumption energy",
               "selected_stat_intro": "Select the energy sensor that measures the device's energy usage in either of {unit}."
             }