traits/on_off.proto

Table of Contents

• traits/on_off.proto

  • DescribeOnOffRequest

  • GetOnOffRequest

  • OnOff

  • OnOffSupport

  • PullOnOffRequest

  • PullOnOffResponse

  • PullOnOffResponse.Change

  • UpdateOnOffRequest

  • OnOff.State

  • OnOffApi

  • OnOffInfo

• Scalar Value Types

Top

traits/on_off.proto

DescribeOnOffRequest

Field	Type	Label	Description
name	string		The name of the device

GetOnOffRequest

Field	Type	Label	Description
name	string
read_mask	google.protobuf.FieldMask		The state fields to fetch

OnOff

Field	Type	Label	Description
state	OnOff.State

OnOffSupport

OnOffSupport 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

PullOnOffRequest

A request to monitor the state of a device

Field	Type	Label	Description
name	string
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.

PullOnOffResponse

Response to a Pull request for OnOffState changes

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

PullOnOffResponse.Change

Field	Type	Label	Description
name	string
on_off	OnOff
change_time	google.protobuf.Timestamp		when the change occurred

UpdateOnOffRequest

Field	Type	Label	Description
name	string
on_off	OnOff
update_mask	google.protobuf.FieldMask		The state fields to update

OnOff.State

Possible states for an On-Off device

Name	Number	Description
STATE_UNSPECIFIED	0
ON	1
OFF	2

OnOffApi

Applicable to devices that have a basic binary on and off functionality.

Method Name	Request Type	Response Type	Description
GetOnOff	GetOnOffRequest	OnOff	Get the current state of the device
UpdateOnOff	UpdateOnOffRequest	OnOff	Update the device to be on or off
PullOnOff	PullOnOffRequest	PullOnOffResponse stream	Get notified of changes to the OnOff state of a device

OnOffInfo

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

Method Name	Request Type	Response Type	Description
DescribeOnOff	DescribeOnOffRequest	OnOffSupport	Get information about how a named device implements OnOff 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)