do_fhem/fhem/core/contrib/97_GROUP.pm

################################################################################
# 97 GROUP
# Feedback: http://groups.google.com/group/fhem-users
# Autor: Axel Rieger fhem[bei]anax.info
# Stand: 05.07.2012
# Version: 1.2
################################################################################
# Usage:
# define <New-Group-Name> GROUP <CATEGORY>
# set <New-Group-Name> ADD/DEL <NAME>:<DEVICENAME>:<READING>
# READING-VALUES are first searched there $hash{<DEVICENAME>}{READINGS}{<READING>}
# and for the second there $hash{<DEVICENAME>}{<READING>}
#
# Special READINGs
# FHT-Device and READING = DNW
# Displays: Day-Temp Night-Temp WindowOpen-Temp: D:22.00 N:18.00 W:5.50
#
# Special Categories:
# SHOWLEFT -> DisplayName & Value appear on the Left-Side (DIV-Left)
#
# Unkown READINGS appear as "???"
# Unkown TimeStamps appear as "****-**-** **:**:**"
################################################################################
package main;
use strict;
use warnings;
use Data::Dumper;
use vars qw(%data);
#-------------------------------------------------------------------------------
sub GROUP_Initialize($)
{
  my ($hash) = @_;
  $hash->{DefFn} = "GRP_Define";
  $hash->{SetFn}    = "GRP_Set";
  $hash->{UndefFn}   = "GRP_Undef";
  $hash->{AttrList}  = "loglevel:0,5";
  # CGI
  my $name = "GROUPS";
  my $fhem_url = "/" . $name ;
  $data{FWEXT}{$fhem_url}{FUNC} = "GRP_CGI";
  $data{FWEXT}{$fhem_url}{LINK} = $name;
  $data{FWEXT}{$fhem_url}{NAME} = $name;
  # Special READINGs
	$data{GROUP}{READINGS}{DNW} = "GRP_GET_READING_DNW";
  return undef;
}
#-------------------------------------------------------------------------------
sub GRP_Define(){
  # define <GROUP-NMAE> GROUP <CATEGORY-NAME>
  # If no Cat is defined:<GROUP-NMAE> = <CATEGORY-NAME>
  my ($self, $defs) = @_;
  my $name = $self->{NAME};
  # defs = $a[0] <GROUP-DEVICE-NAME> $a[1] GROUP $a[2]<CATEGORY-NAME>;
  my @a = split(/ /, $defs);
  # CATEGORY
  my $cat = $name;
  if(int(@a) gt 2){$cat = $a[2];}
  my $ret = &GRP_HANDLE_CAT($name,$cat);
  # Save cat to State
  $self->{STATE} = $cat;
  #Default ROOM DEF.GROUP
  $attr{$self->{NAME}}{room} = "DEF.GROUP";
  return undef;
  }
#-------------------------------------------------------------------------------
sub GRP_Undef(){
  my ($self, $name) = @_;
  # $dc = Device-Count in categorie
	my $dc = 1;
  if(defined($modules{GROUP}{defptr})) {
    foreach my $d (sort keys %{$modules{GROUP}{defptr}}){
      if(defined($modules{GROUP}{defptr}{$d}{$name})){
      delete $modules{GROUP}{defptr}{$d}{$name};
			$dc = keys(%{$modules{GROUP}{defptr}{$d}});
      }
			# Delete empty Categories
			if($dc eq 0) {
				Log 0, "GROUP UNDEF DELETE CAT: $d";
				delete $modules{GROUP}{defptr}{$d};
				};
    }
  }
	$dc = 1;
  if(defined($modules{GROUP}{conf})) {
    foreach my $c (sort keys %{$modules{GROUP}{conf}}){
      if(defined($modules{GROUP}{conf}{$c}{$name})){
      delete $modules{GROUP}{conf}{$c}{$name};
			$dc = keys(%{$modules{GROUP}{conf}{$c}});
      }
			# Delete empty Categories
			if($dc eq 0) {
				Log 0, "GROUP UNDEF DELETE CAT: $c";
				delete $modules{GROUP}{defptr}{$c};
				};
    }
  }
	# ??? empty CAT is left ???
	# Check for empty categories

  return undef;
}
#-------------------------------------------------------------------------------
sub GRP_Set()
 {
  # set <NAME> ADD/DEL <NAME>:<DEVICE-NAME>:<READING>
  # @a => a[0]:<NAME>; a[1]=ADD; a[2]= <DEVICE-NAME>:<READING>
  my ($self, @a) = @_;
  # FHEMWEB Question....select
  return "GROUP Unknown argument $a[1], choose one of ". join(" ",sort keys %{$self->{READINGS}}) if($a[1] eq "?");
  # ADD
  if($a[1] eq "ADD") {
  my ($name,$dev,$reading) = split(/:/,$a[2]);
  if(!defined($defs{$dev})){return "Device unkwon";}
  $self->{READINGS}{$name}{VAL} = $dev . ":" . $reading;
  $self->{READINGS}{$name}{TIME} = TimeNow();
  }
  if($a[1] eq "DEL") {
    delete $self->{READINGS}{$a[2]};
    }
  # Set GROUP-CAT
  # set <NAME> CAT <CATEGORY-NAME>
  if($a[1] eq "CAT") {
    $self->{STATE} = $a[2];
  }
  return undef;
}
#-------------------------------------------------------------------------------
sub GRP_CGI()
{
  my ($htmlarg) = @_;
  # htmlarg = /GROUPS/<CAT-NAME>
  my $Cat = GRP_CGI_DISPTACH_URL($htmlarg);
	Log 0,"GROUPS-FW-FEHM: $FW_ME";
	if(!defined($Cat)){$Cat = ""};
  my ($ret_html);
  $ret_html = "<!DOCTYPE html PUBLIC \"-\/\/W3C\/\/DTD HTML 4.01\/\/EN\" \"http:\/\/www.w3.org\/TR\/html4\/strict.dtd\">\n";
  $ret_html .= "<html>\n";
  $ret_html .= "<head>\n";
  $ret_html .= &GRP_CGI_CSS();
  $ret_html .= "<title>FHEM GROUPS<\/title>\n";
  $ret_html .= "<link href=\"$FW_ME/darkstyle.css\" rel=\"stylesheet\"/>\n";
  $ret_html .= "<\/head>\n";
  $ret_html .= "<body>\n";
  # DIV HDR
  $ret_html .= &GRP_CGI_TOP($Cat);
  # DIV LEFT
  $ret_html .= &GRP_CGI_LEFT($Cat);
  # DIV RIGHT
  $ret_html .= &GRP_CGI_RIGHT($Cat);
  # HTML
  $ret_html .= "</body>\n";
  $ret_html .= "</html>\n";
  return ("text/html; charset=ISO-8859-1", $ret_html);
}
#-------------------------------------------------------------------------------
sub GRP_CGI_CSS() {
  my $css;
  $css   =  "<style type=\"text/css\"><!--\n";
  $css .= "\#left {float: left; width: 15%; height:100%;}\n";
  # $css .= "table.GROUP { border:thin solid; background: #E0E0E0; text-align:left;}\n";
  $css .= "table.GROUP { border:thin solid; text-align:left;}\n";
  # $css .= "table.GROUP tr.odd { background: #F0F0F0;}\n";
  $css .= "table.GROUP td {nowrap;}";
  $css .= "\/\/--><\/style>";
  # TEST
  #$css = "<link href=\"$FW_ME/group.css\" rel=\"stylesheet\"/>\n";
  return $css;
}
#-------------------------------------------------------------------------------
sub GRP_CGI_TOP($) {
  my $CAT = shift(@_);
  # rh = return-Html
  my $rh;
  $rh = "<div id=\"hdr\">\n";
  $rh .= "<form method=\"get\" action=\"" . $FW_ME . "\">\n";
  $rh .= "<table WIDTH=\"100%\">\n";
  $rh .= "<tr>";
  $rh .= "<td><a href=\"" . $FW_ME . "\">FHEM:</a>$CAT</td>";
  $rh .= "<td><input type=\"text\" name=\"cmd\" size=\"30\"/></td>";
  $rh .= "</tr>\n";
  $rh .= "</table>\n";
  $rh .= "</form>\n";
  $rh .= "<br>\n";
  $rh .= "</div>\n";
  return $rh;
}
#-------------------------------------------------------------------------------
sub GRP_CGI_LEFT(){
  # rh = return-Html
  my $rh;
  # $rh = "<div id=\"left\">\n";
  $rh = "<div id=\"logo\"><img src=\"" . $FW_ME . "/fhem.png\"></div>";
  $rh .= "<div id=\"menu\">\n";
  # Print Groups
  $rh .= "<table class=\"room\">\n";
  foreach my $g (sort keys %{$modules{GROUP}{defptr}}){
    $rh .= "<tr><td>";
    $rh .= "<a href=\"" . $FW_ME . "/GROUPS/$g\">$g</a></h3>";
    $rh .= "</td></tr>\n";
  }
  $rh .= "</table><br>\n";
  #SHOWLEFT
  if(defined($modules{GROUP}{conf}{SHOWLEFT})){
    # $rh .= "<table class=\"room\">\n";
    $rh .= "<table id=\"room\">\n";
    foreach my $g (sort keys %{$modules{GROUP}{conf}{SHOWLEFT}}){
      #Tabelle
      $rh .= "<tr><th>$g</th><th></th></tr>\n";
      foreach my $r (sort keys %{$defs{$g}{READINGS}}){
        # $dn = DeviceName + $rn = Readingname to get ReadingValue
        my ($dn,$rn) = split(/:/,$defs{$g}{READINGS}{$r}{VAL});
				# $rv = ReadingValue; $rt = ReadingTime; $ru = ReadingUnit
        my ($rv,undef,undef) = &GRP_GET_READING_VAL($dn,$rn);
        $rh .= "<tr><td>$r</td><td>$rv</td></tr>\n";
      }
    }
    $rh .= "</table>\n";
  }
  $rh .= "</div>\n";
  return $rh;
}
#-------------------------------------------------------------------------------
sub GRP_CGI_RIGHT(){
  my ($CAT) = @_;
  my ($name,$device,$reading,$value,$vtime,$rh,$tr_class,$comment);
  # rh = return-Html
  my $row = 1;
  # Table GROUP
  # Name | Value | Time | Device-Type
  # $rh = "<div id=\"right\">\n";
  $rh = "<div id=\"content\">\n";
  # Category -> DEVICE
  foreach my $c (sort keys %{$modules{GROUP}{defptr}{$CAT}}){
    # Log 0,"GROUP CGI-RIGHT DEV: $c";
    $rh .= "<table class=\"GROUP\" WIDTH=\"85%\">\n";
    $rh .= "<tr>";
    $rh .= "<th align=\"left\" WIDTH=\"10%\"><a href=\"$FW_ME?detail=$c\">$c</a></th>";
    $rh .= "<th align=\"left\" WIDTH=\"8%\"></th>";
    if(defined($attr{$c}{comment})){
          $comment = $attr{$c}{comment};
          $rh .= "<th align=\"left\" WIDTH=\"20%\" colspan=\"2\">$comment</th>";}
    else {
        $rh .= "<th align=\"left\" WIDTH=\"10%\"></th>";
        $rh .= "<th align=\"left\" WIDTH=\"10%\"></th>";}

    $rh .= "</tr>\n";
    # GROUP -> READING
      foreach my $r (sort keys %{$defs{$c}{READINGS}}){
		  # $dn = DeviceName + $rn = Readingname to get ReadingValue
        my ($dn,$rn) = split(/:/,$defs{$c}{READINGS}{$r}{VAL});
		  # $rv = ReadingValue; $rt = ReadingTime; $ru = ReadingUnit
        my ($rv,$rt,$ru) = &GRP_GET_READING_VAL($dn,$rn);
        $tr_class = $row?"odd":"even";
        $rh .= "<tr class=\"" . $tr_class . "\"><td>$r</td><td>$rv&nbsp;$ru</td><td>$rt</td>";
        $rh .= "<td><a href=\"$FW_ME?detail=$dn\">$dn</a></td></tr>\n";
        $row = ($row+1)%2;
      }
    $rh .= "</table><br>\n";
  }
  $rh .= "</div>\n";
  return $rh;
}
#-------------------------------------------------------------------------------
sub GRP_CGI_DISPTACH_URL($){
  my ($htmlarg) = @_;
  my @params = split(/\//,$htmlarg);
  my $CAT = undef;
  if($params[2]) {
    $CAT = $params[2];
    # Log 0,"GRP URL-DISP-CAT: " . $CAT;
    }
  return $CAT;
}
#-------------------------------------------------------------------------------
sub GRP_HANDLE_CAT($$){
  my($device,$cat) = @_;
  # Normal Categories -> %modules{GROUP}{defptr}{<CAT-NAME>}{<GROUP-DEVICE-NAME>}
  # Spezial Categories -> %modules{GROUP}{conf}{<CAT-NAME>}{<GROUP-DEVICE-NAME>}
  if($cat eq "SHOWLEFT") {
    # Log 0,"GRP CAT-DISP-> SHOWLEFT -> $cat -> $device";
    $modules{GROUP}{conf}{$cat}{$device} = 1;
    return undef;
  }
  $modules{GROUP}{defptr}{$cat}{$device} = 1;
  return undef;
}
#-------------------------------------------------------------------------------
sub GRP_GET_READING_VAL($$){
  # IN $dn = DeviceName; $rn = ReadingName
  my($dn,$rn) = @_;
  # OUT $rv = ReadingValue; $rt = ReadingTime; $ru = ReadingUnit
	# Default Values
  my $rv = "???";
  my $rt = "****-**-** **:**:**";
  my $ru = "";
  # First $hash->{READINGS}
  if(defined($defs{$dn}{READINGS}{$rn}{VAL})) {
    $rv = $defs{$dn}{READINGS}{$rn}{VAL};
    $rt = $defs{$dn}{READINGS}{$rn}{TIME};
     }
  if($rv =~ m/ /){
    my @a = split(/ /, $rv);
    $rv = $a[0];
    $ru = $a[1];
    }
	if($rv =~ /\d{1}/) {
		$rv = sprintf("%.2f", $rv);
		}
  # Log 0,"GROUP GET-READING: $rv,$rt,$ru";
  # Second $hash
	# First Wins
  if(defined($defs{$dn}{$rn}) && $rv eq "???"){
    $rv = $defs{$dn}{$rn};
    $rt = " ";
  }
	# third Special READINGs
	if(defined($data{GROUP}{READINGS}{$rn}) && $rv eq "???" ){
		my $rv_function = $data{GROUP}{READINGS}{$rn};
		Log 0, "GROUP SP-READINGS Func: " . $rv_function;
		no strict "refs";
		if(defined(&$rv_function)){
			my ($rv_return,$rt_return) = &$rv_function($dn,$rn);
				# On ERROR return undef
				if($rv_return) {
					$rv = $rv_return;
					$rt = $rt_return;
					}
		}
		use strict "refs";
	}
  # Log 0,"GROUP GET-READING: $rv,$rt,$ru";
  return ($rv,$rt,$ru);
}
#-------------------------------------------------------------------------------
sub GRP_GET_READING_DNW($$){
	# FHT-Device and READING = DNW
	# Displays: Day-Temp Night-Temp WindowOpen-Temp: D:22.00 N:18.00 W:5.50
	# IN $dn = DeviceName; $rn = ReadingName
  my($dn,$rn) = @_;
	# Type = FHT ???
	if($defs{$dn}{TYPE} ne "FHT"){return undef;}
	my($day,$night,$window,$rv_time);
	$day = "??";
	$night = "??";
	$window = "??";
	$rv_time = "--";
	if(defined($defs{$dn}{READINGS}{'day-temp'}{VAL})) {
		$day = $defs{$dn}{READINGS}{'day-temp'}{VAL};
		}
	if(defined($defs{$dn}{READINGS}{'day-temp'}{TIME})) {
		$rv_time = $defs{$dn}{READINGS}{'day-temp'}{TIME};
		}
	if(defined($defs{$dn}{READINGS}{'night-temp'}{VAL})) {
		$night = $defs{$dn}{READINGS}{'night-temp'}{VAL};
		}
	if(defined($defs{$dn}{READINGS}{'windowopen-temp'}{VAL})) {
		$window = $defs{$dn}{READINGS}{'windowopen-temp'}{VAL};
		}
	# Retunr Value
	my $rv = "D:$day N:$night W:$window";
	return ($rv,$rv_time);
}
1;