72ce9ec321
* Initial commit of Vultr components Have a working Vultr hub and binary sensor which pulls down the following attributes of your VPS: - Date created - Subscription id (server id) - Cost per month (in US$) - Operating System installed - IPv4 address - label (human readable name) - region - number of vcpus - which storage package chosen - IPV6 address (if applicable) - RAM amount Working next on sensor and then testing / coverage. * Added Vultr sensor for pending charges and current bandwidth. Refactored binary_sensor and hub too * Corrected is_on bases * Added basic tests for Vultr binary & platform * Updated require files * Changing test fixture to highlight different cases * Written basic test for sensor.vultr * Resolved linting errors and broken test * Increase test coverage and corrected docs * Resolved hound issues * Revert back negative binary test * Another hound resolve * Refactoring and adding is switch, moving over to vultr branch * Made Vultr components more resiliant to invalid configs * Added negetive test for vultr binary sensor * Added better testing of vultr sensor * Resolved vultr platform test affecting subsequent vultr tests * Moving VULTR components to single use design * Added in sensor name config * Added missing sensors var * Resolved init data setting of sensors, added in name conf to switch * Made the Vultr component more resiliant to startup failure with better alerting * Various Vultr component changes - Refactored sensor, binary_sensor, and switch to reference one subscription - Renamed CURRENT_BANDWIDTH_GB monitored condition to CURRENT_BANDWIDTH_USED - Improved test coverage * Resolved local tox linting issue * Added more testing for Vultr switch * Improved test coverage for Vultr components * Made PR comment changes to vultr binary sensor * Made PR comment changes to Vultr sensor * resolved PR comments for Vultr Switch * Resolved vultr sensor name and improved tests * Improved Vultr switch testing (default name formatting) * Removed vultr hub failure checking
103 lines
3.4 KiB
Python
103 lines
3.4 KiB
Python
"""
|
|
Support for monitoring the state of Vultr subscriptions (VPS).
|
|
|
|
For more details about this component, please refer to the documentation at
|
|
https://home-assistant.io/components/binary_sensor.vultr/
|
|
"""
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.const import CONF_NAME
|
|
from homeassistant.components.binary_sensor import (
|
|
BinarySensorDevice, PLATFORM_SCHEMA)
|
|
from homeassistant.components.vultr import (
|
|
CONF_SUBSCRIPTION, ATTR_AUTO_BACKUPS, ATTR_ALLOWED_BANDWIDTH,
|
|
ATTR_CREATED_AT, ATTR_SUBSCRIPTION_ID, ATTR_SUBSCRIPTION_NAME,
|
|
ATTR_IPV4_ADDRESS, ATTR_IPV6_ADDRESS, ATTR_MEMORY, ATTR_DISK,
|
|
ATTR_COST_PER_MONTH, ATTR_OS, ATTR_REGION, ATTR_VCPUS, DATA_VULTR)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DEFAULT_DEVICE_CLASS = 'power'
|
|
DEFAULT_NAME = 'Vultr {}'
|
|
DEPENDENCIES = ['vultr']
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_SUBSCRIPTION): cv.string,
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string
|
|
})
|
|
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Set up the Vultr subscription (server) 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 False
|
|
|
|
add_devices([VultrBinarySensor(vultr, subscription, name)], True)
|
|
|
|
|
|
class VultrBinarySensor(BinarySensorDevice):
|
|
"""Representation of a Vultr subscription sensor."""
|
|
|
|
def __init__(self, vultr, subscription, name):
|
|
"""Initialize a new Vultr sensor."""
|
|
self._vultr = vultr
|
|
self._name = name
|
|
|
|
self.subscription = subscription
|
|
self.data = None
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
try:
|
|
return self._name.format(self.data['label'])
|
|
except (KeyError, TypeError):
|
|
return self._name
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Return the icon of this server."""
|
|
return 'mdi:server' if self.is_on else 'mdi:server-off'
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Return true if the binary sensor is on."""
|
|
return self.data['power_status'] == 'running'
|
|
|
|
@property
|
|
def device_class(self):
|
|
"""Return the class of this sensor."""
|
|
return DEFAULT_DEVICE_CLASS
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the state attributes of the Vultr subscription."""
|
|
return {
|
|
ATTR_ALLOWED_BANDWIDTH: self.data.get('allowed_bandwidth_gb'),
|
|
ATTR_AUTO_BACKUPS: self.data.get('auto_backups'),
|
|
ATTR_COST_PER_MONTH: self.data.get('cost_per_month'),
|
|
ATTR_CREATED_AT: self.data.get('date_created'),
|
|
ATTR_DISK: self.data.get('disk'),
|
|
ATTR_IPV4_ADDRESS: self.data.get('main_ip'),
|
|
ATTR_IPV6_ADDRESS: self.data.get('v6_main_ip'),
|
|
ATTR_MEMORY: self.data.get('ram'),
|
|
ATTR_OS: self.data.get('os'),
|
|
ATTR_REGION: self.data.get('location'),
|
|
ATTR_SUBSCRIPTION_ID: self.data.get('SUBID'),
|
|
ATTR_SUBSCRIPTION_NAME: self.data.get('label'),
|
|
ATTR_VCPUS: self.data.get('vcpu_count')
|
|
}
|
|
|
|
def update(self):
|
|
"""Update state of sensor."""
|
|
self._vultr.update()
|
|
self.data = self._vultr.data[self.subscription]
|