BrightCore BACnet Lookout V2.7

Transcription

1 Page 1

2 BrightCore BACnet Lookout User Guide v Page 2

3 Copyright 2016 by ELMA Kurtalj ltd. All rights reserved. The contents of this documentation are taken in part from the BACnet Standard or are based on the original contents. These contents are subject to copyright. The following applies for the BACnet logo: BACnet is a registered trademark of ASHRAE. BACnet Lookout was tested against 36 different device vendors and more than a 150 device models. For more information see Appendix-A ELMA Kurtalj ltd. Lanište 17c Zagreb, Croatia Tel: +385(1) Fax: +385(1) ] support@brightcore.biz ELMA KURTALJ ltd. BrightCore BACnet Lookout v2.7 Page 3

4 Table of Content 1. System Requirements 6 2. Introduction Features Setup User interface Tool Bar Device Lists Network View Filtered View Value View Property View Monitor View Lua Editor View File View COV Notification View Event Notification View Trend Log View PID View System Messages Window Context Menu BACnet Services Get Alarm Summary Get Enrollment Summary Get Event Information Subscribe COV Subscribe COV Property Create Object Delete Object Time Synchronization UTC Time Synchronization Read Trend Log (Read Range) Atomic Read File Atomic Write File Reinitialize Device Device Communication Control Read Broadcast Distribution Table Write Broadcast Distribution Table Register Foreign Device Options and Settings General Settings Communication Options MSTP Options.51 Page 4

5 10.4 Packet Options PID Options BBMD Settings Analyzing MS/TP Traffic Types of MS/TP Packet Capture Device Testing Stress Tests BTL Tests Copyright Appendix A List of tested BACnet Vendors and device models. Appendix B BACnet Lookout PICS Page 5

6 1. System Requirements Intel Pentium 4 or a similar Processor 512 MB RAM 20 MB of free HD space Operating System Microsoft Windows XP Microsoft Windows Vista Microsoft Windows 7 Microsoft Windows 8 Page 6

7 2. Introduction BACnet Lookout is the most comprehensive BACnet tool available on the market. It supports BACnet/IP, BACnet/Ethernet and BACnet/MSTP form of communication and more than 80% BACnet services. Supported BACnet services are available either from the One-Click Context Menu, or are incorporated to the inner working of BACnet Lookout. (Double-Click to Read Property for example). Apart from the normal Services such as ReadProperty or WriteProperty, BACnet Lookout also provides a level of automation not usually seen in the products of this type. This includes the completely automated property monitor, working independently from the other parts of BACnet Lookout, Proportional-Integral-Derivative automated tester for your controllers and other BACnet devices, automated stress testers for devices and controllers and a LUA Editor for automation engineers to write and execute their own scripts and ideas by using the integrated BAClua API released as a part of BACnet Lookout. As such, BACnet Lookout combined with BAClua API and its internal testing capabilities provide an extremely powerful and versatile work and test environment fitted for anyone interested in BACnet regardless of level of expertise. BACnet Lookout comes with BAClua API specification of the API and a number of examples demonstrating the use of the API. With each copy of BACnet Lookout you will also receive a WaterHeater BACnet Device application to play or test with. This application is a fully operational BACnet compliant device simulating the properties of a water heater. Picture 1. Overview of BACnet Lookout communication. (*) See Table 1. Page 7

8 3. Features Table 1. BACnet Lookout Communication options. *Standard and Extended versions include USB-485 Data Converter with each purchase. Bacnet Lookout Bacnet Bacnet Lookout BACnet Communication Essential Lookout Extended Standard BACnet IP BACnet Ethernet BACnet MS/TP Feature Automated Device Discovery Automated Property Monitor Simple Device List View Complex Device List View Filtered View Extensive Message Info. Automatic Event Subscription External Device Discovery Device Webserver Access Device Testing: Who-Is Device Testing: Who-Has Device Testing: Create Object Device Testing: Read Property BAClua API Support BACnet Router Discovery Router Webserver Access BACnet Router List View Use BACnet Lookout as BBMD Foreign Device Registry Device Testing: BTL Tests Device Testing: PID Tuning MSTP Traffic Analyzer Table 2. BACnet Lookout Built-In Features Bacnet Lookout Essential Bacnet Lookout Standard Bacnet Lookout Extended ELMA KURTALJ ltd. BrightCore BACnet Lookout v2.7 Page 8

9 BACnet Service Who Is Read Property Read Property Multiple Write Property Get Alarm Summary Get Enrollment Summary Get Event Information Subscribe COV Subscribe COV Property Confirmed Event Notification Unconfirmed Event Notification Time Synchronization/UTC Atomic Read File Atomic Write File Read Range Reinitialize Device Device Communication Control Create Object Delete Object Read Broadcast Table Write Broadcast Table Register Foreign Device Read Foreign Device Table Delete Foreign Device Entry Table 3. BACnet Services Supported Bacnet Lookout Essential Bacnet Lookout Standard Bacnet Lookout Extended ELMA KURTALJ ltd. BrightCore BACnet Lookout v2.7 Page 9

10 4. Setup Start the installation by double clicking the BrightCore BACnet Lookout setup.exe and read the license agreement. If you accept the agreement click Next to continue. Picture 2. License Agreement Window By checking the I accept the agreement button and clicking the Next button you will be prompted to enter the installation directory. Important Note: The install target directory must have reading and writing rights for the currently logged user. If you do not have such rights, contact your system administrator. Picture 3. Select Install Folder Select the destination folder and click Next button. Page 10

11 You can choose not to create Start Menu folder for the application by checking the Don t create a Start Menu folder check box. Click Next to continue. Picture 4. Start Menu Folder Click Next to continue. Picture 5. Create Desktop and Quick Launch icons Page 11

12 Picture 6. Create Desktop and Quick Launch icons Confirm your options by pressing the Install button. Complete the installation process by pressing Finish button. If you enabled automatic launch of BACnet lookout, application will start as soon as you click Finish button. Picture 7. Click Finish to Continue. Page 12

13 After the initial launch, BACnet Lookout will notify you of days left in the trial run. If you purchased the application, copy-paste the Registration Number and send it to along with your full name and company name from a valid address. Picture 8. License Window After receiving your unlock code, click on the Register tab or a button and input your Username and Unlock code into their respective fields. Picture 9. Register Window Click OK button to confirm the registration process and start the application. Page 13

14 5. User Interface Picture 10. BACnet Lookout User Interface BACnet Lookout user interface is divided in 7 separate sections each tasked with specific purpose. Those are: The Main Menu: Used for saving and loading projects, device testing, scripting and BACnet Lookout option settings. The Toolbar: A button based toolbar menu used for quick access to common BACnet Services such as WhoIs, WriteProperty, AtomicWriteFile It also contains buttons to show/hide event and alarm windows. For detail description refer to Toolbar Device Tree List View: Consisting of two different device views separated by tab buttons. A simple device tree under the Device List tab shows a simple list of devices and their objects and properties, while the Structured View tab will show BACnet Devices organized under its respective communication layer and network number. Device object types will also be organized under their respective type folders marked by the blue folder icon. For detail description of device lists refer to 5.2 Device Tree Lists Value View: A tabbed view consisting of many separate tabbed windows. These are: Property Value window, Monitor Network window, LUA Editor window, COV Notifications window, Event Notifications window, Trend Log Page 14

15 chart window, PID test window, Alarm Summary window, Enrollment Summary window, BTL Test window, Broadcast Distribution Table window and Foreign Device Table window. For detail description of each window refer to 5.3 Value View Monitored Network View: A used defined automated property monitor. For detail description refer to Monitor Network System Message View: User information message window. Messages are color coded by severity and vary in range from simple confirmation of a WriteProperty service to critical system messages informing the user that some critical system has failed. For detail description refer to 5.5 System messages. Status Bar: Information on the program. It includes: BACnet Lookout Version, Communication Link Layer currently in use, active operation currently in use, property monitor timer, and the progress bar used when reading objects and properties. Page 15

16 5.1 Toolbar Picture 11. Toolbar Toolbar buttons are explained in order of appearance from left to right. Device Discovery: This button will open a Device Discovery Window to issue local or broadcast Who-Is BACnet service in order to detect BACnet devices on a local network. Filtered Device View: Limit the Device Tree View to display device/object/property specified. Confirm Write List: When changing values of properties, BACnet Lookout will not automatically issue a WriteProperty service but will instead put each changed value to a list of changed values for this object. This is done in order to prevent accidental writing to device. This button will open a window with a list of changed values and let you change the write priority for each one. To confirm changes and write new values, click on the Commit button. Clear Write List: Undo the changed made to the property values. Save File to Disk: Whenever user reads file from target device using AtomicReadFile BACnet Service, file will appear in the Value View window under the newly created tab named the same as a read file. This file will appear as an editable hex file and can be saved to a local or a network drive by clicking on this toolbar button. Atomic Write File: This button will issue an AtomicWriteFile BACnet Service for selected opened file writing the file back to the BACnet source device. Change File View: This button will change the view of the opened file to one of 3 possible variations. Hex code with text on the side, only hex code and only text. Show/Hide COV Notification View: This button will show or hide COV notification view. This is a persistent tab and is always active. This means that any COV notification detected by BACnet Lookout will show in this tab view. This includes Confirmed and Unconfirmed COV Notifications. You can clear this list by selecting Clear COV Event List option in the Edit section of the Main Menu. Show/Hide Event Notification View: This button will show or hide Event Notification View. This is a persistent tab and is always active. This means that any event notifications from known or unknown source will appear in this view if detected by BACnet Lookout. Start/Stop Property Monitor: This button will start or stop internal property monitor timer. Set the timer interval in the BACnet Lookout Settings window located under Edit option in the Main Menu. Show/Hide LUA Console: This button will show or hide LUA Console Window. This is convenient way to test your LUA scripts without having to open and write your script output to files. Any LUA command entered in to LUA Editor tab of BACnet Lookout will have its output in this window. For more information refer to (LUA section) Stop All: This button will stop all current reading and writing, will clear all queued tasks and will return the control of to the user. This option is convenient when reading long object lists or when communication to the device is lost. Workspace Manipulation. Four buttons used to manipulate the application workspace. They are in order: Close Active View: Will close any currently opened Value View such as graph view, PID view Back Button: Use this button when configuring routers and devices via Web View to load previous page. Show/Hide: Device List View Show/Hide: Message View Show/Hide: Monitor View Page 16

17 5.2 Device Lists Picture Normal and Structured Device Tree View Device List is a section of BACNet Lookout user interface designed around object oriented nature of the BACnet Protocol and holds all the information about BACnet Device (found or created), BACnet Objects belonging to the device and BACNet Properties belonging to the object. Device List UI control consists of two seperate tree views accessible by clicking the Tab Buttons each with their own advantages. Normal and Structured View lists are also the main control point of BACnet Lookout. By clicking the right mouse button anywhere on Device List, user will open a Context Menu which can then interact with other parts of the program. Device List is also a context sensitive control meaning that clicking and double clicking the left mouse button will have different results on the other sections of the program. For example, clicking the Device icon (marked by red Page 17

18 device instance text) will make the properties section of the program display the properties of the selected device. But double clicking the same device will display device properties and execute ReadProperty service that will then try to discover BACnet objects belonging to the the device. If no objects are found or Lookout loses a connection to the device an appropriate error will be displayed in a message box. Device List displays its data in form of icon nodes and color coded text. There are eleven different icon types that can appear in the Device List each representing device, object, property or a format of data they are presented in. Device List. Root node. Any device found on internal or external network will be a subset of this node. Communication Folder Node. This node only appears in Structured View. Any device found on internal or external BACnet network that share a communication type will appear as a subset of this node. Network Number. This node only appears in Structured View. Any device found on internal or external BACnet network that share a network number will appear as a subset of this node. Active BACnet Device. BACnet Device found on internal or external BACnet network. Inactive BACnet Device. BACnet Device on external BACnet Network created with the Create Shadow Device option. First successful ReadProperty will flag this node active and change its icon to active. Active BACnet Slave Device. BACnet MSTP Slave Device created with Create Shadow Device option and MSTP Slave Device parameter enabled. Inactive BACnet Slave Device. BACnet MSTP Slave Device created with Create Shadow Device option and MSTP Slave Device parameter. First successful ReadProperty will flag this node active and change its icon to active. Object Type Folder. This node only appears in Structured View. BACnet Objects discovered on the device will appear as a subset of their respective type under this node. For example, Files, Values, Inupts etc. BACnet Object. This node represents BACnet Object as described in BACnet Standard , 12. BACnet Property. This node represents BACnet Property as described in BACnet Standard , 12. BACnet Proprietary Property. This node represents BACnet Property of proprietary type. Device, object or a property presented in the Device List will also be color coded based on their type. Device instance will have a red text with the device instance number, objects will be marked with blue text and properties with green text. NOTE: Present_Value properties will always be displayed in orange color and will have property s value displayed next to the name. In addition to color coding when specific objects are read, some nodes will change their text based on the data received. For example: reading the Device Object of BACnet Device will change presented name of the object e.g. Device, to Device, 17222, Device Name. In this case when reading properties of object device, BACnet Lookout will read the Object Name property of Device Object and include this to the name of the object presented in the Device List. Similar thing will happen when reading any Input, Output or a Value object type. Present Value will display next to a property name. Both views contain the list of discovered BACnet devices on the BACnet network. It is also a controlling part of the application meaning all services and options presented in the Toolbar or System menu work in combination with the selected node in Device Tree List. Page 18

19 5.3 Network View Separate from the Device lists, BACnet Lookout also supports BACnet Network device discovery by issuing the Who-Is-Router-To-Network BACnet service. This service is used by both routing and non routing nodes to find the next router to a specific destination network or as an aid in building the up-to-date routing table. If the executing of the service is successful, and receiving device supports this particular NLP message, it will answer with I-Am-Router-To-Network, I-Could-Be-Router-To-Network or an appropriate reject message. After receiving a successful response, list of responding routers will be constructed in the Network List tab in the Device List panel. Picture 14. Picture 14. Network List Each responding BACnet Router will have a list of specific destination addresses router uses to route the traffic which is depended on the router configuration. BACnet Lookout can also try to construct the list of devices under each destination address the device is being routed to. In Picture 15. we can see that the router device is configured to have two destination networks; 2001 and By opening the context menu on the router icon and selecting the Update Topology Map option BACnet Lookout will sort the devices under their respective destination networks. Picture 14. In the Picture 15 we can see the that BACnet Lookout has opened the Web Configuration Tab for this device. This makes it easier for the automation engineer to work and configure BACnet networks by keeping all the relevant configuration information inside only one configuration environment. NOTE: Please follow the device installation manual and configure the device before trying to access it through BACnet Lookout BACnet Lookout can also show the Routing List for specific router by opening the context menu by right clicking on the router icon and selecting the Show Routing Table option. This will open a Routing List Tab in the property view with the list of destination addresses for the selected router, their respective devices but also the From and Destination field as shown in Picture 16. Page 19

20 Picture 15. Example of Router Configuration Picture 16. Routing List With Only BACnet/IP Link Layer Eanbled Picture 17. Routing List With Only BACnet/IP and BACnet/Ethernet Link Layers Enabled Page 20

21 5.4 Filtered View For easier access, Lookout also incorporates the Filtered Device Tree View. With this option it is possible to filter the information displayed in the Device Tree according to Objects and Properties. To enable the Filtered view, click the Filtered Tree View icon from the Toolbar Menu. And check the Enable View Filter View. Picture 18. Display Filter Depending on the selected object and property filters, Device Tree will then only show the selected options. Picture 19. BACnet Property filter example Page 21

22 Picture 20. BACnet Object filter example Page 22

23 6. Value View Picture 21. Value View Window Value View is the context sensitive informative section of BACnet Lookout. Values and information presented in the Value View window are separated into tabbed sections of the window. Each section dependent on the context selected or operation executed. The following section of this user manual describes each tab and its purpose and use. 1. Property List View. Context: Device, Object or a property selected in the Device List. Property List (pic. 21) is the main tab of BACnet Lookout and will display the information about device, object or a property selected in the Device List. The view may vary between the information about hardware device, list of objects or a simple property. Property values are also data context independent meaning that you don t have to know the data type of the property to change it. It is important to note that changing the value of a property will not change the value on the BACnet device, but instead changed property value will be inserted in the list of changed values for the selected object/property and then needs to be manually confirmed for actual WriteProperty service to be issued. Some properties in the Property List will be displayed in the color coded tree-like structure. These are called complex properties and are composed of one or more structured data values. Recipient List property shown in the Picture 22 is one such property. Page 23

24 In BACnet, Recipient List property is comprised of Transition Bits bit field, Confirmed Notifications, Process Id, Recipient structured data field, To and From time fields and structured Valid Days data fields. There are more the 70 properties defined in BACnet standard with structured information similar to this and Lookout will show them all in this or similar format. Changing the values of these properties is not done in the same way as changing the values of primitive properties. Each complex property will have a Click here to edit items text next to the property name. Clicking on this text will open a window corresponding to the selected property. Picture 22. Changing BACnet Recipient List property Window Also, please note that not all complex properties are writable and Lookout will not allow you to change read-only complex properties. A part from normal (primitive) and complex properties there are also a proprietary properties and proprietary objects. Proprietary properties in BACnet are properties defined outside of scope of BACnet standard and are specifically made for a purpose by the device vendor. Many device vendors use this type of properties on their own devices for vendor specific operations. When encountered with this type of properties (and objects), Lookout will try and present them as normal properties but in Proprietary, (#) text format. It is also important to note, that considering the nature of such information, not all proprietary properties can be successfully decoded and displayed. An example would be reading a complex proprietary property where the data doesn t follow BACnet standard on coding and decoding context tags. Lookout will still decode and present this properties but it will be presented in the Property List as proprietary property with an octet string as data type as can be seen in picture 23 at proprietary property 600. Also, some proprietary properties will not allow reading and will return an error when trying to access them. For example, Automated Logic Corporation s ME-LGR25 general purpose controller has a proprietary object of type 900 consisting of almost entirely proprietary properties. When trying to read this object Page 24

25 (Can be read only with ReadPropertyMultiple service) many of its properties will return an access error seen in picture 23. Picture 23. Example of reading proprietary properties with access denied errors 2. Property Monitor View. Context: Device, Object or a node selected in the Monitor Tree List. Monitor Network is a value view for properties directly tied to the automated property monitor. Picture 25. This is an automated property reader that allows you to create topological view of your BACnet internetwork. This section, similar to Device Tree, also operates through Context Menu but instead of service and BACnet operations, allows creation of tree nodes. Picture 24. Picture 24. Monitor Tree Context Menu Page 25

26 When clicking on the monitor tree node, Monitor Network tab will automatically be selected and selected node properties will appear in the Monitor Network s value view. Picture 25. Example of a configured monitor tree Each tree node in the monitor tree will have an editable name, description and a user note for this node that can be changed at any time. Changing the name of the node will also change the name in the Monitor Tree. Value view of the Monitor Tree is also a context sensitive view meaning the values displayed will change depending of the type of node selected in the Monitor Tree. For example, selecting the Device node will display the device information in a similar way the Device Tree displays its own information. Selecting objects will show object type and instance and selecting property will show the property name and its value. Selecting the root node will display values of all property nodes currently created in the Monitor Tree. Picture 26.Node Properties There are six different types of nodes associated with the Monitor Tree. Page 26

27 These are: Network Node: Main root node. Every other node must be a subset of this node. Folder Node: General purpose node. Use to to organize your network in to groups. Device Node: Valid BACnet Device node. This node must be Drag & Dropped from the Device Tree. Object Node: Valid BACnet Object node. This node must be Drag & Dropped from the Device Tree. Property Node: Valid BACnet Property node. This node must be Drag & Dropped from the Device Tree. LUA Node: LUA script node. In addition to the standard type of nodes, Monitor Tree can also associate a special type of node called LUA node. This option allows user to associate any valid LUA script to the current monitor configuration. Lookout will run the associated script every time the property monitor executed a value scan. 3. LUA Editor View. Context: Valid LUA script. Picture 27. LUA Editor View LUA Editor is a basic text editor but also a powerful feature of BACnet Lookout as it allows engineers to write custom scripts and execute them through Lookout s built-in LUA interpreter. Since this editor offers only basic text edit support it is recommended that other third party editor be used and complete script text be copy-pasted to Lookout. Page 27

28 You can execute any LUA script by selecting LUA Editor in the main menu and selecting Execute LUA option. Toolbar also has the button to show/hide LUA console window that can be used enable or disable a quick console based testing environment. Picture 28. Reading object property values example Picture 29. Console output Page 28

29 For examples of the LUA scripts please check the \data\lua folder in the Lookout s install directory. 4. File View. Context: BACnet File object type read with AtomicReadFile service. Picture 30. File View File view tab will appear whenever the user reads an object with the File object type using the AtomicReadFile BACnet service. The file itself will appear in the hexadecimal view with a grid of hexadecimal characters on the left and the actual text on the right. This view can be changed at any time by clicking the Change File View button located on the toolbar menu. User can choose between 3 different file views. Hexadecimal and text view shown in picture 30, only hexadecimal view and only text view. Files read from the BACnet device can be edited at any time by changing the hexadecimal or normal text. Any text from any other program can be pasted to this view by clicking the right mouse button in the file view and selecting the Paste option. Any file currently shown in the File View can also be saved to hard disk by clicking the Save File to Disk button located on the toolbar menu. When changes have been made to the file, it can be downloaded back to the device to by clicking on the Atomic Write File button located on the toolbar menu. Close any previously opened file view by clicking on the Close Active View button located on the toolbar menu. In addition to reading files from the device, BACnet Lookout also includes the ability to load files from the local disk and write it to the remote device. To write a local file to remote device, we must first associate local file with the BACnet Object. To do that, scan the device and find the target file object you wish to write file on to. Then open a context menu and click Associate BACnet File Data. When the Open File window appears select the file you wish to associate with the object. To write file to the device, simple click the Atomic Write File button located at the Toolbar menu. If file is successfully written to the device, a success message will appear in the Message Window. Page 29

30 5. COV Notification View. Context: No Context. By default Lookout will always actively listen for COV notifications. Whenever it receives confirmed or unconfirmed COV notification, it will be stored the internal list that can be accessed by pressing the Change of Value button located on the toolbar menu. Picture 31. Every COV notification will have a set of information embedded in it about the notification itself. These are source Device ID, Object ID on the device, Process ID associated with the notification, Seconds to Live before another subscription must be made, Property ID and the changed value itself. There are two types of COV notifications, confirmed and unconfirmed. When either of these is received the message will appear in the System Message list that COV notification is received. While this is true for the unconfirmed notifications, confirmed ones are treated a little differently. By default, Lookout will try to confirm COV notification by automatically issuing Simple-ACK service to inform the source device that we have received and acknowledged the COV notification. However this is possible only if the source device is discovered and is in the Device List. If no device is found in the Device List, a warning message will appear in the System Message list that device can t be found in the device list. Picture 31. COV Notification View Page 30

31 6. Event Notification View. Context: No Context. Just like COV notifications, Lookout will also always actively listen to Event Notifications. This includes confirmed and unconfirmed event notifications. In some systems a device may need to know that an operator has seen the alarm notification. The AcknowledgeAlarm service is used by a BACnet Lookout to acknowledge that a human operator has seen and responded to an event notification. If the event received is confirmed event notification a checkbox will appear next to the list entry with the Click to Confirm Event Notification text. By clicking the checkbox, user will manually issue an AcknowledgeAlarm service to notify the device that event is seen and confirmed. Each event has a set of values associated with it. These are: source Device ID, Object ID issuing the event, Process ID associated with the notification, Timestamp which can be one of Date and Time, Time or a sequence number, Notification Class associated with the initiating object, Priority, Event Type, Message Text (not required), Ack-Required (should the user confirm the event manually), From State and To State event parameters. Additionally to this, the actual value of the received event depends on the Event Type parameter and can be one of: Change of Bit-String, Change of State, Change of Value, Command Failure, Floating Limit, Out of Range, Complex Event Type, Change of Life Safety, Extended, Buffer Ready and Unsigned range. All values except Extended and Complex will be shown in the List of Event Notifications. Picture 32. Picture 32. Event Notification View Page 31

32 7. Trend Log View. Context: Trend Log Object with discovered properties. BACnet Lookout can also read and show trend log data by reading the TrendLog BACnet Object. (7.10 Reading Trend Log). Trend Log objects are a type of monitoring objects used for recording and monitoring the states/values etc. of BACnet properties associated with the Trend Log objects. When predefined conditions are met, Trend Log will save the value of the property and a time stamp in the internal buffer for subsequent retrieval. The data may be logged periodically or upon a change of value. Each Trend Log object maintains an internal, optionally fixed-size buffer. This buffer grows as log records are added. If the buffer becomes full, the least recent record is overwritten when a new record is added, or data collection may stop. Trend Log records are transferred as BACnetLogRecords using the ReadRange service. The buffer may be cleared by writing a zero to the Record_Count property. Picture 33. Trend Log View Similar to Trend Log, Lookout also supports the Trend Log Multiple object type. This object monitors one or more properties of one or more referenced objects either on the same device as the Trend Log Multiple object or in an external device. To set the trend log values we need to edit the Log_DeviceObjectProperty property of the Trend Log Object and write the changes to the parent device. Picture 34. Page 32

33 Picture 34. Editing the Log Device Object Property 8. PID View. Context: No Context. Picture 35. PID View with properly configured options Page 33

34 A proportional-integral-derivative controller (PID controller) is a control loop feedback mechanism (controller) commonly used in industrial control systems. A PID controller continuously calculates an "error value" as the difference between a measured process variable and a desired setpoint. The controller attempts to minimize the error over time by adjustment of a control variable, such as the position of a control valve, a damper, or the power supplied to a heating element, to a new value determined by a weighted sum: where,, and, all non-negative, denote the coefficients for the proportional, integral, and derivative terms, respectively (sometimes denoted P, I, and D). In this model, P accounts for present values of the error (e.g. if the error is large and positive, the control output will also be large and positive), I accounts for past values of the error (e.g. if the output is not sufficient to reduce the size of the error, error will accumulate over time, causing the controller to apply stronger output), and D accounts for predicted future values of the error, based on its current rate of change. As a PID controller relies only on the measured process variable, not on knowledge of the underlying process, it is a broadly useful controller. By tuning the three parameters of the model, one can design a PID controller for specific process requirements. The response of the controller can be described in terms of the responsiveness of the controller to an error, the degree to which the controller overshoots the setpoint, and the degree of system oscillation. Picture 36. A block diagram of a PID controller in a feedback loop To use Lookout s built in PID controller user must first open the PID view located under the PID section in the main menu. BACnet Lookout comes with the simple Water Heater demo device that you can use to test the PID on your own. In this case the demo device has a few values that we can use to successfully run the PID algorithm. Similar how the Property monitor is configured, we must first configure the PID controller. Drag and drop relevant properties to their respective fields. This operation is called binding. First we must bind the setpoint. Setpoint is the process value of the device. That means that this variable is set based on the feedback from the device. In our case this would be a Analog Output, 201, or Current ELMA KURTALJ ltd. BrightCore BACnet Lookout v2.7 Page 34

35 Temperature in our water heater. Next we bind the output value. This is the value that the PID controller sets up or down based on the feedback from the device. In this case that would be Analog Input, 301, Temperature Regulator. Set value in our is the value of desired temperature and can be set by changing the Analog Value,106, Set Point Temperature normally from the Property Value View. Next we must bind PID properties. Their names may differ from device to device but in this case they are named Analog Value 501, proportional, Analog Value 502, integral, Analog Value 503,derivative. If we configured all properly, we may start the PID process by Accessing Process Testing in the main menu and clicking the Start PID Monitor option. By moving the Kp, Ki and Kd sliders we can visually see the process. NOTE: PID is an experimental part of BACnet Lookout meant to be part of a Process Testing section and for now could serve only a limited purpose inside the application. As we update BACnet Lookout we will also update the Process Testing section and add more functionality to the testing process. Extended version of BACnet Lookout also comes with the WaterHeater BACnet Device seen in Picture 35. To start the application, locate it in the Lookout s install folder under waterheater directory. For demonstration on how to use PID View please check video presentation at: Water Heater Demo Device Page 35

36 7. System Messages Window Picture 37. System messages window System Message window is the way Lookout keeps the user informed on the operations executed or currently executing while working with the program. The window itself is divided in to 3 sections. These are: Confirm with the message type, the Message with the message itself and the Time section with the time of receipt. Lookout has 4 types of message severity. Message: Indicated the success of the executed operation or information about the operation. Warning: This type of messages will usually inform the user of warnings. Error: Will inform the user about BACnet errors received from the device. Critical: Will inform the user about errors intrinsic to the program. Every message that appears in the Message Window carries detailed information about the message and can be viewed by double-clicking the left mouse button or right-clicking on the message and Selecting Show Message Information option. The message information displayed in this window is context sensitive and depends on the type and information the message relays. For example, whenever Lookout detects the BACnet Device through I-Am service, the appropriate message will appear in the Message Window for that device. Opening the Message Info window for that message will display complete information about that device. Picture 38. Every message in the Message List can also be confirmed and removed from the list by clicking the checkbox next to the message type and opening the context menu and clicking the Confirm Selected Messages option. Furthermore, messages can also be filtered by type by accessing the message filter in the context menu and selecting an appropriate message filter option. The message List window can be cleared of all messages by accessing the Edit in the Main Menu and selecting the Clear Message Window option. Page 36

37 Picture 38. Example of the I-Am message information window The description field of the Message Information window will always try to explain the nature of the message. However, in some cases this may be technical information (such as Invalid Tag or Malformed Packet) returned by a remote BACnet device and Lookout will just relay this information to the user. Page 37

38 8. Context Menu Picture 39. Context Menu Context Menu is a part of BACnet Lookout that serves as a starting point for every operation and command the program can perform. It includes a general operations regarding discovering devices object and properties on a local network, list of BACnet Services program can execute, operations for detecting devices on external network and operations regarding event subscriptions and notifications. To successfully run an operation or a BACnet service, an appropriate context must be defined. Context in this case means that appropriate Device List node must be selected in order for a selected operation to run. For example, GetAlarmSummary Service would not run if Object Node is selected or Discover Device Objects operation would not run if Property Node is selected etc Following is the list of all operation and services in the Context Menu and their respective context selection. Scan BACnet Network. Context: No Context needed. Display BACnet Network Scan window. Equivalent to pressing Who-Is Network Scan toolbar button. Rescan BACnet Device. Context: Active or Inactive Device must be selected. Initiate a Who-Is BACnet Service directly to this device to find out if the device is still active. (This option will not work on MSTP Slave devices). Discover Device Objects. Context: Active or Inactive Device must be selected. Page 38

39 Initiate ReadProperty BACnet service. If device can be found on the local or external BACnet network, Lookout will display list of received objects as a subset of this node. This option is equivalent to double clicking the Device Node in the Device List. There are multiple ways this service is can be executed depending on the BACnet Lookout settings. Discover Object Properties. Context: BACnet Object Node must be selected. Initiate ReadPropertyMultiple or ReadProperty BACnet Service. If parent device can be found on the local or external BACnet network, Lookout will display the list of received properties as a subset of this node. This option is equivalent to double clicking the Object Node in the Device List. There are multiple ways this service is executed depending on the BACnet Lookout settings. Discover Object List Properties. Context: Active or Inactive Device must be selected. Both must contain the list of Objects. Initiate ReadPropertyMultiple BACnet Service for each BACnet Object in the list. This will automatically discover all Properties for all objects for a target device. Target Device also must support ReadPropertyMultiple BACnet Service. BACnet Services. Context: Any. Execute any of the available BACnet Service. For detail description refer to 7. BACnet Services Import EDE Object List. Context: No Context needed. Import Device and Object list from the EDE file. NOTE: ASHRAE BACnet committee SSPC-135 has reviewed the EDE file concept and feels that the solution does not fit in with the BACnet roadmap. As such this option is deprecated and will be removed from BACnet Lookout. However, in the future this option will be available through LUA scripting. Create Shadow Device. Context: Device List node must be selected. This option will create a Shadow Device. In BACnet Lookout Shadow Device is a term used to detect and manage BACnet Devices outside of local network. For example, if user wishes to access a device on the internet, remote BACnet network or through VPN and generally access a device that is unable to respond with the I-Am BACnet Service, he would create a shadow device. This will create a shadow of the target device in the Device List and will enable user to work with the device as it were normally found on the local network. This option is also used when working with the BACnet MSTP Slave devices. Since they are not designed to be detected through WhoIs service and usually have hardware settings for device instance and addressing. We would use this option to create a shadow device, set device instance and address, set MS/TP as data link and check MSTP Slave check box. Delete Shadow Device. Context: Active or Inactive Device must be selected. Deletes selected device from the Device List. Subscribe BACnet Lookout for Event Notifications. Context: Notification Class Object type with discovered properties must be selected. After confirmation, this option will Initiate WriteProperty to the target device with BACnet Lookout added as one of possible destinations for event notifications for this Notification Class object. Unsubscribe from Event Notifications. Context: Notification Class Object type with discovered properties must be selected. After confirmation, this option will Initiate WriteProperty to the target device with BACnet Lookout removed as one of possible destinations for event notifications for this Notification Class object. Page 39

40 9. BACnet Services BACnet Services is the sub section of Context menu and hold a set of BACnet Services described in BACnet Standard supported by BACnet Lookout. A part from read, write and remote device management services available through normal use of BACnet Lookout, these services must be initiated manually by the user. They comprise of Event and Alarm, Object Access, File Access, Remote Device Management, Broadcast Distribution and Foreign Device services. For list of services supported by different version of BACnet Lookout, see Table 3. The following is the list of all supported BACnet Services, their description and use. 1. Get Alarm Summary. Context: Active or Inactive Device must be selected. This option will initiate the GetAlarmSummary BACnet Service described in the BACnet Standard , pg519. Use this service to obtain a summary of active alarms. That is, any standard BACnet object whose Event State property is not NORMAL and Notify Type property is in ALARM state. If there are no objects in alarm state and target device supports this service, a system message will appear with appropriate message. If target device doesn t support this service, a system message will appear with Unsupported Service text. If service is successfully executed and we receive a valid list of objects in the ALARM state, Lookout will inform user with the system message that it has received a valid alarm list and open a corresponding tab in the Value View section of the program. 2. Get Enrollment Summary. Context: Active or Inactive Device must be selected. This option will initiate the GetEnrollmentSummary BACnet Service described in the BACnet Standard , pg521. Use this service to obtain a summary of any event-initiating object specified by service filter. Picture 40. Enrollment Summary Filter window Page 40

41 Service Parameters are explained as follows: Acknowledgement. A selection between ALL, ACKED and NOT-ACKED where ALL will request all eventinitiating objects. ACKED will request only objects whose Acked Transitions property has a value of 1 in every bit position. NOT-ACKED will request only objects whose Acked Transitions property has a value of 0 in one or every bit position. Event State. A selection between OFF-NORMAL,FAULT,NORMAL,ALL and ACTIVE states where ALL will request all event initiating objects and every other state will request all event initiating objects whose Event State property has its respective state. If No Filter is selected, a value of ALL will be assumed. Event Type. This parameter will restrict the summary to only those event initiating objects whose Event Type property is equal to this parameter. If this No Filter is selected, all event initiating objects will be included in the summary. Priority Filter. This parameter, if included will request a summary of all event initiating objects with priority equal or in between Min and Max values of this parameter. Enrollment Filter. This parameter, if included will request a summary of all event initiating objects whose Recipient List property has a recipient equal to this parameter. 3. Get Event Information. Context: Active or Inactive Device must be selected. This option will initiate the GetEventInformation BACnet Service described in the BACnet Standard , pg524. Use this service to obtain a summary of all active event states. That is, any event initiating object whose Event State property is not NORMAL or Acked Transitions property has at least one of the bits set to FALSE. If there are no objects in active event state and target device supports this service, a system message will appear with appropriate message. If target device doesn t support this service, a system message will appear with Unsupported Service text. If service is successfully executed and we receive a valid list of objects in the ALARM state, Lookout will inform user with the system message that it has received a valid information list and open corresponding tab in the Value View section of the program. 4. Subscribe to Change of Value. Context: BACnet object node must be selected. This option will initiate the SubscribeCOV BACnet Service described in the BACnet Standard , pg528. Use this service to subscribe BACnet Lookout for the receipt of changes that may occur to the properties of a valid event initiating object. Picture 41. Subscribe to Change of Value window Page 41

42 Service Parameters are explained as follows: Subscribed Process Id. This parameter is a numeric handle parameter unique to the subscriber. In this case, user defined identification. It is used to match future subscriptions and cancelation request for this object. The current list of active COV subscriptions can be found be reading the Device Object s Active COV Subscription property. Monitored Object ID. Object ID of the monitored object. Cancel Subscription. Check this parameter to cancel a subscription for the Monitored Object ID and Subscribed Process Id. Issue Confirmed Notifications. Check this parameter if you would like for the target device to issue the ConfirmedCOVNotification service calls whenever the change appears in the monitored object. If a ConfirmedCOVNotification service is received, BACnet Lookout will automatically confirm it with a SimpleACK BACnet service and store it in the list of received COV notifications. When service is confirmed, a message will appear in the System Messages list indicating the confirmation. If this parameter is left unchecked, received information will simply be stored in the list of received COV notifications. Lifetime in Seconds. This parameter is a life time of the subscription in seconds before the target device automatically cancels the subscription. Specifying the value of zero will indicate that subscription should last indefinitely. 5. Subscribe to COV Property. Context: BACnet Property must be selected. This option will initiate SubscribeCOVProperty BACnet service described in BACnet Standard , pg531. Use this service to subscribe BACnet Lookout for the receipt of changes that may occur to the specific property of a particular object. Service Parameters are explained as follows: Picture 42. Subscribe to Change of Value Property window Subscribed Process Id. This parameter is a numeric handle parameter unique to the subscriber. In this case, user defined identification. It is used to match future subscriptions and cancelation request for this object. The current list of active COV subscriptions can be found be reading the Device Object s Active COV Subscription property. Monitored Object ID. Object ID of the monitored object. Property. Monitored property ID. Page 42