Add support for STATES of vacuums (#15573)
* Vacuum: Added support for STATES * Added debug logging and corrected state order * typo * Fix travis error, STATE = STATE for readability * status -> state * Changed to Entity instead of ToogleEntity * Updated some vacuums * Revert changes * Revert Changes * added SUPPORT_STATE * Woof? * Implement on/off if STATE not supported * Moved new state vaccum to Class StateVacuumDevice * Error: I should go to bed * Moved around methods for easier reading * Added StateVacuumDevice demo vacuum * Added tests for StateVacuumDevice demo vacuum * Fix styling errors * Refactored to BaseVaccum * Vacuum will now go back to dock * Class BaseVacuum is for internal use only * return -> await * return -> await
This commit is contained in:
1 parent
f8a478946e
commit
2ff5b4ce95
3 files changed
+344
-99
No files matched your search
@@ -6,10 +6,12 @@ from homeassistant.components.vacuum import (
|
||||
ATTR_BATTERY_LEVEL, ATTR_COMMAND, ATTR_ENTITY_ID, ATTR_FAN_SPEED,
|
||||
ATTR_FAN_SPEED_LIST, ATTR_PARAMS, ATTR_STATUS, DOMAIN,
|
||||
ENTITY_ID_ALL_VACUUMS,
|
||||
SERVICE_SEND_COMMAND, SERVICE_SET_FAN_SPEED)
|
||||
SERVICE_SEND_COMMAND, SERVICE_SET_FAN_SPEED,
|
||||
STATE_DOCKED, STATE_CLEANING, STATE_PAUSED, STATE_IDLE,
|
||||
STATE_RETURNING)
|
||||
from homeassistant.components.vacuum.demo import (
|
||||
DEMO_VACUUM_BASIC, DEMO_VACUUM_COMPLETE, DEMO_VACUUM_MINIMAL,
|
||||
DEMO_VACUUM_MOST, DEMO_VACUUM_NONE, FAN_SPEEDS)
|
||||
DEMO_VACUUM_MOST, DEMO_VACUUM_NONE, DEMO_VACUUM_STATE, FAN_SPEEDS)
|
||||
from homeassistant.const import (
|
||||
ATTR_SUPPORTED_FEATURES, CONF_PLATFORM, STATE_OFF, STATE_ON)
|
||||
from homeassistant.setup import setup_component
|
||||
@@ -21,6 +23,7 @@ ENTITY_VACUUM_COMPLETE = '{}.{}'.format(DOMAIN, DEMO_VACUUM_COMPLETE).lower()
|
||||
ENTITY_VACUUM_MINIMAL = '{}.{}'.format(DOMAIN, DEMO_VACUUM_MINIMAL).lower()
|
||||
ENTITY_VACUUM_MOST = '{}.{}'.format(DOMAIN, DEMO_VACUUM_MOST).lower()
|
||||
ENTITY_VACUUM_NONE = '{}.{}'.format(DOMAIN, DEMO_VACUUM_NONE).lower()
|
||||
ENTITY_VACUUM_STATE = '{}.{}'.format(DOMAIN, DEMO_VACUUM_STATE).lower()
|
||||
|
||||
|
||||
class TestVacuumDemo(unittest.TestCase):
|
||||
@@ -79,6 +82,14 @@ class TestVacuumDemo(unittest.TestCase):
|
||||
self.assertEqual(None, state.attributes.get(ATTR_FAN_SPEED_LIST))
|
||||
self.assertEqual(STATE_OFF, state.state)
|
||||
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertEqual(5244, state.attributes.get(ATTR_SUPPORTED_FEATURES))
|
||||
self.assertEqual(STATE_DOCKED, state.state)
|
||||
self.assertEqual(100, state.attributes.get(ATTR_BATTERY_LEVEL))
|
||||
self.assertEqual("medium", state.attributes.get(ATTR_FAN_SPEED))
|
||||
self.assertListEqual(FAN_SPEEDS,
|
||||
state.attributes.get(ATTR_FAN_SPEED_LIST))
|
||||
|
||||
def test_methods(self):
|
||||
"""Test if methods call the services as expected."""
|
||||
self.hass.states.set(ENTITY_VACUUM_BASIC, STATE_ON)
|
||||
@@ -147,6 +158,41 @@ class TestVacuumDemo(unittest.TestCase):
|
||||
self.assertIn("spot", state.attributes.get(ATTR_STATUS))
|
||||
self.assertEqual(STATE_ON, state.state)
|
||||
|
||||
vacuum.start_pause(self.hass, ENTITY_VACUUM_STATE)
|
||||
self.hass.block_till_done()
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertEqual(STATE_CLEANING, state.state)
|
||||
|
||||
vacuum.start_pause(self.hass, ENTITY_VACUUM_STATE)
|
||||
self.hass.block_till_done()
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertEqual(STATE_PAUSED, state.state)
|
||||
|
||||
vacuum.stop(self.hass, ENTITY_VACUUM_STATE)
|
||||
self.hass.block_till_done()
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertEqual(STATE_IDLE, state.state)
|
||||
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertLess(state.attributes.get(ATTR_BATTERY_LEVEL), 100)
|
||||
self.assertNotEqual(STATE_DOCKED, state.state)
|
||||
|
||||
vacuum.return_to_base(self.hass, ENTITY_VACUUM_STATE)
|
||||
self.hass.block_till_done()
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertEqual(STATE_RETURNING, state.state)
|
||||
|
||||
vacuum.set_fan_speed(self.hass, FAN_SPEEDS[-1],
|
||||
entity_id=ENTITY_VACUUM_STATE)
|
||||
self.hass.block_till_done()
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertEqual(FAN_SPEEDS[-1], state.attributes.get(ATTR_FAN_SPEED))
|
||||
|
||||
vacuum.clean_spot(self.hass, entity_id=ENTITY_VACUUM_STATE)
|
||||
self.hass.block_till_done()
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertEqual(STATE_CLEANING, state.state)
|
||||
|
||||
def test_unsupported_methods(self):
|
||||
"""Test service calls for unsupported vacuums."""
|
||||
self.hass.states.set(ENTITY_VACUUM_NONE, STATE_ON)
|
||||
@@ -201,6 +247,22 @@ class TestVacuumDemo(unittest.TestCase):
|
||||
self.assertNotIn("spot", state.attributes.get(ATTR_STATUS))
|
||||
self.assertEqual(STATE_OFF, state.state)
|
||||
|
||||
# StateVacuumDevice does not support on/off
|
||||
vacuum.turn_on(self.hass, entity_id=ENTITY_VACUUM_STATE)
|
||||
self.hass.block_till_done()
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertNotEqual(STATE_CLEANING, state.state)
|
||||
|
||||
vacuum.turn_off(self.hass, entity_id=ENTITY_VACUUM_STATE)
|
||||
self.hass.block_till_done()
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertNotEqual(STATE_RETURNING, state.state)
|
||||
|
||||
vacuum.toggle(self.hass, entity_id=ENTITY_VACUUM_STATE)
|
||||
self.hass.block_till_done()
|
||||
state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
self.assertNotEqual(STATE_CLEANING, state.state)
|
||||
|
||||
def test_services(self):
|
||||
"""Test vacuum services."""
|
||||
# Test send_command
|
||||
@@ -241,9 +303,11 @@ class TestVacuumDemo(unittest.TestCase):
|
||||
def test_set_fan_speed(self):
|
||||
"""Test vacuum service to set the fan speed."""
|
||||
group_vacuums = ','.join([ENTITY_VACUUM_BASIC,
|
||||
ENTITY_VACUUM_COMPLETE])
|
||||
ENTITY_VACUUM_COMPLETE,
|
||||
ENTITY_VACUUM_STATE])
|
||||
old_state_basic = self.hass.states.get(ENTITY_VACUUM_BASIC)
|
||||
old_state_complete = self.hass.states.get(ENTITY_VACUUM_COMPLETE)
|
||||
old_state_state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
|
||||
vacuum.set_fan_speed(
|
||||
self.hass, FAN_SPEEDS[0], entity_id=group_vacuums)
|
||||
@@ -251,6 +315,7 @@ class TestVacuumDemo(unittest.TestCase):
|
||||
self.hass.block_till_done()
|
||||
new_state_basic = self.hass.states.get(ENTITY_VACUUM_BASIC)
|
||||
new_state_complete = self.hass.states.get(ENTITY_VACUUM_COMPLETE)
|
||||
new_state_state = self.hass.states.get(ENTITY_VACUUM_STATE)
|
||||
|
||||
self.assertEqual(old_state_basic, new_state_basic)
|
||||
self.assertNotIn(ATTR_FAN_SPEED, new_state_basic.attributes)
|
||||
@@ -261,6 +326,12 @@ class TestVacuumDemo(unittest.TestCase):
|
||||
self.assertEqual(FAN_SPEEDS[0],
|
||||
new_state_complete.attributes[ATTR_FAN_SPEED])
|
||||
|
||||
self.assertNotEqual(old_state_state, new_state_state)
|
||||
self.assertEqual(FAN_SPEEDS[1],
|
||||
old_state_state.attributes[ATTR_FAN_SPEED])
|
||||
self.assertEqual(FAN_SPEEDS[0],
|
||||
new_state_state.attributes[ATTR_FAN_SPEED])
|
||||
|
||||
def test_send_command(self):
|
||||
"""Test vacuum service to send a command."""
|
||||
group_vacuums = ','.join([ENTITY_VACUUM_BASIC,
|
||||
|
||||
Reference in new issue
Block a user