homeassistant.components.noaa_tides.sensor Namespace Reference

Classes
class	NOAATidesAndCurrentsSensor
class	NOAATidesData

Functions
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_STATION_ID = "station_id"
string	DEFAULT_NAME = "NOAA Tides"
string	DEFAULT_TIMEZONE = "lst_ldt"
	PLATFORM_SCHEMA
	SCAN_INTERVAL = timedelta(minutes=60)
list	TIMEZONES = ["gmt", "lst", "lst_ldt"]
list	UNIT_SYSTEMS = ["english", "metric"]

Detailed Description

Support for the NOAA Tides and Currents API.

Function Documentation

setup_platform()

None homeassistant.components.noaa_tides.sensor.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the NOAA Tides and Currents sensor.

Definition at line 50 of file sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.noaa_tides.sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 28 of file sensor.py.

CONF_STATION_ID

string homeassistant.components.noaa_tides.sensor.CONF_STATION_ID = "station_id"

Definition at line 30 of file sensor.py.

DEFAULT_NAME

string homeassistant.components.noaa_tides.sensor.DEFAULT_NAME = "NOAA Tides"

Definition at line 32 of file sensor.py.

DEFAULT_TIMEZONE

string homeassistant.components.noaa_tides.sensor.DEFAULT_TIMEZONE = "lst_ldt"

Definition at line 33 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.noaa_tides.sensor.PLATFORM_SCHEMA

Initial value:

=  SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_STATION_ID): cv.string,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_TIME_ZONE, default=DEFAULT_TIMEZONE): vol.In(TIMEZONES),
        vol.Optional(CONF_UNIT_SYSTEM): vol.In(UNIT_SYSTEMS),
    }
)

Definition at line 40 of file sensor.py.

SCAN_INTERVAL

homeassistant.components.noaa_tides.sensor.SCAN_INTERVAL = timedelta(minutes=60)

Definition at line 35 of file sensor.py.

TIMEZONES

list homeassistant.components.noaa_tides.sensor.TIMEZONES = ["gmt", "lst", "lst_ldt"]

Definition at line 37 of file sensor.py.

UNIT_SYSTEMS

list homeassistant.components.noaa_tides.sensor.UNIT_SYSTEMS = ["english", "metric"]

Definition at line 38 of file sensor.py.