ClimateControlCapabilities Class Reference
Constructors
Instance Methods
- getAcEnableAvailable() ⇒
Boolean - getAcMaxEnableAvailable() ⇒
Boolean - getAutoModeEnableAvailable() ⇒
Boolean - getCirculateAirEnableAvailable() ⇒
Boolean - getClimateEnableAvailable() ⇒
Boolean - getCurrentTemperatureAvailable() ⇒
Boolean - getDefrostZone() ⇒
Array.<DefrostZone> - getDefrostZoneAvailable() ⇒
Boolean - getDesiredTemperatureAvailable() ⇒
Boolean - getDualModeEnableAvailable() ⇒
Boolean - getFanSpeedAvailable() ⇒
Boolean - getHeatedMirrorsAvailable() ⇒
Boolean - getHeatedRearWindowAvailable() ⇒
Boolean - getHeatedSteeringWheelAvailable() ⇒
Boolean - getHeatedWindshieldAvailable() ⇒
Boolean - getModuleInfo() ⇒
ModuleInfo - getModuleName() ⇒
String - getVentilationMode() ⇒
Array.<VentilationMode> - getVentilationModeAvailable() ⇒
Boolean - setAcEnableAvailable(available) ⇒
ClimateControlCapabilities - setAcMaxEnableAvailable(available) ⇒
ClimateControlCapabilities - setAutoModeEnableAvailable(available) ⇒
ClimateControlCapabilities - setCirculateAirEnableAvailable(available) ⇒
ClimateControlCapabilities - setClimateEnableAvailable(available) ⇒
ClimateControlCapabilities - setCurrentTemperatureAvailable(available) ⇒
ClimateControlCapabilities - setDefrostZone(zone) ⇒
ClimateControlCapabilities - setDefrostZoneAvailable(available) ⇒
ClimateControlCapabilities - setDesiredTemperatureAvailable(available) ⇒
ClimateControlCapabilities - setDualModeEnableAvailable(available) ⇒
ClimateControlCapabilities - setFanSpeedAvailable(available) ⇒
ClimateControlCapabilities - setHeatedMirrorsAvailable(available) ⇒
ClimateControlCapabilities - setHeatedRearWindowAvailable(available) ⇒
ClimateControlCapabilities - setHeatedSteeringWheelAvailable(available) ⇒
ClimateControlCapabilities - setHeatedWindshieldAvailable(available) ⇒
ClimateControlCapabilities - setModuleInfo(info) ⇒
ClimateControlCapabilities - setModuleName(name) ⇒
ClimateControlCapabilities - setVentilationMode(mode) ⇒
ClimateControlCapabilities - setVentilationModeAvailable(available) ⇒
ClimateControlCapabilities
Constructors
new ClimateControlCapabilities(parameters)
Initializes an instance of ClimateControlCapabilities.
Instance Methods
climateControlCapabilities.getAcEnableAvailable() ⇒ Boolean
Get the AcEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_AC_ENABLE_AVAILABLE value
climateControlCapabilities.getAcMaxEnableAvailable() ⇒ Boolean
Get the AcMaxEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_AC_MAX_ENABLE_AVAILABLE value
climateControlCapabilities.getAutoModeEnableAvailable() ⇒ Boolean
Get the AutoModeEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_AUTO_MODE_ENABLE_AVAILABLE value
climateControlCapabilities.getCirculateAirEnableAvailable() ⇒ Boolean
Get the CirculateAirEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_CIRCULATE_AIR_ENABLE_AVAILABLE value
climateControlCapabilities.getClimateEnableAvailable() ⇒ Boolean
Get the ClimateEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_CLIMATE_ENABLE_AVAILABLE value
climateControlCapabilities.getCurrentTemperatureAvailable() ⇒ Boolean
Get the CurrentTemperatureAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_CURRENT_TEMPERATURE_AVAILABLE value
climateControlCapabilities.getDefrostZone() ⇒ Array.<DefrostZone>
Get the DefrostZone
Kind: Instance method of ClimateControlCapabilities
Returns: Array.<DefrostZone> - the KEY_DEFROST_ZONE value
climateControlCapabilities.getDefrostZoneAvailable() ⇒ Boolean
Get the DefrostZoneAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_DEFROST_ZONE_AVAILABLE value
climateControlCapabilities.getDesiredTemperatureAvailable() ⇒ Boolean
Get the DesiredTemperatureAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_DESIRED_TEMPERATURE_AVAILABLE value
climateControlCapabilities.getDualModeEnableAvailable() ⇒ Boolean
Get the DualModeEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_DUAL_MODE_ENABLE_AVAILABLE value
climateControlCapabilities.getFanSpeedAvailable() ⇒ Boolean
Get the FanSpeedAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_FAN_SPEED_AVAILABLE value
climateControlCapabilities.getHeatedMirrorsAvailable() ⇒ Boolean
Get the HeatedMirrorsAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_HEATED_MIRRORS_AVAILABLE value
climateControlCapabilities.getHeatedRearWindowAvailable() ⇒ Boolean
Get the HeatedRearWindowAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_HEATED_REAR_WINDOW_AVAILABLE value
climateControlCapabilities.getHeatedSteeringWheelAvailable() ⇒ Boolean
Get the HeatedSteeringWheelAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_HEATED_STEERING_WHEEL_AVAILABLE value
climateControlCapabilities.getHeatedWindshieldAvailable() ⇒ Boolean
Get the HeatedWindshieldAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_HEATED_WINDSHIELD_AVAILABLE value
climateControlCapabilities.getModuleInfo() ⇒ ModuleInfo
Get the ModuleInfo
Kind: Instance method of ClimateControlCapabilities
Returns: ModuleInfo - the KEY_MODULE_INFO value
climateControlCapabilities.getModuleName() ⇒ String
Get the ModuleName
Kind: Instance method of ClimateControlCapabilities
Returns: String - the KEY_MODULE_NAME value
climateControlCapabilities.getVentilationMode() ⇒ Array.<VentilationMode>
Get the VentilationMode
Kind: Instance method of ClimateControlCapabilities
Returns: Array.<VentilationMode> - the KEY_VENTILATION_MODE value
climateControlCapabilities.getVentilationModeAvailable() ⇒ Boolean
Get the VentilationModeAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: Boolean - the KEY_VENTILATION_MODE_AVAILABLE value
climateControlCapabilities.setAcEnableAvailable(available) ⇒ ClimateControlCapabilities
Set the AcEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of turn on/off AC. True: Available, False: Not Available, Not present: Not Available. - The desired AcEnableAvailable. |
climateControlCapabilities.setAcMaxEnableAvailable(available) ⇒ ClimateControlCapabilities
Set the AcMaxEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of enable/disable air conditioning is ON on the maximum level. True: Available, False: Not Available, Not present: Not Available. - The desired AcMaxEnableAvailable. |
climateControlCapabilities.setAutoModeEnableAvailable(available) ⇒ ClimateControlCapabilities
Set the AutoModeEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of enable/disable auto mode. True: Available, False: Not Available, Not present: Not Available. - The desired AutoModeEnableAvailable. |
climateControlCapabilities.setCirculateAirEnableAvailable(available) ⇒ ClimateControlCapabilities
Set the CirculateAirEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of enable/disable circulate Air mode. True: Available, False: Not Available, Not present: Not Available. - The desired CirculateAirEnableAvailable. |
climateControlCapabilities.setClimateEnableAvailable(available) ⇒ ClimateControlCapabilities
Set the ClimateEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of enable/disable climate control. True: Available, False: Not Available, Not present: Not Available. - The desired ClimateEnableAvailable. |
climateControlCapabilities.setCurrentTemperatureAvailable(available) ⇒ ClimateControlCapabilities
Set the CurrentTemperatureAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the reading of current temperature. True: Available, False: Not Available, Not present: Not Available. - The desired CurrentTemperatureAvailable. |
climateControlCapabilities.setDefrostZone(zone) ⇒ ClimateControlCapabilities
Set the DefrostZone
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| zone | Array.<DefrostZone> |
A set of all defrost zones that are controllable. - The desired DefrostZone. {'array_min_size': 1, 'array_max_size': 100} |
climateControlCapabilities.setDefrostZoneAvailable(available) ⇒ ClimateControlCapabilities
Set the DefrostZoneAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of defrost zones. True: Available, False: Not Available, Not present: Not Available. - The desired DefrostZoneAvailable. |
climateControlCapabilities.setDesiredTemperatureAvailable(available) ⇒ ClimateControlCapabilities
Set the DesiredTemperatureAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of desired temperature. True: Available, False: Not Available, Not present: Not Available. - The desired DesiredTemperatureAvailable. |
climateControlCapabilities.setDualModeEnableAvailable(available) ⇒ ClimateControlCapabilities
Set the DualModeEnableAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of enable/disable dual mode. True: Available, False: Not Available, Not present: Not Available. - The desired DualModeEnableAvailable. |
climateControlCapabilities.setFanSpeedAvailable(available) ⇒ ClimateControlCapabilities
Set the FanSpeedAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of fan speed. True: Available, False: Not Available, Not present: Not Available. - The desired FanSpeedAvailable. |
climateControlCapabilities.setHeatedMirrorsAvailable(available) ⇒ ClimateControlCapabilities
Set the HeatedMirrorsAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control (enable/disable) of heated Mirrors. True: Available, False: Not Available, Not present: Not Available. - The desired HeatedMirrorsAvailable. |
climateControlCapabilities.setHeatedRearWindowAvailable(available) ⇒ ClimateControlCapabilities
Set the HeatedRearWindowAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control (enable/disable) of heated Rear Window. True: Available, False: Not Available, Not present: Not Available. - The desired HeatedRearWindowAvailable. |
climateControlCapabilities.setHeatedSteeringWheelAvailable(available) ⇒ ClimateControlCapabilities
Set the HeatedSteeringWheelAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control (enable/disable) of heated Steering Wheel. True: Available, False: Not Available, Not present: Not Available. - The desired HeatedSteeringWheelAvailable. |
climateControlCapabilities.setHeatedWindshieldAvailable(available) ⇒ ClimateControlCapabilities
Set the HeatedWindshieldAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control (enable/disable) of heated Windshield. True: Available, False: Not Available, Not present: Not Available. - The desired HeatedWindshieldAvailable. |
climateControlCapabilities.setModuleInfo(info) ⇒ ClimateControlCapabilities
Set the ModuleInfo
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| info | ModuleInfo |
Information about an RC module, including its id. - The desired ModuleInfo. |
climateControlCapabilities.setModuleName(name) ⇒ ClimateControlCapabilities
Set the ModuleName
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| name | String |
The short friendly name of the climate control module. It should not be used to identify a module by mobile application. - The desired ModuleName. {'string_min_length': 1, 'string_max_length': 100} |
climateControlCapabilities.setVentilationMode(mode) ⇒ ClimateControlCapabilities
Set the VentilationMode
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| mode | Array.<VentilationMode> |
A set of all ventilation modes that are controllable. - The desired VentilationMode. {'array_min_size': 1, 'array_max_size': 100} |
climateControlCapabilities.setVentilationModeAvailable(available) ⇒ ClimateControlCapabilities
Set the VentilationModeAvailable
Kind: Instance method of ClimateControlCapabilities
Returns: ClimateControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of air ventilation mode. True: Available, False: Not Available, Not present: Not Available. - The desired VentilationModeAvailable. |