';
if ($name && defined($defs{$name})) {
my $showfullsize = AttrVal($name, "dashboard_showfullsize", 0);
if ($showfullsize) {
if ($FW_RET =~ m/
]*class="([^"]+)"[^>]*>/) {
$FW_RET =~ s/class="$1"/class="$1 dashboard_fullsize"/;
}
else {
$FW_RET =~ s/{HELPER}{VERSION};
my $dbwidth = AttrVal($name, "dashboard_width", "100%");
my @tabnames = ();
my @tabsortings = ();
for (my $i = 0; $i < $tabcount; $i++) {
$tabnames[$i] = AttrVal($name, "dashboard_tab" . ($i + 1) . "name", "Dashboard-Tab " . ($i + 1));
$tabsortings[$i] = AttrVal($name, "dashboard_tab" . ($i + 1) . "sorting", "");
}
if ($disable == 1) {
readingsSingleUpdate($hash, "state", "Disabled", 0 );
return "";
}
# Hintergrundbild bauen
my $bimg = $hash->{HELPER}{BIMG}{MAIN}?"url(/fhem/images/$hash->{HELPER}{BIMG}{MAIN})":"none";
if ($debug == 1) { $debugfield = "edit"; }
if ($showtabs eq "tabs-and-buttonbar-at-the-top") { $showbuttonbar = "top"; }
if ($showtabs eq "tabs-and-buttonbar-on-the-bottom") { $showbuttonbar = "bottom"; }
if ($showbuttonbar eq "hidden") { $lockstate = "lock"; }
if ($activetab > $tabcount) { $activetab = $tabcount; }
$colwidth =~ tr/,/:/;
if (not ($colheight =~ /^\d+$/)) { $colheight = 400; }
if (not ($rowtopheight =~ /^\d+$/)) { $rowtopheight = 50; }
if (not ($rowbottomheight =~ /^\d+$/)) { $rowbottomheight = 50; }
#------------------- Check dashboard_sorting on false content ------------------------------------
for (my $i=0;$i<@tabsortings;$i++){
if (($tabsortings[$i-1] !~ /[0-9]+/ || $tabsortings[$i-1] !~ /:/ || $tabsortings[$i-1] !~ /,/ ) && ($tabsortings[$i-1] ne "," && $tabsortings[$i-1] ne "")) {
Log3 ($name, 3, "Dashboard $name - Value of attribut dashboard_tab".$i."sorting is wrong. Saved sorting can not be set. Fix Value or delete the Attribute. [".$tabsortings[$i-1]."]");
}
else {
Log3 ($name, 5, "Dashboard $name - Sorting OK or Empty: dashboard_tab".$i."sorting");
}
}
#-------------------------------------------------------------------------------------------------
if ($room ne "all") {
############################ Set FHEM url to avoid hardcoding it in javascript ############################
$ret .= "";
## Dashboard-Tab Details Tabelle (Stift rechte Seite im Kopf)
$ret .= "\n";
$ret .= "
\n";
$ret .= "
\n";
$ret .= "
\n";
$ret .= "
\n";
$ret .= "
\n";
$ret .= "
\n";
$ret .= "Comming soon";
$ret .= "
\n";
$ret .= "
\n";
$ret .= "
$name
\n";
$ret .= "\n";
}
else {
$ret .= "";
$ret .= "".$hash->{TYPE}." |
";
$ret .= "{TYPE}."\" class=\"block wide\">";
$ret .= "";
$ret .= " | ";
$ret .= "".$hash->{STATE}." | ";
$ret .= " ";
$ret .= " |
";
$ret .= "
";
}
return $ret;
}
#############################################################################################
# Dashboard Tabs erstellen
#############################################################################################
sub Dashboard_BuildDashboardTab ($$) {
my ($t, $name) = @_;
my $hash = $defs{$name};
my $ret;
my $id = $hash->{NR};
my $colcount = AttrVal($name, 'dashboard_tab'.($t+1).'colcount', AttrVal($name, "dashboard_colcount", 1));
my $colwidths = AttrVal($name, 'dashboard_tab'.($t+1).'rowcentercolwidth', AttrVal($name, "dashboard_rowcentercolwidth", 100));
$colwidths =~ tr/,/:/;
my $row = AttrVal($name, "dashboard_row", "center");
my $tabgroups = AttrVal($name, "dashboard_tab".($t+1)."groups", "");
my $tabsortings = AttrVal($name, "dashboard_tab".($t+1)."sorting", "");
my $tabdevicegroups = AttrVal($name, "dashboard_tab".($t+1)."devices", "");
my $tabcount = Dashboard_GetTabCount($hash, 1);
unless ($tabgroups || $tabdevicegroups) {
readingsSingleUpdate($hash, "state", "No Groups or devices set", 0);
return "";
}
# Hintergrundbild bauen
my $ct = "tab".($t+1);
my $bimg = $hash->{HELPER}{BIMG}{$ct}?"url(/fhem/images/$hash->{HELPER}{BIMG}{$ct})":"none";
my @temptabdevicegroup = split(' ', $tabdevicegroups);
my @tabdevicegroups = ();
# make sure device groups without a group name are splitted into
# separate groups for every device they are containing
for my $devicegroup (@temptabdevicegroup) {
my @groupparts = split(':', $devicegroup);
if (@groupparts == 1) {
my @devices = map { $_ . '$$$' . $_ } devspec2array($groupparts[0]);
push(@tabdevicegroups, @devices);
}
else {
push(@tabdevicegroups, $devicegroup);
}
}
my $groups = Dashboard_GetGroupList();
$groups =~ s/#/ /g;
my @groups = split ',', $groups;
my @temptabgroup = split ',', $tabgroups;
# resolve group names from regular expressions
for (my $i=0;$i<@temptabgroup;$i++) {
my @stabgroup = split ":", trim($temptabgroup[$i]);
next if(!$stabgroup[0]);
my @index = grep { $groups[$_] eq $stabgroup[0] } (0 .. @groups-1);
if (@index == 0) {
my $matchGroup = '^'.$stabgroup[0] . '$';
@index = grep { $groups[$_] =~ m/$matchGroup/ } (0 .. @groups-1);
}
if (@index > 0) {
for (my $j=0; $j<@index;$j++) {
my $groupname = @groups[$index[$j]];
$groupname .= '$$$'.'a:group='.$groupname;
if (@stabgroup > 1) {
$groupname .= '$$$'.$stabgroup[1];
}
push(@tabdevicegroups,$groupname);
}
}
}
$tabgroups = join('§§§', @tabdevicegroups);
# add sortings for groups not already having a defined sorting
for (my $i=0;$i<@tabdevicegroups;$i++) {
my @stabgroup = split(/\$\$\$/, trim($tabdevicegroups[$i]));
my $matchGroup = ",".quotemeta(trim($stabgroup[0])).",";
if ($tabsortings !~ m/$matchGroup/) {
$tabsortings = $tabsortings."t".$t."c".Dashboard_GetMaxColumnId($row,$colcount).",".trim($stabgroup[0]).",true,0,0:";
}
}
$ret = "\n";
$ret .= "
\n";
$ret .= "\n";
##################### Top Row (only one Column) #############################################
if ($row eq "top-center-bottom" || $row eq "top-center" || $row eq "top"){
$ret .= Dashboard_BuildDashboardTopRow($name,$t,$id,$tabgroups,$tabsortings);
}
##################### Center Row (max. 5 Column) ############################################
if ($row eq "top-center-bottom" || $row eq "top-center" || $row eq "center-bottom" || $row eq "center") {
$ret .= Dashboard_BuildDashboardCenterRow($name,$t,$id,$tabgroups,$tabsortings,$colcount);
}
############################# Bottom Row (only one Column) ############################################
if ($row eq "top-center-bottom" || $row eq "center-bottom" || $row eq "bottom"){
$ret .= Dashboard_BuildDashboardBottomRow($name,$t,$id,$tabgroups,$tabsortings);
}
$ret .= "
\n";
$ret .= "
\n";
$ret .= "
\n";
$ret .= "\n";
$ret .= " \n";
$ret .= Dashboard_BuildGroupWidgets($name,$t,"100",$id,$devicegroups,$groupsorting);
$ret .= " \n";
$ret .= " |
\n";
return $ret;
}
#############################################################################################
#
#############################################################################################
sub Dashboard_BuildDashboardCenterRow ($$$$$$) {
my ($name,$t,$id, $devicegroups, $groupsorting, $colcount) = @_;
my $ret = "\n";
$ret .= "\n";
my $currentcol = $colcount;
my $maxcolindex = $colcount - 1;
my $replace = "t".$t."c".$maxcolindex.",";
# replace all sortings referencing not existing columns
# this does only work if there is no empty column inbetween
while (index($groupsorting, "t".$t."c".$currentcol.",") >= 0) {
my $search = "t" . $t . "c" . $currentcol . ",";
$groupsorting =~ s/$search/$replace/g;
$currentcol++;
}
for (my $i=0;$i<$colcount;$i++){
$ret .= " \n";
$ret .= Dashboard_BuildGroupWidgets($name,$t,$i,$id,$devicegroups,$groupsorting);
$ret .= " \n";
}
$ret .= " |
\n";
return $ret;
}
#############################################################################################
#
#############################################################################################
sub Dashboard_BuildDashboardBottomRow ($$$$$) {
my ($name,$t,$id, $devicegroups, $groupsorting) = @_;
my $ret;
$ret .= "| \n";
$ret .= " \n";
$ret .= Dashboard_BuildGroupWidgets($name,$t,"200",$id,$devicegroups,$groupsorting);
$ret .= " \n";
$ret .= "\n";
$ret .= " |
\n";
return $ret;
}
#############################################################################################
#
#############################################################################################
sub Dashboard_BuildGroupWidgets ($$$$$$) {
my ($name,$tab,$column,$id,$devicegroups,$groupsorting) = @_;
my $ret = "";
my $counter = 0;
my %sorting = ();
my %groups = ();
my @groupnames = ();
for (split(":", $groupsorting)) {
my @parts = split (',', $_);
$sorting{$parts[1]} = $_;
# add group names to a list to have the correct order afterwards in the foreach loop
# store the group names in the right order to use them in the foreach loop
push(@groupnames, $parts[1]);
}
my @devicegroups = split('§§§', $devicegroups);
# sort the devices into a hash to be able to access them via group name
for my $singlegroup (@devicegroups) {
# make sure that splitting with colon is not destroying the devspec that might
# also contain a colon followed by a filter
my ($groupname, $groupdevices, $groupicon) = split(/\$\$\$/, $singlegroup);
my @values = ($groupdevices, $groupicon);
$groups{$groupname} = \@values;
}
my $groupicon = '';
for my $groupname (@groupnames) {
next if (!defined($groups{$groupname}));
my ($groupdevices, $groupicon) = @{$groups{$groupname}};
# if the device is not stored in the current column, skip it
next if (index($sorting{$groupname}, 't'.$tab.'c'.$column) < 0);
my $groupId = $id."t".$tab."c".$column."w".$counter;
$ret .= Dashboard_BuildGroup($name,$groupname,$groupdevices,$sorting{$groupname},$groupId,$groupicon);
$counter++;
}
return $ret;
}
#############################################################################################
#
#############################################################################################
sub Dashboard_BuildGroupList ($) {
my @dashboardgroups = split(",", $_[0]); #array for all groups to build an widget
my %group = ();
for my $d (sort keys %defs) {
for my $grp (split(",", AttrVal($d, "group", ""))) {
$grp = trim($grp);
for my $g (@dashboardgroups){
my ($gtitle, $iconName) = split(":", trim($g));
my $titleMatch = "^" . quotemeta($gtitle) . "\$";
$group{$grp}{$d} = 1 if($grp =~ $titleMatch);
}
}
}
return %group;
}
#############################################################################################
#
#############################################################################################
sub Dashboard_GetGroupList() {
my %allGroups = ();
for my $d (keys %defs ) {
next if(IsIgnored($d));
for my $g (split(",", AttrVal($d, "group", ""))) { $allGroups{$g}{$d} = 1; }
}
my $ret = join(",", sort map { $_ =~ s/ /#/g ;$_} keys %allGroups);
return $ret;
}
#############################################################################################
#
#############################################################################################
sub Dashboard_BuildGroup ($$$$$$) {
my ($name,$groupname,$devices,$sorting,$groupId,$icon) = @_;
my $row = 1;
my %extPage = ();
my $foundDevices = 0;
my $replaceGroup = "";
my $ret = "";
my $rf = ($FW_room ? "&room=$FW_room" : ""); # stay in the room
$ret .= "\n";
$ret .= "
\n";
$ret .= "
";
$ret .= "| Devices for group not found: $groupname |
";
$ret .= "| Check if the device/group attribute is really set |
";
$ret .= "| Check if the device spec is correctly written |
";
$ret .= "
";
}
return $ret;
}
#############################################################################################
#
#############################################################################################
sub Dashboard_GetMaxColumnId ($$) {
my ($row, $colcount) = @_;
my $maxcolid = "0";
if (index($row,"bottom") > 0) { $maxcolid = "200"; }
elsif (index($row,"center") > 0) { $maxcolid = $colcount-1; }
elsif (index($row,"top") > 0) { $maxcolid = "100"; }
return $maxcolid;
}
#############################################################################################
#
#############################################################################################
sub Dashboard_CheckDashboardEntry ($) {
my $hash = shift;
my $now = time();
my $timeToExec = $now + 5;
RemoveInternalTimer($hash);
InternalTimer ($timeToExec, 'Dashboard_CheckDashboardAttributUssage', $hash, 0);
return;
}
#############################################################################################
# replaces old disused attributes and their values | set minimal attributes
#############################################################################################
sub Dashboard_CheckDashboardAttributUssage($) {
my $hash = shift;
my $d = $hash->{NAME};
my $dashboardversion = $hash->{HELPER}{VERSION};
my $detailnote = "";
# --------- Set minimal Attributes in the hope to make it easier for beginners --------------------
my $tab1groups = AttrVal($d, "dashboard_tab1groups", "");
if ($tab1groups eq "") {
FW_fC("attr ".$d." dashboard_tab1groups Set your FHEM groups here and arrange them on tab 1");
}
# ---------------- Delete empty Groups entries ----------------------------------------------------------
my $tabgroups = AttrVal($d, "dashboard_tab1groups", "999");
if ($tabgroups eq "1" ) { FW_fC("deleteattr ".$d." dashboard_tab1groups"); }
$tabgroups = AttrVal($d, "dashboard_tab2groups", "999");
if ($tabgroups eq "1" ) { FW_fC("deleteattr ".$d." dashboard_tab2groups"); }
$tabgroups = AttrVal($d, "dashboard_tab3groups", "999");
if ($tabgroups eq "1" ) { FW_fC("deleteattr ".$d." dashboard_tab3groups"); }
$tabgroups = AttrVal($d, "dashboard_tab4groups", "999");
if ($tabgroups eq "1" ) { FW_fC("deleteattr ".$d." dashboard_tab4groups"); }
$tabgroups = AttrVal($d, "dashboard_tab5groups", "999");
if ($tabgroups eq "1" ) { FW_fC("deleteattr ".$d." dashboard_tab5groups"); }
my $lockstate = AttrVal($d, "dashboard_lockstate", ""); # outdates 04.2014
if ($lockstate ne "") {
{ FW_fC("deleteattr ".$d." dashboard_lockstate"); }
Log3 ($d, 3, "Dashboard $d - Using an outdated no longer used Attribute or Value. This has been corrected. Don't forget to save config. [dashboard_lockstate]");
}
my $showhelper = AttrVal($d, "dashboard_showhelper", ""); # outdates 04.2014
if ($showhelper ne "") {
{ FW_fC("deleteattr ".$d." dashboard_showhelper"); }
Log3 $hash, 3, "[".$d. " V".$dashboardversion."]"." Using an outdated no longer used Attribute or Value. This has been corrected. Don't forget to save config. [dashboard_showhelper]";
}
my $showtabs = AttrVal($d, "dashboard_showtabs", ""); # delete values 04.2014
if ($showtabs eq "tabs-at-the-top-buttonbar-hidden") {
{ FW_fC("set ".$d." dashboard_showtabs tabs-and-buttonbar-at-the-top"); }
Log3 $hash, 3, "[".$d. " V".$dashboardversion."]"." Using an outdated no longer used Attribute or Value. This has been corrected. Don't forget to save config. [tabs-at-the-top-buttonbar-hidden]";
}
if ($showtabs eq "tabs-on-the-bottom-buttonbar-hidden") {
{ FW_fC("set ".$d." dashboard_showtabs tabs-and-buttonbar-on-the-bottom"); }
Log3 $hash, 3, "[".$d. " V".$dashboardversion."]"." Using an outdated no longer used Attribute or Value. This has been corrected. Don't forget to save config. [tabs-on-the-bottom-buttonbar-hidden]";
}
return;
}
#############################################################################################
# Anzahl der vorhandenen Tabs ermitteln und zurück geben
#############################################################################################
sub Dashboard_GetTabCount ($$) {
my ($hash, $defaultTabCount) = @_;
my $tabCount = 0;
while (AttrVal($hash->{NAME}, 'dashboard_tab' . ($tabCount + 1) . 'groups', '') ne ""
|| AttrVal($hash->{NAME}, 'dashboard_tab' . ($tabCount + 1) . 'devices', '') ne "") {
$tabCount++;
}
return $tabCount ? $tabCount : $defaultTabCount;
}
#############################################################################################
# Aktives Tab selektieren
# $gtn setzen um Tabnamen mit abzurufen
#############################################################################################
sub Dashboard_GetActiveTab ($;$) {
my ($name,$gtn) = @_;
my $maxTab = Dashboard_GetTabCount($defs{$name}, 1);
my $activeTab = 1;
for my $key (%FW_httpheader) {
Log3 ($name, 5, "Dashboard $name - FW_httpheader $key: ".$FW_httpheader{$key}) if(defined $FW_httpheader{$key});
}
if (defined($FW_httpheader{Cookie})) {
Log3 ($name, 4, "Dashboard $name - Cookie delivered: ".$FW_httpheader{Cookie});
# my %cookie = map({ split('=', $_) } split(/; */, $FW_httpheader{Cookie}));
my %cookie; # 10.02.2020, Forum: https://forum.fhem.de/index.php/topic,16503.msg1023004.html#msg1023004
for (split(/; */, $FW_httpheader{Cookie})) {
my ($k,$v) = split('=', $_);
next if(!defined $v);
$cookie{$k} = $v;
}
Log3($name, 5, "Dashboard $name - Cookie Hash: ". Dumper %cookie);
if (defined($cookie{dashboard_activetab})) {
$activeTab = $cookie{dashboard_activetab};
$activeTab = ($activeTab <= $maxTab)?$activeTab:$maxTab;
}
}
my $tabno = AttrVal($name, 'dashboard_homeTab', $activeTab);
$tabno = ($tabno <= $maxTab)?$tabno:$maxTab;
my $tabname = AttrVal($name, "dashboard_tab".($tabno)."name", "");
Log3 ($name, 4, "Dashboard $name - Dashboard active tab: $tabno/$tabname");
if($gtn) {
return ($tabno,$tabname);
}
else {
return $tabno;
}
}
#############################################################################################
# Wertevorrat der möglichen Tabs ermitteln
#############################################################################################
sub Dashboard_possibleTabs ($) {
my ($name) = @_;
my $f;
my $maxTab = Dashboard_GetTabCount($defs{$name}, 1);
for my $i (1..$maxTab) {
$f .= "," if($f);
$f .= $i;
}
return $f;
}
################################################################
# Versionierungen des Moduls setzen
# Die Verwendung von Meta.pm und Packages wird berücksichtigt
################################################################
sub Dashboard_setVersionInfo($) {
my ($hash) = @_;
my $name = $hash->{NAME};
my $v = (sortTopicNum("desc",keys %Dashboard_vNotesIntern))[0];
my $type = $hash->{TYPE};
$hash->{HELPER}{PACKAGE} = __PACKAGE__;
$hash->{HELPER}{VERSION} = $v;
if($modules{$type}{META}{x_prereqs_src} && !$hash->{HELPER}{MODMETAABSENT}) { # META-Daten sind vorhanden
$modules{$type}{META}{version} = "v".$v; # Version aus META.json überschreiben, Anzeige mit {Dumper $modules{SMAPortal}{META}}
if($modules{$type}{META}{x_version}) { # {x_version} ( nur gesetzt wenn $Id: 95_Dashboard.pm 21180 2020-02-11 21:04:55Z DS_Starter $ im Kopf komplett! vorhanden )
$modules{$type}{META}{x_version} =~ s/1.1.1/$v/g;
}
else {
$modules{$type}{META}{x_version} = $v;
}
return $@ unless (FHEM::Meta::SetInternals($hash)); # FVERSION wird gesetzt ( nur gesetzt wenn $Id: 95_Dashboard.pm 21180 2020-02-11 21:04:55Z DS_Starter $ im Kopf komplett! vorhanden )
if(__PACKAGE__ eq "FHEM::$type" || __PACKAGE__ eq $type) { # es wird mit Packages gearbeitet -> Perl übliche Modulversion setzen
use version 0.77; our $VERSION = FHEM::Meta::Get( $hash, 'version' ); # mit {->VERSION()} im FHEMWEB kann Modulversion abgefragt werden
}
}
else {
$hash->{VERSION} = $v; # herkömmliche Modulstruktur
}
return;
}
#############################################################################################
# Tabumschaltung bei setzen Attribut dashboard_homeTab bzw. "set ... activeTab"
#############################################################################################
sub Dashboard_activateTab ($$) {
my ($name,$tab) = @_;
my $hash = $defs{$name};
my $url = '/dashboard/'.$name;
return if(!$data{FWEXT}{$url});
$tab--;
my $web = AttrVal($name, "dashboard_webRefresh", $hash->{HELPER}{FW});
return if(!$web);
my @wa = split ',', $web;
{ map { FW_directNotify("#FHEMWEB:$_", 'dashboard_load_tab('."$tab".');$("#dashboardtabs").tabs("option", "active", '."$tab".')', "") } @wa }
# Andere Triggermöglichkeiten:
#{ map { FW_directNotify("#FHEMWEB:$_", 'dashboard_load_tab('."$tab".')', "") } @wa }
#{ map { FW_directNotify("#FHEMWEB:$_", '$("#dashboardtabs").tabs("option", "active", '."$tab".')', "") } @wa }
# CommandTrigger(undef,'WEB JS:dashboard_load_tab('."$tab".');JS:$("#dashboardtabs").tabs("option", "active", '."$tab".')' );
return;
}
######################################################################################
# initiale Routinen für Dashboard
######################################################################################
sub Dashboard_init ($) {
my $hash = shift;
my $name = $hash->{NAME};
RemoveInternalTimer($hash, "Dashboard_init");
if ($init_done) { # die Argumente für das Attribut dashboard_webRefresh dynamisch ermitteln und setzen
my $fwd = join ",", devspec2array("TYPE=FHEMWEB:FILTER=STATE=Initialized");
$hash->{HELPER}{FW} = $fwd;
my $atr = AttrVal($name, "dashboard_webRefresh", "");
delFromDevAttrList($name, "dashboard_webRefresh");
addToDevAttrList ($name, "dashboard_webRefresh:multiple-strict,$fwd");
$attr{$name}{dashboard_webRefresh} = $atr if($atr);
my $f = Dashboard_possibleTabs ($name); # die Argumente für das Attribut dashboard_homeTab dynamisch ermitteln und setzen
my $at = AttrVal($name, "dashboard_homeTab", "");
delFromDevAttrList($name, "dashboard_homeTab");
addToDevAttrList ($name, "dashboard_homeTab:$f");
$attr{$name}{dashboard_homeTab} = $at if($at);
}
else {
InternalTimer(time()+3, "Dashboard_init", $hash, 0);
}
return;
}
######################################################################################
# Zeichen escapen
######################################################################################
sub Dashboard_Escape($) {
my $a = shift;
return "null" if(!defined($a));
my %esc = ("\n" => '\n', "\r" => '\r', "\t" => '\t', "\f" => '\f', "\b" => '\b', "\"" => '\"', "\\" => '\\\\', "\'" => '\\\'', );
$a =~ s/([\x22\x5c\n\r\t\f\b])/$esc{$1}/eg;
return $a;
}
######################################################################################
# angegebenes $file im $dir und Unterverzeichnissen suchen
# und mit Pfad ab ".../images/" in $ct speichern wenn gefunden
######################################################################################
sub Dashboard_searchImage($$$$) {
my ($name,$dir,$file,$ct) = @_;
my $hash = $defs{$name};
my ($t,$im);
opendir(DIR, $dir);
my(@files) = grep {!/^\.\.?$/ } readdir(DIR);
closedir(DIR);
for (@files) {
if (-d ($t = "$dir/$_")) { # -d returns true if the following string is a directory.
Dashboard_searchImage($name,$t,$file,$ct);
}
else {
next if ($_ ne $file);
$im = (split("images\/", $dir."/".$_))[1];
$hash->{HELPER}{BIMG}{$ct} = $im; # Ergebnisfile in Container speichern wenn gefunden
Log3 ($name, 5, "Dashboard $name - Background image file found in: $dir/$_");
}
}
}
1;
=pod
=encoding utf8
=item summary Dashboard for showing multiple devices sorted in tabs
=item summary_DE Dashboard zur Anzeige mehrerer Geräte in verschiedenen Tabs
=begin html
Dashboard
Creates a Dashboard in any group and/or devices can be arranged. The positioning may depend the objects and column width are made
arbitrarily by drag'n drop. Also, the width and height of an object can be increased beyond the minimum size.
Note:
A group name in the dashboard respectively the attribute "dashboard_tabXgroups" equates the group name in FHEM and depict the
devices which are contained in that group.
Define
- define <name> Dashboard
Example:
define anyViews Dashboard
Bestpractice beginner configuration:
define anyViews Dashboard
attr anyViews dashboard_colcount 2
attr anyviews dashboard_rowcentercolwidth 30,70
attr anyViews dashboard_tab1groups <Group1>,<Group2>,<Group3>
Set
- set <name> activateTab <TabNo>
The Tab with the defined number will be activated.
If the attribute "dashboard_homeTab" is set, this defined tab will be reactivated at next
browser refresh.
- set <name> lock
Locks the Dashboard so that no position changes can be made.
- set <name> unlock
Unlock the Dashboard,
Get
- get <name> config
Delivers the configuration of the dashboard back.
- get <name> icon <icon name>
Delivers the path and full name of the denoted icon back.
Example:
get <name> icon measure_power_meter
Attributes
- dashboard_backgroundimage
Displays a background image for the complete dashboard. The image is not stretched in any way. So the size should
match/extend the dashboard height/width. The relative path to "./www/images" has to be used.
Example
attr dashboard_backgroundimage dashboard/cam_video.PNG
# File ./www/images/dashboard/cam_video.PNG is shown
attr dashboard_backgroundimage cam_video.PNG
# File ./www/images/cam_video.PNG is shown
- dashboard_backgroundimage
Displays a background image for the complete dashboard. The image is not stretched in any way. So the size should
match/extend the dashboard height/width. Only the filename has to be set.
The file must be at any location below the directory "./www/images/".
Suggestion: Create the directory "./www/images/dashboard" and put the image file into.
Example
attr dashboard_backgroundimage cam_video.PNG
- dashboard_colcount
Number of columns in which the groups can be displayed. Nevertheless, it is possible to have multiple groups
to be positioned in a column next to each other. This is depend on the width of columns and groups.
Default: 1
- dashboard_debug
Show Hiddenfields. Only for Maintainer's use.
Default: 0
- dashboard_flexible
If set to a value > 0, the widgets are not positioned in columns any more but can be moved freely to any position in
the tab.
The value for this parameter also defines the grid, in which the position "snaps in".
Default: 0
- dashboard_hideGroupHeader
If set, the header containing the group name and group icon above the pictured FHEM-group (see also dashboard_tab1groups) is hidden.
Default: 0
- dashboard_homeTab
Specifies which tab is activated. If it isn't set, the last selected tab will also be the active tab.
Default: 1
- dashboard_row
To select which rows are displayed. top only; center only; bottom only; top and center; center and bottom; top,center and bottom.
Default: center
- dashboard_rowbottomheight
Height of the bottom row in which the groups may be positioned.
Default: 250
- dashboard_rowcenterheight
Height of the center row in which the groups may be positioned.
Default: 400
- dashboard_rowcentercolwidth
About this attribute, the width of each column of the middle Dashboardrow can be set. It can be stored for each column
a separate value.
The values must be separated by a comma (no spaces). Each value determines the column width in%! The first value
specifies the width of the first column, the second value of the width of the second column, etc. Is the sum of the
width greater than 100 it is reduced.
If more columns defined as widths the missing widths are determined by the difference to 100. However, are less
columns are defined as the values of ignores the excess values.
Default: 100
- dashboard_rowtopheight
Height of the top row in which the groups may be positioned.
Default: 250
- dashboard_showfullsize
Hide FHEMWEB Roomliste (complete left side) and Page Header if Value is 1.
Default: 0
- dashboard_showtabs
Displays the Tabs/Buttonbar on top or bottom, or hides them. If the Buttonbar is hidden lockstate is "lock" is used.
Default: tabs-and-buttonbar-at-the-top
- dashboard_showtogglebuttons
Displays a Toogle Button on each Group do collapse.
Default: 0
- dashboard_tab1backgroundimage
Shows a background image for the tab. (also valid for further dashboard_tabXbackgroundimage)
The image is not stretched in any way, it should therefore match the tab size or extend it.
Only the filename has to be set.
The file must be at any location below the directory "./www/images/".
Suggestion: Create the directory "./www/images/dashboard" and put the image file into.
Example
attr dashboard_tab1backgroundimage cam_video.PNG
- dashboard_tab1colcount
Number of columns for a specific tab in which the groups can be displayed. (also valid for further dashboard_tabXcolcount)
Nevertheless, it is possible to have multiple groups to be positioned in a column next to each other.
This depends on the width of columns and groups.
Default: <dashboard_colcount>
- dashboard_tab1devices
DevSpec list of devices that should appear in the tab. (also valid for further dashboard_tabXdevices)
The format is:
GROUPNAME:devspec1,devspec2,...,devspecX:ICONNAME
ICONNAME is optional. Also GROUPNAME is optional. In case of missing GROUPNAME, the matching devices are
not grouped, but shown as separate widgets without titles.
For further details on the DevSpec format see DevSpec.
- dashboard_tab1groups
Comma separated list of FHEM groups (see attribute "group" in a device) to be displayed in Tab.
(also valid for further dashboard_tabXgroups)
Each group can be given an icon for this purpose the group name, the following must be
completed ":<icon>@<color>"
Example:
Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow
Additionally a group can contain a regular expression to show all groups matching a criteria.
Example:
.*Light.* to show all groups that contain the string "Light"
- dashboard_tab1icon
Set the icon for a Tab. (also valid for further dashboard_tabXicon)
There must exist an icon with the name ico.(png|svg) in the modpath directory. If the image is
referencing an SVG icon, then you can use the @colorname suffix to color the image.
- dashboard_tab1name
Title of Tab. (also valid for further dashboard_tabXname)
- dashboard_tab1sorting
Contains the position of each group in Tab. (also valid for further dashboard_tabXsorting)
Value is written by the "Set" button. It is not recommended to take manual changes.
- dashboard_noLinks
No link generation to the detail view of the devices takes place.
Note:
Some device types deliver the links to their detail view integrated in the device.
In such cases you have to deactivate the link generation inside of the device (for example in SMAPortalSPG).
- dashboard_webRefresh
With this attribute the FHEMWEB-Devices are determined, which:
- are activating the tab of a dashboard when the attribute "dashboard_homeTab" will be set
- are positioning to the tab specified by command "set <name> activateTab"
Default: all
- dashboard_width
To determine the Dashboardwidth. The value can be specified, or an absolute width value (eg 1200) in pixels in% (eg 80%).
Default: 100%
=end html
=begin html_DE
Dashboard
Erstellt eine Übersicht in der Gruppen und/oder Geräte angeordnet werden können. Dabei können die Objekte mit Drag'n Drop
frei positioniert und in mehreren Spalten angeordnet werden. Auch kann die Breite und Höhe eines Objektes über die
Mindestgröße hinaus gezogen werden.
Hinweis:
Ein Gruppenname im Dashboard bzw. dem Attribut "dashboard_tabXgroups" entspricht der Gruppe in FHEM und stellt die darin enthaltenen
Geräte im Dashboard dar.
Define
- define <name> Dashboard
Beispiel:
define anyViews Dashboard
Bestpractice Anfängerkonfiguration:
define anyViews Dashboard
attr anyViews dashboard_colcount 2
attr anyViews dashboard_rowcentercolwidth 30,70
attr anyViews dashboard_tab1groups <Group1>,<Group2>,<Group3>
Set
- set <name> activateTab <TabNo>
Das Tab mit der angegebenen Nummer wird im Dashboard aktiviert.
Ist das Attribut "dashboard_homeTab" gesetzt, wird das in diesem Attribut
definierte Tab beim nächsten Browser-Refresh reaktiviert.
- set <name> lock
Sperrt das Dashboard. Es können keine Positionsänderungen vorgenommen werden.
- set <name> unlock
Entsperrt das Dashboard.
Get
- get <name> config
Liefert die Konfiguration des Dashboards zurück.
- get <name> icon <icon name>
Liefert den Pfad und vollen Namen des angegebenen Icons zurück.
Beispiel:
get <name> icon measure_power_meter
Attributes
- dashboard_backgroundimage
Zeigt ein Hintergrundbild im Dashboard an. Das Bild wird nicht gestreckt, es sollte daher auf die Größe des Dashboards
passen oder diese überschreiten. Es ist nur der Filename anzugeben.
Das File muss sich an beliebiger Stelle unterhalb des Verzeichnisses "./www/images/" befinden.
Empfehlung: Das Verzeichnis "./www/images/dashboard" anlegen und das Bildfile in diesem Verzeichnis ablegen.
Beispiel
attr dashboard_backgroundimage cam_video.PNG
- dashboard_colcount
Die Anzahl der Spalten in der Gruppen dargestellt werden können. Dennoch ist es möglich, mehrere Gruppen
in einer Spalte nebeneinander zu positionieren. Dies ist abhängig von der Breite der Spalten und Gruppen.
Gilt nur für die mittlere Spalte!
Default: 1
- dashboard_debug
Zeigt Debug-Felder an. Sollte nicht gesetzt werden!
Default: 0
- dashboard_flexible
Hat dieser Parameter einen Wert > 0, dann können die Widgets in den Tabs frei positioniert werden und hängen nicht
mehr an den Spalten fest. Der Wert gibt ebenfalls das Raster an, in dem die Positionierung "zuschnappt".
Default: 0
- dashboard_hideGroupHeader
Wenn gesetzt, wird der Kopf mit Gruppenname und -icon der dargestellten FHEM-Gruppe (siehe dashboard_tab1groups) verborgen.
Default: 0
- dashboard_homeTab
Legt das aktuell aktivierte Tab fest. Wenn nicht gesetzt, wird das zuletzt gewählte Tab das aktive Tab.
Default: 1
- dashboard_row
Auswahl welche Zeilen angezeigt werden sollen. top (nur Oben), center (nur Mitte), bottom (nur Unten) und den
Kombinationen daraus.
Default: center
- dashboard_rowcenterheight
Höhe der mittleren Zeile, in der die Gruppen angeordnet werden.
Default: 400
- dashboard_rowcentercolwidth
Über dieses Attribut wird die Breite der einzelnen Spalten der mittleren Dashboardreihe festgelegt. Dabei kann je Spalte ein separater Wert hinterlegt werden.
Die Werte sind durch ein Komma (ohne Leerzeichen) zu trennen. Jeder Wert bestimmt die Spaltenbreite in %! Der erste Wert gibt die Breite der ersten Spalte an,
der zweite Wert die Breite der zweiten Spalte usw. Ist die Summe der Breite größer als 100 werden die Spaltenbreiten reduziert.
Sind mehr Spalten als Breiten definiert werden die fehlenden Breiten um die Differenz zu 100 festgelegt. Sind hingegen weniger Spalten als Werte definiert werden
die überschüssigen Werte ignoriert.
Default: 100
- dashboard_rowtopheight
Höhe der oberen Zeile, in der die Gruppen angeordnet werden.
Default: 250
- dashboard_rowbottomheight
Höhe der unteren Zeile, in der die Gruppen angeordnet werden.
Default: 250
- dashboard_showfullsize
Blendet die FHEMWEB Raumliste (kompleter linker Bereich der Seite) und den oberen Bereich von FHEMWEB aus wenn der
Wert auf 1 gesetzt ist.
Default: 0
- dashboard_showtabs
Zeigt die Tabs/Schalterleiste des Dashboards oben oder unten an, oder blendet diese aus. Wenn die Schalterleiste
ausgeblendet wird ist das Dashboard gespert.
Default: tabs-and-buttonbar-at-the-top
- dashboard_showtogglebuttons
Zeigt eine Schaltfläche in jeder Gruppe mit der man diese auf- und zuklappen kann.
Default: 0
- dashboard_tab1backgroundimage
Zeigt ein Hintergrundbild für den Tab an. (gilt ebenfalls für weitere dashboard_tabXbackgroundimage)
Das Bild wird nicht gestreckt, es sollte also auf die Größe des Tabs passen oder diese überschreiten. Es ist nur der
Filename anzugeben.
Das File muss sich an beliebiger Stelle unterhalb des Verzeichnisses "./www/images/" befinden.
Empfehlung: Das Verzeichnis "./www/images/dashboard" anlegen und das Bildfile in diesem Verzeichnis ablegen.
Beispiel
attr dashboard_tab1backgroundimage cam_video.PNG
- dashboard_tab1colcount
Die Anzahl der Spalten im Tab in der Gruppen dargestellt werden können. (gilt ebenfalls für weitere dashboard_tabXcolcount)
Dennoch ist es möglich, mehrere Gruppen in einer Spalte nebeneinander zu positionieren. Dies ist abhängig von der Breite
der Spalten und Gruppen.
Gilt nur für die mittlere Spalte!
Default: <dashboard_colcount>
- dashboard_tab1devices
DevSpec Liste von Geräten, die im Tab angezeigt werden sollen. (gilt ebenfalls für weitere dashboard_tabXdevices)
Das Format ist:
GROUPNAME:devspec1,devspec2,...,devspecX:ICONNAME
ICONNAME ist optional. Auch GROUPNAME muss nicht vorhanden sein. Fehlt GROUPNAME, werden die angegebenen
Geräte nicht gruppiert, sondern als einzelne Widgets im Tab angezeigt. Für weitere Details bezüglich DevSpec:
DevSpec
- dashboard_tab1groups
Durch Komma getrennte Liste der FHEM-Gruppen (siehe Attribut "group" eines Devices), die im Tab angezeigt werden.
(gilt ebenfalls für weitere dashboard_tabXgroups)
Falsche Gruppennamen werden hervorgehoben.
Jede Gruppe kann zusätzlich ein Icon anzeigen, dazu muss der Gruppen name um ":<icon>@<farbe>"ergänzt
werden.
Beispiel:
Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow
Der Gruppenname kann ebenfalls einen regulären Ausdruck beinhalten, um alle Gruppen anzuzeigen, die darauf passen.
Beispiel:
.*Licht.* zeigt alle Gruppen an, die das Wort "Licht" im Namen haben.
- dashboard_tab1icon
Zeigt am Tab ein Icon an (gilt ebenfalls für weitere dashboard_tabXicon).
Es muss sich dabei um ein exisitereindes Icon mit modpath Verzeichnis handeln. Handelt es
sich um ein SVG Icon kann der Suffix @colorname für die Farbe des Icons angegeben werden.
- dashboard_tab1name
Titel des Tab. (gilt ebenfalls für weitere dashboard_tabXname)
- dashboard_tab1sorting
Enthält die Positionierung jeder Gruppe im Tab (gilt ebenfalls für weitere dashboard_tabXsorting).
Der Wert wird mit der Schaltfläche "Set" geschrieben. Es wird nicht
empfohlen dieses Attribut manuell zu ändern.
- dashboard_noLinks
Es erfolgt keine Linkerstellung zur Detailansicht von Devices.
Hinweis:
Bei manchen Devicetypen wird der Link zur Detailansicht integriert im Device mitgeliefert.
In diesen Fällen muß die Linkgenerierung direkt im Device abgestellt werden (z.B. bei SMAPortalSPG).
- dashboard_webRefresh
Mit diesem Attribut werden FHEMWEB-Devices bestimmt, die:
- beim Setzen des Attributes "dashboard_homeTab" diesen Tab im Dashboard sofort aktivieren
- beim Ausführen von "set <name> activateTab" auf diesen Tab im Dashboard positionieren
Default: alle
- dashboard_width
Zum bestimmen der Dashboardbreite. Der Wert kann in % (z.B. 80%) angegeben werden oder als absolute Breite (z.B. 1200)
in Pixel.
Default: 100%
=end html_DE
=for :application/json;q=META.json 95_Dashboard.pm
{
"abstract": "Dashboard for showing multiple devices sorted in tabs",
"x_lang": {
"de": {
"abstract": "Dashboard zur Anzeige mehrerer Geräte in verschiedenen Tabs"
}
},
"keywords": [
"Dashboard",
"Tablet",
"UI",
"Browser"
],
"version": "v1.1.1",
"release_status": "stable",
"author": [
"Heiko Maaz "
],
"x_fhem_maintainer": [
"DS_Starter"
],
"x_fhem_maintainer_github": [
"nasseeder1"
],
"prereqs": {
"runtime": {
"requires": {
"FHEM": 5.00918799,
"perl": 5.014
},
"recommends": {
"FHEM::Meta": 0
},
"suggests": {
}
}
},
"resources": {
"x_wiki": {
"web": "https://wiki.fhem.de/wiki/Dashboard",
"title": "Dashboard"
},
"repository": {
"x_dev": {
"type": "svn",
"url": "https://svn.fhem.de/trac/browser/trunk/fhem/contrib/DS_Starter",
"web": "https://svn.fhem.de/trac/browser/trunk/fhem/contrib/DS_Starter/95_Dashboard.pm",
"x_branch": "dev",
"x_filepath": "fhem/contrib/",
"x_raw": "https://svn.fhem.de/fhem/trunk/fhem/contrib/DS_Starter/95_Dashboard.pm"
}
}
}
}
=end :application/json;q=META.json
=cut