ETC Unison Paradigm Serial Access Protocol User Manual

E T C ® C o n f i g u r a t i o n G u i d e

Paradigm Serial Access Protocol (PSAP)

Overview

The Paradigm ACP can be controlled through its local RS232 serial port and Ethernet interface using a default command structure referred to as the Paradigm Serial Access Protocol (PSAP). All aspects of serial communication can be configured in LightDesigner, including RS232 serial port baud rate and UDP packet settings.

LightDesigner Setup

LightDesigner offers three types of serial options and three groupings of properties to configure them including “RS232 Serial Config”, “UDP Serial Config” and “ACN Serial Config”. To view and set these properties, select a Processor from the Browser. The properties of the selected Processor will display in the Property Editor.

Expand the “RS232 Serial Config” property to view the port setup. Default settings are Baud Rate of 9600, Parity None, 1 Stop Bit (8 data bits is mandatory).

Expand the “UDP Serial Config” property to view the port setup. Input UDP Port defaults to “0” and the Input Handler defaults to [None]. ETC recommends setting the Input UDP Port property in the range of 4703-4727. This same port will be used for replies sent from the Paradigm Architectural Control Processor (P-ACP). If needed, contact ETC Technical Support for additional support with UDP serial setup.

Expand the “ACN Serial Config” property to view the port setup. ACN Serial Config allows for reliable communication between devices that support this method over ACN using simple setup. Devices with matching “ACN Name” property value will connect and communicate.

•For example, a processor's ACN Serial PSAP Input Handler will by default listen to any device configured to send using an ACN Name of "ETC P-ACP". The same Processor will also respond to any queries using the same ACN Name, so any other devices configured to receive from that ACN Name will get all responses. It is possible to specify multiple ACN Names using comma separation in the property, but note that the PSAP input handler will respond to all devices with a matching ACN Name.

N o t e :	Devices with matching “ACN Name” property are considered part of a broadcast
	domain, and will hear anything sent in that session.
N o t e :	ETC recommends that serial communications via Ethernet contain no more than 512
	bytes per packet.

Corporate Headquarters  3031 Pleasant View Road, P.O. Box 620979, Middleton, Wisconsin 53562-0979 USA  Tel [phone]  Fax [phone]
London, UK  Unit 26-28, Victoria Industrial Estate, Victoria Road, London W3 6UU, UK  Tel [phone]  Fax [phone]
Rome, IT  Via Pieve Torina, 48, 00156 Rome, Italy  Tel [phone]		 Fax [phone]
Holzkirchen, DE  Ohmstrasse 3, 83607 Holzkirchen, Germany  Tel +49 (80		24) 47 00-0  Fax [phone]	 Fax [phone]
Hong Kong  Rm 1801, 18/F, Tower 1 Phase 1, Enterprise Square, 9 Sheung Yuet Road, Kowloon Bay, Kowloon, Hong Kong  Tel [phone]
Service: (Americas) [e-mail]	 (UK) [e-mail]	 (DE) [e-mail]  (Asia) [e-mail]
Web: www.etcconnect.com  Copyright © 2012	ETC. All Rights Reserved.  Product information and specifications subject to change.
7180M2400  Rev E  Released 2012-08  ETC intends this document to be provided in its entirety.

PSAP Configuration Guide

Page 1 of 7

Electronic Theatre Controls, Inc .

E T C C o n f i g u r a t i o n G u i d e

Paradigm Serial Access Protocol (PSAP)

N o t e :	With “Advanced” level user access,
	LightDesigner offers a property called
	“Verbose Logging”, nested beneath the “Input
	Handler” node for each serial option when
	PSAP 2.1 is the selected setting.
	“Verbose Logging” defaults to Disabled, but
	can be set to log additional data internally
	using ASCII, Decimal, or Hexidecimal data
	formatting.
	This can be useful when troubleshooting a
	communications problem, but generally
	should be left as disabled for system
	efficiency. Contact ETC Technical Support for
	additional support with logging features.

Input Handler Options

Twirl open the “Input Handler” node that is nested beneath the selected serial option node. Depending on the LightDesigner user access level, several configuration options are displayed when the Input Handler is set to “PSAP 2.1”.

•End of Message Char - an “Advanced” level user access feature. By default the end of message is a single byte carriage return (shown as “CR”), which is equal to 13 decimal and 0D hexadecimal. Other options for this property are carriage return plus line feed (CR+LF) and just a line feed character (LF).

•Verbose Logging - an “Advanced” level user access feature. Can be set to log data internally using ASCII, Decimal, or Hexidecimal data formatting.

•UStrings - 20 user definable strings and actions that when received will execute the corresponding UString Action.

•UString Actions - 20 user definable actions that are executed when the corresponding UString data is received.

For example, configuring the following:

•UString 1 = hello

UString 1 Action = Sequence Start for Sequence 1

Results in the following:

Step 1: When “hello” is received, Sequence 1 will start.

N o t e :	By default, an ASCII carriage return character (which is encoded as 13 decimal and
	0D Hex) is used to terminate or signal the end of any comment, received or sent.
	Received commands are only considered complete once the terminating character
	has been received by Paradigm.
	Data sent from the Paradigm Architectural Control Processor (P-ACP) will also end
	with the terminating character. Contact ETC Professional Services if support for
	another terminating character is required.

PSAP Configuration Guide

Page 2 of 7

Electronic Theatre Controls, Inc.

E T C C o n f i g u r a t i o n G u i d e

Paradigm Serial Access Protocol (PSAP)

Standard PSAP Commands

The following section lists the standard types of serial commands that are supported by the Paradigm Serial Access Protocol (PSAP).

Conventions of Use

•Generic names such as “channame” must be replaced with the actual object names used within the LightDesigner configuration.

N o t e :	All names are case sensitive and must match the names to LightDesigner exactly.
	Additionally, to allow for proper operation avoid the use of commas “,” and colons “:”
	in configuration object names since these characters are instrumental in the string
	parsing logic.

•Values such as “level” and “amount” must be replaced with either a value of 0-255 or 0-100%. Both formats are supported; use of the percent “%” symbol indicates when the value should be treated as a percentage.

•Items listed inside of braces “[ ]“are optional parameters that use a comma “,” as a delimiter.

•White space must separate individual command parameters. White spaces are allowed in object names as well.

•By default, an ASCII carriage return character (which is encoded as 13 decimal and 0D Hex) is used to terminate or signal the end of any command, received or sent. Contact ETC Professional Services if support for another terminating character is required.

•PSAP will return a list of available commands by issuing either ? or help followed by the terminating character (by default this is a carriage return).

Control Channel Commands

Received Data	Resulting Action
chan int:level channame[, spacename]	Sets intensity to level
chan ras:amount channame[, spacename]	Raises intensity by amount
chan low:amount channame[, spacename]	Lowers intensity by amount
chan tog channame[, spacename]	Toggles intensity
chan min:level channame[,spacename]	Sets minimum level for a channel
chan max:level channame[,spacename]	Sets maximum level for a channel
chan int:128 Zone 1	sets Zone 1 to 50% intensity
chan int:75% Dimmer 2, Primary Space 1	Sets Dimmer 2 in Primary Space 1 to 75%

N o t e :	Remember, received commands are only considered complete once the terminating
	character has been received by Paradigm. Data sent from the P-ACP will also end with
	the terminating character.
Group Commands

Fade time format is x.y seconds, with support for tenths of seconds. To use fadetime parameter in your group command, you must specify a space name.

Received Data

grp int:level grpname[, spacename][, fadetime] grp ras:amount grpname[, spacename][, fadetime] grp low:amount grpname[, spacename][, fadetime] grp tog grpname[, spacename][, fadetime]

Resulting Action

Sets intensity to level value Raises intensity by amount Lowers intensity by amount Toggles Group intensity

	grp int:128 Group 1, 3	sets Group 1 intensity to 50% using a
		3 second fade

PSAP Configuration Guide

Page 3 of 7

Electronic Theatre Controls, Inc.