package hardware

import "context"

// Peripheral represents the methods used to manage a peripheral (input or output hardware)
type Peripheral interface {
	Connect(context.Context) error                                 // Connect the peripheral
	Disconnect(context.Context) error                              // Disconnect the peripheral
	Activate(context.Context) error                                // Activate the peripheral
	Deactivate(context.Context) error                              // Deactivate the peripheral
	SetSettings(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
	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     map[string]interface{} `yaml:"settings"` // Peripheral settings
}

// PeripheralFinder represents how compatible peripheral drivers are implemented
type PeripheralFinder interface {
	Initialize() error                                                  // Initializes the protocol
	Start(context.Context) error                                        // Start the detection
	Stop() error                                                        // Stop the detection
	ForceScan()                                                         // Explicitly scans for peripherals
	RegisterPeripheral(context.Context, PeripheralInfo) (string, error) // Registers a new peripheral data
	UnregisterPeripheral(context.Context, string) error                 // Unregisters an existing peripheral
	GetPeripheralSettings(string) (map[string]interface{}, error)       // Gets the peripheral settings
	SetPeripheralSettings(string, map[string]interface{}) error         // Sets the peripheral settings
	GetName() string                                                    // Get the name of the finder
}