Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.usgs_earthquakes_feed.geo_location Namespace Reference

Classes

class  UsgsEarthquakesEvent
 
class  UsgsEarthquakesFeedEntityManager
 

Functions

None async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_ALERT = "alert"
 
string ATTR_EXTERNAL_ID = "external_id"
 
string ATTR_MAGNITUDE = "magnitude"
 
string ATTR_PLACE = "place"
 
string ATTR_STATUS = "status"
 
string ATTR_TYPE = "type"
 
string ATTR_UPDATED = "updated"
 
string CONF_FEED_TYPE = "feed_type"
 
string CONF_MINIMUM_MAGNITUDE = "minimum_magnitude"
 
float DEFAULT_MINIMUM_MAGNITUDE = 0.0
 
float DEFAULT_RADIUS_IN_KM = 50.0
 
 DEFAULT_UNIT_OF_MEASUREMENT = UnitOfLength.KILOMETERS
 
 PLATFORM_SCHEMA
 
 SCAN_INTERVAL = timedelta(minutes=5)
 
string SIGNAL_DELETE_ENTITY = "usgs_earthquakes_feed_delete_{}"
 
string SIGNAL_UPDATE_ENTITY = "usgs_earthquakes_feed_update_{}"
 
string SOURCE = "usgs_earthquakes_feed"
 
list VALID_FEED_TYPES
 

Detailed Description

Support for U.S. Geological Survey Earthquake Hazards Program Feeds.

Function Documentation

◆ async_setup_platform()

None homeassistant.components.usgs_earthquakes_feed.geo_location.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the USGS Earthquake Hazards Program Feed platform.

Definition at line 100 of file geo_location.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.usgs_earthquakes_feed.geo_location._LOGGER = logging.getLogger(__name__)
private

Definition at line 40 of file geo_location.py.

◆ ATTR_ALERT

string homeassistant.components.usgs_earthquakes_feed.geo_location.ATTR_ALERT = "alert"

Definition at line 42 of file geo_location.py.

◆ ATTR_EXTERNAL_ID

string homeassistant.components.usgs_earthquakes_feed.geo_location.ATTR_EXTERNAL_ID = "external_id"

Definition at line 43 of file geo_location.py.

◆ ATTR_MAGNITUDE

string homeassistant.components.usgs_earthquakes_feed.geo_location.ATTR_MAGNITUDE = "magnitude"

Definition at line 44 of file geo_location.py.

◆ ATTR_PLACE

string homeassistant.components.usgs_earthquakes_feed.geo_location.ATTR_PLACE = "place"

Definition at line 45 of file geo_location.py.

◆ ATTR_STATUS

string homeassistant.components.usgs_earthquakes_feed.geo_location.ATTR_STATUS = "status"

Definition at line 46 of file geo_location.py.

◆ ATTR_TYPE

string homeassistant.components.usgs_earthquakes_feed.geo_location.ATTR_TYPE = "type"

Definition at line 47 of file geo_location.py.

◆ ATTR_UPDATED

string homeassistant.components.usgs_earthquakes_feed.geo_location.ATTR_UPDATED = "updated"

Definition at line 48 of file geo_location.py.

◆ CONF_FEED_TYPE

string homeassistant.components.usgs_earthquakes_feed.geo_location.CONF_FEED_TYPE = "feed_type"

Definition at line 50 of file geo_location.py.

◆ CONF_MINIMUM_MAGNITUDE

string homeassistant.components.usgs_earthquakes_feed.geo_location.CONF_MINIMUM_MAGNITUDE = "minimum_magnitude"

Definition at line 51 of file geo_location.py.

◆ DEFAULT_MINIMUM_MAGNITUDE

float homeassistant.components.usgs_earthquakes_feed.geo_location.DEFAULT_MINIMUM_MAGNITUDE = 0.0

Definition at line 53 of file geo_location.py.

◆ DEFAULT_RADIUS_IN_KM

float homeassistant.components.usgs_earthquakes_feed.geo_location.DEFAULT_RADIUS_IN_KM = 50.0

Definition at line 54 of file geo_location.py.

◆ DEFAULT_UNIT_OF_MEASUREMENT

homeassistant.components.usgs_earthquakes_feed.geo_location.DEFAULT_UNIT_OF_MEASUREMENT = UnitOfLength.KILOMETERS

Definition at line 55 of file geo_location.py.

◆ PLATFORM_SCHEMA

homeassistant.components.usgs_earthquakes_feed.geo_location.PLATFORM_SCHEMA
Initial value:
1 = GEO_LOCATION_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_FEED_TYPE): vol.In(VALID_FEED_TYPES),
4  vol.Optional(CONF_LATITUDE): cv.latitude,
5  vol.Optional(CONF_LONGITUDE): cv.longitude,
6  vol.Optional(CONF_RADIUS, default=DEFAULT_RADIUS_IN_KM): vol.Coerce(float),
7  vol.Optional(
8  CONF_MINIMUM_MAGNITUDE, default=DEFAULT_MINIMUM_MAGNITUDE
9  ): cv.positive_float,
10  }
11 )

Definition at line 87 of file geo_location.py.

◆ SCAN_INTERVAL

homeassistant.components.usgs_earthquakes_feed.geo_location.SCAN_INTERVAL = timedelta(minutes=5)

Definition at line 57 of file geo_location.py.

◆ SIGNAL_DELETE_ENTITY

string homeassistant.components.usgs_earthquakes_feed.geo_location.SIGNAL_DELETE_ENTITY = "usgs_earthquakes_feed_delete_{}"

Definition at line 59 of file geo_location.py.

◆ SIGNAL_UPDATE_ENTITY

string homeassistant.components.usgs_earthquakes_feed.geo_location.SIGNAL_UPDATE_ENTITY = "usgs_earthquakes_feed_update_{}"

Definition at line 60 of file geo_location.py.

◆ SOURCE

string homeassistant.components.usgs_earthquakes_feed.geo_location.SOURCE = "usgs_earthquakes_feed"

Definition at line 62 of file geo_location.py.

◆ VALID_FEED_TYPES

list homeassistant.components.usgs_earthquakes_feed.geo_location.VALID_FEED_TYPES
Initial value:
1 = [
2  "past_hour_significant_earthquakes",
3  "past_hour_m45_earthquakes",
4  "past_hour_m25_earthquakes",
5  "past_hour_m10_earthquakes",
6  "past_hour_all_earthquakes",
7  "past_day_significant_earthquakes",
8  "past_day_m45_earthquakes",
9  "past_day_m25_earthquakes",
10  "past_day_m10_earthquakes",
11  "past_day_all_earthquakes",
12  "past_week_significant_earthquakes",
13  "past_week_m45_earthquakes",
14  "past_week_m25_earthquakes",
15  "past_week_m10_earthquakes",
16  "past_week_all_earthquakes",
17  "past_month_significant_earthquakes",
18  "past_month_m45_earthquakes",
19  "past_month_m25_earthquakes",
20  "past_month_m10_earthquakes",
21  "past_month_all_earthquakes",
22 ]

Definition at line 64 of file geo_location.py.