djtimca / haomnilogic

Hayward Omnilogic integration for Home Assistant available through HACS
Apache License 2.0
17 stars 6 forks source link
hacs-integration hayward homeassistant homeassistant-custom-component homeassistant-integration omnilogic

Hayward Omnilogic Pool Controller

Buy me a coffee hacs_badge

This integration will provide sensors and control for Hayward Omnilogic based pool controllers.

Sensors include:

Controls include:

Install

Once installed, go to Configuration -> Integrations and click the + to add a new integration. On new instances of Home Assistant, Settings -> Devices & Services -> Integrations and click the "+ ADD INTEGRATION" in the bottom right to add the Omnilogic integration.

Search for Omnilogic and you will see the integration available.

Click add, confirm you want to install, and enter your username (not email) and password for your Hayward Omnilogic App login and everything should be added and available. A restart will be necessary in the process.

Repository Missing from HACS Integration Search

If the Omnilogic integration isn't found, you may have to add the repository to HACS using the following steps

  1. Open the HACS page/tab in Home Assistant
  2. Navigate to the "Integrations" tab
  3. Click on the three dots in the top right hand and select "Custom repositories" from the list of options
  4. Copy and paste this repoistories link https://github.com/djtimca/haomnilogic and paste it into the "Repository" input field
  5. Select "Integration" from the "Category" dropdown
  6. Click "Add"
    • Allow a few seconds for HACS to pull the latest information and data down. Once available, you'll be able to follow the install instructions above

Enjoy!

Integration Usage

Hayward OmniLogic smart pool and spa technology control.

There is currently support for the following device types within Home Assistant:

Tips for Usage

Review the Wiki for tips on how I have used custom cards and a few helpers/tricks to get the most out of this integration for my pool!

Sensor Platform Options

If you have pH sensors in your Omnilogic setup, you can add an offset to correct reporting from the sensor in the integration configuration.

Go to the Integrations page in setup and choose 'Configure' to adjust your offsets.

Switch Platform

The switch platform contains a custom service to allow you to set the speed on variable speed pumps.

To set pump speed, call the omnilogic.set_pump_speed service as following:

service: omnilogic.set_pump_speed
data:
  entity_id: Entity ID of the Pump
  speed: Speed (0-100%)

Note the custom service is only available for variable speed pumps.

Light Platform

The light platform allows you to set the color or effect of your lights from the effect list supported by your light version.

If you have V2 Colorlogic lights you can also set the brightness and speed of the lights using the custom service omnilogic.set_v2_lights as following:

service: omnilogic.set_v2_lights
data:
  entity_id: Entity ID of the Lights
  speed: Speed (0-8) for the light effect (optional)
  brightness: Brightness (0-4) for the lights (optional)

Debugging integration

If you have problems with the integration, the first thing we will need to troubleshoot is the telemetry for your pool setup. Please:

  1. Go to: https://replit.com/@djtimca/OmniTesting
  2. Hit the 'Run' button at the top.
  3. Enter your username and password
  4. Hit Enter to clear your credentials
  5. After the script finishes, your file names will be listed in the output (eg. output_116_5216g89yd5_telemetry.json, output_116_2859af29q03_msconfig.xml, output_116_c8528gw23y_telemetry.xml)
    • Click on the "Show Files" on the top left
    • Look for the respective file and click on it to open and view the content
      • It may be useful to CTRL+F for your file name as the sidebar view cannot be expanded
    • Copy the telemetry data from the files.
  6. Post your telemetry when you open an issue in this repository as a json/XML code block so we can review and troubleshoot