Getting Started with the Niagara Andover AC256 Driver

Transcription

1
1.1
1.2
1.3
2
3
3.1
3.1.1
3.1.2
3.2
3.2.1
3.2.2
3.2.3
3.2.4
3.2.5
3.2.6
3.2.7
3.2.8
3.2.9
3.2.10
3.2.11
3.2.12
4
4.1
4.2
4.2.1
4.2.2
4.2.3
4.2.4
4.2.5
5
5.1
5.2
5.2.1
5.2.2
5.2.3
5.2.4
5.2.5
5.3
5.3.1
5.3.2
5.3.3
5.3.4
5.3.5
5.4
5.4.1
5.4.2
5.4.3
5.4.4
5.4.5
5.5
5.5.1
5.5.2
Introduction ........................................................................................................................ 3
The Andover AC256 Service .................................................................................. 3
The Andover Device ............................................................................................... 3
Shadow Objects....................................................................................................... 3
Quick Start and Recommended Initial Settings.................................................................. 5
Andover AC256 Service .................................................................................................... 7
Installing the Andover AC256 Service ................................................................... 7
Adding the AC256 Service using the Wizard ...................................................... 7
Adding the AC256 Service Using Copy-and-Paste ............................................. 8
Configuring the AC256 Service ............................................................................ 10
AndoverService: General/Status Properties ....................................................... 10
AndoverService: General/Config Properties...................................................... 11
AndoverService: General/Visual Properties ...................................................... 13
AndoverService: General/Engineering Properties ............................................. 14
AndoverService: General/Security Properties.................................................... 15
AndoverService: Poll/Status Properties ............................................................. 16
AndoverService: Poll/Config Properties............................................................ 18
AndoverService: Comm/Config Parameters ...................................................... 19
AndoverService: DeviceStatus/Status Properties............................................... 20
AndoverService: DeviceStatus/Config Properties ............................................. 21
AndoverService: DeviceStatus/Alarm Setup Properties .................................... 22
AndoverService: Options/Config (version 2.203.228j and later only)............... 23
Andover Device................................................................................................................ 25
Installing the AndoverDevice................................................................................ 25
Configuring the AndoverDevice ........................................................................... 27
AndoverDevice: Status Properties ..................................................................... 27
AndoverDevice: Config Properties .................................................................... 29
AndoverDevice: Visual Properties..................................................................... 30
AndoverDevice: Engineering Properties............................................................ 31
AndoverDevice: Security Properties.................................................................. 32
Andover Shadow Objects................................................................................................. 33
Adding an Andover Shadow Object...................................................................... 34
Configuring the AndoverGenericAI Object .......................................................... 35
AndoverGenericAI: Status Properties................................................................ 35
AndoverGenericAI: Config Properties............................................................... 37
AndoverGenericAI: Visual Properties ............................................................... 39
AndoverGenericAI: Engineering Properties ...................................................... 40
AndoverGenericAI: Security Properties ............................................................ 41
Configuring the AndoverGenericAO Object......................................................... 42
AndoverGenericAO: Status Properties .............................................................. 42
AndoverGenericAO: Config Properties ............................................................. 44
AndoverGenericAO: Visual Properties.............................................................. 46
AndoverGenericAO: Engineering Properties..................................................... 47
AndoverGenericAO: Security Properties........................................................... 48
Configuring the AndoverGenericBI Object .......................................................... 49
AndoverGenericBI: Status Properties ................................................................ 49
AndoverGenericBI: Config Properties............................................................... 51
AndoverGenericBI: Visual Properties ............................................................... 53
AndoverGenericBI: Engineering Properties ...................................................... 54
AndoverGenericBI: Security Properties............................................................. 55
Configuring the AndoverGenericBO Object......................................................... 56
AndoverGenericBO: Status Properties............................................................... 56
AndoverGenericBO: Config Properties ............................................................. 58
Applies to releases up to andoverAC256-2.203.228j.jar and andoverAC256-2.301.324j.v1.jar, or as noted.
All specifications subject to change without notice or liability to provide changes to prior purchasers.
01/04/2005
©
2005 Tridium, Inc.
Page 1 of 117
5.5.3
5.5.4
5.5.5
5.6
5.6.1
5.6.2
5.6.3
5.6.4
5.6.5
5.7
5.7.1
5.7.2
5.7.3
5.7.4
5.7.5
5.8
5.8.1
5.8.2
5.8.3
5.8.4
5.8.5
5.9
5.9.1
5.9.2
5.9.3
5.9.4
5.9.5
5.10
5.10.1
5.10.2
5.10.3
5.10.4
5.10.5
6
7
7.1
7.2
7.2.1
7.2.2
7.2.3
7.2.4
7.2.5
8
8.1
8.2
8.3
8.4
8.5
8.6
8.7
9
10
11
12
13
AndoverGenericBO: Visual Properties.............................................................. 60
AndoverGenericBO: Engineering Properties..................................................... 61
AndoverGenericBO: Security Properties ........................................................... 62
Configuring the AndoverGenericTSO Object....................................................... 63
AndoverGenericTSO: Status Properties............................................................. 63
AndoverGenericTSO: Config Properties ........................................................... 65
AndoverGenericTSO: Visual Properties............................................................ 67
AndoverGenericTSO: Engineering Properties................................................... 68
AndoverGenericTSO: Security Properties ......................................................... 69
Configuring the AndoverVariableAnalog Object ................................................. 70
AndoverVariableAnalog: Status Properties ....................................................... 70
AndoverVariableAnalog: Config Properties ...................................................... 72
AndoverVariableAnalog: Visual Properties....................................................... 74
AndoverVariableAnalog: Engineering Properties.............................................. 75
AndoverVariableAnalog: Security Properties.................................................... 76
Configuring the AndoverVariableDiscrete Object................................................ 77
AndoverVariableDiscrete: Status Properties...................................................... 77
AndoverVariableDiscrete: Config Properties .................................................... 79
AndoverVariableDiscrete: Visual Properties ..................................................... 81
AndoverVariableDiscrete: Engineering Properties ............................................ 82
AndoverVariableDiscrete: Security Properties .................................................. 83
Configuring the AndoverGenericString Object..................................................... 84
AndoverGenericString: Status Properties .......................................................... 84
AndoverGenericString: Config Properties ......................................................... 86
AndoverGenericString: Visual Properties.......................................................... 88
AndoverGenericString: Engineering Properties................................................. 89
AndoverGenericString: Security Properties....................................................... 90
Configuring the AndoverCommand Object (release 2.203.227d or later only) .... 91
AndoverCommand: Status Properties ................................................................ 91
AndoverCommand: Config Properties............................................................... 93
AndoverGenericString: Visual Properties.......................................................... 95
AndoverGenericString: Engineering Properties................................................. 95
AndoverGenericString: Security Properties....................................................... 95
Using SET and AUTO Commands .................................................................................. 96
The Learn Process ............................................................................................................ 97
Invoking the PointListManager............................................................................. 97
The PointListManager Display ............................................................................. 98
The Learn History Status Bar and History Display............................................ 98
The ‘Learn Controls’ Section............................................................................. 99
The ‘Create Controls’ Section............................................................................ 99
Point Manager Action Buttons......................................................................... 100
Default Rules on Mapping AC256 Points to Andover Objects........................ 101
The DownLoadManager (release 2.203.228b and later) ................................................ 102
Invoking the DownLoadManager ....................................................................... 102
Using the DownLoadManager for the first time ................................................. 103
Performing a DUMP Operation .......................................................................... 105
Performing a RELOAD Operation...................................................................... 106
Synch Time Button ............................................................................................. 107
Set Options Button .............................................................................................. 107
Set Saved Opts Button ........................................................................................ 107
Application Note on Creation of Shadow Objects from Non-assigned Points in SV, SX, SA, SF
Tables. ............................................................................................................................ 108
Application Note on Using Analog Objects ................................................................... 110
Application Note on Using Discrete Objects ................................................................. 112
Using Debug................................................................................................................... 113
Performance Benchmarks............................................................................................... 116
01/04/2005
©
2005 Tridium, Inc.
Page 2 of 117
Apendix 1 RS-232 Cable Pin Out .............................................................................................................. 117
1 Introduction
The Andover AC256 driver provides the components necessary to integrate AC 256 devices and data into the
Niagara environment. This driver currently supports. The AC256 Driver is made up of three primary
components: 1) the Niagara service; 2) the Andover device; and, 3) a collection of Niagara objects to “shadow”
I/O and variables in the Andover network.
For successful use of this driver, it is assumed that the AC256 is properly installed, properly configured, and
operational.
1.1
The Andover AC256 Service
The service is composed of a serial communications driver, a poll service, and a device status service:
1. The communications driver provides the protocol communications and serial port support.
2. The data poll service initiates communications requests to read the data specified in the Andover devices
and objects. This driver supports polling using the Andover terminal command “PRINT name”, where
name can be any assigned point in the Andover AC256. A poll is a request for a single name-assigned data
item.
3. The device status service initiates communications request to monitor the communications status of the
Andover master device. The device status service can initiate Niagara alarms on loss of communications.
The driver uses the Andover terminal command “PRINT STATUS” to verify operational communications to
the Andover master device.
1.2
The Andover Device
The Andover AC256 device component is a container object used to track the status of the AC256 and attached
LCUs/IOUs, track and perform time synchronization between the AC256 system and the Niagara system, and
provide support for automatically creating Niagara shadow objects by “learning” assigned names within the
AC256
1.3
Shadow Objects
The AC256 driver provides support for several different types of data that can be provided by the Andover
AC256 system:
AndoverGenericBI: Shadows the behavior of an discrete input point
AndoverGenericAI: Shadows the behavior of an analog input point
AndoverGenericBO: Shadows the behavior of a discrete output point
AndoverGenericAO: Shadows the behavior of an analog output point
AndoverVariableDiscrete: Shadows the behavior of an AC256 system table assigned point (SV, SX,
SA, or SF) and can be used for both input (i.e., status) and output (i.e., commands)
AndoverVariableAnalog: Shadows the behavior of an AC256 system table assigned point (SV, SX, or
SA) which can be used as both input (i.e., a value) and an output (i.e., a setpoint)
AndoverGenericString: A general or “catch-all” object intended to present poll data as an unprocessed string and can be used to execute any command supported by the Andover AC256. Any
return string may be linked to a graphics text object. Note that commands which change the context of
the Andover terminal prompt from “R>” should not be used.
01/04/2005
©
2005 Tridium, Inc.
Page 3 of 117
(this page intentionally left blank)
01/04/2005
©
2005 Tridium, Inc.
Page 4 of 117
2 Quick Start and Recommended Initial Settings
For those familiar with Niagara, including adding services, devices, and shadow objects, this section will give
the abbreviated steps necessary to get up and running with the AC256 driver. For those not as familiar to
Niagara, the following sections give detailed step-by-step instructions, plus explanations of properties.
-
Add the AndoverAC256 Service, either through the new station wizard, or
through copy-and-paste from a local library
Copy-and-paste an AndoverNetwork container from the local library to the
station.
Copy-and-paste an AndoverDevice container from the local library to the
AndoverNetwork (or a sub-container of the AndoverNetwork).
Create Shadow Objects, either from the learn process using the
PointListManager command of the AndoverDevice, or from copy-and-paste from the local
library.
-
The following settings should be applied:
1)
Check/Modify the following property settings on the AndoverAC256Service
- on the General/Config tab, make sure the devicePassword and
personalPassword match the device password and personal password
shipped with the AC256 unit.
- on the Poll/Config tab, the cycleTime property should be a minimum 5000,
but may need to be increased as more points are added.
- on the DeviceStatus/Config tab, make sure the deviceStatusPingDelay
property is set to a minimum of 10,000 (defaults to 1000).
2)
The communications parameters default to 19200 baud, 8 data bits, one stop bit, and no parity.
Make sure the AC256 is configured with the same parameters.
3)
The AC256 unit should be configured with all IOUs, LCUs, and other options, and running
before starting the AC256 driver. After startup, make sure the properties displayed on the
Status tab of the device property sheet matches what is configured in the AC256 unit. (the
Niagara AC256 driver will automatically update the Status tab properties after a successful
login, and at every ping cycle).
01/04/2005
©
2005 Tridium, Inc.
Page 5 of 117
01/04/2005
©
2005 Tridium, Inc.
Page 6 of 117
3 Andover AC256 Service
3.1
Installing the Andover AC256 Service
The Andover AC256 service is most conveniently added during creation of a new station using the “new
station” wizard. Alternatively, the service may be added to an existing station use the copy-and-paste
method.
3.1.1 Adding the AC256 Service using the Wizard
If adding the service at station creation, the new station wizard is the easies way to incorporate the AC256
driver. On the Niagara user interface, select New Station from the File drop down menu. This will bring
up the following screen.
Enter the new station’s name (“SampleAndoverStation”, in this example) and click "Next>".
This will pop up the services selection screen, shown below:
01/04/2005
©
2005 Tridium, Inc.
Page 7 of 117
Using the scroll bar, scroll the display and click on the line “Andover Service”. A red check mark should
appear next to the service.
Click "Next>" to bring up the “Notification Service Setup” screen. Make sure “Create Notification Class
0” is selected, and click Finish to complete creation of the new station. On the last pop-up screen, click
OK.
The new station is now created with the Andover AC256 driver.
3.1.2 Adding the AC256 Service Using Copy-and-Paste
If adding the AC256 driver to an existing station, use the Copy-and-Paste method.
In the Niagara interface console, if a library is not available on the
station tree, add a library by clicking on the File>Open Local
Library menu item or the File>Add Remote Library menu item:
01/04/2005
©
2005 Tridium, Inc.
Page 8 of 117
Click on the library you just opened, and expand
Tridiumx/AndoverAC256.
Right click on AndoverService.class, and select Copy.
Expand the station you wish to add the service to by
clicking on the station. Right click the services
container, and select Paste from the pop-up menu.
The service is now added, and should appear in the list
of station services.
01/04/2005
©
2005 Tridium, Inc.
Page 9 of 117
3.2
Configuring the AC256 Service
Bring up the service property sheet by expanding the Services container, right-click on AndoverService,
and select Go>Properties from the pop up menu. On the displayed menu, make sure the General/Status
tabs are selected. The following screen is displayed in Work Place Pro:
3.2.1 AndoverService: General/Status Properties
objectType
Static field, should say “AndoverService”
statusFlags
Indicates communications status (out of service, fault, OK, etc)
description
User entered text, defaults to “serial connection to ANDOVER AC256”
averageInterCycleDelay(ms)
Statistical average of actual time to complete a poll cycle, should be
close to configured poll cycle time.
lateStarts
Number of times a poll cycle has not started on time
01/04/2005
©
2005 Tridium, Inc.
Page 10 of 117
3.2.2 AndoverService: General/Config Properties
enableAndoverComm
enables or disables the Andover service. Click on the box to select the
state.
devicePassword
Enter the password needed to log onto this AC256 master
personalPassword
Enter the personal password needed to log on to this AC256 master.
Note that the personal password must have the appropriate permissions
in the AC256 master to access all assigned variables.
lBusIOUsAtStartup
If the Andover controller drops its program, after re-logon the AC256
panel will prompt for the number of L-Bus IOUs and ACNET LCUs.
In responses to the prompt “L-Bus Number of IOU’s (1 – 16)?”, the
driver will send the number stored here.
acnetLCUsAtStartup
If the Andover controller drops its program, after re-logon the AC256
panel will prompt for the number of L-Bus IOUs and ACNET LCUs.
In responses to the prompt “ACNET Number of LCU’s (1 – 127)?”, the
driver will send the number stored here.
reloadRequired
If the prompts for “L-Bus Number of IOU’s (1-16)?” or “ACNET
Number of LCU’s (1 – 127)?” are detected at logon, then this flag will
be set to true. If the property autoReload is set to “true” then a reload
of the AC256 panel will be attempted if a locally stored AC256
01/04/2005
©
2005 Tridium, Inc.
Page 11 of 117
program “dump0.txt” file found. See section “DownloadManager” for
details.
setSystemOptionsRequired
If the text “Set System Options” appears in the response to the
Andover PRINT STATUS command, this property will be set to true.
If the property autoSetOptions(see bleow) is set to “true” then the OPT
command will be sent to the AC256 panel using parameters from the
options/config property sheet..
autoReload
If the property reloadRequired (see above, set automatically by driver)
is set to true and this flag is set to true, then a reload of the AC256
program will be initiated. Note that a “dump” of the AC256 program
must have been previously performed and a valid “dump0.txt” file must
exist on the Jace controller.
autoSetOptions
If the text “Set System Options” appears in the response to the
Andover PRINT STATUS command, and this property is set to true,
then the OPT command will be sent to the AC256 panel using
parameters from the options/config property sheet..
01/04/2005
©
2005 Tridium, Inc.
Page 12 of 117
3.2.3 AndoverService: General/Visual Properties
position
Indicates position of device icon on the services workspace.
01/04/2005
©
2005 Tridium, Inc.
Page 13 of 117
3.2.4 AndoverService: General/Engineering Properties
debugOn
selects whether debug is turned on or off. If set to "True", low-level
protocol specific debug text will be generated and sent to the
administrator console window.
retryCount
Indicates how many additional times a request for data will be sent to
the AC256 if the first attempt fails or the answer contains an error. The
recommended setting for this driver is “2”, which allows for up to 3
attempts before declaring a communications error.
responseTimeOut(sec)
indicates how long the driver will wait for a response before declaring
the AC256 non-responding. On a poll/response sequence, if the
response does not return within the responseTimeOut period, a retry is
attempted. If retryCount has been exhausted, a communications failure
is declared. Recommended setting 1 seconds.
noResponseCount
Cumulative total since station started. Keeps track of how many times
a request for data has been unsuccessful. Requests include all polls,
status requests (pings), and writes. This is equal to how many times a
communications failure has been declared.
errorResponseCount
Cumulative total of responses with errors since station started. This
number does include requests which were repeated because of retries
for which the retry returned a good response.
totalRequestsCount
Total of all poll requests, ping (status) requests, and write requests.
Does not include retries.
01/04/2005
©
2005 Tridium, Inc.
Page 14 of 117
3.2.5 AndoverService: General/Security Properties
securityGroups
check boxes for which security groups are to have access to this service
01/04/2005
©
2005 Tridium, Inc.
Page 15 of 117
3.2.6 AndoverService: Poll/Status Properties
averageExecuteTime(ms)
Calculated average of time to execute the polling service. Equals
totalExecuteTime/executionCycles
totalExecuteTime(ms)
Cumulative total of time spent executing the poll service
executionCycles
Cumulative total of number of times the poll service has been executed
overruns
Number of times poll execution time has exceeded time allotment. If
the number of overruns is high (>10% of execution cycles), this is
indicative of performance/bandwidth/retry problems and the poll
frequency may need to be adjusted slower.
objectCount
Number of objects serviced by the polling service.
startTime
Time that the poll service started. Disabling and re-enabling the poll
service will re-initialize the indicated time.
interNodeDelay(ms)
amount of idle time between servicing nodes that require poll support.
Note that the poll service attempts to spread the execution of service for
different nodes across the entire poll interval, giving rise to
interNodeDelay.
01/04/2005
©
2005 Tridium, Inc.
Page 16 of 117
fastestNodeCount
Number of nodes serviced by the poll service that are executed at the
fastest polling interval.
fastestNodeCycleTime(ms)
amount of time servicing all nodes selected as being polled at the
fastest cycle time.
normalNodeCount
normal polling interval.
normalNodeCycleTime(ms)
normal cycle time.
slowestNodeCount
slowest polling interval.
slowestNodeCycleTime(ms)
slowest cycle time.
01/04/2005
©
2005 Tridium, Inc.
Page 17 of 117
3.2.7 AndoverService: Poll/Config Properties
cycleTime
Desired time to service all polled nodes. As number of nodes
increases, this number will need to increase accordingly. A value of
30000 (30 sec) is sufficient for about 15 shadow objects.
displayDots
Normally set to False, setting to True will enable a “.” character to
displayed in the diagnostic output every poll cycle.
disabled
used to enable/disable the polling service. Set to "false" to enable
polling.
fastestRatioCount
Assigns a relative priority for execution of shadow objects for which
the parameter pollFrequency has been set to “Fastest”.
normalRatioCount
the parameter pollFrequency has been set to “Normal”.
slowestRatioCount
the parameter pollFrequency has been set to “Slowest”.
01/04/2005
©
2005 Tridium, Inc.
Page 18 of 117
3.2.8 AndoverService: Comm/Config Parameters
commPort
Set to the Jace comm. port through which communications to the
AC256 will take place.
baudRate
Set to match the baud rate configured in the AC256, recommend
19200.
dataBits
Set to dataBits_8 for AC256 communications.
stopBits
Set to stopBit_1 to select 1 stop bit.
parity
Set to none for AC256.
flowControl
Set to none for AC256.
rs485Mode
Set to false for AC256.
01/04/2005
©
2005 Tridium, Inc.
Page 19 of 117
3.2.9 AndoverService: DeviceStatus/Status Properties
deviceStatusAverageExecuteTime(ms)
Calculated average of time to execute the device status
service. Equals totalExecuteTime/executionCycles
deviceStatusTotalExecuteTime(ms)
Cumulative total of time spent executing the device status
service
deviceStatsusExecuteCycles
Cumulative total of number of times the device status service
has been executed.
deviceStatusObjectCount
Number of nodes serviced by the device status service. For
the AC256, this number will always be 1.
deviceStatusStartTime
The time the device status service was started.
01/04/2005
©
2005 Tridium, Inc.
Page 20 of 117
3.2.10 AndoverService: DeviceStatus/Config Properties
deviceStatusPingDelay
Enter the number of ms between sending the ping message “PRINT
STATUS”, used to determine if the AC256 is capable of
communicating.
deviceStatusDisplayDots
Normally set to False, setting to True will enable a “.” character to
displayed in the diagnostic output every device status cycle.
deviceStatusDisabled
Used to enable/disable the device status service. Set to False to enable
device status messages. Should be set to False.
01/04/2005
©
2005 Tridium, Inc.
Page 21 of 117
3.2.11 AndoverService: DeviceStatus/Alarm Setup Properties
notificationClass
Enter the notification class that is to receive alarms from the device
status service.
01/04/2005
©
2005 Tridium, Inc.
Page 22 of 117
3.2.12 AndoverService: Options/Config (version 2.203.228j and later only)
NOTE: These parameters are used under one of two scenarios:
- The “Set Saved Opts” button is invoked from the DownloadManager view.
See the section DownloadManager for details.
- The “autoSetOptions” parameter is set on the AndoverService’s
general/config property sheet, and options are detected as not set from
Andover command “PRINT STATUS”. “PRINT STATUS” is sent once
per hour, at driver logon, or by a pull down command “getStatus” on an
AndoverDevice view.
consolePortSpeed
Automatic answer to the AC256 OPTIONS command prompt for
“Console Port Speed (110 – 19200)?”
WARNING: MAKE SURE THIS VALUE MATCHES THE
Comm/Config PROPERTY SHEET VALUE “baudRate”, OR
COMMUNICATIONS WILL BE LOST.
consoleInactivityAutoLogoff
“Console Inactivity Auto-Logoff (D or E)?” A setting of FALSE will
cause answer to be “D” , a setting of TRUE will cause the answer to be
“E”.
consoleMessageBuffering
“Console Message Buffering (D or E)?” A setting of FALSE will cause
answer to be “D” , a setting of TRUE will cause the answer to be “E”.
“Console Port Speed (110 – 19200)?”
sPortSpeed
01/04/2005
©
2005 Tridium, Inc.
Page 23 of 117
sPortInactivityAutoLogoff
Automatic answer to the AC256 OPTIONS command prompt for “SPort Inactivity Auto-Logoff (D or E)?” A setting of FALSE will cause
sPortMessageBuffering
Automatic answer to the AC256 OPTIONS command prompt for “SPort Message Buffering (D or E)?” A setting of FALSE will cause
masterIDnumber
“Master I.D. Number (1 – 32)?”
xBusSpeed
Automatic answer to the AC256 OPTIONS command prompt for “XBus Speed (300 or 2400)?”
lBusSpeed
Automatic answer to the AC256 OPTIONS command prompt for “LBus Speed (300 – 19200)?”
acnetSpeed
“ACNET Speed (300, 1200 or 9600)?”
01/04/2005
©
2005 Tridium, Inc.
Page 24 of 117
4 Andover Device
4.1
Installing the AndoverDevice
An AndoverDevice object can only be added to an
AndoverNetwork container, so we must first add the
AndoverNetwork container:
Expand the local library path tridiumx/andoverAC256/containers
as shown in graphic at right. Right-click on AndoverNetwork
and select Copy.
Next, right click on the station in the station tree, and select Paste.
This will at the AndoverNetwork to the station.
In the next step, add the AndoverDevice object to the new
AndoverNetwork container.
01/04/2005
©
2005 Tridium, Inc.
Page 25 of 117
Add the AndoverDevice to the AndoverNetwork by first
copying the device from the local library. Expand the local
library tree to tridimx/andoverAC256/devices and right click
on AndoverDevice, as shown:
Now paste the AndoverDevice into the AndoverNetwork
container by right clicking on AndoverNetwork, and selecting
Paste. The Andover device is now added to the network.
01/04/2005
©
2005 Tridium, Inc.
Page 26 of 117
4.2
Configuring the AndoverDevice
4.2.1 AndoverDevice: Status Properties
Andover Device
Static field indicating the object type
Status Flags
Indicates communications status (out of service, fault, OK, etc)
description
User entered text
promptStatus
Indicates prompt returned from last communications to AC256. During all
normal polling activity, this should be “Ready” indicating that the last
decoded message from the AC256 was correctly terminated by an “R>”
prompt.
currentDomain
Indicates the current AC256 domain, usually 0. When the context of the
communications changes to an alternate domain, as during the learn process,
this field will indicate domain. Determined by reading the terminating
characters of the last valid response.
01/04/2005
©
2005 Tridium, Inc.
Page 27 of 117
unitNumber
AC256 unit number contained in the response to the PRINT STATUS
command. The driver ping process sends the PRINT STATUS command.
Unit number is programmed into the AC256 using the AC256 options menu.
numberAttachedIOUs
Indicates number of IOUs attached to the AC256, contained in the response
to the PRINT STATUS command sent by the driver ping process. This
parameter is used in the learn process to learn assigned names from all IOUs.
iouCommFaults
Indicates which of the attached IOUs are not communicating with the
AC256. Contained in the response to the PRINT STATUS command sent
by the driver ping process.
iouOverrides
Lists which IOU units have outputs overridden, as contained in the response
to the PRINT STATUS command sent by the ping process.
numberAttachedLCUs
Indicates number of LCUs attached to the AC256, contained in the response
to the PRINT STATUS command sent by the driver ping process. This
parameter is used in the learn process to learn assigned names from all
LCUs.
lcuCommFaults
Indicates which of the attached LCUs are not communicating with the
AC256. Contained in the response to the PRINT STATUS command sent
by the driver ping process.
disabledVarClasses
Lists the any AC256 internal classes that have any variables disabled.
Contained in the response to the PRINT STATUS command sent by the
driver ping process.
numberFailures
Indicates number of power failure or other internal errors, as reported in the
response to the PRINT STATUS command sent by the driver ping process.
andoverDateTime
AC256 clock time as returned in response to the PRINT STATUS command
sent by the ping process.
jaceDateTime
Jace controller real time clock time.
syncToJaceTime
Set to true to cause the Jace time to be written to the AC256 at startup and
once per day at midnight, or whenever sync command is initiated from the
device command menu
01/04/2005
©
2005 Tridium, Inc.
Page 28 of 117
4.2.2 AndoverDevice: Config Properties
execution Parameters
freq: select frequency of execution for this object, as defined under the
ControlEngineService/Config properties:
-never
-slower
-normal (default)
-faster
-fastest
-minutely
-onTrigger
order: select order of execution:
-input
-processor (default)
-output
01/04/2005
©
2005 Tridium, Inc.
Page 29 of 117
4.2.3 AndoverDevice: Visual Properties
position
indicates graphical position on workspace of the container in which this
device is located.
01/04/2005
©
2005 Tridium, Inc.
Page 30 of 117
4.2.4 AndoverDevice: Engineering Properties
minExecuteTime
used only for execution profiling in development environment
maxExecutTime
averageExecuteTime
userData
user entered text for information only, not used by the driver.
debugOn
If set to True, then diagnostic messages for this device will be sent to the
administrator console (stdOut). If false, diagnostic messages will not be
sent. Note that diagnostic data sent pertains to device-level driver activity
(ie, shadow object related data is not included, nor is low level message data
sent by the service debug)
01/04/2005
©
2005 Tridium, Inc.
Page 31 of 117
4.2.5 AndoverDevice: Security Properties
securityGroups
check boxes for which security groups are have access to this device.
01/04/2005
©
2005 Tridium, Inc.
Page 32 of 117
5 Andover Shadow Objects
The collection of Andover shadow objects model the real I/O and variable space of the Andover AC245
network. The following shadow objects are provided:
AndoverGenericAI
Models a single analog input from an IOU or LCU,
addressed by Andover assigned name
AndoverGenericAO
Models a single analog output from an IOU or LCU,
addressed by Andover assigned name
AndoverGenericBI
Models a single binary (digital) input from an IOU
or LCU, addressed by Andover assigned name
AndoverGenericBO
Models a single binary (digital) output from an IOU
or LCU, addressed by Andover assigned name
AndoverGenericTSO
Models a single tri-state output from an IOU or
LCU, addressed by Andover assigned name
AndoverVariableAnalog
Models a single system table analog variable
internal to the AC256 system. May be an assigned
variable from the V-Drum, A-Drum, or X-Drum of
the master (Andover domain 0) or from the V-Drum
of a non-master (Andover domain 1 and up). Note
that this can also be a non-assigned single entity
from a system table (example V1, X1, A1, etc), but
not from the Flag table.
AndoverVariableDiscrete
Models a single system table discrete variable
internal to the AC256 system. May be an assigned
variable from the V-Drum, A-Drum, or X-Drum of
the master (Andover domain 0) or from the V-Drum
of a non-master (Andover domain 1 and up). Note
that this can also be a non-assigned single entity
from a system table (example V1, X1, A1, etc)
including the Flags table.
AndoverGenericString
Provides for regular polling and display of response
to any Andover command which does not alter the
Andover prompt context from “R>”. Display of
response is in the form of a text string.
01/04/2005
©
2005 Tridium, Inc.
Page 33 of 117
5.1
Adding an Andover Shadow Object
Shadow objects can be added in one of two ways: 1) learn feature, and 2) copy-and-paste. The easiest way for a
new project is to use the “learn” feature of the driver. The learn feature is discussed in section 5.
The copy-and-paste method is analogous to the copy-and-paste used to add the AndoverNetwork and
AndoverDevice.
First, expand the local library in the menu tree of Work Place
Pro to the andoverAC256/objects level. Select the desired
object type by right clicking on the object and selecting Copy.
Next, paste the object into the desired container in the project
menu tree by right clicking on the desired container and
selecting Paste.
In this example, we are pasting the object into the
AndoverDevice container.
01/04/2005
©
2005 Tridium, Inc.
Page 34 of 117
5.2
Configuring the AndoverGenericAI Object
The AndoverGenericAI object exposes 1 AC256 analog input in the Niagara environment. The object exposes
the analog input value reported from the AC256 as both Integer and Floating-point data types. The object
performs no range/offset functions.
5.2.1 AndoverGenericAI: Status Properties
In tree view expand the station to show the ModbusGenericAI to be setup. Right-click on the object and select
“Go” – “Properties”. An example screen is shown:
objectType
Static field: AndoverGenericAI
statusFlags
ok - Indicates status of this object, should say “ok”.
fault – a fault condition exists
outOfService – set to out of service on the config tab
down – the object is down because the device is down
description
user entered data, for information only.
rdStatus
Error code and type of last poll for data to the AC256. Reports 0:ok if no
errors. See Andover documentation for details on any particular error code.
Possible error codes are:
0, "ok"
no errors detected or reported
1, “noResponse”
no response to last poll
2, "accessDenied"
see Andover documentation
3, "ambiguousKeyword"
4, "badNumber"
5, "badReloadBlock"
01/04/2005
©
2005 Tridium, Inc.
Page 35 of 117
6, "binaryOperatorExpected"
7, "duplicateSymbolAssignment"
8, "entryOutOfRange"
9, "expressionTooComplex"
10,"invalidDrumNumber"
11,"invalidKeyword"
12,"invalidLineNumber"
13,"invalidSymbol"
14,"invalidVariable"
15,"lineLost"
16,"programAreaFull"
17,"requiredEntryMissing"
18,"syntaxError"
19,"variableOutOfRange"
20,"variableOrUnaryExpected"
21,"systemError"
22,”missingLCU”
23, "okNotActive"
24,"unknown"
25, ”numberFormatException”
26, ”binaryFormatException”
27, ”triStateFormatException”
28, “incorrectDomain”
29,”invalidMessage”
requested data is from an LCU
which is not communicating
not actively being polled
unknown error in response
data returned is not a number
data returned is not a binary
data returned is not tri-state
could not get data because domain
context of poll is incorrect
message could not be decoded
pointState
not relevant for this object
aiInt
analog input data, converted to an integer (all fractional data dropped)
aiFloat
analog input data, converted to a floating point value
01/04/2005
©
2005 Tridium, Inc.
Page 36 of 117
5.2.2 AndoverGenericAI: Config Properties
executionParameters
-never
-slower
-normal (default)
-faster
-fastest
-minutely
-onTrigger
-input
-output
pollFrequency
select relative poll frequency as defined in the AndoverService Poll/Config
ratio counts:
-normal (default)
-fastest
-slowest
minimumPollInterval
Minimum poll interval in ms. Will not poll any faster than this value.
pointName
Name of point as “assigned” or programmed in the AC256 unit. The
pointName is used with the Andover AC256 PRINT command to poll for
data.
01/04/2005
©
2005 Tridium, Inc.
Page 37 of 117
pointType
If this object was created by the learn process, this static field will contain
the AC256 defined point type (counter, temperature, or voltage). If created
manually by copy-and-paste, will contain “unknown”.
pollDisable
To disable polling for this object without affecting all other objects, set to
“true”.
pointSource
the origin of the point in the AC256 system. (IOU number or LCU number).
If created manually by copy-and-paste, will contain “unknown”.
pointTerminals
the I/O channel on the IOU or LCU. If created manually by copy-and-paste,
will contain “unknown”.
01/04/2005
©
2005 Tridium, Inc.
Page 38 of 117
5.2.3 AndoverGenericAI: Visual Properties
position
position on the workspace of the container in which this object is placed.
decimalFormat
Select the decimal places of precision for this point. The AC256 is limited
to 4 significant digits for any piece of data returned in a response. This value
should be set to match the precision returned for this object.
01/04/2005
©
2005 Tridium, Inc.
Page 39 of 117
5.2.4 AndoverGenericAI: Engineering Properties
minExecuteTime used only for execution profiling in development environment
maxExecuteTime used only for execution profiling in development environment
averageExecuteTime
userData
any user entered data, no entry required
debugOn
If set to True, enables diagnostic data to be sent to the diagnostic console in
the admin tool.
01/04/2005
©
2005 Tridium, Inc.
Page 40 of 117
5.2.5 AndoverGenericAI: Security Properties
securityGroups
Select which groups are to have access to this object
01/04/2005
©
2005 Tridium, Inc.
Page 41 of 117
5.3
Configuring the AndoverGenericAO Object
5.3.1 AndoverGenericAO: Status Properties
objectType
Static field: AndoverGenericAO
statusFlags
description
User entered data, for information only.
rdStatus
0, "ok"
1, “noResponse”
2, "accessDenied"
4, "badNumber"
5, "badReloadBlock"
7, "duplicateSymbolAssignment" see Andover documentation
11,"invalidKeyword"
01/04/2005
©
2005 Tridium, Inc.
Page 42 of 117
13,"invalidSymbol"
15,"lineLost"
18,"syntaxError"
21,"systemError"
22,”missingLCU”
data is from an LCU which is
not communicating
23, "okNotActive"
24,"unknown"
context of poll is not correct
pointState
selects/indicates status of point in AC256 programming. If “disabled”,
indicates that a DISABLE command has been sent to the AC256 point, and
the point cannot be overwritten by any active AC256 program. If “enabled”,
indicates that a ENABLE command has been sent to the AC256 point to
place the point under control of the AC256. In the “enabled” state, the point
value can be updated from the AC256 and any point updates sent by Niagara
may be overwritten.
wrStatus
indicates status of last command (write) to the AC256 in relation to this
point object.
aoInt
current value of this output in the AC256, presented in Niagara as an integer
(all fractional data dropped), plus a status as follows:
-{ok} updating normally with no errors
-{outOfService} not updating because object is out of service
-{fault} the driver was not able to properly process the response
data, either because an error was detected in the response message
or there was an error in conversion of AC256 data to an integer.
aoFloat
current value of this output in the AC256, presented in Niagara as a floating
point value), plus a status as follows:
-{ok} updating normally with no errors
-{outOfService} not updating because object is out of service
-{fault} the driver was not able to properly process the response
data, either because an error was detected in the response message
or there was an error in conversion of AC256 data to an integer.
output
value to write to the AC256. Changing this value will cause
communications to the AC256 to write this value to the analog output.
01/04/2005
©
2005 Tridium, Inc.
Page 43 of 117
5.3.2 AndoverGenericAO: Config Properties
executionParameters
-never
-slower
-normal (default)
-faster
-fastest
-minutely
-onTrigger
-input
-output
pollFrequency
ratio counts:
-normal (default)
-fastest
-slowest
minimumPollInterval
pointName
data.
01/04/2005
©
2005 Tridium, Inc.
Page 44 of 117
pointType
For informational purposes only. If the object was created by the learn
process, this field will contain the text “AnalogOutput”. Otherwise, it will
contain the text “unknown”.
pollDisable
“true”.
pointSource
For informational purposes only. If this object was created by the learn
process, this static field will contain the origin of the point in the AC256
system. (IOU number or LCU number). If created manually by copy-andpaste, will contain “unknown”.
pointTerminals
For informational purposes only. If this object was created by the learn
process, this static field will contain the I/O channel on the IOU or LCU. If
created manually by copy-and-paste, will contain “unknown”.
01/04/2005
©
2005 Tridium, Inc.
Page 45 of 117
5.3.3 AndoverGenericAO: Visual Properties
position
decimalFormat
01/04/2005
©
2005 Tridium, Inc.
Page 46 of 117
5.3.4 AndoverGenericAO: Engineering Properties
averageExecuteTime
userData
debugOn
the admin tool. The diagnostic data is specific to this object.
01/04/2005
©
2005 Tridium, Inc.
Page 47 of 117
5.3.5 AndoverGenericAO: Security Properties
securityGroups
01/04/2005
©
2005 Tridium, Inc.
Page 48 of 117
5.4
Configuring the AndoverGenericBI Object
5.4.1 AndoverGenericBI: Status Properties
objectType
Static field: AndoverGenericBI
statusFlags
description
rdStatus
0, "ok"
1, “noResponse”
2, "accessDenied"
4, "badNumber"
5, "badReloadBlock"
11,"invalidKeyword"
01/04/2005
©
2005 Tridium, Inc.
Page 49 of 117
13,"invalidSymbol"
15,"lineLost"
18,"syntaxError"
21,"systemError"
22,”missingLCU”
not communicating
23, "okNotActive"
24,"unknown"
status
discrete input data, displayed as defined under the parameter
“activeInactiveText” on the Visual properties page.
01/04/2005
©
2005 Tridium, Inc.
Page 50 of 117
5.4.2 AndoverGenericBI: Config Properties
executionParameters
-never
-slower
-normal (default)
-faster
-fastest
-minutely
-onTrigger
-input
-output
pollFrequency
ratio counts:
-normal (default)
-fastest
-slowest
minimumPollInterval
pointName
data.
01/04/2005
©
2005 Tridium, Inc.
Page 51 of 117
pointType
the AC256 defined point type (“digitalInput”). If created manually by copyand-paste, will contain “unknown”.
pollDisable
“true”.
pointSource
pointTerminals
polarity
“normal” or “reverse”. If set to “normal”, an input read as “ON” in the
Andover poll response will be set to “active” in Niagara. If this parameter is
set to normal, and input read as “ON” in the Andover poll response will be
set to “inactive” in Niagara.
01/04/2005
©
2005 Tridium, Inc.
Page 52 of 117
5.4.3 AndoverGenericBI: Visual Properties
position
activeInactiveText
active – this text is displayed as the point status if the input value modified
by the polarity setting evaluates to “on” or “true”.
inactive – this text is displayed as the point status if the input value modified
by the polarity setting evaluates to “off” or “false”.
01/04/2005
©
2005 Tridium, Inc.
Page 53 of 117
5.4.4 AndoverGenericBI: Engineering Properties
averageExecuteTime
userData
debugOn
the admin tool.
01/04/2005
©
2005 Tridium, Inc.
Page 54 of 117
5.4.5 AndoverGenericBI: Security Properties
securityGroups
01/04/2005
©
2005 Tridium, Inc.
Page 55 of 117
5.5
Configuring the AndoverGenericBO Object
5.5.1 AndoverGenericBO: Status Properties
objectType
Static field: AndoverGenericBO
statusFlags
description
rdStatus
0, "ok"
1, “noResponse”
2, "accessDenied"
4, "badNumber"....................................................................................................................
................................................................................................. see Andover documentation
5, "badReloadBlock"
01/04/2005
©
2005 Tridium, Inc.
Page 56 of 117
11,"invalidKeyword"
13,"invalidSymbol"
15,"lineLost"
18,"syntaxError"
21,"systemError"
22,”missingLCU”
not communicating
23, "okNotActive"
24,"unknown"
pointState
may be overwritten.
wrStatus
Status of last command (write) from Niagara to the AC256. Indicates ok if
write was successful, otherwise indicates an error.
status
bOut
Indicates data sent to the AC256 from Niagara. A command to set this value
in the AC256 is generated whenever this value changes.
01/04/2005
©
2005 Tridium, Inc.
Page 57 of 117
5.5.2 AndoverGenericBO: Config Properties
executionParameters
-never
-slower
-normal (default)
-faster
-fastest
-minutely
-onTrigger
-input
-output
pollFrequency
ratio counts:
-normal (default)
-fastest
-slowest
minimumPollInterval
pointName
data.
01/04/2005
©
2005 Tridium, Inc.
Page 58 of 117
pointType
the AC256 defined point type (counter, temperature, or voltage). If created
manually by copy-and-paste, will contain “unknown”.
pollDisable
“true”.
pointSource
pointTerminals
polarity
01/04/2005
©
2005 Tridium, Inc.
Page 59 of 117
5.5.3 AndoverGenericBO: Visual Properties
position
activeInactiveText
01/04/2005
©
2005 Tridium, Inc.
Page 60 of 117
5.5.4 AndoverGenericBO: Engineering Properties
averageExecuteTime
userData
debugOn
the admin tool.
01/04/2005
©
2005 Tridium, Inc.
Page 61 of 117
5.5.5 AndoverGenericBO: Security Properties
securityGroups
01/04/2005
©
2005 Tridium, Inc.
Page 62 of 117
5.6
Configuring the AndoverGenericTSO Object
5.6.1 AndoverGenericTSO: Status Properties
objectType
Static field: AndoverGenericTSO
statusFlags
description
rdStatus
0, "ok"
1, “noResponse”
2, "accessDenied"
4, "badNumber"
5, "badReloadBlock"
9, "expressionTooComplex".................................................... see Andover documentation
11,"invalidKeyword"
01/04/2005
©
2005 Tridium, Inc.
Page 63 of 117
13,"invalidSymbol"
15,"lineLost"
18,"syntaxError"
21,"systemError"
22,”missingLCU”
not communicating
23, "okNotActive"
24,"unknown"
pointState
may be overwritten.
statusInput
Value read from the AC256, displayed in text defined under visual tab.
statusOutput
01/04/2005
©
2005 Tridium, Inc.
Page 64 of 117
5.6.2 AndoverGenericTSO: Config Properties
executionParameters
-never
-slower
-normal (default)
-faster
-fastest
-minutely
-onTrigger
-input
-output
pollFrequency
ratio counts:
-normal (default)
-fastest
-slowest
minimumPollInterval
pointName
data.
01/04/2005
©
2005 Tridium, Inc.
Page 65 of 117
pointType
the AC256 defined point type (TriStateOutput). If created manually by
copy-and-paste, will contain “unknown”.
pollDisable
“true”.
pointSource
pointTerminals
01/04/2005
©
2005 Tridium, Inc.
Page 66 of 117
5.6.3 AndoverGenericTSO: Visual Properties
position
stateText
Enter in the text that corresponds to the state of the AC256 output.
1= text to display when the AC256 reports a state of “ – ON”.
2= text to display when the AC256 reports a state of “ OFF”
3= text to display when the AC256 reports a state of “ ON”
01/04/2005
©
2005 Tridium, Inc.
Page 67 of 117
5.6.4 AndoverGenericTSO: Engineering Properties
averageExecuteTime
userData
debugOn
the admin tool.
01/04/2005
©
2005 Tridium, Inc.
Page 68 of 117
5.6.5 AndoverGenericTSO: Security Properties
securityGroups
01/04/2005
©
2005 Tridium, Inc.
Page 69 of 117
5.7
Configuring the AndoverVariableAnalog Object
5.7.1 AndoverVariableAnalog: Status Properties
objectType
Static field: AndoverVariableAnalog
statusFlags
outOfService – set to out of service
description
rdStatus
0, "ok"
1, “noResponse”
2, "accessDenied"
4, "badNumber"
5, "badReloadBlock"
11,"invalidKeyword"
01/04/2005
©
2005 Tridium, Inc.
Page 70 of 117
13,"invalidSymbol"
15,"lineLost"
18,"syntaxError"
21,"systemError"
22,”missingLCU”................................................................................................................. data
is from an LCU which is
not communicating
23, "okNotActive"
24,"unknown"
pointState
may be overwritten.
wrStatus
indicates status of last command (write) to the AC256 in relation to this
point object.
aoInt
current value of this output in the AC256, presented in Niagara as an integer
(all fractional data dropped)
aoFloat
current value of this output in the AC256, presented in Niagara as a floating
point value
aPut
value to write to the AC256. Changing this value will cause
communications to the AC256 to write this value to the analog output.
01/04/2005
©
2005 Tridium, Inc.
Page 71 of 117
5.7.2 AndoverVariableAnalog: Config Properties
executionParameters
-never
-slower
-normal (default)
-faster
-fastest
-minutely
-onTrigger
-input
-output
pollFrequency
ratio counts:
-normal (default)
-fastest
-slowest
minimumPollInterval
pointName
data.
01/04/2005
©
2005 Tridium, Inc.
Page 72 of 117
pointType
the AC256 defined point type (VariableAnalog). If created manually by
pollDisable
“true”.
pointSource
the origin of the point in the AC256 system. (which system drum and
domain). If created manually by copy-and-paste, will contain “unknown”.
pointTerminals
01/04/2005
©
2005 Tridium, Inc.
Page 73 of 117
5.7.3 AndoverVariableAnalog: Visual Properties
position
decimalFormat
01/04/2005
©
2005 Tridium, Inc.
Page 74 of 117
5.7.4 AndoverVariableAnalog: Engineering Properties
averageExecuteTime
userData
debugOn
the admin tool.
01/04/2005
©
2005 Tridium, Inc.
Page 75 of 117
5.7.5 AndoverVariableAnalog: Security Properties
securityGroups
01/04/2005
©
2005 Tridium, Inc.
Page 76 of 117
5.8
Configuring the AndoverVariableDiscrete Object
5.8.1 AndoverVariableDiscrete: Status Properties
objectType
Static field: AndoverVariableDiscrete
statusFlags
description
rdStatus
0, "ok"
1, “noResponse”
2, "accessDenied"
4, "badNumber"
5, "badReloadBlock"
6, "binaryOperatorExpected" .................................................. see Andover documentation
11,"invalidKeyword"
01/04/2005
©
2005 Tridium, Inc.
Page 77 of 117
13,"invalidSymbol"
15,"lineLost"
18,"syntaxError"
21,"systemError"
22,”missingLCU”
not communicating
23, "okNotActive"
24,"unknown"
pointState
may be overwritten.
wrStatus
Indicates ok if last data write (command) from Niagara to AC256 was
successful, otherwise indicates an error message.
status
bOut
01/04/2005
©
2005 Tridium, Inc.
Page 78 of 117
5.8.2 AndoverVariableDiscrete: Config Properties
executionParameters
-never
-slower
-normal (default)
-faster
-fastest
-minutely
-onTrigger
-input
-output
pollFrequency
ratio counts:
-normal (default)
-fastest
-slowest
minimumPollInterval
pointName
data.
01/04/2005
©
2005 Tridium, Inc.
Page 79 of 117
pointType
the AC256 defined point type (VariableDiscrete). If created manually by
pollDisable
“true”.
pointSource
the origin of the point in the AC256 system. (SX, SV, SA, or SF system
table, plus domain). If created manually by copy-and-paste, will contain
“unknown”.
pointTerminals
polarity
01/04/2005
©
2005 Tridium, Inc.
Page 80 of 117
5.8.3 AndoverVariableDiscrete: Visual Properties
position
activeInactiveText
01/04/2005
©
2005 Tridium, Inc.
Page 81 of 117
5.8.4 AndoverVariableDiscrete: Engineering Properties
averageExecuteTime
userData
debugOn
the admin tool.
01/04/2005
©
2005 Tridium, Inc.
Page 82 of 117
5.8.5 AndoverVariableDiscrete: Security Properties
securityGroups
01/04/2005
©
2005 Tridium, Inc.
Page 83 of 117
5.9
Configuring the AndoverGenericString Object
5.9.1 AndoverGenericString: Status Properties
objectType
Static field: AndoverGenericString
statusFlags
description
rdStatus
0, "ok"
1, “noResponse”
2, "accessDenied"
4, "badNumber"
5, "badReloadBlock"
01/04/2005
©
2005 Tridium, Inc.
Page 84 of 117
8, "entryOutOfRange" .......................................................................................................... see
Andover documentation
11,"invalidKeyword"
13,"invalidSymbol"
15,"lineLost"
18,"syntaxError"
21,"systemError"
22,”missingLCU”
not communicating
23, "okNotActive"
24,"unknown"
28, “incorrectDomain” .................................................. could not get data because domain
toAndover
any valid Andover command which does not cause the AC256 to change
domains or to return a prompt other than a ready prompt.
fromAndover
The response to the command entered in toAndover.
01/04/2005
©
2005 Tridium, Inc.
Page 85 of 117
5.9.2 AndoverGenericString: Config Properties
executionParameters
-never
-slower
-normal (default)
-faster
-fastest
-minutely
-onTrigger
-input
-output
pollFrequency
ratio counts:
-normal (default)
-fastest
-slowest
minimumPollInterval
pointName
Field ignored for this type of object.
01/04/2005
©
2005 Tridium, Inc.
Page 86 of 117
pointType
Static text “unknown”
pollDisable
“true”.
pointSource
pointTerminals
01/04/2005
©
2005 Tridium, Inc.
Page 87 of 117
5.9.3 AndoverGenericString: Visual Properties
position
01/04/2005
©
2005 Tridium, Inc.
Page 88 of 117
5.9.4 AndoverGenericString: Engineering Properties
averageExecuteTime
userData
debugOn
the admin tool.
01/04/2005
©
2005 Tridium, Inc.
Page 89 of 117
5.9.5 AndoverGenericString: Security Properties
securityGroups
01/04/2005
©
2005 Tridium, Inc.
Page 90 of 117
5.10 Configuring the AndoverCommand Object (release 2.203.227d or later
only)
5.10.1 AndoverCommand: Status Properties
objectType
Static field: AndoverGenericString
statusFlags
description
rdStatus
pointState
wrStatus
not used on this object type, can be ignored
not used on this object type, can be ignored
indicates status of last write
01/04/2005
©
2005 Tridium, Inc.
Page 91 of 117
trigger
indicates the value of the linked trigger input to this object. Commands will
be transmitted once when the trigger value transitions to the level configured
in the triggerLevel parameter on the Config tab.
response 1/response2/response3
The response message from the Andover panel to the last time command1 or
command2 or command3, respectively, was transmitted. An “error”
message here indicates an improper command was sent.
“command1/command2/command3 are configured on the Config tab.
01/04/2005
©
2005 Tridium, Inc.
Page 92 of 117
5.10.2 AndoverCommand: Config Properties
executionParameters
-never
-slower
-normal (default)
-faster
-fastest
-minutely
-onTrigger
-input
-output
pollFrequency
not applicable to this object (this object type does not poll)
01/04/2005
©
2005 Tridium, Inc.
Page 93 of 117
minimumPollInterval
not applicable to this object (this object type does not poll)
pointName
Name which will be pulled to any GxText objects linked to the trigger input.
pointType
Static text “unknown”.
pollDisable
Not used for this object type.
pointSource
Static text “unknown”. Not used for this object type.
pointTerminals
Static text “unknown”. Not used for this object type.
command1
Command which will be sent to the Andover panel whenever the trigger (see
Status properties) transitions to the triggerLevel (see below) or whenever the
manual command “sendCommand”
is executed by right clicking on this
object (see picture at right) or from
this object’s pull down menu.
“command1”, “command2”, and
“command3” commands will be sent
upon one trigger activation. To
deactivate a command, enter an
empty string into this parameter.
command2
See command1
command3
See command1. Recommend setting this to a benign command guaranteed
to return an R> prompt, such as “DOM 0”.
triggerLevel
Whenever “trigger” (see Status properties) transitions to this triggerLevel,
the commands will be sent once.
01/04/2005
©
2005 Tridium, Inc.
Page 94 of 117
5.10.3 AndoverGenericString: Visual Properties
position
5.10.4 AndoverGenericString: Engineering Properties
averageExecuteTime
userData
debugOn
the admin tool.
5.10.5 AndoverGenericString: Security Properties
securityGroups
01/04/2005
©
2005 Tridium, Inc.
Page 95 of 117
6 Using SET and AUTO Commands
The following modules support the use of the SET and AUTO commands: AndoverGenericAO,
AndoverGenericBO, AndoverGenericTSO, AndoverVariableAnalog, AndoverVariableDiscrete.
The Set command provides a way for an operator to send a setpoint command to an AndoverAC256 shadow
object. These commands are not available to the operator if the input property of the object is linked (this is
because it is assumed the value will be driven from the link if the object input is linked). If unlinked, the Set and
Auto commands are available by right-clicking on the shadow object:
Set:
The Set command is only active on shadow objects who’s inputs are not linked. When the Set command is
selected, the Operator is prompted for an SET value. Once the SET value is entered, DISABLE command is
sent to the AC256 real point, followed by the SET value entered. The shadow objects OUTPUT value (if
polled and once polled) should show the same value as the shadow object's INPUT value after the next poll
cycle. Under these conditions, any programs running in the AC256 will have no control over the point.
Auto:
The Auto command is only active on shadow objects that are not linked. When the Auto command is
selected, an ENABLE command is sent to the AC256 point, which will return the point to local control of
the AC256 programs. AC256 programs can now write to that point and the shadow object's OUTPUT value
(if polled) may show a different value than the shadow objects INPUT value.
Neither the SET or AUTO commands are active when a shadow object INPUT is linked. You do not want to
SET the INPUT value of shadow object that has another objects OUTPUT value linked to it. Nor do you want
ENABLE a point and return it to AC256 control if another objects OUTPUT value is linked to it. If the link is
setup to another Niagara object and the linked object OUTPUT value differs from the shadow object INPUT
value, the AC256 system will be sent a DISABLE for the point and then the new linked value will be sent.
Return to AC256 program control after an object has been linked:
If you want the AC256 program to control a point, you are fine if you never use the SET command or never
linked another Niagara object to the output shadow object point type's INPUT.
If you want AC256 program to control a point that you have used the SET command on or linked to, then
you must delete the shadow object link first (if there is one) and you must issue an AUTO command.
01/04/2005
©
2005 Tridium, Inc.
Page 96 of 117
7 The Learn Process
7.1
Invoking the PointListManager
The learn process is a quick way to create Niagara shadow objects which correspond to assigned points in the
AC256 system. To invoke the learn process, the Niagara Andover AC256 service must be installed and
operating, and a AndoverNetwork container containing an AndoverDevice object must also exist. See sections 2
and 3 above to install the network container and the device.
In Work Place Pro, display the project tree, right click on the AndoverDevice you wish to learn, and select the
“PointListManager” command. This process is shown below.
When the PointListManager is invoked, it polls the AC256 to learn data from all IOUs and all Domains that have
been configured into the AC256 Master.
01/04/2005
©
2005 Tridium, Inc.
Page 97 of 117
7.2
The PointListManager Display
It may take several seconds to poll for data from all IOUs, SF Table, SV Drum, SX Drum, SA drum, and
attached LCUs, especially on a large system. If the learn completes successfully, then the status window will
display “idle”, and a list of points will appear in the display window area:
7.2.1 The Learn History Status Bar and History Display
There is a “history” status bar across the top of the learn window, with a right-pointing triangle to the far right.
The history status bar will display the results of the last executed step in the learn process. Upon learn
completion, the history status bar will display “Idle x ERRORS, y WARNINGS”.
If ERRORS or WARNINGS are indicated, then click the black triangle to the right of the status bar and review
the pop-up history display and look for lines beginning with “ERROR” or “WARNING”.
Note that the History will be updated with information during point creation, and should be reviewed after point
creation.
01/04/2005
©
2005 Tridium, Inc.
Page 98 of 117
7.2.2 The ‘Learn Controls’ Section
There are 7 check boxes in the upper right hand corner of the PointListManager. These boxes default to as
shown in the above picture. These check boxes provide a way for the user to learn a subset of points instead of
the entire point list from a system:
- enableGetUserFlags – if checked, will learn assigned user flags from the
master AC256 (domain 0).
- enableGetSystemFlags – if checked, will learn pre-defined system flags
from the master AC256.
- enableGetIouPoints – if checked, all assigned points from all IOUs
configured in the system will be learned.
- enableGetLcuPoints – if checked, all assigned points from configured
LCUs/PCUs/TMUs/VAVCUs will be learned. This will include all
assigned IO, assigned SV, and assigned SF points on LCUs.
- enableGetSvPoints – if checked, will learn all assigned SV points from
domain 0 (master).
- enableGetSaPoints – if checked, will learn all assigned SA points from
domain 0
- enableGetSxPoints – if checked, will learn all assigned SX points from
domain 0
NOTE: IF ANY BOX IS CHECKED or UNCHECKED, THE USER MUST SELECT THE “GETLIST”
BUTTON TO REFRESH THE DISPLAY LIST.
7.2.3 The ‘Create Controls’ Section
(NOTE: new for versions 2.301.601, 2.301.514c, 2.301.431a )
There are two check boxes at the far right side of the display to modify point names and point locations when
creating the learned points:
- useConvertedName – The AC256 allows use of 3 special characters which
can cause problems when creating point names in Niagara. These are the
underscore charater (_), the dot character (.), and the percent character (%).
• If unchecked, the point creation process will use the text under the
“Andover Name” column of the point display to create Niagara points.
The drawback to this approach is that Niagara will automatically
convert all dot characters and all percent characters to the underscore
01/04/2005
©
2005 Tridium, Inc.
Page 99 of 117
character, and attempt to add the resulting point name to the database.
This may result in a duplicate name if a different point with the same
name already exists in the database. Note that if the point name
already exists, the point name will be modified yet again to append
an underscore plus a unique incremental number to the point name
to make it unique. This has the un-desired effect of making the point
name in Niagara not match the point name in Andover.
• If checked, the point creation process will use the text under the
“Converted Name” column of the point display to create Niagara points.
The converted name has replaced all underscores with “_UND_”,
replaced all dots with “_DOT_”, and replaced all percents with
“_PER_”. This guarantees uniqueness when the point is created, and
still provides a reasonable map of the Niagara name back to the Andover
name.
• If the Andover database uses underscore, percent, or dot characters
in the point names, it is recommended to leave this box checked.
-
createInContainers –
• If checked, will create points in appropriately named sub-containers
of the AndoverDevice. The sub-containers are named to reflect the
point source in the Andover system (i.e, which domain or LCU the
point is from, which IOU the point is from, and what type of point
table it originated in. Example container names are :
• IOU_1
points from IOU-1
• IOU_2
points from IOU-2
• DOM_0_SV
points from master SV table
• DOM_0_SX
points from master SX table
• DOM_2
points from LCU2 I/O
• DOM_2_SX
points from LCU2 SX table
• DOM_2_UF
points from LCU2 User Flags
• If un-checked, all points will be created directly in the
AndoverDevice container.
7.2.4 Point Manager Action Buttons
There are 4 buttons at the bottom of the screen:
-
-
GetList – initiates the process to get the list of system points. Must be
selected after any of the “Learn Controls” check boxes are changed in order
to refresh the point list display.
SelectAll – this button will select all points in the list for point creation.
Create – creates all points which have been selected in the display window.
Edit Type – (NOTE: new for versions 2.301.601, 2.301.514c, 2.301.431a)
For many points, the appropriate point type cannot be definitively
ascertained by the learn process. If this is the case, a default “best guess”
point type will be assigned in the point list and displayed in red color. (For
default learn type rules, see “Default Rules on Mapping AC256 Points to
Andover Objects”, below). The user has the option to change the type for
any such point before point creation by using the “Edit Type” action button.
•
To edit a point type, select only one point at a time by clicking on
the point in the point list, and then clicking the “Edit Type” button.
A popup window with an appropriate pull down list will display.
01/04/2005
©
2005 Tridium, Inc.
Page 100 of 117
Select the desired type within the list and click OK.
7.2.5 Default Rules on Mapping AC256 Points to Andover Objects
The learn process keeps track of the particular domain, IOU, LCU, table, etc that each point comes from. For
data from an IOU or LCU, the learn process also keeps track of the indicated type of I/O and what the
channel/terminal information is. In addition, the learn process looks at the data returned for an individual point
to try to determine the type of Niagara object to map it to. For data not from an IOU or LCU, the only way to
tell data type is to look at the data itself. This may lead to points being learned as incorrect object types,
especially if the data is “0”. The user has an opportunity to override the default object types for points that
have ambiguous data types (use the EDIT TYPE button, as described above). This must be done before the
“Create” button is selected. See the following table for default mapping rules:
Point Source
Any IOU or LCU
Any IOU or LCU
Any IOU or LCU
Reported Point Type
Digital On/Off Input
Temperature/Counter/Voltage
Output
Type of Data
Any IOU or LCU
Any IOU or LCU
SV or SA or SX Drum
Output
Output
(not reported)
“ – ON”
Any number
“ON” or “OFF”
SV or SA or SX Drum
SV or SA or SXDrum
(not reported)
(not reported)
“ - ON”
“0”
SV or SA or SX Drum
(not reported)
SF Table
(not reported)
any number other
than “0”
“1” or “0” or
Niagara Object Type Created
AndoverGenericBI
AndoverGenericAI
AndoverGenericBO (default)
AndoverGenericTSO (alt)
AndoverGenericTSO
AndoverGenericAO
AndoverVariableDiscrete (def)
AndoverVariableTSO (alt)
AndoverGenericTSO
AndoverVariableDiscrete (def)
AndoverVariableAnalog (alt)
AndoverGenericTSO (alt)
AndoverVariableAnalog
AndoverGenericBI (def)
AndoverGenericBO (alt)
01/04/2005
©
2005 Tridium, Inc.
Page 101 of 117
8 The DownLoadManager (release 2.203.228b and later)
NOTE: THIS FEATURE IS ONLY AVAILABLE WITH DRIVER VERSION 2.203.228b AND LATER
(under Niagara 2.2) OR DRIVER VERSION 2.301.324b.v1 AND LATER (under Niagara 2.3)
The AndoverAC256 driver has the ability to store a local copy of the Andover controller program in a text file.
This file is stored on the Niagara platform in the same directory as the Niagara station database. The file is an
ASCII format file named “dump.txt”. The DownLoadManager has the ability to create/re-create this file by
sending the “DUMP ALL” command to the Andover controller, and it also has the ability to re-load the Andover
controller by sending the “RELOAD” command followed by the contents of the dump.txt file.
During the “Dump” operation, validity checking is done on all program blocks by comparing program line
checksums with a calculated checksum. If an error is found, the file will not be created/re-created (i.e., and preexisting good dump file will not be overwritten with a new “bad” dumpfile.
During the “Reload” operation, before a dump.txt file is used, it is again pre-validated for bad reload blocks by
comparing calculated and stored checksums on every line of code. Only if the file passes validation will the
RELOAD command be sent to the Andover panel.
During reload operation, the dump.txt file is sent line-by-line to the controller, and stop/start flow control signals
from the Andover panel are used to control the download of the program to prevent buffer overflow on the
Andover panel (and the resulting BAD RELOAD BLOCK errors).
During “Dump” or “Reload” operations, all other Andover driver communications is temporarily halted. After
the dump or reload operation is completed, the driver will automatically resume operation where it left off before
the invokation of “Dump” or “Reload”. Note that the Andover device will most likely be marked as “down” by
the driver, and will be brought back online at the next ping cycle time if the Andover services’s DeviceStatus is
enabled.
8.1
Invoking the DownLoadManager
The DownLoadManager is invoked in WorkPlacePro by expanding the station tree to /<station
name>/AndoverNetwork/AndoverDevice, and right-clicking on AndoverDevice, as shown here:
01/04/2005
©
2005 Tridium, Inc.
Page 102 of 117
8.2
Using the DownLoadManager for the first time
The first time the DownLoadManager is used, there will not be a “dump.txt” file existing in the station directory
on the Jace. In this case, the following DownLoadManager view will be displayed:
In this state, an attempt to invoke the “Reload” button will detect that the file does not exist, and will not result in
any reload commands being sent to the Andover panel. The text area on the right contains the error response to
the attempt to read a non-existant file, and is not actual file contents.
•
•
•
•
•
1: Text area which displays the contents of the dumpn.txt file, if it exists, where n is the number shown
in the window of item 2 “Domain or LCU” (see below) . If the file does not exist, the text area will
display message similar to that shown here.
2: “Domain or LCU” entry field. Enter a number from 0 to 32 which represents the LCU address of
the device to Dump or Reload. An entry of “0” means the master device (the AC256 or AC8 panel).
3: Dump button. Clicking on this button will
a) stop all poll and device status activity and all other communications to the Andover panel,
b) send the DOMAIN n command to the controller, where n is the “Domain or LCU” entry from
item 2 above,
c) cause the “dump all” command to be sent to the Andover panel,
d) error check the dump response from the Andover panel,
e) write the dump response to a dump.txt file if error checking passes, and
f) re-establish poll and device status settings to the values existing before the dump command
was issued.
NOTE: The Dump operation can take a couple of minutes, PLEASE BE PATIENT.
4: Clear LCU mem button. Clicking on this button will send the CLEAR MEMORY ALL command to
the LCU identified in item 2 above. Clearing the LCU memory is necessary before a sucessful reload
can be performed. This button is only enabled if item 2 is set to greater than “0”.
5: Reload button. Clicking on this button will
a) stop all poll and device status activity and all other communications to the Andover panel,
01/04/2005
©
2005 Tridium, Inc.
Page 103 of 117
•
•
•
•
•
•
b) error check the dump.txt file stored on the jace (if it exists)
c) if the dump.txt file passes error checking, cause the DOMAIN n command where n is the
“Domain or LCU” entry from item 2 above,
d) send the “reload ” command to be sent to the Andover panel followed by the contents of the
dump.txt file, and
e) re-establish poll and device status settings to the values existing before the reload command
was issued.
6: Abort button. This button is only active during a Reload operation. Because reloads can take
several minutes (typically about 20 minutes for a 75kByte program file @ 9600 baud), there may be
times when a reload may need to be aborted. Clicking the abort button will abort the reload after the
current program line has been sent.
7: Sync Time button. Will synchronize the AC256 or AC8 panel to the time kept by the Niagara
controller.
8: Set Options button. Will send the OPT command to the AC256/AC8 controller, and display a series
of dialog boxes to answer each of the option command queries from the controller.
9: Set Saved Opts button. Will send the OPT command to the AC256/AC8 controller, and answer each
of the controller queries using values stored on the AndoverService “Options” property tab.
10: Status Window: Displays the current operation in progress during a download/reload operation.
11: Status Window History: Clicking this control will pop up a window containing the history of all
messages sent to the Status Window. IMPORTANT: It is recommended that this be reviewed after
every operation to ensure that no errors occurred during the operation.
01/04/2005
©
2005 Tridium, Inc.
Page 104 of 117
8.3
Performing a DUMP Operation
A dump command can be invoked at any time by clicking on the Dump button. This causes the “DUMP ALL”
command to be sent to the Andover controller n, which then responds with a ASCII formatted and delimited
hexadecimal dump of the Andover controller program. If the hexadecimal dump passes error checking, a new
dumpn.txt file will be saved (or the old one overwritten) on the Niagara platform.
During the receiving of the Andover program, the status line will display the following for up to several minutes:
Please be patient and wait for the status line to progress beyond this before performing any other operation.
Note that all of the action buttons on the DownLoadManager view will be disabled during this operation.
If the dump proceeds normally to completion, the dump.txt file will display in the text area, and the status line
will indicate successful completion:
Check the Status History (see bullet 6 above) to be sure no errors occurred:
01/04/2005
©
2005 Tridium, Inc.
Page 105 of 117
8.4
Performing a RELOAD Operation
A reload command can be invoked at any time by clicking on the Reload button. This causes the “RELOAD”
command to be sent to Andover controller or LCU n, followed by the dumpn.txt file contents.
Note that before invoking the Reload button when reloading an LCU, you must first invoke the “Clear LCU
mem” button for that LCU. This will prepare the LCU to receive the reload.
During the reload operation, the status line will update to display the progression of the reload:
Note that the only action button that is enabled during a reload is the Abort button.
If the reload proceeds normally to completion, the status line will indicate successful completion:
Again, be sure to check the Status History display to verify that no errors were generated during the reload:
01/04/2005
©
2005 Tridium, Inc.
Page 106 of 117
8.5
Synch Time Button
If the controller dropped its program because of an extended power outage, the time will need to be set in the
controller. This can be done by clicking the “Sync Time” button.
8.6
Set Options Button
After a controller reload is performed, usually the OPTIONS command needs to be invoked to set controller
options for proper operations. By clicking on the “Set Options” button, the user can invoke the OPTIONS
command an walk through a series of 10 dialog boxes to set controller options. The first dialog box appears is
shown here:
Answer each of the dialog boxes (or leave blank to accept the default) and click OK to advance to the next dialog
box.
8.7
Set Saved Opts Button
As an alternate to walking through 10 dialog boxes as with the “Set Options” button, the “Set Saved Opts”
button answers each dialog using properties stored on the Andover Service “Options” property sheet. PLEASE
BE CERTAIN THAT THE PROPERTY SHEET IS SET UP PROPERLY BEFORE INVOKING THIS
COMMAND! See the AndoverService section above for setting these parameters.
01/04/2005
©
2005 Tridium, Inc.
Page 107 of 117
9 Application Note on Creation of Shadow Objects from Nonassigned Points in SV, SX, SA, SF Tables.
It is possible to create shadow objects which map to non-assigned table entries in the AC256. This is possible,
because the polling process can use any AC256 PRINT command that returns one and only one data point. For
example the PRINT V1, PRINT X1, and PRINT A1 all return the value of one data point from the SV, SX, and
SA tables respectively.
If you wish to model an un-assigned system table entry, copy the appropriate object from the local library and
enter the address of the table entry for the property “pointName” on the object’s Config tab. For example, to
model SV table entry #57 (for which the value can be obtained with the PRINT V57 command) enter in “V57”
into the pointName field, as
shown:
Note that the properties pointType, pointSource, and pointTerminals will remain “unknown”.
WARNING: do not enter a pointName such as “SV”, “SX”, or “SA”, as this will cause the PRINT SV,
PRINT SX, or PRINT SA commands, respectively, to be generated and sent to the AC256. These
commands DO NOT return a single data item, but rather return the entire table.
01/04/2005
©
2005 Tridium, Inc.
Page 108 of 117
01/04/2005
©
2005 Tridium, Inc.
Page 109 of 117
10 Application Note on Using Analog Objects
The following discussion applies to the following Niagara Andover analog objects: AndoverGenericAI,
AndoverGenericAO, and the AndoverVariableAnalog.
The picture below shows a typical Andover analog object linked to an AnalogOutput command object. The
object ORANGES shows status OK for both read and write.
Since the AC256 handles only 4 digits in any analog command or query PRINT statement, there is a good
possibility that analog values generated in Niagara logic may exceed the capability of the AC256 to handle it.
The AC256 will send the text “OVFL” in place of an analog value for all internal variables and IO that evaluate
to greater than 9999 or less than –9999. In general, all numbers will be truncated at 4 decimal points of accuracy
by the AC256. For instance, for a simple calculation of (x*y) = z would produce the following results:
RESULTS of (x*y) = z
x
1234
12.34
12.34
12.34
0.1234
0.1234
y
10
10
1.2
0.001
0.001
0.0001
z
12340
123.4
14.808
0.01234
0.0001234
0.00001234
text sent by AC256
OVFL
123.4
14.80
0.0123
0.0001
0
The user should be aware of these limitations when designing a system, and should take care to be sure that the
AC256 will not return an OVFL or truncate meaningful data. If an OVFL is returned in response to a querry for
analog data, a “variableOutOfRange” exception will be generated by the Niagara software and displayed as
follows (note that last known good value remains as the output of the shadow object):
A similar limitation applies when trying to write more than 4 significant digits to an Andover analog object
(either AndoverVariableAnalog or AndoverGenericAO). Because the AC256 can handle only 4 digits in the
MODIFY statement, the following processing is performed before generating the command:
01/04/2005
©
2005 Tridium, Inc.
Page 110 of 117
If the value is greater than or equal to 10000, or less than or equal to –10000, then a
“variableOutOfRange” exception is generated as shown below, and no command is sent
If the value between –10000 and +10000, the number is rounded to the 4 most significant digits such
that at most 4 digits are to the right of the decimal place. In other words, a number like 1256.78 will be
rounded and truncated to 1257, and a number like 0.0125678 will be rounded and truncated to 0.0126.
A number such as 0.000012 will be sent as 0.
A “variableOutOfRange exception will be generated for all aPut inputs which are out of range:
Another possible adverse scenario would be the inadvertent mapping of AC256 discrete or tri-state points to an
Niagara analog object, as shown below:
In this case, the pointName for a discrete point was entered on the Config tab for the analog object. This is
possible to do, because the driver simply substitutes the pointName into the AC256’s PRINT command, so any
point name (of any type) is a valid entry. If the resulting querry returns an “ON”, this obviously will not
translate to an analog value, and the numberFormatException is generated. NOTE: A VALUE OF “0” IS
CONSIDERED VALID FOR BOTH ANALOG AND DISCRETE OBJECT TYPES, AND NO ERRORS WILL
BE GENERATED. IT MAY NOT BE OBVIOUS THAT A NIAGARA ANALOG OBJECT IS MISMATCHED TO AN AC256 DISCRETE POINT IF THE VALUE RETURNED IS “0”.
01/04/2005
©
2005 Tridium, Inc.
Page 111 of 117
11 Application Note on Using Discrete Objects
The following discussion applies to the following Niagara objects: AndoverGenericBI, AndoverGenericBO, and
AndoverVariableDiscrete.
The picture below depicts a simple BinaryOutput driving an AndoverVariableDiscrete with a value of “true”.
Notice that the rdStatus output indicates “0: ok”.
Just as it is possible to incorrectly map an Andover analog object to an AC256 discrete point, it is also possible
to map an Andover discrete object type to an AC256 analog point. Doing so will generate a
“binaryFormatException” as shown in the following diagram:
Note that the rdStatus is set to “26: binaryFormatException”. This is indicative that the returned data does not
contain either “0”, “OFF”, or “ON”, and the pointName parameter is most likely set to map to an AC256 analog
point. Note that if the AC256 analog point that the discrete is mapped to happens to be a value of “0”, that the
response would be accepted as a “false” and no exception would be generated.
01/04/2005
©
2005 Tridium, Inc.
Page 112 of 117
12 Using Debug
There are 3 levels of debug included with this driver:
- service level debug, selected from the AndoverService “Engineering”
property sheet.
- device level debug, selected from the AndoverDevice “Engineering”
property sheet.
- object level debug, selected from any shadow object “Engineering” property
sheet.
To view all low-level communications and related diagnostics, turn on the debug feature of the AndoverService
property sheet. The STD output window (usually accessed from the Admin Tool) will then display
querry/response communicatins at the lowest level, as well as any low-level errors/exceptions generated either
because of data errors or driver errors. A typical display is shown, with STD out directed to a command
window:
01/04/2005
©
2005 Tridium, Inc.
Page 113 of 117
To view debug information pertaining to the device, including device-related error messages and device status
messages, turn on debug on the “engineering” tab of the AndoverDevice property sheets. Typical output to a
command window is:
To view debug information for an individual shadow object, turn on the debug option for just that shadow object
(on the “engineering” tab of the object’s property sheets). Sample output is :
01/04/2005
©
2005 Tridium, Inc.
Page 114 of 117
01/04/2005
©
2005 Tridium, Inc.
Page 115 of 117
13 Performance Benchmarks
In factory testing, the following Andover AC256 equipment was available for testing:
•
•
Qty 1: Andover NETMASTER with version 8.3D firmware, no IOUs, sn E222
Qty 1: Andover Program Control Unit
Tests were run from a Dell Dimension XPS 800MHz PC. Serial communications was through the console port
of the AC256.
The AC 256 was set up to include 3 IOUs, 1 LCU, and approximately 100 points were “assigned” in the system,
spread across IOUs, LCU, SV tables, SX table, SA Table, and flag tables.
Niagara was configured using the driver “learn” process to grab all assigned points, and approximately 64 of
these points were moved to “poll always” containers and linked to gxText display objects.
Poll of all 64 linked points took about 21 seconds, which equates to about 330ms per point. Adding more points
increased the cycle time linearly.
In running this test setup non-stop for about 17 ¾ hours, the following performance numbers were recorded:
total requests:
raw response errors:
un-corrected errors:
190561
0
0
from these number, it can be calculated that the overall response per point is about 330ms, and the raw
error rate is 0%.
01/04/2005
©
2005 Tridium, Inc.
Page 116 of 117
Apendix 1 RS-232 Cable Pin Out
A shielded cable with integral drain wire, with at least 3 insulated
conductors should be used. A null-modem configuration is used. All pins
other than those indicated in the diagram below should be left
unconnected. The Andover AC256 requires a continuously active CTS input
which is obtained from the +9V output provided at pin 9 of its RS-232
connector, by looping 5 to 9 at the AC256. The frame ground (earth ground)
from the JACE-501 is connected to the shell of the shielded cable, only at
the JACE end, and is not to be connected to the signal ground. Also note
that the shield should not connect to anything at the AC256 end.
JACE-501
RS-232 PORT
(DB9F)
AC256
C-PORT
(DB25F)
===========
======
2 <-RXD-----------TXD-> 2
3 <-TXD-----------RXD-> 3
5 <----SIGNAL-GND-----> 7
/-CTS-> 5
\-+9V-> 9
}-DRAIN WIRE -------- n/c
01/04/2005
©
2005 Tridium, Inc.
Page 117 of 117

Getting Started with the Niagara Andover AC256 Driver

Transcription

Similar documents

here

No. N o Phillips Academy, Andover, lass., Saturday

IMS Pinafore In Rehearsal For Sawyer Concert April

bryan adamns

SHREVE, CRUMP,- Low,

Math Filler Games for Kindergarten

Comunity Return from

E s tablishedt 1878

Established 1878

WAS ACTING HEADMASTER OF PHILLIPS