Menu

Marine Provider

The Marine Provider gets tidal times information, wave conditions, water temperature and UV index data.

Configuration

  • Location
    The GPS coordinates of the location to get the marine data for. Data is returned of the nearest available location to the location coordinates.
    Coordinates must be in Decimal degrees (DD) format of latitude, longitude, e.g. 41.40338, 2.17403. Decimal separator is a dot.
    Normally this is set using the Location or GPS provider.

  • Settings

    • Tide Transition Factor
      The tide transition factor in percent. This defines the water level at which the ground is considered to be fully submerged or exposed.
      Default is 50.

    • Units
      Units of temperature and measurement data:

      Unit Temperature Description

      US

      Fahrenheit

      US units

      UK

      Celsius

      UK units

      Metric

      Celsius

      Metric units

      Base

      Kelvin

      SI base units

    • Update Interval
      The service refresh interval time like 1h or 8h.
      Default is 4h.
      Use longer intervals to reduce the number of requests and preserve battery life.

    • Language Code
      ISO639 Language code for localized text and messages, like en for English, fr for French etc.

Query

  • Status
    Returns the marine data status:

    Text Numeric Description

    N/A

    0

    No marine data received yet, no data available

    Excellent

    1

    Marine data is valid

    Poor

    4

    Error in parsing the marine data, but data is available

    Fail

    5

    Error getting marine data

  • Location Coordinates
    GPS coordinates in DD format of the resolved data location.

  • Address
    Resolved location name.

Tide Data

Tide queries use Param 1 to select the tide event index:

+

Param 1 Description

0

Current/first tide event of the day

1

Next tide event

+

  • Tide Time
    Time of the tide event (high or low tide).

    • Param 2
      Time format of the text representation. See Time Format for details.
      If empty, the default ISO format is used.

  • Tide Transition
    Time when the tide transitions (ground fully submerged or exposed).

    • Param 2
      Time format of the text representation.

  • Tide Type
    The type of the tide event.
    Returns high or low as text. Numeric: 1 for high tide, 0 for low tide.

  • Tide Height
    The tide height in meters.

  • Tide Movement
    The actual tidal movement direction.
    Returns ebb or flood as text. Numeric: 0 for ebb, 1 for flood.

  • Tide Icon
    Icon name for the current tide movement. Returns tide_ebb or tide_flood.
    This can be used as input for the Icon Facelet.

Wave Data

Wave queries use Param 1 to select the data index:

+

Param 1 Description

0

Current value

1

Next hour forecast

-1

Time series data

+

  • Significant Wave Height
    The significant wave height.

  • Swell Height
    The swell wave height.

  • Swell Direction
    The swell wave direction in degrees.

  • Swell Period
    The swell period in seconds.

Environmental Data

  • Water Temperature
    The water temperature in the selected unit.
    Param 1 selects the data index (0 = current, 1 = next hour, -1 = time series).

  • UV Index
    The UV index near the water location.
    Param 1 selects the data index (0 = current, 1 = next hour, -1 = time series).

Time Queries

  • Data Set Time
    The time of the data set or the forecast time.

    Text Numeric

    Time in the format specified by Param 2

    Milliseconds since 1970-01-01 00:00:00 UTC

    • Param 2
      The time format of the text representation. See Time Format for details.
      If empty, the default ISO format yyyy-MM-dd’T’HH:mm:ss.SSSxxx is used.

  • Update Time
    The time of the last data update.

    Text Numeric

    Time in the format specified by Param 2

    Milliseconds since 1970-01-01 00:00:00 UTC

    • Param 2
      The time format of the text representation. See Time Format for details.
      If empty, the default ISO format yyyy-MM-dd’T’HH:mm:ss.SSSxxx is used.