Fixture#

A Fixture object is returned from get_fixture.

Properties#

Property

Value Type

Description

Value Example

groups

Table of Group objects

A list of the groups containing this fixture

issues

Table of issues
  • ISSUE_ADDRESS_MISMATCH At least one of this fixture’s RDM devices is set to the wrong DMX start address

  • ISSUE_OUTPUT_MISMATCH At least one of this fixture’s RDM devices was discovered on an unexpected output

A list of issues affecting this fixture

{ISSUE_ADDRESS_MISMATCH}

manufacturer

string

Manufacturer name of the fixture

"Example Manufacturer"

name

string

Fixture name

"Downlight"

number

integer

User number

1

patch

Table of PatchPoint objects

Patch points assigned to this fixture

protocol

  • PROTOCOL_DMX Fixture uses DMX

  • PROTOCOL_DALI Fixture uses DALI

The output protocol used by this fixture

PROTOCOL_DMX

status

  • STATUS_ONLINE Fixture marked as online

  • STATUS_PARTIALLY_OFFLINE Fixture marked as partially offline

  • STATUS_OFFLINE Fixture marked as offline

  • STATUS_LOADING Fixture marked as loading

  • STATUS_UNKNOWN Fixture marked as unknown status

The status of this fixture

STATUS_ONLINE

type

string

Fixture type from the fixture library

LED - RGBW 8 bit

updated_at

DateTime or nil

The last status update for this fixture or nil if there has been no update

custom_properties

table of strings

The custom properties for this fixture as configured in Designer

{"Location" = "Room 1"}

rdm_devices

table of RDM DeviceId

RDM UIDs associated with this fixture - empty if fixture has no RDM devices associated (e.g. a DALI fixture)

For example:

-- get a list of all offline fixtures
local offlineFixtures = get_fixtures(STATUS_OFFLINE)
log('Offline fixtures in project:')
for _, fixtureNum in pairs(offlineFixtures) do
   -- get details of fixture
   local fixture = get_fixture(fixtureNum)
   log('- Number: ' .. fixtureNum)
   log('- Name: ' .. fixture.name)
   if (fixture.protocol == PROTOCOL_DMX) then
      log('- Protocol: ' .. DMX)
   elseif (fixture.protocol == PROTOCOL_DALI ) then
      log('- Protocol: ' .. DALI)
   end
   log('- Last updated: ' .. tostring(fixture.updated_at))
end