evcc-io/templates/definition/meter/homeassistant.yaml

template: homeassistant
products:
  - brand: Home Assistant
group: generic
requirements:
  description:
    en: Home Assistant instances in your network will be auto-discovered and suitable entities (e.g. `sensor.*`) will be suggested.
    de: Home Assistant Instanzen in deinem Netzwerk werden automatisch erkannt und passende Entitäten (z.B. `sensor.*`) werden vorgeschlagen.
auth:
  type: homeassistant
  params: [uri, insecure]
params:
  - name: usage
    choice: ["grid", "pv", "battery", "aux", "charge"]
  - name: uri
    description:
      de: Home Assistant URI
      en: Home Assistant URI
    example: http://homeassistant.local:8123
    help:
      en: " " # overwrite default
      de: " " # overwrite default
    service: homeassistant/instances
    required: true
  - name: token
    deprecated: true
  - name: home
    deprecated: true
  - name: power
    description:
      de: Leistungsentität
      en: Power Entity
    required: true
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=sensor
    example: "sensor.house_power"
    help:
      en: Entity ID for instantaneous power measurement in watts. The entity must provide numeric values only (e.g., "1234", not "1234 W").
      de: Entitäts-ID für momentane Leistungsmessung in Watt. Die Entität muss nur numerische Werte liefern (z.B. "1234", nicht "1234 W").
  - name: energy
    description:
      de: Energieentität
      en: Energy Entity
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=sensor
    example: "sensor.house_energy"
    advanced: true
    help:
      en: Entity ID for cumulative energy measurement in kWh. Should provide total energy consumed/produced, not daily or interval values.
      de: Entitäts-ID für kumulative Energiemessung in kWh. Sollte die gesamte verbrauchte/produzierte Energie liefern, nicht tägliche oder Intervallwerte.
  - name: currentL1
    description:
      de: L1 Stromentität
      en: L1 Current Entity
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=sensor
    example: "sensor.house_current_l1"
    advanced: true
    help:
      en: Entity ID for L1 current measurement in amperes
      de: Entitäts-ID für L1 Strommessung in Ampere
  - name: currentL2
    description:
      de: L2 Stromentität
      en: L2 Current Entity
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=sensor
    example: "sensor.house_current_l2"
    advanced: true
    help:
      en: Entity ID for L2 current measurement in amperes
      de: Entitäts-ID für L2 Strommessung in Ampere
  - name: currentL3
    description:
      de: L3 Stromentität
      en: L3 Current Entity
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=sensor
    example: "sensor.house_current_l3"
    advanced: true
    help:
      en: Entity ID for L3 current measurement in amperes
      de: Entitäts-ID für L3 Strommessung in Ampere
  - name: voltageL1
    description:
      de: L1 Spannungsentität
      en: L1 Voltage Entity
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=sensor
    example: "sensor.house_voltage_l1"
    advanced: true
    help:
      en: Entity ID for L1 voltage measurement in volts
      de: Entitäts-ID für L1 Spannungsmessung in Volt
  - name: voltageL2
    description:
      de: L2 Spannungsentität
      en: L2 Voltage Entity
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=sensor
    example: "sensor.house_voltage_l2"
    advanced: true
    help:
      en: Entity ID for L2 voltage measurement in volts
      de: Entitäts-ID für L2 Spannungsmessung in Volt
  - name: voltageL3
    description:
      de: L3 Spannungsentität
      en: L3 Voltage Entity
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=sensor
    example: "sensor.house_voltage_l3"
    advanced: true
    help:
      en: Entity ID for L3 voltage measurement in volts
      de: Entitäts-ID für L3 Spannungsmessung in Volt
  - name: soc
    usages: ["battery"]
    description:
      de: Batterieladestand
      en: Battery State of Charge
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=sensor
    example: "sensor.battery_soc"
    advanced: true
    help:
      en: Entity ID for battery state of charge in percent
      de: Entitäts-ID für Batterieladestand in Prozent
  - name: modeNormal
    usages: ["battery"]
    description:
      de: Normalbetrieb Skript
      en: Normal Mode Script
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=script
    example: "script.battery_normal"
    advanced: true
    help:
      en: Script to put home battery to normal operation. Required when modeHold or modeCharge is set. The script is responsible for any necessary state changes on the HA side.
      de: Skript um die Heimbatterie in den Normalbetrieb zu versetzen. Erforderlich, wenn modeHold oder modeCharge gesetzt ist. Das Skript ist verantwortlich für alle notwendigen Statusänderungen auf der HA-Seite.
  - name: modeHold
    usages: ["battery"]
    description:
      de: Halten Skript
      en: Hold Mode Script
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=script
    example: "script.battery_hold"
    advanced: true
    help:
      en: Optional script to prevent the home battery from discharging.
      de: Optionales Skript um Entladen der Heimbatterie zu verhindern.
  - name: modeCharge
    usages: ["battery"]
    description:
      de: Netzladung Skript
      en: Grid Charge Mode Script
    service: homeassistant/entities?uri={uri}&insecure={insecure}&domain=script
    example: "script.battery_grid_charge"
    advanced: true
    help:
      en: Optional script to grid-charge the home battery.
      de: Optionales Skript um die Heimbatterie aus dem Netz zu laden.
  - name: insecure
  - name: maxacpower
  - preset: battery-params
render: |
  type: homeassistant
  uri: {{ .uri }}
  home: {{ .home }} # deprecated
  insecure: {{ .insecure }}
  power: {{ .power }}
  energy: {{ .energy }}
  currents:
    - {{ .currentL1 }}
    - {{ .currentL2 }}
    - {{ .currentL3 }}
  voltages:
    - {{ .voltageL1 }}
    - {{ .voltageL2 }}
    - {{ .voltageL3 }}
  maxacpower: {{ .maxacpower }} # W
  {{- if eq .usage "battery" }}
  soc: {{ .soc }} # W
  modeNormal: {{ .modeNormal }}
  modeHold: {{ .modeHold }}
  modeCharge: {{ .modeCharge }}
  {{- include "battery-params" . }}
  {{- end }}