Giter Club home page Giter Club logo

pymoebot's Introduction

pymoebot

A Python library intended to monitor (and control?) the MoeBot robotic lawn mowers.

  • MoeBot are controllable over WiFi via the Tuya protocol, using the Tuya apps on your Apple/Android device.
  • Tested using an S5 model of MoeBot (which is identical to an S10 (and S20??) apart from battery size).
  • A number of other Robot Mowers appear to be physically identical, though it is unconfirmed if they work (or even support WiFi control):
  • This library provides a MoeBot facade to the tinytuya library.
  • The ultimate intent is to have a library that can then be used within Home-Assistant

Goals

  • Monitor the MoeBot
  • Control the MoeBot
  • Integrate into Home-Assistant stand-alone.

History

It was originally intended to utilise the official tuya-iot-python-sdk library but that provided minimal support for the MoeBot. Instead, this library now uses local communication with the MoeBot via the tinytuya library. This does require a little bit of pre-work to identify the LOCAL_KEY for the device so that we can communicate with it.

Regardless of chosen library we are required to have configured a Tuya Cloud project, follow these instructions

Using pymoebot

NOTE: The MoeBot needs to have been activated by adding it to the Tuya/SmartLife app first.

In it's most simplistic use, get an instance of MoeBot and query its status.

from pymoebot import MoeBot

moebot = MoeBot('DEVICE_ID', 'IP', 'LOCAL_KEY')
print("Battery level: %s%" % moebot.battery)

See the examples for full examples of usage.

Communicating with the MoeBot

tinytuya have done all the hard work of communicating with the MoeBot. It is worth sharing my understanding of the specifics about the MoeBot though, since I have made some assumptions and peer-review may be able to identify issues.

The MoeBot (like all other Tuya devices) communicates by way of Tuya Data Points (DPS). Some of these are declared when the mower is queried. Others are provided unsolicited.

import tinytuya

d = tinytuya.Device('DEVICEID', 'DEVICEIP', 'DEVICEKEY')
d.set_version(3.3)
print(d.status())

Will result in:

{'dps': {'6': 100, '101': 'STANDBY', '102': 0, '103': 'MOWER_LEAN', '104': True, '105': 3, '106': 1111, '114': 'AutoMode'}}

Tuya Data Points

DPS Read/Write Values Comment
6 r/w 0-100 'Battery'
101 r
  • STANDBY
  • MOWING
  • CHARGING
  • EMERGENCY
  • LOCKED
  • PAUSED
  • PARK
  • CHARGING_WITH_TASK_SUSPEND
  • FIXED_MOWING
  • ERROR
'Machine Status' Provides state - can't seem to command state using this
102 r 0 'Machine error'
103 r
  • MOWER_LEAN
  • MOWER_EMERGENCY
  • MOWER_UI_LOCKED
  • NO_LOOP_SIGNAL
  • BATTERY_NOT_ENOUGH
    'Machine warning' Provides sub-states for when the mower is in EMERGENCY
    104 r/w True/False 'Rain mode' Should we work in the rain?
    105 r/w 1-99 'work time' How many hours to run for when started manually
    106 r/? 1111 'machine password'
    107 w True/False 'Clear machine appointment' results in a DPS 110 response
    108 w True/False 'Query machine appointment' results in a DPS 110 response
    109 w True/False 'query partition parameters' results in a DPS 113 response
    110 r/w [byte data] 'Report machine appointment'
    111 r/? [byte data] 'error log'
    112 r/w [byte data] 'work log' Report of mower working time after work has completed, contains last 10 logs
    113 r/w [byte data] 'Partition parameters' specifies the zone mowing configuration
    114 r/? AutoMode/?? 'WorkMode'
    115 w
    • StartMowing
    • StartFixedMowing
    • PauseWork
    • ContinueWork
    • CancelWork
    • StartReturnStation
      'Machine Control CMD' used to change mower state

      State Model

      Main States

      The following are the declared states of the MoeBot seen so far. They are signified by a '101' DPS.

      • CHARGING
      • EMERGENCY - the emergency stop button has been pressed (or the device has been tipped/picked up).
      • LOCKED - the device is locked and the PIN is required to do anything.
      • PAUSED - the mowing session has been paused.
      • MOWING
      • CHARGING_WITH_TASK_SUSPEND - currently charging but will go back out to mow.
      • STANDBY - the mower is not mowing and is charged. May or may not be docked.
      • PARK - on the way back to the charging dock.
      • FIXED_MOWING - working in a spiral pattern.

      EMERGENCY States

      The following appear to be sub-states for when the mower is in EMERGENCY state. They are signified by a '103' DPS.

      • MOWER_LEAN
      • MOWER_EMERGENCY
      • MOWER_UI_LOCKED
      • PLACE_INSIDE_STATION
      • BATTERY_NOT_ENOUGH

      Recommend Projects

      • React photo React

        A declarative, efficient, and flexible JavaScript library for building user interfaces.

      • Vue.js photo Vue.js

        🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

      • Typescript photo Typescript

        TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

      • TensorFlow photo TensorFlow

        An Open Source Machine Learning Framework for Everyone

      • Django photo Django

        The Web framework for perfectionists with deadlines.

      • D3 photo D3

        Bring data to life with SVG, Canvas and HTML. 📊📈🎉

      Recommend Topics

      • javascript

        JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

      • web

        Some thing interesting about web. New door for the world.

      • server

        A server is a program made to process requests and deliver data to clients.

      • Machine learning

        Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

      • Game

        Some thing interesting about game, make everyone happy.

      Recommend Org

      • Facebook photo Facebook

        We are working to build community through open source technology. NB: members must have two-factor auth.

      • Microsoft photo Microsoft

        Open source projects and samples from Microsoft.

      • Google photo Google

        Google ❤️ Open Source for everyone.

      • D3 photo D3

        Data-Driven Documents codes.