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
115 lines
3.6 KiB
Python
115 lines
3.6 KiB
Python
"""
|
|
Support for monitoring the state of Vultr Subscriptions.
|
|
|
|
For more details about this component, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.vultr/
|
|
"""
|
|
import logging
|
|
import voluptuous as vol
|
|
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.const import (
|
|
CONF_MONITORED_CONDITIONS, CONF_NAME)
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.components.vultr import (
|
|
CONF_SUBSCRIPTION, ATTR_CURRENT_BANDWIDTH_USED, ATTR_PENDING_CHARGES,
|
|
DATA_VULTR)
|
|
|
|
# Name defaults to {subscription label} {sensor name}
|
|
DEFAULT_NAME = 'Vultr {} {}'
|
|
DEPENDENCIES = ['vultr']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
# Monitored conditions: name, units, icon
|
|
MONITORED_CONDITIONS = {
|
|
ATTR_CURRENT_BANDWIDTH_USED: ['Current Bandwidth Used', 'GB',
|
|
'mdi:chart-histogram'],
|
|
ATTR_PENDING_CHARGES: ['Pending Charges', 'US$',
|
|
'mdi:currency-usd']
|
|
}
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_SUBSCRIPTION): cv.string,
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
vol.Optional(CONF_MONITORED_CONDITIONS, default=MONITORED_CONDITIONS):
|
|
vol.All(cv.ensure_list, [vol.In(MONITORED_CONDITIONS)])
|
|
})
|
|
|
|
|
|
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)
|
|
monitored_conditions = config.get(CONF_MONITORED_CONDITIONS)
|
|
|
|
if subscription not in vultr.data:
|
|
_LOGGER.error("Subscription %s not found", subscription)
|
|
return False
|
|
|
|
sensors = []
|
|
|
|
for condition in monitored_conditions:
|
|
sensors.append(VultrSensor(vultr,
|
|
subscription,
|
|
condition,
|
|
name))
|
|
|
|
add_devices(sensors, True)
|
|
|
|
|
|
class VultrSensor(Entity):
|
|
"""Representation of a Vultr subscription sensor."""
|
|
|
|
def __init__(self, vultr, subscription, condition, name):
|
|
"""Initialize a new Vultr sensor."""
|
|
self._vultr = vultr
|
|
self._condition = condition
|
|
self._name = name
|
|
|
|
self.subscription = subscription
|
|
self.data = None
|
|
|
|
condition_info = MONITORED_CONDITIONS[condition]
|
|
|
|
self._condition_name = condition_info[0]
|
|
self._units = condition_info[1]
|
|
self._icon = condition_info[2]
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
try:
|
|
return self._name.format(self._condition_name)
|
|
except IndexError: # name contains more {} than fulfilled
|
|
try:
|
|
return self._name.format(self.data['label'],
|
|
self._condition_name)
|
|
except (KeyError, TypeError): # label key missing or data is None
|
|
return self._name
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Icon used in the frontend if any."""
|
|
return self._icon
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""The unit of measurement to present the value in."""
|
|
return self._units
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the value of this given sensor type."""
|
|
try:
|
|
return round(float(self.data.get(self._condition)), 2)
|
|
except (TypeError, ValueError):
|
|
return self.data.get(self._condition)
|
|
|
|
def update(self):
|
|
"""Update state of sensor."""
|
|
self._vultr.update()
|
|
self.data = self._vultr.data[self.subscription]
|