Usage:   Available Parameters

Following is a table of the available parameters that you can use in your URLs and forms for accessing various HAMweather functions.

Parameter
Name
Description
Parameters Dealing with Location Forecast Needed For
place City/Town/County forecast needed for.
state State needing forecast for. Can be full state name or 2 letter abbreviation.
If you need forecast info on the national level then set state to be "us"
pands Place and state together separated by a comma.State portion can be full state name or 2 letter abbreviation. If the HWzipdb add-on is install will allow you to enter a US zipcode as well.
NOTE: It is recommended you install the HWaltplaces add-on to allow users to enter more "place, state" combinations. Also for the zipcode searching, the HWzipdb add-on must be installed. Both add-ons can be downloaded from http://www.hamweather.com/downloads
zipcode If the HWzipdb add-on is installed, this parameter can be set to a US zipcode  to fetch the forecast.
NOTE: The HWzipdb add-on must be installed to use this parameter. The add-on can be downloaded from http://www.hamweather.com/downloads
zone The actual weather zone number for a place you need zone or shortterm forecast for within a specified state. When both the zone and place are specified the zone will be used to fetch forecast and the place will be the place name outputted to user.
icao This is the 4 digit ICAO code for a weather facility. It is used when obtaining metar observations(current conditions).
type Used by metarlister.cgi and when obtaining metar forecast to determine weather what metar forecast you need. Set to "state" for a metar observation in the US or set to "country" for a metar observation in another country.
Forecast Type and Control Parameters
forecast Tells HAMweather what type of forecast you need. For a complete list of available forecast type check out the Available Forecasts Table.  Also if this is set to "pass" then HAMweather will not output a forecast but will just output the template file specified in by the "pass" parameter.
case If set to "0"(default) then forecast text will be converted to proper casing.  If set to "1" then the forecast text will be left in uppercase
txt If set to "0"(default) then any html coding will be left in the %%zforecast%% variable.  If set to "1" then all html coding will be removed from the %%zforecast%% variable. This is useful if you are outputting the forecast to a text file etc..
daysonly For the zone and zandh forecasts.  This will control how the Weather icon row is displayed.  This parameter can be set via the web based admin for a user. If this parameter is provided in the url it overrides the defautl setting. It has 4 settings:

daysonly=0 : Display the weather icon row normally with day and night icons and use the day titles givien.
daysonly=1 : Display the icon row with days only (no nights) and use the normal day titles given
daysonly=2 : Display the icon row with days only (no nights) and use only weekday names (Monday, Tuesday etc)
daysonly=3 : Display the icon row with days only (no nights) and use only 3 letter weekday names (MON, TUE, etc)

maxdays For the zone and zandh forecasts this will control how many weather icons are included in the zone forecast.Default can be set in the Administration script.
extended If set to "0"(default) then the extended forecast if in the zone forecast will be included.  If set to "1" then the extended forecast will be ignored and not displayed in the zone and zandh forecast.
celsius If set to "1" will make the Temps in the icon row FOR US forecast to be in Celsius instead of Farenheit
metric If set to "1" will make the various values in the icon row and hourly data be in metric units.
round Overrides the default round setting. If set to 0 HW will not round any weather calculations/conversions. If set to one HW will round conversions such as Celsius temps, wind chill etc..
day_begin Can be used to override the default day_begin hour. This is used with current conditions to control whether a day or night icon should be displayed. (This ability to pass this parameter allows  users to match current conditions  with their time zones).  Should be set to a number between 0 and 24 to the hour that is daylight.
day_end Can be used to override the default day_end hour. This is used with current conditions to control whether a day or night icon should be displayed. (This ability to pass this parameter allows  users to match current conditions  with their time zones).   Should be set to a number between 0 and 24 to the hour that daylight ends.
tz If set it will override the default time zone setting. This affects the US maps and the current conditions obtained via the metar observations (ICAO code given). This can allow International users to have their correct time/date on their current conditions. tz should be set to the offset in hours from GMT time. For example to set the tz for EST time you would set tz to -5 .. tz=-5. 

NOTE: The tz parameter should be used along with the tz_name parameter.

tz_name If set it will override the default time zone name setting. This affects the US maps and the current conditions obtained via the metar observations (ICAO code given). This can allow International users to have their correct time/date on their current conditions. tz_name should be set to the time zone name to use. For example to set the tz_name for EST time you would set tz_name to EST.. tz_name=EST. 

NOTE: The tz_name parameter should be used along with the tz parameter.

HAMweather Template Override Parameters
alt When set to an alternate template name (as previously set using the HAMweather Administrator) it will force HAMweather to use the alternate template when outputting the forecast to the user.
pass When the "forecast" parameter is set to "pass" then HAMweather will use the template name specified by this parameter (possible template names need to be set using the HAMweather administrator) and output it to the user.
User/Theme Parameters
user This parameter tells HAMweather what user configuration file to use.  If not specified or the indicated user configuration file does not exist then HAMweather will use the default of "default.txt".  The value you use should be the same as the user config file name minus the ".txt" extension.  this use "default" for the "default.txt" file.

This parameter gives you the ability to have multiple Web server clients use the same HAMweather installation yet have their own customized templates, graphics and themes.  This a good option for ISP's or if you want to allow a friend to use your script installation as well.

theme This parameter tells HAMweather what theme configuration file to use.  If not specified or the indicated theme file does not exist then HAMweather will use the default file "default.txt"  The value you use should be the same as the user config file name minus the ".txt" extension.  this use "default" for the "default.txt" file.

Themes allow you to give your HAMweather multiple looks and feels just by changing the "theme" value in your links to HAMweather.   Themes will usually consist of alternate templates and icons to use.  A great idea is to install/create  themes for holidays then when the holiday comes around you can just change your links to your HAMweather scripts and then your weather site would be in the holiday spirit :)

Site/User Defined Variables
hwvxxxx HAMweather allows for the individual site to define its own variables that can be transfered from page to page and from template to template. To use them you simple add 'hwv' to the variable name.. thus if you wanted a variable called bgcolor you would user 'hwvbgcolor'.  Refer to the User Variables Page (under Customization) for more Information.
Cookie Variables
sc This parameter tells HAMweather to set a cookie on the web visitors computers.   The cookie will hold the info on the current forecast, template, place, state, country, icao code, zone, etc.  Then the next time the user visits the hamweather.cgi without any parameters specified it will use the cookie values to give a default forecast.

This parameter has a total of 5 different settings that can be used:

sc=0 (or parameter not used) : No cookie stored
sc=1 : cookie stored without the user and theme parameters (normal default when saving a cookie)
sc=2 : cookie stored with the user parameter but not the theme parameter
sc=3 : cookie stored with the theme parameter but not the user parameter.
sc=4 : cookie stored with both the user and theme parameters

NOTE: Even if user and theme parameters may be stored in the cookie, if they are provided via the url they override the cookie user and theme settings.

forcefc This paramter is used to overide the 'forecast' setting in a user cookie.  Thus you can use the default place stored in their cookie, yet provide a different forecast etc. For a complete list of available forecast type check out the Available Forecasts Table.  Also if this is set to "pass" then HAMweather will not output a forecast but will just output the template file specified in by the "pass" parameter.
For use when Sending Output to a File
om This parameter sets the output method used by HAMweather.

Set to zero (om=0) or leave out to make output goto Web only.
Set to one (om=1) to make output goto file and web.
Set to two (om=2) to make output goto the web only.

of This parameter is used to specify what file to send output to.  You set to the output file name that was previously set in the web based administration.
Additional Parameters used by HAMweather Pro Add-on
map This parameter is used to tell HAMweather how to create the needed forecast map.   If it is set to "0" then HAMweather will output  the needed national forecast requested but not create a graphical map. 
Set to "1" HAMweather will create a new national map if  needed (previous one has expired in the cache) and output the forecast requested.
Set to "2" HAMweather will create a new national map if needed  but not send out any output.  You should use the "2" setting if you are updating the various national maps from a cron job or command line.

Now to see what Forecast Information is available through HAMweather.