Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
tkrofta committed Feb 16, 2021
2 parents 29d8ac5 + 8904962 commit cc6c2f0
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# signalk-openweather-plugin
SignalK Plugin to inject forecast data from <a href="https://openweathermap.org/">OpenWeather</a> public weather service
# Install & Use

## Install & Use
Note: To use this plugin you need to request an apikey, ie. APPID on http://openweathermap.org/appid and start!
Install the plugin through the SignalK plugin interface. After installation you may want to 'Activate' it through the SignalK Plugin Config interface and enter your pre-requested apikey.<br>The plugin will inject several new SignalK-values, such as:<br>
<p>
<code>'environment.forecast.temperature'<br><br>
'environment.forecast.humidity'<br><br>
'environment.forecast.pressure'<br><br></code><br>
Forecast data is purely based on position - hence <code>'navigation.position'</code> needs to present. Data will be queried on position change and/or regularily on an hourly-basis (triggered by signalk-raspberry-pi-temperature-plugin). <code>'navigation.gnss.antennaAltitude'</code> (GPS altitude) is required if operated on non-sealevel altitude to compensate atmospheric pressure data to the appropriate elevation. Plugins like signalk-fixedstation could be used and the plugin will make calculations by adjusting the pressure accordingly. Default is altitude = 0 (sea level).It will take the plugin a few minutes before showing output data, as it will need to collect position information before requesting data from openweathermap.<br>
</p>
<p>Forecast data is purely based on position - hence <code>'navigation.position'</code> needs to present. Data will be queried on position change and/or regularily on an hourly-basis (triggered by signalk-raspberry-pi-temperature-plugin). <code>'navigation.gnss.antennaAltitude'</code> (GPS altitude) is required if operated on non-sealevel altitude to compensate atmospheric pressure data to the appropriate elevation. Plugins like signalk-fixedstation could be used and the plugin will make calculations by adjusting the pressure accordingly. Default is altitude = 0 (sea level).It will take the plugin a few minutes before showing output data, as it will need to collect position information before requesting data from openweathermap.</p><br>
By default the will update forecast information every hour. No information will be stored or tracked.<br>
Note: Alerts from openweathermap.org currently not implemented as based on <code>'environment.outside.pressure'</code> like provided by RuuviTag severities could be more accurate and it's possible to set an alarm, i.e. via the Simple Notification-plugin.<br>
# Details on input data
Simple output format is based on openweather-apis SMART JSON<br>

## Details on input data
<p>Simple output format is based on openweather-apis SMART JSON<br>
<code>
{
temp: 277.99,
Expand Down Expand Up @@ -50,5 +54,5 @@ Simple output format is based on openweather-apis SMART JSON<br>
visibility: 10000,
wind: { speed: 3.47, dir: 233 }
}
</code>
</code></p>

0 comments on commit cc6c2f0

Please sign in to comment.