commandref changes
- use "id" anchors; - disable german commandref (see https://forum.fhem.de/index.php/topic,122966.msg1175228.html#msg1175228 for background) - extend commandref for some basic info and references esp. to msgConfig Thanks for reviewing!
This commit is contained in:
parent
e63fa85a12
commit
a551ce9517
39
75_MSG.pm
39
75_MSG.pm
@ -1,5 +1,5 @@
|
|||||||
###############################################################################
|
###############################################################################
|
||||||
# $Id$
|
# $Id: 75_MSG.pm 19215 2019-04-18 11:55:19Z loredo $
|
||||||
#
|
#
|
||||||
#TODO
|
#TODO
|
||||||
# - be able to use type "default" to let read from attr
|
# - be able to use type "default" to let read from attr
|
||||||
@ -2463,26 +2463,47 @@ m/^(absent|disappeared|unauthorized|disconnected|unreachable)$/i
|
|||||||
|
|
||||||
1;
|
1;
|
||||||
|
|
||||||
|
__END__
|
||||||
|
|
||||||
=pod
|
=pod
|
||||||
=item command
|
=item command
|
||||||
=item summary dynamic routing of messages to FHEM devices and modules
|
=item summary dynamic routing of messages to FHEM devices and modules
|
||||||
=item summary_DE dynamisches Routing für Nachrichten an FHEM Geräte und Module
|
=item summary_DE dynamisches Routing für Nachrichten an FHEM Geräte und Module
|
||||||
=begin html
|
=begin html
|
||||||
|
|
||||||
<a name="MSG"></a>
|
<a id="MSG"></a>
|
||||||
<h3>msg</h3>
|
<h3>msg</h3>
|
||||||
<ul>
|
<p>For documentation in german see <a href="http://forum.fhem.de/index.php/topic,39983.0.html">FHEM Forum</a> or <a href="https://wiki.fhem.de/wiki/Msg">FHEM Wiki</a></p>
|
||||||
|
Syntax is:<br>
|
||||||
<code>msg [<type>] [<@device>|<e-mail address>] [<priority>] [|<title>|] <message></code>
|
<code>msg [<type>] [<@device>|<e-mail address>] [<priority>] [|<title>|] <message></code>
|
||||||
|
<br><br>
|
||||||
|
Except for <i>message</i> all parameters are optional, for configuration of the entire messageing logics see also <a href="#msgConfig">msgConfig</a>.<br>
|
||||||
<br>
|
<br>
|
||||||
|
Basic idea behind the command (and msgConfig) is to establish a central logic for dispatching messages to be sent to the user, so e.g. in case an address of an recipient changes, you only have to change one single point in your entire configuration.<br><br>
|
||||||
|
Parameters are as follows:<br>
|
||||||
|
<ul>
|
||||||
|
<li>type<br>
|
||||||
|
Is optional and one of <i>text</i>, <i>audio</i>, <i>light</i> or <i>screen</i>. If ommitted, it defaults to <i>text</i>.<br>
|
||||||
|
You may provide more than one type by providing a comma-seperated list.
|
||||||
|
</li>
|
||||||
|
<li>@device or e-mail address<br>
|
||||||
|
For <i>@device</i> you may opt for any instance of a messenger service available in <i>mscConfig</i>, by default <a href="#Pushover">Pushover</a> will be used (if available). <br>
|
||||||
|
For emailing, per default <code>system()</code> command per <code>/usr/bin/mail</code> is issued.
|
||||||
|
You may provide more than one recipent by providing a comma-seperated list here (also mixed).
|
||||||
|
</li>
|
||||||
|
<li>priority<br>
|
||||||
|
Is also optional. You may any (nummeric) value understood by your addressed messaging device, good idea is to use values common in the Pushover API (-2 to 2).
|
||||||
|
</li>
|
||||||
|
<li>title<br>
|
||||||
|
Is also optional, but when given, it has to be enclosed in <i>pipe</i> characters.
|
||||||
|
</li>
|
||||||
<br>
|
<br>
|
||||||
No documentation here yet, sorry.<br>
|
</ul>
|
||||||
<a href="http://forum.fhem.de/index.php/topic,39983.0.html">FHEM Forum</a>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
=end html
|
=end html
|
||||||
=begin html_DE
|
=begin html_old_DE
|
||||||
|
|
||||||
<a name="MSG"></a>
|
<a id="MSG"></a>
|
||||||
<h3>msg</h3>
|
<h3>msg</h3>
|
||||||
<ul>
|
<ul>
|
||||||
<code>msg [<type>] [<@device>|<e-mail address>] [<priority>] [|<title>|] <message></code>
|
<code>msg [<type>] [<@device>|<e-mail address>] [<priority>] [|<title>|] <message></code>
|
||||||
@ -2493,7 +2514,7 @@ m/^(absent|disappeared|unauthorized|disconnected|unreachable)$/i
|
|||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
=end html_DE
|
=end html_old_DE
|
||||||
|
|
||||||
=for :application/json;q=META.json 75_MSG.pm
|
=for :application/json;q=META.json 75_MSG.pm
|
||||||
{
|
{
|
||||||
|
Loading…
Reference in New Issue
Block a user