Merge pull request #310 from seamapi/pawel/shd-125-remove-automatic_c…

…ooling_enabled-and remove automatic_heating_enabled, automatic_cooling_enabled
seamapi · Aug 16, 2024 · 8ccff89 · 8ccff89
2 parents a0b902d + 1b3322c
commit 8ccff89
Show file tree

Hide file tree

Showing 10 changed files with 6 additions and 86 deletions.
diff --git a/docs/api-clients/devices/README.md b/docs/api-clients/devices/README.md
@@ -50,7 +50,7 @@ Superseded by [capability flags](../../capability-guides/device-and-system-capab
 
 ### Thermostat `climate_setting` Properties
 
-<table><thead><tr><th width="204">Property</th><th width="128.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>automatic_heating_enabled</code></td><td>Boolean<br><em>Required</em></td><td>Indicates whether the thermostat has heating turned on.</td></tr><tr><td><code>automatic_cooling_enabled</code></td><td>Boolean<br><em>Required</em></td><td>Indicates whether the thermostat has cooling turned on.</td></tr><tr><td><code>hvac_mode_setting</code></td><td>Enum (string)<br><em>Required</em></td><td><p>HVAC mode to which the thermostat is set.</p><p>Possible values:</p><ul><li><code>cool</code></li><li><code>heat</code></li><li><code>heat_cool</code></li><li><code>off</code></li></ul></td></tr><tr><td><code>cooling_set_point_celsius</code></td><td>Number<br><em>Optional</em></td><td>The <a href="./#climate-set-points">cooling set point</a>, measured in Celsius, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on.</td></tr><tr><td><code>heating_set_point_celsius</code></td><td>Number<br><em>Optional</em></td><td>The <a href="./#climate-set-points">heating set point</a>, measured in Celsius, if heating is turned on. When the ambient temperature drops below this set point, heating turns on.</td></tr><tr><td><code>cooling_set_point_fahrenheit</code></td><td>Number<br><em>Optional</em></td><td>The <a href="./#climate-set-points">cooling set point</a>, measured in Fahrenheit, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on.</td></tr><tr><td><code>heating_set_point_fahrenheit</code></td><td>Number<br><em>Optional</em></td><td>The <a href="./#climate-set-points">heating set point</a>, measured in Fahrenheit, if heating is turned on. When the ambient temperature drops below this set point, heating turns on.</td></tr><tr><td><code>manual_override_allowed</code></td><td>Boolean<br><em>Required</em></td><td>Indicates whether another user can use the thermostat or API to override this climate setting.</td></tr></tbody></table>
+<table><thead><tr><th width="204">Property</th><th width="128.33333333333331">Type</th><th>Description</th></tr></thead><tbody><td><code>hvac_mode_setting</code></td><td>Enum (string)<br><em>Required</em></td><td><p>HVAC mode to which the thermostat is set.</p><p>Possible values:</p><ul><li><code>cool</code></li><li><code>heat</code></li><li><code>heat_cool</code></li><li><code>off</code></li></ul></td></tr><tr><td><code>cooling_set_point_celsius</code></td><td>Number<br><em>Optional</em></td><td>The <a href="./#climate-set-points">cooling set point</a>, measured in Celsius, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on.</td></tr><tr><td><code>heating_set_point_celsius</code></td><td>Number<br><em>Optional</em></td><td>The <a href="./#climate-set-points">heating set point</a>, measured in Celsius, if heating is turned on. When the ambient temperature drops below this set point, heating turns on.</td></tr><tr><td><code>cooling_set_point_fahrenheit</code></td><td>Number<br><em>Optional</em></td><td>The <a href="./#climate-set-points">cooling set point</a>, measured in Fahrenheit, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on.</td></tr><tr><td><code>heating_set_point_fahrenheit</code></td><td>Number<br><em>Optional</em></td><td>The <a href="./#climate-set-points">heating set point</a>, measured in Fahrenheit, if heating is turned on. When the ambient temperature drops below this set point, heating turns on.</td></tr><tr><td><code>manual_override_allowed</code></td><td>Boolean<br><em>Required</em></td><td>Indicates whether another user can use the thermostat or API to override this climate setting.</td></tr></tbody></table>
 
 ## Device Error Types
 

diff --git a/docs/api-clients/thermostats/update-a-thermostat.md b/docs/api-clients/thermostats/update-a-thermostat.md
@@ -30,8 +30,7 @@ The primary attribute you can modify is the [default climate setting](../../prod
 seam.thermostats.update(
   device_id: "a83690b2-2b70-409a-9a94-426699b84c97",
   default_climate_setting: {
-    "automatic_cooling_enabled": true,
-    "automatic_heating_enabled": true,
+    "hvac_mode_setting": "heat_cool",
     "cooling_set_point_fahrenheit": 70
     "heating_set_point_fahrenheit": 65
   }

diff --git a/docs/api-clients/user-identities/list-accessible-devices-for-a-user-identity.md b/docs/api-clients/user-identities/list-accessible-devices-for-a-user-identity.md
@@ -87,8 +87,6 @@ This response also includes a Boolean `ok` status indicator.
         "temperature_celsius": 24.64,
         "temperature_fahrenheit": 76.352,
         "current_climate_setting": {
-          "automatic_heating_enabled": true,
-          "automatic_cooling_enabled": true,
           "hvac_mode_setting": "heat_cool",
           "manual_override_allowed": true,
           "cooling_set_point_celsius": 21.5,

diff --git a/...integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md b/...integration-guides/google-nest-thermostats/get-started-with-nest-thermostats.md
@@ -264,8 +264,7 @@ pprint(devices[0])
 #                                                    'cool',
 #                                                    'heat_cool',
 #                                                    'off'],
-#                   'current_climate_setting': {'automatic_cooling_enabled': True,
-#                                               'automatic_heating_enabled': True,
+#                   'current_climate_setting': {
 #                                               'cooling_set_point_celsius': 21.5,
 #                                               'cooling_set_point_fahrenheit': 70.7,
 #                                               'heating_set_point_celsius': 20,
@@ -330,8 +329,6 @@ console.log(devices[0])
     temperature_celsius: 24.64,
     temperature_fahrenheit: 76.352,
     current_climate_setting: {
-      automatic_heating_enabled: true,
-      automatic_cooling_enabled: true,
       hvac_mode_setting: 'heat_cool',
       manual_override_allowed: true,
       cooling_set_point_celsius: 21.5,
@@ -394,8 +391,6 @@ System.out.println(devices);
 //       "manufacturer_display_name" : "Nest"
 //     },
 //     "current_climate_setting" : {
-//       "automatic_heating_enabled" : true,
-//       "automatic_cooling_enabled" : true,
 //       "hvac_mode_setting" : "heat_cool",
 //       "cooling_set_point_celsius" : 21.5,
 //       "heating_set_point_celsius" : 20.0,
@@ -466,8 +461,6 @@ return nil
 //     "temperature_celsius": 24.64,
 //     "temperature_fahrenheit": 76.352,
 //     "current_climate_setting": {
-//       "automatic_heating_enabled": true,
-//       "automatic_cooling_enabled": true,
 //       "hvac_mode_setting": "heat_cool",
 //       "manual_override_allowed": true,
 //       "cooling_set_point_celsius": 21.5,

diff --git a/...egration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md b/...egration-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md
@@ -266,8 +266,7 @@ pprint(devices[0])
 #                                                   'cool',
 #                                                   'heat',
 #                                                   'heat_cool'],
-#                  'current_climate_setting': {'automatic_cooling_enabled': False,
-#                                              'automatic_heating_enabled': True,
+#                  'current_climate_setting': {
 #                                              'heating_set_point_celsius': 16.666666666666668,
 #                                              'heating_set_point_fahrenheit': 62,
 #                                              'hvac_mode_setting': 'heat',
@@ -338,8 +337,6 @@ console.log(devices[0])
     temperature_celsius: 24.444444444444446,
     temperature_fahrenheit: 76,
     current_climate_setting: {
-      automatic_heating_enabled: true,
-      automatic_cooling_enabled: false,
       hvac_mode_setting: 'heat',
       manual_override_allowed: true,
       heating_set_point_celsius: 16.666666666666668,
@@ -417,8 +414,6 @@ System.out.println(devices);
 //     temperature_celsius: 24.444444444444446,
 //     temperature_fahrenheit: 76,
 //     current_climate_setting: {
-//       automatic_heating_enabled: true,
-//       automatic_cooling_enabled: false,
 //       hvac_mode_setting: 'heat',
 //       manual_override_allowed: true,
 //       heating_set_point_celsius: 16.666666666666668,
@@ -490,8 +485,6 @@ return nil
 //     temperature_celsius: 24.444444444444446,
 //     temperature_fahrenheit: 76,
 //     current_climate_setting: {
-//       automatic_heating_enabled: true,
-//       automatic_cooling_enabled: false,
 //       hvac_mode_setting: 'heat',
 //       manual_override_allowed: true,
 //       heating_set_point_celsius: 16.666666666666668,

diff --git a/docs/device-guides/get-started-with-ecobee-thermostats.md b/docs/device-guides/get-started-with-ecobee-thermostats.md
@@ -283,14 +283,10 @@ pprint(devices[0])
 #       "current_climate_setting": {
 #         "hvac_mode_setting": "off",
 #         "manual_override_allowed": false,
-#         "automatic_cooling_enabled": false,
-#         "automatic_heating_enabled": false
 #       },
 #       "default_climate_setting": {
 #         "hvac_mode_setting": "off",
 #         "manual_override_allowed": false,
-#         "automatic_cooling_enabled": false,
-#         "automatic_heating_enabled": false
 #       },
 #       "available_hvac_mode_settings": [
 #         "off",
@@ -346,14 +342,10 @@ console.log(devices[0])
     "current_climate_setting": {
       "hvac_mode_setting": "off",
       "manual_override_allowed": false,
-      "automatic_cooling_enabled": false,
-      "automatic_heating_enabled": false
     },
     "default_climate_setting": {
       "hvac_mode_setting": "off",
       "manual_override_allowed": false,
-      "automatic_cooling_enabled": false,
-      "automatic_heating_enabled": false
     },
     "available_hvac_mode_settings": [
       "off",
@@ -409,8 +401,6 @@ System.out.println(devices);
 //       "manufacturer_display_name" : "Ecobee"
 //     },
 //     "current_climate_setting" : {
-//       "automatic_heating_enabled" : false,
-//       "automatic_cooling_enabled" : false,
 //       "hvac_mode_setting" : "off",
 //       "manual_override_allowed" : true
 //     },
@@ -487,8 +477,6 @@ return nil
 //     "temperature_celsius": 21.11111111111111,
 //     "temperature_fahrenheit": 70,
 //     "current_climate_setting": {
-//       "automatic_heating_enabled": false,
-//       "automatic_cooling_enabled": false,
 //       "hvac_mode_setting": "off",
 //       "manual_override_allowed": true
 //     },

diff --git a/docs/products/thermostats/retrieving-thermostats.md b/docs/products/thermostats/retrieving-thermostats.md
@@ -25,8 +25,7 @@ seam.thermostats.list()
     properties={
         'available_hvac_mode_settings': ['off', 'cool', 'heat', 'heat_cool'],
         'current_climate_setting': {
-            'automatic_cooling_enabled': True,
-            'automatic_heating_enabled': True,
+            'hvac_mode_setting': 'heat_cool',
             'cooling_set_point_celsius': 25,
             'cooling_set_point_fahrenheit': 77,
             'heating_set_point_celsius': 20,
@@ -35,8 +34,6 @@ seam.thermostats.list()
             'manual_override_allowed': True
         },
         'default_climate_setting': {
-            'automatic_cooling_enabled': True,
-            'automatic_heating_enabled': True,
             'cooling_set_point_celsius': 25,
             'cooling_set_point_fahrenheit': 77,
             'heating_set_point_celsius': 20,
@@ -133,8 +130,6 @@ curl -X 'GET' \
         "current_climate_setting": {
           "hvac_mode_setting": "heat_cool",
           "manual_override_allowed": true,
-          "automatic_cooling_enabled": true,
-          "automatic_heating_enabled": true,
           "cooling_set_point_celsius": 25,
           "heating_set_point_celsius": 20,
           "cooling_set_point_fahrenheit": 77,
@@ -143,8 +138,6 @@ curl -X 'GET' \
         "default_climate_setting": {
           "hvac_mode_setting": "heat_cool",
           "manual_override_allowed": true,
-          "automatic_cooling_enabled": true,
-          "automatic_heating_enabled": true,
           "cooling_set_point_celsius": 25,
           "heating_set_point_celsius": 20,
           "cooling_set_point_fahrenheit": 77,
@@ -305,8 +298,6 @@ echo json_encode($thermostats, JSON_PRETTY_PRINT);
             "fan_mode_setting": "auto",
             "is_temporary_manual_override_active": false,
             "current_climate_setting": {
-                "automatic_heating_enabled": true,
-                "automatic_cooling_enabled": true,
                 "hvac_mode_setting": "heat_cool",
                 "cooling_set_point_celsius": 23.88888888888889,
                 "heating_set_point_celsius": 18.333333333333336,
@@ -470,8 +461,6 @@ return nil
     "temperature_celsius": 21.11111111111111,
     "temperature_fahrenheit": 70,
     "current_climate_setting": {
-      "automatic_heating_enabled": true,
-      "automatic_cooling_enabled": true,
       "hvac_mode_setting": "heat_cool",
       "manual_override_allowed": true,
       "cooling_set_point_celsius": 23.88888888888889,
@@ -545,8 +534,6 @@ Device(
     properties={
         'available_hvac_mode_settings': ['off', 'cool', 'heat', 'heat_cool'],
         'current_climate_setting': {
-            'automatic_cooling_enabled': True,
-            'automatic_heating_enabled': True,
             'cooling_set_point_celsius': 25,
             'cooling_set_point_fahrenheit': 77,
             'heating_set_point_celsius': 20,
@@ -555,8 +542,6 @@ Device(
             'manual_override_allowed': True
         },
         'default_climate_setting': {
-            'automatic_cooling_enabled': True,
-            'automatic_heating_enabled': True,
             'cooling_set_point_celsius': 25,
             'cooling_set_point_fahrenheit': 77,
             'heating_set_point_celsius': 20,
@@ -655,8 +640,6 @@ curl -X 'GET' \
       "current_climate_setting": {
         "hvac_mode_setting": "heat_cool",
         "manual_override_allowed": true,
-        "automatic_cooling_enabled": true,
-        "automatic_heating_enabled": true,
         "cooling_set_point_celsius": 25,
         "heating_set_point_celsius": 20,
         "cooling_set_point_fahrenheit": 77,
@@ -665,8 +648,6 @@ curl -X 'GET' \
       "default_climate_setting": {
         "hvac_mode_setting": "heat_cool",
         "manual_override_allowed": true,
-        "automatic_cooling_enabled": true,
-        "automatic_heating_enabled": true,
         "cooling_set_point_celsius": 25,
         "heating_set_point_celsius": 20,
         "cooling_set_point_fahrenheit": 77,
@@ -745,8 +726,6 @@ console.log(await seam.thermostats.get({
     current_climate_setting: {
       hvac_mode_setting: 'heat_cool',
       manual_override_allowed: true,
-      automatic_cooling_enabled: true,
-      automatic_heating_enabled: true,
       cooling_set_point_celsius: 25,
       heating_set_point_celsius: 20,
       cooling_set_point_fahrenheit: 77,
@@ -755,8 +734,6 @@ console.log(await seam.thermostats.get({
     default_climate_setting: {
       hvac_mode_setting: 'heat_cool',
       manual_override_allowed: true,
-      automatic_cooling_enabled: true,
-      automatic_heating_enabled: true,
       cooling_set_point_celsius: 25,
       heating_set_point_celsius: 20,
       cooling_set_point_fahrenheit: 77,
@@ -851,8 +828,6 @@ echo json_encode($thermostat, JSON_PRETTY_PRINT);
         "fan_mode_setting": "auto",
         "is_temporary_manual_override_active": false,
         "current_climate_setting": {
-            "automatic_heating_enabled": true,
-            "automatic_cooling_enabled": true,
             "hvac_mode_setting": "heat_cool",
             "cooling_set_point_celsius": 23.88888888888889,
             "heating_set_point_celsius": 18.333333333333336,
@@ -956,8 +931,6 @@ System.out.println(thermostat);
       "manufacturer_display_name" : "Ecobee"
     },
     "current_climate_setting" : {
-      "automatic_heating_enabled" : true,
-      "automatic_cooling_enabled" : true,
       "hvac_mode_setting" : "heat_cool",
       "cooling_set_point_celsius" : 25.0,
       "heating_set_point_celsius" : 20.0,
@@ -986,8 +959,6 @@ System.out.println(thermostat);
     "default_climate_setting" : {
       "hvac_mode_setting" : "heat_cool",
       "manual_override_allowed" : true,
-      "automatic_cooling_enabled" : true,
-      "automatic_heating_enabled" : true,
       "cooling_set_point_celsius" : 25,
       "heating_set_point_celsius" : 20,
       "cooling_set_point_fahrenheit" : 77,
@@ -1052,8 +1023,6 @@ return nil
     "temperature_celsius": 21.11111111111111,
     "temperature_fahrenheit": 70,
     "current_climate_setting": {
-      "automatic_heating_enabled": true,
-      "automatic_cooling_enabled": true,
       "hvac_mode_setting": "heat_cool",
       "manual_override_allowed": true,
       "cooling_set_point_celsius": 23.88888888888889,