OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated external content (Jenkins build 1716)

pull/2219/head
openHAB Build Server 2023-10-05 21:29:01 +00:00
parent e66cc0cc71
commit 8d393329a4
2 changed files with 95 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
_addons_bindings/enphase/readme.md
View File

@ -37,18 +37,47 @@ The binding auto detects which data is available and will report this in the log
## Discovery
The binding can discover Envoy gateways, micro inverters and relays.
If login access is needed the Bridge `envoy` needs to be configured after discovering and adding before other things can be discovered.
In that case, after configuring the login, run discovery again.
## Thing Configuration
The Envoy gateway thing `envoy` has the following configuration options:
### Bridge configuration
Depending on the software version of the Envoy gateway thing `envoy` there are different configuration options needed.
Newer versions of the Envoy software (> version 7) require a different authentication method.
Because the configuration is different, different bridge things are available.
The following options are relevant for all envoy versions:
| parameter | required | description |
|--------------|----------|-------------------------------------------------------------------------------------------------------------|
| serialNumber | yes | The serial number of the Envoy gateway which can be found on the gateway |
| hostname | no | The host name/ip address of the Envoy gateway. Leave empty to auto detect |
| refresh | no | Period between data updates. The default is the same 5 minutes the data is actually refreshed on the Envoy |
#### Envoy below version 7
For Envoy versions below 7 has the following authentication configuration options are relevant:
| parameter | required | description |
|--------------|----------|-------------------------------------------------------------------------------------------------------------|
| username | no | The user name to the Envoy gateway. Leave empty when using the default user name |
| password | no | The password to the Envoy gateway. Leave empty when using the default password |
| refresh | no | Period between data updates. The default is the same 5 minutes the data is actual refreshed on the Envoy |
#### Envoy from version 7
For Envoy versions 7 and newer has the following authentication configuration options are relevant:
| parameter | required | description |
|--------------|----------|-------------------------------------------------------------------------------------------------------------|
| autoJwt | yes | Specify if the JWT access token should be obtained by logging in or if the jwt is provided manually |
| username | yes/no | The user name to the Entrez server. Required if auto Jwt is true |
| password | yes/no | The password to the Entrez server. Required if auto Jwt is true |
| siteName | yes/no | The name of the site. Can be found above the Site Id in the Enphase app. Required when autoJwt is true |
| jwt | yes/no | The jwt is required if autoJWT is false, if it's true jwt is not used |
### Thing configuration
The micro inverter `inverter` and `relay` things have only 1 parameter:

78
_thing_types/org.openhab.binding.enphase/src/main/resources/OH-INF/thing/thing-types.xml
View File

@ -10,11 +10,11 @@
<description>Envoy gateway</description>
<channel-groups>
<channel-group id="production" typeId="envoy-data">
<channel-group id="production" typeId="envoy-production">
<label>Production</label>
<description>Production data from the solar panels</description>
</channel-group>
<channel-group id="consumption" typeId="envoy-data">
<channel-group id="consumption" typeId="envoy-consumption">
<label>Consumption</label>
<description>Consumption data from the solar panels</description>
</channel-group>
@ -34,14 +34,31 @@
</parameter>
<parameter name="username" type="text">
<label>User Name</label>
<description>The user name to the Envoy gateway. Leave empty when using the default user name</description>
<description>For versions below version 7, this is the user name to the Envoy gateway. Leave empty when using the
default user name. For newer versions this is user name of the Enphase Entrez Cloud Login when using Auto JWT.</description>
<default>envoy</default>
<advanced>true</advanced>
</parameter>
<parameter name="password" type="text">
<context>password</context>
<label>Password</label>
<description>The password to the Envoy gateway. Leave empty when using the default password</description>
<description>For versions below version 7, this is the password to the Envoy gateway. Leave empty when using the
default password. For newer versions this is the password of the Enphase Entrez Cloud Login when using Auto JWT.</description>
<advanced>true</advanced>
</parameter>
<parameter name="siteName" type="text">
<label>Site Name</label>
<description>The Site Name, which is above the Site Id in Enphase app. Required when using Auto JWT</description>
</parameter>
<parameter name="jwt" type="text">
<label>JWT</label>
<description>For versions above version 7, this is the JWT when not using Auto JWT</description>
<advanced>true</advanced>
</parameter>
<parameter name="autoJwt" type="boolean">
<label>Auto JWT</label>
<description>For versions above version 7, this tells the binding whether to attempt an auto-retrieve of the JWT</description>
<default>true</default>
<advanced>true</advanced>
</parameter>
<parameter name="refresh" type="integer" unit="min">
@ -53,7 +70,6 @@
</config-description>
</bridge-type>
<thing-type id="inverter">
<supported-bridge-type-refs>
<bridge-type-ref id="envoy"/>
@ -128,38 +144,69 @@
</thing-type>
<!-- Envoy gateway channels -->
<channel-group-type id="envoy-data">
<channel-group-type id="envoy-production">
<label>Envoy Data</label>
<channels>
<channel id="wattHoursToday" typeId="watt-hours-today"/>
<channel id="wattHoursSevenDays" typeId="watt-hours-seven-days"/>
<channel id="wattHoursLifetime" typeId="watt-hours-lifetime"/>
<channel id="wattsNow" typeId="watts-now"/>
<channel id="wattHoursToday" typeId="watt-hours-today">
<description>Watt hours produced today</description>
</channel>
<channel id="wattHoursSevenDays" typeId="watt-hours-seven-days">
<description>Watt hours produced the last 7 days</description>
</channel>
<channel id="wattHoursLifetime" typeId="watt-hours-lifetime">
<description>Watt hours produced over the lifetime</description>
</channel>
<channel id="wattsNow" typeId="watts-now">
<description>Latest Watt produced</description>
</channel>
</channels>
</channel-group-type>
<channel-group-type id="envoy-consumption">
<label>Envoy Data</label>
<channels>
<channel id="wattHoursToday" typeId="watt-hours-today">
<label>Consumption Today</label>
<description>Watt hours consumption today</description>
</channel>
<channel id="wattHoursSevenDays" typeId="watt-hours-seven-days">
<label>Consumption 7 Days</label>
<description>Watt hours consumption the last 7 days</description>
</channel>
<channel id="wattHoursLifetime" typeId="watt-hours-lifetime">
<label>Consumption Lifetime</label>
<description>Watt hours consumption over the lifetime</description>
</channel>
<channel id="wattsNow" typeId="watts-now">
<label>Latest Consumption Power</label>
<description>Latest Watt consumption</description>
</channel>
</channels>
</channel-group-type>
<channel-type id="watt-hours-today">
<item-type>Number:Energy</item-type>
<label>Produced Today</label>
<description>Watt hours produced today</description>
<category>energy</category>
<state pattern="%d %unit%" readOnly="true"/>
</channel-type>
<channel-type id="watt-hours-seven-days">
<item-type>Number:Energy</item-type>
<label>Produced 7 Days</label>
<description>Watt hours produced the last 7 days</description>
<category>energy</category>
<state pattern="%d %unit%" readOnly="true"/>
</channel-type>
<channel-type id="watt-hours-lifetime">
<item-type>Number:Energy</item-type>
<label>Produced Lifetime</label>
<description>Watt hours produced over the lifetime</description>
<category>energy</category>
<state pattern="%d %unit%" readOnly="true"/>
</channel-type>
<channel-type id="watts-now">
<item-type>Number:Power</item-type>
<label>Latest Power</label>
<label>Latest Produced Power</label>
<description>Latest watts produced</description>
<category>energy</category>
<state pattern="%d %unit%" readOnly="true"/>
</channel-type>
@ -168,18 +215,21 @@
<item-type>Number:Power</item-type>
<label>Last Report</label>
<description>Last reported power delivery</description>
<category>energy</category>
<state pattern="%d %unit%" readOnly="true"/>
</channel-type>
<channel-type id="max-report-watts">
<item-type>Number:Power</item-type>
<label>Max Report</label>
<description>Maximum reported power</description>
<category>energy</category>
<state pattern="%d %unit%" readOnly="true"/>
</channel-type>
<channel-type id="last-report-date">
<item-type>DateTime</item-type>
<label>Last Report Date</label>
<description>Date of last reported power delivery</description>
<category>energy</category>
<state readOnly="true"/>
</channel-type>