Difference between revisions of "Weather Plugin"

From LinuxMCE
Jump to: navigation, search
(Initial content.)
 
(formatting.)
Line 13: Line 13:
 
Weather icons are referenced by number, and are used by the condicon_* variables mentioned below. These graphics are pre-rendered into the orbiter page, and are selected appropriately.
 
Weather icons are referenced by number, and are used by the condicon_* variables mentioned below. These graphics are pre-rendered into the orbiter page, and are selected appropriately.
  
{|
+
{| class="wikitable"
 
! Icon #
 
! Icon #
 
! Description
 
! Description
Line 60: Line 60:
 
=== Weather Variables and their use ===
 
=== Weather Variables and their use ===
  
{|
+
{| class="wikitable"
 
! Variable
 
! Variable
 
! Description
 
! Description

Revision as of 04:15, 29 July 2013

The Weather Plugin acts as a data store, and event interceptor for all weather related events. This is different from the Climate Plugin, in that Climate Plugin handles all climate related issues with the house itself, whereas Weather Plugin merely reports weather changes, and allows the system to react to them.

Uses

Currently, the Weather Plugin is used to create a weather information page, which can be displayed on all Orbiters. Later revisions of the Weather Plugin will also allow a user to respond to changes in weather, such as "Turn the Lights on when it rains."

Programmer Information

The Weather Plugin listens to events from either a Weather Station device, or from an external script using MessageSend.

Weather Icons

Weather icons are referenced by number, and are used by the condicon_* variables mentioned below. These graphics are pre-rendered into the orbiter page, and are selected appropriately.

Icon # Description
1 Unknown
2 Sunny
3 Fair
4 Cloudy
5 Moderately Cloudy
6 Partially Cloudy
7 Fog
8 Light Showers
9 Showers
10 Thunder/showers
11 Snow showers
12 Flurries
13 Rain/Snow

Weather Variables and their use

Variable Description Example
temp_current The current human readable temperature 71*F
temp_hi_day1 The HI human readable temperature one day after today 70*F
temp_lo_day1 The LO human readable temperature one day after today 55*F
temp_hi_day2 The HI human readable temperature two days after today 66*F
temp_lo_day2 The LO human readable temperature two days after today 45*F
temp_hi_day3 The HI human readable temperature three days after today 62*F
temp_lo_day3 The HI human readable temperature three days after today 55*F
temp_hi_day4 The HI human readable temperature four days after today 70*F
temp_lo_day4 The LO human readable temperature four days after today 70*F
temp_hi_day5 The HI human readable temperature five days after today 55*F
temp_lo_day5 The LO human readable temperature five days after today 55*F
temp_hi_day6 The HI human readable temperature six days after today 66*F
temp_lo_day6 The LO human readable temperature six days after today 66*F
temp_hi_day7 The HI human readable temperature seven days after today 70*F
temp_lo_day7 The LO human readable temperature seven days after today 70*F
condtext_current The human readable weather condition phrase, today Sunny
condtext_day1 The human readable weather condition phrase, one day after today Fair
condtext_day2 The human readable weather condition phrase, two days after today Rainy
condtext_day3 The human readable weather condition phrase, three days after today Cloudy
condicon_current The icon # (see Weather Icons above) to display, today 2
condicon_day1 The icon # (see Weather Icons above) to display, one day after today. 3
condicon_day2 The icon # (see Weather Icons above) to display, two days after today. 4
condicon_day3 The icon # (see Weather Icons above) to display, three days after today. 5
condicon_day4 The icon # (see Weather Icons above) to display, four days after today. 4
condicon_day5 The icon # (see Weather Icons above) to display, five days after today. 2
condicon_day6 The icon # (see Weather Icons above) to display, six days after today. 4
condicon_day7 The icon # (see Weather Icons above) to display, seven days after today. 4
data_age Human readable description describing when data was last sent to the weather plugin. 32 minutes ago.
location Human readable locale name. Dallas, TX 76201