Skip to content

Commit

Permalink
Full implementation - OneCall & Hourly Offset
Browse files Browse the repository at this point in the history
  • Loading branch information
@tkrofta
tkrofta committed Feb 1, 2021
1 parent 625a2ce commit a17ca00
Show file tree
Hide file tree
Showing 3 changed files with 181 additions and 47 deletions.
2 changes: 1 addition & 1 deletion index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ module.exports = function (app) {
},
offset: {
type: 'number',
title: 'Forecast offset to localtime (0 = current, >0 = next full hour in <offset> hours)',
title: 'Forecast offset to localtime (0 = current, otherwise next full hour within <offset> hours (max. 47)',
default: 0
},
}
Expand Down
224 changes: 179 additions & 45 deletions openweather.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
var owm = require ('openweather-apis')
let log = null
let type = 'simple'
let offset = 0

const navigationPosition = 'navigation.position';
const navigationElevation = 'navigation.gnss.antennaAltitude';
Expand All @@ -8,7 +10,7 @@ const oneMinute = 60*1000;
const oneHour = 60*60*1000;

const subscriptions = [
{ path: navigationPosition, period: oneHour, policy: "instant", minPeriod: oneMinute },
{ path: navigationPosition, period: oneHour, policy: "instant", minPeriod: oneHour },
{ path: navigationElevation, period: oneHour, policy: "instant", minPeriod: oneMinute },
// workaround required as policy "ideal" not available for navigationPosition
{ path: environmentRPi, period: oneHour, policy: "instant", minPeriod: oneMinute },
Expand All @@ -25,18 +27,36 @@ const subscriptions = [
*/
const pathPrefix = "environment.forecast.";
const forecastTime = pathPrefix+"time";
const forecastSunrise = pathPrefix+"sunrise";
const forecastSunset = pathPrefix+"sunset";
const simpleTemp = pathPrefix+'temperature';
const simpleHumidity = pathPrefix+'humidity';
const simplePressure = pathPrefix+'pressure';
const simpleDescription = pathPrefix+'description';
const simpleRain = pathPrefix+'rain';
const simpleWeatherCode = pathPrefix+'weathercode';
const fullMain = pathPrefix+'main';
const fullIcon = pathPrefix+'icon';
const fullTempMin = pathPrefix+'temperature.minimum';
const fullTempMax = pathPrefix+'temperature.maximum';
const fullFeelsLike = pathPrefix+'feelslike';
const fullDewPoint = pathPrefix+'dewpoint';
const fullUVIndex = pathPrefix+'uvindex';
const fullClouds = pathPrefix+'clouds';
const fullVisibility = pathPrefix+'visibility';
const fullWindSpeed = pathPrefix+'wind.speed';
const fullWinDir = pathPrefix+'wind.direction';

const latest = {
update: null,
forecast: {
time: null,
lat: null,
lon: null,
lon: null,
sunrise: null,
sunset: null,
main: null,
icon: null
},
simple: {
temp : null,
Expand All @@ -47,7 +67,13 @@ const latest = {
weathercode : null
},
full: {
time: null,
temp: { min: null, max: null },
feelslike: null,
dewpoint : null,
uvindex : null,
clouds : null,
visibility : null,
wind: { speed: null, dir: null }
},
altitude: {
elevation: 0,
Expand Down Expand Up @@ -98,62 +124,163 @@ function onPositionUpdate(value, callback) {

if (!lastUpdateWithin(oneHour) && isValidPosition(latest.forecast.lat, latest.forecast.lon))
{
latest.forecast.time = Date.now();
latest.update = Date.now();

owm.setCoordinate(value.latitude, value.longitude);
log("OWM Coordinates "+value.latitude+","+value.longitude);
// get a simple JSON Object with temperature, humidity, pressure and description
owm.getSmartJSON(function(err, smart){
if (!err)
{
log(smart);
latest.simple.temp = smart.temp
latest.simple.humidity = smart.humidity,
latest.simple.pressure = smart.pressure * 100, // getting hPa instead of Pa
latest.simple.description = smart.description,
latest.simple.rain = smart.rain,
latest.simple.weathercode = smart.weathercode
}
else
{
log(err);
latest.simple.temp = null
latest.simple.humidity = null,
latest.simple.pressure = null,
latest.simple.description = err,
latest.simple.rain = null,
latest.simple.weathercode = null
}
callback(prepareUpdate(latest.forecast, latest.simple));
});
if (type==='simple' && offset==0) {
// get a simple JSON Object with temperature, humidity, pressure and description
owm.getSmartJSON(function(err, smart){
if (!err)
{
log(smart);
latest.forecast.time = latest.update/1000 // getting ms instead of s
latest.simple.temp = smart.temp
latest.simple.humidity = smart.humidity
latest.simple.pressure = compensateToStationAltitude(smart.pressure * 100, latest.altitude.elevation, smart.temp) // getting hPa instead of Pa
latest.simple.description = smart.description
latest.simple.rain = smart.rain
latest.simple.weathercode = smart.weathercode
}
else
{
log(err);
latest.forecast.time = null
latest.simple.temp = null
latest.simple.humidity = null
latest.simple.pressure = null
latest.simple.description = err
latest.simple.rain = null
latest.simple.weathercode = null
}
callback(prepareUpdate(latest.forecast, latest.simple, null));
});
}
else if ((type==='simple' && offset>0) || type==='full') {
owm.setExclude('minutely,daily,alerts')
// get a simple JSON Object with temperature, humidity, pressure and description
owm.getWeatherOneCall(function(err, data){
if (!err)
{
latest.forecast.sunrise = data.current.sunrise
latest.forecast.sunset = data.current.sunset
latest.forecast.time = (offset==0 ? data.current.dt : data.hourly[offset].dt)
latest.simple.temp = (offset==0 ? data.current.temp : data.hourly[offset].temp)
latest.full.feelslike = (offset==0 ? data.current.feels_like : data.hourly[offset].feels_like)
latest.simple.pressure = compensateToStationAltitude((offset==0 ? data.current.pressure : data.hourly[offset].pressure) * 100,
latest.altitude.elevation, latest.simple.temp), // getting hPa instead of Pa
latest.simple.humidity = (offset==0 ? data.current.humidity : data.hourly[offset].humidity)
latest.full.dewpoint = (offset==0 ? data.current.dew_point : data.hourly[offset].dew_point)
latest.full.uvindex = (offset==0 ? data.current.uvi : data.hourly[offset].uvi)
latest.full.clouds = (offset==0 ? data.current.clouds : data.hourly[offset].clouds)
latest.full.visibility = (offset==0 ? data.current.visibility : data.hourly[offset].visibility)
latest.full.wind.speed = (offset==0 ? data.current.wind_speed : data.hourly[offset].wind_speed)
latest.full.wind.dir = (offset==0 ? data.current.wind_deg : data.hourly[offset].wind_deg)
latest.simple.description = (offset==0 ? data.current.weather[0].description : data.hourly[offset].weather[0].description)
latest.forecast.icon = (offset==0 ? data.current.weather[0].icon : data.hourly[offset].weather[0].icon)
latest.forecast.main = (offset==0 ? data.current.weather[0].main : data.hourly[offset].weather[0].main)
latest.simple.rain = (offset<=7 ? data.hourly[0].rain : {})
latest.simple.weathercode = (offset==0 ? data.hourly[0].weather[0].id : data.hourly[offset].weather[0].id)
for (i=0; i<Math.min(data.hourly.length, 23); i++)
{
if (latest.full.temp.min==null || data.hourly[i].temp < latest.full.temp.min)
latest.full.temp.min = data.hourly[i].temp
if (latest.full.temp.max==null || data.hourly[i].temp > latest.full.temp.max)
latest.full.temp.max = data.hourly[i].temp
}
if (type==='simple') log(latest.simple); else log(latest);
}
else
{
log(err);
latest.forecast.sunrise = null
latest.forecast.sunset =null
latest.forecast.time = null
latest.simple.temp = null
latest.full.feelslike = null
latest.simple.pressure = null
latest.simple.humidity = null
latest.full.dewpoint = null
latest.full.uvindex = null
latest.full.clouds = null
latest.full.visibility = null
latest.full.wind.speed = null
latest.full.wind.dir = null
latest.simple.description = null
latest.forecast.icon = null
latest.forecast.main = null
latest.simple.rain = null
latest.simple.weathercode = null
}
callback(prepareUpdate(latest.forecast, latest.simple, latest.full));
});
}
}
}

// returns Pressure at Station based on Pressure at SeaLevel, Elevation (m) and Temperature (K) at Station
function compensateToStationAltitude (pressure, elevation, temperature) {
return pressure * Math.exp(-elevation / (temperature*29.263));
}

// returns Pressure at SeaLevel based on Pressure at Station, Elevation (m) and Temperature (K) at Station
function compensateToSeaLevel (pressure, elevation, temperature) {
return pressure / Math.exp(-elevation / (temperature*29.263));
}

function onElevationUpdate(value) {
if (value == null)
{
log("ElevationUpdate: Cannot add null value - using 0 instead");
log("Cannot add null value as elevation - using 0 instead");
latest.altitude.elevation = 0
}
else
{
latest.altitude.elevation = value
log("ElevationUpdate: Elevation set to "+value+"m above sea level");
log("Elevation set to "+value+"m above sea level");
}
}

function prepareUpdate(forecast, weather) {
function prepareUpdate(forecast, weather, full) {
const noData = "waiting ..."
return [
buildDeltaUpdate(forecastTime, forecast.time !== null ? forecast.time : noData),

buildDeltaUpdate(simpleDescription, weather.description !== null ? weather.description : noData),
buildDeltaUpdate(simpleTemp, weather.temp !== null ? weather.temp : noData),
buildDeltaUpdate(simpleHumidity, weather.humidity !== null ? weather.humidity : noData),
buildDeltaUpdate(simplePressure, weather.pressure !== null ? weather.pressure : noData),
buildDeltaUpdate(simpleRain, weather.rain !== null ? weather.rain : noData),
buildDeltaUpdate(simpleWeatherCode, weather.weathercode !== null ? weather.weathercode : noData)
];
switch (type) {
case 'simple': return [
buildDeltaUpdate(forecastTime, forecast.time !== null ? forecast.time : noData),

buildDeltaUpdate(simpleDescription, weather.description !== null ? weather.description : noData),
buildDeltaUpdate(simpleTemp, weather.temp !== null ? weather.temp : noData),
buildDeltaUpdate(simpleHumidity, weather.humidity !== null ? weather.humidity : noData),
buildDeltaUpdate(simplePressure, weather.pressure !== null ? weather.pressure : noData),
buildDeltaUpdate(simpleRain, weather.rain !== null ? weather.rain : noData),
buildDeltaUpdate(simpleWeatherCode, weather.weathercode !== null ? weather.weathercode : noData)
];
case 'full': return [
buildDeltaUpdate(forecastTime, forecast.time !== null ? forecast.time : noData),
buildDeltaUpdate(forecastSunrise, forecast.sunrise !== null ? forecast.sunrise : noData),
buildDeltaUpdate(forecastSunset, forecast.sunset !== null ? forecast.sunset : noData),

buildDeltaUpdate(simpleDescription, weather.description !== null ? weather.description : noData),
buildDeltaUpdate(fullIcon, forecast.icon !== null ? forecast.icon : noData),
buildDeltaUpdate(fullMain, forecast.main !== null ? forecast.main : noData),

buildDeltaUpdate(simpleTemp, weather.temp !== null ? weather.temp : noData),
buildDeltaUpdate(fullTempMin, full.temp.min !== null ? full.temp.min : noData),
buildDeltaUpdate(fullTempMax, full.temp.max !== null ? full.temp.max : noData),
buildDeltaUpdate(fullFeelsLike, full.feelslike !== null ? full.feelslike : noData),
buildDeltaUpdate(simplePressure, weather.pressure !== null ? weather.pressure : noData),
buildDeltaUpdate(simpleHumidity, weather.humidity !== null ? weather.humidity : noData),
buildDeltaUpdate(fullDewPoint, full.dewpoint !== null ? full.dewpoint : noData),
buildDeltaUpdate(fullUVIndex, full.uvindex !== null ? full.uvindex : noData),
buildDeltaUpdate(fullClouds, full.clouds !== null ? full.clouds : noData),
buildDeltaUpdate(fullVisibility, full.visibility !== null ? full.visibility : noData),
buildDeltaUpdate(fullWindSpeed, full.wind.speed !== null ? full.wind.speed : noData),
buildDeltaUpdate(fullWinDir, full.wind.dir !== null ? full.wind.dir : noData),
buildDeltaUpdate(simpleRain, weather.rain !== null ? weather.rain : noData),
buildDeltaUpdate(simpleWeatherCode, weather.weathercode !== null ? weather.weathercode : noData)
];
default:
return [];
}
}

function buildDeltaUpdate(path, value) {
Expand All @@ -163,7 +290,7 @@ function buildDeltaUpdate(path, value) {
}
}

function preLoad(lat, lon, apikey, type, offset) {
function preLoad(lat, lon, apikey, configtype, configoffset) {
owm.setLang('en');
// English - en, Russian - ru, Italian - it, Spanish - es (or sp),
// Ukrainian - uk (or ua), German - de, Portuguese - pt,Romanian - ro,
Expand All @@ -175,17 +302,23 @@ function preLoad(lat, lon, apikey, type, offset) {
latest.forecast.lat = lat;
latest.forecast.lon = lon;
latest.simple.description = 'connecting to openweathermap...';
// owm.setCoordinate(lat, lon);
if (type!==undefined && type!==null)
type = configtype.split('-')[0].trim();
if (offset!==undefined && offset!==null)
{
if (offset>48) { log("Forecast supported max. 48Hours!") }
offset = Math.min(configoffset, 47);
}
// 'metric' 'internal' 'imperial'
owm.setUnits('internal');
// check http://openweathermap.org/appid#get for get the APPID
owm.setAPPID(apikey);
// return empty data set
return prepareUpdate(latest.forecast, latest.simple);
return prepareUpdate(latest.forecast, latest.simple, latest.full);
}

function lastUpdateWithin(interval) {
return latest.forecast.time !== null ? (Date.now() - latest.forecast.time) <= interval : false;
return latest.update !== null ? (Date.now() - latest.update) <= interval : false;
}

function isValidPosition(lat, lon) {
Expand All @@ -200,5 +333,6 @@ module.exports = {

init: function(loghandler) {
log = loghandler;
latest.update = null;
}
}
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "openweather-signalk",
"version": "0.1.0",
"version": "0.2.0",
"description": "SignalK plugin to provide data from OpenWeather Service",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit a17ca00

Please sign in to comment.