mirror of
https://github.com/home-assistant/core.git
synced 2025-05-06 15:09:17 +00:00
f99701f41a
In 0.7.x the API to HDate was cleaned up so as to move logic from homeassistant to the HDate external library. This commit removes all the superfluous code, updates the required tests and changes the requirement from version 0.6.5 to 0.7.5
142 lines
4.7 KiB
Python
142 lines
4.7 KiB
Python
"""
|
|
Platform to retrieve Jewish calendar information for Home Assistant.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.jewish_calendar/
|
|
"""
|
|
from datetime import timedelta
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import (
|
|
CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME, SUN_EVENT_SUNSET)
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.helpers.sun import get_astral_event_date
|
|
import homeassistant.util.dt as dt_util
|
|
|
|
REQUIREMENTS = ['hdate==0.7.5']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
SENSOR_TYPES = {
|
|
'date': ['Date', 'mdi:judaism'],
|
|
'weekly_portion': ['Parshat Hashavua', 'mdi:book-open-variant'],
|
|
'holiday_name': ['Holiday', 'mdi:calendar-star'],
|
|
'holyness': ['Holyness', 'mdi:counter'],
|
|
'first_light': ['Alot Hashachar', 'mdi:weather-sunset-up'],
|
|
'gra_end_shma': ['Latest time for Shm"a GR"A', 'mdi:calendar-clock'],
|
|
'mga_end_shma': ['Latest time for Shm"a MG"A', 'mdi:calendar-clock'],
|
|
'plag_mincha': ['Plag Hamincha', 'mdi:weather-sunset-down'],
|
|
'first_stars': ['T\'set Hakochavim', 'mdi:weather-night'],
|
|
}
|
|
|
|
CONF_DIASPORA = 'diaspora'
|
|
CONF_LANGUAGE = 'language'
|
|
CONF_SENSORS = 'sensors'
|
|
|
|
DEFAULT_NAME = 'Jewish Calendar'
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
vol.Optional(CONF_DIASPORA, default=False): cv.boolean,
|
|
vol.Optional(CONF_LATITUDE): cv.latitude,
|
|
vol.Optional(CONF_LONGITUDE): cv.longitude,
|
|
vol.Optional(CONF_LANGUAGE, default='english'):
|
|
vol.In(['hebrew', 'english']),
|
|
vol.Optional(CONF_SENSORS, default=['date']):
|
|
vol.All(cv.ensure_list, vol.Length(min=1), [vol.In(SENSOR_TYPES)]),
|
|
})
|
|
|
|
|
|
async def async_setup_platform(
|
|
hass, config, async_add_entities, discovery_info=None):
|
|
"""Set up the Jewish calendar sensor platform."""
|
|
language = config.get(CONF_LANGUAGE)
|
|
name = config.get(CONF_NAME)
|
|
latitude = config.get(CONF_LATITUDE, hass.config.latitude)
|
|
longitude = config.get(CONF_LONGITUDE, hass.config.longitude)
|
|
diaspora = config.get(CONF_DIASPORA)
|
|
|
|
if None in (latitude, longitude):
|
|
_LOGGER.error("Latitude or longitude not set in Home Assistant config")
|
|
return
|
|
|
|
dev = []
|
|
for sensor_type in config[CONF_SENSORS]:
|
|
dev.append(JewishCalSensor(
|
|
name, language, sensor_type, latitude, longitude,
|
|
hass.config.time_zone, diaspora))
|
|
async_add_entities(dev, True)
|
|
|
|
|
|
class JewishCalSensor(Entity):
|
|
"""Representation of an Jewish calendar sensor."""
|
|
|
|
def __init__(
|
|
self, name, language, sensor_type, latitude, longitude, timezone,
|
|
diaspora):
|
|
"""Initialize the Jewish calendar sensor."""
|
|
self.client_name = name
|
|
self._name = SENSOR_TYPES[sensor_type][0]
|
|
self.type = sensor_type
|
|
self._hebrew = (language == 'hebrew')
|
|
self._state = None
|
|
self.latitude = latitude
|
|
self.longitude = longitude
|
|
self.timezone = timezone
|
|
self.diaspora = diaspora
|
|
_LOGGER.debug("Sensor %s initialized", self.type)
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return '{} {}'.format(self.client_name, self._name)
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Icon to display in the front end."""
|
|
return SENSOR_TYPES[self.type][1]
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return self._state
|
|
|
|
async def async_update(self):
|
|
"""Update the state of the sensor."""
|
|
import hdate
|
|
|
|
now = dt_util.as_local(dt_util.now())
|
|
_LOGGER.debug("Now: %s Timezone = %s", now, now.tzinfo)
|
|
|
|
today = now.date()
|
|
sunset = dt_util.as_local(get_astral_event_date(
|
|
self.hass, SUN_EVENT_SUNSET, today))
|
|
|
|
_LOGGER.debug("Now: %s Sunset: %s", now, sunset)
|
|
|
|
if now > sunset:
|
|
today += timedelta(1)
|
|
|
|
date = hdate.HDate(
|
|
today, diaspora=self.diaspora, hebrew=self._hebrew)
|
|
|
|
if self.type == 'date':
|
|
self._state = date.hebrew_date
|
|
elif self.type == 'weekly_portion':
|
|
self._state = date.parasha
|
|
elif self.type == 'holiday_name':
|
|
self._state = date.holiday_description
|
|
elif self.type == 'holyness':
|
|
self._state = date.holiday_type
|
|
else:
|
|
times = hdate.Zmanim(
|
|
date=today, latitude=self.latitude, longitude=self.longitude,
|
|
timezone=self.timezone, hebrew=self._hebrew).zmanim
|
|
self._state = times[self.type].time()
|
|
|
|
_LOGGER.debug("New value: %s", self._state)
|