traits/waste.proto

Table of Contents

• traits/waste.proto

  • DescribeWasteRecordRequest

  • ListWasteRecordsRequest

  • ListWasteRecordsResponse

  • PullWasteRecordsRequest

  • PullWasteRecordsResponse

  • PullWasteRecordsResponse.Change

  • WasteRecord

  • WasteRecordSupport

  • WasteRecord.DisposalMethod

  • WasteApi

  • WasteInfo

• Scalar Value Types

Top

traits/waste.proto

DescribeWasteRecordRequest

Field	Type	Label	Description
name	string

ListWasteRecordsRequest

Field	Type	Label	Description
name	string
read_mask	google.protobuf.FieldMask
page_size	int32		The maximum number of WasteRecords 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 ListWasteRecordsResponse call. Provide this to retrieve the subsequent page.

ListWasteRecordsResponse

Field	Type	Label	Description
wasteRecords	WasteRecord	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 alerts after filtering is applied. This may be an estimate.

PullWasteRecordsRequest

Field	Type	Label	Description
name	string
read_mask	google.protobuf.FieldMask
updates_only	bool

PullWasteRecordsResponse

Field	Type	Label	Description
changes	PullWasteRecordsResponse.Change	repeated

PullWasteRecordsResponse.Change

Field	Type	Label	Description
name	string
change_time	google.protobuf.Timestamp
new_value	WasteRecord
old_value	WasteRecord
type	smartcore.types.ChangeType

WasteRecord

WasteRecord is a record of a unit of waste produced by the building

Field	Type	Label	Description
id	string		The id of the waste record assigned by the external waste management system
record_create_time	google.protobuf.Timestamp		The time the record was created, this is not the time the waste was created
weight	float		The weight of the waste. Use the InfoApi to find the actual unit the device uses.
system	string		The system the waste was collected from. Used for presentation not to identify the waste
disposal_method	WasteRecord.DisposalMethod
area	string		Area the waste was collected from, e.g. tenant x, common area. Used for presentation not to identify the waste
waste_create_time	google.protobuf.Timestamp		The date/time the waste was created
stream	string		The stream the waste was collected from. For example, general waste, mixed recycling etc. Used for presentation not to identify the waste
co2_saved	float		The amount of co2 saved.
land_saved	float		The amount of land saved.
trees_saved	float		The amount of trees saved in number of trees. Can be a decimal number.

WasteRecordSupport

WasteRecordSupport 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
unit	string		The unit associated with the weight value
co2_saved_unit	string		The unit associated with the co2_saved value
land_saved_unit	string		The unit associated with the land_saved value

WasteRecord.DisposalMethod

Describes the disposal method of the waste. Recycled, general

Name	Number	Description
DISPOSAL_METHOD_UNSPECIFIED	0
GENERAL_WASTE	1
MIXED_RECYCLING	2

WasteApi

WasteApi exposes details about units of waste that have been produced by the building

Method Name	Request Type	Response Type	Description
ListWasteRecords	ListWasteRecordsRequest	ListWasteRecordsResponse
PullWasteRecords	PullWasteRecordsRequest	PullWasteRecordsResponse stream

WasteInfo

Method Name	Request Type	Response Type	Description
DescribeWasteRecord	DescribeWasteRecordRequest	WasteRecordSupport

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)