Central Control Server BACnet Interface Object Reference Guide C o p y r i g h t © 2 0 1 2 E le c tr o n i c T h e a t r e C o n t r o l s , I n c . All Rights reserved. P r o d u c t in f o r m a t i on a n d s p e c i f i c a t i o n s s u bj e c t t o c h a n g e .
Contacting ETC If you are having difficulties, your most convenient resources are the references given in this reference guide. To search more widely, try the ETC Web site at www.etcconnect.com. If none of these resources are sufficient, contact ETC Technical Services directly at one of the offices identified below. Emergency service is available from all ETC offices outside of normal business hours. When calling for help, please have the following information handy: • Your location and job name.
Table of Contents Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 1 Object Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.1 Analog Input Object Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 1.2 Analog Output Object Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 1.
3.5 EtcErrorSeverity Datatype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20 3.6 EtcTimedEventStatus Datatype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20 3.7 EtcAstronomicalEvent Datatype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20 3.8 EtcTimeType Datatype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20 3.9 EtcRecurrence Datatype . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Purpose This document provides detailed information regarding objects that are exposed for use within the Paradigm Central Control Server (P-CCS) BACnet IP interface. This document provides additional information, beyond the Protocol Implementation Conformance Statement (PICS), as needed to develop BACnet client support for proprietary object types. The PICS document is provided in the LightDesigner online help system or available on the ETC web site at www.etcconnect.com.
1 - Object Types The Paradigm Central Control Server (P-CCS) BACnet interface provides twelve (12) object types; four (4) of them are standard BACnet object types and eight (8) of are ETC proprietary object types. This document section provides user detailed information for the construction of each of these client readable object types. 1.
1.
1.
1.
1.5 ETC Macro Object Type ETC Macro: BACn et Properties List Property Identifier Property Datatype Property Brief Description Object_Identifier BACnetObjectIdentifier Numeric code uniquely identifying this object Object_Name CharacterString Alphanumeric string identifying this object Object_Type BACnetObjectType Always: "OBJECT_MACRO" or decimal 132 Present_Value EtcMacroStatus Current status of object (see 3.1).
1.6 ETC Preset Object Type ETC Preset: BACnet Properties List Property Identifier Property Datatype Property Brief Description Object_Identifier BACnetObjectIdentifier Numeric code uniquely identifying this object Object_Name CharacterString Alphanumeric string identifying this object Object_Type BACnetObjectType Always: "OBJECT_PRESET" or decimal 152 Present_Value EtcPresetStatus Current Global status this object (see 3.2).
1.7 ETC Override Object Type ETC Override: BACnet Properties List Property Identifier Property Datatype Property Brief Description Object_Identifier BACnetObjectIdentifier Numeric code uniquely identifying this object Object_Name CharacterString Alphanumeric string identifying this object Object_Type BACnetObjectType Always: "OBJECT_OVERRIDE" or decimal 136 Present_Value EtcOverrideStatus Current status this object (see 3.3).
1.
1.
1.
1.11 ETC Timed Event Object Type ETC Timed Event: BACnet Prop erties List Property Identifier Property Datatype Property Brief Description Object_Identifier BACnetObjectIdentifier Numeric code uniquely identifying object Object_Name CharacterString Alphanumeric string identifying this object Object_Type BACnetObjectType Always: "OBJECT_TIMED_EVENT" or 168 Present_Value EtcTimedEventStatus Current status of object (see 3.6).
1.12 ETC Action Script Template Object Type ETC Action Script Template: BACnet Properties List Property Identifier Property Datatype Property Brief Description Object_Identifier BACnetObjectIdentifier Numeric code uniquely identifying object Object_Name CharacterString Alphanumeric string identifying this object Object_Type BACnetObjectType "OBJECT_ACTION_SCRIPT_TEMPLATE" 164 Present_Value EtcTargetType Current target type of this object (see 3.10).
1.
2 ETC Structures The Paradigm Central Control Server (P-CCS) BACnet interface provides a series of ETC specific data structures that are used within the ETC proprietary object types. The following tables provide the user detailed information of the construction of each of these client readable data structures 2.
2.5 ETCWall Structure EtcWall: Structure Definition Field DataType Field Name Description CharacterString name WALL designation EtcBACnetCID wallBCID Unique identifier for this WALL Unsigned16 noOfMetaData Number of metadata strings EtcMetaData metadata MetaData for this WALL EtcWallStatus status "Open"' or "Closed" 2.
2.9 ETCActionScriptSelection Structure EtcActionScriptS election: Structure Definition Field DataType Field Name Description EtcBACnetCID actionScriptTemplateBCID Unique identifier for this A.S. Selection EtcBACnetCID selectedObjectBCID Selected Object's BACnet CID Unsigned16 noOfArgumentValues Number of Arguments Unsigned16 argumentValues[] Argument Values 2.
2.
3 Enumerations The Paradigm Central Control Server (P-CCS) BACnet interface provides a series of Paradigm specific enumerations that are used within the ETC proprietary object types and their structures. The following tables provide use detailed information of the various values for each of these enumerations. 3.
3.
3.9 EtcRecurrence Datatype Enumeration Description ONCE Occurs only once HOURLY Reoccurs hourly DAILY Reoccurs daily WEEKLY Reoccurs weekly MONTH Reoccurs monthly YEARLY Reoccurs yearly CUSTOM Reoccurs at a custom interval HOLIDAY Reoccurs based on a ETC HOLIDAY 3.
3.
4 ETC Proprietary Object Types and Properties The ASHRAE Standard BACnet 135-2004 specifies that all object types and their properties support being referenced by a unique object identifier. The following tables list ETC proprietary and Paradigm specific decimal constant Object_Identifer values for objects and properties. 4.
24 PROPRIETARY BACnet Property Decimal Constant PROP_BINARY_OUTPUT_BCID 554 PROP_CHANNEL_BCID 522 PROP_CHANNEL_INTENSITY 521 PROP_CHANNEL_NAME 523 PROP_CHANNEL_VALUE 537 PROP_CHILD_SPACES 538 PROP_CONTROL_OBJECT 617 PROP_CREATE_OBJECT 562 PROP_DELETE_OBJECT 563 PROP_END_ACTION 540 PROP_END_ACTION_ARGUMENT_VALUES 602 PROP_END_ACTION_AST_BCID 607 PROP_END_ACTION_AST_NAME 594 PROP_END_ACTION_NO_OF_ARG_VALUES 600 PROP_END_ACTION_SELECTED_OBJECT_BCID 605 PROP_END_ACTION_SELECTED_
PROPRIETARY BACnet Property Decimal Constant PROP_PRESET_STATUS 525 PROP_PRESET_VALUE 548 PROP_PRESETS_FOR_SPACE 549 PROP_RECURRENCE 550 PROP_RECURRENCE_CUSTOM_DATES 609 PROP_RECURRENCE_END_DATE_TIME 592 PROP_RECURRENCE_HOLIDAY_BCID 610 PROP_RECURRENCE_MONTHLY_MONTHDAY 582 PROP_RECURRENCE_MONTHLY_MONTHWEEK 583 PROP_RECURRENCE_MONTHLY_WEEKDAY 584 PROP_RECURRENCE_NO_OF_CUSTOM_DATES 608 PROP_RECURRENCE_ONCE_DAY 581 PROP_RECURRENCE_ONCE_MONTH 580 PROP_RECURRENCE_ONCE_YEAR 579 PROP_
Proprietary BACnet Object Type 26 Decimal Constant PROP_KWH_CONSUMPTION 520 PROP_CHANNEL_INTENSITY 521 PROP_CHANNEL_BCID 522 PROP_CHANNEL_NAME 523 PROP_PRESET_NAME 524 PROP_PRESET_STATUS 525 PROP_PRESET_BCID 526 PROP_WALL_NAME 527 PROP_WALL_STATUS 528 PROP_WALL_BCID 529 PROP_ETC_MODEL_NAME 530 PROP_ERROR_SEVERITY 531 PROP_ERROR_TEXT 532 PROP_ERROR_NO 533 PROP_ARGUMENT_BLOCKS 534 PROP_BEGIN_TIME 535 PROP_END_TIME 536 PROP_CHANNEL 537 PROP_CHILD_SPACES 538 PROP_ERR_DEV
Proprietary BACnet Object Type Decimal Constant PROP_END_TIME_ASTRO 573 PROP_BEGIN_TIME_OFFSET_MINUTES 574 PROP_END_TIME_OFFSET_MINUTES 575 PROP_BEGIN_TIME_DURATION 576 PROP_END_TIME_DURATION 577 PROP_RECURRENCE_TYPE 578 PROP_RECURRENCE_ONCE_YEAR 579 PROP_RECURRENCE_ONCE_MONTH 580 PROP_RECURRENCE_ONCE_DAY 581 PROP_RECURRENCE_MONTHLY_MONTHDAY 582 PROP_RECURRENCE_MONTHLY_MONTHWEEK 583 PROP_RECURRENCE_MONTHLY_WEEKDAY 584 PROP_RECURRENCE_YEARLY_MONTH 585 PROP_RECURRENCE_YEARLY_MONTHD
5 Timed Event Handling The Timed Event object type is somewhat special, in that new object instances can be created by the user. In addition, existing "Timed Event" instances may be controlled, modified, or even deleted. This section describes, in detail, the BACnet client's process of creating, controlling and/or deleting Paradigm system Timed Events using BACnet. 5.1Creating a New Timed Event Instance Step 1: Write the Timed Event "Name".
Timed Event object, using the property type: "PROP_BEGIN_TIME_OFFSET_MINUTES". This is an integer data-type with a value between -1439 and 1439. • If a Duration Time Type: • Perform a BACnet "Write Property" command on Instance Zero of the Timed Event object, using the property type: "PROP_BEGIN_TIME_DURATION". This is an integer data-type with a value between 0 and 2,147,483,647 (minutes). Step 5: Write the Timed Event "End Time". If no event duration is required, set this equal to the "Start Time".
selection of Sunday and Friday. • If a Monthly Recurrence • Perform a BACnet "Write Property" command on Instance Zero of the Timed Event object. Use the property type: "PROP_RECURRENCE_MONTHLY_MONTHDAY" if a "specific day of the month" is desired. This is an integer data-type with a value ranging between 1 and 31. • Alternately, if a "WeekDay of a MonthWeek" is desired (i.e.
c: Using the returned property value, perform a "Read Property" for the object type: OBJECT_ACTION_SCRIPT_TEMPLATE, this time using the property: "PROP_NO_OF_ARGUMENT_BLOCKS". The returned property value is an integer with range 0-4 and specifies the number of argument values that will be provided below. d: Next, perform a BACnet "Write Property" command on Instance Zero of the Timed Event object, using the property type: "PROP_START_ACTION_NO_OF_ARG_VALUES".
d: Next, using the AST instance number returned above, perform a "Read Property" for the object type: OBJECT_ACTION_SCRIPT_TEMPLATE, using the BACnet standard property: "PROP_PRESENT_VALUE" (decimal constant 85). The returned property value is the target type that will be used below. e: Perform a BACnet "Write Property" command on Instance Zero of the Timed Event object, using the property type: "PROP_END_ACTION_SELECTED_OBJECT_TYPE".
• This action will send a request for modification to the P-CCS. If the P-CCS agrees to the modification, an UCOV (Unconfirmed Change of Value) message will be received verifying the Timed Event modification. 5.2Deleting an existing Timed Event Instance Step 1: Perform a BACnet "Write Property" command on an existing Instance of the Timed Event object, using the property type: "PROP_DELETE_OBJECT". The property value can be set to an integer zero and is not used.
6 Paradigm LightDesigner Items 6.1 Expose On BACnet Property Using Paradigm LightDesigner software, specific object instances may be removed from exposition via the BACnet interface by setting the "Expose On BACnet" object property to false. The Central Control Server node in LightDesigner provides this property for Error objects and affects all errors reported within the Paradigm system.
Paradigm LightDesigner Items 35
Corporate Headquarters 3031 Pleasant View Road, P.O.
