traits/meter.proto

Table of Contents

• traits/meter.proto

  • DescribeMeterReadingRequest

  • GetMeterReadingRequest

  • MeterReading

  • MeterReadingSupport

  • PullMeterReadingsRequest

  • PullMeterReadingsResponse

  • PullMeterReadingsResponse.Change

  • MeterApi

  • MeterInfo

• Scalar Value Types

Top

traits/meter.proto

DescribeMeterReadingRequest

Field	Type	Label	Description
name	string

GetMeterReadingRequest

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

MeterReading

Field	Type	Label	Description
usage	float		Usage records the current value of the meter. The unit is unspecified, use device documentation or MeterInfo to discover it. This value is a total recorded between the start and end times.
start_time	google.protobuf.Timestamp		Optional. The start period usage is recorded relative to. Typically the installation date, but not required to be. The start time can be reset and updated by the device if it is serviced or updated.
end_time	google.protobuf.Timestamp		Optional. The end of the period usage is recorded relative to, i.e. the time the reading was taken. This time might not be now if the device has a low resolution for taking readings.

MeterReadingSupport

MeterReadingSupport 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 usage value

PullMeterReadingsRequest

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

PullMeterReadingsResponse

Field	Type	Label	Description
changes	PullMeterReadingsResponse.Change	repeated

PullMeterReadingsResponse.Change

Field	Type	Label	Description
name	string
change_time	google.protobuf.Timestamp
meter_reading	MeterReading

MeterApi

MeterApi represents a metering device, like an electric meter. The device records total usage since some fixed point in time, this trait provides access to that usage value. For example an electric meter records total energy usage since it was installed/reset in kWh as an ever increasing number.

Method Name	Request Type	Response Type	Description
GetMeterReading	GetMeterReadingRequest	MeterReading
PullMeterReadings	PullMeterReadingsRequest	PullMeterReadingsResponse stream

MeterInfo

Method Name	Request Type	Response Type	Description
DescribeMeterReading	DescribeMeterReadingRequest	MeterReadingSupport

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)