Convert a DLGW3 from LightRules to SiteWorx

Convert a DLGW3 from LightRules to SiteWorx

Alert
This guide only applies to DLGW3-LR gateways. All DLGW3-LR's have serial numbers beginning in 0202XXXX and have model number "DLGW3-LR" on the front serial number label. DLGW2 units are not compatible.
Warning
DLGW2 gateways are not compatible with SiteWorx and cannot be converted.

Before you Start

Check Gateway Mode

Confirm the DLGW3-LR is in LightRules mode by powering the DLGW3-LR and viewing the Mode status indicator.
  1. LightRules mode
    1. Blinking yellow (OS 1.1.0+)
    2. Solid yellow (OS 1.0.0)
  2. SiteWorx mode
    1. Solid green
Info
If you are uncertain on the color or pattern of the Mode status indicator, the mode can be also checked using either the Convert DLGW3-LR feature in Commissioner or gw3cli.

Gather Necessary Items

  1. Micro USB cable (Micro USB-B)
  2. Computer
  3. DLGW3-LR
  4. Commissioner software - click here to download 

Commissioner Convert DLGW3-LR Method

  1. Connect a Micro USB-B cable to the port labeled Micro USB on a DLGW3-LR. Connect the other end of the cable to a laptop running Commissioner.
    1. Unlike static IP programming, it does not matter if there is an ethernet cable connected to the gateway.
  2. Wait at least 45 seconds for the DLGW3-LR to boot.  When the gateway is ready for programming, the System status LED on the ethernet side of the gateway will be solid blue.
  3. In Commissioner, select the Map menu, select Gateways and Convert DLGW3-LR.

  1. In the Find Gateway step, Commissioner will confirm it can communicate with the gateway and also check if the gateway is in LightRules mode. If Commissioner is able to communicate with the DLGW3-LR, the Convert Gateway option will be available. Click Convert Gateway to proceed.

    1. If Commissioner cannot communicate with the gateway, you may need to wait longer for the gateway to finish booting at which point the System status LED on the gateway to be solid blue. Also check that the micro USB cable is properly connected to the DLGW3-LR and the laptop with Commissioner. 
    2. If the DLGW3-LR is already in SiteWorx mode, you will see the below message. If you wish to proceed and update the gateway firmware, click OK.
  1. Click OK to proceed past the warning message

  1. The mode change and updates consist of several steps and will take several minutes per gateway. Commissioner will display the time and status as the updates progress.
  1. Once the mode conversion and updates are complete, you will see the Please disconnect your gateway message.

Old GW3CLI Method

Warning
Only use gw3clli if advised by SiteWorx Support. The Convert DLGW3-LR feature in Commissioner is the preferred method in almost all scenarios as it both changes the gateway mode and updates the gateway firmware.
Mac
  1. Download and unzip gw3cli-macos-1.2.4. Drag the unzipped file into your Desktop.
  2. Open Terminal and change directory to to your Desktop directory where the gw3cli tool is located.
    1. To do so, type in cd ~/Desktop/




  3. Enter command ./gw3cli this will show you the help menu with all commands and options



    1. If you see the "gw3cli cannot be opened.." message, the click Cancel



    2. Navigate to System Settings > Privacy & Security, then click Allow Anyway



  4. Connect the DLGW3-LR to your computer via Micro USB cable and wait a few minutes for the DLGW3-LR to complete booting.
  5. Enter command: ./gw3cli get-status
    1. This will display the serial number and versions of all software.
  6. Enter command: ./gw3cli get-config
    1. This will display the configuration of the DLGW3-LR.



  7. Look for mode in the setup section
    1. "gateway2.emulator" indicates the DLGW3-LR is in LightRules mode
    2. "gateway3.engine" indicates the DLGW3-LR is in SiteWorx mode
      1. Only proceed if mode is "gateway2.emulator"
  8. To switch from LightRules mode to SiteWorx mode, enter command: ./gw3cli set-config '{"setup":{"mode":"gateway3.engine"}}'
  9. Enter command: ./gw3cli restart-app
  10. After gateway reboots, verify the changes were completed by checking that mode is now "gateway3.engine"



  11. Email SiteWorxOps@siteworx.io the serial numbers of the DLGW3-LRs that were converted from LightRules mode to SiteWorx mode. The DLGW3-LRs will need to be registered to SiteWorx by SiteWorx Operations before the DLGW3-LRs will connect to SiteWorx.
Windows
  1. Download and unzip gw3cli-win32-1.2.4.zip Drag the unzipped file into your Desktop.
  2. Ensure the latest version of Commissioner is installed to ensure USB drivers are up to date:
    1. https://commissioner.lightrules.net/Content/English/Home.htm
  3. Click Start, and search for cmd to open CMD prompt.
  4. Enter command: cd Desktop
  5. Enter command: ./gw3cli.exe
    1. This will show you the help menu with all commands and options.



      The exact syntax of the below commands will depend on where the file is saved and the configuration of your computer. If you are not comfortable with Command Prompt, the easiest thing to do is drag and drop the gw3cli.exe file into Command Prompt to start each command and then manually type the portion of the command after gw3cli.exe For example to do the gw3cli.exe command, drag gw3cli.exe into the Command Prompt and then press the Return/Enter key. To do the gw3cli.exe get-status command, drag gw3cli.exe into the Command Prompt and then type get-status and then press the Return/Enter key.

  6. Connect the DLGW3-LR to your computer via Micro USB cable and wait a few minutes for the DLGW3-LR to complete booting.
  7. Enter command: ./gw3cli.exe get-status
    1. This will display the serial number and versions of all software.
    2. If this command fails to read the serial number from the gateway, please email SiteWorxOps@siteworx.io with a screenshot of Command Prompt as an additional driver may need to be installed.
  8. Enter command: ./gw3cli.exe get-config
    1. This will display the configuration of the DLGW3-LR.
    2. Look for mode in the setup section:
      1. "gateway2.emulator" indicates the DLGW3-LR is in LightRules mode
      2. "gateway3.engine" indicates the DLGW3-LR is in SiteWorx mode
        1. Only proceed if mode is "gateway2.emulator"
  9. To switch from LightRules mode to SiteWorx mode, enter command: gw3cli.exe set-config {\"setup\":{\"mode\":\"gateway3.engine\"}}
  10. Enter command: ./gw3cli restart-app
  11. After gateway reboots, verify the changes were completed by checking that mode is now "gateway3.engine"
  12. Email SiteWorxOps@siteworx.io the serial numbers of the DLGW3-LRs that were converted from LightRules mode to SiteWorx mode. The DLGW3-LRs will need to be registered to SiteWorx by SiteWorx Operations before the DLGW3-LRs will connect to SiteWorx.
 

    • Related Articles

    • SiteWorx Gateway Connection - IT Information

      Firewall Ports Gateways must be able to connect to reliable high-speed internet, with outbound firewall access to the following standard ports. Inbound access can remain blocked. 443 (HTTPS - TCP): Secure HTTP, used for SiteWorx core services 8444 ...

    • How to Statically Address a Gateway 3 (DLGW3)

      This guide only applies to gateways of model DLGW3-LR or DLGW3. These products will have serial numbers beginning in 0202XXXX. Before you Start Gather Necessary Items Micro USB cable Computer, with Commissioner 3.4.1 or later DLGW3 or DLGW3-LR “Live” ...

    • Add a Gateway

      Click Lighting Gateway Select Manually add gateway information to the map and then click Next Enter all lighting gateway information, associate the lighting gateway with the desired network, and then select the lighting gateway type (refer to the ...

    • Gateway Connection Troubleshooting

      Live Gateway Connectivity Status Admin users can view the live gateway connectivity status in the Admin Console by clicking the user icon in the top-right of any SiteWorx page and selecting Admin from the drop-down menu. Once in the Admin Console, ...

    • Installer Gateway Connectivity Tool

      Resellers have access to an online tool to check gateway connectivity status for newly connected gateways. This is a helpful tool to confirm IT departments have configured ports correctly before traveling onsite for commissioning, or requesting ...