21-peripherals-settings (#22)

Added the concept of peripheral settings.

Reviewed-on: #22

hardware/FTDIPeripheral.go

@@ -21,30 +21,31 @@ const (
 
 // FTDIPeripheral contains the data of an FTDI peripheral
 type FTDIPeripheral struct {
-	name            string         // The name of the peripheral
-	serialNumber    string         // The S/N of the FTDI peripheral
-	location        int            // The location of the peripheral
-	universesNumber int            // The number of DMX universes handled by this peripheral
-	programName     string         // The temp file name of the executable
-	dmxSender       *exec.Cmd      // The command to pilot the DMX sender program
-	stdin           io.WriteCloser // For writing in the DMX sender
-	stdout          io.ReadCloser  // For reading from the DMX sender
-	stderr          io.ReadCloser  // For reading the errors
-	disconnectChan  chan struct{}  // Channel to cancel the connection
-	errorsChan      chan error     // Channel to get the errors
+	name           string                 // The name of the peripheral
+	serialNumber   string                 // The S/N of the FTDI peripheral
+	location       int                    // The location of the peripheral
+	programName    string                 // The temp file name of the executable
+	settings       map[string]interface{} // The settings of the peripheral
+	dmxSender      *exec.Cmd              // The command to pilot the DMX sender program
+	stdin          io.WriteCloser         // For writing in the DMX sender
+	stdout         io.ReadCloser          // For reading from the DMX sender
+	stderr         io.ReadCloser          // For reading the errors
+	disconnectChan chan struct{}          // Channel to cancel the connection
+	errorsChan     chan error             // Channel to get the errors
 }
 
 // NewFTDIPeripheral creates a new FTDI peripheral
 func NewFTDIPeripheral(name string, serialNumber string, location int) (*FTDIPeripheral, error) {
 	log.Info().Str("file", "FTDIPeripheral").Str("name", name).Str("s/n", serialNumber).Int("location", location).Msg("FTDI peripheral created")
+	settings := make(map[string]interface{})
 	return &FTDIPeripheral{
-		name:            name,
-		dmxSender:       nil,
-		serialNumber:    serialNumber,
-		location:        location,
-		universesNumber: 1,
-		disconnectChan:  make(chan struct{}),
-		errorsChan:      make(chan error, 1),
+		name:           name,
+		dmxSender:      nil,
+		serialNumber:   serialNumber,
+		location:       location,
+		settings:       settings,
+		disconnectChan: make(chan struct{}),
+		errorsChan:     make(chan error, 1),
 	}, nil
 }
 
@@ -170,6 +171,12 @@ func (p *FTDIPeripheral) Deactivate(ctx context.Context) error {
 	return fmt.Errorf("unable to deactivate: not connected")
 }
 
+// SetPeripheralSettings sets a specific setting for this peripheral
+func (p *FTDIPeripheral) SetPeripheralSettings(settings map[string]interface{}) error {
+	p.settings = settings
+	return nil
+}
+
 // SetDeviceProperty sends a command to the specified device
 func (p *FTDIPeripheral) SetDeviceProperty(ctx context.Context, uint32, channelNumber uint32, channelValue byte) error {
 	if p.dmxSender != nil {
@@ -186,6 +193,11 @@ func (p *FTDIPeripheral) SetDeviceProperty(ctx context.Context, uint32, channelN
 	return fmt.Errorf("unable to set device property: not connected")
 }
 
+// GetSettings gets the peripheral settings
+func (p *FTDIPeripheral) GetSettings() map[string]interface{} {
+	return p.settings
+}
+
 // GetInfo gets all the peripheral information
 func (p *FTDIPeripheral) GetInfo() PeripheralInfo {
 	return PeripheralInfo{

hardware/MIDIPeripheral.go

@@ -8,18 +8,21 @@ import (
 
 // MIDIPeripheral contains the data of a MIDI peripheral
 type MIDIPeripheral struct {
-	name         string // The name of the peripheral
-	location     int    // The location of the peripheral
-	serialNumber string // The S/N of the peripheral
+	name         string                 // The name of the peripheral
+	location     int                    // The location of the peripheral
+	serialNumber string                 // The S/N of the peripheral
+	settings     map[string]interface{} // The settings of the peripheral
 }
 
 // NewMIDIPeripheral creates a new MIDI peripheral
 func NewMIDIPeripheral(name string, location int, serialNumber string) *MIDIPeripheral {
 	log.Trace().Str("file", "MIDIPeripheral").Str("name", name).Str("s/n", serialNumber).Int("location", location).Msg("MIDI peripheral created")
+	settings := make(map[string]interface{})
 	return &MIDIPeripheral{
 		name:         name,
 		location:     location,
 		serialNumber: serialNumber,
+		settings:     settings,
 	}
 }
 
@@ -43,11 +46,22 @@ func (p *MIDIPeripheral) Deactivate(ctx context.Context) error {
 	return nil
 }
 
+// SetPeripheralSettings sets a specific setting for this peripheral
+func (p *MIDIPeripheral) SetPeripheralSettings(settings map[string]interface{}) error {
+	p.settings = settings
+	return nil
+}
+
 // SetDeviceProperty - not implemented for this kind of peripheral
 func (p *MIDIPeripheral) SetDeviceProperty(context.Context, uint32, uint32, byte) error {
 	return nil
 }
 
+// GetSettings gets the peripheral settings
+func (p *MIDIPeripheral) GetSettings() map[string]interface{} {
+	return p.settings
+}
+
 // GetInfo gets the peripheral information
 func (p *MIDIPeripheral) GetInfo() PeripheralInfo {
 	return PeripheralInfo{

hardware/OS2LPeripheral.go

@@ -2,6 +2,7 @@ package hardware
 
 import (
 	"context"
+	"fmt"
 
 	"github.com/rs/zerolog/log"
 )
@@ -10,6 +11,8 @@ import (
 type OS2LPeripheral struct {
 	name         string // The name of the peripheral
 	serialNumber string // The serial number of the peripheral
+	serverIP     string // OS2L server IP
+	serverPort   int    // OS2L server port
 }
 
 // NewOS2LPeripheral creates a new OS2L peripheral
@@ -17,6 +20,8 @@ func NewOS2LPeripheral(name string, serialNumber string) *OS2LPeripheral {
 	log.Trace().Str("file", "OS2LPeripheral").Str("name", name).Str("s/n", serialNumber).Msg("OS2L peripheral created")
 	return &OS2LPeripheral{
 		name:         name,
+		serverIP:     "127.0.0.1",
+		serverPort:   9995,
 		serialNumber: serialNumber,
 	}
 }
@@ -45,11 +50,49 @@ func (p *OS2LPeripheral) Deactivate(ctx context.Context) error {
 	return nil
 }
 
+// SetPeripheralSettings sets a specific setting for this peripheral
+func (p *OS2LPeripheral) SetPeripheralSettings(settings map[string]interface{}) error {
+	// Check if the IP exists
+	serverIP, found := settings["os2lIp"]
+	if !found {
+		return fmt.Errorf("Unable to find the OS2L server IP")
+	}
+	// Check if it is a string
+	ipSetting, ok := serverIP.(string)
+	if ok {
+		p.serverIP = ipSetting
+
+	} else {
+		return fmt.Errorf("The specified IP is not a string")
+	}
+	// Check if the port exists
+	serverPort, found := settings["os2lPort"]
+	if !found {
+		return fmt.Errorf("Unable to find the OS2L server port")
+	}
+	// Check if it is a float and convert to int
+	portFloat, ok := serverPort.(float64)
+	if ok {
+		p.serverPort = int(portFloat)
+	} else {
+		return fmt.Errorf("The specified port is not an int")
+	}
+	return nil
+}
+
 // SetDeviceProperty - not implemented for this kind of peripheral
 func (p *OS2LPeripheral) SetDeviceProperty(context.Context, uint32, uint32, byte) error {
 	return nil
 }
 
+// GetSettings gets the peripheral settings
+func (p *OS2LPeripheral) GetSettings() map[string]interface{} {
+	return map[string]interface{}{
+		"os2lIp":   p.serverIP,
+		"os2lPort": p.serverPort,
+	}
+}
+
 // GetInfo gets the peripheral information
 func (p *OS2LPeripheral) GetInfo() PeripheralInfo {
 	return PeripheralInfo{

hardware/interfaces.go

@@ -8,17 +8,19 @@ type Peripheral interface {
 	Disconnect(context.Context) error                              // Disconnect the peripheral
 	Activate(context.Context) error                                // Activate the peripheral
 	Deactivate(context.Context) error                              // Deactivate the peripheral
+	SetPeripheralSettings(map[string]interface{}) error            // Set a peripheral setting
 	SetDeviceProperty(context.Context, uint32, uint32, byte) error // Update a device property
 
-	GetInfo() PeripheralInfo // Get the peripheral information
+	GetInfo() PeripheralInfo             // Get the peripheral information
+	GetSettings() map[string]interface{} // Get the peripheral settings
 }
 
 // PeripheralInfo represents a peripheral information
 type PeripheralInfo struct {
-	Name         string        `yaml:"name"`     // Name of the peripheral
-	SerialNumber string        `yaml:"sn"`       // S/N of the peripheral
-	ProtocolName string        `yaml:"protocol"` // Protocol name of the peripheral
-	Settings     []interface{} `yaml:"settings"` // Number of DMX universes handled by the peripheral
+	Name         string                 `yaml:"name"`     // Name of the peripheral
+	SerialNumber string                 `yaml:"sn"`       // S/N of the peripheral
+	ProtocolName string                 `yaml:"protocol"` // Protocol name of the peripheral
+	Settings     map[string]interface{} `yaml:"settings"` // Peripheral settings
 }
 
 // PeripheralFinder represents how compatible peripheral drivers are implemented