[Feature]: Add the ability to use custom variables to set fader values.

[bront32]

Make sure you have updated to the latest version of the module

• I have checked this on the latest version of the module

Is there an existing issue for this?

• I have searched for similar existing issues

Describe the feature

I see that Soundcraft variables are very close to being implemented - thankyou fmalcher
At this point, when creating a button action to set a relative or absolute value to a fader, only integer values are allowed in the "value" field.

Usecases

I am creating buttons to quickly toggle:

1. boosted levels for instrument input faders during solos and ...
2. reduce the volume of the rhythm section subgroup during acoustic instrument solos and return after the solo.
   The amount of boost or cut needs to be adjusted during performances. So I want to use custom variables (the values of which are set with other buttons) to pass the required boost amount to input or subgroup - not a static integer value that can't be changed during the performance.

[fmalcher]

This is possible, but it requires to set the input type to text.
This means we cannot display a range slider or up/down buttons anymore but just a plain text field – but we can support variables then. Is it worth it?

[bront32]

I think most users would be happy to type a value in.  The ability to use a variable is an added feature...just what I and probably others need.

[fmalcher]

Do you know (or can you find out) about other Companion modules that do it the same way, or even aome who don't?
I see your usecase, but I'd like to know whether using a text input with variables is a common practice.

[bront32]

Hmm, I am a new user of Companion so can't answer that. I am not sure of the architecture, where your module ends and Companion begins.  From what you say, it seems the input field and the passing of data to your module is Companion and your concern is how Companion supports text in the value field. Is that correct? I will investigate today and get back to you.

[fmalcher]

Not quite 😊 Companion supports text fields with variables, so we can use them. The input validation is on our side.
However, to know that we're not on the wrong track, It would be super helpful to know: Are there other Companion modules with actions that use text inputs for numeric values (like fader levels)?
If this is common practice among other modules, I have no concerns to implement this, too.

[fmalcher]

Question answered in the Slack channel:

[Philipp] I have done that in some places. Then just parse the string to a number. It's also common to have a use variable check box, and use isVisibleExpression to toggle between number and string input fields. Which creates a nice UI, but requires a little more boilerplate.

[Dist] I use text inputs for things that expect numbers all over the place. I just then parse the variable and do sanity checking to ensure it is a number, and depending on the use case either return an error if it's outside the range or force it to within a min/max.

[bront32]

It seems this is being looked at by the Companion developers: [https://github.com/bitfocus/companion/pull/3617]
They are having similar discussions about using a checkbox to toggle text or number field type.