Chapter 4: Field Installation

Transcription

1 Chapter 4: Field Installation Table of Contents Introduction... 2 Install the InteliGateway... 2 Configure the InteliGateway Start the Ibis Installer application Connect the InteliGateway to the laptop Put the InteliGateway in configuration mode Edit the InteliNetwork settings BACnet/IP configuration Save the configuration Check if the gateway is online... 5 Install the InteliSockets... 6 Overview Start the Ibis Installer application Open the Install Page on ibis.io Plug in the InteliSocket : Set attributes in the Editor Panel : Check the History panel Using the Locations Panel Using the Device Types Panel Troubleshooting General InteliGateway InteliSocket Appendix A: BACnet/IP Configuration Updated: 7/12/ Ibis Networks 1

2 Introduction Field Installation is Chapter 4 of the installation tutorial. It covers physically installing the InteliGateways and InteliSockets at the customer s site. Before going to the site, make sure you have read and completed Chapters 1 through 3 of this tutorial. Chapter 3, Field Installation Preparation, provides a checklist of tasks to complete and items to bring to the installation. Install the InteliGateway Each InteliGateway will be installed at the customer site and then configured using the Ibis Installer application. As covered in Field Installation Preparation, each gateway needs to be installed in a location that: Has a nearby functional Ethernet jack and power outlet (work with the customer s IT department to find available Ethernet jacks) Has low interference (e.g. being located in a room with very thick walls would not be ideal) Is secure so that it will not be tampered with Is central to its InteliSocket network mesh Once the above conditions are satisfied, install the InteliGateway by plugging in its Ethernet and power cords. Once powered, the gateway s LED will light up red. For IG- 202 InteliGateways, it may take up to a minute for LED to turn on as the backup battery charges. Configure the InteliGateway Once the gateway is powered up, it is ready to be configured so that it can send data to the InteliNetwork cloud application. Complete the following steps to configure the gateway. 1. Start the Ibis Installer application Turn on your installation laptop and start up the Ibis Installer application. Sign in at the top of the app using your ibis.io account credentials. After signing in, you will be able to choose an organization from the dropdown at the top. Select the appropriate customer organization, and then click Set Current Organization. If an organization is not appearing, sign out and then sign back in to refresh the list. Once the customer s organization is selected, switch to the InteliGateway tab. Updated: 7/12/ Ibis Networks 2

3 2. Connect the InteliGateway to the laptop Connect the gateway to the installation laptop using the USB- to- serial cable. 3. Put the InteliGateway in configuration mode Initially, the gateway will be in run mode, which is the gateway s normal mode of operation. When connected to a gateway in run mode, the InteliGateway tab shows: Instructions on how to put the gateway in configuration mode Output log of the connected gateway To put the gateway in configuration mode, simply restart the gateway while it is connected to the laptop. You can restart a gateway by pressing the small grey button on its side. Once the gateway reboots (which can take up to 15 seconds), the configuration screen will appear: Configuration settings Save/run buttons Updated: 7/12/ Ibis Networks 3

4 4. Edit the InteliNetwork settings The left side of the configuration screen contains panels that control the gateway s connection to the InteliNetwork and the gateway s communication with its InteliSockets. In order to edit these settings, Enable InteliNetwork will need to be checked. The InteliNetwork Configuration panel allows you to configure the gateway so that it correctly reports data to the InteliNetwork application. 1. Set the appropriate Time Zone for the installation site. The table below maps some of the more common time zones to the appropriate gateway option. User Time Zone Hawaii Alaska Pacific Time (US & Canada) Arizona Mountain Time (US & Canada) Central Time (US & Canada) Eastern Time (US & Canada) Indiana (East) Gateway Time Zone Pacific/Honolulu America/Juneau America/Los_Angeles America/Phoenix America/Denver America/Chicago America/New_York America/Indiana/Indianapolis 2. Set the gateway Name. Usually this is set according to the building and room the gateway will be located in. 3. Authorize the gateway by clicking the Create New Key button. You must create a new key in order for the gateway to connect to the cloud servers. The IP Network Configuration section allows you to set up the gateway s network settings. If the customer allows DHCP connections, simply check the Use DHCP box. If a static IP is required, uncheck the Use DHCP box, and enter the IP information provided by the customer s IT department. The Mesh Network Configuration allows you to set the gateway s Plover communication settings. Specific details about Plover can be found in the Plover Communications Protocol sheet, but for now follow these guidelines: Hive: Give each InteliGateway you install a unique hive number. Channel: Use either channel 14, 15, 20, 21, or 25, since they generally have the least interference. If you are installing multiple gateways near each other, put each one on a different channel. Updated: 7/12/ Ibis Networks 4

5 5. BACnet/IP configuration BACnet/IP configuration is outside the scope of this tutorial; leave the Enable BACnet/IP checkbox unchecked. For information on setting up BACnet- enabled gateways, please refer to Appendix A: BACnet/IP Configuration. 6. Save the configuration Once all the appropriate InteliGateway settings have been changed, click the Save to Gateway button at the bottom. After saving, the gateway again boot up in configuration mode. When the configuration loads, verify the fields and make sure your configuration was saved correctly. If everything looks correct, click the Done button to put the gateway in run mode. 7. Check if the gateway is online Now that the configuration has been saved and the gateway is in run mode, the gateway will attempt to connect to the InteliNetwork. Once connected, the LED on the gateway will change from red to green (it can take up to a minute to connect). Additionally, verify that gateway is online on ibis.io: 1. Switch to the customer s organization using the organization menu. 2. Navigate to the Install page. 3. Select the appropriate Target Gateway. 4. Make sure the Status shows as Online. Target Gateway If the gateway does not come online within one minute, see the Troubleshooting section. Updated: 7/12/ Ibis Networks 5

6 Install the InteliSockets Overview Once the InteliGateway(s) have been installed and are online, you re ready to install the InteliSockets. As covered in the Field Installation Preparation chapter, you should have done a walkthrough of the customer s building(s) and have an idea of the devices you will be installing on. Each InteliSocket has a communication range of ~100 feet, and each InteliSocket passes along data for its neighboring sockets. To ensure reliable data transmission at the fastest possible rate: Install the InteliSockets nearest to the InteliGateway first and work outward. Keep sockets within communication range of each other. The strength of a connection becomes weaker as the distance increases, so try to keep InteliSockets closer whenever possible. Try to place each new socket within communication range of multiple, previously installed sockets. This creates multiple communication paths in the network s mesh and has a direct impact on the mesh s capacity and reliability. If groups of sockets are too far apart to communicate reliably (e.g. installing on the 1st and 3rd floors of a building), use two InteliGateways instead of chaining the meshes together with additional sockets. Updated: 7/12/ Ibis Networks 6

7 1. Start the Ibis Installer application The Ibis Installer application will allow your installation laptop to communicate with and configure the InteliSockets. If you have shut the application down since configuring the gateways, do the following: 1. Start the Ibis Installer application. 2. Sign in at the top of the app. 3. Select the appropriate customer organization. 4. Click the Set Current Organization button. To configure InteliSockets: 1. Go to the InteliSockets tab. 2. Plug in the Installation Dongle. Having multiple Installation Dongles plugged in and within range of each will result in communication interference. If multiple teams will be installing, make sure they are far apart from each other. Login + select organization InteliSockets communicating with Dongle Debug Log The top- left panel lists of all of the sockets the Dongle is currently communicating with. The bottom- left panel logs the commands being sent, which can be used for debugging. The right side of the screen shows information about the Dongle and any nearby meshes. Click Scan and make sure the installed gateway s hive and channel appear. If the gateway doesn t appear, you must start installing the sockets at a closer range. During the rest of the installation the Ibis Installer app will usually just run in the background. However, if problems arise, the app can be used to help isolate and debug the issues. Updated: 7/12/ Ibis Networks 7

8 2. Open the Install Page on ibis.io As you install each InteliSocket, you will configure its attributes on ibis.io: 1. Log in to ibis.io. 2. Switch to the customer s organization using the organization menu. 3. Navigate to the Install page. 4. Select the appropriate Installation Laptop. This should match the name at the top of your Ibis Installer application. If the Status shows as Offline, the Ibis Installer is not connected to the cloud. 5. Select the appropriate Target Gateway. The InteliSockets will be attached to the mesh of the gateway you select. See the Troubleshooting manual if the gateway is showing as offline. Installation Laptop Target Gateway Locations Pending Device Types Editor History As you plug InteliSockets in, they will automatically be added to a queue in the Pending panel, with the first socket immediately dropping down into the Editor panel. New sockets should appear on the screen within 15 seconds of being plugged in. You will use the Editor panel to configure the socket s attributes, such as its location, device type, and description. After saving, the socket will be moved down into the History panel and the next queued socket will move into the editor. On the left side of the screen are the Locations and Device Types panels. These are lists of locations and device types that you will use when configuring sockets. Using these lists makes editing socket attributes less error- prone and speeds up the installation process. More information about these two panels can be found in the Using the Locations panel and Using the Device Types panel sections below. Updated: 7/12/ Ibis Networks 8

9 3. Plug in the InteliSocket Physically plug in the InteliSocket: 1. Power down the device (e.g. the computer or printer). 2. Install the InteliSocket between the device s power cord and the power outlet. 3. The InteliSocket will appear in the Editor Panel within 15 seconds of plugging it in. 4: Set attributes in the Editor Panel The Editor Panel is where you will configure the location, device, description, and other attributes of the InteliSocket. The panel lights up blue if there is an InteliSocket to edit. 1. Set the socket s Location by selecting the desired location from the Locations panel on the left, or by selecting one of the drop- down options. You can only set the location to be one of the items in the Locations Panel. See Using the Locations Panel (below) for more information on adding locations. 2. Set the socket s Device Type in a similar fashion as the Location. 3. Give the socket a Description if it needs additional information to identify it (e.g. Left monitor / Right monitor). The Description will be visible in other sections of the UI. 4. Give the socket an Install note if there s something notable about the way it was installed. The Install Note is hidden in other sections of the UI. 5. Check the Always On checkbox if the device should never be turned off, such as refrigerators or freezers. Always On sockets cannot be remotely turned off, and will be flagged with a symbol. 6. Once you ve set the socket s attributes, click the Save button to save the information. This will also begin transferring the socket to the target gateway. The socket will switch from communicating with the Ibis Installer to communicating with the target gateway. Updated: 7/12/ Ibis Networks 9

10 5: Check the History panel After saving an InteliSocket, it will move to the History Panel. If needed, you can still change the InteliSocket s attributes by clicking on the Edit link. This will cause the InteliSocket to move back to the Editor Panel where changes can be made. Upon saving, the InteliSocket will also transfer from the Dongle to the target gateway. This process usually takes one minute. During this time, you can continue to install more InteliSockets (beginning back at Step 3: Plug in the InteliSocket). However, you should stay within range of transitioning InteliSockets until they have successfully attached to the target gateway. The status of transitioning InteliSockets is described by the following states: 1. Transition State: Initially, an InteliSocket will be in a transition state as it is switching to the target gateway. This state is indicated by grey text. During the transition, the InteliSocket s state will say Configuring then Resetting. 2. Finished State: Once an InteliSocket has successfully connected to the target gateway, it will be in a finished state. This is indicated by the previously grey text turning black. 3. Error State: If any errors occur during the transition, the InteliSocket will be in an error state. This state is indicated by red text. If an error occurs, it will be accompanied by text to help you solve the issue. Usually it is best to wait for a minute and then refresh the History Panel, as some errors can be automatically fixed by the system. If an error cannot be automatically solved, follow the instructions in the error message. Additional information on debugging can be found in the Troubleshooting section. Updated: 7/12/ Ibis Networks 10

11 Using the Locations Panel The Locations panel is where you will manage all of your InteliSockets locations. New locations must be created in the locations panel, and an InteliSocket can only be assigned to an existing location. Locations should be organized as a hierarchical tree, such as the two examples below. Organizing your locations in this way will make it possible to create summary reports for larger areas (e.g. departments, whole floors, and buildings) as well as make it easier to navigate through the data in the future. Create root locations (e.g. Suite 600, Building A, Building B) by clicking the button at the top of the list. Mousing over an existing location shows a few additional tools: o Add sub- locations (e.g. Cubicles, Kitchen) by clicking the button. o Edit a location s name by clicking the button or double- clicking the location s name. o Rearrange the tree structure by clicking and dragging on the button. Selecting a location will highlight it in blue and select it in Editor panel. The selected location will also be the default location for the next pending socket. o Use the buttons to delete locations (the dark trash- can deletes the location and all sub- locations). o The button selects the location in the Editor panel. The number of InteliSockets assigned to a location is shown in parenthesis following the name. Updated: 7/12/ Ibis Networks 11

12 Using the Device Types Panel The Device Types Panel is managed in the same way as the Locations panel, however it is initially populated with a variety of default devices. These default devices cannot be edited or moved, but can have sub- devices. Two examples of a how to organize the hierarchy of the device list are shown below. The example on the left is for the Computer device type and has two sub- levels: the brand (e.g. Dell) and the model (e.g. Optiplex 755). In the example on the right, many of the device types only have one sub- level; the model was not included. It is important to assign the correct device type for each socket. The InteliNetwork uses this information for a variety of purposes such as tracking expected behavior and measuring device health. Updated: 7/12/ Ibis Networks 12

13 Troubleshooting General On ibis.io, a panel is loading for a long time, or a refresh button is stuck grey. If some part of the app fails to load or seems to be out of sync, refreshing the web page will usually fix it. The default for most browsers is Ctrl- R or Cmd- R. InteliGateway During gateway configuration, I m seeing an error message: Gateway not authorized on ibis.io. When configuring the gateway, first make sure you are signed in to the correct customer organization at the top of the window. Once you have signed in to the correct organization, authorize the gateway by clicking the Create New Key button. On ibis.io s Install page, it says: No gateways have been configured. At least one InteliGateway must be installed and configured before the Install page can be used. Please refer to the Install the InteliGateway and Configure the InteliGateway sections of this manual for details. On ibis.io s Install page, the Target Gateway is offline. The Target Gateway is the InteliGateway you have installed at the customer site. Read through the Configure the InteliGateway section to make sure you ve configured the gateway correctly, and then follow these steps: 1. Verify that the InteliGateway has power (the power light should be lit) 2. Verify that the Ethernet port is functioning (the Ethernet port should have flashing green lights). If not flashing, double check that the Ethernet cord is plugged into correct data jack, or try replacing the Ethernet cord. 3. Make sure the USB- to- serial cable is not plugged in (otherwise it will be in configuration mode). 4. Restart the InteliGateway by pressing the grey button on the side. If the InteliGateway has power and the Ethernet is connected correctly but it still can t connect to the web app, there could possibly be a network filter blocking the InteliGateway. Check with the customer s IT department, and if network changes need to be made follow the instructions in the Configure the InteliGateway section. Updated: 7/12/ Ibis Networks 13

14 InteliSocket Rebooting a socket. Rebooting a socket is identical to unplugging the socket and plugging it back in. Note that this is different than a factory- reset (see below for factory- reset details). To reboot a socket, hold down its button for 3 seconds while it is plugged in. The light will briefly turn orange, signaling the reboot. Make sure to release the button once the light turns orange; holding down the button for a total of 8 seconds will perform a factory- reset. Factory- resetting a socket. Factory- resetting a socket will reset its communication channel, allowing it to communicate with Installation Dongles. You can factory- reset a socket holding down its button for 8 seconds while it is plugged in. The socket s light will briefly turn orange before switching to red. Factory resetting a socket will return it to the off state; make sure any connected devices are properly shut down before performing a factory reset. After factory- resetting a socket, its light will slowly blink until the socket connects to an Installation Dongle. See the following section for more information. The socket s LED light is slowly blinking on and off. If the socket s light is blinking, it is not connected to any Installation Dongles or network meshes. If you factory- reset the socket and it continues blinking, this means it is unable to connect to the installation Dongle. If you ve recently saved the socket on ibis.io, the socket may still be switching to the target gateway s channel. If the light continues to blink for more than 15 seconds, it can t find the target gateway s mesh. The socket is probably too far from the nearest neighboring socket or gateway. On ibis.io s Install page, my socket is not appearing in the Editor or Pending List. First, use the Ibis Installer application to check if the socket is communicating with the Installation Dongle. In the InteliSockets section, it shows a list of all sockets that have recently communicated with the Dongle. Sockets communicating with Dongle Updated: 7/12/ Ibis Networks 14

15 If the socket doesn t appear in this list: 1. Make sure the Dongle is securely connected to the USB port. It should say Dongle connected in the lower left corner of the app. 2. Factory- reset the socket If the socket is appearing in the list: 1. On ibis.io, make sure the appropriate installation laptop is selected from the Installation Laptop dropdown. It should match the name at the top of the Ibis Installer application ( Ibis Demo Customer A in the example above). 2. Refresh the ibis.io page in your browser. The socket appears in the Pending List, but it says: Socket belongs to a different organization. This means the socket has already been installed at a different customer organization. In order to reuse an InteliSocket, a system administrator will need to conclude its data stream. On ibis.io s Install page, I saved the socket, but something went wrong during its transition onto the target InteliGateway. How can I redo the transition? 1. Factory- reset the socket. 2. Once reconnected with the Dongle, a link will appear in the History Panel asking if you d like to retry the installation. Click the retry link. Updated: 7/12/ Ibis Networks 15

16 Appendix A: BACnet/IP Configuration InteliGateways can be optionally configured to function as a BACnet/IP virtual device server. BACnet/IP should be enabled only when integrating with a secured BACnet/IP network. Follow the steps in the Configure the InteliGateway section, and for step 5 do the following: 1. Check the Enable BACnet box to make the BACnet settings editable: Enable BACnet BACnet configuration Connected BACnet devices 2. Input the BACnet Network Number. Choose a number that is unique from the existing BACnet network, because the InteliGateway is a BACnet/IP virtual device server and acts as a BACnet gateway to the InteliSockets. The system may not function properly if this number is not unique. 3. Input the Gateway BACnet ID. As InteliSockets are installed, each InteliSocket will be assigned a BACnet ID based on the Gateway BACnet ID (each InteliSocket s ID will be incremented by 1). 4. If needed, input the FDR (Foreign Device Registration) IP Address and Port for the BACnet system. The IP address is the address of the BBMD (BACnet/IP Broadcast Management Device) that you want the InteliGateway to foreign device register with. Leave the FDR address blank to disable this feature. The connected devices table will eventually list all of the connected InteliSockets along with their assigned BACnet IDs and Descriptions. This table will not begin to populate until you have saved the BACnet configuration to the gateway and have the gateway run to discover the devices. If the Clear Devices box is checked upon saving, the InteliSocket BACnet IDs will be cleared and reassigned based on the Gateway BACnet ID. Once all of the InteliSockets have been installed, verify a few of the InteliSocket s BV Object Properties using your BACnet controller. In particular, verify the Scheduled On/Off Status (BV- 40) object. Using the InteliNetwork to control InteliSockets or using Updated: 7/12/ Ibis Networks 16

17 the button on the side of the InteliSocket will cause priority 8 of the BV- 40 priority array to be set. This will override any BACnet schedulers that use a lower priority. Therefore, if the BACnet controller s scheduler is used, it is important that priority 8 be set back to null. It is important to note that because of the BV- 40 priority array, only one system (BACnet controller or the InteliNetwork) should be used to schedule InteliSockets. Updated: 7/12/ Ibis Networks 17