traits/motion_sensor.proto

Table of Contents

• traits/motion_sensor.proto

  • DescribeMotionDetectionRequest

  • GetMotionDetectionRequest

  • MotionDetection

  • MotionDetectionSupport

  • PullMotionDetectionRequest

  • PullMotionDetectionResponse

  • PullMotionDetectionResponse.Change

  • MotionDetection.State

  • MotionSensorApi

  • MotionSensorSensorInfo

• Scalar Value Types

Top

traits/motion_sensor.proto

DescribeMotionDetectionRequest

Field	Type	Label	Description
name	string		The name of the device

GetMotionDetectionRequest

request to fetch the current state of the device

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

MotionDetection

the current state of the motion sensor

Field	Type	Label	Description
state	MotionDetection.State		has motion been detected or not
state_change_time	google.protobuf.Timestamp		The time the state last changed

MotionDetectionSupport

MotionDetectionSupport describes the capabilities of devices implementing this trait

Field	Type	Label	Description
resource_support	smartcore.types.ResourceSupport		How a named device supports read/pull apis
not_detected_delay	google.protobuf.Duration		How long the device is configured to wait before reporting a state of NOT_DETECTED

PullMotionDetectionRequest

request to be notified of changes to the state of the device

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

PullMotionDetectionResponse

response containing motion state changes

Field	Type	Label	Description
changes	PullMotionDetectionResponse.Change	repeated	the list of changes that have occurred since the last event

PullMotionDetectionResponse.Change

A change to the motion state of the device

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

MotionDetection.State

Possible states for motion detected

Name	Number	Description
STATE_UNSPECIFIED	0	The state has not been specified.
NOT_DETECTED	1	No motion is detected, or has been detected within the not_detected_delay period
DETECTED	2	Motion has been detected by the device.

MotionSensorApi

Represents a sensor that detects motion. Note that the absence of motion does not directly imply an unoccupied space.

Method Name	Request Type	Response Type	Description
GetMotionDetection	GetMotionDetectionRequest	MotionDetection	Get the current motion state for the device.
PullMotionDetections	PullMotionDetectionRequest	PullMotionDetectionResponse stream	subscribe to changes in the motion state for the device.

MotionSensorSensorInfo

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

Method Name	Request Type	Response Type	Description
DescribeMotionDetection	DescribeMotionDetectionRequest	MotionDetectionSupport	Get information about how a named device implements MotionDetection measurements

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)