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

[Documentation] Markdown improvements t to z (#14371)

Browse Source 
* Apply markdown fixes for bindings with letter _t_
* Apply markdown fixes for bindings with letter _u_
* Apply markdown fixes for bindings with letter _v_
* Apply markdown fixes for bindings with letter _w_
* Apply markdown fixes for bindings with letter _x_
* Apply markdown fixes for bindings with letter _y_
* Apply markdown fixes for bindings with letter _z_

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2023-04-11 12:54:54 +02:00
committed by GitHub
parent 69a09ed825
commit ce3f673380
54 changed files with 1655 additions and 1778 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
bundles/org.openhab.binding.vigicrues/README.md
View File

@@ -1,7 +1,7 @@
# 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.
These data are made public through OpenDataSoft website.
## Supported Things
@@ -10,22 +10,21 @@ It is identified by the `id`.
To get your station id :
1. open https://www.vigicrues.gouv.fr/
1. open <https://www.vigicrues.gouv.fr/>
2. Select your region on the France map
1. Select your region on the France map
3. Select the station nearest to your location
1. 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)
1. 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
You can discover stations based upon the system location.
Select Vigicrues binding and click scan in order to discover new stations.
The first scan will proceed with stations located in a radius of 10 km.
Select Vigicrues binding and click scan in order to discover new stations.
The first scan will proceed with stations located in a radius of 10 km.
This radius will increase by 10 km at each new scan.
## Binding Configuration
@@ -41,7 +40,6 @@ The thing has a few configuration parameters:
| id | Id of the station. |
| refresh | Refresh interval in minutes. Optional, the default value is 30 minutes. |
## Channels
Once created, at first initialization, the thing will discover its capabilities (available data) using the webservices apis.
@@ -61,7 +59,7 @@ The VigiCrues information that retrieved are made available with these channels:
| short-comment | String | Description of the alert level |
| comment | String | Detailed informations regarding the ongoing event |
(*) Each alert level is described by a color :
(*) Each alert level is described by a color:
| Code | Color | Description |
|------|--------|-------------------------------------------|
@@ -70,19 +68,18 @@ The VigiCrues information that retrieved are made available with these channels:
| 2 | Orange | Be "very vigilant" in the concerned areas |
| 3 | Red | Absolute vigilance required |
## Full Example
vigicrues.things:
```
```java
Thing vigicrues:station:poissy "Station Poissy" @ "VigiCrues" [id="H300000201", refresh=30]
Thing vigicrues:station:vernon "Station Vernon" @ "VigiCrues" [id="H320000104", refresh=30]
```
vigicrues.items:
```
```java
Group gVigiCrues "VigiCrues" <flow>
Number:Length VC_hauteur "Hauteur Eau Poissy [%.2f %unit%]" <none> (gVigiCrues) {channel="vigicrues:station:poissy:height"}
Number:VolumetricFlowRate VC_debit "Débit Eau Poissy [%.2f %unit%]" <flow> (gVigiCrues) {channel="vigicrues:station:poissy:flow"}
@@ -91,7 +88,7 @@ Group gVigiCrues "VigiCrues" <flow>
vigicrues.sitemap:
```
```perl
sitemap vigicrues label="VigiCrues" {
Frame {
Default item=VC_hauteur