Classes
class	GeoRssServiceSensor

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

Variables
	_LOGGER = logging.getLogger(__name__)

string	ATTR_CATEGORY = "category"

string	ATTR_DISTANCE = "distance"

string	ATTR_TITLE = "title"

string	CONF_CATEGORIES = "categories"

string	DEFAULT_ICON = "mdi:alert"

string	DEFAULT_NAME = "Event Service"

float	DEFAULT_RADIUS_IN_KM = 20.0

string	DEFAULT_UNIT_OF_MEASUREMENT = "Events"

string	DOMAIN = "geo_rss_events"

	PLATFORM_SCHEMA

	SCAN_INTERVAL = timedelta(minutes=5)

Detailed Description

Generic GeoRSS events service.

Retrieves current events (typically incidents or alerts) in GeoRSS format, and
shows information on events filtered by distance to the HA instance's location
and grouped by category.

Function Documentation

◆ setup_platform()

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

Set up the GeoRSS component.

Definition at line 67 of file sensor.py.

Variable Documentation

◆ _LOGGER

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

private

Definition at line 35 of file sensor.py.

◆ ATTR_CATEGORY

string homeassistant.components.geo_rss_events.sensor.ATTR_CATEGORY = "category"

Definition at line 37 of file sensor.py.

◆ ATTR_DISTANCE

string homeassistant.components.geo_rss_events.sensor.ATTR_DISTANCE = "distance"

Definition at line 38 of file sensor.py.

◆ ATTR_TITLE

string homeassistant.components.geo_rss_events.sensor.ATTR_TITLE = "title"

Definition at line 39 of file sensor.py.

◆ CONF_CATEGORIES

string homeassistant.components.geo_rss_events.sensor.CONF_CATEGORIES = "categories"

Definition at line 41 of file sensor.py.

◆ DEFAULT_ICON

string homeassistant.components.geo_rss_events.sensor.DEFAULT_ICON = "mdi:alert"

Definition at line 43 of file sensor.py.

◆ DEFAULT_NAME

string homeassistant.components.geo_rss_events.sensor.DEFAULT_NAME = "Event Service"

Definition at line 44 of file sensor.py.

◆ DEFAULT_RADIUS_IN_KM

float homeassistant.components.geo_rss_events.sensor.DEFAULT_RADIUS_IN_KM = 20.0

Definition at line 45 of file sensor.py.

◆ DEFAULT_UNIT_OF_MEASUREMENT

string homeassistant.components.geo_rss_events.sensor.DEFAULT_UNIT_OF_MEASUREMENT = "Events"

Definition at line 46 of file sensor.py.

◆ DOMAIN

string homeassistant.components.geo_rss_events.sensor.DOMAIN = "geo_rss_events"

Definition at line 48 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.geo_rss_events.sensor.PLATFORM_SCHEMA

Initial value:

 =  SENSOR_PLATFORM_SCHEMA.extend(
     {
         vol.Required(CONF_URL): cv.string,
         vol.Optional(CONF_LATITUDE): cv.latitude,
         vol.Optional(CONF_LONGITUDE): cv.longitude,
         vol.Optional(CONF_RADIUS, default=DEFAULT_RADIUS_IN_KM): vol.Coerce(float),
         vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
         vol.Optional(CONF_CATEGORIES, default=[]): vol.All(cv.ensure_list, [cv.string]),
         vol.Optional(
             CONF_UNIT_OF_MEASUREMENT, default=DEFAULT_UNIT_OF_MEASUREMENT
         ): cv.string,
     }
 )

Definition at line 52 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.geo_rss_events.sensor.SCAN_INTERVAL = timedelta(minutes=5)

Definition at line 50 of file sensor.py.

Home Assistant Unofficial Reference 2024.12.1

Classes

Functions

Variables