mirror of
https://github.com/home-assistant/core
synced 2024-09-15 17:29:45 +02:00
3ee4d1060f
* Update docstrings * Update docstrings * Update docstrings * Update docstrings * update docstrings * Update docstrings * Update docstrings * Update docstrings * Update docstrings * Update docstrings * Update tomato.py * Update isy994.py * Lint + fix tests * Lint
137 lines
3.9 KiB
Python
137 lines
3.9 KiB
Python
"""
|
|
Support for Neato botvac connected vacuum cleaners.
|
|
|
|
For more details about this component, please refer to the documentation at
|
|
https://home-assistant.io/components/neato/
|
|
"""
|
|
import logging
|
|
from datetime import timedelta
|
|
from urllib.error import HTTPError
|
|
|
|
import voluptuous as vol
|
|
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
|
|
from homeassistant.helpers import discovery
|
|
from homeassistant.util import Throttle
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
REQUIREMENTS = ['https://github.com/jabesq/pybotvac/archive/v0.0.3.zip'
|
|
'#pybotvac==0.0.3']
|
|
|
|
DOMAIN = 'neato'
|
|
NEATO_ROBOTS = 'neato_robots'
|
|
NEATO_LOGIN = 'neato_login'
|
|
NEATO_MAP_DATA = 'neato_map_data'
|
|
|
|
CONFIG_SCHEMA = vol.Schema({
|
|
DOMAIN: vol.Schema({
|
|
vol.Required(CONF_USERNAME): cv.string,
|
|
vol.Required(CONF_PASSWORD): cv.string,
|
|
})
|
|
}, extra=vol.ALLOW_EXTRA)
|
|
|
|
STATES = {
|
|
1: 'Idle',
|
|
2: 'Busy',
|
|
3: 'Pause',
|
|
4: 'Error'
|
|
}
|
|
|
|
MODE = {
|
|
1: 'Eco',
|
|
2: 'Turbo'
|
|
}
|
|
|
|
ACTION = {
|
|
0: 'No action',
|
|
1: 'House cleaning',
|
|
2: 'Spot cleaning',
|
|
3: 'Manual cleaning',
|
|
4: 'Docking',
|
|
5: 'User menu active',
|
|
6: 'Cleaning cancelled',
|
|
7: 'Updating...',
|
|
8: 'Copying logs...',
|
|
9: 'Calculating position...',
|
|
10: 'IEC test'
|
|
}
|
|
|
|
ERRORS = {
|
|
'ui_error_brush_stuck': 'Brush stuck',
|
|
'ui_error_brush_overloaded': 'Brush overloaded',
|
|
'ui_error_bumper_stuck': 'Bumper stuck',
|
|
'ui_error_dust_bin_missing': 'Dust bin missing',
|
|
'ui_error_dust_bin_full': 'Dust bin full',
|
|
'ui_error_dust_bin_emptied': 'Dust bin emptied',
|
|
'ui_error_navigation_backdrop_leftbump': 'Clear my path',
|
|
'ui_error_navigation_noprogress': 'Clear my path',
|
|
'ui_error_navigation_origin_unclean': 'Clear my path',
|
|
'ui_error_navigation_pathproblems_returninghome': 'Cannot return to base',
|
|
'ui_error_navigation_falling': 'Clear my path',
|
|
'ui_error_picked_up': 'Picked up',
|
|
'ui_error_stuck': 'Stuck!'
|
|
}
|
|
|
|
ALERTS = {
|
|
'ui_alert_dust_bin_full': 'Please empty dust bin',
|
|
'ui_alert_recovering_location': 'Returning to start'
|
|
}
|
|
|
|
|
|
def setup(hass, config):
|
|
"""Set up the Neato component."""
|
|
from pybotvac import Account
|
|
|
|
hass.data[NEATO_LOGIN] = NeatoHub(hass, config[DOMAIN], Account)
|
|
hub = hass.data[NEATO_LOGIN]
|
|
if not hub.login():
|
|
_LOGGER.debug("Failed to login to Neato API")
|
|
return False
|
|
hub.update_robots()
|
|
for component in ('camera', 'sensor', 'switch'):
|
|
discovery.load_platform(hass, component, DOMAIN, {}, config)
|
|
|
|
return True
|
|
|
|
|
|
class NeatoHub(object):
|
|
"""A My Neato hub wrapper class."""
|
|
|
|
def __init__(self, hass, domain_config, neato):
|
|
"""Initialize the Neato hub."""
|
|
self.config = domain_config
|
|
self._neato = neato
|
|
self._hass = hass
|
|
|
|
self.my_neato = neato(
|
|
domain_config[CONF_USERNAME],
|
|
domain_config[CONF_PASSWORD])
|
|
self._hass.data[NEATO_ROBOTS] = self.my_neato.robots
|
|
self._hass.data[NEATO_MAP_DATA] = self.my_neato.maps
|
|
|
|
def login(self):
|
|
"""Login to My Neato."""
|
|
try:
|
|
_LOGGER.debug("Trying to connect to Neato API")
|
|
self.my_neato = self._neato(
|
|
self.config[CONF_USERNAME], self.config[CONF_PASSWORD])
|
|
return True
|
|
except HTTPError:
|
|
_LOGGER.error("Unable to connect to Neato API")
|
|
return False
|
|
|
|
@Throttle(timedelta(seconds=1))
|
|
def update_robots(self):
|
|
"""Update the robot states."""
|
|
_LOGGER.debug("Running HUB.update_robots %s",
|
|
self._hass.data[NEATO_ROBOTS])
|
|
self._hass.data[NEATO_ROBOTS] = self.my_neato.robots
|
|
self._hass.data[NEATO_MAP_DATA] = self.my_neato.maps
|
|
|
|
def download_map(self, url):
|
|
"""Download a new map image."""
|
|
map_image_data = self.my_neato.get_map_image(url)
|
|
return map_image_data
|