public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[ecowatt] Add support for API version 5 (#15953)

Browse Source 
A new thing parameter to define the API version has been added.
Its default value is 4 for backward compatibility even if this version
is now deprecated. The documentation explains what to do to switch from
a version to another.

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
This commit is contained in:
lolodomo
2023-11-26 23:34:45 +01:00
committed by GitHub
parent a4da986330
commit 9b55bfba58
9 changed files with 62 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
bundles/org.openhab.binding.ecowatt/README.md
View File

@@ -17,11 +17,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.
@@ -29,10 +34,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
@@ -42,14 +50,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: