4 feature ids, 5 permutations, 3 channel/feature values – LSC Lighting CLARITY LX Series v.1 User Manual

Page 261: 4 programmer api functions

Advertising
background image

Clarity

Appendix

Operator Manual

Page 251

44.2.4 Feature IDs

Many other functions instead accept Feature IDs, which are similar to Channel IDs, but are the

names you would see on the LX’s universal windows. For example:


In many cases these will be the same, but that is not always the case. An example would be for

a colour wheel. The Channel ID would be ”Colour Wheel” but the relevant Feature ID to select a
slot would be “Colour Wheel Select”. Typically, functions that accept a Channel ID identify a

whole channel, and the value applied will be a raw percentage. Functions that accept a Feature
ID are generic, and will adapt the value for the underlying type of the fixtures being controlled

(in the same way the LX Universal controls do).

44.2.5 Permutations

When more than one channel/feature of a given ID exists, then by default the
ChannelID/FeatureID refers to the first instance. You can specify other instances by appending
the permutation index. For example “Intensity#2”.

44.3 CHANNEL/FEATURE VALUES
A basic value can be specified as a number or a percentage. You can also specify them as a range

or as a comma separated list of values. For example.

setFeatureStaticValue(“Intensity”, 50) // sets to 50%
setFeatureStaticValue(“Intensity”, “50%”) // same (need quotes if using % symbol)
setFeatureStaticValue(“Intensity”, “25/75”) // fans intensity from 25% to 75%
setFeatureStaticValue(“Intensity”, “25,50,75”) // results in 25,50,75,25,50,75 etc.

The value depends on what is being controlled. If a channel is being controlled (for example, the

setChannelValue() function) then a basic value will be taken verbatim. If a percentage value is
given, then it will respect the hi-res/low-res size of the channel (for example, 50% would be 127

for an 8-bit channel and 32767 for a 16-bit channel). When a feature is being controlled (for
example, the setFeatureStaticValue() function) then values are nearly always taken to be
percentage. Slots will be indices (for example, setFeatureStaticValue(“Colour Wheel Select”, 2)

will dial up the second slot on the colour wheel).

44.4 PROGRAMMER API FUNCTIONS

setChannelValue(channelId, channelValue)

Sets the relevant channel in each fixture to the value specified. The channelValue should be

specified as a percentage so that it adapts to the size of the channel being controlled (hi-res/low-
res) otherwise the value is taken as a verbatim raw decimal value.

clearChannel(channelIdList)

Clears the channel(s) in each fixture. Eg. clearChannel(“Pan,Tilt”).

setFeatureStaticValue(featureId, featureValue)

Sets the relevant feature in each fixture.

Advertising
This manual is related to the following products: