mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-02 17:18:58 +00:00
65 lines
2.1 KiB
Markdown
65 lines
2.1 KiB
Markdown
---
|
|
layout: page
|
|
title: "NOAA Tides"
|
|
description: "Instructions to add NOAA Tide information to Home Assistant."
|
|
date: 2018-07-24 08:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
ha_category: Environment
|
|
ha_release: 0.75
|
|
logo: noaa.png
|
|
---
|
|
|
|
The `noaa_tides` sensor platform uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States.
|
|
|
|
## {% linkable_title Setup %}
|
|
|
|
This sensor requires the use of a NOAA station ID. Search [NOAA Tide Predictions](https://tidesandcurrents.noaa.gov/tide_predictions.html) to find a location. Use the ID from the search results in your configuration. Alternatively, you can determine a station ID from a URL. For example, `8721164` in the following URL: `https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=8721164`
|
|
|
|
## {% linkable_title Configuration %}
|
|
|
|
To use this sensor, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
- platform: noaa_tides
|
|
station_id: 8721164
|
|
```
|
|
|
|
{% configuration %}
|
|
station_id:
|
|
description: ID of the station you'd like to track from https://tidesandcurrents.noaa.gov/tide_predictions.html.
|
|
required: true
|
|
type: string
|
|
name:
|
|
description: User-supplied sensor name.
|
|
required: false
|
|
default: NOAA Tides.
|
|
type: string
|
|
time_zone:
|
|
description: User-selected timezone.
|
|
required: false
|
|
default: Local Standard Time/Local Daylight Time.
|
|
type: list
|
|
keys:
|
|
gmt:
|
|
description: Greenwich Mean Time.
|
|
lst:
|
|
description: Local Standard Time. The time local to the requested station.
|
|
lst_ldt:
|
|
description: Local Standard/Local Daylight Time. The time local to the requested station.
|
|
unit_system:
|
|
description: Specify the unit system.
|
|
required: false
|
|
default: Defaults to `metric` or `imperial` based on the Home Assistant configuration.
|
|
type: string
|
|
keys:
|
|
metric:
|
|
description: Metric (Celsius, meters, cm/s) units.
|
|
english:
|
|
description: English (fahrenheit, feet, knots) units.
|
|
{% endconfiguration %}
|