Universal BACnet Router UBR-01

Transcription

1 User s Manual Universal BACnet Router UBR-01 Rev 1.3,

2

3 List of Contents 1 Revision History Welcome to UBR General Information Related Documents The information in this document is based on the general installation instructions described in the UBR-01 Installation Manual Copyright Quick Installation Guide Step 1 Connect and Activate DHCP Step 2 Login Step 3 Setup Step 4 Activate the configuration Step 5 Check the settings Step 6 Access the BACnet network Selection of the German language package Opening the Web server Login as Administrator Changing the language pack Introduction to BACnet Routing BACnet Network Numbers BACnet Network Layer Messages Example of a BACnet Network General Configuration Setup using a web-browser UBR-01 Menu Structure General Settings Instruction Login to the web-server

4 7.1 User Levels Guest Level User Level Admin Level Factory Level Logout from the web-server Auto-Logout from the web-server Main Menu Assistant Submenu Device Routing Type Object Name Object Instance Description Location DCC/RD Password APDU Retries APDU Timeout APDU Segment Timeout Language Save Button Submenu Network IP-Address Subnet mask Default Gateway Save Button Submenu BACnet/IP BACnet Network Number UDP Port BBMD/FD Mode Save Button Submenu BBMD Two-hop Forwarding Adding a BDT Entry Removing BDT Entries IP Address UDP Port Subnet/Distribution Mask Save Button Submenu FD IP Address

5 8.5.2 UDP Port Re-Register Time Save Button Submenu MS/TP Baud Rate MAC Address Network Number Token Timeout Reply Timeout Max Master Max Info Frames Enable sole master operation Slave autodiscovery operation Enable slave proxy operation Enable auto slave discovery Save Button Add Manual Slave Address Binding List of Manual Slave Address Bindings Submenu Ethernet Network Number Save Button Main Menu Diagnostics Submenu Verbose Submenu Restart Submenu Ping Main Menu Backup Submenu Backup Submenu Restore Submenu Last Config Main Menu Passwords Submenu User Submenu Admin Main Menu Maintenance Main Menu Activate

6 14 Main Menu Help Submenu Factory Manuals Submenu Project Manuals Submenu Language Pack Submenu Support Submenu About Location of the BACnet Device Object...54 The MBS logo is a registered trademark of MBS GmbH. BACnet is a registered trademark of ASHRAE, Inc. 6

7 1 Revision History This table shows the revision history of this document. Date Author Changes Frank Schubert Revision 1.0 Initial version Frank Schubert Revision 1.1 Corrections ANE Revision 1.2 Corrections ANE Revision 1.3 Corrections manual slave address binding.

8 2 Welcome to UBR General Information Thank you for purchasing UBR-01! This device is designed to provide highly reliable and easy-to-install routing functions in BACnet networks. 2.2 Related Documents The information in this document is based on the general installation instructions described in the UBR-01 Installation Manual. Please refer to this document to learn how to install UBR-01 and to access the integrated web-server. 2.3 Copyright 2008 MBS GmbH All rights reserved. 8

9 3 Quick Installation Guide This quick installation guide is intended for professionals in IT and BACnet communication. Please refer to the following chapters, if you are uncertain, how to configure the settings. 3.1 Step 1 Connect and Activate DHCP Connect the crossover-cable to UBR-01 and your notebook. If not done, setup your notebook to run as DHCP-Client or setup the IPaddress of your notebook manually to / If your are about to use DHCP, activate the DHCP-server by pressing and holding the reset-switch for more than 5 seconds, but not longer than 10 seconds. The status-led starts alternate blinking in red and green color, if the DHCP server is active. 3.2 Step 2 Login Enter in your web-browser and login to UBR-01 using the user/password combination admin/admin. 3.3 Step 3 Setup Step through all assistant pages from left to right and apply the settings according to your BACnet-project. Don t forget to confirm all settings on each page by clicking the save -button. 3.4 Step 4 Activate the configuration Activate the configuration by clicking Activate and Restart in the Activate page. Restarting UBR-01 will take approx. 25 seconds. 3.5 Step 5 Check the settings If you changed the IP-address of UBR-01, adjust the IP-address settings of your notebook according to the setting in UBR Step 6 Access the BACnet network Use your preferred BACnet-Client software to access the connected BACnet network. 9

10 4 Selection of the German language package The default language of the UBR-01, the English language, is preselected. To switch to the German language pack, follow the instructions in this chapter. 4.1 Opening the Web server Type in the address bar of your browser, the following IP address and press the Enter key: : The home page of the web server is displayed. 10

11 The English language package is active. 4.2 Login as Administrator Select the menu item 'login / logout ", the login dialog is displayed. Enter the user "admin" (the "User Name") the name in lowercase letters and the password (field "Password") "admin" password in lowercase letters. Then click on the "Login". 11

12 4.3 Changing the language pack Switch to Assistant. Select Device. 12

13 Select language Deutsch ( de ). Select Save. Please note that this setting is active only temporarily. Use to permanent activation of the German language package the "activate" button. 13

14 5 Introduction to BACnet Routing BACnet routers are devices that interconnect BACnet networks to form a BACnet internetwork. BACnet routers make use of BACnet network layer protocol messages (layer 3) to maintain their routing tables and exchange their routing information. 5.1 BACnet Network Numbers BACnet Network Numbers are assigned to router devices only. Each single router knows the BACnet Network Number of each of the Data-Link-Layers and interfaces supported by the router. The network number is allowed in the range from 1 to BACnet Network numbers shall be unique within the entire BACnet network. 5.2 BACnet Network Layer Messages BACnet currently supports 10 network layer messages exchanged by router devices. The two most important messages are Who-Is- Router-To-Network and I-Am-Router-To-Network sent as broadcast to determine other router devices and to distribute the information about the own routing capabilities to other router devices. 5.3 Example of a BACnet Network 14

15 6 General Configuration This chapter describes the setup steps to configure UBR Setup using a web-browser The UBR-01 setup is provided by a HTTP web-server (standard port TCP 80). To connect to the UBR-01 web-server, open your preferred webbrowser, e.g. Microsoft Internet Explorer. Enter the IP-address in the address field and press enter. The web-server start page will be displayed. 15

16 Clicking on the MBS logo on the top left corner returns back to the start page anytime. When starting UBR-01 for the first time, the start page shows UBR-01 not commissioned. Default configuration active. UBR-01 needs to be setup according to the required settings in your BACnet project. 6.2 UBR-01 Menu Structure The UBR-01 user menu provides three levels Login/Logout menu bar: This level provides access to the login/logout functions. The current access level is shown on the right corner. 2. The main menu bar: This level provides access to the main menu items. 3. Submenu bar: According to the setting in the main menu, this level provides submenus to the main menu items. 6.3 General Settings Instruction Every configuration page provides a Save button. Pressing this button causes temporary storage of the changes made to the configuration. After applying the first change to UBR- 01, the web-server displays a warning Configuration is not active! in blue color. Additionally, the Activate button turns into blue color. Please note that you have to save your changes before switching to another configuration page. If you switch to another page without saving, the settings remain as they were before. 16

17 Please note that you have to activate the configuration before restarting UBR-01. Activating the configuration saves all settings permanently and reboots UBR-01 to activate the new settings. 17

18 7 Login to the web-server Click Login/ Logout to start the login process. The login page will be displayed. Enter the user name and password as shown below. Enter the User Name and Password and click the Login-Button. Clicking the Logout-Button returns to the guest level. 7.1 User Levels UBR-01 provides four user levels: Please note that all passwords are case-sensitive! Guest Level guest: When connecting to UBR-01, you are already logged in as guest. Guest-user may read all settings but modification is not allowed. No password is required for the guest-user User Level user: This is the user-level to modify most settings except changing the passwords, upload documentations or perform a backup/restore of the configuration. The default password is: user 18

19 7.1.3 Admin Level admin: This is the administrator level to allow all modifications of a regular user, but additionally allow changing password, uploading or removing documentations to the web-server and performing a backup/restore of the configuration. The default password is: admin Factory Level factory: This user has the same access rights as the admin user, but additionally allows uploading an update file to UBR-01. The password is provided by the support with the update file. 7.2 Logout from the web-server Click Logout to logout from the web-server. The access level will return to the guest-mode and the start page will be shown. 7.3 Auto-Logout from the web-server After 30 minutes of inactivity, the current user is automatically logged out. 19

20 8 Main Menu Assistant The Commissioning Assistant assists in performing the required setup steps for easy setup. The Assistant menu bar provides the required steps from left to right to setup the router. Menu items, which are unavailable in certain operating modes may be disabled. E.g. if no BBMD is configured, the BBMD tab is not accessible. 8.1 Submenu Device This page provides the general settings for the device and the UBR- 01 operating modes Routing Type Set the routing type here, available options: B/IP Ethernet MS/TP: This setting defines a router supporting all three Layers BACnet/IP, BACnet 20

21 Ethernet and MS/TP B/IP Ethernet: B/IP MS/TP: Ethernet MS/TP: MS/TP B/IP This setting defines a router supporting the Layers BACnet/IP and BACnet Ethernet This setting defines a router supporting the Layers BACnet/IP and MS/TP (Default-mode) This setting defines a router supporting BACnet Ethernet and MS/TP This setting defines a router for MS / TP This setting defines a router for B/IP Object Name Setup the BACnet Object-Name of the UBR-01 Device Object here. Please note that this name shall be unique within the entire BACnetnetwork! The maximum length of this string is 50 characters Object Instance Setup the BACnet Object-Instance-number of the UBR-01 Device Object here. Please note that this number shall be unique within the entire BACnet-network! The value range of this property is 0 to Description Setup a free description text for UBR-01 here. This text appears in the Device Object of UBR-01 and can be read by communication peers in the BACnet-network. The maximum length of this string is 50 characters Location Setup a free location text for UBR-01 here. This text appears in the Device Object of UBR-01 and can be read by communication peers in the BACnet-network. The maximum length of this string is 50 characters. 21

22 8.1.6 DCC/RD Password Setup the password for the BACnet services DeviceCommunicationControl and ReinitializeDevice. This password is case-sensitive! The maximum length of this string is 50 characters APDU Retries The Number-Of-APDU-Retries property indicates the maximum number of times that an APDU shall be retransmitted. The default value for this property is APDU Timeout The APDU-Timeout property indicates the amount of time in milliseconds between retransmissions of an APDU requiring acknowledgment for which no acknowledgment has been received. The default value for this property is 3000 milliseconds APDU Segment Timeout The APDU-Segment-Timeout property indicates the amount of time in milliseconds between retransmission of an APDU segment. The default value for this property is 2000 milliseconds Language To select a language, choose the language from the combo-box. To permanently switch to another language, you need to activate the configuration, otherwise UBR-01 will fall back to the previous language. This feature offers temporary switch to another than the currently selected language Save Button Temporarily saves the changes made in this page. Changed configurations require activation. 22

23 8.2 Submenu Network This page provides the general IP-settings of UBR-01. In foreign networks you may have to retrieve this information by an ITadministrator IP-Address Setup the IP-Address of UBR-01 in the designated network Subnet mask Setup the Subnet mask of UBR-01 according to the IP-Address Default Gateway In networks, where sub-networks are connected by IP-Routers, this address is used to setup the gateway to other networks (the IP- Address of the router of the sub-network, where UBRP-01 is installed). Please note that if Default-Gateways are used, most likely Broadcastmessages are blocked by IP-routers and you will need to use a BBMD to transport broadcast-messages Save Button Temporarily saves the changes made in this page. Changed configurations require activation. 23

24 8.3 Submenu BACnet/IP This page provides the settings for BACnet/IP BACnet Network Number Setup the network number for your local BACnet/IP network here. This number shall be unique within the entire BACnet network. The value range of this property is 1 to UDP Port Setup the port-number for BACnet/IP in your local IP-network. This value is in decimal notation, the default value is dec. (0xBAC0 hex.) BBMD/FD Mode Setup the BBMD/FD-mode here, available options: NONE: BBMD or FD is not active. BBMD: UBR-01 will provide BBMD functionality to the BACnet subnetwork, allowing connections from external FD or BBMD. FD: UBR-01 will run in BACnet/IP FD-mode, connecting to an external BBMD. 24

25 8.3.4 Save Button Temporarily saves the changes made in this page. Changed configurations require activation. 25

26 8.4 Submenu BBMD This page provides the settings for BBMD (BACnet Broadcast Management Device). If set to this mode, UBR-01 provides BBMD functionality to the local sub-network Two-hop Forwarding If in this mode, the IP-routers are not involved in broadcast transport. In two-hop mode, the broadcast messages are transported to the BBMD and the BBMD will send the forwarded broadcast to the local network. If in this mode, the BDT (Broadcast Distribution Table) contains the address of external BBMD and the Subnet/Distribution mask is a mask, which specifies the distribution of the forwarded broadcast to the local network for each connected BBMD (normally to distribute the broadcast messages to all devices in the sub-network). If in One-hop mode, the BDT contains the addresses of the IProuters, which forward the broadcast messages to the external sub- 26

27 networks. This mode requires to setup the IP-Routers to support the so-called Directed Broadcast mode. If in this mode, the BDT contains the addresses of the external IProuters (not the external BBMD!) and the Subnet/Distribution mask is the Subnet mask of IP-router providing broadcast-forwarding Adding a BDT Entry Enter IP-Address, UDP-Port and Subnet/Distribution mask of the BDT-entry and click the Add -button. This creates a new BDT entry. The BDT can contain up to 30 external entries. Please note that the UBR-01 device is always included in the BDT, so it is not required to include the own address to the BDT. 27

28 BDT entries are shown in the list Broadcast Distribution Table Removing BDT Entries Simply check the BDT-entry/entries you want to remove and click the Remove -button IP Address Setup the IP-Address of the external BBMD or IP-Router UDP Port Setup the UDP-Port, which is used for BACnet communication in the external BACnet-sub-network. This value is in decimal notation and the default value is dec. (0xBAC0 hex.). 28

29 8.4.6 Subnet/Distribution Mask Setup the Subnet-mask or Distribution-mask of the BDT entry here. Depending on the operation mode (One-hop or Two-hop), the entry may vary. One-hop: This mask is the Subnet mask of the external IP-Router, e.g in Class-B networks, in Class-C networks or even super-netting addresses like or subnetting addresses like Two-hop: This mask is the Distribution mask and allows restricting the distribution of the broadcast messages to only parts of the external network. To distribute the broadcast messages to all hosts in the external network, the mask shall have the value of

30 This dialog shows a One-hop configuration (Directed Broadcast) Save Button Temporarily saves the changes made in this page. Changed configurations require activation. 30

31 8.5 Submenu FD This page provides the settings for FD (Foreign Device). If in this mode, UBR-01 acts as a FD to retrieve broadcast messages from an external BBMD IP Address Setup the IP-Address of the external BBMD to connect to UDP Port Setup the UDP-Port, which is used for BACnet communication in the external BACnet-sub-network. This value is in decimal notation and the default value is dec. (0xBAC0 hex.) Re-Register Time Setup the interval to re-register at the external BBMD. The value is in seconds and the default value is 10s Save Button Temporarily saves the changes made in this page. Changed configurations require activation. 31

32 8.6 Submenu MS/TP This page provides the settings for BACnet MS/TP Baud Rate Setup the baud-rate in the MS/TP network here. The value is in bit/s, potential values are: 9600, 19200, 38400, 57600, and The default value is Please note that the baud-rates and are not (yet) specified in the BACnet-standard and may not be supported by all MS/TP implementations. 32

33 8.6.2 MAC Address Setup the MAC-Address of UBR-01 in the MS/TP network here. UBR- 01 acts as a MS/TP master-node. The value is valid from 0-127, the default Value is 0. The MAC-Address shall be unique within the entire MS/TP network Network Number Setup the network number for your local MS/TP network here. This number shall be unique within the entire BACnet network. The value range of this property is 1 to Token Timeout The Token timeout is the minimum time without a DataAvailable or ReceiveError event that a node must wait for a remote node to begin using a token or replying to a Poll For Master frame. The valid range is milliseconds, the default value is 20 milliseconds Reply Timeout The Reply timeout is the minimum time without a DataAvailable or ReceiveError event that a node must wait for a station to begin replying to a confirmed request. The valid range is milliseconds, the default value is 250 milliseconds Max Master The Max_Master property specifies the highest possible address for master nodes. If the Max_Master property is not writeable via BACnet services, its value shall be 127. The valid range is 0-127, the default value is Max Info Frames The Max_Info_Frames property specifies the maximum number of information frames the node may send before it must pass the token. If Max_Info_Frames is not writable or otherwise user configurable, its value shall be 1. The valid range is 1-127, the default value is Enable sole master operation The property " Enable sole master operation " specifies that only the UBR-01 is master on the MS / TP bus. There is then no longer be requested on other masters. 33

34 8.6.8 Slave autodiscovery operation Insert here the interval at which you want to slave devices on the MS / TP network are being sought. Slave nodes are detected by reading the property ProtocolServicesSupported using the instance number (wildcards) when the service Who-Is is not supported Enable slave proxy operation Choose whether the slave-proxy mode to be switched on. In this case, the UBR-01 answers for the slave devices on the service to the Who-Is automatic detection of devices on the BACnet network Enable auto slave discovery Choose the automatic determination slave on / off. Please note that it can take up to seconds, until all slave nodes are detected for the first time (depending on the baud rate) Save Button Temporarily saves the changes made in this page. Changed configurations require activation Add Manual Slave Address Binding Known addresses of slave devices (MAC address) in the MS / TP network can be entered here. Please specify the device instance number (device ID) and the MAC address in the MS / TP network and select the "Add" button. The device numbers are entered in decimal format List of Manual Slave Address Bindings Here you will find the list of currently manually configured slave nodes. Select one or more nodes and select the "Remove" to delete one or more entries. The list of bindings in the manual slave address contains a max. of 30 units. If you use the automatic address binding, you can use the max. number of slaves. 34

35 8.7 Submenu Ethernet This page provides the settings for BACnet/Ethernet (ISO Type 1 on ISO ) Network Number Setup the network number for your local BACnet/Ethernet network here. This number shall be unique within the entire BACnet network. The value range of this property is 1 to Save Button Temporarily saves the changes made in this page. Changed configurations require activation. 35

36 9 Main Menu Diagnostics This menu provides diagnostics functions which are useful in the process of installation and configuration of UBR-01 in a BACnet network. The Diagnostics page provides different levels of diagnostics. 9.1 Submenu Verbose This menu allows creation of a Logfile for diagnosis. Error-Logfile: This file basically contains information about errors, which occurred while operating. The file may be watched by clicking here in the first text line. If certain verbose levels are set, additional verbose information is provided in the logfile. To save the files to your local hard-disk, right-click to here and choose save as. 36

37 9.2 Submenu Restart This page provides a restart of UBR-01. Click the Restart button to restart UBR-01, the process of restart takes approx. 25s. 37

38 9.3 Submenu Ping This page allows issuing a ping command from UBR-01. The ping command is used to test the IP-connection between two IPnodes in an IT network. Please note that in some networks, the ICMP-protocol transporting the ping-commands may be blocked by IT-routers, so you will likely not succeed in accessing the destination node using ping outside the local sub-network where UBR-01 is installed. If in doubt, ask the IT-administrator for assistance. 38

39 If errors occur in issuing the ping command (e.g. if an invalid address was issued), the error message is displayed. 39

40 10 Main Menu Backup The backup menu provides the capability to download a backup file or to restore (upload) a backup-file to or from UBR Submenu Backup The backup-file may be saved to your local hard-drive by clicking here in the text line. The backup-file is a simple text file, which allows easy modification for experienced users. Please note to keep all file-entries, removing tags from the file may cause serious malfunction. Please note that factory and project documents cannot be backed-up or restored using this function. 40

41 10.2 Submenu Restore To upload a backup-file to restore the configuration locate the backup-file on your local hard-disk and click the Restore-button. After restoring the configuration, the configurations needs to be activated. The backup-file is a simple text file, which allows easy modification for experienced users. Please note to keep all entries, removing tags from the file may cause malfunction. Please make sure, to only restore valid backup-files, restoring other text-files may cause serious malfunction. Please note that factory and project documents cannot be backed-up or restored. 41

42 10.3 Submenu Last Config This function restores the last configuration and is intended to be a last resort before restoring the factory default in case, the configuration changes caused malfunctions. Please note that factory and project documents cannot be backed-up or restored. 42

43 11 Main Menu Passwords The passwords menu allows changing the passwords for the user and admin users. Changing passwords require admin or factory rights, guest and user cannot change the passwords Submenu User In this dialog the user password may be changed. The default password is user. Enter the new password and confirm the new password. 43

44 11.2 Submenu Admin In this dialog the admin password may be changed. The default password is admin. Enter the old password, the new password and confirm the new password. 44

45 12 Main Menu Maintenance The Maintenance-Menu is reserved for factory access and is disabled in guest-, user- and admin-mode. Factory users may upload firmware updates to UBR-01. The file name of update files is update.ugw. Do not try to upload other files than provided by the MBS support using the firmware update function. This may cause serious problems or malfunction. 45

46 13 Main Menu Activate Press the button Activate and Restart to reboot UBR-01 and to permanently activate the configuration. Press the button Cancel to discard the configuration changes. Please note that all changes of the configuration are temporary unless activated. 46

47 14 Main Menu Help The help menu provides information for support and allows access to factory and project documents. This menu allows uploading documents to the factory or project directory or manage language packs. Please note that documents, which are removed from the web-server are permanently lost! These files are not backedup or restored by a factory-reset Submenu Factory Manuals This page shows all available factory manuals provided by the webserver. The available space for factory manuals is 150MB. Simply click to the manual or file, you want to display on your local PC. 47

48 If you want to copy the file to your local hard-disk, right-click to the file and choose save as. If you want to permanently remove files from the web-server, check the file(s) and click the Remove -button. 48

49 14.2 Submenu Project Manuals This page works exactly the same way as the factory manuals page, except it is intended to store project documentations, manuals or simply leave messages in text-files for other technicians. The available space for project manuals is 50MB. 49

50 14.3 Submenu Language Pack UBR-01 supports multiple languages by adding so-called languagepacks. Language-packs are binary files providing the text-translation for the designated language. Language packs are identified by the international abbreviation for the language according to ISO 639-1, e.g. en for English language, de for German language, fr for French language. To upload a language pack, select the language file on your local hard-disk and click the Upload -button. To remove language packs, check the languages to be removed and click to the Remove -button. Please note that the files will be permanently removed and will not be restored by a factory reset! 50

51 14.4 Submenu Support This page provides information how and where to retrieve support. This is mostly intended for OEM purpose to identify the address information about the product and project support. Der in diesem Fenster anzuzeigende Text kann mit Hilfe eines FTP- Zugriffs als Textdatei auf den Webserver geladen werden, bei Bedarf sprechen Sie bitte den MBS-Support an. 51

52 14.5 Submenu About This page shows copyright and version information about UBR-01. The firmware revision (FW-Revision) is additionally shown in the BACnet Device-Object of UBR

53 Annex Location of the BACnet Device Object 53

54 15 Location of the BACnet Device Object In router applications the Device Object of the Router can only reside at one of the supported media (without using Virtual Networks). In UBR-01 the Device Object resides at the MS/TP layer. As usual in routing applications, the BACnet network layer (ISO/OSI layer 3) is always involved in the BACnet telegrams. The following picture shows a telegram example with support of network layer 3 (I-Am telegram from network number 2, in this configuration MS/TP). This picture was taken using VTS (Visual Test Shell). This free BACnet software can be downloaded from: 54

55

56 MBS GmbH Römerstrasse 15 D Krefeld [Geben Sie ein Zitat aus dem