Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 4.64 KB

CommandRef.en.md

File metadata and controls

98 lines (64 loc) · 4.64 KB

Buienradar

Buienradar provides access to precipitation forecasts by the dutch service Buienradar.nl.

Define

define <devicename> Buienradar [latitude] [longitude]

latitude and longitude are facultative and will gathered from global if not set. So the smallest possible definition is:

define <devicename> Buienradar

Set

Set will get you the following:

  • refresh - get new data from Buienradar.nl.

Get

Get will get you the following:

  • rainDuration - predicted duration of the next precipitation in minutes.
  • startsIn - next precipitation starts in n minutes. Obsolete!
  • version - get current version of the Buienradar module.

Readings

Buienradar provides several readings:

  • rainAmount - amount of predicted precipitation in mm/h for the next hour.
  • rainBegin - starting time of the next precipitation, unknown if no precipitation is predicted.
  • raindEnd - ending time of the next precipitation, unknown if no precipitation is predicted.
  • rainDataStart - starting time of gathered data.
  • rainDataEnd - ending time of gathered data.
  • rainLaMetric - data formatted for a LaMetric device.
  • rainMax - maximal amount of precipitation for any 5 minute interval of the gathered data in mm/h.
  • rainNow - amount of precipitation for the current 5 minute interval in mm/h.
  • rainTotal - total amount of precipition for the gathered data in mm/h.
  • rainDuration - duration of the precipitation contained in the forecast
  • rainDurationTime - duration of the precipitation contained in the forecast in HH:MM
  • rainDurationIntervals - amount of intervals with precipitation
  • rainDurationPercent - percentage of interavls with precipitation

Attributes

  • disabled on|off - If disabled is set to on, no further requests to Buienradar.nl will be performed. off reactivates the device, also if the attribute ist simply deleted.

    Caution! To be compatible with FHEM::IsDisabled(), any set or delete with disabled will also create or delete an additional disable attribute. Is disable (without d) set or deleted, disabled (with d) will not be affected. Just don't use disable.

  • region nl|de - Allowed values are nl (default value) and de. In some cases, especially in the south and east of Germany, de returns values at all.

  • interval 10|60|120|180|240|300 - Data update every n seconds. Attention! 10 seconds is a very aggressive value and should be chosen carefully, e.g. when troubleshooting. The default value is 120 seconds.

Visualisation

Buienradar offers besides the usual view as device also the possibility to visualize the data as charts in different formats.

  • An HTML version that is displayed in the detail view by default and can be viewed with

      { FHEM::Buienradar::HTML("buienradar device name")}
    

    can be retrieved.

  • A chart generated by Google Charts in PNG format, which can be viewed with

      { FHEM::Buienradar::GChart("buienradar device name")}
    

    can be retrieved. Caution! Please note that data is transferred to Google for this purpose!

  • FTUI is supported by the LogProxy format:

      { FHEM::Buienradar::LogProxy("buienradar device name")}
    
  • A plain text representation can be display by

      { FHEM::Buienradar::TextChart("buienradar device name")}
    

    Every line represents a record of the whole set in a format like

      22:25 |   0.060 | =
      22:30 |   0.370 | ====
      22:35 |   0.650 | =======
    

    For every 0.1 mm/h precipitation a = is displayed, but the output is capped to 50 units. If more than 50 units would be display, the bar is appended with a >.

      23:00 |  11.800 | ==================================================>
    
  • A compact graphical representation is displayed with

      { FHEM::Buienradar::ColourBarChart("buienradar device name") }
    

    is shown. A two-line HTML table formatted with CSS is generated; for each value a single cell with different blue intensity as background colour and a legend is depicted.