traits/extend_retract.proto

Table of Contents

• traits/extend_retract.proto

  • CreateExtensionPresetRequest

  • DescribeExtensionRequest

  • ExtendRetractStopRequest

  • Extension

  • ExtensionPreset

  • ExtensionSupport

  • GetExtensionRequest

  • PullExtensionsRequest

  • PullExtensionsResponse

  • PullExtensionsResponse.Change

  • UpdateExtensionRequest

  • ExtendRetractApi

  • ExtendRetractInfo

• Scalar Value Types

Top

traits/extend_retract.proto

CreateExtensionPresetRequest

A request to store the current position under a preset name

Field	Type	Label	Description
name	string		The name of the device
preset	ExtensionPreset		The preset to store the position under

DescribeExtensionRequest

Field	Type	Label	Description
name	string		The name of the device

ExtendRetractStopRequest

Request for the stop api

Field	Type	Label	Description
name	string		the name of the device to stop

Extension

How extended the device is.

Field	Type	Label	Description
extend_percent	float		0 to 100, representing the extension percentage of the device
extend_preset	string		A named preset for recall to extend the device to a specific point
extend_tween	smartcore.types.Tween		How the extension changes or should change over time. On write only duration should be set.
target_extend_percent	float		if tweening between values, this is our end goal
target_extend_preset	string		if tweening between values, this is our end goal

ExtensionPreset

Describes a preset that may be configured on the device

Field	Type	Label	Description
name	string		Required. The name of the preset, to be used for recall.
extend_percent	float	optional	Optional 0 to 100, extension percentage that the preset would extend the device by.
writable	bool		Can this preset be stored via the api

ExtensionSupport

ExtensionSupport describes the capabilities of devices implementing this trait

Field	Type	Label	Description
resource_support	smartcore.types.ResourceSupport		How a named device supports read/write/pull apis
presets	ExtensionPreset	repeated	List of presets that this device supports. If empty then the device does not support presets
step	float		0 to 100, how precise is the control of the extension. A value of 0 (or 100) means only 0 or 100 extend_percent are valid.
tween_support	smartcore.types.TweenSupport		Does the device support tweening between the current value and a target value
supports_custom_presets	bool		If true, custom preset names can be used to store extension values. If false only writable presets can be updated.

GetExtensionRequest

request to fetch the current extension for the device

Field	Type	Label	Description
name	string		the name of the device to fetch the information for
read_mask	google.protobuf.FieldMask		The state fields to fetch

PullExtensionsRequest

A request to monitor the state of a device

Field	Type	Label	Description
name	string		name of the device to subscribe to
read_mask	google.protobuf.FieldMask		The state fields to fetch
updates_only	bool		When true the device will only send changes to the resource value. The default behaviour is to send the current value immediately followed by any updates as they happen.

PullExtensionsResponse

Response to a Pull request for extension changes

Field	Type	Label	Description
changes	PullExtensionsResponse.Change	repeated	Changes that have occurred since the last event

PullExtensionsResponse.Change

A change to the state

Field	Type	Label	Description
name	string		name for the device that issued the change
change_time	google.protobuf.Timestamp		when the change occurred
extension	Extension		the new state for the device

UpdateExtensionRequest

Field	Type	Label	Description
name	string
extension	Extension
update_mask	google.protobuf.FieldMask

ExtendRetractApi

Applicable to devices that can be extended or retracted. Like a tv mount or adjustable desk

Method Name	Request Type	Response Type	Description
GetExtension	GetExtensionRequest	Extension	Set the target state for the device
UpdateExtension	UpdateExtensionRequest	Extension	Set the target state for the device
Stop	ExtendRetractStopRequest	Extension	Stop the device if it is extending or retracting, returns the current known state after stopping.
CreateExtensionPreset	CreateExtensionPresetRequest	ExtensionPreset	Create a preset for the extension. If no preset extension value is specified then use the current position
PullExtensions	PullExtensionsRequest	PullExtensionsResponse stream	Get notified of changes to the OnOffState of a device

ExtendRetractInfo

Describes the capabilities of a specific named device with respect to this trait.

Method Name	Request Type	Response Type	Description
DescribeExtension	DescribeExtensionRequest	ExtensionSupport	Get information about how a named device implements Extension features

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)