mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-01-31 12:49:34 +00:00
1295 lines
45 KiB
Perl
Executable File
1295 lines
45 KiB
Perl
Executable File
# $Id$
|
|
##############################################################################
|
|
#
|
|
# 71_YAMAHA_AVR.pm
|
|
# An FHEM Perl module for controlling Yamaha AV-Receivers
|
|
# via network connection. As the interface is standardized
|
|
# within all Yamaha AV-Receivers, this module should work
|
|
# with any receiver which has an ethernet or wlan connection.
|
|
#
|
|
# Copyright by Markus Bloch
|
|
# e-mail: Notausstieg0309@googlemail.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 <http://www.gnu.org/licenses/>.
|
|
#
|
|
##############################################################################
|
|
|
|
package main;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use Time::HiRes qw(gettimeofday sleep);
|
|
use HttpUtils;
|
|
|
|
sub YAMAHA_AVR_Get($@);
|
|
sub YAMAHA_AVR_Define($$);
|
|
sub YAMAHA_AVR_GetStatus($;$);
|
|
sub YAMAHA_AVR_Undefine($$);
|
|
|
|
|
|
|
|
|
|
###################################
|
|
sub
|
|
YAMAHA_AVR_Initialize($)
|
|
{
|
|
my ($hash) = @_;
|
|
|
|
$hash->{GetFn} = "YAMAHA_AVR_Get";
|
|
$hash->{SetFn} = "YAMAHA_AVR_Set";
|
|
$hash->{DefFn} = "YAMAHA_AVR_Define";
|
|
$hash->{UndefFn} = "YAMAHA_AVR_Undefine";
|
|
|
|
$hash->{AttrList} = "do_not_notify:0,1 volumeSteps:1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20 volume-smooth-change:0,1 volume-smooth-steps:1,2,3,4,5,6,7,8,9,10 ".
|
|
$readingFnAttributes;
|
|
}
|
|
|
|
###################################
|
|
sub
|
|
YAMAHA_AVR_GetStatus($;$)
|
|
{
|
|
my ($hash, $local) = @_;
|
|
my $name = $hash->{NAME};
|
|
my $power;
|
|
|
|
$local = 0 unless(defined($local));
|
|
|
|
return "" if(!defined($hash->{helper}{ADDRESS}) or !defined($hash->{helper}{INTERVAL}));
|
|
|
|
my $device = $hash->{helper}{ADDRESS};
|
|
|
|
# get the model informations and available zones if no informations are available
|
|
if(not defined($hash->{ACTIVE_ZONE}) or not defined($hash->{MODEL}) or not defined($hash->{FIRMWARE}))
|
|
{
|
|
YAMAHA_AVR_getModel($hash);
|
|
}
|
|
|
|
# get all available inputs if nothing is available
|
|
if(not defined($hash->{helper}{INPUTS}) or length($hash->{helper}{INPUTS}) == 0)
|
|
{
|
|
YAMAHA_AVR_getInputs($hash);
|
|
}
|
|
|
|
my $zone = YAMAHA_AVR_getZoneName($hash, $hash->{ACTIVE_ZONE});
|
|
|
|
if(not defined($zone))
|
|
{
|
|
InternalTimer(gettimeofday()+$hash->{helper}{INTERVAL}, "YAMAHA_AVR_GetStatus", $hash, 0) unless($local == 1);
|
|
return "No Zone available";
|
|
}
|
|
|
|
my $return = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"GET\"><$zone><Basic_Status>GetParam</Basic_Status></$zone></YAMAHA_AV>");
|
|
|
|
Log3 $name, 4, "YAMAHA_AVR: GetStatus-Request returned: $return" if(defined($return));
|
|
|
|
if(not defined($return) or $return eq "")
|
|
{
|
|
readingsSingleUpdate($hash, "state", "absent", 1);
|
|
InternalTimer(gettimeofday()+$hash->{helper}{INTERVAL}, "YAMAHA_AVR_GetStatus", $hash, 0) unless($local == 1);
|
|
return;
|
|
}
|
|
|
|
readingsBeginUpdate($hash);
|
|
|
|
if($return =~ /<Power>(.+)<\/Power>/)
|
|
{
|
|
$power = $1;
|
|
|
|
if($power eq "Standby")
|
|
{
|
|
$power = "off";
|
|
}
|
|
readingsBulkUpdate($hash, "power", lc($power));
|
|
readingsBulkUpdate($hash, "state", lc($power));
|
|
}
|
|
|
|
# current volume and mute status
|
|
if($return =~ /<Volume><Lvl><Val>(.+)<\/Val><Exp>(.+)<\/Exp><Unit>.+<\/Unit><\/Lvl><Mute>(.+)<\/Mute>.*<\/Volume>/)
|
|
{
|
|
readingsBulkUpdate($hash, "volumeStraight", ($1 / 10 ** $2));
|
|
readingsBulkUpdate($hash, "volume", YAMAHA_AVR_volume_abs2rel(($1 / 10 ** $2)));
|
|
readingsBulkUpdate($hash, "mute", lc($3));
|
|
|
|
$hash->{helper}{USE_SHORT_VOL_CMD} = "0";
|
|
}
|
|
elsif($return =~ /<Vol><Lvl><Val>(.+)<\/Val><Exp>(.+)<\/Exp><Unit>.+<\/Unit><\/Lvl><Mute>(.+)<\/Mute>.*<\/Vol>/)
|
|
{
|
|
readingsBulkUpdate($hash, "volumeStraight", ($1 / 10 ** $2));
|
|
readingsBulkUpdate($hash, "volume", YAMAHA_AVR_volume_abs2rel(($1 / 10 ** $2)));
|
|
readingsBulkUpdate($hash, "mute", lc($3));
|
|
|
|
$hash->{helper}{USE_SHORT_VOL_CMD} = "1";
|
|
}
|
|
|
|
|
|
# (only available in zones other than mainzone) absolute or relative volume change to the mainzone
|
|
if($return =~ /<Volume>.*?<Output>(.+?)<\/Output>.*?<\/Volume>/)
|
|
{
|
|
readingsBulkUpdate($hash, "output", lc($1));
|
|
}
|
|
elsif($return =~ /<Vol>.*?<Output>(.+?)<\/Output>.*?<\/Vol>/)
|
|
{
|
|
readingsBulkUpdate($hash, "output", lc($1));
|
|
}
|
|
else
|
|
{
|
|
# delete the reading if this information is not available
|
|
delete($hash->{READINGS}{output}) if(defined($hash->{READINGS}{output}));
|
|
}
|
|
|
|
# current input same as the corresponding set command name
|
|
if($return =~ /<Input_Sel>(.+)<\/Input_Sel>/)
|
|
{
|
|
readingsBulkUpdate($hash, "input", YAMAHA_AVR_InputParam2Fhem(lc($1), 0));
|
|
}
|
|
|
|
# input name as it is displayed on the receivers front display
|
|
if($return =~ /<Input>.*?<Title>\s*(.+?)\s*<\/Title>.*<\/Input>/)
|
|
{
|
|
readingsBulkUpdate($hash, "inputName", $1);
|
|
}
|
|
|
|
readingsEndUpdate($hash, 1);
|
|
|
|
InternalTimer(gettimeofday()+$hash->{helper}{INTERVAL}, "YAMAHA_AVR_GetStatus", $hash, 0) unless($local == 1);
|
|
|
|
Log3 $name, 4, "YAMAHA_AVR $name: ".$hash->{STATE};
|
|
|
|
return $hash->{STATE};
|
|
}
|
|
|
|
###################################
|
|
sub
|
|
YAMAHA_AVR_Get($@)
|
|
{
|
|
my ($hash, @a) = @_;
|
|
my $what;
|
|
|
|
return "argument is missing" if(int(@a) != 2);
|
|
|
|
$what = $a[1];
|
|
|
|
if($what =~ /^(power|input|inputName|output|volume|volumeStraight|mute)$/)
|
|
{
|
|
YAMAHA_AVR_GetStatus($hash, 1);
|
|
|
|
if(defined($hash->{READINGS}{$what}))
|
|
{
|
|
return $hash->{READINGS}{$what}{VAL};
|
|
}
|
|
else
|
|
{
|
|
return "no such reading: $what";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return "Unknown argument $what, choose one of power:noArg input:noArg inputName:noArg volume:noArg mute:noArg".(exists($hash->{READINGS}{output})?" output:noArg":"");
|
|
}
|
|
}
|
|
|
|
|
|
###################################
|
|
sub
|
|
YAMAHA_AVR_Set($@)
|
|
{
|
|
my ($hash, @a) = @_;
|
|
my $name = $hash->{NAME};
|
|
my $address = $hash->{helper}{ADDRESS};
|
|
my $result = "";
|
|
my $command;
|
|
my $target_volume;
|
|
my $zone = YAMAHA_AVR_getZoneName($hash, $hash->{ACTIVE_ZONE});
|
|
|
|
my $inputs_piped = defined($hash->{helper}{INPUTS}) ? YAMAHA_AVR_InputParam2Fhem(lc($hash->{helper}{INPUTS}), 0) : "" ;
|
|
my $inputs_comma = defined($hash->{helper}{INPUTS}) ? YAMAHA_AVR_InputParam2Fhem(lc($hash->{helper}{INPUTS}), 1) : "" ;
|
|
|
|
|
|
my $scenes_piped = defined($hash->{helper}{SCENES}) ? YAMAHA_AVR_InputParam2Fhem(lc($hash->{helper}{SCENES}), 0) : "" ;
|
|
my $scenes_comma = defined($hash->{helper}{SCENES}) ? YAMAHA_AVR_InputParam2Fhem(lc($hash->{helper}{SCENES}), 1) : "" ;
|
|
|
|
|
|
return "No Argument given" if(!defined($a[1]));
|
|
|
|
my $what = $a[1];
|
|
my $usage = "Unknown argument $what, choose one of on:noArg off:noArg volumeStraight:slider,-80,1,16 volume:slider,0,1,100 volumeUp volumeDown input:".$inputs_comma." mute:on,off remoteControl:setup,up,down,left,right,return,option,display,enter ".(defined($hash->{helper}{SCENES})?"scene:".$scenes_comma." ":"")."statusRequest:noArg";
|
|
|
|
# Depending on the status response, use the short or long Volume command
|
|
|
|
my $volume_cmd = (exists($hash->{helper}{USE_SHORT_VOL_CMD}) and $hash->{helper}{USE_SHORT_VOL_CMD} eq "1" ? "Vol" : "Volume");
|
|
|
|
|
|
if($what eq "on")
|
|
{
|
|
|
|
$result = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><Power_Control><Power>On</Power></Power_Control></$zone></YAMAHA_AV>");
|
|
|
|
if($result =~ /RC="0"/ and $result =~ /<Power><\/Power>/)
|
|
{
|
|
# As the receiver startup takes about 5 seconds, the status will be already set, if the return code of the command is 0.
|
|
readingsBeginUpdate($hash);
|
|
readingsBulkUpdate($hash, "power", "on");
|
|
readingsBulkUpdate($hash, "state","on");
|
|
readingsEndUpdate($hash, 1);
|
|
return undef;
|
|
}
|
|
else
|
|
{
|
|
return "Could not set power to on";
|
|
}
|
|
|
|
}
|
|
elsif($what eq "off")
|
|
{
|
|
$result = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><Power_Control><Power>Standby</Power></Power_Control></$zone></YAMAHA_AV>");
|
|
|
|
if(not $result =~ /RC="0"/)
|
|
{
|
|
# if the returncode isn't 0, than the command was not successful
|
|
return "Could not set power to off";
|
|
}
|
|
|
|
}
|
|
elsif($what eq "input")
|
|
{
|
|
if(defined($a[2]))
|
|
{
|
|
if($hash->{READINGS}{power}{VAL} eq "on")
|
|
{
|
|
if(not $inputs_piped eq "")
|
|
{
|
|
if($a[2] =~ /^($inputs_piped)$/)
|
|
{
|
|
$command = YAMAHA_AVR_getInputParam($hash, $a[2]);
|
|
if(defined($command) and length($command) > 0)
|
|
{
|
|
$result = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><Input><Input_Sel>".$command."</Input_Sel></Input></$zone></YAMAHA_AV>");
|
|
}
|
|
else
|
|
{
|
|
return "invalid input: ".$a[2];
|
|
}
|
|
|
|
if(not $result =~ /RC="0"/)
|
|
{
|
|
# if the returncode isn't 0, than the command was not successful
|
|
return "Could not set input to ".$a[2].".";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return $usage;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return "No inputs are avaible. Please try an statusUpdate.";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return "input can only be used when device is powered on";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return $inputs_piped eq "" ? "No inputs are available. Please try an statusUpdate." : "No input parameter was given";
|
|
}
|
|
}
|
|
elsif($what eq "scene")
|
|
{
|
|
if(defined($a[2]))
|
|
{
|
|
|
|
if(not $scenes_piped eq "")
|
|
{
|
|
if($a[2] =~ /^($scenes_piped)$/)
|
|
{
|
|
$command = YAMAHA_AVR_getSceneName($hash, $a[2]);
|
|
if(defined($command) and length($command) > 0)
|
|
{
|
|
$result = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><Scene><Scene_Sel>".$command."</Scene_Sel></Scene></$zone></YAMAHA_AV>");
|
|
}
|
|
else
|
|
{
|
|
return "invalid input: ".$a[2];
|
|
}
|
|
|
|
if(not $result =~ /RC="0"/)
|
|
{
|
|
# if the returncode isn't 0, than the command was not successful
|
|
return "Could not set scene to ".$a[2].".";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return $usage;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return "No scenes are avaible. Please try an statusUpdate.";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return $scenes_piped eq "" ? "No scenes are available. Please try an statusUpdate." : "No scene parameter was given";
|
|
}
|
|
}
|
|
|
|
elsif($what eq "mute")
|
|
{
|
|
if(defined($a[2]))
|
|
{
|
|
if($hash->{READINGS}{power}{VAL} eq "on")
|
|
{
|
|
if( $a[2] eq "on")
|
|
{
|
|
$result = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><$volume_cmd><Mute>On</Mute></$volume_cmd></$zone></YAMAHA_AV>");
|
|
}
|
|
elsif($a[2] eq "off")
|
|
{
|
|
$result = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><$volume_cmd><Mute>Off</Mute></$volume_cmd></$zone></YAMAHA_AV>");
|
|
}
|
|
else
|
|
{
|
|
return $usage;
|
|
}
|
|
|
|
if(not $result =~ /RC="0"/)
|
|
{
|
|
# if the returncode isn't 0, than the command was not successful
|
|
return "Could not set mute to ".$a[2].".";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return "mute can only used when device is powered on";
|
|
}
|
|
}
|
|
}
|
|
elsif($what =~ /(volumeStraight|volume|volumeUp|volumeDown)/)
|
|
{
|
|
|
|
if($what eq "volume" and $a[2] >= 0 && $a[2] <= 100)
|
|
{
|
|
$target_volume = YAMAHA_AVR_volume_rel2abs($a[2]);
|
|
}
|
|
elsif($what eq "volumeDown")
|
|
{
|
|
$target_volume = YAMAHA_AVR_volume_rel2abs($hash->{READINGS}{volume}{VAL} - ((defined($a[2]) and $a[2] =~ /^\d+$/) ? $a[2] : AttrVal($hash->{NAME}, "volumeSteps",5)));
|
|
}
|
|
elsif($what eq "volumeUp")
|
|
{
|
|
$target_volume = YAMAHA_AVR_volume_rel2abs($hash->{READINGS}{volume}{VAL} + ((defined($a[2]) and $a[2] =~ /^\d+$/) ? $a[2] : AttrVal($hash->{NAME}, "volumeSteps",5)));
|
|
}
|
|
else
|
|
{
|
|
$target_volume = $a[2];
|
|
}
|
|
|
|
if(defined($target_volume) && $target_volume >= -80.5 && $target_volume < 16.5)
|
|
{
|
|
if($hash->{READINGS}{power}{VAL} eq "on")
|
|
{
|
|
if(AttrVal($name, "volume-smooth-change", "0") eq "1")
|
|
{
|
|
my $diff = int(($target_volume - $hash->{READINGS}{volumeStraight}{VAL}) / AttrVal($hash->{NAME}, "volume-smooth-steps", 5) / 0.5) * 0.5;
|
|
my $steps = AttrVal($name, "volume-smooth-steps", 5);
|
|
my $current_volume = $hash->{READINGS}{volumeStraight}{VAL};
|
|
|
|
if($diff > 0)
|
|
{
|
|
Log3 $name, 4, "YAMAHA_AVR: use smooth volume change (with $steps steps of +$diff volume change)";
|
|
}
|
|
else
|
|
{
|
|
Log3 $name, 4, "YAMAHA_AVR: use smooth volume change (with $steps steps of $diff volume change)";
|
|
}
|
|
|
|
# Only if a volume reading exists and smoohing is really needed (step difference is not zero)
|
|
if(defined($hash->{READINGS}{volumeStraight}{VAL}) and $diff != 0)
|
|
{
|
|
for(my $step = 1; $step <= $steps; $step++)
|
|
{
|
|
Log3 $name, 4, "YAMAHA_AVR: set volume to ".($current_volume + ($diff * $step))." dB";
|
|
|
|
YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><$volume_cmd><Lvl><Val>".(($current_volume + ($diff * $step))*10)."</Val><Exp>1</Exp><Unit>dB</Unit></Lvl></$volume_cmd></$zone></YAMAHA_AV>");
|
|
|
|
}
|
|
}
|
|
}
|
|
|
|
# Set the desired volume
|
|
Log3 $name, 4, "YAMAHA_AVR: set volume to ".$target_volume." dB";
|
|
$result = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><$volume_cmd><Lvl><Val>".($target_volume*10)."</Val><Exp>1</Exp><Unit>dB</Unit></Lvl></$volume_cmd></$zone></YAMAHA_AV>");
|
|
if(not $result =~ /RC="0"/)
|
|
{
|
|
# if the returncode isn't 0, than the command was not successful
|
|
return "Could not set volume to ".$target_volume.".";
|
|
}
|
|
|
|
}
|
|
else
|
|
{
|
|
return "volume can only be used when device is powered on";
|
|
}
|
|
}
|
|
}
|
|
elsif($what eq "remoteControl")
|
|
{
|
|
if($a[2] eq "up")
|
|
{
|
|
YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><List_Control><Cursor>Up</Cursor></List_Control></$zone></YAMAHA_AV>");
|
|
}
|
|
elsif($a[2] eq "down")
|
|
{
|
|
YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><List_Control><Cursor>Down</Cursor></List_Control></$zone></YAMAHA_AV>");
|
|
}
|
|
elsif($a[2] eq "left")
|
|
{
|
|
YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><List_Control><Cursor>Left</Cursor></List_Control></$zone></YAMAHA_AV>");
|
|
}
|
|
elsif($a[2] eq "right")
|
|
{
|
|
YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"PUT\"><$zone><List_Control><Cursor>Right</Cursor></List_Control></$zone></YAMAHA_AV>");
|
|
}
|
|
elsif($a[2] eq "display")
|
|
{
|
|
YAMAHA_AVR_SendCommand($hash,"<YAMAHA_AV cmd=\"PUT\"><$zone><List_Control><Menu_Control>Display</Menu_Control></List_Control></$zone></YAMAHA_AV>");
|
|
}
|
|
elsif($a[2] eq "return")
|
|
{
|
|
YAMAHA_AVR_SendCommand($hash,"<YAMAHA_AV cmd=\"PUT\"><$zone><List_Control><Cursor>Return</Cursor></List_Control></$zone></YAMAHA_AV>");
|
|
}
|
|
elsif($a[2] eq "enter")
|
|
{
|
|
YAMAHA_AVR_SendCommand($hash,"<YAMAHA_AV cmd=\"PUT\"><$zone><List_Control><Cursor>Sel</Cursor></List_Control></$zone></YAMAHA_AV>");
|
|
}
|
|
elsif($a[2] eq "setup")
|
|
{
|
|
YAMAHA_AVR_SendCommand($hash,"<YAMAHA_AV cmd=\"PUT\"><$zone><List_Control><Menu_Control>On Screen</Menu_Control></List_Control></$zone></YAMAHA_AV");
|
|
}
|
|
elsif($a[2] eq "option")
|
|
{
|
|
YAMAHA_AVR_SendCommand($hash,"<YAMAHA_AV cmd=\"PUT\"><$zone><List_Control><Menu_Control>Option</Menu_Control></List_Control></$zone></YAMAHA_AV>");
|
|
}
|
|
else
|
|
{
|
|
return $usage;
|
|
}
|
|
}
|
|
elsif($what eq "statusRequest")
|
|
{
|
|
# Will be executed anyway on the end of the function
|
|
}
|
|
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)
|
|
YAMAHA_AVR_GetStatus($hash, 1);
|
|
|
|
return undef;
|
|
|
|
}
|
|
|
|
|
|
#############################
|
|
sub
|
|
YAMAHA_AVR_Define($$)
|
|
{
|
|
my ($hash, $def) = @_;
|
|
my @a = split("[ \t][ \t]*", $def);
|
|
my $name = $hash->{NAME};
|
|
|
|
if(! @a >= 4)
|
|
{
|
|
my $msg = "wrong syntax: define <name> YAMAHA_AVR <ip-or-hostname> [<zone>] [<statusinterval>]";
|
|
Log 2, $msg;
|
|
return $msg;
|
|
}
|
|
|
|
|
|
my $address = $a[2];
|
|
|
|
$hash->{helper}{ADDRESS} = $address;
|
|
|
|
|
|
# if a zone was given, use it, otherwise use the mainzone
|
|
if(defined($a[3]))
|
|
{
|
|
$hash->{helper}{SELECTED_ZONE} = $a[3];
|
|
}
|
|
else
|
|
{
|
|
$hash->{helper}{SELECTED_ZONE} = "mainzone";
|
|
}
|
|
|
|
# if an update interval was given which is greater than zero, use it.
|
|
if(defined($a[4]) and $a[4] > 0)
|
|
{
|
|
$hash->{helper}{INTERVAL}=$a[4];
|
|
}
|
|
else
|
|
{
|
|
$hash->{helper}{INTERVAL}=30;
|
|
}
|
|
|
|
|
|
# In case of a redefine, check the zone parameter if the specified zone exist, otherwise use the main zone
|
|
if(defined($hash->{helper}{ZONES}) and length($hash->{helper}{ZONES}) > 0)
|
|
{
|
|
if(defined(YAMAHA_AVR_getZoneName($hash, lc $hash->{helper}{SELECTED_ZONE})))
|
|
{
|
|
|
|
$hash->{ACTIVE_ZONE} = lc $hash->{helper}{SELECTED_ZONE};
|
|
YAMAHA_AVR_getInputs($hash);
|
|
|
|
}
|
|
else
|
|
{
|
|
Log3 $name, 2, "YAMAHA_AVR: selected zone >>".$hash->{helper}{SELECTED_ZONE}."<< is not available on device ".$hash->{NAME}.". Using Main Zone instead";
|
|
$hash->{ACTIVE_ZONE} = "mainzone";
|
|
YAMAHA_AVR_getInputs($hash);
|
|
}
|
|
}
|
|
|
|
# set the volume-smooth-change attribute only if it is not defined, so no user values will be overwritten
|
|
#
|
|
# own attribute values will be overwritten anyway when all attr-commands are executed from fhem.cfg
|
|
$attr{$name}{"volume-smooth-change"} = "1" unless(defined($attr{$name}{"volume-smooth-change"}));
|
|
|
|
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, "YAMAHA_AVR_GetStatus", $hash, 0);
|
|
|
|
return undef;
|
|
}
|
|
|
|
#############################################################################################################
|
|
#
|
|
# Begin of helper functions
|
|
#
|
|
############################################################################################################
|
|
|
|
|
|
|
|
#############################
|
|
sub
|
|
YAMAHA_AVR_SendCommand($$;$)
|
|
{
|
|
my ($hash, $command, $loglevel) = @_;
|
|
my $name = $hash->{NAME};
|
|
my $address = $hash->{helper}{ADDRESS};
|
|
my $response;
|
|
|
|
$loglevel = 3;
|
|
|
|
Log3 $name, 5, "YAMAHA_AVR: execute on $name: $command";
|
|
|
|
# In case any URL changes must be made, this part is separated in this function".
|
|
|
|
$response = CustomGetFileFromURL(0, "http://".$address."/YamahaRemoteControl/ctrl", 4, "<?xml version=\"1.0\" encoding=\"utf-8\"?>".$command, 0, ($hash->{helper}{AVAILABLE} ? $loglevel : 5));
|
|
|
|
Log3 $name, 5, "YAMAHA_AVR: got response for $name: $response" if(defined($response));
|
|
|
|
unless(defined($response))
|
|
{
|
|
|
|
if((not exists($hash->{helper}{AVAILABLE})) or (exists($hash->{helper}{AVAILABLE}) and $hash->{helper}{AVAILABLE} eq 1))
|
|
{
|
|
Log3 $name, 3, "YAMAHA_AVR: could not execute command on device $name. Please turn on your device in case of deactivated network standby or check for correct hostaddress.";
|
|
readingsSingleUpdate($hash, "presence", "absent", 1);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (defined($hash->{helper}{AVAILABLE}) and $hash->{helper}{AVAILABLE} eq 0)
|
|
{
|
|
Log3 $name, 3, "YAMAHA_AVR: device $name reappeared";
|
|
readingsSingleUpdate($hash, "presence", "present", 1);
|
|
}
|
|
}
|
|
|
|
$hash->{helper}{AVAILABLE} = (defined($response) ? 1 : 0);
|
|
|
|
return $response;
|
|
|
|
}
|
|
|
|
#############################
|
|
sub
|
|
YAMAHA_AVR_Undefine($$)
|
|
{
|
|
my($hash, $name) = @_;
|
|
|
|
# Stop the internal GetStatus-Loop and exit
|
|
RemoveInternalTimer($hash);
|
|
return undef;
|
|
}
|
|
|
|
|
|
#############################
|
|
# Converts all Inputs to FHEM usable command lists
|
|
sub YAMAHA_AVR_InputParam2Fhem($$)
|
|
{
|
|
my ($inputs, $replace_pipes) = @_;
|
|
|
|
|
|
$inputs =~ s/\s+//g;
|
|
$inputs =~ s/,//g;
|
|
$inputs =~ s/\(/_/g;
|
|
$inputs =~ s/\)//g;
|
|
$inputs =~ s/\|/,/g if($replace_pipes == 1);
|
|
|
|
return $inputs;
|
|
}
|
|
|
|
#############################
|
|
# Converts all Zones to FHEM usable command lists
|
|
sub YAMAHA_AVR_Param2Fhem($$)
|
|
{
|
|
my ($param, $replace_pipes) = @_;
|
|
|
|
|
|
$param =~ s/\s+//g;
|
|
$param =~ s/_//g;
|
|
$param =~ s/\|/,/g if($replace_pipes == 1);
|
|
|
|
return lc $param;
|
|
|
|
}
|
|
|
|
#############################
|
|
# Returns the Yamaha Zone Name for the FHEM like zone attribute
|
|
sub YAMAHA_AVR_getZoneName($$)
|
|
{
|
|
my ($hash, $zone) = @_;
|
|
my $item;
|
|
|
|
return undef if(not defined($hash->{helper}{ZONES}));
|
|
|
|
my @commands = split("\\|", $hash->{helper}{ZONES});
|
|
|
|
foreach $item (@commands)
|
|
{
|
|
if(YAMAHA_AVR_Param2Fhem($item, 0) eq $zone)
|
|
{
|
|
return $item;
|
|
}
|
|
}
|
|
|
|
return undef;
|
|
|
|
}
|
|
|
|
#############################
|
|
# Returns the Yamaha Parameter Name for the FHEM like aquivalents
|
|
sub YAMAHA_AVR_getSceneName($$)
|
|
{
|
|
my ($hash, $scene) = @_;
|
|
my $item;
|
|
|
|
return undef if(not defined($hash->{helper}{SCENES}));
|
|
|
|
my @commands = split("\\|", $hash->{helper}{SCENES});
|
|
|
|
foreach $item (@commands)
|
|
{
|
|
if(YAMAHA_AVR_Param2Fhem($item, 0) eq $scene)
|
|
{
|
|
return $item;
|
|
}
|
|
}
|
|
|
|
return undef;
|
|
|
|
}
|
|
|
|
#############################
|
|
# Returns the Yamaha Parameter Name for the FHEM like input channel
|
|
sub YAMAHA_AVR_getInputParam($$)
|
|
{
|
|
my ($hash, $command) = @_;
|
|
my $item;
|
|
my @commands = split("\\|", $hash->{helper}{INPUTS});
|
|
|
|
foreach $item (@commands)
|
|
{
|
|
if(lc(YAMAHA_AVR_InputParam2Fhem($item, 0)) eq $command)
|
|
{
|
|
return $item;
|
|
}
|
|
}
|
|
|
|
return undef;
|
|
|
|
}
|
|
|
|
#############################
|
|
# queries the receiver model, system-id, version and all available zones
|
|
sub YAMAHA_AVR_getModel($)
|
|
{
|
|
my ($hash) = @_;
|
|
my $name = $hash->{NAME};
|
|
my $address = $hash->{helper}{ADDRESS};
|
|
my $response;
|
|
my $desc_url;
|
|
|
|
$response = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"GET\"><System><Unit_Desc>GetParam</Unit_Desc></System></YAMAHA_AV>");
|
|
|
|
Log3 $name, 3, "YAMAHA_AVR: could not get unit description url from device $name. Please turn on the device or check for correct hostaddress!" if (not defined($response) and defined($hash->{helper}{AVAILABLE}) and $hash->{helper}{AVAILABLE} eq 1);
|
|
|
|
if(defined($response) and $response =~ /<URL>(.+?)<\/URL>/)
|
|
{
|
|
$desc_url = $1;
|
|
}
|
|
else
|
|
{
|
|
$desc_url = "/YamahaRemoteControl/desc.xml";
|
|
}
|
|
|
|
$response = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"GET\"><System><Config>GetParam</Config></System></YAMAHA_AV>");
|
|
|
|
Log3 $name, 3, "YAMAHA_AVR: could not get system configuration from device $name. Please turn on the device or check for correct hostaddress!" if (not defined($response) and defined($hash->{helper}{AVAILABLE}) and $hash->{helper}{AVAILABLE} eq 1);
|
|
|
|
if(defined($response) and $response =~ /<Model_Name>(.+?)<\/Model_Name>.*<System_ID>(.+?)<\/System_ID>.*<Version>(.+?)<\/Version>/)
|
|
{
|
|
$hash->{MODEL} = $1;
|
|
$hash->{SYSTEM_ID} = $2;
|
|
$hash->{FIRMWARE} = $3;
|
|
}
|
|
elsif(defined($response) and $response =~ /<Model_Name>(.+?)<\/Model_Name>.*<System_ID>(.+?)<\/System_ID>.*<Version>.*<Main>(.+?)<\/Main>.*<Sub>(.+?)<\/Sub>.*<\/Version>/)
|
|
{
|
|
$hash->{MODEL} = $1;
|
|
$hash->{SYSTEM_ID} = $2;
|
|
$hash->{FIRMWARE} = $3." ".$4;
|
|
}
|
|
else
|
|
{
|
|
return undef;
|
|
}
|
|
|
|
# query the description url which contains all zones
|
|
$response = CustomGetFileFromURL(0, "http://".$address.$desc_url, 4, undef, 0, ($hash->{helper}{AVAILABLE} ? 3 : 5));
|
|
|
|
Log3 $name, 3, "YAMAHA_AVR: could not get unit description from device $name. Please turn on the device or check for correct hostaddress!" if (not defined($response) and defined($hash->{helper}{AVAILABLE}) and $hash->{helper}{AVAILABLE} eq 1);
|
|
|
|
return undef unless(defined($response));
|
|
|
|
while($response =~ /<Menu Func="Subunit" Title_1="(.+?)" YNC_Tag="(.+?)">/gc)
|
|
{
|
|
if(defined($hash->{helper}{ZONES}) and length($hash->{helper}{ZONES}) > 0)
|
|
{
|
|
$hash->{helper}{ZONES} .= "|";
|
|
}
|
|
|
|
$hash->{helper}{ZONES} .= $2;
|
|
|
|
}
|
|
|
|
# uncommented line for zone detection testing
|
|
#
|
|
# $hash->{helper}{ZONES} .= "|Zone_2";
|
|
|
|
$hash->{ZONES_AVAILABLE} = YAMAHA_AVR_Param2Fhem($hash->{helper}{ZONES}, 1);
|
|
|
|
# if explicitly given in the define command, set the desired zone
|
|
if(defined(YAMAHA_AVR_getZoneName($hash, lc $hash->{helper}{SELECTED_ZONE})))
|
|
{
|
|
Log3 $name, 4, "YAMAHA_AVR: using zone ".YAMAHA_AVR_getZoneName($hash, lc $hash->{helper}{SELECTED_ZONE});
|
|
$hash->{ACTIVE_ZONE} = lc $hash->{helper}{SELECTED_ZONE};
|
|
}
|
|
else
|
|
{
|
|
Log3 $name, 2, "YAMAHA_AVR: selected zone >>".$hash->{helper}{SELECTED_ZONE}."<< is not available on device $name. Using Main Zone instead";
|
|
$hash->{ACTIVE_ZONE} = "mainzone";
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
sub YAMAHA_AVR_volume_rel2abs($)
|
|
{
|
|
my ($percentage) = @_;
|
|
|
|
# 0 - 100% -equals 80.5 to 16.5 dB
|
|
return int((($percentage / 100 * 97) - 80.5) / 0.5) * 0.5;
|
|
}
|
|
|
|
|
|
sub YAMAHA_AVR_volume_abs2rel($)
|
|
{
|
|
my ($absolute) = @_;
|
|
|
|
# -80.5 to 16.5 dB equals 0 - 100%
|
|
return int(($absolute + 80.5) / 97 * 100);
|
|
}
|
|
|
|
#############################
|
|
# queries all available inputs and scenes
|
|
sub YAMAHA_AVR_getInputs($)
|
|
{
|
|
|
|
my ($hash) = @_;
|
|
my $name = $hash->{NAME};
|
|
my $address = $hash->{helper}{ADDRESS};
|
|
|
|
my $zone = YAMAHA_AVR_getZoneName($hash, $hash->{ACTIVE_ZONE});
|
|
|
|
return undef if (not defined($zone) or $zone eq "");
|
|
|
|
my $response = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"GET\"><$zone><Input><Input_Sel_Item>GetParam</Input_Sel_Item></Input></$zone></YAMAHA_AV>");
|
|
|
|
|
|
Log3 $name, 3, "YAMAHA_AVR: could not get the available inputs from device $name. Please turn on the device or check for correct hostaddress!!!" if (not defined($response) and defined($hash->{helper}{AVAILABLE}) and $hash->{helper}{AVAILABLE} eq 1);
|
|
|
|
return undef unless (defined($response));
|
|
|
|
|
|
delete($hash->{helper}{INPUTS}) if(defined($hash->{helper}{INPUTS}));
|
|
|
|
|
|
|
|
while($response =~ /<Param>(.+?)<\/Param>/gc)
|
|
{
|
|
if(defined($hash->{helper}{INPUTS}) and length($hash->{helper}{INPUTS}) > 0)
|
|
{
|
|
$hash->{helper}{INPUTS} .= "|";
|
|
}
|
|
|
|
$hash->{helper}{INPUTS} .= $1;
|
|
}
|
|
|
|
$hash->{helper}{INPUTS} = join("|", sort split("\\|", $hash->{helper}{INPUTS}));
|
|
|
|
|
|
# query all available scenes
|
|
$response = YAMAHA_AVR_SendCommand($hash, "<YAMAHA_AV cmd=\"GET\"><$zone><Scene><Scene_Sel_Item>GetParam</Scene_Sel_Item></Scene></$zone></YAMAHA_AV>", 5);
|
|
|
|
delete($hash->{helper}{SCENES}) if(defined($hash->{helper}{SCENES}));
|
|
|
|
return undef unless (defined($response));
|
|
|
|
|
|
|
|
# get all available scenes from response
|
|
while($response =~ /<Item_\d+>.*?<Param>(.+?)<\/Param>.*?<RW>(\w+)<\/RW>.*?<\/Item_\d+>/gc)
|
|
{
|
|
# check if the RW-value is "W" (means: writeable => can be set through FHEM)
|
|
if($2 eq "W")
|
|
{
|
|
if(defined($hash->{helper}{SCENES}) and length($hash->{helper}{SCENES}) > 0)
|
|
{
|
|
$hash->{helper}{SCENES} .= "|";
|
|
}
|
|
$hash->{helper}{SCENES} .= $1;
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
1;
|
|
|
|
=pod
|
|
=begin html
|
|
|
|
<a name="YAMAHA_AVR"></a>
|
|
<h3>YAMAHA_AVR</h3>
|
|
<ul>
|
|
|
|
<a name="YAMAHA_AVRdefine"></a>
|
|
<b>Define</b>
|
|
<ul>
|
|
<code>define <name> YAMAHA_AVR <ip-address> [<zone>] [<status_interval>]</code>
|
|
<br><br>
|
|
|
|
This module controls AV receiver from Yamaha via network connection. You are able
|
|
to power your AV reveiver on and off, query it's power state,
|
|
select the input (HDMI, AV, AirPlay, internet radio, Tuner, ...), select the volume
|
|
or mute/unmute the volume.<br><br>
|
|
Defining a YAMAHA_AVR device will schedule an internal task (interval can be set
|
|
with optional parameter <status_interval> in seconds, if not set, the value is 30
|
|
seconds), which periodically reads the status of the AV receiver (power state, selected
|
|
input, volume and mute status) and triggers notify/filelog commands.<br><br>
|
|
|
|
Example:<br><br>
|
|
<ul><code>
|
|
define AV_Receiver YAMAHA_AVR 192.168.0.10
|
|
<br><br>
|
|
define AV_Receiver YAMAHA_AVR 192.168.0.10 mainzone 60 # With custom interval of 60 seconds
|
|
</code></ul>
|
|
|
|
</ul>
|
|
<br><br>
|
|
<b>Zone Selection</b><br>
|
|
<ul>
|
|
If your receiver supports zone selection (e.g. RX-V671, RX-V673,... and the AVANTAGE series)
|
|
you can select the zone which should be controlled. The RX-V3xx and RX-V4xx series for example
|
|
just have a "Main Zone" (which is the whole receiver itself). In general you have the following
|
|
possibilities for the parameter <zone> (depending on your receiver model).<br><br>
|
|
<ul>
|
|
<li><b>mainzone</b> - this is the main zone (standard)</li>
|
|
<li><b>zone2</b> - The second zone (Zone 2)</li>
|
|
<li><b>zone3</b> - The third zone (Zone 3)</li>
|
|
<li><b>zone4</b> - The fourth zone (Zone 4)</li>
|
|
</ul>
|
|
<br>
|
|
Depending on your receiver model you have not all inputs available on these different zones.
|
|
The module just offers the real available inputs.
|
|
<br><br>
|
|
Example:
|
|
<br><br>
|
|
<ul><code>
|
|
define AV_Receiver YAMAHA_AVR 192.168.0.10 # If no zone is specified, the "Main Zone" will be used.<br>
|
|
attr AV_Receiver YAMAHA_AVR room Livingroom<br>
|
|
<br>
|
|
# Define the second zone<br>
|
|
define AV_Receiver_Zone2 YAMAHA_AVR 192.168.0.10 zone2<br>
|
|
attr AV_Receiver_Zone2 room Bedroom
|
|
</code></ul><br><br>
|
|
For each Zone you will need an own YAMAHA_AVR device, which can be assigned to a different room.
|
|
Each zone can be controlled separatly from all other available zones.
|
|
<br><br>
|
|
</ul>
|
|
|
|
<a name="YAMAHA_AVRset"></a>
|
|
<b>Set </b>
|
|
<ul>
|
|
<code>set <name> <command> [<parameter>]</code>
|
|
<br><br>
|
|
Currently, the following commands are defined; the available inputs are depending on the used receiver.
|
|
The module only offers the real available inputs and scenes. The following input commands are just an example and can differ.
|
|
<br><br>
|
|
<ul>
|
|
<li><b>on</b> - powers on the device</li>
|
|
<li><b>off</b> - shuts down the device </li>
|
|
<li><b>input</b> hdm1,hdmX,... - selects the input channel (only the real available inputs were given)</li>
|
|
<li><b>scene</b> scene1,sceneX - select the scene</li>
|
|
<li><b>volume</b> 0...100 - set the volume level in percentage</li>
|
|
<li><b>volumeStraight</b> -80...15 - set the volume level in decibel</li>
|
|
<li><b>volumeUp</b> [0-100] - increases the volume level by 5% or the value of attribute volumeSteps (optional the increasing level can be given as argument, which will be used instead)</li>
|
|
<li><b>volumeDown</b> [0-100] - decreases the volume level by 5% or the value of attribute volumeSteps (optional the decreasing level can be given as argument, which will be used instead)</li>
|
|
<li><b>mute</b> on|off - activates volume mute</li>
|
|
<li><b>statusRequest</b> - requests the current status of the device</li>
|
|
<li><b>remoteControl</b> up,down,... - sends remote control commands as listed below</li>
|
|
</ul>
|
|
</ul><br><br>
|
|
<u>Remote control (not in all zones available, depending on your model)</u><br><br>
|
|
<ul>
|
|
In many receiver models, inputs exist, which can't be used just by selecting them. These inputs needs
|
|
a manual interaction with the remote control to activate the playback (e.g. Internet Radio, Network Streaming).<br><br>
|
|
For this application the following commands are available:<br><br>
|
|
|
|
<u>Cursor Selection:</u><br><br>
|
|
<ul><code>
|
|
remoteControl up<br>
|
|
remoteControl down<br>
|
|
remoteControl left<br>
|
|
remoteControl right<br>
|
|
remoteControl enter<br>
|
|
remoteControl return<br>
|
|
</code></ul><br><br>
|
|
|
|
<u>Menu Selection:</u><br><br>
|
|
<ul><code>
|
|
remoteControl setup<br>
|
|
remoteControl option<br>
|
|
remoteControl display<br>
|
|
</code></ul><br><br>
|
|
|
|
The button names are the same as on your remote control.<br><br>
|
|
|
|
A typical example is the automatical turn on and play an internet radio broadcast:<br><br>
|
|
<ul><code>
|
|
# the initial definition.<br>
|
|
define AV_receiver YAMAHA_AVR 192.168.0.3
|
|
</code></ul><br><br>
|
|
And in your 99_MyUtils.pm the following function:<br><br>
|
|
<ul><code>
|
|
sub startNetRadio()<br>
|
|
{<br>
|
|
fhem "set AV_Receiver on";<br>
|
|
sleep 5;<br>
|
|
fhem "set AV_Receiver input netradio";<br>
|
|
sleep 4;<br>
|
|
fhem "set AV_Receiver remoteControl enter";<br>
|
|
sleep 2;<br>
|
|
fhem "set AV_Receiver remoteControl enter";<br>
|
|
}
|
|
</code></ul><br><br>
|
|
The remote control commands must be separated with a sleep, because the receiver is loading meanwhile and don't accept commands.<br><br>
|
|
|
|
Now you can use this function by typing the following line in your FHEM command line or in your notify-definitions:<br><br>
|
|
<ul><code>
|
|
{startNetRadio()}
|
|
</code></ul><br><br>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
<a name="YAMAHA_AVRget"></a>
|
|
<b>Get</b>
|
|
<ul>
|
|
<code>get <name> <what></code>
|
|
<br><br>
|
|
Currently, the following commands are defined and return the current state of the receiver.<br><br>
|
|
<ul><code>power<br>
|
|
input<br>
|
|
inputName<br>
|
|
mute<br>
|
|
volume<br>
|
|
volumeStraight<br>
|
|
presence<br>
|
|
output # only available in zones other than mainzone</code></ul><br><br>
|
|
</ul>
|
|
<a name="YAMAHA_AVRattr"></a>
|
|
<b>Attributes</b>
|
|
<ul>
|
|
|
|
<li><a href="#do_not_notify">do_not_notify</a></li>
|
|
<li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
|
|
<li><a name="volume-smooth-change">volume-smooth-change</a></li>
|
|
Optional attribute to activate a smooth volume change.
|
|
<br><br>
|
|
Possible values: 0 => off , 1 => on<br><br>
|
|
<li><a name="volume-smooth-steps">volume-smooth-steps</a></li>
|
|
Optional attribute to define the number of volume changes between the
|
|
current and the desired volume. Default value is 5 steps<br><br>
|
|
<li><a name="volume-smooth-steps">volumeSteps</a></li>
|
|
Optional attribute to define the default increasing and decreasing level for the volumeUp and volumeDown set command. Default value is 5%<br>
|
|
</ul>
|
|
<br>
|
|
<b>Generated Readings/Events:</b><br>
|
|
<ul>
|
|
<li><b>input</b> - The selected input source according to the FHEM input commands</li>
|
|
<li><b>inputName</b> - The input description as seen on the receiver display</li>
|
|
<li><b>mute</b> - Reports the mute status of the receiver or zone (can be "on" or "off")</li>
|
|
<li><b>power</b> - Reports the power status of the receiver or zone (can be "on" or "off")</li>
|
|
<li><b>presence</b> - Reports the presence status of the receiver or zone (can be "absent" or "present"). In case of an absent device, it cannot be controlled via FHEM anymore.</li>
|
|
<li><b>volume</b> - Reports the current volume level of the receiver or zone in percentage values (between 0 and 100 %)</li>
|
|
<li><b>volumeStraight</b> - Reports the current volume level of the receiver or zone in decibel values (between -80.5 and +15.5 dB)</li>
|
|
<li><b>state</b> - Reports the current power state and an absence of the device (can be "on", "off" or "absent")</li>
|
|
</ul>
|
|
<br>
|
|
<b>Implementator's note</b><br>
|
|
<ul>
|
|
The module is only usable if you activate "Network Standby" on your receiver. Otherwise it is not possible to communicate with the receiver when it is turned off.
|
|
</ul>
|
|
<br>
|
|
</ul>
|
|
|
|
|
|
=end html
|
|
=begin html_DE
|
|
|
|
<a name="YAMAHA_AVR"></a>
|
|
<h3>YAMAHA_AVR</h3>
|
|
<ul>
|
|
|
|
<a name="YAMAHA_AVRdefine"></a>
|
|
<b>Definition</b>
|
|
<ul>
|
|
<code>define <name> YAMAHA_AVR <IP-Addresse> [<Zone>] [<Status_Interval>]</code>
|
|
<br><br>
|
|
|
|
Dieses Modul steuert AV-Receiver des Herstellers Yamaha über die Netzwerkschnittstelle.
|
|
Es bietet die Möglichkeit den Receiver an-/auszuschalten, den Eingangskanal zu wählen,
|
|
die Lautstärke zu ändern, den Receiver "Stumm" zu schalten, sowie den aktuellen Status abzufragen.
|
|
<br><br>
|
|
Bei der Definition eines YAMAHA_AVR-Moduls wird eine interne Routine in Gang gesetzt, welche regelmäßig
|
|
(einstellbar durch den optionalen Parameter <code><Status_Interval></code>; falls nicht gesetzt ist der Standardwert 30 Sekunden)
|
|
den Status des Receivers abfragt und entsprechende Notify-/FileLog-Geräte triggert..<br><br>
|
|
|
|
Beispiel:<br><br>
|
|
<ul><code>
|
|
define AV_Receiver YAMAHA_AVR 192.168.0.10<br><br>
|
|
|
|
define AV_Receiver YAMAHA_AVR 192.168.0.10 mainzone 60 # Mit modifiziertem Status Interval (60 Sekunden)
|
|
</code></ul><br><br>
|
|
</ul>
|
|
<b>Zonenauswahl</b><br>
|
|
<ul>
|
|
Wenn der zu steuernde Receiver mehrere Zonen besitzt (z.B. RX-V671, RX-V673,... sowie die AVANTAGE Modellreihe)
|
|
kann die zu steuernde Zone explizit angegeben werden. Die Modellreihen RX-V3xx und RX-V4xx als Beispiel
|
|
haben nur eine Zone (Main Zone). Je nach Receiver-Modell stehen folgende Zonen zur Verfügung, welche mit
|
|
dem optionalen Parameter <Zone> angegeben werden können.<br><br>
|
|
<ul>
|
|
<li><b>mainzone</b> - Das ist die Hauptzone (Standard)</li>
|
|
<li><b>zone2</b> - Die zweite Zone (Zone 2)</li>
|
|
<li><b>zone3</b> - Die dritte Zone (Zone 3)</li>
|
|
<li><b>zone4</b> - Die vierte Zone (Zone 4)</li>
|
|
</ul>
|
|
<br>
|
|
Je nach Receiver-Modell stehen in den verschiedenen Zonen nicht immer alle Eingänge zur Verfügung.
|
|
Dieses Modul bietet nur die tatsächlich verfügbaren Eingänge an.
|
|
<br><br>
|
|
Beispiel:<br><br>
|
|
<ul><code>
|
|
define AV_Receiver YAMAHA_AVR 192.168.0.10 # Wenn keine Zone angegeben ist, wird<br>
|
|
attr AV_Receiver YAMAHA_AVR room Wohnzimmer # standardmäßig "mainzone" verwendet<br>
|
|
<br>
|
|
# Definition der zweiten Zone<br>
|
|
define AV_Receiver_Zone2 YAMAHA_AVR 192.168.0.10 zone2<br>
|
|
attr AV_Receiver_Zone2 room Schlafzimmer<br>
|
|
</code></ul><br><br>
|
|
Für jede Zone muss eine eigene YAMAHA_AVR Definition erzeugt werden, welche dann unterschiedlichen Räumen zugeordnet werden kann.
|
|
Jede Zone kann unabhängig von allen anderen Zonen (inkl. der Main Zone) gesteuert werden.
|
|
<br><br>
|
|
</ul>
|
|
|
|
<a name="YAMAHA_AVRset"></a>
|
|
<b>Set-Kommandos </b>
|
|
<ul>
|
|
<code>set <Name> <Kommando> [<Parameter>]</code>
|
|
<br><br>
|
|
Aktuell werden folgende Kommandos unterstützt. Die verfügbaren Eingänge und Szenen können je nach Receiver-Modell variieren.
|
|
Die folgenden Eingänge stehen beispielhaft an einem RX-V473 Receiver zur Verfügung.
|
|
Aktuell stehen folgende Kommandos zur Verfügung.
|
|
<br><br>
|
|
<ul>
|
|
<li><b>on</b> - Schaltet den Receiver ein</li>
|
|
<li><b>off</b> - Schaltet den Receiver aus</li>
|
|
<li><b>input</b> hdm1,hdmX,... - Wählt den Eingangskanal (es werden nur die tatsächlich verfügbaren Eingänge angeboten)</li>
|
|
<li><b>scene</b> scene1,sceneX - Wählt eine vorgefertigte Szene aus</li>
|
|
<li><b>volume</b> 0...100 - Setzt die Lautstärke in Prozent (0 bis 100%)</li>
|
|
<li><b>volumeStraight</b> -87...15 - Setzt die Lautstärke in Dezibel (-80.5 bis 15.5 dB) so wie sie am Receiver auch verwendet wird.</li>
|
|
<li><b>volumeUp</b> [0...100] - Erhöht die Lautstärke um 5% oder entsprechend dem Attribut volumeSteps (optional kann der Wert auch als Argument angehangen werden, dieser hat dann Vorang) </li>
|
|
<li><b>volumeDown</b> [0...100] - Veringert die Lautstärke um 5% oder entsprechend dem Attribut volumeSteps (optional kann der Wert auch als Argument angehangen werden, dieser hat dann Vorang) </li>
|
|
<li><b>mute</b> on|off - Schaltet den Receiver stumm</li>
|
|
<li><b>statusRequest</b> - Fragt den aktuell Status des Receivers ab</li>
|
|
<li><b>remoteControl</b> up,down,... - Sendet Fernbedienungsbefehle wie im nächsten Abschnitt beschrieben</li>
|
|
</ul>
|
|
<br><br>
|
|
</ul>
|
|
<u>Fernbedienung (je nach Modell nicht in allen Zonen verfügbar)</u><br><br>
|
|
<ul>
|
|
In vielen Receiver-Modellen existieren Eingänge, welche nach der Auswahl keinen Sound ausgeben. Diese Eingänge
|
|
bedürfen manueller Interaktion mit der Fernbedienung um die Wiedergabe zu starten (z.B. Internet Radio, Netzwerk Streaming, usw.).<br><br>
|
|
Für diesen Fall gibt es folgende Befehle:<br><br>
|
|
|
|
<u>Cursor Steuerung:</u><br><br>
|
|
<ul><code>
|
|
remoteControl up<br>
|
|
remoteControl down<br>
|
|
remoteControl left<br>
|
|
remoteControl right<br>
|
|
remoteControl enter<br>
|
|
remoteControl return<br>
|
|
</code></ul><br><br>
|
|
|
|
<u>Menü Auswahl:</u><br><br>
|
|
<ul><code>
|
|
remoteControl setup<br>
|
|
remoteControl option<br>
|
|
remoteControl display<br>
|
|
</code></ul><br><br>
|
|
|
|
Die Befehlsnamen entsprechen den Tasten auf der Fernbedienung.<br><br>
|
|
|
|
Ein typisches Beispiel ist das automatische Einschalten und Abspielen eines Internet Radio Sender:<br><br>
|
|
<ul><code>
|
|
# Die Gerätedefinition<br><br>
|
|
define AV_receiver YAMAHA_AVR 192.168.0.3
|
|
</code></ul><br><br>
|
|
Und in der 99_MyUtils.pm die folgende Funktion:<br><br>
|
|
<ul><code>
|
|
sub startNetRadio<br>
|
|
{<br>
|
|
fhem "set AV_Receiver on";<br>
|
|
sleep 5;<br>
|
|
fhem "set AV_Receiver input netradio";<br>
|
|
sleep 4;<br>
|
|
fhem "set AV_Receiver remoteControl enter";<br>
|
|
sleep 2;<br>
|
|
fhem "set AV_Receiver remoteControl enter";<br>
|
|
}
|
|
</code></ul><br><br>
|
|
Die Kommandos der Fernbedienung müssen mit einem sleep pausiert werden, da der Receiver in der Zwischenzeit arbeitet und keine Befehle annimmt..<br><br>
|
|
|
|
Nun kann man diese Funktion in der FHEM Kommandozeile oder in notify-Definitionen wie folgt verwenden.:<br><br>
|
|
<ul><code>
|
|
{startNetRadio()}
|
|
</code></ul><br><br>
|
|
</ul>
|
|
|
|
<a name="YAMAHA_AVRget"></a>
|
|
<b>Get-Kommandos</b>
|
|
<ul>
|
|
<code>get <Name> <Parameter></code>
|
|
<br><br>
|
|
Aktuell stehen folgende Parameter zur Verfügung welche den aktuellen Status des Receivers zurück geben.<br><br>
|
|
<ul>
|
|
<li><code>power</code> - Betriebszustand des Receiveres/Zone (on oder off)</li>
|
|
<li><code>presence</code> - Empfangsbereitschaft des Receivers (absent oder present)</li>
|
|
<li><code>input</code> - Gewählter Eingang</li>
|
|
<li><code>inputName</code> - Bezeichnung des gewählten Einganges wie im Display des Receivers</li>
|
|
<li><code>mute</code> - Lautlos an oder aus (on oder off)</li>
|
|
<li><code>volume</code> - Lautstärkepegel in %</li>
|
|
<li><code>volumeStraight</code> - Lautstärkepegel in dB</li>
|
|
</ul>
|
|
</ul>
|
|
<br>
|
|
<a name="YAMAHA_AVRattr"></a>
|
|
<b>Attribute</b>
|
|
<ul>
|
|
|
|
<li><a href="#do_not_notify">do_not_notify</a></li>
|
|
<li><a href="#readingFnAttributes">readingFnAttributes</a></li><br>
|
|
<li><a name="volume-smooth-change">volume-smooth-change</a></li>
|
|
Optionales Attribut, welches einen weichen Lautstärkeübergang aktiviert..
|
|
<br><br>
|
|
Mögliche Werte: 0 => deaktiviert , 1 => aktiviert<br><br>
|
|
<li><a name="volume-smooth-steps">volume-smooth-steps</a></li>
|
|
Optionales Attribut, welches angibt, wieviele Schritte zur weichen Lautstärkeanpassung
|
|
durchgeführt werden sollen. Standartwert ist 5 Anpassungschritte<br><br>
|
|
<li><a name="volumeSteps">volumeSteps</a></li>
|
|
Optionales Attribut, welches den Standartwert zur Lautstärkenerhöhung (volumeUp) und Lautstärkenveringerung (volumeDown) konfiguriert. Standartwert ist 5%<br>
|
|
<br>
|
|
</ul>
|
|
<b>Generierte Readings/Events:</b><br>
|
|
<ul>
|
|
<li><b>input</b> - Der ausgewählte Eingang entsprechend dem FHEM-Kommando</li>
|
|
<li><b>inputName</b> - Die Eingangsbezeichnung, so wie sie am Receiver eingestellt wurde und auf dem Display erscheint</li>
|
|
<li><b>mute</b> - Der aktuelle Stumm-Status("on" => Stumm, "off" => Laut)</li>
|
|
<li><b>power</b> - Der aktuelle Betriebsstatuse ("on" => an, "off" => aus)</li>
|
|
<li><b>presence</b> - Die aktuelle Empfangsbereitschaft ("present" => empfangsbereit, "absent" => nicht empfangsbereits, z.B. Stromausfall)</li>
|
|
<li><b>volume</b> - Der aktuelle Lautstärkepegel in Prozent (zwischen 0 und 100 %)</li>
|
|
<li><b>volumeStraight</b> - Der aktuelle Lautstärkepegel in Dezibel (zwischen -80.0 und +15 dB)</li>
|
|
<li><b>state</b> - Der aktuelle Schaltzustand (power-Reading) oder die Abwesenheit des Gerätes (mögliche Werte: "on", "off" oder "absent")</li>
|
|
</ul>
|
|
<br>
|
|
<b>Hinweise des Autors</b>
|
|
<ul>
|
|
Dieses Modul ist nur nutzbar, wenn die Option "Network Standby" am Receiver aktiviert ist. Ansonsten ist die Steuerung nur im eingeschalteten Zustand möglich.
|
|
</ul>
|
|
<br>
|
|
</ul>
|
|
=end html_DE
|
|
|
|
=cut
|