OnGuard v1.1 Integration for v8.0 or later systems Carrier ©2022 · Catalog No.
Verify that you have the most current version of this document from www.hvacpartners.com, the Carrier Partner Community website, or your local Carrier office. Important changes are listed in Document revision history at the end of this document. Carrier© 2022. All rights reserved. The content of this guide is furnished for informational use only and is subject to change without notice.
Contents What is the OnGuard Integration? ............................................................................................................................. 1 Requirements ........................................................................................................................................................1 When upgrading to i-Vu® Pro v8.0 ....................................................................................................................
What is the OnGuard Integration? The OnGuard® Integration consists of a collection of add-ons that allow the i-Vu® Pro building automation system and an OnGuard® security system to work together. The OnGuard® Integration enables the i-Vu® Pro system to utilize actual occupancy data in control program logic by monitoring entry and exit events. Included in the .zip file... Purpose Data Connector (page 6) (onguard.
• • Building Integration Platform (v1.11) (see the Building Integration Platform’s installation guide): • Building Integration Platform Service installed • OnGuard® Connector Service installed • Username, password, and port number for the Building Integration Platform Network connectivity between the i-Vu® Pro Server, OnGuard® server, and Building Integration Platform server When upgrading to i-Vu® Pro v8.0 If you are running the OnGuard Integration with a pre-v8.
BIP installation and configuration details To enable communication between the WebCTRL and OnGuard servers, the Building Integration Platform (BIP) must be installed on a server that can connect to both application servers. Refer to the following documents to install and configure the BIP: • Building Integration Platform Installation Guidelines • Building Integration Platform Commissioning User Manual The BIP is designed to support multiple integrations.
IT considerations The following information may be useful to network administrators. Client Server Default Port Traffic i-Vu Pro – OnGuard® Data Connector Building Integration Platform TCP/IP 8443* Building Integration Platform Rest API secured with TLS 1.2 i-Vu Pro – OnGuard® Data Connector Building Integration Platform OAuth Service Provider TCP/IP 8444* Building Integration Platform OAuth Rest API secured with TLS 1.
Configuring the Server 1 On the Server Configuration tab, enter the OnGuard Connector settings. See table below. 2 To allow a Self Signed Certificate, check the checkbox. Note: Choosing this option will result in a less secure configuration, therefore should only be chosen when you are unable to use a certificate signed by a certificate authority. NOTE Status indicates Connected if configured properly.
Setting up the Data Connector add-on To track occupancy through the security system, you must define one or more zones. NOTE For the purpose of this integration, a zone is a geographical area for which occupancy can be detected through the activity of its associated badge readers. Adding a zone 1 On the Occupancy tab, enter a unique name for the new zone in the Add New Zone field. 2 Press Enter to add the new zone – it appears in the list of zones below.
Associating microblocks with a zone A control program can be designed to operate on zone occupancy data from the integration. Do this by associating microblocks in the control program as targets to receive the zone occupancy data. The microblocks are updated 1 minute after startup and every 5 minutes following that. There are four different microblocks that can be configured. Microblock Maps too... And represents... Occupancy Count an AV microblock how many people are currently badged into a zone.
Manual mapping of reference names 1 On the Occupancy tab, click the zone you wish to configure in the Zone list. 2 Click Microblocks in the Occupancy panel. 3 When the Equipment panel appears, navigate the Equipment tree and select a microblock to associate. 4 Drag the selected microblock from the tree to the corresponding slot in the Microblocks section. NOTE To remove a microblock association, click the Delete ( ) button to the right of the microblock name.
Setting up the Advanced Occupancy Scheduling add-on Advanced Occupancy Scheduling is an add-on that predicts and schedules occupancy based on past occupancy data. The schedule that is generated contains no undefined regions and the whole day is scheduled with off and on times. For example, a 9-5 schedule would be written with midnight to 9am as off, 9am-5pm as on and 5pm to midnight as off.
Associating schedulable items to a zone 1 On the Scheduling tab, click on zone you wish to configure in the Zone list. 2 Click on Destinations in the Schedules panel. 3 From the Destination panel, you can either add Areas and Equipment or Scheduling Groups: ○ In the Areas and Equipment section of the Destination panel, drag the desired Area or Equipment to the Destinations section of the Schedules panel.
Setting up the Integrated Alarm Management add-on Integrated Alarm Management is an add-on that enables the exchange of alarms between the i-Vu® Pro system and the OnGuard® system. Setting up alarms from OnGuard to the i-Vu® Pro system In order to send alarms from an OnGuard® system to the i-Vu® Pro system, you must define a mapping. The mapping describes the OnGuard® event source and the destination microblock which re-generates the alarm for the i-Vu® Pro system.
Adding Zone Mapping Map the equipment files to the zones to receive OnGuard® events. Once the Zone Mapping is set up, any mapped OnGuard® events will be written to the mapped BV microblocks in the mapped Equipment file. 1 On the Alarms tab, click OnGuard to i-Vu Pro. 2 Click the Edit Zones button to open the Zone Map and Equipment panels. 3 Drag the equipment from the Equipment panel to the desired zone in the Zone Map panel.
To add OnGuard® Alarm Points to an equipment file: Once the alarm-manager.logic-script and alarm-manager.logic symbol has been properly installed, OnGuard® Alarm points can be appended to existing equipment files with appropriate reference names. 1 Export the current Zone Mapping JSON configuration file (see Exporting Zone Mapping section above) and note where you download the onguardmapping.json file.
Setting up the alarm transfer schedule For items that you have selected YES for Use Schedule, you must specify the alarm transfer schedule. The transfer schedule time range applies to both OnGuard to i-Vu Pro and i-Vu Pro to OnGuard alarms. On the Alarms tab, set the following from the System Select column in the Schedule section: Start Time - to start sending alarms Stop Time - to stop sending alarms OnGuard v1.1 Integration for v8.
Troubleshooting If the connection is not successful and you receive an error message in the Activity Log panel, see the table below. Error message Solution Error reading system id, No active system named OnGuard Make sure your Lenel® OnGuard system is configured with the System Name "OnGuard". You can edit this field in the Building Integration Platform's System Configuration tab. Error authenticating with DIP Check Allow Self Signed Certificate.
Document revision history Important changes to this document are listed below. Minor changes such as typographical or formatting errors are not listed. Date Topic Change description Code* 7/28/22 Requirements Updated version requirements AC-PM-LO-OLO Carrier Proprietary and Confidential ©2022 Carrier. All rights reserved. * For internal use only OnGuard v1.1 Integration for v8.
