-
Notifications
You must be signed in to change notification settings - Fork 174
/
programmer.go
494 lines (417 loc) · 14.4 KB
/
programmer.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
package main
import (
"bufio"
//"fmt"
"encoding/json"
"github.com/facchinm/go-serial"
"github.com/kardianos/osext"
"log"
"os"
"os/exec"
"path/filepath"
"strconv"
"strings"
"time"
)
// Download the file from URL first, store in tmp folder, then pass to spProgram
func spProgramFromUrl(portname string, boardname string, url string) {
mapB, _ := json.Marshal(map[string]string{"ProgrammerStatus": "DownloadStart", "Url": url})
h.broadcastSys <- mapB
startDownloadProgress()
filename, err := downloadFromUrl(url)
endDownloadProgress()
mapB, _ = json.Marshal(map[string]string{"Filename": filename, "Url": url, "ProgrammerStatus": "DownloadDone"})
h.broadcastSys <- mapB
if err != nil {
spErr(err.Error())
} else {
spProgram(portname, boardname, filename)
}
// delete file
}
func spProgram(portname string, boardname string, filePath string) {
isFound, flasher, mycmd := assembleCompilerCommand(boardname, portname, filePath)
mapD := map[string]string{"ProgrammerStatus": "CommandReady", "IsFound": strconv.FormatBool(isFound), "Flasher": flasher, "Cmd": strings.Join(mycmd, " ")}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
if isFound {
spHandlerProgram(flasher, mycmd)
} else {
spErr("We could not find the serial port " + portname + " or the board " + boardname + " that you were trying to program. It is also possible your serial port is locked by another app and thus we can't grab it to use for programming. Make sure all other apps that may be trying to access this serial port are disconnected or exited.")
}
}
var oscmd *exec.Cmd
var isRunning = false
func spHandlerProgram(flasher string, cmdString []string) {
// Extra protection code to ensure we aren't getting called from multiple threads
if isRunning {
mapD := map[string]string{"ProgrammerStatus": "ThreadError", "Msg": "You tried to run a 2nd (or further) program command while the 1st one was already running. Only 1 program cmd can run at once."}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
return
}
isRunning = true
//h.broadcastSys <- []byte("Start flashing with command " + cmdString)
log.Printf("Flashing with command:" + strings.Join(cmdString, " "))
mapD := map[string]string{"ProgrammerStatus": "Starting", "Cmd": strings.Join(cmdString, " ")}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
// if runtime.GOOS == "darwin" {
// sh, _ := exec.LookPath("sh")
// // prepend the flasher to run it via sh
// cmdString = append([]string{flasher}, cmdString...)
// oscmd = exec.Command(sh, cmdString...)
// } else {
oscmd = exec.Command(flasher, cmdString...)
// }
// Stdout buffer
//var cmdOutput []byte
// start sending back signals to the browser as the programmer runs
// just so user sees that things are chugging along
startProgress()
// will block here until results are done
cmdOutput, err := oscmd.CombinedOutput()
endProgress()
if err != nil {
log.Printf("Command finished with error: %v "+string(cmdOutput), err)
h.broadcastSys <- []byte("Could not program the board")
//mapD := map[string]string{"ProgrammerStatus": "Error", "Msg": "Could not program the board. It is also possible your serial port is locked by another app and thus we can't grab it to use for programming. Make sure all other apps that may be trying to access this serial port are disconnected or exited.", "Output": string(cmdOutput)}
mapD := map[string]string{"ProgrammerStatus": "Error", "Msg": "Could not program the board.", "Output": string(cmdOutput)}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
} else {
log.Printf("Finished without error. Good stuff. stdout: " + string(cmdOutput))
h.broadcastSys <- []byte("Flash OK!")
mapD := map[string]string{"ProgrammerStatus": "Done", "Flash": "Ok", "Output": string(cmdOutput)}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
// analyze stdin
}
isRunning = false
}
func spHandlerProgramKill() {
// Kill the process if there is one running
if oscmd != nil && oscmd.Process.Pid > 0 {
h.broadcastSys <- []byte("{\"ProgrammerStatus\": \"PreKilled\", \"Pid\": " + strconv.Itoa(oscmd.Process.Pid) + ", \"ProcessState\": \"" + oscmd.ProcessState.String() + "\"}")
oscmd.Process.Kill()
h.broadcastSys <- []byte("{\"ProgrammerStatus\": \"Killed\", \"Pid\": " + strconv.Itoa(oscmd.Process.Pid) + ", \"ProcessState\": \"" + oscmd.ProcessState.String() + "\"}")
} else {
if oscmd != nil {
h.broadcastSys <- []byte("{\"ProgrammerStatus\": \"KilledError\", \"Msg\": \"No current process\", \"Pid\": " + strconv.Itoa(oscmd.Process.Pid) + ", \"ProcessState\": \"" + oscmd.ProcessState.String() + "\"}")
} else {
h.broadcastSys <- []byte("{\"ProgrammerStatus\": \"KilledError\", \"Msg\": \"No current process\"}")
}
}
}
// send back pseudo-status to browser while programming in progress
// so user doesn't think it's dead
// this is not multi-threaded, but will work for now since
// this is just a nice-to-have informational progress
var inProgress bool
type ProgressState struct {
ProgrammerStatus string
Duration int
Pid int
//ProcessState string
}
func startProgress() {
inProgress = true
go func() {
duration := 0
for {
time.Sleep(1 * time.Second)
duration++
if inProgress == false {
break
}
// break after 5 minutes max
if duration > 60*5 {
break
}
progmsg := ProgressState{
"Progress",
duration,
oscmd.Process.Pid,
//oscmd.ProcessState.String(),
}
bm, _ := json.Marshal(progmsg)
h.broadcastSys <- []byte(bm)
}
}()
}
func endProgress() {
inProgress = false
}
// send back pseudo-status to browser while downloading in progress
// so user doesn't think it's dead
// this is not multi-threaded, but will work for now since
// this is just a nice-to-have informational progress
var inDownloadProgress bool
func startDownloadProgress() {
inDownloadProgress = true
go func() {
duration := 0
for {
time.Sleep(1 * time.Second)
duration++
h.broadcastSys <- []byte("{\"ProgrammerStatus\": \"DownloadProgress\", \"Duration\": " + strconv.Itoa(duration) + "}")
if inDownloadProgress == false {
break
}
// break after 5 minutes max
if duration > 60*5 {
break
}
}
}()
}
func endDownloadProgress() {
inDownloadProgress = false
}
func formatCmdline(cmdline string, boardOptions map[string]string) (string, bool) {
list := strings.Split(cmdline, "{")
if len(list) == 1 {
return cmdline, false
}
cmdline = ""
for _, item := range list {
item_s := strings.Split(item, "}")
item = boardOptions[item_s[0]]
if len(item_s) == 2 {
cmdline += item + item_s[1]
} else {
if item != "" {
cmdline += item
} else {
cmdline += item_s[0]
}
}
}
log.Println(cmdline)
return cmdline, true
}
func containsStr(s []string, e string) bool {
for _, a := range s {
if strings.ToLower(a) == strings.ToLower(e) {
return true
}
}
return false
}
func findNewPortName(slice1 []string, slice2 []string) string {
m := map[string]int{}
for _, s1Val := range slice1 {
m[s1Val] = 1
}
for _, s2Val := range slice2 {
m[s2Val] = m[s2Val] + 1
}
for mKey, mVal := range m {
if mVal == 1 {
return mKey
}
}
return ""
}
func assembleCompilerCommand(boardname string, portname string, filePath string) (bool, string, []string) {
// get executable (self)path and use it as base for all other paths
execPath, _ := osext.Executable()
boardFields := strings.Split(boardname, ":")
if len(boardFields) != 3 {
h.broadcastSys <- []byte("Board need to be specified in core:architecture:name format")
return false, "", nil
}
tempPath := (filepath.Dir(execPath) + "/" + boardFields[0] + "/hardware/" + boardFields[1] + "/boards.txt")
file, err := os.Open(tempPath)
if err != nil {
//h.broadcastSys <- []byte("Could not find board: " + boardname)
log.Println("Error:", err)
mapD := map[string]string{"ProgrammerStatus": "Error", "Msg": "Could not find board: " + boardname}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
return false, "", nil
}
scanner := bufio.NewScanner(file)
boardOptions := make(map[string]string)
uploadOptions := make(map[string]string)
for scanner.Scan() {
// map everything matching with boardname
if strings.Contains(scanner.Text(), boardFields[2]) {
arr := strings.Split(scanner.Text(), "=")
arr[0] = strings.Replace(arr[0], boardFields[2]+".", "", 1)
boardOptions[arr[0]] = arr[1]
}
}
if len(boardOptions) == 0 {
errmsg := "Board " + boardFields[2] + " is not part of " + boardFields[0] + ":" + boardFields[1]
mapD := map[string]string{"ProgrammerStatus": "Error", "Msg": errmsg}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
return false, "", nil
}
boardOptions["serial.port"] = portname
boardOptions["serial.port.file"] = filepath.Base(portname)
// filepath need special care; the project_name var is the filename minus its extension (hex or bin)
// if we are going to modify standard IDE files we also could pass ALL filename
filePath = strings.Trim(filePath, "\n")
boardOptions["build.path"] = filepath.Dir(filePath)
boardOptions["build.project_name"] = strings.TrimSuffix(filepath.Base(filePath), filepath.Ext(filepath.Base(filePath)))
file.Close()
// get infos about the programmer
tempPath = (filepath.Dir(execPath) + "/" + boardFields[0] + "/hardware/" + boardFields[1] + "/platform.txt")
file, err = os.Open(tempPath)
if err != nil {
errmsg := "Could not find board: " + boardname
log.Println("Error:", err)
mapD := map[string]string{"ProgrammerStatus": "Error", "Msg": errmsg}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
return false, "", nil
}
scanner = bufio.NewScanner(file)
tool := boardOptions["upload.tool"]
for scanner.Scan() {
// map everything matching with upload
if strings.Contains(scanner.Text(), tool) {
arr := strings.Split(scanner.Text(), "=")
uploadOptions[arr[0]] = arr[1]
arr[0] = strings.Replace(arr[0], "tools."+tool+".", "", 1)
boardOptions[arr[0]] = arr[1]
// we have a "=" in command line
if len(arr) > 2 {
boardOptions[arr[0]] = arr[1] + "=" + arr[2]
}
}
}
file.Close()
// multiple verisons of the same programmer can be handled if "version" is specified
version := uploadOptions["runtime.tools."+tool+".version"]
path := (filepath.Dir(execPath) + "/" + boardFields[0] + "/tools/" + tool + "/" + version)
if err != nil {
errmsg := "Could not find board: " + boardname
log.Println("Error:", err)
mapD := map[string]string{"ProgrammerStatus": "Error", "Msg": errmsg}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
return false, "", nil
}
boardOptions["runtime.tools."+tool+".path"] = path
cmdline := boardOptions["upload.pattern"]
// remove cmd.path as it is handled differently
cmdline = strings.Replace(cmdline, "\"{cmd.path}\"", " ", 1)
cmdline = strings.Replace(cmdline, "\"{path}/{cmd}\"", " ", 1)
cmdline = strings.Replace(cmdline, "\"", "", -1)
initialPortName := portname
// some boards (eg. Leonardo, Yun) need a special procedure to enter bootloader
if boardOptions["upload.use_1200bps_touch"] == "true" {
// triggers bootloader mode
// the portname could change in this occasion, so fail gently
log.Println("Restarting in bootloader mode")
mode := &serial.Mode{
BaudRate: 1200,
Vmin: 1,
Vtimeout: 0,
}
port, err := serial.OpenPort(portname, mode)
if err != nil {
log.Println(err)
mapD := map[string]string{"ProgrammerStatus": "Error", "Msg": err.Error()}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
return false, "", nil
}
log.Println("Was able to open port in 1200 baud mode")
//port.SetDTR(false)
port.Close()
time.Sleep(time.Second / 2.0)
timeout := false
go func() {
time.Sleep(2 * time.Second)
timeout = true
}()
// time.Sleep(time.Second / 4)
// wait for port to reappear
if boardOptions["upload.wait_for_upload_port"] == "true" {
after_reset_ports, _ := serial.GetPortsList()
log.Println(after_reset_ports)
var ports []string
for {
ports, _ = serial.GetPortsList()
log.Println(ports)
time.Sleep(time.Millisecond * 200)
portname = findNewPortName(ports, after_reset_ports)
if portname != "" {
break
}
if timeout {
break
}
}
}
}
if portname == "" {
portname = initialPortName
}
// some boards (eg. TinyG) need a ctrl+x to enter bootloader
if boardOptions["upload.send_ctrl_x_to_enter_bootloader"] == "true" {
// triggers bootloader mode
// the portname could change in this occasion, so fail gently
log.Println("Sending ctrl+x to enter bootloader mode")
// Extra protection code to ensure we aren't getting called from multiple threads
if isRunning {
mapD := map[string]string{"AssembleStatus": "ThreadError", "Msg": "You tried to run a 2nd (or further) Ctrl+x prep command while the 1st one was already running."}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
return false, "", nil
}
isRunning = true
mode := &serial.Mode{
BaudRate: 115200,
Vmin: 1,
Vtimeout: 0,
}
port, err := serial.OpenPort(portname, mode)
if err != nil {
log.Println(err)
mapD := map[string]string{"ProgrammerStatus": "Error", "Msg": err.Error()}
mapB, _ := json.Marshal(mapD)
h.broadcastSys <- mapB
isRunning = false
return false, "", nil
}
log.Println("Was able to open port in 115200 baud mode for ctrl+x send")
port.Write([]byte(string(24))) // byte value which is ascii 24, ctrl+x
port.Close()
log.Println("Sent ctrl+x and then closed port. Go ahead and upload cuz we are in bootloader mode.")
}
isRunning = false
boardOptions["serial.port"] = portname
boardOptions["serial.port.file"] = filepath.Base(portname)
// split the commandline in substrings and recursively replace mapped strings
cmdlineSlice := strings.Split(cmdline, " ")
var winded = true
for index, _ := range cmdlineSlice {
winded = true
for winded != false {
cmdlineSlice[index], winded = formatCmdline(cmdlineSlice[index], boardOptions)
}
}
tool = (filepath.Dir(execPath) + "/" + boardFields[0] + "/tools/" + tool + "/bin/" + tool)
// the file doesn't exist, we are on windows
if _, err := os.Stat(tool); err != nil {
tool = tool + ".exe"
// convert all "/" to "\"
tool = strings.Replace(tool, "/", "\\", -1)
}
// remove blanks from cmdlineSlice
var cmdlineSliceOut []string
for _, element := range cmdlineSlice {
if element != "" {
cmdlineSliceOut = append(cmdlineSliceOut, element)
}
}
// add verbose
cmdlineSliceOut = append(cmdlineSliceOut, "-v")
log.Printf("Tool:%v, cmdline:%v\n", tool, cmdlineSliceOut)
return (tool != ""), tool, cmdlineSliceOut
}