feat(pkg/board): expose board name and name (#452)

Author: lucarin91

cmd/arduino-app-cli/fs/fs.go cmd/arduino-app-cli/board/board.gocmd/arduino-app-cli/fs/fs.go renamed to cmd/arduino-app-cli/board/board.go

@@ -1,4 +1,4 @@
-package fs
+package board
 
 import (
 	"context"
@@ -19,12 +19,13 @@ const boardHomePath = "/home/arduino"
 type contextKey string
 
 const remoteConnKey contextKey = "remoteConn"
+const boardsListKey contextKey = "boardsList"
 
-func NewFSCmd() *cobra.Command {
+func NewBoardCmd() *cobra.Command {
 	var fqbn, host string
 	fsCmd := &cobra.Command{
-		Use:   "fs",
-		Short: "Manage board fs",
+		Use:   "board",
+		Short: "Manage boards",
 		Long:  "",
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
 			if host != "" {
@@ -43,13 +44,13 @@ func NewFSCmd() *cobra.Command {
 			if len(boards) == 0 {
 				panic(fmt.Errorf("no boards found for FQBN %s", fqbn))
 			}
-			conn, err := boards[0].Connect()
+			conn, err := boards[0].GetConnection()
 			if err != nil {
 				panic(fmt.Errorf("failed to connect to board: %w", err))
 			}
 
 			cmd.SetContext(context.WithValue(cmd.Context(), remoteConnKey, conn))
-
+			cmd.SetContext(context.WithValue(cmd.Context(), boardsListKey, boards))
 		},
 	}
 	fsCmd.PersistentFlags().StringVarP(&fqbn, "fqbn", "b", "arduino:zephyr:unoq", "fqbn of the board")
@@ -58,6 +59,8 @@ func NewFSCmd() *cobra.Command {
 	fsCmd.AddCommand(newPushCmd())
 	fsCmd.AddCommand(newPullCmd())
 	fsCmd.AddCommand(newSyncAppCmd())
+	fsCmd.AddCommand(newBoardListCmd())
+	fsCmd.AddCommand(newBoardSetName())
 
 	return fsCmd
 }
@@ -99,3 +102,48 @@ func newSyncAppCmd() *cobra.Command {
 
 	return syncAppCmd
 }
+
+func newBoardListCmd() *cobra.Command {
+	listCmd := &cobra.Command{
+		Use:   "list",
+		Short: "List available boards",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			boards := cmd.Context().Value(boardsListKey).([]board.Board)
+			for _, b := range boards {
+				var address string
+				switch b.Protocol {
+				case board.SerialProtocol:
+					address = b.Serial
+				case board.NetworkProtocol:
+					address = b.Address
+				default:
+					panic("unreachable")
+				}
+				feedback.Printf("%s (%s) - Connection: %s [%s]\n", b.BoardName, b.CustomName, b.Protocol, address)
+			}
+			return nil
+		},
+	}
+
+	return listCmd
+}
+
+func newBoardSetName() *cobra.Command {
+	setNameCmd := &cobra.Command{
+		Use:   "set-name <name>",
+		Short: "Set the custom name of the board",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			conn := cmd.Context().Value(remoteConnKey).(remote.RemoteConn)
+			name := args[0]
+
+			if err := board.SetCustomName(cmd.Context(), conn, name); err != nil {
+				return fmt.Errorf("failed to set custom name: %w", err)
+			}
+			feedback.Printf("Custom name set to %q\n", name)
+			return nil
+		},
+	}
+
+	return setNameCmd
+}

cmd/arduino-app-cli/fs/pull.go cmd/arduino-app-cli/board/pull.gocmd/arduino-app-cli/fs/pull.go renamed to cmd/arduino-app-cli/board/pull.go

@@ -1,4 +1,4 @@
-package fs
+package board
 
 import (
 	"fmt"

cmd/arduino-app-cli/fs/push.go cmd/arduino-app-cli/board/push.gocmd/arduino-app-cli/fs/push.go renamed to cmd/arduino-app-cli/board/push.go

@@ -1,4 +1,4 @@
-package fs
+package board
 
 import (
 	"fmt"

cmd/arduino-app-cli/main.go

@@ -11,11 +11,11 @@ import (
 	"go.bug.st/cleanup"
 
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/app"
+	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/board"
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/brick"
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/completion"
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/config"
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/daemon"
-	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/fs"
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/internal/servicelocator"
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/properties"
 	"github.com/bcmi-labs/orchestrator/cmd/arduino-app-cli/system"
@@ -58,7 +58,7 @@ func main() {
 		properties.NewPropertiesCmd(),
 		config.NewConfigCmd(),
 		system.NewSystemCmd(),
-		fs.NewFSCmd(),
+		board.NewBoardCmd(),
 		version.NewVersionCmd(Version),
 	)
 

pkg/board/board.go

@@ -1,9 +1,12 @@
 package board
 
 import (
+	"bytes"
 	"context"
 	"fmt"
+	"io"
 	"log/slog"
+	"regexp"
 	"slices"
 	"strings"
 
@@ -18,10 +21,11 @@ import (
 )
 
 type Board struct {
-	// TODO: add fields for allowing identification
-	Protocol string
-	Serial   string
-	Address  string
+	Protocol   string
+	Serial     string
+	Address    string
+	CustomName string
+	BoardName  string
 }
 
 const (
@@ -70,17 +74,25 @@ func FromFQBN(ctx context.Context, fqbn string) ([]Board, error) {
 			if port.GetPort() == nil {
 				continue
 			}
+
+			var boardName string
+			if len(port.GetMatchingBoards()) > 0 {
+				boardName = port.GetMatchingBoards()[0].GetName()
+			}
+
 			switch port.GetPort().GetProtocol() {
 			case SerialProtocol:
 				serial := strings.ToLower(port.GetPort().GetHardwareId()) // in windows this is uppercase.
 				boards = append(boards, Board{
-					Protocol: SerialProtocol,
-					Serial:   serial,
+					Protocol:  SerialProtocol,
+					Serial:    serial,
+					BoardName: boardName,
 				})
 			case NetworkProtocol:
 				boards = append(boards, Board{
-					Protocol: NetworkProtocol,
-					Address:  port.GetPort().GetAddress(),
+					Protocol:  NetworkProtocol,
+					Address:   port.GetPort().GetAddress(),
+					BoardName: boardName,
 				})
 			default:
 				slog.Warn("unknown protocol", "protocol", port.GetPort().GetProtocol())
@@ -96,13 +108,29 @@ func FromFQBN(ctx context.Context, fqbn string) ([]Board, error) {
 			}
 		})
 
+		// Get board names
+		for i := range boards {
+			switch boards[i].Protocol {
+			case SerialProtocol:
+				// TODO: we should store the board custom name in the product id so we can get it from the discovery service.
+				var name string
+				if conn, err := adb.FromSerial(boards[i].Serial, ""); err == nil {
+					if name, err = GetCustomName(ctx, conn); err == nil {
+						boards[i].CustomName = name
+					}
+				}
+			case NetworkProtocol:
+				// TODO: get from mDNS
+			}
+		}
+
 		return boards, nil
 	}
 
 	return nil, fmt.Errorf("no hardware ID found for FQBN %s", fqbn)
 }
 
-func (b *Board) Connect() (remote.RemoteConn, error) {
+func (b *Board) GetConnection() (remote.RemoteConn, error) {
 	switch b.Protocol {
 	case SerialProtocol:
 		return adb.FromSerial(b.Serial, "")
@@ -114,6 +142,32 @@ func (b *Board) Connect() (remote.RemoteConn, error) {
 	}
 }
 
+var customNameRegex = regexp.MustCompile(`^[a-zA-Z0-9][a-zA-Z0-9-]{0,63}$`)
+
+func SetCustomName(ctx context.Context, conn remote.RemoteConn, name string) error {
+	if !customNameRegex.MatchString(name) {
+		return fmt.Errorf("invalid custom name: %s, must match regex %s", name, customNameRegex.String())
+	}
+
+	if err := conn.WriteFile(strings.NewReader(name), "/etc/hostname"); err != nil {
+		return fmt.Errorf("failed to set board name: %w", err)
+	}
+	return nil
+}
+
+func GetCustomName(ctx context.Context, conn remote.RemoteConn) (string, error) {
+	r, err := conn.ReadFile("/etc/hostname")
+	if err != nil {
+		return "", fmt.Errorf("failed to get board name: %w", err)
+	}
+	defer r.Close()
+	out, err := io.ReadAll(r)
+	if err != nil {
+		return "", fmt.Errorf("failed to read board name: %w", err)
+	}
+	return string(bytes.TrimSpace(out)), nil
+}
+
 func EnsurePlatformInstalled(ctx context.Context, rawFQBN string) error {
 	parsedFQBN, err := fqbn.Parse(rawFQBN)
 	if err != nil {