[enphase] Add Entrez/JWT support for newer software versions of Envoy

[Hilbrand]

Adds support for newer Envoy software version that currently is not supported by the binding.
See also https://community.openhab.org/t/new-binding-enphase-envoy-solar-system-gateway/44449/113

[joseil]

Hallo Hilbrand,
i noticed that you have been working on the Enphase binding to support version 7 of the envoy with the JWT.
Is there away that i can tryout this enhancement?, or will it be publiched in the next release of Openhab
Jos

[Hilbrand]

@joseil You can find the jar file in this community message: https://community.openhab.org/t/new-binding-enphase-envoy-solar-system-gateway/44449/94

[joseil]

Hallo Hilbrand, bedankt voor de info, het is gelukt groeten Jos Op di 13 jun 2023 om 17:15 schreef Hilbrand Bouwkamp < ***@***.***>:

…

@joseil <https://github.com/joseil> You can find the jar file in this community message: https://community.openhab.org/t/new-binding-enphase-envoy-solar-system-gateway/44449/94 — Reply to this email directly, view it on GitHub <#15077 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACJRWDZY6F27Q4T2RH63XSTXLB7XJANCNFSM6AAAAAAZBXGGZQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[jlaur]

Thank you for taking care! I have added some minor comments.

I believe update instructions are needed because of the channel group changes.

Also, it seems connection is now hybrid or cloud rather than local?

[Hilbrand]

I've changed connection to hybrid, although it's only a small part. Because only for certain versions of the Enphase software it's needed to get the authorization, which only needs to be done after certain period of time. All reading of the data is still local.

It doesn't seem to need a migration update. Because the group type id has changed and that information is not stored in the json database. Therefor after installing the new version of the binding the channels created in the ui keep working.

[jlaur]

It doesn't seem to need a migration update. Because the group type id has changed and that information is not stored in the json database. Therefor after installing the new version of the binding the channels created in the ui keep working.

👍 Still, items need to be relinked, right? So probably should be mentioned after:

https://github.com/openhab/openhab-distro/blob/a3e95096144a2b867f67a29cb1f542f9ffd42f57/distributions/openhab/src/main/resources/bin/update.lst#L95-L119

[jlaur]

I've changed connection to hybrid, although it's only a small part. Because only for certain versions of the Enphase software it's needed to get the authorization, which only needs to be done after certain period of time. All reading of the data is still local.

Does this mean that without the cloud, it will not be possible to get the authorization and read data locally? Or is this cloud authorization not needed for using the local API?

[Hilbrand]

Still, items need to be relinked, right?

Items should be automatically relinked, because the channel names itself didn't change. Therefor I would not expect an issue. I did test this, and it did just relink the items. Although someone on the forum did mention problems with the items linking when updating the binding, but I don't understand what is the cause or if/how that is related to the rename of the group type id.

Does this mean that without the cloud, it will not be possible to get the authorization and read data locally? Or is this cloud authorization not needed for using the local API?

The Envoys with the newer software version require authorization. It is required to get the jwt from the portal, either by login to the portal and get the jwt and configure the jwt or config login and than the jwt will be obtained from the portal by the binding. After setting the jwt it can use the local API and no cloud connection is needed. So yes the jwt from the portal is needed. But once one has the jwt the binding doesn't need cloud connection.

[jlaur]

Still, items need to be relinked, right?

Items should be automatically relinked, because the channel names itself didn't change. Therefor I would not expect an issue. I did test this, and it did just relink the items. Although someone on the forum did mention problems with the items linking when updating the binding, but I don't understand what is the cause or if/how that is related to the rename of the group type id.

Sorry, I mixed changed id with changed group name. Since the id is changed, I would have suspected issues for managed things without update instructions, but since you tested this, apparently there is no issue. Channel relinking was a brainfart - that would only be needed if channel group name changed.

Does this mean that without the cloud, it will not be possible to get the authorization and read data locally? Or is this cloud authorization not needed for using the local API?

The Envoys with the newer software version require authorization. It is required to get the jwt from the portal, either by login to the portal and get the jwt and configure the jwt or config login and than the jwt will be obtained from the portal by the binding. After setting the jwt it can use the local API and no cloud connection is needed. So yes the jwt from the portal is needed. But once one has the jwt the binding doesn't need cloud connection.

Hmm, I never heard of such a solution before. If the cloud services will be shut down (for any reason), the integration will stop working, even though it actually runs locally. By the definition it's actually cloud now rather than local or hybrid, since cloud is required and not optional. But since it only applies to newer software, I guess some users will still run entirely local. So I guess we can use hybrid as some kind of compromise (if you agree).

[jlaur]

LGTM

[jlaur]

So I guess we can use hybrid as some kind of compromise (if you agree).

I'm sorry, this PR somehow got off my radar. I guess I was waiting for a reply here - but assuming silent agreement now. 😉