2
0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-01-31 06:39:11 +00:00

48_MieleAtHome: v1.1.0 - use id-tag instead of name-tag for docs

git-svn-id: https://svn.fhem.de/fhem/trunk@24511 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
choenig 2021-05-25 19:10:59 +00:00
parent 42ee822a2d
commit 2cb2603d46
2 changed files with 31 additions and 29 deletions

View File

@ -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.
- change: 48_MieleAtHome: use id-tag instead of name-tag for docs
- new: 50_SSFile: Module that integrates Synology Sile Station
- bugfix: 98_WeekdayTimer: CONDITION now again is checked for entire day
- feature: 74_GardenaSmartDevice: add support for SmartIrrigationControl

View File

@ -35,7 +35,7 @@ use Encode qw(encode_utf8);
use List::Util qw[min max];
use JSON;
my $version = "1.0.2";
my $version = "1.1.0";
my $MAH_hasMimeBase64 = 1;
@ -1229,6 +1229,7 @@ sub MAH_calculateETA($$$)
if ($statusRaw == 2 || $statusRaw == 7) { # On (but not running) or End
my $eta = POSIX::strftime("%H:%M", localtime(time + $remainingSecs)); # ignore startOffsetSecs here as this is very strange
my $etaHR = "+" . MAH_formatTime($remainingHour, $remainingMinute);
$etaHR = "Ende" if ($remainingHour == 0 && $remainingMinute == 0);
return ($eta, $etaHR);
}
@ -1237,7 +1238,7 @@ sub MAH_calculateETA($$$)
my $etaHR = $eta;
# write remaining minutes in the last 15 minutes instead of
$etaHR = sprintf("+0:%02d", ${remainingMinute}) if ($remainingSecs <= 15 * 60);
$etaHR = "+" . MAH_formatTime($remainingHour, $remainingMinute) if ($remainingSecs <= 15 * 60);
return ($eta, $etaHR);
# }
@ -1862,7 +1863,7 @@ sub MAH_getStacktrace()
=begin html
<a name="MieleAtHome"></a>
<a id="MieleAtHome"></a>
<h3>MieleAtHome</h3>
<ul>
<u><b>MieleAtHome - Controls Miele@home Devices</b></u><br>
@ -1876,7 +1877,7 @@ sub MAH_getStacktrace()
<br>
To use this module you need to register as a developer at <a href="https://www.miele.com/f/com/en/register_api.aspx">https://www.miele.com/f/com/en/register_api.aspx</a>. After you successfully registered, you will receive a <i>clientId</i> and a <i>clientSecret</i> which you'll need to configure in your <code>&lt;gateway&gt;</code>-device.<br>
<br>
<a name="MieleAtHomedefine"></a>
<a id="MieleAtHome-define"></a>
<b>Define</b><br>
<br>
<u>(1) Setup gateway:</u><br>
@ -1939,106 +1940,106 @@ sub MAH_getStacktrace()
</li>
-->
<a name="MieleAtHomeset"></a>
<a id="MieleAtHome-set"></a>
<b>Set</b>
<ul>
<li><a name="autocreate"></a>
<li><a id="MieleAtHome-set-autocreate"></a>
<dt><code><b>autocreate</b></code></dt>
autocreate fhem-devices for each Miele@home appliance found in your account. Needs <i>login</i>, <i>clientId</i>, <i>password</i> and <i>clientSecret</i> to be configured properly. Only available for the gateway device.
</li>
<li><a name="clientSecret"></a>
<li><a id="MieleAtHome-set-clientSecret"></a>
<dt><code><b>clientSecret &lt;secret&gt;</b></code></dt>
sets the <i>clientSecret</i> of your Miele@home-developer Account and stores it in a file (base64-encoded if you have MIME::Base64 installed).
</li>
<li><a name="light"></a>
<li><a id="MieleAtHome-set-light"></a>
<dt><code><b>light [enable|disable]</b></code></dt>
enable/disable the light of your device. only available depending on the type and state of your appliance.
</li>
<li><a name="on"></a>
<li><a id="MieleAtHome-set-on"></a>
<dt><code><b>on</b></code></dt>
power up your device. only available depending on the type and state of your appliance.
</li>
<li><a name="off"></a>
<li><a id="MieleAtHome-set-off"></a>
<dt><code><b>off</b></code></dt>
power off your device. only available depending on the type and state of your appliance.
</li>
<li><a name="password"></a>
<li><a id="MieleAtHome-set-password"></a>
<dt><code><b>password &lt;pass&gt;</b></code></dt>
set the <i>password</i> of your Miele@home Account and stores it in a file (base64-encoded if you have MIME::Base64 installed).
</li>
<li><a name="pause"></a>
<li><a id="MieleAtHome-set-pause"></a>
<dt><code><b>pause</b></code></dt>
pause your device. only available depending on the type and state of your appliance.
</li>
<li><a name="start"></a>
<li><a id="MieleAtHome-set-start"></a>
<dt><code><b>start</b></code></dt>
start your device. only available depending on the type and state of your appliance.
</li>
<li><a name="startTime"></a>
<li><a id="MieleAtHome-set-startTime"></a>
<dt><code><b>startTime &lt;[H]H:MM&gt;</b></code></dt>
modify the start time of your device relative from current time. only available depending on the type and state of your appliance.
</li>
<li><a name="stop"></a>
<li><a id="MieleAtHome-set-stop"></a>
<dt><code><b>stop</b></code></dt>
stop your device. only available depending on the type and state of your appliance.
</li>
<li><a name="startSuperFreezing"></a>
<li><a id="MieleAtHome-set-startSuperFreezing"></a>
<dt><code><b>startSuperFreezing</b></code></dt>
start super freezing your device. only available depending on the type and state of your appliance.
</li>
<li><a name="stopSuperFreezing"></a>
<li><a id="MieleAtHome-set-stopSuperFreezing"></a>
<dt><code><b>stopSuperFreezing</b></code></dt>
stop super freezing your device. only available depending on the type and state of your appliance.
</li>
<li><a name="startSuperCooling"></a>
<li><a id="MieleAtHome-set-startSuperCooling"></a>
<dt><code><b>startSuperCooling</b></code></dt>
start super cooling your device. only available depending on the type and state of your appliance.
</li>
<li><a name="stopSuperCooling"></a>
<li><a id="MieleAtHome-set-stopSuperCooling"></a>
<dt><code><b>stopSuperCooling</b></code></dt>
stop super cooling your device. only available depending on the type and state of your appliance.
</li>
<li><a name="update"></a>
<li><a id="MieleAtHome-set-update"></a>
<dt><code><b>update</b></code></dt>
instantly update all readings.
</li>
<li><a name="ventilationStep"></a>
<li><a id="MieleAtHome-set-ventilationStep"></a>
<dt><code><b>ventilationStep [Step1|Step2|Step3|Step4]</b></code></dt>
set the ventilation step of your device. only available depending on the type and state of your appliance.
</li>
</ul>
<br>
<a name="MieleAtHomeget"></a>
<a id="MieleAtHome-get"></a>
<b>Get</b>
<ul>
<li><a name="listDevices"></a>
<li><a id="MieleAtHome-get-listDevices"></a>
<dt><code><b>listDevices</b></code></dt>
lists the devices associated with your Miele@home-account. Needs <i>login</i>, <i>clientId</i>, <i>password</i> and <i>clientSecret</i> to be configured properly.
</li>
</ul>
<br>
<a name="MieleAtHomeattribut"></a>
<a id="MieleAtHome-attr"></a>
<b>Attributes</b>
<ul>
<li><a name="clientId"></a>
<li><a id="MieleAtHome-attr-clientId"></a>
<dt><code><b>clientId</b></code></dt>
set the <i>clientId</i> of your Miele@home-developer account.
</li>
<li><a name="country"></a>
<li><a id="MieleAtHome-attr-country"></a>
<dt><code><b>country</b></code></dt>
set the <i>country</i> where you registered your Miele@home account.
</li>
<li><a name="login"></a>
<li><a id="MieleAtHome-attr-login"></a>
<dt><code><b>login</b></code></dt>
set the <i>login</i> of your Miele@home account.
</li>
<li><a name="disable"></a>
<li><a id="MieleAtHome-attr-disable"></a>
<dt><code><b>disable</b></code></dt>
disables this MieleAtHome-instance.
</li>
<li><a name="lang"></a>
<li><a id="MieleAtHome-attr-lang"></a>
<dt><code><b>lang [de|en]</b></code></dt>
request the readings in either german or english. <i>en</i> is default.
</li>