2019-06-03 23:00:53 +00:00
########################################################################################################################
2020-04-20 14:55:36 +00:00
# $Id: 76_SMAPortalSPG.pm 19799 2019-07-08 16:33:29Z DS_Starter $
2019-06-03 23:00:53 +00:00
#########################################################################################################################
# 76_SMAPortalSPG.pm
#
2020-04-20 14:55:36 +00:00
# (c) 2019-2020 by Heiko Maaz e-mail: Heiko dot Maaz at t-online dot de
2019-06-03 23:00:53 +00:00
#
# This Module is used by module 76_SMAPortal to create graphic devices.
# It can't be used standalone without any SMAPortal-Device.
#
# This script 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/>.
#
#########################################################################################################################
2020-04-20 14:55:36 +00:00
package FHEM::SMAPortalSPG ; ## no critic 'package'
2019-06-03 23:00:53 +00:00
use strict ;
use warnings ;
2020-04-20 14:55:36 +00:00
use GPUtils qw( GP_Import GP_Export ) ; # wird für den Import der FHEM Funktionen aus der fhem.pl benötigt
2019-06-03 23:00:53 +00:00
use Time::HiRes qw( gettimeofday ) ;
2020-04-20 14:55:36 +00:00
eval "use FHEM::Meta;1" or my $ modMetaAbsent = 1 ; ## no critic 'eval'
# Run before module compilation
BEGIN {
# Import from main::
GP_Import (
qw(
AnalyzePerlCommand
AttrVal
AttrNum
defs
delFromDevAttrList
delFromAttrList
devspec2array
deviceEvents
Debug
FmtDateTime
FmtTime
FW_makeImage
fhemTimeGm
getKeyValue
gettimeofday
genUUID
init_done
InternalTimer
IsDisabled
Log
Log3
makeReadingName
modules
readingsSingleUpdate
readingsBulkUpdate
readingsBulkUpdateIfChanged
readingsBeginUpdate
readingsDelete
readingsEndUpdate
ReadingsNum
ReadingsTimestamp
ReadingsVal
RemoveInternalTimer
readingFnAttributes
setKeyValue
sortTopicNum
TimeNow
Value
json2nameValue
FW_directNotify
)
) ;
# Export to main context with different name
# my $pkg = caller(0);
# my $main = $pkg;
# $main =~ s/^(?:.+::)?([^:]+)$/main::$1\_/g;
# foreach (@_) {
# *{ $main . $_ } = *{ $pkg . '::' . $_ };
# }
GP_Export (
qw(
Initialize
pageAsHtml
)
) ;
}
2019-06-03 23:00:53 +00:00
# Versions History intern
2020-04-20 14:55:36 +00:00
my % vNotesIntern = (
"1.6.0" = > "19.04.2020 switch to pachages, some improvements according to PBP " ,
2019-07-07 18:54:56 +00:00
"1.5.0" = > "07.07.2019 new attributes headerAlignment, headerDetail " ,
2019-06-26 21:43:03 +00:00
"1.4.0" = > "26.06.2019 support for FTUI-Widget " ,
2019-06-24 09:28:41 +00:00
"1.3.0" = > "24.06.2019 replace suggestIcon by consumerAdviceIcon " ,
2019-06-21 12:32:46 +00:00
"1.2.0" = > "21.06.2019 GetFn -> get <name> html " ,
2019-06-13 19:20:53 +00:00
"1.1.0" = > "13.06.2019 commandRef revised, changed attribute W/kW to Wh/kWh " ,
2019-06-03 23:00:53 +00:00
"1.0.0" = > "03.06.2019 initial Version "
) ;
################################################################
2020-04-20 14:55:36 +00:00
sub Initialize {
2019-06-03 23:00:53 +00:00
my ( $ hash ) = @ _ ;
my $ fwd = join ( "," , devspec2array ( "TYPE=FHEMWEB:FILTER=STATE=Initialized" ) ) ;
2020-04-20 14:55:36 +00:00
$ hash - > { DefFn } = \ & Define ;
$ hash - > { GetFn } = \ & Get ;
$ hash - > { RenameFn } = \ & Rename ;
$ hash - > { CopyFn } = \ & Copy ;
$ hash - > { FW_summaryFn } = \ & FwFn ;
$ hash - > { FW_detailFn } = \ & FwFn ;
$ hash - > { AttrFn } = \ & Attr ;
2019-06-03 23:00:53 +00:00
$ hash - > { AttrList } = "autoRefresh:selectnumbers,120,0.2,1800,0,log10 " .
"autoRefreshFW:$fwd " .
"beamColor:colorpicker,RGB " .
"beamColor2:colorpicker,RGB " .
"beamHeight " .
"beamWidth " .
"consumerList " .
"consumerLegend:none,icon_top,icon_bottom,text_top,text_bottom " .
"disable:1,0 " .
"forcePageRefresh:1,0 " .
2019-07-07 18:54:56 +00:00
"headerAlignment:center,left,right " .
"headerDetail:all,co,pv,pvco,statusLink " .
2019-06-03 23:00:53 +00:00
"hourCount:slider,4,1,24 " .
"hourStyle " .
"maxPV " .
"htmlStart " .
"htmlEnd " .
"showDiff:no,top,bottom " .
"showHeader:1,0 " .
"showLink:1,0 " .
"showNight:1,0 " .
"showWeather:1,0 " .
"spaceSize " .
2019-06-24 09:28:41 +00:00
"consumerAdviceIcon " .
2019-06-03 23:00:53 +00:00
"layoutType:pv,co,pvco,diff " .
2019-06-13 19:20:53 +00:00
"Wh/kWh:Wh,kWh " .
2019-06-03 23:00:53 +00:00
"weatherColor:colorpicker,RGB " .
$ readingFnAttributes ;
2020-04-20 14:55:36 +00:00
2019-06-03 23:00:53 +00:00
$ hash - > { FW_hideDisplayName } = 1 ; # Forum 88667
# $hash->{FW_addDetailToSummary} = 1;
# $hash->{FW_atPageEnd} = 1; # wenn 1 -> kein Longpoll ohne informid in HTML-Tag
eval { FHEM::Meta:: InitMod ( __FILE__ , $ hash ) } ; # für Meta.pm (https://forum.fhem.de/index.php/topic,97589.0.html)
return ;
}
2019-06-21 12:32:46 +00:00
###############################################################
# SMAPortalSPG Define
###############################################################
2020-04-20 14:55:36 +00:00
sub Define {
2019-06-03 23:00:53 +00:00
my ( $ hash , $ def ) = @ _ ;
my ( $ name , $ type , $ link ) = split ( "[ \t]+" , $ def , 3 ) ;
if ( ! $ link ) {
return "Usage: define <name> SMAPortalSPG <arg>" ;
}
my $ arg = ( split ( "[()]" , $ link ) ) [ 1 ] ;
$ arg =~ s/'//g ;
$ hash - > { PARENT } = ( split ( "," , $ arg ) ) [ 0 ] ;
$ hash - > { HELPER } { MODMETAABSENT } = 1 if ( $ modMetaAbsent ) ; # Modul Meta.pm nicht vorhanden
$ hash - > { LINK } = $ link ;
# Versionsinformationen setzen
2020-04-20 14:55:36 +00:00
setVersionInfo ( $ hash ) ;
2019-06-03 23:00:53 +00:00
readingsSingleUpdate ( $ hash , "state" , "initialized" , 1 ) ; # Init für "state"
2020-04-20 14:55:36 +00:00
return ;
2019-06-03 23:00:53 +00:00
}
2019-06-21 12:32:46 +00:00
###############################################################
# SMAPortalSPG Get
###############################################################
2020-04-20 14:55:36 +00:00
sub Get {
2019-06-21 12:32:46 +00:00
my ( $ hash , @ a ) = @ _ ;
return "\"get X\" needs at least an argument" if ( @ a < 2 ) ;
my $ name = shift @ a ;
my $ cmd = shift @ a ;
2020-04-20 14:55:36 +00:00
my $ getlist = "Unknown argument $cmd, choose one of " .
"html:noArg " .
"ftui:noArg " ;
2019-06-21 12:32:46 +00:00
if ( $ cmd eq "html" ) {
2020-04-20 14:55:36 +00:00
return pageAsHtml ( $ hash ) ;
2019-06-21 12:32:46 +00:00
}
2019-06-26 21:43:03 +00:00
if ( $ cmd eq "ftui" ) {
2020-04-20 14:55:36 +00:00
return pageAsHtml ( $ hash , "ftui" ) ;
2019-06-26 21:43:03 +00:00
}
2020-04-20 14:55:36 +00:00
return ;
2019-06-21 12:32:46 +00:00
}
2019-06-03 23:00:53 +00:00
################################################################
2020-04-20 14:55:36 +00:00
sub Rename {
2019-06-03 23:00:53 +00:00
my ( $ new_name , $ old_name ) = @ _ ;
my $ hash = $ defs { $ new_name } ;
$ hash - > { DEF } =~ s/$old_name/$new_name/g ;
$ hash - > { LINK } =~ s/$old_name/$new_name/g ;
return ;
}
################################################################
2020-04-20 14:55:36 +00:00
sub Copy {
2019-06-03 23:00:53 +00:00
my ( $ old_name , $ new_name ) = @ _ ;
my $ hash = $ defs { $ new_name } ;
$ hash - > { DEF } =~ s/$old_name/$new_name/g ;
$ hash - > { LINK } =~ s/$old_name/$new_name/g ;
return ;
}
################################################################
2020-04-20 14:55:36 +00:00
sub Attr {
2019-06-03 23:00:53 +00:00
my ( $ cmd , $ name , $ aName , $ aVal ) = @ _ ;
my $ hash = $ defs { $ name } ;
my ( $ do , $ val ) ;
# $cmd can be "del" or "set"
# $name is device name
# aName and aVal are Attribute name and value
if ( $ aName eq "disable" ) {
if ( $ cmd eq "set" ) {
$ do = ( $ aVal ) ? 1 : 0 ;
}
$ do = 0 if ( $ cmd eq "del" ) ;
$ val = ( $ do == 1 ? "disabled" : "initialized" ) ;
readingsSingleUpdate ( $ hash , "state" , $ val , 1 ) ;
if ( $ do == 1 ) {
my @ allrds = keys % { $ defs { $ name } { READINGS } } ;
foreach my $ key ( @ allrds ) {
delete ( $ defs { $ name } { READINGS } { $ key } ) if ( $ key ne "state" ) ;
}
}
}
if ( $ aName eq "icon" ) {
2019-06-24 09:28:41 +00:00
$ _ [ 2 ] = "consumerAdviceIcon" ;
2019-06-03 23:00:53 +00:00
}
2020-04-20 14:55:36 +00:00
return ;
2019-06-03 23:00:53 +00:00
}
################################################################
2020-04-20 14:55:36 +00:00
sub FwFn {
2019-06-03 23:00:53 +00:00
my ( $ FW_wname , $ d , $ room , $ pageHash ) = @ _ ; # pageHash is set for summaryFn.
my $ hash = $ defs { $ d } ;
my $ link = $ hash - > { LINK } ;
my $ height ;
RemoveInternalTimer ( $ hash ) ;
$ hash - > { HELPER } { FW } = $ FW_wname ;
$ link = AnalyzePerlCommand ( undef , $ link ) if ( $ link =~ m/^{(.*)}$/s ) ;
my $ alias = AttrVal ( $ d , "alias" , $ d ) ; # Linktext als Aliasname oder Devicename setzen
my $ dlink = "<a href=\"/fhem?detail=$d\">$alias</a>" ;
my $ ret = "" ;
if ( IsDisabled ( $ d ) ) {
$ height = AttrNum ( $ d , 'beamHeight' , 200 ) ;
$ ret . = "<table class='roomoverview'>" ;
$ ret . = "<tr style='height:" . $ height . "px'>" ;
$ ret . = "<td>" ;
$ ret . = "SMA Portal graphic device <a href=\"/fhem?detail=$d\">$d</a> is disabled" ;
$ ret . = "</td>" ;
$ ret . = "</tr>" ;
$ ret . = "</table>" ;
} else {
$ ret . = "<span>$dlink </span><br>" if ( AttrVal ( $ d , "showLink" , 0 ) ) ;
$ ret . = $ link ;
}
# Autorefresh nur des aufrufenden FHEMWEB-Devices
my $ al = AttrVal ( $ d , "autoRefresh" , 0 ) ;
if ( $ al ) {
2020-04-20 14:55:36 +00:00
InternalTimer ( gettimeofday ( ) + $ al , \ & pageRefresh , $ hash , 0 ) ;
2019-06-03 23:00:53 +00:00
Log3 ( $ d , 5 , "$d - next start of autoRefresh: " . FmtDateTime ( gettimeofday ( ) + $ al ) ) ;
}
return $ ret ;
}
################################################################
2020-04-20 14:55:36 +00:00
sub pageRefresh {
2019-06-03 23:00:53 +00:00
my ( $ hash ) = @ _ ;
my $ d = $ hash - > { NAME } ;
# Seitenrefresh festgelegt durch SMAPortalSPG-Attribut "autoRefresh" und "autoRefreshFW"
my $ rd = AttrVal ( $ d , "autoRefreshFW" , $ hash - > { HELPER } { FW } ) ;
{ map { FW_directNotify ( "#FHEMWEB:$_" , "location.reload('true')" , "" ) } $ rd }
my $ al = AttrVal ( $ d , "autoRefresh" , 0 ) ;
if ( $ al ) {
2020-04-20 14:55:36 +00:00
InternalTimer ( gettimeofday ( ) + $ al , \ & pageRefresh , $ hash , 0 ) ;
2019-06-03 23:00:53 +00:00
Log3 ( $ d , 5 , "$d - next start of autoRefresh: " . FmtDateTime ( gettimeofday ( ) + $ al ) ) ;
} else {
RemoveInternalTimer ( $ hash ) ;
}
return ;
}
#############################################################################################
# Versionierungen des Moduls setzen
# Die Verwendung von Meta.pm und Packages wird berücksichtigt
#############################################################################################
2020-04-20 14:55:36 +00:00
sub setVersionInfo {
2019-06-03 23:00:53 +00:00
my ( $ hash ) = @ _ ;
my $ name = $ hash - > { NAME } ;
2020-04-20 14:55:36 +00:00
my $ v = ( sortTopicNum ( "desc" , keys % vNotesIntern ) ) [ 0 ] ;
2019-06-03 23:00:53 +00:00
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}}
2020-04-20 14:55:36 +00:00
if ( $ modules { $ type } { META } { x_version } ) { # {x_version} ( nur gesetzt wenn $Id: 76_SMAPortalSPG.pm 19799 2019-07-08 16:33:29Z DS_Starter $ im Kopf komplett! vorhanden )
2019-06-03 23:00:53 +00:00
$ modules { $ type } { META } { x_version } =~ s/1.1.1/$v/g ;
} else {
$ modules { $ type } { META } { x_version } = $ v ;
}
2020-04-20 14:55:36 +00:00
return $@ unless ( FHEM::Meta:: SetInternals ( $ hash ) ) ; # FVERSION wird gesetzt ( nur gesetzt wenn $Id: 76_SMAPortalSPG.pm 19799 2019-07-08 16:33:29Z DS_Starter $ im Kopf komplett! vorhanden )
2019-06-03 23:00:53 +00:00
if ( __PACKAGE__ eq "FHEM::$type" || __PACKAGE__ eq $ type ) {
# es wird mit Packages gearbeitet -> Perl übliche Modulversion setzen
# mit {<Modul>->VERSION()} im FHEMWEB kann Modulversion abgefragt werden
use version 0.77 ; our $ VERSION = FHEM::Meta:: Get ( $ hash , 'version' ) ;
}
} else {
# herkömmliche Modulstruktur
$ hash - > { VERSION } = $ v ;
}
return ;
}
2019-06-21 12:32:46 +00:00
################################################################
# Grafik als HTML zurück liefern (z.B. für Widget)
################################################################
2020-04-20 14:55:36 +00:00
sub pageAsHtml {
2019-06-26 21:43:03 +00:00
my ( $ hash , $ ftui ) = @ _ ;
my $ name = $ hash - > { NAME } ;
my $ link = $ hash - > { LINK } ;
2019-06-21 12:32:46 +00:00
my $ height ;
2019-06-26 21:43:03 +00:00
2020-04-20 14:55:36 +00:00
if ( $ ftui && $ ftui eq "ftui" ) { # Aufruf aus TabletUI -> FW_cmd ersetzen gemäß FTUI Syntax
2019-06-26 21:43:03 +00:00
my $ s = substr ( $ link , 0 , length ( $ link ) - 2 ) ;
$ link = $ s . ",'$ftui')}" ;
}
2019-06-21 12:32:46 +00:00
$ link = AnalyzePerlCommand ( undef , $ link ) if ( $ link =~ m/^{(.*)}$/s ) ;
my $ alias = AttrVal ( $ name , "alias" , $ name ) ; # Linktext als Aliasname oder Devicename setzen
my $ dlink = "<a href=\"/fhem?detail=$name\">$alias</a>" ;
my $ ret = "<html>" ;
if ( IsDisabled ( $ name ) ) {
$ height = AttrNum ( $ name , 'beamHeight' , 200 ) ;
$ ret . = "<table class='roomoverview'>" ;
$ ret . = "<tr style='height:" . $ height . "px'>" ;
$ ret . = "<td>" ;
$ ret . = "SMA Portal graphic device <a href=\"/fhem?detail=$name\">$name</a> is disabled" ;
$ ret . = "</td>" ;
$ ret . = "</tr>" ;
$ ret . = "</table>" ;
} else {
$ ret . = "<span>$dlink </span><br>" if ( AttrVal ( $ name , "showLink" , 0 ) ) ;
$ ret . = $ link ;
}
$ ret . = "</html>" ;
return $ ret ;
}
2019-06-03 23:00:53 +00:00
1 ;
= pod
2019-06-13 19:20:53 +00:00
= item summary Definition of graphic devices by the SMAPortal module
2019-06-03 23:00:53 +00:00
= item summary_DE Erstellung von Grafik - Devices durch das SMAPortal - Modul
= begin html
< a name = "SMAPortalSPG" > </a>
<h3> SMAPortalSPG </h3>
2019-06-13 19:20:53 +00:00
<br>
The module SMAPortalSPG is a device module attuned to the module SMAPortal for definition of graphic devices . <br>
2019-07-04 20:02:57 +00:00
Graphic data can also be integrated into FHEM Tablet UI with the
< a href = "https://wiki.fhem.de/wiki/FTUI_Widget_SMAPortalSPG" > "SMAPortalSPG Widget" </a> . <br>
2019-06-13 19:20:53 +00:00
<ul>
< a name = "SMAPortalSPGdefine" > </a>
<b> Define </b>
<br> <br>
<ul>
A SMAPortal graphic device is defined by the command "set <name> createPortalGraphic <type>" in an SMAPortal device .
Please see the description of SMAPortal < a href = "#SMAPortalCreatePortalGraphic" > "createPortalGraphic" </a> command .
<br> <br>
</ul>
< a name = "SMAPortalSPGset" > </a>
<b> Set </b>
<ul>
N / A
</ul>
<br>
< a name = "SMAPortalSPGget" > </a>
<b> Get </b>
<ul>
2019-07-02 22:20:22 +00:00
<br>
<ul>
<li> <b> get & lt ; name & gt ; html </b> </li>
The SMAPortal graphic is fetched as HTML - code and depicted .
</ul>
<br>
<br>
2019-06-13 19:20:53 +00:00
</ul>
< a name = "SMAPortalSPGattr" > </a>
<b> Attribute </b>
<br> <br>
<ul>
<ul>
< a name = "alias" > </a>
<li> <b> alias </b> <br>
In conjunction with "showLink" a user - defined label for the device .
</li>
<br>
< a name = "autoRefresh" > </a>
<li> <b> autoRefresh </b> <br>
If set , active browser pages of the FHEMWEB device which has called the SMAPortalSPG device , are new reloaded after
the specified time ( seconds ) . Browser pages of a particular FHEMWEB device to be refreshed can be specified by
attribute "autoRefreshFW" instead .
</li>
<br>
< a name = "autoRefreshFW" > </a>
<li> <b> autoRefreshFW </b> <br>
If "autoRefresh" is activated , you can specify a particular FHEMWEB device whose active browser pages are refreshed
periodically .
</li>
<br>
< a name = "beamColor" > </a>
<li> <b> beamColor </b> <br>
Color selection for the primary beams .
</li>
<br>
< a name = "beamColor2" > </a>
<li> <b> beamColor2 </b> <br>
Color selection for the secondary beams . The second color only make sense for devices of type "Generation_Consumption"
( Type pvco ) and "Differential" ( Type diff ) .
</li>
<br>
< a name = "beamHeight" > </a>
<li> <b> beamHeight & lt ; value & gt ; </b> <br>
Height of beams in px and therefore the determination of the whole graphic Height .
In conjunction with "hourCount" it is possible to create quite tiny graphics . ( default: 200 )
</li>
<br>
< a name = "beamWidth" > </a>
<li> <b> beamWidth & lt ; value & gt ; </b> <br>
Width of the beams in px . ( default: 6 ( auto ) )
</li>
<br>
< a name = "consumerList" > </a>
<li> <b> consumerList & lt ; Verbraucher1 & gt ; : & lt ; Icon & gt ; @ & lt ; Farbe & gt ; , & lt ; Verbraucher2 & gt ; : & lt ; Icon & gt ; @ & lt ; Farbe & gt ; , ... </b> <br>
Comma separated list of consumers which are connected to the Sunny Home Manager . <br>
Once the activation of a listed consumer is planned , the consumer icon will be shown in the beams of the planned period .
The name of a consumer must be identical to its name in Reading "L3_<consumer>_Planned" . <br> <br>
<b> Example: </b> <br>
attr & lt ; name & gt ; consumerList Trockner:scene_clothes_dryer @ yellow , Waschmaschine:scene_washing_machine @ lightgreen , Geschirrspueler:scene_dishwasher @ orange
<br>
</li>
<br>
< a name = "consumerLegend" > </a>
<li> <b> consumerLegend & ltnone | icon_top | icon_bottom | text_top | text_bottom & gt ; </b> <br>
Location respectively the method of the shown consumer legend .
</li>
<br>
< a name = "disable" > </a>
<li> <b> disable </b> <br>
Activate / deactivate the device .
</li>
<br>
< a name = "forcePageRefresh" > </a>
<li> <b> forcePageRefresh </b> <br>
The attribute is evaluated by the SMAPortal module . <br>
If set , a reload of all browser pages with active FHEMWEB connections will be enforced when the parent SMAPortal device
was updated .
</li>
<br>
2019-07-07 18:54:56 +00:00
< a name = "headerAlignment" > </a>
<li> <b> headerAlignment & lt ; center | left | right & gt ; </b> <br>
Alignment of the header lines . ( default: center )
</li>
<br>
< a name = "headerDetail" > </a>
<li> <b> headerDetail & lt ; all | co | pv | pvco | statusLink & gt ; </b> <br>
Detail level of the header lines . ( default: all )
<ul>
<table>
<colgroup> < col width = 15 % > < col width = 85 % > < / colgroup >
<tr> <td> <b> all </b> </td> <td> display production ( PV ) , consumption ( CO ) , link to SMAPortal device + update timestamp ( default ) </td> </tr>
<tr> <td> <b> co </b> </td> <td> display consumption ( CO ) only </td> </tr>
2019-07-07 19:19:04 +00:00
<tr> <td> <b> pv </b> </td> <td> display production ( PV ) only </td> </tr>
2019-07-07 18:54:56 +00:00
<tr> <td> <b> pvco </b> </td> <td> display production ( PV ) and consumption ( CO ) </td> </tr>
<tr> <td> <b> statusLink </b> </td> <td> Link to SMAPortal device + update timestamp only </td> </tr>
</table>
</ul>
</li>
<br>
2019-06-13 19:20:53 +00:00
< a name = "hourCount" > </a>
<li> <b> hourCount & lt ; 4 ... 24 & gt ; </b> <br>
Amount of beams / hours to show . ( default: 24 )
</li>
<br>
< a name = "hourStyle" > </a>
<li> <b> hourStyle </b> <br>
Format of time specification . <br> <br>
<ul>
<table>
<colgroup> < col width = 10 % > < col width = 90 % > < / colgroup >
<tr> <td> <b> not set </b> </td> <td> - only hours without minutes ( default ) </td> </tr>
<tr> <td> <b> : 00 </b> </td> <td> - hours and minutes two - digit , e . g . 10 : 00 </td> </tr>
<tr> <td> <b> : 0 </b> </td> <td> - hours and minutes one - digit , e . g . 8 : 0 </td> </tr>
</table>
</ul>
</li>
<br>
< a name = "maxPV" > </a>
<li> <b> maxPV & lt ; 0 ... val & gt ; </b> <br>
Maximum yield per hour to calculate the beam height . ( default: 0 - > dynamical )
</li>
<br>
< a name = "htmlStart" > </a>
<li> <b> htmlStart & lt ; HTML - String & gt ; </b> <br>
A user - defined HTML - String issued before the graphic code .
</li>
<br>
< a name = "htmlEnd" > </a>
<li> <b> htmlEnd & lt ; HTML - String & gt ; </b> <br>
A user - defined HTML - String issued after the graphic code .
</li>
<br>
< a name = "showDiff" > </a>
<li> <b> showDiff & lt ; no | top | bottom & gt ; </b> <br>
Additional note of the difference "Generation - Consumption" as well as the device type Differential ( diff ) does .
( default: no )
</li>
<br>
< a name = "showHeader" > </a>
<li> <b> showHeader </b> <br>
Shows the header line with forecast data , Rest of the current day generation and the forecast of the next day
( default: 1 )
</li>
<br>
< a name = "showLink" > </a>
<li> <b> showLink </b> <br>
Show the detail link above the graphic device . ( default: 1 )
</li>
<br>
< a name = "showNight" > </a>
<li> <b> showNight </b> <br>
Show the night hours ( without forecast values ) additionally . ( default: 0 )
</li>
<br>
< a name = "showWeather" > </a>
<li> <b> showWeather </b> <br>
Show weather icons . ( default: 1 )
</li>
<br>
< a name = "spaceSize" > </a>
<li> <b> spaceSize & lt ; value & gt ; </b> <br>
Determines the space ( px ) above or below the beams ( only when using the type "Differential" ( diff ) ) to the shown values .
If styles are using large fonts the default value may be too less .
In that cases please increase the value . ( default: 24 )
</li>
<br>
2019-06-24 09:28:41 +00:00
< a name = "consumerAdviceIcon" > </a>
<li> <b> consumerAdviceIcon </b> <br>
2019-06-13 19:20:53 +00:00
Set the icon used in periods with suggestion to switch consumers on .
You can use the standard "Select Icon" function ( down left in FHEMWEB ) to select the wanted icon .
</li>
<br>
< a name = "layoutType" > </a>
<li> <b> layoutType & lt ; pv | co | pvco | diff & gt ; </b> <br>
Layout type of Portal graphic . ( default: pv ) <br> <br>
<ul>
<table>
<colgroup> < col width = 15 % > < col width = 85 % > < / colgroup >
<tr> <td> <b> pv </b> </td> <td> - Generation </td> </tr>
<tr> <td> <b> co </b> </td> <td> - Consumption </td> </tr>
<tr> <td> <b> pvco </b> </td> <td> - Generation and Consumption </td> </tr>
<tr> <td> <b> diff </b> </td> <td> - Differenz between Generation and Consumption </td> </tr>
</table>
</ul>
</li>
<br>
< a name = "Wh/kWh" > </a>
<li> <b> Wh /kWh <Wh | kWh> </ b > <br>
Switch the unit to W or to kW rounded to one position after decimal point . ( default: W )
</li>
<br>
< a name = "weatherColor" > </a>
<li> <b> weatherColor </b> <br>
Color of weather icons .
</li>
<br>
</ul>
</ul>
</ul>
2019-06-03 23:00:53 +00:00
= end html
= begin html_DE
< a name = "SMAPortalSPG" > </a>
<h3> SMAPortalSPG </h3>
<br>
Das Modul SMAPortalSPG ist ein mit SMAPortal abgestimmtes Gerätemodul zur Definition von Grafik - Devices . <br>
2019-07-04 20:02:57 +00:00
Die Portalgrafik kann ebenfalls in FHEM Tablet UI mit dem
< a href = "https://wiki.fhem.de/wiki/FTUI_Widget_SMAPortalSPG" > "SMAPortalSPG Widget" </a> integriert werden . <br>
2019-06-03 23:00:53 +00:00
<ul>
< a name = "SMAPortalSPGdefine" > </a>
<b> Define </b>
<br> <br>
<ul>
2019-06-13 19:20:53 +00:00
Ein SMAPortal Grafik - Device wird durch den SMAPortal Befehl "set <name> createPortalGraphic <Typ>" erstellt .
2019-06-03 23:00:53 +00:00
Siehe auch die Beschreibung zum SMAPortal < a href = "#SMAPortalCreatePortalGraphic" > "createPortalGraphic" </a> Befehl .
<br> <br>
</ul>
< a name = "SMAPortalSPGset" > </a>
<b> Set </b>
<ul>
N / A
</ul>
<br>
< a name = "SMAPortalSPGget" > </a>
<b> Get </b>
<ul>
2019-07-02 22:20:22 +00:00
<br>
<ul>
<li> <b> get & lt ; name & gt ; html </b> </li>
Die SMAPortal - Grafik wird als HTML - Code abgerufen und wiedergegeben .
</ul>
<br>
<br>
2019-06-03 23:00:53 +00:00
</ul>
< a name = "SMAPortalSPGattr" > </a>
<b> Attribute </b>
<br> <br>
<ul>
<ul>
< a name = "alias" > </a>
<li> <b> alias </b> <br>
2019-06-13 19:20:53 +00:00
In Verbindung mit "showLink" ein beliebiger Abzeigename .
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "autoRefresh" > </a>
<li> <b> autoRefresh </b> <br>
Wenn gesetzt , werden aktive Browserseiten des FHEMWEB - Devices welches das SMAPortalSPG - Device aufgerufen hat , nach der
eingestellten Zeit ( Sekunden ) neu geladen . Sollen statt dessen Browserseiten eines bestimmten FHEMWEB - Devices neu
geladen werden , kann dieses Device mit dem Attribut "autoRefreshFW" festgelegt werden .
</li>
<br>
< a name = "autoRefreshFW" > </a>
<li> <b> autoRefreshFW </b> <br>
Ist "autoRefresh" aktiviert , kann mit diesem Attribut das FHEMWEB - Device bestimmt werden dessen aktive Browserseiten
regelmäßig neu geladen werden sollen .
</li>
<br>
< a name = "beamColor" > </a>
<li> <b> beamColor </b> <br>
Farbauswahl der primären Balken .
</li>
<br>
< a name = "beamColor2" > </a>
<li> <b> beamColor2 </b> <br>
2019-06-13 19:20:53 +00:00
Farbauswahl der sekundären Balken . Die zweite Farbe ist nur sinnvoll für den Anzeigedevice - Typ "Generation_Consumption"
( pvco ) und "Differential" ( diff ) .
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "beamHeight" > </a>
<li> <b> beamHeight & lt ; value & gt ; </b> <br>
Höhe der Balken in px und damit Bestimmung der gesammten Höhe .
2019-06-13 19:20:53 +00:00
In Verbindung mit "hourCount" lassen sich damit auch recht kleine Grafikausgaben erzeugen . ( default: 200 )
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "beamWidth" > </a>
<li> <b> beamWidth & lt ; value & gt ; </b> <br>
2019-06-13 19:20:53 +00:00
Breite der Balken in px . ( default: 6 ( auto ) )
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "consumerList" > </a>
2019-06-13 19:20:53 +00:00
<li> <b> consumerList & lt ; Verbraucher1 & gt ; : & lt ; Icon & gt ; @ & lt ; Farbe & gt ; , & lt ; Verbraucher2 & gt ; : & lt ; Icon & gt ; @ & lt ; Farbe & gt ; , ... </b> <br>
Komma getrennte Liste der am SMA Sunny Home Manager angeschlossenen Geräte . <br>
Sobald die Aktivierung einer der angegebenen Verbraucher geplant ist , wird der geplante Zeitraum in der Grafik
2019-06-03 23:00:53 +00:00
angezeigt .
Der Name des Verbrauchers muss dabei dem Namen im Reading "L3_<Verbrauchername>_Planned" entsprechen . <br> <br>
<b> Beispiel: </b> <br>
2019-06-13 19:20:53 +00:00
attr & lt ; name & gt ; consumerList Trockner:scene_clothes_dryer @ yellow , Waschmaschine:scene_washing_machine @ lightgreen , Geschirrspueler:scene_dishwasher @ orange
2019-06-03 23:00:53 +00:00
<br>
</li>
<br>
< a name = "consumerLegend" > </a>
<li> <b> consumerLegend & ltnone | icon_top | icon_bottom | text_top | text_bottom & gt ; </b> <br>
2019-06-13 19:20:53 +00:00
Lage bzw . Art und Weise der angezeigten Verbraucherlegende .
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "disable" > </a>
<li> <b> disable </b> <br>
Aktiviert / deaktiviert das Device .
</li>
<br>
< a name = "forcePageRefresh" > </a>
<li> <b> forcePageRefresh </b> <br>
2019-06-13 19:20:53 +00:00
Das Attribut wird durch das SMAPortal - Device ausgewertet . <br>
Wenn gesetzt , wird ein Reload aller Browserseiten mit aktiven FHEMWEB - Verbindungen nach dem Update des
Eltern - SMAPortal - Devices erzwungen .
2019-06-03 23:00:53 +00:00
</li>
<br>
2019-07-07 18:54:56 +00:00
< a name = "headerAlignment" > </a>
<li> <b> headerAlignment & lt ; center | left | right & gt ; </b> <br>
Ausrichtung der Kopfzeilen . ( default: center )
</li>
<br>
< a name = "headerDetail" > </a>
<li> <b> headerDetail & lt ; all | co | pv | pvco | statusLink & gt ; </b> <br>
Detailiierungsgrad der Kopfzeilen . ( default: all )
<ul>
<table>
<colgroup> < col width = 15 % > < col width = 85 % > < / colgroup >
<tr> <td> <b> all </b> </td> <td> Anzeige Erzeugung ( PV ) , Verbrauch ( CO ) , Link zum SMAPortal - Device + Aktualisierungszeit ( default ) </td> </tr>
<tr> <td> <b> co </b> </td> <td> nur Verbrauch ( CO ) </td> </tr>
<tr> <td> <b> pv </b> </td> <td> nur Erzeugung ( PV ) </td> </tr>
<tr> <td> <b> pvco </b> </td> <td> Erzeugung ( PV ) und Verbrauch ( CO ) </td> </tr>
<tr> <td> <b> statusLink </b> </td> <td> nur Link zum SMAPortal - Device + Aktualisierungszeit </td> </tr>
</table>
</ul>
</li>
<br>
2019-06-03 23:00:53 +00:00
< a name = "hourCount" > </a>
<li> <b> hourCount & lt ; 4 ... 24 & gt ; </b> <br>
Anzahl der Balken / Stunden . ( default: 24 )
</li>
<br>
< a name = "hourStyle" > </a>
<li> <b> hourStyle </b> <br>
Format der Zeitangabe . <br> <br>
<ul>
<table>
<colgroup> < col width = 10 % > < col width = 90 % > < / colgroup >
<tr> <td> <b> nicht gesetzt </b> </td> <td> - nur Stundenangabe ohne Minuten ( default ) </td> </tr>
<tr> <td> <b> : 00 </b> </td> <td> - Stunden sowie Minuten zweistellig , z . B . 10 : 00 </td> </tr>
<tr> <td> <b> : 0 </b> </td> <td> - Stunden sowie Minuten einstellig , z . B . 8 : 0 </td> </tr>
</table>
</ul>
</li>
<br>
< a name = "maxPV" > </a>
<li> <b> maxPV & lt ; 0 ... val & gt ; </b> <br>
2019-06-13 19:20:53 +00:00
Maximaler Ertrag in einer Stunde zur Berechnung der Balkenhöhe . ( default: 0 - > dynamisch )
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "htmlStart" > </a>
<li> <b> htmlStart & lt ; HTML - String & gt ; </b> <br>
2019-06-13 19:20:53 +00:00
Angabe eines beliebigen HTML - Strings der vor dem Grafik - Code ausgeführt wird .
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "htmlEnd" > </a>
<li> <b> htmlEnd & lt ; HTML - String & gt ; </b> <br>
2019-06-13 19:20:53 +00:00
Angabe eines beliebigen HTML - Strings der nach dem Grafik - Code ausgeführt wird .
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "showDiff" > </a>
<li> <b> showDiff & lt ; no | top | bottom & gt ; </b> <br>
Zusätzliche Anzeige der Differenz "Ertrag - Verbrauch" wie beim Anzeigetyp Differential ( diff ) . ( default: no )
</li>
<br>
< a name = "showHeader" > </a>
2019-06-13 19:20:53 +00:00
<li> <b> showHeader </b> <br>
2019-06-03 23:00:53 +00:00
Anzeige der Kopfzeile mit Prognosedaten , Rest des aktuellen Tages und des nächsten Tages ( default: 1 )
</li>
<br>
< a name = "showLink" > </a>
2019-06-13 19:20:53 +00:00
<li> <b> showLink </b> <br>
Anzeige des Detail - Links über dem Grafik - Device ( default: 1 )
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "showNight" > </a>
2019-06-13 19:20:53 +00:00
<li> <b> showNight </b> <br>
Die Nachtstunden ( ohne Ertragsprognose ) werden mit angezeigt . ( default: 0 )
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "showWeather" > </a>
2019-06-13 19:20:53 +00:00
<li> <b> showWeather </b> <br>
2019-06-03 23:00:53 +00:00
Wettericons anzeigen . ( default: 1 )
</li>
<br>
< a name = "spaceSize" > </a>
<li> <b> spaceSize & lt ; value & gt ; </b> <br>
2019-06-13 19:20:53 +00:00
Legt fest wieviel Platz in px über oder unter den Balken ( bei Anzeigetyp Differential ( diff ) ) zur Anzeige der
Werte freigehalten wird . Bei Styles mit große Fonts kann der default - Wert zu klein sein bzw . rutscht ein
Balken u . U . über die Grundlinie . In diesen Fällen bitte den Wert erhöhen . ( default: 24 )
2019-06-03 23:00:53 +00:00
</li>
<br>
2019-06-24 09:28:41 +00:00
< a name = "consumerAdviceIcon" > </a>
<li> <b> consumerAdviceIcon </b> <br>
2019-06-03 23:00:53 +00:00
Setzt das Icon zur Darstellung der Zeiten mit Verbraucherempfehlung .
Dazu kann ein beliebiges Icon mit Hilfe der Standard "Select Icon" - Funktion ( links unten im FHEMWEB ) direkt ausgewählt
werden .
</li>
<br>
< a name = "layoutType" > </a>
<li> <b> layoutType & lt ; pv | co | pvco | diff & gt ; </b> <br>
Layout der Portalgrafik . ( default: pv ) <br> <br>
<ul>
<table>
<colgroup> < col width = 15 % > < col width = 85 % > < / colgroup >
<tr> <td> <b> pv </b> </td> <td> - Erzeugung </td> </tr>
<tr> <td> <b> co </b> </td> <td> - Verbrauch </td> </tr>
<tr> <td> <b> pvco </b> </td> <td> - Erzeugung und Verbrauch </td> </tr>
<tr> <td> <b> diff </b> </td> <td> - Differenz von Erzeugung und Verbrauch </td> </tr>
</table>
</ul>
</li>
<br>
2019-06-13 19:20:53 +00:00
< a name = "Wh/kWh" > </a>
<li> <b> Wh /kWh <Wh | kWh> </ b > <br>
Definiert die Anzeigeeinheit in Wh oder in kWh auf eine Nachkommastelle gerundet . ( default: W )
2019-06-03 23:00:53 +00:00
</li>
<br>
< a name = "weatherColor" > </a>
<li> <b> weatherColor </b> <br>
Farbe der Wetter - Icons .
</li>
<br>
</ul>
</ul>
</ul>
= end html_DE
= for : application / json ; q = META . json 76 _SMAPortalSPG . pm
{
"abstract" : "Definition of grapic devices by the SMAPortal module" ,
"x_lang" : {
"de" : {
"abstract" : "Erstellung von Grafik-Devices durch das SMAPortal-Modul"
}
} ,
"keywords" : [
"sma" ,
"photovoltaik" ,
"electricity" ,
"portal" ,
"smaportal" ,
"graphics" ,
"longpoll" ,
"refresh"
] ,
"version" : "v1.1.1" ,
2019-06-13 19:20:53 +00:00
"release_status" : "stable" ,
2019-06-03 23:00:53 +00:00
"author" : [
"Heiko Maaz <heiko.maaz@t-online.de>"
] ,
"x_fhem_maintainer" : [
"DS_Starter"
] ,
"x_fhem_maintainer_github" : [
"nasseeder1"
] ,
"prereqs" : {
"runtime" : {
"requires" : {
"FHEM" : 5.00918799 ,
"perl" : 5.014 ,
"Time::HiRes" : 0
} ,
"recommends" : {
"FHEM::Meta" : 0
} ,
"suggests" : {
}
}
} ,
"resources" : {
"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/76_SMAPortalSPG.pm" ,
"x_branch" : "dev" ,
"x_filepath" : "fhem/contrib/" ,
"x_raw" : "https://svn.fhem.de/fhem/trunk/fhem/contrib/DS_Starter/76_SMAPortalSPG.pm"
}
}
}
}
= end : application / json ; q = META . json
= cut
