traits/parent.proto

Table of Contents

• traits/parent.proto

  • Child

  • ListChildrenRequest

  • ListChildrenResponse

  • PullChildrenRequest

  • PullChildrenResponse

  • PullChildrenResponse.Change

  • Trait

  • ParentApi

  • ParentInfo

• Scalar Value Types

Top

traits/parent.proto

Child

Child is a member of a parent.

Field	Type	Label	Description
name	string		Name is the Smart Core name for this child device.
traits	Trait	repeated	Traits lists the traits this child implements.
parent	string		Parent is the name of this child's direct parent. If absent this is the name of the device in the children request.

ListChildrenRequest

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 ElectricMode type
page_size	int32		The maximum number of children to return. The service may return fewer than this value. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string		A page token, received from a previous ListChildrenResponse call. Provide this to retrieve the subsequent page.

ListChildrenResponse

Field	Type	Label	Description
children	Child	repeated
next_page_token	string		A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
total_size	int32		If non-zero this is the total number of draw notifications. This may be an estimate.

PullChildrenRequest

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 ElectricMode 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.

PullChildrenResponse

Field	Type	Label	Description
changes	PullChildrenResponse.Change	repeated	The list of changes which have occurred

PullChildrenResponse.Change

Field	Type	Label	Description
name	string		The name of the device that emitted this change
type	smartcore.types.ChangeType		The type of change (e.g. ADD, UPDATE, etc...)
new_value	Child		The new value to use for ADD
old_value	Child		The old value to use for UPDATE
change_time	google.protobuf.Timestamp		When the change occurred

Trait

Field	Type	Label	Description
name	string		The qualified name of the trait. For example smartcore.traits.Parent

ParentApi

ParentApi describes the capabilities of a device to have child devices.

Method Name	Request Type	Response Type	Description
ListChildren	ListChildrenRequest	ListChildrenResponse	ListChildren returns children associated with the named parent device.
PullChildren	PullChildrenRequest	PullChildrenResponse stream	PullChildren subscribes to changes in the children associated with the named parent device.

ParentInfo

todo: define ParentInfo

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)