Vistapool Integration

uspino · July 29, 2019, 9:40am

I wish I could help you. Local access would be the ideal solution, but I’m guessing a lot of programming knowledge would be involved. I’m also trying to get this to work inside Home Assistant, but so far I’m unable to log into the web site with a Python script. Let me know if you get somewhere.

jiiins · July 29, 2019, 9:59am

I found the modbus platform and the modbus sensor, which look exactly like what we need.

I’m corresponding with the Vistapool guys to understand how to connect via TCP, as I’m unable to see any information. The only open port seem to be 23 (telnet), but by using it HA doesn’t report anything at all (no errors, nothing).

I keep you posted!

uspino · July 29, 2019, 10:03am

Were the Vistapool guys helpful? I’ve had no luck getting in touch with them…

jiiins · July 29, 2019, 10:09am

Until now very responsive. They sent me this doc which has all the modbus details, but I have no idea how to connect via TCP. As said, I can only go in via Telnet, but I’m totally out of my expertise.

uspino · July 29, 2019, 10:18am

If you log into your account and you go to http://vistapool.es/en/pool/getmainvalues?id=XXXX (change XXXX for your 4-digit pool ID) you get a json file with all the info. If you could ask them to explain how to access that page without having to log in (or maybe including login info in the url address) we could at least build sensors with all the info. Let know if I can help in any way, or any advance on your findings.

jiiins · July 29, 2019, 11:15am

In this thread you commented in, the last post seems to be correct to achieve that.

My objective is the local access, so I’ll keep digging!

kajmaj · July 29, 2019, 11:27am

I am digging as well
But I have a limited time to experiment at the moment.

In my understanding:
script itself should

go throught login and save cookies to an any local storage -it might be SD, NAS, USB - really des not matter.
open web from the link and write/rewrite data provided to local storage as well

If it works, HASSIO automation will fire a script in preset period and read dedicated data in json format
If it works, hypothetically it should be possible to extend it to the full control.

kajmaj · August 1, 2019, 10:21am

The only way to have full local controll is through MODBUS.
Related to the MODBUS.
There are three main issues:

How to read data from connected device registers
How to interpret data red from device.
How to control device (the most tricky, due to multiple confirmation needed for any change and possibility of bricking the device when data are written in inproper register)
Data itself are described in the document from vistapool (description of registers), it is relatively clear.
Some time ago I was experimenting with this
I was able to connect, read data (even by HASSIO modbus sensor) but they were different to the vistapool document, and I was not able to interpret them properly.
I do not know anybody who knows modbus on the needed level (format of data, parity etc.)
so the HF 2211 is somewhere deep in the drawer.

uspino · August 8, 2019, 2:52pm

I found a better way to do it. I wrote a simple Python script to log in and get all the values as sensor attributes. That way all is done by Home Assistant, with no outside PHP script being run.

You need to get your pool ID. It’s just 4 numbers you can get from the url address bar when you log into your account.

Then create this Python script (I save it as vista.py). Fill in your username and password and change 1234 to match your pool ID:

#!/usr/bin/env python
# coding: utf-8

# In[ ]:

import requests

# Fill in your details here to be posted to the login form.
payload = {
    'user': ‘[email protected]’,
'pass': ‘yourpassword’,
'remember_password': '0',
'entrar': 'Enter'
}

# Use 'with' to ensure the session context is closed after use.
with requests.Session() as s:
    p = s.post('http://vistapool.es/en/login/login', data=payload)


# An authorised request.
    r = s.get('http://vistapool.es/en/pool/getmainvalues?id=1234’)
    print(r.text)

Then create a command_line sensor pointing at the file. I chose to run mine every 10 minutes and timeout at 30 seconds if there are connection problems. You can include any of the json file values as json_attributes to the main sensor (temp). Just execute the scrip in a terminal window to see what values are available. Here’s the command line sensor and the extra sensor for what I wanted: filtration status, ph level and RX. I added | replace("º","") | replace("C","") to avoid duplication of the temp unit of measurement:

  - platform: command_line
    name: Pool
    scan_interval: 600
    command_timeout: 30
    json_attributes:
      - filtration_stat
      - PH
      - RX
    command: "python3 /config/www/vistapool/vista.py"
    value_template: '{{ value_json.temp | replace("º","") | replace("C","") }}'
    unit_of_measurement: '°C'
    
  - platform: template
    sensors:
      phlevel:
        friendly_name: pH Level
        value_template: '{{ states.sensor.pool.attributes.PH }}'
      filtrationstatus:
        friendly_name: Filtration Status
        value_template: '{{ states.sensor.pool.attributes.filtration_stat }}'
      rxlevel:
        friendly_name: RX Level
        value_template: '{{ states.sensor.pool.attributes.RX }}'

This script is obviously read-only, can not modify values on the server. My Python skills are worse than rudimentary so I have no idea how to do that, but at least you can monitor every aspect of the system.

kajmaj · August 10, 2019, 5:28pm

Thanks. Well done
Going to try right now.

Edited:

Hmm, did not work for me

Command failed: python3 /config/www/vistapool/vista.py
19:32 components/command_line/sensor.py (ERROR) - message first occured at 19:22 and shows up 2 times

I did copy-paste, the same folder, same sensors, well, except RX, changed login details and pool ID.
Other my scripts working well.

uspino · August 10, 2019, 5:40pm

Hmm, let me think about it, it’s working great for me. Did you create the vistapool dir?

kajmaj · August 10, 2019, 5:44pm

Yep. It is a real copy/paste, www/vistapool dir included.
I run Homeassistant 0.97.1

uspino · August 10, 2019, 6:10pm

What do you get when you run the py script in a terminal window? It should print out all the json values

kajmaj · August 10, 2019, 6:53pm

Traceback (most recent call last):
  File "C:\Users\B\python27\Scripts\vista.py", line 6, in <module>
    import requests
ImportError: No module named requests

uspino · August 10, 2019, 7:17pm

You need to update your python environment with pip install requests

kajmaj · August 10, 2019, 7:22pm

From a terminal window on Win 10, with requests installed, script works.
As I run hassio, there is no way to use pip

kajmaj · August 11, 2019, 5:48am

Uups . I’ve installed requests library through python_exec addon
Your script works now.
Thank you for guiding me

uspino · August 11, 2019, 7:47am

Glad it works!

jiiins · August 22, 2019, 1:54pm

How did you read the data via HASSIO modbus sensor? By using this I can’t get anything at all:

modbus:
  type: tcp #(or rtuovertcp, no difference)
  host: 192.168.10.159
  port: 23
  name: modbus_pool

and in sensors:

- platform: modbus
 scan_interval: 600
 registers:
   - name: pH
     slave: 5
     register: 0x0102
     hub: modbus_pool
   - name: free chlorine
     unit_of_measurement: ppm
     slave: 5
     register: 0x0104
     hub: modbus_pool
     scale: 0.01
     precision: 2

kajmaj · August 23, 2019, 6:43am

I used the same configuration as you.
You should have converter properly set and wired (A to A and B to B), are you sure about slave: 5 and port number?

Nonetheless for me obtained values had been different to the description from vistapool manual.