Niagara EC-BOSax WIFI Option

Engineering Notes : EC-BOSAX WiFi Option Information and/or specifications published here are current as of the date of publication of this document. Distech Controls Inc. reserves the right to change or modify specifications without prior notice. The latest product specifications can be found by contacting our corporate headquarters, Brossard, Quebec. Products or features contained herein are covered by one or more U.S. or foreign patents. This document may be copied by parties who are authorized to distribute Distech Controls products in connection with distribution of those products, subject to the contracts that authorize such distribution. It may not otherwise, in whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine-readable form without prior written consent from Distech Controls, Inc. Distech Controls and the Distech Controls logo are trademarks of Distech Controls, Inc. © 2011 Distech Controls, Inc. Document revised in November 2011 by Distech Controls Inc. Starting in AX-3.6, EC-NetAX support was added for wireless 802.11b/g EC-BOSAX connectivity (WiFi). At the time of this document, this applies only to an EC-BOS-7AX with an installed Mini-PCI WiFi adapter card (EC-T7-WIFI option). This EC-BOS-7AX option became available in the AX-3.6 software release timeframe. Note: See the “install sheet” document that ships with this WiFi adapter option card, for physical mounting details. This document summarizes usage scenarios and software configuration details of the WiFi option. The following sections provide more details: • “EC-BOSAX WiFi usage scenario” on page 1 • “Requirements for WiFi EC-BOSAX support” on page 2 • “Operation notes for a WiFi EC-BOSAX” on page 2 • “Configuring the EC-BOSAX for Wifi” on page 3 • “Install the WiFi adapter card” on page 3 • “Install the platWifi software module” on page 3 • “Discover and add a wireless network” on page 3 • “Enable and configure TCP/IP settings for the WiFi interface” on page 4 • “About the WiFi Configuration view” on page 6 • “About a discovered wireless network” • “About a new (undiscovered) wireless network” • “Notes on mode and security and authentication types” • “About Buttons in WiFi Network Database” • “About the WiFi Certificate Manager view” on page 10 • “About the WiFiPlatformService” on page 11 • “Document change log” on page 13 EC-BOSAX WiFi usage scenario The primary use case for EC-BOSAX WiFi connectivity is when, for whatever reason, the EC-BOSAX cannot be directly Ethernet “patch cabled” to the desired IP LAN. However, that LAN provides a wireless WiFi router or access point (it is a “WLAN”). The EC-BOSAX’s WiFi adapter effectively adds a “third” WLAN choice for this IP connectivity, apart from its LAN1 and LAN2 Ethernet ports. Note: Please note that WiFi support does not enable the EC-BOSAX to operate as a Wifi “hotspot” or access point, nor does it enable the EC-BOSAX to provide routing functions between different LAN or Interface connections. Two possible usage scenarios are: • The only (primary) LAN connection needed to the EC-BOSAX cannot be done using Ethernet cabling, perhaps for some physical reason that making it too expensive. In normal daily operation, neither physical (RJ-45) LAN port is used, meaning no cable is attached. • The EC-BOSAX is already (primary) LAN1 connected with a patch cable, but a separate, isolated WLAN has devic- es that need to be integrated in the station with a driver. This other WLAN provides a nearby wireless router that would save the expense of pulling more cable. In any case, note that you need normal LAN connectivity to the EC-BOSAX for the initial EC-NetAX configuration of this WiFi option. EC-NetAX-3.6 Engineering Notes: EC-BOSAX WiFi Option 1 Requirements for WiFi EC-BOSAX support EC-BOSAX WiFi usage scenario November 2011 Requirements for WiFi EC-BOSAX support No EC-BOSAX licensing feature specific to WiFi is needed. Other requirements for a WiFi EC-BOSAX are as follows: EC-BOSAX WiFi platform At the time of this document, an EC-BOS-7AX series controller (EC-BOS-7AX), running AX-3.6 or later is required, with a Distech Controls EC-BOS-7AX WiFi adapter card option (EC-T7-WIFI) installed in that controller’s MiniPCI slot. EC-NetAX software module The “platWifi” software module must be installed in the EC-BOSAX. Note you can do this either before or after physically installing the WiFi adapter card option. WiFi (802.11b/g) router or access point information To configure the EC-BOSAX for WiFi access, you must know the SSID of your site’s local 802.11b/g WiFi router (or access point), as well as its network key, that is its security password. If the router or access point is configured to use MAC address filtering, note you can find the WiFi adapter’s MAC address (physical address) in the platform TCP/IP Configuration view, under the “Interface 3” area. You will need to enter that MAC address into your router’s MAC address filter table. Operation notes for a WiFi EC-BOSAX Operation of the WiFi-equipped EC-BOSAX allows it to be accessed via a wireless 802.11 connection, for example. a station (fox) connection from EC-NetAX Pro, or a station-to-station fox connection, or an EC-NetAX Pro platform connection, or a browser connection, all from a host on that same network. You specify that network in the TCP/IP platform configuration of the EC-BOSAX, under the “Interface 3” section of the platform TCP/IP Configuration view, or in the station’s equivalent TcpIpPlatformService view. By default, the Interface 3 (bc0) adapter is not enabled—you need to enable it and then specify the appropriate network serviced by the target WiFi router/access point. Just as when enabling both Ethernet LAN ports on the EC-BOSAX, the Interface 3 bc0 wireless adapter must specify a different network (subnet) than either LAN1 or (if enabled) LAN2. Note: An EC-BOSAX does not provide IP routing or bridging operation between different Interfaces (LAN ports, WiFi, GPRS, dialup). Even if no permanent LAN1 connection is made to the WiFi-equipped EC-BOSAX, it may be typical to leave it (Interface 1) enabled and configured to a known static IP address. This could help facilitate on-site EC-NetAX maintenance, for example, by connecting an Ethernet cable directly between its LAN1 port and an engineering workstation laptop, and then accessing it using this separate network. Be aware that any QNX-based EC-BOSAX has only a single IPv4 TCP/IP gateway and (potential) set of IPv4 DNS servers, which apply to all Eth/IP interfaces (en0, en1, bc0). If the WiFi network (Interface 3, bc0) is the primary operating network for the EC- BOSAX, you should specify IP address values for the EC-BOSAX’s IPv4 gateway and DNS servers accordingly. Often the IP address of the target Wifi router/access point is used as the “IPv4 Gateway”, and its DNS server addresses are reused in the EC- BOSAX’s TCP/IP setup. Otherwise, outbound operations from the EC-BOSAX’s station, e.g. IP-based discover operations, or WeatherService or other customized applications, may fail because a route or host was not found. Finally, note these two differences between Interface 3 (bc0) and the two onboard LAN ports (en0, en1): • System shell access (serial shell or Telnet EC-BOSAX) to the EC-BOSAX does not provide TCP/IP configuration of the WiFi adapter, via its “Update Network Settings” menu selection. This is for the EC-BOSAX onboard LAN ports only. However, you do see some configured values for the “bc0” adapter atop the menu. • When performing a discover operation in the Station Manager view from another remote EC-NetAX host like a Supervisor or other EC-BOSAX, the EC-BOSAX’s reported IP address can be wrong. In this case, the Supervisor is on the same network served by the WiFi router/access point connected to the EC-BOSAX. The EC-NetAX Station for the WiFi EC-BOSAX will ap- pear discovered showing its LAN1 (en0) IP address—and not the IP address for Interface 3 (bc0) that was actually used. In this case, to successfully add the discovered station to the Supervisor station’s EC-NetAX Network, you need to know what its Interface 3 IP address is, and replace the incorrect reported address. Note a similar issue occurs when your EC-NetAX Pro host is connected on the WiFi-equipped network, and you issue the “Find Station” command (from File menu: File > Open > Find Stations). Again, the discovered entry for the WiFi EC-BOSAX is likely to show its LAN 1 IP address, and will be unreachable if selected for station connection in that dialog. EC-NetAX-3.6 Engineering Notes: EC-BOSAX WiFi Option 2 Configuring the EC-BOSAX for Wifi Install the WiFi adapter card November 2011 Configuring the EC-BOSAX for Wifi This section provides a summary of the necessary steps to configure an EC-BOS-7AX for WiFi access. 1. Install the WiFi adapter card 2. Install the platWifi software module 3. Discover and add a wireless network 4. Enable and configure TCP/IP settings for the WiFi interface Install the WiFi adapter card Installation requires removing the controller from any mounting and working on a static-free, well-lit work surface. For specific details, refer to the WiFi Option Install Guide document that ships with the WiFi adapter card. Install the platWifi software module Open an EC-NetAX platform connection to the EC-BOSAX. Use the platform Software Manager to install the platWifi module, if not already installed. For related details, see “Software Manager” in the EC-NetAXPlatform Guide. Discover and add a wireless network After rebooting with the WiFi adapter card in the EC-BOSAX, you may have noticed two new platform views when you opened a platform connection, shown in Figure 1. Figure 1 Platform tools WiFi Configuration view and WiFi Certificate Manager view These two platform views are: • WiFi Certificate Manager - typically not applicable, unless authentication on the target network requires you to have a CA certificate. See the local network administrator to request the necessary certificate file(s) to import using this view. • WiFi Configuration - the main view used to discover and connect to a wireless network. Unlike some other specialized platform views (Dialup Configuration, GPRS Modem Configuration), these WiFi platform views appear only if the WiFi adapter option is physically installed in the EC-BOSAX. Note: Providing that the platWifi module is installed in the EC-BOSAX, its running station should also show a new WiFiPlatformService too—it provides identical functions as the two WiFi platform views. Discover and add a wireless network Perform the following steps with the EC-BOSAX installed at the job site, with an opened platform connection. Step 1 Double-click WiFi Configuration to open the platform WiFi Configuration view. Step 2 Click the Discover button. This launches a discovery process, with an “Discovering Wireless Networks” popup dialog. When finished, one or more 802.11 wireless networks should appear in the (top) Discovered pane. Note: A router/access point that does not broadcast its SSID will need to be added manually. See “About a new (undiscovered) wireless network” on page 8. EC-NetAX-3.6 Engineering Notes: EC-BOSAX WiFi Option 3 Enable and configure TCP/IP settings for the WiFi interface Configuring the EC-BOSAX for Wifi November 2011 Step 3 Double-click the desired network (or click and select Add Network) for the Add a Wireless Network dialog. An example dialog is shown below. Figure 2 Example Add a Wireless Network dialog in the WiFi Configuration view, following a Discover Discovery typically learns most required values, some of which are read-only (SSID, BSSID, Mode). Other settings are often correct as shown, such that you only need to enter the Network Key (password). Note: Under “Encryption Method”, note that “CCMP” is equivalent to “AES”, where the latter term may be used more frequently in router configurations. Step 4 Enter the network key in both fields, and if necessary, make any other adjustments. Then click OK. The dialog closes and the network is added to the Database pane, with a status of either “Disconnected” or “Connecting” during handshaking between the WiFi daemon and the wireless router or access point. Upon successful connection, the network appears with a status of “Connected”. Step 5 Click the Save button to save the platform configuration. Next, configure IP settings for the WiFi adapter. See “Enable and configure TCP/IP settings for the WiFi interface”. Note: For more details on the WiFi Configuration view and wireless network properties, see “About the WiFi Configu- ration view” on page 6 and “About a discovered wireless network” on page 6. Enable and configure TCP/IP settings for the WiFi interface If a wireless network is configured and connected in the EC-BOSAX’s platform WiFi Configuration view (or equivalent view in its station’s Config > Services > PlatformService > WiFiPlatformService), you can enable its TCP/IP interface and enter IP settings to enable access on that WLAN. Enable and configure TCP/IP settings for the WiFi interface Perform the following steps with the EC-BOSAX installed at the job site, with an opened platform connection. Step 1 Double-click TCP/IP Configuration to open the platform TCP/IP Configuration view. Step 2 Under Interfaces, click the Interface 3 control to expand the available properties. Interface properties are shown at the top above an IPv4 Settings tab, and include the following read only properties (showing example values of the WiFi adapter option for the EC-BOS-7AX): • ID — bc0 • Description — Broadcom Wi-Fi Ethernet Adapter bc0 • Physical Address — the MAC address for the WiFi adapter, for example 00:21:86:45:49:99 Step 3 Click the Adapter Enabled checkbox to set it Enabled, and in the IPv4 Settings tab enter the appropriate IP address information for the EC-BOSAX on this WLAN. Example entries are shown in Figure 3. EC-NetAX-3.6 Engineering Notes: EC-BOSAX WiFi Option 4 Configuring the EC-BOSAX for Wifi Enable and configure TCP/IP settings for the WiFi interface November 2011 Figure 3 Example Interface 3 (WiFi Adapter) TCP/IP settings for an EC-BOS-7AX in TCP/IP Configuration view Typically you enter a (unused) static IP address and appropriate subnet mask, as shown above. Note: This must be a different IP network (subnet) than the currently used LAN1 (Interface 1, en0) or if enabled, LAN2 (Interface 2, en1) port. For related details, see “Operation notes for a WiFi EC-BOSAX” on page 2. As an alternative to a static IP address, you could select to enable DHCP. However, as always if configuring for DHCP it is recom- mended that you reserve a specific, fixed IP address for this EC-BOSAX host in the network’s DHCP server/router configuration, noting the MAC address of this adapter as shown above. Step 4 Click the Save button to save the platform configuration. A popup Reboot dialog appears for the EC-BOSAX, as shown in Figure 4 below. Figure 4 Example Reboot dialog after making changes from platform TCP/IP Configuration view Step 5 Click Yes to reboot the EC-BOSAX. A popup Rebooting dialog appears, and the opened platform connection (as well as any station connection) to the EC-BOSAX is dropped. Figure 5 Example popup Rebooting dialog After a minute or so you should be able to re-establish a platform connection, and a minute or so after that, a station connection. The EC-BOSAX should also be available on the newly added WLAN, via its installed wireless adapter. Note: For more details on the platform TCP/IP Configuration view, see “TCP/IP Configuration” in the Platform Guide. EC-NetAX-3.6 Engineering Notes: EC-BOSAX WiFi Option 5 About a discovered wireless network About the WiFi Configuration view November 2011 About the WiFi Configuration view The platform WiFi Configuration view (and equivalent station “WiFiPlatformService” under its PlatformServices) lets you discover 802.11b/g networks available to the EC-BOSAX, and add one or more networks, as necessary. Figure 6 WiFi Configuration view in platform connection to WiFi enabled EC-BOSAX (e.g. EC-BOS-7AX) Figure 6 above shows an example view for an EC-BOS-7AX with an added network (SSID of “Bnet_Plant”), which is currently connected. This view is split into three main areas, described as follows: • Wireless Host Settings Read-only status properties as follows: • Wireless Enabled — either true (typical) or false • WiFi Daemon Status — reflects current status of underlying WiFi daemon, such as “Completed” (typical) or “Scanning”. • Current Adapter — the TCP/IP interface name for the WiFi adapter, different from such interface names for the EC- BOSAX’s Ethernet LAN 1 port (en0) or LAN2 port (en1). • Wireless Networks Split into two separate panes: • Discovered Networks Reflects results of the last Discover, listing available wireless networks, by SSID, BSSID, signal strength, and so on. Buttons below allow you to Discover and Add Network. Note: During a discover, any network in the lower Network Database pane that was previously “Connected” becomes “Disconnected”—a popup confirmation dialog appears to warn you of this too. Immediately following a discovery, such a network’s status changes back to “Connecting” and then when handshaking completes, “Connected”. Therefore, keep in mind that any station or platform access connected over wireless (bc0) will be dropped upon a discover. • Network Database Lists the wireless network(s) persisted in the platform’s configuration, along with corresponding polled status and signal strength. If more than one network is added, note that only one can be “Connected” at any time. Buttons below provide various functions—see “About Buttons in WiFi Network Database” on page 9. About a discovered wireless network In the typical case where the WiFi router /access point broadcasts its SSID (Service Set Identifier), you should use the Discover feature to learn and then add a wireless network. This greatly simplifies setup. Various configuration information is received and automatically seeded in the resulting add dialog, as shown in Figure 7. Note: The “Priority” property (0 to 10, default 0) does not reflect any configuration of the router/access point. Instead, it can be used in a “multiple network” setting to specify the preferred network for connection to the EC-BOSAX, by highest priority number (overriding just “strength”). See the Roam button description in “About Buttons in WiFi Network Database” on page 9. EC-NetAX-3.6 Engineering Notes: EC-BOSAX WiFi Option 6 About the WiFi Configuration view About a discovered wireless network November 2011 Figure 7 Example “Add a Wireless Network” dialog for a discovered WiFi router Note: The checkbox “SSID Broadcasted” was added starting in the 3.6.44 maintenance build and later, and for any discovered router/access point will always be checked (set) and read-only. Typically, this dialog’s OK button becomes enabled only after you enter a Network Key (password) value in its “Network Security Options” area, which you should re-enter as Confirm Network Key. In the example above, the router was discovered to be using channel 6 along with a security type of “WPA-PSK” with encryption method of “TKIP”. Although the security/encryption settings could be manually overridden in this dialog, in this case it was unnec- essary—only the network key required entry (twice) for the network to allow connection. A router/access point discovered using another security type can require different entries. For example, with WEP security, a hexadecimal numeral “key” must be entered that matches the indexed key. Figure 8 Example “Add a Wireless Network” dialog for a discovered WiFi router using WEP-40 security In the Figure 8 example for WEP-40 se