From f780fac4bff78cdc26aec8cc1491931221eb6e2d Mon Sep 17 00:00:00 2001
From: Milad <milad@high-mobility.com>
Date: Wed, 12 Jun 2024 16:57:23 +0200
Subject: [PATCH] add L13.4 properties

---
 hm-vehicle-data-api-v1.yml | 80 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)

diff --git a/hm-vehicle-data-api-v1.yml b/hm-vehicle-data-api-v1.yml
index 3ada08b..d406e65 100644
--- a/hm-vehicle-data-api-v1.yml
+++ b/hm-vehicle-data-api-v1.yml
@@ -295,6 +295,9 @@ components:
         current_limit:
           $ref: '#/components/schemas/property_electric_current'
           description: Limit for the charging current.
+        conserving_charge:
+          $ref: '#/components/schemas/property_active_state'
+          description: Indicates if the vehicle is conserving charge.
         hybrid_operating_mode:
           $ref: '#/components/schemas/property_hybrid_operating_mode'
           description: Operating mode of the hybrid vehicle.
@@ -386,6 +389,9 @@ components:
         battery_temperature_control_demand:
           $ref: '#/components/schemas/property_battery_temperature_control_demand'
           description: Current demand of HV battery temperature control system.
+        charging_scenario:
+          $ref: '#/components/schemas/property_charging_scenario'
+          description: Charging scenario.
         battery_level:
           $ref: '#/components/schemas/property_percentage'
           description: Battery level percentage between 0.0-1.0
@@ -411,6 +417,9 @@ components:
         preconditioning_error:
           $ref: '#/components/schemas/property_preconditioning_error'
           description: Preconditioning error if one is encountered
+        charging_rate_distance:
+          $ref: '#/components/schemas/property_distance_over_time'
+          description: Range increase per time unit during ongoing charging process based on the average energy comsumption for driving.
         timers:
           description: Timers
           items:
@@ -797,6 +806,11 @@ components:
           items:
             $ref: '#/components/schemas/property_dashboard_light'
           type: array
+        dynamic_warnings:
+          description: Dynamic warnings
+          items:
+            $ref: '#/components/schemas/property_dynamic_warning'
+          type: array
     property_percentage:
       additionalProperties: false
       minProperties: 1
@@ -1366,6 +1380,7 @@ components:
             - green_flashing
             - initialising
             - error
+            - blue
           type: string
         failure:
           $ref: '#/components/schemas/custom_type_failure'
@@ -2263,6 +2278,9 @@ components:
         engine_oil_service_status:
           $ref: '#/components/schemas/property_service_status'
           description: Engine oil service status
+        estimated_primary_powertrain_range:
+          $ref: '#/components/schemas/property_length'
+          description: Estimated primary powertrain range
         diesel_exhaust_filter_status:
           description: Diesel exhaust filter status
           items:
@@ -2288,6 +2306,18 @@ components:
           format: date-time
           type: string
       type: object
+    property_dynamic_warning:
+      additionalProperties: false
+      minProperties: 1
+      properties:
+        data:
+          $ref: '#/components/schemas/custom_type_dynamic_warning'
+        failure:
+          $ref: '#/components/schemas/custom_type_failure'
+        timestamp:
+          format: date-time
+          type: string
+      type: object
     power_takeoff:
       properties:
         engaged:
@@ -2954,6 +2984,24 @@ components:
         - unit
         - value
       type: object
+    custom_type_dynamic_warning:
+      additionalProperties: false
+      description: Dynamic warning
+      properties:
+        category:
+          description: Category of the warning
+          type: string
+        description:
+          description: Description of the warning
+          type: string
+        id:
+          description: Identifier of the warning
+          type: string
+      required:
+        - category
+        - id
+        - description
+      type: object
     property_diesel_exhaust_filter_status:
       additionalProperties: false
       minProperties: 1
@@ -4348,6 +4396,7 @@ components:
             - digital_communication_established
             - digital_communication_ended
             - station_ready
+            - active
           type: string
         failure:
           $ref: '#/components/schemas/custom_type_failure'
@@ -4522,6 +4571,37 @@ components:
         - id
         - distance
       type: object
+    property_charging_scenario:
+      additionalProperties: false
+      minProperties: 1
+      properties:
+        data:
+          enum:
+            - 'off'
+            - charging_to_departure_time_finished
+            - immediately_charging_finished
+            - optimised_charging_finished
+            - charging_to_departure_time_active
+            - immediately_charging_active
+            - optimised_charging_active
+            - charging_to_departure_time_waiting
+            - optimised_charging_waiting
+            - no_grid_voltage
+            - error_lock
+            - error_charging_system
+            - initialization_charging_communication
+            - immediately_optimised_charging_active
+            - immediately_optimised_charging_finished
+            - emergency_charging
+            - charging_interrupt_by_user
+            - plug_releasable
+          type: string
+        failure:
+          $ref: '#/components/schemas/custom_type_failure'
+        timestamp:
+          format: date-time
+          type: string
+      type: object
     property_trip_meter:
       additionalProperties: false
       minProperties: 1