Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.worldtidesinfo.sensor Namespace Reference

Classes

class  WorldTidesInfoSensor
 

Functions

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

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTRIBUTION = "Data provided by WorldTides"
 
string DEFAULT_NAME = "WorldTidesInfo"
 
 PLATFORM_SCHEMA
 
 SCAN_INTERVAL = timedelta(seconds=3600)
 

Detailed Description

Support for the worldtides.info API.

Function Documentation

◆ setup_platform()

None homeassistant.components.worldtidesinfo.sensor.setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the WorldTidesInfo sensor.

Definition at line 40 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.worldtidesinfo.sensor._LOGGER = logging.getLogger(__name__)
private

Definition at line 22 of file sensor.py.

◆ ATTRIBUTION

string homeassistant.components.worldtidesinfo.sensor.ATTRIBUTION = "Data provided by WorldTides"

Definition at line 24 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.worldtidesinfo.sensor.DEFAULT_NAME = "WorldTidesInfo"

Definition at line 26 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.worldtidesinfo.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_API_KEY): cv.string,
4  vol.Optional(CONF_LATITUDE): cv.latitude,
5  vol.Optional(CONF_LONGITUDE): cv.longitude,
6  vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
7  }
8 )

Definition at line 30 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.worldtidesinfo.sensor.SCAN_INTERVAL = timedelta(seconds=3600)

Definition at line 28 of file sensor.py.