added migrated 2.x add-ons
Signed-off-by: Kai Kreuzer <kai@openhab.org>
This commit is contained in:
Kai Kreuzer
92
bundles/org.openhab.binding.meteoalerte/README.md
Normal file
92
bundles/org.openhab.binding.meteoalerte/README.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# Meteo Alerte Binding
|
||||
|
||||
The Meteo Alerte binding gives alert level regarding major weather related risk factors.
|
||||
|
||||
## Supported Things
|
||||
|
||||
There is exactly one supported thing type, which represents the weather alerts for a given department.
|
||||
It has the `department` id.
|
||||
Of course, you can add multiple things, e.g. for getting alerts for different locations.
|
||||
|
||||
## 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 |
|
||||
|---------------|----------------------------------------------------------------------------------------|
|
||||
| `department` | Name of the department. |
|
||||
| refresh | Refresh interval in minutes. Optional, the default value is 1440 minutes (once a day). |
|
||||
|
||||
## Channels
|
||||
|
||||
The Météo Alerte information that are retrieved is available as these channels:
|
||||
|
||||
| Channel ID | Item Type | Description |
|
||||
|-----------------------|-----------|-----------------------------------------------|
|
||||
| observation-time | DateTime | Date and time of alert creation |
|
||||
| comment | String | General comments on alerts for the department |
|
||||
| vent | String | Wind alert level (*) |
|
||||
| pluie-inondation | String | Rain alert level (*) |
|
||||
| orage | String | Storm alert level (*) |
|
||||
| inondation | String | Flood alert level (*) |
|
||||
| neige | String | Snow alert level (*) |
|
||||
| canicule | String | Heat alert level (*) |
|
||||
| grand-froid | String | Cold alert level (*) |
|
||||
| avalanches | String | Avalanche alert level (*) |
|
||||
| pluie-inondation-icon | Image | Pictogram of the Rain alert level |
|
||||
| vent-icon | Image | Pictogram of the Wind alert level |
|
||||
| orage-icon | Image | Pictogram of Storm alert level |
|
||||
| inondation-icon | Image | Pictogram of Flood alert level |
|
||||
| neige-icon | Image | Pictogram of Snow alert level |
|
||||
| canicule-icon | Image | Pictogram of Heat alert level |
|
||||
| grand-froid-icon | Image | Pictogram of Cold alert level |
|
||||
| avalanches-icon | Image | Pictogram of Avalanche alert level |
|
||||
|
||||
(*) Each alert level is described by a color :
|
||||
|
||||
| Code | Color | Description |
|
||||
|------|--------|-------------------------------------------|
|
||||
| 0 | Green | No particular vigilance |
|
||||
| 1 | Yellow | Be attentive to the weather situation |
|
||||
| 2 | Orange | Be "very vigilant" in the concerned areas |
|
||||
| 3 | Red | Absolute vigilance required |
|
||||
|
||||
|
||||
## Full Example
|
||||
|
||||
meteoalert.things:
|
||||
|
||||
```
|
||||
Thing meteoalerte:department:yvelines @ "MyCity" [department="YVELINES", refresh=12]
|
||||
```
|
||||
|
||||
meteoalert.items:
|
||||
|
||||
```
|
||||
Group gMeteoAlert "Alertes Météo" <weather>
|
||||
String MA_Dept78 "Département 78 [%s]" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:comment"}
|
||||
String MA_etat_canicule "Canicule [%s]" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:canicule"}
|
||||
String MA_etat_grand_froid "Grand Froid [%s]" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:grand-froid"}
|
||||
String MA_etat_pluie_inondation "Pluie-Inondation [%s]" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:pluie-inondation"}
|
||||
String MA_etat_neige "Neige [%s]" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:neige"}
|
||||
String MA_etat_vent "Vent [%s]" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:vent"}
|
||||
String MA_etat_inondation "Inondation [%s]" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:inondation"}
|
||||
String MA_etat_orage "Orage [%s]" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:orage"}
|
||||
String MA_etat_avalanche "Avalanches [%s]" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:avalanches"}
|
||||
|
||||
Image MA_icon_canicule "Canicule" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:canicule-icon"}
|
||||
Image MA_icon_grand_froid "Grand Froid" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:grand-froid-icon"}
|
||||
Image MA_icon_pluie_inondation "Pluie-Inondation" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:pluie-inondation-icon"}
|
||||
Image MA_icon_neige "Neige" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:neige-icon"}
|
||||
Image MA_icon_vent "Vent" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:vent-icon"}
|
||||
Image MA_icon_inondation "Inondation" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:inondation-icon"}
|
||||
Image MA_icon_orage "Orage" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:orage-icon"}
|
||||
Image MA_icon_avalanche "Avalanche" <aqi> (gMeteoAlert) {channel="meteoalerte:department:yvelines:avalanches-icon"}
|
||||
|
||||
DateTime MA_ObservationTS "Timestamp [%1$tH:%1$tM]" <time> (gMeteoAlert) {channel="meteoalerte:department:yvelines:observation-time"}
|
||||
|
||||
```
|
||||
Reference in New Issue
Block a user