type InvalidSketchFolderNameError struct {SketchFolder *paths.PathSketchFile   *paths.Path}

func (*InvalidSketchFolderNameError)Error¶

func (e *InvalidSketchFolderNameError) Error()string

type Profile struct {NamestringNotesstring                   `yaml:"notes"`FQBNstring                   `yaml:"fqbn"`Portstring                   `yaml:"port"`PortConfig map[string]string        `yaml:"port_config"`Protocolstring                   `yaml:"protocol"`Programmerstring                   `yaml:"programmer"`PlatformsProfileRequiredPlatforms `yaml:"platforms"`LibrariesProfileRequiredLibraries `yaml:"libraries"`}

func (*Profile)AsYaml¶

func (p *Profile) AsYaml()string

AsYaml outputs the profile as Yaml

func (*Profile)RequireSystemInstalledPlatform¶added inv1.3.0

func (p *Profile) RequireSystemInstalledPlatform()bool

UsesSystemPlatform checks if this profile requires a system installed platform.

func (*Profile)ToRpc¶

func (p *Profile) ToRpc() *rpc.SketchProfile

ToRpc converts this Profile to an rpc.SketchProfile

type ProfileLibraryReference struct {LibrarystringInstallDir *paths.PathVersion    *semver.Version}

func (*ProfileLibraryReference)AsYaml¶

func (l *ProfileLibraryReference) AsYaml()string

AsYaml outputs the required library as Yaml

func (*ProfileLibraryReference)InternalUniqueIdentifier¶

func (l *ProfileLibraryReference) InternalUniqueIdentifier()string

InternalUniqueIdentifier returns the unique identifier for this object

func (*ProfileLibraryReference)String¶

func (l *ProfileLibraryReference) String()string

func (*ProfileLibraryReference)UnmarshalYAML¶

func (l *ProfileLibraryReference) UnmarshalYAML(unmarshal func(interface{})error)error

UnmarshalYAML decodes a ProfileLibraryReference from YAML source.

type ProfilePlatformReference struct {PackagerstringArchitecturestringVersion          *semver.VersionPlatformIndexURL *url.URL}

func (*ProfilePlatformReference)AsYaml¶

func (p *ProfilePlatformReference) AsYaml()string

AsYaml outputs the platform reference as Yaml

func (*ProfilePlatformReference)InternalUniqueIdentifier¶

func (p *ProfilePlatformReference) InternalUniqueIdentifier()string

InternalUniqueIdentifier returns the unique identifier for this object

func (*ProfilePlatformReference)RequireSystemInstalledPlatform¶added inv1.3.0

func (p *ProfilePlatformReference) RequireSystemInstalledPlatform()bool

RequireSystemInstalledPlatform returns true if the platform referencedoes not specify a version, meaning it requires the system installed platform.

func (*ProfilePlatformReference)String¶

func (p *ProfilePlatformReference) String()string

func (*ProfilePlatformReference)UnmarshalYAML¶

func (p *ProfilePlatformReference) UnmarshalYAML(unmarshal func(interface{})error)error

UnmarshalYAML decodes a ProfilePlatformReference from YAML source.

type ProfileRequiredLibraries []*ProfileLibraryReference

func (*ProfileRequiredLibraries)AsYaml¶

func (p *ProfileRequiredLibraries) AsYaml()string

AsYaml outputs the required libraries as Yaml

type ProfileRequiredPlatforms []*ProfilePlatformReference

func (*ProfileRequiredPlatforms)AsYaml¶

func (p *ProfileRequiredPlatforms) AsYaml()string

AsYaml outputs the required platforms as Yaml

func (*ProfileRequiredPlatforms)UnmarshalYAML¶added inv1.3.0

func (p *ProfileRequiredPlatforms) UnmarshalYAML(unmarshal func(interface{})error)error

type Project struct {Profiles          []*ProfileDefaultProfilestringDefaultFqbnstringDefaultPortstringDefaultPortConfig map[string]stringDefaultProtocolstringDefaultProgrammerstring}

funcLoadProjectFile¶

func LoadProjectFile(file *paths.Path) (*Project,error)

LoadProjectFile reads a sketch project file

func (*Project)AsYaml¶

func (p *Project) AsYaml()string

AsYaml outputs the sketch project file as YAML

type Sketch struct {NamestringMainFile         *paths.PathFullPath         *paths.Path// FullPath is the path to the Sketch folderOtherSketchFiles paths.PathList// Sketch files that end in .ino other than main fileAdditionalFiles  paths.PathListRootFolderFiles  paths.PathList// All files that are in the Sketch rootProject          *Project}

funcNew¶

func New(path *paths.Path) (*Sketch,error)

New creates an Sketch instance by reading all the files composing a sketch and grouping themby file type.

func (*Sketch)GetDefaultFQBN¶

func (s *Sketch) GetDefaultFQBN()string

GetDefaultFQBN returns the default FQBN for the sketch (from the sketch.yaml project file), or theempty string if not set.

func (*Sketch)GetDefaultPortAddressAndProtocol¶

func (s *Sketch) GetDefaultPortAddressAndProtocol() (string,string)

GetDefaultPortAddressAndProtocol returns the default port address and port protocol for the sketch(from the sketch.yaml project file), or empty strings if not set.

func (*Sketch)GetDefaultProgrammer¶

func (s *Sketch) GetDefaultProgrammer()string

GetDefaultProgrammer return the default Programmer for the sketch (from the sketch.yaml project file),ore the empty string if not set.

func (*Sketch)GetProfile¶

func (s *Sketch) GetProfile(profileNamestring) (*Profile,error)

GetProfile returns the requested profile or an error if not found

func (*Sketch)GetProjectPath¶

func (s *Sketch) GetProjectPath() *paths.Path

GetProjectPath returns the path to the sketch project file (sketch.yaml or sketch.yml)

func (*Sketch)Hash¶

func (s *Sketch) Hash()string

Hash generate a unique hash for the given sketch.

func (*Sketch)SetDefaultFQBN¶

func (s *Sketch) SetDefaultFQBN(fqbnstring)error

SetDefaultFQBN sets the default FQBN for the sketch and saves it in the sketch.yaml project file.

func (*Sketch)SetDefaultPort¶

func (s *Sketch) SetDefaultPort(address, protocolstring)error

SetDefaultPort sets the default port address and port protocol for the sketch and saves it in thesketch.yaml project file.

func (*Sketch)SetDefaultProgrammer¶

func (s *Sketch) SetDefaultProgrammer(programmerstring)error

SetDefaultFQBN sets the default programmer for the sketch and saves it in the sketch.yaml project file.

func (*Sketch)ToRpc¶

func (s *Sketch) ToRpc() *rpc.Sketch

ToRpc converts this Sketch into a rpc.LoadSketchResponse