NOAA Tides and Currents Sensor for Home-Assistant

This library is a fork of the core component which adds some additional features and migrates the backend from the now-defunct py_noaa to the superseding noaa_coops.

Installation

1. Clone the repository.
2. Copy the noaa_tides directory into <home assistant directory>/custom_components/
3. Configure a sensor in configuration.yaml

Sample configuration

sensor:
  - platform: noaa_tides
    name: tides           # Useful when more than one sensor is used. Otherwise a name is generated.
    station_id: 8512354   # A station ID from https://tidesandcurrents.noaa.gov/
    type: tides           # This station will be used to measure water level
    scan_interval: 360    # Polling interval for the NOAA API

  - platform: noaa_tides
    station_id: 8510560
    type: temp            # This station will be used to measure water temperature
    name: water_temp
    scan_interval: 360

  - platform: noaa_tides
    name: buoy
    type: buoy            # This station will be used for off-shore Buoy data
    station_id: 44017     # A buoy ID from https://www.ndbc.noaa.gov/
    scan_interval: 360

Different stations support different features (products/datums), so use the station finder to select the right station for tides vs temp types.

For complex lovelace widgets, it is suggested to use the template platform.

Sample template sensor:

        next_tide:
            friendly_name: "Next tide"
            entity_id: sensor.tides
            value_template: "{{ state_attr('sensor.tides', 'next_tide_type') }} tide at {{ state_attr('sensor.tides', 'next_tide_time') }}"
            icon_template: "{% if is_state_attr('sensor.tides', 'next_tide_type', 'High') %}mdi:waves{% else %}mdi:wave{% endif %}"
        last_tide:
            friendly_name: "Last tide"
            entity_id: sensor.tides
            value_template: "{{ state_attr('sensor.tides', 'last_tide_type') }} tide at {{ state_attr('sensor.tides', 'last_tide_time') }}"
            icon_template: "{% if is_state_attr('sensor.tides', 'last_tide_type', 'High') %}mdi:waves{% else %}mdi:wave{% endif %}"
        water_level:
            friendly_name: "Water level"
            entity_id: sensor.internet_time
            value_template: "{{ state_attr('sensor.tides', 'tide_factor') }}"
            unit_of_measurement: '%'
        beach_air_temp:
            friendly_name: "Air temperature"
            entity_id: sensor.water_temp
            value_template: "{{ state_attr('sensor.water_temp', 'air_temperature') }}"

Note that the tide curve requires sensor.internet_time to be updated correctly. Use the time_date sensor platform like this:

  - platform: time_date
    display_options:
      - 'beat'

I'm also using the custom mini-graph card with the following lovelace configuration:

          - entities:
              - color: '#02ace5'
                entity: sensor.beach_air_temp
                name: Air
                show_state: true
                state_adaptive_color: true
              - color: darkblue
                entity: sensor.water_temp
                name: Water
                show_state: true
                state_adaptive_color: true
            hours_to_show: 24
            name: Air and Water Temperatures
            points_per_hour: 12
            show:
              fill: false
            type: 'custom:mini-graph-card'
            unit: °F
          - entities:
              - entity: sensor.next_tide
              - entity: sensor.last_tide
            footer:
              entities:
                - sensor.water_level
              hours_to_show: 12
              icon: 'mdi:swim'
              line_color: darkblue
              lower_bound: 0
              points_per_hour: 60
              show:
                labels: false
              type: 'custom:mini-graph-card'
              upper_bound: 100
            title: Tides
            type: entities

Which looks like this:

Support

For setup and other support questions, see the Home Assistant community discussion for this add-on.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT