ENIGMA2: update documentation
git-svn-id: https://svn.fhem.de/fhem/trunk@4449 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
loredo
@@ -2261,8 +2261,9 @@ sub ENIGMA2_GetRemotecontrolCommand($) {
|
|||||||
<br><br>
|
<br><br>
|
||||||
define SATReceiver ENIGMA2 192.168.0.10 80 60 root secret # With HTTP user credentials
|
define SATReceiver ENIGMA2 192.168.0.10 80 60 root secret # 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>
|
||||||
@@ -2271,49 +2272,53 @@ sub ENIGMA2_GetRemotecontrolCommand($) {
|
|||||||
<br><br>
|
<br><br>
|
||||||
Currently, the following commands are defined.<br>
|
Currently, the following commands are defined.<br>
|
||||||
<ul>
|
<ul>
|
||||||
<li><b>on</b> - powers on the device and send a WoL magic package if needed</li>
|
<li><b>on</b> - powers on the device and send a WoL magic package if needed</li>
|
||||||
<li><b>off</b> - turns the device in standby mode</li>
|
<li><b>off</b> - turns the device in standby mode</li>
|
||||||
<li><b>toggle</b> - switch between on and off</li>
|
<li><b>toggle</b> - switch between on and off</li>
|
||||||
<li><b>shutdown</b> - turns the device in deepstandby mode</li>
|
<li><b>shutdown</b> - turns the device in deepstandby mode</li>
|
||||||
<li><b>reboot</b> - reboots the device</li>
|
<li><b>reboot</b> - reboots the device</li>
|
||||||
<li><b>restartGui</b> - restarts the GUI / ENIGMA2 process</li>
|
<li><b>restartGui</b> - restarts the GUI / ENIGMA2 process</li>
|
||||||
<li><b>channel</b> channel,0...999,sRef - zap to specific channel or service reference</li>
|
<li><b>channel</b> channel,0...999,sRef - zap to specific channel or service reference</li>
|
||||||
<li><b>channelUp</b> - zap to next channel</li>
|
<li><b>channelUp</b> - zap to next channel</li>
|
||||||
<li><b>channelDown</b> - zap to previous channel</li>
|
<li><b>channelDown</b> - zap to previous channel</li>
|
||||||
<li><b>volume</b> 0...100 - set the volume level in percentage</li>
|
<li><b>volume</b> 0...100 - set the volume level in percentage</li>
|
||||||
<li><b>volumeUp</b> - increases the volume level</li>
|
<li><b>volumeUp</b> - increases the volume level</li>
|
||||||
<li><b>volumeDown</b> - decreases the volume level</li>
|
<li><b>volumeDown</b> - decreases the volume level</li>
|
||||||
<li><b>mute</b> on,off - controls volume mute</li>
|
<li><b>mute</b> on,off - controls volume mute</li>
|
||||||
<li><b>play</b> on,off - starts/resumes playback</li>
|
<li><b>play</b> on,off - starts/resumes playback</li>
|
||||||
<li><b>pause</b> on,off - pauses current playback or enables timeshift</li>
|
<li><b>pause</b> on,off - pauses current playback or enables timeshift</li>
|
||||||
<li><b>stop</b> on,off - stops current playback</li>
|
<li><b>stop</b> on,off - stops current playback</li>
|
||||||
<li><b>input</b> tv,radio - switches between tv and radio mode</li>
|
<li><b>input</b> tv,radio - switches between tv and radio mode</li>
|
||||||
<li><b>statusRequest</b> - requests the current status of the device</li>
|
<li><b>statusRequest</b> - requests the current status of the device</li>
|
||||||
<li><b>remoteControl</b> UP,DOWN,... - sends remote control commands; see remoteControl help</li>
|
<li><b>remoteControl</b> UP,DOWN,... - sends remote control commands; see remoteControl help</li>
|
||||||
<li><b>showText</b> text - sends info message to screen to be displayed for 8 seconds</li>
|
<li><b>showText</b> text - sends info message to screen to be displayed for 8 seconds</li>
|
||||||
<li><b>msg</b> yesno,info... - allows more complex messages as showText, see commands as listed below</li>
|
<li><b>msg</b> yesno,info... - allows more complex messages as showText, see commands as listed below</li>
|
||||||
</ul>
|
</ul>
|
||||||
</ul><br><br>
|
</ul>
|
||||||
|
|
||||||
<u>Messaging</u><br><br>
|
<ul>
|
||||||
<ul>
|
<u>Messaging</u><br><br>
|
||||||
showText has predefined settings. If you would like to send more individual messages
|
<ul>
|
||||||
to your TV screen, the function msg can be used.
|
showText has predefined settings. If you would like to send more individual messages
|
||||||
For this application the following commands are available:<br><br>
|
to your TV screen, the function msg can be used.
|
||||||
|
For this application the following commands are available:<br><br>
|
||||||
|
|
||||||
<u>Type Selection:</u><br>
|
<u>Type Selection:</u><br>
|
||||||
<ul><code>
|
<ul><code>
|
||||||
msg yesno<br>
|
msg yesno<br>
|
||||||
msg info<br>
|
msg info<br>
|
||||||
msg message<br>
|
msg message<br>
|
||||||
msg attention<br>
|
msg attention<br>
|
||||||
</code></ul><br><br>
|
</code></ul><br><br>
|
||||||
|
|
||||||
The following parameter are essentially needed after type specification:
|
The following parameter are essentially needed after type specification:
|
||||||
<ul><code>
|
<ul><code>
|
||||||
msg <TYPE> <TIMEOUT> <YOUR MESSAGETEXT><br>
|
msg <TYPE> <TIMEOUT> <YOUR MESSAGETEXT><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>
|
||||||
@@ -2333,57 +2338,75 @@ sub ENIGMA2_GetRemotecontrolCommand($) {
|
|||||||
servicevideosize<br>
|
servicevideosize<br>
|
||||||
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>
|
||||||
<li><b>channel</b> - Shows the service name of current channel or media file name; part of FHEM-4-AV-Devices compatibility</li>
|
<li><b>channel</b> - Shows the service name of current channel or media file name; 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>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>eventdescription</b> - Shows the description of running event</li>
|
<li><b>eventcurrenttime</b> - Shows the current time of running event as UNIX timestamp</li>
|
||||||
<li><b>evenduration</b> - Shows the total duration time of running event in seconds</li>
|
<li><b>eventcurrenttime_hr</b> - Shows the current time of running event in human-readable format</li>
|
||||||
<li><b>eventid</b> - Shows the ID of running event</li>
|
<li><b>eventdescription</b> - Shows the description of running event</li>
|
||||||
<li><b>eventstart</b> - Shows the starting time of running event as UNIX timestamp</li>
|
<li><b>evenduration</b> - Shows the total duration time of running event in seconds</li>
|
||||||
<li><b>eventstart_hr</b> - Shows the starting time of running event in human readable format</li>
|
<li><b>evenduration_hr</b> - Shows the total duration time of running event in human-readable format</li>
|
||||||
<li><b>eventtitle</b> - Shows the title of the running event</li>
|
<li><b>eventid</b> - Shows the ID of running event</li>
|
||||||
<li><b>fpversion</b> - Shows the firmware version for the front processor</li>
|
<li><b>eventstart</b> - Shows the starting time of running event as UNIX timestamp</li>
|
||||||
<li><b>hddX_capacity</b> - Shows the total capacity of the installed hard drive in GB</li>
|
<li><b>eventstart_hr</b> - Shows the starting time of running event in human readable format</li>
|
||||||
<li><b>hddX_free</b> - Shows the free capacity of the installed hard drive in GB</li>
|
<li><b>eventtitle</b> - Shows the title of the running event</li>
|
||||||
<li><b>hddX_model</b> - Shows hardware details for the installed hard drive</li>
|
<li><b>fpversion</b> - Shows the firmware version for the front processor</li>
|
||||||
<li><b>imageversion</b> - Shows the version for the installed software image</li>
|
<li><b>hddX_capacity</b> - Shows the total capacity of the installed hard drive in GB</li>
|
||||||
<li><b>input</b> - Shows currently used input; part of FHEM-4-AV-Devices compatibility</li>
|
<li><b>hddX_free</b> - Shows the free capacity of the installed hard drive in GB</li>
|
||||||
<li><b>lanmac</b> - Shows the device MAC address</li>
|
<li><b>hddX_model</b> - Shows hardware details for the installed hard drive</li>
|
||||||
<li><b>model</b> - Shows details about the device hardware</li>
|
<li><b>imageversion</b> - Shows the version for the installed software image</li>
|
||||||
<li><b>mute</b> - Reports the mute status of the device (can be "on" or "off")</li>
|
<li><b>input</b> - Shows currently used input; part of FHEM-4-AV-Devices compatibility</li>
|
||||||
<li><b>onid</b> - The ON ID</li>
|
<li><b>lanmac</b> - Shows the device MAC address</li>
|
||||||
<li><b>pcrpid</b> - The PCR process ID</li>
|
<li><b>model</b> - Shows details about the device hardware</li>
|
||||||
<li><b>pmtpid</b> - The PMT process ID</li>
|
<li><b>mute</b> - Reports the mute status of the device (can be "on" or "off")</li>
|
||||||
<li><b>power</b> - Reports the power status of the device (can be "on" or "off")</li>
|
<li><b>onid</b> - The ON ID</li>
|
||||||
<li><b>presence</b> - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is basically limited to turn it on again. This will only work if the device supports Wake-On-LAN packages, otherwise command "on" will have no effect.</li>
|
<li><b>pcrpid</b> - The PCR process ID</li>
|
||||||
<li><b>serviceaspect</b> - Aspect ratio for current channel</li>
|
<li><b>pmtpid</b> - The PMT process ID</li>
|
||||||
<li><b>servicename</b> - Name for current channel</li>
|
<li><b>power</b> - Reports the power status of the device (can be "on" or "off")</li>
|
||||||
<li><b>servicenamespace</b> - Namespace for current channel</li>
|
<li><b>presence</b> - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is basically limited to turn it on again. This will only work if the device supports Wake-On-LAN packages, otherwise command "on" will have no effect.</li>
|
||||||
<li><b>serviceprovider</b> - Service provider of current channel</li>
|
<li><b>serviceaspect</b> - Aspect ratio for current channel</li>
|
||||||
<li><b>servicereference</b> - The service reference ID of current channel</li>
|
<li><b>servicename</b> - Name for current channel</li>
|
||||||
<li><b>servicevideosize</b> - Video resolution for current channel</li>
|
<li><b>servicenamespace</b> - Namespace for current channel</li>
|
||||||
<li><b>sid</b> - The S-ID</li>
|
<li><b>serviceprovider</b> - Service provider of current channel</li>
|
||||||
<li><b>snr</b> - Shows Signal to Noise for current channel in percent</li>
|
<li><b>servicereference</b> - The service reference ID of current channel</li>
|
||||||
<li><b>snrdb</b> - Shows Signal to Noise in dB</li>
|
<li><b>servicevideosize</b> - Video resolution for current channel</li>
|
||||||
<li><b>state</b> - Reports current power state and an absence of the device (can be "on", "off" or "absent")</li>
|
<li><b>sid</b> - The S-ID</li>
|
||||||
<li><b>tsid</b> - The TS ID</li>
|
<li><b>snr</b> - Shows Signal to Noise for current channel in percent</li>
|
||||||
<li><b>tuner_X</b> - Details about the used tuner hardware</li>
|
<li><b>snrdb</b> - Shows Signal to Noise in dB</li>
|
||||||
<li><b>txtpid</b> - The TXT process ID</li>
|
<li><b>state</b> - Reports current power state and an absence of the device (can be "on", "off" or "absent")</li>
|
||||||
<li><b>videoheight</b> - Height of the video resolution for current channel</li>
|
<li><b>tsid</b> - The TS ID</li>
|
||||||
<li><b>videowidth</b> - Width of the video resolution for current channel</li>
|
<li><b>tuner_X</b> - Details about the used tuner hardware</li>
|
||||||
<li><b>volume</b> - Reports current volume level of the receiver in percentage values (between 0 and 100 %)</li>
|
<li><b>txtpid</b> - The TXT process ID</li>
|
||||||
<li><b>vpid</b> - The Video process ID</li>
|
<li><b>videoheight</b> - Height of the video resolution for current channel</li>
|
||||||
<li><b>webifversion</b> - Type and version of the used web interface</li>
|
<li><b>videowidth</b> - Width of the video resolution for current channel</li>
|
||||||
</ul>
|
<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>webifversion</b> - Type and version of the used web interface</li>
|
||||||
|
</ul></ul>
|
||||||
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
=end html
|
=end html
|
||||||
|
|||||||
Reference in New Issue
Block a user