Weather Plugin - Revision history

Guessed: Correct case of "MiOS"

2010-10-08T22:01:11Z

Correct case of "MiOS"

Javier at 21:34, 17 April 2010

2010-04-17T21:34:56Z

Guessed: Move the content over to the http://code.mios.com Wiki page.

2010-04-03T01:56:40Z

Move the content over to the http://code.mios.com Wiki page.

Guessed: /* Extras */ Added some more condition codesas published in the Forum thread by @sjolshagen on 8-Dec

2009-12-08T15:40:36Z

‎Extras: Added some more condition codesas published in the Forum thread by @sjolshagen on 8-Dec

Guessed: /* Errors */

2009-11-13T22:56:02Z

‎Errors

Guessed: /* Errors */ Add references to Vera missing a UI/Rendition of the Humidity sensor in the Dashboard.

2009-11-13T22:55:38Z

‎Errors: Add references to Vera missing a UI/Rendition of the Humidity sensor in the Dashboard.

Guessed: add "Condition" state values that are known

2009-11-12T20:12:22Z

add "Condition" state values that are known

Guessed: /* Releases */

2009-11-07T19:42:39Z

‎Releases

Guessed: Added new section describing features/fixes in the latest releases. Added 7-Nov release including Condition and WindCondition stateVariables now being exposed.

2009-11-07T19:27:11Z

Added new section describing features/fixes in the latest releases. Added 7-Nov release including Condition and WindCondition stateVariables now being exposed.

Guessed: /* Errors */

2009-10-04T20:00:10Z

‎Errors

@@ Line 1: / Line 1: @@
 [[Category:Plugins]]
 [[Category:3rd Party]]
-This page has moved to the MIOS Code Respository:
+This page has moved to the MiOS Code Respository:
      http://code.mios.com/trac/mios_weather/wiki

← Older revision		Revision as of 21:34, 17 April 2010
Line 1:		Line 1:
		+	[[Category:Plugins]]
		+	[[Category:3rd Party]]
	This page has moved to the MIOS Code Respository:		This page has moved to the MIOS Code Respository:

	http://code.mios.com/trac/mios_weather/wiki		http://code.mios.com/trac/mios_weather/wiki

@@ Line 1: / Line 1: @@
-[[Image:WeatherDevice.png|thumb]]
+This page has moved to the MIOS Code Respository:
-=Introduction=
-The Weather plugin is a [[Luup_Plugins|Luup component]] that captures, displays, and periodically updates Temperature and Humidity data based upon Vera's current [[Location]].
-=How does it work=
+    http://code.mios.com/trac/mios_weather/wiki
-The plugin uses the Latitude/Longitude values configured in Vera's [[Location]] settings, and data provided by the ''Unofficial'' Google Weather service, to retrieve:
-−
-* Temperature - The Current temperature
-* Low Temperature - The ''estimated'' low temperature
-* High Temperature - The ''estimated'' high temperature
-* Humidity - The ''estimated'' humidity
-−
-Each of these values is presented as a Child Device of the Weather plugin, implementing the respective [[Luup_UPNP_Files|UPnP Service]].  They're all set to be visually ''grouped'' in the UI/Presentation.
-−
-Behind the scenes, the plugin uses Vera's ''Latitude'' and ''Longitude'' values, derived from the User-specified [[Location]] settings, to help form a URL to the Google Weather API.  This URL call looks like:
-−
-:http://www.google.com/ig/api?weather=,,,40980465,-72212690
-−
-The plugin selects elements from the XML output, and translates them into values that are set upon the respective Child Devices.
-−
-The Weather plugin retrieves the Weather data at startup, and again every 30 minutes after that.
-−
-=Installation=
-# Configure the physical location of your Vera, using the ''Location'' settings UI
-# Download the ZIP file <tt>Weather.zip</tt> from [http://www.box.net/shared/b7z6s9j9md document]
-# Expand the ZIP File to extract the 3x files, their names should be exactly as follows:
-#*<tt>D_Weather.xml</tt>
-#*<tt>S_Weather.xml</tt>
-#*<tt>I_GoogleWeather.xml</tt>
-# Goto ''Devices'' --> ''Luup plugins'' --> ''Luup files''
-# Click the '''(Browse)''' buttons on the right, and enter the 3 filenames references above.
-# Select the checkbox "''[x] Restart Luup after upload''" and click '''(Go)'''
-# ... wait whilst it uploads and restarts the Lua engine ...
-# If successful, you'll see the 3x files listed in the System.
-# Navigate to ''Devices'', scroll to the bottom at the ''Add device'' form.
-# Type "<tt>D_Weather.xml</tt>", and click '''(Add Device)''', type in a name of your choice against the device then click '''(Save)'''
-# At this point you should have a working Weather component
-−
-=Extras=
-Support has been added for the following Device Variables:
-*<tt>Location</tt> (String) a Location override for the settings configured within Vera.
-:This can be set to any value that the Google API supports.  These options aren't officially documented by Google, but there are various websites that show examples.  You can use values like "New York, USA" (etc) and it'll override the Lat/Long values in the Vera's [[Location]] settings.
-*<tt>Metric</tt> (Boolean) an override to force the calculations to produce values in Metric instead of Imperial.
-:This parameter defaults to "0" (Imperial), but can be set to Metric by changing the value to "1".  Visually, Vera will still display ("F" or "C") after the values, depending upon what has been set in Vera's [[Location]] settings.
-*<tt>Condition</tt> (String) something representing the current Weather state.  From postings on the internet, this seems to have values in the list (potentially more):
-:: <tt>Clear</tt>
-:: <tt>Cloudy</tt>
-:: <tt>Fog</tt>
-:: <tt>Haze</tt>
-:: <tt>Light rain</tt>
-:: <tt>Mostly Cloudy</tt>
-:: <tt>Overcast</tt>
-:: <tt>Partly Cloudy</tt>
-:: <tt>Rain</tt>
-:: <tt>Rain Showers</tt>
-:: <tt>Showers</tt>
-:: <tt>Thunderstorm</tt>
-:: <tt>Chance of Showers</tt>
-:: <tt>Chance of Snow</tt>
-:: <tt>Chance of Storm</tt>
-:: <tt>Mostly Sunny</tt>
-:: <tt>Partly Sunny</tt>
-:: <tt>Scattered Showers</tt>
-:: <tt>Sunny</tt>
-:: <tt>Snow</tt>
-:: <tt>Snow Showers</tt>
-:: <tt>Flurries</tt>
-:: <tt>Rain and Snow</tt>
-:: <tt>Ice/Snow</tt>
-:: <tt>Fog</tt>
-:: <tt>Windy</tt>
-:: <tt>Heavy Rain</tt>
-−
-−
-*<tt>WindCondition</tt> (String) a value like "W at 2 mph".
-−
-Changes to the values of Variables requires a '''(Save)''' Operation to be performed in Vera after the change has been made.
-−
-=Errors=
-*The Weather device requires [[Location]] data to start
-:If the Vera's Location has not been configured by the user, then the Weather plugin will not startup, and will indicate an error to the User in Vera's Device pane.
-*The Weather device is dependent upon data from Google's Weather API
-:Through the discussion thread below we've discovered that some of the values, such as the Humidity, for a given [[Location]] are extrapolated from nearby Weather stations.  This process isn't 100% accurate and can lead to anomalies.  If the information that's derived from Vera's [[Location]] settings is not accurate enough, you can use the Weather Device's <tt>Location</tt> variable to override it.  You can then specify ZIP Codes (etc) to get more accurate information.
-*The values don't display in Metric
-:Vera's luup API's, as of 1.0.900 don't support retrieval of the User-specified ''Temperature format'' in Vera's [[Location]] settings.  When this API is added, we can make changes to have the temperature values presented in that format.
-*It doesn't display correctly using http://findvera.com/mobile
-:As of Vera firmware release 1.0.900 there are problems in the Mobile renditions of multiple components.  <tt>TemperatureSensor</tt> and <tt>HumiditySensor</tt> devices seem to be among those not implemented.
-*The Humidity value doesn't display in the Dashboard.
-:This is a limitation of the Vera UI.  They don't appear to have a rendition for the <tt>HumdiditySensor</tt>.
-−
-=Releases=
-*4-Oct-2009
-:Added ability to override the Location information.  http://forum.micasaverde.com/index.php?topic=1435.msg8832#msg8832
-*7-Nov-2009
-:Added stateVariables for <tt>Condition</tt> ("Sunny", "Partly Cloudy", etc) and <tt>WindCondition</tt> ("W at 2 mph"), in case folks want to script off of these.  These are direct translations of the equivalent data from Google Weather.  I strip out the "<tt>Wind: </tt>" prefix string from the <tt>WindCondition</tt>
-−
-=Discussion=
-The Weather plugin is discussed in this forum thread, along with a lot of it's development history:
-:http://forum.micasaverde.com/index.php?topic=1435.0
-−
-Feel free to ask questions on that thread, as well as make any suggestions & contributions to the future development of the Weather plugin's functionality.

@@ Line 63: / Line 63: @@
 :: <tt>Scattered Showers</tt>
 :: <tt>Sunny</tt>
 *<tt>WindCondition</tt> (String) a value like "W at 2 mph".

@@ Line 77: / Line 77: @@
 :As of Vera firmware release 1.0.900 there are problems in the Mobile renditions of multiple components.  <tt>TemperatureSensor</tt> and <tt>HumiditySensor</tt> devices seem to be among those not implemented.
 *The Humidity value doesn't display in the Dashboard.
-:This is a limitation of the Vera UI.  They don't appear to have a rendition for the </tt>HumdiditySensor</tt>.
+:This is a limitation of the Vera UI.  They don't appear to have a rendition for the <tt>HumdiditySensor</tt>.
 =Releases=