traits/lock_unlock.proto

Table of Contents

• traits/lock_unlock.proto

  • GetLockUnlockRequest

  • LockUnlock

  • PullLockUnlockRequest

  • PullLockUnlockResponse

  • PullLockUnlockResponse.Change

  • UpdateLockUnlockRequest

  • LockUnlock.Position

  • LockUnlockApi

  • LockUnlockInfo

• Scalar Value Types

Top

traits/lock_unlock.proto

GetLockUnlockRequest

Field	Type	Label	Description
name	string		Name of the device to fetch the state for
read_mask	google.protobuf.FieldMask		Fields to fetch relative to the LockUnlock type

LockUnlock

LockUnlock models the possible states of a lockable device.

Field	Type	Label	Description
position	LockUnlock.Position		Position reports whether the device is locked or unlocked, or transitioning.
jammed	bool		Jammed reports whether the lock has jammed and is unable to reach it's position. Output only.

PullLockUnlockRequest

Field	Type	Label	Description
name	string		Name of the device to fetch the state for
read_mask	google.protobuf.FieldMask		Fields to fetch relative to the LockUnlock type
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.

PullLockUnlockResponse

Field	Type	Label	Description
changes	PullLockUnlockResponse.Change	repeated	Changes since the last message.

PullLockUnlockResponse.Change

Field	Type	Label	Description
name	string		Name of the device that issued the change.
change_time	google.protobuf.Timestamp		When the change occurred
lock_unlock	LockUnlock		The new value for the lock.

UpdateLockUnlockRequest

Field	Type	Label	Description
name	string		Name of the device to fetch the state for
lock_unlock	LockUnlock		The new value
update_mask	google.protobuf.FieldMask		Fields to fetch relative to the LockUnlock type

LockUnlock.Position

Position defines the possible lock positions. Note that only LOCKED and UNLOCKED can be used during a write.

Name	Number	Description
POSITION_UNSPECIFIED	0	The lock position is unspecified.
LOCKED	1	The device is locked.
UNLOCKED	2	The device is unlocked.
LOCKING	3	The device is in the process of locking. Optional. Output only.
UNLOCKING	4	The device is in the process of unlocking. Optional. Output only.

LockUnlockApi

LockUnlockApi describes devices that can be locked and unlocked, and/or report a locked state. The concept is encoded in the LockUnlock.position, a device may be locked, unlocked, or transitioning into one of these positions.

Method Name	Request Type	Response Type	Description
GetLockUnlock	GetLockUnlockRequest	LockUnlock	Get the current lock position for the device.
UpdateLockUnlock	UpdateLockUnlockRequest	LockUnlock	Update the lock position of the device.
PullLockUnlock	PullLockUnlockRequest	PullLockUnlockResponse stream	Subscribe to changes in the lock position for the device.

LockUnlockInfo

todo: define LockUnlockInfo

Method Name	Request Type	Response Type	Description

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)