This article details how to integrate Switch Dx3, from gateway installation, to site selection, to performing a network health scan.
Switch Dx3 (Digital Device Discovery) runs an IP-level scan across a building network to detail the compatible systems and data points on that network, including the connectivity and potential vulnerabilities in each building. This section walks through the steps to setup the integration within the Platform to run the Switch Dx3 scan and produce a smart building readiness report and dashboard.
Prior to setting up and beginning the Switch Dx3 scan in the Platform, users must complete the following steps:
1. Install the Switch Gateway onsite and confirm it’s online.
2. If the Switch Gateway is on a separate subnet from the BAS, confirm the IP address and BACnet port for the BBMD.
3. Ensure all users have either Microsoft Edge, Google Chrome or Mozilla Firefox web browsers installed for use with the Platform. Please note that neither Microsoft Internet Explorer nor Safari are currently supported.
Next, users should complete the following steps to run a successful Switch Dx3 scan.
Once in the Platform, select the portfolio in the top right drop down. Next, select the specific site for the Switch Dx3 scan by navigating to site in the left-hand navigation menu and choosing the site from the drop down at the top, as shown in Figure 1. Once the site loads, the Platform will navigate back to the Overview page.
Figure 1. Choose a Site from the Drop Down within the Site Side-menu Option.
Next, users should set up the site architecture. Navigate to Site Builder by again choosing ‘Site’ in the left-hand navigation menu. Click on the ‘carrot’ next to Site Builder and choose ‘Integration.’
Figure 2. Navigating to the Integration Page.
A grey grid will appear once the page has loaded - this is a canvas to build the network diagram.
Figure 3. Build the Site Architecture in the Integration Canvas.
The site architecture needs at least four key components to complete a Switch Dx3 scan:
- A generic network switch, typically with 12 ports.
- A Switch Gateway.
- A BACnet/IP driver.
- A BI Driver Config.
Users can add each of these components from the Platform library by clicking ‘+’ in the bottom right corner and selecting the left icon. The Library side bar will then appear on the page. The Library side bar may have already appeared when the page loads, in which case this step is not necessary.
Figure 4. Add Components from the Drivers Library in the Platform.
In the Integration Library, search for the first three devices listed above in the Device Name. Hover above the 12 dots next to the name until the hand appears before then clicking and dragging the device into the canvas.
Figure 5. Choose the Component By Clicking on the Dots Left of the Device Name.
Figure 6. Drag the Component into the Network Architecture Canvas.
Add the BI Driver Config by navigating to the Devices Library in the drop-down menu of the Library side bar. Search for the device by its device name and drag this into the canvas similar to the other components.
Figure 7. Add the BI Driver Config from the Devices Library.
In order to connect components, the blue node () needs to be on the same side as the desired connection. Move the node to the other side by clicking on the ‘+’ sign and choosing 'Move to Left/Right' from the drop down.
Figure 8. Moving a Node to another Side to Build Connections.
From each node, click the blue dot and drag the arrow to a node on the Generic network switch. This arrow emulates a physical Ethernet connection from the Switch Gateway to the network switch on the site. The final network diagram should resemble the diagram below. Next, add details for each of the components.
Figure 9. A Connected Network Diagram.
Device Component Details
Click on each of the components to view the Properties side bar and edit the device details. It’s important to make sure the address of each of the devices is correct. Starting with the Switch Gateway, click on the component and add the IP address of the Switch Gateway to the Address box. The name can also be edited but this is not necessary.
Figure 10. Add the IP Address to the Switch Gateway Device.
Next, add the device details to the BI Driver Config device. Please note, it’s important that the IP address of the BI Driver Config matches the IP address of the Switch Gateway (the IP address of the Switch Gateway can be found under 'Portfolio' -> 'Build' -> 'Site Details').
The BACnet Port must also be configured - this will typically be ‘47808’ but users should confirmed this with the site team.
Figure 11. Add the IP address and BACnet port to the BI Driver Config.
The BACnet/IP device should only be updated if the site has a BBMD. For a BBMD, the device name is commonly changed to 'BBMD=[IP address of BBMD]'. Add the BBMD IP address to the BBMD field, noting that the IP address does not go in the Address field, which should remain blank.
Figure 12. BBMD Configuration Details.
The final step before running the Switch Dx3 scan is to restart the gateway. Click on the Portfolio tab, then 'Gateway Management,' then search for the site. Then right click that site and select 'restart.
Alternatively, click on the Gateway tab at the top of the page. This can also be accessed via ‘Site' -> 'Site Builder' -> 'Gateway Management.’
Figure 13. Two Ways to Navigate to Gateway Management.
Enter the gateway console by choosing the Console tab under Status. Once this loads, a black screen will appear with a username ending in a ‘$.’ Type “sst” and press enter to restart the gateway.
Figure 14. Restart the Gateway via ‘Console.’
Eventually the screen will display the message “Gateway is restarting. Please wait…”
It typically progresses from 1% to 100% quickly before returning to the black console screen with multiple lines of new text starting with “Welcome to…”. This indicates the gateway was restarted and is ready for the Switch Dx3 scan.
Figure 15. Gateway is Restarting.
Switch Dx3 Scan
Navigate to Switch Dx3 via the Site side-menu. In the top right corner, click the black 'Start Scan' button to begin the scan. Once the scan begins, this button will turn red and show the percentage of completion.
Figure 17. Starting a Switch Dx3 Scan.
Depending on the size of the network, this scan may take up to several days. Once the scan is complete, the Switch Dx3 Dashboard will populate with diagrams showing ‘Network Health’, ‘Building Readiness’, ‘Firmware Versions’ and ‘Potential Vulnerabilities’. For more details, either click 'See more' at the bottom of any module or 'See Full Report' in the top right corner. The different sections of the report can be accessed through the four tabs at the top.
Figure 18. A Full Switch Dx3 Report.