Metasys BACnet System Integrator (BSI) Monitoring

Transcription

1 Metasys Connectivity Technical Manual Metasys BACnet System Integrator Section Issue Date 73 TECHNICAL BULLETIN Metasys BACnet System Integrator (BSI) Monitoring Monitoring the BSI Communicator...2 Introduction... 2 Key Concepts... 3 Software Architecture Review... 3 BSI Viewer Menu Bar and Toolbar... 4 BACnet Communicator Application Statistics... 7 Datalink Statistics... 9 Object Mapping PC Protocol Engine Statistics... 2 Notification Class Objects (NCOs) Procedure Overview Detailed Procedures Viewing Mapped BACnet Object Cache Data Viewing BACnet Communicator Application Statistics Viewing Datalink Statistics Viewing PC Protocol Engine Statistics Viewing Notification Class Object Data Troubleshooting... 3 Error Log File... 3 Enable Debug Johnson Controls, Inc. Code No. LIT

2 2 Metasys BACnet System Integrator Monitoring the BSI Communicator Introduction Monitoring involves viewing communication statistics stored within the Metasys BACnet System Integrator (BSI) Communicator by accessing the various screens of the BSI Viewer. The BSI Viewer provides the means to verify that communication is taking place between the Metasys and BACnet systems; therefore, it can only be accessed if the BSI Communicator is running. The BSI Viewer aids in troubleshooting by displaying possible communication inconsistencies. BACnet data that appears in the BSI Viewer and also in the NCM means that communication between the systems is successful and that information is being relayed. This document describes how to: view mapped BACnet object cache data view BACnet Communicator Application Statistics view Datalink Statistics view PC Protocol Engine Statistics view Notification Class Object (NCO) data

3 Metasys BACnet System Integrator (BSI) Monitoring 3 Key Concepts Software Architecture Review The BSI software consists of the BSI Communicator, the BSI Configurator, and the BSI Viewer. As the main component of the BSI software, the BSI Communicator relays and translates information between the Metasys system and the BACnet system. The BSI Configurator is a software support tool for the BSI Communicator. It is used for initial BSI Communicator setup, which includes: defining which Metasys points will be available to foreign BACnet devices defining which BACnet points will be available to the Metasys system setting system parameters in the Metasys device object mapping priority differences between Metasys and BACnet systems establishing a data table for the different ways Engineering units are represented in Metasys and BACnet systems configuring the BSI Communicator s broadcast management feature setting up BACnet event notification for Metasys points The BSI Configurator provides separate user screens for each of these aspects. Data entered on these screens build databases that the BSI Communicator uses when communicating between Metasys and BACnet systems. For more information regarding the BSI Configurator refer to the Metasys BACnet System Integrator (BSI) Commissioning Technical Bulletin (LIT ) in the Metasys Connectivity Technical Manual (FAN 629.5).

4 4 Metasys BACnet System Integrator The BSI Viewer is another software support tool for the BSI Communicator. It provides the means to verify that communication is taking place between the Metasys and BACnet systems. This is done by allowing data about the communication process, stored within the BSI Communicator, to be viewed. The viewable data includes: information relating to the interaction between databases and the creation of original read and write messages information regarding the transmitting and receiving of messages runtime point statistics of the BSI Communicator s cache of BACnet points mapped into Metasys information relating to the acknowledging of messages information on the BSI Notification Class Objects (NCOs) BSI Viewer Menu Bar and Toolbar Each screen of the BSI Viewer has a Menu bar. Options to select the screen type and write a database to disk exist on the File menu. Only the Object Mapping screen has an active toolbar because multiple pieces of information can be viewed from that screen. Table 1 describes the available features and the method to access them. Table 1: Viewer Feature Options Task File Menu Option Menu Bar Option Select screen type. Type - - Write a running database. Write - - Exit the Viewer. Exit - - Rebind a BACnet object. - Rebind - Go to the first BACnet point in the database. - - Toolbar Button First Go to the previous BACnet point in the database. Continued on next page First Prev Prev

5 Metasys BACnet System Integrator (BSI) Monitoring 5 Task (Cont.) Go to the next BACnet point in the database. Go to the last BACnet point in the database. File Menu Option Menu Bar Option Toolbar Button Next Next Last Search backward in the database. - - Search forward in the database. - - Last? Find FindL Find? FindR Write Command On the File menu, the Write submenu lists the different databases used by the BSI Communicator. Choosing one of the databases from this list tells the BSI Communicator to write the current runtime database to the directory determined by the Metasys.ini FMSDATA parameter setting, where it overwrites the existing database file. When the system is running well and all points are online with valid data, use the Write command to save the images of the databases at the current state. The BSI Communicator can use the saved images of the databases to restart quickly with valid default data.

6 6 Metasys BACnet System Integrator Rebind Command The Rebind command applies to only the BACnet object being viewed last in the Viewer and tells the BSI Communicator to do three things: Remember the information specified in the BSI Configurator for the object being viewed in the BSI Viewer. Eliminate any information it might have found in the initial (or subsequent) auto-configuration for the object being viewed in the BSI Viewer (e.g., BSI Configurator fields marked Find from name ). Re-interrogate the system to relearn the information not supplied in the BSI Configurator for the object being viewed in the BSI Viewer. By asking the BSI Communicator to relearn unspecified data fields with the Rebind command, changes in point information are reflected in the running database. To make these changes permanent, perform the Write command for BACnet Object Mapping after Rebinding (relearning) is complete. Clear Stats and Done Command A Done button, Clear Stats button, or both appear on most of the BSI Viewer screens. The Done button closes the current display and redisplays the Object Mapping screen. Clicking the Clear Stats button zeros (clears) the information from the fields within the BSI Communicator. Use this button in a situation where statistics need to be collected from a known point in time (e.g., over a 24-hour period, overnight, or when certain events occur). This eliminates the need of writing down prior values and subtracting them from the new values. In addition, if the commissioning of the BSI Communicator results in numerous errors, the user may want to clear those error counts from the BSI Viewer afterward and then verify the information in the BSI Viewer once the system is running.

7 Metasys BACnet System Integrator (BSI) Monitoring 7 BACnet Communicator Application Statistics The statistics on the BACnet Communicator Application Statistics screen (Figure 1) show the interaction between databases and information relating to the creation of original read and write messages. Table 2 describes this screen s fields. BACnet Communicator Application Statistics - BACnet System Integrator File Rebind View Help First Prev Next Last? Find Find? BACNet Communicator Summary Status Last Scan 1/7/98 9:17:51 Prev Scan 1/7/98 9:17:18 Last Cleared 1/5/ :22:7 Metasys Communication Summary Read Requests Failed Read Req Write Requests Failed Write Req Read Requests Failed Read Req Write Requests Failed Write Req BACNet Communication Summary Failed Cmds Msg Decode Errors Objects Not Found Unsup. Properties Failed Read Prop. Msg Decode Errors Objects Not Found Unsup. Properties 'Other' Failures Clear Stats Done Ready NUM CAS Figure 1: BACnet Communicator Application Statistics BACnet System Integrator Screen

8 8 Metasys BACnet System Integrator Table 2: Field Descriptions - BACnet Communicator Application Statistics Section Field Name Description BACnet Communicator Summary Status Metasys Communication Summary BACnet Communication Summary Last Scan Prev Scan Last Cleared Read Requests Failed Read Req Write Requests Failed Write Req Failed Cmds Msg Decode Errors Objects Not Found Unsup. Properties Read Requests Failed Read Req Write Requests Failed Write Req Failed Read Prop. Msg Decode Errors Objects Not Found Unsup. Properties Other Failures Time stamp of last request to complete a scan of BACnet points. Last time stamp before update appeared in Last Scan. Difference between Last Scan and Prev Scan should be close to the Min Polling Time Interval on the System Setup screen in the BSI Configurator. Time stamp when these statistics were last cleared. Number of BACnet reads sent to the Metasys system. Number of BACnet reads sent to the Metasys system that failed. Number of Metasys writes and commands attempted. Number of Metasys write attributes sent that came back with an error or attempts to write attributes that are read only. Number of failed Metasys commands. Number of BACnet messages sent to Metasys points that could not be decoded. Number of times a BACnet message referenced a Metasys object that the BSI Communicator could not locate in the BSI database. Number of errors from attempts to read an unsupported property. Number of BACnet reads sent. Number of BACnet reads that came back with an error. Number of BACnet writes sent. Number of BACnet writes that came back with an error. Number of individual BACnet property read that failed. Number of BACnet replies to BSI Communicator requests that could not be decoded. Number of times a BACnet message sent from the BSI Communicator referenced an object that the BACnet device could not locate. Number of attempts by the BSI Communicator to read an unsupported property on a BACnet object. Can also occur while the BSI Communicator is learning which optional properties are supported by each BACnet object. Miscellaneous BACnet errors.

9 Metasys BACnet System Integrator (BSI) Monitoring 9 Datalink Statistics The Datalink puts BACnet message packets on and or takes them off the Ethernet card, if they arrive or need to be sent. There are two BACnet Datalink Statistics screens (Figure 2 and Figure 3), and you choose the appropriate screen from the Type submenu on the File menu according to the type of transport protocol used on the BACnet network (Raw Ethernet ISO or BACnet/IP). Each screen shows information regarding the transmitting and receiving of BACnet message packets. Each BACnet message can consist of one or more packets depending on its size. Note that the two screens are the same except for the additional section on the Raw Ethernet ISO screen. Table 3 describes the fields on these screens. BACnet Datalink Statistics - BACnet System Integrator File Rebind View Help First Prev Next Last? Find Find? Datalink Summary Status Last Cleared 1/5/ :22:12 Base Datalink Summary Msg Transmits Msg Received Broadcast Msg Transmits Broadcast Msg Received Retries Transmit Failures Datalink 8823 Summary DLC Xmit Frames DLC Recv Frames Buffers Free Now Least Buffers Free Recv Data Lost Ethernet Errors Discarded Frames Critical Exceptions DLC Data Lost Segments Lost Before Signup Clear Stats Done Ready NUM DS Figure 2: BACnet Datalink Statistics BACnet System Integrator Screen

10 1 Metasys BACnet System Integrator BACnet/IP Datalink Statistics - BACnet System Integrator File Rebind View Help First Prev Next Last? Find Find? Datalink Summary Status Last Cleared 5/ 1/ 2 14:22:12 Base Datalink Summary Msg Transmits Msg Received Broadcast Msg Transmits Broadcast Msg Received Retries Transmit Failures Clear Stats Done Ready NUM DS_BACIP Figure 3: BACnet/IP Datalink Statistics BACnet System Integrator Screen Note: If you display the wrong screen for the type of transport protocol used on the BACnet network, all of the statistics fields contain zeros ().

11 Metasys BACnet System Integrator (BSI) Monitoring 11 Table 3: Field Descriptions - Datalink Statistics Section Field Name Description Datalink Summary Last Cleared Time stamp when these statistics were last cleared. Status Base Datalink Msg Transmits Number of message packets transmitted. Summary Msg Received Number of message packets received. Broadcast Msg Transmits Number of broadcast message packets sent. Broadcast Msg Received Number of broadcast message packets received. Retries Number of retries (not used for Ethernet). Transmit Failures Number of failures in message packet transmits. Datalink 8823 DLC Xmit Frames Number of DLC Xmit frames put on the Ethernet card. Summary DLC Recv Frames Number of DLC Recv frames taken off the Ethernet card. Buffers Free Now Number of empty receive buffers available at current time. Least Buffers Free Lowest number of empty receive buffers reached since the statistics were last cleared. Recv Data Lost Indicates how many received data frames were lost. Ethernet Errors Number of errors indicated by the Ethernet card. Discarded Frames Number of frames that the Ethernet card eliminated. Critical Exceptions Emergency alarm - Any number besides zero in this field indicates a major communication problem occurred. DLC Data Lost Indicates how many data frames were lost. Segments Lost Before Signup The number of message frames the datalink did not know where to relay because initialization was not complete when they arrived. These were discarded.

12 12 Metasys BACnet System Integrator Object Mapping After accessing the BSI Viewer, the BACnet Object Mapping screen may be displayed. This screen provides a view of the BSI Communicator s cache of BACnet points mapped into the Metasys system. The various points can be moved through using the buttons on the toolbar. The screen changes according to the different types of points (device object, analog, binary, and multistate) being viewed. The first point is a dummy device object entry. It is used as a placeholder and always has the reference number of zero. Figures 4 through 7 show the various screen types. Tables 4 through 7 list descriptions of the various fields on each screen. Note: BACnet Object Mapping - BACnet System Integrator File Rebind View Help First Prev Next Last? Find Find? Initially, a blank white screen appears. Bypass this screen by using the toolbar buttons to begin moving through the viewable points. BACNet Device Object Configuration Object ID 8:5 Ref. No. 1 Name MACCR Metasys Configuration System MACCR Information Object Name Offline Expanded ID Last Update 1/7/98 8:29:1 Offline [no. of no-replies] 3 Segmentation Support 3 Max. No. of Segments 4 Max. APDU Seg. Size 1476 Address / Network No. 28 / 2 Object No. First Point 2 Status Code Total No. of No-replies Device Service Values Known Supports (who-has and who-is) User Specified Max. Msg. Size Object Types Supported Analog Value Analog Output Analog Input Ready Services Supported Auto Write File Write Property Write Property Mult Delete Object Create Object Remove List Element Add List Element Auto Read File Read Property Read Property Mult Read Property Cond Get Enrollment Summary Get Alarm Summary Subscribe COV Binary Value Binary Output Binary Input Config COV Notification Config Text Message Config Private Transfer Config Event Notification vt Data vt Open vt Close Notification Class Multistate Output Multistate Input Loop Group File Unconfig COV Notification Unconfig Text Message Unconfig Private Transfer Unconfig Event Notification Reinitialize Device Device Comm Control Acknowledge Alarm Command Calendar Schedule Device Program Event Enrollment I Have I Am Who Is Who Has Request Key Authenticate Time Synchronization Done NUM OMDO Figure 4: BACnet Object Mapping (Device Object) BACnet System Integrator Screen

13 Metasys BACnet System Integrator (BSI) Monitoring 13 Table 4: Field Descriptions - Device Object Section Field Name Description BACnet Device Object Configuration Metasys Configuration Information Services Supported Object Types Supported Object ID Ref. No. Name System Object Name Expanded ID Offline Last Update Offline (no. of no-replies) Segmentation Support Max. No. of Segments Max. APDU Seg. Size Address/Network No. Object No. of First Point Status Code Total No. of No-replies Device Service Values Known Supports (who-has and who-is) User Specified Max. Msg. Size See Figure 4. See Figure 4. The number to the left of the decimal point is the BACnet code for the object type. The number to the right of the decimal point is the BACnet code for the instance number. Internal index number used to identify the object entry in the BSI Communicator error log files. BACnet object name. Metasys system name where the mapped BACnet point resides. Metasys object name for the mapped BACnet object. Metasys expanded ID derived from BACnet object. Indicates if the BSI Communicator thinks this object is offline. Time stamp of when the value was last successfully read. Number of unsuccessful reads before the device object and associated points are flagged offline. BACnet code for segmentation level supported. Number of segments that can combine to determine the maximum message size (if message segmentation is supported). Maximum size a single message segment can be. MAC address/bacnet network number for the BACnet device object. Reference number of the first point associated with this device. BACnet device status returned by this device object. Number of failures to get a valid reply since last valid reply. Indicates if the Services Supported section has been successfully read from the device. Indicates if this device supports Who-has and Who-is. If checked, indicates that the Max. APDU Seg. Size was entered by the person configuring the system. If not checked, indicates the Max. APDU Seg. Size that can be handled by the device object. List of standard services in BACnet object. Ones checked are services that the device object says it can handle. List of standard object types for BACnet. Ones checked are object types that the device object says it can handle. Those not checked are not supported.

14 14 Metasys BACnet System Integrator BACnet Object Mapping - BACnet System Integrator File Rebind View Help First Prev Next Last? Find Find? BACNet Analog Object Configuration Object ID :1 Ref. No. 2 Name Room_Temperature Metasys Configuration System MACCR Unit 64 Object Name Expanded ID M_RT_ Room_Temperature Status Offline Last Update 1/7/98 8:34:41 Present Value High Alarm Limit. Low Alarm Limit. Relinquish Default. In Alarm Unreliable In Override Done Ready Figure 5: BACnet Object Mapping (Analog Object) BACnet System Integrator Screen NUM OMAO

15 Metasys BACnet System Integrator (BSI) Monitoring 15 Table 5: Field Descriptions - Analog Object Section Field Name Description BACnet Analog Object Configuration Metasys Configuration Status Object ID Ref. No. Name System Object Name Expanded ID Unit Offline Last Update Present Value High Alarm Limit Low Alarm Limit Relinquish Default In Alarm Unreliable In Override The number to the left of the decimal point is the BACnet code for the object type. The number to the right of the decimal point is the BACnet code for the instance number. Internal index number used to identify the object entry in the BSI Communicator error log files. BACnet object name. Metasys system name where the mapped BACnet point resides. Metasys object name for the mapped BACnet object. Metasys expanded ID derived from BACnet object. BACnet enumeration number for the BACnet unit used by this Analog point. Indicates if the BSI Communicator thinks this object is offline. Time stamp of when the present value was last successfully read. Present value last read. High alarm limit properties last read, if any. Low alarm limit properties last read, if any. Last relinquish default read, if any. Indicates if the BACnet point status is reporting alarm. Indicates unreliable status determined by BACnet object. Indicates if the BACnet point is in override.

16 16 Metasys BACnet System Integrator BACnet Object Mapping - BACnet System Integrator File Rebind View Help First Prev Next Last? Find Find? BACNet Binary Object Configuration Object ID 3:2 Ref. No. 22 Name Valve_Jam_Alarm Metasys Configuration System MACCR Object Name Expanded ID H_VJA Valve_Jam_Alarm Status Offline Last Update 1/7/98 8:37:1 Delay Value Units Text 1 Units Text 2 OFF ON Value Alarm State Polarity Relinquish Default In Alarm Unreliable In Override Done Ready Figure 6: BACnet Object Mapping (Binary Object) BACnet System Integrator Screen NUM OMBO

17 Metasys BACnet System Integrator (BSI) Monitoring 17 Table 6: Field Descriptions - Binary Object Section Field Name Description BACnet Binary Object Configuration Metasys Configuration Status Object ID Ref. No. Name System Object Name Expanded ID Offline Last Update Delay Value Units Text 1 Units Text 2 Value Alarm State Polarity Relinquish Default In Alarm Unreliable In Override The number to the left of the decimal point is the BACnet code for the object type. The number to the right of the decimal point is the BACnet code for the instance number. Internal index number used to identify the object entry in the BSI Communicator error log files. BACnet object name. Metasys system name where the mapped BACnet point resides. Metasys object name for the mapped BACnet object. Metasys expanded ID derived from BACnet object. Indicates if the BSI Communicator thinks this object is offline. Time stamp of when the present value was last successfully read. BACnet alarm delay value, if there is one. BACnet point inactive (State) text. BACnet point active (State1) text. Checkmark indicates point is active (State1). No checkmark indicates point is inactive (State). Indicates if point is in alarm state at BACnet object. Indicates reverse action on means off. Default inactive/active state when all priorities are released. Indicates if the BACnet point status is reporting alarm. Indicates unreliable status determined by BACnet object. Indicates if the BACnet point is in override.

18 18 Metasys BACnet System Integrator BACnet Object Mapping - BACnet System Integrator File Rebind View Help First Prev Next Last? Find Find? BACnet Multistate Object Configuration Object ID Name 13:1 Ref. No. 88 MODE Metasys Configuration System Object Name Expanded ID XL MODE Chiller Mode Status Offline Last Update 1/7/98 8:1:15 Delay Value 1 Units Text 1 OFF Present Value 2 Relinquish Default 1 Units Text 2 Units Text 3 RUN STDBY In Alarm Unreliable In Override Feedback Value 2 Units Text 4 No of States 3 Ready... NUM OMMS Figure 7: BACnet Object Mapping (Multistate Object) BACnet System Integrator Screen

19 Metasys BACnet System Integrator (BSI) Monitoring 19 Table 7: Field Descriptions - Multistate Object Section Field Name Description BACnet Multistate Object Object ID The number to the left of the decimal point is the BACnet code for the object type. The number to the right of the decimal point is the BACnet code for the instance number. Configuration Ref. No. Internal index number used to identify the object entry in the BSI Communicator error log files. Name BACnet object name. Metasys System Metasys system name where the mapped BACnet point resides. Configuration Object Name Metasys object name for the mapped BACnet object. Expanded ID Metasys expanded ID derived from BACnet object. Status Offline Indicates if the BSI Communicator thinks this object is offline. Last Update Time stamp of when the present value was last successfully read. Delay Value BACnet alarm delay value, if there is one. Present Value Present value of state the BACnet point is in. Relinquish Indicates default inactive/active state when all priorities are released. Default Feedback Value Indicates associated feedback with this point, if there is any. No of States Indicates the number of states that this multistate claims it can have. Units Text 1 Indicates text for State 1. Units Text 2 Indicates text for State 2. Units Text 3 Indicates text for State 3. Units Text 4 Indicates text for State 4. In Alarm Indicates if the BACnet point status is reporting alarm. Unreliable Indicates unreliable status determined by BACnet object. In Override Indicates if the BACnet point is in override.

20 2 Metasys BACnet System Integrator PC Protocol Engine Statistics The BACnet PC Protocol Engine screen (Figure 8) shows information about acknowledging BACnet messages. The Application Layer section shows data regarding the creation and analysis of BACnet messages. The BACNL section shows data pertaining to BACnet datalink tasks. Table 8 describes this screen s fields. BACnet PC Protocol Engine - BACnet System Integrator File Rebind View Help First Prev Next Last? Find Find? PC Protocol Engine Summary Status Last Cleared 1/ :22:12 Application Layer Transmit Confirmed Reqs 9625 Segment Reqs Complex Acks Seg Complex Acks Simple Acks Receive Confirmed Reqs Segment Reqs Complex Acks Seg Complex Acks Segment Acks Unconfirms 1 Errors Rejects Aborts Simple Acks Segment Acks Unconfirms Errors 33 Segments Local Aborts Request Retries 7129 Segment Retries Rejects Aborts Segments BACNL Datalink Msg Rcv Datalink Msg Txt Unknown Routes 1142 Unknown Msg Rcv Rejects Rcv Route Busy 9988 Clear Stats Done Ready NUM Figure 8: BACnet PC Protocol Engine BACnet System Integrator Screen PCProto

21 Metasys BACnet System Integrator (BSI) Monitoring 21 Table 8: Field Descriptions PC Protocol Engine Section Field Name Description PC Protocol Engine Last Cleared Time stamp when these statistics were last cleared. Summary Status Application Layer Transmit Confirmed Reqs Number of confirmed requests transmitted. Segment Reqs Number of segmented confirmed requests transmitted. Complex Acks Number of acknowledgements sent with reply data included. BACNL Seg Complex Acks Simple Acks Segment Acks Unconfirms Errors Rejects Aborts Segments Local Aborts Number of segmented acknowledgements sent with reply data included. Number of transmitted acknowledgements with no reply data. Number of acknowledgements sent to Segment Reqs or Seg Complex Acks. Number of unconfirmed requests transmitted. Indicates an error with a valid confirmed (seg) request. Indicates the number of times that the BACnet device rejected messages even though the messages may have been valid. Indicates the number of times that the processing of messages was aborted even though the messages may have been valid. Total number of message segments transmitted. The number of aborts generated as a result of a local protocol error usually due to timeouts. Number of retries due to no acknowledgment of requests. Number of retries due to no acknowledgement of segments. Request Retries Segment Retries Receive Confirmed Reqs Number of confirmed requests received. Segment Reqs Number of segmented confirmed requests received. Complex Acks Number of acknowledgements received with reply data included. Seg Complex Acks Simple Acks Segment Acks Unconfirms Errors Rejects Aborts Segments Datalink Msg Rcv Datalink Msg Txt Unknown Routes Unknown Msg Rcv Rejects Rcv Route Busy Number of segmented acknowledgments received with reply data included. Number of received acknowledgements with no reply data. Number of acknowledgements received for Segment Reqs or Seg Complex Acks. Number of unconfirmed requests received. Indicates an error with a valid confirmed (seg) request. Indicates the number of times that the BACnet device rejected messages even though the messages may have been valid. Indicates the number of times that the processing of messages was aborted even though the messages may have been valid. Total number of message segments received. Number of messages received from the datalink. Number of messages transmitted to the datalink. Number of messages that destination cannot be found because BACnet routing is unknown. Number of BACnet Network layer messages received that are not valid. Number of messages rejected at the BACnet Network Layer. Route to known destination network unavailable due to lost connection.

22 22 Metasys BACnet System Integrator Notification Class Objects (NCOs) BACnet Notification Class - Recipient List File Rebind View Help The BACnet Notification Class screen (Figure 9) shows information about the ten Notification Class Objects implemented in the BSI. These objects determine how alarm event messages from Metasys points are routed to BACnet devices, such as BACnet workstations. Table 9 describes the fields on this screen. First Prev Next Last? Find Find? BACnet Notification Class Object Notification Class Object Name 1 NCO_1 Description NCO_1_TEST Priority Ack_Required TO-OFFNORMAL 11 TO-FAULT 12 Recipient List [IP]1:13::45 [Port]4788 [Net#]1 [ProcessID]1 [Seg]1476 [Confirmed]F [mon]t [tue]t [wed]t [thu]t [fri]t [sat]t [sun]t [TIME]::. - 23:59:59.99 [offnormal]t [fault]t [normal]t TO-NORMAL 13 Refresh Done Ready NUM NCO Figure 9: BACnet Notification Class Recipient List Screen

23 Metasys BACnet System Integrator (BSI) Monitoring 23 Table 9: Field Descriptions - Notification Class Objects Section Field Name Description BACnet Notification Class Object Priority Ack_Required Notification Class Object Name Description TO-OFFNORMAL TO-FAULT TO-NORMAL Instance number from 1 to 1 of the Notification Class Object. Use the toolbar buttons to move through the ten objects. User-defined name of the NCO. User-defined description of the NCO. Priority, and whether operator acknowledgment is required, for messages indicating change to alarm state. Priority, and whether operator acknowledgment is required, for messages indicating change to fault state. Priority, and whether operator acknowledgment is required, for messages indicating change to normal state. Recipient List Recipient List List showing the destination device or devices for event messages from points assigned to this NCO. Further information includes the time schedule during which the destination is active. The Recipient List must be defined at a BACnet workstation.

24 24 Metasys BACnet System Integrator Procedure Overview Table 1: Monitoring the BSI Communicator To Do This View Mapped BACnet Object Cache Data (for device, analog, binary, and multi-state) View BACnet Communicator Application Statistics View Datalink Statistics View PC Protocol Engine Statistics View Notification Class Object Data Follow These Steps: With the BSI Communicator running, open the BSI Viewer. Move through the viewable points or search for a particular point using the toolbar buttons. Look at the information and check for inconsistencies and/or alarms. If no inconsistencies or alarms are found, click Done and from the File menu, select Exit to exit the BSI Viewer. If an inconsistency is found, continue. Open the BSI Configurator to verify how the point was configured. Compare the point configuration in the BSI Configurator with the appearance of the point in the third-party BACnet system. If necessary, check the error log file. Make any necessary changes in the BSI Configurator. Make any necessary changes in the BACnet system. If desired, recheck the data in the BSI Viewer. With the BSI Communicator running, open the BSI Viewer. From the File menu, point to Type and select Communicator Application Statistics. Look at the information and check for indications of problems. If no problems are indicated, click Done and from the File menu, select Exit to exit the BSI Viewer. If a problem is found, continue. Open the BSI Configurator to verify addressing information and to check for misnamed points, or point information that is obsolete. Make any necessary changes in the BSI Configurator or elsewhere. If desired, recheck the data in the BSI Viewer. With the BSI Communicator running, open the BSI Viewer. From the File menu, point to Type and select either Raw Ethernet (ISO 882.3) Datalink Statistics or BACnet/IP Datalink Statistics, depending on the type of transport protocol used on the BACnet network. Look at the information and check for indications of problems. If no problems are indicated, click Done and from the File menu, select Exit to exit the BSI Viewer. If a problem is found, continue. Look for and correct any Windows network driver problems, network errors, bad network card or misconfigured card problems. If desired, recheck the data in the BSI Viewer. With the BSI Communicator running, open the BSI Viewer. From the File menu, point to Type and select PC Protocol Engine Statistics. Look at the information and check for indications of problems. If no problems are indicated, click Done and from the File menu, select Exit to exit the BSI Viewer. If a problem is found, continue. Open the BSI Configurator to verify BACnet network addresses and Ethernet network information, and to check for slow responding devices and traffic overload. Make any necessary changes in the BSI Configurator or elsewhere. If desired, recheck the data in the BSI Viewer. With the BSI Communicator running, open the BSI Viewer. From the File menu, point to Type and select Notification Class Object. Use the toolbar buttons to move through the ten NCOs implemented in the BSI. Look at the information and check for indications of problems. If no problems are indicated, click Done and from the File menu, select Exit to exit the BSI Viewer. If a problem is found, continue. Open the BSI Configurator to correct Priority and Ack_Required settings. Use a BACnet workstation to correct the Recipient List. Make any necessary changes in the BSI Configurator or elsewhere. If desired, recheck the data in the BSI Viewer.

25 Metasys BACnet System Integrator (BSI) Monitoring 25 Detailed Procedures Viewing Mapped BACnet Object Cache Data To view mapped BACnet object cache data: 1. With the BSI Communicator running, open the BSI Viewer. The Object Mapping screen (internal list of BACnet points) appears. 2. Move through the viewable points or search for a particular point using the toolbar buttons. The screen s appearance will change according to the point type being viewed (Figures 4 through 7). 3. Look at the information and check for inconsistencies and/or alarms. Data on this screen may change as it is being viewed. 4. If no inconsistencies or alarms are found, click Done and from the File menu, select Exit to exit the BSI Viewer. If an inconsistency is found, continue with Step 5. Otherwise, the procedure is complete. 5. Open the BSI Configurator to verify how the point was configured. 6. Compare the point configuration in the BSI Configurator with the appearance of the point in the third-party BACnet system. 7. If necessary, check the error log file (BGATEERR.TXT) using any ASCII readable program. Refer to the Troubleshooting section of this document. 8. Make any necessary changes in the BSI Configurator. Refer to the Metasys BACnet System Integrator (BSI) Commissioning Technical Bulletin (LIT ) in the Metasys Connectivity Technical Manual (FAN-629.5). 9. If database changes are made with the BSI Configurator, be sure to restart Person-Machine Interface (PMI) or Metasys Application Enabler (MAE). 1. Make any necessary changes in the BACnet system. 11. If desired, recheck the data in the BSI Viewer. Note: An error occurs if the BSI Viewer is started without the BSI Communicator running.

26 26 Metasys BACnet System Integrator Viewing BACnet Communicator Application Statistics To view BACnet Communicator Application Statistics: 1. With the BSI Communicator running, open the BSI Viewer. The Object Mapping screen (internal list of BACnet points) appears. 2. From the File menu, point to Type and select Communicator Application Statistics. The BACnet Communicator Application Statistics screen appears (Figure 1). 3. Look at the information and check for indications of problems. Data on this screen may change as it is being viewed. 4. If no problems are indicated, click Done and from the File menu, select Exit to exit the BSI Viewer. If a problem is found, continue with Step 5. Otherwise, the procedure is complete. 5. Open the BSI Configurator to verify addressing information and to check for misnamed points, or point information that is obsolete. 6. Make any necessary changes in the BSI Configurator or elsewhere. Refer to the Metasys BACnet System Integrator (BSI) Commissioning Technical Bulletin (LIT ) in the Metasys Connectivity Technical Manual (FAN-629.5). 7. If database changes are made with the BSI Configurator, be sure to restart Person-Machine Interface (PMI) or Metasys Application Enabler (MAE). 8. If desired, recheck the data in the BSI Viewer. Note: An error occurs if the BSI Viewer is started without the BSI Communicator running.

27 Metasys BACnet System Integrator (BSI) Monitoring 27 Viewing Datalink Statistics To view Datalink Statistics: 1. Open the BSI Viewer. The Object Mapping screen (internal list of BACnet points) appears. 2. From the File menu, point to Type and select either Raw Ethernet (ISO 882.3) Datalink Statistics or BACnet/IP Datalink Statistics, depending on the type of transport protocol used on the BACnet network. The corresponding BACnet Datalink Statistics screen appears (Figure 2 or Figure 3). 3. Look at the information and check for indications of problems. Data on this screen may change as it is being viewed. 4. If no problems are indicated, click Done and from the File menu, select Exit to exit the BSI Viewer. If a problem is found, continue with Step 5. Otherwise, the procedure is complete. 5. Look for and correct any Windows network driver problems, network errors, bad network card or misconfigured card problems. 6. If desired, recheck the data in the BSI Viewer. Note: An error occurs if the BSI Viewer is started without the BSI Communicator running.

28 28 Metasys BACnet System Integrator Viewing PC Protocol Engine Statistics To view PC Protocol Engine Statistics: 1. Open the BSI Viewer. The Object Mapping screen (internal list of BACnet points) appears. 2. From the File menu, point to Type and select PC Protocol Engine Statistics. The BACnet PC Protocol Engine screen appears (Figure 8). 3. Look at the information and check for indications of problems. Data on this screen may change as it is being viewed. 4. If no problems are indicated, click Done and from the File menu, select Exit to exit the BSI Viewer. If a problem is found, continue with Step 5. Otherwise, the procedure is complete. 5. Open the BSI Configurator to verify BACnet network addresses and Ethernet network information, and to check for slow responding devices and traffic overload. 6. Make any necessary changes in the BSI Configurator or elsewhere. Refer to the Metasys BACnet System Integrator (BSI) Commissioning Technical Bulletin (LIT ) in the Metasys Connectivity Technical Manual (FAN-629.5). 7. If database changes are made with the BSI Configurator, be sure to restart PMI or MAE. 8. If desired, recheck the data in the BSI Viewer. Note: An error occurs if the BSI Viewer is started without the BSI Communicator running.

29 Metasys BACnet System Integrator (BSI) Monitoring 29 Viewing Notification Class Object Data To view Notification Class Object data: 1. With the BSI Communicator running, open the BSI Viewer. The Object Mapping screen (internal list of BACnet points) appears. 2. From the File menu, point to Type and select Notification Class Object. The BACnet Notification Class screen appears (Figure 9). 3. Use the toolbar buttons to move through the ten Notification Class Objects implemented in the BSI. 4. Look at the information and check for indications of problems. Data on this screen may change as it is being viewed. 5. If no problems are indicated, click Done and from the File menu, select Exit to exit the BSI Viewer. If a problem is found, continue with Step 6. Otherwise, the procedure is complete. 6. Open the BSI Configurator to correct Priority and Ack_Required settings. Use a BACnet workstation to correct the Recipient List. 7. If desired, recheck the data in the BSI Viewer. Note: An error occurs if the BSI Viewer is started without the BSI Communicator running.

30 3 Metasys BACnet System Integrator Troubleshooting Table 11: Monitoring Error Messages Throughout the monitoring process, error messages may appear. Table 11 lists the possible error messages, problems, and solutions. Error Message Problem Solution Object number: [number], classid = [number], objtyp_name = [text] - Metasys type is invalid. Object number: [number], type: [text], not implemented yet. OSRegisterTask, ID = [number] was unsuccessful. Metasys point object type is not valid. May be caused by incomplete binding to NCM data point (offline NCM, missing Metasys point) or unsupported Metasys point type. Metasys point object type is not handled by BSI Viewer. Fatal error - Unable to communicate with BSI Communicator. Likely to be caused by BSI Communicator not running or an install problem. Ignore Done button and go on to the next point. Check mapped Metasys point to make sure it exists as named. Verify database for this point. Make sure the BSI Communicator/Metasys PMI or MAE is running. Error Log File Enable Debug BSI Communicator information and error messages are written to an error log file, BGATEERR.TXT, found in the directory determined by the Metasys.ini ERRORLOGPATH parameter setting. Error messages are only added to the error log when the BSI Communicator is running or attempting to run. When the file reaches approximately.5 MB, it is renamed to BGATEERR.OLD, any existing BGATEERR.OLD file is deleted, and a new BGATEERR.TXT is started. Table 12 lists possible error messages, explanations, and solutions. The selection of the Enable Debug field during System Setup of the BSI Configurator affects messages written to the BGATEERR.TXT error log file. During commissioning, selecting this field results in all of the information being written to this error log file as installation and testing aids and as error messages. When this field is deselected, only error messages are written. Once commissioning is complete and the system is performing as desired, deselect Enable Debug on the Device Object screen of the BSI Configurator to avoid excessive disk activity and the loss of possible error messages. Refer to the Metasys BACnet System Integrator (BSI) Commissioning Technical Bulletin (LIT ) in the Metasys Connectivity Technical Manual (FAN 629.5) for more information.

31 Metasys BACnet System Integrator (BSI) Monitoring 31 Table 12: Runtime Troubleshooting Guide Problem Explanation Solution Asking Metasys attributes Information Debug only BSI Communicator is as: [request text] sending request for Metasys attributes. BACnet device index mismatch on point index=[number], scanning device ndx=[number], real dev ndx=[number] BACnet object no reply yet at index = [number] BACnet object scan time remaining after all requests sent = [number] BACnet Object Table Corrupted BACnet object table overflow Bad Data Type = [BACnet data type] Bad Error Type in message = [number] hex Can t decode I-HAVE message, address NETDEVINFO structure follows Can t decode WHO-HAS message, address NETDEVINFO structure follows Can t decode WHO-IS message, address NETDEVINFO structure follows Can t send WHO-HAS message on BACnet point ndx = [number], not enough info Continued on next page... Error BSI Communicator database corruption where device object is inconsistent for a BACnet point. Information Debug only BACnet object in BSI Communicator database at reference number has not received a reply since the last data request message was sent even though it is due to be polled again. This BACnet object is slow to reply or is offline, or the polling rate is too fast. Information Debug only Useful for setting the minimum scan time in the system information data. Tells how much time is left to complete the scan after all BACnet points have been scanned. If there is no time left or it runs over, (zero) is printed. After the BSI Communicator is up and running, this log should record at least 2% of the minimum scan time in order to have a predictable scan rate. Fatal Error BSI Communicator BACnet object database is corrupt, linkages or object types are not consistent. Error Could not add required BACnet device object information to BSI Communicator database due to database being full. Error BACnet data type not supported for read of Metasys points. Error BACnet object sent nonstandard error message that could not be decoded. Error BSI Communicator could not decode I-HAVE message from address structure printed in the next error log message. Error BSI Communicator could not decode WHO-HAS message from address structure printed in the next error log message. Error WHO-IS message from BACnet device could not be decoded. Address structure is printed in the next error log entry. Information Debug only There is not enough information to send a needed WHO-HAS message to the BACnet point at BSI Communicator database reference. Rebuild BSI Communicator BACnet object mapping database. Rebuild BSI Communicator BACnet object database. Too many BACnet points in BSI Communicator database. BSI Communicator database error or internal error. Check BACnet devices for nonstandard error message types. BACnet device sending nonstandard message. BACnet device sending nonstandard message. BACnet device sending nonstandard message.

32 32 Metasys BACnet System Integrator Problem (Cont.) Explanation Solution Can t send WHO-IS message on BACnet device ndx = [number], not enough info Information Debug only There is not enough information to send a needed WHO-IS message to the BACnet point at BSI Communicator database reference. Can t write to BACnet read only obj ndx [number] (not write enabled) Clock call returned invalid data Closing BACnet System Integrator Corrupted [file name] file Could not get memory, operation failed! Could not get message from NCM Could not read details of object = [Object name] Could not read details of system = [system name] Could not save NCM name in [message] Could not save net name Could not save object name Could not save object type for [object name] Could not save system name Continued on next page... Error Attempt to write to BACnet object that is not write enabled in the BSI Communicator BACnet object database. Error BSI Communicator internal clock read failed. Information Debug Only BSI Communicator received a request to shut down. Fatal Error Format of database file listed is incorrect. Error BSI Communicator is out of memory and cannot operate properly. Error Message from BACnet NCM to BSI PC could not be received at BSI Communicator. Error Metasys object data could not be read from NCM. Fatal Error BSI Communicator startup failure reading information about the BACnet NCM designated in the BSI Communicator system information. or Metasys point auto-configuration failed when data could not be extracted from a database read message. Fatal Error Metasys startup failed when unable to read NCM name from database read message. or Metasys point auto-configuration failed when data could not be extracted from a database read message. Fatal Error Metasys point auto-configuration failed when data could not be extracted from a database read message. Fatal Error Metasys point auto-configuration failed when data could not be extracted from a database read message. Error Metasys point information could not be extracted from read message. Fatal Error Could not read Metasys system name from database read message during Metasys point auto-configuration. Application error or update BSI Communicator database to allow writing. Windows problem. BSI Communicator database file has been corrupted or version is incorrect and it needs to be rebuilt. Check Windows resources. Install problem, Windows resources. BSI Communicator database problem or Metasys object does not exist or is not downloaded. Installation problem or Metasys system not operating correctly or BSI Communicator databases not correct or inconsistent (mapped BACnet points must be specified if a BACnet NCM is specified). Installation problem or Metasys system not operating correctly or BSI Communicator database incorrect. Installation problem or Metasys system not operating correctly. Installation problem or Metasys system not operating correctly. Metasys system not operating correctly or unsupported Metasys point type or BSI Communicator database error. Installation problem or Metasys system not operating correctly.

33 Metasys BACnet System Integrator (BSI) Monitoring 33 Problem (Cont.) Explanation Solution Could not set thread Error Could not control priority of parallel Windows problem. priority process in BSI Communicator. Could not start BACnet polling thread Could not start IAPI thread Data link task ID [number] is not supported Error BACnet mapped system not in specified NCM: [NCM text] Error BACnet Multistate Feedback over 4 on index [number] Error BACnet Multistate Number of States over 4 on index [number] Error BACnet Multistate Relinquish Default over 4 on index [number] Error BACnet Multistate Value over 4 on index [number] Error BACnet write service not supported by device at index = [number] Error Bad NCM COS report alarm type text=[cos text] Error Bot entry for system [system name] object [object name] ndx [number] no type (for writing) Error Can t find property [number] in PC table for BACnet obj ndx [number] Error Can t write when device unknown, BACnet point index = [number] Error COS signup string [command text] failed with status [number] Error Illegal bot index = [number] Continued on next page... Fatal Error BACnet polling could not be started. Fatal Error BSI Communicator process that communicates with Metasys system could not be started. Fatal Error The Data Link Task ID number entered at the BSI Configurator System Setup screen (Metasys Device Object) is not supported by BSI Communicator. Fatal Error BSI Communicator BACnet object database does not match actual NCM addressing structure. Error BACnet multistate point has feedback state with value having a higher state than Metasys system supports. Error BACnet multistate point has number of states greater than supported by Metasys system. Error BACnet multistate point has relinquish default with value having a higher state than Metasys system supports. Error BACnet multistate point has value with higher state than Metasys system supports. Error Attempt to write to BACnet object that does not support the write service as defined by BACnet. Error COS message for BACnet NCM has status that does not match strings in BGLANGTX.DAT. This is usually ONLINE or OFFLINE. Error Attempt to write mapped BACnet point while the BSI Communicator database does not have all of the required information in place. Error Unsupported property cannot be located in the supported property list. Error Attempt to write to BACnet point with unknown BACnet address. Fatal Error Unable to signup to receive Metasys COS messages for BACnet NCM on/offline detection. Error BSI Communicator BACnet object mapping database does not have a point at this index. Installation problem or insufficient Windows resources. Windows resources or installation problem. Choose a supported Data Link Task ID number code at the BSI Configurator System Setup screen (Metasys Device Object). Make BSI Communicator database and Metasys database match. Cannot map this point. Cannot map this point. Cannot map this point. Cannot map this point. Application error or improper use of BACnet device. BGLANGTX.DAT needs updating or Metasys system is not operating properly. Wait for BSI Communicator to finish database binding or correct BSI Communicator database. BACnet device may be sending nonstandard messages. Startup initialization may not be complete yet or BSI Communicator database may not be complete. Installation problem or BSI Communicator database problem. Internal error or corrupt BSI Communicator database.