README
¶
use 'godoc cmd/github.com/arduino/arduino-create-agent/upload' for documentation on the github.com/arduino/arduino-create-agent/upload command
Package upload
import "github.com/arduino/arduino-create-agent/upload"
Package upload allows to upload sketches into a board connected to the computer It can do it via serial port or via network
Usage for a serial upload
Make sure that you have a compiled sketch somewhere on your disk
commandline = ``"/usr/bin/avrdude" "-C/usr/bin/avrdude.conf" -v -patmega32u4 -cavr109 -P/dev/ttyACM0 -b57600 -D "-Uflash:w:./sketch.hex:i"``
err := upload.Serial("/dev/ttyACM0", commandline, upload.Extra{}, nil)
note that the commandline contains the path of the sketch (sketch.hex)
Usage for a network upload
Make sure that you have a compiled sketch somewhere on your disk
err := upload.Network("127.0.10.120", "arduino:avr:yun, "./sketch.hex", "", upload.Auth{}, nil)
The commandline can be empty or it can contain instructions (depends on the board)
Resolving commandlines
If you happen to have an unresolved commandline (full of {} parameters) you can resolve it
t := tools.Tools{}
commandline = upload.Resolve("/dev/ttyACM0", "arduino:avr:leonardo", "./sketch.hex", commandline, upload.Extra{}, t)
t must implement the locater interface (the Tools package does!)
Logging If you're interested in the output of the commands, you can implement the logger interface. Here's an example:
logger := logrus.New()
logger.Level = logrus.DebugLevel
upload.Serial("/dev/ttyACM0", commandline, upload.Extra{}, logger)
Variables
var Busy = false
Busy tells wether the upload is doing something
Functions
func Kill()
Kill stops any upload process as soon as possible
func Network(port, board, file, commandline string, auth Auth, l Logger) error
Network performs a network upload
func Resolve(port, board, file, commandline string, extra Extra, t Locater) (string, error)
Resolve replaces some symbols in the commandline with the appropriate values it can return an error when looking a variable in the Locater
func Serial(port, commandline string, extra Extra, l Logger) error
Serial performs a serial upload
Types
type Auth struct {
Username string `json:"username"`
Password string `json:"password"`
}
Auth contains username and password used for a network upload
type Extra struct {
Use1200bpsTouch bool `json:"use_1200bps_touch"`
WaitForUploadPort bool `json:"wait_for_upload_port"`
Network bool `json:"network"`
Auth Auth `json:"auth"`
Verbose bool `json:"verbose"`
ParamsVerbose string `json:"params_verbose"`
ParamsQuiet string `json:"params_quiet"`
}
Extra contains some options used during the upload
type Locater interface {
GetLocation(command string) (string, error)
}
Locater can return the location of a tool in the system
type Logger interface {
Debug(args ...interface{})
Info(args ...interface{})
}
Logger is an interface implemented by most loggers (like logrus)
Documentation
¶
Overview ¶
Package upload allows to upload sketches into a board connected to the computer It can do it via serial port or via network
**Usage for a serial upload**
Make sure that you have a compiled sketch somewhere on your disk
```go
commandline = ``"/usr/bin/avrdude" "-C/usr/bin/avrdude.conf" -v -patmega32u4 -cavr109 -P/dev/ttyACM0 -b57600 -D "-Uflash:w:./sketch.hex:i"``
err := upload.Serial("/dev/ttyACM0", commandline, upload.Extra{}, nil)
```
note that the commandline contains the path of the sketch (sketch.hex)
**Usage for a network upload**
Make sure that you have a compiled sketch somewhere on your disk
```go
err := upload.Network("127.0.10.120", "arduino:avr:yun, "./sketch.hex", "", upload.Auth{}, nil)
```
The commandline can be empty or it can contain instructions (depends on the board)
**Resolving commandlines**
If you happen to have an unresolved commandline (full of {} parameters) you can resolve it
```go
t := tools.Tools{}
commandline = upload.Resolve("/dev/ttyACM0", "arduino:avr:leonardo", "./sketch.hex", commandline, upload.Extra{}, t)
```
t must implement the locater interface (the Tools package does!)
**Logging** If you're interested in the output of the commands, you can implement the logger interface. Here's an example:
```go
logger := logrus.New()
logger.Level = logrus.DebugLevel
upload.Serial("/dev/ttyACM0", commandline, upload.Extra{}, logger)
```
Index ¶
- Variables
- func Kill()
- func Network(port, board string, files []string, commandline string, auth Auth, l Logger, ...) error
- func PartiallyResolve(board, file, commandline string, extra Extra, t Locater) (string, error)
- func Serial(port, commandline string, extra Extra, l Logger) error
- type Auth
- type Extra
- type Locater
- type Logger
Constants ¶
This section is empty.
Variables ¶
var Busy = false
Busy tells wether the programmer is doing something
Functions ¶
func Network ¶
func Network(port, board string, files []string, commandline string, auth Auth, l Logger, SSH bool) error
Network performs a network upload
func PartiallyResolve ¶
PartiallyResolve replaces some symbols in the commandline with the appropriate values it can return an error when looking a variable in the Locater
Types ¶
type Auth ¶
type Auth struct {
Username string `json:"username"`
Password string `json:"password"`
PrivateKey string `json:"private_key"`
Port int `json:"port"`
}
Auth contains username and password used for a network upload
type Extra ¶
type Extra struct {
Use1200bpsTouch bool `json:"use_1200bps_touch"`
WaitForUploadPort bool `json:"wait_for_upload_port"`
Network bool `json:"network"`
Auth Auth `json:"auth"`
Verbose bool `json:"verbose"`
ParamsVerbose string `json:"params_verbose"`
ParamsQuiet string `json:"params_quiet"`
SSH bool `json:"ssh,omitempty"`
}
Extra contains some options used during the upload
Source Files