sketches

Documentation

Index

• func NewSketchFromPath(path *paths.Path) (*sketches.Sketch, error)
• type BoardMetadata
• type Sketch
• type SketchBook
  • func NewSketchBook(path *paths.Path) *SketchBook
  • func (sketchbook *SketchBook) NewSketch(name string) (*sketches.Sketch, error)

Functions

func NewSketchFromPath

func NewSketchFromPath(path *paths.Path) (*sketches.Sketch, error)

NewSketchFromPath loads a sketch from the specified path

Types

type BoardMetadata

type BoardMetadata struct {
	Fqbn string `json:"fqbn,required"`
	Name string `json:"name,required"`
}

BoardMetadata represents the board metadata for the sketch

type Sketch

type Sketch struct {
	Name          string
	Path          string
	BoardMetadata *BoardMetadata `json:"board"`
}

Sketch is a sketch for Arduino

type SketchBook

type SketchBook struct {
	Path *paths.Path
}

SketchBook is a sketchbook

func NewSketchBook

func NewSketchBook(path *paths.Path) *SketchBook

NewSketchBook returns a new SketchBook object

func (*SketchBook) NewSketch

func (sketchbook *SketchBook) NewSketch(name string) (*sketches.Sketch, error)

NewSketch loads a sketch from the sketchbook