1
0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-05-07 22:29:19 +00:00

70_BOTVAC.pm: added instant help for get/set/attributes

git-svn-id: https://svn.fhem.de/fhem/trunk@18624 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
vuffiraa 2019-02-17 19:45:12 +00:00
parent 25b6aa60b6
commit c21cfe5609

View File

@ -817,9 +817,9 @@ sub ReceiveCommand($$$) {
if ($err) { if ($err) {
if ( !defined($cmd) || $cmd eq "" ) { if ( !defined($cmd) || $cmd eq "" ) {
Log3($name, 3, "BOTVAC $name:$service RCV $err"); Log3($name, 4, "BOTVAC $name:$service RCV $err");
} else { } else {
Log3($name, 3, "BOTVAC $name:$service/$cmd RCV $err"); Log3($name, 4, "BOTVAC $name:$service/$cmd RCV $err");
} }
# keep last state # keep last state
@ -1900,6 +1900,7 @@ sub wsMasking($$) {
<b>Get</b> <b>Get</b>
<ul> <ul>
<br> <br>
<a name="batteryPercent"></a>
<li><code>get &lt;name&gt; batteryPercent</code> <li><code>get &lt;name&gt; batteryPercent</code>
<br> <br>
requests the state of the battery from Robot requests the state of the battery from Robot
@ -1911,24 +1912,28 @@ sub wsMasking($$) {
<ul> <ul>
<br> <br>
<li> <li>
<a name="findMe"></a>
<code> set &lt;name&gt; findMe</code> <code> set &lt;name&gt; findMe</code>
<br> <br>
plays a sound and let the LED light for easier finding of a stuck robot plays a sound and let the LED light for easier finding of a stuck robot
</li> </li>
<br> <br>
<li> <li>
<a name="dismissCurrentAlert"></a>
<code> set &lt;name&gt; dismissCurrentAlert</code> <code> set &lt;name&gt; dismissCurrentAlert</code>
<br> <br>
reset an actual Warning (e.g. dustbin full) reset an actual Warning (e.g. dustbin full)
</li> </li>
<br> <br>
<li> <li>
<a name="nextCleaningMode"></a>
<code> set &lt;name&gt; nextCleaningMode</code> <code> set &lt;name&gt; nextCleaningMode</code>
<br> <br>
Depending on Model, there are Arguments available: eco/turbo Depending on Model, there are Arguments available: eco/turbo
</li> </li>
<br> <br>
<li> <li>
<a name="nextCleaningNavigationMode"></a>
<code> set &lt;name&gt; nextCleaningNavigationMode</code> <code> set &lt;name&gt; nextCleaningNavigationMode</code>
<br> <br>
The navigation mode is used for the next house cleaning. The navigation mode is used for the next house cleaning.
@ -1936,6 +1941,7 @@ sub wsMasking($$) {
</li> </li>
<br> <br>
<li> <li>
<a name="nextCleaningNavigationModifier"></a>
<code> set &lt;name&gt; nextCleaningNavigationModifier</code> <code> set &lt;name&gt; nextCleaningNavigationModifier</code>
<br> <br>
The modifier is used for next spot cleaning. The modifier is used for next spot cleaning.
@ -1943,66 +1949,77 @@ sub wsMasking($$) {
</li> </li>
<br> <br>
<li> <li>
<a name="nextCleaningZone"></a>
<code> set &lt;name&gt; nextCleaningZone</code> <code> set &lt;name&gt; nextCleaningZone</code>
<br> <br>
Depending on Model, the ID of the zone that will be used for the next zone cleaning can be set. Depending on Model, the ID of the zone that will be used for the next zone cleaning can be set.
</li> </li>
<br> <br>
<li> <li>
<a name="nextCleaningSpotHeight"></a>
<code> set &lt;name&gt; nextCleaningSpotHeight</code> <code> set &lt;name&gt; nextCleaningSpotHeight</code>
<br> <br>
Is defined as number between 100 - 400. The unit is cm. Is defined as number between 100 - 400. The unit is cm.
</li> </li>
<br> <br>
<li> <li>
<a name="nextCleaningSpotWidth"></a>
<code> set &lt;name&gt; nextCleaningSpotWidth</code> <code> set &lt;name&gt; nextCleaningSpotWidth</code>
<br> <br>
Is defined as number between 100 - 400. The unit is cm. Is defined as number between 100 - 400. The unit is cm.
</li> </li>
<br> <br>
<li> <li>
<a name="password"></a>
<code> set &lt;name&gt; password &lt;password&gt;</code> <code> set &lt;name&gt; password &lt;password&gt;</code>
<br> <br>
set the password for the NEATO/VORWERK account set the password for the NEATO/VORWERK account
</li> </li>
<br> <br>
<li> <li>
<a name="pause"></a>
<code> set &lt;name&gt; pause</code> <code> set &lt;name&gt; pause</code>
<br> <br>
interrupts the cleaning interrupts the cleaning
</li> </li>
<br> <br>
<li> <li>
<a name="pauseToBase"></a>
<code> set &lt;name&gt; pauseToBase</code> <code> set &lt;name&gt; pauseToBase</code>
<br> <br>
stops cleaning and returns to base stops cleaning and returns to base
</li> </li>
<br> <br>
<li> <li>
<a name="reloadMaps"></a>
<code> set &lt;name&gt; reloadMaps</code> <code> set &lt;name&gt; reloadMaps</code>
<br> <br>
load last map from server into the cache of the module. no file is stored! load last map from server into the cache of the module. no file is stored!
</li> </li>
<br> <br>
<li> <li>
<a name="resume"></a>
<code> set &lt;name&gt; resume</code> <code> set &lt;name&gt; resume</code>
<br> <br>
resume cleaning after pause resume cleaning after pause
</li> </li>
<br> <br>
<li> <li>
<a name="schedule"></a>
<code> set &lt;name&gt; schedule</code> <code> set &lt;name&gt; schedule</code>
<br> <br>
on and off, switch time control on and off, switch time control
</li> </li>
<br> <br>
<li> <li>
<a name="sendToBase"></a>
<code> set &lt;name&gt; sendToBase</code> <code> set &lt;name&gt; sendToBase</code>
<br> <br>
send roboter back to base send roboter back to base
</li> </li>
<br> <br>
<li> <li>
<a name="setBoundariesOnFloorplan"></a>
<code> set &lt;name&gt; setBoundariesOnFloorplan_&lt;floor plan&gt; &lt;name|{JSON String}&gt;</code> <code> set &lt;name&gt; setBoundariesOnFloorplan_&lt;floor plan&gt; &lt;name|{JSON String}&gt;</code>
<br> <br>
Set boundaries/nogo lines in the corresponding floor plan.<br> Set boundaries/nogo lines in the corresponding floor plan.<br>
@ -2018,12 +2035,14 @@ sub wsMasking($$) {
</li> </li>
<br> <br>
<li> <li>
<a name="setRobot"></a>
<code> set &lt;name&gt; setRobot</code> <code> set &lt;name&gt; setRobot</code>
<br> <br>
choose robot if more than one is registered at the used account choose robot if more than one is registered at the used account
</li> </li>
<br> <br>
<li> <li>
<a name="startCleaning"></a>
<code> set &lt;name&gt; startCleaning ([house|map|zone])</code> <code> set &lt;name&gt; startCleaning ([house|map|zone])</code>
<br> <br>
start the Cleaning from the scratch. start the Cleaning from the scratch.
@ -2036,12 +2055,14 @@ sub wsMasking($$) {
</li> </li>
<br> <br>
<li> <li>
<a name="startSpot"></a>
<code> set &lt;name&gt; startSpot</code> <code> set &lt;name&gt; startSpot</code>
<br> <br>
start spot-Cleaning from actual position. start spot-Cleaning from actual position.
</li> </li>
<br> <br>
<li> <li>
<a name="startManual"></a>
<code> set &lt;name&gt; startManual</code> <code> set &lt;name&gt; startManual</code>
<br> <br>
start Manual Cleaning. This cleaning mode opens a direct websocket connection to the robot. start Manual Cleaning. This cleaning mode opens a direct websocket connection to the robot.
@ -2053,24 +2074,28 @@ sub wsMasking($$) {
</li> </li>
<br> <br>
<li> <li>
<a name="statusRequest"></a>
<code> set &lt;name&gt; statusRequest</code> <code> set &lt;name&gt; statusRequest</code>
<br> <br>
pull update of all readings. necessary because NEATO/VORWERK does not send updates at their own. pull update of all readings. necessary because NEATO/VORWERK does not send updates at their own.
</li> </li>
<br> <br>
<li> <li>
<a name="stop"></a>
<code> set &lt;name&gt; stop</code> <code> set &lt;name&gt; stop</code>
<br> <br>
stop cleaning and in case of manual cleaning mode close also the websocket connection stop cleaning and in case of manual cleaning mode close also the websocket connection
</li> </li>
<br> <br>
<li> <li>
<a name="syncRobots"></a>
<code> set &lt;name&gt; syncRobots</code> <code> set &lt;name&gt; syncRobots</code>
<br> <br>
sync robot data with online account. Useful if one has more then one robot registered sync robot data with online account. Useful if one has more then one robot registered
</li> </li>
<br> <br>
<li> <li>
<a name="wsCommand"></a>
<code> set &lt;name&gt; wsCommand</code> <code> set &lt;name&gt; wsCommand</code>
<br> <br>
Commands start or stop cleaning activities. Commands start or stop cleaning activities.
@ -2087,6 +2112,7 @@ sub wsMasking($$) {
</li> </li>
<br> <br>
<li> <li>
<a name="wsCombo"></a>
<code> set &lt;name&gt; wsCombo</code> <code> set &lt;name&gt; wsCombo</code>
<br> <br>
Combos specify a behavior on the robot. They need to be sent with less than 1Hz frequency. Combos specify a behavior on the robot. They need to be sent with less than 1Hz frequency.
@ -2116,6 +2142,7 @@ sub wsMasking($$) {
</li> </li>
<br> <br>
<li> <li>
<a name="boundaries"></a>
<code>boundaries</code> <code>boundaries</code>
<br> <br>
Boundary entries separated by space in JSON format, e.g.<br> Boundary entries separated by space in JSON format, e.g.<br>