From 1a7e17fbc7356985ac7b9fdb34a9d4f22ecba640 Mon Sep 17 00:00:00 2001 From: Deborah Femia Date: Tue, 19 Nov 2024 18:55:27 +0000 Subject: [PATCH] GITBOOK-483: Add therm props to device props table --- docs/api-clients/devices/README.md | 24 ++++++++++++++----- docs/core-concepts/workspaces/README.md | 4 ++-- .../sandbox-and-sample-data/README.md | 2 ++ 3 files changed, 22 insertions(+), 8 deletions(-) diff --git a/docs/api-clients/devices/README.md b/docs/api-clients/devices/README.md index cfaca1e4..016e07eb 100644 --- a/docs/api-clients/devices/README.md +++ b/docs/api-clients/devices/README.md @@ -10,7 +10,7 @@ The `device` object represents a [device](../../core-concepts/devices/) that has The `device` object has the following properties: -
PropertyTypeDescription
device_idString (UUID)
Required		Unique identifier for the device.
device_typeString
Required		Type of the device.
display_nameString
Required		Display name for the device.
capabilities_supportedArray of strings
Required		Collection of capabilities that the device supports when connected to Seam.
See capabilities_supported Values.
Important: Superseded by capability flags.
properties

Object

Required

Properties of the device.
See device.properties Properties.
locationObject
Optional		Read-only location information for the device.
See location Properties.
connected_account_idString (UUID)
Required		ID of the connected account associated with the device.
workspace_idString (UUID)
Required		ID of the workspace that contains the device.
errorsArray of objects
Required

Array of errors associated with the device.

Each error object within the array contains two fields: error_code and message.

error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue.

message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
See Device Error Types.

warningsArray of objects
Required

Array of warnings associated with the device.

Each warning object within the array contains two fields: warning_code and message.

warning_code is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue.

message provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
See Device Warning Types.

created_atString (datetime)
Required		Date and time at which the device object was created.
is_managedBoolean
Required		Indicates whether Seam manages the device.
custom_metadataJSON object
Optional

Set of custom_metadata for the device.

Specify up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters.

can_remotely_unlockBoolean
Optional		Indicates whether the device can perform a remote unlock operation. See Capability Flags.
can_remotely_lockBoolean
Optional		Indicates whether the device can perform a remote lock operation. See Capability Flags.
can_program_online_access_codesBoolean
Optional		Indicates whether the device can program online access codes. See Capability Flags.
can_program_offline_access_codesBoolean
Optional		Indicates whether the device can program offline access codes. See Capability Flags.
can_hvac_heatBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat mode. See Capability Flags.
can_hvac_coolBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports cool mode. See Capability Flags.
can_hvac_heat_coolBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat-cool (auto) mode. See Capability Flags.
can_turn_off_hvacBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports off mode. See Capability Flags.
+
PropertyTypeDescription
device_idString (UUID)
Required		Unique identifier for the device.
device_typeString
Required		Type of the device.
display_nameString
Required		Display name for the device.
capabilities_supportedArray of strings
Required		Collection of capabilities that the device supports when connected to Seam.
See capabilities_supported Values.
Important: Superseded by capability flags.
properties

Object

Required

Properties of the device.
See device.properties Properties.
locationObject
Optional		Read-only location information for the device.
See location Properties.
connected_account_idString (UUID)
Required		ID of the connected account associated with the device.
workspace_idString (UUID)
Required		ID of the workspace that contains the device.
errorsArray of objects
Required

Array of errors associated with the device.

Each error object within the array contains two fields: error_code and message.

error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue.

message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
See Device Error Types.

warningsArray of objects
Required

Array of warnings associated with the device.

Each warning object within the array contains two fields: warning_code and message.

warning_code is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue.

message provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
See Device Warning Types.

created_atString (datetime)
Required		Date and time at which the device object was created.
is_managedBoolean
Required		Indicates whether Seam manages the device.
custom_metadataJSON object
Optional

Set of custom_metadata for the device.

Specify up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters.

can_remotely_unlockBoolean
Optional		Indicates whether the device can perform a remote unlock operation. See Capability Flags.
can_remotely_lockBoolean
Optional		Indicates whether the device can perform a remote lock operation. See Capability Flags.
can_program_online_access_codesBoolean
Optional		Indicates whether the device can program online access codes. See Capability Flags.
can_program_offline_access_codesBoolean
Optional		Indicates whether the device can program offline access codes. See Capability Flags.
can_hvac_heatBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat mode. See Capability Flags.
can_hvac_coolBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports cool mode. See Capability Flags.
can_hvac_heat_coolBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports heat-cool (auto) mode. See Capability Flags.
can_turn_off_hvacBoolean
Optional		Indicates whether the thermostat device (in conjunction with the associated HVAC system) supports off mode. See Capability Flags.
can_simulate_removalBoolean
Optional		Indicates whether you can simulate removal of the sandbox device. See Testing Your App Against Device Disconnection and Removal.
can_simulate_connectionBoolean
Optional		Indicates whether you can simulate connection (or reconnection) of the sandbox device. See Testing Your App Against Device Disconnection and Removal.
can_simulate_disconnectionBoolean
Optional		Indicates whether you can simulate disconnection of the sandbox device. See Testing Your App Against Device Disconnection and Removal.
### `capabilities_supported` Values @@ -18,11 +18,11 @@ The `device` object has the following properties: Superseded by [capability flags](../../capability-guides/device-and-system-capabilities.md#capability-flags). {% endhint %} -
CapabilityDescription
access_codeIf present, you can set access codes on the device.
batteryIf present, you can look at the device.properties.battery.level of the device.
healthIf present, you can introspect some parameters related to the health of the device.
lockIf present, you can lock and unlock the device.
noise_sensorIf present, the device can issue noise alerts when noise thresholds are exceeded.
thermostatIf present, the device can regulate the temperature of a system so that the temperature of the system is maintained near a desired set point temperature.
+
CapabilityDescription
access_codeIf present, the device can manage and utilize digital PIN codes for secure access.
lockIf present, the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points.
noise_detectionIf present, the device supports monitoring and responding to ambient noise levels.
thermostatIf present, the device can regulate and adjust indoor temperatures.
batteryIf present, the device can manage battery life and health.
phoneIf present, the device is a mobile phone.
### `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.
If the device is offline, Seam does not return this property.
Deprecated. Use device.properties.battery.level instead.
batteryObject
Optional

Device battery properties.

If the device is offline, Seam does not return this property.
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.
If the device is offline, Seam does not return this property.

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.
If the device is offline, Seam does not return this property.

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.
+
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.
If the device is offline, Seam does not return this property.
Deprecated. Use device.properties.battery.level instead.
batteryObject
Optional

Device battery properties.

If the device is offline, Seam does not return this property.
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.
noise_level_decibelsNumber
Optional		Current noise level in decibels, if the device supports noise detection.
currently_triggering_noise_threshold_idsArray of strings
Optional		Array of noise threshold IDs that are currently triggering.
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.
has_native_entry_eventsBoolean
Optional		Indicates whether Seam receives lock and unlock events from the device provider.
lockedBoolean
Optional

Indicates whether the device is locked.

Applicable to locks.
If the device is offline, Seam does not return this property.

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.
If the device is offline, Seam does not return this property.

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 mode settings for the thermostat.
Possible values:

  • cool
  • heat
  • heat_cool
  • off

Applicable to thermostats.

available_fan_mode_settingsArray of enums (strings)

List of the available fan mode settings for the thermostat.
Possible values:

  • auto
  • on
  • circulate

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 setting of the thermostat.

Deprecated. Use current_climate_setting.fan_mode_setting instead.

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.
Applicable to thermostats.
See current_climate_setting Properties.
default_climate_settingObject
Required		Deprecated. Use fallback_climate_preset_key to specify a fallback climate preset instead.
available_climate_presetsArray of objects
Required		Set of climate presets that are available for the thermostat device.
See available_climate_presets Properties.
fallback_climate_preset_keyString
Optional		Key that identifies the current fallback climate preset.
active_thermostat_scheduleObject
Optional		Currently active thermostat schedule.
See active_thermostat_schedule 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.
temperature_thresholdObject
Optional		Acceptable temperature bounds consisting of a temperature range or single upper or lower temperature. Seam emits a thermostat.temperature_threshold_exceeded event if the thermostat reports a temperature outside the specified threshold.
See temperature_threshold Properties.
XXX_metadataObjectManufacturer-specific metadata for the device, where XXX is the manufacturer.
### `location` Properties @@ -50,9 +50,21 @@ If the device is offline, Seam does not return these properties.
PropertyTypeDescription
levelNumber
Required		Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
statusEnum (string)
Required

Represents the current status of the battery charge level.

Values are:

  • critical: Indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging.
  • low: Signifies that the battery is under the preferred threshold and should be charged soon.
  • good: Denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging.
  • full: Represents a battery that is fully charged, providing the maximum duration of usage.
-### Thermostat `climate_setting` Properties +### `current_climate_setting` Properties -
PropertyTypeDescription
hvac_mode_settingEnum (string)
Required

HVAC mode to which the thermostat is set.

Possible values:

  • cool
  • heat
  • heat_cool
  • off
cooling_set_point_celsiusNumber
Optional		The cooling set point, measured in Celsius, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on.
heating_set_point_celsiusNumber
Optional		The heating set point, measured in Celsius, if heating is turned on. When the ambient temperature drops below this set point, heating turns on.
cooling_set_point_fahrenheitNumber
Optional		The cooling set point, measured in Fahrenheit, if cooling is turned on. When the ambient temperature rises above this set point, cooling turns on.
heating_set_point_fahrenheitNumber
Optional		The heating set point, measured in Fahrenheit, if heating is turned on. When the ambient temperature drops below this set point, heating turns on.
manual_override_allowedBoolean
Required		Indicates whether another user can use the thermostat or API to override this climate setting.
+
PropertyTypeDescription
climate_preset_keyString
Required		Unique key to identify the current climate preset.
can_editBoolean
Required		Indicates whether the current climate preset can be edited.
can_deleteBoolean
Required		Indicates whether the current climate preset can be deleted.
nameString
Optional		User-friendly name to identify the current climate preset.
display_nameString
Required		Display name for the current climate preset.
fan_mode_settingEnum (string)
Required

Current desired fan mode setting.

Possible values:

  • auto
  • on
  • circulate
hvac_mode_settingEnum (string)
Required

Current desired HVAC mode setting.

Possible values:

  • cool
  • heat
  • heat_cool
  • off
cooling_set_point_celsiusNumber
Optional		Temperature to which the thermostat should currently cool (in °C). See also Set Points.
heating_set_point_celsiusNumber
Optional		Temperature to which the thermostat should currently heat (in °C).
cooling_set_point_fahrenheitNumber
Optional		Temperature to which the thermostat should currently cool (in °F).
heating_set_point_fahrenheitNumber
Optional		Temperature to which the thermostat should currently heat (in °F).
manual_override_allowedBoolean
Required		Indicates whether another user can use the thermostat or API to override this climate setting.
Deprecated. Use thermostat_schedule.is_override_allowed instead.
+ +### `available_climate_presets` Properties + +
PropertyTypeDescription
climate_preset_keyString
Required		Unique key to identify the climate preset.
can_editBoolean
Required		Indicates whether the climate preset can be edited.
can_deleteBoolean
Required		Indicates whether the climate preset can be deleted.
nameString
Optional		User-friendly name to identify the climate preset.
display_nameString
Required		Display name for the climate preset.
fan_mode_settingEnum (string)
Required

Desired fan mode setting.

Possible values:

  • auto
  • on
  • circulate
hvac_mode_settingEnum (string)
Required

Desired HVAC mode setting.

Possible values:

  • cool
  • heat
  • heat_cool
  • off
cooling_set_point_celsiusNumber
Optional		Temperature to which the thermostat should cool (in °C). See also Set Points.
heating_set_point_celsiusNumber
Optional		Temperature to which the thermostat should heat (in °C).
cooling_set_point_fahrenheitNumber
Optional		Temperature to which the thermostat should cool (in °F).
heating_set_point_fahrenheitNumber
Optional		Temperature to which the thermostat should heat (in °F).
manual_override_allowedBoolean
Required		Indicates whether another user can use the thermostat or API to override this climate setting.
Deprecated. Use thermostat_schedule.is_override_allowed instead.
+ +### `active_thermostat_schedule` Properties + +
PropertyTypeDescription
thermostat_schedule_idString (UUID)
Required		ID of the active thermostat schedule.
device_idString (UUID)
Required		ID of the thermostat device.
nameString
Optional		User-friendly name to identify the thermostat schedule.
climate_preset_keyString
Required		Key of the climate preset to use for the thermostat schedule.
max_override_period_minutesInteger
Required		Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also Specifying Manual Override Permissions.
starts_atString (Datetime)
Required		Date and time at which the thermostat schedule starts, in ISO 8601 format.
is_override_allowedBoolean
Optional		Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
ends_atString (Datetime)
Required		Date and time at which the thermostat schedule ends, in ISO 8601 format.
created_atString (Datetime)
Required		Date and time at which the thermostat schedule was created.
errorsArray of objects
Optional		Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: error_code and message. error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
+ +### `temperature_threshold` Properties + +
PropertyTypeDescription
lower_limit_celsiusNumber
Optional		Lower acceptable temperature bound in degrees Celsius.
lower_limit_fahrenheitNumber
Optional		Lower acceptable temperature bound in degrees Fahrenheit.
upper_limit_celsiusNumber
Optional		Upper acceptable temperature bound in degrees Celsius.
upper_limit_fahrenheitNumber
Optional		Upper acceptable temperature bound in degrees Fahrenheit.
## Device Error Types @@ -145,7 +157,7 @@ Each constraint in the `code_constraints` array contains objects with the `const The `constraint_type` property can be one of the following enum values: -
Constraint TypeDescription
no_zeros0s cannot be used as digits in the PIN code.
cannot_start_with_12The PIN code cannot start with the sequence of digits 12.
no_triple_consecutive_intsNo more than three digits in a row can be consecutive or the same in the PIN code.
cannot_specify_pin_codeYou cannot specify a PIN code. You must leave the code empty, and the lock provider generates a PIN code.
pin_code_matches_existing_set

If you specify a PIN code, it must match an existing set of PIN codes used in the account.

For example, the PIN code could match the code assigned to a user in the system.

start_date_in_futureFor time-bound codes, the start date must be in the future.
no_ascending_or_descending_sequenceThe PIN code cannot consist of a sequence of consecutive digits.
at_least_three_unique_digitsThe PIN must contain at least three unique digits.
cannot_contain_089

The PIN code cannot contain the digits 0, 8, or 9.

For example, this restriction could apply to a cylinder lock that only includes the digits 1 to 7.

name_length

The name of the code has some restrictions on length.

When the constraint_type is name_length, the constraint object has one or two additional properties called min_length and max_length to specify the length constraints.

name_must_be_uniqueThe name of the code must be unique within the device.
+
Constraint TypeDescription
no_zeros0s cannot be used as digits in the PIN code.
cannot_start_with_12The PIN code cannot start with the sequence of digits 12.
no_triple_consecutive_intsNo more than three digits in a row can be consecutive or the same in the PIN code.
cannot_specify_pin_codeYou cannot specify a PIN code. You must leave the code empty, and the lock provider generates a PIN code.
pin_code_matches_existing_set

If you specify a PIN code, it must match an existing set of PIN codes used in the account.

For example, the PIN code could match the code assigned to a user in the system.

start_date_in_futureFor time-bound codes, the start date must be in the future.
no_ascending_or_descending_sequenceThe PIN code cannot consist of a sequence of consecutive digits.
at_least_three_unique_digitsThe PIN must contain at least three unique digits.
cannot_contain_089

The PIN code cannot contain the digits 0, 8, or 9.

For example, this restriction could apply to a cylinder lock that only includes the digits 1 to 7.

cannot_contain_0789

The PIN code cannot contain the digits 0, 7, 8, or 9.

For example, this restriction could apply to a cylinder lock that only includes the digits 1 to 6.

name_length

The name of the code has some restrictions on length.

When the constraint_type is name_length, the constraint object has one or two additional properties called min_length and max_length to specify the length constraints.

name_must_be_uniqueThe name of the code must be unique within the device.
## `device` Methods diff --git a/docs/core-concepts/workspaces/README.md b/docs/core-concepts/workspaces/README.md index e459a81d..cbd036e6 100644 --- a/docs/core-concepts/workspaces/README.md +++ b/docs/core-concepts/workspaces/README.md @@ -113,7 +113,7 @@ You can only connect virtual devices in a sandbox workspace. To connect a real d ### Connecting Virtual Devices -To connect virtual devices, specify the login credentials for test device accounts in the [Seam Console](./#connect-devices-using-the-seam-console) or in [Connect Webviews](./#connect-devices-using-connect-webviews) within you apps. All manufacturers and devices that Seam supports have one or more sandbox test accounts with pre-seeded devices. For login credentials for all test device accounts, see [Sandbox & Sample Data](../../device-guides/sandbox-and-sample-data/). +To connect virtual devices, specify the login credentials for test device accounts in the [Seam Console](./#connect-devices-using-the-seam-console) or in [Connect Webviews](./#connect-devices-using-connect-webviews) within you apps. All manufacturers and devices that Seam supports have one or more sandbox test accounts with pre-seeded devices. For login credentials for all test device accounts, see [Sandbox Devices and Systems](../../device-guides/sandbox-and-sample-data/). ### Interacting with a Virtual Device @@ -198,4 +198,4 @@ You can add teammates to your workspace. The Seam Console sends an email invitation to the specified teammate. -{% @supademo/embed demoid="YLZEbSgX5shkgOyFb4LE9" url="https://app.supademo.com/demo/YLZEbSgX5shkgOyFb4LE9" %} +{% @supademo/embed demoId="YLZEbSgX5shkgOyFb4LE9" url="https://app.supademo.com/demo/YLZEbSgX5shkgOyFb4LE9" %} diff --git a/docs/device-guides/sandbox-and-sample-data/README.md b/docs/device-guides/sandbox-and-sample-data/README.md index f285b43b..6332ed6a 100644 --- a/docs/device-guides/sandbox-and-sample-data/README.md +++ b/docs/device-guides/sandbox-and-sample-data/README.md @@ -6,6 +6,8 @@ description: >- # Sandbox Devices and Systems +You can connect and work with virtual devices and systems in a [sandbox workspace](../../core-concepts/workspaces/#sandbox-workspaces). This ability to work with sandbox devices and systems is quite handy because it removes the need to own physical devices from multiple brands. Importantly, virtual devices behave identically to the corresponding real devices. That is, if your app works with a virtual device in a sandbox workspace, it will also work with a real device in a [production workspace](../../core-concepts/workspaces/#production-workspaces). + {% content-ref url="2n-intercoms-sample-data.md" %} [2n-intercoms-sample-data.md](2n-intercoms-sample-data.md) {% endcontent-ref %}