ENIGMA2: update documentation

git-svn-id: https://svn.fhem.de/fhem/trunk@4449 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
loredo
2013-12-23 21:47:23 +00:00
parent e6202037e4
commit 3ca4d4ef19

View File

@@ -2261,8 +2261,9 @@ sub ENIGMA2_GetRemotecontrolCommand($) {
<br><br> <br><br>
define SATReceiver ENIGMA2 192.168.0.10 80 60 root secret &nbsp;&nbsp;&nbsp; # With HTTP user credentials define SATReceiver ENIGMA2 192.168.0.10 80 60 root secret &nbsp;&nbsp;&nbsp; # With HTTP user credentials
</code></ul> </code></ul>
</ul> </ul>
<br>
<br>
<a name="ENIGMA2set"></a> <a name="ENIGMA2set"></a>
<b>Set </b> <b>Set </b>
@@ -2293,8 +2294,9 @@ sub ENIGMA2_GetRemotecontrolCommand($) {
<li><b>showText</b> text &nbsp;&nbsp;-&nbsp;&nbsp; sends info message to screen to be displayed for 8 seconds</li> <li><b>showText</b> text &nbsp;&nbsp;-&nbsp;&nbsp; sends info message to screen to be displayed for 8 seconds</li>
<li><b>msg</b> yesno,info... &nbsp;&nbsp;-&nbsp;&nbsp; allows more complex messages as showText, see commands as listed below</li> <li><b>msg</b> yesno,info... &nbsp;&nbsp;-&nbsp;&nbsp; allows more complex messages as showText, see commands as listed below</li>
</ul> </ul>
</ul><br><br> </ul>
<ul>
<u>Messaging</u><br><br> <u>Messaging</u><br><br>
<ul> <ul>
showText has predefined settings. If you would like to send more individual messages showText has predefined settings. If you would like to send more individual messages
@@ -2312,8 +2314,11 @@ sub ENIGMA2_GetRemotecontrolCommand($) {
The following parameter are essentially needed after type specification: The following parameter are essentially needed after type specification:
<ul><code> <ul><code>
msg &lt;TYPE&gt; &lt;TIMEOUT&gt; &lt;YOUR MESSAGETEXT&gt;<br> msg &lt;TYPE&gt; &lt;TIMEOUT&gt; &lt;YOUR MESSAGETEXT&gt;<br>
</code></ul><br><br> </code></ul>
</ul> </ul>
</ul>
<br>
<br>
<a name="ENIGMA2get"></a> <a name="ENIGMA2get"></a>
<b>Get</b> <b>Get</b>
@@ -2334,10 +2339,24 @@ sub ENIGMA2_GetRemotecontrolCommand($) {
streamUrl<br> streamUrl<br>
</code></ul> </code></ul>
</ul> </ul>
<br>
<br>
<a name="ENIGMA2attr"></a>
<b>Attributes</b><br>
<ul><ul>
<li><b>bouquet-tv</b> - service reference address where the favorite television bouquet can be found (initially set automatically during define)</li>
<li><b>bouquet-radio</b> - service reference address where the favorite radio bouquet can be found (initially set automatically during define)</li>
<li><b>disable</b> - Disable polling (true/false)</li>
<li><b>https</b> - Access box via secure HTTP (true/false)</li>
<li><b>timeout</b> - Set different polling timeout in seconds (default=6)</li>
</ul></ul>
<br>
<br>
<br> <br>
<b>Generated Readings/Events:</b><br> <b>Generated Readings/Events:</b><br>
<ul> <ul><ul>
<li><b>acg</b> - Shows Automatic Gain Control value in percent; reflects overall signal quality strength</li> <li><b>acg</b> - Shows Automatic Gain Control value in percent; reflects overall signal quality strength</li>
<li><b>apid</b> - Shows the audio process ID for current channel</li> <li><b>apid</b> - Shows the audio process ID for current channel</li>
<li><b>ber</b> - Shows Bit Error Rate for current channel</li> <li><b>ber</b> - Shows Bit Error Rate for current channel</li>
@@ -2345,8 +2364,11 @@ sub ENIGMA2_GetRemotecontrolCommand($) {
<li><b>currentTitle</b> - Shows the title of the running event; part of FHEM-4-AV-Devices compatibility</li> <li><b>currentTitle</b> - Shows the title of the running event; part of FHEM-4-AV-Devices compatibility</li>
<li><b>currentMedia</b> - The service reference ID of current channel; part of FHEM-4-AV-Devices compatibility</li> <li><b>currentMedia</b> - The service reference ID of current channel; part of FHEM-4-AV-Devices compatibility</li>
<li><b>enigmaversion</b> - Shows the installed version of ENIGMA2</li> <li><b>enigmaversion</b> - Shows the installed version of ENIGMA2</li>
<li><b>eventcurrenttime</b> - Shows the current time of running event as UNIX timestamp</li>
<li><b>eventcurrenttime_hr</b> - Shows the current time of running event in human-readable format</li>
<li><b>eventdescription</b> - Shows the description of running event</li> <li><b>eventdescription</b> - Shows the description of running event</li>
<li><b>evenduration</b> - Shows the total duration time of running event in seconds</li> <li><b>evenduration</b> - Shows the total duration time of running event in seconds</li>
<li><b>evenduration_hr</b> - Shows the total duration time of running event in human-readable format</li>
<li><b>eventid</b> - Shows the ID of running event</li> <li><b>eventid</b> - Shows the ID of running event</li>
<li><b>eventstart</b> - Shows the starting time of running event as UNIX timestamp</li> <li><b>eventstart</b> - Shows the starting time of running event as UNIX timestamp</li>
<li><b>eventstart_hr</b> - Shows the starting time of running event in human readable format</li> <li><b>eventstart_hr</b> - Shows the starting time of running event in human readable format</li>
@@ -2383,7 +2405,8 @@ sub ENIGMA2_GetRemotecontrolCommand($) {
<li><b>volume</b> - Reports current volume level of the receiver in percentage values (between 0 and 100 %)</li> <li><b>volume</b> - Reports current volume level of the receiver in percentage values (between 0 and 100 %)</li>
<li><b>vpid</b> - The Video process ID</li> <li><b>vpid</b> - The Video process ID</li>
<li><b>webifversion</b> - Type and version of the used web interface</li> <li><b>webifversion</b> - Type and version of the used web interface</li>
</ul> </ul></ul>
</ul> </ul>
=end html =end html