Skip to content

Commit

Permalink
add thermostat code samples
Browse files Browse the repository at this point in the history
  • Loading branch information
mikewuu committed Oct 16, 2024
1 parent 7292aec commit beb1430
Showing 1 changed file with 129 additions and 0 deletions.
129 changes: 129 additions & 0 deletions src/data/code-sample-definitions/acs-entrances.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
---
- title: List Thermostats
description: Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.
request:
path: /thermostats/list
response:
body:
thermostats:
- device_id: 123e4567-e89b-12d3-a456-426614174000
device_type: "ecobee_thermostat"
capabilities_supported:
- thermostat
properties:
name: "Entryway"
online: true,
relative_humidity: 0.36
temperature_farenheit: 70
available_hvac_mode_settings:
- cool
- heat
- heat_cool
- off
current_climate_setting:
hvac_mode_setting: heat_cool
cooling_set_point_farenheit: 75
heating_set_point_farenheit: 65
manual_override_allowed: false
location: null
connected_account_id: 123e4567-e89b-12d3-a456-426614174000
workspace_id: 123e4567-e89b-12d3-a456-426614174000
created_at: '2024-04-05T07:57:05.323Z'
- title: Get a Thermostat
description: Retrieves the details of a thermostat.
request:
path: /thermostats/get
parameters:
device_id: 123e4567-e89b-12d3-a456-426614174000
response:
body:
thermostat:
- device_id: 123e4567-e89b-12d3-a456-426614174000
device_type: "ecobee_thermostat"
capabilities_supported:
- thermostat
properties:
name: "Entryway"
online: true,
relative_humidity: 0.36
temperature_farenheit: 70
available_hvac_mode_settings:
- cool
- heat
- heat_cool
- off
current_climate_setting:
hvac_mode_setting: heat_cool
cooling_set_point_farenheit: 75
heating_set_point_farenheit: 65
manual_override_allowed: false
location: null
connected_account_id: 123e4567-e89b-12d3-a456-426614174000
workspace_id: 123e4567-e89b-12d3-a456-426614174000
created_at: '2024-04-05T07:57:05.323Z'
- title: Set to Heat Mode
description: Set a thermostat to heating mode. To do so, you must include a heating set point in the payload, either in Celsius or Fahrenheit. For information about verifying the heating availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](https://docs.seam.co/latest/capability-guides/thermostats/hvac-mode#hvac-mode-constraints) and [Set Point Constraints](https://docs.seam.co/latest/capability-guides/thermostats/set-points#set-point-constraints).
request:
path: /thermostats/heat
parameters:
device_id: 123e4567-e89b-12d3-a456-426614174000
heating_set_point_celcius: 25
response:
body:
action_attempt:
action_attempt_id: 123e4567-e89b-12d3-a456-426614174000
status: pending
action_type: LOCK_DOOR
- title: Set to Cool Mode
description: Set a thermostat to heating mode. To do so, you must include a heating set point in the payload, either in Celsius or Fahrenheit. For information about verifying the heating availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](https://docs.seam.co/latest/capability-guides/thermostats/hvac-mode#hvac-mode-constraints) and [Set Point Constraints](https://docs.seam.co/latest/capability-guides/thermostats/set-points#set-point-constraints).
request:
path: /thermostats/heat
parameters:
device_id: 123e4567-e89b-12d3-a456-426614174000
cooling_set_point_celcius: 25
response:
body:
action_attempt:
action_attempt_id: 123e4567-e89b-12d3-a456-426614174000
status: pending
action_type: LOCK_DOOR
- title: Set to Heat-Cool (Auto) Mode
description: Set a thermostat to heating mode. To do so, you must include a heating set point in the payload, either in Celsius or Fahrenheit. For information about verifying the heating availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](https://docs.seam.co/latest/capability-guides/thermostats/hvac-mode#hvac-mode-constraints) and [Set Point Constraints](https://docs.seam.co/latest/capability-guides/thermostats/set-points#set-point-constraints).
request:
path: /thermostats/heat_cool
parameters:
device_id: 123e4567-e89b-12d3-a456-426614174000
cooling_set_point_celcius: 25
heating_set_point: 20
response:
body:
action_attempt:
action_attempt_id: 123e4567-e89b-12d3-a456-426614174000
status: pending
action_type: LOCK_DOOR
- title: Set to Off Mode
description: Set a thermostat to "off" mode.
request:
path: /thermostats/off
parameters:
device_id: 123e4567-e89b-12d3-a456-426614174000
response:
body:
action_attempt:
action_attempt_id: 123e4567-e89b-12d3-a456-426614174000
status: pending
action_type: LOCK_DOOR
- title: Set Fan Mode
description: Sets a thermostat fan mode.
request:
path: /thermostats/set_fan_mode
parameters:
device_id: 123e4567-e89b-12d3-a456-426614174000
fan_mode_setting: "auto"
response:
body:
action_attempt:
action_attempt_id: 123e4567-e89b-12d3-a456-426614174000
status: pending
action_type: LOCK_DOOR

0 comments on commit beb1430

Please sign in to comment.