mirror of
https://github.com/home-assistant/core
synced 2024-10-07 10:13:38 +02:00
100 lines
3.0 KiB
Python
100 lines
3.0 KiB
Python
"""Support for tracking the moon phases."""
|
|
from __future__ import annotations
|
|
|
|
from astral import moon
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity
|
|
from homeassistant.const import CONF_NAME
|
|
from homeassistant.core import HomeAssistant
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
import homeassistant.util.dt as dt_util
|
|
|
|
DEFAULT_NAME = "Moon"
|
|
|
|
STATE_FIRST_QUARTER = "first_quarter"
|
|
STATE_FULL_MOON = "full_moon"
|
|
STATE_LAST_QUARTER = "last_quarter"
|
|
STATE_NEW_MOON = "new_moon"
|
|
STATE_WANING_CRESCENT = "waning_crescent"
|
|
STATE_WANING_GIBBOUS = "waning_gibbous"
|
|
STATE_WAXING_GIBBOUS = "waxing_gibbous"
|
|
STATE_WAXING_CRESCENT = "waxing_crescent"
|
|
|
|
MOON_ICONS = {
|
|
STATE_FIRST_QUARTER: "mdi:moon-first-quarter",
|
|
STATE_FULL_MOON: "mdi:moon-full",
|
|
STATE_LAST_QUARTER: "mdi:moon-last-quarter",
|
|
STATE_NEW_MOON: "mdi:moon-new",
|
|
STATE_WANING_CRESCENT: "mdi:moon-waning-crescent",
|
|
STATE_WANING_GIBBOUS: "mdi:moon-waning-gibbous",
|
|
STATE_WAXING_CRESCENT: "mdi:moon-waxing-crescent",
|
|
STATE_WAXING_GIBBOUS: "mdi:moon-waxing-gibbous",
|
|
}
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string}
|
|
)
|
|
|
|
|
|
async def async_setup_platform(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
async_add_entities: AddEntitiesCallback,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> None:
|
|
"""Set up the Moon sensor."""
|
|
name = config.get(CONF_NAME)
|
|
|
|
async_add_entities([MoonSensor(name)], True)
|
|
|
|
|
|
class MoonSensor(SensorEntity):
|
|
"""Representation of a Moon sensor."""
|
|
|
|
def __init__(self, name):
|
|
"""Initialize the moon sensor."""
|
|
self._name = name
|
|
self._state = None
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the entity."""
|
|
return self._name
|
|
|
|
@property
|
|
def device_class(self):
|
|
"""Return the device class of the entity."""
|
|
return "moon__phase"
|
|
|
|
@property
|
|
def native_value(self):
|
|
"""Return the state of the device."""
|
|
if self._state < 0.5 or self._state > 27.5:
|
|
return STATE_NEW_MOON
|
|
if self._state < 6.5:
|
|
return STATE_WAXING_CRESCENT
|
|
if self._state < 7.5:
|
|
return STATE_FIRST_QUARTER
|
|
if self._state < 13.5:
|
|
return STATE_WAXING_GIBBOUS
|
|
if self._state < 14.5:
|
|
return STATE_FULL_MOON
|
|
if self._state < 20.5:
|
|
return STATE_WANING_GIBBOUS
|
|
if self._state < 21.5:
|
|
return STATE_LAST_QUARTER
|
|
return STATE_WANING_CRESCENT
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Icon to use in the frontend, if any."""
|
|
return MOON_ICONS.get(self.state)
|
|
|
|
async def async_update(self):
|
|
"""Get the time and updates the states."""
|
|
today = dt_util.as_local(dt_util.utcnow()).date()
|
|
self._state = moon.phase(today)
|