Skip to content

Installation and Setup

rstrouse edited this page May 15, 2020 · 3 revisions

Installing the Plugin

This plugin is manually installed on your Vera device. As of this moment the plugin is not available in the Vera App Store.

To install the plugin:

  1. Download all the files in the plugin directory.
  2. Open the Vera web interface
  3. From the menu choose Apps --> Develop Apps then select the Luup Files menu on the Develop apps page uploadPluginFiles
  4. Drag all the files that you downloaded from the plugin directory onto the upload section.
  5. Vera will go through a luup reload so give her a minute to catch up.
  6. After Vera has finished reloading the Luup engine click on the Create Device menu to create a new device.
  7. Fill out the fields as you see them on the screenshot below IMPORTANT the device file must use the same capitalization as shown.
  • Upnp Device Filename D_PoolController.xml createDevice
  1. When You go back to your devices you will now see a Pool Controller device in the interface. If you do not see the device, hard refresh your browser by choosing Ctrl + F5.

Configuring the Plugin

Before You Begin, enable the Vera interface on the nodejs-PoolController server:

  1. Open the config.json file in the root directory of the installed nodejs-poolController server.
  2. Scroll down to the interfaces section and put the local IP address of your Vera in the options section of the interface and set the enabled property to true. Replace XXX.XXX.XXX.XXX with your Vera IP address.
  3. Enter the Vera device id of the Pool Controller device that we created in the previous step. To find the device id click the right arrow on the device, choose advanced and the device # will be shown directly under the menu.
      "vera": {
        "name": "Vera",
        "enabled": true,
        "fileName": "vera.json",
        "vars": {
          "deviceId": 237
        },
        "options": {
          "host": "XXX.XXX.XXX.XXX",
          "port": 3480
        }
      }

To configure the plugin:

  1. Click the right arrow on the Pool Controller device.
  2. On the top of the screen click the Configure menu to reveal the Equipment Panel Configuration options
  3. Enter the IP address for the nodejs-poolController server in the poolController IP Address field. If you have added a username and password to the server then you must enter the username and password in the provided fields. connectionSetup
  4. When you have completed your setup click the Save Changes button and Vera will begin reloading the Luup engine.
  5. Once Vera has reloaded the plugin will load all the Circuits, Features, Bodies, Pumps, Chlorinators, and Groups will appear in the Vera device list.

Troubleshooting

Issue Problem Suggested Resolution
Error when pressing Save Changes on the Configuration Vera security is blocking the changes Uncheck Secure Vera and check Enable potentially unsafe lua code... under Users & Account Info --> Security
Error when pressing Save Changes on the Configuration Vera relay is blocking the changes Log into your Vera using the local IP address prior to making changes. Once you have resolved your configuration issues you may then log in again through the Vera relay servers at getvera.com.
No pool devices appear Refresh your Browser Press ctrl + F5 or choose refresh from your browsers menu.
No pool devices appear poolController IP address is not correct Open a browser window and test the IP address by entering <IP address as you entered it into the plugin>/state/all. This should return a full dump of all devices on the nodejs-poolController.
Some pool devices appear incorrectly on the mobile app Vera is sometimes lame Each Vera device type is custom coded in the Vera mobile application. Plugin developers do not have access to create interfaces in that environment and over the years Vera does not have a history of creating them outside of known devices in the wild. The complaint department on this one is getvera.com but experience has borne out that you will not get the desired results.

Clone this wiki locally