diff --git a/ui/src/hooks/stores.ts b/ui/src/hooks/stores.ts
index aa29528..e788faa 100644
--- a/ui/src/hooks/stores.ts
+++ b/ui/src/hooks/stores.ts
@@ -283,8 +283,6 @@ export const useVideoStore = create(set => ({
},
}));
-export type KeyboardLedSync = "auto" | "browser" | "host";
-
interface SettingsState {
isCursorHidden: boolean;
setCursorVisibility: (enabled: boolean) => void;
@@ -308,9 +306,6 @@ interface SettingsState {
keyboardLayout: string;
setKeyboardLayout: (layout: string) => void;
- keyboardLedSync: KeyboardLedSync;
- setKeyboardLedSync: (sync: KeyboardLedSync) => void;
-
scrollThrottling: number;
setScrollThrottling: (value: number) => void;
@@ -356,9 +351,6 @@ export const useSettingsStore = create(
keyboardLayout: "en-US",
setKeyboardLayout: layout => set({ keyboardLayout: layout }),
- keyboardLedSync: "auto",
- setKeyboardLedSync: sync => set({ keyboardLedSync: sync }),
-
scrollThrottling: 0,
setScrollThrottling: value => set({ scrollThrottling: value }),
@@ -436,14 +428,13 @@ export interface KeyboardLedState {
scroll_lock: boolean;
compose: boolean;
kana: boolean;
+ shift: boolean; // Optional, as not all keyboards have a shift LED
};
-const defaultKeyboardLedState: KeyboardLedState = {
- num_lock: false,
- caps_lock: false,
- scroll_lock: false,
- compose: false,
- kana: false,
-};
+
+export interface KeysDownState {
+ modifier: number;
+ keys: number[];
+}
export interface HidState {
activeKeys: number[];
@@ -465,12 +456,9 @@ export interface HidState {
keyboardLedState?: KeyboardLedState;
setKeyboardLedState: (state: KeyboardLedState) => void;
- setIsNumLockActive: (active: boolean) => void;
- setIsCapsLockActive: (active: boolean) => void;
- setIsScrollLockActive: (active: boolean) => void;
- keyboardLedStateSyncAvailable: boolean;
- setKeyboardLedStateSyncAvailable: (available: boolean) => void;
+ keysDownState?: KeysDownState;
+ setKeysDownState: (state: KeysDownState) => void;
isVirtualKeyboardEnabled: boolean;
setVirtualKeyboardEnabled: (enabled: boolean) => void;
@@ -482,9 +470,10 @@ export interface HidState {
setUsbState: (state: HidState["usbState"]) => void;
}
-export const useHidStore = create((set, get) => ({
+export const useHidStore = create((set) => ({
activeKeys: [],
activeModifiers: [],
+
updateActiveKeysAndModifiers: ({ keys, modifiers }) => {
return set({ activeKeys: keys, activeModifiers: modifiers });
},
@@ -498,25 +487,11 @@ export const useHidStore = create((set, get) => ({
altGrCtrlTime: 0,
setAltGrCtrlTime: time => set({ altGrCtrlTime: time }),
+ keyboardLedState: undefined,
setKeyboardLedState: ledState => set({ keyboardLedState: ledState }),
- setIsNumLockActive: active => {
- const keyboardLedState = { ...(get().keyboardLedState || defaultKeyboardLedState) };
- keyboardLedState.num_lock = active;
- set({ keyboardLedState });
- },
- setIsCapsLockActive: active => {
- const keyboardLedState = { ...(get().keyboardLedState || defaultKeyboardLedState) };
- keyboardLedState.caps_lock = active;
- set({ keyboardLedState });
- },
- setIsScrollLockActive: active => {
- const keyboardLedState = { ...(get().keyboardLedState || defaultKeyboardLedState) };
- keyboardLedState.scroll_lock = active;
- set({ keyboardLedState });
- },
- keyboardLedStateSyncAvailable: false,
- setKeyboardLedStateSyncAvailable: available => set({ keyboardLedStateSyncAvailable: available }),
+ keysDownState: undefined,
+ setKeysDownState: state => set({ keysDownState: state }),
isVirtualKeyboardEnabled: false,
setVirtualKeyboardEnabled: enabled => set({ isVirtualKeyboardEnabled: enabled }),
diff --git a/ui/src/hooks/useKeyboard.ts b/ui/src/hooks/useKeyboard.ts
index 0ce1eef..7861dd9 100644
--- a/ui/src/hooks/useKeyboard.ts
+++ b/ui/src/hooks/useKeyboard.ts
@@ -1,6 +1,6 @@
import { useCallback } from "react";
-import { useHidStore, useRTCStore } from "@/hooks/stores";
+import { KeysDownState, useHidStore, useRTCStore } from "@/hooks/stores";
import { useJsonRpc } from "@/hooks/useJsonRpc";
import { keys, modifiers } from "@/keyboardMappings";
@@ -25,6 +25,30 @@ export default function useKeyboard() {
[rpcDataChannel?.readyState, send, updateActiveKeysAndModifiers],
);
+ const modifiersFromModifierMask = (activeModifiers: number): number[] => {
+ return Object.values(modifiers).filter(m => (activeModifiers & m) !== 0);
+ }
+
+ const sendKeypressEvent = useCallback(
+ (key: number, press: boolean) => {
+ if (rpcDataChannel?.readyState !== "open") return;
+
+ send("keypressReport", { key, press }, resp => {
+ if ("error" in resp) {
+ console.error("Failed to send keypress:", resp.error);
+ } else {
+ const keyDownState = resp.result as KeysDownState;
+ const keysDown = keyDownState.keys;
+ const activeModifiers = modifiersFromModifierMask(keyDownState.modifier)
+
+ // We do this for the info bar to display the currently pressed keys for the user
+ updateActiveKeysAndModifiers({ keys: keysDown, modifiers: activeModifiers });
+ }
+ });
+ },
+ [rpcDataChannel?.readyState, send, updateActiveKeysAndModifiers],
+ );
+
const resetKeyboardState = useCallback(() => {
sendKeyboardEvent([], []);
}, [sendKeyboardEvent]);
@@ -52,5 +76,5 @@ export default function useKeyboard() {
}
};
- return { sendKeyboardEvent, resetKeyboardState, executeMacro };
+ return { sendKeyboardEvent, sendKeypressEvent, resetKeyboardState, executeMacro };
}
diff --git a/ui/src/keyboardMappings.ts b/ui/src/keyboardMappings.ts
index bb24fbb..1395a59 100644
--- a/ui/src/keyboardMappings.ts
+++ b/ui/src/keyboardMappings.ts
@@ -42,6 +42,7 @@ export const keys = {
F10: 0x43,
F11: 0x44,
F12: 0x45,
+ F13: 0x68,
F14: 0x69,
F15: 0x6a,
F16: 0x6b,
diff --git a/ui/src/routes/devices.$id.settings.keyboard.tsx b/ui/src/routes/devices.$id.settings.keyboard.tsx
index 57119ba..40c7c6f 100644
--- a/ui/src/routes/devices.$id.settings.keyboard.tsx
+++ b/ui/src/routes/devices.$id.settings.keyboard.tsx
@@ -1,6 +1,6 @@
import { useCallback, useEffect, useMemo } from "react";
-import { KeyboardLedSync, useSettingsStore } from "@/hooks/stores";
+import { useSettingsStore } from "@/hooks/stores";
import { useJsonRpc } from "@/hooks/useJsonRpc";
import notifications from "@/notifications";
import { SettingsPageHeader } from "@components/SettingsPageheader";
@@ -13,14 +13,10 @@ import { SettingsItem } from "./devices.$id.settings";
export default function SettingsKeyboardRoute() {
const keyboardLayout = useSettingsStore(state => state.keyboardLayout);
- const keyboardLedSync = useSettingsStore(state => state.keyboardLedSync);
const showPressedKeys = useSettingsStore(state => state.showPressedKeys);
const setKeyboardLayout = useSettingsStore(
state => state.setKeyboardLayout,
);
- const setKeyboardLedSync = useSettingsStore(
- state => state.setKeyboardLedSync,
- );
const setShowPressedKeys = useSettingsStore(
state => state.setShowPressedKeys,
);
@@ -33,11 +29,6 @@ export default function SettingsKeyboardRoute() {
}, [keyboardLayout]);
const layoutOptions = keyboardOptions();
- const ledSyncOptions = [
- { value: "auto", label: "Automatic" },
- { value: "browser", label: "Browser Only" },
- { value: "host", label: "Host Only" },
- ];
const [send] = useJsonRpc();
@@ -91,23 +82,6 @@ export default function SettingsKeyboardRoute() {
-
- { /* this menu item could be renamed to plain "Keyboard layout" in the future, when also the virtual keyboard layout mappings are being implemented */ }
-
- setKeyboardLedSync(e.target.value as KeyboardLedSync)}
- options={ledSyncOptions}
- />
-
-
-
state.keyboardLedState);
const setKeyboardLedState = useHidStore(state => state.setKeyboardLedState);
- const setKeyboardLedStateSyncAvailable = useHidStore(state => state.setKeyboardLedStateSyncAvailable);
+ const keysDownState = useHidStore(state => state.keysDownState);
+ const setKeysDownState = useHidStore(state => state.setKeysDownState);
const [hasUpdated, setHasUpdated] = useState(false);
const { navigateTo } = useDeviceUiNavigation();
@@ -617,7 +619,12 @@ export default function KvmIdRoute() {
const ledState = resp.params as KeyboardLedState;
console.log("Setting keyboard led state", ledState);
setKeyboardLedState(ledState);
- setKeyboardLedStateSyncAvailable(true);
+ }
+
+ if (resp.method === "keysDownState") {
+ const downState = resp.params as KeysDownState;
+ console.log("Setting key down state", downState);
+ setKeysDownState(downState);
}
if (resp.method === "otaState") {
@@ -664,20 +671,29 @@ export default function KvmIdRoute() {
send("getKeyboardLedState", {}, resp => {
if ("error" in resp) {
- // -32601 means the method is not supported
- if (resp.error.code === -32601) {
- setKeyboardLedStateSyncAvailable(false);
- console.error("Failed to get keyboard led state, disabling sync", resp.error);
- } else {
- console.error("Failed to get keyboard led state", resp.error);
- }
+ console.error("Failed to get keyboard led state", resp.error);
return;
}
console.log("Keyboard led state", resp.result);
setKeyboardLedState(resp.result as KeyboardLedState);
- setKeyboardLedStateSyncAvailable(true);
});
- }, [rpcDataChannel?.readyState, send, setKeyboardLedState, setKeyboardLedStateSyncAvailable, keyboardLedState]);
+ }, [rpcDataChannel?.readyState, send, setKeyboardLedState, keyboardLedState]);
+
+ // request keyboard key down state from the device
+ useEffect(() => {
+ if (rpcDataChannel?.readyState !== "open") return;
+ if (keysDownState !== undefined) return;
+ console.log("Requesting keys down state");
+
+ send("getKeyDownState", {}, resp => {
+ if ("error" in resp) {
+ console.error("Failed to get key down state", resp.error);
+ return;
+ }
+ console.log("Keyboard key down state", resp.result);
+ setKeysDownState(resp.result as KeysDownState);
+ });
+ }, [keysDownState, rpcDataChannel?.readyState, send, setKeysDownState]);
// When the update is successful, we need to refresh the client javascript and show a success modal
useEffect(() => {
diff --git a/usb.go b/usb.go
index f777f89..3cf6908 100644
--- a/usb.go
+++ b/usb.go
@@ -31,16 +31,26 @@ func initUsbGadget() {
}
})
+ gadget.SetOnKeysDownChange(func(state usbgadget.KeysDownState) {
+ if currentSession != nil {
+ writeJSONRPCEvent("keysDownState", state, currentSession)
+ }
+ })
+
// open the keyboard hid file to listen for keyboard events
if err := gadget.OpenKeyboardHidFile(); err != nil {
usbLogger.Error().Err(err).Msg("failed to open keyboard hid file")
}
}
-func rpcKeyboardReport(modifier uint8, keys []uint8) error {
+func rpcKeyboardReport(modifier byte, keys []byte) error {
return gadget.KeyboardReport(modifier, keys)
}
+func rpcKeypressReport(key byte, press bool) (usbgadget.KeysDownState, error) {
+ return gadget.KeypressReport(key, press)
+}
+
func rpcAbsMouseReport(x, y int, buttons uint8) error {
return gadget.AbsMouseReport(x, y, buttons)
}
@@ -57,6 +67,10 @@ func rpcGetKeyboardLedState() (state usbgadget.KeyboardState) {
return gadget.GetKeyboardState()
}
+func rpcGetKeysDownState() (state usbgadget.KeysDownState) {
+ return gadget.GetKeysDownState()
+}
+
var usbState = "unknown"
func rpcGetUSBState() (state string) {
@@ -66,7 +80,7 @@ func rpcGetUSBState() (state string) {
func triggerUSBStateUpdate() {
go func() {
if currentSession == nil {
- usbLogger.Info().Msg("No active RPC session, skipping update state update")
+ usbLogger.Info().Msg("No active RPC session, skipping USB state update")
return
}
writeJSONRPCEvent("usbState", usbState, currentSession)
@@ -78,9 +92,9 @@ func checkUSBState() {
if newState == usbState {
return
}
+ usbLogger.Info().Str("from", usbState).Str("to", newState).Msg("USB state changed")
usbState = newState
- usbLogger.Info().Str("from", usbState).Str("to", newState).Msg("USB state changed")
requestDisplayUpdate(true)
triggerUSBStateUpdate()
}
diff --git a/webrtc.go b/webrtc.go
index f6c8529..f62a0f2 100644
--- a/webrtc.go
+++ b/webrtc.go
@@ -102,6 +102,7 @@ func newSession(config SessionConfig) (*Session, error) {
ICEServers: []webrtc.ICEServer{iceServer},
})
if err != nil {
+ scopedLogger.Warn().Err(err).Msg("Failed to create PeerConnection")
return nil, err
}
session := &Session{peerConnection: peerConnection}
@@ -133,11 +134,13 @@ func newSession(config SessionConfig) (*Session, error) {
session.VideoTrack, err = webrtc.NewTrackLocalStaticSample(webrtc.RTPCodecCapability{MimeType: webrtc.MimeTypeH264}, "video", "kvm")
if err != nil {
+ scopedLogger.Warn().Err(err).Msg("Failed to create VideoTrack")
return nil, err
}
rtpSender, err := peerConnection.AddTrack(session.VideoTrack)
if err != nil {
+ scopedLogger.Warn().Err(err).Msg("Failed to add VideoTrack to PeerConnection")
return nil, err
}
@@ -187,8 +190,9 @@ func newSession(config SessionConfig) (*Session, error) {
currentSession = nil
}
if session.shouldUmountVirtualMedia {
- err := rpcUnmountImage()
- scopedLogger.Warn().Err(err).Msg("unmount image failed on connection close")
+ if err := rpcUnmountImage(); err != nil {
+ scopedLogger.Warn().Err(err).Msg("unmount image failed on connection close")
+ }
}
if isConnected {
isConnected = false