Kuando Busylight

The Kuando Busylight connector controls Kuando Busylight status indicators. It changes the light's color and brightness, makes it blink or pulse, and plays the device's built-in sounds.

This connector requires instance creation before you can control a physical unit, though it includes a static utility for device scanning. Because a Busylight is a physical USB device on your premises, this function typically executes inside an Agent installed on the local computer where the light is connected (see the local connection scenario).

Device management

getDevices

Scans the local system and lists all connected Busylight devices.

Parameters

None.

Output

Returns an array of device objects containing details about each connected Busylight.

create

Creates an instance to control a specific Kuando Busylight and establishes a connection to it. To control multiple lights connected to the same computer, create one instance per device using its respective index.

Parameters

Input	Description	Type
deviceIndex	The zero-based index of the device to control, selected from the array returned by getDevices. Default 0.	integer

Example

# deviceIndex
1

Output

Returns the name of the created instance.

getName

Retrieves the model name of the connected device.

Parameters

None.

Output

Returns the device model name as a string (such as Busylight Omega model 2).

getTones

Retrieves all available tone names supported by the connected device.

Parameters

None.

Output

Returns an array of strings containing the names of all playable tones.

delete

Removes the instance and disconnects from the device.

Irreversible action

Deleting an instance removes its configuration. To control the device again, you must trigger create anew.

Parameters

None.

Output

Returns true upon removal.

Light and sound

setColor

Turns on the light with a solid, continuous color.

Parameters

Input	Description	Type
color	The desired color in any CSS-compatible format (such as #ff0000, rgb(255, 0, 0), or red).	string

Example

# color
'#0000FF'

Output

Returns the raw result of the underlying device driver. The value is not meant for further processing.

pulse

Fades the light in and out smoothly using the specified color.

Parameters

Input	Description	Type
color	The color to pulse, provided in any CSS-compatible format.	string

Example

# color
orange

Output

Returns the raw result of the underlying device driver. The value is not meant for further processing.

blink

Flashes the light using the specified color and timing configuration.

Parameters

Input	Description	Type
color	The color to blink, provided in any CSS-compatible format.	string
onDuration	The time in seconds the light stays on during each blink cycle. Default 0.5.	number
offDuration	The time in seconds the light stays off during each blink cycle. Default 0.3.	number

Example

# color
red
# onDuration
0.2
# offDuration
0.2

Output

Returns the raw result of the underlying device driver. The value is not meant for further processing.

setLightIntensity

Changes the brightness of the light. The new intensity applies immediately to the active light state and overrides the default for subsequent commands.

Parameters

Input	Description	Type
value	The light intensity measured in percent (0 to 100).	integer

Example

# value
50

Output

Returns nothing.

playTone

Plays one of the device's built-in sounds once.

Parameters

Input	Description	Type
name	The name of the tone to play, matching an item from the list returned by getTones.	string
volume	Optional volume level (0 to 10). If provided, this value also sets the new default volume. If omitted, the connector uses the last configured volume. Default 3.	integer

Example

# name
'Open Office'

Output

Returns the raw result of the underlying device driver. The value is not meant for further processing.

setToneVolume

Sets the default volume for all sounds played by the device.

Parameters

Input	Description	Type
value	The target volume level (0 to 10).	integer

Example

# value
7

Output

Returns true once the volume is set.

alert

Triggers a pre-configured alert sequence, combining a flashing red light and a tone to grab attention. The alert turns itself off automatically after a few seconds.

Parameters

None.

Output

Returns nothing.

off

Switches off the light and any playing sound immediately.

Parameters

None.

Output

Returns the raw result of the underlying device driver. The value is not meant for further processing.