sketch

Documentation

Index

• func ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchRequest) (*rpc.ArchiveSketchResponse, error)
• func LoadSketch(ctx context.Context, req *rpc.LoadSketchRequest) (*rpc.LoadSketchResponse, error)
• func NewSketch(ctx context.Context, req *rpc.NewSketchRequest) (*rpc.NewSketchResponse, error)
• func SetSketchDefaults(ctx context.Context, req *rpc.SetSketchDefaultsRequest) (*rpc.SetSketchDefaultsResponse, error)
• func WarnDeprecatedFiles(sketchPath *paths.Path) string

Functions

func ArchiveSketch

func ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchRequest) (*rpc.ArchiveSketchResponse, error)

ArchiveSketch FIXMEDOC

func LoadSketch

func LoadSketch(ctx context.Context, req *rpc.LoadSketchRequest) (*rpc.LoadSketchResponse, error)

LoadSketch collects and returns all files composing a sketch

func NewSketch

func NewSketch(ctx context.Context, req *rpc.NewSketchRequest) (*rpc.NewSketchResponse, error)

NewSketch creates a new sketch via gRPC

func SetSketchDefaults

func SetSketchDefaults(ctx context.Context, req *rpc.SetSketchDefaultsRequest) (*rpc.SetSketchDefaultsResponse, error)

SetSketchDefaults updates the sketch project file (sketch.yaml) with the given defaults for the values `default_fqbn`, `default_port`, and `default_protocol`.

func WarnDeprecatedFiles

func WarnDeprecatedFiles(sketchPath *paths.Path) string

WarnDeprecatedFiles warns the user that a type of sketch files are deprecated