|
|
@@ -406,6 +406,7 @@
|
|
|
<a href="#SISPM">SISPM</a>
|
|
|
<a href="#SMAEM">SMAEM</a>
|
|
|
<a href="#SMAInverter">SMAInverter</a>
|
|
|
+ <a href="#SmarterCoffee">SmarterCoffee</a>
|
|
|
<a href="#SmartMeterP1">SmartMeterP1</a>
|
|
|
<a href="#SMARTMON">SMARTMON</a>
|
|
|
<a href="#SmartPi">SmartPi</a>
|
|
|
@@ -4221,7 +4222,7 @@ The following local attributes are used by a wider range of devices:
|
|
|
<h3>CALVIEW</h3>
|
|
|
<div class='langLinks'>[EN <a href='commandref_DE.html#CALVIEW'>DE</a>]</div>
|
|
|
<ul>This module creates a device with deadlines based on calendar-devices of the 57_Calendar.pm module. You need to install the perl-modul Date::Parse!</ul>
|
|
|
-<ul>Actually the module supports only the "get <> next" function of the CALENDAR-Modul.</ul>
|
|
|
+<ul>Please configure the attribut HideOlderThen in your CALENDAR-Device, that controls if old events from past are shown!</ul>
|
|
|
<b>Define</b>
|
|
|
<ul><code>define <Name> CALVIEW <calendarname(s) separate with ','> <next> <updateintervall in sec (default 43200)></code></ul>
|
|
|
<ul><code>define myView CALVIEW Googlecalendar next</code></ul>
|
|
|
@@ -10346,6 +10347,7 @@ Just one definition per FHEM-installation is allowed. <a href="https://fhem.de/c
|
|
|
<li> delete consecutive datasets with different timestamp but same values (clearing up consecutive doublets) </li>
|
|
|
<li> Repair of a corrupted SQLite database ("database disk image is malformed") </li>
|
|
|
<li> transmission of datasets from source database into another (Standby) database (syncStandby) </li>
|
|
|
+ <li> reduce the amount of datasets in database (reduceLog) </li>
|
|
|
</ul></ul>
|
|
|
<br>
|
|
|
|
|
|
@@ -10527,11 +10529,30 @@ Just one definition per FHEM-installation is allowed. <a href="https://fhem.de/c
|
|
|
</li> <br>
|
|
|
</ul>
|
|
|
|
|
|
- <li><b> countEntries [history|current] </b> - provides the number of table-entries (default: history) between period set
|
|
|
- by timestamp-<a href="#DbRepattr">attributes</a> if set.
|
|
|
- If timestamp-attributes are not set, all entries of the table will be count.
|
|
|
+ <li><b> countEntries [history|current] </b> - provides the number of table entries (default: history) between time period set
|
|
|
+ by time.* -<a href="#DbRepattr">attributes</a> if set.
|
|
|
+ If time.* attributes not set, all entries of the table will be count.
|
|
|
The <a href="#DbRepattr">attributes</a> "device" and "reading" can be used to
|
|
|
- limit the evaluation. </li> <br>
|
|
|
+ limit the evaluation. <br>
|
|
|
+ By default the summary of all counted datasets, labeled by "ALLREADINGS", will be created.
|
|
|
+ If the attribute "countEntriesDetail" is set, the number of every reading
|
|
|
+ is reported additionally. <br><br>
|
|
|
+
|
|
|
+ The relevant attributes for this function are: <br><br>
|
|
|
+
|
|
|
+ <ul>
|
|
|
+ <table>
|
|
|
+ <colgroup> <col width=5%> <col width=95%> </colgroup>
|
|
|
+ <tr><td> <b>aggregation</b> </td><td>: aggregatiion/grouping of time intervals </td></tr>
|
|
|
+ <tr><td> <b>countEntriesDetail</b></td><td>: detailed report the count of datasets (per reading) </td></tr>
|
|
|
+ <tr><td> <b>device</b> </td><td>: selection only of datasets which contain <device> </td></tr>
|
|
|
+ <tr><td> <b>reading</b> </td><td>: selection only of datasets which contain <reading> </td></tr>
|
|
|
+ <tr><td> <b>time.*</b> </td><td>: a number of attributes to limit selection by time </td></tr>
|
|
|
+ </table>
|
|
|
+ </ul>
|
|
|
+ <br>
|
|
|
+
|
|
|
+ </li> <br>
|
|
|
|
|
|
|
|
|
<li><b> delEntries </b> - deletes all database entries or only the database entries specified by <a href="#DbRepattr">attributes</a> Device and/or
|
|
|
@@ -10989,7 +11010,7 @@ Just one definition per FHEM-installation is allowed. <a href="https://fhem.de/c
|
|
|
<tr><td> <b>device</b> </td><td>: select only datasets which are contain <device> </td></tr>
|
|
|
<tr><td> <b>reading</b> </td><td>: select only datasets which are contain <reading> </td></tr>
|
|
|
<tr><td> <b>time.*</b> </td><td>: A number of attributes to limit selection by time </td></tr>
|
|
|
- <tr><td> <b>valueFilter</b> </td><td>: filter datasets of database field "VALUE" by a regular expression </td></tr>
|
|
|
+ <tr><td> <b>valueFilter</b> </td><td>: Filter datasets which are to show by a regular expression. The regex is applied to the whole selected dataset. </td></tr>
|
|
|
</table>
|
|
|
</ul>
|
|
|
<br>
|
|
|
@@ -11512,7 +11533,16 @@ return $ret;
|
|
|
</li>
|
|
|
<br><br>
|
|
|
</ul>
|
|
|
- <br>
|
|
|
+
|
|
|
+ <li><b> versionNotes [hints | rel | <key>] </b> -
|
|
|
+ Shows realease informations and/or hints about the module. It contains only main release
|
|
|
+ informations for module users. <br>
|
|
|
+ If no options are specified, both release informations and hints will be shown. "rel" shows
|
|
|
+ only release informations and "hints" shows only hints. By the <key>-specification only
|
|
|
+ the hint with the specified number is shown.
|
|
|
+ </li>
|
|
|
+ <br>
|
|
|
+
|
|
|
</ul></ul>
|
|
|
|
|
|
</ul>
|
|
|
@@ -11523,7 +11553,9 @@ return $ret;
|
|
|
|
|
|
<br>
|
|
|
<ul>
|
|
|
- Using the module specific attributes you are able to define the scope of evaluation and the aggregation. <br><br>
|
|
|
+ Using the module specific attributes you are able to define the scope of evaluation and the aggregation. <br>
|
|
|
+ The listed attrbutes are not completely relevant for every function of the module. The help of set/get-commands
|
|
|
+ contain explicitly which attributes are relevant for the specific command. <br><br>
|
|
|
|
|
|
<b>Note for SQL-Wildcard Usage:</b> <br>
|
|
|
Within the attribute values of "device" and "reading" you may use SQL-Wildcard "%", Character "_" is not supported as a wildcard.
|
|
|
@@ -11551,15 +11583,20 @@ return $ret;
|
|
|
<ul>
|
|
|
<table>
|
|
|
<colgroup> <col width=20%> <col width=80%> </colgroup>
|
|
|
- <tr><td><b>avgArithmeticMean :</b> </td><td>the arithmetic average is calculated (default) </td></tr>
|
|
|
- <tr><td><b>avgDailyMeanGWS :</b> </td><td>calculates the daily medium temperature according the
|
|
|
- specifications of german weather service (pls. see helpful hints by get versionNotes). <br>
|
|
|
- This variant uses aggregation "day" automatically. </td></tr>
|
|
|
- <tr><td><b>avgTimeWeightMean :</b> </td><td>calculates a time weighted average mean value is calculated </td></tr>
|
|
|
+ <tr><td><b>avgArithmeticMean :</b> </td><td>the arithmetic average is calculated (default) </td></tr>
|
|
|
+ <tr><td style="vertical-align:top"><b>avgDailyMeanGWS :</b> <td>calculates the daily medium temperature according the
|
|
|
+ specifications of german weather service (pls. see "get <name> versionNotes 2"). <br>
|
|
|
+ This variant uses aggregation "day" automatically. </td></tr>
|
|
|
+ <tr><td><b>avgTimeWeightMean :</b> </td><td>calculates a time weighted average mean value is calculated </td></tr>
|
|
|
</table>
|
|
|
</ul>
|
|
|
</li><br>
|
|
|
|
|
|
+ <a name="countEntriesDetail"></a>
|
|
|
+ <li><b>countEntriesDetail </b> - If set, the function countEntries creates a detailed report of counted datasets of
|
|
|
+ every reading. By default only the summary of counted datasets is reported.
|
|
|
+ </li> <br>
|
|
|
+
|
|
|
<a name="device"></a>
|
|
|
<li><b>device </b> - Selection of a particular device. <br>
|
|
|
You can specify device specifications (devspec). <br>
|
|
|
@@ -11648,7 +11685,8 @@ return $ret;
|
|
|
The global attrubute "archivesort" will be considered. </li> <br>
|
|
|
|
|
|
<a name="executeAfterProc"></a>
|
|
|
- <li><b>executeAfterProc </b> - you can specify a FHEM-command which should be executed <b>after dump</b>. <br>
|
|
|
+ <li><b>executeAfterProc </b> - you can specify a FHEM command or perl function which should be executed
|
|
|
+ <b>after command execution</b>. <br>
|
|
|
Perl functions have to be enclosed in {} .<br><br>
|
|
|
|
|
|
<ul>
|
|
|
@@ -11672,8 +11710,9 @@ sub adump {
|
|
|
</li>
|
|
|
|
|
|
<a name="executeBeforeProc"></a>
|
|
|
- <li><b>executeBeforeProc </b> - you can specify a FHEM-command which should be executed <b>before dump</b>. <br>
|
|
|
- Perl functions have to be enclosed in {} .<br><br>
|
|
|
+ <li><b>executeBeforeProc </b> - you can specify a FHEM command or perl function which should be executed
|
|
|
+ <b>before command execution</b>. <br>
|
|
|
+ Perl functions have to be enclosed in {} .<br><br>
|
|
|
|
|
|
<ul>
|
|
|
<b>Example:</b> <br><br>
|
|
|
@@ -11963,12 +12002,38 @@ sub bdump {
|
|
|
<br><br>
|
|
|
|
|
|
<a name="timestamp_begin"></a>
|
|
|
- <li><b>timestamp_begin </b> - begin of data selection (*) </li> <br>
|
|
|
+ <li><b>timestamp_begin </b> - begin of data selection </li> <br>
|
|
|
+
|
|
|
+ The format of timestamp is as used with DbLog "YYYY-MM-DD HH:MM:SS". For the attributes "timestamp_begin", "timestamp_end"
|
|
|
+ you can also use one of the following entries. The timestamp-attribute will be dynamically set to: <br><br>
|
|
|
+ <ul>
|
|
|
+ <b>current_year_begin</b> : matches "<current year>-01-01 00:00:00" <br>
|
|
|
+ <b>current_year_end</b> : matches "<current year>-12-31 23:59:59" <br>
|
|
|
+ <b>previous_year_begin</b> : matches "<previous year>-01-01 00:00:00" <br>
|
|
|
+ <b>previous_year_end</b> : matches "<previous year>-12-31 23:59:59" <br>
|
|
|
+ <b>current_month_begin</b> : matches "<current month first day> 00:00:00" <br>
|
|
|
+ <b>current_month_end</b> : matches "<current month last day> 23:59:59" <br>
|
|
|
+ <b>previous_month_begin</b> : matches "<previous month first day> 00:00:00" <br>
|
|
|
+ <b>previous_month_end</b> : matches "<previous month last day> 23:59:59" <br>
|
|
|
+ <b>current_week_begin</b> : matches "<first day of current week> 00:00:00" <br>
|
|
|
+ <b>current_week_end</b> : matches "<last day of current week> 23:59:59" <br>
|
|
|
+ <b>previous_week_begin</b> : matches "<first day of previous week> 00:00:00" <br>
|
|
|
+ <b>previous_week_end</b> : matches "<last day of previous week> 23:59:59" <br>
|
|
|
+ <b>current_day_begin</b> : matches "<current day> 00:00:00" <br>
|
|
|
+ <b>current_day_end</b> : matches "<current day> 23:59:59" <br>
|
|
|
+ <b>previous_day_begin</b> : matches "<previous day> 00:00:00" <br>
|
|
|
+ <b>previous_day_end</b> : matches "<previous day> 23:59:59" <br>
|
|
|
+ <b>current_hour_begin</b> : matches "<current hour>:00:00" <br>
|
|
|
+ <b>current_hour_end</b> : matches "<current hour>:59:59" <br>
|
|
|
+ <b>previous_hour_begin</b> : matches "<previous hour>:00:00" <br>
|
|
|
+ <b>previous_hour_end</b> : matches "<previous hour>:59:59" <br>
|
|
|
+ </ul>
|
|
|
+ <br><br>
|
|
|
|
|
|
<a name="timestamp_end"></a>
|
|
|
- <li><b>timestamp_end </b> - end of data selection. If not set the current date/time combination will be used. (*) </li> <br>
|
|
|
+ <li><b>timestamp_end </b> - end of data selection. If not set the current date/time combination will be used. </li> <br>
|
|
|
|
|
|
- (*) The format of timestamp is as used with DbLog "YYYY-MM-DD HH:MM:SS". For the attributes "timestamp_begin", "timestamp_end"
|
|
|
+ The format of timestamp is as used with DbLog "YYYY-MM-DD HH:MM:SS". For the attributes "timestamp_begin", "timestamp_end"
|
|
|
you can also use one of the following entries. The timestamp-attribute will be dynamically set to: <br><br>
|
|
|
<ul>
|
|
|
<b>current_year_begin</b> : matches "<current year>-01-01 00:00:00" <br>
|
|
|
@@ -12010,7 +12075,7 @@ sub bdump {
|
|
|
<br><br>
|
|
|
|
|
|
<a name="timeDiffToNow"></a>
|
|
|
- <li><b>timeDiffToNow </b> - the <b>begin</b> of data selection will be set to the timestamp <b>"<current time> -
|
|
|
+ <li><b>timeDiffToNow </b> - the <b>begin time </b> of data selection will be set to the timestamp <b>"<current time> -
|
|
|
<timeDiffToNow>"</b> dynamically (e.g. if set to 86400, the last 24 hours are considered by data
|
|
|
selection). The time period will be calculated dynamically at execution time. </li> <br>
|
|
|
|
|
|
@@ -12029,15 +12094,39 @@ sub bdump {
|
|
|
<code>attr <name> timeDiffToNow y:1.5</code> <br>
|
|
|
# the start time is set to "current time - 1.5 years" <br>
|
|
|
</ul>
|
|
|
- <br><br>
|
|
|
+ <br>
|
|
|
+
|
|
|
+ If both attributes "timeDiffToNow" and "timeOlderThan" are set, the selection
|
|
|
+ period will be calculated between of these timestamps dynamically.
|
|
|
+ <br><br>
|
|
|
|
|
|
<a name="timeOlderThan"></a>
|
|
|
- <li><b>timeOlderThan </b> - the <b>end</b> of data selection will be set to the timestamp <b>"<aktuelle Zeit> -
|
|
|
+ <li><b>timeOlderThan </b> - the <b>end time</b> of data selection will be set to the timestamp <b>"<aktuelle Zeit> -
|
|
|
<timeOlderThan>"</b> dynamically. Always the datasets up to timestamp
|
|
|
"<current time> - <timeOlderThan>" will be considered (e.g. if set to
|
|
|
86400, all datasets older than one day are considered). The time period will be calculated dynamically at
|
|
|
- execution time. <br>
|
|
|
- The valid input format for attribute "timeOlderThan" is identical to attribute "timeDiffToNow". </li> <br>
|
|
|
+ execution time. </li> <br>
|
|
|
+
|
|
|
+ <ul>
|
|
|
+ <b>Examples for input format:</b> <br>
|
|
|
+ <code>attr <name> timeOlderThan 86400</code> <br>
|
|
|
+ # the selection end time is set to "current time - 86400 seconds" <br>
|
|
|
+ <code>attr <name> timeOlderThan d:2 h:3 m:2 s:10</code> <br>
|
|
|
+ # the selection end time is set to "current time - 2 days 3 hours 2 minutes 10 seconds" <br>
|
|
|
+ <code>attr <name> timeOlderThan m:600</code> <br>
|
|
|
+ # the selection end time is set to "current time - 600 minutes" gesetzt <br>
|
|
|
+ <code>attr <name> timeOlderThan h:2.5</code> <br>
|
|
|
+ # the selection end time is set to "current time - 2,5 hours" <br>
|
|
|
+ <code>attr <name> timeOlderThan y:1 h:2.5</code> <br>
|
|
|
+ # the selection end time is set to "current time - 1 year and 2,5 hours" <br>
|
|
|
+ <code>attr <name> timeOlderThan y:1.5</code> <br>
|
|
|
+ # the selection end time is set to "current time - 1.5 years" <br>
|
|
|
+ </ul>
|
|
|
+ <br>
|
|
|
+
|
|
|
+ If both attributes "timeDiffToNow" and "timeOlderThan" are set, the selection
|
|
|
+ period will be calculated between of these timestamps dynamically.
|
|
|
+ <br><br>
|
|
|
|
|
|
<a name="timeout"></a>
|
|
|
<li><b>timeout </b> - set the timeout-value for Blocking-Call Routines in background in seconds (default 86400) </li> <br>
|
|
|
@@ -12086,8 +12175,9 @@ sub bdump {
|
|
|
|
|
|
<a name="valueFilter"></a>
|
|
|
<li><b>valueFilter </b> - Regular expression to filter datasets within particular functions. The regex is
|
|
|
- applied to the whole selected dataset (inclusive Device, Reading and so on).
|
|
|
- Please compare to explanations of relevant set-commands. </li> <br>
|
|
|
+ applied to a particular field or to the whole selected dataset (inclusive Device, Reading and
|
|
|
+ so on).
|
|
|
+ Please consider the explanations within the set-commands. </li> <br>
|
|
|
|
|
|
</ul>
|
|
|
</ul></ul>
|
|
|
@@ -25095,6 +25185,13 @@ Step C0 C1<br>
|
|
|
<li><b>set <name> on-for-timer [{ <Seconds> | <u>forever</u> | off }]</b><br/>
|
|
|
Set timer for display. Default is forever.
|
|
|
</li><br/>
|
|
|
+ <li><b>set <name> photo</b><br/>
|
|
|
+ Take a picture with device cam. Setting motion detection must be enabled. Picture
|
|
|
+ can be viewed in remote admin interface under device info.
|
|
|
+ </li><br/>
|
|
|
+ <li><b>set <name> playSound <url> [loop]</b><br/>
|
|
|
+ Play sound from URL.
|
|
|
+ </li><br/>
|
|
|
<li><b>set <name> restart</b><br/>
|
|
|
Restart Fully.
|
|
|
</li><br/>
|
|
|
@@ -25117,9 +25214,16 @@ Step C0 C1<br>
|
|
|
<li><b>set <name> startURL <URL></b><br/>
|
|
|
Show this URL when FULLY starts.<br/>
|
|
|
</li><br/>
|
|
|
+ <li><b>set <name> stopSound</b><br/>
|
|
|
+ Stop playback of sound if playback has been started with option <i>loop</i>.
|
|
|
+ </li><br/>
|
|
|
<li><b>set <name> url [<URL>]</b><br/>
|
|
|
Navigate to <i>URL</i>. If no URL is specified navigate to start URL.
|
|
|
</li><br/>
|
|
|
+ <li><b>set <name> volume <level> <stream></b><br/>
|
|
|
+ Set audio volume. Range of parameter <i>level</i> is 0-100, range of parameter
|
|
|
+ <i>stream</i> is 1-10.
|
|
|
+ </li><br/>
|
|
|
</ul>
|
|
|
<br/>
|
|
|
|
|
|
@@ -56455,12 +56559,16 @@ Here an event is defined, where in time of 2 seconds the Mute-Button has to be p
|
|
|
</pre>
|
|
|
|
|
|
The password length has a maximum of 20 characters. <br>
|
|
|
- The operator can, dependend on what functions are planned to execute, create an user in DSM respectively in Synology Surveillance Station as well. <br>
|
|
|
- If the user is member of admin-group, he has access to all module functions. Without this membership the user can only execute functions with lower need of rights. <br>
|
|
|
+ The operator can, dependend on what functions are planned to execute, create an user in DSM respectively in Synology
|
|
|
+ Surveillance Station as well. <br>
|
|
|
+ If the user is member of admin-group, he has access to all module functions. Without this membership the user can only
|
|
|
+ execute functions with lower need of rights. <br>
|
|
|
The required minimum rights to execute functions are listed in a table further down. <br>
|
|
|
|
|
|
- Alternatively to DSM-user a user created in SVS can be used. Also in that case a user of type "manager" has the right to execute all functions, <br>
|
|
|
- whereat the access to particular cameras can be restricted by the privilege profile (please see help function in SVS for details). <br>
|
|
|
+ Alternatively to DSM-user a user created in SVS can be used. Also in that case a user of type "manager" has the right to
|
|
|
+ execute all functions, <br>
|
|
|
+ whereat the access to particular cameras can be restricted by the privilege profile (please see help function in SVS for
|
|
|
+ details). <br>
|
|
|
As best practice it is proposed to create an user in DSM as well as in SVS too: <br><br>
|
|
|
|
|
|
<ul>
|
|
|
@@ -56469,13 +56577,16 @@ Here an event is defined, where in time of 2 seconds the Mute-Button has to be p
|
|
|
</ul>
|
|
|
<br>
|
|
|
|
|
|
- Using the <a href="#SSCamattr">Attribute</a> "session" can be selected, if the session should be established to DSM or the SVS instead. <br>
|
|
|
- If the session will be established to DSM, SVS Web-API methods are available as well as further API methods of other API's what possibly needed for processing. <br><br>
|
|
|
+ Using the <a href="#SSCamattr">Attribute</a> "session" can be selected, if the session should be established to DSM or the
|
|
|
+ SVS instead. Further informations about user management in SVS are available by execute
|
|
|
+ "get <name> versionNotes 5".<br>
|
|
|
+ If the session will be established to DSM, SVS Web-API methods are available as well as further API methods of other API's
|
|
|
+ what possibly needed for processing. <br><br>
|
|
|
|
|
|
After device definition the default is "login to DSM", that means credentials with admin rights can be used to test all camera-functions firstly. <br>
|
|
|
After this the credentials can be switched to a SVS-session with a restricted privilege profile as needed on dependency what module functions are want to be executed. <br><br>
|
|
|
|
|
|
- The following list shows the minimum rights what the particular module function needs. <br><br>
|
|
|
+ The following list shows the <b>minimum rights</b> that the particular module function needs. <br><br>
|
|
|
<ul>
|
|
|
<table>
|
|
|
<colgroup> <col width=20%> <col width=80%> </colgroup>
|
|
|
@@ -56488,7 +56599,7 @@ Here an event is defined, where in time of 2 seconds the Mute-Button has to be p
|
|
|
<tr><td><li>set ... expmode </td><td> session: ServeillanceStation - manager </li></td></tr>
|
|
|
<tr><td><li>set ... extevent </td><td> session: DSM - user as member of admin-group </li></td></tr>
|
|
|
<tr><td><li>set ... goPreset </td><td> session: ServeillanceStation - observer with privilege objective control of camera </li></td></tr>
|
|
|
- <tr><td><li>set ... homeMode </td><td> ssession: ServeillanceStation - observer with privilege Home Mode switch </li></td></tr>
|
|
|
+ <tr><td><li>set ... homeMode </td><td> ssession: ServeillanceStation - observer with privilege Home Mode switch (valid for <b>SVS-device ! </b>) </li></td></tr>
|
|
|
<tr><td><li>set ... motdetsc </td><td> session: ServeillanceStation - manager </li></td></tr>
|
|
|
<tr><td><li>set ... runPatrol </td><td> session: ServeillanceStation - observer with privilege objective control of camera </li></td></tr>
|
|
|
<tr><td><li>set ... goAbsPTZ </td><td> session: ServeillanceStation - observer with privilege objective control of camera </li></td></tr>
|
|
|
@@ -56511,11 +56622,13 @@ Here an event is defined, where in time of 2 seconds the Mute-Button has to be p
|
|
|
<tr><td><li>get ... stmUrlPath </td><td> session: ServeillanceStation - observer </li></td></tr>
|
|
|
</table>
|
|
|
</ul>
|
|
|
- <br><br>
|
|
|
+ <br><br>
|
|
|
+ </ul>
|
|
|
|
|
|
- <a name="SSCam_HTTPTimeout"></a>
|
|
|
- <b>HTTP-Timeout Settings</b><br><br>
|
|
|
+<a name="SSCam_HTTPTimeout"></a>
|
|
|
+<b>HTTP-Timeout Settings</b><br><br>
|
|
|
|
|
|
+ <ul>
|
|
|
All functions of SSCam use HTTP-calls to SVS Web API. <br>
|
|
|
The default-value of HTTP-Timeout amounts 4 seconds. You can set the <a href="#SSCamattr">attribute</a> "httptimeout" > 0 to adjust the value as needed in your technical environment. <br>
|
|
|
|
|
|
@@ -57230,9 +57343,19 @@ http(s)://<hostname><port>/webapi/entry.cgi?api=SYNO.SurveillanceSta
|
|
|
|
|
|
Determines common informations about the installed SVS-version and other properties. <br>
|
|
|
</ul>
|
|
|
- <br><br>
|
|
|
+ <br><br>
|
|
|
+
|
|
|
+ <ul>
|
|
|
+ <li><b> get <name> versionNotes [hints | rel | <key>] </b> (valid for CAM/SVS)</li> <br>
|
|
|
|
|
|
+ Shows realease informations and/or hints about the module. It contains only main release informations for module users. <br>
|
|
|
+ If no options are specified, both release informations and hints will be shown. "rel" shows only release informations and
|
|
|
+ "hints" shows only hints. By the <key>-specification only the hint with the specified number is shown.
|
|
|
+ </ul>
|
|
|
+ <br><br>
|
|
|
|
|
|
+
|
|
|
+ <a name="SSCamPolling"></a>
|
|
|
<b>Polling of Camera/SVS-Properties</b><br><br>
|
|
|
<ul>
|
|
|
Retrieval of Camera-Properties can be done automatically if the attribute "pollcaminfoall" will be set to a value > 10. <br>
|
|
|
@@ -57297,12 +57420,15 @@ http(s)://<hostname><port>/webapi/entry.cgi?api=SYNO.SurveillanceSta
|
|
|
|
|
|
<ul>
|
|
|
<ul>
|
|
|
+ <a name="debugactivetoken"></a>
|
|
|
<li><b>debugactivetoken</b><br>
|
|
|
if set the state of active token will be logged - only for debugging, don't use it in normal operation ! </li><br>
|
|
|
|
|
|
+ <a name="disable"></a>
|
|
|
<li><b>disable</b><br>
|
|
|
deactivates the device definition </li><br>
|
|
|
|
|
|
+ <a name="genericStrmHtmlTag"></a>
|
|
|
<li><b>genericStrmHtmlTag</b><br>
|
|
|
This attribute contains HTML-Tags for video-specification in a Streaming-Device of type "generic".
|
|
|
(see also "set <name> createStreamDev generic") <br><br>
|
|
|
@@ -57319,10 +57445,12 @@ attr <name> genericStrmHtmlTag <video $HTMLATTR controls autoplay>
|
|
|
<br><br>
|
|
|
</li>
|
|
|
|
|
|
+ <a name="httptimeout"></a>
|
|
|
<li><b>httptimeout</b><br>
|
|
|
Timeout-Value of HTTP-Calls to Synology Surveillance Station, Default: 4 seconds (if httptimeout = "0"
|
|
|
or not set) </li><br>
|
|
|
|
|
|
+ <a name="htmlattr"></a>
|
|
|
<li><b>htmlattr</b><br>
|
|
|
additional specifications to inline oictures to manipulate the behavior of stream, e.g. size of the image. </li><br>
|
|
|
|
|
|
@@ -57332,32 +57460,40 @@ attr <name> genericStrmHtmlTag <video $HTMLATTR controls autoplay>
|
|
|
</ul>
|
|
|
<br>
|
|
|
|
|
|
+ <a name="livestreamprefix"></a>
|
|
|
<li><b>livestreamprefix</b><br>
|
|
|
overwrites the specifications of protocol, servername and port for further use of the livestream address, e.g.
|
|
|
as an link to external use. It has to be specified as "http(s)://<servername>:<port>" </li><br>
|
|
|
|
|
|
+ <a name="loginRetries"></a>
|
|
|
<li><b>loginRetries</b><br>
|
|
|
- set the amount of login-repetitions in case of failure (default = 1) </li><br>
|
|
|
+ set the amount of login-repetitions in case of failure (default = 3) </li><br>
|
|
|
|
|
|
+ <a name="noQuotesForSID"></a>
|
|
|
<li><b>noQuotesForSID</b><br>
|
|
|
- this attribute may be helpfull in some cases to avoid errormessage "402 - permission denied" and makes login
|
|
|
+ this attribute may be helpful in some cases to avoid errormessage "402 - permission denied" and makes login
|
|
|
possible. </li><br>
|
|
|
|
|
|
+ <a name="pollcaminfoall"></a>
|
|
|
<li><b>pollcaminfoall</b><br>
|
|
|
Interval of automatic polling the Camera properties (if <= 10: no polling, if > 10: polling with interval) </li><br>
|
|
|
|
|
|
+ <a name="pollnologging"></a>
|
|
|
<li><b>pollnologging</b><br>
|
|
|
"0" resp. not set = Logging device polling active (default), "1" = Logging device polling inactive</li><br>
|
|
|
-
|
|
|
+
|
|
|
+ <a name="ptzPanel_Home"></a>
|
|
|
<li><b>ptzPanel_Home</b><br>
|
|
|
In the PTZ-control panel the Home-Icon (in attribute "ptzPanel_row02") is automatically assigned to the value of
|
|
|
Reading "PresetHome".
|
|
|
With "ptzPanel_Home" you can change the assignment to another preset from the available Preset list. </li><br>
|
|
|
-
|
|
|
+
|
|
|
+ <a name="ptzPanel_iconPath"></a>
|
|
|
<li><b>ptzPanel_iconPath</b><br>
|
|
|
Path for icons used in PTZ-control panel, default is "www/images/sscam".
|
|
|
The attribute value will be used for all icon-files except *.svg. </li><br>
|
|
|
|
|
|
+ <a name="ptzPanel_iconPrefix"></a>
|
|
|
<li><b>ptzPanel_iconPrefix</b><br>
|
|
|
Prefix for icons used in PTZ-control panel, default is "black_btn_".
|
|
|
The attribute value will be used for all icon-files except *.svg. <br>
|
|
|
@@ -57365,6 +57501,7 @@ attr <name> genericStrmHtmlTag <video $HTMLATTR controls autoplay>
|
|
|
attributes "ptzPanel_row[00-09]" just with the subsequent part of name, e.g. "CAMDOWN.png".
|
|
|
</li><br>
|
|
|
|
|
|
+ <a name="ptzPanel_row00"></a>
|
|
|
<li><b>ptzPanel_row[00-09] <command>:<icon>,<command>:<icon>,... </b><br>
|
|
|
For PTZ-cameras the attributes "ptzPanel_row00" to "ptzPanel_row04" are created automatically for usage by
|
|
|
the PTZ-control panel. <br>
|
|
|
@@ -57375,9 +57512,8 @@ attr <name> genericStrmHtmlTag <video $HTMLATTR controls autoplay>
|
|
|
If needed the assignment for Home-button in "ptzPanel_row02" can be changed by attribute "ptzPanel_Home". <br>
|
|
|
The icons are searched in path "ptzPanel_iconPath". The value of "ptzPanel_iconPrefix" is prepend to the icon filename.
|
|
|
Own extensions of the PTZ-control panel can be done using the attributes "ptzPanel_row05" to "ptzPanel_row09".
|
|
|
- For creation of own icons a template is provided in the SVN:
|
|
|
- <a href="https://svn.fhem.de/trac/browser/trunk/fhem/contrib/sscam">contrib/sscam/black_btn_CAM_Template.pdn</a>. This
|
|
|
- template can be edited by e.g. Paint.Net. <br><br>
|
|
|
+ For creation of own icons a template is provided in the SVN. Further information can be get by "get <name> versionNotes 2".
|
|
|
+ <br><br>
|
|
|
|
|
|
<b>Note:</b> <br>
|
|
|
For an empty field please use ":CAMBLANK.png" respectively ":CAMBLANK.png,:CAMBLANK.png,:CAMBLANK.png,..." for an empty
|
|
|
@@ -57392,25 +57528,33 @@ attr <name> genericStrmHtmlTag <video $HTMLATTR controls autoplay>
|
|
|
<br>
|
|
|
</li><br>
|
|
|
|
|
|
+ <a name="ptzPanel_use"></a>
|
|
|
<li><b>ptzPanel_use</b><br>
|
|
|
Switch the usage of a PTZ-control panel in detail view respectively a created StreamDevice off or on
|
|
|
(default: on). </li><br>
|
|
|
|
|
|
+ <a name="rectime"></a>
|
|
|
<li><b>rectime</b><br>
|
|
|
determines the recordtime when a recording starts. If rectime = 0 an endless recording will be started. If
|
|
|
it isn't defined, the default recordtime of 15s is activated </li><br>
|
|
|
|
|
|
+ <a name="recextend"></a>
|
|
|
<li><b>recextend</b><br>
|
|
|
"rectime" of a started recording will be set new. Thereby the recording time of the running recording will be
|
|
|
extended </li><br>
|
|
|
|
|
|
+ <a name="session"></a>
|
|
|
<li><b>session</b><br>
|
|
|
selection of login-Session. Not set or set to "DSM" -> session will be established to DSM (Sdefault).
|
|
|
- "SurveillanceStation" -> session will be established to SVS </li><br>
|
|
|
+ "SurveillanceStation" -> session will be established to SVS. <br>
|
|
|
+ For establish a sesion with Surveillance Station you have to create a user with suitable privilege profile in SVS.
|
|
|
+ If you need more infomations please execute "get <name> versionNotes 5". </li><br>
|
|
|
|
|
|
+ <a name="simu_SVSversion"></a>
|
|
|
<li><b>simu_SVSversion</b><br>
|
|
|
simulates another SVS version. (only a lower version than the installed one is possible !) </li><br>
|
|
|
-
|
|
|
+
|
|
|
+ <a name="snapGalleryBoost"></a>
|
|
|
<li><b>snapGalleryBoost</b><br>
|
|
|
If set, the last snapshots (default 3) will be retrieved by Polling, will be stored in the FHEM-servers main memory
|
|
|
and can be displayed by the "set/get ... snapGallery" command. <br>
|
|
|
@@ -57418,9 +57562,11 @@ attr <name> genericStrmHtmlTag <video $HTMLATTR controls autoplay>
|
|
|
If the attribute is set, you can't specify arguments in addition to the "set/get ... snapGallery" command.
|
|
|
(see also attribut "snapGalleryNumber") </li><br>
|
|
|
|
|
|
+ <a name="snapGalleryColumns"></a>
|
|
|
<li><b>snapGalleryColumns</b><br>
|
|
|
The number of snapshots which shall appear in one row of the gallery popup (default 3). </li><br>
|
|
|
|
|
|
+ <a name="snapGalleryHtmlAttr"></a>
|
|
|
<li><b>snapGalleryHtmlAttr</b><br>
|
|
|
the image parameter can be controlled by this attribute. <br>
|
|
|
If the attribute isn't set, the value of attribute "htmlattr" will be used. <br>
|
|
|
@@ -57432,26 +57578,32 @@ attr <name> genericStrmHtmlTag <video $HTMLATTR controls autoplay>
|
|
|
</ul>
|
|
|
<br>
|
|
|
</li>
|
|
|
-
|
|
|
+
|
|
|
+ <a name="snapGalleryNumber"></a>
|
|
|
<li><b>snapGalleryNumber</b><br>
|
|
|
The number of snapshots to retrieve (default 3). </li><br>
|
|
|
|
|
|
+ <a name="snapGallerySize"></a>
|
|
|
<li><b>snapGallerySize</b><br>
|
|
|
By this attribute the quality of the snapshot images can be controlled (default "Icon"). <br>
|
|
|
If mode "Full" is set, the images are retrieved with their original available resolution. That requires more ressources
|
|
|
and may slow down the display. By setting attribute "snapGalleryBoost=1" the display may accelerated, because in that case
|
|
|
the images will be retrieved by continuous polling and need only bring to display. </li><br>
|
|
|
|
|
|
+ <a name="showStmInfoFull"></a>
|
|
|
<li><b>showStmInfoFull</b><br>
|
|
|
additional stream informations like LiveStreamUrl, StmKeyUnicst, StmKeymjpegHttp will be created </li><br>
|
|
|
|
|
|
+ <a name="showPassInLog"></a>
|
|
|
<li><b>showPassInLog</b><br>
|
|
|
if set the used password will be shown in logfile with verbose 4. (default = 0) </li><br>
|
|
|
|
|
|
+ <a name="videofolderMap"></a>
|
|
|
<li><b>videofolderMap</b><br>
|
|
|
replaces the content of reading "VideoFolder", Usage if e.g. folders are mountet with different names than original
|
|
|
(SVS) </li><br>
|
|
|
|
|
|
+ <a name="verbose"></a>
|
|
|
<li><b>verbose</b></li><br>
|
|
|
|
|
|
<ul>
|
|
|
@@ -59575,6 +59727,262 @@ set Siro1 set_favorite programs the current roll position as hardw
|
|
|
</ul>
|
|
|
</ul>
|
|
|
|
|
|
+<p><a name="SmarterCoffee"></a>
|
|
|
+<h3>SmarterCoffee</h3>
|
|
|
+<div class='langLinks'>[EN <a href='commandref_DE.html#SmarterCoffee'>DE</a>]</div>
|
|
|
+<ul>
|
|
|
+ Integrates the equally called Wi-Fi coffee machine (<code>http://smarter.am/</code>) with FHEM.
|
|
|
+ <br><br>
|
|
|
+ <i>Prerequisite</i>:<br>
|
|
|
+ Make sure the machine can be controlled by the smarter mobile app when both are connected to the same network as fhem.<br>
|
|
|
+ If in doubt check the official documentation or official support forum to get help with integrating the coffee machine into your network.
|
|
|
+</ul>
|
|
|
+<br>
|
|
|
+
|
|
|
+<a name="SmarterCoffeedefine"></a>
|
|
|
+<b>Define</b>
|
|
|
+<ul>
|
|
|
+ <code>define <name> SmarterCoffee (<hostname>)</code>
|
|
|
+ <br><br>
|
|
|
+ Hostname is optional, if omitted the name is auto-detected via UDP broadcast.
|
|
|
+ <br><br>
|
|
|
+ Examples:<ul>
|
|
|
+ <li><code>define coffee-machine SmarterCoffee</code><br>
|
|
|
+ Connects with the first coffee machine that answers the UDP broadcast.</li><br>
|
|
|
+ <li><code>define coffee-machine SmarterCoffee smarter-coffee.fritz.box</code><br>
|
|
|
+ Connects with the coffee machine at address 'smarter-coffee.fritz.box'.</li><br>
|
|
|
+ <li><code>define coffee-machine SmarterCoffee 192.168.2.56:2081</code><br>
|
|
|
+ Connects with the coffee machine at '192.168.2.56' using port 2081 (= default)</li>
|
|
|
+ </ul>
|
|
|
+</ul>
|
|
|
+<br>
|
|
|
+
|
|
|
+<a name="SmarterCoffeereadings"></a>
|
|
|
+<b>Readings</b><br>
|
|
|
+<ul>
|
|
|
+ <li>
|
|
|
+ <code>state</code><br>
|
|
|
+ Device state, can be one of:<ul>
|
|
|
+ <li><code>disconnected</code>: No connection to coffee machine.</li>
|
|
|
+ <li><code>opened / connected</code>: Intermediate states after connection has been established but before the machine's state is known.</li>
|
|
|
+ <li><code>invalid</code>: The connected device is not a coffee machine.</li>
|
|
|
+ <li><code>ready</code>: Ready to start brewing.</li>
|
|
|
+ <li><code>grinding</code>: Grinding coffee.</li>
|
|
|
+ <li><code>brewing</code>: Brewing coffee.</li>
|
|
|
+ <li><code>done</code>: Done brewing.</li>
|
|
|
+ <li><code>heating</code>: Keeping coffee warm or reheating.</li>
|
|
|
+ <li><code>maintenance</code>: Maintenance is needed to get ready for brewing (e.g. water or carafe is missing).</li>
|
|
|
+ </ul>
|
|
|
+ </li><br>
|
|
|
+ <li>
|
|
|
+ <code>hotplate_on_for_minutes</code><br>
|
|
|
+ Shows the number of minutes that the hotplate will be on when it was turned on via "<code>set <name> hotplate</code>"
|
|
|
+ or "<code>set <name> brew</code>".</li><br>
|
|
|
+ <li>
|
|
|
+ <code>carafe</code><br>
|
|
|
+ One of "<code>present</code>" or "<code>missing</code>" as the carafe is detected as being present or not.<br>
|
|
|
+ (<code>state</code> <code>ready</code> turns to <code>maintenance</code> when carafe is missing and <code>carafe_required</code> is <code>yes</code>)</li><br>
|
|
|
+ <li>
|
|
|
+ <code>carafe_required</code><br>
|
|
|
+ Is "<code>yes</code>" or "<code>no</code>" as the carafe is required to start brewing or not.<br>
|
|
|
+ This option can be configured via the smarter mobile app. Read disclaimer before turning off carafe detection.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>cups_max</code><br>
|
|
|
+ The estimated maximum brewable cups when taking current water level into account.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>cups_single_mode</code><br>
|
|
|
+ Is "<code>yes</code>" or "<code>no</code>" as the single cup mode is active or not.<br>
|
|
|
+ This option can be configured via the smarter mobile app.
|
|
|
+ When enabled "<code>set <name> brew</code>" will not enable the hotplate and "<code>cups_max</code>" is limited to <code>3</code>.
|
|
|
+ In single cup mode, cups [1,2,3] is used for one [small,medium,large] cup.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>water</code> and <code>water_level</code><br>
|
|
|
+ Is [<code>none, low, half, full</code>] and [<code>0, 25, 50, 100</code>] indicating the amount of water that remains in the tank.<br>
|
|
|
+ (<code>state</code> <code>ready</code> turns to <code>maintenance</code> when <code>water_level</code> is "<code>0</code>")</li><br>
|
|
|
+ <li>
|
|
|
+ <code>last_command.*</code><br>
|
|
|
+ Is updated with the last executed <code>set</code> or <code>get</code> command string, including device response and success information.</li><br>
|
|
|
+ <li>
|
|
|
+ Further readings match <code>set</code> commands and reflect the corresponding machine state. See <i>Set</i> section below.</li><br>
|
|
|
+</ul>
|
|
|
+
|
|
|
+<a name="SmarterCoffeeget"></a>
|
|
|
+<b>Get</b><br>
|
|
|
+<ul>
|
|
|
+ <li>
|
|
|
+ <code>get <name> info</code><br>
|
|
|
+ Retrieves firmware & device type information and updates internals.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>get <name> carafe_required_status</code><br>
|
|
|
+ Retrieves whether carafe is required for brewing and updates reading "carafe_required".</li><br>
|
|
|
+ <li>
|
|
|
+ <code>get <name> cups_single_mode_status</code><br>
|
|
|
+ Retrieves whether single cup mode is active and updates reading "cups_single_mode".</li><br>
|
|
|
+ <li>
|
|
|
+ <code>get <name> get_defaults</code><br>
|
|
|
+ Retrieves and applies previously set machine defaults. Triggers the event "defaults" after retrieval but before applying them.</li><br>
|
|
|
+</ul>
|
|
|
+
|
|
|
+<a name="SmarterCoffeeset"></a>
|
|
|
+<b>Set</b><br>
|
|
|
+<ul>
|
|
|
+ <li>
|
|
|
+ <code>set <name> brew</code><br>
|
|
|
+ Start brewing with settings displayed in readings and "<code>default-hotplate-on-for-minutes</code>" for hotplate.</li>
|
|
|
+ <li>
|
|
|
+ <code>set <name> brew current</code><br>
|
|
|
+ Start brewing with current machine settings.</li>
|
|
|
+ <li>
|
|
|
+ <code>set <name> brew [1 - 12] ([weak, medium, strong, extra]) ([5-40]) ([enabled, disabled])</code><br>
|
|
|
+ Start brewing the specified amount of cups at optionally specified strength, hotplate and grinder with non-specified settings used from readings
|
|
|
+ and "<code>default-hotplate-on-for-minutes</code>" for hotplate.
|
|
|
+ <p></p>
|
|
|
+ E.g. "<code>set <name> brew 5 medium</code>" brews 5 cups of medium coffee reusing current hotplate and grinder settings.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>set <name> defaults ([1 - 12]) ([weak, medium, strong]) ([5-40]) ([enabled, disabled])</code><br>
|
|
|
+ Sets the machine defaults to the current settings optionally overridden by specified amount of cups, strength, hotplate and grinder.
|
|
|
+ Non-specified settings are used from readings and "<code>default-hotplate-on-for-minutes</code>" for hotplate.<br>
|
|
|
+ Note: Machine defaults are applied by the coffee machine after every brew and when stopping or turning off.
|
|
|
+ Readings are updated accordingly when defaults are applied.
|
|
|
+ <p></p>
|
|
|
+ E.g. "<code>set <name> defaults 5 medium</code>" sets defaults to 5 cups of medium coffee and reuses current hotplate and grinder settings
|
|
|
+ as future defaults.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>set <name> stop</code><br>
|
|
|
+ Stop brewing and disable hotplate if on.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>set <name> strength [weak, medium, strong, extra]</code><br>
|
|
|
+ Toggles the strength via the amount of coffee beans to use per cup when grinding.
|
|
|
+ <p></p>
|
|
|
+ The strength "<code>extra</code>" is special in that it is not natively supported by the machine itself.
|
|
|
+ To brew coffee with "extra" strength a custom sequence similar to the following is started:<br>
|
|
|
+ <code>set <name> brew <cups + 1> strong on enabled ;; sleep <cups * 1.5> ;; set <name> stop ;; set <name> brew <cups> on disabled</code>.<br>
|
|
|
+ See also attributes "<code>strength-extra-percent</code>" and "<code>strength-coffee-weights</code>" which control the calculation
|
|
|
+ of actual strength and cup counts.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>set <name> grinder [enabled, disabled]</code><br>
|
|
|
+ Toggles whether grinder is used when brewing coffee.
|
|
|
+ Ground coffee has to be added manually to the filter and strength settings are ignored when grinder is disabled.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>set <name> cups [1 - 12]</code><br>
|
|
|
+ Toggles the amount of cups (~100ml) to brew.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>set <name> [1 - 12]-cups</code><br>
|
|
|
+ Is an alias to "<code>set <name> brew [1 - 12]</code>".
|
|
|
+ This adds support for web commands like "8-cups" and "3-cups,strong".</li><br>
|
|
|
+ <li>
|
|
|
+ <code>set <name> hotplate <command></code><br>
|
|
|
+ Toggles the hotplate that keeps the coffee warm after brewing.
|
|
|
+ <br><br>
|
|
|
+ <command> is one of:<ul>
|
|
|
+ <li><code>on</code><br>On for "<code>default-hotplate-on-for-minutes</code>" minutes (defaults to 15 minutes)</li>
|
|
|
+ <li><code>on [5 - 40]</code><br>On for the specified amount of minutes</li>
|
|
|
+ <li><code>off</code></li>
|
|
|
+ </ul>
|
|
|
+ </li><br>
|
|
|
+ <li>
|
|
|
+ <code>set <name> hotplate_on_for_minutes [5 - 40]</code><br>
|
|
|
+ Is an alias to "<code>set <name> hotplate on [5 - 40]</code>".</li><br>
|
|
|
+ <li>
|
|
|
+ <code>set <name> reconnect</code><br>
|
|
|
+ Disconnects, optionally runs discovery (if hostname or address was omitted in the device definition) and reconnects.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>set <name> reset</code><br>
|
|
|
+ Resets machine to factory default, excluding WLAN settings.</li><br>
|
|
|
+</ul>
|
|
|
+
|
|
|
+<a name="SmarterCoffeeattr"></a>
|
|
|
+<b>Attributes</b><br>
|
|
|
+<ul>
|
|
|
+ <li>
|
|
|
+ <code>attr <name> devStateIcon { SmarterCoffee::GetDevStateIcon($name) }</code>
|
|
|
+ <br><br>
|
|
|
+ The function <code>SmarterCoffee::GetDevStateIcon($name[, "...colors..."])</code> renders a custom dev state icon that displays
|
|
|
+ the machine states (ready, brewing, done) and shows information on carafe, hotplate and water level.
|
|
|
+ <br><br>
|
|
|
+ The icon is monochrome using a default color that may change to highlight states: ready, brewing, done.
|
|
|
+ Built-in colors can be adjusted with the second parameter of <code>SmarterCoffee::GetDevStateIcon</code>.<br>
|
|
|
+ E.g. using "<code>attr <name> devStateIcon { SmarterCoffee::GetDevStateIcon($name, '#7b7b7b green chocolate #336699' }</code>"
|
|
|
+ sets colors for default, ready, brewing and done.
|
|
|
+ <br><br>
|
|
|
+ Colors are specified as HTML color values delimited by whitespace using a fixed order of "default ready brewing done".
|
|
|
+ Use '-' or '0' to substitute a color with the built-in or the default color within the color sequence. E.g. a color sequence of 'blue - 0 0' uses
|
|
|
+ blue for all states except "ready" which uses the built-in color green.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>attr <name> default-hotplate-on-for-minutes 15</code><br>
|
|
|
+ Defines how long the hotplate is heating coffee when turning it on without specifying a time or when brewing coffee without
|
|
|
+ specifying a valid time value for hotplate.<br>
|
|
|
+ Values of 15, 5 or 40 minutes are used as this attribute is not specified, invalid or greater than 40 (5 <= x <= 40, with x defaulting to 15).
|
|
|
+ <br><br>
|
|
|
+ In addition to a fixed value, the hotplate can also be turned on relative to the number of cups that are brewed.
|
|
|
+ E.g. setting a value of "<code>15 5=20 10=35</code>" means: 15 from 1 to 4 cups, 20 from 5 cups and 35 from 10 cups.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>attr <name> ignore-max-cups [1, 0]</code><br>
|
|
|
+ Toggles whether the reading "<code>cups_max</code>" influences the state "<code>ready</code>".
|
|
|
+ By default "<code>attr <name> ignore-max-cups 1</code>" is assumed which means that the state "<code>ready</code>" is not
|
|
|
+ related to "<code>cups_max</code>" if this attribute is not set. Set this attribute to "0" if the state should turn to "<code>maintenance</code>"
|
|
|
+ when the selected cup count is larger than "<code>cups_max</code>".</li><br>
|
|
|
+ <li>
|
|
|
+ <code>attr <name> set-on-brews-coffee [0, 1]</code><br>
|
|
|
+ Toggles whether the command "<code>set <name> on</code>" is an alias to "<code>set <name> brew</code>".
|
|
|
+ By default this is disabled to avoid accidental coffee brewing.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>attr <name> strength-extra-percent 1.4</code><br>
|
|
|
+ Specifies the percentage of coffee to use relative to strength "<code>strong</code>" when brewing coffee with <code>extra</code> strength.
|
|
|
+ A value of "<code>1.4</code>" brews coffee that is 140% the strength of "<code>strong</code>" respectively "<code>0.6</code>" brews coffee that
|
|
|
+ is 60% the strength. Setting <code>strength-extra-percent</code> to <code>0</code> disables support for extra strength.
|
|
|
+ <br><br>
|
|
|
+ Note: Brewing coffee with <code>extra</code> strength uses strengths and cup counts natively supported by the machine and the configured percentage
|
|
|
+ is likely not matched exactly.
|
|
|
+ Best results are achieved with 4 - 8 cups and a full water tank as it allows to use most variations to get close to the target.</li><br>
|
|
|
+ <li>
|
|
|
+ <code>attr <name> strength-extra-pre-brew-delay-seconds 0</code><br>
|
|
|
+ Specifies a delay in seconds when brewing coffee with extra strength which is used to split the brewing operation in a pre-brew
|
|
|
+ and the normal brew phase. The pre-brew phase brews a small amount of cups (usually 1) and pauses for a couple of seconds
|
|
|
+ before continuing with the rest of the cups.
|
|
|
+ This mode can help to overcome limitations with grounds being too coarse to provide good taste at standard brewing speed.
|
|
|
+ Specifying 0 disables "pre-brew".
|
|
|
+ </li><br>
|
|
|
+ <li>
|
|
|
+ <code>attr <name> strength-extra-pre-brew-cups 1</code><br>
|
|
|
+ Specifies the number of cups that are brewed first before delaying brewing in extra mode. Specifying 0 disables "pre-brew".
|
|
|
+ </li><br>
|
|
|
+ <li>
|
|
|
+ <code>attr <name> strength-extra-start-on-device-strength [off, weak, medium, strong]</code><br>
|
|
|
+ Specifies a strength level that maps to strength 'extra' when starting brewing without grinder using the buttons at the coffee machine.
|
|
|
+ By default this option is set to "<code>off</code>" which means that strength 'extra' can only be used when starting brewing via FHEM.
|
|
|
+ <br>
|
|
|
+ E.g. a value of "<code>weak</code>" allows to brew coffee with extra strength by pressing the start button at the coffee machine
|
|
|
+ with strength set to "weak" and grinder set to "disabled" (= "Filter" in the display).
|
|
|
+ <br><br>
|
|
|
+ Note: Brewing started from FHEM is never affected by this setting.
|
|
|
+ </li><br>
|
|
|
+ <li>
|
|
|
+ <code>attr <name> strength-coffee-weights 3.5 3.9 4.3</code><br>
|
|
|
+ Is the amount of coffee that the grinder produces per cup depending on the selected strength. This setting does not control the amount it only
|
|
|
+ tells the module what the grinder will produce. Changing the default values is therefore only required if the coffee machine produces
|
|
|
+ different results on the actually used beans.<br>
|
|
|
+ The amounts are specified in grams per strength <code>[weak, medium, strong]</code> using whitespace as delimiter.
|
|
|
+ <br><br>
|
|
|
+ The purpose of this metric is to calculate the actual <code>strength</code> and <code>cups</code> to use when grinding coffee with
|
|
|
+ <code>extra</code> strength. E.g. for 140% extra strength, 4 cups require <tt style="white-space: nowrap">(4 * 4.3 * 1.4) = 24.08</tt>
|
|
|
+ gramms of coffee. In this example the closest match is grinding 7 cups with weak strength which produces <code>(7 * 3.5) = 24.5</code> gramms.
|
|
|
+ The actual brewing is then performed with 4 cups as originally requested.
|
|
|
+ <br><br>
|
|
|
+ The algorithm tries to find the closest matching cup counts and strength value towards the target amount of coffee required for
|
|
|
+ <code>extra</code> strength. It is technically not possible to control the amount of coffee directly, therefore the grams specified for the
|
|
|
+ different strengths are used select between natively supported strengths <code>weak, medium, strong</code> that match the desired target the closest.
|
|
|
+ Water level is also taken into account as cup count is truncated by the coffee machine when grinding, depending on the amount of available water.
|
|
|
+ Decisions may vary depending on cups and available water, keep water level at maximum to get best results.
|
|
|
+ <br><br>
|
|
|
+ Note: SCAE (Speciality Coffee Association of Europe) recommends ~6 gramms of coffee per cup. To come close, 140% is the default value for
|
|
|
+ <code>extra</code> strength assuming that the default values for <code>strength-coffee-weights</code> apply to the used coffee beans.
|
|
|
+ As the density of coffee beans differs these defaults may be inappropriate. To get better results with a certain kind of beans it may make
|
|
|
+ sense to measure the actual produced weights and adjust the values (<code>strength-coffee-weights</code> and <code>strength-extra-percent</code>)
|
|
|
+ accordingly.
|
|
|
+ </li><br>
|
|
|
+</ul>
|
|
|
+
|
|
|
<p><a name="Snapcast"></a>
|
|
|
<h3>Snapcast</h3>
|
|
|
<div class='langLinks'>[EN <a href='commandref_DE.html#Snapcast'>DE</a>]</div>
|
|
|
@@ -62595,13 +63003,13 @@ KlikAanKlikUit, NEXA, CHACON, HomeEasy UK. <br> You need to define an RFXtrx433
|
|
|
You need to run kCoAPSocket running in background, that acts like a translator between FHEM and the Trådfri Gateway.
|
|
|
</ul>
|
|
|
<br>
|
|
|
-
|
|
|
+
|
|
|
<a name="TradfriGatewayset"></a>
|
|
|
<b>Set</b><br>
|
|
|
<ul>
|
|
|
<code>set <name> <option> [<value>]</code>
|
|
|
<br><br>
|
|
|
- You can set the following options. See <a href="http://fhem.de/commandref.html#set">commandref#set</a>
|
|
|
+ You can set the following options. See <a href="http://fhem.de/commandref.html#set">commandref#set</a>
|
|
|
for more info about the set command.
|
|
|
<br><br>
|
|
|
Options:
|
|
|
@@ -62620,8 +63028,8 @@ KlikAanKlikUit, NEXA, CHACON, HomeEasy UK. <br> You need to define an RFXtrx433
|
|
|
<ul>
|
|
|
<code>get <name> <option></code>
|
|
|
<br><br>
|
|
|
- You can get the following information about the device. See
|
|
|
- <a href="http://fhem.de/commandref.html#get">commandref#get</a> for more info about
|
|
|
+ You can get the following information about the device. See
|
|
|
+ <a href="http://fhem.de/commandref.html#get">commandref#get</a> for more info about
|
|
|
the get command.
|
|
|
<br><br>
|
|
|
Options:
|
|
|
@@ -62633,13 +63041,13 @@ KlikAanKlikUit, NEXA, CHACON, HomeEasy UK. <br> You need to define an RFXtrx433
|
|
|
</ul>
|
|
|
</ul>
|
|
|
<br>
|
|
|
-
|
|
|
+
|
|
|
<a name="TradfriGatewayattr"></a>
|
|
|
<b>Attributes</b>
|
|
|
<ul>
|
|
|
<code>attr <name> <attribute> <value></code>
|
|
|
<br><br>
|
|
|
- See <a href="http://fhem.de/commandref.html#attr">commandref#attr</a> for more info about
|
|
|
+ See <a href="http://fhem.de/commandref.html#attr">commandref#attr</a> for more info about
|
|
|
the attr command.
|
|
|
<br><br>
|
|
|
Attributes:
|
|
|
@@ -72313,12 +72721,15 @@ attr SVG_link_archetype attributes group</pre>
|
|
|
but the next time will be computed.</li><br>
|
|
|
|
|
|
<a name="disabledForIntervals"></a>
|
|
|
- <li>disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...<br>
|
|
|
+ <li>disabledForIntervals HH:MM-HH:MM HH:MM-HH:MM ...<br>
|
|
|
Space separated list of HH:MM or D@HH:MM tupels. If the current time is
|
|
|
between the two time specifications, the current device is disabled.
|
|
|
Instead of HH:MM you can also specify HH or HH:MM:SS. D is the day of
|
|
|
- the week, with 0 indicating Sunday and 3 indicating Wednesday. To
|
|
|
- specify an interval spawning midnight, you have to specify two
|
|
|
+ the week, with 0 indicating Sunday and 3 indicating Wednesday.
|
|
|
+ Specifying the day for the "from" part does _not_ specify it for the
|
|
|
+ "to" part, i.e. 1@00-24 will disable from monday to the end of the
|
|
|
+ week, but not on sunday (as 1@00 is greater than any time on sunday).
|
|
|
+ To specify an interval spawning midnight, you have to specify two
|
|
|
intervals, e.g.:
|
|
|
<ul>
|
|
|
23:00-24:00 00:00-01:00
|