binary_sensor.py

Go to the documentation of this file.

"""Support for monitoring the state of Vultr subscriptions (VPS)."""
 
from __future__ import annotations
 
import logging
 
import voluptuous as vol
 
from homeassistant.components.binary_sensor import (
    PLATFORM_SCHEMA as BINARY_SENSOR_PLATFORM_SCHEMA,
    BinarySensorDeviceClass,
    BinarySensorEntity,
)
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
 
from . import (
    ATTR_ALLOWED_BANDWIDTH,
    ATTR_AUTO_BACKUPS,
    ATTR_COST_PER_MONTH,
    ATTR_CREATED_AT,
    ATTR_DISK,
    ATTR_IPV4_ADDRESS,
    ATTR_IPV6_ADDRESS,
    ATTR_MEMORY,
    ATTR_OS,
    ATTR_REGION,
    ATTR_SUBSCRIPTION_ID,
    ATTR_SUBSCRIPTION_NAME,
    ATTR_VCPUS,
    CONF_SUBSCRIPTION,
    DATA_VULTR,
)
 
_LOGGER = logging.getLogger(__name__)
 
DEFAULT_NAME = "Vultr {}"
PLATFORM_SCHEMA = BINARY_SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_SUBSCRIPTION): cv.string,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
    }
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the Vultr subscription (server) binary sensor."""
    vultr = hass.data[DATA_VULTR]
 
    subscription = config.get(CONF_SUBSCRIPTION)
    name = config.get(CONF_NAME)
 
    if subscription not in vultr.data:
        _LOGGER.error("Subscription %s not found", subscription)
        return
 
    add_entities([VultrBinarySensor(vultr, subscription, name)], True)
 
 
class VultrBinarySensor(BinarySensorEntity):
    """Representation of a Vultr subscription sensor."""
 
    _attr_device_class = BinarySensorDeviceClass.POWER
 
    def __init__(self, vultr, subscription, name):
        """Initialize a new Vultr binary sensor."""
        self._vultr_vultr = vultr
        self._name_name = name
 
        self.subscriptionsubscription = subscription
        self.datadata = None
 
    @property
    def name(self):
        """Return the name of the sensor."""
        try:
            return self._name_name.format(self.datadata["label"])
        except (KeyError, TypeError):
            return self._name_name
 
    @property
    def icon(self):
        """Return the icon of this server."""
        return "mdi:server" if self.is_onis_on else "mdi:server-off"
 
    @property
    def is_on(self):
        """Return true if the binary sensor is on."""
        return self.datadata["power_status"] == "running"
 
    @property
    def extra_state_attributes(self):
        """Return the state attributes of the Vultr subscription."""
        return {
            ATTR_ALLOWED_BANDWIDTH: self.datadata.get("allowed_bandwidth_gb"),
            ATTR_AUTO_BACKUPS: self.datadata.get("auto_backups"),
            ATTR_COST_PER_MONTH: self.datadata.get("cost_per_month"),
            ATTR_CREATED_AT: self.datadata.get("date_created"),
            ATTR_DISK: self.datadata.get("disk"),
            ATTR_IPV4_ADDRESS: self.datadata.get("main_ip"),
            ATTR_IPV6_ADDRESS: self.datadata.get("v6_main_ip"),
            ATTR_MEMORY: self.datadata.get("ram"),
            ATTR_OS: self.datadata.get("os"),
            ATTR_REGION: self.datadata.get("location"),
            ATTR_SUBSCRIPTION_ID: self.datadata.get("SUBID"),
            ATTR_SUBSCRIPTION_NAME: self.datadata.get("label"),
            ATTR_VCPUS: self.datadata.get("vcpu_count"),
        }
 
    def update(self) -> None:
        """Update state of sensor."""
        self._vultr_vultr.update()
        self.datadata = self._vultr_vultr.data[self.subscriptionsubscription]