BACnet Test Framework Manual 06 Stand 2020/ Table of contents 1 Introduction .......................................................................... 5 2 Product support ................................................................... 6 3 Quick overview version 3.1 or later ................................ 7 Steps to change to Version 3.1 or later .......................................... 7 Python Environment ............................................................................ 7 Content of BTFEnvironment.py (if installed on drive C:) ............ 8 Converting script files ......................................................................... 8 Script import changes ......................................................................... 9 Debugger support ............................................................................... 9 Command-line interface ..................................................................... 9 Make / Check Automation ................................................................. 9 GCOM_LOG.txt ..................................................................................... 9 Project Directory _Working ............................................................... 9 Directory _Recycler ........................................................................... 10 Sample Script Files ............................................................................ 10 Sample EPICS Files ............................................................................ 10 4 Glossary................................................................................. 11 5 Available Software Editions ............................................ 13 Light-Edition ..........................................................................................13 Standard-Edition ..................................................................................13 Premium-Edition ..................................................................................13 Retrieving the supported software edition ...................................14 6 System Requirements ....................................................... 15 Operating System .............................................................................. 15 Hardware .............................................................................................. 15 Networks .............................................................................................. 16 Other Software .................................................................................... 16 7 Software components ...................................................... 17 The software structure ....................................................................... 17 A typical test network setup ............................................................ 18 Python Script language .................................................................... 19 8 Wireshark Integration ..................................................... 20 Settings ................................................................................................ 20 9 Setup ....................................................................................22 Requirements ..................................................................................... 22 BACnet Test Framework Content 2 von 117 Operating system .............................................................................. 22 Setup procedure ............................................................................... 22 Updates ............................................................................................... 22 Updating using the Patchfile .......................................................... 22 Registering Microsoft Office / Word ............................................. 23 10 General information about the BACnet Test Framework ................................................................................26 The associated user ......................................................................... 26 System history .................................................................................... 26 Project history .................................................................................... 26 Telegram buffer for execution ....................................................... 26 11.5. Testing Efforts ........................................................................... 26 11 Working with the BTF ...................................................... 27 Starting the Software ........................................................................ 27 Menu Project/Change ....................................................................... 27 Menu Project/Rename ..................................................................... 30 Menu Project/Reset .......................................................................... 30 Menu Project/Export ......................................................................... 30 The System Administration ...............................................................31 Quit .........................................................................................................41 Results .................................................................................................. 42 12 The main dialog ................................................................. 44 13 The test tasks ..................................................................... 45 Project Properties ............................................................................. 45 Importing EPICS files ........................................................................ 49 EPICS Consistency Test .................................................................. 53 Conformance Tests .......................................................................... 54 14 Testing conformance to BACnet ..................................55 Test plan configuration .................................................................... 55 Symbols used in test plan execution ............................................ 67 15 Command-line Interface .................................................. 73 The command-line arguments ........................................................ 73 16 Make-Automation ............................................................. 77 18.1. Introduction ................................................................................. 77 18.2. Writing a Make Script .............................................................. 77 Types of messages ............................................................................ 78 Assigning a Make Script ................................................................... 81 Enabling/Disabling the Make automation .................................... 81 Flag Uninterrupted Execution ......................................................... 81 Execution Flowchart ......................................................................... 82 BACnet Test Framework Content 3 von 117 17 Reading and Writing proprietary data ......................... 83 19.1. Proprietary ReadProperty Example ..................................... 83 Proprietary WriteProperty Example .............................................. 84 18 The recommended network setting ............................ 85 Setting up the BACnet Protocol-Stack ........................................ 86 Error starting the test plan ............................................................... 87 19 The process identifier for events and alarms ............ 88 20 Conventions for usage of wildcards ............................ 89 21 Sample EPICS-file for IUT ............................................... 94 22 Sample EPICS-file for TD .............................................. 104 23 Sample EPICS-file for OD ............................................... 115 BACnet Test Framework Content 4 von 117 1 Introduction Thank you for purchasing the BACnet Test Framework. This software allows comfortable setup of BACnet test projects, performing automated BACnet tests for BACnet server-devices as well as BACnet client-devices and supports printouts of test-reports directly from the database. The BACnet Test Framework is designed to perform script-based BACnet-tests for conformance testing according to the BTL-test-plans. You may add your own scripts and use the BACnet Test Framework for your QAtasks (standard and premium version). The BACnet Test Frameworks includes the test scripts used in the current BTL test-plan as a factory default database. Continuous maintenance will be provided and updates may be retrieved from MBS in the future. We wish you a successful testing with the BACnet Test Framework! MBS GmbH, Krefeld BACnet Test Framework Introduction 5 von 117 2 Product support Manufacturer MBS GmbH Römerstraße 15 47809 Krefeld Telephone +49 21 51 72 94-0 Fax +49 21 51 72 94-50 E-Mail [email protected] Internet www.mbs-solutions.de wiki.mbs-software.info Service times Monday to Friday: 8:30 to 12:00 13:00 to 17:00 BACnet Test Framework Product support 6 von 117 3 Quick overview version 3.1 or later This chapter provides an overview of changes from earlier versions to version 3.1 or later versions. Please refer to the release notes for details. Steps to change to Version 3.1 or later Due to the debugger support and changes to the environment all prolog-, epilog, user- used in former BTF versions have to be converted using a converter