[SDL 0269] New vehicle data ClimateData

lib/js/src/rpc/enums/VehicleDataType.js

@@ -1,6 +1,6 @@
 /* eslint-disable camelcase */
 /*
-* Copyright (c) 2020, SmartDeviceLink Consortium, Inc.
+* Copyright (c) 2021, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
@@ -97,8 +97,19 @@ class VehicleDataType extends Enum {
         return VehicleDataType._MAP.VEHICLEDATA_FUELCONSUMPTION;
     }
 
+    /**
+     * Get the enum value for VEHICLEDATA_CLIMATEDATA.
+     * @since SmartDeviceLink 7.1.0
+     * @returns {String} - The enum value.
+     */
+    static get VEHICLEDATA_CLIMATEDATA () {
+        return VehicleDataType._MAP.VEHICLEDATA_CLIMATEDATA;
+    }
+
     /**
      * Get the enum value for VEHICLEDATA_EXTERNTEMP.
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
      * @returns {String} - The enum value.
      */
     static get VEHICLEDATA_EXTERNTEMP () {
@@ -390,6 +401,7 @@ VehicleDataType._MAP = Object.freeze({
     'VEHICLEDATA_FUELLEVEL': 'VEHICLEDATA_FUELLEVEL',
     'VEHICLEDATA_FUELLEVEL_STATE': 'VEHICLEDATA_FUELLEVEL_STATE',
     'VEHICLEDATA_FUELCONSUMPTION': 'VEHICLEDATA_FUELCONSUMPTION',
+    'VEHICLEDATA_CLIMATEDATA': 'VEHICLEDATA_CLIMATEDATA',
     'VEHICLEDATA_EXTERNTEMP': 'VEHICLEDATA_EXTERNTEMP',
     'VEHICLEDATA_VIN': 'VEHICLEDATA_VIN',
     'VEHICLEDATA_GEARSTATUS': 'VEHICLEDATA_GEARSTATUS',

lib/js/src/rpc/messages/GetVehicleData.js

@@ -1,6 +1,6 @@
 /* eslint-disable camelcase */
 /*
-* Copyright (c) 2020, SmartDeviceLink Consortium, Inc.
+* Copyright (c) 2021, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
@@ -204,9 +204,30 @@ class GetVehicleData extends RpcRequest {
         return this.getParameter(GetVehicleData.KEY_FUEL_RANGE);
     }
 
+    /**
+     * Set the ClimateData
+     * @since SmartDeviceLink 7.1.0
+     * @param {Boolean} data - See ClimateData - The desired ClimateData.
+     * @returns {GetVehicleData} - The class instance for method chaining.
+     */
+    setClimateData (data) {
+        this.setParameter(GetVehicleData.KEY_CLIMATE_DATA, data);
+        return this;
+    }
+
+    /**
+     * Get the ClimateData
+     * @returns {Boolean} - the KEY_CLIMATE_DATA value
+     */
+    getClimateData () {
+        return this.getParameter(GetVehicleData.KEY_CLIMATE_DATA);
+    }
+
     /**
      * Set the ExternalTemperature
-     * @param {Boolean} temperature - The external temperature in degrees celsius - The desired ExternalTemperature.
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
+     * @param {Boolean} temperature - The external temperature in degrees celsius. This parameter is deprecated starting RPC Spec 7.1, please see climateData. - The desired ExternalTemperature.
      * @returns {GetVehicleData} - The class instance for method chaining.
      */
     setExternalTemperature (temperature) {
@@ -216,6 +237,8 @@ class GetVehicleData extends RpcRequest {
 
     /**
      * Get the ExternalTemperature
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
      * @returns {Boolean} - the KEY_EXTERNAL_TEMPERATURE value
      */
     getExternalTemperature () {
@@ -727,6 +750,7 @@ GetVehicleData.KEY_FUEL_LEVEL = 'fuelLevel';
 GetVehicleData.KEY_FUEL_LEVEL_STATE = 'fuelLevel_State';
 GetVehicleData.KEY_INSTANT_FUEL_CONSUMPTION = 'instantFuelConsumption';
 GetVehicleData.KEY_FUEL_RANGE = 'fuelRange';
+GetVehicleData.KEY_CLIMATE_DATA = 'climateData';
 GetVehicleData.KEY_EXTERNAL_TEMPERATURE = 'externalTemperature';
 GetVehicleData.KEY_TURN_SIGNAL = 'turnSignal';
 GetVehicleData.KEY_VIN = 'vin';

lib/js/src/rpc/messages/GetVehicleDataResponse.js

@@ -1,6 +1,6 @@
 /* eslint-disable camelcase */
 /*
-* Copyright (c) 2020, SmartDeviceLink Consortium, Inc.
+* Copyright (c) 2021, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
@@ -34,6 +34,7 @@
 import { AirbagStatus } from '../structs/AirbagStatus.js';
 import { BeltStatus } from '../structs/BeltStatus.js';
 import { BodyInformation } from '../structs/BodyInformation.js';
+import { ClimateData } from '../structs/ClimateData.js';
 import { ClusterModeStatus } from '../structs/ClusterModeStatus.js';
 import { ComponentVolumeStatus } from '../enums/ComponentVolumeStatus.js';
 import { DeviceStatus } from '../structs/DeviceStatus.js';
@@ -231,9 +232,31 @@ class GetVehicleDataResponse extends RpcResponse {
         return this.getObject(FuelRange, GetVehicleDataResponse.KEY_FUEL_RANGE);
     }
 
+    /**
+     * Set the ClimateData
+     * @since SmartDeviceLink 7.1.0
+     * @param {ClimateData} data - See ClimateData - The desired ClimateData.
+     * @returns {GetVehicleDataResponse} - The class instance for method chaining.
+     */
+    setClimateData (data) {
+        this._validateType(ClimateData, data);
+        this.setParameter(GetVehicleDataResponse.KEY_CLIMATE_DATA, data);
+        return this;
+    }
+
+    /**
+     * Get the ClimateData
+     * @returns {ClimateData} - the KEY_CLIMATE_DATA value
+     */
+    getClimateData () {
+        return this.getObject(ClimateData, GetVehicleDataResponse.KEY_CLIMATE_DATA);
+    }
+
     /**
      * Set the ExternalTemperature
-     * @param {Number} temperature - The external temperature in degrees celsius - The desired ExternalTemperature.
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
+     * @param {Number} temperature - The external temperature in degrees celsius. This parameter is deprecated starting RPC Spec 7.1, please see climateData. - The desired ExternalTemperature.
      * {'num_min_value': -40.0, 'num_max_value': 100.0}
      * @returns {GetVehicleDataResponse} - The class instance for method chaining.
      */
@@ -244,6 +267,8 @@ class GetVehicleDataResponse extends RpcResponse {
 
     /**
      * Get the ExternalTemperature
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
      * @returns {Number} - the KEY_EXTERNAL_TEMPERATURE value
      */
     getExternalTemperature () {
@@ -782,6 +807,7 @@ GetVehicleDataResponse.KEY_FUEL_LEVEL = 'fuelLevel';
 GetVehicleDataResponse.KEY_FUEL_LEVEL_STATE = 'fuelLevel_State';
 GetVehicleDataResponse.KEY_INSTANT_FUEL_CONSUMPTION = 'instantFuelConsumption';
 GetVehicleDataResponse.KEY_FUEL_RANGE = 'fuelRange';
+GetVehicleDataResponse.KEY_CLIMATE_DATA = 'climateData';
 GetVehicleDataResponse.KEY_EXTERNAL_TEMPERATURE = 'externalTemperature';
 GetVehicleDataResponse.KEY_TURN_SIGNAL = 'turnSignal';
 GetVehicleDataResponse.KEY_VIN = 'vin';

lib/js/src/rpc/messages/OnVehicleData.js

@@ -1,6 +1,6 @@
 /* eslint-disable camelcase */
 /*
-* Copyright (c) 2020, SmartDeviceLink Consortium, Inc.
+* Copyright (c) 2021, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
@@ -34,6 +34,7 @@
 import { AirbagStatus } from '../structs/AirbagStatus.js';
 import { BeltStatus } from '../structs/BeltStatus.js';
 import { BodyInformation } from '../structs/BodyInformation.js';
+import { ClimateData } from '../structs/ClimateData.js';
 import { ClusterModeStatus } from '../structs/ClusterModeStatus.js';
 import { ComponentVolumeStatus } from '../enums/ComponentVolumeStatus.js';
 import { DeviceStatus } from '../structs/DeviceStatus.js';
@@ -210,9 +211,31 @@ class OnVehicleData extends RpcNotification {
         return this.getObject(FuelRange, OnVehicleData.KEY_FUEL_RANGE);
     }
 
+    /**
+     * Set the ClimateData
+     * @since SmartDeviceLink 7.1.0
+     * @param {ClimateData} data - See ClimateData - The desired ClimateData.
+     * @returns {OnVehicleData} - The class instance for method chaining.
+     */
+    setClimateData (data) {
+        this._validateType(ClimateData, data);
+        this.setParameter(OnVehicleData.KEY_CLIMATE_DATA, data);
+        return this;
+    }
+
+    /**
+     * Get the ClimateData
+     * @returns {ClimateData} - the KEY_CLIMATE_DATA value
+     */
+    getClimateData () {
+        return this.getObject(ClimateData, OnVehicleData.KEY_CLIMATE_DATA);
+    }
+
     /**
      * Set the ExternalTemperature
-     * @param {Number} temperature - The external temperature in degrees celsius - The desired ExternalTemperature.
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
+     * @param {Number} temperature - The external temperature in degrees celsius. This parameter is deprecated starting RPC Spec 7.1, please see climateData. - The desired ExternalTemperature.
      * {'num_min_value': -40.0, 'num_max_value': 100.0}
      * @returns {OnVehicleData} - The class instance for method chaining.
      */
@@ -223,6 +246,8 @@ class OnVehicleData extends RpcNotification {
 
     /**
      * Get the ExternalTemperature
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
      * @returns {Number} - the KEY_EXTERNAL_TEMPERATURE value
      */
     getExternalTemperature () {
@@ -761,6 +786,7 @@ OnVehicleData.KEY_FUEL_LEVEL = 'fuelLevel';
 OnVehicleData.KEY_FUEL_LEVEL_STATE = 'fuelLevel_State';
 OnVehicleData.KEY_INSTANT_FUEL_CONSUMPTION = 'instantFuelConsumption';
 OnVehicleData.KEY_FUEL_RANGE = 'fuelRange';
+OnVehicleData.KEY_CLIMATE_DATA = 'climateData';
 OnVehicleData.KEY_EXTERNAL_TEMPERATURE = 'externalTemperature';
 OnVehicleData.KEY_TURN_SIGNAL = 'turnSignal';
 OnVehicleData.KEY_VIN = 'vin';

lib/js/src/rpc/messages/SubscribeVehicleData.js

@@ -1,6 +1,6 @@
 /* eslint-disable camelcase */
 /*
-* Copyright (c) 2020, SmartDeviceLink Consortium, Inc.
+* Copyright (c) 2021, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
@@ -204,9 +204,30 @@ class SubscribeVehicleData extends RpcRequest {
         return this.getParameter(SubscribeVehicleData.KEY_FUEL_RANGE);
     }
 
+    /**
+     * Set the ClimateData
+     * @since SmartDeviceLink 7.1.0
+     * @param {Boolean} data - See ClimateData - The desired ClimateData.
+     * @returns {SubscribeVehicleData} - The class instance for method chaining.
+     */
+    setClimateData (data) {
+        this.setParameter(SubscribeVehicleData.KEY_CLIMATE_DATA, data);
+        return this;
+    }
+
+    /**
+     * Get the ClimateData
+     * @returns {Boolean} - the KEY_CLIMATE_DATA value
+     */
+    getClimateData () {
+        return this.getParameter(SubscribeVehicleData.KEY_CLIMATE_DATA);
+    }
+
     /**
      * Set the ExternalTemperature
-     * @param {Boolean} temperature - The external temperature in degrees celsius - The desired ExternalTemperature.
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
+     * @param {Boolean} temperature - The external temperature in degrees celsius. This parameter is deprecated starting RPC Spec 7.1, please see climateData. - The desired ExternalTemperature.
      * @returns {SubscribeVehicleData} - The class instance for method chaining.
      */
     setExternalTemperature (temperature) {
@@ -216,6 +237,8 @@ class SubscribeVehicleData extends RpcRequest {
 
     /**
      * Get the ExternalTemperature
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
      * @returns {Boolean} - the KEY_EXTERNAL_TEMPERATURE value
      */
     getExternalTemperature () {
@@ -709,6 +732,7 @@ SubscribeVehicleData.KEY_FUEL_LEVEL = 'fuelLevel';
 SubscribeVehicleData.KEY_FUEL_LEVEL_STATE = 'fuelLevel_State';
 SubscribeVehicleData.KEY_INSTANT_FUEL_CONSUMPTION = 'instantFuelConsumption';
 SubscribeVehicleData.KEY_FUEL_RANGE = 'fuelRange';
+SubscribeVehicleData.KEY_CLIMATE_DATA = 'climateData';
 SubscribeVehicleData.KEY_EXTERNAL_TEMPERATURE = 'externalTemperature';
 SubscribeVehicleData.KEY_TURN_SIGNAL = 'turnSignal';
 SubscribeVehicleData.KEY_GEAR_STATUS = 'gearStatus';

lib/js/src/rpc/messages/SubscribeVehicleDataResponse.js

@@ -1,6 +1,6 @@
 /* eslint-disable camelcase */
 /*
-* Copyright (c) 2020, SmartDeviceLink Consortium, Inc.
+* Copyright (c) 2021, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
@@ -209,9 +209,31 @@ class SubscribeVehicleDataResponse extends RpcResponse {
         return this.getObject(VehicleDataResult, SubscribeVehicleDataResponse.KEY_FUEL_RANGE);
     }
 
+    /**
+     * Set the ClimateData
+     * @since SmartDeviceLink 7.1.0
+     * @param {VehicleDataResult} data - See ClimateData - The desired ClimateData.
+     * @returns {SubscribeVehicleDataResponse} - The class instance for method chaining.
+     */
+    setClimateData (data) {
+        this._validateType(VehicleDataResult, data);
+        this.setParameter(SubscribeVehicleDataResponse.KEY_CLIMATE_DATA, data);
+        return this;
+    }
+
+    /**
+     * Get the ClimateData
+     * @returns {VehicleDataResult} - the KEY_CLIMATE_DATA value
+     */
+    getClimateData () {
+        return this.getObject(VehicleDataResult, SubscribeVehicleDataResponse.KEY_CLIMATE_DATA);
+    }
+
     /**
      * Set the ExternalTemperature
-     * @param {VehicleDataResult} temperature - The external temperature in degrees celsius. - The desired ExternalTemperature.
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
+     * @param {VehicleDataResult} temperature - The external temperature in degrees celsius. This parameter is deprecated starting RPC Spec 7.1, please see climateData. - The desired ExternalTemperature.
      * @returns {SubscribeVehicleDataResponse} - The class instance for method chaining.
      */
     setExternalTemperature (temperature) {
@@ -222,6 +244,8 @@ class SubscribeVehicleDataResponse extends RpcResponse {
 
     /**
      * Get the ExternalTemperature
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
      * @returns {VehicleDataResult} - the KEY_EXTERNAL_TEMPERATURE value
      */
     getExternalTemperature () {
@@ -741,6 +765,7 @@ SubscribeVehicleDataResponse.KEY_FUEL_LEVEL = 'fuelLevel';
 SubscribeVehicleDataResponse.KEY_FUEL_LEVEL_STATE = 'fuelLevel_State';
 SubscribeVehicleDataResponse.KEY_INSTANT_FUEL_CONSUMPTION = 'instantFuelConsumption';
 SubscribeVehicleDataResponse.KEY_FUEL_RANGE = 'fuelRange';
+SubscribeVehicleDataResponse.KEY_CLIMATE_DATA = 'climateData';
 SubscribeVehicleDataResponse.KEY_EXTERNAL_TEMPERATURE = 'externalTemperature';
 SubscribeVehicleDataResponse.KEY_TURN_SIGNAL = 'turnSignal';
 SubscribeVehicleDataResponse.KEY_GEAR_STATUS = 'gearStatus';

lib/js/src/rpc/messages/UnsubscribeVehicleData.js

@@ -1,6 +1,6 @@
 /* eslint-disable camelcase */
 /*
-* Copyright (c) 2020, SmartDeviceLink Consortium, Inc.
+* Copyright (c) 2021, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
@@ -204,9 +204,30 @@ class UnsubscribeVehicleData extends RpcRequest {
         return this.getParameter(UnsubscribeVehicleData.KEY_FUEL_RANGE);
     }
 
+    /**
+     * Set the ClimateData
+     * @since SmartDeviceLink 7.1.0
+     * @param {Boolean} data - See ClimateData - The desired ClimateData.
+     * @returns {UnsubscribeVehicleData} - The class instance for method chaining.
+     */
+    setClimateData (data) {
+        this.setParameter(UnsubscribeVehicleData.KEY_CLIMATE_DATA, data);
+        return this;
+    }
+
+    /**
+     * Get the ClimateData
+     * @returns {Boolean} - the KEY_CLIMATE_DATA value
+     */
+    getClimateData () {
+        return this.getParameter(UnsubscribeVehicleData.KEY_CLIMATE_DATA);
+    }
+
     /**
      * Set the ExternalTemperature
-     * @param {Boolean} temperature - The external temperature in degrees celsius. - The desired ExternalTemperature.
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
+     * @param {Boolean} temperature - The external temperature in degrees celsius. This parameter is deprecated starting RPC Spec 7.1, please see climateData. - The desired ExternalTemperature.
      * @returns {UnsubscribeVehicleData} - The class instance for method chaining.
      */
     setExternalTemperature (temperature) {
@@ -216,6 +237,8 @@ class UnsubscribeVehicleData extends RpcRequest {
 
     /**
      * Get the ExternalTemperature
+     * @since SmartDeviceLink 2.0.0
+     * @deprecated in SmartDeviceLink 7.1.0
      * @returns {Boolean} - the KEY_EXTERNAL_TEMPERATURE value
      */
     getExternalTemperature () {
@@ -709,6 +732,7 @@ UnsubscribeVehicleData.KEY_FUEL_LEVEL = 'fuelLevel';
 UnsubscribeVehicleData.KEY_FUEL_LEVEL_STATE = 'fuelLevel_State';
 UnsubscribeVehicleData.KEY_INSTANT_FUEL_CONSUMPTION = 'instantFuelConsumption';
 UnsubscribeVehicleData.KEY_FUEL_RANGE = 'fuelRange';
+UnsubscribeVehicleData.KEY_CLIMATE_DATA = 'climateData';
 UnsubscribeVehicleData.KEY_EXTERNAL_TEMPERATURE = 'externalTemperature';
 UnsubscribeVehicleData.KEY_TURN_SIGNAL = 'turnSignal';
 UnsubscribeVehicleData.KEY_GEAR_STATUS = 'gearStatus';