Vehicles: refactor common properties (evcc-io#17650)

GrimmiMeloni · Dec 8, 2024 · 782f83c · 782f83c
1 parent c273b1b
commit 782f83c
Show file tree

Hide file tree

Showing 54 changed files with 136 additions and 412 deletions.
diff --git a/templates/definition/vehicle/aiways.yaml b/templates/definition/vehicle/aiways.yaml
@@ -3,10 +3,8 @@ products:
   - brand: Aiways
 params:
   - preset: vehicle-base
-  - preset: vehicle-identify
   - name: vin
     required: true
 render: |
   type: aiways
   {{ include "vehicle-base" . }}
-  {{ include "vehicle-identify" . }}
diff --git a/templates/definition/vehicle/audi.yaml b/templates/definition/vehicle/audi.yaml
@@ -4,10 +4,8 @@ products:
   - brand: Audi
 params:
   - preset: vehicle-base
-  - preset: vehicle-identify
   - name: vin
     example: WAUZZZ...
 render: |
   type: etron
   {{ include "vehicle-base" . }}
-  {{ include "vehicle-identify" . }}
diff --git a/templates/definition/vehicle/bmw.yaml b/templates/definition/vehicle/bmw.yaml
@@ -9,38 +9,23 @@ requirements:
       Requires `hcaptcha` token. This must be generated once at https://bimmer-connected.readthedocs.io/en/latest/captcha/rest_of_world.html. The token is only valid for a short time. Please copy it into the configuration and start evcc as soon as possible after generation.
 params:
   - preset: vehicle-base
-  - preset: vehicle-identify
   - name: vin
     example: WBMW...
   - name: region
     description:
       de: Region
       en: Region
-    # values:
-    #   - NA
-    #   - EU
+    validvalues: ["NA", "EU"]
     default: EU
     advanced: true
-  - name: coarsecurrent
-    advanced: true
-  - name: welcomecharge
-    advanced: true
   - name: hcaptcha
     required: true
+  - preset: vehicle-features
 render: |
   type: bmw
   {{ include "vehicle-base" . }}
-  {{ include "vehicle-identify" . }}
   {{- if ne .region "EU" }}
   region: {{ .region }}
   {{- end }}
-  {{- if or (eq .coarsecurrent "true") (eq .welcomecharge "true") }}
-  features:
-  {{- if eq .coarsecurrent "true" }}
-  - coarsecurrent
-  {{- end }}
-  {{- if eq .welcomecharge "true" }}
-  - welcomecharge
-  {{- end }}
-  {{- end }}
+  {{ include "vehicle-features" . }}
   hcaptcha: {{ .hcaptcha }}
diff --git a/templates/definition/vehicle/carwings.yaml b/templates/definition/vehicle/carwings.yaml
@@ -5,8 +5,6 @@ products:
       generic: Leaf (pre 2019)
 params:
   - preset: vehicle-base
-  - preset: vehicle-identify
 render: |
   type: carwings
   {{ include "vehicle-base" . }}
-  {{ include "vehicle-identify" . }}
diff --git a/templates/definition/vehicle/citroen.yaml b/templates/definition/vehicle/citroen.yaml
@@ -8,10 +8,7 @@ requirements:
     en: |
       Requires `access` and `refresh` tokens. These can be generated with command `evcc token [name]`.
 params:
-  - name: title
-  - name: icon
-    default: car
-    advanced: true
+  - preset: vehicle-common
   - name: user
     required: true
   - name: password
@@ -24,10 +21,8 @@ params:
     mask: true
   - name: vin
     example: V...
-  - name: capacity
-  - name: phases
-    advanced: true
-  - preset: vehicle-identify
+  - name: cache
+    default: 15m
 render: |
   type: citroen
   vin: {{ .vin }}
@@ -36,4 +31,4 @@ render: |
     access: {{ .accessToken }}
     refresh: {{ .refreshToken }}
   {{ include "vehicle-common" . }}
-  {{ include "vehicle-identify" . }}
+  cache: {{ .cache }}
diff --git a/templates/definition/vehicle/dacia.yaml b/templates/definition/vehicle/dacia.yaml
@@ -3,13 +3,8 @@ products:
   - brand: Dacia
 params:
   - preset: vehicle-base
-  - preset: vehicle-identify
-  - name: welcomecharge
-    advanced: true
+  - preset: vehicle-features
 render: |
   type: dacia
   {{ include "vehicle-base" . }}
-  {{ include "vehicle-identify" . }}
-  {{- if eq .welcomecharge "true" }}
-  features: ["welcomecharge"]
-  {{- end }}
+  {{ include "vehicle-features" . }}
diff --git a/templates/definition/vehicle/ds.yaml b/templates/definition/vehicle/ds.yaml
@@ -8,10 +8,7 @@ requirements:
     en: |
       Requires `access` and `refresh` tokens. These can be generated with command `evcc token [name]`.
 params:
-  - name: title
-  - name: icon
-    default: car
-    advanced: true
+  - preset: vehicle-common
   - name: user
     required: true
   - name: password
@@ -24,10 +21,8 @@ params:
     mask: true
   - name: vin
     example: V...
-  - name: capacity
-  - name: phases
-    advanced: true
-  - preset: vehicle-identify
+  - name: cache
+    default: 15m
 render: |
   type: ds
   vin: {{ .vin }}
@@ -36,4 +31,4 @@ render: |
     access: {{ .accessToken }}
     refresh: {{ .refreshToken }}
   {{ include "vehicle-common" . }}
-  {{ include "vehicle-identify" . }}
+  cache: {{ .cache }}
diff --git a/templates/definition/vehicle/evnotify.yaml b/templates/definition/vehicle/evnotify.yaml
@@ -4,24 +4,15 @@ products:
       generic: evNotify
 group: generic
 params:
-  - name: title
-  - name: icon
-    default: car
-    advanced: true
   - name: akey
     required: true
   - name: token
     required: true
-  - name: capacity
-    type: float
-  - name: phases
-    advanced: true
-  - preset: vehicle-identify
+  - preset: vehicle-common
 render: |
   type: custom
   {{ include "vehicle-common" . }}
   soc:
     source: http
-    uri: https://app.evnotify.de/soc?akey={{ urlEncode .akey }}&token={{ urlEncode .token }} # evNotify Server + AKEY
+    uri: https://app.evnotify.de/soc?akey={{ urlEncode .akey }}&token={{ urlEncode .token }}
     jq: .soc_display
-  {{ include "vehicle-identify" . }}
diff --git a/templates/definition/vehicle/fiat.yaml b/templates/definition/vehicle/fiat.yaml
@@ -8,16 +8,11 @@ params:
     example: ZFAE...
   - name: pin
     mask: true
-  - preset: vehicle-identify
-  - name: welcomecharge
-    advanced: true
+  - preset: vehicle-features
 render: |
   type: fiat
   {{ include "vehicle-base" . }}
   {{- if .pin }}
   pin: {{ .pin }} # mandatory to deep refresh Soc
   {{- end }}
-  {{ include "vehicle-identify" . }}
-  {{- if eq .welcomecharge "true" }}
-  features: ["welcomecharge"]
-  {{- end }}
+  {{ include "vehicle-features" . }}
diff --git a/templates/definition/vehicle/flobz.yaml b/templates/definition/vehicle/flobz.yaml
@@ -7,47 +7,25 @@ requirements:
   description:
     generic: Remote Control of PSA car https://github.com/flobz/psa_car_controller
 params:
-  - name: title
-  - name: icon
-    default: car
-    advanced: true
   - name: url
-    required: true
     example: http://192.0.2.2
+    required: true
+  - name: vin
+    required: true
+  - preset: vehicle-common
   - name: host
     deprecated: true
   - name: port
     deprecated: true
-  - name: vin
-    required: true
-    help:
-      de: Erforderlich
-      en: Required
-  - name: capacity
-  - name: phases
-    advanced: true
   - name: wakeup_alt
     help:
       de: alternativer wakeup-Code; könnte zu erhöhter Entladung der 12V-Batterie führen.
       en: alternative wakeup-code; could lead to increased discharge of the 12V battery.
     default: false
     advanced: true
-  - preset: vehicle-identify
 render: |
   type: custom
-  {{- if .title }}
-  title: {{ .title }}
-  {{- end }}
-  {{- if .icon }}
-  icon: {{ .icon }}
-  {{- end }}
-  {{- if .capacity }}
-  capacity: {{ .capacity }}
-  {{- end }}
-  {{- if .phases }}
-  phases: {{ .phases }}
-  {{- end }}
-  {{- include "vehicle-identify" . }}
+  {{- include "vehicle-common" . }}
   soc:
     {{- include "source" . | indent 2 }}
     jq: .energy[0].level

diff --git a/templates/definition/vehicle/ford-connect.yaml b/templates/definition/vehicle/ford-connect.yaml
@@ -2,10 +2,7 @@ template: ford-connect
 products:
   - brand: Ford
 params:
-  - name: title
-  - name: icon
-    default: car
-    advanced: true
+  - preset: vehicle-common
   - name: clientid
     description:
       generic: FordConnect API Client ID
@@ -28,11 +25,8 @@ params:
     mask: true
   - name: vin
     example: WF0FXX...
-  - name: capacity
-    default: 10
-  - name: phases
-    advanced: true
-  - preset: vehicle-identify
+  - name: cache
+    default: 15m
 render: |
   type: ford-connect
   vin: {{ .vin }}
@@ -43,4 +37,4 @@ render: |
     access: {{ .accessToken }}
     refresh: {{ .refreshToken }}
   {{ include "vehicle-common" . }}
-  {{ include "vehicle-identify" . }}
+  cache: {{ .cache }}
diff --git a/templates/definition/vehicle/ford.yaml b/templates/definition/vehicle/ford.yaml
@@ -4,7 +4,6 @@ products:
   - brand: Ford
 params:
   - preset: vehicle-base
-  - preset: vehicle-identify
   - name: vin
     example: WF0FXX...
   - name: domain
@@ -13,5 +12,4 @@ params:
 render: |
   type: ford
   {{ include "vehicle-base" . }}
-  {{ include "vehicle-identify" . }}
   domain: {{ .domain }}
diff --git a/templates/definition/vehicle/hyundai.yaml b/templates/definition/vehicle/hyundai.yaml
@@ -10,9 +10,7 @@ requirements:
 params:
   - preset: vehicle-base
   - preset: vehicle-language
-  - preset: vehicle-identify
 render: |
   type: hyundai
   {{ include "vehicle-base" . }}
   {{ include "vehicle-language" . }}
-  {{ include "vehicle-identify" . }}
diff --git a/templates/definition/vehicle/ioBroker.bmw.yaml b/templates/definition/vehicle/ioBroker.bmw.yaml
@@ -8,17 +8,9 @@ requirements:
     en: ioBroker BMW Adapter. Requires ioBroker.bmw and ioBroker.simple-api
     de: ioBroker BMW Adapter. Benötigt ioBroker.bmw und ioBroker.simple-api
 params:
-  - name: title
-  - name: icon
-    default: car
-    advanced: true
-  - name: capacity
-    type: float
-  - name: phases
-    advanced: true
+  - preset: vehicle-common
   - name: vin
     example: WBMW...
-  - preset: vehicle-identify
   - name: uri
     help:
       generic: ioBroker URL
@@ -29,14 +21,10 @@ params:
       de: Instanz-ID
       en: Instance ID
     advanced: true
-  - name: coarsecurrent
-    advanced: true
-  - name: welcomecharge
-    advanced: true
+  - preset: vehicle-features
 render: |
   type: custom
   {{ include "vehicle-common" . }}
-  {{ include "vehicle-identify" . }}
   soc:
     source: http
     uri: {{ .uri }}/getPlainValue/bmw.{{ .id }}.{{ .vin }}.state.electricChargingState.chargingLevelPercent
@@ -55,12 +43,4 @@ render: |
   odometer:
     source: http
     uri: {{ .uri }}/getPlainValue/bmw.{{ .id }}.{{ .vin }}.state.currentMileage
-  {{- if or (eq .coarsecurrent "true") (eq .welcomecharge "true") }}
-  features:
-  {{- if eq .coarsecurrent "true" }}
-  - coarsecurrent
-  {{- end }}
-  {{- if eq .welcomecharge "true" }}
-  - welcomecharge
-  {{- end }}
-  {{- end }}
+  {{ include "vehicle-features" . }}
diff --git a/templates/definition/vehicle/iso15118.yaml b/templates/definition/vehicle/iso15118.yaml
@@ -17,19 +17,11 @@ requirements:
       This requires an active location-based charging profile with the lowest minimum charge (25%) and direct charging disabled.
       Otherwise the vehicle cannot be put into sleep mode.
 params:
-  - name: title
-  - name: icon
-    default: car
-    advanced: true
-  - name: capacity
-  - name: phases
-    advanced: true
-  - preset: vehicle-identify
+  - preset: vehicle-common
 render: |
   type: custom
   {{- include "vehicle-common" . }}
   features: ["offline"]
   soc:
     source: const
     value: 0
-  {{ include "vehicle-identify" . }}
diff --git a/templates/definition/vehicle/jaguar-landrover.yaml b/templates/definition/vehicle/jaguar-landrover.yaml
@@ -5,8 +5,6 @@ products:
   - brand: Land Rover
 params:
   - preset: vehicle-base
-  - preset: vehicle-identify
 render: |
   type: jaguar
   {{ include "vehicle-base" . }}
-  {{ include "vehicle-identify" . }}
diff --git a/templates/definition/vehicle/kia.yaml b/templates/definition/vehicle/kia.yaml
@@ -10,9 +10,7 @@ requirements:
 params:
   - preset: vehicle-base
   - preset: vehicle-language
-  - preset: vehicle-identify
 render: |
   type: kia
   {{ include "vehicle-base" . }}
   {{ include "vehicle-language" . }}
-  {{ include "vehicle-identify" . }}