Configuring a Default Climate Setting

Configure the Default Climate Setting to be configured when are no Climate Setting Schedules running.

After a Climate Setting Schedule has completed, Seam will set the Climate Setting of a thermostat back to its Default Climate Setting.

This is different from the thermostat's current settings on a thermostat, which reflect what is currently programmed on the thermostst.

The Default Climate Setting for a thermostat will be set to the following settings by default:

• automatic_cooling_enabled: off

• automatic_heating_enabled: off

Updating the Thermostat

POST https://connect.getseam.com/thermostats/update

Headers

Name	Type	Description
Authorization*	String	Bearer <API_KEY>

Request Body

Name	Type	Description
device_id	String	ID of Device to be Locked
sync	Boolean
default_climate_setting	Object	The default Climate Setting when no scheduled Climate Settings are in place.

200: OK

{
  "action_attempt": {
    "status": "pending",
    "action_type": "UPDATE_THERMOSTAT",
    "action_attempt_id": "7e700856-a7d5-4aba-bffe-eb7dd6e9f265",
    "result": null,
    "error": null
  },
  "ok": true
}

404: Not Found

{
  "error": {
    "type": "device_not_found",
    "message": "Device not found",
    "request_id": "cda51712-7c52-482b-910d-04bc93fb4782"
  },
  "ok": false
}

400: Bad Request

{
  "error": {
    "type": "invalid_input",
    "message": "Required for provided \"device_id\"",
    "validation_errors": {
      "_errors": [],
      "device_id": {
        "_errors": [
          "Required"
        ]
      }
    },
    "request_id": "87ff554d-e27f-474d-b0f9-200c38ac3ab4"
  },
  "ok": false
}

Code Example

Python

seam.thermostats.update(
  device_id: "a83690b2-2b70-409a-9a94-426699b84c97",
  default_climate_setting: {
    "automatic_cooling_enabled": true,
    "automatic_heating_enabled": true,
    "cooling_set_point_fahrenheit": 70
    "heating_set_point_fahrenheit": 65
  }
)

# <Seam::ActionAttempt:0x008f6b0                                                         
#   status="success"                                                                     
#   action_type="UPDATE_THERMOSTAT"
#   action_attempt_id="4c3f9e12-5c9e-474e-92c4-719f72e13496"
#   result={}>

Javascript

await seam.thermostats.update({
  device_id: "a83690b2-2b70-409a-9a94-426699b84c97",
  default_climate_setting: {
    "automatic_heating_enabled": true,
    "heating_set_point_fahrenheit": 70
  },
});

//{}

Parameters

device_id	type: string	Device ID
default_climate_setting	type: Climate Setting object	The default Climate Setting when no Climate Setting Schedules are in place.
sync	type: boolean Optional

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

JSON

{
  "action_attempt": {
    "status": "pending",
    "action_type": "UPDATE_THERMOSTAT",
    "action_attempt_id": "4a11bcaf-c930-41d8-85f0-be375c93096f",
    "result": null,
    "error": null
  },
  "ok": true
}

status	"success" | "error" | "pending"	success determines a completed action performed on the device. error determines an unsuccessful action performed on the device. pending determines Seam is still trying to perform the action on the device
action_type	"UPDATE_THERMOSTAT"	Determines the type of action performed on the device
action_attempt_id	String	ID of the action attempt
result	String	result only exists for the success status describing the event
error	Object	error only exists for the error status describing the event. It is an object with type and message. Where type determines type of error and message describes the error