Pirate Weather - Version 2.0.0.BETA2#

Module Summary#

Receives weather conditions and forecasts for the project location from Pirate Weather.

Module Status#

Note: Please be aware that this is a beta version of this IO Module which has not yet been fully tested. We recommend testing before use.

If you encounter any issues with this module, or have any feedback regarding its operation, please contact our support team.

Release Notes#

Version 2.0#

  •  Initial release.

Minor point releases (eg. 1.1.x) will be for small fixes and may not be listed here.

Requirements#

The module requires the use of an API key, this can be obtained from https://pirate-weather.apiable.io/

Configuration#

The module uses the project’s location, this should be appropriately set in the Designer Project Properties.

Operation#

Instance Properties#

Set the API Key to that obtained from Pirate Weather.

Set Units to either Metric, Imperial or Mixed (UK) to set the desired returned units.

Metric Imperial Mixed (UK)
Precipitation Intensity mm/hour Inch/hour mm/hour
Temperature Degrees Celsius Degrees Fahrenheit Degrees Celsius
Pressure Hectopascals Millibars Hectopascals
Wind Speed Meters/second Miles/Hour Miles/Hour

Checking the Extended Logging checkbox will provide more detailed log messages. This is intended for diagnostics and problem solving and should ideally be disabled during normal operation.

Triggers#

Receive Current Conditions#

Fires when a requested report for the current weather matches the selected summary item(s).

Trigger variables:

  • Variable 1: Short summary (‘clear-day’|’clear-night’|’rain’|’snow’|’sleet’|’wind’|’fog’|’cloudy’|’partly-cloudy-day’|’partly-cloudy-night’).

  • Variable 2: Precipitation Intensity (number).

  • Variable 3: Temperature (integer).

  • Variable 4: Apparent Temperature

  • Variable 5: Humidity

  • Variable 6: Pressure

  • Variable 7: Wind Speed

Receive Hourly Forecast#

Fires when a requested weather forecast report for Time Offset hour(s), matches the selected summary item(s).

Trigger variables:

  • Variable 1: Short summary (‘clear-day’|’clear-night’|’rain’|’snow’|’sleet’|’wind’|’fog’|’cloudy’|’partly-cloudy-day’|’partly-cloudy-night’).

  • Variable 2: Precipitation Intensity (number).

  • Variable 3: Temperature (integer).

  • Variable 4: Apparent Temperature

  • Variable 5: Humidity

  • Variable 6: Pressure

  • Variable 7: Wind Speed

Receive Daily Forecast#

Fires when a requested weather forecast report for Time Offset day(s), matches the selected summary item(s).

Trigger variables:

  • Variable 1: Short summary (‘clear-day’|’clear-night’|’rain’|’snow’|’sleet’|’wind’|’fog’|’cloudy’|’partly-cloudy-day’|’partly-cloudy-night’).

  • Variable 2: Precipitation Intensity (number).

  • Variable 3: Temperature (integer).

  • Variable 4: Apparent Temperature

  • Variable 5: Humidity

  • Variable 6: Pressure

  • Variable 7: Wind Speed

Actions#

Request Weather Data#

Sends a request for weather data, the results of which will be returned by triggers.

Support#

If you encounter any issues with this module, please contact our support team.