ardunno-cli
Version:
nice-grpc API for the Arduino CLI
5,069 lines • 265 kB
TypeScript
import type { CallContext, CallOptions } from 'nice-grpc-common';
import _m0 from 'protobufjs/minimal';
import { Status } from '../../../../../google/rpc/status';
import { BoardDetailsRequest, BoardDetailsResponse, BoardIdentifyRequest, BoardIdentifyResponse, BoardListAllRequest, BoardListAllResponse, BoardListRequest, BoardListResponse, BoardListWatchRequest, BoardListWatchResponse, BoardSearchRequest, BoardSearchResponse } from './board';
import { DownloadProgress, Instance, ProfileLibraryReference, Sketch, SketchProfile, TaskProgress } from './common';
import { CompileRequest, CompileResponse } from './compile';
import { PlatformDownloadRequest, PlatformDownloadResponse, PlatformInstallRequest, PlatformInstallResponse, PlatformSearchRequest, PlatformSearchResponse, PlatformUninstallRequest, PlatformUninstallResponse, PlatformUpgradeRequest, PlatformUpgradeResponse } from './core';
import { DebugRequest, DebugResponse, GetDebugConfigRequest, GetDebugConfigResponse, IsDebugSupportedRequest, IsDebugSupportedResponse } from './debug';
import { GitLibraryInstallRequest, GitLibraryInstallResponse, LibraryDownloadRequest, LibraryDownloadResponse, LibraryInstallRequest, LibraryInstallResponse, LibraryListRequest, LibraryListResponse, LibraryResolveDependenciesRequest, LibraryResolveDependenciesResponse, LibrarySearchRequest, LibrarySearchResponse, LibraryUninstallRequest, LibraryUninstallResponse, LibraryUpgradeAllRequest, LibraryUpgradeAllResponse, LibraryUpgradeRequest, LibraryUpgradeResponse, ZipLibraryInstallRequest, ZipLibraryInstallResponse } from './lib';
import { EnumerateMonitorPortSettingsRequest, EnumerateMonitorPortSettingsResponse, MonitorRequest, MonitorResponse } from './monitor';
import { ConfigurationGetRequest, ConfigurationGetResponse, ConfigurationOpenRequest, ConfigurationOpenResponse, ConfigurationSaveRequest, ConfigurationSaveResponse, SettingsEnumerateRequest, SettingsEnumerateResponse, SettingsGetValueRequest, SettingsGetValueResponse, SettingsSetValueRequest, SettingsSetValueResponse } from './settings';
import { BurnBootloaderRequest, BurnBootloaderResponse, ListProgrammersAvailableForUploadRequest, ListProgrammersAvailableForUploadResponse, SupportedUserFieldsRequest, SupportedUserFieldsResponse, UploadRequest, UploadResponse, UploadUsingProgrammerRequest, UploadUsingProgrammerResponse } from './upload';
/** Represent the reason why an instance initialization failed. */
export declare enum FailedInstanceInitReason {
/**
* FAILED_INSTANCE_INIT_REASON_UNSPECIFIED -
* FAILED_INSTANCE_INIT_REASON_UNSPECIFIED the error reason is not
* specialized.
*/
FAILED_INSTANCE_INIT_REASON_UNSPECIFIED = 0,
/**
* FAILED_INSTANCE_INIT_REASON_INVALID_INDEX_URL - INVALID_INDEX_URL a package
* index url is malformed.
*/
FAILED_INSTANCE_INIT_REASON_INVALID_INDEX_URL = 1,
/**
* FAILED_INSTANCE_INIT_REASON_INDEX_LOAD_ERROR -
* FAILED_INSTANCE_INIT_REASON_INDEX_LOAD_ERROR failure encountered while
* loading an index.
*/
FAILED_INSTANCE_INIT_REASON_INDEX_LOAD_ERROR = 2,
/**
* FAILED_INSTANCE_INIT_REASON_TOOL_LOAD_ERROR -
* FAILED_INSTANCE_INIT_REASON_TOOL_LOAD_ERROR failure encountered while
* loading a tool.
*/
FAILED_INSTANCE_INIT_REASON_TOOL_LOAD_ERROR = 3,
/**
* FAILED_INSTANCE_INIT_REASON_INDEX_DOWNLOAD_ERROR -
* FAILED_INSTANCE_INIT_REASON_INDEX_DOWNLOAD_ERROR failure encountered while
* downloading an index.
*/
FAILED_INSTANCE_INIT_REASON_INDEX_DOWNLOAD_ERROR = 4,
UNRECOGNIZED = -1
}
export declare function failedInstanceInitReasonFromJSON(object: any): FailedInstanceInitReason;
export declare function failedInstanceInitReasonToJSON(object: FailedInstanceInitReason): string;
export interface CreateRequest {
}
export interface CreateResponse {
/** An Arduino Core instance. */
instance: Instance | undefined;
}
export interface InitRequest {
/** An Arduino Core instance. */
instance: Instance | undefined;
/** Profile to use. */
profile: string;
/** The path where the sketch is stored. */
sketchPath: string;
}
export interface InitResponse {
message?: {
$case: 'initProgress';
initProgress: InitResponse_Progress;
} | {
$case: 'error';
error: Status;
} | {
$case: 'profile';
profile: SketchProfile;
} | undefined;
}
export interface InitResponse_Progress {
/** Progress of the downloads of platforms and libraries index files. */
downloadProgress: DownloadProgress | undefined;
/** Describes the current stage of the initialization. */
taskProgress: TaskProgress | undefined;
}
export interface FailedInstanceInitError {
/** Specific cause of the error. */
reason: FailedInstanceInitReason;
/** Explanation of the error. */
message: string;
}
export interface DestroyRequest {
/** The Arduino Core Service instance to destroy. */
instance: Instance | undefined;
}
export interface DestroyResponse {
}
export interface UpdateIndexRequest {
/** Arduino Core Service instance from the Init response. */
instance: Instance | undefined;
/** If set to true user defined package indexes will not be updated. */
ignoreCustomPackageIndexes: boolean;
/**
* Only perform index update if the index file is older than this value in
* seconds.
*/
updateIfOlderThanSecs: number;
}
export interface UpdateIndexResponse {
message?: {
$case: 'downloadProgress';
downloadProgress: DownloadProgress;
} | {
$case: 'result';
result: UpdateIndexResponse_Result;
} | undefined;
}
export interface UpdateIndexResponse_Result {
/** The result of the packages index update. */
updatedIndexes: IndexUpdateReport[];
}
export interface UpdateLibrariesIndexRequest {
/** Arduino Core Service instance from the Init response. */
instance: Instance | undefined;
/**
* Only perform index update if the index file is older than this value in
* seconds.
*/
updateIfOlderThanSecs: number;
}
export interface UpdateLibrariesIndexResponse {
message?: {
$case: 'downloadProgress';
downloadProgress: DownloadProgress;
} | {
$case: 'result';
result: UpdateLibrariesIndexResponse_Result;
} | undefined;
}
export interface UpdateLibrariesIndexResponse_Result {
/** The result of the libraries index update. */
librariesIndex: IndexUpdateReport | undefined;
}
export interface IndexUpdateReport {
/** The URL of the index that was updated. */
indexUrl: string;
/** The result of the index update. */
status: IndexUpdateReport_Status;
}
/** The status represents the result of the index update. */
export declare enum IndexUpdateReport_Status {
/** STATUS_UNSPECIFIED - The status of the index update is unspecified. */
STATUS_UNSPECIFIED = 0,
/** STATUS_UPDATED - The index has been successfully updated. */
STATUS_UPDATED = 1,
/** STATUS_ALREADY_UP_TO_DATE - The index was already up to date. */
STATUS_ALREADY_UP_TO_DATE = 2,
/** STATUS_FAILED - The index update failed. */
STATUS_FAILED = 3,
/** STATUS_SKIPPED - The index update was skipped. */
STATUS_SKIPPED = 4,
UNRECOGNIZED = -1
}
export declare function indexUpdateReport_StatusFromJSON(object: any): IndexUpdateReport_Status;
export declare function indexUpdateReport_StatusToJSON(object: IndexUpdateReport_Status): string;
export interface VersionRequest {
}
export interface VersionResponse {
/** The version of Arduino CLI in use. */
version: string;
}
export interface NewSketchRequest {
/** New sketch name. */
sketchName: string;
/**
* Optional: create a Sketch in this directory (used as "Sketchbook"
* directory). Default Sketchbook directory "directories.User" is used if
* sketch_dir is empty.
*/
sketchDir: string;
/** Specificies if an existing .ino sketch should be overwritten. */
overwrite: boolean;
}
export interface NewSketchResponse {
/** Absolute path to a main sketch file. */
mainFile: string;
}
export interface LoadSketchRequest {
/** Absolute path to single sketch file or a sketch folder. */
sketchPath: string;
}
export interface LoadSketchResponse {
/** The loaded sketch. */
sketch: Sketch | undefined;
}
export interface ArchiveSketchRequest {
/** Absolute path to Sketch file or folder containing Sketch file. */
sketchPath: string;
/**
* Absolute path to archive that will be created or folder that will contain
* it.
*/
archivePath: string;
/** Specifies if build directory should be included in the archive. */
includeBuildDir: boolean;
/** Allows to override an already existing archive. */
overwrite: boolean;
}
export interface ArchiveSketchResponse {
}
export interface SetSketchDefaultsRequest {
/** Absolute path to Sketch file or folder containing Sketch file. */
sketchPath: string;
/** The desired value for default_fqbn in project file (sketch.yaml). */
defaultFqbn: string;
/** The desired value for default_port in project file (sketch.yaml). */
defaultPortAddress: string;
/** The desired value for default_protocol in project file (sketch.yaml). */
defaultPortProtocol: string;
/** The desired value for default_programmer in project file (sketch.yaml). */
defaultProgrammer: string;
}
export interface SetSketchDefaultsResponse {
/**
* The value of default_fqnn that has been written in project file
* (sketch.yaml).
*/
defaultFqbn: string;
/**
* The value of default_port that has been written in project file
* (sketch.yaml).
*/
defaultPortAddress: string;
/**
* The value of default_protocol that has been written in project file
* (sketch.yaml).
*/
defaultPortProtocol: string;
/**
* The value of default_programmer that has been written in project file
* (sketch.yaml).
*/
defaultProgrammer: string;
}
export interface CheckForArduinoCLIUpdatesRequest {
/** Force the check, even if the configuration says not to check for updates. */
forceCheck: boolean;
}
export interface CheckForArduinoCLIUpdatesResponse {
/**
* The latest version of Arduino CLI available, if bigger than the current
* version.
*/
newestVersion: string;
}
export interface CleanDownloadCacheDirectoryRequest {
/** The Arduino Core Service instance. */
instance: Instance | undefined;
}
export interface CleanDownloadCacheDirectoryResponse {
}
export interface ProfileCreateRequest {
/** An Arduino Core instance. */
instance: Instance | undefined;
/** Absolute path to Sketch folder. */
sketchPath: string;
/** Name of the profile. */
profileName: string;
/** FQBN of the provided profile. */
fqbn: string;
/** Set the created profile as the default one. */
defaultProfile: boolean;
}
export interface ProfileCreateResponse {
}
export interface ProfileLibAddRequest {
/** An Arduino Core instance. */
instance: Instance | undefined;
/** Absolute path to Sketch folder. */
sketchPath: string;
/** Name of the profile. */
profileName: string;
/** The library to add to the profile. */
library: ProfileLibraryReference | undefined;
/** Set to true to add also all the dependencies of the library. */
addDependencies?: boolean | undefined;
/** Set to true to avoid overwriting an existing library in the profile. */
noOverwrite?: boolean | undefined;
}
export interface ProfileLibAddResponse {
/** The library that has been added or overwritten to the profile. */
addedLibraries: ProfileLibraryReference[];
/**
* The libraries that have been skipped because they were already present in
* the profile and the no_overwrite option was set to true.
*/
skippedLibraries: ProfileLibraryReference[];
/** Name of the profile. */
profileName: string;
}
export interface ProfileLibRemoveRequest {
/** An Arduino Core instance. */
instance: Instance | undefined;
/** Absolute path to Sketch folder. */
sketchPath: string;
/** Name of the profile. */
profileName: string;
/** The library to remove from the profile. */
library: ProfileLibraryReference | undefined;
/**
* Set to true to remove also all the dependencies of the library that are not
* used by other libraries in the profile.
*/
removeDependencies?: boolean | undefined;
}
export interface ProfileLibRemoveResponse {
/** The libraries that have been removed from the profile. */
removedLibraries: ProfileLibraryReference[];
/** Name of the profile. */
profileName: string;
}
export interface ProfileLibListRequest {
/** Absolute path to Sketch folder. */
sketchPath: string;
/** Name of the profile. */
profileName: string;
}
export interface ProfileLibListResponse {
/** The libraries in the profile. */
libraries: ProfileLibraryReference[];
/** Name of the profile. */
profileName: string;
}
export interface ProfileSetDefaultRequest {
/** Absolute path to Sketch folder. */
sketchPath: string;
/** Name of the profile. */
profileName: string;
}
export interface ProfileSetDefaultResponse {
}
export declare const CreateRequest: {
encode(_: CreateRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CreateRequest;
fromJSON(_: any): CreateRequest;
toJSON(_: CreateRequest): unknown;
create(base?: DeepPartial<CreateRequest>): CreateRequest;
fromPartial(_: DeepPartial<CreateRequest>): CreateRequest;
};
export declare const CreateResponse: {
encode(message: CreateResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CreateResponse;
fromJSON(object: any): CreateResponse;
toJSON(message: CreateResponse): unknown;
create(base?: DeepPartial<CreateResponse>): CreateResponse;
fromPartial(object: DeepPartial<CreateResponse>): CreateResponse;
};
export declare const InitRequest: {
encode(message: InitRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): InitRequest;
fromJSON(object: any): InitRequest;
toJSON(message: InitRequest): unknown;
create(base?: DeepPartial<InitRequest>): InitRequest;
fromPartial(object: DeepPartial<InitRequest>): InitRequest;
};
export declare const InitResponse: {
encode(message: InitResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): InitResponse;
fromJSON(object: any): InitResponse;
toJSON(message: InitResponse): unknown;
create(base?: DeepPartial<InitResponse>): InitResponse;
fromPartial(object: DeepPartial<InitResponse>): InitResponse;
};
export declare const InitResponse_Progress: {
encode(message: InitResponse_Progress, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): InitResponse_Progress;
fromJSON(object: any): InitResponse_Progress;
toJSON(message: InitResponse_Progress): unknown;
create(base?: DeepPartial<InitResponse_Progress>): InitResponse_Progress;
fromPartial(object: DeepPartial<InitResponse_Progress>): InitResponse_Progress;
};
export declare const FailedInstanceInitError: {
encode(message: FailedInstanceInitError, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): FailedInstanceInitError;
fromJSON(object: any): FailedInstanceInitError;
toJSON(message: FailedInstanceInitError): unknown;
create(base?: DeepPartial<FailedInstanceInitError>): FailedInstanceInitError;
fromPartial(object: DeepPartial<FailedInstanceInitError>): FailedInstanceInitError;
};
export declare const DestroyRequest: {
encode(message: DestroyRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): DestroyRequest;
fromJSON(object: any): DestroyRequest;
toJSON(message: DestroyRequest): unknown;
create(base?: DeepPartial<DestroyRequest>): DestroyRequest;
fromPartial(object: DeepPartial<DestroyRequest>): DestroyRequest;
};
export declare const DestroyResponse: {
encode(_: DestroyResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): DestroyResponse;
fromJSON(_: any): DestroyResponse;
toJSON(_: DestroyResponse): unknown;
create(base?: DeepPartial<DestroyResponse>): DestroyResponse;
fromPartial(_: DeepPartial<DestroyResponse>): DestroyResponse;
};
export declare const UpdateIndexRequest: {
encode(message: UpdateIndexRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UpdateIndexRequest;
fromJSON(object: any): UpdateIndexRequest;
toJSON(message: UpdateIndexRequest): unknown;
create(base?: DeepPartial<UpdateIndexRequest>): UpdateIndexRequest;
fromPartial(object: DeepPartial<UpdateIndexRequest>): UpdateIndexRequest;
};
export declare const UpdateIndexResponse: {
encode(message: UpdateIndexResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UpdateIndexResponse;
fromJSON(object: any): UpdateIndexResponse;
toJSON(message: UpdateIndexResponse): unknown;
create(base?: DeepPartial<UpdateIndexResponse>): UpdateIndexResponse;
fromPartial(object: DeepPartial<UpdateIndexResponse>): UpdateIndexResponse;
};
export declare const UpdateIndexResponse_Result: {
encode(message: UpdateIndexResponse_Result, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UpdateIndexResponse_Result;
fromJSON(object: any): UpdateIndexResponse_Result;
toJSON(message: UpdateIndexResponse_Result): unknown;
create(base?: DeepPartial<UpdateIndexResponse_Result>): UpdateIndexResponse_Result;
fromPartial(object: DeepPartial<UpdateIndexResponse_Result>): UpdateIndexResponse_Result;
};
export declare const UpdateLibrariesIndexRequest: {
encode(message: UpdateLibrariesIndexRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UpdateLibrariesIndexRequest;
fromJSON(object: any): UpdateLibrariesIndexRequest;
toJSON(message: UpdateLibrariesIndexRequest): unknown;
create(base?: DeepPartial<UpdateLibrariesIndexRequest>): UpdateLibrariesIndexRequest;
fromPartial(object: DeepPartial<UpdateLibrariesIndexRequest>): UpdateLibrariesIndexRequest;
};
export declare const UpdateLibrariesIndexResponse: {
encode(message: UpdateLibrariesIndexResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UpdateLibrariesIndexResponse;
fromJSON(object: any): UpdateLibrariesIndexResponse;
toJSON(message: UpdateLibrariesIndexResponse): unknown;
create(base?: DeepPartial<UpdateLibrariesIndexResponse>): UpdateLibrariesIndexResponse;
fromPartial(object: DeepPartial<UpdateLibrariesIndexResponse>): UpdateLibrariesIndexResponse;
};
export declare const UpdateLibrariesIndexResponse_Result: {
encode(message: UpdateLibrariesIndexResponse_Result, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UpdateLibrariesIndexResponse_Result;
fromJSON(object: any): UpdateLibrariesIndexResponse_Result;
toJSON(message: UpdateLibrariesIndexResponse_Result): unknown;
create(base?: DeepPartial<UpdateLibrariesIndexResponse_Result>): UpdateLibrariesIndexResponse_Result;
fromPartial(object: DeepPartial<UpdateLibrariesIndexResponse_Result>): UpdateLibrariesIndexResponse_Result;
};
export declare const IndexUpdateReport: {
encode(message: IndexUpdateReport, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): IndexUpdateReport;
fromJSON(object: any): IndexUpdateReport;
toJSON(message: IndexUpdateReport): unknown;
create(base?: DeepPartial<IndexUpdateReport>): IndexUpdateReport;
fromPartial(object: DeepPartial<IndexUpdateReport>): IndexUpdateReport;
};
export declare const VersionRequest: {
encode(_: VersionRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): VersionRequest;
fromJSON(_: any): VersionRequest;
toJSON(_: VersionRequest): unknown;
create(base?: DeepPartial<VersionRequest>): VersionRequest;
fromPartial(_: DeepPartial<VersionRequest>): VersionRequest;
};
export declare const VersionResponse: {
encode(message: VersionResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): VersionResponse;
fromJSON(object: any): VersionResponse;
toJSON(message: VersionResponse): unknown;
create(base?: DeepPartial<VersionResponse>): VersionResponse;
fromPartial(object: DeepPartial<VersionResponse>): VersionResponse;
};
export declare const NewSketchRequest: {
encode(message: NewSketchRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): NewSketchRequest;
fromJSON(object: any): NewSketchRequest;
toJSON(message: NewSketchRequest): unknown;
create(base?: DeepPartial<NewSketchRequest>): NewSketchRequest;
fromPartial(object: DeepPartial<NewSketchRequest>): NewSketchRequest;
};
export declare const NewSketchResponse: {
encode(message: NewSketchResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): NewSketchResponse;
fromJSON(object: any): NewSketchResponse;
toJSON(message: NewSketchResponse): unknown;
create(base?: DeepPartial<NewSketchResponse>): NewSketchResponse;
fromPartial(object: DeepPartial<NewSketchResponse>): NewSketchResponse;
};
export declare const LoadSketchRequest: {
encode(message: LoadSketchRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LoadSketchRequest;
fromJSON(object: any): LoadSketchRequest;
toJSON(message: LoadSketchRequest): unknown;
create(base?: DeepPartial<LoadSketchRequest>): LoadSketchRequest;
fromPartial(object: DeepPartial<LoadSketchRequest>): LoadSketchRequest;
};
export declare const LoadSketchResponse: {
encode(message: LoadSketchResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LoadSketchResponse;
fromJSON(object: any): LoadSketchResponse;
toJSON(message: LoadSketchResponse): unknown;
create(base?: DeepPartial<LoadSketchResponse>): LoadSketchResponse;
fromPartial(object: DeepPartial<LoadSketchResponse>): LoadSketchResponse;
};
export declare const ArchiveSketchRequest: {
encode(message: ArchiveSketchRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ArchiveSketchRequest;
fromJSON(object: any): ArchiveSketchRequest;
toJSON(message: ArchiveSketchRequest): unknown;
create(base?: DeepPartial<ArchiveSketchRequest>): ArchiveSketchRequest;
fromPartial(object: DeepPartial<ArchiveSketchRequest>): ArchiveSketchRequest;
};
export declare const ArchiveSketchResponse: {
encode(_: ArchiveSketchResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ArchiveSketchResponse;
fromJSON(_: any): ArchiveSketchResponse;
toJSON(_: ArchiveSketchResponse): unknown;
create(base?: DeepPartial<ArchiveSketchResponse>): ArchiveSketchResponse;
fromPartial(_: DeepPartial<ArchiveSketchResponse>): ArchiveSketchResponse;
};
export declare const SetSketchDefaultsRequest: {
encode(message: SetSketchDefaultsRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SetSketchDefaultsRequest;
fromJSON(object: any): SetSketchDefaultsRequest;
toJSON(message: SetSketchDefaultsRequest): unknown;
create(base?: DeepPartial<SetSketchDefaultsRequest>): SetSketchDefaultsRequest;
fromPartial(object: DeepPartial<SetSketchDefaultsRequest>): SetSketchDefaultsRequest;
};
export declare const SetSketchDefaultsResponse: {
encode(message: SetSketchDefaultsResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SetSketchDefaultsResponse;
fromJSON(object: any): SetSketchDefaultsResponse;
toJSON(message: SetSketchDefaultsResponse): unknown;
create(base?: DeepPartial<SetSketchDefaultsResponse>): SetSketchDefaultsResponse;
fromPartial(object: DeepPartial<SetSketchDefaultsResponse>): SetSketchDefaultsResponse;
};
export declare const CheckForArduinoCLIUpdatesRequest: {
encode(message: CheckForArduinoCLIUpdatesRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CheckForArduinoCLIUpdatesRequest;
fromJSON(object: any): CheckForArduinoCLIUpdatesRequest;
toJSON(message: CheckForArduinoCLIUpdatesRequest): unknown;
create(base?: DeepPartial<CheckForArduinoCLIUpdatesRequest>): CheckForArduinoCLIUpdatesRequest;
fromPartial(object: DeepPartial<CheckForArduinoCLIUpdatesRequest>): CheckForArduinoCLIUpdatesRequest;
};
export declare const CheckForArduinoCLIUpdatesResponse: {
encode(message: CheckForArduinoCLIUpdatesResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CheckForArduinoCLIUpdatesResponse;
fromJSON(object: any): CheckForArduinoCLIUpdatesResponse;
toJSON(message: CheckForArduinoCLIUpdatesResponse): unknown;
create(base?: DeepPartial<CheckForArduinoCLIUpdatesResponse>): CheckForArduinoCLIUpdatesResponse;
fromPartial(object: DeepPartial<CheckForArduinoCLIUpdatesResponse>): CheckForArduinoCLIUpdatesResponse;
};
export declare const CleanDownloadCacheDirectoryRequest: {
encode(message: CleanDownloadCacheDirectoryRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CleanDownloadCacheDirectoryRequest;
fromJSON(object: any): CleanDownloadCacheDirectoryRequest;
toJSON(message: CleanDownloadCacheDirectoryRequest): unknown;
create(base?: DeepPartial<CleanDownloadCacheDirectoryRequest>): CleanDownloadCacheDirectoryRequest;
fromPartial(object: DeepPartial<CleanDownloadCacheDirectoryRequest>): CleanDownloadCacheDirectoryRequest;
};
export declare const CleanDownloadCacheDirectoryResponse: {
encode(_: CleanDownloadCacheDirectoryResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CleanDownloadCacheDirectoryResponse;
fromJSON(_: any): CleanDownloadCacheDirectoryResponse;
toJSON(_: CleanDownloadCacheDirectoryResponse): unknown;
create(base?: DeepPartial<CleanDownloadCacheDirectoryResponse>): CleanDownloadCacheDirectoryResponse;
fromPartial(_: DeepPartial<CleanDownloadCacheDirectoryResponse>): CleanDownloadCacheDirectoryResponse;
};
export declare const ProfileCreateRequest: {
encode(message: ProfileCreateRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileCreateRequest;
fromJSON(object: any): ProfileCreateRequest;
toJSON(message: ProfileCreateRequest): unknown;
create(base?: DeepPartial<ProfileCreateRequest>): ProfileCreateRequest;
fromPartial(object: DeepPartial<ProfileCreateRequest>): ProfileCreateRequest;
};
export declare const ProfileCreateResponse: {
encode(_: ProfileCreateResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileCreateResponse;
fromJSON(_: any): ProfileCreateResponse;
toJSON(_: ProfileCreateResponse): unknown;
create(base?: DeepPartial<ProfileCreateResponse>): ProfileCreateResponse;
fromPartial(_: DeepPartial<ProfileCreateResponse>): ProfileCreateResponse;
};
export declare const ProfileLibAddRequest: {
encode(message: ProfileLibAddRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibAddRequest;
fromJSON(object: any): ProfileLibAddRequest;
toJSON(message: ProfileLibAddRequest): unknown;
create(base?: DeepPartial<ProfileLibAddRequest>): ProfileLibAddRequest;
fromPartial(object: DeepPartial<ProfileLibAddRequest>): ProfileLibAddRequest;
};
export declare const ProfileLibAddResponse: {
encode(message: ProfileLibAddResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibAddResponse;
fromJSON(object: any): ProfileLibAddResponse;
toJSON(message: ProfileLibAddResponse): unknown;
create(base?: DeepPartial<ProfileLibAddResponse>): ProfileLibAddResponse;
fromPartial(object: DeepPartial<ProfileLibAddResponse>): ProfileLibAddResponse;
};
export declare const ProfileLibRemoveRequest: {
encode(message: ProfileLibRemoveRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibRemoveRequest;
fromJSON(object: any): ProfileLibRemoveRequest;
toJSON(message: ProfileLibRemoveRequest): unknown;
create(base?: DeepPartial<ProfileLibRemoveRequest>): ProfileLibRemoveRequest;
fromPartial(object: DeepPartial<ProfileLibRemoveRequest>): ProfileLibRemoveRequest;
};
export declare const ProfileLibRemoveResponse: {
encode(message: ProfileLibRemoveResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibRemoveResponse;
fromJSON(object: any): ProfileLibRemoveResponse;
toJSON(message: ProfileLibRemoveResponse): unknown;
create(base?: DeepPartial<ProfileLibRemoveResponse>): ProfileLibRemoveResponse;
fromPartial(object: DeepPartial<ProfileLibRemoveResponse>): ProfileLibRemoveResponse;
};
export declare const ProfileLibListRequest: {
encode(message: ProfileLibListRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibListRequest;
fromJSON(object: any): ProfileLibListRequest;
toJSON(message: ProfileLibListRequest): unknown;
create(base?: DeepPartial<ProfileLibListRequest>): ProfileLibListRequest;
fromPartial(object: DeepPartial<ProfileLibListRequest>): ProfileLibListRequest;
};
export declare const ProfileLibListResponse: {
encode(message: ProfileLibListResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibListResponse;
fromJSON(object: any): ProfileLibListResponse;
toJSON(message: ProfileLibListResponse): unknown;
create(base?: DeepPartial<ProfileLibListResponse>): ProfileLibListResponse;
fromPartial(object: DeepPartial<ProfileLibListResponse>): ProfileLibListResponse;
};
export declare const ProfileSetDefaultRequest: {
encode(message: ProfileSetDefaultRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileSetDefaultRequest;
fromJSON(object: any): ProfileSetDefaultRequest;
toJSON(message: ProfileSetDefaultRequest): unknown;
create(base?: DeepPartial<ProfileSetDefaultRequest>): ProfileSetDefaultRequest;
fromPartial(object: DeepPartial<ProfileSetDefaultRequest>): ProfileSetDefaultRequest;
};
export declare const ProfileSetDefaultResponse: {
encode(_: ProfileSetDefaultResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileSetDefaultResponse;
fromJSON(_: any): ProfileSetDefaultResponse;
toJSON(_: ProfileSetDefaultResponse): unknown;
create(base?: DeepPartial<ProfileSetDefaultResponse>): ProfileSetDefaultResponse;
fromPartial(_: DeepPartial<ProfileSetDefaultResponse>): ProfileSetDefaultResponse;
};
/** The main Arduino Platform service API. */
export type ArduinoCoreServiceDefinition = typeof ArduinoCoreServiceDefinition;
export declare const ArduinoCoreServiceDefinition: {
readonly name: "ArduinoCoreService";
readonly fullName: "cc.arduino.cli.commands.v1.ArduinoCoreService";
readonly methods: {
/** Create a new Arduino Core instance. */
readonly create: {
readonly name: "Create";
readonly requestType: {
encode(_: CreateRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CreateRequest;
fromJSON(_: any): CreateRequest;
toJSON(_: CreateRequest): unknown;
create(base?: DeepPartial<CreateRequest>): CreateRequest;
fromPartial(_: DeepPartial<CreateRequest>): CreateRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: CreateResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CreateResponse;
fromJSON(object: any): CreateResponse;
toJSON(message: CreateResponse): unknown;
create(base?: DeepPartial<CreateResponse>): CreateResponse;
fromPartial(object: DeepPartial<CreateResponse>): CreateResponse;
};
readonly responseStream: false;
readonly options: {};
};
/**
* Initializes an existing Arduino Core instance by loading platforms and
* libraries.
*/
readonly init: {
readonly name: "Init";
readonly requestType: {
encode(message: InitRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): InitRequest;
fromJSON(object: any): InitRequest;
toJSON(message: InitRequest): unknown;
create(base?: DeepPartial<InitRequest>): InitRequest;
fromPartial(object: DeepPartial<InitRequest>): InitRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: InitResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): InitResponse;
fromJSON(object: any): InitResponse;
toJSON(message: InitResponse): unknown;
create(base?: DeepPartial<InitResponse>): InitResponse;
fromPartial(object: DeepPartial<InitResponse>): InitResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Destroy an instance of the Arduino Core Service. */
readonly destroy: {
readonly name: "Destroy";
readonly requestType: {
encode(message: DestroyRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): DestroyRequest;
fromJSON(object: any): DestroyRequest;
toJSON(message: DestroyRequest): unknown;
create(base?: DeepPartial<DestroyRequest>): DestroyRequest;
fromPartial(object: DeepPartial<DestroyRequest>): DestroyRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(_: DestroyResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): DestroyResponse;
fromJSON(_: any): DestroyResponse;
toJSON(_: DestroyResponse): unknown;
create(base?: DeepPartial<DestroyResponse>): DestroyResponse;
fromPartial(_: DeepPartial<DestroyResponse>): DestroyResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Update package index of the Arduino Core Service. */
readonly updateIndex: {
readonly name: "UpdateIndex";
readonly requestType: {
encode(message: UpdateIndexRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UpdateIndexRequest;
fromJSON(object: any): UpdateIndexRequest;
toJSON(message: UpdateIndexRequest): unknown;
create(base?: DeepPartial<UpdateIndexRequest>): UpdateIndexRequest;
fromPartial(object: DeepPartial<UpdateIndexRequest>): UpdateIndexRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: UpdateIndexResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UpdateIndexResponse;
fromJSON(object: any): UpdateIndexResponse;
toJSON(message: UpdateIndexResponse): unknown;
create(base?: DeepPartial<UpdateIndexResponse>): UpdateIndexResponse;
fromPartial(object: DeepPartial<UpdateIndexResponse>): UpdateIndexResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Update libraries index. */
readonly updateLibrariesIndex: {
readonly name: "UpdateLibrariesIndex";
readonly requestType: {
encode(message: UpdateLibrariesIndexRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UpdateLibrariesIndexRequest;
fromJSON(object: any): UpdateLibrariesIndexRequest;
toJSON(message: UpdateLibrariesIndexRequest): unknown;
create(base?: DeepPartial<UpdateLibrariesIndexRequest>): UpdateLibrariesIndexRequest;
fromPartial(object: DeepPartial<UpdateLibrariesIndexRequest>): UpdateLibrariesIndexRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: UpdateLibrariesIndexResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UpdateLibrariesIndexResponse;
fromJSON(object: any): UpdateLibrariesIndexResponse;
toJSON(message: UpdateLibrariesIndexResponse): unknown;
create(base?: DeepPartial<UpdateLibrariesIndexResponse>): UpdateLibrariesIndexResponse;
fromPartial(object: DeepPartial<UpdateLibrariesIndexResponse>): UpdateLibrariesIndexResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Get the version of Arduino CLI in use. */
readonly version: {
readonly name: "Version";
readonly requestType: {
encode(_: VersionRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): VersionRequest;
fromJSON(_: any): VersionRequest;
toJSON(_: VersionRequest): unknown;
create(base?: DeepPartial<VersionRequest>): VersionRequest;
fromPartial(_: DeepPartial<VersionRequest>): VersionRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: VersionResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): VersionResponse;
fromJSON(object: any): VersionResponse;
toJSON(message: VersionResponse): unknown;
create(base?: DeepPartial<VersionResponse>): VersionResponse;
fromPartial(object: DeepPartial<VersionResponse>): VersionResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Create a new Sketch. */
readonly newSketch: {
readonly name: "NewSketch";
readonly requestType: {
encode(message: NewSketchRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): NewSketchRequest;
fromJSON(object: any): NewSketchRequest;
toJSON(message: NewSketchRequest): unknown;
create(base?: DeepPartial<NewSketchRequest>): NewSketchRequest;
fromPartial(object: DeepPartial<NewSketchRequest>): NewSketchRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: NewSketchResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): NewSketchResponse;
fromJSON(object: any): NewSketchResponse;
toJSON(message: NewSketchResponse): unknown;
create(base?: DeepPartial<NewSketchResponse>): NewSketchResponse;
fromPartial(object: DeepPartial<NewSketchResponse>): NewSketchResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Returns all files composing a Sketch. */
readonly loadSketch: {
readonly name: "LoadSketch";
readonly requestType: {
encode(message: LoadSketchRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LoadSketchRequest;
fromJSON(object: any): LoadSketchRequest;
toJSON(message: LoadSketchRequest): unknown;
create(base?: DeepPartial<LoadSketchRequest>): LoadSketchRequest;
fromPartial(object: DeepPartial<LoadSketchRequest>): LoadSketchRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: LoadSketchResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LoadSketchResponse;
fromJSON(object: any): LoadSketchResponse;
toJSON(message: LoadSketchResponse): unknown;
create(base?: DeepPartial<LoadSketchResponse>): LoadSketchResponse;
fromPartial(object: DeepPartial<LoadSketchResponse>): LoadSketchResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Creates a zip file containing all files of specified Sketch. */
readonly archiveSketch: {
readonly name: "ArchiveSketch";
readonly requestType: {
encode(message: ArchiveSketchRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ArchiveSketchRequest;
fromJSON(object: any): ArchiveSketchRequest;
toJSON(message: ArchiveSketchRequest): unknown;
create(base?: DeepPartial<ArchiveSketchRequest>): ArchiveSketchRequest;
fromPartial(object: DeepPartial<ArchiveSketchRequest>): ArchiveSketchRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(_: ArchiveSketchResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ArchiveSketchResponse;
fromJSON(_: any): ArchiveSketchResponse;
toJSON(_: ArchiveSketchResponse): unknown;
create(base?: DeepPartial<ArchiveSketchResponse>): ArchiveSketchResponse;
fromPartial(_: DeepPartial<ArchiveSketchResponse>): ArchiveSketchResponse;
};
readonly responseStream: false;
readonly options: {};
};
/**
* Sets the sketch default FQBN and Port Address/Protocol in the sketch
* project file (sketch.yaml). These metadata can be retrieved using
* LoadSketch.
*/
readonly setSketchDefaults: {
readonly name: "SetSketchDefaults";
readonly requestType: {
encode(message: SetSketchDefaultsRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SetSketchDefaultsRequest;
fromJSON(object: any): SetSketchDefaultsRequest;
toJSON(message: SetSketchDefaultsRequest): unknown;
create(base?: DeepPartial<SetSketchDefaultsRequest>): SetSketchDefaultsRequest;
fromPartial(object: DeepPartial<SetSketchDefaultsRequest>): SetSketchDefaultsRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: SetSketchDefaultsResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SetSketchDefaultsResponse;
fromJSON(object: any): SetSketchDefaultsResponse;
toJSON(message: SetSketchDefaultsResponse): unknown;
create(base?: DeepPartial<SetSketchDefaultsResponse>): SetSketchDefaultsResponse;
fromPartial(object: DeepPartial<SetSketchDefaultsResponse>): SetSketchDefaultsResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Requests details about a board. */
readonly boardDetails: {
readonly name: "BoardDetails";
readonly requestType: {
encode(message: BoardDetailsRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardDetailsRequest;
fromJSON(object: any): BoardDetailsRequest;
toJSON(message: BoardDetailsRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
doNotExpandBuildProperties?: boolean | undefined;
}): BoardDetailsRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
doNotExpandBuildProperties?: boolean | undefined;
}): BoardDetailsRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: BoardDetailsResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardDetailsResponse;
fromJSON(object: any): BoardDetailsResponse;
toJSON(message: BoardDetailsResponse): unknown;
create(base?: {
fqbn?: string | undefined;
name?: string | undefined;
version?: string | undefined;
propertiesId?: string | undefined;
alias?: string | undefined;
official?: boolean | undefined;
pinout?: string | undefined;
package?: {
maintainer?: string | undefined;
url?: string | undefined;
websiteUrl?: string | undefined;
email?: string | undefined;
name?: string | undefined;
help?: {
online?: string | undefined;
} | undefined;
} | undefined;
platform?: {
architecture?: string | undefined;
category?: string | undefined;
url?: string | undefined;
archiveFilename?: string | undefined;
checksum?: string | undefined;
size?: number | undefined;
name?: string | undefined;
} | undefined;
toolsDependencies?: {
packager?: string | undefined;
name?: string | undefined;
version?: string | undefined;
systems?: {
checksum?: string | undefined;
host?: string | undefined;
archiveFilename?: string | undefined;
url?: string | undefined;
size?: number | undefined;
}[] | undefined;
}[] | undefined;
configOptions?: {
option?: string | undefined;
optionLabel?: string | undefined;
values?: {
value?: string | undefined;
valueLabel?: string | undefined;
selected?: boolean | undefined;
}[] | undefined;
}[] | undefined;
programmers?: {
platform?: string | undefined;
id?: string | undefined;
name?: string | undefined;
}[] | undefined;
identificationProperties?: {
properties?: {
[x: string]: string | undefined;
} | undefined;
}[] | undefined;
buildProperties?: string[] | undefined;
defaultProgrammerId?: string | undefined;
}): BoardDetailsResponse;
fromPartial(object: {
fqbn?: string | undefined;
name?: string | undefined;
version?: string | undefined;
propertiesId?: string | undefined;
alias?: string | undefined;
official?: boolean | undefined;
pinout?: string | undefined;
package?: {
maintainer?: string | undefined;
url?: string | undefined;
websiteUrl?: string | undefined;
email?: string | undefined;
name?: string | undefined;
help?: {
online?: string | undefined;
} | undefined;
} | undefined;
platform?: {
architecture?: string | undefined;
category?: string | undefined;
url?: string | undefined;
archiveFilename?: string | undefined;
checksum?: string | undefined;
size?: number | undefined;
name?: string | undefined;
} | undefined;
toolsDependencies?: {
packager?: string | undefined;
name?: string | undefined;
version?: string | undefined;
systems?: {
checksum?: string | undefined;
host?: string | undefined;
archiveFilename?: string | undefined;
url?: string | undefined;
size?: number | undefined;
}[] | undefined;
}[] | undefined;
configOptions?: {
option?: string | undefined;
optionLabel?: string | undefined;
values?: {
value?: string | undefined;
valueLabel?: string | undefined;
selected?: boolean | undefined;
}[] | undefined;
}[] | undefined;
programmers?: {
platform?: string | undefined;
id?: string | undefined;
name?: string | undefined;
}[] | undefined;
identificationProperties?: {
properties?: {
[x: string]: string | undefined;
} | undefined;
}[] | undefined;
buildProperties?: string[] | undefined;
defaultProgrammerId?: string | undefined;
}): BoardDetailsResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** List the boards currently connected to the computer. */
readonly boardList: {
readonly name: "BoardList";
readonly requestType: {
encode(message: BoardListRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardListRequest;
fromJSON(object: any): BoardListRequest;
toJSON(message: BoardListRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
timeout?: number | undefined;
fqbn?: string | undefined;
skipCloudApiForBoardDetection?: boolean | undefined;
}): BoardListRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
timeout?: number | undefined;
fqbn?: string | undefined;
skipCloudApiForBoardDetection?: boolean | undefined;
}): BoardListRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: BoardListResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardListResponse;
fromJSON(object: any): BoardListResponse;
toJSON(message: BoardListResponse): unknown;
create(base?: {
ports?: {
matchingBoards?: {
name?: string | undefined;
fqbn?: string | undefined;
isHidden?: boolean | undefined;
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
}[] | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
}[] | undefined;
warnings?: string[] | undefined;
}): BoardListResponse;
fromPartial(object: {
ports?: {
matchingBoards?: {
name?: string | undefined;
fqbn?: string | undefined;
isHidden?: boolean | undefined;
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
}[] | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
}[] | undefined;
warnings?: string[] | undefined;
}): BoardListResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** List all the boards provided by installed platforms. */
readonly boardListAll: {
readonly name: "BoardListAll";
readonly requestType: {
encode(message: BoardListAllRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardListAllRequest;
fromJSON(object: any): BoardListAllRequest;
toJSON(message: BoardListAllRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
searchArgs?: string[] | undefined;
includeHiddenBoards?: boolean | undefined;
}): BoardListAllRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
searchArgs?: string[] | undefined;
includeHiddenBoards?: boolean | undefined;
}): BoardListAllRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: BoardListAllResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardListAllResponse;
fromJSON(object: any): BoardListAllResponse;
toJSON(message: BoardListAllResponse): unknown;
create(base?: {
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
isHidden?: boolean | undefined;
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
}[] | undefined;
}): BoardListAllResponse;
fromPartial(object: {
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
isHidden?: boolean | undefined;
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
}[] | undefined;
}): BoardListAllResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Search boards in installed and not installed Platforms. */
readonly boardSearch: {
readonly name: "BoardSearch";
readonly requestType: {
encode(message: BoardSearchRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardSearchRequest;
fromJSON(object: any): BoardSearchRequest;
toJSON(message: BoardSearchRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
searchArgs?: string | undefined;
includeHiddenBoards?: boolean | undefined;
}): BoardSearchRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
searchArgs?: string | undefined;
includeHiddenBoards?: boolean | undefined;
}): BoardSearchRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: BoardSearchResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardSearchResponse;
fromJSON(object: any): BoardSearchResponse;
toJSON(message: BoardSearchResponse): unknown;
create(base?: {
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
isHidden?: boolean | undefined;
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
}[] | undefined;
}): BoardSearchResponse;
fromPartial(object: {
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
isHidden?: boolean | undefined;
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
}[] | undefined;
}): BoardSearchResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Identify a board using the given properties. */
readonly boardIdentify: {
readonly name: "BoardIdentify";
readonly requestType: {
encode(message: BoardIdentifyRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardIdentifyRequest;
fromJSON(object: any): BoardIdentifyRequest;
toJSON(message: BoardIdentifyRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
useCloudApiForUnknownBoardDetection?: boolean | undefined;
}): BoardIdentifyRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
useCloudApiForUnknownBoardDetection?: boolean | undefined;
}): BoardIdentifyRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: BoardIdentifyResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardIdentifyResponse;
fromJSON(object: any): BoardIdentifyResponse;
toJSON(message: BoardIdentifyResponse): unknown;
create(base?: {
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
isHidden?: boolean | undefined;
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
}[] | undefined;
}): BoardIdentifyResponse;
fromPartial(object: {
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
isHidden?: boolean | undefined;
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
}[] | undefined;
}): BoardIdentifyResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** List boards connection and disconnected events. */
readonly boardListWatch: {
readonly name: "BoardListWatch";
readonly requestType: {
encode(message: BoardListWatchRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardListWatchRequest;
fromJSON(object: any): BoardListWatchRequest;
toJSON(message: BoardListWatchRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
skipCloudApiForBoardDetection?: boolean | undefined;
}): BoardListWatchRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
skipCloudApiForBoardDetection?: boolean | undefined;
}): BoardListWatchRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: BoardListWatchResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BoardListWatchResponse;
fromJSON(object: any): BoardListWatchResponse;
toJSON(message: BoardListWatchResponse): unknown;
create(base?: {
eventType?: string | undefined;
port?: {
matchingBoards?: {
name?: string | undefined;
fqbn?: string | undefined;
isHidden?: boolean | undefined;
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
}[] | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
} | undefined;
error?: string | undefined;
}): BoardListWatchResponse;
fromPartial(object: {
eventType?: string | undefined;
port?: {
matchingBoards?: {
name?: string | undefined;
fqbn?: string | undefined;
isHidden?: boolean | undefined;
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
}[] | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
} | undefined;
error?: string | undefined;
}): BoardListWatchResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Compile an Arduino sketch. */
readonly compile: {
readonly name: "Compile";
readonly requestType: {
encode(message: CompileRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CompileRequest;
fromJSON(object: any): CompileRequest;
toJSON(message: CompileRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
sketchPath?: string | undefined;
showProperties?: boolean | undefined;
preprocess?: boolean | undefined;
buildCachePath?: string | undefined;
buildPath?: string | undefined;
buildProperties?: string[] | undefined;
warnings?: string | undefined;
verbose?: boolean | undefined;
quiet?: boolean | undefined;
jobs?: number | undefined;
libraries?: string[] | undefined;
optimizeForDebug?: boolean | undefined;
exportDir?: string | undefined;
clean?: boolean | undefined;
createCompilationDatabaseOnly?: boolean | undefined;
sourceOverride?: {
[x: string]: string | undefined;
} | undefined;
exportBinaries?: boolean | undefined | undefined;
library?: string[] | undefined;
keysKeychain?: string | undefined;
signKey?: string | undefined;
encryptKey?: string | undefined;
skipLibrariesDiscovery?: boolean | undefined;
doNotExpandBuildProperties?: boolean | undefined;
buildCacheExtraPaths?: string[] | undefined;
}): CompileRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
sketchPath?: string | undefined;
showProperties?: boolean | undefined;
preprocess?: boolean | undefined;
buildCachePath?: string | undefined;
buildPath?: string | undefined;
buildProperties?: string[] | undefined;
warnings?: string | undefined;
verbose?: boolean | undefined;
quiet?: boolean | undefined;
jobs?: number | undefined;
libraries?: string[] | undefined;
optimizeForDebug?: boolean | undefined;
exportDir?: string | undefined;
clean?: boolean | undefined;
createCompilationDatabaseOnly?: boolean | undefined;
sourceOverride?: {
[x: string]: string | undefined;
} | undefined;
exportBinaries?: boolean | undefined | undefined;
library?: string[] | undefined;
keysKeychain?: string | undefined;
signKey?: string | undefined;
encryptKey?: string | undefined;
skipLibrariesDiscovery?: boolean | undefined;
doNotExpandBuildProperties?: boolean | undefined;
buildCacheExtraPaths?: string[] | undefined;
}): CompileRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: CompileResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CompileResponse;
fromJSON(object: any): CompileResponse;
toJSON(message: CompileResponse): unknown;
create(base?: {
message?: ({
outStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "outStream";
}) | ({
errStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "errStream";
}) | ({
progress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
result?: {
buildPath?: string | undefined;
usedLibraries?: {
name?: string | undefined;
author?: string | undefined;
maintainer?: string | undefined;
sentence?: string | undefined;
paragraph?: string | undefined;
website?: string | undefined;
category?: string | undefined;
architectures?: string[] | undefined;
types?: string[] | undefined;
installDir?: string | undefined;
sourceDir?: string | undefined;
utilityDir?: string | undefined;
containerPlatform?: string | undefined;
dotALinkage?: boolean | undefined;
precompiled?: boolean | undefined;
ldFlags?: string | undefined;
isLegacy?: boolean | undefined;
version?: string | undefined;
license?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
location?: import("./lib").LibraryLocation | undefined;
layout?: import("./lib").LibraryLayout | undefined;
examples?: string[] | undefined;
providesIncludes?: string[] | undefined;
compatibleWith?: {
[x: string]: boolean | undefined;
} | undefined;
inDevelopment?: boolean | undefined;
}[] | undefined;
executableSectionsSize?: {
name?: string | undefined;
size?: number | undefined;
maxSize?: number | undefined;
}[] | undefined;
boardPlatform?: {
id?: string | undefined;
version?: string | undefined;
installDir?: string | undefined;
packageUrl?: string | undefined;
} | undefined;
buildPlatform?: {
id?: string | undefined;
version?: string | undefined;
installDir?: string | undefined;
packageUrl?: string | undefined;
} | undefined;
buildProperties?: string[] | undefined;
diagnostics?: {
severity?: string | undefined;
message?: string | undefined;
file?: string | undefined;
line?: number | undefined;
column?: number | undefined;
context?: {
message?: string | undefined;
file?: string | undefined;
line?: number | undefined;
column?: number | undefined;
}[] | undefined;
notes?: {
message?: string | undefined;
file?: string | undefined;
line?: number | undefined;
column?: number | undefined;
}[] | undefined;
}[] | undefined;
} | undefined;
} & {
$case: "result";
}) | undefined;
}): CompileResponse;
fromPartial(object: {
message?: ({
outStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "outStream";
}) | ({
errStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "errStream";
}) | ({
progress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
result?: {
buildPath?: string | undefined;
usedLibraries?: {
name?: string | undefined;
author?: string | undefined;
maintainer?: string | undefined;
sentence?: string | undefined;
paragraph?: string | undefined;
website?: string | undefined;
category?: string | undefined;
architectures?: string[] | undefined;
types?: string[] | undefined;
installDir?: string | undefined;
sourceDir?: string | undefined;
utilityDir?: string | undefined;
containerPlatform?: string | undefined;
dotALinkage?: boolean | undefined;
precompiled?: boolean | undefined;
ldFlags?: string | undefined;
isLegacy?: boolean | undefined;
version?: string | undefined;
license?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
location?: import("./lib").LibraryLocation | undefined;
layout?: import("./lib").LibraryLayout | undefined;
examples?: string[] | undefined;
providesIncludes?: string[] | undefined;
compatibleWith?: {
[x: string]: boolean | undefined;
} | undefined;
inDevelopment?: boolean | undefined;
}[] | undefined;
executableSectionsSize?: {
name?: string | undefined;
size?: number | undefined;
maxSize?: number | undefined;
}[] | undefined;
boardPlatform?: {
id?: string | undefined;
version?: string | undefined;
installDir?: string | undefined;
packageUrl?: string | undefined;
} | undefined;
buildPlatform?: {
id?: string | undefined;
version?: string | undefined;
installDir?: string | undefined;
packageUrl?: string | undefined;
} | undefined;
buildProperties?: string[] | undefined;
diagnostics?: {
severity?: string | undefined;
message?: string | undefined;
file?: string | undefined;
line?: number | undefined;
column?: number | undefined;
context?: {
message?: string | undefined;
file?: string | undefined;
line?: number | undefined;
column?: number | undefined;
}[] | undefined;
notes?: {
message?: string | undefined;
file?: string | undefined;
line?: number | undefined;
column?: number | undefined;
}[] | undefined;
}[] | undefined;
} | undefined;
} & {
$case: "result";
}) | undefined;
}): CompileResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Download and install a platform and its tool dependencies. */
readonly platformInstall: {
readonly name: "PlatformInstall";
readonly requestType: {
encode(message: PlatformInstallRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): PlatformInstallRequest;
fromJSON(object: any): PlatformInstallRequest;
toJSON(message: PlatformInstallRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
platformPackage?: string | undefined;
architecture?: string | undefined;
version?: string | undefined;
skipPostInstall?: boolean | undefined;
noOverwrite?: boolean | undefined;
skipPreUninstall?: boolean | undefined;
}): PlatformInstallRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
platformPackage?: string | undefined;
architecture?: string | undefined;
version?: string | undefined;
skipPostInstall?: boolean | undefined;
noOverwrite?: boolean | undefined;
skipPreUninstall?: boolean | undefined;
}): PlatformInstallRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: PlatformInstallResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): PlatformInstallResponse;
fromJSON(object: any): PlatformInstallResponse;
toJSON(message: PlatformInstallResponse): unknown;
create(base?: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): PlatformInstallResponse;
fromPartial(object: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): PlatformInstallResponse;
};
readonly responseStream: true;
readonly options: {};
};
/**
* Download a platform and its tool dependencies to the `staging/packages`
* subdirectory of the data directory.
*/
readonly platformDownload: {
readonly name: "PlatformDownload";
readonly requestType: {
encode(message: PlatformDownloadRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): PlatformDownloadRequest;
fromJSON(object: any): PlatformDownloadRequest;
toJSON(message: PlatformDownloadRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
platformPackage?: string | undefined;
architecture?: string | undefined;
version?: string | undefined;
}): PlatformDownloadRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
platformPackage?: string | undefined;
architecture?: string | undefined;
version?: string | undefined;
}): PlatformDownloadRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: PlatformDownloadResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): PlatformDownloadResponse;
fromJSON(object: any): PlatformDownloadResponse;
toJSON(message: PlatformDownloadResponse): unknown;
create(base?: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): PlatformDownloadResponse;
fromPartial(object: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): PlatformDownloadResponse;
};
readonly responseStream: true;
readonly options: {};
};
/**
* Uninstall a platform as well as its tool dependencies that are not used
* by other installed platforms.
*/
readonly platformUninstall: {
readonly name: "PlatformUninstall";
readonly requestType: {
encode(message: PlatformUninstallRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): PlatformUninstallRequest;
fromJSON(object: any): PlatformUninstallRequest;
toJSON(message: PlatformUninstallRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
platformPackage?: string | undefined;
architecture?: string | undefined;
skipPreUninstall?: boolean | undefined;
}): PlatformUninstallRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
platformPackage?: string | undefined;
architecture?: string | undefined;
skipPreUninstall?: boolean | undefined;
}): PlatformUninstallRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: PlatformUninstallResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): PlatformUninstallResponse;
fromJSON(object: any): PlatformUninstallResponse;
toJSON(message: PlatformUninstallResponse): unknown;
create(base?: {
message?: ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): PlatformUninstallResponse;
fromPartial(object: {
message?: ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): PlatformUninstallResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Upgrade an installed platform to the latest version. */
readonly platformUpgrade: {
readonly name: "PlatformUpgrade";
readonly requestType: {
encode(message: PlatformUpgradeRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): PlatformUpgradeRequest;
fromJSON(object: any): PlatformUpgradeRequest;
toJSON(message: PlatformUpgradeRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
platformPackage?: string | undefined;
architecture?: string | undefined;
skipPostInstall?: boolean | undefined;
skipPreUninstall?: boolean | undefined;
}): PlatformUpgradeRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
platformPackage?: string | undefined;
architecture?: string | undefined;
skipPostInstall?: boolean | undefined;
skipPreUninstall?: boolean | undefined;
}): PlatformUpgradeRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: PlatformUpgradeResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): PlatformUpgradeResponse;
fromJSON(object: any): PlatformUpgradeResponse;
toJSON(message: PlatformUpgradeResponse): unknown;
create(base?: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
} | undefined;
} & {
$case: "result";
}) | undefined;
}): PlatformUpgradeResponse;
fromPartial(object: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {
platform?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
release?: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
} | undefined;
} & {
$case: "result";
}) | undefined;
}): PlatformUpgradeResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Upload a compiled sketch to a board. */
readonly upload: {
readonly name: "Upload";
readonly requestType: {
encode(message: UploadRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UploadRequest;
fromJSON(object: any): UploadRequest;
toJSON(message: UploadRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
sketchPath?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
verbose?: boolean | undefined;
verify?: boolean | undefined;
importFile?: string | undefined;
importDir?: string | undefined;
programmer?: string | undefined;
dryRun?: boolean | undefined;
userFields?: {
[x: string]: string | undefined;
} | undefined;
uploadProperties?: string[] | undefined;
}): UploadRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
sketchPath?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
verbose?: boolean | undefined;
verify?: boolean | undefined;
importFile?: string | undefined;
importDir?: string | undefined;
programmer?: string | undefined;
dryRun?: boolean | undefined;
userFields?: {
[x: string]: string | undefined;
} | undefined;
uploadProperties?: string[] | undefined;
}): UploadRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: UploadResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UploadResponse;
fromJSON(object: any): UploadResponse;
toJSON(message: UploadResponse): unknown;
create(base?: {
message?: ({
outStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "outStream";
}) | ({
errStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "errStream";
}) | ({
result?: {
updatedUploadPort?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
} | undefined;
} & {
$case: "result";
}) | undefined;
}): UploadResponse;
fromPartial(object: {
message?: ({
outStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "outStream";
}) | ({
errStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "errStream";
}) | ({
result?: {
updatedUploadPort?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
} | undefined;
} & {
$case: "result";
}) | undefined;
}): UploadResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Upload a compiled sketch to a board using a programmer. */
readonly uploadUsingProgrammer: {
readonly name: "UploadUsingProgrammer";
readonly requestType: {
encode(message: UploadUsingProgrammerRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UploadUsingProgrammerRequest;
fromJSON(object: any): UploadUsingProgrammerRequest;
toJSON(message: UploadUsingProgrammerRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
sketchPath?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
verbose?: boolean | undefined;
verify?: boolean | undefined;
importFile?: string | undefined;
importDir?: string | undefined;
programmer?: string | undefined;
dryRun?: boolean | undefined;
userFields?: {
[x: string]: string | undefined;
} | undefined;
uploadProperties?: string[] | undefined;
}): UploadUsingProgrammerRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
sketchPath?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
verbose?: boolean | undefined;
verify?: boolean | undefined;
importFile?: string | undefined;
importDir?: string | undefined;
programmer?: string | undefined;
dryRun?: boolean | undefined;
userFields?: {
[x: string]: string | undefined;
} | undefined;
uploadProperties?: string[] | undefined;
}): UploadUsingProgrammerRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: UploadUsingProgrammerResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): UploadUsingProgrammerResponse;
fromJSON(object: any): UploadUsingProgrammerResponse;
toJSON(message: UploadUsingProgrammerResponse): unknown;
create(base?: {
message?: ({
outStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "outStream";
}) | ({
errStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "errStream";
}) | undefined;
}): UploadUsingProgrammerResponse;
fromPartial(object: {
message?: ({
outStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "outStream";
}) | ({
errStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "errStream";
}) | undefined;
}): UploadUsingProgrammerResponse;
};
readonly responseStream: true;
readonly options: {};
};
/**
* Returns the list of users fields necessary to upload to that board using
* the specified protocol.
*/
readonly supportedUserFields: {
readonly name: "SupportedUserFields";
readonly requestType: {
encode(message: SupportedUserFieldsRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SupportedUserFieldsRequest;
fromJSON(object: any): SupportedUserFieldsRequest;
toJSON(message: SupportedUserFieldsRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
protocol?: string | undefined;
}): SupportedUserFieldsRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
protocol?: string | undefined;
}): SupportedUserFieldsRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: SupportedUserFieldsResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SupportedUserFieldsResponse;
fromJSON(object: any): SupportedUserFieldsResponse;
toJSON(message: SupportedUserFieldsResponse): unknown;
create(base?: {
userFields?: {
toolId?: string | undefined;
name?: string | undefined;
label?: string | undefined;
secret?: boolean | undefined;
}[] | undefined;
}): SupportedUserFieldsResponse;
fromPartial(object: {
userFields?: {
toolId?: string | undefined;
name?: string | undefined;
label?: string | undefined;
secret?: boolean | undefined;
}[] | undefined;
}): SupportedUserFieldsResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** List programmers available for a board. */
readonly listProgrammersAvailableForUpload: {
readonly name: "ListProgrammersAvailableForUpload";
readonly requestType: {
encode(message: ListProgrammersAvailableForUploadRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ListProgrammersAvailableForUploadRequest;
fromJSON(object: any): ListProgrammersAvailableForUploadRequest;
toJSON(message: ListProgrammersAvailableForUploadRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
}): ListProgrammersAvailableForUploadRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
}): ListProgrammersAvailableForUploadRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: ListProgrammersAvailableForUploadResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ListProgrammersAvailableForUploadResponse;
fromJSON(object: any): ListProgrammersAvailableForUploadResponse;
toJSON(message: ListProgrammersAvailableForUploadResponse): unknown;
create(base?: {
programmers?: {
platform?: string | undefined;
id?: string | undefined;
name?: string | undefined;
}[] | undefined;
}): ListProgrammersAvailableForUploadResponse;
fromPartial(object: {
programmers?: {
platform?: string | undefined;
id?: string | undefined;
name?: string | undefined;
}[] | undefined;
}): ListProgrammersAvailableForUploadResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Burn bootloader to a board. */
readonly burnBootloader: {
readonly name: "BurnBootloader";
readonly requestType: {
encode(message: BurnBootloaderRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BurnBootloaderRequest;
fromJSON(object: any): BurnBootloaderRequest;
toJSON(message: BurnBootloaderRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
verbose?: boolean | undefined;
verify?: boolean | undefined;
programmer?: string | undefined;
dryRun?: boolean | undefined;
userFields?: {
[x: string]: string | undefined;
} | undefined;
uploadProperties?: string[] | undefined;
}): BurnBootloaderRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
verbose?: boolean | undefined;
verify?: boolean | undefined;
programmer?: string | undefined;
dryRun?: boolean | undefined;
userFields?: {
[x: string]: string | undefined;
} | undefined;
uploadProperties?: string[] | undefined;
}): BurnBootloaderRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: BurnBootloaderResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): BurnBootloaderResponse;
fromJSON(object: any): BurnBootloaderResponse;
toJSON(message: BurnBootloaderResponse): unknown;
create(base?: {
message?: ({
outStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "outStream";
}) | ({
errStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "errStream";
}) | undefined;
}): BurnBootloaderResponse;
fromPartial(object: {
message?: ({
outStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "outStream";
}) | ({
errStream?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "errStream";
}) | undefined;
}): BurnBootloaderResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Search for a platform in the platforms indexes. */
readonly platformSearch: {
readonly name: "PlatformSearch";
readonly requestType: {
encode(message: PlatformSearchRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): PlatformSearchRequest;
fromJSON(object: any): PlatformSearchRequest;
toJSON(message: PlatformSearchRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
searchArgs?: string | undefined;
manuallyInstalled?: boolean | undefined;
}): PlatformSearchRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
searchArgs?: string | undefined;
manuallyInstalled?: boolean | undefined;
}): PlatformSearchRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: PlatformSearchResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): PlatformSearchResponse;
fromJSON(object: any): PlatformSearchResponse;
toJSON(message: PlatformSearchResponse): unknown;
create(base?: {
searchOutput?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
releases?: {
[x: string]: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
installedVersion?: string | undefined;
latestVersion?: string | undefined;
}[] | undefined;
}): PlatformSearchResponse;
fromPartial(object: {
searchOutput?: {
metadata?: {
id?: string | undefined;
maintainer?: string | undefined;
website?: string | undefined;
email?: string | undefined;
manuallyInstalled?: boolean | undefined;
deprecated?: boolean | undefined;
indexed?: boolean | undefined;
} | undefined;
releases?: {
[x: string]: {
name?: string | undefined;
version?: string | undefined;
types?: string[] | undefined;
installed?: boolean | undefined;
boards?: {
name?: string | undefined;
fqbn?: string | undefined;
}[] | undefined;
help?: {
online?: string | undefined;
} | undefined;
missingMetadata?: boolean | undefined;
deprecated?: boolean | undefined;
compatible?: boolean | undefined;
} | undefined;
} | undefined;
installedVersion?: string | undefined;
latestVersion?: string | undefined;
}[] | undefined;
}): PlatformSearchResponse;
};
readonly responseStream: false;
readonly options: {};
};
/**
* Download the archive file of an Arduino library in the libraries index to
* the staging directory.
*/
readonly libraryDownload: {
readonly name: "LibraryDownload";
readonly requestType: {
encode(message: LibraryDownloadRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryDownloadRequest;
fromJSON(object: any): LibraryDownloadRequest;
toJSON(message: LibraryDownloadRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
name?: string | undefined;
version?: string | undefined;
}): LibraryDownloadRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
name?: string | undefined;
version?: string | undefined;
}): LibraryDownloadRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: LibraryDownloadResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryDownloadResponse;
fromJSON(object: any): LibraryDownloadResponse;
toJSON(message: LibraryDownloadResponse): unknown;
create(base?: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): LibraryDownloadResponse;
fromPartial(object: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): LibraryDownloadResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Download and install an Arduino library from the libraries index. */
readonly libraryInstall: {
readonly name: "LibraryInstall";
readonly requestType: {
encode(message: LibraryInstallRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryInstallRequest;
fromJSON(object: any): LibraryInstallRequest;
toJSON(message: LibraryInstallRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
name?: string | undefined;
version?: string | undefined;
noDeps?: boolean | undefined;
noOverwrite?: boolean | undefined;
installLocation?: import("./lib").LibraryInstallLocation | undefined;
}): LibraryInstallRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
name?: string | undefined;
version?: string | undefined;
noDeps?: boolean | undefined;
noOverwrite?: boolean | undefined;
installLocation?: import("./lib").LibraryInstallLocation | undefined;
}): LibraryInstallRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: LibraryInstallResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryInstallResponse;
fromJSON(object: any): LibraryInstallResponse;
toJSON(message: LibraryInstallResponse): unknown;
create(base?: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): LibraryInstallResponse;
fromPartial(object: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): LibraryInstallResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Upgrade a library to the newest version available. */
readonly libraryUpgrade: {
readonly name: "LibraryUpgrade";
readonly requestType: {
encode(message: LibraryUpgradeRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryUpgradeRequest;
fromJSON(object: any): LibraryUpgradeRequest;
toJSON(message: LibraryUpgradeRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
name?: string | undefined;
noDeps?: boolean | undefined;
}): LibraryUpgradeRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
name?: string | undefined;
noDeps?: boolean | undefined;
}): LibraryUpgradeRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: LibraryUpgradeResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryUpgradeResponse;
fromJSON(object: any): LibraryUpgradeResponse;
toJSON(message: LibraryUpgradeResponse): unknown;
create(base?: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): LibraryUpgradeResponse;
fromPartial(object: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): LibraryUpgradeResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Install a library from a Zip File. */
readonly zipLibraryInstall: {
readonly name: "ZipLibraryInstall";
readonly requestType: {
encode(message: ZipLibraryInstallRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ZipLibraryInstallRequest;
fromJSON(object: any): ZipLibraryInstallRequest;
toJSON(message: ZipLibraryInstallRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
path?: string | undefined;
overwrite?: boolean | undefined;
}): ZipLibraryInstallRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
path?: string | undefined;
overwrite?: boolean | undefined;
}): ZipLibraryInstallRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: ZipLibraryInstallResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ZipLibraryInstallResponse;
fromJSON(object: any): ZipLibraryInstallResponse;
toJSON(message: ZipLibraryInstallResponse): unknown;
create(base?: {
message?: ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): ZipLibraryInstallResponse;
fromPartial(object: {
message?: ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): ZipLibraryInstallResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Download and install a library from a git url. */
readonly gitLibraryInstall: {
readonly name: "GitLibraryInstall";
readonly requestType: {
encode(message: GitLibraryInstallRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GitLibraryInstallRequest;
fromJSON(object: any): GitLibraryInstallRequest;
toJSON(message: GitLibraryInstallRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
url?: string | undefined;
overwrite?: boolean | undefined;
}): GitLibraryInstallRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
url?: string | undefined;
overwrite?: boolean | undefined;
}): GitLibraryInstallRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: GitLibraryInstallResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GitLibraryInstallResponse;
fromJSON(object: any): GitLibraryInstallResponse;
toJSON(message: GitLibraryInstallResponse): unknown;
create(base?: {
message?: ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): GitLibraryInstallResponse;
fromPartial(object: {
message?: ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): GitLibraryInstallResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Uninstall an Arduino library. */
readonly libraryUninstall: {
readonly name: "LibraryUninstall";
readonly requestType: {
encode(message: LibraryUninstallRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryUninstallRequest;
fromJSON(object: any): LibraryUninstallRequest;
toJSON(message: LibraryUninstallRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
name?: string | undefined;
version?: string | undefined;
}): LibraryUninstallRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
name?: string | undefined;
version?: string | undefined;
}): LibraryUninstallRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: LibraryUninstallResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryUninstallResponse;
fromJSON(object: any): LibraryUninstallResponse;
toJSON(message: LibraryUninstallResponse): unknown;
create(base?: {
message?: ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): LibraryUninstallResponse;
fromPartial(object: {
message?: ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): LibraryUninstallResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Upgrade all installed Arduino libraries to the newest version available. */
readonly libraryUpgradeAll: {
readonly name: "LibraryUpgradeAll";
readonly requestType: {
encode(message: LibraryUpgradeAllRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryUpgradeAllRequest;
fromJSON(object: any): LibraryUpgradeAllRequest;
toJSON(message: LibraryUpgradeAllRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
}): LibraryUpgradeAllRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
}): LibraryUpgradeAllRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: LibraryUpgradeAllResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryUpgradeAllResponse;
fromJSON(object: any): LibraryUpgradeAllResponse;
toJSON(message: LibraryUpgradeAllResponse): unknown;
create(base?: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): LibraryUpgradeAllResponse;
fromPartial(object: {
message?: ({
progress?: {
message?: ({
start?: {
url?: string | undefined;
label?: string | undefined;
} | undefined;
} & {
$case: "start";
}) | ({
update?: {
downloaded?: number | undefined;
totalSize?: number | undefined;
} | undefined;
} & {
$case: "update";
}) | ({
end?: {
success?: boolean | undefined;
message?: string | undefined;
} | undefined;
} & {
$case: "end";
}) | undefined;
} | undefined;
} & {
$case: "progress";
}) | ({
taskProgress?: {
name?: string | undefined;
message?: string | undefined;
completed?: boolean | undefined;
percent?: number | undefined;
} | undefined;
} & {
$case: "taskProgress";
}) | ({
result?: {} | undefined;
} & {
$case: "result";
}) | undefined;
}): LibraryUpgradeAllResponse;
};
readonly responseStream: true;
readonly options: {};
};
/**
* List the recursive dependencies of a library, as defined by the `depends`
* field of the library.properties files.
*/
readonly libraryResolveDependencies: {
readonly name: "LibraryResolveDependencies";
readonly requestType: {
encode(message: LibraryResolveDependenciesRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryResolveDependenciesRequest;
fromJSON(object: any): LibraryResolveDependenciesRequest;
toJSON(message: LibraryResolveDependenciesRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
name?: string | undefined;
version?: string | undefined;
doNotUpdateInstalledLibraries?: boolean | undefined;
}): LibraryResolveDependenciesRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
name?: string | undefined;
version?: string | undefined;
doNotUpdateInstalledLibraries?: boolean | undefined;
}): LibraryResolveDependenciesRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: LibraryResolveDependenciesResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryResolveDependenciesResponse;
fromJSON(object: any): LibraryResolveDependenciesResponse;
toJSON(message: LibraryResolveDependenciesResponse): unknown;
create(base?: {
dependencies?: {
name?: string | undefined;
versionRequired?: string | undefined;
versionInstalled?: string | undefined;
}[] | undefined;
}): LibraryResolveDependenciesResponse;
fromPartial(object: {
dependencies?: {
name?: string | undefined;
versionRequired?: string | undefined;
versionInstalled?: string | undefined;
}[] | undefined;
}): LibraryResolveDependenciesResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Search the Arduino libraries index for libraries. */
readonly librarySearch: {
readonly name: "LibrarySearch";
readonly requestType: {
encode(message: LibrarySearchRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibrarySearchRequest;
fromJSON(object: any): LibrarySearchRequest;
toJSON(message: LibrarySearchRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
omitReleasesDetails?: boolean | undefined;
searchArgs?: string | undefined;
}): LibrarySearchRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
omitReleasesDetails?: boolean | undefined;
searchArgs?: string | undefined;
}): LibrarySearchRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: LibrarySearchResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibrarySearchResponse;
fromJSON(object: any): LibrarySearchResponse;
toJSON(message: LibrarySearchResponse): unknown;
create(base?: {
libraries?: {
name?: string | undefined;
releases?: {
[x: string]: {
author?: string | undefined;
version?: string | undefined;
maintainer?: string | undefined;
sentence?: string | undefined;
paragraph?: string | undefined;
website?: string | undefined;
category?: string | undefined;
architectures?: string[] | undefined;
types?: string[] | undefined;
resources?: {
url?: string | undefined;
archiveFilename?: string | undefined;
checksum?: string | undefined;
size?: number | undefined;
cachePath?: string | undefined;
} | undefined;
license?: string | undefined;
providesIncludes?: string[] | undefined;
dependencies?: {
name?: string | undefined;
versionConstraint?: string | undefined;
}[] | undefined;
} | undefined;
} | undefined;
latest?: {
author?: string | undefined;
version?: string | undefined;
maintainer?: string | undefined;
sentence?: string | undefined;
paragraph?: string | undefined;
website?: string | undefined;
category?: string | undefined;
architectures?: string[] | undefined;
types?: string[] | undefined;
resources?: {
url?: string | undefined;
archiveFilename?: string | undefined;
checksum?: string | undefined;
size?: number | undefined;
cachePath?: string | undefined;
} | undefined;
license?: string | undefined;
providesIncludes?: string[] | undefined;
dependencies?: {
name?: string | undefined;
versionConstraint?: string | undefined;
}[] | undefined;
} | undefined;
availableVersions?: string[] | undefined;
}[] | undefined;
status?: import("./lib").LibrarySearchStatus | undefined;
}): LibrarySearchResponse;
fromPartial(object: {
libraries?: {
name?: string | undefined;
releases?: {
[x: string]: {
author?: string | undefined;
version?: string | undefined;
maintainer?: string | undefined;
sentence?: string | undefined;
paragraph?: string | undefined;
website?: string | undefined;
category?: string | undefined;
architectures?: string[] | undefined;
types?: string[] | undefined;
resources?: {
url?: string | undefined;
archiveFilename?: string | undefined;
checksum?: string | undefined;
size?: number | undefined;
cachePath?: string | undefined;
} | undefined;
license?: string | undefined;
providesIncludes?: string[] | undefined;
dependencies?: {
name?: string | undefined;
versionConstraint?: string | undefined;
}[] | undefined;
} | undefined;
} | undefined;
latest?: {
author?: string | undefined;
version?: string | undefined;
maintainer?: string | undefined;
sentence?: string | undefined;
paragraph?: string | undefined;
website?: string | undefined;
category?: string | undefined;
architectures?: string[] | undefined;
types?: string[] | undefined;
resources?: {
url?: string | undefined;
archiveFilename?: string | undefined;
checksum?: string | undefined;
size?: number | undefined;
cachePath?: string | undefined;
} | undefined;
license?: string | undefined;
providesIncludes?: string[] | undefined;
dependencies?: {
name?: string | undefined;
versionConstraint?: string | undefined;
}[] | undefined;
} | undefined;
availableVersions?: string[] | undefined;
}[] | undefined;
status?: import("./lib").LibrarySearchStatus | undefined;
}): LibrarySearchResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** List the installed libraries. */
readonly libraryList: {
readonly name: "LibraryList";
readonly requestType: {
encode(message: LibraryListRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryListRequest;
fromJSON(object: any): LibraryListRequest;
toJSON(message: LibraryListRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
all?: boolean | undefined;
updatable?: boolean | undefined;
name?: string | undefined;
fqbn?: string | undefined;
}): LibraryListRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
all?: boolean | undefined;
updatable?: boolean | undefined;
name?: string | undefined;
fqbn?: string | undefined;
}): LibraryListRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: LibraryListResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): LibraryListResponse;
fromJSON(object: any): LibraryListResponse;
toJSON(message: LibraryListResponse): unknown;
create(base?: {
installedLibraries?: {
library?: {
name?: string | undefined;
author?: string | undefined;
maintainer?: string | undefined;
sentence?: string | undefined;
paragraph?: string | undefined;
website?: string | undefined;
category?: string | undefined;
architectures?: string[] | undefined;
types?: string[] | undefined;
installDir?: string | undefined;
sourceDir?: string | undefined;
utilityDir?: string | undefined;
containerPlatform?: string | undefined;
dotALinkage?: boolean | undefined;
precompiled?: boolean | undefined;
ldFlags?: string | undefined;
isLegacy?: boolean | undefined;
version?: string | undefined;
license?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
location?: import("./lib").LibraryLocation | undefined;
layout?: import("./lib").LibraryLayout | undefined;
examples?: string[] | undefined;
providesIncludes?: string[] | undefined;
compatibleWith?: {
[x: string]: boolean | undefined;
} | undefined;
inDevelopment?: boolean | undefined;
} | undefined;
release?: {
author?: string | undefined;
version?: string | undefined;
maintainer?: string | undefined;
sentence?: string | undefined;
paragraph?: string | undefined;
website?: string | undefined;
category?: string | undefined;
architectures?: string[] | undefined;
types?: string[] | undefined;
resources?: {
url?: string | undefined;
archiveFilename?: string | undefined;
checksum?: string | undefined;
size?: number | undefined;
cachePath?: string | undefined;
} | undefined;
license?: string | undefined;
providesIncludes?: string[] | undefined;
dependencies?: {
name?: string | undefined;
versionConstraint?: string | undefined;
}[] | undefined;
} | undefined;
}[] | undefined;
}): LibraryListResponse;
fromPartial(object: {
installedLibraries?: {
library?: {
name?: string | undefined;
author?: string | undefined;
maintainer?: string | undefined;
sentence?: string | undefined;
paragraph?: string | undefined;
website?: string | undefined;
category?: string | undefined;
architectures?: string[] | undefined;
types?: string[] | undefined;
installDir?: string | undefined;
sourceDir?: string | undefined;
utilityDir?: string | undefined;
containerPlatform?: string | undefined;
dotALinkage?: boolean | undefined;
precompiled?: boolean | undefined;
ldFlags?: string | undefined;
isLegacy?: boolean | undefined;
version?: string | undefined;
license?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
location?: import("./lib").LibraryLocation | undefined;
layout?: import("./lib").LibraryLayout | undefined;
examples?: string[] | undefined;
providesIncludes?: string[] | undefined;
compatibleWith?: {
[x: string]: boolean | undefined;
} | undefined;
inDevelopment?: boolean | undefined;
} | undefined;
release?: {
author?: string | undefined;
version?: string | undefined;
maintainer?: string | undefined;
sentence?: string | undefined;
paragraph?: string | undefined;
website?: string | undefined;
category?: string | undefined;
architectures?: string[] | undefined;
types?: string[] | undefined;
resources?: {
url?: string | undefined;
archiveFilename?: string | undefined;
checksum?: string | undefined;
size?: number | undefined;
cachePath?: string | undefined;
} | undefined;
license?: string | undefined;
providesIncludes?: string[] | undefined;
dependencies?: {
name?: string | undefined;
versionConstraint?: string | undefined;
}[] | undefined;
} | undefined;
}[] | undefined;
}): LibraryListResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Open a monitor connection to a board port. */
readonly monitor: {
readonly name: "Monitor";
readonly requestType: {
encode(message: MonitorRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): MonitorRequest;
fromJSON(object: any): MonitorRequest;
toJSON(message: MonitorRequest): unknown;
create(base?: {
message?: ({
openRequest?: {
instance?: {
id?: number | undefined;
} | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
fqbn?: string | undefined;
portConfiguration?: {
settings?: {
settingId?: string | undefined;
value?: string | undefined;
}[] | undefined;
} | undefined;
} | undefined;
} & {
$case: "openRequest";
}) | ({
txData?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "txData";
}) | ({
updatedConfiguration?: {
settings?: {
settingId?: string | undefined;
value?: string | undefined;
}[] | undefined;
} | undefined;
} & {
$case: "updatedConfiguration";
}) | ({
close?: boolean | undefined;
} & {
$case: "close";
}) | undefined;
}): MonitorRequest;
fromPartial(object: {
message?: ({
openRequest?: {
instance?: {
id?: number | undefined;
} | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
fqbn?: string | undefined;
portConfiguration?: {
settings?: {
settingId?: string | undefined;
value?: string | undefined;
}[] | undefined;
} | undefined;
} | undefined;
} & {
$case: "openRequest";
}) | ({
txData?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "txData";
}) | ({
updatedConfiguration?: {
settings?: {
settingId?: string | undefined;
value?: string | undefined;
}[] | undefined;
} | undefined;
} & {
$case: "updatedConfiguration";
}) | ({
close?: boolean | undefined;
} & {
$case: "close";
}) | undefined;
}): MonitorRequest;
};
readonly requestStream: true;
readonly responseType: {
encode(message: MonitorResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): MonitorResponse;
fromJSON(object: any): MonitorResponse;
toJSON(message: MonitorResponse): unknown;
create(base?: {
message?: ({
error?: string | undefined;
} & {
$case: "error";
}) | ({
rxData?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "rxData";
}) | ({
appliedSettings?: {
settings?: {
settingId?: string | undefined;
value?: string | undefined;
}[] | undefined;
} | undefined;
} & {
$case: "appliedSettings";
}) | ({
success?: boolean | undefined;
} & {
$case: "success";
}) | undefined;
}): MonitorResponse;
fromPartial(object: {
message?: ({
error?: string | undefined;
} & {
$case: "error";
}) | ({
rxData?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "rxData";
}) | ({
appliedSettings?: {
settings?: {
settingId?: string | undefined;
value?: string | undefined;
}[] | undefined;
} | undefined;
} & {
$case: "appliedSettings";
}) | ({
success?: boolean | undefined;
} & {
$case: "success";
}) | undefined;
}): MonitorResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Returns the parameters that can be set in the MonitorRequest calls. */
readonly enumerateMonitorPortSettings: {
readonly name: "EnumerateMonitorPortSettings";
readonly requestType: {
encode(message: EnumerateMonitorPortSettingsRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): EnumerateMonitorPortSettingsRequest;
fromJSON(object: any): EnumerateMonitorPortSettingsRequest;
toJSON(message: EnumerateMonitorPortSettingsRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
portProtocol?: string | undefined;
fqbn?: string | undefined;
}): EnumerateMonitorPortSettingsRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
portProtocol?: string | undefined;
fqbn?: string | undefined;
}): EnumerateMonitorPortSettingsRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: EnumerateMonitorPortSettingsResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): EnumerateMonitorPortSettingsResponse;
fromJSON(object: any): EnumerateMonitorPortSettingsResponse;
toJSON(message: EnumerateMonitorPortSettingsResponse): unknown;
create(base?: {
settings?: {
settingId?: string | undefined;
label?: string | undefined;
type?: string | undefined;
enumValues?: string[] | undefined;
value?: string | undefined;
}[] | undefined;
}): EnumerateMonitorPortSettingsResponse;
fromPartial(object: {
settings?: {
settingId?: string | undefined;
label?: string | undefined;
type?: string | undefined;
enumValues?: string[] | undefined;
value?: string | undefined;
}[] | undefined;
}): EnumerateMonitorPortSettingsResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Start a debug session and communicate with the debugger tool. */
readonly debug: {
readonly name: "Debug";
readonly requestType: {
encode(message: DebugRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): DebugRequest;
fromJSON(object: any): DebugRequest;
toJSON(message: DebugRequest): unknown;
create(base?: {
debugRequest?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
sketchPath?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
interpreter?: string | undefined;
importDir?: string | undefined;
programmer?: string | undefined;
debugProperties?: string[] | undefined;
} | undefined;
data?: Uint8Array<ArrayBufferLike> | undefined;
sendInterrupt?: boolean | undefined;
}): DebugRequest;
fromPartial(object: {
debugRequest?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
sketchPath?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
interpreter?: string | undefined;
importDir?: string | undefined;
programmer?: string | undefined;
debugProperties?: string[] | undefined;
} | undefined;
data?: Uint8Array<ArrayBufferLike> | undefined;
sendInterrupt?: boolean | undefined;
}): DebugRequest;
};
readonly requestStream: true;
readonly responseType: {
encode(message: DebugResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): DebugResponse;
fromJSON(object: any): DebugResponse;
toJSON(message: DebugResponse): unknown;
create(base?: {
message?: ({
data?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "data";
}) | ({
result?: {
error?: string | undefined;
} | undefined;
} & {
$case: "result";
}) | undefined;
}): DebugResponse;
fromPartial(object: {
message?: ({
data?: Uint8Array<ArrayBufferLike> | undefined;
} & {
$case: "data";
}) | ({
result?: {
error?: string | undefined;
} | undefined;
} & {
$case: "result";
}) | undefined;
}): DebugResponse;
};
readonly responseStream: true;
readonly options: {};
};
/** Determine if debugging is suported given a specific configuration. */
readonly isDebugSupported: {
readonly name: "IsDebugSupported";
readonly requestType: {
encode(message: IsDebugSupportedRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): IsDebugSupportedRequest;
fromJSON(object: any): IsDebugSupportedRequest;
toJSON(message: IsDebugSupportedRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
interpreter?: string | undefined;
programmer?: string | undefined;
debugProperties?: string[] | undefined;
}): IsDebugSupportedRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
interpreter?: string | undefined;
programmer?: string | undefined;
debugProperties?: string[] | undefined;
}): IsDebugSupportedRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: IsDebugSupportedResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): IsDebugSupportedResponse;
fromJSON(object: any): IsDebugSupportedResponse;
toJSON(message: IsDebugSupportedResponse): unknown;
create(base?: {
debuggingSupported?: boolean | undefined;
debugFqbn?: string | undefined;
}): IsDebugSupportedResponse;
fromPartial(object: {
debuggingSupported?: boolean | undefined;
debugFqbn?: string | undefined;
}): IsDebugSupportedResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Query the debugger information given a specific configuration. */
readonly getDebugConfig: {
readonly name: "GetDebugConfig";
readonly requestType: {
encode(message: GetDebugConfigRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetDebugConfigRequest;
fromJSON(object: any): GetDebugConfigRequest;
toJSON(message: GetDebugConfigRequest): unknown;
create(base?: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
sketchPath?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
interpreter?: string | undefined;
importDir?: string | undefined;
programmer?: string | undefined;
debugProperties?: string[] | undefined;
}): GetDebugConfigRequest;
fromPartial(object: {
instance?: {
id?: number | undefined;
} | undefined;
fqbn?: string | undefined;
sketchPath?: string | undefined;
port?: {
address?: string | undefined;
label?: string | undefined;
protocol?: string | undefined;
protocolLabel?: string | undefined;
properties?: {
[x: string]: string | undefined;
} | undefined;
hardwareId?: string | undefined;
} | undefined;
interpreter?: string | undefined;
importDir?: string | undefined;
programmer?: string | undefined;
debugProperties?: string[] | undefined;
}): GetDebugConfigRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: GetDebugConfigResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetDebugConfigResponse;
fromJSON(object: any): GetDebugConfigResponse;
toJSON(message: GetDebugConfigResponse): unknown;
create(base?: {
executable?: string | undefined;
toolchain?: string | undefined;
toolchainPath?: string | undefined;
toolchainPrefix?: string | undefined;
server?: string | undefined;
serverPath?: string | undefined;
toolchainConfiguration?: {
typeUrl?: string | undefined;
value?: Uint8Array<ArrayBufferLike> | undefined;
} | undefined;
serverConfiguration?: {
typeUrl?: string | undefined;
value?: Uint8Array<ArrayBufferLike> | undefined;
} | undefined;
customConfigs?: {
[x: string]: string | undefined;
} | undefined;
svdFile?: string | undefined;
programmer?: string | undefined;
}): GetDebugConfigResponse;
fromPartial(object: {
executable?: string | undefined;
toolchain?: string | undefined;
toolchainPath?: string | undefined;
toolchainPrefix?: string | undefined;
server?: string | undefined;
serverPath?: string | undefined;
toolchainConfiguration?: {
typeUrl?: string | undefined;
value?: Uint8Array<ArrayBufferLike> | undefined;
} | undefined;
serverConfiguration?: {
typeUrl?: string | undefined;
value?: Uint8Array<ArrayBufferLike> | undefined;
} | undefined;
customConfigs?: {
[x: string]: string | undefined;
} | undefined;
svdFile?: string | undefined;
programmer?: string | undefined;
}): GetDebugConfigResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Check for updates to the Arduino CLI. */
readonly checkForArduinoCLIUpdates: {
readonly name: "CheckForArduinoCLIUpdates";
readonly requestType: {
encode(message: CheckForArduinoCLIUpdatesRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CheckForArduinoCLIUpdatesRequest;
fromJSON(object: any): CheckForArduinoCLIUpdatesRequest;
toJSON(message: CheckForArduinoCLIUpdatesRequest): unknown;
create(base?: DeepPartial<CheckForArduinoCLIUpdatesRequest>): CheckForArduinoCLIUpdatesRequest;
fromPartial(object: DeepPartial<CheckForArduinoCLIUpdatesRequest>): CheckForArduinoCLIUpdatesRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: CheckForArduinoCLIUpdatesResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CheckForArduinoCLIUpdatesResponse;
fromJSON(object: any): CheckForArduinoCLIUpdatesResponse;
toJSON(message: CheckForArduinoCLIUpdatesResponse): unknown;
create(base?: DeepPartial<CheckForArduinoCLIUpdatesResponse>): CheckForArduinoCLIUpdatesResponse;
fromPartial(object: DeepPartial<CheckForArduinoCLIUpdatesResponse>): CheckForArduinoCLIUpdatesResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Clean the download cache directory (where archives are downloaded). */
readonly cleanDownloadCacheDirectory: {
readonly name: "CleanDownloadCacheDirectory";
readonly requestType: {
encode(message: CleanDownloadCacheDirectoryRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CleanDownloadCacheDirectoryRequest;
fromJSON(object: any): CleanDownloadCacheDirectoryRequest;
toJSON(message: CleanDownloadCacheDirectoryRequest): unknown;
create(base?: DeepPartial<CleanDownloadCacheDirectoryRequest>): CleanDownloadCacheDirectoryRequest;
fromPartial(object: DeepPartial<CleanDownloadCacheDirectoryRequest>): CleanDownloadCacheDirectoryRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(_: CleanDownloadCacheDirectoryResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): CleanDownloadCacheDirectoryResponse;
fromJSON(_: any): CleanDownloadCacheDirectoryResponse;
toJSON(_: CleanDownloadCacheDirectoryResponse): unknown;
create(base?: DeepPartial<CleanDownloadCacheDirectoryResponse>): CleanDownloadCacheDirectoryResponse;
fromPartial(_: DeepPartial<CleanDownloadCacheDirectoryResponse>): CleanDownloadCacheDirectoryResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Writes the settings currently stored in memory in a YAML file. */
readonly configurationSave: {
readonly name: "ConfigurationSave";
readonly requestType: {
encode(message: ConfigurationSaveRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ConfigurationSaveRequest;
fromJSON(object: any): ConfigurationSaveRequest;
toJSON(message: ConfigurationSaveRequest): unknown;
create(base?: {
settingsFormat?: string | undefined;
}): ConfigurationSaveRequest;
fromPartial(object: {
settingsFormat?: string | undefined;
}): ConfigurationSaveRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: ConfigurationSaveResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ConfigurationSaveResponse;
fromJSON(object: any): ConfigurationSaveResponse;
toJSON(message: ConfigurationSaveResponse): unknown;
create(base?: {
encodedSettings?: string | undefined;
}): ConfigurationSaveResponse;
fromPartial(object: {
encodedSettings?: string | undefined;
}): ConfigurationSaveResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Read the settings from a YAML file. */
readonly configurationOpen: {
readonly name: "ConfigurationOpen";
readonly requestType: {
encode(message: ConfigurationOpenRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ConfigurationOpenRequest;
fromJSON(object: any): ConfigurationOpenRequest;
toJSON(message: ConfigurationOpenRequest): unknown;
create(base?: {
encodedSettings?: string | undefined;
settingsFormat?: string | undefined;
}): ConfigurationOpenRequest;
fromPartial(object: {
encodedSettings?: string | undefined;
settingsFormat?: string | undefined;
}): ConfigurationOpenRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: ConfigurationOpenResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ConfigurationOpenResponse;
fromJSON(object: any): ConfigurationOpenResponse;
toJSON(message: ConfigurationOpenResponse): unknown;
create(base?: {
warnings?: string[] | undefined;
}): ConfigurationOpenResponse;
fromPartial(object: {
warnings?: string[] | undefined;
}): ConfigurationOpenResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Get the current configuration. */
readonly configurationGet: {
readonly name: "ConfigurationGet";
readonly requestType: {
encode(_: ConfigurationGetRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ConfigurationGetRequest;
fromJSON(_: any): ConfigurationGetRequest;
toJSON(_: ConfigurationGetRequest): unknown;
create(base?: {}): ConfigurationGetRequest;
fromPartial(_: {}): ConfigurationGetRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: ConfigurationGetResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ConfigurationGetResponse;
fromJSON(object: any): ConfigurationGetResponse;
toJSON(message: ConfigurationGetResponse): unknown;
create(base?: {
configuration?: {
directories?: {
data?: string | undefined;
user?: string | undefined;
downloads?: string | undefined;
builtin?: {
libraries?: string | undefined | undefined;
} | undefined;
} | undefined;
network?: {
extraUserAgent?: string | undefined | undefined;
proxy?: string | undefined | undefined;
} | undefined;
sketch?: {
alwaysExportBinaries?: boolean | undefined;
} | undefined;
buildCache?: {
compilationsBeforePurge?: number | undefined;
ttlSecs?: number | undefined;
} | undefined;
boardManager?: {
additionalUrls?: string[] | undefined;
} | undefined;
daemon?: {
port?: string | undefined;
} | undefined;
output?: {
noColor?: boolean | undefined;
} | undefined;
logging?: {
level?: string | undefined;
format?: string | undefined;
file?: string | undefined | undefined;
} | undefined;
library?: {
enableUnsafeInstall?: boolean | undefined;
} | undefined;
updater?: {
enableNotification?: boolean | undefined;
} | undefined;
locale?: string | undefined | undefined;
} | undefined;
}): ConfigurationGetResponse;
fromPartial(object: {
configuration?: {
directories?: {
data?: string | undefined;
user?: string | undefined;
downloads?: string | undefined;
builtin?: {
libraries?: string | undefined | undefined;
} | undefined;
} | undefined;
network?: {
extraUserAgent?: string | undefined | undefined;
proxy?: string | undefined | undefined;
} | undefined;
sketch?: {
alwaysExportBinaries?: boolean | undefined;
} | undefined;
buildCache?: {
compilationsBeforePurge?: number | undefined;
ttlSecs?: number | undefined;
} | undefined;
boardManager?: {
additionalUrls?: string[] | undefined;
} | undefined;
daemon?: {
port?: string | undefined;
} | undefined;
output?: {
noColor?: boolean | undefined;
} | undefined;
logging?: {
level?: string | undefined;
format?: string | undefined;
file?: string | undefined | undefined;
} | undefined;
library?: {
enableUnsafeInstall?: boolean | undefined;
} | undefined;
updater?: {
enableNotification?: boolean | undefined;
} | undefined;
locale?: string | undefined | undefined;
} | undefined;
}): ConfigurationGetResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Enumerate all the keys/values pairs available in the configuration. */
readonly settingsEnumerate: {
readonly name: "SettingsEnumerate";
readonly requestType: {
encode(_: SettingsEnumerateRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SettingsEnumerateRequest;
fromJSON(_: any): SettingsEnumerateRequest;
toJSON(_: SettingsEnumerateRequest): unknown;
create(base?: {}): SettingsEnumerateRequest;
fromPartial(_: {}): SettingsEnumerateRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: SettingsEnumerateResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SettingsEnumerateResponse;
fromJSON(object: any): SettingsEnumerateResponse;
toJSON(message: SettingsEnumerateResponse): unknown;
create(base?: {
entries?: {
key?: string | undefined;
type?: string | undefined;
}[] | undefined;
}): SettingsEnumerateResponse;
fromPartial(object: {
entries?: {
key?: string | undefined;
type?: string | undefined;
}[] | undefined;
}): SettingsEnumerateResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Get a single configuration value. */
readonly settingsGetValue: {
readonly name: "SettingsGetValue";
readonly requestType: {
encode(message: SettingsGetValueRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SettingsGetValueRequest;
fromJSON(object: any): SettingsGetValueRequest;
toJSON(message: SettingsGetValueRequest): unknown;
create(base?: {
key?: string | undefined;
valueFormat?: string | undefined;
}): SettingsGetValueRequest;
fromPartial(object: {
key?: string | undefined;
valueFormat?: string | undefined;
}): SettingsGetValueRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: SettingsGetValueResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SettingsGetValueResponse;
fromJSON(object: any): SettingsGetValueResponse;
toJSON(message: SettingsGetValueResponse): unknown;
create(base?: {
encodedValue?: string | undefined;
}): SettingsGetValueResponse;
fromPartial(object: {
encodedValue?: string | undefined;
}): SettingsGetValueResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Set a single configuration value. */
readonly settingsSetValue: {
readonly name: "SettingsSetValue";
readonly requestType: {
encode(message: SettingsSetValueRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SettingsSetValueRequest;
fromJSON(object: any): SettingsSetValueRequest;
toJSON(message: SettingsSetValueRequest): unknown;
create(base?: {
key?: string | undefined;
encodedValue?: string | undefined;
valueFormat?: string | undefined;
}): SettingsSetValueRequest;
fromPartial(object: {
key?: string | undefined;
encodedValue?: string | undefined;
valueFormat?: string | undefined;
}): SettingsSetValueRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(_: SettingsSetValueResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SettingsSetValueResponse;
fromJSON(_: any): SettingsSetValueResponse;
toJSON(_: SettingsSetValueResponse): unknown;
create(base?: {}): SettingsSetValueResponse;
fromPartial(_: {}): SettingsSetValueResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Create the sketch project file and add a build profile to it. */
readonly profileCreate: {
readonly name: "ProfileCreate";
readonly requestType: {
encode(message: ProfileCreateRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileCreateRequest;
fromJSON(object: any): ProfileCreateRequest;
toJSON(message: ProfileCreateRequest): unknown;
create(base?: DeepPartial<ProfileCreateRequest>): ProfileCreateRequest;
fromPartial(object: DeepPartial<ProfileCreateRequest>): ProfileCreateRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(_: ProfileCreateResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileCreateResponse;
fromJSON(_: any): ProfileCreateResponse;
toJSON(_: ProfileCreateResponse): unknown;
create(base?: DeepPartial<ProfileCreateResponse>): ProfileCreateResponse;
fromPartial(_: DeepPartial<ProfileCreateResponse>): ProfileCreateResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Add a library to the build profile. */
readonly profileLibAdd: {
readonly name: "ProfileLibAdd";
readonly requestType: {
encode(message: ProfileLibAddRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibAddRequest;
fromJSON(object: any): ProfileLibAddRequest;
toJSON(message: ProfileLibAddRequest): unknown;
create(base?: DeepPartial<ProfileLibAddRequest>): ProfileLibAddRequest;
fromPartial(object: DeepPartial<ProfileLibAddRequest>): ProfileLibAddRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: ProfileLibAddResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibAddResponse;
fromJSON(object: any): ProfileLibAddResponse;
toJSON(message: ProfileLibAddResponse): unknown;
create(base?: DeepPartial<ProfileLibAddResponse>): ProfileLibAddResponse;
fromPartial(object: DeepPartial<ProfileLibAddResponse>): ProfileLibAddResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Remove a library from the build profile. */
readonly profileLibRemove: {
readonly name: "ProfileLibRemove";
readonly requestType: {
encode(message: ProfileLibRemoveRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibRemoveRequest;
fromJSON(object: any): ProfileLibRemoveRequest;
toJSON(message: ProfileLibRemoveRequest): unknown;
create(base?: DeepPartial<ProfileLibRemoveRequest>): ProfileLibRemoveRequest;
fromPartial(object: DeepPartial<ProfileLibRemoveRequest>): ProfileLibRemoveRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: ProfileLibRemoveResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibRemoveResponse;
fromJSON(object: any): ProfileLibRemoveResponse;
toJSON(message: ProfileLibRemoveResponse): unknown;
create(base?: DeepPartial<ProfileLibRemoveResponse>): ProfileLibRemoveResponse;
fromPartial(object: DeepPartial<ProfileLibRemoveResponse>): ProfileLibRemoveResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** List the libraries in the build profile. */
readonly profileLibList: {
readonly name: "ProfileLibList";
readonly requestType: {
encode(message: ProfileLibListRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibListRequest;
fromJSON(object: any): ProfileLibListRequest;
toJSON(message: ProfileLibListRequest): unknown;
create(base?: DeepPartial<ProfileLibListRequest>): ProfileLibListRequest;
fromPartial(object: DeepPartial<ProfileLibListRequest>): ProfileLibListRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(message: ProfileLibListResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileLibListResponse;
fromJSON(object: any): ProfileLibListResponse;
toJSON(message: ProfileLibListResponse): unknown;
create(base?: DeepPartial<ProfileLibListResponse>): ProfileLibListResponse;
fromPartial(object: DeepPartial<ProfileLibListResponse>): ProfileLibListResponse;
};
readonly responseStream: false;
readonly options: {};
};
/** Set the default build profile. */
readonly profileSetDefault: {
readonly name: "ProfileSetDefault";
readonly requestType: {
encode(message: ProfileSetDefaultRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileSetDefaultRequest;
fromJSON(object: any): ProfileSetDefaultRequest;
toJSON(message: ProfileSetDefaultRequest): unknown;
create(base?: DeepPartial<ProfileSetDefaultRequest>): ProfileSetDefaultRequest;
fromPartial(object: DeepPartial<ProfileSetDefaultRequest>): ProfileSetDefaultRequest;
};
readonly requestStream: false;
readonly responseType: {
encode(_: ProfileSetDefaultResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ProfileSetDefaultResponse;
fromJSON(_: any): ProfileSetDefaultResponse;
toJSON(_: ProfileSetDefaultResponse): unknown;
create(base?: DeepPartial<ProfileSetDefaultResponse>): ProfileSetDefaultResponse;
fromPartial(_: DeepPartial<ProfileSetDefaultResponse>): ProfileSetDefaultResponse;
};
readonly responseStream: false;
readonly options: {};
};
};
};
export interface ArduinoCoreServiceImplementation<CallContextExt = {}> {
/** Create a new Arduino Core instance. */
create(request: CreateRequest, context: CallContext & CallContextExt): Promise<DeepPartial<CreateResponse>>;
/**
* Initializes an existing Arduino Core instance by loading platforms and
* libraries.
*/
init(request: InitRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<InitResponse>>;
/** Destroy an instance of the Arduino Core Service. */
destroy(request: DestroyRequest, context: CallContext & CallContextExt): Promise<DeepPartial<DestroyResponse>>;
/** Update package index of the Arduino Core Service. */
updateIndex(request: UpdateIndexRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<UpdateIndexResponse>>;
/** Update libraries index. */
updateLibrariesIndex(request: UpdateLibrariesIndexRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<UpdateLibrariesIndexResponse>>;
/** Get the version of Arduino CLI in use. */
version(request: VersionRequest, context: CallContext & CallContextExt): Promise<DeepPartial<VersionResponse>>;
/** Create a new Sketch. */
newSketch(request: NewSketchRequest, context: CallContext & CallContextExt): Promise<DeepPartial<NewSketchResponse>>;
/** Returns all files composing a Sketch. */
loadSketch(request: LoadSketchRequest, context: CallContext & CallContextExt): Promise<DeepPartial<LoadSketchResponse>>;
/** Creates a zip file containing all files of specified Sketch. */
archiveSketch(request: ArchiveSketchRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ArchiveSketchResponse>>;
/**
* Sets the sketch default FQBN and Port Address/Protocol in the sketch
* project file (sketch.yaml). These metadata can be retrieved using
* LoadSketch.
*/
setSketchDefaults(request: SetSketchDefaultsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<SetSketchDefaultsResponse>>;
/** Requests details about a board. */
boardDetails(request: BoardDetailsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<BoardDetailsResponse>>;
/** List the boards currently connected to the computer. */
boardList(request: BoardListRequest, context: CallContext & CallContextExt): Promise<DeepPartial<BoardListResponse>>;
/** List all the boards provided by installed platforms. */
boardListAll(request: BoardListAllRequest, context: CallContext & CallContextExt): Promise<DeepPartial<BoardListAllResponse>>;
/** Search boards in installed and not installed Platforms. */
boardSearch(request: BoardSearchRequest, context: CallContext & CallContextExt): Promise<DeepPartial<BoardSearchResponse>>;
/** Identify a board using the given properties. */
boardIdentify(request: BoardIdentifyRequest, context: CallContext & CallContextExt): Promise<DeepPartial<BoardIdentifyResponse>>;
/** List boards connection and disconnected events. */
boardListWatch(request: BoardListWatchRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<BoardListWatchResponse>>;
/** Compile an Arduino sketch. */
compile(request: CompileRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<CompileResponse>>;
/** Download and install a platform and its tool dependencies. */
platformInstall(request: PlatformInstallRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<PlatformInstallResponse>>;
/**
* Download a platform and its tool dependencies to the `staging/packages`
* subdirectory of the data directory.
*/
platformDownload(request: PlatformDownloadRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<PlatformDownloadResponse>>;
/**
* Uninstall a platform as well as its tool dependencies that are not used by
* other installed platforms.
*/
platformUninstall(request: PlatformUninstallRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<PlatformUninstallResponse>>;
/** Upgrade an installed platform to the latest version. */
platformUpgrade(request: PlatformUpgradeRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<PlatformUpgradeResponse>>;
/** Upload a compiled sketch to a board. */
upload(request: UploadRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<UploadResponse>>;
/** Upload a compiled sketch to a board using a programmer. */
uploadUsingProgrammer(request: UploadUsingProgrammerRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<UploadUsingProgrammerResponse>>;
/**
* Returns the list of users fields necessary to upload to that board using
* the specified protocol.
*/
supportedUserFields(request: SupportedUserFieldsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<SupportedUserFieldsResponse>>;
/** List programmers available for a board. */
listProgrammersAvailableForUpload(request: ListProgrammersAvailableForUploadRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ListProgrammersAvailableForUploadResponse>>;
/** Burn bootloader to a board. */
burnBootloader(request: BurnBootloaderRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<BurnBootloaderResponse>>;
/** Search for a platform in the platforms indexes. */
platformSearch(request: PlatformSearchRequest, context: CallContext & CallContextExt): Promise<DeepPartial<PlatformSearchResponse>>;
/**
* Download the archive file of an Arduino library in the libraries index to
* the staging directory.
*/
libraryDownload(request: LibraryDownloadRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<LibraryDownloadResponse>>;
/** Download and install an Arduino library from the libraries index. */
libraryInstall(request: LibraryInstallRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<LibraryInstallResponse>>;
/** Upgrade a library to the newest version available. */
libraryUpgrade(request: LibraryUpgradeRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<LibraryUpgradeResponse>>;
/** Install a library from a Zip File. */
zipLibraryInstall(request: ZipLibraryInstallRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<ZipLibraryInstallResponse>>;
/** Download and install a library from a git url. */
gitLibraryInstall(request: GitLibraryInstallRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<GitLibraryInstallResponse>>;
/** Uninstall an Arduino library. */
libraryUninstall(request: LibraryUninstallRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<LibraryUninstallResponse>>;
/** Upgrade all installed Arduino libraries to the newest version available. */
libraryUpgradeAll(request: LibraryUpgradeAllRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<LibraryUpgradeAllResponse>>;
/**
* List the recursive dependencies of a library, as defined by the `depends`
* field of the library.properties files.
*/
libraryResolveDependencies(request: LibraryResolveDependenciesRequest, context: CallContext & CallContextExt): Promise<DeepPartial<LibraryResolveDependenciesResponse>>;
/** Search the Arduino libraries index for libraries. */
librarySearch(request: LibrarySearchRequest, context: CallContext & CallContextExt): Promise<DeepPartial<LibrarySearchResponse>>;
/** List the installed libraries. */
libraryList(request: LibraryListRequest, context: CallContext & CallContextExt): Promise<DeepPartial<LibraryListResponse>>;
/** Open a monitor connection to a board port. */
monitor(request: AsyncIterable<MonitorRequest>, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<MonitorResponse>>;
/** Returns the parameters that can be set in the MonitorRequest calls. */
enumerateMonitorPortSettings(request: EnumerateMonitorPortSettingsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<EnumerateMonitorPortSettingsResponse>>;
/** Start a debug session and communicate with the debugger tool. */
debug(request: AsyncIterable<DebugRequest>, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<DebugResponse>>;
/** Determine if debugging is suported given a specific configuration. */
isDebugSupported(request: IsDebugSupportedRequest, context: CallContext & CallContextExt): Promise<DeepPartial<IsDebugSupportedResponse>>;
/** Query the debugger information given a specific configuration. */
getDebugConfig(request: GetDebugConfigRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetDebugConfigResponse>>;
/** Check for updates to the Arduino CLI. */
checkForArduinoCLIUpdates(request: CheckForArduinoCLIUpdatesRequest, context: CallContext & CallContextExt): Promise<DeepPartial<CheckForArduinoCLIUpdatesResponse>>;
/** Clean the download cache directory (where archives are downloaded). */
cleanDownloadCacheDirectory(request: CleanDownloadCacheDirectoryRequest, context: CallContext & CallContextExt): Promise<DeepPartial<CleanDownloadCacheDirectoryResponse>>;
/** Writes the settings currently stored in memory in a YAML file. */
configurationSave(request: ConfigurationSaveRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ConfigurationSaveResponse>>;
/** Read the settings from a YAML file. */
configurationOpen(request: ConfigurationOpenRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ConfigurationOpenResponse>>;
/** Get the current configuration. */
configurationGet(request: ConfigurationGetRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ConfigurationGetResponse>>;
/** Enumerate all the keys/values pairs available in the configuration. */
settingsEnumerate(request: SettingsEnumerateRequest, context: CallContext & CallContextExt): Promise<DeepPartial<SettingsEnumerateResponse>>;
/** Get a single configuration value. */
settingsGetValue(request: SettingsGetValueRequest, context: CallContext & CallContextExt): Promise<DeepPartial<SettingsGetValueResponse>>;
/** Set a single configuration value. */
settingsSetValue(request: SettingsSetValueRequest, context: CallContext & CallContextExt): Promise<DeepPartial<SettingsSetValueResponse>>;
/** Create the sketch project file and add a build profile to it. */
profileCreate(request: ProfileCreateRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ProfileCreateResponse>>;
/** Add a library to the build profile. */
profileLibAdd(request: ProfileLibAddRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ProfileLibAddResponse>>;
/** Remove a library from the build profile. */
profileLibRemove(request: ProfileLibRemoveRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ProfileLibRemoveResponse>>;
/** List the libraries in the build profile. */
profileLibList(request: ProfileLibListRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ProfileLibListResponse>>;
/** Set the default build profile. */
profileSetDefault(request: ProfileSetDefaultRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ProfileSetDefaultResponse>>;
}
export interface ArduinoCoreServiceClient<CallOptionsExt = {}> {
/** Create a new Arduino Core instance. */
create(request: DeepPartial<CreateRequest>, options?: CallOptions & CallOptionsExt): Promise<CreateResponse>;
/**
* Initializes an existing Arduino Core instance by loading platforms and
* libraries.
*/
init(request: DeepPartial<InitRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<InitResponse>;
/** Destroy an instance of the Arduino Core Service. */
destroy(request: DeepPartial<DestroyRequest>, options?: CallOptions & CallOptionsExt): Promise<DestroyResponse>;
/** Update package index of the Arduino Core Service. */
updateIndex(request: DeepPartial<UpdateIndexRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<UpdateIndexResponse>;
/** Update libraries index. */
updateLibrariesIndex(request: DeepPartial<UpdateLibrariesIndexRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<UpdateLibrariesIndexResponse>;
/** Get the version of Arduino CLI in use. */
version(request: DeepPartial<VersionRequest>, options?: CallOptions & CallOptionsExt): Promise<VersionResponse>;
/** Create a new Sketch. */
newSketch(request: DeepPartial<NewSketchRequest>, options?: CallOptions & CallOptionsExt): Promise<NewSketchResponse>;
/** Returns all files composing a Sketch. */
loadSketch(request: DeepPartial<LoadSketchRequest>, options?: CallOptions & CallOptionsExt): Promise<LoadSketchResponse>;
/** Creates a zip file containing all files of specified Sketch. */
archiveSketch(request: DeepPartial<ArchiveSketchRequest>, options?: CallOptions & CallOptionsExt): Promise<ArchiveSketchResponse>;
/**
* Sets the sketch default FQBN and Port Address/Protocol in the sketch
* project file (sketch.yaml). These metadata can be retrieved using
* LoadSketch.
*/
setSketchDefaults(request: DeepPartial<SetSketchDefaultsRequest>, options?: CallOptions & CallOptionsExt): Promise<SetSketchDefaultsResponse>;
/** Requests details about a board. */
boardDetails(request: DeepPartial<BoardDetailsRequest>, options?: CallOptions & CallOptionsExt): Promise<BoardDetailsResponse>;
/** List the boards currently connected to the computer. */
boardList(request: DeepPartial<BoardListRequest>, options?: CallOptions & CallOptionsExt): Promise<BoardListResponse>;
/** List all the boards provided by installed platforms. */
boardListAll(request: DeepPartial<BoardListAllRequest>, options?: CallOptions & CallOptionsExt): Promise<BoardListAllResponse>;
/** Search boards in installed and not installed Platforms. */
boardSearch(request: DeepPartial<BoardSearchRequest>, options?: CallOptions & CallOptionsExt): Promise<BoardSearchResponse>;
/** Identify a board using the given properties. */
boardIdentify(request: DeepPartial<BoardIdentifyRequest>, options?: CallOptions & CallOptionsExt): Promise<BoardIdentifyResponse>;
/** List boards connection and disconnected events. */
boardListWatch(request: DeepPartial<BoardListWatchRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<BoardListWatchResponse>;
/** Compile an Arduino sketch. */
compile(request: DeepPartial<CompileRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<CompileResponse>;
/** Download and install a platform and its tool dependencies. */
platformInstall(request: DeepPartial<PlatformInstallRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<PlatformInstallResponse>;
/**
* Download a platform and its tool dependencies to the `staging/packages`
* subdirectory of the data directory.
*/
platformDownload(request: DeepPartial<PlatformDownloadRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<PlatformDownloadResponse>;
/**
* Uninstall a platform as well as its tool dependencies that are not used by
* other installed platforms.
*/
platformUninstall(request: DeepPartial<PlatformUninstallRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<PlatformUninstallResponse>;
/** Upgrade an installed platform to the latest version. */
platformUpgrade(request: DeepPartial<PlatformUpgradeRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<PlatformUpgradeResponse>;
/** Upload a compiled sketch to a board. */
upload(request: DeepPartial<UploadRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<UploadResponse>;
/** Upload a compiled sketch to a board using a programmer. */
uploadUsingProgrammer(request: DeepPartial<UploadUsingProgrammerRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<UploadUsingProgrammerResponse>;
/**
* Returns the list of users fields necessary to upload to that board using
* the specified protocol.
*/
supportedUserFields(request: DeepPartial<SupportedUserFieldsRequest>, options?: CallOptions & CallOptionsExt): Promise<SupportedUserFieldsResponse>;
/** List programmers available for a board. */
listProgrammersAvailableForUpload(request: DeepPartial<ListProgrammersAvailableForUploadRequest>, options?: CallOptions & CallOptionsExt): Promise<ListProgrammersAvailableForUploadResponse>;
/** Burn bootloader to a board. */
burnBootloader(request: DeepPartial<BurnBootloaderRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<BurnBootloaderResponse>;
/** Search for a platform in the platforms indexes. */
platformSearch(request: DeepPartial<PlatformSearchRequest>, options?: CallOptions & CallOptionsExt): Promise<PlatformSearchResponse>;
/**
* Download the archive file of an Arduino library in the libraries index to
* the staging directory.
*/
libraryDownload(request: DeepPartial<LibraryDownloadRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<LibraryDownloadResponse>;
/** Download and install an Arduino library from the libraries index. */
libraryInstall(request: DeepPartial<LibraryInstallRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<LibraryInstallResponse>;
/** Upgrade a library to the newest version available. */
libraryUpgrade(request: DeepPartial<LibraryUpgradeRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<LibraryUpgradeResponse>;
/** Install a library from a Zip File. */
zipLibraryInstall(request: DeepPartial<ZipLibraryInstallRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<ZipLibraryInstallResponse>;
/** Download and install a library from a git url. */
gitLibraryInstall(request: DeepPartial<GitLibraryInstallRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<GitLibraryInstallResponse>;
/** Uninstall an Arduino library. */
libraryUninstall(request: DeepPartial<LibraryUninstallRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<LibraryUninstallResponse>;
/** Upgrade all installed Arduino libraries to the newest version available. */
libraryUpgradeAll(request: DeepPartial<LibraryUpgradeAllRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<LibraryUpgradeAllResponse>;
/**
* List the recursive dependencies of a library, as defined by the `depends`
* field of the library.properties files.
*/
libraryResolveDependencies(request: DeepPartial<LibraryResolveDependenciesRequest>, options?: CallOptions & CallOptionsExt): Promise<LibraryResolveDependenciesResponse>;
/** Search the Arduino libraries index for libraries. */
librarySearch(request: DeepPartial<LibrarySearchRequest>, options?: CallOptions & CallOptionsExt): Promise<LibrarySearchResponse>;
/** List the installed libraries. */
libraryList(request: DeepPartial<LibraryListRequest>, options?: CallOptions & CallOptionsExt): Promise<LibraryListResponse>;
/** Open a monitor connection to a board port. */
monitor(request: AsyncIterable<DeepPartial<MonitorRequest>>, options?: CallOptions & CallOptionsExt): AsyncIterable<MonitorResponse>;
/** Returns the parameters that can be set in the MonitorRequest calls. */
enumerateMonitorPortSettings(request: DeepPartial<EnumerateMonitorPortSettingsRequest>, options?: CallOptions & CallOptionsExt): Promise<EnumerateMonitorPortSettingsResponse>;
/** Start a debug session and communicate with the debugger tool. */
debug(request: AsyncIterable<DeepPartial<DebugRequest>>, options?: CallOptions & CallOptionsExt): AsyncIterable<DebugResponse>;
/** Determine if debugging is suported given a specific configuration. */
isDebugSupported(request: DeepPartial<IsDebugSupportedRequest>, options?: CallOptions & CallOptionsExt): Promise<IsDebugSupportedResponse>;
/** Query the debugger information given a specific configuration. */
getDebugConfig(request: DeepPartial<GetDebugConfigRequest>, options?: CallOptions & CallOptionsExt): Promise<GetDebugConfigResponse>;
/** Check for updates to the Arduino CLI. */
checkForArduinoCLIUpdates(request: DeepPartial<CheckForArduinoCLIUpdatesRequest>, options?: CallOptions & CallOptionsExt): Promise<CheckForArduinoCLIUpdatesResponse>;
/** Clean the download cache directory (where archives are downloaded). */
cleanDownloadCacheDirectory(request: DeepPartial<CleanDownloadCacheDirectoryRequest>, options?: CallOptions & CallOptionsExt): Promise<CleanDownloadCacheDirectoryResponse>;
/** Writes the settings currently stored in memory in a YAML file. */
configurationSave(request: DeepPartial<ConfigurationSaveRequest>, options?: CallOptions & CallOptionsExt): Promise<ConfigurationSaveResponse>;
/** Read the settings from a YAML file. */
configurationOpen(request: DeepPartial<ConfigurationOpenRequest>, options?: CallOptions & CallOptionsExt): Promise<ConfigurationOpenResponse>;
/** Get the current configuration. */
configurationGet(request: DeepPartial<ConfigurationGetRequest>, options?: CallOptions & CallOptionsExt): Promise<ConfigurationGetResponse>;
/** Enumerate all the keys/values pairs available in the configuration. */
settingsEnumerate(request: DeepPartial<SettingsEnumerateRequest>, options?: CallOptions & CallOptionsExt): Promise<SettingsEnumerateResponse>;
/** Get a single configuration value. */
settingsGetValue(request: DeepPartial<SettingsGetValueRequest>, options?: CallOptions & CallOptionsExt): Promise<SettingsGetValueResponse>;
/** Set a single configuration value. */
settingsSetValue(request: DeepPartial<SettingsSetValueRequest>, options?: CallOptions & CallOptionsExt): Promise<SettingsSetValueResponse>;
/** Create the sketch project file and add a build profile to it. */
profileCreate(request: DeepPartial<ProfileCreateRequest>, options?: CallOptions & CallOptionsExt): Promise<ProfileCreateResponse>;
/** Add a library to the build profile. */
profileLibAdd(request: DeepPartial<ProfileLibAddRequest>, options?: CallOptions & CallOptionsExt): Promise<ProfileLibAddResponse>;
/** Remove a library from the build profile. */
profileLibRemove(request: DeepPartial<ProfileLibRemoveRequest>, options?: CallOptions & CallOptionsExt): Promise<ProfileLibRemoveResponse>;
/** List the libraries in the build profile. */
profileLibList(request: DeepPartial<ProfileLibListRequest>, options?: CallOptions & CallOptionsExt): Promise<ProfileLibListResponse>;
/** Set the default build profile. */
profileSetDefault(request: DeepPartial<ProfileSetDefaultRequest>, options?: CallOptions & CallOptionsExt): Promise<ProfileSetDefaultResponse>;
}
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
$case: string;
} ? {
[K in keyof Omit<T, '$case'>]?: DeepPartial<T[K]>;
} & {
$case: T['$case'];
} : T extends {} ? {
[K in keyof T]?: DeepPartial<T[K]>;
} : Partial<T>;
export type ServerStreamingMethodResult<Response> = {
[Symbol.asyncIterator](): AsyncIterator<Response, void>;
};
export {};
//# sourceMappingURL=commands.d.ts.map