Magicseaweed Sensor


The magicseaweed platform uses the Magicseaweed Forecast API as a source for surf forecasting data for the surf spots of your choice.

Setup

You need an API key which is free but requires registration. Magicseaweed is limiting users of the API to 1 spot for the free plan.

Configuration

To add Magicseaweed forecasts to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: magicseaweed
    api_key: YOUR_API_KEY
    spot_id: 1092
    monitored_conditions:
      - max_breaking_swell

Configuration Variables

api_key

(string)(Required)The API key to access the service.

name

(string)(Optional)Spot nickname for the sensors.

Default value: MSW.

hour

(list)(Optional)List of hours you would like to receive data for.

Default value: Defaults to current forecast.

3AM

Display forecast for 3AM.

6AM

Display forecast for 6AM.

9AM

Display forecast for 9AM.

12PM

Display forecast for 12PM.

3PM

Display forecast for 3PM.

6PM

Display forecast for 6PM.

9PM

Display forecast for 9PM.

12AM

Display forecast for 12AM.

spot_id

(string)(Required)ID of the surf spot. Details for getting spot id available at Magicseaweed

monitored_conditions

(list)(Required)Type of data to display.

swell_forecast

List of forecast summaries as attributes with current summary as state.

min_breaking_swell

The minimum wave height as the state with a detailed list of forecast attributes.

max_breaking_swell

The maximum wave height as the state with a detailed list of forecast attributes.

units

(string)(Optional)Specify the unit system.

Default value: Default to uk or us based on the temperature preference in Home Assistant.

uk

Use UK units.

eu

Use EU units.

us

Use US units.

Details about the API are available in the Magicseaweed documentation.