Table of Contents
0
Part I Introduction 5
1 About ...................................................................................................................................
Exporer 5
2 System...................................................................................................................................
Requirements 5
3
4 BACnet Explorer Help
1 Links...................................................................................................................................
to BACnet Resources 60
2 License
...................................................................................................................................
Agreement 61
Index 0
1 Introduction
With BACnet Explorer, you can see the whole system, without pre-configuring of any kind! You can see
all the BACnet compatible devices on connected networks, in one tree-structured, interactive, user-
friendly display. With this software tool, physically connected at the site via an Ethernet adapter, you
can discover the devices, via the broadcast (and other) Who-Is service, on all networks or a specified
network. Dynamic discovery can be limited to specific networks to minimize the amount of traffic. You
can request or set property values of any BACnet device. You can save devices, objects and property
values of devices to a file, for later off-line redisplay, printout, or comparison.
The BACnet Explorer uses the familiar tree-structured, two-panel model of the Windows Explorer.
Clicking on any item opens it a level for further browsing. A right-mouse-button menu of operations is
available, tailored for each item in the system. E.g: Auto-read at open, Re-read and Write Property,
Refresh all objects and any device, Add Device (objects and properties), and Hide/Unhide.
Explorer version with ads and without support is free. If you would like the version without ads + one year
support please purchase a software license for $199.
Licensing: Within the program go to Help - Buy License and follow purchasing instructions. When you
get the license just place it in the \Cimetrics\Cimetrics BACnet Explorer directory.
Upgrade: To upgrade to a newer version please uninstall an existing version of Explorer. If you are
updating an existing version to a new release just run an installer. E.g. Explorer V.4. will have a release
V4.1, V4.2. You can check for a new release or version on our website www.cimetrics.com.
2.2 Licensing
If you purchased a paid version of an Explorer which does not have ads and has one year support you
will get a software key. In order for the application to run in a licensed mode, you will need to have a
software license placed in BACnet Explorer folder or you will see ads. The free version does not provide
any support. You can use BACnet Explorer forum for filing bugs/suggestions/requests.
LOCKING MECHANISM:
1) Soft license file - this is a small file which is also emailed to you when you purchase the software.
Send us the "machine code" listed on the popup screen and we will create the license file and email this
to you. This file is loaded into the main Explorer folder (same location as described above). The
advantage of this option is that there is no shipment delay or expense. The "limitation" of this is that
the license will only work on ONE computer and cannot be moved (it looks to match the "machine code"
that was supplied to us).
Configure BACstac to work with BACnet/IP interface. Within a BACnet Explorer go to Tools - Settings
BACnet Protocol configuration
Add new BACnet/IP connection choose your Network Interface Card in the Adapter:
Leave port number default 1. Change UDP port if needed to match the one on your network. Click ok and
restart BACstac.
If your IP address changes during your BACnet Explorer running you would need to run a BACnet
Protocol Configurator and restart BACnet Explorer.
Within a BACnet Explorer go to Tools - Settings BACnet Protocol configuration. Navigate on the port
you want to edit and click on Edit. Click on BBMD tab
Check BACnet Broadcast Management Device and put an IP address of the BBMDs you would like to
maintain in your BBMD table.
You can also enable Foreign Device Table or NAT Global Address.
A "foreign" device is a BACnet device that has an IP subnet address different from those comprising the
BACnet/IP network which the device seeks to join. The foreign device may be a full-time node on the
foreign subnet or may be a part-time participant, as would be the case if the device accessed the
internet via a SLIP or PPP connection. More on that in this tutorial.
Within a BACnet Explorer go to Tools - Settings BACnet Protocol configuration - Edit - Foreign Device
tab
Check the Foreign Device and put the IP of the remote BBMD to which you want your foreign device to
get attached.
If BACstac resumes its' service while BACnet Explorer is running (BACstac will be restarted) then
the Explorer will start working in a full mode and will have a similar message on the panel:
3 Using Explorer
3.1 Overview
The program interface allows you to view data and perform various actions with discovered devices. Start
of discovering devices happens automatically at start of the program. Successively clicking on tree
nodes or on left table nodes will perform dynamic discovery on a connected site.
Main Menu
File
Open - Opens an existing treeview file.Use this command to open an existing treeview file.
Save As - Saves an opened treeview file to a specified file name (XML or CSV format). Use this
command to save and name the active treeview file. BACnet Explorer displays the Save As dialog box
so you can choose a name and a specific format for your document. BACnet Explorer saves and opens
files in XML format.
Exit - Exits Cimetrics BACnet Explorer. Use this command to end your BACnet Explorer session. You
can also use the Close dialog box on the application System menu. BACnet Explorer prompts you to
save your document if it has any unsaved changes.
Actions
Add Object - Creates a new object. Use this command to create a new object within a device. You
specify an Object type and Object Instance (make sure the Object Instance is a unique number within
the device
Tools
APDU settings Set and save to file configuration APDU Properties settings.
Find device settings Set and save to file configuration found device settings.
Common settings Show of common informations on the working computer and Set default Priority for
writable properties.
Toolbar Panel
The Tool bar panel consists of:
1. Refresh All results-
7. Saves an opened document to a specified file name (XMl or CSV format), equal to Main menu-
>File->Save As-
9. Filter On/Off, for more information about filtration please see Filtration section
10. Write Property, use this action for writing selected property (Only for Enumerated property type)
-
When you use Write Property for complex properties (DateTime, Object Identifier etc.) you have to use a
dialogue box which opens by the special button. It simplifies input correctly of new values.
11. Device Object On/Off (equal to Main menu->Actions->Simple Device Object). Start/Stop BACnet
Device Object server -
Help
Help Topics - Offers you an index to topics on which you can get help.
About - Displays the version number of this application.
Buy License - Information on how to purchase a paid version without ads.'Cimetrics BACnet Explorer
Forum'
Cimetrics BACnet Explorer Forum - link to the forum where you can ask any questions about the
Explorer, report bug or make a suggestion for useful features in the upcoming version.
Almost every element of the interface has a context-sensitive menu that can be invoked by clicking on
the right mouse button, and many commands are available only through these menus.
You can search for duplicated devices Tools - Search for Duplicated devices
Use this command to open an existing document. BACnet Explorer prompts you to save your current
document if it has any unsaved changes. You can instead create new documents with the New
command if what you want is not an existing document.
Shortcuts:
Toolbar:
Use this command to save and name the active document. BACnet Explorer displays the Save As
dialog box so you can name your document.
Shortcuts
Toolbar:
Use this command to end your BACnet Explorer session. You can also use the Close on the
application System menu. BACnet Explorer prompts you to save your document if it has any unsaved
changes.
Shortcuts:
Use this command to create a new network in BACnet Explorer. You specify the network number -
make sure it's a unique number on a global internetwork. If you would like BACnet Explorer
automatically discover devices on this network when it starts check Auto-discover at Open check box.
Use this command to create a new device on a network. You specify the Device ID - make sure it's a
unique number on a network. If you would like BACnet Explorer read this device after it is created check
Auto-discover at Open check box. In MAC address box specify MAC address in hexadecimal - make
sure it's a unique number on a network. If you would like BACnet Explorer to look for this device on a
remote network check Attempt to Find on Remote Networks box.
Use this command to create a new object within a device. You specify an Object type and Object
Instance (make sure an Object Instance is a unique number within a device). If you would like BACnet
Explorer to read this object after it is created check Auto-discover at Open check box.
Use this command to create a new property within an object. You specify the Property ID, property Data
type, Structure type and Property Value. If you would like BACnet Explorer to read this property after it
is created check Auto-read check box.
3.5 Toolbar
The toolbar is displayed across the top of the application window, below the menu bar. The toolbar
provides quick mouse access to many tools used in BACnet Explorer.
Click To
------------------------------------------------------------------------------------------------------------
Re-read network or device or object or property.
Use filtering.
Use this command to display the opening screen of Help. From the opening screen, you can jump to
step-by-step instructions for using BACnet Explorer and various types of reference information.
Help Index - Offers you an index to topics on which you can get help.
Buy License - Information on how to purchase a paid version without ads.'Cimetrics BACnet Explorer
Forum'
Cimetrics BACnet Explorer Forum - link to the forum where you can ask any questions about the
Explorer, report bug or make a suggestion for useful features in the upcoming version.
Send Us Feedback - Information Form you can use to send us feedback/suggestions and we will get
back to you as soon as possible!
3.7 Examples
Scenarios of working with BACnet Explorer:
The first and foremost purpose of BACnet Explorer is to capture the information for an existing site.
Successively double-clicking on nodes or repeatedly pressing the right arrow key will perform dynamic
discovery on a connected site. When you have discovered all the portions of a site of interest, the Save
As command makes it easy to write all the information to hard disk for persistent use later. Each new
site in BACnet Explorer starts out with the name "Untitled." The first time you Save As function, choose
a name for the hard disk file which corresponds with the site or portion of the site that is meaningful to
you.
Comparing a site with its previously saved information is facilitated by BACnet Explorer. The first time
you Save you choose a name which is meaningful to you for referring to the site. In future visits when
you want to compare the information, you can load the site file that has already been stored, but be sure
that you invoke Save As immediately so that you are working with a file whose name represents the
information now, as contrasted with the information then.
Use a file difference utility to display and highlight the differences between the prior and current files. You
can iteratively use discovery or re-read and Save As to update the current file in various ways and repeat
the difference display.
When you arrive at a new site, but one with resembles another that you have previously stored, you need
not start from scratch. Load the site file that has already been stored, but be sure that you invoke Save
As immediately so that you are working with a file whose name represents the information now at the
new site, as contrasted with the name for the file from the prior site which still holds the information
captured then. Note that BACnet Explorer does not dynamically update the display with information as it
exists at the new site, and will only update the display to match the reality for those nodes on which you
invoke the re-read, auto-read or re-discovery. This saves you time obviating the need for communication
with portions of the network about which you do not care. But for those portions about which you do
care, be sure to invoke re-read to insure you are looking at current information.
4 Info Panel
You can use Search fields for searching network, devices or objects in the tree-
Tree view panel has a context pop-up menu, which depends on type of the selected items:
For selected network-
The right panel has a context pop-up menu which depends on the types of the displayed items:
If Double click on the Table with properties then will be shown a field contains property value(for big
property value)-
The right panel may contain various images which describe the found characteristics for items (rows) of
the table or operation to made over items from the table. For more details and explanations use indicator
in Status Bar panel.
If the property is checked then when you click on it BACnet Explorer will automatically re-read this
property. If the value of the property has changed after re-read then it will show you in Italic.
If you perform Write Property on any property in an object then all the properties of this object will be re-
read (if the re-read values has changed then they will be shown in italic).
When you perform Relinquish Default then Priority Array will be re-read. Here is an example:
For more information about states of items in the tree and tables please see of ANNEX A STATES of
ITEMS
You can use Object Filter list box for filtration objects in the tree-
For closing of " Filter Panel Show/Hide " panel it is possible to use the button or click on any line in
tables or a tree.
For a choice of operations AND or OR it is possible to use click in the field with an operation badge
( ->click -> ).
For a task of use of brackets in the rule of a filtration, the button is used.
Fields with a choice for rules of a filtration are strictly above the corresponding fields in the lower table.
After opening of the Filter Panel Show/Hide panel, it is necessary to set rules of a filtration. Three fields
are for this purpose used -
2. Device Name
3. Vendor Name
The user has to set values in one or more of three fields. Fields can join or be excluded in the rule for a
filtration. For an exception of value of a field it is necessary to make a double click in the field, (the field
with an exception has the Strikeout font).
After a task of the rule it is possible to close simply the Filter Panel Show/Hide panel (in this case for
activation of the filter it will be necessary to use " Filter On/Off " function), to use button.
After a task of the rule it is possible to activate the filter immediately, to use button.
To cancel the filter, use the " Filter On/Off " function.
Objects
After opening the Filter Panel Show/Hide panel it is necessary to set filtration rules. Three fields are
used for this purpose -
2. Object identifier(Obj.Id)
3. Object Name(Obj.Name)
The user has to set values in one or more of three fields. Fields can join or be excluded in the rule for a
filtration. For an exception of value of a field it is necessary to make a double click in the field (the field
with an exception has the Strikeout font). For Obj.Type filed Enter a key is used.
After a task of the rule it is possible to close simply the Filter Panel Show/Hide panel (in this case for
activation of the filter it will be necessary to use " Filter On/Off " function), to use button.
After a task of the rule it is possible to activate the filter immediately, to use button.
For cancellation of the filter it is possible to use the " Filter On/Off " function.
Properties
After opening the Filter Panel Show/Hide panel it is necessary to set filtration rules. One field is used
for this purpose Property Name.
The field used for Property Name values is the Checked List Box type.
Fields can be joined or excluded in the filtration rule. For inverting the value of a field it is necessary to
click Enter in the field (the field with the inversion is displayed in Strikeout font).
After creating the rule it is possible to simply close the Filter Panel Show/Hide panel using the
button (in this case to reactivate the filter it will be necessary to use the "Filter On/Off " function).
For cancellation of the filter use the "Filter On/Off " function.
5.2 Sorting
Sorting of tables according to columns
For sorting of tables according to columns, click the mouse button on the heading of the desired
column.
or
The Device Object On/Off function is equivalent to the Main menu->Actions->Simple Device Object. To
Start or Stop the BACnet Device Object server, use the following functions -
Device Object Settings. To set BACnet Device Object settings, use the following functions-
7 Icons descriptions
When you perform operations with devices, objects and properties you will see different status icons.
Here is the description of what they mean:
Tree:
- state for items with items (device, object) which have been Added;
- state for items whose status is undefined;
- state for items whose status is OK;
- state for items whose status is Not OK ;
- state for items (device, object, property) which have been Added;
- state for items in the Selected state (for more operations on the item);
- state for items in the ReReadOk state (the ReRead property for the selected item is in the
OK state);
- state for items in the ReReadNo state (the ReRead property for the selected item is in the
No|Error state);
- state for items in the WriteOk state (the Write property for the selected item is in the OK
state);
- state for items in the WriteNo state (the Write property for the selected item is in the No|
Error state);
- state for items which have been Edited (Selected property value is edit, without
WriteProperty);
- state for table in the Filter state (The table has been filtered);
- state for items in the Duplicate state (duplicate Device Ids have been found and this is the
first instance found of that Device Id);
- state for items in the Duplicate state (duplicate Device Ids have been found, and this is the
second or subsequent instance of that Device Id found);
8 Writable Properties
Writable properties types :
NULL
Boolean
Unsigned Integer
Signed Integer
Real
Double
Character String
Enumerated
BACnetObjectIdentifier
Date
Time
DateTime
Writable properties :
Present_Value(all objects without Group, Schedule, Credential Data Input, BitString Value, OctetString
Value, Global Group, Channel objects)
9 How to Purchase
To buy a Cimetrics Explorer without ads and with one year of support please do the following:
- Download the free version of Explorer on our site www.cimetrics.com
- Open it and go to Help Buy License
- It will show you a string code. Please copy a string code and email it to purchase@cimetrics.
com. We will generate a license for you and email it to you.
- Put this license in Cimetrics\Cimetrics BACnet Explorer folder (usually located in Program
Files).
10 General Information
NOTE: Check the main help file for BAS-o-matic for General Networking links.
BACnet Information
ASHRAE BACnet Standard 135-2001 - This is a link directly to the ASHRAE web site where you can
purchase the BACnet standard in hard-copy , CD-ROM, or download.
BACnet Testing Lab - The organization that tests BACnet devices for conformance to the standard..
BACnet Interest Groups - List of organizations that facilitates the use of BACnet and holds regular
BACnet training conferences all over the world.
BACnet - European Interest Group - The European group which promotes the use of BACnet and holds
regular training conferences in Europe.
BACnet FAQ - A good frequently asked questions page on the www.bacnet.org web site.
Copyright
This software is copyrighted 2016 by Cimetrics, Inc. BACnet Explorer is a trademark of Cimetrics, Inc..
The use and copyright of this software is governed by international copyright treaties. Cimetrics retains
full title and rights to this software and documentation, and in no way does the license granted diminish
their intellectual property rights. You must not redistribute the registration codes provided-on paper,
electronically, or in any other form.
Disclaimer
THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL CIMETRICS,
INC. BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING INCIDENTAL OR CONSEQUENTIAL
DAMAGES, ARISING OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES. YOU ACKNOWLEDGE THAT YOU HAVE READ THIS LICENSE,
UNDERSTAND IT, AND AGREE TO BE BOUND BY ITS TERMS.
Governing Law
This Agreement will be governed by the laws of the state of Massachusetts, USA.
Distribution
The evaluation version of this software may only be obtained from Cimetrics, Inc or their authorized
agents.
Other Restrictions
You may not modify, reverse engineer, decompile, or disassemble this software in any way, including
Windows is a registered trademark of Microsoft Corporation. All other trademarks and service marks are
the property of their respective owners..
11 Cimetrics Information
uBACstac BACnet Protocol for small devices with or without OS - is is a BACnet protocol stack
designed for the development of low and high volume BACnet-compliant devices with or without OS. It
allows a simple, easy and quick way porting on a new hardware. You can make a device with B-ASC
profile.
uBACstac features:
> Provides a small footprint BACnet stack for small devices with or without OS.
> Implements state-of-the-art MS/TP protocol.
> Provides truly portable codethe same core uBACstac library, the portable MS/TP implementation
and the example application run on all platforms unmodified, including bare-metal uC and embedded
OSs.
> Supports a wide range of processors, from entry level 8-bit AVR to powerful 32-bit ARM7 and Cortex-
M, or even more powerful.
> Makes it possible to implement a device conforming to B-ASC profile.
> Provides the stack in source code form, with example program(s) and reference ports to a few
hardware platforms, both with embedded OS and without OS. Also, for ease of application development,
provides a port to Linux as an "instrumental" platform.
> Implements a modular design, with clean separation between platform-dependent and portable code.
> Includes detailed documentation, including User's Guide and Porting Guide.
> Supports segmentation.
> Implements full BACnet application server functionality and Limited BACnet application client
functionality, sufficient to implement a device matching B-ASC profile: support for RP/RPM/WP/ WPM/
Who-Is/Who-Has/DCC.
> Provides highly configurable source code: unwanted features can be turned off, decreasing the
executable footprint.
BACstac series: Save design time and support costs by using the industry's leading OEM BACnet
protocol stack.
BACnet OPC Server: Enables control and monitoring BACnet devices from any OPC workstation.
BAS-O-matic Protocol Analyzer - Captures and anlyzes Internet and Local Area Network (LAN_ data
traffic.
BR2 Router series: The BR2 router provides routing between BACnet networks such as BACnet/IP,
BACnet ARCNET, BACnet Ethernet, and virtual or tunneled BACnet networks.
E+ series: Inexpensive serial and I/O solutions. Models include BACnet/IP to BACnet Web Services,
Bacnet/IP/WS to Relays and DIN, BACnet/IP/WS to Home Automation, Modbus/TCP to Modbus RTU,
and many more. See our web site for the latest models (www.cimetrics.com).
U+ series - Fieldbus Interface: USB to RS485 interface for BACnet MS/TP or Modbus RTU.
Cimetrics Inc.
support@cimetrics.com
We would prefer email, but if you need to speak to someone immediately call:
+1-617-350-7550
Provide your feedback and publish your requests for the new features on our forum - http://
bacnetexplorer.boards.net/
Thank you !