traits/channel.proto

Table of Contents

• traits/channel.proto

  • AdjustChannelRequest

  • Channel

  • ChooseChannelRequest

  • ChosenChannelSupport

  • DescribeChosenChannelRequest

  • GetChosenChannelRequest

  • PullChosenChannelRequest

  • PullChosenChannelResponse

  • PullChosenChannelResponse.Change

  • ReturnChannelRequest

  • ChannelApi

  • ChannelInfo

• Scalar Value Types

Top

traits/channel.proto

AdjustChannelRequest

AdjustChannelRequest describes how to change the channel relative to the current channel.

Field	Type	Label	Description
name	string		The name of the device
amount	int32		How many channels to skip, use negative numbers to select previous channels. See ChannelApiAttributes.adjust_max.

Channel

Channel describes a single channel that can be chosen on the device.

During read all known properties will be populated, id and title will always be present. On write either id or number must be present.

Field	Type	Label	Description
id	string		Id uniquely identifies the channel and can be used to select it explicitly.
channel_number	string		A numeric identifier for the channel, such as 17 or 712.11-14. Not always parsable as a number.
title	string		A human readable name for the channel.

ChooseChannelRequest

ChooseChannelRequest describes which channel to select.

Field	Type	Label	Description
name	string		The name of the device
channel	Channel		The channel to select. Must contain either id or number.

ChosenChannelSupport

ChosenChannelSupport 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
adjust_max	int32		The max number of channels away from the current that are supported when adjusting channels. Defaults to 1.

todo: support for [choose,adjust,return], not sure what the defaults should be |

DescribeChosenChannelRequest

Field	Type	Label	Description
name	string		The name of the device

GetChosenChannelRequest

Field	Type	Label	Description
name	string		The name of the device
read_mask	google.protobuf.FieldMask		The state fields to fetch

PullChosenChannelRequest

Field	Type	Label	Description
name	string		The name of the device
read_mask	google.protobuf.FieldMask		The state fields to fetch
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.

PullChosenChannelResponse

Field	Type	Label	Description
changes	PullChosenChannelResponse.Change	repeated

PullChosenChannelResponse.Change

Field	Type	Label	Description
name	string		name for the device that issued the change
change_time	google.protobuf.Timestamp		when the change occurred
chosen_channel	Channel		The new chosen channel

ReturnChannelRequest

Select the last channel to be selected before the current one.

Field	Type	Label	Description
name	string		The name of the device

ChannelApi

ChannelApi allows for querying and updating the chosen channel on a device like a TV.

Method Name	Request Type	Response Type	Description
GetChosenChannel	GetChosenChannelRequest	Channel	GetChosenChannel returns the currently chosen channel for the device.
ChooseChannel	ChooseChannelRequest	Channel	ChooseChannel will set the currently chosen channel to the one specified. Returns the chosen channel
AdjustChannel	AdjustChannelRequest	Channel	AdjustChannel will choose a channel based on the current channel, i.e. 'next channel'. Returns the chosen channel
ReturnChannel	ReturnChannelRequest	Channel	ReturnChannel will choose the previously chosen channel. Returns the chosen channel
PullChosenChannel	PullChosenChannelRequest	PullChosenChannelResponse stream	PullChosenChannel subscribes to chosen channel changes

ChannelInfo

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

Method Name	Request Type	Response Type	Description
DescribeChosenChannel	DescribeChosenChannelRequest	ChosenChannelSupport	Get information about how a named device implements channel choosing and adjustment

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)