81 lines
2.1 KiB
Python
81 lines
2.1 KiB
Python
"""
|
|
Support for tracking the moon phases.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.moon/
|
|
"""
|
|
import asyncio
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import (CONF_NAME)
|
|
import homeassistant.util.dt as dt_util
|
|
from homeassistant.helpers.entity import Entity
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DEFAULT_NAME = 'Moon'
|
|
|
|
ICON = 'mdi:brightness-3'
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
})
|
|
|
|
|
|
@asyncio.coroutine
|
|
def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
|
|
"""Set up the Moon sensor."""
|
|
name = config.get(CONF_NAME)
|
|
|
|
async_add_devices([MoonSensor(name)], True)
|
|
|
|
|
|
class MoonSensor(Entity):
|
|
"""Representation of a Moon sensor."""
|
|
|
|
def __init__(self, name):
|
|
"""Initialize the sensor."""
|
|
self._name = name
|
|
self._state = None
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the device."""
|
|
return self._name
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the device."""
|
|
if self._state == 0:
|
|
return 'New moon'
|
|
elif self._state < 7:
|
|
return 'Waxing crescent'
|
|
elif self._state == 7:
|
|
return 'First quarter'
|
|
elif self._state < 14:
|
|
return 'Waxing gibbous'
|
|
elif self._state == 14:
|
|
return 'Full moon'
|
|
elif self._state < 21:
|
|
return 'Waning gibbous'
|
|
elif self._state == 21:
|
|
return 'Last quarter'
|
|
return 'Waning crescent'
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Icon to use in the frontend, if any."""
|
|
return ICON
|
|
|
|
@asyncio.coroutine
|
|
def async_update(self):
|
|
"""Get the time and updates the states."""
|
|
from astral import Astral
|
|
|
|
today = dt_util.as_local(dt_util.utcnow()).date()
|
|
self._state = Astral().moon_phase(today)
|