Protocol Documentation¶

Table of Contents¶

cc/arduino/cli/settings/v1/settings.proto - DeleteRequest - DeleteResponse - GetAllRequest - GetAllResponse - GetValueRequest - GetValueResponse - MergeRequest - MergeResponse - SetValueRequest - SetValueResponse - WriteRequest - WriteResponse
- SettingsService

Scalar Value Types

cc/arduino/cli/settings/v1/settings.proto¶

DeleteRequest¶

Field	Type	Label	Description
key	string		The key of the setting to delete.

DeleteResponse¶

GetAllRequest¶

GetAllResponse¶

Field	Type	Label	Description
json_data	string		The settings, in JSON format.

GetValueRequest¶

Field	Type	Label	Description
key	string		The key of the setting.

GetValueResponse¶

Field	Type	Label	Description
key	string		The key of the setting.
json_data	string		The setting, in JSON format.

MergeRequest¶

Field	Type	Label	Description
json_data	string		The settings, in JSON format.

MergeResponse¶

SetValueRequest¶

Field	Type	Label	Description
key	string		The key of the setting.
json_data	string		The setting, in JSON format.

SetValueResponse¶

WriteRequest¶

Field	Type	Label	Description
file_path	string		Path to settings file (e.g. /path/to/arduino-cli.yaml)

WriteResponse¶

SettingsService¶

The SettingsService provides an interface to Arduino CLI configuration options

Method Name	Request Type	Response Type	Description
GetAll	GetAllRequest	GetAllResponse	List all the settings.
Merge	MergeRequest	MergeResponse	Set multiple settings values at once.
GetValue	GetValueRequest	GetValueResponse	Get the value of a specific setting.
SetValue	SetValueRequest	SetValueResponse	Set the value of a specific setting.
Write	WriteRequest	WriteResponse	Writes to file settings currently stored in memory
Delete	DeleteRequest	DeleteResponse	Deletes an entry and rewrites the file settings

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)