traits/fan_speed.proto

Table of Contents

• traits/fan_speed.proto

  • DescribeFanSpeedRequest

  • FanSpeed

  • FanSpeedSupport

  • GetFanSpeedRequest

  • PullFanSpeedRequest

  • PullFanSpeedResponse

  • PullFanSpeedResponse.Change

  • ReverseFanSpeedDirectionRequest

  • UpdateFanSpeedRequest

  • FanSpeed.Direction

  • FanSpeedApi

  • FanSpeedInfo

• Scalar Value Types

Top

traits/fan_speed.proto

DescribeFanSpeedRequest

Field	Type	Label	Description
name	string		The name of the device

FanSpeed

FanSpeed describes how fast a fan is spinning.

Field	Type	Label	Description
percentage	float		Percentage describes the fan speed relative to it's minimum and maximum fan speed. In the range [0,100].
preset	string		Preset describes the fan speed in terms of qualitative values, low, high, etc. Available values are reported via FanSpeedSupport.presets.
preset_index	int32		Preset index is the index in FanSpeedSupport.presets of the currently selected preset. This field is primarily used for relative speed adjustment, a value of 1 when the update is relative, adds 1 to the active preset, increasing the fan speed by one adjustment. Negative values would decrease the fan speed by an equivalent number of steps.
direction	FanSpeed.Direction		Direction describes the direction of the fan rotation. This is typically described relative to the function of the fan. For example a table top fan might describe FORWARD as blowing air out the front of the fan.

FanSpeedSupport

Field	Type	Label	Description
resource_support	smartcore.types.ResourceSupport		How a named device supports read/write/pull apis
presets	string	repeated	Presets is the list of supported fan speed presets, in ascending fan speed order - i.e. index 0 is the slowest.

GetFanSpeedRequest

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 FanSpeed type

PullFanSpeedRequest

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

PullFanSpeedResponse

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

PullFanSpeedResponse.Change

Field	Type	Label	Description
name	string		Name of the device that issued the change.
change_time	google.protobuf.Timestamp		When the change occurred
fan_speed	FanSpeed		The new value for the current fan speed.

ReverseFanSpeedDirectionRequest

Field	Type	Label	Description
name	string		Name of the device to reverse the fan speed for.

UpdateFanSpeedRequest

Field	Type	Label	Description
name	string		Name of the device to fetch the state for
fan_speed	FanSpeed		The new fan speed.
update_mask	google.protobuf.FieldMask		Fields to fetch relative to the FanSpeed type
relative	bool		Values in fan_speed are relative to their current values. FanSpeed.preset cannot be directly set relatively, use preset_index instead to adjust the selected preset index.

FanSpeed.Direction

Name	Number	Description
DIRECTION_UNSPECIFIED	0
FORWARD	1
BACKWARD	2

FanSpeedApi

Trait for devices that can control the speed of a fan.

Method Name	Request Type	Response Type	Description
GetFanSpeed	GetFanSpeedRequest	FanSpeed	GetFanSpeed returns the fan speed for the device.
UpdateFanSpeed	UpdateFanSpeedRequest	FanSpeed	UpdateFanSpeed updates the fan speed for the device.
PullFanSpeed	PullFanSpeedRequest	PullFanSpeedResponse stream	PullFanSpeed returns a stream of changes to the current fan speed for the device.
ReverseFanSpeedDirection	ReverseFanSpeedDirectionRequest	FanSpeed	ReverseFanSpeedDirection reverses the fan speed direction. If the fan is spinning FORWARD it will be changed to BACKWARD, etc.

FanSpeedInfo

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

Method Name	Request Type	Response Type	Description
DescribeFanSpeed	DescribeFanSpeedRequest	FanSpeedSupport	Get information about how a named device implements FanSpeed features

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)