From 1d3b3eb207164eaa54042d7dffbba9534c0ed582 Mon Sep 17 00:00:00 2001 From: vuffiraa Date: Thu, 18 Feb 2021 18:32:34 +0000 Subject: [PATCH] 70_BOTVAC.pm: commandref anker point style git-svn-id: https://svn.fhem.de/fhem/trunk@23770 2b470e98-0d58-463d-a4d8-8e2adae1ed80 --- fhem/CHANGED | 1 + fhem/FHEM/70_BOTVAC.pm | 74 +++++++++++++++++++++--------------------- 2 files changed, 38 insertions(+), 37 deletions(-) diff --git a/fhem/CHANGED b/fhem/CHANGED index 8b8d445fe..a3d0e8cc3 100644 --- a/fhem/CHANGED +++ b/fhem/CHANGED @@ -1,5 +1,6 @@ # Add changes at the top of the list. Keep it in ASCII, and 80-char wide. # Do not insert empty lines here, update check depends on it. + - bugfix: 70_BOTVAC: commandref anker point style - feature: 72_TA_CMI_JSON: added readOutputStates and according attributes - feature: 73_km200: Errorcodes implemented - change: 98_weekprofile: don't display '°C' by temperature keywords diff --git a/fhem/FHEM/70_BOTVAC.pm b/fhem/FHEM/70_BOTVAC.pm index 671455374..ecd02b949 100755 --- a/fhem/FHEM/70_BOTVAC.pm +++ b/fhem/FHEM/70_BOTVAC.pm @@ -2904,88 +2904,88 @@ It is exactly the same Password as you use on the Website or inside the App.

Get

    -
  • get <name> batteryPercent
    +
  • get <name> batteryPercent
    requests the state of the battery from Robot
    • -
  • get <name> securityTokens
    +
  • get <name> securityTokens
    list of all tokens stored by the module. The tokens are relevant for user authentication and to get access to robot data.
    • -
  • get <name> statistics
    +
  • get <name> statistics
    display statistical data, extracted from available maps of recent cleanings

Set

    -
  • set <name> findMe
    +
  • set <name> findMe
    plays a sound and let the LED light for easier finding of a stuck robot
    • -
  • set <name> dismissCurrentAlert
    +
  • set <name> dismissCurrentAlert
    reset an actual Warning (e.g. dustbin full)
    • -
  • set <name> nextCleaningMode
    +
  • set <name> nextCleaningMode
    Depending on Model, there are Arguments available: eco/turbo
    • -
  • set <name> nextCleaningModifier
    +
  • set <name> nextCleaningModifier
    The modifier is used for next spot cleaning. Depending on Model, there are Arguments available: normal/double
    • -
  • set <name> nextCleaningNavigationMode
    +
  • set <name> nextCleaningNavigationMode
    The navigation mode is used for the next house cleaning. Depending on Model, there are Arguments available: normal/extraCare/deep
    • -
  • set <name> nextCleaningZone
    +
  • set <name> nextCleaningZone
    Depending on Model, the ID of the zone that will be used for the next zone cleaning can be set.
    • -
  • set <name> nextCleaningSpotHeight
    +
  • set <name> nextCleaningSpotHeight
    Is defined as number between 100 - 400. The unit is cm.
    • -
  • set <name> nextCleaningSpotWidth
    +
  • set <name> nextCleaningSpotWidth
    Is defined as number between 100 - 400. The unit is cm.
    • -
  • set <name> password <password>
    +
  • set <name> password <password>
    set the password for the NEATO/VORWERK account
    • -
  • set <name> pause
    +
  • set <name> pause
    interrupts the cleaning
    • -
  • set <name> pauseToBase
    +
  • set <name> pauseToBase
    stops cleaning and returns to base
    • -
  • set <name> reloadMaps
    +
  • set <name> reloadMaps
    load last map from server into the cache of the module. no file is stored!
    • -
  • set <name> resume
    +
  • set <name> resume
    resume cleaning after pause
    • -
  • set <name> requestVerification
    +
  • set <name> requestVerification
    Request one-time password for account verfication.
    One-time password will be sent to the account's email address.
    • -
  • set <name> schedule
    +
  • set <name> schedule
    on and off, switch time control
    • -
  • set <name> sendToBase
    +
  • set <name> sendToBase
    send roboter back to base
    • -
  • set <name> sendVerification <code>
    +
  • set <name> sendVerification <code>
    Use one-time password from email as code to log in into your account, see requestVerification.
    • -
  • set <name> setBoundariesOnFloorplan_<floor plan> <name|{JSON String}>
    +
  • set <name> setBoundariesOnFloorplan_<floor plan> <name|{JSON String}>
    Set boundaries/nogo lines in the corresponding floor plan. The paramter can either be a name, which is already defined by attribute "boundaries", or alternatively a JSON string. (A comma-separated list of names is also possible.)
    Description of syntax
    Examples:
    set <name> setBoundariesOnFloorplan_0 Bad
    set <name> setBoundariesOnFloorplan_0 Bad,Kueche
    set <name> setBoundariesOnFloorplan_0 {"type":"polyline","vertices":[[0.710,0.6217],[0.710,0.6923]], "name":"Bad","color":"#E54B1C","enabled":true}
    • -
  • set <name> setRobot
    +
  • set <name> setRobot
    choose robot if more than one is registered at the used account
    • -
  • set <name> startCleaning ([house|map|zone])
    +
  • set <name> startCleaning ([house|map|zone])
    start the Cleaning from the scratch. If the robot supports boundaries/nogo lines/zones, the additional parameter can be used as:
    • house - cleaning without a persisted map
    • map - cleaning with a persisted map
    • zone - cleaning in a specific zone, set zone with nextCleaningZone
    • -
  • set <name> startSpot
    +
  • set <name> startSpot
    start spot-Cleaning from actual position.
    • -
  • set <name> startManual
    +
  • set <name> startManual
    start Manual Cleaning. This cleaning mode opens a direct websocket connection to the robot. Therefore robot and FHEM installation has to reside in the same LAN. Even though an internet connection is necessary as the initialization is triggered by a remote call.
    Note: If the robot does not receive any messages for 30 seconds it will exit Manual Cleaning, but it will not close the websocket connection automaticaly.
    • -
  • set <name> statusRequest
    +
  • set <name> statusRequest
    pull update of all readings. necessary because NEATO/VORWERK does not send updates at their own.
    • -
  • set <name> stop
    +
  • set <name> stop
    stop cleaning and in case of manual cleaning mode close also the websocket connection
    • -
  • set <name> syncRobots
    +
  • set <name> syncRobots
    sync robot data with online account. Useful if one has more then one robot registered
    • -
  • set <name> pollingMode <on|off>
    +
  • set <name> pollingMode <on|off>
    set polling on (default) or off like attribut disable.
    • -
  • set <name> robotSounds <on|off>
    +
  • set <name> robotSounds <on|off>
    set sounds on or off.
    • -
  • set <name> dirtbinAlertReminderInterval <30|60|90|120|150>
    +
  • set <name> dirtbinAlertReminderInterval <30|60|90|120|150>
    set alert intervall in minutes.
    • -
  • set <name> filterChangeReminderInterval <1|2|3>
    +
  • set <name> filterChangeReminderInterval <1|2|3>
    set alert intervall in months.
    • -
  • set <name> brushChangeReminderInterval <4|5|6|7|8>
    +
  • set <name> brushChangeReminderInterval <4|5|6|7|8>
    set alert intervall in months.
    • -
  • set <name> wsCommand
    +
  • set <name> wsCommand
    Commands start or stop cleaning activities.
    • eco-on
      • @@ -2997,7 +2997,7 @@ Commands start or stop cleaning activities.
    • vacuum-on
    • vacuum-off
    • -
  • set <name> wsCombo
    +
  • set <name> wsCombo
    Combos specify a behavior on the robot.
    They need to be sent with less than 1Hz frequency. If the robot doesn't receive a combo with the specified frequency it will stop moving. Also, if the robot does not receive any messages for 30 seconds it will exit Manual Cleaning.
      @@ -3012,9 +3012,9 @@ They need to be sent with less than 1Hz frequency. If the robot doesn't receive

    Attributes

      -
    • actionInterval
      +
    • actionInterval
      time in seconds between status requests while Device is working
      • -
    • boundaries
      +
    • boundaries
      Boundary entries separated by space in JSON format, e.g.
      {"type":"polyline","vertices":[[0.710,0.6217],[0.710,0.6923]],"name":"Bad","color":"#E54B1C","enabled":true}
      {"type":"polyline","vertices":[[0.7139,0.4101],[0.7135,0.4282],[0.4326,0.3322],[0.4326,0.2533],[0.3931,0.2533],[0.3931,0.3426],[0.7452,0.4637],[0.7617,0.4196]],"name":"Kueche","color":"#000000","enabled":true}