feat: move serial port into new file

Author: dido18

serial.go

@@ -19,7 +19,6 @@ package main
 
 import (
 	"encoding/json"
-	"fmt"
 	"slices"
 	"strings"
 	"sync"
@@ -45,34 +44,6 @@ func newSerialHub() *serialhub {
 	}
 }
 
-type serialPortList struct {
-	tools *tools.Tools
-
-	Ports     []*SpPortItem
-	portsLock sync.Mutex
-
-	OnList func([]byte) `json:"-"`
-	OnErr  func(string) `json:"-"`
-}
-
-func newSerialPortList(tools *tools.Tools) *serialPortList {
-	return &serialPortList{tools: tools}
-}
-
-// SpPortItem is the serial port item
-type SpPortItem struct {
-	Name            string
-	SerialNumber    string
-	DeviceClass     string
-	IsOpen          bool
-	IsPrimary       bool
-	Baud            int
-	BufferAlgorithm string
-	Ver             string
-	VendorID        string
-	ProductID       string
-}
-
 // Register serial ports from the connections.
 func (sh *serialhub) Register(port *serport) {
 	sh.mu.Lock()
@@ -107,164 +78,6 @@ func (sh *serialhub) FindPortByName(portname string) (*serport, bool) {
 	return nil, false
 }
 
-// List broadcasts a Json representation of the ports found
-func (sp *serialPortList) List() {
-	sp.portsLock.Lock()
-	ls, err := json.MarshalIndent(sp, "", "\t")
-	sp.portsLock.Unlock()
-
-	if err != nil {
-		sp.OnErr("Error creating json on port list " + err.Error())
-	} else {
-		sp.OnList(ls)
-	}
-}
-
-// Run is the main loop for port discovery and management
-func (sp *serialPortList) Run() {
-	for retries := 0; retries < 10; retries++ {
-		sp.runSerialDiscovery()
-
-		logrus.Errorf("Serial discovery stopped working, restarting it in 10 seconds...")
-		time.Sleep(10 * time.Second)
-	}
-	logrus.Errorf("Failed restarting serial discovery. Giving up...")
-}
-
-func (sp *serialPortList) runSerialDiscovery() {
-	// First ensure that all the discoveries are available
-	noOpProgress := func(msg string) {}
-	if err := sp.tools.Download("builtin", "serial-discovery", "latest", "keep", noOpProgress); err != nil {
-		logrus.Errorf("Error downloading serial-discovery: %s", err)
-		panic(err)
-	}
-	sd, err := sp.tools.GetLocation("serial-discovery")
-	if err != nil {
-		logrus.Errorf("Error downloading serial-discovery: %s", err)
-		panic(err)
-	}
-	d := discovery.NewClient("serial", sd+"/serial-discovery")
-	dLogger := logrus.WithField("discovery", "serial")
-	if *verbose {
-		d.SetLogger(dLogger)
-	}
-	d.SetUserAgent("arduino-create-agent/" + version)
-	if err := d.Run(); err != nil {
-		logrus.Errorf("Error running serial-discovery: %s", err)
-		panic(err)
-	}
-	defer d.Quit()
-
-	events, err := d.StartSync(10)
-	if err != nil {
-		logrus.Errorf("Error starting event watcher on serial-discovery: %s", err)
-		panic(err)
-	}
-
-	logrus.Infof("Serial discovery started, watching for events")
-	for ev := range events {
-		logrus.WithField("event", ev).Debugf("Serial discovery event")
-		switch ev.Type {
-		case "add":
-			sp.add(ev.Port)
-		case "remove":
-			sp.remove(ev.Port)
-		}
-	}
-
-	sp.reset()
-	logrus.Errorf("Serial discovery stopped.")
-}
-
-func (sp *serialPortList) reset() {
-	sp.portsLock.Lock()
-	defer sp.portsLock.Unlock()
-	sp.Ports = []*SpPortItem{}
-}
-
-func (sp *serialPortList) add(addedPort *discovery.Port) {
-	if addedPort.Protocol != "serial" {
-		return
-	}
-	props := addedPort.Properties
-	if !props.ContainsKey("vid") {
-		return
-	}
-	vid, pid := props.Get("vid"), props.Get("pid")
-	if vid == "0x0000" || pid == "0x0000" {
-		return
-	}
-	if portsFilter != nil && !portsFilter.MatchString(addedPort.Address) {
-		logrus.Debugf("ignoring port not matching filter. port: %v\n", addedPort.Address)
-		return
-	}
-
-	sp.portsLock.Lock()
-	defer sp.portsLock.Unlock()
-
-	// If the port is already in the list, just update the metadata...
-	for _, oldPort := range sp.Ports {
-		fmt.Println("oldPort.Name: ", oldPort.Name)
-		if oldPort.Name == addedPort.Address {
-			oldPort.SerialNumber = props.Get("serialNumber")
-			oldPort.VendorID = vid
-			oldPort.ProductID = pid
-			return
-		}
-	}
-	// ...otherwise, add it to the list
-	sp.Ports = append(sp.Ports, &SpPortItem{
-		Name:            addedPort.Address,
-		SerialNumber:    props.Get("serialNumber"),
-		VendorID:        vid,
-		ProductID:       pid,
-		Ver:             version,
-		IsOpen:          false,
-		IsPrimary:       false,
-		Baud:            0,
-		BufferAlgorithm: "",
-	})
-}
-
-func (sp *serialPortList) remove(removedPort *discovery.Port) {
-	sp.portsLock.Lock()
-	defer sp.portsLock.Unlock()
-
-	// Remove the port from the list
-	sp.Ports = slices.DeleteFunc(sp.Ports, func(oldPort *SpPortItem) bool {
-		return oldPort.Name == removedPort.Address
-	})
-}
-
-// MarkPortAsOpened marks a port as opened by the user
-func (sp *serialPortList) MarkPortAsOpened(portname string) {
-	sp.portsLock.Lock()
-	defer sp.portsLock.Unlock()
-	port := sp.getPortByName(portname)
-	if port != nil {
-		port.IsOpen = true
-	}
-}
-
-// MarkPortAsClosed marks a port as no more opened by the user
-func (sp *serialPortList) MarkPortAsClosed(portname string) {
-	sp.portsLock.Lock()
-	defer sp.portsLock.Unlock()
-	port := sp.getPortByName(portname)
-	if port != nil {
-		port.IsOpen = false
-	}
-}
-
-func (sp *serialPortList) getPortByName(portname string) *SpPortItem {
-	for _, port := range sp.Ports {
-		if port.Name == portname {
-			return port
-		}
-	}
-	return nil
-}
-
 func (h *hub) spErr(err string) {
 	//log.Println("Sending err back: ", err)
 	//sh.hub.broadcastSys <- []byte(err)

serialport.go

@@ -62,7 +62,6 @@ type serport struct {
 	//bufferwatcher *BufferflowDummypause
 	bufferwatcher Bufferflow
 
-	// TODO: to remove global
 	OnMessage func([]byte)
 	OnClose   func(*serport)
 }
@@ -93,7 +92,6 @@ func (p *serport) reader(buftype string) {
 		if p.isClosing.Load() {
 			strmsg := "Shutting down reader on " + p.portConf.Name
 			log.Println(strmsg)
-			// h.broadcastSys <- ([]byte(strmsg)
 			p.OnMessage([]byte(strmsg))
 			break
 		}
@@ -148,18 +146,13 @@ func (p *serport) reader(buftype string) {
 			if err == io.EOF || err == io.ErrUnexpectedEOF {
 				// hit end of file
 				log.Println("Hit end of file on serial port")
-				// h.broadcastSys <- []byte("{\"Cmd\":\"OpenFail\",\"Desc\":\"Got EOF (End of File) on port which usually means another app other than Serial Port JSON Server is locking your port. " + err.Error() + "\",\"Port\":\"" + p.portConf.Name + "\",\"Baud\":" + strconv.Itoa(p.portConf.Baud) + "}")
 				p.OnMessage([]byte("{\"Cmd\":\"OpenFail\",\"Desc\":\"Got EOF (End of File) on port which usually means another app other than Serial Port JSON Server is locking your port. " + err.Error() + "\",\"Port\":\"" + p.portConf.Name + "\",\"Baud\":" + strconv.Itoa(p.portConf.Baud) + "}"))
 
 			}
 
 			if err != nil {
 				log.Println(err)
-				// h.broadcastSys <- []byte("Error reading on " + p.portConf.Name + " " +
-				// 	err.Error() + " Closing port.")
 				p.OnMessage([]byte("Error reading on " + p.portConf.Name + " " + err.Error() + " Closing port."))
-
-				// h.broadcastSys <- []byte("{\"Cmd\":\"OpenFail\",\"Desc\":\"Got error reading on port. " + err.Error() + "\",\"Port\":\"" + p.portConf.Name + "\",\"Baud\":" + strconv.Itoa(p.portConf.Baud) + "}")
 				p.OnMessage([]byte("{\"Cmd\":\"OpenFail\",\"Desc\":\"Got error reading on port. " + err.Error() + "\",\"Port\":\"" + p.portConf.Name + "\",\"Baud\":" + strconv.Itoa(p.portConf.Baud) + "}"))
 				p.isClosingDueToError = true
 				break
@@ -218,7 +211,6 @@ func (p *serport) writerBuffered() {
 	}
 	msgstr := "writerBuffered just got closed. make sure you make a new one. port:" + p.portConf.Name
 	log.Println(msgstr)
-	// h.broadcastSys <- []byte(msgstr)
 	p.OnMessage([]byte(msgstr))
 }
 
@@ -240,18 +232,17 @@ func (p *serport) writerNoBuf() {
 		if err != nil {
 			errstr := "Error writing to " + p.portConf.Name + " " + err.Error() + " Closing port."
 			log.Print(errstr)
-			// h.broadcastSys <- []byte(errstr)
 			p.OnMessage([]byte(errstr))
 			break
 		}
 	}
 	msgstr := "Shutting down writer on " + p.portConf.Name
 	log.Println(msgstr)
-	// h.broadcastSys <- []byte(msgstr)
 	p.OnMessage([]byte(msgstr))
+
 	p.portIo.Close()
-	// TODO: is this needed ?
-	// serialPorts.List()
+	// serialPorts.List(
+
 }
 
 // this method runs as its own thread because it's instantiated
@@ -283,7 +274,6 @@ func (p *serport) writerRaw() {
 	}
 	msgstr := "writerRaw just got closed. make sure you make a new one. port:" + p.portConf.Name
 	log.Println(msgstr)
-	// h.broadcastSys <- []byte(msgstr)
 	p.OnMessage([]byte(msgstr))
 }