Presets wiki

[Colbix]

I've started using Bitfocus Companion v3.0 beta and wanted to develop a module as an existing one either wasn't compatible or didn't meet my use case. The wiki for presets¹ can be improved that would clarify aspects with module development. I thought to provide some feedback after my first go through with using presets where there were some knowledge gaps.

1. combineRgb reference in color and bgcolor reference. If combineRgb isn't imported it will cause an error, especially if trying to separate the presets into their own file. Recommend either include const { combineRgb } = require('@companion-module/base') at the beginning of the example code or make a note that it needs to be imported into the file where it's referenced.
2. this.setPresetDefinitions(presets). If used with v3.0 creates a TypeError. Recommend changing the example to self.setPresetDefinitions(presets) as it corrects the error.
3. options. A minor thing with options, but helps to clarify the use as it relates to actions, should mention they should be stacked if multiple options are located in the referenced actions. ie:

options: {
// options values to use
brightness_level_1: 100,
brightness_level_2: 75,
},

4. a broken link. the link at the end of the sentence "You can see the full list of values that can be set and their valid values in the style object here" is broken. Broken Style. Recommend using the following link instead: Style

I haven't quite figured out how to make use of the icons, maybe it's similar in use as the combineRgb where I'm missing an import? For now I've used a similar module that contained a base64 image of what I needed.

Overall I enjoyed the experience and am looking forward to v3.0 coming out of beta. Thank you for your time.

Footnotes

1. Presets ↩