Connect through ISY Portal

[mkohanim]

Hi shbatm,

Is it possible to use this library against ISY Portal?

Thank you.

[OverloadUT]

Currently this module only supports talking to the ISY directly. I am not aware of any plans or requests to have it go through the ISY Portal yet.

The main (but not only) users of this module is Home Assistant, and in Home Assistant there is a very large focus on maximizing local communication whenever possible to keep dependencies off of the cloud, so I would be surprised to see anyone asking for ISY Portal support from that community.

I am very curious why you ask! Is it something you'd like to see?

[mkohanim]

Hi OverloadUT,
Yes. The reason is that the only difference is the host:port, the base url, and username/pwd. Everything else identical to connecting to ISY directly.

[OverloadUT]

Ah! Well in that case I don't see any reason it wouldn't work! We're certainly not doing anything on purpose to prevent it. It's something we ought to test to confirm!

[mkohanim]

That would be great Greg. Do you have an ISY Portal account?

[OverloadUT]

I've got an account (same user as here, but @gmail), but the license is expired at the moment. I need to go upgrade my ISY firmware as well, which has been on my to-do list for a while :)

[mkohanim]

Please send me your uuid and I will extend it for you and anyone else who can fix this issue.

[jimboca]

This is now working, the user didn't have the preferred ISY set.

[mkohanim]

This is excellent news! Thanks so much.

[arrowstem]

Hello, just to add more details, I was the guy who tried (and couldn't) connect to ISY portal using PyISY code

isy = PyISY.ISY(ADDR, PORT, USER, PASS, HTTPS)

with proper arguments passed to it. As it turned out, the reason it failed to connect was that I didn't have a preferred ISY set (even though I only have a single ISY under my username, so I'd think it would be my preferred ISY by default).

While I was trying to figure out why PyISY.ISY(...) was not successful, I found the exception that was raised in the file connection.py, line 48:

            raise(ValueError('PyISY could not connect to the ISY '
                             + 'controller with the provided attributes.'))

So I thought one of the arguments (ADDR, PORT, USER, PASS, HTTPS) was incorrect. Actually the reason was that preferred ISY was not set. By contrast, when opened the link https://my.isy.io/rest/status in a web browser, the page showed a clear error message saying "Preferred ISY not set on user profile". It would be nice if PyISY also provided a correct error message in this case.

On the other subject, I really want to connect to ISY portal rather than ISY itself because I need to make that connection from a remote server, and I am comfortable doing that from a Python script. So I thought PyISY would be ideal for my goals. Thanks for developing this module!

[shbatm]

@mkohanim - just thinking about future use cases for this: is there anything in the Portal REST protocol for determining which ISY to use?

I'm thinking about if someone has multiple ISYs tied to a single portal account, how would this module be able to differentiate between them?

[shbatm]

By contrast, when opened the link https://my.isy.io/rest/status in a web browser, the page showed a clear error message saying "Preferred ISY not set on user profile".

@arrowstem glad you got it working. I'll look at the error message... Right now the module tests the connection by calling an invalid REST URL (/rest/ping) just to see if it gets a 404 error (valid connection, invalid url) or something else. It should probably call (/rest/status) to provide some more useful info (@OverloadUT, one of the last 2 PRs I have staged for v2 includes a change to allow connection testing without downloading the full config, this would probably fit well there).

[jimboca]

@mkohanim - just thinking about future use cases for this: is there anything in the Portal REST protocol for determining which ISY to use?

I'm thinking about if someone has multiple ISYs tied to a single portal account, how would this module be able to differentiate between them?

Currently this is based on the login credentials, different user (email) for each preferred ISY, and if you don't want a unique email you can use to + like username+somestring@gmail.com for each one.

[mkohanim]

@shbatm , thanks so very much! Please note that the only reason you need Preferred ISY is for cases (such as MobiLinc and apparently PyISY), where you do NOT define the base URL during the connection. Each ISY has a full path in ISY Portal. So, if you allow the based URL path to be defined during connection (instead of /rest/ping), then the only failure would be authentication. So, my.isy.io:443, username, pwd, https=true, baseURL = /rest/.

[shbatm]

@mkohanim Thanks for the suggestion. Added a webroot parameter to some upcoming connection changes for V2. Connection details will be:

isy = ISY(
    address="my.isy.io",
    port=443,
    username="your@portal.email",
    password="yourpassword",
    use_https=True,
    tls_ver=1.1,
    log=None,
    webroot="/isy/unique_isy_url_code_from_portal",
)
# Unique URL can be found in ISY Portal under 
#   Tools > Information > ISY Information
#  Do not add /rest/ to the end!