Fix logic errors in previous commits, update version readme and changelog, add features, improve things, etc.

CHANGELOG.md

@@ -1,6 +1,21 @@
 # v1.2
 
-- Add mode selection
+- Major changes to default behavior:
+  - If time is not specified, whatever mode is selected will run until the vacuum gets low on battery. Then it will go home.
+  - If a time is specified, vacuum will run until the end of elapsed time then it will stop in place.
+- Addition of a mode flag:
+  - `-m quiet`: Automatic direction, low suction
+  - `-m default`: Automatic direction, medium suction
+  - `-m max`: Automatic direction, maximum suction
+  - `-m edge`: Stick to the edges of the room
+  - `-m spot`: "Spot clean" - goes in goes in a spiral from one point
+- Addition of a status flag:
+  - `-s or --status` will connect to robovac and print status.
+- Improve tuya logs and callbacks by associating status names with their values.
+  - whereas before, status indicators such as "power" and "work mode" were reported as numerical keys, the keys are now just called "power" and "work mode".
+- add a return to base flag
+  - `--return or -r`: when combined with `--time or -t`, will instruct robovac to return to base after time has elapsed. (default is to pause in place when time elapses).
+  - This is semantically different from `-b or --home` because it only impacts a timed job.
 
 # v1.1
 

README.md

@@ -8,6 +8,7 @@
     - [Command-line](#command-line)
     - [Config file](#config-file)
 - [Usage](#usage)
+  - [Examples](#examples-1)
 - [Obtaining device credentials](#obtaining-device-credentials)
   - [tl;dr](#tldr)
   - [Instructions:](#instructions-1)
@@ -77,7 +78,7 @@ local_code=LOCAL_CODE
 # Usage
 
 ```
-usage: vac [-h] [-c CONFIG] [--device_id DEVICE_ID] [--ip IP] [--local_code LOCAL_CODE] [--time TIME] [--pause] [--home] [--debug] [--verbose] [--quiet]
+usage: vac.py [-h] [-c CONFIG] [--device_id DEVICE_ID] [--ip IP] [--local_code LOCAL_CODE] [--time TIME] [--home] [--pause] [--mode MODE] [--verbose] [--quiet] [--status] [--return]
 
 Control a Robovac device.
 
@@ -91,11 +92,33 @@ options:
   --local_code LOCAL_CODE
                         Secret key obtained from eufy
   --time TIME, -t TIME  Cleaning time in minutes
-  --pause, -p           Pause vacuum
   --home, -b            Go home
-  --debug, -d           Enter debugging mode (won't send commands to vacuum)
+  --pause, -p           Pause vacuum
+  --mode MODE, -m MODE  Options: default, max, edge, spot, quiet
   --verbose, -v         Enable verbose logs
   --quiet, -q           Quiet logs
+  --status, -s          Print status
+  --return, -r          Return to base upon completion (requires -t)
+```
+
+## Examples
+
+__Clean for 5 minutes, then go home__
+
+```
+robovac -t 5 -r
+```
+
+__Clean the edge of the room until the battery runs out, then go home__
+
+```
+robovac -m edge
+```
+
+__Clean for 20 minutes then go home. Quiet all logs and run process in the background__
+
+```
+robovac -t 20 -r -q > /dev/null 2>&1 &
 ```
 
 # Obtaining device credentials

VERSION

@@ -1 +1 @@
-version=1.1
+version=1.2

src/robovac/tuya.py

@@ -536,7 +536,22 @@ class TuyaDevice:
 
     async def async_update_state(self, state_message, _):
         self._dps.update(state_message.payload["dps"])
-        _LOGGER.info("Received updated state {}: {}".format(self, self._dps))
+        dict1 = {
+            'POWER': '1',
+            'PLAY_PAUSE': '2',
+            'DIRECTION': '3',
+            'WORK_MODE': '5',
+            'WORK_STATUS': '15',
+            'GO_HOME': '101',
+            'CLEAN_SPEED': '102',
+            'FIND_ROBOT': '103',
+            'BATTERY_LEVEL': '104',
+            'ERROR_CODE': '106'
+        }
+        dict2 = self._dps
+        combined_dict = {key: dict2[value] for key, value in dict1.items() if value in dict2}
+
+        _LOGGER.info("Received updated state {}: {}".format(self, combined_dict))
 
     @property
     def state(self):

src/vac.py

@@ -2,25 +2,39 @@
 import asyncio
 import signal
 import logging
-import pprint
 import sys
 import argparse
 from enum import Enum
 import os
+from pprint import pprint
 
 
-from robovac.robovac import Robovac, CleanSpeed, WorkMode
+from robovac.robovac import Robovac, CleanSpeed, WorkMode, WorkStatus
-from robovac.property import StringEnum
 
 
-DEFAULT_TIME = 20
+DEFAULT_TIME = False
 
 
 stop_event = asyncio.Event()
 
 
-class Modes(StringEnum):
+device_status = {
+    'POWER': '1',
+    'PLAY_PAUSE': '2',
+    'DIRECTION': '3',
+    'WORK_MODE': '5',
+    'WORK_STATUS': '15',
+    'GO_HOME': '101',
+    'CLEAN_SPEED': '102',
+    'FIND_ROBOT': '103',
+    'BATTERY_LEVEL': '104',
+    'ERROR_CODE': '106'
+}
+
+
+class Modes:
     DEFAULT = CleanSpeed.BOOST_IQ, WorkMode.AUTO
+    QUIET = CleanSpeed.STANDARD, WorkMode.AUTO
     MAX = CleanSpeed.MAX, WorkMode.AUTO
     EDGE = CleanSpeed.MAX, WorkMode.EDGE
     SPOT = CleanSpeed.MAX, WorkMode.SPOT
@@ -63,12 +77,23 @@ def parse_robovac_config(path="/home/freyja/Desktop/robovac.conf"):
     return credentials
 
 
+async def ordered_callback(message,device):
+    # print(message)
+    dict1 = device_status
+    dict2 = device.state
+    combined_dict = {key: dict2[value] for key, value in dict1.items() if value in dict2}
+    pprint(combined_dict)
+
+
 async def callback(message,device):
-    print(message)
+    # print(message)
-    pprint.pprint(device.state)
+    dict1 = device_status
+    dict2 = device.state
+    combined_dict = {key: dict2[value] for key, value in dict1.items() if value in dict2}
+    print(combined_dict)
 
 
-async def stepper(time):
+async def stepper(time) -> bool:
     total_seconds = time * 60
     step = 1
     elapsed = 0
@@ -78,21 +103,25 @@ async def stepper(time):
     return True
 
 
-async def async_clean(r: Robovac, time: int, mode: Modes):
+async def async_clean(r: Robovac, mode: Modes):
-    if mode:
+    if r.work_mode != mode[1]:
-        await r.async_set_clean_speed(mode[0])
+        await r.async_set_work_mode(mode[1],callback)
-        await r.async_set_work_mode(mode[1])
+        await asyncio.sleep(1)
-    await r.async_start_cleaning(callback)
+    await r.async_set_clean_speed(mode[0],callback)
-    await stepper(time)
+    await asyncio.sleep(1)
-    await r.async_pause()
 
 
 async def async_go_home(r: Robovac):
-    await r.async_go_home(callback)
+    if r.work_status != WorkStatus.CHARGING:
+        await r.async_go_home(callback)
+        await asyncio.sleep(1)
+
 
 
 async def async_pause(r: Robovac):
-    await r.async_pause(callback)
+    if r.work_status != WorkStatus.CHARGING:
+        await r.async_pause(callback)
+        await asyncio.sleep(1)
 
 
 async def async_main(
@@ -102,19 +131,26 @@ async def async_main(
     time=DEFAULT_TIME,
     go_home=False,
     pause=False,
-    mode=Modes.DEFAULT
+    mode=None,
+    status=False,
+    rtb=False
 ):
     asyncio.get_event_loop().add_signal_handler(signal.SIGTERM, signal_handler)
     asyncio.get_event_loop().add_signal_handler(signal.SIGINT, signal_handler)
     r = Robovac(device_id,ip,local_code)
-    await r.async_connect(callback)
+    await r.async_connect(ordered_callback if status else callback)
     await asyncio.sleep(2)
 
 
+    if status:
+        stop_event.set()
+
+
     if mode and not go_home and not pause:
         while not stop_event.is_set():
-            await async_clean(r, time, mode)
+            await async_clean(r, mode)
-            await async_go_home(r)
+            if time:
+                await stepper(time)
             stop_event.set()
 
 
@@ -130,12 +166,16 @@ async def async_main(
             stop_event.set()
 
 
-    if not r.go_home and not pause:
+    if time and not pause and not go_home and not status:
-        await async_go_home(r)
+        if rtb:
+            await async_go_home(r)
+        elif not rtb:
+            await async_pause(r)
 
 
     if r._connected:
         await r.async_disconnect()
+    return
 
 
 def main(*args, **kwargs):
@@ -166,75 +206,25 @@ def main(*args, **kwargs):
 
 
     parser = argparse.ArgumentParser(description="Control a Robovac device.")
-    parser.add_argument(
+    parser.add_argument('-c', '--config',help="Path to config file",default=early_args.config)
-        '-c', '--config',
+    parser.add_argument('--device_id',help="Device ID",default=None if early_args.device_id else defaults.get('device_id'))
-        help="Path to config file",
+    parser.add_argument('--ip',help="Device IP address",default=None if early_args.ip else defaults.get('ip'))
-        default=early_args.config
+    parser.add_argument('--local_code',help="Secret key obtained from eufy",default=None if early_args.local_code else defaults.get('local_code'))
-    )
+    parser.add_argument('--time', '-t',type=int,help="Cleaning time in minutes",default=DEFAULT_TIME)
-    parser.add_argument(
+    parser.add_argument('--home', '-b',action='store_true',help="Go home",default=False,dest="go_home")
-        '--device_id',
+    parser.add_argument('--pause','-p',action='store_true',help="Pause vacuum",default=False,dest="pause")
-        help="Device ID",
+    parser.add_argument('--mode', '-m',dest="mode",default="",help = "Options: default, max, edge, spot, quiet")
-        default=None if early_args.device_id else defaults.get('device_id')
+    parser.add_argument('--verbose','-v',action='store_true',dest="verbose",default=False,help="Enable verbose logs")
-    )
+    parser.add_argument('--quiet','-q',action='store_true',dest="quiet",default=False,help="Quiet logs")
-    parser.add_argument(
+    parser.add_argument('--status','-s',action='store_true',dest="status",default=False,help="Print status")
-        '--ip',
+    parser.add_argument('--return','-r',action='store_true',dest="rtb",default=False,help="Return to base upon completion (requires -t)")
-        help="Device IP address",
-        default=None if early_args.ip else defaults.get('ip')
-    )
-    parser.add_argument(
-        '--local_code',
-        help="Secret key obtained from eufy",
-        default=None if early_args.local_code else defaults.get('local_code')
-    )
-    parser.add_argument(
-        '--time', '-t',
-        type=int,
-        help="Cleaning time in minutes",
-        default=DEFAULT_TIME
-    )
-    parser.add_argument(
-        '--home', '-b',
-        action='store_true',
-        help="Go home",
-        default=False,
-        dest="go_home",
-    )
-    parser.add_argument(
-        '--pause','-p',
-        action='store_true',
-        help="Pause vacuum",
-        default=False,
-        dest="pause",
-    )
-    parser.add_argument(
-        '--mode', '-m',
-        dest="mode",
-        default="default",
-        help = '''Options: default, max, edge, spot \n
-        default: Automatic work mode, medium suction \n
-        max: Automatic work mode, max suction \n
-        edge: Clean edges of room, max suction \n
-        spot: Spot clean, max suction \n
-        '''
-    )
-    parser.add_argument(
-        '--verbose','-v',
-        action='store_true',
-        dest="verbose",
-        default=False,
-        help="Enable verbose logs"
-    )
-    parser.add_argument(
-        '--quiet','-q',
-        action='store_true',
-        dest="quiet",
-        default=False,
-        help="Quiet logs"
-    )
 
 
     args = parser.parse_args()
 
+    if args.rtb and not args.time:
+        parser.error("Return to base may only be set if a duration is specified.")
+
 
     if args.quiet and args.verbose:
         parser.error("Cannot set quiet and verbose mode simultaneously.")
@@ -243,13 +233,19 @@ def main(*args, **kwargs):
     elif args.quiet:
         logging.basicConfig(level=logging.CRITICAL)
         sys.stdout = open(os.devnull, 'w')
+    elif args.status:
+        logging.basicConfig(level=logging.CRITICAL)
     else:
         logging.basicConfig(level=logging.INFO)
 
 
-    if args.mode.lower() and (args.pause or args.home):
+    if args.mode != "" and (args.pause or args.go_home):
         print("Mode will be overridden.")
         args.mode = None
+    elif args.mode == "" and (args.pause or args.go_home):
+        args.mode = None
+    elif args.mode.lower() == "" and not (args.pause or args.go_home):
+        args.mode = Modes.DEFAULT
     elif args.mode.lower() == "default":
         args.mode = Modes.DEFAULT
     elif args.mode.lower() == "max":
@@ -258,6 +254,10 @@ def main(*args, **kwargs):
         args.mode = Modes.SPOT
     elif args.mode.lower() == "edge":
         args.mode = Modes.EDGE
+    elif args.mode.lower() == "quiet":
+        args.mode = Modes.QUIET
+    else:
+        parser.error(f'Invalid mode selection')
 
 
     if not use_config:
@@ -272,9 +272,9 @@ def main(*args, **kwargs):
 
 
     try:
-        asyncio.run(async_main(args.device_id, args.ip, args.local_code, args.time, args.go_home,args.pause, args.mode))
+        asyncio.run(async_main(args.device_id, args.ip, args.local_code, args.time, args.go_home,args.pause, args.mode, args.status,args.rtb))
     except Exception as e:
-        if args.debug or args.verbose:
+        if args.verbose:
             print(e)
         else:
             print("An error occured.")