Fixes #89, refactors arduino lib list output 👍

Author: saniales

cmd/arduino_boards.go

@@ -13,6 +13,7 @@ import (
 	"github.com/bcmi-labs/arduino-modules/sketches"
 
 	"github.com/bcmi-labs/arduino-cli/cmd/formatter"
+	"github.com/bcmi-labs/arduino-cli/cmd/output"
 
 	"github.com/arduino/board-discovery"
 	"github.com/spf13/cobra"
@@ -48,6 +49,19 @@ func executeBoardListCommand(cmd *cobra.Command, args []string) {
 		formatter.PrintErrorMessage("Not accepting additional arguments")
 		os.Exit(errBadCall)
 	}
+
+	packageFolder, err := common.GetDefaultPkgFolder()
+	if err != nil {
+		formatter.PrintErrorMessage("Cannot Parse Board Index file")
+		os.Exit(errCoreConfig)
+	}
+
+	bs, err := boards.Find(packageFolder)
+	if err != nil {
+		formatter.PrintErrorMessage("Cannot Parse Board Index file")
+		os.Exit(errCoreConfig)
+	}
+
 	monitor := discovery.New(time.Millisecond)
 	monitor.Start()
 	duration, err := time.ParseDuration(arduinoBoardListFlags.SearchTimeout)
@@ -59,7 +73,7 @@ func executeBoardListCommand(cmd *cobra.Command, args []string) {
 			for {
 				select {
 				case <-stop:
-					fmt.Print("\r              ")
+					fmt.Print("\r              \r")
 					return
 				default:
 					fmt.Print("\rDiscovering.  ")
@@ -69,7 +83,6 @@ func executeBoardListCommand(cmd *cobra.Command, args []string) {
 					fmt.Print("\rDiscovering...")
 					time.Sleep(time.Millisecond * 500)
 				}
-
 			}
 		})
 
@@ -81,7 +94,9 @@ func executeBoardListCommand(cmd *cobra.Command, args []string) {
 	} else {
 		time.Sleep(duration)
 	}
-	formatter.Print(*monitor)
+
+	formatter.Print(output.NewBoardList(bs, monitor))
+
 	//monitor.Stop() //If called will slow like 1sec the program to close after print, with the same result (tested).
 	// it closes ungracefully, but at the end of the command we can't have races.
 }

cmd/output/board_structs.go

@@ -0,0 +1,126 @@
+/*
+ * This file is part of arduino-cli.
+ *
+ * arduino-cli is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2017 ARDUINO AG (http://www.arduino.cc/)
+ */
+
+package output
+
+import (
+	"fmt"
+
+	discovery "github.com/arduino/board-discovery"
+	"github.com/bcmi-labs/arduino-modules/boards"
+)
+
+// SerialBoardListItem represents a board connected using serial port.
+type SerialBoardListItem struct {
+	Name  string `json:"name,required"`
+	Fqbn  string `json:"fqbn,required"`
+	Port  string `json:"port,required"`
+	UsbID string `json:"usbID,reqiured"`
+}
+
+// NetworkBoardListItem represents a board connected via network.
+type NetworkBoardListItem struct {
+	Name     string `json:"name,required"`
+	Fqbn     string `json:"fqbn,required"`
+	Location string `json:"location,required"`
+}
+
+// BoardList is a list of attached boards.
+type BoardList struct {
+	SerialBoards  []SerialBoardListItem  `json:"serialBoards,required"`
+	NetworkBoards []NetworkBoardListItem `json:"networkBoards,required"`
+}
+
+func (bl *BoardList) String() string {
+	ret := fmt.Sprintln("DEVICES:") +
+		fmt.Sprintln("SERIAL:")
+	if len(bl.SerialBoards) == 0 {
+		ret += fmt.Sprintln("   <none>")
+	} else {
+		for _, item := range bl.SerialBoards {
+			ret += fmt.Sprintln(" - BOARD NAME:", item.Name) +
+				fmt.Sprintln("   FQBN:", item.Fqbn) +
+				fmt.Sprintln("   PORT:", item.Port) +
+				fmt.Sprintln("   USB ID:", item.UsbID)
+		}
+	}
+	ret += fmt.Sprintln("NETWORK:")
+	if len(bl.NetworkBoards) == 0 {
+		ret += fmt.Sprintln("   <none>")
+	} else {
+		for _, item := range bl.NetworkBoards {
+			ret += fmt.Sprintln(" - BOARD NAME:", item.Name) +
+				fmt.Sprintln("   FQBN:", item.Fqbn) +
+				fmt.Sprintln("   LOCATION:", item.Location)
+		}
+	}
+	return ret
+}
+
+// NewBoardList returns a new board list by adding discovered boards from the board list and a monitor.
+func NewBoardList(boards boards.Boards, monitor *discovery.Monitor) *BoardList {
+	if monitor == nil || boards == nil {
+		return nil
+	}
+
+	serialDevices := monitor.Serial()
+	networkDevices := monitor.Network()
+	ret := &BoardList{
+		SerialBoards:  make([]SerialBoardListItem, 0, len(serialDevices)),
+		NetworkBoards: make([]NetworkBoardListItem, 0, len(networkDevices)),
+	}
+
+	for _, item := range serialDevices {
+		board := boards.ByVidPid(item.VendorID, item.ProductID)
+		if board == nil { // skip it if not recognized
+			continue
+		}
+
+		ret.SerialBoards = append(ret.SerialBoards, SerialBoardListItem{
+			Name:  board.Name,
+			Fqbn:  board.Fqbn,
+			Port:  item.Port,
+			UsbID: fmt.Sprintf("%s:%s - %s", item.ProductID[2:len(item.ProductID)-1], item.VendorID[2:len(item.VendorID)-1], item.SerialNumber),
+		})
+	}
+
+	for _, item := range networkDevices {
+		board := boards.ByID(item.Name)
+		if board == nil { // skip it if not recognized
+			continue
+		}
+
+		ret.NetworkBoards = append(ret.NetworkBoards, NetworkBoardListItem{
+			Name:     board.Name,
+			Fqbn:     board.Fqbn,
+			Location: fmt.Sprintf("%s:%d", item.Address, item.Port),
+		})
+	}
+	return ret
+}