MMM-FOSHKplugin-PWS-Observations

A basic module for displaying local current weather data from your PWS via FOSHKplugin

This project started life as an attempted to get the MMM-Wunderground module from https://github.com/saabman/MMM-Wunderground-PWS-Observations working for a local access via WU protocol offered by FOSHKplugin http service. I decided to cut it down to just the data provided from your local PWS.

The Weather Icons used in this module are created and maintained by Erik Flowers. v1.0 artwork by Lukas Bischoff. v1.1 - 2.0 artwork by Erik Flowers www.weathericons.io

Requires FOSHKplugin http address http://ipaddress:port/observations/ as apiBase

See also the recipe Displaying local PWS data with FOSHKplugin on a MagicMirror on FOSHKplugin web page.

to install:

cd ~/MagicMirror/modules # adapt directory if you are using a different one
git clone https://github.com/git-olicat/MMM-FOSHKplugin-PWS-Observations
cd MMM-FOSHKplugin-PWS-Observations
npm install

After installation you have to configure the modul within the modules section of config.js (just before the "]":

cd ~/MagicMirror/config # adapt directory if you are using a different one
vi config.js // or use your favourite editor

Remember: apiBase is mandatory and should contain the FOSHKplugin http URL (e.g. http://192.168.178.100:8080/observations/)

		{
			module: 'MMM-FOSHKplugin-PWS-Observations',

			position: 'top_right',
			header: 'FOSHKplugin data',
			config: {

				apiBase: 'http://ipaddress:port/observations/', // e.g. http://192.168.15.100:8096/observations/
				pws: 'FOSHKplugin',
				apikey: 'MMM',
				updateInterval: 60000,  // 1 minute = 60000 millis
				roundTmpDecs: 0,
				sysstat: 0,
				debug: 1,
				currentweather: 1,
				temperature: 1,
				humidity: 1,
				pressure: 1,
				wind: 1,
				solarRadiation: 1,
				UV: 1,
				rain: 1,
				rainRate: 1,
				dewPoint: 1,
				windChill: 1,
				heatIndex: 1,
				// new keys - choose whatever you want, but bear in mind the limited space
				indoorTemperature: 0,
				indoorHumidity: 0,
				temperature1: 0,
				Humidity1: 0,
				temperature2: 0,
				Humidity2: 0,
				temperature3: 0,
				Humidity3: 0,
				temperature4: 0,
				Humidity4: 0,
				temperature5: 0,
				Humidity5: 0,
				temperature6: 0,
				Humidity6: 0,
				temperature7: 0,
				Humidity7: 0,
				temperature8: 0,
				Humidity8: 0,
				soilmoisture: 0,
				soilmoisture2: 0,
				soilmoisture3: 0,
				soilmoisture4: 0,
				soilmoisture5: 0,
				soilmoisture6: 0,
				soilmoisture7: 0,
				soilmoisture8: 0,
				soilmoisture9: 0,
				soilmoisture10: 0,
				soilmoisture11: 0,
				soilmoisture12: 0,
				soilmoisture13: 0,
				soilmoisture14: 0,
				soilmoisture15: 0,
				soilmoisture16: 0,
				soiltemp: 0,
				soiltemp2: 0,
				soiltemp3: 0,
				soiltemp4: 0,
				soiltemp5: 0,
				soiltemp6: 0,
				soiltemp7: 0,
				soiltemp8: 0,
				lightning_day: 0,
				lightning_distance: 0,
				lightning_time: 0,
			}
		},

Configuration options

The following properties can be configured:

Option	Description
apiBase	The FOSHKplugin http URL This value is REQUIRED
apikey	The Weather Underground API key This value is optional.
wind	Displays wind data Possible values: 1 - 0 Default value: 1 (Will display data) This value is optional. By default the data will be displayed
humidity	Displays humidity data Possible values: 0 - 1 Default value: 1 (Will display data) This value is optional. By default the data will be displayed.
UV	Displays UV data Possible values: 0 - 1 Default value: 0 (Will not display data) This value is optional. By default the data will not be displayed.
rain	Displays rain fall data Possible values: 0 - 1 Default value: 1 (Will display data) This value is optional. By default the data will be displayed.
rainRate	Displays rain rate data Possible values: 0 - 1 Default value: 1 (Will display data) This value is optional. By default the data will be displayed.
pressure	Displays atmospheric pressure data Possible values: 0 - 1 Default value: 1 (Will display data) This value is optional. By default the data will be displayed.
dewpoint	Displays dewpoint temperature Possible values: 0 - 1 Default value: 1 (Will display data) This value is optional. By default the data will be displayed.
windChill	Displays wind chill temperature Possible values: 0 - 1 Default value: 1 (Will display data) This value is optional. By default the data will be displayed.
heatIndex	Displays heat index temperature Possible values: 0 - 1 Default value: 1 (Will display data) This value is optional. By default the data will be displayed.
temperature	Displays current temperature Possible values: 0 - 1 Default value: 1 (Will display data) This value is optional. By default the data will be displayed.
updateInterval	How often does the content needs to be fetched? (Milliseconds) There're no restriction with FOSHKplugin, you may update as often as you like Possible values: 1000 - 86400000 Default value: 60000 (1 minute)
animationSpeed	Speed of the update animation. (Milliseconds) Possible values:0 - 5000 Default value: 2000 (2 seconds)
lang	The language of the days. Possible values: en, nl, ru, etc ... Default value: uses value of config.language
sysstat	Toggle sysinfo display Possible values: 0 or 1 Default value: 0
debug	Toggle debug logging Possible values: 0 or 1 Default value: 0