diff --git a/CODEOWNERS b/CODEOWNERS index 5e299a75cc4a4..9b9bf59650c17 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -208,6 +208,7 @@ /bundles/org.openhab.binding.vektiva/ @octa22 /bundles/org.openhab.binding.velbus/ @cedricboon /bundles/org.openhab.binding.velux/ @gs4711 +/bundles/org.openhab.binding.vigicrues/ @clinique /bundles/org.openhab.binding.vitotronic/ @steand /bundles/org.openhab.binding.volvooncall/ @clinique /bundles/org.openhab.binding.weathercompany/ @mhilbush diff --git a/bom/openhab-addons/pom.xml b/bom/openhab-addons/pom.xml index df3a28ecb3107..15e92b1609b7c 100644 --- a/bom/openhab-addons/pom.xml +++ b/bom/openhab-addons/pom.xml @@ -1036,6 +1036,11 @@ org.openhab.binding.velux ${project.version} + + org.openhab.addons.bundles + org.openhab.binding.vigicrues + ${project.version} + org.openhab.addons.bundles org.openhab.binding.vitotronic diff --git a/bundles/org.openhab.binding.vigicrues/.classpath b/bundles/org.openhab.binding.vigicrues/.classpath new file mode 100644 index 0000000000000..a5d95095ccaaf --- /dev/null +++ b/bundles/org.openhab.binding.vigicrues/.classpath @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/bundles/org.openhab.binding.vigicrues/.project b/bundles/org.openhab.binding.vigicrues/.project new file mode 100644 index 0000000000000..8bdaeaeb2f825 --- /dev/null +++ b/bundles/org.openhab.binding.vigicrues/.project @@ -0,0 +1,23 @@ + + + org.openhab.binding.vigicrues + + + + + + org.eclipse.jdt.core.javabuilder + + + + + org.eclipse.m2e.core.maven2Builder + + + + + + org.eclipse.jdt.core.javanature + org.eclipse.m2e.core.maven2Nature + + diff --git a/bundles/org.openhab.binding.vigicrues/NOTICE b/bundles/org.openhab.binding.vigicrues/NOTICE new file mode 100644 index 0000000000000..38d625e349232 --- /dev/null +++ b/bundles/org.openhab.binding.vigicrues/NOTICE @@ -0,0 +1,13 @@ +This content is produced and maintained by the openHAB project. + +* Project home: https://www.openhab.org + +== Declared Project Licenses + +This program and the accompanying materials are made available under the terms +of the Eclipse Public License 2.0 which is available at +https://www.eclipse.org/legal/epl-2.0/. + +== Source Code + +https://github.com/openhab/openhab-addons diff --git a/bundles/org.openhab.binding.vigicrues/README.md b/bundles/org.openhab.binding.vigicrues/README.md new file mode 100644 index 0000000000000..744569a98129d --- /dev/null +++ b/bundles/org.openhab.binding.vigicrues/README.md @@ -0,0 +1,81 @@ +# VigiCrues Binding + +This binding allows you to get data regarding water flow and water height on major French rivers. +These data are made public through OpenDataSoft website. + +## Supported Things + +There is exactly one supported thing type, which represents a river level measurement station. +It is identified by the `id`. + +To get your station id : + +1. open https://www.vigicrues.gouv.fr/ + +2. Select your region on the France map + +3. Select the station nearest to your location + +4. In the 'Info Station' tab you'll get the id just near the station name (e.g. X9999999299) + +Of course, you can add multiple Things, e.g. for getting measures for different locations. + + +## Discovery + +This binding does not handle auto-discovery. + +## Binding Configuration + +The binding has no configuration options, all configuration is done at Thing level. + +## Thing Configuration + +The thing has a few configuration parameters: + +| Parameter | Description | +|-----------|-------------------------------------------------------------------------| +| id | Id of the station. | +| refresh | Refresh interval in minutes. Optional, the default value is 30 minutes. | + + +## Channels + +The VigiCrues information that retrieved are made available with these channels: + +| Channel ID | Item Type | Description | +|------------------|---------------------------|-------------------------------| +| observation-time | DateTime | Date and time of measurement | +| flow | Number:VolumetricFlowRate | Volume of water per time unit | +| height | Number:Length | Water height of the river | + + +## Full Example + +vigicrues.things: + +``` +Thing vigicrues:station:poissy "Station Poissy" @ "VigiCrues" [id="H300000201", refresh=30] +Thing vigicrues:station:vernon "Station Vernon" @ "VigiCrues" [id="H320000104", refresh=30] +``` + +vigicrues.items: + +``` +Group gVigiCrues "VigiCrues" + Number:Length VC_hauteur "Hauteur Eau Poissy [%.2f %unit%]" (gVigiCrues) {channel="vigicrues:station:poissy:height"} + Number:VolumetricFlowRate VC_debit "Débit Eau Poissy [%.2f %unit%]" (gVigiCrues) {channel="vigicrues:station:poissy:flow"} + DateTime VC_ObservationPTS "Timestamp [%1$tH:%1$tM]"