Protocol Documentation

Table of Contents

• ledcontrol.proto

  • GetNotificationLedConfigRequest
  • GetNotificationLedConfigResponse
  • GetNotificationLedConfigResponse.LedConfigEntry
  • LedConfig
  • LedFlashing
  • LedInfo
  • LedValue
  • ListLedsRequest
  • ListLedsResponse
  • ListNotificationsRequest
  • ListNotificationsResponse
  • Notification
  • NotificationState
  • NotificationState.LedConfigEntry
  • Rgbw
  • SetNotificationActiveRequest
  • SetNotificationActiveResponse
  • UpdateNotificationLedConfigRequest
  • UpdateNotificationLedConfigRequest.LedConfigEntry

  • UpdateNotificationLedConfigResponse

  • LedType

  • LedControl

• Scalar Value Types

Top

ledcontrol.proto

GetNotificationLedConfigRequest

Field	Type	Label	Description
notification_name	string

GetNotificationLedConfigResponse

Field	Type	Label	Description
led_config	GetNotificationLedConfigResponse.LedConfigEntry	repeated

GetNotificationLedConfigResponse.LedConfigEntry

Field	Type	Label	Description
key	string
value	LedConfig

LedConfig

Field	Type	Label	Description
fixed	LedValue
flashing	LedFlashing

LedFlashing

Field	Type	Label	Description
value	LedValue
t_on_ms	uint32
t_off_ms	uint32

LedInfo

Field	Type	Label	Description
name	string
type	LedType

LedValue

Field	Type	Label	Description
brightness	float
rgbw	Rgbw

ListLedsRequest

ListLedsResponse

Field	Type	Label	Description
leds	LedInfo	repeated

ListNotificationsRequest

ListNotificationsResponse

Field	Type	Label	Description
notifications	Notification	repeated

Notification

Field	Type	Label	Description
name	string
priority	int32
state	NotificationState

NotificationState

Field	Type	Label	Description
active	bool
led_config	NotificationState.LedConfigEntry	repeated

NotificationState.LedConfigEntry

Field	Type	Label	Description
key	string
value	LedConfig

Rgbw

Field	Type	Label	Description
red	float
green	float
blue	float
white	float

SetNotificationActiveRequest

Field	Type	Label	Description
notification_name	string
active	bool

SetNotificationActiveResponse

UpdateNotificationLedConfigRequest

Field	Type	Label	Description
notification_name	string
led_config	UpdateNotificationLedConfigRequest.LedConfigEntry	repeated

UpdateNotificationLedConfigRequest.LedConfigEntry

Field	Type	Label	Description
key	string
value	LedConfig

UpdateNotificationLedConfigResponse

LedType

Name	Number	Description
LedType_Unknown	0
LedType_Red	1
LedType_Green	2
LedType_Blue	3
LedType_White	4
LedType_RGBW	5

LedControl

Method Name	Request Type	Response Type	Description
ListLeds	ListLedsRequest	ListLedsResponse
ListNotifications	ListNotificationsRequest	ListNotificationsResponse
SetNotificationActive	SetNotificationActiveRequest	SetNotificationActiveResponse
GetNotificationLedConfig	GetNotificationLedConfigRequest	GetNotificationLedConfigResponse
UpdateNotificationLedConfig	UpdateNotificationLedConfigRequest	UpdateNotificationLedConfigResponse

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)