diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ffc57a8c..23f81bed 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -70,7 +70,6 @@ * [Set Points](products/thermostats/set-points.md) * [Retrieving Thermostats](products/thermostats/retrieving-thermostats.md) * [Setting the Current HVAC and Fan Mode Settings](products/thermostats/configure-current-climate-settings.md) - * [Setting the Default Climate Setting](capability-guides/thermostats/configure-current-climate-settings/setting-the-default-climate-setting.md) * [👂 Noise Sensors](products/noise-sensors/README.md) * [Configuring Noise Threshold Settings](products/noise-sensors/configure-noise-threshold-settings.md) * [📡 Seam Bridge](capability-guides/seam-bridge.md) diff --git a/docs/api-clients/devices/README.md b/docs/api-clients/devices/README.md index 37d23199..f1779c8c 100644 --- a/docs/api-clients/devices/README.md +++ b/docs/api-clients/devices/README.md @@ -22,7 +22,7 @@ Superseded by [capability flags](../../capability-guides/device-and-system-capab ### `device.properties` Properties -
PropertyTypeDescription
onlineBoolean
Required
Indicates whether the device is online.
accessory_keypadObject
Optional
Accessory keypad state. See accessory_keypad Properties.
appearanceObject
Required
Appearance-related properties, including the read-only name of the device, as seen from the provider API and application.
modelObject
Required
Device model properties. See model Properties.
has_direct_powerBoolean
Optional
Indicates whether the device has direct power.
battery_levelNumber
Required
Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
Deprecated. Use device.properties.battery.level instead.
batteryObject
Optional
Device battery properties. See Devicebattery Properties.
manufacturerString
Optional
Manufacturer of the device. See Device Manufacturers.
image_urlString (URL)
Optional
Image URL for the device or placeholder image URL if a device-specific image is unavailable.
image_alt_textString
Optional
Alternative text for the device image.
serial_numberString
Optional
Serial number of the device.
online_access_codes_enabledBoolean
Optional
Indicates whether it is currently possible to use online access codes for the device.
Superseded by the device.properties.can_program_online_access_codes capability flag.
offline_access_codes_enabledBoolean
Optional
Indicates whether it is currently possible to use offline access codes for the device.
Superseded by the device.properties.can_program_offline_access_codes capability flag.
lockedBoolean
Optional

Indicates whether the device is locked.

Applicable to locks.

keypad_batteryObject
Optional

Keypad battery properties.

Applicable to locks.

See keypad_battery Properties.

door_openBoolean
Optional

Indicates whether the door is open.

Applicable to locks.

code_constraintsArray of objects
Optional

Constraints on access codes that can be set on the device.

Applicable to devices that support access codes.
See Access Code Constraints.

supported_code_lengthsArray of numbers
Optional

Supported code lengths for the device.

For example, [4,5] means that 1234 and 12345 are valid codes, but 123 and 123456 are invalid codes.
Applicable to devices that support access codes.

max_active_codes_supportedNumber
Optional
Maximum number of codes that can exist on the device at one time.
Applicable to devices that support access codes.
supports_backup_access_code_poolBoolean
Optional
Indicates whether the device supports backup access code pools.
Applicable to devices that support access codes.
temperature_fahrenheitNumber
Required
Temperature, measured in Fahrenheit.
Applicable to thermostats.
temperature_celsiusNumber
Required
Temperature, measured in Celsius.
Applicable to thermostats.
relative_humidityNumber
Required
Relative humidity, the amount of moisture in the air compared to the maximum amount of moisture the air can hold at a given temperature. It is a percentage expressed as a number between 0 and 1, inclusive.
Applicable to thermostats.
available_hvac_mode_settingsArray of enums (strings)

List of the available HVAC modes for the thermostat.
Possible values:

  • cool
  • heat
  • heat_cool
  • off

Applicable to thermostats.

is_heatingBoolean
Required
Indicates whether the heating system is currently heating.
Applicable to thermostats.
is_coolingBoolean
Required
Indicates whether the cooling system is currently cooling.
Applicable to thermostats.
is_fan_runningBoolean
Required
Indicates whether the fan is currently running.
Applicable to thermostats.
fan_mode_settingEnum (string)
Required

Fan mode of the thermostat.
Possible values:

  • on: The fan continuously operates, ensuring air circulation regardless of the heating or cooling demand.
  • auto: The fan activates only when heating or cooling is on, making it a more energy-efficient choice.

Applicable to thermostats.

is_temporary_manual_override_activeBoolean
Required
Indicates whether the current thermostat settings differ from the configured current_climate_setting.
Applicable to thermostats.
current_climate_settingObject
Required
Current climate setting for the thermostat. Can only be overridden manually if device.properties.current_climate_setting.manual_override_allowed is true.
Applicable to thermostats.
See Thermostat climate_setting Properties.
default_climate_settingObject
Optional
Default climate setting for the thermostat.
Applicable to thermostats.
See Thermostat climate_setting Properties.
min_cooling_set_point_celsiusNumber
Required
Minimum cooling set point that this thermostat supports, measured in Celsius.
Applicable to thermostats.
min_cooling_set_point_fahrenheitNumber
Required
Minimum cooling set point that this thermostat supports, measured in Fahrenheit.
Applicable to thermostats.
max_cooling_set_point_celsiusNumber
Required
Maximum cooling set point that this thermostat supports, measured in Celsius.
Applicable to thermostats.
max_cooling_set_point_fahrenheitNumber
Required
Maximum cooling set point that this thermostat supports, measured in Fahrenheit.
Applicable to thermostats.
min_heating_set_point_celsiusNumber
Required
Minimum heating set point that this thermostat supports, measured in Celsius.
Applicable to thermostats.
min_heating_set_point_fahrenheitNumber
Required
Minimum heating set point that this thermostat supports, measured in Fahrenheit.
Applicable to thermostats.
max_heating_set_point_celsiusNumber
Required
Maximum heating set point that this thermostat supports, measured in Celsius.
Applicable to thermostats.
max_heating_set_point_fahrenheitNumber
Required
Maximum heating set point that this thermostat supports, measured in Fahrenheit.
Applicable to thermostats.
min_heating_cooling_delta_celsiusNumber
Required
Minimum temperature difference—that is, delta—in degrees Celsius between the cooling and heating set points when in heat-cool (auto) mode.
Applicable to thermostats.
min_heating_cooling_delta_fahrenheitNumber
Required
Minimum temperature difference—that is, delta—in degrees Fahrenheit between the cooling and heating set points when in heat-cool (auto) mode.
Applicable to thermostats.
XXX_metadataObjectManufacturer-specific metadata for the device, where XXX is the manufacturer.
+
PropertyTypeDescription
onlineBoolean
Required
Indicates whether the device is online.
accessory_keypadObject
Optional
Accessory keypad state. See accessory_keypad Properties.
appearanceObject
Required
Appearance-related properties, including the read-only name of the device, as seen from the provider API and application.
modelObject
Required
Device model properties. See model Properties.
has_direct_powerBoolean
Optional
Indicates whether the device has direct power.
battery_levelNumber
Required
Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
Deprecated. Use device.properties.battery.level instead.
batteryObject
Optional
Device battery properties. See Devicebattery Properties.
manufacturerString
Optional
Manufacturer of the device. See Device Manufacturers.
image_urlString (URL)
Optional
Image URL for the device or placeholder image URL if a device-specific image is unavailable.
image_alt_textString
Optional
Alternative text for the device image.
serial_numberString
Optional
Serial number of the device.
online_access_codes_enabledBoolean
Optional
Indicates whether it is currently possible to use online access codes for the device.
Superseded by the device.properties.can_program_online_access_codes capability flag.
offline_access_codes_enabledBoolean
Optional
Indicates whether it is currently possible to use offline access codes for the device.
Superseded by the device.properties.can_program_offline_access_codes capability flag.
lockedBoolean
Optional

Indicates whether the device is locked.

Applicable to locks.

keypad_batteryObject
Optional

Keypad battery properties.

Applicable to locks.

See keypad_battery Properties.

door_openBoolean
Optional

Indicates whether the door is open.

Applicable to locks.

code_constraintsArray of objects
Optional

Constraints on access codes that can be set on the device.

Applicable to devices that support access codes.
See Access Code Constraints.

supported_code_lengthsArray of numbers
Optional

Supported code lengths for the device.

For example, [4,5] means that 1234 and 12345 are valid codes, but 123 and 123456 are invalid codes.
Applicable to devices that support access codes.

max_active_codes_supportedNumber
Optional
Maximum number of codes that can exist on the device at one time.
Applicable to devices that support access codes.
supports_backup_access_code_poolBoolean
Optional
Indicates whether the device supports backup access code pools.
Applicable to devices that support access codes.
temperature_fahrenheitNumber
Required
Temperature, measured in Fahrenheit.
Applicable to thermostats.
temperature_celsiusNumber
Required
Temperature, measured in Celsius.
Applicable to thermostats.
relative_humidityNumber
Required
Relative humidity, the amount of moisture in the air compared to the maximum amount of moisture the air can hold at a given temperature. It is a percentage expressed as a number between 0 and 1, inclusive.
Applicable to thermostats.
available_hvac_mode_settingsArray of enums (strings)

List of the available HVAC modes for the thermostat.
Possible values:

  • cool
  • heat
  • heat_cool
  • off

Applicable to thermostats.

is_heatingBoolean
Required
Indicates whether the heating system is currently heating.
Applicable to thermostats.
is_coolingBoolean
Required
Indicates whether the cooling system is currently cooling.
Applicable to thermostats.
is_fan_runningBoolean
Required
Indicates whether the fan is currently running.
Applicable to thermostats.
fan_mode_settingEnum (string)
Required

Fan mode of the thermostat.
Possible values:

  • on: The fan continuously operates, ensuring air circulation regardless of the heating or cooling demand.
  • auto: The fan activates only when heating or cooling is on, making it a more energy-efficient choice.

Applicable to thermostats.

is_temporary_manual_override_activeBoolean
Required
Indicates whether the current thermostat settings differ from the configured current_climate_setting.
Applicable to thermostats.
current_climate_settingObject
Required
Current climate setting for the thermostat. Can only be overridden manually if device.properties.current_climate_setting.manual_override_allowed is true.
Applicable to thermostats.
See Thermostat climate_setting Properties.
min_cooling_set_point_celsiusNumber
Required
Minimum cooling set point that this thermostat supports, measured in Celsius.
Applicable to thermostats.
min_cooling_set_point_fahrenheitNumber
Required
Minimum cooling set point that this thermostat supports, measured in Fahrenheit.
Applicable to thermostats.
max_cooling_set_point_celsiusNumber
Required
Maximum cooling set point that this thermostat supports, measured in Celsius.
Applicable to thermostats.
max_cooling_set_point_fahrenheitNumber
Required
Maximum cooling set point that this thermostat supports, measured in Fahrenheit.
Applicable to thermostats.
min_heating_set_point_celsiusNumber
Required
Minimum heating set point that this thermostat supports, measured in Celsius.
Applicable to thermostats.
min_heating_set_point_fahrenheitNumber
Required
Minimum heating set point that this thermostat supports, measured in Fahrenheit.
Applicable to thermostats.
max_heating_set_point_celsiusNumber
Required
Maximum heating set point that this thermostat supports, measured in Celsius.
Applicable to thermostats.
max_heating_set_point_fahrenheitNumber
Required
Maximum heating set point that this thermostat supports, measured in Fahrenheit.
Applicable to thermostats.
min_heating_cooling_delta_celsiusNumber
Required
Minimum temperature difference—that is, delta—in degrees Celsius between the cooling and heating set points when in heat-cool (auto) mode.
Applicable to thermostats.
min_heating_cooling_delta_fahrenheitNumber
Required
Minimum temperature difference—that is, delta—in degrees Fahrenheit between the cooling and heating set points when in heat-cool (auto) mode.
Applicable to thermostats.
XXX_metadataObjectManufacturer-specific metadata for the device, where XXX is the manufacturer.
### `location` Properties diff --git a/docs/api-clients/overview.md b/docs/api-clients/overview.md index 20dcce04..4d1e3e69 100644 --- a/docs/api-clients/overview.md +++ b/docs/api-clients/overview.md @@ -6,5 +6,5 @@ description: Comprehensive reference for integrating with Seam API endpoints ### Commonly-Used Seam API Endpoints -
Workspaces
Retrieving workspaces and resetting sandbox workspaces
/workspaces/get
/workspaces/reset_sandbox
Devices
Retrieving and updating devices, as well as listing device providers
/devices/get
/devices/list
/devices/update
/devices/list_device_providers
Connect Webviews
Creating, retrieving, and deleting Connect Webviews
/connect_webviews/create
/connect_webviews/get
/connect_webviews/list
/connect_webviews/delete
Connected Accounts
Retrieving connected account information, as well as updating and deleting connected accounts
/connected_accounts/get
/connected_accounts/list
/connected_accounts/update
/connected_accounts/delete
Devices
Retrieving and updating managed and unmanaged devices
/devices/list
/devices/list_device_providers
/devices/get
/devices/update
/devices/unmanaged/list
/devices/unmanaged/get
/devices/unmanaged/update
Access Codes
Creating, retrieving, updating, and deleting access codes

/access_codes/create

/access_codes/update
/access_codes/delete
/access_codes/get
/access_codes/list

Locks
Performing lock and unlock actions on a device, as well as retrieving locks

/locks/list

/locks/get

/locks/unlock_door
/locks/lock_door

Events
Retrieving events
/events/list
/events/get
Action Attempts
Retrieving action attempts
/action_attempts/get
Noise Sensors
Creating, retrieving, updating, and deleting noise thresholds
/noise_sensors/noise_thresholds/create
/noise_sensors/noise_thresholds/list
/noise_sensors/noise_thresholds/update
/noise_sensors/noise_thresholds/delete
Thermostats
Retrieving, updating, and setting current and default climate settings on thermostats.
/thermostats/list
/thermostats/get
/thermostats/update
/thermostats/heat
/thermostats/cool
/thermostats/heat_cool
Access Control Systems
Retrieving access control systems (ACSs), as well as listing compatible credential manager systems
/acs/systems/list
/acs/systems/get
/acs/systems/list_compatible_credential_manager_acs_systems
ACS Users
Creating, retrieving, updating, suspending, unsuspending, and deleting ACS users, as well as adding users to and removing ACS users from access groups
/acs/users/create
/acs/users/list
/acs/users/get
/acs/users/update
/acs/users/suspend
/acs/users/unsuspend
/acs/users/delete
/acs/users/add_to_access_group
/acs/users/remove_from_access_group
ACS Entrances
Retrieving entrances, as well as listing credentials with access to entrances
/acs/entrances/list
/acs/entrances/get
/acs/entrances/list_credentials_with_access
ACS Access Groups
Retrieving ACS access groups, adding ACS users to and removing ACS users from access groups, and listing ACS users in access groups
/acs/access_groups/list
/acs/access_groups/get
/acs/access_groups/add_user
/acs/access_groups/remove_user
/acs/access_groups/list_users
ACS Credentials
Creating, assigning, retrieving, updating, unassigning, and deleting credentials for ACS users
/acs/credentials/create
/acs/credentials/assign
/acs/credentials/list
/acs/credentials/get
/acs/credentials/update
/acs/credentials/unassign
/acs/credentials/delete
/acs/credentials/list_accessible_entrances
User Identities
Creating, retrieving, and deleting user identities; adding ACS users to and removing ACS users from user identities; and listing ACS users and ACS systems associated with user identities

/user_identities/create

/user_identities/list

/user_identities/get

/user_identities/add_acs_user
/user_identities/list_acs_users
/user_identities/list_acs_systems
/user_identities/remove_acs_user
/user_identities/delete

Enrollment Automations
Launching, retrieving, and deleting enrollment automations
/user_identities/enrollment_automations/launch
/user_identities/enrollment_automations/list
/user_identities/enrollment_automations/get
/user_identities/enrollment_automations/delete
+
Workspaces
Retrieving workspaces and resetting sandbox workspaces
/workspaces/get
/workspaces/reset_sandbox
Devices
Retrieving and updating devices, as well as listing device providers
/devices/get
/devices/list
/devices/update
/devices/list_device_providers
Connect Webviews
Creating, retrieving, and deleting Connect Webviews
/connect_webviews/create
/connect_webviews/get
/connect_webviews/list
/connect_webviews/delete
Connected Accounts
Retrieving connected account information, as well as updating and deleting connected accounts
/connected_accounts/get
/connected_accounts/list
/connected_accounts/update
/connected_accounts/delete
Devices
Retrieving and updating managed and unmanaged devices
/devices/list
/devices/list_device_providers
/devices/get
/devices/update
/devices/unmanaged/list
/devices/unmanaged/get
/devices/unmanaged/update
Access Codes
Creating, retrieving, updating, and deleting access codes

/access_codes/create

/access_codes/update
/access_codes/delete
/access_codes/get
/access_codes/list

Locks
Performing lock and unlock actions on a device, as well as retrieving locks

/locks/list

/locks/get

/locks/unlock_door
/locks/lock_door

Events
Retrieving events
/events/list
/events/get
Action Attempts
Retrieving action attempts
/action_attempts/get
Noise Sensors
Creating, retrieving, updating, and deleting noise thresholds
/noise_sensors/noise_thresholds/create
/noise_sensors/noise_thresholds/list
/noise_sensors/noise_thresholds/update
/noise_sensors/noise_thresholds/delete
Thermostats
Retrieving, updating, and setting current climate setting on thermostats.
/thermostats/list
/thermostats/get
/thermostats/update
/thermostats/heat
/thermostats/cool
/thermostats/heat_cool
Access Control Systems
Retrieving access control systems (ACSs), as well as listing compatible credential manager systems
/acs/systems/list
/acs/systems/get
/acs/systems/list_compatible_credential_manager_acs_systems
ACS Users
Creating, retrieving, updating, suspending, unsuspending, and deleting ACS users, as well as adding users to and removing ACS users from access groups
/acs/users/create
/acs/users/list
/acs/users/get
/acs/users/update
/acs/users/suspend
/acs/users/unsuspend
/acs/users/delete
/acs/users/add_to_access_group
/acs/users/remove_from_access_group
ACS Entrances
Retrieving entrances, as well as listing credentials with access to entrances
/acs/entrances/list
/acs/entrances/get
/acs/entrances/list_credentials_with_access
ACS Access Groups
Retrieving ACS access groups, adding ACS users to and removing ACS users from access groups, and listing ACS users in access groups
/acs/access_groups/list
/acs/access_groups/get
/acs/access_groups/add_user
/acs/access_groups/remove_user
/acs/access_groups/list_users
ACS Credentials
Creating, assigning, retrieving, updating, unassigning, and deleting credentials for ACS users
/acs/credentials/create
/acs/credentials/assign
/acs/credentials/list
/acs/credentials/get
/acs/credentials/update
/acs/credentials/unassign
/acs/credentials/delete
/acs/credentials/list_accessible_entrances
User Identities
Creating, retrieving, and deleting user identities; adding ACS users to and removing ACS users from user identities; and listing ACS users and ACS systems associated with user identities

/user_identities/create

/user_identities/list

/user_identities/get

/user_identities/add_acs_user
/user_identities/list_acs_users
/user_identities/list_acs_systems
/user_identities/remove_acs_user
/user_identities/delete

Enrollment Automations
Launching, retrieving, and deleting enrollment automations
/user_identities/enrollment_automations/launch
/user_identities/enrollment_automations/list
/user_identities/enrollment_automations/get
/user_identities/enrollment_automations/delete
diff --git a/docs/api-clients/thermostats/update-a-thermostat.md b/docs/api-clients/thermostats/update-a-thermostat.md deleted file mode 100644 index e4422772..00000000 --- a/docs/api-clients/thermostats/update-a-thermostat.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: - title: - visible: true - description: - visible: false - tableOfContents: - visible: true - outline: - visible: true - pagination: - visible: true ---- - -# Update a Thermostat - -Updates a [thermostat](../../thermostats/) by setting the values of the parameters passed. Any parameters not provides are left unchanged. - -The primary attribute you can modify is the [default climate setting](../../products/thermostats/#default-climate-setting). The default climate setting determines the configuration of the thermostat. This differs from the [current climate setting](../../products/thermostats/#current-climate-setting) of the thermostat, which represent the active programming on the device. - -{% swagger src="https://connect.getseam.com/openapi.json" path="/thermostats/update" method="post" %} -[https://connect.getseam.com/openapi.json](https://connect.getseam.com/openapi.json) -{% endswagger %} - -### Code Example - -{% tabs %} -{% tab title="Python" %} -```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 - } -) - -# -``` -{% endtab %} - -{% tab title="Javascript" %} -```javascript -await seam.thermostats.update({ - device_id: "a83690b2-2b70-409a-9a94-426699b84c97", - default_climate_setting: { - "automatic_heating_enabled": true, - "heating_set_point_fahrenheit": 70 - }, -}); - -//{} -``` -{% endtab %} -{% endtabs %} - -### Parameters - -| `device_id` | String |


Device ID

| -| ------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `default_climate_setting` | [Climate Setting object](../../thermostats/#climate-setting-properties) | Default [climate setting](../../thermostats/#climate-setting-properties). | - -### 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 - -{% tabs %} -{% tab title="JSON" %} -```json -{ - "action_attempt": { - "status": "pending", - "action_type": "UPDATE_THERMOSTAT", - "action_attempt_id": "4a11bcaf-c930-41d8-85f0-be375c93096f", - "result": null, - "error": null - }, - "ok": true -} -``` -{% endtab %} -{% endtabs %} - -
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_idStringID of the action attempt
resultStringresult only exists for the success status describing the event
errorObjecterror 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
diff --git a/docs/capability-guides/thermostats/configure-current-climate-settings/setting-the-default-climate-setting.md b/docs/capability-guides/thermostats/configure-current-climate-settings/setting-the-default-climate-setting.md deleted file mode 100644 index fd7f8823..00000000 --- a/docs/capability-guides/thermostats/configure-current-climate-settings/setting-the-default-climate-setting.md +++ /dev/null @@ -1,2 +0,0 @@ -# Setting the Default Climate Setting - diff --git a/docs/core-concepts/seam-console/seam-online-cli.md b/docs/core-concepts/seam-console/seam-online-cli.md index 1ca2acbd..cde4448f 100644 --- a/docs/core-concepts/seam-console/seam-online-cli.md +++ b/docs/core-concepts/seam-console/seam-online-cli.md @@ -65,7 +65,7 @@ Interact with the Seam Online CLI using any combination of interactive and typed The Seam Online CLI supports the following command stubs: -
Command StubDescription
seamAccess all Seam Online CLI commands in an interactive manner.
seam access-codesManage access codes.
seam acsManage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials.
seam action-attemptsList and get action attempts to poll the status of attempted actions, such as unlock and create access code.
seam client-sessionsManage client sessions that enable you to restrict users' interactions to include only the devices that they own.
seam connect-webviewsManage Connect Webviews that enable users to connect their devices to Seam.
seam connected-accountsManage connected accounts that represent external, third-party accounts to which users have authorized Seam to access.
seam devicesManage devices, including both "managed" and "unmanaged" devices.
seam eventsRetrieve events.
seam locksRetrieve, lock, and unlock smart locks.
seam loginLog back in to the Seam Online CLI or change your authorization to use a different API key or Personal Access Token.
seam logoutLog out of the Seam Online CLI.
seam noise-sensorsManage noise thresholds for noise sensors and simulate triggering noise threshold alerts.
seam selectSelect the desired workspace or server.
seam thermostatsManage thermostats, including current climate settings, default climate settings.
seam user-identitiesManage user identities that enable you to issue and manage mobile credentials and access permissions for users.
seam webhooksManage webhook endpoints that enable you to receive notifications of Seam-related events.
seam workspacesManage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces.
+
Command StubDescription
seamAccess all Seam Online CLI commands in an interactive manner.
seam access-codesManage access codes.
seam acsManage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials.
seam action-attemptsList and get action attempts to poll the status of attempted actions, such as unlock and create access code.
seam client-sessionsManage client sessions that enable you to restrict users' interactions to include only the devices that they own.
seam connect-webviewsManage Connect Webviews that enable users to connect their devices to Seam.
seam connected-accountsManage connected accounts that represent external, third-party accounts to which users have authorized Seam to access.
seam devicesManage devices, including both "managed" and "unmanaged" devices.
seam eventsRetrieve events.
seam locksRetrieve, lock, and unlock smart locks.
seam loginLog back in to the Seam Online CLI or change your authorization to use a different API key or Personal Access Token.
seam logoutLog out of the Seam Online CLI.
seam noise-sensorsManage noise thresholds for noise sensors and simulate triggering noise threshold alerts.
seam selectSelect the desired workspace or server.
seam thermostatsManage thermostats, including current climate settings.
seam user-identitiesManage user identities that enable you to issue and manage mobile credentials and access permissions for users.
seam webhooksManage webhook endpoints that enable you to receive notifications of Seam-related events.
seam workspacesManage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces.
## Copying and Pasting in the Seam Online CLI diff --git a/docs/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md b/docs/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md index 3f3d00e6..a89acc36 100644 --- a/docs/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md +++ b/docs/device-and-system-integration-guides/tedee-locks/get-started-with-tedee-locks.md @@ -317,7 +317,7 @@ $locks = $seam->locks->list(); echo json_encode($locks); /* -{"device_id":"ffc4d67f-e3a6-4ef8-ac84-f3770750422a","device_type":"tedee_lock","capabilities_supported":["access_code","battery","lock"],"properties":{"online":true,"name":"Front Door","model":{"display_name":"Lock PRO","manufacturer_display_name":"Tedee","offline_access_codes_supported":false,"online_access_codes_supported":true,"accessory_keypad_supported":false},"has_direct_power":null,"battery_level":1,"battery":{"level":1,"status":"full"},"manufacturer":"tedee","image_url":"https:\/\/connect.getseam.com\/assets\/images\/devices\/unknown-lock.png","image_alt_text":"Placeholder Lock Image","serial_number":null,"online_access_codes_enabled":true,"offline_access_codes_enabled":true,"supports_accessory_keypad":null,"supports_offline_access_codes":true,"august_metadata":null,"avigilon_alta_metadata":null,"schlage_metadata":null,"smartthings_metadata":null,"lockly_metadata":null,"nuki_metadata":null,"kwikset_metadata":null,"salto_metadata":null,"genie_metadata":null,"brivo_metadata":null,"igloo_metadata":null,"noiseaware_metadata":null,"minut_metadata":null,"four_suites_metadata":null,"two_n_metadata":null,"controlbyweb_metadata":null,"ttlock_metadata":null,"seam_bridge_metadata":null,"igloohome_metadata":null,"nest_metadata":null,"ecobee_metadata":null,"dormakaba_oracode_metadata":null,"wyze_metadata":null,"code_constraints":[{"constraint_type":"no_ascending_or_descending_sequence","min_length":null,"max_length":null},{"constraint_type":"at_least_three_unique_digits","min_length":null,"max_length":null}],"supported_code_lengths":[5,6,7,8],"max_active_codes_supported":null,"supports_backup_access_code_pool":true,"has_native_entry_events":null,"locked":true,"keypad_battery":null,"door_open":null,"temperature_fahrenheit":null,"temperature_celsius":null,"relative_humidity":null,"available_hvac_mode_settings":null,"is_heating":null,"is_cooling":null,"is_fan_running":null,"fan_mode_setting":null,"is_temporary_manual_override_active":null,"current_climate_setting":null,"default_climate_setting":null,"is_climate_setting_schedule_active":null,"active_climate_setting_schedule":null,"min_cooling_set_point_celsius":null,"min_cooling_set_point_fahrenheit":null,"max_cooling_set_point_celsius":null,"max_cooling_set_point_fahrenheit":null,"min_heating_set_point_celsius":null,"min_heating_set_point_fahrenheit":null,"max_heating_set_point_celsius":null,"max_heating_set_point_fahrenheit":null,"min_heating_cooling_delta_celsius":null,"min_heating_cooling_delta_fahrenheit":null,"assa_abloy_credential_service_metadata":null},"location":null,"connected_account_id":"f1e093d9-7a11-4d04-8c7e-619a037bd11a","workspace_id":"398d80b7-3f96-47c2-b85a-6f8ba21d07be","errors":[],"warnings":[],"created_at":"2024-02-08T19:47:43.810Z","is_managed":true,"custom_metadata":{}} +{"device_id":"ffc4d67f-e3a6-4ef8-ac84-f3770750422a","device_type":"tedee_lock","capabilities_supported":["access_code","battery","lock"],"properties":{"online":true,"name":"Front Door","model":{"display_name":"Lock PRO","manufacturer_display_name":"Tedee","offline_access_codes_supported":false,"online_access_codes_supported":true,"accessory_keypad_supported":false},"has_direct_power":null,"battery_level":1,"battery":{"level":1,"status":"full"},"manufacturer":"tedee","image_url":"https:\/\/connect.getseam.com\/assets\/images\/devices\/unknown-lock.png","image_alt_text":"Placeholder Lock Image","serial_number":null,"online_access_codes_enabled":true,"offline_access_codes_enabled":true,"supports_accessory_keypad":null,"supports_offline_access_codes":true,"august_metadata":null,"avigilon_alta_metadata":null,"schlage_metadata":null,"smartthings_metadata":null,"lockly_metadata":null,"nuki_metadata":null,"kwikset_metadata":null,"salto_metadata":null,"genie_metadata":null,"brivo_metadata":null,"igloo_metadata":null,"noiseaware_metadata":null,"minut_metadata":null,"four_suites_metadata":null,"two_n_metadata":null,"controlbyweb_metadata":null,"ttlock_metadata":null,"seam_bridge_metadata":null,"igloohome_metadata":null,"nest_metadata":null,"ecobee_metadata":null,"dormakaba_oracode_metadata":null,"wyze_metadata":null,"code_constraints":[{"constraint_type":"no_ascending_or_descending_sequence","min_length":null,"max_length":null},{"constraint_type":"at_least_three_unique_digits","min_length":null,"max_length":null}],"supported_code_lengths":[5,6,7,8],"max_active_codes_supported":null,"supports_backup_access_code_pool":true,"has_native_entry_events":null,"locked":true,"keypad_battery":null,"door_open":null,"temperature_fahrenheit":null,"temperature_celsius":null,"relative_humidity":null,"available_hvac_mode_settings":null,"is_heating":null,"is_cooling":null,"is_fan_running":null,"fan_mode_setting":null,"is_temporary_manual_override_active":null,"current_climate_setting":null,"is_climate_setting_schedule_active":null,"active_climate_setting_schedule":null,"min_cooling_set_point_celsius":null,"min_cooling_set_point_fahrenheit":null,"max_cooling_set_point_celsius":null,"max_cooling_set_point_fahrenheit":null,"min_heating_set_point_celsius":null,"min_heating_set_point_fahrenheit":null,"max_heating_set_point_celsius":null,"max_heating_set_point_fahrenheit":null,"min_heating_cooling_delta_celsius":null,"min_heating_cooling_delta_fahrenheit":null,"assa_abloy_credential_service_metadata":null},"location":null,"connected_account_id":"f1e093d9-7a11-4d04-8c7e-619a037bd11a","workspace_id":"398d80b7-3f96-47c2-b85a-6f8ba21d07be","errors":[],"warnings":[],"created_at":"2024-02-08T19:47:43.810Z","is_managed":true,"custom_metadata":{}} */ ``` {% endcode %} diff --git a/docs/device-guides/get-started-with-ecobee-thermostats.md b/docs/device-guides/get-started-with-ecobee-thermostats.md index 7da361f9..4954961b 100644 --- a/docs/device-guides/get-started-with-ecobee-thermostats.md +++ b/docs/device-guides/get-started-with-ecobee-thermostats.md @@ -286,12 +286,6 @@ pprint(devices[0]) # "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", # "cool", @@ -349,12 +343,6 @@ console.log(devices[0]) "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", "cool", diff --git a/docs/products/thermostats/README.md b/docs/products/thermostats/README.md index 388849e2..4240437e 100644 --- a/docs/products/thermostats/README.md +++ b/docs/products/thermostats/README.md @@ -25,7 +25,6 @@ Using the Seam API, you can configure the following groups of climate settings o * [**Current climate setting**](configure-current-climate-settings.md)**:** The current heating and cooling settings on a smart thermostat, including the [HVAC mode](hvac-mode.md) and its corresponding [set points](set-points.md). * [**Fan mode**](configure-current-climate-settings.md)**:** Whether the fan operates all the time (on) or only when needed (auto). -* [**Default climate setting**](../../capability-guides/thermostats/managing-scheduled-climate-settings-in-development/setting-the-default-climate-setting.md) **\[in development]:** The set of default HVAC settings on a smart thermostat. *** diff --git a/docs/products/thermostats/retrieving-thermostats.md b/docs/products/thermostats/retrieving-thermostats.md index 218fed56..8b896acf 100644 --- a/docs/products/thermostats/retrieving-thermostats.md +++ b/docs/products/thermostats/retrieving-thermostats.md @@ -34,16 +34,6 @@ seam.thermostats.list() 'hvac_mode_setting': 'heat_cool', '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, - 'heating_set_point_fahrenheit': 68, - 'hvac_mode_setting': 'heat_cool', - 'manual_override_allowed': True - }, 'ecobee_metadata': { 'device_name': 'Thermostat 1', 'ecobee_device_id': 'a64074f3-a0aa-4dbb-bbd3-f17f61701602' @@ -140,16 +130,6 @@ curl -X 'GET' \ "cooling_set_point_fahrenheit": 77, "heating_set_point_fahrenheit": 68 }, - "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, - "heating_set_point_fahrenheit": 68 - }, "available_hvac_mode_settings": [ "off", "cool", @@ -219,7 +199,6 @@ console.log(await seam.thermostats.list()) temperature_celsius: 21.11111111111111, temperature_fahrenheit: 70, current_climate_setting: [Object], - default_climate_setting: [Object], available_hvac_mode_settings: [Array], max_cooling_set_point_celsius: 33.333333333333336, max_heating_set_point_celsius: 26.11111111111111, @@ -314,7 +293,6 @@ echo json_encode($thermostats, JSON_PRETTY_PRINT); "heating_set_point_fahrenheit": 65, "manual_override_allowed": true }, - "default_climate_setting": null, "min_cooling_set_point_celsius": 18.333333333333336, "min_cooling_set_point_fahrenheit": 65, "max_cooling_set_point_celsius": 33.333333333333336, @@ -554,16 +532,6 @@ Device( 'hvac_mode_setting': 'heat_cool', '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, - 'heating_set_point_fahrenheit': 68, - 'hvac_mode_setting': 'heat_cool', - 'manual_override_allowed': True - }, 'ecobee_metadata': { 'device_name': 'Thermostat 1', 'ecobee_device_id': 'a64074f3-a0aa-4dbb-bbd3-f17f61701602' @@ -662,16 +630,6 @@ curl -X 'GET' \ "cooling_set_point_fahrenheit": 77, "heating_set_point_fahrenheit": 68 }, - "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, - "heating_set_point_fahrenheit": 68 - }, "available_hvac_mode_settings": [ "off", "cool", @@ -752,16 +710,6 @@ console.log(await seam.thermostats.get({ cooling_set_point_fahrenheit: 77, heating_set_point_fahrenheit: 68 }, - 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, - heating_set_point_fahrenheit: 68 - }, available_hvac_mode_settings: [ 'off', 'cool', 'heat', 'heat_cool' ], max_cooling_set_point_celsius: 33.333333333333336, max_heating_set_point_celsius: 26.11111111111111, @@ -860,7 +808,6 @@ echo json_encode($thermostat, JSON_PRETTY_PRINT); "heating_set_point_fahrenheit": 65, "manual_override_allowed": true }, - "default_climate_setting": null, "min_cooling_set_point_celsius": 18.333333333333336, "min_cooling_set_point_fahrenheit": 65, "max_cooling_set_point_celsius": 33.333333333333336, @@ -983,16 +930,6 @@ System.out.println(thermostat); "max_heating_set_point_fahrenheit" : 79, "image_url" : "https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png", "is_fan_running" : false, - "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, - "heating_set_point_fahrenheit" : 68 - }, "image_alt_text" : "Ecobee 3 Lite Thermostat", "min_heating_set_point_fahrenheit" : 45, "ecobee_metadata" : { diff --git a/docs/thermostats/README.md b/docs/thermostats/README.md index 321ef659..a38472ab 100644 --- a/docs/thermostats/README.md +++ b/docs/thermostats/README.md @@ -27,4 +27,3 @@ When you have `heat_cool` turned on, where both heating and cooling systems are | [Get Thermostat](get-thermostat.md) | | ----------------------------------------------------------------------------------------------- | | [List Thermostats](list-thermostats.md) | -| [Set Default Climate Setting](../api-clients/thermostats/update-a-thermostat.md) |