Add cli commands pause resume; fix stop

.gitignore

@@ -9,3 +9,11 @@ dist
 # Nosetests files
 cover/
 .coverage
+
+# Ignore Vscode files
+.vscode/
+
+# Ignore sucks.egg-info
+sucks.egg-info/
+.noseids
+nosetests.xml

README.md

@@ -99,8 +99,8 @@ shaping the API.
 
 A simple usage might go something like this:
 
-```
-import sucks
+```python
+from sucks import *
 
 config = ...
 

setup.py

@@ -68,6 +68,7 @@
         'requests>=2.18',
         'pycryptodome>=3.4',
         'pycountry-convert>=0.5',
+        'paho-mqtt>=1.4',
         'stringcase>=1.2'
     ],
 

sucks/cli.py

@@ -8,8 +8,9 @@
 import click
 from pycountry_convert import country_alpha2_to_continent_code
 
+import sucks
 from sucks import *
-
+print(sucks.__file__)
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -67,12 +68,15 @@ def __init__(self, wait_on, wait_for):
 
     def wait(self, bot):
         if not hasattr(bot, self.wait_on):
-            raise ValueError("object " + bot + " does not have method " + self.wait_on)
-        _LOGGER.debug("waiting on " + self.wait_on + " for value " + self.wait_for)
+            raise ValueError("object " + bot +
+                             " does not have method " + self.wait_on)
+        _LOGGER.debug("waiting on " + self.wait_on +
+                      " for value " + self.wait_for)
 
         while getattr(bot, self.wait_on) != self.wait_for:
             time.sleep(0.5)
-        _LOGGER.debug("wait complete; " + self.wait_on + " is now " + self.wait_for)
+        _LOGGER.debug("wait complete; " + self.wait_on +
+                      " is now " + self.wait_for)
 
 
 class CliAction:
@@ -96,7 +100,8 @@ def config_file_exists():
 def read_config():
     parser = configparser.ConfigParser()
     with open(config_file()) as fp:
-        parser.read_file(itertools.chain(['[global]'], fp), source=config_file())
+        parser.read_file(itertools.chain(
+            ['[global]'], fp), source=config_file())
     return parser['global']
 
 
@@ -124,7 +129,8 @@ def should_run(frequency):
         return True
     n = random.random()
     result = n <= frequency
-    _LOGGER.debug("tossing coin: {:0.3f} <= {:0.3f}: {}".format(n, frequency, result))
+    _LOGGER.debug("tossing coin: {:0.3f} <= {:0.3f}: {}".format(
+        n, frequency, result))
     return result
 
 
@@ -141,15 +147,17 @@ def cli(debug):
 @click.option('--country-code', prompt='your two-letter country code', default=lambda: current_country())
 @click.option('--continent-code', prompt='your two-letter continent code',
               default=lambda: continent_for_country(click.get_current_context().params['country_code']))
-def login(email, password, country_code, continent_code):
+@click.option('--verify-ssl', prompt='Verify SSL for API requests', default=True)
+def login(email, password, country_code, continent_code, verify_ssl):
     if config_file_exists() and not click.confirm('overwrite existing config?'):
         click.echo("Skipping login.")
         exit(0)
     config = OrderedDict()
     password_hash = EcoVacsAPI.md5(password)
     device_id = EcoVacsAPI.md5(str(time.time()))
     try:
-        EcoVacsAPI(device_id, email, password_hash, country_code, continent_code)
+        EcoVacsAPI(device_id, email, password_hash,
+                   country_code, continent_code, verify_ssl)
     except ValueError as e:
         click.echo(e.args[0])
         exit(1)
@@ -158,17 +166,22 @@ def login(email, password, country_code, continent_code):
     config['device_id'] = device_id
     config['country'] = country_code.lower()
     config['continent'] = continent_code.lower()
+    config['verify_ssl'] = verify_ssl
     write_config(config)
     click.echo("Config saved.")
     exit(0)
 
 
-@cli.command(help='auto-cleans for the specified number of minutes')
+@cli.command(help='auto-cleans for the specified number of minutes, if minutes is 0 auto clean until bot returns to charger by itself')
 @click.option('--frequency', '-f', type=FREQUENCY, help='frequency with which to run; e.g. 0.5 or 3/7')
 @click.argument('minutes', type=click.FLOAT)
 def clean(frequency, minutes):
+    waiter = StatusWait('charge_status', 'charging')
+    if minutes > 0:
+        waiter = TimeWait(minutes * 60)
+
     if should_run(frequency):
-        return CliAction(Clean(), wait=TimeWait(minutes * 60))
+        return CliAction(Clean(), wait=waiter)
 
 
 @cli.command(help='cleans room edges for the specified number of minutes')
@@ -179,6 +192,17 @@ def edge(frequency, minutes):
         return CliAction(Edge(), wait=TimeWait(minutes * 60))
 
 
+# ignore_unknown for map coordinates with negatives
+@cli.command(help='cleans provided area(s), ex: "0,1"', context_settings={"ignore_unknown_options": True})
+@click.option("--map-position", "-p", is_flag=True, help='clean provided map position instead of area, ex: "-602,1812,800,723"')
+@click.argument('area', type=click.STRING, required=True)
+def area(area, map_position):
+    if map_position:
+        return CliAction(SpotArea('start', map_position=area), wait=StatusWait('charge_status', 'returning'))
+    else:
+        return CliAction(SpotArea('start', area=area), wait=StatusWait('charge_status', 'returning'))
+
+
 @cli.command(help='returns to charger')
 def charge():
     return charge_action()
@@ -193,6 +217,21 @@ def stop():
     return CliAction(Stop(), terminal=True, wait=StatusWait('clean_status', 'stop'))
 
 
+@cli.command(help='pause the robot in its current position')
+def pause():
+    return CliAction(Pause(), terminal=True, wait=StatusWait('clean_status', 'pause'))
+
+
+@cli.command(help='Resume job')
+def resume():
+    return CliAction(Resume(), terminal=True, wait=StatusWait('charge_status', 'charging'))
+
+
+@cli.command(help='get the current state of the robot')
+def state():
+    return CliAction(GetCleanState(), terminal=True, wait=TimeWait(10))
+
+
 @cli.resultcallback()
 def run(actions, debug):
     actions = list(filter(None.__ne__, actions))
@@ -209,9 +248,10 @@ def run(actions, debug):
     if actions:
         config = read_config()
         api = EcoVacsAPI(config['device_id'], config['email'], config['password_hash'],
-                         config['country'], config['continent'])
+                         config['country'], config['continent'], verify_ssl=config['verify_ssl'])
         vacuum = api.devices()[0]
-        vacbot = VacBot(api.uid, api.REALM, api.resource, api.user_access_token, vacuum, config['continent'])
+        vacbot = VacBot(api.uid, api.REALM, api.resource, api.user_access_token,
+                        vacuum, config['continent'], verify_ssl=config['verify_ssl'])
         vacbot.connect_and_wait_until_ready()
 
         for action in actions:

tests/test_commands.py

@@ -19,6 +19,20 @@ def test_custom_command_inner_tag():
                   b'<ctl td="CustomCommand"><customtag customvar="customvalue" /></ctl>')
 
 
+def test_custom_command_multiple_inner_tag():
+    # Ensure a custom-built command with multiple inner tags generates the expected XML payload
+    c = VacBotCommand('CustomCommand', {"customtag":[{"customvar":"customvalue1"},{"customvar":"customvalue2"}]})
+    logging.info(ElementTree.tostring(c.to_xml()))
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                  b'<ctl td="CustomCommand"><customtag customvar="customvalue1" /><customtag customvar="customvalue2" /></ctl>')
+
+def test_custom_command_args_multiple_inner_tag():
+    # Ensure a custom-built command with args and multiple inner tags generates the expected XML payload
+    c = VacBotCommand('CustomCommand', {"arg1":"value1","customtag":[{"customvar":"customvalue1"},{"customvar":"customvalue2"}]})
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                  b'<ctl arg1="value1" td="CustomCommand"><customtag customvar="customvalue1" /><customtag customvar="customvalue2" /></ctl>')
+
+
 def test_custom_command_noargs():
     # Ensure a custom-built command with no args generates XML without an args element
     c = VacBotCommand('CustomCommand')
@@ -29,22 +43,63 @@ def test_custom_command_noargs():
 def test_clean_command():
     c = Clean()
     assert_equals(ElementTree.tostring(c.to_xml()),
-                  b'<ctl td="Clean"><clean speed="standard" type="auto" /></ctl>')  # protocol has attribs in other order
+                  b'<ctl td="Clean"><clean act="s" speed="standard" type="auto" /></ctl>')  # protocol has attribs in other order
+
     c = Clean('edge', 'high')
     assert_equals(ElementTree.tostring(c.to_xml()),
-                  b'<ctl td="Clean"><clean speed="strong" type="border" /></ctl>')  # protocol has attribs in other order
+                  b'<ctl td="Clean"><clean act="s" speed="strong" type="border" /></ctl>')  # protocol has attribs in other order
+
+    c = Clean(iotmq=True)
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                  b'<ctl td="Clean"><clean act="s" speed="standard" type="auto" /></ctl>') # test for iot act is added                         
+
+
+def test_spotarea_command():
+    assert_raises(ValueError, SpotArea, 'start') #Value error if SpotArea doesn't include a mid or p
+
+    c = SpotArea('start', '0')
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                b'<ctl td="Clean"><clean act="s" mid="0" speed="standard" type="SpotArea" /></ctl>')  #Test namedarea clean
+
+    c = SpotArea('start', area='0')
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                b'<ctl td="Clean"><clean act="s" mid="0" speed="standard" type="SpotArea" /></ctl>')  #Test namedarea keyword clean
+
+    c = SpotArea('start', '', '-602,1812,800,723')
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                b'<ctl td="Clean"><clean act="s" deep="1" p="-602,1812,800,723" speed="standard" type="SpotArea" /></ctl>')  #Test customarea clean
+
+    c = SpotArea('start', '', '-602,1812,800,723', '2')
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                b'<ctl td="Clean"><clean act="s" deep="2" p="-602,1812,800,723" speed="standard" type="SpotArea" /></ctl>')  #Test customarea clean with deep 2
+
+    c = SpotArea('start', '', map_position='-602,1812,800,723')
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                b'<ctl td="Clean"><clean act="s" deep="1" p="-602,1812,800,723" speed="standard" type="SpotArea" /></ctl>')  #Test customarea keyword clean with deep default
+
+    c = SpotArea('start', map_position='-602,1812,800,723', cleanings='2')
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                b'<ctl td="Clean"><clean act="s" deep="2" p="-602,1812,800,723" speed="standard" type="SpotArea" /></ctl>')  #Test customarea keyword and cleanings keyword clean with deep default
+
+    c = SpotArea('start', area='0', map_position='-602,1812,800,723', cleanings='2')
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                b'<ctl td="Clean"><clean act="s" mid="0" speed="standard" type="SpotArea" /></ctl>')  #Test all keywords specified, should default to only mid
+
+    c = SpotArea('start', '0', '-602,1812,800,723','2')
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                b'<ctl td="Clean"><clean act="s" mid="0" speed="standard" type="SpotArea" /></ctl>')  #Test all keywords specified, should default to only mid
 
 
 def test_edge_command():
     c = Edge()
     assert_equals(ElementTree.tostring(c.to_xml()),
-                  b'<ctl td="Clean"><clean speed="strong" type="border" /></ctl>')  # protocol has attribs in other order
+                  b'<ctl td="Clean"><clean act="s" speed="strong" type="border" /></ctl>')  # protocol has attribs in other order
 
 
 def test_spot_command():
     c = Spot()
     assert_equals(ElementTree.tostring(c.to_xml()),
-                  b'<ctl td="Clean"><clean speed="strong" type="spot" /></ctl>')  # protocol has attribs in other order
+                  b'<ctl td="Clean"><clean act="s" speed="strong" type="spot" /></ctl>')  # protocol has attribs in other order
 
 
 def test_charge_command():
@@ -56,7 +111,7 @@ def test_charge_command():
 def test_stop_command():
     c = Stop()
     assert_equals(ElementTree.tostring(c.to_xml()),
-                  b'<ctl td="Clean"><clean speed="standard" type="stop" /></ctl>')
+                  b'<ctl td="Clean"><clean act="s" speed="standard" type="stop" /></ctl>')
 
 
 def test_play_sound_command():
@@ -89,7 +144,6 @@ def test_get_battery_state_command():
                   b'<ctl td="GetBatteryInfo" />')
 
 
-
 def test_move_command():
     c = Move(action='left')
     assert_equals(ElementTree.tostring(c.to_xml()),
@@ -103,6 +157,9 @@ def test_move_command():
     c = Move(action='forward')
     assert_equals(ElementTree.tostring(c.to_xml()),
                   b'<ctl td="Move"><move action="forward" /></ctl>')
+    c = Move(action='backward')
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                  b'<ctl td="Move"><move action="backward" /></ctl>')
     c = Move(action='stop')
     assert_equals(ElementTree.tostring(c.to_xml()),
                   b'<ctl td="Move"><move action="stop" /></ctl>')
@@ -112,9 +169,16 @@ def test_get_lifepsan_command():
     c = GetLifeSpan('main_brush')
     assert_equals(ElementTree.tostring(c.to_xml()),
                   b'<ctl td="GetLifeSpan" type="Brush" />')
+
     c = GetLifeSpan('side_brush')
     assert_equals(ElementTree.tostring(c.to_xml()),
                   b'<ctl td="GetLifeSpan" type="SideBrush" />')
+
     c = GetLifeSpan('filter')
     assert_equals(ElementTree.tostring(c.to_xml()),
                   b'<ctl td="GetLifeSpan" type="DustCaseHeap" />')
+
+def test_set_time_command():
+    c = SetTime('1234', 'GMT-5')
+    assert_equals(ElementTree.tostring(c.to_xml()),
+                  b'<ctl td="SetTime"><time t="1234" tz="GMT-5" /></ctl>')