Weatherlobby 3.90

From Cinemar Wiki
Jump to: navigation, search

About

Welcome to the MLWeatherLobby 3.90 Plugin.

WeatherLobby uses your Internet connection to download the current and future weather conditions for any number of locations. It creates MLServer variables with this information so that you can build custom MainLobby user interface scenes to display the weather. Because this weather data is contained in MLServer3 variables, you can also leverage that data for weather related automation logic. An example would be to shut down MLIrrigation from watering the lawn if the forecast was for rain.

System Requirements

  • MLServer version 3.75.78 or later
  • MainLobby Client v 3.0.151 or later
  • Microsoft Windows (any version)
  • PC with persistent Internet connection

Installation

Download and run the WeatherLobby Installer on the primary MLServer PC. You can optionally download the sample advanced weather scenes for MainLobby and install them on your client PCs.

Restart MLServer.

Adding Locations

Weather Locations.jpg

1. Open the MLWeatherLobby plugin.

2. Click on the Locations tab at the top.

3. Click on the Add Location button on the toolbar.

Weather AddLocation.jpg

4. If in the USA enter the 5 digit zipcode and press the Zip Code Look Up button. If outside the USA click the International Look Up button and select the country and city you wish to monitor and click ok.

4. Click Save.

Removing Locations

1. Open the MLWeatherLobby plugin.

2. Click on the locations tab at the top.

3. Select the locations to remove in the grid and then click on the delete button on the toolbar.


Adding Maps

Weather Maps.jpg

1. Open the MLWeatherLobby plugin.

2. Click on the Maps tab at the top.

3. Click on the Add Map button on the toolbar.

3. Enter the description and URL of the map in the apprppriate fields.

4. Click Save.


Removing Maps

1. Open the MLWeatherLobby plugin.

2. Click on the Maps tab at the top.

3. Select the maps to be removed in the grid and click on the delete button on the toolbar.


Enabling / Disabling Maps

1. Open the MLWeatherLobby plugin.

2. Click on the Maps tab at the top.

3. Click on the enable field in the grid to toggle the availability of the map.


Importing Maps

1. Open the MLWeatherLobby plugin.

2. Click on the Maps tab at the top.

3. Click on the Import.

4. Select the *.map file to be Imported.

NOTE: A sample map import file with over 5000 maps is installed in the root MLServer folder. The name of the file is "All Weather Maps.map"


Exporting Maps

1. Open the MLWeatherLobby plugin.

2. Click on the Maps tab at the top.

3. Select the maps to be exported on the grid

4. Click on the Export button.

4. Specify the name of the *.map file to be Exported and press save.


General Settings

Weather Settings.jpg

1. Open the MLWeatherLobby plugin.

2. Click on the Setting tab at the top.

3. If you have your own weather graphics you can specify the alternate folder.

4. Weather updates happen every 60 minutes. You can adjust the updated frequency by specifying a new value. Weather updates cannot occur at intervals less that 20 minutes.

WeatherLobby Advanced Client Scenes

Additional weather forecast variables are provided to view 48 hour weather, alerts, ski, pollen, tide and historic weather information for your selected areas. A set of advanced weather scenes are available to demonstrate the user of these variables. To access the advanced weather scenes do the following.

1. Make sure to install the updated WeatherLobby macros when prompted at the end of the WeatherLobby plugin install. This will update the Changescene.Weather macro to include the logic to switch to the advanced weather scenes if you have an active sunscription to the Intellicast weather feeds.

2. Download and install the latest MainLobby Advanced client scenes for WeatherLobby from MLInstaller. The installation will put new sample WeatherLobby scenes in the Cinemar\Content\0019\1024x768\Weather folder.

If everything goes well your new weather scene will become the Weather.mls file in the new Weather subfolder of the 0019 content folder. You will have to move the entire weather folder to a sub-folder of your active content folder before you use these scenes in a live environment. Please keep everything in a folder called weather because all the sample scenes use relative links to this folder.

MLServeCmds

Active

{MLServeCmd}Script Usage

MLServeCmd.MLWeatherLobby|Active~Number/Zip Code/Location ID


(Literal)

MLServeCmd.MLWeatherLobby|Active~1

MLServeCmd.MLWeatherLobby|Active~12345

MLServeCmd.MLWeatherLobby|Active~USWI0644


Parameters
Number/Zip Code/Location ID = The number, zip code, or location id of the location you wish to set to active.


Description

Sets the Active location.


Register

{MLServeCmd}Script Usage

MLServeCmd.MLWeatherLobby|Register~Number~Zip Code/Location ID


(Literal)

MLServeCmd.MLWeatherLobby|Register~1~12345

MLServeCmd.MLWeatherLobby|Register~2~USWI0644


Parameters
Number = The number of the new location Zip Code.
Zip Code/Location ID = The zip code or location of the new location.


Description

Registers a new location to be monitored.


Next

{MLServeCmd}Script Usage

MLServeCmd.MLWeatherLobby|Next


(Literal)

MLServeCmd.MLWeatherLobby|Next


Parameters
None =


Description

Sets the active location to the next one in the list. This command works in a circular fashion when the end of the list is reached it goes back to the beginning.


Previous

{MLServeCmd}Script Usage

MLServeCmd.MLWeatherLobby|Previous


(Literal)

MLServeCmd.MLWeatherLobby|Previous


Parameters
None =


Description

Sets the active location to the previous one in the list. This command works in a circular fashion when the beginning of the list is reached it goes back to the end.


ActiveMap

{MLServeCmd}Script Usage

MLServeCmd.MLWeatherLobby|ActiveMap~Number


(Literal)

MLServeCmd.MLWeatherLobby|ActiveMap~1

MLServeCmd.MLWeatherLobby|ActiveMap~2

MLServeCmd.MLWeatherLobby|ActiveMap~3


Parameters
Number = The number of the map you wish to make the active map.


Description

Sets the active map to the map with the specified number.


PreviousMap

{MLServeCmd}Script Usage

MLServeCmd.MLWeatherLobby|PreviousMap


(Literal)

MLServeCmd.MLWeatherLobby|PreviousMap


Parameters
None =


Description

Sets the active map to the next map in the list. This command works in a circular fashion, when the end of the list is reached it goes back to the beginning.


NextMap

{MLServeCmd}Script Usage

MLServeCmd.MLWeatherLobby|NextMap


(Literal)

MLServeCmd.MLWeatherLobby|NextMap


Parameters
None =


Description

Sets the active map to the previous map in the list. This command works in a circular fashion, when the beginning of the list is reached it goes back to the end.


MLServer Variables

Basic WeatherLobby Server Variables

The MLWeatherLobby plugin will auto generate variables in MLServer based on the settings you have entered. It will also update variables in certain circumstances such as changing the active location.

  • mlweather_active_map_description
  • mlweather_active_map_url
  • mlweather_barometer_direction
  • mlweather_barometer_pressure
  • mlweather_currenttemp
  • mlweather_feelslike
  • mlweather_humidity
  • mlweather_icon
  • mlweather_last_source_update
  • mlweather_location
  • mlweather_location_#_city
  • mlweather_location_#_state
  • mlweather_location_#_zipcode
  • mlweather_logo
  • mlweather_number
  • mlweather_source
  • mlweather_sunrise
  • mlweather_sunset
  • mlweather_temp_description
  • mlweather_units
  • mlweather_uvindex
  • mlweather_visibility
  • mlweather_wind_description
  • mlweather_wind_direction
  • mlweather_wind_gust
  • mlweather_wind_speed
  • mlweather_zipcode
  • mlweather_map_#_description
  • mlweather_map_#_url
  • mlweather_forecast_#_date
  • mlweather_forecast_#_day
  • mlweather_forecast_#_hitemp
  • mlweather_forecast_#_lowtemp
  • mlweather_forecast_#_sunrise
  • mlweather_forecast_#_sunset
  • mlweather_forecast_#_current_condition
  • mlweather_forecast_#_current_description (Automatically changes value based on Sunrise/Sunset)
  • mlweather_forecast_#_day_description
  • mlweather_forecast_#_day_humidity
  • mlweather_forecast_#_day_icon
  • mlweather_forecast_#_day_precipitation
  • mlweather_forecast_#_day_wind_description
  • mlweather_forecast_#_day_wind_direction
  • mlweather_forecast_#_day_wind_gust
  • mlweather_forecast_#_day_wind_speed
  • mlweather_forecast_#_night_description
  • mlweather_forecast_#_night_humidity
  • mlweather_forecast_#_night_icon
  • mlweather_forecast_#_night_precipitation
  • mlweather_forecast_#_night_wind_description
  • mlweather_forecast_#_night_wind_direction
  • mlweather_forecast_#_night_wind_gust
  • mlweather_forecast_#_night_wind_speed

Advanced WeatherLobby Server Variables

  • MLWeather_LocationID
  • MLWeather_City
  • MLWeather_StateAbbr
  • MLWeather_State
  • MLWeather_CountyFIPS
  • MLWeather_County
  • MLWeather_Country
  • MLWeather_CountryFIPS
  • MLWeather_WeatherStation
  • MLWeather_Latitude
  • MLWeather_Longtitude
  • MLWeather_TimeZone
  • MLWeather_IsDaylightsavings
  • MLWeather_ObservesDaylightSavings
  • MLWeather_PrimaryZipCode


Current Observation

  • MLWeather_Current_ReportTime
  • MLWeather_Current_DateYear
  • MLWeather_Current_DateMonth
  • MLWeather_Current_DateDay
  • MLWeather_Current_DateHour
  • MLWeather_Current_DateMinute
  • MLWeather_Current_DateSecond
  • MLWeather_Current_DateDOW
  • MLWeather_Current_TempF
  • MLWeather_Current_TempC
  • MLWeather_Current_DewPointF
  • MLWeather_Current_DewPointC
  • MLWeather_Current_RelHumidity
  • MLWeather_Current_WindSpeedMPH
  • MLWeather_Current_WindDirectionDegrees
  • MLWeather_Current_WindDirection
  • MLWeather_Current_WindGustsMPH
  • MLWeather_Current_Pressure
  • MLWeather_Current_Weather
  • MLWeather_Current_Sky
  • MLWeather_Current_Icon
  • MLWeather_Current_Ceiling
  • MLWeather_Current_Visibility
  • MLWeather_Current_HeatIndexF
  • MLWeather_Current_HeatIndexC
  • MLWeather_Current_WindChillF
  • MLWeather_Current_WindChillC
  • MLWeather_Current_FeelsLikeF
  • MLWeather_Current_FeelsLikeC
  • MLWeather_Current_SnowDepth
  • MLWeather_Current_SixHrMaxTemp
  • MLWeather_Current_TwentyFourHrMaxTemp
  • MLWeather_Current_SixHrMinTemp
  • MLWeather_Current_TwentyFourHrMinTemp
  • MLWeather_Current_ThreeHrPrecip
  • MLWeather_Current_SixHrPrecip
  • MLWeather_Current_TwentyFourHrPrecip
  • MLWeather_Current_CodedWeather
  • MLWeather_Current_EnhancedWeather
  • MLWeather_Current_ReportText

Historic Average

  • MLWeather_Historic_StationName
  • MLWeather_Historic_Month
  • MLWeather_Historic_Date
  • MLWeather_Historic_Interval
  • MLWeather_Historic_AvgHiF
  • MLWeather_Historic_AvgHiC
  • MLWeather_Historic_AvgLoF
  • MLWeather_Historic_AvgLoC
  • MLWeather_Historic_RecordHiF
  • MLWeather_Historic_RecordHiC
  • MLWeather_Historic_RecordHiDate
  • MLWeather_Historic_RecordLoF
  • MLWeather_Historic_RecordLoC
  • MLWeather_Historic_RecordLoDate
  • MLWeather_Historic_MeanTempF
  • MLWeather_Historic_MeanTempC
  • MLWeather_Historic_AvgPrecipIn
  • MLWeather_Historic_AvgPrecipCm
  • MLWeather_Historic_AvgSnowIn
  • MLWeather_Historic_AvgSnowCm

Hourly Forecast

  • MLWeather_HF 1..48 _Hour
  • MLWeather_HF_ReportTime
  • MLWeather_HF_ReportTimeYear
  • MLWeather_HF_ReportTimeMonth
  • MLWeather_HF_ReportTimeDay
  • MLWeather_HF_ReportTimeHour
  • MLWeather_HF_ReportTimeMinute
  • MLWeather_HF_ReportTimeSecond
  • MLWeather_HF_ReportTimeDOW
  • MLWeather_HF 1..48 _DOW
  • MLWeather_HF 1..48 _DateUTC
  • MLWeather_HF 1..48 _Date
  • MLWeather_HF 1..48 _DateYear
  • MLWeather_HF 1..48 _DateMonth
  • MLWeather_HF 1..48 _DateDay
  • MLWeather_HF 1..48 _DateHour
  • MLWeather_HF 1..48 _DateMinute
  • MLWeather_HF 1..48 _DateSecond
  • MLWeather_HF 1..48 _DateDOW
  • MLWeather_HF 1..48 _TempF
  • MLWeather_HF 1..48 _TempC
  • MLWeather_HF 1..48 _SkyCode
  • MLWeather_HF 1..48 _SkyCodeExt
  • MLWeather_HF 1..48 _Icon
  • MLWeather_HF 1..48 _SkyL
  • MLWeather_HF 1..48 _SkyM
  • MLWeather_HF 1..48 _SkyS
  • MLWeather_HF 1..48 _ChancePrecip
  • MLWeather_HF 1..48 _ChanceSnow
  • MLWeather_HF 1..48 _RelHumidity
  • MLWeather_HF 1..48 _WindSpeedMPH
  • MLWeather_HF 1..48 _WindSpeedKM
  • MLWeather_HF 1..48 _WindSpeedKN
  • MLWeather_HF 1..48 _WindDegrees
  • MLWeather_HF 1..48 _WindDirection
  • MLWeather_HF 1..48 _HeatIndexF
  • MLWeather_HF 1..48 _HeatIndexC
  • MLWeather_HF 1..48 _WindChillF
  • MLWeather_HF 1..48 _WindChillC
  • MLWeather_HF 1..48 _VisibilityMI
  • MLWeather_HF 1..48 _VisibilityKM
  • MLWeather_HF 1..48 _CloudCoverage
  • MLWeather_HF 1..48 _DewPointF
  • MLWeather_HF 1..48 _DewPointC
  • MLWeather_HF 1..48 _UVIndex
  • MLWeather_HF 1..48 _UVDescr
  • MLWeather_HF 1..48 _UVWarn

Daily Forecast

  • MLWeather_DF 1..10 _Day
  • MLWeather_DF 1..10 _DateUTC
  • MLWeather_DF 1..10 _Date
  • MLWeather_DF 1..10 _DateYear
  • MLWeather_DF 1..10 _DateMonth
  • MLWeather_DF 1..10 _DateDay
  • MLWeather_DF 1..10 _DateHour
  • MLWeather_DF 1..10 _DateMinute
  • MLWeather_DF 1..10 _DateSecond
  • MLWeather_DF 1..10 _DateDOW
  • MLWeather_DF 1..10 _HiTempF
  • MLWeather_DF 1..10 _LoTempF
  • MLWeather_DF 1..10 _HiTempC
  • MLWeather_DF 1..10 _LoTempC
  • MLWeather_DF 1..10 _DayShort
  • MLWeather_DF 1..10 _Day
  • MLWeather_DF 1..10 _Night
  • MLWeather_DF 1..10 _Icon
  • MLWeather_DF 1..10 _SkyCode
  • MLWeather_DF 1..10 _SkyText
  • MLWeather_DF 1..10 _ChancePrecip
  • MLWeather_DF 1..10 _ChanceSnow
  • MLWeather_DF 1..10 _RelHumidity
  • MLWeather_DF 1..10 _WindSpeedMPH
  • MLWeather_DF 1..10 _WindSpeedKM
  • MLWeather_DF 1..10 _WindSpeedKN
  • MLWeather_DF 1..10 _Degrees
  • MLWeather_DF 1..10 _Direction
  • MLWeather_DF 1..10 _CloudCoverage
  • MLWeather_DF 1..10 _UVIndex
  • MLWeather_DF 1..10 _UVDescr
  • MLWeather_DF 1..10 _UVWarn
  • MLWeather_DF 1..10 _Sunrise
  • MLWeather_DF 1..10 _Sunset
  • MLWeather_DF 1..10 _MoonRise
  • MLWeather_DF 1..10 _MoonSet
  • MLWeather_DF 1..10 _MoonPhase
  • MLWeather_DF 1..10 _MoonDescr

Weather Alerts

  • MLWeather_Alert_Count
  • MLWeather_Alert1_CountryFIPS
  • MLWeather_Alert1_StateAbbr
  • MLWeather_Alert1_Type
  • MLWeather_Alert1_StartTime
  • MLWeather_Alert1_EndTime
  • MLWeather_Alert1_Headline
  • MLWeather_Alert1_Bulletin
  • MLWeather_Alert1_URL
  • MLWeather_Alert1_Category
  • MLWeather_Alert1_Urgency
  • MLWeather_Alert1_Severity
  • MLWeather_Alert1_Certainty
  • MLWeather_Alert1_Geoname
  • MLWeather_Alert1_StateName
  • MLWeather_Alert1_CountyName
  • MLWeather_Alert 1..n _CountryFIPS
  • MLWeather_Alert 1..n _StateAbbr
  • MLWeather_Alert 1..n _Type
  • MLWeather_Alert 1..n _StartTime
  • MLWeather_Alert 1..n _EndTime
  • MLWeather_Alert 1..n _Headline
  • MLWeather_Alert 1..n _Bulletin
  • MLWeather_Alert 1..n _URL
  • MLWeather_Alert 1..n _Category
  • MLWeather_Alert 1..n _Urgency
  • MLWeather_Alert 1..n _Severity
  • MLWeather_Alert 1..n _Certainty
  • MLWeather_Alert 1..n _Geoname
  • MLWeather_Alert 1..n _StateName
  • MLWeather_Alert 1..n _CountyName

Tides

  • MLWeather_Tide_CityID
  • MLWeather_Tide_TideID
  • MLWeather_Tide_Distance
  • MLWeather_Tide_CityName
  • MLWeather_Tide_CityLatitude
  • MLWeather_Tide_CityLongtitude
  • MLWeather_Tide_Count
  • MLWeather_Tide 1..n _Date
  • MLWeather_Tide 1..n _TimeZone
  • MLWeather_Tide 1..n _FirstHiTide
  • MLWeather_Tide 1..n _FirstHiTideHeight
  • MLWeather_Tide 1..n _SecondHiTide
  • MLWeather_Tide 1..n _SecondHiTideHeight
  • MLWeather_Tide 1..n _FirstLoTide
  • MLWeather_Tide 1..n _FirstLoTideHeight
  • MLWeather_Tide 1..n _SecondLoTide
  • MLWeather_Tide 1..n _SecondLoTideHeight
  • MLWeather_Tide 1..n _Sunrise
  • MLWeather_Tide 1..n _Sunset

Ski Resort

  • MLWeather_Ski_CityID
  • MLWeather_Ski_Name
  • MLWeather_Ski_CityName
  • MLWeather_Ski_StateAbbr
  • MLWeather_Ski_ZipCode
  • MLWeather_Ski_Latitude
  • MLWeather_Ski_Longtitude
  • MLWeather_Ski_BaseElevation
  • MLWeather_SkiConditions_crosscountrykm
  • MLWeather_SkiConditions_snowmakingpercent
  • MLWeather_SkiConditions_snowmakingtrails
  • MLWeather_SkiConditions_groomingpercent
  • MLWeather_SkiConditions_groomingtrails
  • MLWeather_SkiConditions_hastubinglift
  • MLWeather_SkiConditions_tubinglanes
  • MLWeather_SkiConditions_tubinglocation
  • MLWeather_SkiConditions_tubinghours
  • MLWeather_SkiConditions_halfpipelocation
  • MLWeather_SkiConditions_terrainparklocation
  • MLWeather_SkiConditions_terrainparkfeatures
  • MLWeather_SkiConditions_halfpipeterrainother
  • MLWeather_SkiConditions_currentweather
  • MLWeather_SkiConditions_currenttemperature
  • MLWeather_SkiConditions_forecastweather
  • MLWeather_SkiConditions_forecasttemperature
  • MLWeather_SkiConditions_roads
  • MLWeather_SkiConditions_winds
  • MLWeather_SkiConditions_visibility
  • MLWeather_SkiConditions_suggestedtrails
  • MLWeather_SkiConditions_hasiceskating
  • MLWeather_SkiConditions_haswalkingtrails
  • MLWeather_SkiConditions_hassledding
  • MLWeather_SkiConditions_hascurling
  • MLWeather_SkiConditions_crosscountrynotes
  • MLWeather_SkiConditions_descent
  • MLWeather_SkiConditions_runconditions
  • MLWeather_SkiConditions_specialevents
  • MLWeather_SkiConditions_avalancherisk
  • MLWeather_SkiConditions_crosscountrysingletrack
  • MLWeather_SkiConditions_crosscountryskatingkm
  • MLWeather_SkiConditions_crosscountryopentrails
  • MLWeather_SkiConditions_latitude
  • MLWeather_SkiConditions_longitude
  • MLWeather_SkiConditions_cityname
  • MLWeather_SkiConditions_physicaladdressshort
  • MLWeather_SkiConditions_zipcode
  • MLWeather_SkiConditions_physicaladdresslong
  • MLWeather_SkiConditions_secondarysurface
  • MLWeather_SkiConditions_snowcomments
  • MLWeather_SkiConditions_hoursopen
  • MLWeather_SkiConditions_nighttrails
  • MLWeather_SkiConditions_nightlifts
  • MLWeather_SkiConditions_hascrosscountry
  • MLWeather_SkiConditions_issnowmaking
  • MLWeather_SkiConditions_isgrooming
  • MLWeather_SkiConditions_hastubing
  • MLWeather_SkiConditions_hashalfpipe
  • MLWeather_SkiConditions_hasterrainpark
  • MLWeather_SkiConditions_projectedterrain
  • MLWeather_SkiConditions_totaltrails
  • MLWeather_SkiConditions_totalmiles
  • MLWeather_SkiConditions_totalacres
  • MLWeather_SkiConditions_totallifts
  • MLWeather_SkiConditions_lastsnow
  • MLWeather_SkiConditions_previoussnow
  • MLWeather_SkiConditions_phonenumber
  • MLWeather_SkiConditions_stateabbreviation
  • MLWeather_SkiConditions_areaname
  • MLWeather_SkiConditions_reporttime
  • MLWeather_SkiConditions_newsnow24hours
  • MLWeather_SkiConditions_primarysurface
  • MLWeather_SkiConditions_averagebase
  • MLWeather_SkiConditions_trailsopen
  • MLWeather_SkiConditions_liftsopen
  • MLWeather_SkiConditions_milesopen
  • MLWeather_SkiConditions_acresopen
  • MLWeather_SkiConditions_percentopen
  • MLWeather_SkiConditions_hasnightskiing
  • MLWeather_SkiConditions_openstatus
  • MLWeather_SkiConditions_crosscountryopenkm
  • MLWeather_SkiConditions_entrytype
  • MLWeather_SkiConditions_lastsnowamount
  • MLWeather_SkiConditions_previoussnowdate
  • MLWeather_SkiConditions_previoussnowamount
  • MLWeather_SkiConditions_seasontotalsnow
  • MLWeather_SkiConditions_newsnowminimum
  • MLWeather_SkiConditions_newsnowmaximum
  • MLWeather_SkiConditions_baseminimum
  • MLWeather_SkiConditions_basemaximum
  • MLWeather_SkiConditions_lastsnowdate

Pollen Forecast

  • MLWeather_PF_DayCount
  • MLWeather_PF 1..n _DayNum
  • MLWeather_PF 1..n _PollenType
  • MLWeather_PF 1..n _Station
  • MLWeather_PF 1..n _ReportTime
  • MLWeather_PF 1..n _Date
  • MLWeather_PF 1..n _UTCDate
  • MLWeather_PF 1..n _PollenIndex
  • MLWeather_PF 1..n _PollenDescr

Pollen Observation

  • MLWeather_Pollen_ReportTime
  • MLWeather_Pollen_CityName
  • MLWeather_Pollen_StateAbbr
  • MLWeather_Pollen_TreePollenIndex
  • MLWeather_Pollen_GrassPollenIndex
  • MLWeather_Pollen_WeedPollenIndex
  • MLWeather_Pollen_MoldCountIndex
  • MLWeather_Pollen_ActiveTreeSpecies1
  • MLWeather_Pollen_ActiveTreeSpecies2
  • MLWeather_Pollen_ActiveTreeSpecies3
  • MLWeather_Pollen_PollenCount