EISSBox 2a Local Mode Installation Manual

IPKeys Technologies LLC:
Energy Interop™ Server & System (EISS™)
EISSBox 2.0a Local Mode Installation Guide
IPKeys EISSBox is an OpenADR 2.0a-compliant end point that is capable of
receiving demand response (DR) and pricing signals. This document is a
guide on how to setup, install, and trouble shoot the EISSBox.
Prepared by:
IPKeys Technologies LLC
12 Christopher Way, Suite 301
Eatontown, NJ 07724
(732) 389-8112
www.ipkeys.com
August 22, 2014
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
Table of Contents
Table of Contents ...................................................................................................................................... 2 1. Revision History ................................................................................................................................. 2 2. Copyright Notice ................................................................................................................................ 2 3. EISSBox Exterior ............................................................................................................................... 3 4. EISSBox Interior ................................................................................................................................ 3 5. Location for your EISSBox ............................................................................................................... 4 6. EISSBox Installation ......................................................................................................................... 4 Mounting the EISSBox ............................................................................................................................. 4 Connecting the EISSBox to Relays ............................................................................................................ 4 Powering up your EISSBox ....................................................................................................................... 5 7. Troubleshooting after Initial Installation ......................................................................................... 6 9. EISSBox Administration ................................................................................................................... 7 9.1 Installing the Phidget Desktop Application .................................................................................... 7 9.2 Accessing the EISSBox .................................................................................................................... 8 9.3 PhidgetSBC Configuration .............................................................................................................. 9 oadr.properties ................................................................................................................................ 12 1. Revision History
Name
Date
J. Boch
08/22/2014
Reason For Changes
Initial Draft
Version
1.0
2. Copyright Notice
Copyright © 2014 IPKeys Technologies, LLC. All rights reserved. EISS™ is a trademark of
IPKeys. All trademarks, trade names, service marks and logos referenced herein belong to
their respective companies.
Page 2
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
3. EISSBox Exterior
IPKeys manufacturers many kinds of EISSBoxes. They come in a variety of enclosures and
circuit boards. The actual device you have may not match the version shown in the pictures.
The EISSBox assembly consists of an enclosure, a computer, and relays. As shown below
in Figure 1, the EISSBox may also contain indicator lights or buttons on the external
enclosure. The enclosure is held shut with screws. To open the EISSBox, loosen the screws
and remove the cover.
Figure 1. The exterior of the EISSBox
4. EISSBox Interior
There are several components that make up the EISSBox interior. These components
include the main circuit board, shown in Figure 2, and relays. The relays are where the
output signals originate and can be wired with normally open or closed conditions.
Connecting the EISSBox to relays to external hardware will be discussed in further detail
later in this document.
Page 3
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
Figure 2. The interior of the EISSBox consists of the main board
and relays.
5. Location for your EISSBox
The EISSBox is used for controlling loads. Typically, the EISSBox should be mounted in a
dry location near the loads to be controlled. The maximum recommended distance from the
EISSBox to the load is 100 feet.
Wet locations require a different waterproof enclosure (not shown) for the EISSBox. In
addition, a 120V AC receptacle must be located within four (4) feet of the EISSBox, as well
as a wired Ethernet connection unless the cellular option has been included.
6. EISSBox Installation
Mounting the EISSBox
When mounting the EISSBox, orient the box vertically. This position will keep all
external wiring below the box and minimize the potential of contamination from
condensation or dust.
To mount the EISSBox, it is best to use self tapping screws suitable to the surface to
which the EISSBox will be mounted. Sheet metal screws are usually best for metal
surfaces and drywall screws for wood or drywall surfaces. For secure fastening,
insert screws in the upper and lower holes in the box. Once the box has been
mounted, proceed to connecting the EISSBox to loads.
Connecting the EISSBox to Relays
Relays are included in the standard EISSBox to allow external equipment to receive
automated demand response signals. These relays can be used either for direct
control or to signal other devices. When used for direct control applications, EISSBox
relays are rated up to 250VAC, 5A (120VAC, 10A) resistive load. If higher powered
loads are to be controlled, the use of a contactor or motor controller is
recommended. These relays are suitable for simple lighting contactors and
small resistive loads only. Using these relays to drive large current devices or
highly inductive loads will cause premature failure. EISSBoxes have two (2) relays
standard but can be optionally equipped with up to four (4).
Page 4
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
Figure 3. The relay board is where external hardware will be connected.
If used for signaling, these relays can be configured to provide either 5VDC or 12VDC
directly from the circuit board. This capability would be used to signal devices like
building controllers as to when it is time to shed load. There are 5V supply terminals
located on the top of the left and right side terminal blocks; 12V is available right next to
the power cord (See Figure 3.) Use a volt meter to verify correct polarity.
These relays can be wired in a normally open or closed state. Depending on the choice
of wiring, either state can indicate when a demand response event has occurred. For
example, if the box is wired to be normally open, then it is in demand response when it is
closed and vise versa. The relay on the right marked Relay 0 in Figure 3 corresponds to
the first asset. As stated above, for meter name and number, note which device is
connected to each relay for later configuration at the server. The standard EISSBox
comes with two relays as shown. However up to four relays and as few as zero relays
may be present in an actual unit, depending on the EISSBox configuration ordered for a
specific site.
Powering up your EISSBox
Once mounted and wired to your meters and loads, it is time to power up the EISSBox.
Plug in the supplied wall mounted power supply and the Ethernet cable into a network
that allows IP addresses to be assigned via DHCP. The EISSBox uses a request /
response method called “Poll” to contact the EISS™ server to get its configuration
parameters and OpenADR 2.0 information. This method is commonly used by end point
devices because it often does not require any modification to the customer network or
firewall.
Page 5
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
There are three LED lights on the circuit board that can be used to determine the
EISSBox’ operational state. The red and green lights, shown below in Figure 4, on the
right side will light when power is applied. The red light indicates that there is power.
After a few moments the green light should light up to indicated the EISSBox’ internal
single board computer has booted successfully. The small LED light located next to the
Ethernet cable will then begin flashing green, indicating network traffic and a successful
connection to the network.
Figure 4. This figure shows the location of the LED lights, which signal
when the EISSBox is powered, booted, and connected to the network.
7. Troubleshooting after Initial Installation
The EISSBox has a red / green LED that is located on the front of the panel. This LED becomes
active once the EISSBox has been assigned to an account. The color of the LED indicates the
state of the EISSBox:
Table 1. LED Light Codes
Light Color
Explanation
Green
Red Solid
Yellow Flashing
No Events Pending
Active Event
Error
Table 2. Error Codes
Error Codes
Single flash, 3 sec spacing
Single flash, 6 sec spacing
Double flash, 3 sec spacing
Double flash, 6 sec spacing
Explanation
noServerConnection
noIpAddress
unauthorized
serverError
Page 6
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
9. EISSBox Administration
Use of the instructions in this section implies a certain familiarity with the working of IP
networks and computer equipment.
9.1 Installing the Phidget Desktop Application
IPKeys uses a single board computer manufactured by Phidget for most EISSBox
models. Phidget supplies a web based interface for accessing the internal configuration
of
the
EISSBox.
The
application
can
be
downloaded
here:
http://www.phidgets.com/drivers.php. Download and install the appropriate application
for your operating system.
On MS Windows, you will also need to install Apple’s Bonjour Print Services drivers,
which the Phidget desktop application uses to detect Phidgets connected on the local
subnet.
You
can
download
the
drivers
here:
http://support.apple.com/downloads/DL999/en_US/BonjourPSSetup.exe. The Phidget
desktop application resides in your system tray
. Open the application and, if your
EISSBox is running and on the same network as the computer running the Phidget
desktop application, you will see it in this Phidget Control Panel application (See Figure
5.)
Figure 5. The Phidget Control Panel.
Page 7
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
Select the PhidgetSBC tab and look for your EISSBox. The serial number, located on
the back and the inside cover of the EISSBox, will match the hostname. Once selected,
the IP address will be located on the bottom of the dialogue box. You can double click on
your EISSBox and open the administration console (See Figure 6, below.)
For MacOS users, the Phidget desktop application actually resides in System
Preferences. After installation, you should see it at the bottom of the System
Preferences panel among the other 3rd party preferences. Bonjour functionality should
already be included with the OS.
9.2 Accessing the EISSBox
IPKeys ships all boxes with DHCP enabled, that means if your network does not have
DHCP enabled (most do), then the EISSBox will be unable to get an IP address. In such
situations, IPKeys also provides an alternative; the EISSBox has a secondary IP
address of 1.1.1.1 that will allow direct access to the box in the event that the network is
not DHCP-enabled or if an incorrect static IP address is assigned. You can directly
connect the EISSBox to a computer with a “gigabit” Ethernet interface with a standard
Ethernet cable. If your computer does not have “gigabit” Ethernet, than a crossover
cable is required (available from IPKeys for a nominal charge).
In either case, connect the EISSBox directly to the computer. Disconnect your computer
from other networks and set your computer for a static IP address of 1.1.1.2.
Use your browser to navigate to 1.1.1.1 and you will see the Phidget log on interface.
Figure 6. The PhidgetSBC Administration Console.
The box is shipped from the factory with admin, ipkeys as the username and password,
respectively. For security, these default settings should be changed to prevent
tampering. If the new username/password is forgotten, then the EISSBox will need to be
returned to IPKeys Technologies for erasure and reloading of the software.
Page 8
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
9.3 PhidgetSBC Configuration
Figure 7. The PhidgetSBC Configuration.
There are two tabs that are of interest to the administrator: Network and Projects.
Figure 8. The PhidgetSBC Configuration – Network Tab.
Page 9
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
Figure 9. The PhidgetSBC Configuration – Network Tab, Settings Sub-tab.
Using this screen, EISSBox administrators can set a static IP address, configure DNS settings
and enable or disable SSH access. IPKeys uses SSH to configure EISSBoxes at the factory. If
desired, this feature can be disabled by the administrator for greater security.
Page 10
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
The Project Tab is used – by advanced administrators only – to manage the applications that
run on the EISSBox and their configuration settings.
Figure 10. The PhidgetSBC Configuration – Projects Tab.
Select the project Eiss.
Edit Button Files Figure 11. The PhidgetSBC Configuration – Projects Tab, User Projects Sub-tab.
Page 11
Author: IPKeys Technologies, LLC
Date Created: 08/22/2014
Rev: 1.0
Revision Date: NA
Energy Interop™ Server & System (EISS™) EISSBox 2.0a Local Mode Installation Guide
If EISS™ is being used without over-the-wire configuration; the properties file can be edited
manually. Such edits should only be made by specifically trained personnel.
oadr.properties
Properties required for connecting to an OpenADR server and OpenADR 2.0b client operation
Table 3. OADR Properties.
Property
Example
Definition
ServerURL
http://example.vtn.com/oadr
URL of OpenADR server
User
IPKeys.1
Username credentials
Password
Test_1234
Password credentials
EventPollInterval
20
How often to poll for events (in
seconds)
Resource
IPKeys.1
Resource of the box, same as user
for Honeywell Server
Not commonly used, same as user
for Honeywell Server
asset.0
IPKeys.1
Resource target of the box (indexed
0,1,2…), this determines which relay
activate. Default is relay 0 activates
for all market context calls.
vtnId
vtn
Used for VTN authentication
OpenADRNetworkInterface
eth0
Always this value, NIC card to use
for OpenADR comms
AutoDemandResponse
true
Always use this value - Whether the
box automatically responds to
events or requires manual response
LicenseKey
L!¢3ñ$3-K3¥-1234
License key provided by IPKeys
Page 12