Protocol Documentation

Table of Contents

• iocontrol.proto

  • DisablePinControlRequest
  • EnablePinControlRequest
  • GetPinValueRequest
  • GetPinValueResponse
  • GetPowerSupplyStateRequest
  • ListPinsRequest
  • ListPinsResponse
  • ListPowerSuppliesRequest
  • ListPowerSuppliesResponse
  • Pin
  • PinConfig
  • PowerSupply
  • PowerSupplyState
  • ResetPowerSuppliesRequest
  • ResetPowerSuppliesResponse
  • SetPinValueRequest
  • SetPinValueResponse

  • UpdatePowerSupplyConfigRequest

  • PinDirection

  • PowerSupplyConfig

  • IoControl

• Scalar Value Types

Top

iocontrol.proto

DisablePinControlRequest

Field	Type	Label	Description
name	string

EnablePinControlRequest

Field	Type	Label	Description
name	string
config	PinConfig

GetPinValueRequest

Field	Type	Label	Description
name	string

GetPinValueResponse

Field	Type	Label	Description
value	bool

GetPowerSupplyStateRequest

Field	Type	Label	Description
name	string

ListPinsRequest

ListPinsResponse

Field	Type	Label	Description
pins	Pin	repeated

ListPowerSuppliesRequest

ListPowerSuppliesResponse

Field	Type	Label	Description
power_supplies	PowerSupply	repeated

Pin

Field	Type	Label	Description
name	string
directions_available	PinDirection	repeated
power_supply	string
managed	bool
config	PinConfig		only if managed == true

PinConfig

Field	Type	Label	Description
direction	PinDirection
default_value	bool

PowerSupply

Field	Type	Label	Description
name	string
configs_available	PowerSupplyConfig	repeated
default_config	PowerSupplyConfig
state	PowerSupplyState

PowerSupplyState

Field	Type	Label	Description
config	PowerSupplyConfig
faulty	bool

ResetPowerSuppliesRequest

resets eFuse

ResetPowerSuppliesResponse

SetPinValueRequest

Field	Type	Label	Description
name	string
value	bool

SetPinValueResponse

Field	Type	Label	Description
value	bool

UpdatePowerSupplyConfigRequest

Field	Type	Label	Description
name	string
config	PowerSupplyConfig
persistent	bool

PinDirection

Name	Number	Description
PinDirection_Unknown	0
PinDirection_In	1
PinDirection_Out	2

PowerSupplyConfig

Name	Number	Description
PowerSupplyConfig_Unknown	0	unknown state
PowerSupplyConfig_Disabled	1	Relay -> internal, eFuse -> disabled
PowerSupplyConfig_Enabled	2	Relay -> internal, eFuse -> enabled
PowerSupplyConfig_External	3	Relay -> external, eFuse -> disabled

IoControl

Method Name	Request Type	Response Type	Description
ListPins	ListPinsRequest	ListPinsResponse	list available pins
EnablePinControl	EnablePinControlRequest	Pin	enable control of specific pin
DisablePinControl	DisablePinControlRequest	Pin	enable control of specific pin
GetPinValue	GetPinValueRequest	GetPinValueResponse	get current pin value (Pin must be enabled with SetPinControlEnabled before)
SetPinValue	SetPinValueRequest	SetPinValueResponse	set pin value (Pin must be enabled with SetPinControlEnabled before and direction must be "out")
ListPowerSupplies	ListPowerSuppliesRequest	ListPowerSuppliesResponse	list available power supplies
GetPowerSupplyState	GetPowerSupplyStateRequest	PowerSupplyState	get state of power supply
UpdatePowerSupplyConfig	UpdatePowerSupplyConfigRequest	PowerSupplyState	update power supply configuration (relay, efuse)
ResetPowerSupplies	ResetPowerSuppliesRequest	ResetPowerSuppliesResponse	reset efuses of power supplies

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)