Getting Started
Installation
Installing Spyder tool in Soft JACE - Installer EXE Method
- Install Java Runtime Environment (JRE) v1.6 on your system, if not installed already as
the installer program requires JRE 1.6.
- Stop all running stations and close the workbench. Close any other application accessing
the jar files from the NiagaraHome\modules folder.
- Browse to the location of the release folder of the tool.
- You will find the Installer file called LonBacnetInstaller<versionNo>.exe.
- Double click the installer executable file.
- License agreement screen appears, read the
license agreement and accept it to proceed with the tool installation.
- An installation screen appears. The installer detects the current NiagaraHome path and
displays it on the screen. If there are more than one Niagara versions installed, the
installer picks the higher version. You can change the path to install the jar files using
the Browse button next to the WEBs-N4 Home option.
- Click Install for the Installer to start the Installation. The
installer installs the required jar files in the Niagara modules folder. As the
installation proceeds, the installation status is displayed. After the installation is
complete, Install Status text in the screen changes to Installation
complete and the progress bar indicates 100% completion.
- Please see the Installation instructions section in the SRB for more details on
the installation procedure.
Note: Existing applications created with versions earlier than 4.xx of the
tool need to be migrated using Spyder Migration tool to be compatible with the
current version of the tool. See Using Spyder Migration Utility section for
information on the migration procedure
Upgrading Hard JACE
You must stop the station running on the JACE and start the workbench before you start
upgrading the hard JACE.
- Select the dist_JACE_Lon_Bacnet_Spyder.dist file.
- Run the file using Niagara Platforms Distribution File Installer
option. The Distribution File Installer installs the required modules in the JACE.
From this release, the following .jar files alone are required:
- honeywellSpyderTool.jar
- docHoneywellSpyder.jar
- honeywellLonSpyder.jar
- honeywellBacnetSpyder.jar
- genericUIFramework.jar
- wsVavBalancer.jar
- wsStdLonDeviceTemplates.jar
- honeywellSpyderMigrator.jar
- airFlowBalancer.jar
To free up JACE memory, old, unused .jar files such as the following can be
deleted:
- flowBalancer.jar
- docFlowBalancer.jar
- niagaraDynamicBean.jar
- wsAppliance.jar
- wsBacnetChannel.jar
- wsCommon.jar
- wsDeviceMgmt.jar
- wsLonChannel.jar
- wsValidationFw.jar
- wsStdBACNetDevTemplates.jar
- lonSpyderTemplates.jar
Note: Existing applications created with earlier versions of the tool need
to be migrated using Spyder Migration tool to be compatible with the current version of
the tool.
After installing the new tool version in the JACE, you can migrate the existing Spyder
applications in the JACE using the following procedure.
- Copy the station running in the JACE to your local PC using the Station Copier
option available in the Platform options of the JACE.
- Migrate the copied JACE station using the Spyder Migrator tool. See Using Spyder
Migration Utility section for information on Spyder Migration tool.
- Copy the migrated station back to the JACE using the Station Copier
option and restart the JACE.
Using Spyder Migration Utility
Use the honeywellSpyderMigrator.jar to run the migration utility.
To migrate the existing applications:
- Launch the workbench after installing the migration tool through the dist file.
- Browse to the migration utility on the main menu of the workbench.
- Click the migration utility option from the list. The tool allows you to migrate various
types of databases.
- Select the File Type and then select the Niagara Home Directory
where that particular database is stored. The tool automatically lists all the
files of the selected file type available in the directory, as shown in the screenshot.
- Select the files to be migrated and click Migrate.
- Once the migration is completed, click Close to close the migration
utility window.
The tool automatically moves the selected existing stations to a folder called LegacyStations.
The migrated Stations are given the actual station name so that they are ready to be used.
Similarly, the tool moves the existing Lexicon files to a folder called LegacyLexicons
and it renames the migrated Lexicon files with the names of existing files.
For other file types, you can choose the Output directory where you
want the migrated databases to be stored. By default the tool stores them in a folder by
name Migrated<FileType> where FileType is the file type that you
have selected for migration. This new directory is created under the input directory.
For example, if the file type selected for migration is of type SpyderLibrary, and the
existing library is available in the location C:/Library, then the migrated libraries are
stored in C:/Library/MigratedLibraries.
Note:
If you are a first time user, follow the procedures to Launch the
workbench, Add new station, Start the station, Add a network, and Add a controller.
If you are an existing user and would like to migrate from an existing
Spyder controller to a new Spyder controller, see the Migration section.
Launching the Workbench
Click Start > Programs > Niagara
> Workbench to launch the workbench.
Adding New Station
On the Workbench:
- Click Tools > New Station. The New Station
Wizard appears.
- Type the Station Name.
- The Station Directory path is updated with the name you just entered
and displays the location where the files are stored. Click Next.
- Type a password in the Admin Password field.
- Re-type the same password in the Admin Password Confirm field.
- Click Finish to complete adding a station. The station is added and the
Property Sheet of the station is displayed on the right portion of your
screen.
Starting the Station
Once you have added a station, you must start it to begin using it. To
start a station:
- On the Nav palette, click Platform. The Authentication
dialog box appears.
Note: If the Nav palette is not visible on the left pane, from the Menu
bar, select Window > Sidebars > Nav to
display the Nav palette.
- Type the User Name, Password, and click OK.
The right portion of your screen displays a list of object names and their description.
- Double-click Application Director. The list of available stations
appears.
- Select the station you have added and click Start. The station you have
added appears in the Nav palette under Platform.
- Double-click the Station option on the Nav palette.
The Authentication dialog box appears.
- Type the User Name and Password and click OK.
The Station you have added is launched and the Station Summary Property view
appears on the right portion of your screen.
Adding a Network
To add a Lon Network:
- Click Windows > Side Bars > Palette to
add the palette named Palette if it is not visible on the left pane.
- Click the Open Palette button on the Palette.
The Open Palette dialog box appears.
- Select Lonworks from the list if available and click OK.
or
Click Browse and select the location this folder is stored and click OK.
- Expand Config in the Nav palette to display Drivers.
- Select LonNetwork from the Palette and drag it on Drivers
in the Nav Palette.
- Type a name for the Lon Network you are adding and click OK.
Expand Drivers and verify to see that the Lon Network is added.
To add a BACnet Network:
- Click Windows > Side Bars > Palette to add
the palette named Palette if it is not visible on the left pane.
- Click the Open Palette button on the Palette.
The Open Palette dialog box appears.
- Select bacnet from the list if available and
click OK.
or
Click Browse and select the location this folder is stored and click OK.
- Expand Config in the Nav palette
to display Drivers.
- Select BacnetNetwork from the Palette and
drag it on Drivers in the Nav Palette.
- Type a name for the BACnet Network you are adding and click OK.
Expand Drivers and verify to see that the BACnet Network is added.
Adding a Controller
To add a Honeywell Spyder controller:
- Click the Open Palette button on the Palette.
The Open Palette dialog box appears.
- Select honeywellSpyderTool from the list if available and click OK.
or
Click Browse and select the location this folder is stored and click OK.
- Select LonSpyder from the Palette and
drag it on Lon Network under Drivers in the Nav palette.
or
Select BacnetSpyder from the Palette and drag it on BacnetNetwork
under Drivers in the Nav palette.
- Type a name for the device you are adding and click OK.
Expand Lon Network or Bacnet Network and verify to see that the device is
added.
Viewing or Modifying Controller Summary Details
To view or modify the summary details of the LonSpyder controller:
- Double-click the device name in the Nav palette to display the Controller
Summary View on the right portion of your screen.
Device Name is an editable field.
- Click the drop-down menu to select a Device Model from the list.
- Select Enable Daylight Savings option and specify the following
information when the day light savings must come into effect:
- Start Month
- End Month
- Start Day
- End Day
- Click Save to save the changes made to the Controller Summary
View.
To view or modify the summary details of the BacnetSpyder
controller:
- Double-click the device name in the Nav palette
to display the Controller Summary View
on the right portion of your screen.
Device Name is an editable field.
- Click the drop-down menu to select a Device Model
from the list.
- Click the Set button to change the Global
Update Rate.
Note: Setting the Global Update Rate changes all the individual update
rates including the update rates for Network Input points, Analog Outputs, Binary Outputs
that are enabled for Fail Detect. Global Update Rate has a default value of 60 seconds.
The value can range from 0-3600 seconds.
- Click the Set button to change the Global
Send Heart Beat.
Note: Global Send Heart Beat is set at the device level and the changes
made to this value is applied automatically to all the objects. Global Send Heart Beat has
a default value of 60 seconds. The value can range from 0-3600 seconds.
- Select Enable Daylight Savings option and specify
the following information when the day light savings must come into effect:
- Start Month
- End Month
- Start Day
- End Day
- Click Save to save the changes made to the Controller
Summary View.
Migration
From Spyder II to Spyder Micro
If you want to migrate from any of the earlier LonSpyder models,
that is,
Spyder I (PVL6436A, PVL6438N, or PUL6438) and
Spyder II ( PVL6436AS, PVL6438NS,
or PUL6438S) to the latest Lon models supported by Spyder, that is Spyder Micro
(PVL4024NS, PVL4022AS, PUL4024S, PUL1012S, or PVL0000AS), do the following:
- Replace the existing Spyder controller in the field (could be any
one of
the Spyder I or
Spyder II models) with the new Spyder Micro controller.
- Right-click the Lon network in the Nav palette of
the Spyder tool.
- Select Views > Lon Device
Manager. The list of controllers is displayed on the right portion of the screen.
- Select the controller from the list and click Discover. The device
appears under Discovered on the top portion of the screen.
- Select the controller under Discovered and click Add to
add the controller.
- Click OK.
- Click Match to match the neuron id of the field controller with the
device in station.
- Select the new model you are migrating to in the Controller
Summary View (right-click device in the Nav palette and choose Views
> Controller Summary View).
- Load an application from the Spyder library.
- Download the configuration to the new Spyder Micro controller
model by right-clicking the device and selecting Actions > Download.
From LonSpyder to BacnetSpyder
If you want to migrate from any of the LonSpyder models (
Spyder I,
Spyder II, or Spyder Micro) to the Bacnet models (PVB6436AS, PVB6438NS, or PUB6438S)
supported by Spyder, do the following:
- Replace the existing LonSpyder controller in the field (could be
any one of
the Spyder I,
Spyder II, or Spyder Micro models) with the new
BacnetSpyder controller.
- Right-click the Bacnet network in the Nav palette
of the Spyder tool.
- Select Views > Bacnet Device
Manager. The list of controllers is displayed on the right portion of the screen.
- Select the controller from the list and click Discover. The device
appears under Discovered on the top portion of the screen.
- Select the controller under Discovered and click Add to
add the controller.
- Click OK.
- Click Match to match the neuron id of the field controller with the
device in station.
- Select the new model you are migrating to in the Controller
Summary View (right-click device in the Nav palette and choose Views
> Controller Summary View).
- Load an application from the Spyder library.
- Download the configuration to the new Spyder Micro controller
model by right-clicking the device and selecting Actions > Download.
You can use Bacnet Spyder in one of the following ways.
- Create a new application in the BacnetSpyder controller.
- Convert an existing Lon Application to corresponding Bacnet application.
To create a Bacnet Spyder application:
- Drag a BacnetSpyder device to the station under a Bacnet Network.
- Double-click the device you have added and right-click on it to choose Views
> Controller Summary View.
- Select a model from the list.
- Browse to the ControlProgram of the BacnetSpyder device.
- Drag the required objects from honeywellSpyderTool palette and create an application.
- Browse to Bacnet Device Manager view on Bacnet Network and discover the
online Bacnet Spyder devices.
- Match the device in Niagara to appropriate discovered device.
Note: Alternately, instead of creating an application you can load a
suitable application from Spyder library or from Standard Applications Library in palette.
- Download the configuration to the online device using Download option on the device.
To use an existing Lon Application in a BacnetSpyder device:
- Drag a BacnetSpyder device to the station under a Bacnet Network.
- Double-click the device you have added and right-click on it to choose Views
> Controller Summary View.
- Select a model from the list.
- Browse to the ControlProgram of the BacnetSpyder device.
- Drag an existing Lon Application from Spyder Library to the Control Program under the
BacnetSpyder device. The tool automatically creates a Bacnet interface for the Lon
application. ( If it is an application in library, the tool would have automatically
created the Bacnet interface in library ). Review the Bacnet interface that the tool has
created and make necessary changes, if any.
- Browse to Bacnet Device Manager view on Bacnet Network and discover the
online Bacnet Spyder devices.
- Match the device in Niagara to appropriate discovered device
- Download the configuration to the online device using Download option
on the device.
From Conventional wall module to SBus wall
module
If you want to replace the existing conventional wall module
(T7770) with the SBus wall module, do the following:
- Replace the existing Spyder controller in the field
(could be any of LonSpyder I models: PVL6436A, PVL6438N, or PUL6438 )
with a new LonSpyderII, or Spyder
Micro, or BacnetSpyder controller.
- Right-click the Lon or Bacnet network in the Nav palette
of the Spyder tool.
- Select Views > Lon Device
Manager or Bacnet Device Manager. The list of controllers is
displayed on the right portion of the screen.
- Select the controller from the list and click Discover. The device
appears under Discovered on the top portion of the screen.
- Select the controller under Discovered and click Add to
add the controller.
- Click OK.
- Click Match to match the neuron id of the field controller with the
device in station.
- Select the new model you are migrating to in the Controller
Summary View (right-click device in the Nav palette and choose Views
> Controller Summary).
- Download the configuration to the new Spyder controller model.
- Replace the existing wall module model to any one of the SBus wall
module models (same as hardware attached).
- Drag the ConventionalWallModule function block
from the Palette onto the wiresheet of the controller.
- Right-click the conventional wall module block and select Configure
Properties. The General Settings dialog box appears.
- Select LCD Display under Model Options
on the dialog box. This changes the wall module selection from Conventional to S-Bus wall
module.
- Make appropriate links in the wire sheet of the application logic
where the wall module is being used.
- Download the configuration to the controller.
Note: Make sure that the SBusWallModule should be assigned the same
address using rotatory Address switch as defined in the SBus wall module function block in
Station.
Programming the Honeywell Spyder
The Honeywell Spyder Tool offers a graphical environment to program the Honeywell
Spyder controller. You can use the wiresheet view in the Engineering
Mode to use Physical points, Software points, and function blocks to build an application
in the ControlProgram. The Physical points, Software points, and function blocks can be
accessed using the Palette. You can drag these items on to the wiresheet and connect them,
based on your need, to develop your application logic. The logic that you create
can then be stored in a Spyder Library for reuse. Once you are satisfied with the logic
you have created, you can download the same to the controller. The logic thus created can
be tested for correctness using the Simulation and Online Debugging modes.
Note: Changing NCI values, configuration of a Schedule block, or Daylight
savings option, puts the application in a quick download pending state. As long as the
application has been downloaded atleast once to the controller, these changes only trigger
a quick download to the controller.
Use the ControlProgram option to program the Honeywell Spyder tool. To do this:
- Expand LonSpyder or BacnetSpyder in the Nav palette
and double-click ControlProgram to display the Wiresheet view.
- Display the Palette (From the Menu bar, select Window
> Sidebars > Palette to display the Palette).
The Palette appears on the left pane with the following items:
- Physical Points: Modulating and Binary Inputs or Outputs.
- SoftwarePoints: Software Input or Output. Use this to create NVI, NCI,
NVO, Network Input, Network Setpoints, or Network Output.
- Analog: Analog function blocks
- Logic: Logic function blocks
- Math: Math function blocks
- Control: Control function blocks
- DataFunction: Data Function function blocks
- ZoneArbitration: Zone Arbitration function blocks
- BuiltIn: BuiltIn function blocks
- Macro: A Macro is a group of functional blocks grouped together that
define a specific functionality. Commonly used program elements can be defined as macros
so that they could be reused across applications.
- Application: This includes macros and logic that you can define and use
in applications.
- StandardApplications: Standard applications shipped by Honeywell which
you can use to build application logic
You can drag any of these items on to the wiresheet of a ControlProgram in its
Engineering Mode and make the connections between Physical points, Software points, and
function blocks to create a ControlProgram or an Application.
Use this wiresheet view to drag the Physical points and Function blocks to build your
application logic. You can save a logic you created to be used later and also share it
with other users.You can build several applications and store them in a Spyder Library
along with Honeywell supplied standard applications.
Downloading Application Logic
After you have created your application logic and tested the
logic using the simulation feature, you can download the application logic to the
controller. To download the application logic:
- On the Nav palette, right-click the device and
select Actions > Download. The Download dialog
box appears.
- Select True under Full Download for
a full download or False for a quick download.
Note: A Quick Download only downloads the modified items from a previous
download where as with a Full Download the entire configuration is downloaded to the
controller replacing the existing configuration. However, if changes have been made to the
SBus wall module by an operator/tenant locally from the display on the wall module, and a
full download is performed, Spyder tool downloads the entire configuration to the
controller except the SBus wall module configuration. This is done to avoid losing any
changes made locally on the SBus wall module during a download operation.
- Click OK. The application logic is downloaded to
the controller based on your selection.
Note: Make sure that if you are using the SBus wall module or the ignore
invalid option for function blocks , the models selected are LonSpyder II, Spyder Micro,
or BacnetSpyder.
SBus wall module cannot be downloaded to the LonSpyder I models.
When using Spyder II, Spyder Micro, or BacnetSpyder models, if
you modify SBus wall module settings from the display in the wall module, you can also
upload the same configuration into the Spyder tool.
Updating Modules
Follow this procedure to install updates of Standard Applications. The StandardApps.jar
file that you receive, needs to be installed to begin using the latest Standard
Applications provided.
- Connect to the platform of the station.
- Browse to File transfer Client and transfer the StandardApps.jar
file from the local drive to the modules folder of the Station.
- Restart the workbench or webworkbench.
- Expand StandardApplications in the Spyder palette. The
latest Standard Applications are displayed.
Creating Custom Palette File