USAP Objects, Properties and Actions

Rooms

In USAP, Room objects have no properties or actions, but are used when referencing the objects contained in them such as Presets, Walls, Sections, and Zones.

Sections

In USAP, section objects have no properties or actions but are used when referencing Zones contained in them, when obtaining the status of a Preset action, or section Master values.

Presets

Preset objects are referenced by Room and Section objects.

• To send commands which will affect a Preset, first reference the Room and then the Preset. Example: [BALLROOM.Dinner].
• To access properties or actions specific to a section in a divided room, you must reference the Room, the Section, and then the Preset. Example: [BALLROOM.Hall A.Dinner].

Preset Command Format:

You can place multiple commands for the same object on a single command line, provided they are each separated by a period.

Example: [ROOM NAME].[SECTION NAME].[PRESET NAME].COMMAND

Preset Commands: 

• Activate a preset: ACTI
• Deactivate a Preset: DACT
• Record a Preset: RECO
• Set a fade time for a Preset: nDFT= (time is entered in milliseconds)
• Get status of a Preset: bACT
  • (Unison will respond with Preset name and 1=active, or 0=not active)
• Get Priority status of a Preset: bAAP
  •  (Unison will respond with preset name and priority level)

Property	Description	Value
bACT bAAP   nDFT	Active (read only) Active at Priority (read only) Fade Time	False = Preset is not active True = Preset is active False = Preset is not active at it’s current priority True = Preset is active at it’s current priority milliseconds from 0 to 4294967295 (approximately 50 days)

 

Action	Description	Function
ACTI DACT RECO	Activate Deactivate Record	Activates the Preset at the current priority and with the current fade time Deactivates the Preset at the current priority and with the current fade time Record the Preset

Preset Examples:

Examples of preset commands:

Activate a Preset

• Command - [BALLROOM.Hall A.Dinner.ACTI]
• Response - [BALLROOM.Hall A.Dinner.ACTI]

Activate a Preset including Fade Time

• Command - [BALLROOM.Dinner.nDFT=5000]
• Response - [BALLROOM.Dinner.nDFT=5000]
  • *(5000 milliseconds = 5 second fade)

Get the Active state of a Preset in a Section

• Command - [BALLROOM.Hall A.Dinner.bACT.BAAP]
• Response - [BALLROOM.Hall A.Dinner.bACT.BAAP=0]
  • =0 means the preset is not active / =1 means the preset is active

Walls

Wall Command Format:

[ROOM NAME].[WALL NAME].COMMAND Wall Commands:

• Open a Wall: OPEN
  • Close a Wall: CLOS
• Toggle a Wall State: TOGL
• Get status of a Wall: bOPN
  • (Unison Processor will respond with Wall name and 1=open or 0=closed

Property	Description	Value
bOPN	Open	If false (=0), Wall is closed and related sections are not combined. If true (=1), Wall is open and related sections are combined.

 

Action	Description	Function
OPEN CLOS TOGL	Open Close Toggle	Wall state is set to Open (same as bOPN=1) Wall state is set to Close (same as bOPN =0) Wall state is toggled (open to closed, or closed to open)

Wall Examples

Get the open/close state of a wall

• Command - [BALLROOM.East Wall.bOPN]
• Response - [BALLROOM.East Wall.bOPN=0]
  • =0 means the wall is closed / =1 means the wall is open

Set the open/close state of a Wall

• Command - [BALLROOM.East Wall.bOPN=1]
• Response - [BALLROOM.East Wall.bOPN=1]
  OR
• Command - [BALLROOM.East Wall.OPEN]
• Response - [BALLROOM.East Wall.OPEN]

Toggle the open/close state of a Wall and get its new open/close state

• Command - [BALLROOM.East Wall.bOPN]
• Response - [BALLROOM.East Wall.BOPN=0]
  • =0 means the wall is closed / =1 means the wall is open

Zones

Zones are contained in Rooms or Sections and can be controlled by Presets. To send commands which will affect a Zone in a Room, first reference the Room and then the Zone. Example: [BALLROOM.Downlights].

If the Room is divided (or uses the Unison room combine feature), reference the Room and Section, and then the Zone. Example: [BALLROOM.Hall A.Downlights].

Macros

A Macro is a series of pre-stored commands that can be carried out by the Unison processor.

Macro Command Format:

[MACRO NAME].[COMMAND]

Macro Commands

Action	Description	Function
EXEC STOP	Execute Stop	Run the macro Stop the macro

Macro Examples

Run a Macro called Lockout

• Command - [Lockout.EXEC]
• Response - [Lockout.EXEC]

Stop a Macro called Lockout

• Command - [Lockout.STOP]
• Response - [Lockout.STOP]

Master

Sections of a room, including Section Zero, may be mastered by using the master value command. This command yields the same functionality as a station fader configured as Master for a serially connected device. This command may also be useful in monitoring the master value of a section if a station alters it.