mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-03-09 14:47:00 +00:00
70_BOTVAC.pm: commandref anker point style <module><get|set|attr>
git-svn-id: https://svn.fhem.de/fhem/trunk@23770 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
vuffiraa
parent
27deb1ead3
commit
e53670c1e6
@ -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 <module><get|set|attr>
|
||||
- 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
|
||||
|
||||
@ -2904,88 +2904,88 @@ It is exactly the same Password as you use on the Website or inside the App.</p>
|
||||
|
||||
<p><strong><a name="BOTVACget"></a>Get</strong></p>
|
||||
<ul>
|
||||
<li><a name="batteryPercent"></a><code>get <name> batteryPercent</code><br />
|
||||
<li><a name="BOTVACbatteryPercent"></a><code>get <name> batteryPercent</code><br />
|
||||
requests the state of the battery from Robot</li>
|
||||
<li><a name="securityTokens"></a><code>get <name> securityTokens</code><br />
|
||||
<li><a name="BOTVACsecurityTokens"></a><code>get <name> securityTokens</code><br />
|
||||
list of all tokens stored by the module. The tokens are relevant for user authentication and to get access to robot data.</li>
|
||||
<li><a name="statistics"></a><code>get <name> statistics</code><br />
|
||||
<li><a name="BOTVACstatistics"></a><code>get <name> statistics</code><br />
|
||||
display statistical data, extracted from available maps of recent cleanings</li>
|
||||
</ul>
|
||||
<p><strong><a name="BOTVACset"></a>Set</strong></p>
|
||||
<ul>
|
||||
<li><a name="findMe"></a><code>set <name> findMe</code><br />
|
||||
<li><a name="BOTVACfindMe"></a><code>set <name> findMe</code><br />
|
||||
plays a sound and let the LED light for easier finding of a stuck robot</li>
|
||||
<li><a name="dismissCurrentAlert"></a><code>set <name> dismissCurrentAlert</code><br />
|
||||
<li><a name="BOTVACdismissCurrentAlert"></a><code>set <name> dismissCurrentAlert</code><br />
|
||||
reset an actual Warning (e.g. dustbin full)</li>
|
||||
<li><a name="nextCleaningMode"></a><code>set <name> nextCleaningMode</code><br />
|
||||
<li><a name="BOTVACnextCleaningMode"></a><code>set <name> nextCleaningMode</code><br />
|
||||
Depending on Model, there are Arguments available: eco/turbo</li>
|
||||
<li><a name="nextCleaningModifier"></a><code>set <name> nextCleaningModifier</code><br />
|
||||
<li><a name="BOTVACnextCleaningModifier"></a><code>set <name> nextCleaningModifier</code><br />
|
||||
The modifier is used for next spot cleaning. Depending on Model, there are Arguments available: normal/double</li>
|
||||
<li><a name="nextCleaningNavigationMode"></a><code>set <name> nextCleaningNavigationMode</code><br />
|
||||
<li><a name="BOTVACnextCleaningNavigationMode"></a><code>set <name> nextCleaningNavigationMode</code><br />
|
||||
The navigation mode is used for the next house cleaning. Depending on Model, there are Arguments available: normal/extraCare/deep</li>
|
||||
<li><a name="nextCleaningZone"></a><code>set <name> nextCleaningZone</code><br />
|
||||
<li><a name="BOTVACnextCleaningZone"></a><code>set <name> nextCleaningZone</code><br />
|
||||
Depending on Model, the ID of the zone that will be used for the next zone cleaning can be set.</li>
|
||||
<li><a name="nextCleaningSpotHeight"></a><code>set <name> nextCleaningSpotHeight</code><br />
|
||||
<li><a name="BOTVACnextCleaningSpotHeight"></a><code>set <name> nextCleaningSpotHeight</code><br />
|
||||
Is defined as number between 100 - 400. The unit is cm.</li>
|
||||
<li><a name="nextCleaningSpotWidth"></a><code>set <name> nextCleaningSpotWidth</code><br />
|
||||
<li><a name="BOTVACnextCleaningSpotWidth"></a><code>set <name> nextCleaningSpotWidth</code><br />
|
||||
Is defined as number between 100 - 400. The unit is cm.</li>
|
||||
<li><a name="password"></a><code>set <name> password <password></code><br />
|
||||
<li><a name="BOTVACpassword"></a><code>set <name> password <password></code><br />
|
||||
set the password for the NEATO/VORWERK account</li>
|
||||
<li><a name="pause"></a><code>set <name> pause</code><br />
|
||||
<li><a name="BOTVACpause"></a><code>set <name> pause</code><br />
|
||||
interrupts the cleaning</li>
|
||||
<li><a name="pauseToBase"></a><code>set <name> pauseToBase</code><br />
|
||||
<li><a name="BOTVACpauseToBase"></a><code>set <name> pauseToBase</code><br />
|
||||
stops cleaning and returns to base</li>
|
||||
<li><a name="reloadMaps"></a><code>set <name> reloadMaps</code><br />
|
||||
<li><a name="BOTVACreloadMaps"></a><code>set <name> reloadMaps</code><br />
|
||||
load last map from server into the cache of the module. no file is stored!</li>
|
||||
<li><a name="resume"></a><code>set <name> resume</code><br />
|
||||
<li><a name="BOTVACresume"></a><code>set <name> resume</code><br />
|
||||
resume cleaning after pause</li>
|
||||
<li><a name="requestVerification"></a><code>set <name> requestVerification</code><br />
|
||||
<li><a name="BOTVACrequestVerification"></a><code>set <name> requestVerification</code><br />
|
||||
Request one-time password for account verfication.<br />
|
||||
One-time password will be sent to the account's email address.</li>
|
||||
<li><a name="schedule"></a><code>set <name> schedule</code><br />
|
||||
<li><a name="BOTVACschedule"></a><code>set <name> schedule</code><br />
|
||||
on and off, switch time control</li>
|
||||
<li><a name="sendToBase"></a><code>set <name> sendToBase</code><br />
|
||||
<li><a name="BOTVACsendToBase"></a><code>set <name> sendToBase</code><br />
|
||||
send roboter back to base</li>
|
||||
<li><a name="sendVerification"></a><code>set <name> sendVerification <code></code><br />
|
||||
<li><a name="BOTVACsendVerification"></a><code>set <name> sendVerification <code></code><br />
|
||||
Use one-time password from email as code to log in into your account, see <a href="#requestVerification">requestVerification</a>.</li>
|
||||
<li><a name="setBoundariesOnFloorplan"></a><code>set <name> setBoundariesOnFloorplan_<floor plan> <name|{JSON String}></code><br />
|
||||
<li><a name="BOTVACsetBoundariesOnFloorplan"></a><code>set <name> setBoundariesOnFloorplan_<floor plan> <name|{JSON String}></code><br />
|
||||
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.)<br />
|
||||
<a href="https://developers.neatorobotics.com/api/robot-remote-protocol/maps">Description of syntax</a><br />
|
||||
Examples:<br />
|
||||
<code>set <name> setBoundariesOnFloorplan_0 Bad</code><br />
|
||||
<code>set <name> setBoundariesOnFloorplan_0 Bad,Kueche</code><br />
|
||||
<code>set <name> setBoundariesOnFloorplan_0 {"type":"polyline","vertices":[[0.710,0.6217],[0.710,0.6923]], "name":"Bad","color":"#E54B1C","enabled":true}</code></li>
|
||||
<li><a name="setRobot"></a><code>set <name> setRobot</code><br />
|
||||
<li><a name="BOTVACsetRobot"></a><code>set <name> setRobot</code><br />
|
||||
choose robot if more than one is registered at the used account</li>
|
||||
<li><a name="startCleaning"></a><code>set <name> startCleaning ([house|map|zone])</code><br />
|
||||
<li><a name="BOTVACstartCleaning"></a><code>set <name> startCleaning ([house|map|zone])</code><br />
|
||||
start the Cleaning from the scratch. If the robot supports boundaries/nogo lines/zones, the additional parameter can be used as:
|
||||
<ul>
|
||||
<li><code>house</code> - cleaning without a persisted map</li>
|
||||
<li><code>map</code> - cleaning with a persisted map</li>
|
||||
<li><code>zone</code> - cleaning in a specific zone, set zone with nextCleaningZone</li>
|
||||
</ul></li>
|
||||
<li><a name="startSpot"></a><code>set <name> startSpot</code><br />
|
||||
<li><a name="BOTVACstartSpot"></a><code>set <name> startSpot</code><br />
|
||||
start spot-Cleaning from actual position.</li>
|
||||
<li><a name="startManual"></a><code>set <name> startManual</code><br />
|
||||
<li><a name="BOTVACstartManual"></a><code>set <name> startManual</code><br />
|
||||
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.<br />
|
||||
<em>Note:</em> 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.</li>
|
||||
<li><a name="statusRequest"></a><code>set <name> statusRequest</code><br />
|
||||
<li><a name="BOTVACstatusRequest"></a><code>set <name> statusRequest</code><br />
|
||||
pull update of all readings. necessary because NEATO/VORWERK does not send updates at their own.</li>
|
||||
<li><a name="stop"></a><code>set <name> stop</code><br />
|
||||
<li><a name="BOTVACstop"></a><code>set <name> stop</code><br />
|
||||
stop cleaning and in case of manual cleaning mode close also the websocket connection</li>
|
||||
<li><a name="syncRobots"></a><code>set <name> syncRobots</code><br />
|
||||
<li><a name="BOTVACsyncRobots"></a><code>set <name> syncRobots</code><br />
|
||||
sync robot data with online account. Useful if one has more then one robot registered</li>
|
||||
<li><a name="pollingMode"></a><code>set <name> pollingMode <on|off></code><br />
|
||||
<li><a name="BOTVACpollingMode"></a><code>set <name> pollingMode <on|off></code><br />
|
||||
set polling on (default) or off like attribut disable.</li>
|
||||
<li><a name="robotSounds"></a><code>set <name> robotSounds <on|off></code><br />
|
||||
<li><a name="BOTVACrobotSounds"></a><code>set <name> robotSounds <on|off></code><br />
|
||||
set sounds on or off.</li>
|
||||
<li><a name="dirtbinAlertReminderInterval"></a><code>set <name> dirtbinAlertReminderInterval <30|60|90|120|150></code><br />
|
||||
<li><a name="BOTVACdirtbinAlertReminderInterval"></a><code>set <name> dirtbinAlertReminderInterval <30|60|90|120|150></code><br />
|
||||
set alert intervall in minutes.</li>
|
||||
<li><a name="filterChangeReminderInterval"></a><code>set <name> filterChangeReminderInterval <1|2|3></code><br />
|
||||
<li><a name="BOTVACfilterChangeReminderInterval"></a><code>set <name> filterChangeReminderInterval <1|2|3></code><br />
|
||||
set alert intervall in months.</li>
|
||||
<li><a name="brushChangeReminderInterval"></a><code>set <name> brushChangeReminderInterval <4|5|6|7|8></code><br />
|
||||
<li><a name="BOTVACbrushChangeReminderInterval"></a><code>set <name> brushChangeReminderInterval <4|5|6|7|8></code><br />
|
||||
set alert intervall in months.</li>
|
||||
<li><a name="wsCommand"></a><code>set <name> wsCommand</code><br />
|
||||
<li><a name="BOTVACwsCommand"></a><code>set <name> wsCommand</code><br />
|
||||
Commands start or stop cleaning activities.
|
||||
<ul>
|
||||
<li><code>eco-on</code></li>
|
||||
@ -2997,7 +2997,7 @@ Commands start or stop cleaning activities.
|
||||
<li><code>vacuum-on</code></li>
|
||||
<li><code>vacuum-off</code></li>
|
||||
</ul></li>
|
||||
<li><a name="wsCombo"></a><code>set <name> wsCombo</code><br />
|
||||
<li><a name="BOTVACwsCombo"></a><code>set <name> wsCombo</code><br />
|
||||
Combos specify a behavior on the robot.<br />
|
||||
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.
|
||||
<ul>
|
||||
@ -3012,9 +3012,9 @@ They need to be sent with less than 1Hz frequency. If the robot doesn't receive
|
||||
</ul>
|
||||
<p><strong><a name="BOTVACattr"></a>Attributes</strong></p>
|
||||
<ul>
|
||||
<li><a name="actionInterval"></a><code>actionInterval</code><br />
|
||||
<li><a name="BOTVACactionInterval"></a><code>actionInterval</code><br />
|
||||
time in seconds between status requests while Device is working</li>
|
||||
<li><a name="boundaries"></a><code>boundaries</code><br />
|
||||
<li><a name="BOTVACboundaries"></a><code>boundaries</code><br />
|
||||
Boundary entries separated by space in JSON format, e.g.<br />
|
||||
<code>{"type":"polyline","vertices":[[0.710,0.6217],[0.710,0.6923]],"name":"Bad","color":"#E54B1C","enabled":true}</code><br />
|
||||
<code>{"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}</code><br />
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user