mirror of
https://github.com/home-assistant/core.git
synced 2025-07-23 21:27:38 +00:00
Add functionality to the version sensor (#18067)
* Added functionality to the version sensor. * Corrected typo. * Change default name to not cause a breaking change. * Use vol.lower in the schema. * Add missing blank line. * Change order of cv.string and vol.Lower.
This commit is contained in:
parent
a9140dc8f5
commit
3d1a324f33
@ -1,54 +1,110 @@
|
|||||||
"""
|
"""
|
||||||
Support for displaying the current version of Home Assistant.
|
Sensor that can display the current Home Assistant versions.
|
||||||
|
|
||||||
For more details about this platform, please refer to the documentation at
|
For more details about this platform, please refer to the documentation at
|
||||||
https://home-assistant.io/components/sensor.version/
|
https://home-assistant.io/components/sensor.version/
|
||||||
"""
|
"""
|
||||||
import logging
|
import logging
|
||||||
|
from datetime import timedelta
|
||||||
|
|
||||||
import voluptuous as vol
|
import voluptuous as vol
|
||||||
|
|
||||||
import homeassistant.helpers.config_validation as cv
|
import homeassistant.helpers.config_validation as cv
|
||||||
|
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
||||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||||
from homeassistant.const import __version__, CONF_NAME
|
from homeassistant.const import CONF_NAME, CONF_SOURCE
|
||||||
from homeassistant.helpers.entity import Entity
|
from homeassistant.helpers.entity import Entity
|
||||||
|
from homeassistant.util import Throttle
|
||||||
|
|
||||||
|
REQUIREMENTS = ['pyhaversion==2.0.1']
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
CONF_BETA = 'beta'
|
||||||
|
CONF_IMAGE = 'image'
|
||||||
|
|
||||||
|
DEFAULT_IMAGE = 'default'
|
||||||
DEFAULT_NAME = "Current Version"
|
DEFAULT_NAME = "Current Version"
|
||||||
|
DEFAULT_SOURCE = 'local'
|
||||||
|
|
||||||
|
ICON = 'mdi:package-up'
|
||||||
|
|
||||||
|
TIME_BETWEEN_UPDATES = timedelta(minutes=5)
|
||||||
|
|
||||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||||
|
vol.Optional(CONF_BETA, default=False): cv.boolean,
|
||||||
|
vol.Optional(CONF_IMAGE, default=DEFAULT_IMAGE): vol.All(cv.string,
|
||||||
|
vol.Lower),
|
||||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||||
|
vol.Optional(CONF_SOURCE, default=DEFAULT_SOURCE): vol.All(cv.string,
|
||||||
|
vol.Lower),
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
async def async_setup_platform(
|
async def async_setup_platform(
|
||||||
hass, config, async_add_entities, discovery_info=None):
|
hass, config, async_add_entities, discovery_info=None):
|
||||||
"""Set up the Version sensor platform."""
|
"""Set up the Version sensor platform."""
|
||||||
|
from pyhaversion import Version
|
||||||
|
beta = config.get(CONF_BETA)
|
||||||
|
image = config.get(CONF_IMAGE)
|
||||||
name = config.get(CONF_NAME)
|
name = config.get(CONF_NAME)
|
||||||
|
source = config.get(CONF_SOURCE)
|
||||||
|
|
||||||
async_add_entities([VersionSensor(name)])
|
session = async_get_clientsession(hass)
|
||||||
|
if beta:
|
||||||
|
branch = 'beta'
|
||||||
|
else:
|
||||||
|
branch = 'stable'
|
||||||
|
haversion = VersionData(Version(hass.loop, session, branch, image), source)
|
||||||
|
|
||||||
|
async_add_entities([VersionSensor(haversion, name)], True)
|
||||||
|
|
||||||
|
|
||||||
class VersionSensor(Entity):
|
class VersionSensor(Entity):
|
||||||
"""Representation of a Home Assistant version sensor."""
|
"""Representation of a Home Assistant version sensor."""
|
||||||
|
|
||||||
def __init__(self, name):
|
def __init__(self, haversion, name):
|
||||||
"""Initialize the Version sensor."""
|
"""Initialize the Version sensor."""
|
||||||
|
self.haversion = haversion
|
||||||
self._name = name
|
self._name = name
|
||||||
self._state = __version__
|
self._state = None
|
||||||
|
|
||||||
|
async def async_update(self):
|
||||||
|
"""Get the latest version information."""
|
||||||
|
await self.haversion.async_update()
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def name(self):
|
def name(self):
|
||||||
"""Return the name of the sensor."""
|
"""Return the name of the sensor."""
|
||||||
return self._name
|
return self._name
|
||||||
|
|
||||||
@property
|
|
||||||
def should_poll(self):
|
|
||||||
"""No polling needed."""
|
|
||||||
return False
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def state(self):
|
def state(self):
|
||||||
"""Return the state of the sensor."""
|
"""Return the state of the sensor."""
|
||||||
return self._state
|
return self.haversion.api.version
|
||||||
|
|
||||||
|
@property
|
||||||
|
def device_state_attributes(self):
|
||||||
|
"""Return attributes for the sensor."""
|
||||||
|
return self.haversion.api.version_data
|
||||||
|
|
||||||
|
|
||||||
|
class VersionData:
|
||||||
|
"""Get the latest data and update the states."""
|
||||||
|
|
||||||
|
def __init__(self, api, source):
|
||||||
|
"""Initialize the data object."""
|
||||||
|
self.api = api
|
||||||
|
self.source = source
|
||||||
|
|
||||||
|
@Throttle(TIME_BETWEEN_UPDATES)
|
||||||
|
async def async_update(self):
|
||||||
|
"""Get the latest version information."""
|
||||||
|
if self.source == 'pypi':
|
||||||
|
await self.api.get_pypi_version()
|
||||||
|
elif self.source == 'hassio':
|
||||||
|
await self.api.get_hassio_version()
|
||||||
|
elif self.source == 'docker':
|
||||||
|
await self.api.get_docker_version()
|
||||||
|
else:
|
||||||
|
await self.api.get_local_version()
|
||||||
|
@ -919,6 +919,9 @@ pygtfs-homeassistant==0.1.3.dev0
|
|||||||
# homeassistant.components.remote.harmony
|
# homeassistant.components.remote.harmony
|
||||||
pyharmony==1.0.20
|
pyharmony==1.0.20
|
||||||
|
|
||||||
|
# homeassistant.components.sensor.version
|
||||||
|
pyhaversion==2.0.1
|
||||||
|
|
||||||
# homeassistant.components.binary_sensor.hikvision
|
# homeassistant.components.binary_sensor.hikvision
|
||||||
pyhik==0.1.8
|
pyhik==0.1.8
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user