@decky/ui 4.9.2 → 4.10.0

package/src/globals/steam-client/system/Bluetooth.ts

@@ -0,0 +1,171 @@
+import { OperationResponse, Unregisterable } from "../shared";
+
+/**
+ * Provides functionality for managing Bluetooth devices and interactions.
+ */
+export interface Bluetooth {
+    /**
+     * Cancels an ongoing pairing request with a Bluetooth device.
+     * @param adapterId The ID of the Bluetooth adapter.
+     * @param deviceId The ID of the Bluetooth device to cancel pairing with.
+     */
+    CancelPairing(adapterId: number, deviceId: number): Promise<OperationResponse>;
+
+    /**
+     * Connects to a paired Bluetooth device using the specified adapter.
+     * @param adapterId The ID of the Bluetooth adapter.
+     * @param deviceId The ID of the paired Bluetooth device to connect to.
+     */
+    Connect(adapterId: number, deviceId: number): Promise<OperationResponse>;
+
+    /**
+     * Disconnects from a currently connected Bluetooth device using the specified adapter.
+     * @param adapterId The ID of the Bluetooth adapter.
+     * @param deviceId The ID of the connected Bluetooth device to disconnect from.
+     */
+    Disconnect(adapterId: number, deviceId: number): Promise<OperationResponse>;
+
+    /**
+     * Initiates pairing with a Bluetooth device using the specified adapter.
+     * @param adapterId The ID of the Bluetooth adapter.
+     * @param deviceId The ID of the Bluetooth device to initiate pairing with.
+     */
+    Pair(adapterId: number, deviceId: number): Promise<OperationResponse>;
+
+    /**
+     * Registers a callback function to be called when the Bluetooth state changes.
+     * @param callback The callback function to be called.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForStateChanges(callback: (state: BluetoothState) => void): Unregisterable;
+
+    /**
+     * Sets whether the Bluetooth adapter should be in discovering mode.
+     * @param adapterId The ID of the Bluetooth adapter.
+     * @param value `true` to enable discovering mode, `false` to disable it.
+     */
+    SetAdapterDiscovering(adapterId: number, value: boolean): Promise<OperationResponse>;
+
+    /**
+     * Enables or disables Bluetooth functionality.
+     * @param value `true` to enable Bluetooth, `false` to disable it.
+     */
+    SetEnabled(value: boolean): Promise<OperationResponse>;
+
+    /**
+     * Unpairs a Bluetooth device from the adapter.
+     * @param adapterId The ID of the Bluetooth adapter.
+     * @param deviceId The ID of the Bluetooth device to unpair with.
+     */
+    UnPair(adapterId: number, deviceId: number): Promise<OperationResponse>;
+}
+
+/**
+ * Represents a change in the state of Bluetooth adapters and devices.
+ */
+export interface BluetoothState {
+    /**
+     * An array of Bluetooth adapters with their current state.
+     */
+    vecAdapters: BluetoothAdapter[];
+
+    /**
+     * An array of Bluetooth devices with their current state.
+     */
+    vecDevices: BluetoothDevice[];
+
+    /**
+     * Indicates whether Bluetooth is enabled (`true`) or disabled (`false`).
+     */
+    bEnabled: boolean;
+}
+
+/**
+ * Represents information about a Bluetooth adapter.
+ */
+export interface BluetoothAdapter {
+    /**
+     * The unique identifier of the Bluetooth adapter.
+     */
+    nId: number;
+
+    /**
+     * The MAC address of the Bluetooth adapter.
+     */
+    sMAC: string;
+
+    /**
+     * The name of the Bluetooth adapter.
+     */
+    sName: string;
+
+    /**
+     * Indicates whether the Bluetooth adapter is enabled.
+     */
+    bEnabled: boolean;
+
+    /**
+     * Indicates whether the Bluetooth adapter is in discovering mode.
+     */
+    bDiscovering: boolean;
+}
+
+/**
+ * Represents information about a Bluetooth device.
+ */
+export interface BluetoothDevice {
+    /**
+     * The unique identifier of the Bluetooth device.
+     */
+    nId: number;
+
+    /**
+     * The ID of the Bluetooth adapter to which this device is discovered by / connected to.
+     */
+    nAdapterId: number;
+
+    /**
+     * The type of the Bluetooth device (e.g., headphones, mouse, keyboard).
+     */
+    eType: EBluetoothDeviceType;
+
+    /**
+     * The MAC address of the Bluetooth device.
+     */
+    sMAC: string;
+
+    /**
+     * The name of the Bluetooth device.
+     */
+    sName: string;
+
+    /**
+     * Indicates whether the Bluetooth device is currently connected to the adapter.
+     */
+    bConnected: boolean;
+
+    /**
+     * Indicates whether the Bluetooth device is paired to the adapter.
+     */
+    bPaired: boolean;
+
+    /**
+     * The raw signal strength of the Bluetooth device.
+     */
+    nStrengthRaw: number;
+}
+
+export enum EBluetoothDeviceType {
+    Invalid,
+    Unknown,
+    Phone,
+    Computer,
+    Headset,
+    Headphones,
+    Speakers,
+    OtherAudio,
+    Mouse,
+    Joystick,
+    Gamepad,
+    Keyboard,
+}

package/src/globals/steam-client/system/Devkit.ts

@@ -0,0 +1,11 @@
+import { Unregisterable } from "../shared";
+
+export interface Devkit {
+    DeveloperModeChanged(state: boolean): any;
+
+    RegisterForPairingPrompt(callback: (param0: any) => any): Unregisterable;
+
+    RespondToPairingPrompt(param0: any, param1: any): any;
+
+    SetPairing(param0: any): any;
+}

package/src/globals/steam-client/system/Display.ts

@@ -0,0 +1,15 @@
+import { Unregisterable } from "../shared";
+
+export interface Display {
+    EnableUnderscan(param0: boolean): any;
+
+    RegisterForBrightnessChanges(callback: (state: BrightnessState) => void): Unregisterable;
+
+    SetBrightness(brightness: number): any;
+
+    SetUnderscanLevel(param0: any): any;
+}
+
+export interface BrightnessState {
+    flBrightness: number;
+}

package/src/globals/steam-client/system/DisplayManager.ts

@@ -0,0 +1,16 @@
+import { Unregisterable } from "../shared";
+
+// CMsgSystemDisplayManagerState, CMsgSystemDisplayManagerSetMode
+export interface DisplayManager {
+    ClearModeOverride(displayId: any): any;
+
+    GetState: any;
+
+    RegisterForStateChanges(callback: () => void): Unregisterable;
+
+    SetCompatibilityMode(displayId: any): any;
+
+    SetGamescopeInternalResolution(width: number, height: number): any;
+
+    SetMode(base64: string): any; //
+}

package/src/globals/steam-client/system/Dock.ts

@@ -0,0 +1,34 @@
+import { JsPbMessage, Unregisterable } from "../shared";
+import {EUpdaterState} from "../Updates";
+
+export interface Dock {
+    DisarmSafetyNet(): void;
+
+    /**
+     * If `data` is deserialized, returns {@link MsgSystemDockState}.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
+
+    /**
+     * @param base64 Serialized base64 message from `CMsgSystemDockUpdateFirmware`.
+     */
+    UpdateFirmware(base64: string): any;
+}
+
+/**
+ * CMsgSystemDockState
+ */
+export interface MsgSystemDockState extends JsPbMessage {
+    update_state(): SystemDockUpdateState | undefined;
+}
+
+export interface SystemDockUpdateState {
+    state: EUpdaterState | undefined;
+    rtime_last_checked: number | undefined;
+    version_current: string | undefined;
+    version_available: string | undefined;
+    stage_progress: number | undefined;
+    rtime_estimated_completion: number | undefined;
+    old_fw_workaround: number | undefined;
+}

package/src/globals/steam-client/system/Perf.ts

@@ -0,0 +1,194 @@
+import { JsPbMessage } from "../shared";
+import { Unregisterable } from "../shared";
+
+// CMsgSystemPerfUpdateSettings, CMsgSystemPerfState, CMsgSystemPerfSettings
+export interface Perf {
+    /**
+     * If `data` is deserialized, returns {@link CMsgSystemPerfDiagnosticInfo}.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForDiagnosticInfoChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
+
+    /**
+     * If `data` is deserialized, returns {@link CMsgSystemPerfState}.
+     * @returns an object that can be used to unregister the callback.
+     */
+    RegisterForStateChanges(callback: (data: ArrayBuffer) => void): Unregisterable;
+
+    /**
+     * @param base64 Serialized base64 message from `CMsgSystemPerfUpdateSettings`.
+     */
+    UpdateSettings(base64: string): any;
+}
+
+export interface CMsgSystemPerfDiagnosticInfo extends JsPbMessage {
+    battery_temp_c(): number | undefined;
+
+    entries(): SystemPerfDiagnosticEntry[] | undefined;
+
+    interfaces(): SystemPerfNetworkInterface[] | undefined;
+}
+
+export interface SystemPerfDiagnosticEntry {
+    name: string | undefined;
+    value: string | undefined;
+}
+
+export interface SystemPerfNetworkInterface {
+    name: string | undefined;
+    timestamp: number | undefined;
+    tx_bytes_total: number | undefined;
+    rx_bytes_total: number | undefined;
+    tx_bytes_per_sec: number | undefined;
+    rx_bytes_per_sec: number | undefined;
+}
+
+export interface CMsgSystemPerfState extends JsPbMessage {
+    active_profile_game_id(): string | undefined;
+
+    current_game_id(): string | undefined;
+
+    limits(): SystemPerfLimits | undefined;
+
+    settings(): SystemPerfSettings | undefined;
+}
+
+export interface SystemPerfLimits {
+    cpu_governor_manual_min_mhz: number | undefined;
+    cpu_governor_manual_max_mhz: number | undefined;
+    fsr_sharpness_min: number | undefined;
+    fsr_sharpness_max: number | undefined;
+    gpu_performance_manual_min_mhz: number | undefined;
+    gpu_performance_manual_max_mhz: number | undefined;
+    perf_overlay_is_standalone: boolean | undefined;
+    is_dynamic_vrs_available: boolean | undefined;
+    is_manual_display_refresh_rate_available: boolean | undefined;
+    gpu_performance_levels_available: EGPUPerformanceLevel[];
+    display_refresh_manual_hz_min: number | undefined;
+    display_refresh_manual_hz_max: number | undefined;
+    fps_limit_options: number[] | undefined;
+    tdp_limit_min: number | undefined;
+    tdp_limit_max: number | undefined;
+    is_nis_supported: boolean | undefined;
+    nis_sharpness_min: number | undefined;
+    nis_sharpness_max: number | undefined;
+    display_external_refresh_manual_hz_min: number | undefined;
+    display_external_refresh_manual_hz_max: number | undefined;
+    fps_limit_options_external: number[] | undefined;
+    is_tearing_supported: boolean | undefined;
+    is_vrr_supported: boolean | undefined;
+    is_dynamic_refresh_rate_in_steam_supported: boolean | undefined;
+    is_split_scaling_and_filtering_supported: boolean | undefined;
+    split_scaling_filters_available: ESplitScalingFilter[];
+    split_scaling_scalers_available: ESplitScalingScaler[];
+    is_hdr_supported: boolean | undefined;
+    display_refresh_manual_hz_oc_max: number | undefined;
+    disable_refresh_rate_management: boolean | undefined;
+}
+
+export enum EGPUPerformanceLevel {
+    Invalid,
+    Auto,
+    Manual,
+    Low,
+    High,
+    Profiling,
+}
+
+export enum ESplitScalingFilter {
+    Invalid,
+    Linear,
+    Nearest,
+    FSR,
+    NIS,
+}
+
+export enum ESplitScalingScaler {
+    Invalid,
+    Auto,
+    Integer,
+    Fit,
+    Fill,
+    Stretch,
+}
+
+export interface SystemPerfSettings {
+    global: SystemPerfSettingsGlobal | undefined;
+    per_app: SystemPerfSettingsPerApp | undefined;
+}
+
+export interface SystemPerfSettingsGlobal {
+    diagnostic_update_rate: number;
+    system_trace_service_state: ESystemServiceState;
+    graphics_profiling_service_state: ESystemServiceState;
+    perf_overlay_service_state: ESystemServiceState;
+    perf_overlay_level: EGraphicsPerfOverlayLevel;
+    is_show_perf_overlay_over_steam_enabled: boolean;
+    is_advanced_settings_enabled: boolean;
+    allow_external_display_refresh_control: boolean;
+    is_hdr_enabled: boolean;
+    hdr_on_sdr_tonemap_operator: EHDRToneMapOperator;
+    is_hdr_debug_heatmap_enabled: boolean;
+    force_hdr_wide_gammut_for_sdr: boolean;
+    allow_experimental_hdr: boolean;
+    sdr_to_hdr_brightness: number;
+    debug_force_hdr_support: boolean;
+    force_hdr_10pq_output_debug: boolean;
+    is_display_oc_enabled: boolean;
+    is_color_management_enabled: boolean;
+}
+
+export enum ESystemServiceState {
+    Unavailable,
+    Disabled,
+    Enabled,
+}
+
+export enum EGraphicsPerfOverlayLevel {
+    Hidden,
+    Basic,
+    Medium,
+    Full,
+    Minimal,
+}
+
+export enum EHDRToneMapOperator {
+    Invalid,
+    Uncharted,
+    Reinhard,
+}
+
+export interface SystemPerfSettingsPerApp {
+    gpu_performance_manual_mhz: number | undefined;
+    fps_limit: number | undefined;
+    is_variable_resolution_enabled: boolean | undefined;
+    is_dynamic_refresh_rate_enabled: boolean | undefined;
+    tdp_limit: number | undefined;
+    cpu_governor: ECPUGovernor | undefined;
+    cpu_governor_manual_mhz: number | undefined;
+    scaling_filter: number | undefined;
+    fsr_sharpness: number | undefined;
+    is_fps_limit_enabled: boolean | undefined;
+    is_tdp_limit_enabled: boolean | undefined;
+    is_low_latency_mode_enabled: boolean | undefined;
+    display_refresh_manual_hz: number | undefined;
+    is_game_perf_profile_enabled: boolean | undefined;
+    gpu_performance_level: EGPUPerformanceLevel | undefined;
+    nis_sharpness: number | undefined;
+    display_external_refresh_manual_hz: number | undefined;
+    fps_limit_external: number | undefined;
+    is_tearing_enabled: boolean | undefined;
+    is_vrr_enabled: boolean | undefined;
+    is_composite_debug_enabled: boolean | undefined;
+    force_composite: boolean | undefined;
+    use_dynamic_refresh_rate_in_steam: boolean | undefined;
+    split_scaling_filter: ESplitScalingFilter | undefined;
+    split_scaling_scaler: ESplitScalingScaler | undefined;
+}
+
+export enum ECPUGovernor {
+    Invalid,
+    Perf,
+    Powersave,
+    Manual,
+}

package/src/globals/steam-client/system/Report.ts

@@ -0,0 +1,39 @@
+import { JsPbMessage, OperationResponse } from "../shared";
+
+export interface Report {
+    /**
+     * Generates a system report located in `/tmp/steamXXXXXX` (located in
+     * https://steamloopback.host/systemreports).
+     */
+    GenerateSystemReport(): Promise<SystemReportReply>;
+
+    /**
+     * Saves a report in the Desktop directory.
+     * @param reportId The report ID (file name) to save.
+     */
+    SaveToDesktop(reportId: string): Promise<OperationResponse>;
+
+    /**
+     * @param reportId The report ID (file name) to submit.
+     * @todo times out ({@link Result.Timeout})
+     */
+    Submit(reportId: string): Promise<OperationResponse>;
+}
+
+export interface SystemReportReply extends OperationResponse {
+    /**
+     * If deserialized, returns {@link CMsgGenerateSystemReportReply}.
+     * 
+     * Optional, since {@link Report.GenerateSystemReport} throws without this.
+     */
+    reply?: ArrayBuffer;
+}
+
+export interface CMsgGenerateSystemReportReply extends JsPbMessage {
+    /**
+     * The report file name.
+     */
+    report_id(): string | undefined;
+
+    set_report_id(param0: any): any;
+}

package/src/globals/steam-client/system/UI.ts

@@ -0,0 +1,38 @@
+import { Unregisterable } from "../shared";
+
+export interface UI {
+    CloseGameWindow(appId: number, windowId: number): void;
+
+    GetGameWindowsInfo(appId: number, windowIds: number[]): Promise<GameWindowInfo>;
+
+    RegisterForFocusChangeEvents(callback: (event: FocusChangeEvent) => void): Unregisterable;
+
+    // appId is 0 if unknown app is focused
+    RegisterForOverlayGameWindowFocusChanged(callback: (appId: number, overlayPid: number) => void): Unregisterable;
+
+    RegisterForSystemKeyEvents(callback: (event: SystemKeyEvent) => void): Unregisterable;
+}
+
+interface SystemKeyEvent {
+    /** @todo enum */
+    eKey: number;
+    nControllerIndex: number;
+}
+
+export interface FocusChangeEvent {
+    focusedApp: FocusedApp;
+    rgFocusable: FocusedApp[];
+}
+
+export interface FocusedApp {
+    appid: number;
+    pid: number;
+    windowid: number;
+    strExeName: string;
+}
+
+export interface GameWindowInfo {
+    bCanClose: boolean;
+    strTitle: string;
+    windowid: number;
+}