# $Id$
##############################################################################
#
# 70_ENIGMA2.pm
# An FHEM Perl module for controlling ENIGMA2 based TV receivers
# via network connection.
#
# Copyright by Julian Pawlowski
# e-mail: julian.pawlowski at gmail.com
#
# This file is part of fhem.
#
# Fhem is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# Fhem is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with fhem. If not, see .
#
#
# Version: 1.2.4
#
# Major Version History:
# - 1.2.0 - 2013-12-21
# -- Add bouquet support e.g. for named channels
#
# - 1.1.0 - 2013-12-16
# -- Improved logging & debugging
# -- added default attributes for webCmd and devStateIcon
#
# - 1.0.0 - 2013-09-23
# -- First release
#
##############################################################################
package main;
use strict;
use warnings;
use XML::Simple;
use IO::Socket;
use HttpUtils;
use Encode;
sub ENIGMA2_Set($@);
sub ENIGMA2_Get($@);
sub ENIGMA2_GetStatus($;$);
sub ENIGMA2_Define($$);
sub ENIGMA2_Undefine($$);
#########################
# Forward declaration for remotecontrol module
sub ENIGMA2_RClayout_TV();
sub ENIGMA2_RCmakenotify($$);
###################################
sub ENIGMA2_Initialize($) {
my ($hash) = @_;
Log3 $hash, 5, "ENIGMA2_Initialize: Entering";
$hash->{GetFn} = "ENIGMA2_Get";
$hash->{SetFn} = "ENIGMA2_Set";
$hash->{DefFn} = "ENIGMA2_Define";
$hash->{UndefFn} = "ENIGMA2_Undefine";
$hash->{AttrList} =
"https:0,1 http-method:GET,POST disable:0,1 bouquet-tv bouquet-radio timeout "
. $readingFnAttributes;
$data{RC_layout}{ENIGMA2_DreamMultimedia_DM500_DM800_SVG} =
"ENIGMA2_RClayout_DM800_SVG";
$data{RC_layout}{ENIGMA2_DreamMultimedia_DM500_DM800} =
"ENIGMA2_RClayout_DM800";
$data{RC_layout}{ENIGMA2_DreamMultimedia_DM8000_DM800se_SVG} =
"ENIGMA2_RClayout_DM8000_SVG";
$data{RC_layout}{ENIGMA2_DreamMultimedia_DM8000_DM800se} =
"ENIGMA2_RClayout_DM8000";
$data{RC_layout}{ENIGMA2_DreamMultimedia_RC10_SVG} =
"ENIGMA2_RClayout_RC10_SVG";
$data{RC_layout}{ENIGMA2_DreamMultimedia_RC10} = "ENIGMA2_RClayout_RC10";
# $data{RC_layout}{ENIGMA2_VUplus_Solo2_SVG} = "ENIGMA2_RClayout_VUplusSolo2_SVG";
# $data{RC_layout}{ENIGMA2_VUplus_Solo2} = "ENIGMA2_RClayout_VUplusSolo2";
$data{RC_layout}{ENIGMA2_VUplus_Duo2_SVG} =
"ENIGMA2_RClayout_VUplusDuo2_SVG";
$data{RC_layout}{ENIGMA2_VUplus_Duo2} = "ENIGMA2_RClayout_VUplusDuo2";
# $data{RC_layout}{ENIGMA2_VUplus_Ultimo_SVG} = "ENIGMA2_RClayout_VUplusUltimo_SVG";
# $data{RC_layout}{ENIGMA2_VUplus_Ultimo} = "ENIGMA2_RClayout_VUplusUltimo";
$data{RC_makenotify}{ENIGMA2} = "ENIGMA2_RCmakenotify";
}
#####################################
sub ENIGMA2_GetStatus($;$) {
my ( $hash, $local ) = @_;
my $name = $hash->{NAME};
my $interval = $hash->{INTERVAL};
my $state = '';
my $boxinfo;
my $currsrvinfo;
my $signalinfo;
my $vol;
my $changecount = 0;
Log3 $name, 5, "ENIGMA2 $name: called function ENIGMA2_GetStatus()";
$local = 0 unless ( defined($local) );
if ( defined( $attr{$name}{disable} ) && $attr{$name}{disable} == 1 ) {
return $hash->{STATE};
}
InternalTimer( gettimeofday() + $interval, "ENIGMA2_GetStatus", $hash, 0 )
unless ( $local == 1 );
# Read powerstate
#
my $powerstate = ENIGMA2_SendCommand( $hash, "powerstate", "" );
if ( defined($powerstate) && ref($powerstate) eq "HASH" ) {
# Cache bouquet information - get favorite bouquet
# if not available from helper
foreach my $input ( "tv", "radio" ) {
my $service_uri;
my $services;
my $services_list;
if ( !defined( $hash->{helper}{bouquet}{$input} )
|| !defined( $hash->{helper}{channels}{$input} ) )
{
$service_uri =
'1:7:2:0:0:0:0:0:0:0:(type == 2)FROM BOUQUET "bouquets.'
. $input
. '" ORDER BY bouquet';
$services =
ENIGMA2_SendCommand( $hash, "getservices",
"sRef=" . urlEncode($service_uri) )
if ( !defined( $attr{$name}{ "bouquet-" . $input } ) );
# set FHEM device attribute if not available
# multiple
if ( ref($services) eq "HASH"
&& defined( $services->{e2service} )
&& ref( $services->{e2service} ) eq "ARRAY"
&& defined( $services->{e2service}[0]{e2servicereference} )
&& $services->{e2service}[0]{e2servicereference} ne "" )
{
Log3 $name, 3,
"ENIGMA2 $name: Adding attribute bouquet-"
. $input . " = "
. $services->{e2service}[0]{e2servicereference};
$attr{$name}{ "bouquet-" . $input } =
$services->{e2service}[0]{e2servicereference};
}
# single
elsif (ref($services) eq "HASH"
&& defined( $services->{e2service}{e2servicereference} )
&& $services->{e2service}{e2servicereference} ne "" )
{
Log3 $name, 3,
"ENIGMA2 $name: Adding attribute bouquet-"
. $input . " = "
. $services->{e2service}{e2servicereference};
$attr{$name}{ "bouquet-" . $input } =
$services->{e2service}{e2servicereference};
}
elsif ( !defined( $attr{$name}{ "bouquet-" . $input } ) ) {
Log3 $name, 3,
"ENIGMA2 $name: ERROR: Unable to read any "
. $input
. " bouquets from device";
}
$services_list = ENIGMA2_SendCommand( $hash, "getservices",
"sRef=" . urlEncode( $attr{$name}{ "bouquet-" . $input } ) )
if ( defined( $attr{$name}{ "bouquet-" . $input } ) );
# Read channels
if ( ref($services_list) eq "HASH"
&& defined( $services_list->{e2service} ) )
{
# multiple
if (
ref( $services_list->{e2service} ) eq "ARRAY"
&& defined(
$services_list->{e2service}[0]{e2servicename}
)
&& $services_list->{e2service}[0]{e2servicename} ne ""
&& defined(
$services_list->{e2service}[0]{e2servicereference}
)
&& $services_list->{e2service}[0]{e2servicereference}
ne ""
)
{
my $i = 0;
for ( keys @{ $services_list->{e2service} } ) {
my $channel =
$services_list->{e2service}[$_]{e2servicename};
$channel =~ s/\s/_/g;
# ignore markers
if ( $services_list->{e2service}[$_]
{e2servicereference} =~ /^1:64:/ )
{
Log3 $name, 4,
"ENIGMA2 $name: Ignoring marker "
. $services_list->{e2service}[$_]
{e2servicename};
next;
}
if ( $channel ne "" ) {
$hash->{helper}{bouquet}{$input}{$channel} =
{ 'sRef' => $services_list->{e2service}[$_]
{e2servicereference} };
$hash->{helper}{channels}{$input}[$i] =
$channel;
}
$i++;
}
Log3 $name, 4,
"ENIGMA2 $name: Cached favorite "
. $input
. " channels: "
. join( ', ',
@{ $hash->{helper}{channels}{$input} } );
}
# single
elsif (
defined( $services_list->{e2service}{e2servicename} )
&& $services_list->{e2service}{e2servicename} ne ""
&& defined(
$services_list->{e2service}{e2servicereference}
)
&& $services_list->{e2service}{e2servicereference} ne ""
)
{
# ignore markers
if ( $services_list->{e2service}{e2servicereference} =~
/^1:64:/ )
{
Log3 $name, 4,
"ENIGMA2 $name: Ignoring marker "
. $services_list->{e2service}{e2servicename};
}
else {
my $channel =
$services_list->{e2service}{e2servicename};
$channel =~ s/\s/_/g;
if ( $channel ne "" ) {
$hash->{helper}{bouquet}{$input}{$channel} =
{ 'sRef' => $services_list->{e2service}
{e2servicereference} };
$hash->{helper}{channels}{$input}[0] =
$channel;
Log3 $name, 4,
"ENIGMA2 $name: Cached favorite "
. $input
. " channels: "
. $hash->{helper}{channels}{$input}[0];
}
}
}
else {
Log3 $name, 4,
"ENIGMA2 $name: ERROR: bouquet-"
. $input
. " seems to be empty.";
}
}
elsif ( $input eq "radio" ) {
Log3 $name, 4,
"ENIGMA2 $name: ERROR: Unable to read "
. $input
. " bouquet '"
. $attr{$name}{ "bouquet-" . $input }
. "' from device";
}
else {
Log3 $name, 3,
"ENIGMA2 $name: ERROR: Unable to read "
. $input
. " bouquet '"
. $attr{$name}{ "bouquet-" . $input }
. "' from device";
}
}
}
if ( $powerstate->{e2instandby} eq "true" ) {
$state = "off";
}
else {
$state = "on";
# Read Boxinfo every 10 minutes only
if (
!defined( $hash->{helper}{lastFullUpdate} )
|| ( defined( $hash->{helper}{lastFullUpdate} )
&& $hash->{helper}{lastFullUpdate} + 900 le time() )
)
{
$boxinfo = ENIGMA2_SendCommand( $hash, "about", "" );
# Update state
$hash->{helper}{lastFullUpdate} = time();
}
# get current states
$currsrvinfo = ENIGMA2_SendCommand( $hash, "getcurrent", "" );
$vol = ENIGMA2_SendCommand( $hash, "vol", "" );
$signalinfo = ENIGMA2_SendCommand( $hash, "signal", "" );
}
}
elsif ( $hash->{helper}{AVAILABLE} == 1 ) {
Log3 $name, 2, "ENIGMA2 $name: ERROR: Undefined state of device";
$state = "undefined";
}
else {
$state = "absent";
}
####
# update readings
#
readingsBeginUpdate($hash);
# Set reading for power
#
my $readingPower = "off";
if ( $state eq "on" ) {
$readingPower = "on";
}
if ( !defined( $hash->{READINGS}{power}{VAL} )
|| $hash->{READINGS}{power}{VAL} ne $readingPower )
{
readingsBulkUpdate( $hash, "power", $readingPower );
}
# Set reading for state
#
if ( !defined( $hash->{READINGS}{state}{VAL} )
|| $hash->{READINGS}{state}{VAL} ne $state )
{
readingsBulkUpdate( $hash, "state", $state );
}
my $reading;
my $e2reading;
# Boxinfo
#
if ( ref($boxinfo) eq "HASH" ) {
# General readings
foreach (
"enigmaversion", "imageversion", "webifversion",
"fpversion", "lanmac", "model",
)
{
$reading = $_;
$e2reading = "e2" . $_;
if ( defined( $boxinfo->{e2about}{$e2reading} ) ) {
if ( $boxinfo->{e2about}{$e2reading} eq "False"
|| $boxinfo->{e2about}{$e2reading} eq "True" )
{
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne
lc( $boxinfo->{e2about}{$e2reading} ) )
{
readingsBulkUpdate( $hash, $reading,
lc( $boxinfo->{e2about}{$e2reading} ) );
}
}
else {
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne
$boxinfo->{e2about}{$e2reading} )
{
readingsBulkUpdate( $hash, $reading,
$boxinfo->{e2about}{$e2reading} );
}
}
}
else {
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne "-" )
{
readingsBulkUpdate( $hash, $reading, "-" );
}
}
}
# HDD
if ( defined( $boxinfo->{e2about}{e2hddinfo} ) ) {
# multiple
if ( ref( $boxinfo->{e2about}{e2hddinfo} ) eq "ARRAY" ) {
my $i = 0;
my $arr_size = @{ $boxinfo->{e2about}{e2hddinfo} };
while ( $i < $arr_size ) {
my $counter = $i + 1;
my $readingname = "hdd" . $counter . "_model";
if ( !defined( $hash->{READINGS}{$readingname}{VAL} )
|| $hash->{READINGS}{$readingname}{VAL} ne
$boxinfo->{e2about}{e2hddinfo}[$i]{model} )
{
readingsBulkUpdate( $hash, $readingname,
$boxinfo->{e2about}{e2hddinfo}[$i]{model} );
}
$readingname = "hdd" . $counter . "_capacity";
my @value =
split( / /,
$boxinfo->{e2about}{e2hddinfo}[$i]{capacity} );
if (
!defined( $hash->{READINGS}{$readingname}{VAL} )
|| ( @value
&& $hash->{READINGS}{$readingname}{VAL} ne
$value[0] )
)
{
readingsBulkUpdate( $hash, $readingname, $value[0] );
}
$readingname = "hdd" . $counter . "_free";
@value =
split( / /, $boxinfo->{e2about}{e2hddinfo}[$i]{free} );
if (
!defined( $hash->{READINGS}{$readingname}{VAL} )
|| ( @value
&& $hash->{READINGS}{$readingname}{VAL} ne
$value[0] )
)
{
readingsBulkUpdate( $hash, $readingname, $value[0] );
}
$i++;
}
}
# single
elsif ( ref( $boxinfo->{e2about}{e2hddinfo} ) eq "HASH" ) {
my $readingname = "hdd1_model";
if ( !defined( $hash->{READINGS}{$readingname}{VAL} )
|| $hash->{READINGS}{$readingname}{VAL} ne
$boxinfo->{e2about}{e2hddinfo}{model} )
{
readingsBulkUpdate( $hash, $readingname,
$boxinfo->{e2about}{e2hddinfo}{model} );
}
$readingname = "hdd1_capacity";
my @value =
split( / /, $boxinfo->{e2about}{e2hddinfo}{capacity} );
if (
!defined( $hash->{READINGS}{$readingname}{VAL} )
|| ( @value
&& $hash->{READINGS}{$readingname}{VAL} ne $value[0] )
)
{
readingsBulkUpdate( $hash, $readingname, $value[0] );
}
$readingname = "hdd1_free";
@value = split( / /, $boxinfo->{e2about}{e2hddinfo}{free} );
if (
!defined( $hash->{READINGS}{$readingname}{VAL} )
|| ( @value
&& $hash->{READINGS}{$readingname}{VAL} ne $value[0] )
)
{
readingsBulkUpdate( $hash, $readingname, $value[0] );
}
}
}
# Tuner
if ( defined( $boxinfo->{e2about}{e2tunerinfo}{e2nim} ) ) {
my %tuner = %{ $boxinfo->{e2about}{e2tunerinfo}{e2nim} };
# single
if ( defined( $tuner{type} ) ) {
my $tunerRef = \%tuner;
my $tuner_name = lc( $$tunerRef{name} );
$tuner_name =~ s/\s/_/g;
if ( !defined( $hash->{READINGS}{$tuner_name}{VAL} )
|| $hash->{READINGS}{$tuner_name}{VAL} ne $$tunerRef{type} )
{
readingsBulkUpdate( $hash, $tuner_name, $$tunerRef{type} );
}
}
# multiple
else {
for ( keys %tuner ) {
my $tuner_name = lc($_);
$tuner_name =~ s/\s/_/g;
my $tuner_type = $tuner{$_}{type};
if ( !defined( $hash->{READINGS}{$tuner_name}{VAL} )
|| $hash->{READINGS}{$tuner_name}{VAL} ne $tuner_type )
{
readingsBulkUpdate( $hash, $tuner_name, $tuner_type );
}
}
}
}
}
# Service and Event information
#
if ( ref($currsrvinfo) eq "HASH" ) {
my $reading;
my $e2reading;
# Service readings
foreach (
"servicereference", "servicename", "providername",
"servicevideosize", "videowidth", "videoheight",
"iswidescreen", "apid", "vpid",
"pcrpid", "pmtpid", "txtpid",
"tsid", "onid", "sid"
)
{
$reading = $_;
$e2reading = "e2" . $_;
if ( defined( $currsrvinfo->{e2service}{$e2reading} )
&& lc( $currsrvinfo->{e2service}{$e2reading} ) ne "n/a"
&& lc( $currsrvinfo->{e2service}{$e2reading} ) ne "n/axn/a" )
{
if ( $currsrvinfo->{e2service}{$e2reading} eq "False"
|| $currsrvinfo->{e2service}{$e2reading} eq "True" )
{
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne
lc( $currsrvinfo->{e2service}{$e2reading} ) )
{
readingsBulkUpdate( $hash, $reading,
lc( $currsrvinfo->{e2service}{$e2reading} ) );
}
}
else {
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne
$currsrvinfo->{e2service}{$e2reading} )
{
readingsBulkUpdate( $hash, $reading,
$currsrvinfo->{e2service}{$e2reading} );
# channel
if ( $reading eq "servicename" ) {
my $val = $currsrvinfo->{e2service}{$e2reading};
$val =~ s/\s/_/g;
readingsBulkUpdate( $hash, "channel", $val );
}
# currentMedia
readingsBulkUpdate( $hash, "currentMedia",
$currsrvinfo->{e2service}{$e2reading} )
if $reading eq "servicereference";
}
}
# input
if ( $reading eq "servicereference" ) {
my @servicetype =
split( /:/, $currsrvinfo->{e2service}{$e2reading} );
if ( defined( $servicetype[2] )
&& $servicetype[2] eq "2" )
{
$hash->{helper}{lastInput} = "radio";
readingsBulkUpdate( $hash, "input", "radio" );
}
else {
$hash->{helper}{lastInput} = "tv";
readingsBulkUpdate( $hash, "input", "tv" );
}
}
}
else {
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne "-" )
{
readingsBulkUpdate( $hash, $reading, "-" );
# channel
readingsBulkUpdate( $hash, "channel", "-" )
if $reading eq "servicename";
# currentMedia
readingsBulkUpdate( $hash, "currentMedia", "-" )
if $reading eq "servicereference";
}
}
}
# Event readings
#
if ( defined( $currsrvinfo->{e2eventlist} ) ) {
my $eventNow;
my $eventNext;
if ( ref( $currsrvinfo->{e2eventlist}{e2event} ) eq "ARRAY" ) {
$eventNow = $currsrvinfo->{e2eventlist}{e2event}[0];
$eventNext = $currsrvinfo->{e2eventlist}{e2event}[1]
if ( defined( $currsrvinfo->{e2eventlist}{e2event}[1] ) );
}
else {
$eventNow = $currsrvinfo->{e2eventlist}{e2event};
}
foreach (
"eventstart", "eventduration", "eventremaining",
"eventcurrenttime", "eventdescription", "eventtitle",
"eventname",
)
{
$reading = $_;
$e2reading = "e2" . $_;
# current event
if ( defined( $eventNow->{$e2reading} )
&& lc( $eventNow->{$e2reading} ) ne "n/a"
&& $eventNow->{$e2reading} ne "0"
&& $eventNow->{$e2reading} ne "" )
{
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne
$eventNow->{$e2reading} )
{
readingsBulkUpdate( $hash, $reading,
$eventNow->{$e2reading} );
# currentTitle
readingsBulkUpdate( $hash, "currentTitle",
$eventNow->{$e2reading} )
if $reading eq "eventtitle";
}
}
else {
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne "-" )
{
readingsBulkUpdate( $hash, $reading, "-" );
# currentTitle
readingsBulkUpdate( $hash, "currentTitle", "-" )
if $reading eq "eventtitle";
}
}
# next event
$reading = $_ . "_next";
if ( defined( $eventNext->{$e2reading} )
&& lc( $eventNext->{$e2reading} ) ne "n/a"
&& $eventNext->{$e2reading} ne "0"
&& $eventNext->{$e2reading} ne "" )
{
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne
$eventNext->{$e2reading} )
{
readingsBulkUpdate( $hash, $reading,
$eventNext->{$e2reading} );
# nextTitle
readingsBulkUpdate( $hash, "nextTitle",
$eventNext->{$e2reading} )
if $reading eq "eventtitle_next";
}
}
else {
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne "-" )
{
readingsBulkUpdate( $hash, $reading, "-" );
# nextTitle
readingsBulkUpdate( $hash, "nextTitle", "-" )
if $reading eq "eventtitle_next";
}
}
}
# convert date+time into human readable formats
foreach (
"eventstart", "eventcurrenttime",
"eventduration", "eventremaining"
)
{
$reading = $_ . "_hr";
$e2reading = "e2" . $_;
# current event
if ( defined( $eventNow->{$e2reading} )
&& $eventNow->{$e2reading} ne "0"
&& $eventNow->{$e2reading} ne "" )
{
my $timestring;
if ( $_ eq "eventduration"
|| $_ eq "eventremaining" )
{
my @t = localtime( $eventNow->{$e2reading} );
$timestring =
sprintf( "%02d:%02d:%02d", $t[2] - 1, $t[1], $t[0] );
}
else {
$timestring =
substr( FmtDateTime( $eventNow->{$e2reading} ), 11 );
}
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne $timestring )
{
readingsBulkUpdate( $hash, $reading, $timestring );
}
}
else {
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne "-" )
{
readingsBulkUpdate( $hash, $reading, "-" );
}
}
# next event
$reading = $_ . "_next_hr";
if ( defined( $eventNext->{$e2reading} )
&& $eventNext->{$e2reading} ne "0"
&& $eventNext->{$e2reading} ne "" )
{
my $timestring;
if ( $_ eq "eventduration"
|| $_ eq "eventremaining" )
{
my @t = localtime( $eventNext->{$e2reading} );
$timestring =
sprintf( "%02d:%02d:%02d", $t[2] - 1, $t[1], $t[0] );
}
else {
$timestring =
substr( FmtDateTime( $eventNext->{$e2reading} ), 11 );
}
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne $timestring )
{
readingsBulkUpdate( $hash, $reading, $timestring );
}
}
else {
if ( !defined( $hash->{READINGS}{$reading}{VAL} )
|| $hash->{READINGS}{$reading}{VAL} ne "-" )
{
readingsBulkUpdate( $hash, $reading, "-" );
}
}
}
}
}
# Volume
#
if ( ref($vol) eq "HASH" && defined( $vol->{e2current} ) ) {
if ( !defined( $hash->{READINGS}{volume}{VAL} )
|| $hash->{READINGS}{volume}{VAL} ne $vol->{e2current} )
{
readingsBulkUpdate( $hash, "volume", $vol->{e2current} );
}
}
if ( ref($vol) eq "HASH" && defined( $vol->{e2ismuted} ) ) {
my $muteState = "on";
if ( lc( $vol->{e2ismuted} ) eq "false" ) {
$muteState = "off";
}
if ( !defined( $hash->{READINGS}{mute}{VAL} )
|| $hash->{READINGS}{mute}{VAL} ne $muteState )
{
readingsBulkUpdate( $hash, "mute", $muteState );
}
}
# Signal
#
if ( ref($signalinfo) eq "HASH"
&& defined( $signalinfo->{e2snrdb} ) )
{
foreach ( "snrdb", "snr", "ber", "acg", ) {
$reading = $_;
$e2reading = "e2" . $_;
if ( defined( $signalinfo->{$e2reading} )
&& lc( $signalinfo->{$e2reading} ) ne "n/a" )
{
my @value = split( / /, $signalinfo->{$e2reading} );
if ( defined( $value[1] ) || $reading eq "ber" ) {
readingsBulkUpdate( $hash, $reading, $value[0] );
}
else {
readingsBulkUpdate( $hash, $reading, "0" );
}
}
else {
readingsBulkUpdate( $hash, $reading, "0" );
}
}
}
# Set ENIGMA2 online-only readings to "-" in case box is in
# offline or in standby mode
if ( $state eq "off" || $state eq "absent" || $state eq "undefined" ) {
foreach (
'servicename', 'providername',
'servicereference', 'videowidth',
'videoheight', 'servicevideosize',
'apid', 'vpid',
'pcrpid', 'pmtpid',
'txtpid', 'tsid',
'onid', 'sid',
'iswidescreen', 'mute',
'volume', 'channel',
'currentTitle', 'nextTitle',
'currentMedia', 'eventcurrenttime',
'eventcurrenttime_hr', 'eventdescription',
'eventduration', 'eventduration_hr',
'eventremaining', 'eventremaining_hr',
'eventstart', 'eventstart_hr',
'eventtitle', 'eventname',
'eventcurrenttime_next', 'eventcurrenttime_next_hr',
'eventdescription_next', 'eventduration_next',
'eventduration_next_hr', 'eventremaining_next',
'eventremaining_next_hr', 'eventstart_next',
'eventstart_next_hr', 'eventtitle_next',
'eventname_next',
)
{
if ( !defined( $hash->{READINGS}{$_}{VAL} )
|| $hash->{READINGS}{$_}{VAL} ne "-" )
{
readingsBulkUpdate( $hash, $_, "-" );
}
}
# special handling for signal values
foreach ( 'acg', 'ber', 'snr', 'snrdb', ) {
if ( !defined( $hash->{READINGS}{$_}{VAL} )
|| $hash->{READINGS}{$_}{VAL} ne "0" )
{
readingsBulkUpdate( $hash, $_, "0" );
}
}
}
# Set ENIGMA2 online+standby readings to "-" in case box is in
# offline mode
if ( $state eq "absent" || $state eq "undefined" ) {
foreach ( 'input', ) {
if ( !defined( $hash->{READINGS}{$_}{VAL} )
|| $hash->{READINGS}{$_}{VAL} ne "-" )
{
readingsBulkUpdate( $hash, $_, "-" );
}
}
}
readingsEndUpdate( $hash, 1 );
return $hash->{STATE};
}
###################################
sub ENIGMA2_Get($@) {
my ( $hash, @a ) = @_;
my $name = $hash->{NAME};
my $what;
Log3 $name, 5, "ENIGMA2 $name: called function ENIGMA2_Get()";
return "argument is missing" if ( int(@a) < 2 );
$what = $a[1];
if ( $what =~
/^(power|input|volume|mute|channel|currentMedia|currentTitle|serviceprovider|servicevideosize)$/
)
{
ENIGMA2_GetStatus( $hash, 1 );
if ( defined( $hash->{READINGS}{$what} ) ) {
return $hash->{READINGS}{$what}{VAL};
}
else {
return "no such reading: $what";
}
}
# streamUrl
elsif ( $what eq "streamUrl" ) {
if ( defined( $a[2] ) && $a[2] eq "mobile" ) {
return
"http://"
. $hash->{helper}{ADDRESS} . ":"
. $hash->{helper}{PORT}
. "/web/stream.m3u?ref="
. urlEncode( $hash->{READINGS}{servicereference}{VAL} )
. "&device=phone";
}
else {
return
"http://"
. $hash->{helper}{ADDRESS} . ":"
. $hash->{helper}{PORT}
. "/web/stream.m3u?ref="
. urlEncode( $hash->{READINGS}{servicereference}{VAL} )
. "&device=etc";
}
}
else {
return
"Unknown argument $what, choose one of power:noArg input:noArg volume:noArg mute:noArg channel:noArg currentMedia:noArg currentTitle:noArg serviceprovider:noArg servicevideosize:noArg streamUrl:,mobile ";
}
}
###################################
sub ENIGMA2_Set($@) {
my ( $hash, @a ) = @_;
my $name = $hash->{NAME};
my $state = $hash->{STATE};
my $channel = $hash->{READINGS}{channel}{VAL}
if ( defined( $hash->{READINGS}{channel}{VAL} ) );
my $channels = "";
if ( defined( $hash->{READINGS}{input}{VAL} )
&& $hash->{READINGS}{input}{VAL} ne "-" )
{
$hash->{helper}{lastInput} = $hash->{READINGS}{input}{VAL};
}
elsif ( !defined( $hash->{helper}{lastInput} ) ) {
$hash->{helper}{lastInput} = "";
}
my $input = $hash->{helper}{lastInput};
Log3 $name, 5, "ENIGMA2 $name: called function ENIGMA2_Set()";
return "No Argument given" if ( !defined( $a[1] ) );
# load channel list
if (
defined($input)
&& defined($channel)
&& $input ne ""
&& $channel ne ""
&& ( !defined( $hash->{helper}{bouquet}{$input} )
|| !defined( $hash->{helper}{bouquet}{$input}{$channel} ) )
)
{
$channels .= $channel . ",";
}
if ( $input ne ""
&& defined( $hash->{helper}{channels}{$input} )
&& ref( $hash->{helper}{channels}{$input} ) eq "ARRAY" )
{
$channels .= join( ',', @{ $hash->{helper}{channels}{$input} } );
}
my $usage =
"Unknown argument "
. $a[1]
. ", choose one of statusRequest:noArg toggle:noArg on:noArg off:noArg reboot:noArg restartGui:noArg shutdown:noArg volume:slider,0,1,100 volumeUp:noArg volumeDown:noArg mute:on,off msg remoteControl:UP,DOWN,LEFT,RIGHT,OK,MENU,EPG,ESC,EXIT,RECORD,RED,GREEN,YELLOW,BLUE,AUDIO channelUp:noArg channelDown:noArg play:noArg pause:noArg stop:noArg showText channel:"
. $channels;
$usage .= " input:-,tv,radio"
if ( defined( $hash->{READINGS}{input}{VAL} )
&& $hash->{READINGS}{input}{VAL} eq "-" );
$usage .= " input:tv,radio"
if ( defined( $hash->{READINGS}{input}{VAL} )
&& $hash->{READINGS}{input}{VAL} ne "-" );
my $cmd = '';
my $result;
# statusRequest
if ( $a[1] eq "statusRequest" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $state ne "absent" ) {
Log3 $name, 4,
"ENIGMA2 $name: Clearing cache for bouquet and channels";
$hash->{helper}{bouquet} = undef;
$hash->{helper}{channels} = undef;
}
# actual statusRequest be executed anyway on the end of the function
}
# toggle
elsif ( $a[1] eq "toggle" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{power}{VAL} eq "off" ) {
return ENIGMA2_Set( $hash, $name, "on" );
}
else {
return ENIGMA2_Set( $hash, $name, "off" );
}
}
# shutdown
elsif ( $a[1] eq "shutdown" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{state}{VAL} ne "absent" ) {
$cmd = "newstate=1";
$result = ENIGMA2_SendCommand( $hash, "powerstate", $cmd );
readingsBeginUpdate($hash);
if ( !defined( $hash->{READINGS}{state}{VAL} )
|| $hash->{READINGS}{power}{VAL} ne "off" )
{
readingsBulkUpdate( $hash, "power", "off" );
}
if ( !defined( $hash->{READINGS}{presence}{VAL} )
|| $hash->{READINGS}{presence}{VAL} ne "absent" )
{
$hash->{helper}{AVAILABLE} = 0;
readingsBulkUpdate( $hash, "presence", "absent" );
}
if ( !defined( $hash->{READINGS}{state}{VAL} )
|| $hash->{READINGS}{state}{VAL} ne "absent" )
{
readingsBulkUpdate( $hash, "state", "absent" );
}
readingsEndUpdate( $hash, 1 );
}
else {
return "Device needs to be ON to be set to standby mode.";
}
}
# reboot
elsif ( $a[1] eq "reboot" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{state}{VAL} ne "absent" ) {
$cmd = "newstate=2";
$result = ENIGMA2_SendCommand( $hash, "powerstate", $cmd );
}
else {
return "Device needs to be reachable to be rebooted.";
}
}
# restartGui
elsif ( lc( $a[1] ) eq "restartgui" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{state}{VAL} eq "on" ) {
$cmd = "newstate=3";
$result = ENIGMA2_SendCommand( $hash, "powerstate", $cmd );
}
else {
return "Device needs to be ON to restart the GUI.";
}
}
# on
elsif ( $a[1] eq "on" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{state}{VAL} eq "absent" ) {
if ( defined( $hash->{READINGS}{lanmac}{VAL} )
&& $hash->{READINGS}{lanmac}{VAL} ne "-" )
{
$result = ENIGMA2_wake($hash);
}
else {
return
"Device MAC address unknown. Please turn on the device manually once.";
}
}
else {
$cmd = "newstate=4";
$result = ENIGMA2_SendCommand( $hash, "powerstate", $cmd );
readingsBeginUpdate($hash);
if ( !defined( $hash->{READINGS}{power}{VAL} )
|| $hash->{READINGS}{power}{VAL} ne "on" )
{
readingsBulkUpdate( $hash, "power", "on" );
}
if ( !defined( $hash->{READINGS}{state}{VAL} )
|| $hash->{READINGS}{state}{VAL} ne "on" )
{
readingsBulkUpdate( $hash, "state", "on" );
}
readingsEndUpdate( $hash, 1 );
ENIGMA2_GetStatus( $hash, 1 );
}
}
# off
elsif ( $a[1] eq "off" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{state}{VAL} ne "absent" ) {
$cmd = "newstate=5";
$result = ENIGMA2_SendCommand( $hash, "powerstate", $cmd );
readingsBeginUpdate($hash);
if ( !defined( $hash->{READINGS}{power}{VAL} )
|| $hash->{READINGS}{power}{VAL} ne "off" )
{
readingsBulkUpdate( $hash, "power", "off" );
}
if ( !defined( $hash->{READINGS}{state}{VAL} )
|| $hash->{READINGS}{state}{VAL} ne "off" )
{
readingsBulkUpdate( $hash, "state", "off" );
}
readingsEndUpdate( $hash, 1 );
}
else {
return "Device needs to be reachable to be set to standby mode.";
}
}
# volume
elsif ( $a[1] eq "volume" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1] . " " . $a[2];
return "No argument given" if ( !defined( $a[2] ) );
if ( $hash->{READINGS}{state}{VAL} eq "on" ) {
my $_ = $a[2];
if ( m/^\d+$/ && $_ >= 0 && $_ <= 100 ) {
$cmd = "set=set" . $a[2];
if ( !defined( $hash->{READINGS}{volume}{VAL} )
|| $hash->{READINGS}{volume}{VAL} ne $a[2] )
{
readingsSingleUpdate( $hash, "volume", $a[2], 1 );
}
}
else {
return
"Argument does not seem to be a valid integer between 0 and 100";
}
$result = ENIGMA2_SendCommand( $hash, "vol", $cmd );
}
else {
return "Device needs to be ON to adjust volume.";
}
}
# volumeUp/volumeDown
elsif ( $a[1] =~ /^(volumeUp|volumeDown)$/ ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{state}{VAL} eq "on" ) {
if ( $a[1] eq "volumeUp" ) {
$cmd = "set=up";
}
else {
$cmd = "set=down";
}
$result = ENIGMA2_SendCommand( $hash, "vol", $cmd );
}
else {
return "Device needs to be ON to adjust volume.";
}
}
# mute
elsif ( $a[1] eq "mute" ) {
if ( defined( $a[2] ) ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1] . " " . $a[2];
}
else {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
}
if ( $hash->{READINGS}{state}{VAL} eq "on" ) {
if ( !defined( $a[2] ) || $a[2] eq "toggle" ) {
$cmd = "set=mute";
if ( $hash->{READINGS}{mute}{VAL} eq "off" ) {
readingsSingleUpdate( $hash, "mute", "on", 1 );
}
else {
readingsSingleUpdate( $hash, "mute", "off", 1 );
}
}
elsif ( $a[2] eq "off" ) {
if ( $hash->{READINGS}{mute}{VAL} ne "off" ) {
$cmd = "set=mute";
readingsSingleUpdate( $hash, "mute", $a[2], 1 );
}
}
elsif ( $a[2] eq "on" ) {
if ( $hash->{READINGS}{mute}{VAL} ne "on" ) {
$cmd = "set=mute";
readingsSingleUpdate( $hash, "mute", $a[2], 1 );
}
}
else {
return "Unknown argument " . $a[2];
}
$result = ENIGMA2_SendCommand( $hash, "vol", $cmd );
}
else {
return "Device needs to be ON to mute/unmute audio.";
}
}
# msg
elsif ( $a[1] eq "msg" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1] . " " . $a[2];
if ( $hash->{READINGS}{state}{VAL} ne "absent" ) {
return
"No 1st argument given, choose one of yesno info message attention "
if ( !defined( $a[2] ) );
return "No 2nd argument given, choose one of timeout "
if ( !defined( $a[3] ) );
return "No 3nd argument given, choose one of messagetext "
if ( !defined( $a[4] ) );
$_ = $a[3];
return
"Argument "
. $_
. " is not a valid integer between 5 and 49680"
if ( !m/^\d+$/ || $_ < 5 || $_ > 49680 );
my $i = 4;
my $text = $a[$i];
$i++;
if ( defined( $a[$i] ) ) {
my $arr_size = @a;
while ( $i < $arr_size ) {
$text = $text . " " . $a[$i];
$i++;
}
}
if ( $a[2] eq "yesno" ) {
$cmd = "type=0&timeout=" . $a[3] . "&text=" . urlEncode($text);
}
elsif ( $a[2] eq "info" ) {
$cmd = "type=1&timeout=" . $a[3] . "&text=" . urlEncode($text);
}
elsif ( $a[2] eq "message" ) {
$cmd = "type=2&timeout=" . $a[3] . "&text=" . urlEncode($text);
}
elsif ( $a[2] eq "attention" ) {
$cmd = "type=3&timeout=" . $a[3] . "&text=" . urlEncode($text);
}
else {
return
"Unknown argument "
. $a[2]
. ", choose one of yesno info message attention ";
}
$result = ENIGMA2_SendCommand( $hash, "message", $cmd );
}
else {
return "Device needs to be reachable to send a message to screen.";
}
}
# remoteControl
elsif ( lc( $a[1] ) eq "remotecontrol" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1] . " " . $a[2];
if ( $hash->{READINGS}{state}{VAL} ne "absent" ) {
if ( !defined( $a[2] ) ) {
my $commandKeys = "";
for (
sort keys %{
ENIGMA2_GetRemotecontrolCommand(
"GetRemotecontrolCommands")
}
)
{
$commandKeys = $commandKeys . " " . $_;
}
return "No argument given, choose one of" . $commandKeys;
}
my $request = ENIGMA2_GetRemotecontrolCommand( uc( $a[2] ) );
if ( uc( $a[2] ) eq "POWER" ) {
return ENIGMA2_Set( $hash, $name, "toggle" );
}
elsif ( uc( $a[2] ) eq "MUTE" ) {
return ENIGMA2_Set( $hash, $name, "mute" );
}
elsif ( $request ne "" ) {
$cmd = "command=" . ENIGMA2_GetRemotecontrolCommand( $a[2] );
}
else {
my $commandKeys = "";
for (
sort keys %{
ENIGMA2_GetRemotecontrolCommand(
"GetRemotecontrolCommands")
}
)
{
$commandKeys = $commandKeys . " " . $_;
}
return
"Unknown argument "
. $a[2]
. ", choose one of"
. $commandKeys;
}
$result = ENIGMA2_SendCommand( $hash, "remotecontrol", $cmd );
}
else {
return "Device needs to be reachable to be controlled remotely.";
}
}
# channel
elsif ( $a[1] eq "channel" ) {
if ( defined( $a[2] )
&& $hash->{READINGS}{presence}{VAL} eq "present"
&& $hash->{READINGS}{state}{VAL} ne "on" )
{
Log3 $name, 4, "ENIGMA2 $name: indirect switching request to ON";
ENIGMA2_Set( $hash, $name, "on" );
}
Log3 $name, 2, "ENIGMA2 set $name " . $a[1] . " " . $a[2];
return
"No argument given, choose one of channel channelNumber servicereference "
if ( !defined( $a[2] ) );
if ( $hash->{READINGS}{state}{VAL} eq "on" ) {
my $_ = $a[2];
if ( defined( $hash->{helper}{bouquet}{$input}{$_}{sRef} ) ) {
$result = ENIGMA2_SendCommand( $hash, "zap",
"sRef="
. urlEncode( $hash->{helper}{bouquet}{$input}{$_}{sRef} )
);
}
elsif (m/^(\d+):(.*):$/) {
$result =
ENIGMA2_SendCommand( $hash, "zap", "sRef=" . urlEncode($_) );
}
elsif ( m/^\d+$/ && $_ > 0 && $_ < 10000 ) {
for ( split( //, $a[2] ) ) {
$cmd = "command=" . ENIGMA2_GetRemotecontrolCommand($_);
$result =
ENIGMA2_SendCommand( $hash, "remotecontrol", $cmd );
}
$result = ENIGMA2_SendCommand( $hash, "remotecontrol",
"command=" . ENIGMA2_GetRemotecontrolCommand("OK") );
}
else {
return "Argument " . $_
. " is not a valid integer between 0 and 9999 or servicereference is invalid";
}
}
else {
return
"Device needs to be present to switch to a specific channel.";
}
}
# channelUp/channelDown
elsif ( $a[1] =~ /^(channelUp|channelDown)$/ ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{state}{VAL} eq "on" ) {
if ( $a[1] eq "channelUp" ) {
$cmd = "command=" . ENIGMA2_GetRemotecontrolCommand("RIGHT");
}
else {
$cmd = "command=" . ENIGMA2_GetRemotecontrolCommand("LEFT");
}
$result = ENIGMA2_SendCommand( $hash, "remotecontrol", $cmd );
}
else {
return "Device needs to be ON to switch channel.";
}
}
# input
elsif ( $a[1] eq "input" ) {
if ( defined( $a[2] )
&& $hash->{READINGS}{presence}{VAL} eq "present"
&& $hash->{READINGS}{state}{VAL} ne "on" )
{
Log3 $name, 4, "ENIGMA2 $name: indirect switching request to ON";
ENIGMA2_Set( $hash, $name, "on" );
}
return "No argument given, choose one of tv radio "
if ( !defined( $a[2] ) );
Log3 $name, 2, "ENIGMA2 set $name " . $a[1] . " " . $a[2];
if ( $hash->{READINGS}{state}{VAL} eq "on" ) {
if ( $a[2] eq "tv" || $a[2] eq "TV" ) {
$cmd = "command=" . ENIGMA2_GetRemotecontrolCommand("TV");
$hash->{helper}{lastInput} = "tv";
readingsSingleUpdate( $hash, "input", "tv", 1 );
}
elsif ( $a[2] eq "radio" || $a[2] eq "RADIO" ) {
$cmd = "command=" . ENIGMA2_GetRemotecontrolCommand("RADIO");
$hash->{helper}{lastInput} = "radio";
readingsSingleUpdate( $hash, "input", "radio", 1 );
}
else {
return
"Argument "
. $a[2]
. " is not valid, please choose one from tv radio ";
}
$result = ENIGMA2_SendCommand( $hash, "remotecontrol", $cmd );
}
else {
return "Device needs to be present to switch input.";
}
}
# play / pause
elsif ( $a[1] =~ /^(play|pause)$/ ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{state}{VAL} eq "on" ) {
$cmd = "command=" . ENIGMA2_GetRemotecontrolCommand("PLAYPAUSE");
$result = ENIGMA2_SendCommand( $hash, "remotecontrol", $cmd );
}
else {
return "Device needs to be ON to play or pause video.";
}
}
# stop
elsif ( $a[1] eq "stop" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{state}{VAL} eq "on" ) {
$cmd = "command=" . ENIGMA2_GetRemotecontrolCommand("STOP");
$result = ENIGMA2_SendCommand( $hash, "remotecontrol", $cmd );
}
else {
return "Device needs to be ON to stop video.";
}
}
# showText
elsif ( $a[1] eq "showText" ) {
Log3 $name, 2, "ENIGMA2 set $name " . $a[1];
if ( $hash->{READINGS}{state}{VAL} ne "absent" ) {
return "No argument given, choose one of messagetext "
if ( !defined( $a[2] ) );
my $i = 2;
my $text = $a[$i];
$i++;
if ( defined( $a[$i] ) ) {
my $arr_size = @a;
while ( $i < $arr_size ) {
$text = $text . " " . $a[$i];
$i++;
}
}
$cmd = "type=1&timeout=8&text=" . urlEncode($text);
$result = ENIGMA2_SendCommand( $hash, "message", $cmd );
}
else {
return "Device needs to be reachable to send a message to screen.";
}
}
# return usage hint
else {
return $usage;
}
# Call the GetStatus() Function to retrieve the new values after setting
# something (with local flag, so the internal timer is not getting interupted)
if ( $a[1] ne "shutdown"
&& $a[1] ne "on"
&& $a[1] ne "mute"
&& lc( $a[1] ) ne "restartgui"
&& lc( $a[1] ) ne "remotecontrol"
&& $a[1] ne "reboot" )
{
ENIGMA2_GetStatus( $hash, 1 );
}
return undef;
}
###################################
sub ENIGMA2_Define($$) {
my ( $hash, $def ) = @_;
my @a = split( "[ \t][ \t]*", $def );
my $name = $hash->{NAME};
Log3 $name, 5, "ENIGMA2 $name: called function ENIGMA2_Define()";
if ( int(@a) < 3 ) {
my $msg =
"Wrong syntax: define ENIGMA2 [] [] []";
Log3 $name, 4, $msg;
return $msg;
}
my $address = $a[2];
$hash->{helper}{ADDRESS} = $address;
# use port 80 if not defined
my $port = $a[3] || 80;
$hash->{helper}{PORT} = $port;
# use interval of 75sec if not defined
my $interval = $a[4] || 75;
$hash->{INTERVAL} = $interval;
# set http user if defined
my $http_user = $a[5];
$hash->{helper}{USER} = $http_user if $http_user;
# set http password if defined
my $http_passwd = $a[6];
$hash->{helper}{PASSWORD} = $http_passwd if $http_passwd;
# set default attributes
unless ( exists( $attr{$name}{"http-method"} ) ) {
# use http-method POST for FritzBox environment as GET does not seem to
# work properly. Might restrict use to newer
# ENIGMA2 Webif versions or use of OWIF only.
if ( exists $ENV{CONFIG_PRODUKT_NAME}
&& defined $ENV{CONFIG_PRODUKT_NAME} )
{
$attr{$name}{"http-method"} = 'POST';
}
# default method is GET and should be compatible to most
# ENIGMA2 Webif versions
else {
$attr{$name}{"http-method"} = 'GET';
}
}
unless ( exists( $attr{$name}{webCmd} ) ) {
$attr{$name}{webCmd} = 'channel:input';
}
unless ( exists( $attr{$name}{devStateIcon} ) ) {
$attr{$name}{devStateIcon} =
'on:rc_GREEN:off off:rc_YELLOW:on absent:rc_STOP:on';
}
unless ( exists( $attr{$name}{icon} ) ) {
$attr{$name}{icon} = 'dreambox';
}
unless ( exists( $hash->{helper}{AVAILABLE} )
and ( $hash->{helper}{AVAILABLE} == 0 ) )
{
$hash->{helper}{AVAILABLE} = 1;
readingsSingleUpdate( $hash, "presence", "present", 1 );
}
# start the status update timer
RemoveInternalTimer($hash);
InternalTimer( gettimeofday() + 2, "ENIGMA2_GetStatus", $hash, 0 );
return undef;
}
############################################################################################################
#
# Begin of helper functions
#
############################################################################################################
###################################
sub ENIGMA2_SendCommand($$;$) {
my ( $hash, $service, $cmd ) = @_;
my $name = $hash->{NAME};
my $address = $hash->{helper}{ADDRESS};
my $port = $hash->{helper}{PORT};
my $http_method = $attr{$name}{"http-method"};
my $timeout;
Log3 $name, 5, "ENIGMA2 $name: called function ENIGMA2_SendCommand()";
my $http_proto;
if ( $port eq "443" ) {
$http_proto = "https";
}
elsif ( defined( $attr{$name}{https} ) && $attr{$name}{https} eq "1" ) {
$http_proto = "https";
$port = "443" if ( $port eq "80" );
}
else {
$http_proto = "http";
}
my $http_user = $hash->{helper}{USER}
if ( defined( $hash->{helper}{USER} ) );
my $http_passwd = $hash->{helper}{PASSWORD}
if ( defined( $hash->{helper}{PASSWORD} ) );
my $URL;
my $response;
my $return;
if ( !defined($cmd) || $cmd eq "" ) {
Log3 $name, 4, "ENIGMA2 $name: REQ $service";
}
else {
$cmd = "?" . $cmd . "&"
if ( $http_method eq "GET" || $http_method eq "" );
Log3 $name, 4, "ENIGMA2 $name: REQ $service/" . urlDecode($cmd);
}
if ( defined($http_user) && defined($http_passwd) ) {
$URL =
$http_proto . "://"
. $http_user . ":"
. $http_passwd . "@"
. $address . ":"
. $port . "/web/"
. $service;
$URL .= $cmd if ( $http_method eq "GET" || $http_method eq "" );
}
elsif ( defined($http_user) ) {
$URL =
$http_proto . "://"
. $http_user . "@"
. $address . ":"
. $port . "/web/"
. $service;
$URL .= $cmd if ( $http_method eq "GET" || $http_method eq "" );
}
else {
$URL =
$http_proto . "://" . $address . ":" . $port . "/web/" . $service;
$URL .= $cmd if ( $http_method eq "GET" || $http_method eq "" );
}
if ( defined( $attr{$name}{timeout} )
&& $attr{$name}{timeout} =~ /^\d+$/ )
{
$timeout = $attr{$name}{timeout};
}
else {
$timeout = 6;
}
# send request via HTTP-GET method
if ( $http_method eq "GET" || $http_method eq "" || $cmd eq "" ) {
Log3 $name, 5, "ENIGMA2 $name: GET " . urlDecode($URL);
$response = CustomGetFileFromURL( 0, $URL, $timeout, undef, 0, 5 );
}
# send request via HTTP-POST method
elsif ( $http_method eq "POST" ) {
Log3 $name, 5,
"ENIGMA2 $name: GET "
. $URL
. " (POST DATA: "
. urlDecode($cmd) . ")";
$response = CustomGetFileFromURL( 0, $URL, $timeout, $cmd, 0, 5 );
}
# other HTTP methods are not supported
else {
Log3 $name, 1,
"ENIGMA2 $name: ERROR: HTTP method "
. $http_method
. " is not supported.";
}
unless ( defined($response) ) {
if (
( not exists( $hash->{helper}{AVAILABLE} ) )
or ( exists( $hash->{helper}{AVAILABLE} )
and $hash->{helper}{AVAILABLE} eq 1 )
)
{
Log3 $name, 3, "ENIGMA2 device $name is unavailable";
readingsSingleUpdate( $hash, "presence", "absent", 1 );
}
}
else {
if ( defined( $hash->{helper}{AVAILABLE} )
and $hash->{helper}{AVAILABLE} eq 0 )
{
Log3 $name, 3, "ENIGMA2 device $name is available";
readingsSingleUpdate( $hash, "presence", "present", 1 );
}
if ( !defined($cmd) || $cmd eq "" ) {
Log3 $name, 4, "ENIGMA2 $name: RCV $service";
}
else {
Log3 $name, 4, "ENIGMA2 $name: RCV $service/" . urlDecode($cmd);
}
if ( $response ne "" ) {
if ( $response =~ /^<\?xml/ && $response !~ /<\/html>/ ) {
if ( !defined($cmd) || $cmd eq "" ) {
Log3 $name, 5, "ENIGMA2 $name: RES $service\n" . $response;
}
else {
Log3 $name, 5,
"ENIGMA2 $name: RES $service/"
. urlDecode($cmd) . "\n"
. $response;
}
my $parser = XML::Simple->new(
NormaliseSpace => 2,
KeepRoot => 0,
ForceArray => 0,
SuppressEmpty => 1
);
$return = $parser->XMLin( Encode::encode_utf8($response) );
}
else {
if ( !defined($cmd) || $cmd eq "" ) {
Log3 $name, 5,
"ENIGMA2 $name: RES ERROR $service - not in XML format\n"
. $response;
}
else {
Log3 $name, 5,
"ENIGMA2 $name: RES ERROR $service/"
. urlDecode($cmd)
. " - not in XML format\n"
. $response;
}
return undef;
}
}
$hash->{helper}{AVAILABLE} = ( defined($response) ? 1 : 0 );
if ( ref($return) eq "HASH" ) {
return $return;
}
else {
return Encode::encode_utf8($response);
}
}
$hash->{helper}{AVAILABLE} = ( defined($response) ? 1 : 0 );
return undef;
}
###################################
sub ENIGMA2_Undefine($$) {
my ( $hash, $arg ) = @_;
my $name = $hash->{NAME};
Log3 $name, 5, "ENIGMA2 $name: called function ENIGMA2_Undefine()";
# Stop the internal GetStatus-Loop and exit
RemoveInternalTimer($hash);
return undef;
}
###################################
sub ENIGMA2_wake ($) {
my ($hash) = @_;
my $name = $hash->{NAME};
my $mac_addr = $hash->{READINGS}{lanmac}{VAL};
my $address;
my $port;
if ( $mac_addr ne "-" ) {
if ( !defined $address ) { $address = '255.255.255.255' }
if ( !defined $port || $port !~ /^\d+$/ ) { $port = 9 }
my $sock = new IO::Socket::INET( Proto => 'udp' )
or die "socket : $!";
die "Can't create WOL socket" if ( !$sock );
my $ip_addr = inet_aton($address);
my $sock_addr = sockaddr_in( $port, $ip_addr );
$mac_addr =~ s/://g;
my $packet =
pack( 'C6H*', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, $mac_addr x 16 );
setsockopt( $sock, SOL_SOCKET, SO_BROADCAST, 1 )
or die "setsockopt : $!";
Log3 $name, 4,
"ENIGMA2 $name: Waking up by sending Wake-On-Lan magic package to "
. $mac_addr;
send( $sock, $packet, 0, $sock_addr ) or die "send : $!";
close($sock);
}
else {
Log3 $name, 3,
"ENIGMA2 $name: Unknown MAC address. Please turn on device manually once.";
}
return 1;
}
#####################################
# Callback from 95_remotecontrol for command makenotify.
sub ENIGMA2_RCmakenotify($$) {
my ( $nam, $ndev ) = @_;
my $nname = "notify_$nam";
fhem( "define $nname notify $nam set $ndev remoteControl " . '$EVENT', 1 );
Log3 undef, 2, "[remotecontrol:ENIGMA2] Notify created: $nname";
return "Notify created by ENIGMA2: $nname";
}
#####################################
# RC layouts
# Dreambox DM500 + DM800 with SVG
sub ENIGMA2_RClayout_DM800_SVG() {
my @row;
$row[0] = ":rc_BLANK.svg,:rc_BLANK.svg,POWER:rc_POWER.svg";
$row[1] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[2] = "1:rc_1.svg,2:rc_2.svg,3:rc_3.svg";
$row[3] = "4:rc_4.svg,5:rc_5.svg,6:rc_6.svg";
$row[4] = "7:rc_7.svg,8:rc_8.svg,9:rc_9.svg";
$row[5] = "LEFTBRACE:rc_PREVIOUS.svg,0:rc_0.svg,RIGHTBRACE:rc_NEXT.svg";
$row[6] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[7] = "VOLUMEUP:rc_VOLPLUS.svg,MUTE:rc_MUTE.svg,CHANNELUP:rc_UP.svg";
$row[8] =
"VOLUMEDOWN:rc_VOLMINUS.svg,EXIT:rc_EXIT.svg,CHANNELDOWN:rc_DOWN.svg";
$row[9] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[10] = "INFO:rc_INFO.svg,UP:rc_UP.svg,MENU:rc_MENU.svg";
$row[11] = "LEFT:rc_LEFT.svg,OK:rc_OK.svg,RIGHT:rc_RIGHT.svg";
$row[12] = "AUDIO:rc_AUDIO.svg,DOWN:rc_DOWN.svg,VIDEO:rc_VIDEO.svg";
$row[13] = ":rc_BLANK.svg,EXIT:rc_EXIT.svg,:rc_BLANK.svg";
$row[14] =
"RED:rc_REWred.svg,GREEN:rc_PLAYgreen.svg,YELLOW:rc_PAUSEyellow.svg,BLUE:rc_FFblue.svg";
$row[15] =
"TV:rc_TVstop.svg,RADIO:rc_RADIOred.svg,TEXT:rc_TEXT.svg,HELP:rc_HELP.svg";
$row[16] = "attr rc_iconpath icons/remotecontrol";
$row[17] = "attr rc_iconprefix black_btn_";
return @row;
}
# Dreambox DM500 + DM800 with PNG
sub ENIGMA2_RClayout_DM800() {
my @row;
$row[0] = ":blank,:blank,POWER:POWEROFF";
$row[1] = ":blank,:blank,:blank";
$row[2] = "1,2,3";
$row[3] = "4,5,6";
$row[4] = "7,8,9";
$row[5] = "LEFTBRACE:LEFT2,0:0,RIGHTBRACE:RIGHT2";
$row[6] = ":blank,:blank,:blank";
$row[7] = "VOLUMEUP:VOLUP,MUTE,CHANNELUP:CHUP2";
$row[8] = "VOLUMEDOWN:VOLDOWN,EXIT,CHANNELDOWN:CHDOWN2";
$row[9] = ":blank,:blank,:blank";
$row[10] = "INFO,UP,MENU";
$row[11] = "LEFT,OK,RIGHT";
$row[12] = "AUDIO,DOWN,VIDEO";
$row[13] = ":blank,:blank,:blank";
$row[14] = "RED:REWINDred,GREEN:PLAYgreen,YELLOW:PAUSEyellow,BLUE:FFblue";
$row[15] = "TV:TVstop,RADIO:RADIOred,TEXT,HELP";
$row[16] = "attr rc_iconpath icons/remotecontrol";
$row[17] = "attr rc_iconprefix black_btn_";
return @row;
}
# Dreambox DM800se + DM8000 with SVG
sub ENIGMA2_RClayout_DM8000_SVG() {
my @row;
$row[0] = ":rc_BLANK.svg,:rc_BLANK.svg,POWER:rc_POWER.svg";
$row[1] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[2] = "1:rc_1.svg,2:rc_2.svg,3:rc_3.svg";
$row[3] = "4:rc_4.svg,5:rc_5.svg,6:rc_6.svg";
$row[4] = "7:rc_7.svg,8:rc_8.svg,9:rc_9.svg";
$row[5] = "LEFTBRACE:rc_PREVIOUS.svg,0:rc_0.svg,RIGHTBRACE:rc_NEXT.svg";
$row[6] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[7] = "VOLUMEUP:rc_VOLPLUS.svg,MUTE:rc_MUTE.svg,CHANNELUP:rc_UP.svg";
$row[8] =
"VOLUMEDOWN:rc_VOLMINUS.svg,EXIT:rc_EXIT.svg,CHANNELDOWN:rc_DOWN.svg";
$row[9] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[10] = "INFO:rc_INFO.svg,UP:rc_UP.svg,MENU:rc_MENU.svg";
$row[11] = "LEFT:rc_LEFT.svg,OK:rc_OK.svg,RIGHT:rc_RIGHT.svg";
$row[12] = "AUDIO:rc_AUDIO.svg,DOWN:rc_DOWN.svg,VIDEO:rc_VIDEO.svg";
$row[13] = ":rc_BLANK.svg,EXIT:rc_EXIT.svg,:rc_BLANK.svg";
$row[14] =
"RED:rc_RED.svg,GREEN:rc_GREEN.svg,YELLOW:rc_YELLOW.svg,BLUE:rc_BLUE.svg";
$row[15] =
"REWIND:rc_REW.svg,PLAY:rc_PLAY.svg,STOP:rc_STOP.svg,FASTFORWARD:rc_FF.svg";
$row[16] =
"TV:rc_TV.svg,RADIO:rc_RADIO.svg,TEXT:rc_TEXT.svg,RECORD:rc_REC.svg";
$row[17] = "attr rc_iconpath icons/remotecontrol";
$row[18] = "attr rc_iconprefix black_btn_";
return @row;
}
# Dreambox DM800se + DM8000 with PNG
sub ENIGMA2_RClayout_DM8000() {
my @row;
$row[0] = ":blank,:blank,POWER:POWEROFF";
$row[1] = ":blank,:blank,:blank";
$row[2] = "1,2,3";
$row[3] = "4,5,6";
$row[4] = "7,8,9";
$row[5] = "LEFTBRACE:LEFT2,0:0,RIGHTBRACE:RIGHT2";
$row[6] = ":blank,:blank,:blank";
$row[7] = "VOLUMEUP:VOLUP,MUTE,CHANNELUP:CHUP2";
$row[8] = "VOLUMEDOWN:VOLDOWN,EXIT,CHANNELDOWN:CHDOWN2";
$row[9] = ":blank,:blank,:blank";
$row[10] = "INFO,UP,MENU";
$row[11] = "LEFT,OK,RIGHT";
$row[12] = "AUDIO,DOWN,VIDEO";
$row[13] = ":blank,:blank,:blank";
$row[14] = "RED,GREEN,YELLOW,BLUE";
$row[15] = "REWIND,PLAY,STOP,FASTFORWARD:FF";
$row[16] = "TV,RADIO,TEXT,RECORD:REC";
$row[17] = "attr rc_iconpath icons/remotecontrol";
$row[18] = "attr rc_iconprefix black_btn_";
return @row;
}
# Dreambox RC10 with SVG
sub ENIGMA2_RClayout_RC10_SVG() {
my @row;
$row[0] = ":rc_BLANK.svg,:rc_BLANK.svg,POWER:rc_POWER.svg";
$row[1] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[2] = "1:rc_1.svg,2:rc_2.svg,3:rc_3.svg";
$row[3] = "4:rc_4.svg,5:rc_5.svg,6:rc_6.svg";
$row[4] = "7:rc_7.svg,8:rc_8.svg,9:rc_9.svg";
$row[5] = "LEFTBRACE:rc_PREVIOUS.svg,0:rc_0.svg,RIGHTBRACE:rc_NEXT.svg";
$row[6] =
"RED:rc_RED.svg,GREEN:rc_GREEN.svg,YELLOW:rc_YELLOW.svg,BLUE:rc_BLUE.svg";
$row[7] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[8] = "INFO:rc_INFO.svg,UP:rc_UP.svg,MENU:rc_MENU.svg";
$row[9] = "LEFT:rc_LEFT.svg,OK:rc_OK.svg,RIGHT:rc_RIGHT.svg";
$row[10] = "AUDIO:rc_AUDIO.svg,DOWN:rc_DOWN.svg,VIDEO:rc_VIDEO.svg";
$row[11] = ":rc_BLANK.svg,EXIT:rc_EXIT.svg,:rc_BLANK.svg";
$row[12] = "VOLUMEUP:rc_VOLPLUS.svg,:rc_BLANK.svg,CHANNELUP:rc_UP.svg";
$row[13] =
"VOLUMEDOWN:rc_VOLMINUS.svg,MUTE:rc_MUTE.svg,CHANNELDOWN:rc_DOWN.svg";
$row[14] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[15] =
"REWIND:rc_REW.svg,PLAY:rc_PLAY.svg,STOP:rc_STOP.svg,FASTFORWARD:rc_FF.svg";
$row[16] =
"TV:rc_TV.svg,RADIO:rc_RADIO.svg,TEXT:rc_TEXT.svg,RECORD:rc_REC.svg";
$row[17] = "attr rc_iconpath icons";
$row[18] = "attr rc_iconprefix rc_";
return @row;
}
# Dreambox RC10 with PNG
sub ENIGMA2_RClayout_RC10() {
my @row;
$row[0] = ":blank,:blank,POWER:POWEROFF";
$row[1] = ":blank,:blank,:blank";
$row[2] = "1,2,3";
$row[3] = "4,5,6";
$row[4] = "7,8,9";
$row[5] = "LEFTBRACE:LEFT2,0:0,RIGHTBRACE:RIGHT2";
$row[6] = "RED,GREEN,YELLOW,BLUE";
$row[7] = ":blank,:blank,:blank";
$row[8] = "INFO,UP,MENU";
$row[9] = "LEFT,OK,RIGHT";
$row[10] = "AUDIO,DOWN,VIDEO";
$row[11] = ":blank,EXIT,:blank";
$row[12] = "VOLUMEUP:VOLUP,:blank,CHANNELUP:CHUP2";
$row[13] = "VOLUMEDOWN:VOLDOWN,MUTE,CHANNELDOWN:CHDOWN2";
$row[14] = ":blank,:blank,:blank";
$row[15] = "REWIND,PLAY,STOP,FASTFORWARD:FF";
$row[16] = "TV,RADIO,TEXT,RECORD:REC";
$row[17] = "attr rc_iconpath icons/remotecontrol";
$row[18] = "attr rc_iconprefix black_btn_";
return @row;
}
# VU+ Duo2 with SVG
sub ENIGMA2_RClayout_VUplusDuo2_SVG() {
my @row;
$row[0] = ":rc_BLANK.svg,MUTE:rc_MUTE.svg,POWER:rc_POWER.svg";
$row[1] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[2] = "REWIND:rc_REW.svg,PLAY:rc_PLAY.svg,FASTFORWARD:rc_FF.svg";
$row[3] = "RECORD:rc_REC.svg,STOP:rc_STOP.svg,VIDEO:rc_VIDEO.svg";
$row[4] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[5] = "TV:rc_TV.svg,AUDIO:rc_AUDIO.svg,RADIO:rc_RADIO.svg";
$row[6] = "TEXT:rc_TEXT.svg,HELP:rc_HELP.svg,AV:rc_AV.svg";
$row[7] = "INFO:rc_EPG.svg,MENU:rc_MENU.svg,EXIT:rc_EXIT.svg";
$row[8] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[9] = "VOLUMEUP:rc_VOLPLUS.svg,UP:rc_UP.svg,CHANNELUP:rc_PLUS.svg";
$row[10] = "LEFT:rc_LEFT.svg,OK:rc_OK.svg,RIGHT:rc_RIGHT.svg";
$row[11] =
"VOLUMEDOWN:rc_VOLMINUS.svg,DOWN:rc_DOWN.svg,CHANNELDOWN:rc_MINUS.svg";
$row[12] = ":rc_BLANK.svg,:rc_BLANK.svg,:rc_BLANK.svg";
$row[13] =
"RED:rc_RED.svg,GREEN:rc_GREEN.svg,YELLOW:rc_YELLOW.svg,BLUE:rc_BLUE.svg";
$row[14] = "1:rc_1.svg,2:rc_2.svg,3:rc_3.svg";
$row[15] = "4:rc_4.svg,5:rc_5.svg,6:rc_6.svg";
$row[16] = "7:rc_7.svg,8:rc_8.svg,9:rc_9.svg";
$row[17] = "LEFTBRACE:rc_PREVIOUS.svg,0:rc_0.svg,RIGHTBRACE:rc_NEXT.svg";
$row[18] = "attr rc_iconpath icons";
$row[19] = "attr rc_iconprefix rc_";
return @row;
}
# VU+ Duo2 with PNG
sub ENIGMA2_RClayout_VUplusDuo2() {
my @row;
$row[0] = ":blank,MUTE,POWER:POWEROFF";
$row[1] = ":blank,:blank,:blank";
$row[2] = "REWIND,PLAY,FASTFORWARD:FF";
$row[3] = "RECORD:REC,STOP,VIDEO";
$row[4] = ":blank,:blank,:blank";
$row[5] = "TV,AUDIO,RADIO:RADIO";
$row[6] = "TEXT,HELP,AV";
$row[7] = "INFO,MENU,EXIT";
$row[8] = ":blank,:blank,:blank";
$row[9] = "VOLUMEUP:VOLUP,UP,CHANNELUP:CHUP2";
$row[10] = "LEFT,OK,RIGHT";
$row[11] = "VOLUMEDOWN:VOLDOWN,DOWN,CHANNELDOWN:CHDOWN2";
$row[12] = ":blank,:blank,:blank";
$row[13] = "RED,GREEN,YELLOW,BLUE";
$row[14] = "1,2,3";
$row[15] = "4,5,6";
$row[16] = "7,8,9";
$row[17] = "LEFTBRACE:LEFT2,0:0,RIGHTBRACE:RIGHT2";
$row[18] = "attr rc_iconpath icons/remotecontrol";
$row[19] = "attr rc_iconprefix black_btn_";
return @row;
}
###################################
sub ENIGMA2_GetRemotecontrolCommand($) {
my ($command) = @_;
my $commands = {
'RESERVED' => 0,
'ESC' => 1,
'1' => 2,
'2' => 3,
'3' => 4,
'4' => 5,
'5' => 6,
'6' => 7,
'7' => 8,
'8' => 9,
'9' => 10,
'0' => 11,
'MINUS' => 12,
'EQUAL' => 13,
'BACKSPACE' => 14,
'TAB' => 15,
'Q' => 16,
'W' => 17,
'E' => 18,
'R' => 19,
'T' => 20,
'Y' => 21,
'U' => 22,
'I' => 23,
'O' => 24,
'P' => 25,
'LEFTBRACE' => 26,
'RIGHTBRACE' => 27,
'ENTER' => 28,
'LEFTCTRL' => 29,
'A' => 30,
'S' => 31,
'D' => 32,
'F' => 33,
'G' => 34,
'H' => 35,
'J' => 36,
'K' => 37,
'L' => 38,
'SEMICOLON' => 39,
'APOSTROPHE' => 40,
'GRAVE' => 41,
'LEFTSHIFT' => 42,
'BACKSLASH' => 43,
'Z' => 44,
'X' => 45,
'C' => 46,
'V' => 47,
'B' => 48,
'N' => 49,
'M' => 50,
'COMMA' => 51,
'DOT' => 52,
'SLASH' => 53,
'RIGHTSHIFT' => 54,
'KPASTERISK' => 55,
'LEFTALT' => 56,
'SPACE' => 57,
'CAPSLOCK' => 58,
'F1' => 59,
'F2' => 60,
'F3' => 61,
'F4' => 62,
'F5' => 63,
'F6' => 64,
'F7' => 65,
'F8' => 66,
'F9' => 67,
'F10' => 68,
'NUMLOCK' => 69,
'SCROLLLOCK' => 70,
'KP7' => 71,
'KP8' => 72,
'KP9' => 73,
'KPMINUS' => 74,
'KP4' => 75,
'KP5' => 76,
'KP6' => 77,
'KPPLUS' => 78,
'KP1' => 79,
'KP2' => 80,
'KP3' => 81,
'KP0' => 82,
'KPDOT' => 83,
'103RD' => 84,
'F13' => 85,
'102ND' => 86,
'F11' => 87,
'F12' => 88,
'F14' => 89,
'F15' => 90,
'F16' => 91,
'F17' => 92,
'F18' => 93,
'F19' => 94,
'F20' => 95,
'KPENTER' => 96,
'RIGHTCTRL' => 97,
'KPSLASH' => 98,
'SYSRQ' => 99,
'RIGHTALT' => 100,
'LINEFEED' => 101,
'HOME' => 102,
'UP' => 103,
'PAGEUP' => 104,
'LEFT' => 105,
'RIGHT' => 106,
'END' => 107,
'DOWN' => 108,
'PAGEDOWN' => 109,
'INSERT' => 110,
'DELETE' => 111,
'MACRO' => 112,
'MUTE' => 113,
'VOLUMEDOWN' => 114,
'VOLUMEUP' => 115,
'POWER' => 116,
'KPEQUAL' => 117,
'KPPLUSMINUS' => 118,
'PAUSE' => 119,
'F21' => 120,
'F22' => 121,
'F23' => 122,
'F24' => 123,
'KPCOMMA' => 124,
'LEFTMETA' => 125,
'RIGHTMETA' => 126,
'COMPOSE' => 127,
'STOP' => 128,
'AGAIN' => 129,
'PROPS' => 130,
'UNDO' => 131,
'FRONT' => 132,
'COPY' => 133,
'OPEN' => 134,
'PASTE' => 135,
'FIND' => 136,
'CUT' => 137,
'HELP' => 138,
'MENU' => 139,
'CALC' => 140,
'SETUP' => 141,
'SLEEP' => 142,
'WAKEUP' => 143,
'FILE' => 144,
'SENDFILE' => 145,
'DELETEFILE' => 146,
'XFER' => 147,
'PROG1' => 148,
'PROG2' => 149,
'WWW' => 150,
'MSDOS' => 151,
'COFFEE' => 152,
'DIRECTION' => 153,
'CYCLEWINDOWS' => 154,
'MAIL' => 155,
'BOOKMARKS' => 156,
'COMPUTER' => 157,
'BACK' => 158,
'FORWARD' => 159,
'CLOSECD' => 160,
'EJECTCD' => 161,
'EJECTCLOSECD' => 162,
'NEXTSONG' => 163,
'PLAYPAUSE' => 164,
'PREVIOUSSONG' => 165,
'STOPCD' => 166,
'RECORD' => 167,
'REWIND' => 168,
'PHONE' => 169,
'ISO' => 170,
'CONFIG' => 171,
'HOMEPAGE' => 172,
'REFRESH' => 173,
'EXIT' => 174,
'MOVE' => 175,
'EDIT' => 176,
'SCROLLUP' => 177,
'SCROLLDOWN' => 178,
'KPLEFTPAREN' => 179,
'KPRIGHTPAREN' => 180,
'INTL1' => 181,
'INTL2' => 182,
'INTL3' => 183,
'INTL4' => 184,
'INTL5' => 185,
'INTL6' => 186,
'INTL7' => 187,
'INTL8' => 188,
'INTL9' => 189,
'LANG1' => 190,
'LANG2' => 191,
'LANG3' => 192,
'LANG4' => 193,
'LANG5' => 194,
'LANG6' => 195,
'LANG7' => 196,
'LANG8' => 197,
'LANG9' => 198,
'PLAYCD' => 200,
'PAUSECD' => 201,
'PROG3' => 202,
'PROG4' => 203,
'SUSPEND' => 205,
'CLOSE' => 206,
'PLAY' => 207,
'FASTFORWARD' => 208,
'BASSBOOST' => 209,
'PRINT' => 210,
'HP' => 211,
'CAMERA' => 212,
'SOUND' => 213,
'QUESTION' => 214,
'EMAIL' => 215,
'CHAT' => 216,
'SEARCH' => 217,
'CONNECT' => 218,
'FINANCE' => 219,
'SPORT' => 220,
'SHOP' => 221,
'ALTERASE' => 222,
'CANCEL' => 223,
'BRIGHTNESSDOWN' => 224,
'BRIGHTNESSUP' => 225,
'MEDIA' => 226,
'UNKNOWN' => 240,
'BTN_0' => 256,
'BTN_1' => 257,
'OK' => 352,
'SELECT' => 353,
'GOTO' => 354,
'CLEAR' => 355,
'POWER2' => 356,
'OPTION' => 357,
'INFO' => 358,
'TIME' => 359,
'VENDOR' => 360,
'ARCHIVE' => 361,
'PROGRAM' => 362,
'CHANNEL' => 363,
'FAVORITES' => 364,
'EPG' => 365,
'PVR' => 366,
'MHP' => 367,
'LANGUAGE' => 368,
'TITLE' => 369,
'SUBTITLE' => 370,
'ANGLE' => 371,
'ZOOM' => 372,
'MODE' => 373,
'KEYBOARD' => 374,
'SCREEN' => 375,
'PC' => 376,
'TV' => 377,
'TV2' => 378,
'VCR' => 379,
'VCR2' => 380,
'SAT' => 381,
'SAT2' => 382,
'CD' => 383,
'TAPE' => 384,
'RADIO' => 385,
'TUNER' => 386,
'PLAYER' => 387,
'TEXT' => 388,
'DVD' => 389,
'AUX' => 390,
'MP3' => 391,
'AUDIO' => 392,
'VIDEO' => 393,
'DIRECTORY' => 394,
'LIST' => 395,
'MEMO' => 396,
'CALENDAR' => 397,
'RED' => 398,
'GREEN' => 399,
'YELLOW' => 400,
'BLUE' => 401,
'CHANNELUP' => 402,
'CHANNELDOWN' => 403,
'FIRST' => 404,
'LAST' => 405,
'AB' => 406,
'NEXT' => 407,
'RESTART' => 408,
'SLOW' => 409,
'SHUFFLE' => 410,
'BREAK' => 411,
'PREVIOUS' => 412,
'DIGITS' => 413,
'TEEN' => 414,
'TWEN' => 415,
'DEL_EOL' => 448,
'DEL_EOS' => 449,
'INS_LINE' => 450,
'DEL_LINE' => 451,
'ASCII' => 510,
'MAX' => 511
};
if ( defined( $commands->{$command} ) ) {
return $commands->{$command};
}
elsif ( $command eq "GetRemotecontrolCommands" ) {
return $commands;
}
else {
return "";
}
}
1;
=pod
=begin html
ENIGMA2
Define
define <name> ENIGMA2 <ip-address-or-hostname> [<port>] [<poll-interval>]
[<http-user>] [<http-password>]
This module controls ENIGMA2 based devices like Dreambox or VUplus via network connection.
Defining an ENIGMA2 device will schedule an internal task (interval can be set
with optional parameter <poll-interval> in seconds, if not set, the value is 75
seconds), which periodically reads the status of the device and triggers notify/filelog commands.
Example:
define SATReceiver ENIGMA2 192.168.0.10
define SATReceiver ENIGMA2 192.168.0.10 8080 # With custom port
define SATReceiver ENIGMA2 192.168.0.10 80 60 # With custom interval of 60 seconds
define SATReceiver ENIGMA2 192.168.0.10 80 60 root secret # With HTTP user credentials
Set
set <name> <command> [<parameter>]
Currently, the following commands are defined.
- on - powers on the device and send a WoL magic package if needed
- off - turns the device in standby mode
- toggle - switch between on and off
- shutdown - turns the device in deepstandby mode
- reboot - reboots the device
- restartGui - restarts the GUI / ENIGMA2 process
- channel channel,0...999,sRef - zap to specific channel or service reference
- channelUp - zap to next channel
- channelDown - zap to previous channel
- volume 0...100 - set the volume level in percentage
- volumeUp - increases the volume level
- volumeDown - decreases the volume level
- mute on,off - controls volume mute
- play on,off - starts/resumes playback
- pause on,off - pauses current playback or enables timeshift
- stop on,off - stops current playback
- input tv,radio - switches between tv and radio mode
- statusRequest - requests the current status of the device
- remoteControl UP,DOWN,... - sends remote control commands; see remoteControl help
- showText text - sends info message to screen to be displayed for 8 seconds
- msg yesno,info... - allows more complex messages as showText, see commands as listed below
Messaging
showText has predefined settings. If you would like to send more individual messages
to your TV screen, the function msg can be used.
For this application the following commands are available:
Type Selection:
msg yesno
msg info
msg message
msg attention
The following parameter are essentially needed after type specification:
msg <TYPE> <TIMEOUT> <YOUR MESSAGETEXT>
Get
get <name> <what>
Currently, the following commands are defined:
power
input
volume
mute
channel
currentMedia
currentTitle
serviceprovider
servicevideosize
streamUrl
Attributes
- bouquet-tv - service reference address where the favorite television bouquet can be found (initially set automatically during define)
- bouquet-radio - service reference address where the favorite radio bouquet can be found (initially set automatically during define)
- disable - Disable polling (true/false)
- http-method - HTTP access method to be used; e.g. a FritzBox might need to use POST instead of GET (GET/POST)
- https - Access box via secure HTTP (true/false)
- timeout - Set different polling timeout in seconds (default=6)
Generated Readings/Events:
- acg - Shows Automatic Gain Control value in percent; reflects overall signal quality strength
- apid - Shows the audio process ID for current channel
- ber - Shows Bit Error Rate for current channel
- channel - Shows the service name of current channel or media file name; part of FHEM-4-AV-Devices compatibility
- currentTitle - Shows the title of the running event; part of FHEM-4-AV-Devices compatibility
- currentMedia - The service reference ID of current channel; part of FHEM-4-AV-Devices compatibility
- enigmaversion - Shows the installed version of ENIGMA2
- eventcurrenttime - Shows the current time of running event as UNIX timestamp
- eventcurrenttime_hr - Shows the current time of running event in human-readable format
- eventdescription - Shows the description of running event
- evenduration - Shows the total duration time of running event in seconds
- evenduration_hr - Shows the total duration time of running event in human-readable format
- eventid - Shows the ID of running event
- eventstart - Shows the starting time of running event as UNIX timestamp
- eventstart_hr - Shows the starting time of running event in human readable format
- eventtitle - Shows the title of the running event
- fpversion - Shows the firmware version for the front processor
- hddX_capacity - Shows the total capacity of the installed hard drive in GB
- hddX_free - Shows the free capacity of the installed hard drive in GB
- hddX_model - Shows hardware details for the installed hard drive
- imageversion - Shows the version for the installed software image
- input - Shows currently used input; part of FHEM-4-AV-Devices compatibility
- lanmac - Shows the device MAC address
- model - Shows details about the device hardware
- mute - Reports the mute status of the device (can be "on" or "off")
- onid - The ON ID
- pcrpid - The PCR process ID
- pmtpid - The PMT process ID
- power - Reports the power status of the device (can be "on" or "off")
- presence - 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.
- serviceaspect - Aspect ratio for current channel
- servicename - Name for current channel
- servicenamespace - Namespace for current channel
- serviceprovider - Service provider of current channel
- servicereference - The service reference ID of current channel
- servicevideosize - Video resolution for current channel
- sid - The S-ID
- snr - Shows Signal to Noise for current channel in percent
- snrdb - Shows Signal to Noise in dB
- state - Reports current power state and an absence of the device (can be "on", "off" or "absent")
- tsid - The TS ID
- tuner_X - Details about the used tuner hardware
- txtpid - The TXT process ID
- videoheight - Height of the video resolution for current channel
- videowidth - Width of the video resolution for current channel
- volume - Reports current volume level of the receiver in percentage values (between 0 and 100 %)
- vpid - The Video process ID
- webifversion - Type and version of the used web interface
=end html
=cut