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 1799)

pull/2219/head
openHAB Build Server 2023-11-26 23:21:34 +00:00
parent d6f6283f47
commit f67d15b318
2 changed files with 31 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
_addons_bindings/ecowatt/readme.md
View File

@ -32,11 +32,16 @@ You have to add the thing manually.
You must create an account and an application on the RTE portal to obtain the OAuth2 credentials required to access the API.
1. Open this [page](https://data.rte-france.com/catalog/-/api/consumption/Ecowatt/v4.0), find the "Ecowatt" tile and click on the "Abonnez-vous à l'API" button.
1. Open this [page](https://data.rte-france.com/catalog/-/api/consumption/Ecowatt/v5.0), find the "Ecowatt" tile and click on the "Abonnez-vous à l'API" button.
1. Create an account by following the instructions (you will receive an email to validate your new account).
1. Once logged in, create an application by entering a name (for example "openHAB Integration"), choosing "Web Server" as type, entering any description of your choice and finally clicking on the "Valider" button.
1. You will then see your application details, in particular the "ID client" and "ID Secret" information which you will need later to set up your binding thing.
Note that you are subscribed to a particular version of the API.
When a new version of the API is released, you will have to subscribe to this new version and create a new application.
You will then get new information "ID client" and "ID Secret" and you will have to update your thing configuration in openHAB.
After changing version, you will have to wait for your authentication token to be renewed (max 2 hours) to get a successful response from the API.
## Binding Configuration
There are no overall binding configuration settings that need to be set.
@ -44,10 +49,13 @@ All settings are through thing configuration parameters.
## Thing Configuration
| Name | Type | Description | Required |
|-----------|---------|-----------------------------------------------------------------------|----------|
| idClient | text | ID client provided with the application you created in the RTE portal | yes |
| idSecret | text | ID secret provided with the application you created in the RTE portal | yes |
| Name | Type | Description | Required | Default |
|------------|---------|---------------------------------------------------------------------------|----------|---------|
| apiVersion | integer | The version of the Ecowatt tile to which you subscribed in the RTE portal | no | 4 |
| idClient | text | ID client provided with the application you created in the RTE portal | yes | |
| idSecret | text | ID secret provided with the application you created in the RTE portal | yes | |
Take care to select the API version corresponding to the one to which you subscribed in the RTE portal.
## Channels
@ -57,14 +65,14 @@ All channels are read-only.
|-------------------|--------|------------------------------------------------------------------|
| todaySignal | Number | The signal relating to the forecast consumption level for today. Values are 1 for normal consumption (green), 2 for strained electrical system (orange) and 3 for very strained electrical system (red). |
| tomorrowSignal | Number | The signal relating to the forecast consumption level for tomorrow. Values are 1 for normal consumption (green), 2 for strained electrical system (orange) and 3 for very strained electrical system (red). |
| currentHourSignal | Number | The signal relating to the forecast consumption level for the current hour. Values are 1 for normal consumption (green), 2 for strained electrical system (orange) and 3 for very strained electrical system (red). |
| currentHourSignal | Number | The signal relating to the forecast consumption level for the current hour. Values are 0 for normal consumption (green) and carbon-free production, 1 for normal consumption (green), 2 for strained electrical system (orange) and 3 for very strained electrical system (red). |
## Full Example
example.things:
```java
Thing ecowatt:signals:signals "Ecowatt Signals" [ idClient="xxxxx", idSecret="yyyyy"]
Thing ecowatt:signals:signals "Ecowatt Signals" [ apiVersion=4, idClient="xxxxx", idSecret="yyyyy"]
```
example.items:

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

@ -34,12 +34,22 @@
</channel>
<channel id="currentHourSignal" typeId="signal">
<label>Current Hour Signal</label>
<description>The signal relating to the forecast consumption level for the current hour. Values are 1 for normal
consumption (green), 2 for strained electrical system (orange) and 3 for very strained electrical system (red).</description>
<description>The signal relating to the forecast consumption level for the current hour. Values are 0 for normal
consumption (green) and carbon-free production, 1 for normal consumption (green), 2 for strained electrical system
(orange) and 3 for very strained electrical system (red).</description>
</channel>
</channels>
<config-description>
<parameter name="apiVersion" type="integer" required="false">
<label>API Version</label>
<description>The version of the Ecowatt tile to which you subscribed in the RTE portal.</description>
<options>
<option value="4">V4.0 (deprecated)</option>
<option value="5">V5.0</option>
</options>
<default>4</default>
</parameter>
<parameter name="idClient" type="text" required="true">
<label>ID Client</label>
<description>ID client provided with the application you created in the RTE portal.</description>
@ -55,10 +65,12 @@
<channel-type id="signal">
<item-type>Number</item-type>
<label>Consumption Signal</label>
<description>The signal relating to the forecast consumption level. Values are 1 for normal consumption (green), 2 for
strained electrical system (orange) and 3 for very strained electrical system (red).</description>
<description>The signal relating to the forecast consumption level. Values are 0 for normal consumption (green) and
carbon-free production, 1 for normal consumption (green), 2 for strained electrical system (orange) and 3 for very
strained electrical system (red).</description>
<state readOnly="true">
<options>
<option value="0">Green + carbon-free production</option>
<option value="1">Green</option>
<option value="2">Orange</option>
<option value="3">Red</option>