Skip to content
This repository has been archived by the owner on Mar 28, 2021. It is now read-only.
xbgmsharp edited this page Jun 4, 2016 · 11 revisions

piwigo-forecast

This place is mean to store the documentation of the plugin piwigo-forecast.

Feel free to edit it and contribute.

This plugin integrate Forecat.io on your web gallery Piwigo.

Weather view

Graphical mode

Sample Weather1

Click on it to see the details weather condition.

Sample Weather2

Text mode

Sample Weather3

Configuration panel

Add weather before

Make sure that the position you choose for the map is set in 'Display' options to be visible and does exist. Configuration -> Options -> Display

For example the 'Who can see this photo' option is only available to Admin, so choosing this will make the map invisible to everyone but Admin, and choosing something like 'Date Taken' will hide the map for any photos where there is no 'Date taken' in the Metadata (eg photos stripped of Metadata by software) and one is not set in Batch Manager.

Unit

By default the API will return the unit base on the location. If you always want Degrees Celsius, you should select the Internal Units, eg: si.

  • us: American measure.
    
  • summary: A human-readable text summary of in miles or in degrees Fahrenheit
    
  • nearestStormDistance: in miles
    
  • precipIntensity: in inches of liquid water per hour
    
  • precipIntensityMax, and precipIntensityMaxTime : in inches of liquid water per hour.
    
  • precipAccumulation: in inches.
    
  • temperature: the temperature at the given time in degrees Fahrenheit.
    
  • temperatureMin, temperatureMinTime, temperatureMax, and temperatureMaxTime: in degrees Fahrenheit.
    
  • apparentTemperature: in degrees Fahrenheit.
    
  • apparentTemperatureMin, apparentTemperatureMinTime, apparentTemperatureMax, and apparentTemperatureMaxTime: in degrees Fahrenheit.
    
  • dewPoint: in degrees Fahrenheit.
    
  • windSpeed: in miles per hour.
    
  • pressure: in millibars.
    
  • visibility: in miles, capped at 10 miles.
    
  • ozone: in Dobson units.
    
  • si: Returns results in SI units. In particular, properties now have the following units:
    
  • summary: Any summaries containing temperature or snow accumulation units will have their values in degrees Celsius or in centimeters (respectively).
    
  • nearestStormDistance: Kilometers.
    
  • precipIntensity: Millimeters per hour.
    
  • precipIntensityMax: Millimeters per hour.
    
  • precipAccumulation: Centimeters.
    
  • temperature: Degrees Celsius.
    
  • temperatureMin: Degrees Celsius.
    
  • temperatureMax: Degrees Celsius.
    
  • apparentTemperature: Degrees Celsius.
    
  • dewPoint: Degrees Celsius.
    
  • windSpeed: Meters per second.
    
  • pressure: Hectopascals (which are, conveniently, equivalent to the default millibars).
    
  • visibility: Kilometers.
    
  • uk (deprecated): Identical to si, except that windSpeed is in miles per hour. The uk2 option should be used in preference to this option, which is deprecated.
    
  • uk2: Identical to si, except that windSpeed is in miles per hour, and nearestStormDistance and visibility are in miles, as in the US. (This option is provided because adoption of SI in the UK has been inconsistent.)
    
  • auto: Selects the relevant units automatically, based on geographic location.
    

Language

It allow you have a weather condition summary in your own language. Please be advised that units in the summary will be set according to the units option, above, so be sure to set both options as needed.

API Forecast.io

If you don't have a Forecast.io API KEY, you should use the proxy. This is mainly to hide my API key and to avoid the limit requests set by the forecast.io API, eg: 1000 per day free. You can register for API Key for free, https://developer.forecast.io/

Keywords panel

To use this feature you need the tag_groups plugin to be activate.

Tag name group

By default, it is weather. It will create tags like: weather:rain or weather:clear-day.

Tag can be one of the following values: clear-day, clear-night, rain, snow, sleet, wind, fog, cloudy, partly-cloudy-day, or partly-cloudy-night. It is base on the icon field return by the weather condition from forecast.io

The puglin only allow to create the tags/keywords. In order to manage (delete/edit) the tags/keywords, you need to use the keywords feature: Photos -> keywords

Translation

You can help by translating the plugin in your language. Thanks to the contributors. It is available via the translate tool from piwigo.

Support

To get support, please create new issue

Help me improve the plugin, rate my plugin, and if possible please send a greeting message to me ;)

Clone this wiki locally