feat: allow specifying 'learn' function timeout

bitfocus · Nov 27, 2023 · d6b2f72 · d6b2f72
1 parent beef8b9
commit d6b2f72
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 3 deletions.
diff --git a/src/host-api/api.ts b/src/host-api/api.ts
@@ -103,22 +103,24 @@ export interface SetActionDefinitionsMessage {
 	actions: Array<{
 		id: string
 		name: string
-		description?: string
+		description: string | undefined
 		options: EncodeIsVisible<SomeCompanionActionInputField>[] // TODO module-lib - versioned types?
 		hasLearn: boolean
+		learnTimeout: number | undefined
 	}>
 }
 
 export interface SetFeedbackDefinitionsMessage {
 	feedbacks: Array<{
 		id: string
 		name: string
-		description?: string
+		description: string | undefined
 		options: EncodeIsVisible<SomeCompanionFeedbackInputField>[] // TODO module-lib - versioned types?
 		type: 'boolean' | 'advanced'
-		defaultStyle?: Partial<CompanionFeedbackButtonStyleResult>
+		defaultStyle?: CompanionFeedbackButtonStyleResult
 		hasLearn: boolean
 		showInvert: boolean | undefined
+		learnTimeout: number | undefined
 	}>
 }
 

diff --git a/src/internal/actions.ts b/src/internal/actions.ts
@@ -196,6 +196,7 @@ export class ActionManager {
 					description: action.description,
 					options: serializeIsVisibleFn(action.options),
 					hasLearn: !!action.learn,
+					learnTimeout: action.learnTimeout,
 				})
 
 				// Remember the definition locally

diff --git a/src/internal/feedback.ts b/src/internal/feedback.ts
@@ -393,6 +393,7 @@ export class FeedbackManager {
 					type: feedback.type,
 					defaultStyle: feedback.type === 'boolean' ? feedback.defaultStyle : undefined,
 					hasLearn: !!feedback.learn,
+					learnTimeout: feedback.learnTimeout,
 					showInvert: feedback.type === 'boolean' ? feedback.showInvert : false,
 				})
 

diff --git a/src/module-api/action.ts b/src/module-api/action.ts
@@ -56,6 +56,13 @@ export interface CompanionActionDefinition {
 		action: CompanionActionEvent,
 		context: CompanionActionContext
 	) => CompanionOptionValues | undefined | Promise<CompanionOptionValues | undefined>
+
+	/**
+	 * Timeout for the 'learn' function (in milliseconds)
+	 * Companion sets a default value of 5s, to ensure that the learn does not get stuck never completing
+	 * You can change this if this number does not work for you, but you should keep it to a sensible value
+	 */
+	learnTimeout?: number
 }
 
 /**

diff --git a/src/module-api/feedback.ts b/src/module-api/feedback.ts
@@ -115,6 +115,13 @@ export interface CompanionFeedbackDefinitionBase {
 		action: CompanionFeedbackInfo,
 		context: CompanionFeedbackContext
 	) => CompanionOptionValues | undefined | Promise<CompanionOptionValues | undefined>
+
+	/**
+	 * Timeout for the 'learn' function (in milliseconds)
+	 * Companion sets a default value of 5s, to ensure that the learn does not get stuck never completing
+	 * You can change this if this number does not work for you, but you should keep it to a sensible value
+	 */
+	learnTimeout?: number
 }
 
 /**