This proposal is a draft and subject to change.
This article describes the general process and steps for performing commissioning for an XPoint Wireless network. Basic troubleshooting and initial configuration steps are included as well.
This document focuses on performing commissioning for new installations, any installation which has previously been commissioned should be discussed with product management and engineering prior to scheduling service.
- A colloquial term for an XPW BRG that is used to refer to using an XPW BRG for the purposes of rescuing an XPW device
- Refers to an XPW device which is running a firmware version which is not compatible with SensorView (< 2.5.x, typically listed as 0.0.0.0 in the routing table)
- The process of specifying RF configuration for an XPW BRG and the associated XPW devices along with virtual port configuration for devices
- An operation that refers to using an XPW BRG to find the RF channel a device is operating on (and subsequently commissioned to join a different configuration) or a command to instruct a XPW device to search the available RF channels for a specific device ID and bring it back to the currently programed network configuration (of the device doing the rescuing)
- A file that is kept on each XPW BRG which lists XPW devices that have communicated with it (at some point in the past).
- A device that, for whatever reason, does not have any devices in range of its RF to communicate with. This can trivially come about during a replace or addition operation in which the device network is not using the factory default RF configuration. It may also come about if a device fails to receive a command to migrate to a new network. Typically a rescue operation or a field bridge is used to restore connectivity.
- A feature within the XPW commissioning process which allows the user to specify a "port" (similar in function to an nBRG8 port) a XPW device should organize under. Devices operating in a local port are able to communicate with local channels and participate in Preset Scene (Local) and Profile Scene (Local) functions.
Prior to commissioning a system ensure the following:
- Confirm IP enabled devices (nGWY2, XPA BRG) are connected
- Confirm installer access to the IT subnet the XPA BRG is connected to (or confirm direct access to XPA BRG)
- Electrical contractor should provide completed floorplan with barcode locations for installed XPoint Wireless devices
- Sequence of operations description
- Any specific RF network requirements dictated by the customer (RF channel, network security key)
At a high level the commissioning process consists of the following steps:
- Commission nGWY2 and XPA BRG devices
- Bind XPA BRG to associated nGWY2 (as appropriate)
- Perform updates for all XPA devices older than version 2.5.x (which are incompatible with SensorView)
Commissioning nGWY2 and XPA BRG
Prior to commissioning XPA devices the XPA BRG and nGWY2 should be commissioned, this includes setting up IP configurations and performing firmware updates on the devices.
The IP configuration for the nGWY2 is performed, as normal, through the nGWY2 GFX device. IP configuration for the XPA BRG is performed through the Network config tool, which is bundled with the SensorView installer (requires at least SensorView 13.0) and available through the start menu. TODO: provide document on using Network config.
As usual the desired IP configuration for nGWY2 and XPA BRG devices is dictated, solely, by the customer's IT department. This information must be provided to us prior to commissioning. In general Acuity advises static IPs be used for this configuration.
Firmware updates for the nGWY2 can be performed through SensorView as normal. Connect to the nGWY2 via Ethernet, log into SensorView, and perform the updates on the Updates page.
Firmware updates for the XPA BRG are not currently supported in SensorView. Refer here for instructions on how to perform this update. The firmware update file to use (.tar file), should be provided by engineering.
Similar to nWIFI the XPA BRG must be "bound" to the appropriate nGWY2. This involves:
- Confirming the desired nGWY2 and XPA BRG device are on the same IT subnet
- Using SensorView to bind the XPA BRG to the nGWY2 (only if an nGWY2 is in use on the site, otherwise skip)
- Connect the commissioning computer to the same subnet as the desired XPA BRG
- Run the nCOMKIT and select Wireless as the connection mode and press Start
- Go into SensorView and wait for the XPA BRG to be discovered (basically the same as for nWIFI)
- Click on the XPA BRG in the device tree and then select XPoint Associations
- Enter the IP address of the desired nGWY2 and save the changes for the XPA BRG only, do not modify the pre-loaded RF parameters, these defaults will be needed to commission the XPA devices
3. Disconnect the nCOMKIT
How to manually enable WI-FI on the nGWY gateway via G2 gateway screen :
Touch Lock symbol> enter password ( default 1234 ) > select Gateway Set Up > select down arrow to go to second screen options > Select configure wireless > select
Typically firmware updates for devices should be rolled out overnight, similar to nLight commissioning, but it may be necessary to perform firmware updates if devices on the network are not yet compatible with SensorView. Instructions for viewing a list of devices controllable from the XPA BRG are available here, if the firmware version field for any devices shows 0.0.0.0 then a firmware upgrade for it is required prior to proceeding with commissioning. Review instructions here for performing firmware device updates, engineering will need to supply the appropriate .ota file to use for the update.
Out of the box all XPW devices, and XPW BRGs, operate with the same RF configuration, and as result will immediately form a network. For smaller deployments this is ideal, the mesh forms automatically and as a user you're ready to go quite quickly. But for larger installations, typically those with more than 250 devices or multiple XPW BRGs (which often go hand in hand) a situation can arise in which the network becomes too big to optimally function for lighting control purposes; the degree to which optimal functionality is diminished by overall device count is dependent on a large variety of factors, but in general a XPW BRG should only have up to 250 devices associated with it.
The RF configuration for the XPW BRG and its associated devices are specified at the same time (to prevent them from falling out of sync and resulting in loss of communication). Beyond inheriting the RF configuration of the specified XPW BRG migrated devices can also have a virtual port selected. In short hand this is the wireless equivalent of "plugging in to an nBRG port" in the nLight world. Virtual ports allow the user to specify meaningful relationships between the devices within them, such as for a private office, a hallway, or a row of inter-operating lights. All devices in a virtual port can communicate with one another via local channels; global channels, of course, span the entire lighting control network. It is for this reason (specifically scope of channeling and scenes) that it is recommended to consult the user's desired sequence of operations prior to specifying the virtual port for devices.
For all installations migration is a required step. However, for smaller networks it is not required that the default RF channel and PanId be changed. All devices must be assigned a virtual port, even if they are all assigned the default port of 1.
The general process for performing migration is as follows:
- Consult sequence of operations manual to determine optimal virtual port associations amongst devices
- Click on the XPW BRG device you'd like to perform migration for in the device tree
- Click on the XPoint Associations tab on the far right of the screen
- Specify the desired RF configuration (Channel, PAN, and security key, the upstream nGWY2 IP should have already been set during the binding phase)
- When migrating devices in a multi-XPW BRG installation it is highly recommended not to re-use channels, if an installation becomes large enough such that all channels will be required consult engineering regarding how to proceed
- In most all situations the PAN ID field can be left to Default
- If a custom security key is requested by the customer check the Change Security Key box and input the requested passkey
- For all XPW devices which should be associated with the selected XPW BRG:
- Use the Virtual Port drop down to pre-select what virtual port the next entered device will be added to
- Either scan the barcode on the device / floorplan or manually enter the device ID to add it to the table
- At this point the application will periodically attempt to ping the device to determine its online status
- If needed you can use the curtsy button to force the device to toggle its output status and identify itself, if needed
- A custom label can be added to the device at this point
- Once all devices have been added select Send Parameters, this will push the specified configuration to the device, but will not have them migrate yet
- Sending parameters, but not immediately migrating is intentionally separated to afford the user the opportunity to address any connectivity problems prior to performing the migration; because XPW is a mesh network, prematurely migrating devices may result in a fragmented network and require the use of a field bridge to recover
- TODO: add states for this column
- Press Migrate to instruct all devices to move; depending on the number of devices it may take 1 to 2 minutes for the network to come up
- TODO: add states for this column
The image below highlights the key components of the interface used throughout the above process:
Sequence of operations programming
After migrations have been completed the network is ready to receive programming for sequence of operations. At this point, programming XPoint devices is largely the same as nLight devices.
Unlike nLight devices, XPoint devices can broadcast on multiple channels at once.
Global channels are confined to a single XPA BRG, but can be used to span virtual ports. The exception is that nLight switches can control XPoint global channels.
XPoint Wireless Device Settings Unique Default (Master) Settings The following Default Master Settings are unique for XPoint Wireless devices. They cannot be changed as part of a system Profile.
- Trim Levels
Low / High Trim voltages are intended to be combined with XPoint Low / High Trim percentages to calibrate a linear relative light output setting for the luminaire or controlled load.
- Low/High Trim (Voltage)
- Use the low end voltage to define the minimum light output of the controller. Typically this should correspond to the driver/ballast’s 0-10 voltage at which light output is lowest (not off). This setting may also be used to increase the trim level if minimum light output desired is greater than the driver/ballast capability (e.g., wishing for lights not to go below 5% if using is a 1% dimming driver).
- Use the high end voltage to define the 0-10 voltage at which the driver/ballast produces its maximum light output. It is not necessary to use this setting to trim available maximum light output – see below, XPoint Low/High Trim.
- XPoint Low/High Trim (% Light Output)
- Set low end to correspond with the percentage of relative light output that the driver/ballast is specified to deliver at the Low Trim Voltage setting. For example, if this is a 10% dimming driver/ballast, then the setting should be “10%.” If this using a 0.1% dimming driver, use 1% for this setting.
- Set the high end to correspond with maximum relative light output desired from this luminaire. This setting allows the user to more easily estimate targeted adjustments to light levels, for example for lumen management purposes, and to also see how much reserve lighting capacity may be available. For example, if it is determined that the space illuminance is 50 footcandles at max lumen output, and the space requirement calls for 40 footcandles, then the XPoint High Trim % should be set to 80%. If this level needs to be increased in the future, then it is clear that there is an additional 20% relative light output available for this luminaire.
- Fast Ramp Rate
This setting adjusts the rate of manual wall control dimming and also the “Fast Ramp” transitions that can be used in occupied-to-idle transitions or Profile light level transitions (when changing Occupied Bright Light level via Current Settings or with a Profile Change). The setting defines the amount of time that the controller takes to adjust its dimming output from 100% to 1%, and vice versa.
- Slow Ramp Rate
This setting adjusts the “Slow Ramp” transition dimming rate that can be used in occupied-to-idle transitions or Profile light level transitions (when changing Occupied Bright Light level via Current Settings or with a Profile Change). The setting defines the amount of time that the controller takes to adjust its dimming output from 100% to 1%, and vice versa. This is typically used to support occupied-to-idle transitions in parking garages, stairwells, corridors, and other public spaces where visible transitions in light levels are undesirable. This setting can also be used for Profile transitions, such as astronomical time clock or demand response curtailments where gradual adjustments in light level are desired.
- PIR Sensitivity
This adjusts the sensitivity of the occupancy sensor’s pyrolytic infrared (PIR) trip level. Factory default is 96. 100 is the highest sensitivity available and 0 completely disables the sensor’s response. Reducing this sensitivity may be desirable in outdoor applications or where HVAC equipment is tripping the occupancy sensor.
- Sensor Timeout
This defines the amount of time it takes for a controller to revert to “Occupied Bright Level” and/or “Daylight Level Bright” if it is tracking occupancy or photocell channels and it has not received any broadcasts messages from any devices on that channel (including itself, if it is enabled for broadcasting). Light level will only revert to Occupied Bright / Daylight Level Bright (whichever of the two is lower) when all broadcasting sensors in the channel have not been not heard from; for example if there are 4 broadcasting devices in the channel and 1 of them stops broadcasting, the light level does not revert because the others on the channel are heard from within the Sensor Timeout period.
Special Operating Modes
The following Special Operating Modes are unique for XPoint Wireless devices and may be configured and saved to a Profile.
Normal operating mode is different in XPoint Wireless from nLight. The lights automatically respond to occupancy and daylight control settings based on whichever strategy results in the lowest light level. For example, if the unoccupied dim level is 20% but the daylight control point is at 1%, the daylight setting takes precedence. Manual switch adjustments to light levels (local or global) are maintained until one of three conditions are met: either the occupancy time delay timer expires and the area becomes unoccupied, a Profile is re-applied to the controller, or SensorView is used to apply a settings change to the device.
- Semi Auto
Lights are off until manually turned on by the occupant. Lights turn on to previous level. Daylighting controls (if enabled) automatically adjust light level unless adjusted by the occupant, at which point the light level is maintained under the same conditions as Normal Mode. Grace Period is automatically enabled following shutoff and is factory set at 30 seconds.
Because Switch Timers are not enabled in XPoint Wireless, all of the Special Operating Modes that use Overrides (e.g., Auto to Override On) are not supported by XPoint Wireless. Other Special Operating Modes not discussed here are not supported by XPoint Wireless.
The following Profile Settings are unique to XPoint Wireless devices and may be configured and saved to a Profile.
- Profile Ramp Rate
This setting indicates whether the Occupied Bright Level transition occurs using the Slow Ramp Rate or Fast Ramp Rate. This setting impacts Occupied Bright Level if it is changed as part of a Profile being applied or from SensorView as a change to Current Settings.
- Operating Mode
Applying “Commissioning Fast Response” setting temporarily shortens all occupancy and daylight time delays to 5 seconds and provides instant feedback that broadcasting and tracking devices are properly configured. This setting can be enabled to test Control Zone Settings, especially if the project is being reviewed by an onsite Acceptance Test technician or 3rd party Commissioning agent. This setting automatically reverts back to “Normal” after 5 minutes. Normal setting uses the occupancy and daylight time delays specified in Current Settings.
The following Profile settings function the same in XPoint Wireless as in nLight devices:
- Override (Normal/OFF/ON)
Other Profile-specific settings not discussed here are not supported by XPoint Wireless.
Occupancy and Dimming Settings
The following Occupancy Settings are unique to XPoint Wireless devices and may be configured and saved to a Profile.
- Occupancy Ramp Rate
This setting indicates whether the occupied-to-idle dimming transition occurs using the Slow Ramp Rate or Fast Ramp Rate.
- Occupancy Broadcasting (Enabled/Disabled)
Disabling this setting prevents the occupancy sensor from controlling its own relay/dimming state and also prevents the sensor from broadcasting sensor updates, even if it is designated as a broadcasting device in the Control Channels interface. When this setting is disabled, the sensor may still be allowed to track and respond to other occupancy sensors as defined by the occupancy and Special Operating Mode settings.
Enabling Occupancy Broadcasting without any Local Channel broadcasting and tracking memberships will enable this device to control itself as a standalone (non-networked) occupancy sensor.
The following occupancy settings function the same in XPoint Wireless as in nLight devices:
- Unoccupied Dim / Occupied Bright Levels
- Occupancy Time Delay
- Idle Time Until Dim
- Maintain Dim Level when Vacant (No/Yes)
Other occupancy and dimming-specific settings not discussed here are not supported by XPoint Wireless.
The following Daylight Settings are unique to XPoint Wireless devices and may be configured and saved to a Profile.
- Photocell Broadcasting (Enabled/Disabled)
Disabling this setting prevents the photocell from controlling its own relay/dimming state and also prevents the sensor from broadcasting sensor updates, even if it is designated as a broadcasting device in the Control Channels interface. When this setting is disabled, the sensor may still be allowed to track and respond to other photocells as defined by the daylight and Special Operating Mode settings. If a sensor-controller is a member of a daylight control zone, and is not designated as the master photocell for the zone, then Photocell Broadcasting should be Disabled.
Enabling Photocell Broadcasting without any Local Channel broadcasting and tracking memberships will enable this device to control itself as a standalone (non-networked) daylight sensor.
- Daylight Method
Daylight Method is a new setting used to configure how a sensor/controller responds to photocell broadcasts or its own light measurement.
- Closed Loop Continuous
This setting should generally be used when the photocell is controlling itself (e.g., fixture-mounted sensor), or when the controller is responding to a broadcasting photocell that can also view the task area within the daylight zone. Closed Loop Continuous response is calibrated with a single-point setting (Set Point Dim). In this mode, the controller assumes that the Set Point Dim level is equal to the photocell sensor reading when there is no daylight and 100% electric light. The electric light contribution is automatically compensated for when responding to photocell readings above the Set Point Dim level. Auto-Setpoint is not supported in XPoint Wireless. Sunlight Discount Factor is set at 4 by default.
- Set Point Dim
Set Point Dim, in Closed Loop mode, is the same as the nLight photocell setpoint. This should be set to the sensor’s photocell reading when there is no daylight contribution and 100% electric light contribution. Setting this number lower than this will trim the electric light output. Setting this number higher will make the daylighting response less aggressive and delay the dimming start of the daylight response.
- Open Loop Continuous
This setting should be used when the broadcasting photocell does not view the task area within the daylight zone and is instead primarily viewing a daylight aperture or a surface only affected by daylight contribution (such as a skylight well or skylight lens). Open Loop Continuous response is defined by a two-point linear curve.
- Set Point Bright
Photocell readings higher than level this result in reduced light levels.
- Daylight Level Bright
This is the electric light output by the controller when photocell readings are at or below the Set Point Bright. Typically it is best to use 100%. Daylight Level Bright settings below 100% can be used to trim the electric light levels to achieve the specified task illuminance.
- Set Point Dim
This is the photocell reading at or above which the controller should reach its lowest electric light output.
- Daylight Level Dim
This is the electric light output by the controller when photocell readings are at or above Set Point Dim setting. Typically it is best to use 1% but higher levels may be used if a minimum look of luminaires on the ceiling should be maintained.
- Dimming Rate
This setting adjusts the rate of photocell dimming response to changes in light level readings.
- Photocell Control Demo
Enabling this setting allows the photocell to maintain automatic control of light level regardless of whether manual wall controls have been used to adjust light level. This setting also disables adaptive photocell transition off delay, so that lights can respond quickly to changing photocell readings. This is commonly used during a system demonstration, so that shining a light into the photocell will always result in a change in light level even if manual adjustments have been made.
The following daylight settings function the same in XPoint Wireless as nLight:
- Photocell Transition Off
This is the amount of time that the controller spends at the lowest electric light level before completely shutting off the lights. Use “Never” if lights should never be turned off.
Sunlight Discount Factor is set to 4 by default and not configurable in SensorView.
Other daylight-specific settings not discussed here are not supported by XPoint Wireless.
Daylight Application Notes:
Secondary Daylight Zones as required by certain energy codes can be programmed to track the same broadcasting photocell as the master zone, but with higher Set Point Dim levels to accommodate the reduced amount of daylight available in these zones.
Parking Garage Adaptation Zones as defined in IES Recommended Practice should be configured with Astronomical Timeclock Profiles, where Occupied Bright level is set high during daylight hours (e.g., 100%) and programmed to a reduced level (e.g., 10%) during night time hours.
The good news when it comes to troubleshooting wireless networks, as opposed to wired networks, is that the quality of cabling is not an issue! The bad news, however, is that troubleshooting RF connectivity can be tricky. A number of tools and techniques are available to the commissioning agent in this regard:
- The routing table on the XPW BRG provides insight to the firmware version of connected devices and tiemstamps of their last network activity
- Field bridges are typically used to rescue devices which may be isolated on an RF network and needs to be re-programmed to restore communication
- The rescue operation instructs a device to search other RF channels for a particular device, based on serial ID, this is a pre-requisite to performing a replace operation (unless the factory default network configuration is in use at a site)
- RF scan: This tool scans all RF channels and reports back a list of RF channels and PanId's where it sees activity. The report can be found on the home page of the XPA BRG (click on the URL link under Advanced Details on the XPA BRG Properties Page). This can be useful to identify active existing networks or "lost" devices.
Each XPW BRG publishes a routing table which lists basic information about devices the XPW BRG has communicated with. The maximum size of the table is quite large (~2,000 devices), much larger than the recommended capacity (250) of the XPW BRG, and as a result may list offline devices the XPW BRG is no longer in communication with. Whenever the XPW BRG is rebooted the routing table will cleared and recreated with devices currently on the same RF settings.
The routing table is useful for:
- Verifying that a given XPW device has, or currently is, in communication with the XPW BRG
- If a device used to be in communication with an XPW BRG the routing table will list its prior RF configuration
- Detecting if any legacy devices exist on the network. Firmware version for legacy devices will appear as 0.0.0.0.
Note: If the time on the XPW BRG is not configured to sync with a network source it may be off (due to differences in assumed time zone, clock drift, etc). If using fields that rely on timestamps it is recommended to refresh the page and look for updates to the values, rather than basing decisions on the raw value directly (i.e. don't assume just because a timestamp is technically from three hours ago that the difference in time isn't just due to the time zone configured on the device).
A field bridge is often used when an XPW device has been stranded on an RF channel a field bridge is deployed to restore communication to that device and re-program its RF configuration. To do this:
- Select the field bridge in the device tree (at this point it is assumed the chosen bridge is in RF range of the desired device)
- Go to the XPoint Associations tab
- Modify the RF configuration and select Change bridge only
- Scan the device in via the migration process and send it (and the field bridge) to the desired RF configuration
- Disconnect field bridge
A rescue operation is typically used when a device has been stranded, but would be in RF range of another nearby device that is already on the desired RF configuration. A rescue operation can be initiated by:
- Selecting the XPW BRG you'd like the stranded device to be associated with in the device tree
- Select XPoint Associations
- Select Rescue
- Input the serial ID of the device you'd like to perform the rescue along with the serial ID of the device you'd like to rescue
- Push the Rescue button
During a rescue operation the chosen XPW device will scan all available RF channels in search of the stranded device. If that device is found the rescuer will program the rescuee with the original RF configuration and both devices will rejoin the network. During this operation the rescuer device will not be able to communicate with the associated XPW BRG, and may be offline in SensorView. Throughout (TODO: provide screenshot) the operation SensorView will attempt to ping both devices to determine if they have successfully rejoined the network.
This is initiated by the Start button on the Network Scan tab of the XPoint Associations section of the XPA BRG. The scan length controls how long the scanning process takes - a longer scan is more likely to find any given device. One the scan is initiated, click on the link below the Start button to see the results. Note: The results page is currently generated only once every minute - check the timestamp at the top of the RFScan.html page to make sure the results are current. Refresh the page to update the results if they are not current.