diff --git a/jsonrpc.go b/jsonrpc.go index 6b321c6db..a29fd7ed6 100644 --- a/jsonrpc.go +++ b/jsonrpc.go @@ -10,13 +10,11 @@ import ( "os/exec" "path/filepath" "reflect" - "strconv" "sync" "time" "github.com/pion/webrtc/v4" "github.com/rs/zerolog" - "go.bug.st/serial" "github.com/jetkvm/kvm/internal/hidrpc" "github.com/jetkvm/kvm/internal/usbgadget" @@ -772,6 +770,8 @@ func rpcSetActiveExtension(extensionId string) error { _ = unmountATXControl() case "dc-power": _ = unmountDCControl() + case "serial-buttons": + _ = unmountSerialButtons() } config.ActiveExtension = extensionId if err := SaveConfig(); err != nil { @@ -782,6 +782,8 @@ func rpcSetActiveExtension(extensionId string) error { _ = mountATXControl() case "dc-power": _ = mountDCControl() + case "serial-buttons": + _ = mountSerialButtons() } return nil } @@ -816,94 +818,84 @@ func rpcGetATXState() (ATXState, error) { return state, nil } -type SerialSettings struct { - BaudRate string `json:"baudRate"` - DataBits string `json:"dataBits"` - StopBits string `json:"stopBits"` - Parity string `json:"parity"` +func rpcSendCustomCommand(command string) error { + logger.Debug().Str("Command", command).Msg("JSONRPC: Sending custom serial command") + err := sendCustomCommand(command) + if err != nil { + return fmt.Errorf("failed to send custom command in jsonrpc: %w", err) + } + return nil } func rpcGetSerialSettings() (SerialSettings, error) { - settings := SerialSettings{ - BaudRate: strconv.Itoa(serialPortMode.BaudRate), - DataBits: strconv.Itoa(serialPortMode.DataBits), - StopBits: "1", - Parity: "none", - } + return getSerialSettings() +} + +func rpcSetSerialSettings(settings SerialSettings) error { + return setSerialSettings(settings) +} + +const SerialCommandHistoryPath = "/userdata/serialCommandHistory.json" - switch serialPortMode.StopBits { - case serial.OneStopBit: - settings.StopBits = "1" - case serial.OnePointFiveStopBits: - settings.StopBits = "1.5" - case serial.TwoStopBits: - settings.StopBits = "2" +func rpcGetSerialCommandHistory() ([]string, error) { + items := []string{} + + file, err := os.Open(SerialCommandHistoryPath) + if err != nil { + logger.Debug().Msg("SerialCommandHistory file doesn't exist, using default") + return items, nil } + defer file.Close() - switch serialPortMode.Parity { - case serial.NoParity: - settings.Parity = "none" - case serial.OddParity: - settings.Parity = "odd" - case serial.EvenParity: - settings.Parity = "even" - case serial.MarkParity: - settings.Parity = "mark" - case serial.SpaceParity: - settings.Parity = "space" + // load and merge the default config with the user config + var loadedItems []string + if err := json.NewDecoder(file).Decode(&loadedItems); err != nil { + logger.Warn().Err(err).Msg("SerialCommandHistory file JSON parsing failed") + return items, nil } - return settings, nil + return loadedItems, nil } -var serialPortMode = defaultMode +func rpcSetSerialCommandHistory(commandHistory []string) error { + logger.Trace().Str("path", SerialCommandHistoryPath).Msg("Saving serial command history") -func rpcSetSerialSettings(settings SerialSettings) error { - baudRate, err := strconv.Atoi(settings.BaudRate) + file, err := os.Create(SerialCommandHistoryPath) if err != nil { - return fmt.Errorf("invalid baud rate: %v", err) + return fmt.Errorf("failed to create SerialCommandHistory file: %w", err) } - dataBits, err := strconv.Atoi(settings.DataBits) - if err != nil { - return fmt.Errorf("invalid data bits: %v", err) + defer file.Close() + + encoder := json.NewEncoder(file) + encoder.SetIndent("", " ") + if err := encoder.Encode(commandHistory); err != nil { + return fmt.Errorf("failed to encode SerialCommandHistory: %w", err) } - var stopBits serial.StopBits - switch settings.StopBits { - case "1": - stopBits = serial.OneStopBit - case "1.5": - stopBits = serial.OnePointFiveStopBits - case "2": - stopBits = serial.TwoStopBits - default: - return fmt.Errorf("invalid stop bits: %s", settings.StopBits) - } - - var parity serial.Parity - switch settings.Parity { - case "none": - parity = serial.NoParity - case "odd": - parity = serial.OddParity - case "even": - parity = serial.EvenParity - case "mark": - parity = serial.MarkParity - case "space": - parity = serial.SpaceParity - default: - return fmt.Errorf("invalid parity: %s", settings.Parity) + return nil +} + +func rpcDeleteSerialCommandHistory() error { + logger.Trace().Str("path", SerialCommandHistoryPath).Msg("Deleting serial command history") + empty := []string{} + + file, err := os.Create(SerialCommandHistoryPath) + if err != nil { + return fmt.Errorf("failed to create SerialCommandHistory file: %w", err) } - serialPortMode = &serial.Mode{ - BaudRate: baudRate, - DataBits: dataBits, - StopBits: stopBits, - Parity: parity, + defer file.Close() + + encoder := json.NewEncoder(file) + encoder.SetIndent("", " ") + if err := encoder.Encode(empty); err != nil { + return fmt.Errorf("failed to encode SerialCommandHistory: %w", err) } - _ = port.SetMode(serialPortMode) + return nil +} +func rpcSetTerminalPaused(terminalPaused bool) error { + setTerminalPaused(terminalPaused) return nil } @@ -1182,91 +1174,96 @@ func rpcDoExecuteKeyboardMacro(ctx context.Context, macro []hidrpc.KeyboardMacro } var rpcHandlers = map[string]RPCHandler{ - "ping": {Func: rpcPing}, - "reboot": {Func: rpcReboot, Params: []string{"force"}}, - "getDeviceID": {Func: rpcGetDeviceID}, - "deregisterDevice": {Func: rpcDeregisterDevice}, - "getCloudState": {Func: rpcGetCloudState}, - "getNetworkState": {Func: rpcGetNetworkState}, - "getNetworkSettings": {Func: rpcGetNetworkSettings}, - "setNetworkSettings": {Func: rpcSetNetworkSettings, Params: []string{"settings"}}, - "renewDHCPLease": {Func: rpcRenewDHCPLease}, - "getKeyboardLedState": {Func: rpcGetKeyboardLedState}, - "getKeyDownState": {Func: rpcGetKeysDownState}, - "keyboardReport": {Func: rpcKeyboardReport, Params: []string{"modifier", "keys"}}, - "keypressReport": {Func: rpcKeypressReport, Params: []string{"key", "press"}}, - "absMouseReport": {Func: rpcAbsMouseReport, Params: []string{"x", "y", "buttons"}}, - "relMouseReport": {Func: rpcRelMouseReport, Params: []string{"dx", "dy", "buttons"}}, - "wheelReport": {Func: rpcWheelReport, Params: []string{"wheelY"}}, - "getVideoState": {Func: rpcGetVideoState}, - "getUSBState": {Func: rpcGetUSBState}, - "unmountImage": {Func: rpcUnmountImage}, - "rpcMountBuiltInImage": {Func: rpcMountBuiltInImage, Params: []string{"filename"}}, - "setJigglerState": {Func: rpcSetJigglerState, Params: []string{"enabled"}}, - "getJigglerState": {Func: rpcGetJigglerState}, - "setJigglerConfig": {Func: rpcSetJigglerConfig, Params: []string{"jigglerConfig"}}, - "getJigglerConfig": {Func: rpcGetJigglerConfig}, - "getTimezones": {Func: rpcGetTimezones}, - "sendWOLMagicPacket": {Func: rpcSendWOLMagicPacket, Params: []string{"macAddress"}}, - "getStreamQualityFactor": {Func: rpcGetStreamQualityFactor}, - "setStreamQualityFactor": {Func: rpcSetStreamQualityFactor, Params: []string{"factor"}}, - "getAutoUpdateState": {Func: rpcGetAutoUpdateState}, - "setAutoUpdateState": {Func: rpcSetAutoUpdateState, Params: []string{"enabled"}}, - "getEDID": {Func: rpcGetEDID}, - "setEDID": {Func: rpcSetEDID, Params: []string{"edid"}}, - "getVideoLogStatus": {Func: rpcGetVideoLogStatus}, - "getVideoSleepMode": {Func: rpcGetVideoSleepMode}, - "setVideoSleepMode": {Func: rpcSetVideoSleepMode, Params: []string{"duration"}}, - "getDevChannelState": {Func: rpcGetDevChannelState}, - "setDevChannelState": {Func: rpcSetDevChannelState, Params: []string{"enabled"}}, - "getLocalVersion": {Func: rpcGetLocalVersion}, - "getUpdateStatus": {Func: rpcGetUpdateStatus}, - "tryUpdate": {Func: rpcTryUpdate}, - "getDevModeState": {Func: rpcGetDevModeState}, - "setDevModeState": {Func: rpcSetDevModeState, Params: []string{"enabled"}}, - "getSSHKeyState": {Func: rpcGetSSHKeyState}, - "setSSHKeyState": {Func: rpcSetSSHKeyState, Params: []string{"sshKey"}}, - "getTLSState": {Func: rpcGetTLSState}, - "setTLSState": {Func: rpcSetTLSState, Params: []string{"state"}}, - "setMassStorageMode": {Func: rpcSetMassStorageMode, Params: []string{"mode"}}, - "getMassStorageMode": {Func: rpcGetMassStorageMode}, - "isUpdatePending": {Func: rpcIsUpdatePending}, - "getUsbEmulationState": {Func: rpcGetUsbEmulationState}, - "setUsbEmulationState": {Func: rpcSetUsbEmulationState, Params: []string{"enabled"}}, - "getUsbConfig": {Func: rpcGetUsbConfig}, - "setUsbConfig": {Func: rpcSetUsbConfig, Params: []string{"usbConfig"}}, - "checkMountUrl": {Func: rpcCheckMountUrl, Params: []string{"url"}}, - "getVirtualMediaState": {Func: rpcGetVirtualMediaState}, - "getStorageSpace": {Func: rpcGetStorageSpace}, - "mountWithHTTP": {Func: rpcMountWithHTTP, Params: []string{"url", "mode"}}, - "mountWithStorage": {Func: rpcMountWithStorage, Params: []string{"filename", "mode"}}, - "listStorageFiles": {Func: rpcListStorageFiles}, - "deleteStorageFile": {Func: rpcDeleteStorageFile, Params: []string{"filename"}}, - "startStorageFileUpload": {Func: rpcStartStorageFileUpload, Params: []string{"filename", "size"}}, - "getWakeOnLanDevices": {Func: rpcGetWakeOnLanDevices}, - "setWakeOnLanDevices": {Func: rpcSetWakeOnLanDevices, Params: []string{"params"}}, - "resetConfig": {Func: rpcResetConfig}, - "setDisplayRotation": {Func: rpcSetDisplayRotation, Params: []string{"params"}}, - "getDisplayRotation": {Func: rpcGetDisplayRotation}, - "setBacklightSettings": {Func: rpcSetBacklightSettings, Params: []string{"params"}}, - "getBacklightSettings": {Func: rpcGetBacklightSettings}, - "getDCPowerState": {Func: rpcGetDCPowerState}, - "setDCPowerState": {Func: rpcSetDCPowerState, Params: []string{"enabled"}}, - "setDCRestoreState": {Func: rpcSetDCRestoreState, Params: []string{"state"}}, - "getActiveExtension": {Func: rpcGetActiveExtension}, - "setActiveExtension": {Func: rpcSetActiveExtension, Params: []string{"extensionId"}}, - "getATXState": {Func: rpcGetATXState}, - "setATXPowerAction": {Func: rpcSetATXPowerAction, Params: []string{"action"}}, - "getSerialSettings": {Func: rpcGetSerialSettings}, - "setSerialSettings": {Func: rpcSetSerialSettings, Params: []string{"settings"}}, - "getUsbDevices": {Func: rpcGetUsbDevices}, - "setUsbDevices": {Func: rpcSetUsbDevices, Params: []string{"devices"}}, - "setUsbDeviceState": {Func: rpcSetUsbDeviceState, Params: []string{"device", "enabled"}}, - "setCloudUrl": {Func: rpcSetCloudUrl, Params: []string{"apiUrl", "appUrl"}}, - "getKeyboardLayout": {Func: rpcGetKeyboardLayout}, - "setKeyboardLayout": {Func: rpcSetKeyboardLayout, Params: []string{"layout"}}, - "getKeyboardMacros": {Func: getKeyboardMacros}, - "setKeyboardMacros": {Func: setKeyboardMacros, Params: []string{"params"}}, - "getLocalLoopbackOnly": {Func: rpcGetLocalLoopbackOnly}, - "setLocalLoopbackOnly": {Func: rpcSetLocalLoopbackOnly, Params: []string{"enabled"}}, + "ping": {Func: rpcPing}, + "reboot": {Func: rpcReboot, Params: []string{"force"}}, + "getDeviceID": {Func: rpcGetDeviceID}, + "deregisterDevice": {Func: rpcDeregisterDevice}, + "getCloudState": {Func: rpcGetCloudState}, + "getNetworkState": {Func: rpcGetNetworkState}, + "getNetworkSettings": {Func: rpcGetNetworkSettings}, + "setNetworkSettings": {Func: rpcSetNetworkSettings, Params: []string{"settings"}}, + "renewDHCPLease": {Func: rpcRenewDHCPLease}, + "getKeyboardLedState": {Func: rpcGetKeyboardLedState}, + "getKeyDownState": {Func: rpcGetKeysDownState}, + "keyboardReport": {Func: rpcKeyboardReport, Params: []string{"modifier", "keys"}}, + "keypressReport": {Func: rpcKeypressReport, Params: []string{"key", "press"}}, + "absMouseReport": {Func: rpcAbsMouseReport, Params: []string{"x", "y", "buttons"}}, + "relMouseReport": {Func: rpcRelMouseReport, Params: []string{"dx", "dy", "buttons"}}, + "wheelReport": {Func: rpcWheelReport, Params: []string{"wheelY"}}, + "getVideoState": {Func: rpcGetVideoState}, + "getUSBState": {Func: rpcGetUSBState}, + "unmountImage": {Func: rpcUnmountImage}, + "rpcMountBuiltInImage": {Func: rpcMountBuiltInImage, Params: []string{"filename"}}, + "setJigglerState": {Func: rpcSetJigglerState, Params: []string{"enabled"}}, + "getJigglerState": {Func: rpcGetJigglerState}, + "setJigglerConfig": {Func: rpcSetJigglerConfig, Params: []string{"jigglerConfig"}}, + "getJigglerConfig": {Func: rpcGetJigglerConfig}, + "getTimezones": {Func: rpcGetTimezones}, + "sendWOLMagicPacket": {Func: rpcSendWOLMagicPacket, Params: []string{"macAddress"}}, + "getStreamQualityFactor": {Func: rpcGetStreamQualityFactor}, + "setStreamQualityFactor": {Func: rpcSetStreamQualityFactor, Params: []string{"factor"}}, + "getAutoUpdateState": {Func: rpcGetAutoUpdateState}, + "setAutoUpdateState": {Func: rpcSetAutoUpdateState, Params: []string{"enabled"}}, + "getEDID": {Func: rpcGetEDID}, + "setEDID": {Func: rpcSetEDID, Params: []string{"edid"}}, + "getVideoLogStatus": {Func: rpcGetVideoLogStatus}, + "getVideoSleepMode": {Func: rpcGetVideoSleepMode}, + "setVideoSleepMode": {Func: rpcSetVideoSleepMode, Params: []string{"duration"}}, + "getDevChannelState": {Func: rpcGetDevChannelState}, + "setDevChannelState": {Func: rpcSetDevChannelState, Params: []string{"enabled"}}, + "getLocalVersion": {Func: rpcGetLocalVersion}, + "getUpdateStatus": {Func: rpcGetUpdateStatus}, + "tryUpdate": {Func: rpcTryUpdate}, + "getDevModeState": {Func: rpcGetDevModeState}, + "setDevModeState": {Func: rpcSetDevModeState, Params: []string{"enabled"}}, + "getSSHKeyState": {Func: rpcGetSSHKeyState}, + "setSSHKeyState": {Func: rpcSetSSHKeyState, Params: []string{"sshKey"}}, + "getTLSState": {Func: rpcGetTLSState}, + "setTLSState": {Func: rpcSetTLSState, Params: []string{"state"}}, + "setMassStorageMode": {Func: rpcSetMassStorageMode, Params: []string{"mode"}}, + "getMassStorageMode": {Func: rpcGetMassStorageMode}, + "isUpdatePending": {Func: rpcIsUpdatePending}, + "getUsbEmulationState": {Func: rpcGetUsbEmulationState}, + "setUsbEmulationState": {Func: rpcSetUsbEmulationState, Params: []string{"enabled"}}, + "getUsbConfig": {Func: rpcGetUsbConfig}, + "setUsbConfig": {Func: rpcSetUsbConfig, Params: []string{"usbConfig"}}, + "checkMountUrl": {Func: rpcCheckMountUrl, Params: []string{"url"}}, + "getVirtualMediaState": {Func: rpcGetVirtualMediaState}, + "getStorageSpace": {Func: rpcGetStorageSpace}, + "mountWithHTTP": {Func: rpcMountWithHTTP, Params: []string{"url", "mode"}}, + "mountWithStorage": {Func: rpcMountWithStorage, Params: []string{"filename", "mode"}}, + "listStorageFiles": {Func: rpcListStorageFiles}, + "deleteStorageFile": {Func: rpcDeleteStorageFile, Params: []string{"filename"}}, + "startStorageFileUpload": {Func: rpcStartStorageFileUpload, Params: []string{"filename", "size"}}, + "getWakeOnLanDevices": {Func: rpcGetWakeOnLanDevices}, + "setWakeOnLanDevices": {Func: rpcSetWakeOnLanDevices, Params: []string{"params"}}, + "resetConfig": {Func: rpcResetConfig}, + "setDisplayRotation": {Func: rpcSetDisplayRotation, Params: []string{"params"}}, + "getDisplayRotation": {Func: rpcGetDisplayRotation}, + "setBacklightSettings": {Func: rpcSetBacklightSettings, Params: []string{"params"}}, + "getBacklightSettings": {Func: rpcGetBacklightSettings}, + "getDCPowerState": {Func: rpcGetDCPowerState}, + "setDCPowerState": {Func: rpcSetDCPowerState, Params: []string{"enabled"}}, + "setDCRestoreState": {Func: rpcSetDCRestoreState, Params: []string{"state"}}, + "getActiveExtension": {Func: rpcGetActiveExtension}, + "setActiveExtension": {Func: rpcSetActiveExtension, Params: []string{"extensionId"}}, + "getATXState": {Func: rpcGetATXState}, + "setATXPowerAction": {Func: rpcSetATXPowerAction, Params: []string{"action"}}, + "sendCustomCommand": {Func: rpcSendCustomCommand, Params: []string{"command"}}, + "getSerialSettings": {Func: rpcGetSerialSettings}, + "setSerialSettings": {Func: rpcSetSerialSettings, Params: []string{"settings"}}, + "getSerialCommandHistory": {Func: rpcGetSerialCommandHistory}, + "setSerialCommandHistory": {Func: rpcSetSerialCommandHistory, Params: []string{"commandHistory"}}, + "deleteSerialCommandHistory": {Func: rpcDeleteSerialCommandHistory}, + "setTerminalPaused": {Func: rpcSetTerminalPaused, Params: []string{"terminalPaused"}}, + "getUsbDevices": {Func: rpcGetUsbDevices}, + "setUsbDevices": {Func: rpcSetUsbDevices, Params: []string{"devices"}}, + "setUsbDeviceState": {Func: rpcSetUsbDeviceState, Params: []string{"device", "enabled"}}, + "setCloudUrl": {Func: rpcSetCloudUrl, Params: []string{"apiUrl", "appUrl"}}, + "getKeyboardLayout": {Func: rpcGetKeyboardLayout}, + "setKeyboardLayout": {Func: rpcSetKeyboardLayout, Params: []string{"layout"}}, + "getKeyboardMacros": {Func: getKeyboardMacros}, + "setKeyboardMacros": {Func: setKeyboardMacros, Params: []string{"params"}}, + "getLocalLoopbackOnly": {Func: rpcGetLocalLoopbackOnly}, + "setLocalLoopbackOnly": {Func: rpcSetLocalLoopbackOnly, Params: []string{"enabled"}}, } diff --git a/serial.go b/serial.go index 5439d135a..5d35147f3 100644 --- a/serial.go +++ b/serial.go @@ -2,7 +2,9 @@ package kvm import ( "bufio" - "io" + "encoding/json" + "fmt" + "os" "strconv" "strings" "time" @@ -14,6 +16,8 @@ import ( const serialPortPath = "/dev/ttyS3" var port serial.Port +var serialMux *SerialMux +var consoleBroker *ConsoleBroker func mountATXControl() error { _ = port.SetMode(defaultMode) @@ -251,6 +255,28 @@ func setDCRestoreState(state int) error { return nil } +func mountSerialButtons() error { + _ = port.SetMode(defaultMode) + return nil +} + +func unmountSerialButtons() error { + _ = reopenSerialPort() + return nil +} + +func sendCustomCommand(command string) error { + scopedLogger := serialLogger.With().Str("service", "custom_buttons_tx").Logger() + scopedLogger.Info().Str("Command", command).Msg("Sending custom command.") + scopedLogger.Info().Msgf("Sending custom command: %q", command) + if serialMux == nil { + return fmt.Errorf("serial mux not initialized") + } + payload := []byte(command) + serialMux.Enqueue(payload, "button", true) // echo if enabled + return nil +} + var defaultMode = &serial.Mode{ BaudRate: 115200, DataBits: 8, @@ -258,6 +284,271 @@ var defaultMode = &serial.Mode{ StopBits: serial.OneStopBit, } +var serialPortMode = defaultMode + +var serialConfig = SerialSettings{ + BaudRate: defaultMode.BaudRate, + DataBits: defaultMode.DataBits, + Parity: "none", + StopBits: "1", + Terminator: Terminator{Label: "LF (\\n)", Value: "\n"}, + HideSerialSettings: false, + EnableEcho: false, + NormalizeMode: "names", + NormalizeLineEnd: "keep", + PreserveANSI: true, + Buttons: []QuickButton{}, +} + +const serialSettingsPath = "/userdata/serialSettings.json" + +type Terminator struct { + Label string `json:"label"` // Terminator label + Value string `json:"value"` // Terminator value +} + +type QuickButton struct { + Id string `json:"id"` // Unique identifier + Label string `json:"label"` // Button label + Command string `json:"command"` // Command to send, raw command to send (without auto-terminator) + Terminator Terminator `json:"terminator"` // Terminator to use: None/CR/LF/CRLF/LFCR + Sort int `json:"sort"` // Sort order +} + +// Mode describes a serial port configuration. +type SerialSettings struct { + BaudRate int `json:"baudRate"` // The serial port bitrate (aka Baudrate) + DataBits int `json:"dataBits"` // Size of the character (must be 5, 6, 7 or 8) + Parity string `json:"parity"` // Parity (see Parity type for more info) + StopBits string `json:"stopBits"` // Stop bits (see StopBits type for more info) + Terminator Terminator `json:"terminator"` // Terminator to send after each command + HideSerialSettings bool `json:"hideSerialSettings"` // Whether to hide the serial settings in the UI + EnableEcho bool `json:"enableEcho"` // Whether to echo received characters back to the sender + NormalizeMode string `json:"normalizeMode"` // Normalization mode: "carret", "names", "hex" + NormalizeLineEnd string `json:"normalizeLineEnd"` // Line ending normalization: "keep", "lf", "cr", "crlf" + TabRender string `json:"tabRender"` // How to render tabs: "spaces", "arrow", "pipe" + PreserveANSI bool `json:"preserveANSI"` // Whether to preserve ANSI escape codes + ShowNLTag bool `json:"showNLTag"` // Whether to show a special tag for new lines + Buttons []QuickButton `json:"buttons"` // Custom quick buttons +} + +func getSerialSettings() (SerialSettings, error) { + + switch defaultMode.StopBits { + case serial.OneStopBit: + serialConfig.StopBits = "1" + case serial.OnePointFiveStopBits: + serialConfig.StopBits = "1.5" + case serial.TwoStopBits: + serialConfig.StopBits = "2" + } + + switch defaultMode.Parity { + case serial.NoParity: + serialConfig.Parity = "none" + case serial.OddParity: + serialConfig.Parity = "odd" + case serial.EvenParity: + serialConfig.Parity = "even" + case serial.MarkParity: + serialConfig.Parity = "mark" + case serial.SpaceParity: + serialConfig.Parity = "space" + } + + file, err := os.Open(serialSettingsPath) + if err != nil { + logger.Debug().Msg("SerialButtons config file doesn't exist, using default") + return serialConfig, err + } + defer file.Close() + + // load and merge the default config with the user config + var loadedConfig SerialSettings + if err := json.NewDecoder(file).Decode(&loadedConfig); err != nil { + logger.Warn().Err(err).Msg("SerialButtons config file JSON parsing failed") + return serialConfig, nil + } + + serialConfig = loadedConfig // Update global config + + // Apply settings to serial port, when opening the extension + var stopBits serial.StopBits + switch serialConfig.StopBits { + case "1": + stopBits = serial.OneStopBit + case "1.5": + stopBits = serial.OnePointFiveStopBits + case "2": + stopBits = serial.TwoStopBits + } + + var parity serial.Parity + switch serialConfig.Parity { + case "none": + parity = serial.NoParity + case "odd": + parity = serial.OddParity + case "even": + parity = serial.EvenParity + case "mark": + parity = serial.MarkParity + case "space": + parity = serial.SpaceParity + } + + serialPortMode = &serial.Mode{ + BaudRate: serialConfig.BaudRate, + DataBits: serialConfig.DataBits, + StopBits: stopBits, + Parity: parity, + } + + _ = port.SetMode(serialPortMode) + + if serialMux != nil { + serialMux.SetEchoEnabled(serialConfig.EnableEcho) + } + + var normalizeMode NormalizeMode + switch serialConfig.NormalizeMode { + case "carret": + normalizeMode = ModeCaret + case "names": + normalizeMode = ModeNames + case "hex": + normalizeMode = ModeHex + default: + normalizeMode = ModeNames + } + + var crlfMode CRLFMode + switch serialConfig.NormalizeLineEnd { + case "keep": + crlfMode = CRLFAsIs + case "lf": + crlfMode = CRLF_LF + case "cr": + crlfMode = CRLF_CR + case "crlf": + crlfMode = CRLF_CRLF + case "lfcr": + crlfMode = CRLF_LFCR + default: + crlfMode = CRLFAsIs + } + + if consoleBroker != nil { + norm := NormOptions{ + Mode: normalizeMode, CRLF: crlfMode, TabRender: serialConfig.TabRender, PreserveANSI: serialConfig.PreserveANSI, ShowNLTag: serialConfig.ShowNLTag, + } + consoleBroker.SetNormOptions(norm) + } + + return loadedConfig, nil +} + +func setSerialSettings(newSettings SerialSettings) error { + logger.Trace().Str("path", serialSettingsPath).Msg("Saving config") + + file, err := os.Create(serialSettingsPath) + if err != nil { + return fmt.Errorf("failed to create SerialButtons config file: %w", err) + } + defer file.Close() + + encoder := json.NewEncoder(file) + encoder.SetIndent("", " ") + if err := encoder.Encode(newSettings); err != nil { + return fmt.Errorf("failed to encode SerialButtons config: %w", err) + } + + var stopBits serial.StopBits + switch newSettings.StopBits { + case "1": + stopBits = serial.OneStopBit + case "1.5": + stopBits = serial.OnePointFiveStopBits + case "2": + stopBits = serial.TwoStopBits + default: + return fmt.Errorf("invalid stop bits: %s", newSettings.StopBits) + } + + var parity serial.Parity + switch newSettings.Parity { + case "none": + parity = serial.NoParity + case "odd": + parity = serial.OddParity + case "even": + parity = serial.EvenParity + case "mark": + parity = serial.MarkParity + case "space": + parity = serial.SpaceParity + default: + return fmt.Errorf("invalid parity: %s", newSettings.Parity) + } + serialPortMode = &serial.Mode{ + BaudRate: newSettings.BaudRate, + DataBits: newSettings.DataBits, + StopBits: stopBits, + Parity: parity, + } + + _ = port.SetMode(serialPortMode) + + serialConfig = newSettings // Update global config + + if serialMux != nil { + serialMux.SetEchoEnabled(serialConfig.EnableEcho) + } + + var normalizeMode NormalizeMode + switch serialConfig.NormalizeMode { + case "carret": + normalizeMode = ModeCaret + case "names": + normalizeMode = ModeNames + case "hex": + normalizeMode = ModeHex + default: + normalizeMode = ModeNames + } + + var crlfMode CRLFMode + switch serialConfig.NormalizeLineEnd { + case "keep": + crlfMode = CRLFAsIs + case "lf": + crlfMode = CRLF_LF + case "cr": + crlfMode = CRLF_CR + case "crlf": + crlfMode = CRLF_CRLF + case "lfcr": + crlfMode = CRLF_LFCR + default: + crlfMode = CRLFAsIs + } + + if consoleBroker != nil { + norm := NormOptions{ + Mode: normalizeMode, CRLF: crlfMode, TabRender: serialConfig.TabRender, PreserveANSI: serialConfig.PreserveANSI, ShowNLTag: serialConfig.ShowNLTag, + } + consoleBroker.SetNormOptions(norm) + } + + return nil +} + +func setTerminalPaused(paused bool) { + if consoleBroker != nil { + consoleBroker.SetTerminalPaused(paused) + } +} + func initSerialPort() { _ = reopenSerialPort() switch config.ActiveExtension { @@ -280,49 +571,66 @@ func reopenSerialPort() error { Str("path", serialPortPath). Interface("mode", defaultMode). Msg("Error opening serial port") + return err + } + + // new broker (no sink yet—set it in handleSerialChannel.OnOpen) + norm := NormOptions{ + Mode: ModeNames, CRLF: CRLF_LF, TabRender: "", PreserveANSI: true, + } + if consoleBroker != nil { + consoleBroker.Close() + } + consoleBroker = NewConsoleBroker(nil, norm) + consoleBroker.Start() + + // new mux + if serialMux != nil { + serialMux.Close() } + serialMux = NewSerialMux(port, consoleBroker) + serialMux.SetEchoEnabled(serialConfig.EnableEcho) // honor your setting + serialMux.Start() + return nil } -func handleSerialChannel(d *webrtc.DataChannel) { +func handleSerialChannel(dataChannel *webrtc.DataChannel) { scopedLogger := serialLogger.With(). - Uint16("data_channel_id", *d.ID()).Logger() - - d.OnOpen(func() { - go func() { - buf := make([]byte, 1024) - for { - n, err := port.Read(buf) - if err != nil { - if err != io.EOF { - scopedLogger.Warn().Err(err).Msg("Failed to read from serial port") - } - break - } - err = d.Send(buf[:n]) - if err != nil { - scopedLogger.Warn().Err(err).Msg("Failed to send serial output") - break - } - } - }() + Uint16("data_channel_id", *dataChannel.ID()).Str("service", "serial terminal channel").Logger() + + dataChannel.OnOpen(func() { + + // Plug the terminal sink into the broker + scopedLogger.Info().Msg("Opening serial channel from console broker") + if consoleBroker != nil { + consoleBroker.SetSink(dataChannelSink{dataChannel: dataChannel}) + _ = dataChannel.SendText("RX: [serial attached]\n") + scopedLogger.Info().Msg("Serial channel is now active") + } }) - d.OnMessage(func(msg webrtc.DataChannelMessage) { - if port == nil { + dataChannel.OnMessage(func(msg webrtc.DataChannelMessage) { + + scopedLogger.Info().Bytes("Data:", msg.Data).Msg("Sending data to serial mux") + scopedLogger.Info().Msgf("Sending data to serial mux: %q", msg.Data) + if serialMux == nil { return } - _, err := port.Write(msg.Data) - if err != nil { - scopedLogger.Warn().Err(err).Msg("Failed to write to serial") - } + + // requestEcho=true — the mux will honor it only if EnableEcho is on + serialMux.Enqueue(msg.Data, "webrtc", true) }) - d.OnError(func(err error) { + dataChannel.OnError(func(err error) { scopedLogger.Warn().Err(err).Msg("Serial channel error") }) - d.OnClose(func() { + dataChannel.OnClose(func() { scopedLogger.Info().Msg("Serial channel closed") + + if consoleBroker != nil { + consoleBroker.SetSink(nil) + } }) } diff --git a/serial_console_helpers.go b/serial_console_helpers.go new file mode 100644 index 000000000..bb6f79a91 --- /dev/null +++ b/serial_console_helpers.go @@ -0,0 +1,656 @@ +package kvm + +import ( + "fmt" + "io" + "strings" + "sync/atomic" + "time" + + "github.com/pion/webrtc/v4" + "go.bug.st/serial" +) + +/* ---------- SINK (terminal output) ---------- */ + +type Sink interface { + SendText(s string) error +} + +type dataChannelSink struct{ dataChannel *webrtc.DataChannel } + +func (sink dataChannelSink) SendText(str string) error { return sink.dataChannel.SendText(str) } + +/* ---------- NORMALIZATION (applies to RX & TX) ---------- */ + +type NormalizeMode int + +const ( + ModeCaret NormalizeMode = iota // ^C ^M ^? + ModeNames // , , , … + ModeHex // \x1B +) + +type CRLFMode int + +const ( + CRLFAsIs CRLFMode = iota + CRLF_LF + CRLF_CR + CRLF_CRLF + CRLF_LFCR +) + +type NormOptions struct { + Mode NormalizeMode + CRLF CRLFMode + TabRender string // e.g. " " or "" to keep '\t' + PreserveANSI bool + ShowNLTag bool // <- NEW: also print a visible tag for CR/LF +} + +func normalize(in []byte, opt NormOptions) string { + var out strings.Builder + esc := byte(0x1B) + for i := 0; i < len(in); { + b := in[i] + + // ANSI preservation (CSI/OSC) + if opt.PreserveANSI && b == esc && i+1 < len(in) { + if in[i+1] == '[' { // CSI + j := i + 2 + for j < len(in) { + c := in[j] + if c >= 0x40 && c <= 0x7E { + j++ + break + } + j++ + } + out.Write(in[i:j]) + i = j + continue + } else if in[i+1] == ']' { // OSC ... BEL or ST + j := i + 2 + for j < len(in) { + if in[j] == 0x07 { + j++ + break + } // BEL + if j+1 < len(in) && in[j] == esc && in[j+1] == '\\' { + j += 2 + break + } // ST + j++ + } + out.Write(in[i:j]) + i = j + continue + } + } + + // CR/LF normalization (emit real newline(s), optionally tag them visibly) + if b == '\r' || b == '\n' { + // detect pair (CRLF or LFCR) + isPair := i+1 < len(in) && + ((b == '\r' && in[i+1] == '\n') || (b == '\n' && in[i+1] == '\r')) + + // optional visible tag of what we *saw* + if opt.ShowNLTag { + if isPair { + if b == '\r' { // saw CRLF + out.WriteString("") + } else { // saw LFCR + out.WriteString("") + } + } else { + if b == '\r' { + out.WriteString("") + } else { + out.WriteString("") + } + } + } + + // now emit the actual newline(s) per the normalization mode + switch opt.CRLF { + case CRLFAsIs: + if isPair { + out.WriteByte(b) + out.WriteByte(in[i+1]) + i += 2 + } else { + out.WriteByte(b) + i++ + } + case CRLF_LF: + if isPair { + i += 2 + } else { + i++ + } + out.WriteByte('\n') + case CRLF_CR: + if isPair { + i += 2 + } else { + i++ + } + out.WriteByte('\r') + case CRLF_CRLF: + if isPair { + i += 2 + } else { + i++ + } + out.WriteString("\r\n") // (fixed to actually write CRLF) + case CRLF_LFCR: + if isPair { + i += 2 + } else { + i++ + } + out.WriteString("\n\r") + } + continue + } + + // Tabs + if b == '\t' { + if opt.TabRender != "" { + out.WriteString(opt.TabRender) + } else { + out.WriteByte('\t') + } + i++ + continue + } + + // Controls + if b < 0x20 || b == 0x7F { + switch opt.Mode { + case ModeCaret: + if b == 0x7F { + out.WriteString("^?") + } else { + out.WriteByte('^') + out.WriteByte(byte('@' + b)) + } + case ModeNames: + names := map[byte]string{ + 0: "NUL", 1: "SOH", 2: "STX", 3: "ETX", 4: "EOT", 5: "ENQ", 6: "ACK", 7: "BEL", + 8: "BS", 9: "TAB", 10: "LF", 11: "VT", 12: "FF", 13: "CR", 14: "SO", 15: "SI", + 16: "DLE", 17: "DC1", 18: "DC2", 19: "DC3", 20: "DC4", 21: "NAK", 22: "SYN", 23: "ETB", + 24: "CAN", 25: "EM", 26: "SUB", 27: "ESC", 28: "FS", 29: "GS", 30: "RS", 31: "US", 127: "DEL", + } + if n, ok := names[b]; ok { + out.WriteString("<" + n + ">") + } else { + out.WriteString(fmt.Sprintf("0x%02X", b)) + } + case ModeHex: + out.WriteString(fmt.Sprintf("\\x%02X", b)) + } + i++ + continue + } + + out.WriteByte(b) + i++ + } + return out.String() +} + +/* ---------- CONSOLE BROKER (ordering + normalization + RX/TX) ---------- */ + +type consoleEventKind int + +const ( + evRX consoleEventKind = iota + evTX // local echo after a successful write +) + +type consoleEvent struct { + kind consoleEventKind + data []byte +} + +type ConsoleBroker struct { + sink Sink + in chan consoleEvent + done chan struct{} + + // pause control + terminalPaused bool + pauseCh chan bool + + // buffered output while paused + bufLines []string + bufBytes int + maxBufLines int + maxBufBytes int + + // line-aware echo + rxAtLineEnd bool + txLineActive bool // true if we’re mid-line (prefix already written) + pendingTX *consoleEvent + quietTimer *time.Timer + quietAfter time.Duration + + // normalization + norm NormOptions + + // labels + labelRX string + labelTX string +} + +func NewConsoleBroker(s Sink, norm NormOptions) *ConsoleBroker { + return &ConsoleBroker{ + sink: s, + in: make(chan consoleEvent, 256), + done: make(chan struct{}), + pauseCh: make(chan bool, 8), + terminalPaused: false, + rxAtLineEnd: true, + txLineActive: false, + quietAfter: 120 * time.Millisecond, + norm: norm, + labelRX: "RX", + labelTX: "TX", + // reasonable defaults; tweak as you like + maxBufLines: 5000, + maxBufBytes: 1 << 20, // 1 MiB + } +} + +func (b *ConsoleBroker) Start() { go b.loop() } +func (b *ConsoleBroker) Close() { close(b.done) } +func (b *ConsoleBroker) SetSink(s Sink) { b.sink = s } +func (b *ConsoleBroker) SetNormOptions(norm NormOptions) { b.norm = norm } +func (b *ConsoleBroker) SetTerminalPaused(v bool) { + if b == nil { + return + } + // send to broker loop to avoid data races + select { + case b.pauseCh <- v: + default: + b.pauseCh <- v + } +} + +func (b *ConsoleBroker) Enqueue(ev consoleEvent) { + b.in <- ev // blocking is fine; adjust if you want drop semantics +} + +func (b *ConsoleBroker) loop() { + scopedLogger := serialLogger.With().Str("service", "Serial Console Broker").Logger() + for { + select { + case <-b.done: + return + + case v := <-b.pauseCh: + // apply pause state + was := b.terminalPaused + b.terminalPaused = v + if was && !v { + // we just unpaused: flush buffered output in order + scopedLogger.Info().Msg("Terminal unpaused; flushing buffered output") + b.flushBuffer() + } else if !was && v { + scopedLogger.Info().Msg("Terminal paused; buffering output") + } + + case ev := <-b.in: + switch ev.kind { + case evRX: + scopedLogger.Info().Msg("Processing RX data from serial port") + b.handleRX(ev.data) + case evTX: + scopedLogger.Info().Msg("Processing TX echo request") + b.handleTX(ev.data) + } + + case <-b.quietCh(): + if b.pendingTX != nil { + b.emitToTerminal(b.lineSep()) // use CRLF policy + b.flushPendingTX() + b.rxAtLineEnd = true + b.txLineActive = false + } + } + } +} + +func (b *ConsoleBroker) quietCh() <-chan time.Time { + if b.quietTimer != nil { + return b.quietTimer.C + } + return make(<-chan time.Time) +} + +func (b *ConsoleBroker) startQuietTimer() { + if b.quietTimer == nil { + b.quietTimer = time.NewTimer(b.quietAfter) + } else { + b.quietTimer.Reset(b.quietAfter) + } +} + +func (b *ConsoleBroker) stopQuietTimer() { + if b.quietTimer != nil { + if !b.quietTimer.Stop() { + select { + case <-b.quietTimer.C: + default: + } + } + } +} + +func (b *ConsoleBroker) handleRX(data []byte) { + scopedLogger := serialLogger.With().Str("service", "Serial Console Broker RX handler").Logger() + if b.sink == nil || len(data) == 0 { + return + } + + // If we’re mid TX line, end it before RX + if b.txLineActive { + b.emitToTerminal(b.lineSep()) + b.txLineActive = false + } + + text := normalize(data, b.norm) + if text == "" { + return + } + + scopedLogger.Info().Msg("Emitting RX data to sink (with per-line prefixes)") + + // Prefix every line, regardless of how the EOLs look + lines := splitAfterAnyEOL(text, b.norm.CRLF) + + // Start from the broker's current RX line state + atLineEnd := b.rxAtLineEnd + + for _, line := range lines { + if line == "" { + continue + } + + if atLineEnd { + // New physical line -> prefix with RX: + b.emitToTerminal(fmt.Sprintf("%s: %s", b.labelRX, line)) + } else { + // Continuation of previous RX line -> no extra RX: prefix + b.emitToTerminal(line) + } + + // Update line-end state based on this piece + atLineEnd = endsWithEOL(line, b.norm.CRLF) + } + + // Persist state for next RX chunk + b.rxAtLineEnd = atLineEnd + + if b.pendingTX != nil && b.rxAtLineEnd { + b.flushPendingTX() + b.stopQuietTimer() + } +} + +func (b *ConsoleBroker) handleTX(data []byte) { + scopedLogger := serialLogger.With().Str("service", "Serial Console Broker TX handler").Logger() + if b.sink == nil || len(data) == 0 { + return + } + if b.rxAtLineEnd && b.pendingTX == nil { + scopedLogger.Info().Msg("Emitting TX data to sink immediately") + b.emitTX(data) + return + } + scopedLogger.Info().Msg("Queuing TX data to emit after RX line completion or quiet period") + b.pendingTX = &consoleEvent{kind: evTX, data: append([]byte(nil), data...)} + b.startQuietTimer() +} + +func (b *ConsoleBroker) emitTX(data []byte) { + scopedLogger := serialLogger.With().Str("service", "Serial Console Broker TX emiter").Logger() + if len(data) == 0 { + return + } + + text := normalize(data, b.norm) + if text == "" { + return + } + + // Check if we’re in the middle of a TX line + if !b.txLineActive { + // Start new TX line with prefix + scopedLogger.Info().Msg("Emitting TX data to sink with prefix") + b.emitToTerminal(fmt.Sprintf("%s: %s", b.labelTX, text)) + b.txLineActive = true + } else { + // Continue current line (no prefix) + scopedLogger.Info().Msg("Emitting TX data to sink without prefix") + b.emitToTerminal(text) + } + + // If the data ends with a newline, mark TX line as complete + if strings.HasSuffix(text, "\r") || strings.HasSuffix(text, "\n") { + b.txLineActive = false + } +} + +func (b *ConsoleBroker) flushPendingTX() { + if b.pendingTX == nil { + return + } + b.emitTX(b.pendingTX.data) + b.pendingTX = nil + b.txLineActive = false +} + +func (b *ConsoleBroker) lineSep() string { + switch b.norm.CRLF { + case CRLF_CRLF: + return "\r\n" + case CRLF_LFCR: + return "\n\r" + case CRLF_CR: + return "\r" + case CRLF_LF: + return "\n" + default: + return "\n" + } +} + +// splitAfterAnyEOL splits text into lines keeping the EOL with each piece. +// For CRLFAsIs it treats \r, \n, \r\n, and \n\r as EOLs. +// For other modes it uses the normalized separator. +func splitAfterAnyEOL(text string, mode CRLFMode) []string { + if text == "" { + return nil + } + + // Fast path for normalized modes + switch mode { + case CRLF_LF: + return strings.SplitAfter(text, "\n") + case CRLF_CR: + return strings.SplitAfter(text, "\r") + case CRLF_CRLF: + return strings.SplitAfter(text, "\r\n") + case CRLF_LFCR: + return strings.SplitAfter(text, "\n\r") + } + + // CRLFAsIs: scan bytes and treat \r, \n, \r\n, \n\r as one boundary + b := []byte(text) + var parts []string + start := 0 + for i := 0; i < len(b); i++ { + if b[i] == '\r' || b[i] == '\n' { + j := i + 1 + // coalesce pair if the next is the "other" newline + if j < len(b) && ((b[i] == '\r' && b[j] == '\n') || (b[i] == '\n' && b[j] == '\r')) { + j++ + } + parts = append(parts, string(b[start:j])) + start = j + i = j - 1 // advance past the EOL (or pair) + } + } + if start < len(b) { + parts = append(parts, string(b[start:])) + } + return parts +} + +func endsWithEOL(s string, mode CRLFMode) bool { + if s == "" { + return false + } + switch mode { + case CRLF_CRLF: + return strings.HasSuffix(s, "\r\n") + case CRLF_LFCR: + return strings.HasSuffix(s, "\n\r") + case CRLF_LF: + return strings.HasSuffix(s, "\n") + case CRLF_CR: + return strings.HasSuffix(s, "\r") + default: // AsIs: any of \r, \n, \r\n, \n\r + return strings.HasSuffix(s, "\r\n") || + strings.HasSuffix(s, "\n\r") || + strings.HasSuffix(s, "\n") || + strings.HasSuffix(s, "\r") + } +} + +func (b *ConsoleBroker) emitToTerminal(s string) { + if b.sink == nil || s == "" { + return + } + if b.terminalPaused { + b.enqueueBuffered(s) + return + } + _ = b.sink.SendText(s) +} + +func (b *ConsoleBroker) enqueueBuffered(s string) { + b.bufLines = append(b.bufLines, s) + b.bufBytes += len(s) + // trim if over limits (drop oldest) + for b.bufBytes > b.maxBufBytes || len(b.bufLines) > b.maxBufLines { + if len(b.bufLines) == 0 { + break + } + b.bufBytes -= len(b.bufLines[0]) + b.bufLines = b.bufLines[1:] + } +} + +func (b *ConsoleBroker) flushBuffer() { + if b.sink == nil || len(b.bufLines) == 0 { + b.bufLines = nil + b.bufBytes = 0 + return + } + for _, s := range b.bufLines { + _ = b.sink.SendText(s) + } + b.bufLines = nil + b.bufBytes = 0 +} + +/* ---------- SERIAL MUX (single reader/writer, emits to broker) ---------- */ + +type txFrame struct { + payload []byte // should include terminator already + source string // "webrtc" | "button" + echo bool // request TX echo (subject to global toggle) +} + +type SerialMux struct { + port serial.Port + txQ chan txFrame + done chan struct{} + broker *ConsoleBroker + + echoEnabled atomic.Bool // controlled via SetEchoEnabled +} + +func NewSerialMux(p serial.Port, broker *ConsoleBroker) *SerialMux { + m := &SerialMux{ + port: p, + txQ: make(chan txFrame, 128), + done: make(chan struct{}), + broker: broker, + } + return m +} + +func (m *SerialMux) Start() { + go m.reader() + go m.writer() +} + +func (m *SerialMux) Close() { close(m.done) } + +func (m *SerialMux) SetEchoEnabled(v bool) { m.echoEnabled.Store(v) } + +func (m *SerialMux) Enqueue(payload []byte, source string, requestEcho bool) { + serialLogger.Info().Str("src", source).Bool("echo", requestEcho).Msg("Enqueuing TX data to serial port") + m.txQ <- txFrame{payload: append([]byte(nil), payload...), source: source, echo: requestEcho} +} + +func (m *SerialMux) reader() { + scopedLogger := serialLogger.With().Str("service", "SerialMux reader").Logger() + buf := make([]byte, 4096) + for { + select { + case <-m.done: + return + default: + n, err := m.port.Read(buf) + if err != nil { + if err != io.EOF { + serialLogger.Warn().Err(err).Msg("serial read failed") + } + time.Sleep(50 * time.Millisecond) + continue + } + if n > 0 && m.broker != nil { + scopedLogger.Info().Msg("Sending RX data to console broker") + m.broker.Enqueue(consoleEvent{kind: evRX, data: append([]byte(nil), buf[:n]...)}) + } + } + } +} + +func (m *SerialMux) writer() { + scopedLogger := serialLogger.With().Str("service", "SerialMux writer").Logger() + for { + select { + case <-m.done: + return + case f := <-m.txQ: + scopedLogger.Info().Msg("Writing TX data to serial port") + if _, err := m.port.Write(f.payload); err != nil { + scopedLogger.Warn().Err(err).Str("src", f.source).Msg("serial write failed") + continue + } + // echo (if requested AND globally enabled) + if f.echo && m.echoEnabled.Load() && m.broker != nil { + scopedLogger.Info().Msg("Sending TX echo to console broker") + m.broker.Enqueue(consoleEvent{kind: evTX, data: append([]byte(nil), f.payload...)}) + } + } + } +} diff --git a/ui/src/components/CommandInput.tsx b/ui/src/components/CommandInput.tsx new file mode 100644 index 000000000..526642500 --- /dev/null +++ b/ui/src/components/CommandInput.tsx @@ -0,0 +1,309 @@ +import React, { useCallback, useEffect, useMemo, useState } from "react"; +import { createPortal } from "react-dom"; +import clsx from "clsx"; + +import InputField from "@/components/InputField"; // your existing input component +import { JsonRpcResponse, useJsonRpc } from "@/hooks/useJsonRpc"; +import notifications from "@/notifications"; + +interface Hit { value: string; index: number } + +// ---------- history hook ---------- +function useCommandHistory(max = 300) { + const { send } = useJsonRpc(); + const [items, setItems] = useState([]); + + const deleteHistory = useCallback(() => { + console.log("Deleting serial command history"); + send("deleteSerialCommandHistory", {}, (resp: JsonRpcResponse) => { + if ("error" in resp) { + notifications.error( + `Failed to delete serial command history: ${resp.error.data || "Unknown error"}`, + ); + } else { + setItems([]); + notifications.success("Serial command history deleted"); + } + }); + }, [send]); + + useEffect(() => { + send("getSerialCommandHistory", {}, (resp: JsonRpcResponse) => { + if ("error" in resp) { + notifications.error( + `Failed to get command history: ${resp.error.data || "Unknown error"}`, + ); + } else if ("result" in resp) { + setItems(resp.result as string[]); + } + }); + }, [send]); + + const [pointer, setPointer] = useState(-1); // -1 = fresh line + const [anchorPrefix, setAnchorPrefix] = useState(null); + + useEffect(() => { + if (items.length > 1) { + send("setSerialCommandHistory", { commandHistory: items }, (resp: JsonRpcResponse) => { + if ("error" in resp) { + notifications.error(`Failed to update command history: ${resp.error.data || "Unknown error"}`); + return; + } + }); + } + }, [items, send]); + + const push = useCallback((cmd: string) => { + if (!cmd.trim()) return; + setItems((prev) => { + const next = prev[prev.length - 1] === cmd ? prev : [...prev, cmd]; + return next.slice(-max); + }); + setPointer(-1); + setAnchorPrefix(null); + }, [max]); + + const resetTraversal = useCallback(() => { + setPointer(-1); + setAnchorPrefix(null); + }, []); + + const up = useCallback((draft: string) => { + const pref = anchorPrefix ?? draft; + if (anchorPrefix == null) setAnchorPrefix(pref); + let i = pointer < 0 ? items.length - 1 : pointer - 1; + for (; i >= 0; i--) { + if (items[i].startsWith(pref)) { + setPointer(i); + return items[i]; + } + } + return draft; + }, [items, pointer, anchorPrefix]); + + const down = useCallback((draft: string) => { + const pref = anchorPrefix ?? draft; + if (anchorPrefix == null) setAnchorPrefix(pref); + let i = pointer < 0 ? 0 : pointer + 1; + for (; i < items.length; i++) { + if (items[i].startsWith(pref)) { + setPointer(i); + return items[i]; + } + } + setPointer(-1); + return draft; + }, [items, pointer, anchorPrefix]); + + const search = useCallback((query: string): Hit[] => { + if (!query) return []; + const q = query.toLowerCase(); + return [...items] + .map((value, index) => ({ value, index })) + .filter((x) => x.value.toLowerCase().includes(q)) + .reverse(); // newest first + }, [items]); + + return { push, up, down, resetTraversal, search, deleteHistory }; +} + +function Portal({ children }: { children: React.ReactNode }) { + const [mounted, setMounted] = useState(false); + useEffect(() => setMounted(true), []); + if (!mounted) return null; + return createPortal(children, document.body); +} + +// ---------- reverse search popup ---------- +function ReverseSearch({ + open, results, sel, setSel, onPick, onClose, onDeleteHistory +}: { + open: boolean; + results: Hit[]; + sel: number; + setSel: (i: number) => void; + onPick: (val: string) => void; + onClose: () => void; + onDeleteHistory: () => void; +}) { + const listRef = React.useRef(null); + + // keep selected item in view when sel changes + useEffect(() => { + if (!listRef.current) return; + const el = listRef.current.querySelector(`[data-idx="${sel}"]`); + el?.scrollIntoView({ block: "nearest" }); + }, [sel, results]); + + if (!open) return null; + return ( + +
+
+ {results.length === 0 ? ( +
No matches
+ ) : results.map((r, i) => ( +
setSel(i)} + onClick={() => onPick(r.value)} + > + {r.value} +
+ ))} +
+
+ ↑/↓ select • Enter accept • Esc close +
+ + +
+
+
+ + ); +} + +// ---------- main component ---------- +interface CommandInputProps { + onSend: (line: string) => void; // called on Enter + storageKey?: string; // localStorage key for history + placeholder?: string; // input placeholder + className?: string; // container className + disabled?: boolean; // disable input (optional) +} + +export function CommandInput({ + onSend, + placeholder = "Type serial command… (Enter to send • ↑/↓ history • Ctrl+R search)", + className, + disabled, +}: CommandInputProps) { + const [cmd, setCmd] = useState(""); + const [revOpen, setRevOpen] = useState(false); + const [revQuery, setRevQuery] = useState(""); + const [sel, setSel] = useState(0); + const { push, up, down, resetTraversal, search, deleteHistory } = useCommandHistory(); + + const results = useMemo(() => search(revQuery), [revQuery, search]); + + useEffect(() => { setSel(0); }, [results]); + + const cmdInputRef = React.useRef(null); + + const handleKeyDown = (e: React.KeyboardEvent) => { + const isMeta = e.ctrlKey || e.metaKey; + + if (e.key === "Enter" && !e.shiftKey && !isMeta) { + e.preventDefault(); + if (!cmd) return; + onSend(cmd); + push(cmd); + setCmd(""); + resetTraversal(); + setRevOpen(false); + return; + } + if (e.key === "ArrowUp") { + e.preventDefault(); + setCmd((prev) => up(prev)); + return; + } + if (e.key === "ArrowDown") { + e.preventDefault(); + setCmd((prev) => down(prev)); + return; + } + if (isMeta && e.key.toLowerCase() === "r") { + e.preventDefault(); + setRevOpen(true); + setRevQuery(cmd); + setSel(0); + return; + } + if (e.key === "Escape" && revOpen) { + e.preventDefault(); + setRevOpen(false); + return; + } + }; + + return ( +
+
+ CMD + { setCmd(e.target.value); resetTraversal(); }} + onKeyDown={handleKeyDown} + placeholder={placeholder} + className="font-mono" + /> +
+ + {/* Reverse search controls */} + {revOpen && ( +
+
+ Search + setRevQuery(e.target.value)} + onKeyDown={(e) => { + if (e.key === "ArrowDown") { + e.preventDefault(); + setSel((i) => (i + 1) % Math.max(1, results.length)); + } else if (e.key === "ArrowUp") { + e.preventDefault(); + setSel((i) => (i - 1 + results.length) % Math.max(1, results.length)); + } else if (e.key === "Enter") { + e.preventDefault(); + const pick = results[sel]?.value ?? results[0]?.value; + if (pick) { + setCmd(pick); + setRevOpen(false); + requestAnimationFrame(() => cmdInputRef.current?.focus()); + } + } else if (e.key === "Escape") { + e.preventDefault(); + setRevOpen(false); + requestAnimationFrame(() => cmdInputRef.current?.focus()); + } + }} + placeholder="Type to filter history…" + className="font-mono" + /> +
+ { setCmd(v); setRevOpen(false); requestAnimationFrame(() => cmdInputRef.current?.focus()); }} + onClose={() => {setRevOpen(false); requestAnimationFrame(() => cmdInputRef.current?.focus());}} + onDeleteHistory={deleteHistory} + /> +
+ )} +
+ ); +}; + +export default CommandInput; diff --git a/ui/src/components/Terminal.tsx b/ui/src/components/Terminal.tsx index ba3e667c1..8a2345c8b 100644 --- a/ui/src/components/Terminal.tsx +++ b/ui/src/components/Terminal.tsx @@ -1,6 +1,6 @@ import "react-simple-keyboard/build/css/index.css"; -import { ChevronDownIcon } from "@heroicons/react/16/solid"; -import { useEffect, useMemo } from "react"; +import { ChevronDownIcon, PauseCircleIcon, PlayCircleIcon } from "@heroicons/react/16/solid"; +import { useEffect, useMemo, useCallback, useState } from "react"; import { useXTerm } from "react-xtermjs"; import { FitAddon } from "@xterm/addon-fit"; import { WebLinksAddon } from "@xterm/addon-web-links"; @@ -9,10 +9,14 @@ import { Unicode11Addon } from "@xterm/addon-unicode11"; import { ClipboardAddon } from "@xterm/addon-clipboard"; import { cx } from "@/cva.config"; -import { AvailableTerminalTypes, useUiStore } from "@/hooks/stores"; +import { AvailableTerminalTypes, useUiStore, useTerminalStore } from "@/hooks/stores"; +import { CommandInput } from "@/components/CommandInput"; +import { JsonRpcResponse, useJsonRpc } from "@/hooks/useJsonRpc"; +import notifications from "@/notifications"; import { Button } from "./Button"; + const isWebGl2Supported = !!document.createElement("canvas").getContext("webgl2"); // Terminal theme configuration @@ -66,9 +70,12 @@ function Terminal({ readonly type: AvailableTerminalTypes; }) { const { terminalType, setTerminalType, setDisableVideoFocusTrap } = useUiStore(); + const { terminator } = useTerminalStore(); const { instance, ref } = useXTerm({ options: TERMINAL_CONFIG }); + const [ terminalPaused, setTerminalPaused ] = useState(false) const isTerminalTypeEnabled = useMemo(() => { + console.log("Terminal type:", terminalType, "Checking against:", type); return terminalType == type; }, [terminalType, type]); @@ -83,6 +90,18 @@ function Terminal({ }, [setDisableVideoFocusTrap, isTerminalTypeEnabled]); const readyState = dataChannel.readyState; + + const { send } = useJsonRpc(); + + const handleTerminalPauseChange = () => { + send("setTerminalPaused", { terminalPaused: !terminalPaused }, (resp: JsonRpcResponse) => { + if ("error" in resp) { + notifications.error(`Failed to update terminal pause state: ${resp.error.data || "Unknown error"}`); + return; + } + setTerminalPaused(!terminalPaused); + }); + }; useEffect(() => { if (!instance) return; if (readyState !== "open") return; @@ -92,6 +111,11 @@ function Terminal({ dataChannel.addEventListener( "message", e => { + if (typeof e.data === "string") { + instance.write(e.data); // text path + return; + } + // binary path (if the server ever sends bytes) // Handle binary data differently based on browser implementation // Firefox sends data as blobs, chrome sends data as arraybuffer if (binaryType === "arraybuffer") { @@ -109,7 +133,12 @@ function Terminal({ ); const onDataHandler = instance.onData(data => { - dataChannel.send(data); + if (data === "\r") { + // Intercept enter key to add terminator + dataChannel.send(terminator ?? ""); + } else { + dataChannel.send(data); + } }); // Setup escape key handler @@ -132,7 +161,7 @@ function Terminal({ onDataHandler.dispose(); onKeyHandler.dispose(); }; - }, [dataChannel, instance, readyState, setDisableVideoFocusTrap, setTerminalType]); + }, [dataChannel, instance, readyState, setDisableVideoFocusTrap, setTerminalType, terminator]); useEffect(() => { if (!instance) return; @@ -161,6 +190,11 @@ function Terminal({ }; }, [instance]); + const sendLine = useCallback((line: string) => { + // Just send; line ending/echo/normalization handled in serial.go + dataChannel.send(line + terminator); + }, [dataChannel, terminator]); + return (
e.stopPropagation()} @@ -188,6 +222,17 @@ function Terminal({ {title}
+ {terminalType == "serial" && ( +
- {/* Settings */} -
- handleSettingChange("baudRate", e.target.value)} - /> - handleSettingChange("dataBits", e.target.value)} - /> + {/* Serial settings (collapsible) */} + {!buttonConfig.hideSerialSettings && ( + <> +
+ handleSerialSettingsChange("baudRate", Number(e.target.value))} + /> - handleSettingChange("stopBits", e.target.value)} - /> + handleSerialSettingsChange("dataBits", Number(e.target.value))} + /> - handleSettingChange("parity", e.target.value)} - /> + handleSerialSettingsChange("stopBits", e.target.value)} + /> + + handleSerialSettingsChange("parity", e.target.value)} + /> +
+ { + handleSerialSettingsChange("terminator", {label: e.target.selectedOptions[0].text, value: e.target.value}) + setTerminator(e.target.value); + }} + /> +
+ When sent, the selected line ending ({buttonConfig.terminator.label}) will be appended. +
+
+
+ { + handleSerialSettingsChange("normalizeMode", e.target.value) + }} + /> +
+ {normalizeHelp[(buttonConfig.normalizeMode as NormalizeMode)]} +
+
+
+ { + handleSerialSettingsChange("normalizeLineEnd", e.target.value) + }} + /> +
+
+ { + handleSerialSettingsChange("preserveANSI", e.target.value === "keep") + }} + /> +
+
+ tag", value: "hide" }, + { label: "Show tag", value: "show" }, + ]} + value={buttonConfig.showNLTag ? "show" : "hide"} + onChange={(e) => { + handleSerialSettingsChange("showNLTag", e.target.value === "show") + }} + /> +
+
+ { + handleSerialSettingsChange("tabRender", e.target.value) + }} + /> +
+ Empty for no replacement +
+
+
+
+ + { + handleSerialSettingsChange("enableEcho", e.target.checked); + }} + /> + +
+
+ + )} + + {/* Buttons grid */} +
+ {sortedButtons.map((btn) => ( +
+
+
+
+ ))} + {sortedButtons.length === 0 && ( +
No buttons yet. Click “Add Button”.
+ )}
+ + {/* Editor drawer/modal (inline lightweight) */} + {editorOpen && ( +
+
+ +
{editorOpen.id ? "Edit Button" : "New Button"}
+
+
+
+ { + setDraftLabel(e.target.value); + }} + /> +
+
+ { + setDraftCmd(e.target.value); + }} + /> + {draftTerminator.value != "" && ( +
+ When sent, the selected line ending ({draftTerminator.label}) will be appended. +
+ )} +
+
+
+ setDraftTerminator({label: e.target.selectedOptions[0].text, value: e.target.value})} + /> +
+
+
+
+
+
+ {editorOpen.id && ( + <> +
+
+ )}
); } + +/** ============== helpers ============== */ +function genId() { + return "b_" + Math.random().toString(36).slice(2, 10); +} +function stableSort(arr: QuickButton[]) { + return [...arr].sort((a, b) => (a.sort - b.sort) || a.label.localeCompare(b.label)); +} + diff --git a/ui/src/hooks/stores.ts b/ui/src/hooks/stores.ts index bfbbb26e5..22f77043a 100644 --- a/ui/src/hooks/stores.ts +++ b/ui/src/hooks/stores.ts @@ -465,7 +465,7 @@ export interface KeysDownState { keys: number[]; } -export type USBStates = +export type USBStates = | "configured" | "attached" | "not attached" @@ -658,6 +658,18 @@ export const useDeviceStore = create(set => ({ setSystemVersion: (version: string) => set({ systemVersion: version }), })); +export interface TerminalState { + terminator: string | null; + + setTerminator: (version: string) => void; +} + +export const useTerminalStore = create(set => ({ + terminator: null, + + setTerminator: (version: string) => set({ terminator: version }), +})); + export interface DhcpLease { ip?: string; netmask?: string;