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
105 lines
2.7 KiB
Python
105 lines
2.7 KiB
Python
"""
|
|
Support for Vultr.
|
|
|
|
For more details about this component, please refer to the documentation at
|
|
https://home-assistant.io/components/vultr/
|
|
"""
|
|
import logging
|
|
from datetime import timedelta
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.const import CONF_API_KEY
|
|
from homeassistant.util import Throttle
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
REQUIREMENTS = ['vultr==0.1.2']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
ATTR_AUTO_BACKUPS = 'auto_backups'
|
|
ATTR_ALLOWED_BANDWIDTH = 'allowed_bandwidth_gb'
|
|
ATTR_COST_PER_MONTH = 'cost_per_month'
|
|
ATTR_CURRENT_BANDWIDTH_USED = 'current_bandwidth_gb'
|
|
ATTR_CREATED_AT = 'created_at'
|
|
ATTR_DISK = 'disk'
|
|
ATTR_SUBSCRIPTION_ID = 'subid'
|
|
ATTR_SUBSCRIPTION_NAME = 'label'
|
|
ATTR_IPV4_ADDRESS = 'ipv4_address'
|
|
ATTR_IPV6_ADDRESS = 'ipv6_address'
|
|
ATTR_MEMORY = 'memory'
|
|
ATTR_OS = 'os'
|
|
ATTR_PENDING_CHARGES = 'pending_charges'
|
|
ATTR_REGION = 'region'
|
|
ATTR_VCPUS = 'vcpus'
|
|
|
|
CONF_SUBSCRIPTION = 'subscription'
|
|
|
|
DATA_VULTR = 'data_vultr'
|
|
DOMAIN = 'vultr'
|
|
|
|
NOTIFICATION_ID = 'vultr_notification'
|
|
NOTIFICATION_TITLE = 'Vultr Setup'
|
|
|
|
VULTR_PLATFORMS = ['binary_sensor', 'sensor', 'switch']
|
|
|
|
MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=60)
|
|
|
|
CONFIG_SCHEMA = vol.Schema({
|
|
DOMAIN: vol.Schema({
|
|
vol.Required(CONF_API_KEY): cv.string,
|
|
}),
|
|
}, extra=vol.ALLOW_EXTRA)
|
|
|
|
|
|
def setup(hass, config):
|
|
"""Set up the Vultr component."""
|
|
api_key = config[DOMAIN].get(CONF_API_KEY)
|
|
|
|
vultr = Vultr(api_key)
|
|
|
|
try:
|
|
vultr.update()
|
|
except RuntimeError as ex:
|
|
_LOGGER.error("Failed to make update API request because: %s",
|
|
ex)
|
|
hass.components.persistent_notification.create(
|
|
'Error: {}'
|
|
''.format(ex),
|
|
title=NOTIFICATION_TITLE,
|
|
notification_id=NOTIFICATION_ID)
|
|
return False
|
|
|
|
hass.data[DATA_VULTR] = vultr
|
|
return True
|
|
|
|
|
|
class Vultr(object):
|
|
"""Handle all communication with the Vultr API."""
|
|
|
|
def __init__(self, api_key):
|
|
"""Initialize the Vultr connection."""
|
|
from vultr import Vultr as VultrAPI
|
|
|
|
self._api_key = api_key
|
|
self.data = None
|
|
self.api = VultrAPI(self._api_key)
|
|
|
|
@Throttle(MIN_TIME_BETWEEN_UPDATES)
|
|
def update(self):
|
|
"""Use the data from Vultr API."""
|
|
self.data = self.api.server_list()
|
|
|
|
def _force_update(self):
|
|
"""Use the data from Vultr API."""
|
|
self.data = self.api.server_list()
|
|
|
|
def halt(self, subscription):
|
|
"""Halt a subscription (hard power off)."""
|
|
self.api.server_halt(subscription)
|
|
self._force_update()
|
|
|
|
def start(self, subscription):
|
|
"""Start a subscription."""
|
|
self.api.server_start(subscription)
|
|
self._force_update()
|