FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-03-10 03:06:37 +00:00
Code Issues Releases Wiki Activity

Inserted CUL_IR

Browse Source 
git-svn-id: https://svn.fhem.de/fhem/trunk@1068 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
odroegehorn 2011-10-12 12:52:33 +00:00
parent 05c73e27ee
commit 9397f9b13c
1 changed files with 323 additions and 205 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

118
fhem/docs/commandref.html
View File

@ -82,6 +82,7 @@
<a href="#CUL_FHTTK">CUL_FHTTK</a> &nbsp;
<a href="#CUL_HM">CUL_HM</a> &nbsp;
<a href="#CUL_HOERMANN">CUL_HOERMANN</a> &nbsp;
<a href="#CUL_IR">CUL_IR</a> &nbsp;
<a href="#CUL_RFR">CUL_RFR</a> &nbsp;
<a href="#CUL_TX">CUL_TX</a> &nbsp;
<a href="#CUL_WS">CUL_WS</a> &nbsp;
@ -2420,6 +2421,123 @@ A line ending with \ will be concatenated with the next one, so long lines
</ul>
<a name="CUL_IR"></a>
<h3>CUL_IR</h3>
<ul>
<table>
<tr><td>
The CUL_IR module interprets Infrared messages received by the CUN/CUNO/CUNOv2/TuxRadio.
Those devices can receive Infrared Signals from basically any Remote controller and will transform
that information in a so called Button-Code <br><br>
<a name="CUL_IRdefine"></a>
<b>Define</b>
<ul>
<code>define &lt;name&gt; CUL_IR &lt;<a href="#IODev">IODev</a>&gt;</code> <br>
<br>
&lt;<a href="#IODev">IODev</a>&gt; is the devicename of the IR-receivung device, e.g. CUL1.<br><br>
Your definition should look like E.g.:
<pre>
define IR-Rec CUL_IR CUNO1</pre>
</ul>
<a name="CUL_IRset"></a>
<b>Set</b>
<ul>
<a name="irLearnForSec"></a>
<li>irLearnForSec<br>
Sets the CUL_IR device in an IR-Code Learning mode for the given seconds. Any received IR-Code will
be stored as a Button attribute for this devices. The name of these attributes is dependent on the two
attributes <a href="#CUL_IRattr">learncount</a> and <a href="#CUL_IRattr">learnprefix</a>.<br>
Attention: Before learning IR-Codes the CUL_IR device needs to be set in IR-Receiving mode
by modifying the <a href="#irReceive">irReceive</a> attribute.
</li>
</ul>
<a name="CUL_IRget"></a>
<b>Get</b>
<ul>N/A</ul>
<a name="CUL_IRattr"></a>
<b>Attributes</b>
<ul>
<li><a href="#do_not_notify">do_not_notify</a></li><br>
<li><a href="#showtime">showtime</a></li><br>
<li><a href="#loglevel">loglevel</a></li><br>
<li><a href="#irReceive">irReceive</a><br>
Configure the IR Transceiver of the &lt;<a href="#IODev">IODev</a>&gt; (the CUNO1). Available
arguments are:
<ul>
<li>OFF<br>
Switching off the reception of IR signals. This is the default.
<li>ON<br>
Switching on the reception of IR signals. This is WITHOUT filtering repetitions. This is
not recommended as many remote controls do repeat their signals.
<li>ON_NR<br>
Switching on the reception of IR signals with filtering of repetitions. This is
the recommended modus operandi.
</ul>
</li><br>
<li><a href="#Button.*">Button.*</a><br>
Button.* is the wildcard for all learnt IR-Codes. IR-Codes are learnt as Button-Attributes.
The name for a learnt Button - IR-Code is compiled out of three elements:<br>
<pre>
Button&lt;learnprefix&gt;&lt;learncount&gt;
</pre>
When the CUL_IR device is set into <a href="#irLearnForSec">learning mode</a> it will generate a
new button-attribute for each new IR-Code received.This is done according to the following syntax:<br>
<pre>
&lt;Button-Attribute-Name&gt; &lt;IR-Code&gt;</pre>
Examples of learnt button-attributes with EMPTY &lt;learnprefix&gt; and &lt;learncount&gt; starting from 1:<br>
<pre>
Button001 I02029A000000
Button002 I02029A000001</pre>
To make sure that something happens when this IR-code is received later on one has to modify the attribute
and to add commands as attribute values.
Examples:
<pre>
Button001 I02029A000000 set WZ_Lamp on
Button002 I02029A000001 set Switch on</pre>
The syntax for this is:
<pre>
attr &lt;device-name&gt; &lt;attribute-name&gt; &lt;IR-Code&gt; &lt;command&gt;
</pre>
</li>
<li><a href="#Group.*">Group.*</a><br>
Group.* is the wildcard for IR-Code groups. With these attributes one can define
IR-Code parts, which may match to several Button-IR-Codes.<br>
This is done by defining group-attributes that contain only parts of the IR-Code.
The syntax is:
<pre>
&lt;Group-Attribute-Name&gt; &lt;IR-Code&gt;</pre>
Examples of a group-attribute is:<br>
<pre>
Group001 I02029A</pre>
With this all IR-Codes starting with I02029A will match the Group001.
</li><br>
<li><a href="#learncount">learncount</a><br>
learncount is used to store the next button-code-number that needs to be learned.
By manually modifying this attribute new button sequences can be arranged.
</li><br>
<li><a href="#learnprefix">learnprefix</a><br>
learnprefix is a string which will be added to the button-attribute-name. <br>
A button-attribute-name is constructed by:
<pre>
Button&lt;learnprefix&gt;&lt;learncount&gt; </pre>
If learnprefix is empty the button-attribute-name only contains the term
"Button" and the actual number of <a href="#learncount">learncount</a>.
</li><br>
</ul>
<br>
</ul>
<a name="ESA2000"></a>
<h3>ESA2000</h3>
<ul>