Skip to content

Latest commit

 

History

History
134 lines (103 loc) · 5.6 KB

README.md

File metadata and controls

134 lines (103 loc) · 5.6 KB

NWS Forecasts with Leaflet map

This script set was based on an earlier work by Curly of Michiana Weather that used the MapClick.php on https://forecast.weather.gov/ for XML data about the point weather forecast. Since the NWS is soon to deprecate that script, the former wxForecastMap.php script has been rewritten to use Leaflet/OpenStreetMap map display (instead of Google maps) and to use the NWS API at https://api.weather.gov/ for JSON data regarding the forecast point.

Using Leaflet/OpenStreetMap means no API key is required for display of the map. However, if you wish to use the OPTIONAL Mapbox.com tiles (terrain3, Satellite maps), you will need a Mapbox.com API key (called an "Access Token") which can be acquired (for free with 50K accesses usage/month) at:

https://www.mapbox.com/signup/?

in the NWS-forecast-map.php script you can put

$setMapboxAPIkey = '-replace-this-with-your-API-key-here-';

Note: if using the Saratoga template set, put a new entry in Settings.php

$SITE['mapboxAPIkey'] = '-replace-this-with-your-API-key-here-';

A Mapbox API key is OPTIONAL .. you do not need it to use maps from 5 included free map tile providers.

Script operation

The script will make three API calls to api.weather.gov when a forecast is loaded (either at script initialization, or a double-click on a point on the displayed map). Changing the basemap tiles, zoom-in/zoom-out or scrolling the map does not result in API calls to api.weather.gov

The first API request is for /points/<latitude>,<longitude> and the resulting JSON is used to fetch the /gridpoints/<WFO>/<gridpointX>,<gridpointY>/forecast which contains the actual forecast for that area. The third API call is to /alerts/active/zone/<CountyZone> to get/format any active weather alerts for the county. If any are found, the text summary of the alert is presented in a red-outlined box below the map. A mouseover will display the details, and a click will go to the weather.gov page with the full alert. If the alert provided a geometry polygon, then that polygon will be drawn on the map (in addition to the outline of the forecast area).

Note that NO CACHING is done on the results, and the weather icons displayed in the table below the map are directly from api.weather.gov.

Script settings

The following are customizable settings for the NWS-forecast-map.php script:

# settings: --------------------------------------------------------------------
# if you are using www.mapbox.com for map tiles, you
# need to acquire an API ke from that service
#
#  put this in the CALLING page for quake-json.php script:
/*
  $mapboxAPIkey = '-replace-this-with-your-API-key-here-';
*/
# Note: if using the Saratoga template set, put a new entry in Settings.php
/*

$SITE['mapboxAPIkey'] = '-replace-this-with-your-API-key-here-';

*/
# and you won't need to change the $mapAPI value above (nor any of the other
# settings in the script below.
#
#  change myLat, myLong to your station latitude/longitude,
#  set $ourTZ to your time zone
#    other settings are optional
#
#  set to station latitude/longitude (decimal degrees)
  $myLat = 37.2747;    //North=positive, South=negative decimal degrees
  $myLong = -122.0229;   //East=positive, West=negative decimal degrees
# The above settings are for saratoga-weather.org location
  $ourTZ = "America/Los_Angeles";  //NOTE: this *MUST* be set correctly to
# translate UTC times to your LOCAL time for the displays.
# Use https://www.php.net/manual/en/timezones.php to find the timezone suitable for
#  your location.
#
#  pick a format for the time to display ..uncomment one (or make your own)
# $timeFormat = 'D, Y-m-d H:i:s T';  // Fri, 2006-03-31 14:03:22 TZone
#  $timeFormat = 'D, d-M-Y g:i:s a T';  // Fri, 31-Mar-2006 4:03:22 am TZone
  $timeFormat = 'g:i a T M d, Y';  // 10:30 am CDT March 31, 2018

	# see: http://leaflet-extras.github.io/leaflet-providers/preview/ for additional maps
	# select ONE map tile provider by uncommenting the values below.

	$mapProvider = 'Esri_WorldTopoMap'; // ESRI topo map - no key needed
	#$mapProvider = 'OSM';     // OpenStreetMap - no key needed
	#$mapProvider = 'Terrain'; // Terrain map by stamen.com - no key needed
	#$mapProvider = 'OpenTopo'; // OpenTopoMap.com - no key needed
	#$mapProvider = 'Wikimedia'; // Wikimedia map - no key needed
#
	#$mapProvider = 'MapboxSat';  // Maps by Mapbox.com - API KEY needed in $mapboxAPIkey
	#$mapProvider = 'MapboxTer';  // Maps by Mapbox.com - API KEY needed in $mapboxAPIkey
	$mapboxAPIkey = '--mapbox-API-key--';
	# use this for the API key to MapBox
  $mapZoomDefault = 11;  // =11; default Leaflet Map zoom entry for display (1=world, 14=street)

# end of settings -------------------------------------------------------------

If you are running the script in a Saratoga template, then the following entries in Settings.php will override what is defaulted in the NWS-forecast-map.php script:

$SITE['latitude']
$SITE['longitude']
$SITE['tz']
$SITE['timeFormat']
$SITE['mapboxAPIkey']

Using in your existing page design

Put the following before the </head> part of your page:

<link rel="stylesheet" href="NWS-forecast-map.css" />
<style type="text/css">
<!--
.graytitles {
  font-size:large;
  text-align:center;
  margin-top: 5px;
}
-->
</style>
</head>

and put the following in the main display section of your page:

<?php
  $doInclude = true;
	include_once('NWS-forecast-map.php');

?>

Sample Output (no alert active)

Sample output

Sample Output (several alerts active)

Sample output with alerts showing