Gateways

Adding Gateways

Gateways forward messages to and from sensors and Manage. You can add Gateways to an on-premise or Manage in the Cloud (EMC) server. For EMC, you will have to register the Gateway to the Cloud. Please contact Enlighted Support to do that for you. 

The Gateways are automatically discovered and added when the DHCP server provides their IP addresses. If this is the case, skip Adding Gateways, and refer to  Discovering Gateways.  When the customer provides the DHCP address, the Gateways are added manually to Manage. Refer to the process below for Adding Gateways.

Before Adding a Gateway,

• Ensure that the organization tree with the required floor and floor plan image exists, and it appears in the Facilities left panel. If it does not appear, it means that the floor has not been added to Manage. Refer to the article Add a Floor.
• For each Gateway, the Gateway ethernet cable must be connected to the PoE switch and verify if the PoE switch and Gateway LEDs are blinking. Refer to the Gateway LED Status in the Install Guide.
• Verify Gateway network settings. Refer to the article Assigning Network IP Addresses (On-premise Manage). Gateways can either be added manually or automatically discovered and added by Manage. When the customer provides the DHCP address, the Gateways are added manually to Manage.
• To add Gateways to an on-premise Manage, you need to know the IP and MAC addresses ahead of time. Please coordinate with your IT manager to determine the MAC addresses for all gateways, create an excel file with the MAC and IP addresses, and save it as a .csv file. When the MAC address is entered or pasted into the input field, the address is automatically formatted with colons as the user inputs it.
• For Cloud-hosted Manage (EMC), you need only the MAC address since the customer will provide the Gateway IP addresses via their DHCP.

To add Gateways to a floor,

1. Select the floor in the Facilities tree.
2. Click on Devices
3. Click on the sub-tab Gateways.
4. Click on the Add Gateway button.

Add Gateway to an On-prem Manage 

5. To add a Gateway to an on-premise Manage, type or copy the 12-digit MAC address and IP address  in the input fields. The MAC address is automatically formatted with colons as the user inputs it.
6. To add multiple gateways, click Bulk Upload. Then, upload the appropriate .csv file that contains both the MAC and IP addresses.
7. Click Add.

 

Add Gateway to Manage in the Cloud (EMC)

To add a Gateway to Manage in the Cloud, you will enter only the MAC address. The Customer  provides the IP address for the Gateway. To add multiple gateways, click Bulk Upload. Upload the appropriate .csv file with only the MAC addresses.

After the .csv file is uploaded, review and edit the details to resolve duplicate IP or MAC addresses, and then click Add.

Confirm Gateway is Added

A success message appears confirming that the Gateways are added. It takes 10-12 minutes for all Gateways to be added to the queue. After the Gateways are added to the list, the status for each Gateway is displayed as follows:    

• DISCOVERED – Gateway has been added to the queue. You are now ready to discover and commission the Gateways. 
• PENDING – Gateway is yet to be included in the queue. Give it a few minutes.
• FAILED – Gateway failed to be added.

If a Gateway fails, check the IP address in the Gateway Details window, and verify cables and network settings. Contact Enlighted Support to ensure that the Gateway has been registered in the Cloud for the cloud-hosted server.

Recommended articles:

• Discovering Gateways
• Commissioning Gateways
• Gateway Supports 100 Devices and 5 Hoppers

Discovering Gateways

The Gateways are automatically discovered and added when the DHCP server provides their IP addresses. See Assigning Network IP Addresses (for on-premise Manage) to enable the DHCP server to provide the Gateways' IP addresses.

To discover Gateways on a floor.

1. Select the floor in the Facilities navigation tree.
2. Click the Devices tab.
3. Click Gateways. 
4. Click the Discover button.

Manage discovers Gateways that have been provided with IP addresses but have not yet been commissioned and adds them to the Gateway table.

The discovered Gateways are shown in the Gateway table. To commission a Gateway, refer to the article Commissioning Gateways.

Recommended articles:

• Adding Gateways 
• Assigning Network IP Addresses (On-premise Manage)

 

Commissioning Gateways

After Gateways (GWs) are added and discovered, the next step is to commission them. If you are commissioning a Gateway running firmware before v2.8, see Commissioning Gateways with Firmware version before 2.8. 

To commission and place a Gateway (GW) on the floor plan,

1. Select a Floor in the Facilities panel.
2. Click Devices.
3. Click the Gateways tabs to view the list of gateways.
4. Select a Gateway and click the Commission button in the Action column.
   You can also click the Bulk Commission button to commission multiple gateways on the same floor after you have selected them.

The Commission Gateway screen is displayed. To commission and place the gateway, follow the steps below.

Step 1: Select the Gateway (GW) by clicking on it.

Step 2: Fill in the configuration fields:

• Name – A default name is generated based on the gateway's MAC address's last three octets. Typically, this is not changed.
• Radio Channel ID – A wireless channel with values between 0 and 15. Channel 4 is reserved for the discovery of sensors, hence do not use Channel 4. When assigning channels, select channels that are apart to minimize interference from the nearby buildings or parking lots on the same campus; channels should be selected to reduce the probability that either GWs or sensors can simultaneously communicate with two GWs on the same channel.
• Radio Network ID – A value to make the wireless communication unique to a building even when the same channel is being used. However, the same Network ID value can be used for gateways in a different building of the same organization.
• Radio Encrypt type – A value of none or AES128 to specify whether packets on the wireless network are encrypted. The encryption is done by hardware and does not affect the performance of wireless communication.
• Radio Security String – Used to generate the encryption key. Recommend using the default key provided by EM. If a unique value is specified, remember to write the key safely as it cannot be restored by the system if needed later. The length of the key must be 16 characters.

Step 3: Click on the Commission and Place button to commission the GW.

Initially, place the gateway on the floor plan, and then drag the commissioned gateway to the actual location. Alternatively, right-click on the floor plan where the gateway should be placed and select Commission and Place in the resulting popup.

After the Gateway's initial placement, you can drag it to its actual location on the floor plan.

When the Commission Gateway pop-up is closed, the table should be updated to show that the GW has been commissioned, as shown below. The GW’s status is changed to Commissioned. You have successfully added and commissioned the gateway.

The green LED on the GW blinks once every five seconds after it is commissioned. If you need to upgrade the firmware image on the gateway devices, refer to the Upgrade Firmware section.

Recommended articles:

• Adding Gateways to an EM
• Discovering Gateways
• Viewing Sensors Bound to a Gateway
• Changing Sensors to a Different Gateway
• Commissioning Gateways with Firmware Version before 2.8

Viewing the Gateway associated with Sensors or Devices

Devices such as sensors, ERCs, Plug Load Controllers are assigned to a Gateway at the time of commission. To determine devices associated with a Gateway, follow the procedure below.

1. Select a floor in the Facilities left panel.
2. Click the Floor Plan tab.
3. In the View drop-down list, select Gateway Status.
4. Select a gateway in the drop-down list next to it. Sensors bound to the selected gateway are displayed on the floor plan.

Another way to determine devices associated with gateways is to

1. Select a floor in the Facilities left panel.
2. Click the Floor Plan tab.
3. Select Network from the View drop-down list.
4. Color-coded devices and gateways are displayed on the floor plan allowing you to identify the association between the devices and gateway visually, as shown below.

The gateway associated with the sensors is grouped in the same color. For example, in the image below, the blue Gateway is associated with the blue sensors and the brown Gateway with the brown sensors.

Recommended articles:

• Changing Sensors to a Different Gateway
• Adding Gateways
• Discovering Gateways

Change Gateway

Sensors are assigned to a Gateway during commissioning; however, they can be changed to another Gateway within its communication range, assuming that they can currently communicate with the original Gateway. Changing a sensor’s gateway will remove the sensors or fixtures from any groups, such as motion or switch groups. Note that this feature does NOT check whether communication is possible with the newly assigned gateway. It is possible to inadvertently lose communication to the sensor by assigning it to a gateway with which it cannot communicate.

To change the sensor’s gateway,

1. In the left panel, select a floor from the Facilities tab.
2. Select the Floor Plan tab.
3. Select fixtures or sensors on the floor plan (press the Ctrl key to select additional fixtures).
4. Right-click and choose Change Gateway.

5. A Change Gateway pop-up shows the currently assigned Gateway for the selected sensors and a drop-down list of all Gateways available on the floor. Select a Gateway from the drop-down list and click Apply.

If the sensors or fixtures do not belong to a motion or switch group, a confirmation message is displayed, indicating that the Gateway has been successfully changed.

If the sensors or fixtures belong to a motion or switch group, the group names are displayed in a window, as shown below. Click the group to see details or make changes and then close it to continue changing the Gateway.

6. Click Yes to confirm changing the Gateway. A confirmation message is displayed indicating that the Gateway has been successfully changed.

The link provides the status details of all selected sensors and their names, MAC addresses, and status of each sensor. Use the filter option to sort and view the list of sensors based on their status: Successful or Unsuccessful.

• Successful - The sensor has been successfully changed to the gateway.
• Unsuccessful - The old gateway cannot reliably communicate with the sensor. If that is the case, you may want to temporarily add a hopper, change the gateway, and then remove the hopper.

It is also possible to successfully assign a sensor to a gateway to which it cannot communicate. Hence, you always want to verify that the new gateway is within the sensor's communication distance before changing its gateway.

Recommended articles:

• Viewing Sensors Bound to a Gateway
• Automatic Recovery of Lost Sensors
• Discovering Sensors
• Commissioning Sensors
• Adding Gateways

Show or Hide Gateways on Subfloor

The Sub-floors inherit Gateway devices commissioned to the parent floor.  Not all gateways commissioned to a parent floor may be used on a sub-floor. You can change the visibility of  individual Gateways to show only the Gateways to which devices will be commissioned on the subfloor by taking the following actions:

1. Select a sub-floor in the Facilities panel.
2. Click Devices > Gateways tabs to view the list of gateways.
3. Select a Gateway and click the Change Visibility button. It's a toggle button that toggles between SHOWN and HIDDEN.

Recommended articles:

• Add a Subfloor

Assigning Network IP Addresses (On-premise Manage)

The on-premise Enlighted Manage server may be either on a customer IT network or a stand-alone network. The Enlighted Manage integrates seamlessly with the Building Management Systems (BMS) using well-defined REST APIs and the BACnet interface. The following figure provides an overview of the on-premise network design.

Static and Dynamic IP Addresses

When the Manage server is on-premise, it acts as the DHCP server for all gateways in the network, and it provides the IP addresses. The Gateways communicate using the customer’s existing network, and they are automatically discovered and added. When the customer provides the DHCP address, you must add the gateways manually. The Corporate network is assigned to use a static IP address.

Manage has two Ethernet interfaces: Corporate and Gateway network.

Corporate Network Configuration

To program the network ports and DNS address, click on the Administration>Network Settings menu item and set up the network.

1. Select the eth0 tab.
2. Check Enable Port.
3. Type the details for the Static IP address.

Gateway Network Configuration

Typically, an Enlighted Manage located on-premise is configured to use the Gateway network on Ethernet 1 port to connect gateways. While setting up networks, depending on the organization’s network settings preference, the DHCP server for Ethernet 1 port (eth1) can either be disabled or enabled. When the DHCP Server is disabled, you must add the gateways manually.

Go to Administration>Network Settings>Eth1 to see the Gateway Network settings. When the DHCP server is disabled (NA), add the gateways manually. Refer to Adding Gateways.

When the DHCP Server is enabled, the Gateways are automatically discovered and added. The DHCP server provides the IP address for each Gateway. See Discovering Gateways for details.

Also, read the Enlighted Network Design Guide for additional information and refer to the Network Topology options.

Connecting to Gateways with Firmware v2.8

If you have Gateways running firmware before v2.8, Manage does not communicate or commission them. To communicate and commission Gateways with firmware before v2.8, you need to do a few steps:

Step 1: Go to Administration > System Management.

Step 2: Click the Settings tab and scroll to Security Settings.

Step 3: Uncheck both the security options and click Apply.

Manage will then commission and communicate Gateways with firmware v2.8 or earlier and send notification messages if Gateways could not be commissioned. Retry commissioning the Gateways again.

Recommended articles:

• Adding Gateways to an EM
• Discovering Gateways
• Viewing Sensors Bound to a Gateway
• Changing Sensors to a Different Gateway

Replacing a Defective Gateway

If the red LED on a Gateway (GW) is on continuously, you will need to return the unit. Please read the procedure for requesting an RMA (Return Merchandise Authorization).

After receiving the replacement device, remove the current Gateway unit in the site, and install the Gateway replacement in its place.  The next step is to add or discover the Gateway in Manage.

If the Gateway is using the customer's IP address, refer to the article Adding Gateways. If Manage is providing the IP address, refer to the article Discovering Gateways.

Replacing a Gateway

The Enlighted Manage discovers the RMA Gateway and lists it in the Gateway (GW) table. The RMA GW is shown in the GW table. Select the defective GW from the GW table list and click on Edit. The Gateway Details window opens.

Copy and save the following information from the Gateway Details window.

• Radio channel ID – Channel ID of the defective Gateway.
• Radio network ID – Network ID (case sensitive)  

Select the newly installed Gateway in the table, and click Commission in the Action column.

In the Commission Gateway window,  

1. Right-click on the defective Gateway in the floorplan. 
2. Select the RMA option to commission the Gateway. This allows the fixtures that were bound to the old Gateway to rebind to the replacement GW. The rebinding will occur when the sensors report their status and statistics. 
3. Wait until the Success message is displayed, and click Done.

Troubleshooting:

RMA Gateway Troubleshoot:

If you have trouble in replacing the Gateway, contact  Customer Support with the following information.

• Radio channel ID – Channel ID of the defective Gateway.
• Radio network ID – Network ID (case sensitive). 

ERC Communication with the Gateway

If for any reason, the ERCs are not communicating with the RMA Gateway, all the ERCs have to be restarted after the RMA Gateway is commissioned. To restart the ERCs, simultaneously, press and hold the buttons 1 and 4 on the ERC until a single blink from the red LED is observed approximately after 5 seconds. 

Recommended articles:

• Replacing a Defective Sensor 
• Replace a Defective Plug Load Controller (PLC)
• Replacing a Defective ERC