Fixtures#

Note

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

All properties described below relating to a fixture or device’s status are obtained by the Status Monitor.

Fixtures Overview#

Get an overview of fixtures used in the current project including their statuses.

GET /api/fixtures

Returns a JSON array of objects with the following attributes:

Attribute	Value Type	Description	Value Example
`space`	string	Name of the immediate parent space containing this fixture	`"1: Project Space"`
`manufacturer`	string	Manufacturer name as defined in the fixture library	`"Generic"`
`number`	integer	User number of the fixture	`1`
`patch`	string	Combined universe key and address (see Universe Key String Format)	`"dmx:2:101"`
`protocol`	string	`"dali"`, or `"dmx"`	`"dmx"`
`status`	string	`"online"`, `"partially_offline"`, `"offline"`, `"loading"`, or `"unknown"`	`"online"`
`updated_at`	string	ISO 8601-formatted timestamp of the last status update, or `null` if unknown	`2024-06-27T09:30`

If the with_custom_properties query parameter is true, the following additional attribute is included for each fixture.

Attribute	Value Type	Description	Value Example
`custom_properties`	object	Object properties and property values correspond to custom property names and values	`{ "Custom Property 1": "value" }`

If the with_rdm_devices query parameter is true, the following additional attribute is included for each fixture:

Attribute	Value Type	Description	Value Example
`rdm_devices`	array of objects	A list of RDM devices associated with this fixture	`[ { "uid": "1234:56789abc" } ]`

Get detailed information for a single fixture including its status.

GET /api/fixtures/{fixtureNumber}

Returns a JSON object with the same properties as contained in the Fixtures Overview GET response.

A universe key string takes the form:

protocol:index where:
- protocol is dmx, sacn, or art-net;
- index is the index of the output port, 1 or 2, matching the port on the Express controller.

For example: