update to TTYSettings

koush · Aug 5, 2024 · 1fe581a · 1fe581a
1 parent 2372dbc
commit 1fe581a
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 19 deletions.
diff --git a/sdk/types/scrypted_python/scrypted_sdk/types.py b/sdk/types/scrypted_python/scrypted_sdk/types.py
@@ -183,9 +183,9 @@ class ScryptedInterface(str, Enum):
     StartStop = "StartStop"
     StreamService = "StreamService"
     TTY = "TTY"
+    TTYSettings = "TTYSettings"
     TamperSensor = "TamperSensor"
     TemperatureSetting = "TemperatureSetting"
-    TerminalSettings = "TerminalSettings"
     Thermometer = "Thermometer"
     UltravioletSensor = "UltravioletSensor"
     VOCSensor = "VOCSensor"
@@ -1478,6 +1478,13 @@ class TTY:
 
     pass
 
+class TTYSettings:
+    """TTYSettings allows TTY backends to query plugins for modifications to the (non-)interactive terminal environment."""
+
+    async def getTTYSettings(self) -> Any:
+        pass
+
+
 class TamperSensor:
 
     tampered: TamperState
@@ -1490,13 +1497,6 @@ async def setTemperature(self, command: TemperatureCommand) -> None:
         pass
 
 
-class TerminalSettings:
-    """TerminalSettings allows TerminalService to query plugins for modifications to the (non-)interactive terminal environment."""
-
-    def getPaths(self) -> list[str]:
-        pass
-
-
 class Thermometer:
 
     temperature: float  # Get the ambient temperature in Celsius.
@@ -1936,7 +1936,7 @@ class ScryptedInterfaceMethods(str, Enum):
     getScryptedUserAccessControl = "getScryptedUserAccessControl"
     generateVideoFrames = "generateVideoFrames"
     connectStream = "connectStream"
-    getPaths = "getPaths"
+    getTTYSettings = "getTTYSettings"
 
 class DeviceState:
 
@@ -3151,10 +3151,10 @@ def systemDevice(self, value: ScryptedSystemDeviceInfo):
     "methods": [],
     "properties": []
   },
-  "TerminalSettings": {
-    "name": "TerminalSettings",
+  "TTYSettings": {
+    "name": "TTYSettings",
     "methods": [
-      "getPaths"
+      "getTTYSettings"
     ],
     "properties": []
   },

diff --git a/sdk/types/src/types.input.ts b/sdk/types/src/types.input.ts
@@ -1537,14 +1537,13 @@ export interface StreamService<Input, Output=Input> {
 export interface TTY {
 }
 /**
- * TerminalSettings allows TerminalService to query plugins for modifications
+ * TTYSettings allows TTY backends to query plugins for modifications
  * to the (non-)interactive terminal environment.
  */
-export interface TerminalSettings {
-  /**
-   * List of extra PATHs to add to the terminal environment
-   */
-  getPaths(): string[];
+export interface TTYSettings {
+  getTTYSettings(): Promise<{
+    paths?: string[];
+  }>;
 }
 /**
  * Logger is exposed via log.* to allow writing to the Scrypted log.
@@ -2162,7 +2161,7 @@ export enum ScryptedInterface {
   VideoFrameGenerator = 'VideoFrameGenerator',
   StreamService = 'StreamService',
   TTY = 'TTY',
-  TerminalSettings = 'TerminalSettings',
+  TTYSettings = 'TTYSettings',
 
   ScryptedSystemDevice = "ScryptedSystemDevice",
   ScryptedDeviceCreator = "ScryptedDeviceCreator",