Override

Note

The endpoints listed on this page require a project to be loaded on the controller.

Methods

PUT

Set the Intensity, Red, Green, Blue levels and Colour Temperature for a Group or Space.

PUT /api/override

Payload is a JSON object with the following attributes:

Attribute	Value Type	Description	Value Example
target	string	What the override should be applied to: group or space.	"space"
num	integer	Group or Space number depending on target.	1
intensity	integer or string	Optional. Either an integer (0-255) representing the intensity to set as part of override or the string "snapshot" to capture the current intensity of the fixture(s) and set this as the override value. Intensity override will not be changed if this attribute isn’t provided.	128
colour	Override Colour or string	Optional. Specifies the colour to set as part of the override. Either an Override Colour or the string "snapshot" to capture the current colour of the fixture(s) and set this as the override.
temperature	integer or string	Optional. Either an integer (0-255) representing the temperature component to set as part of override or the string "snapshot" to capture the current temperature component of the fixture(s) and set this as the override value. Temperature override will not be changed if this attribute isn’t provided.	128
fade	float	Optional. Fade time to apply the override change, in seconds.	2.0
path	string	Optional. Crossfade path to use when applying the override: Default, Linear, Start, End, Braked, Accelerated, Damped, Overshoot, Col At Start, Col At End, Int At Start, Int At End, Colour First, Intensity First	"Braked"

Override Colour

The value of the colour attribute in a PUT override request is a JSON object, specifying colour as either RGB or Hue/Saturation values.

RGB

Colour as RGB for colour in an override PUT request:

Attribute	Value Type	Description	Value Example
red	integer or string	Optional. Red component to set as part of override: 0-255, or a percentage (0-100) followed by the % sign. Red override will not be changed if this attribute isn’t provided.	255
green	integer or string	Optional. Green component to set as part of override: 0-255, or a percentage (0-100) followed by the % sign. Green override will not be changed if this attribute isn’t provided.	255
blue	integer or string	Optional. Blue component to set as part of override: 0-255, or a percentage (0-100) followed by the % sign. Blue override will not be changed if this attribute isn’t provided.	255

Hue/Saturation

Colour as hue/saturation for colour in an override PUT request:

Attribute	Value Type	Description	Value Example
hue	integer	Hue component to set as part of override: 0-255.	0
saturation	integer	Saturation component to set as part of override: 0-255.	255

Note

Both hue and saturation are required for the request to be valid.

DELETE

Release any overrides on a Space.

DELETE /api/override

Payload is a JSON object with the following attributes:

Attribute	Value Type	Description	Value Example
target	string	What the overrides should be cleared on. Only space is supported.	"space"
num	integer	Optional Space number. If not provided, target is ignored and all overrides are cleared.	1
fade	float	Optional. Fade time in which to release overrides, in seconds.	2.0