diff --git a/fhem/CHANGED b/fhem/CHANGED index fa8032196..73cf82024 100644 --- a/fhem/CHANGED +++ b/fhem/CHANGED @@ -1,5 +1,7 @@ # Add changes at the top of the list. Keep it in ASCII, and 80-char wide. # Do not insert empty lines here, update check depends on it. + - new: 98_powerMap: introducing new module to calculate power and + energy for every FHEM device w/o power meter - updated: 38_netatmo.pm: added support for Presence, Homecoach & Webhook - new: 98_GoogleAuth.pm for use of 2-factor-authentication in FHEM - updated: codemirror & addons version to 5.22.0 (minified) diff --git a/fhem/FHEM/98_powerMap.pm b/fhem/FHEM/98_powerMap.pm new file mode 100644 index 000000000..f5c11e983 --- /dev/null +++ b/fhem/FHEM/98_powerMap.pm @@ -0,0 +1,1424 @@ +################################################################################ +# $Id$ +############################################################################## +# +# 98_powerMap.pm +# Original version by igami +# +# Copyright by Julian Pawlowski +# e-mail: julian.pawlowski at gmail.com +# +# This file is part of fhem. +# +# Fhem is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 2 of the License, or +# (at your option) any later version. +# +# Fhem is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with fhem. If not, see . +# +################################################################################ +# TODO +# - help users setting powerMap attribute using internal hash database or +# by copying from $defs{$name}{powerMap} +# - document how to include powerMap for other module maintainers +# (see 50_HP1000) +# + +package main; +use strict; +use warnings; +use Unit; + +# forward declarations ######################################################### +sub powerMap_Initialize($); + +sub powerMap_Define($$); +sub powerMap_Undefine($$); +sub powerMap_Get($@); +sub powerMap_Attr(@); +sub powerMap_Notify($$); + +sub powerMap_AttrVal($$$$); +sub powerMap_load($$); +sub powerMap_power($$$); +sub powerMap_energy($$;$); +sub powerMap_update($;$); + +# initialize ################################################################### +sub powerMap_Initialize($) { + my ($hash) = @_; + my $TYPE = "powerMap"; + + $hash->{DefFn} = $TYPE . "_Define"; + $hash->{UndefFn} = $TYPE . "_Undefine"; + $hash->{GetFn} = $TYPE . "_Get"; + $hash->{AttrFn} = $TYPE . "_Attr"; + $hash->{NotifyFn} = $TYPE . "_Notify"; + + $hash->{NotifyOrderPrefix} = "10-"; # Want to be called before the rest + + $hash->{AttrList} = + "disable:1,0 " . $TYPE . "_gridV:230,110 " . $readingFnAttributes; + + addToAttrList( $TYPE . "_noEnergy:1,0" ); + addToAttrList( $TYPE . "_noPower:1,0" ); + addToAttrList( $TYPE . "_interval" ); + addToAttrList( $TYPE . "_rname_P:textField" ); + addToAttrList( $TYPE . "_rname_E:textField" ); + addToAttrList( $TYPE . ":textField-long" ); +} + +# regular Fn ################################################################### +sub powerMap_Define($$) { + my ( $hash, $def ) = @_; + my ( $name, $type, $rest ) = split( /[\s]+/, $def, 3 ); + my $TYPE = $hash->{TYPE}; + my $d = $modules{$TYPE}{defptr}; + + return "Usage: define powerMap" if ($rest); + return "powerMap device already defined as $d->{NAME}" if ( defined($d) ); + + my $interval = AttrVal( $name, "powerMap_interval", 900 ); + $interval = 900 unless ( looks_like_number($interval) ); + $interval = 30 if ( $interval < 30 ); + + $modules{$TYPE}{defptr} = $hash; + $hash->{INTERVAL} = $interval; + $hash->{STATE} = "Initialized"; + + return; +} + +sub powerMap_Undefine($$) { + my ( $hash, $arg ) = @_; + my $name = $hash->{NAME}; + my $TYPE = $hash->{TYPE}; + + delete $modules{$TYPE}{defptr}; + + # search for devices with user defined + # powerMap support to be terminated + my @slaves = devspec2array("a:powerMap=.+"); + + # search for loaded modules with direct + # powerMap support to be terminated + foreach ( keys %modules ) { + if ( defined( $modules{$_}{$TYPE} ) ) { + my @instances = devspec2array("TYPE=$_"); + push @slaves, @instances; + } + } + + # search for devices with direct + # powerMap support to be terminated + foreach ( keys %defs ) { + push( @slaves, $_ ) + if ( defined( $defs{$_}{$TYPE} ) ); + } + + # terminate powerMap for each device + foreach (@slaves) { + next if ( $_ eq "global" or $_ eq $name ); + RemoveInternalTimer("$name|$_"); + delete $defs{$_}{pM_update} + if ( defined( $defs{$_}{pM_update} ) ); + delete $defs{$_}{pM_interval} + if ( defined( $defs{$_}{pM_interval} ) ); + } + + return; +} + +sub powerMap_Get($@) { + my ( $hash, @a ) = @_; + + return "Missing argument" if ( @a < 2 ); + + my $name = shift @a; + my $argument = shift @a; + my $value = join( " ", @a ) if (@a); + + my %powerMap_tmpl = ( + + # Format example for devices w/ model support: + # + # '' => { + # '(|)' => { + # '' => { + # + # # This is the actual powerMap definition + # '' => { + # '' => '', + # }, + # }, + # }, + # }, + + # Format example for devices w/o model support: + # + # '' => { + # + # # This is the actual powerMap definition + # '' => { + # '' => '', + # }, + # }, + + FS20 => { + state => { + 0 => 0.5, + 100 => 60, + }, + }, + + netatmo => { + model => { + NAMain => { + temperature => { + '*' => 5, + }, + }, + }, + }, + + ONKYO_AVR => { + model => { + 'TX-NR626' => { + stateAV => { + absent => 0, + off => 0, + muted => 85, + '*' => 140, + }, + }, + }, + }, + + ONKYO_AVR_ZONE => { + stateAV => { + off => 0, + muted => 10, + '*' => 20, + }, + }, + + PHTV => { + model => { + '55PFL8008S/12' => { + stateAV => { + absent => 0, + off => 0.1, + '*' => 90, + }, + }, + }, + }, + + HUEBridge => { + model => { + BSB001 => { + state => { + 0 => 0, + '*' => 1.669, + }, + }, + + BSB002 => { + state => { + 0 => 0, + '*' => 1.669, + }, + }, + }, + }, + + THINKINGCLEANER => { + model => { + Roomba_700_Series => { + presence => { + absent => 0, + }, + deviceStatus => { + base => 0.1, + plug => 0.1, + base_recon => 33, + plug_recon => 33, + base_full => 33, + plug_full => 33, + base_trickle => 5, + plug_trickle => 5, + base_wait => 0.1, + plug_wait => 0.1, + '*' => 0, + }, + }, + }, + }, + + HMCCU => { + state => { + '*' => 7.5, + }, + }, + + HMCCUDEV => { + ccutype => { + 'HM-LC-Dim1TPBU-FM' => { + stateHM => { + unreachable => 0, + working => 101, + up => 101, + down => 101, + 0 => 1.0, + 100 => 101, + }, + }, + 'HM-LC-Dim1T-FM' => { + stateHM => { + unreachable => 0, + working => 23.5, + up => 23.5, + down => 23.5, + 0 => 1.0, + 100 => 23.5, + }, + }, + 'HM-LC-Sw2-PB-FM' => { + stateHM => { + unreachable => 0, + off => 0.25, + on => 100.25, + }, + }, + 'HM-LC-Bl1PBU-FM' => { + stateHM => { + unreachable => 0, + working => 121, + up => 121, + down => 121, + '*' => 0.5, + }, + }, + 'HM-LC-Bl1-SM' => { + stateHM => { + unreachable => 0, + working => 121, + up => 121, + down => 121, + '*' => 0.4, + }, + }, + }, + }, + + HUEDevice => { + model => { + + # Hue Bulb + LCT001 => { + state => { + unreachable => 0, + 0 => 0.4, + 100 => 8.5, + }, + }, + + # Hue Spot BR30 + LCT002 => {}, + + # Hue Spot GU10 + LCT003 => {}, + + # Hue Bulb V2 + LCT007 => { + state => { + unreachable => 0, + 0 => 0.4, + 100 => 10, + }, + }, + + # Hue Bulb V3 + LCT010 => { + state => { + unreachable => 0, + 0 => 0.4, + 100 => 10, + }, + }, + + # Hue BR30 + LCT011 => {}, + + # Hue Bulb V3 + LCT014 => {}, + + # Living Colors G2 + LLC001 => {}, + + # Living Colors Bloom + LLC005 => {}, + + # Living Colors Gen3 Iris + LLC006 => {}, + + # Living Colors Gen3 Bloom + LLC007 => {}, + + # Living Colors Iris + LLC010 => {}, + + # Living Colors Bloom + LLC011 => {}, + + # Living Colors Bloom + LLC012 => {}, + + # Disney Living Colors + LLC013 => {}, + + # Living Colors Aura + LLC014 => {}, + + # Hue Go + LLC020 => {}, + + # Hue LightStrip + LST001 => { + state => { + unreachable => 0, + 0 => 0.4, + 100 => 12, + }, + }, + + # Hue LightStrip Plus + LST002 => { + state => { + unreachable => 0, + 0 => 0.4, + 100 => 20.5, + }, + }, + + # Living Whites Bulb + LWB001 => { + state => { + unreachable => 0, + 0 => 0.4, + 10 => 1.2, + 20 => 1.7, + 30 => 1.9, + 40 => 2.3, + 50 => 2.7, + 60 => 3.4, + 70 => 4.7, + 80 => 5.9, + 90 => 7.5, + 100 => 9.2, + }, + }, + + # Living Whites Bulb + LWB003 => { + state => { + unreachable => 0, + 0 => 0.4, + 10 => 1.2, + 20 => 1.7, + 30 => 1.9, + 40 => 2.3, + 50 => 2.7, + 60 => 3.4, + 70 => 4.7, + 80 => 5.9, + 90 => 7.5, + 100 => 9.2, + }, + }, + + # Hue Lux + LWB004 => {}, + + # Hue Lux + LWB006 => {}, + + # Hue Lux + LWB007 => {}, + + # Hue A19 White Ambience + LTW001 => {}, + + # Hue A19 White Ambience + LTW004 => {}, + + # Hue GU10 White Ambience + LTW013 => {}, + + # Hue GU10 White Ambience + LTW014 => {}, + + # Color Light Module + LLM001 => {}, + + # Color Temperature Module + LLM010 => {}, + + # Color Temperature Module + LLM011 => {}, + + # Color Temperature Module + LLM012 => {}, + + # LivingWhites Outlet + LWL001 => {}, + + # Hue Dimmer Switch + RWL020 => {}, + + # Hue Dimmer Switch + RWL021 => {}, + + # Hue Tap + ZGPSWITCH => {}, + + # dresden elektronik FLS-H lp + 'FLS-H3' => {}, + + # dresden elektronik FLS-PP lp + 'FLS-PP3' => {}, + + # LIGHTIFY Flex RGBW + 'Flex RGBW' => {}, + + # LIGHTIFY Classic A60 RGBW + 'Classic A60 RGBW' => {}, + + # LIGHTIFY Gardenspot Mini RGB + 'Gardenspot RGB' => {}, + + # LIGHTIFY Surface light tunable white + 'Surface Light TW' => {}, + + # LIGHTIFY Classic A60 tunable white + 'Classic A60 TW' => {}, + + # LIGHTIFY Classic B40 tunable white + 'Classic B40 TW' => {}, + + # LIGHTIFY PAR16 50 tunable white + 'PAR16 50 TW' => {}, + + # LIGHTIFY Plug + 'Plug - LIGHTIFY' => {}, + + # LIGHTIFY Plug + 'Plug 01' => {}, + + # Busch-Jaeger ZigBee Light Link Relais + 'RM01' => {}, + + # Busch-Jaeger ZigBee Light Link Dimmer + 'DM01' => {}, + }, + }, + + SONOSPLAYER => { + model => { + Sonos_S6 => { + stateAV => { + disappeared => 0, + off => 2.2, + mute => 2.2, + pause => 2.2, + on => 14.5, + }, + }, + + Sonos_S5 => { + stateAV => { + disappeared => 0, + off => 8.3, + mute => 8.3, + pause => 8.3, + on => 14.5, + }, + }, + + Sonos_S3 => { + stateAV => { + disappeared => 0, + off => 4.4, + mute => 4.4, + pause => 4.4, + on => 11.3, + }, + }, + + Sonos_S1 => { + stateAV => { + disappeared => 0, + off => 3.8, + mute => 3.8, + pause => 3.8, + on => 5.2, + }, + }, + }, + }, + ); + my %powerMap_gets = ( "devices" => "devices:noArg", ); + + return "Unknown argument $argument, choose one of " + . join( " ", values %powerMap_gets ) + unless ( exists( $powerMap_gets{$argument} ) ); + + if ( $argument eq "devices" ) { + my @devices = devspec2array("powerMap=.+"); + return @devices + ? join( "\n", sort(@devices) ) + : "no devices with powerMap attribute defined"; + } + + return; +} + +sub powerMap_Attr(@) { + my ( $cmd, $name, $attribute, $value ) = @_; + my $hash = $defs{$name}; + + if ( $attribute eq "disable" ) { + readingsSingleUpdate( $hash, "state", "disabled", 1 ) + if ( $value and $value == 1 ); + readingsSingleUpdate( $hash, "state", "enabled", 1 ) + if ( $cmd eq "del" or !$value ); + } + + return if ( IsDisabled($name) ); + + if ( $attribute eq "powerMap_interval" ) { + my $interval = $cmd eq "set" ? $value : 900; + $interval = 900 unless ( looks_like_number($interval) ); + $interval = 30 if ( $interval < 30 ); + + $hash->{INTERVAL} = $interval; + } + + return; +} + +sub powerMap_Notify($$) { + my ( $hash, $dev_hash ) = @_; + my $name = $hash->{NAME}; + my $dev = $dev_hash->{NAME}; + my $TYPE = $hash->{TYPE}; + + return + if ( + !$init_done + or IsDisabled($name) + or IsDisabled($dev) + or $name eq $dev # do not process own events + or powerMap_AttrVal( $name, $dev, "noPower", 0 ) + or ( !$modules{ $defs{$dev}{TYPE} }{$TYPE} + and !$defs{$dev}{'.powerMap'} + and $dev ne "global" ) + ); + + my $events = deviceEvents( $dev_hash, 1 ); + return unless ($events); + + Log3 $name, 5, "powerMap: Entering powerMap_Notify() for $dev"; + + # global events + if ( $dev eq "global" ) { + foreach my $event ( @{$events} ) { + next unless ( defined($event) ); + + if ( $event =~ m/^(INITIALIZED|SHUTDOWN)$/ ) { + my $event_prefix = $1; + + # search for devices with user defined + # powerMap support to be initialized + my @slaves = + devspec2array("a:powerMap=.+:FILTER=powerMap_noEnergy!=1"); + + # search for loaded modules with direct + # powerMap support to be initialized + foreach ( keys %modules ) { + if ( defined( $modules{$_}{$TYPE} ) ) { + my @instances = + devspec2array("TYPE=$_:FILTER=powerMap_noEnergy!=1"); + push @slaves, @instances; + } + } + + # search for devices with direct + # powerMap support to be initialized + foreach ( keys %defs ) { + push( @slaves, $_ ) + if ( defined( $defs{$_}{'.powerMap'} ) ); + } + + # initialize or terminate powerMap for each device + foreach (@slaves) { + next if ( $_ eq "global" or $_ eq $name ); + next + unless ( $event_prefix eq "SHUTDOWN" + or powerMap_load( $name, $_ ) ); + Log3 $name, 4, "powerMap: $event_prefix for $_"; + } + } + + # device attribute changed + elsif ( $event =~ + m/^(ATTR|DELETEATTR)\s(.*)\s(powerMap[a-zA-Z_]*)(\s+(.*))?/ ) + { + next unless ( powerMap_load( $name, $2 ) ); + Log3 $name, 4, "powerMap: UPDATED for $2"; + } + + # device was newly defined, renamed or got deleted + elsif ( $event =~ m/^(DEFINED|RENAMED|DELETED)\s(.*)/ ) { + next unless ( powerMap_load( $name, $2 ) ); + Log3 $name, 4, "powerMap: INITIALIZED for $2"; + } + } + + return; + } + + my $rname_e = powerMap_AttrVal( $name, $dev, "rname_E", "pM_energy" ); + my $rname_p = powerMap_AttrVal( $name, $dev, "rname_P", "pM_power" ); + + my $powerRecalcDone; + + # foreign device events + foreach my $event ( @{$events} ) { + next + if (!$event + or $event =~ /^($rname_e|$rname_p): / + or $event !~ /: / ); + + # only recalculate once no matter + # how many events we get at once + unless ($powerRecalcDone) { + my $power = powerMap_power( $name, $dev, $event ); + if ( defined($power) ) { + $powerRecalcDone = 1; + powerMap_update( "$name|$dev", $power ); + + # recalculate CHANGEDWITHSTATE + # for target device in deviceEvents() + $dev_hash->{CHANGEDWITHSTATE} = []; + } + } + } + + readingsSingleUpdate( $hash, "state", "Last device: $dev", 1 ) + if ($powerRecalcDone); + return undef; +} + +# module Fn #################################################################### +sub powerMap_AttrVal($$$$) { + my ( $p, $d, $n, $default ) = @_; + my $TYPE = $defs{$p}{TYPE}; + Log3 $p, 6, "powerMap: Entering powerMap_AttrVal() for $d"; + + return $default if ( !$TYPE ); + + # device attribute + # + + my $da = AttrVal( $d, $TYPE . "_" . $n, AttrVal( $d, $n, undef ) ); + return $da if ( defined($da) ); + + # device INTERNAL + # + + # HASH format + return $defs{$d}{$TYPE}{$n} + if ( $d + && defined( $defs{$d} ) + && defined( $defs{$d}{$TYPE} ) + && defined( $defs{$d}{$TYPE}{$n} ) ); + + # HASH format with dot prefix + return $defs{$d}{".$TYPE"}{$n} + if ( $d + && defined( $defs{$d} ) + && defined( $defs{$d}{".$TYPE"} ) + && defined( $defs{$d}{".$TYPE"}{$n} ) ); + + # name format with TYPE underscore prefix + return $defs{$d}{ $TYPE . "_" . $n } + if ( $d + && defined( $defs{$d} ) + && defined( $defs{$d}{ $TYPE . "_" . $n } ) ); + + # name format + return $defs{$d}{$n} + if ( $d + && defined( $defs{$d} ) + && defined( $defs{$d}{$n} ) ); + + # name format with dot TYPE underscore prefix + return $defs{$d}{ "." . $TYPE . "_" . $n } + if ( $d + && defined( $defs{$d} ) + && defined( $defs{$d}{ "." . $TYPE . "_" . $n } ) ); + + # name format with dot prefix + return $defs{$d}{".$n"} + if ( $d + && defined( $defs{$d} ) + && defined( $defs{$d}{".$n"} ) ); + + # module HASH + # + + my $t = $defs{$d}{TYPE}; + + # HASH format + return $modules{$t}{$TYPE}{$n} + if ( $t + && defined( $modules{$t} ) + && defined( $modules{$t}{$TYPE} ) + && defined( $modules{$t}{$TYPE}{$n} ) ); + + # HASH format with TYPE underscore prefix + return $modules{$t}{$TYPE}{ $TYPE . "_" . $n } + if ( $t + && defined( $modules{$t} ) + && defined( $modules{$t}{$TYPE} ) + && defined( $modules{$t}{$TYPE}{ $TYPE . "_" . $n } ) ); + + # module attribute + # + return AttrVal( $p, $TYPE . "_" . $n, AttrVal( $p, $n, $default ) ); +} + +sub powerMap_load($$) { + my ( $name, $dev ) = @_; + my $dev_hash = $defs{$dev}; + my $TYPE = $defs{$name}{TYPE}; + + Log3 $name, 5, "powerMap: Entering powerMap_load() for $dev"; + + unless ($dev_hash) { + RemoveInternalTimer("$name|$dev"); + return; + } + + my $powerMap = AttrVal( $dev, "powerMap", undef ); + my $rname_e = powerMap_AttrVal( $name, $dev, "rname_E", "pM_energy" ); + my $rname_p = powerMap_AttrVal( $name, $dev, "rname_P", "pM_power" ); + + # Support for Unit.pm + $dev_hash->{readingsDesc}{$rname_e} = { rtype => 'whr', }; + $dev_hash->{readingsDesc}{$rname_p} = { rtype => 'w', }; + + # Enable Unit.pm for DbLog + if ( $modules{ $dev_hash->{TYPE} }{DbLog_splitFn} + or $dev_hash->{DbLog_splitFn} + or $dev_hash->{'.DbLog_splitFn'} ) + { + Log3 $name, 5, + "powerMap: $dev has defined it's own DbLog_splitFn; " + . "won't enable unit support with DbLog but rather " + . "let this to the module itself"; + } + else { + Log3 $name, 4, "powerMap: Enabled unit support for $dev"; + $dev_hash->{'.DbLog_splitFn'} = "Unit_DbLog_split"; + } + + # restore original powerMap from module + if ( defined( $dev_hash->{'.powerMap'}{map} ) + and defined( $dev_hash->{'.powerMap'}{'map.module'} ) ) + { + Log3 $dev, 5, + "powerMap $dev: Updated device hash with module mapping table"; + + delete $dev_hash->{$TYPE}{map}; + $dev_hash->{$TYPE}{map} = $dev_hash->{$TYPE}{'map.module'}; + delete $dev_hash->{$TYPE}{'map.module'}; + } + + unless ($powerMap) { + return powerMap_update("$name|$dev") + if ( defined( $dev_hash->{$TYPE}{map} ) + || defined( $modules{ $dev_hash->{TYPE} }{$TYPE}{map} ) ); + return; + } + + if ( $powerMap =~ m/=>/ + and $powerMap !~ m/\$/ ) + { + $powerMap = "{" . $powerMap . "}" if ( $powerMap !~ m/^{.*}$/s ); + my $map = eval $powerMap; + if ($@) { + Log3 $dev, 3, + "powerMap $dev: Unable to evaluate attribute powerMap: " . $@; + } + elsif ( ref($map) ne "HASH" ) { + Log3 $dev, 3, + "powerMap $dev: Attribute powerMap was " + . "not defined in HASH format"; + } + else { + # backup any pre-existing definitions from module + if ( defined( $dev_hash->{$TYPE}{map} ) ) { + Log3 $dev, 4, + "powerMap $dev: Updated device hash with user mapping table"; + + $dev_hash->{$TYPE}{'map.module'} = + $dev_hash->{$TYPE}{map}; + delete $dev_hash->{$TYPE}{map}; + } + else { + Log3 $dev, 4, + "powerMap $dev: Updated device hash with mapping table"; + } + + $dev_hash->{$TYPE}{map} = $map; + return powerMap_update("$name|$dev"); + } + } + else { + Log3 $dev, 3, "powerMap $dev: Illegal format for attribute powerMap"; + } + + return 0; +} + +sub powerMap_power($$$) { + my ( $name, $dev, $event ) = @_; + my $hash = $defs{$name}; + my $TYPE = $hash->{TYPE}; + my $power = 0; + my $powerMap = + $defs{$dev}{$TYPE}{map} ? $defs{$dev}{$TYPE}{map} + : ( + $defs{$dev}{$TYPE}{map} ? $defs{$dev}{$TYPE}{map} + : $modules{ $defs{$dev}{TYPE} }{$TYPE}{map} + ); + + return unless ( defined($powerMap) and ref($powerMap) eq "HASH" ); + + # Log3 $name, 5, "powerMap: Entering powerMap_power() for $dev"; + + if ( $event =~ /^([A-Za-z\d_\.\-\/]+):\s+(.*)$/ ) { + my ( $reading, $val ) = ( $1, $2 ); + my $num = $val; + $num =~ s/[^-\.\d]//g; + + my $valueAliases = { + initialized => '0', + unavailable => '0', + disappeared => '0', + absent => '0', + disabled => '0', + disconnected => '0', + off => '0', + on => '100', + connected => '100', + enabled => '100', + present => '100', + appeared => '100', + available => '100', + }; + + $num = $valueAliases->{ lc($val) } + if ( defined( $valueAliases->{ lc($val) } ) + and looks_like_number( $valueAliases->{ lc($val) } ) ); + + # no power consumption defined for this reading + if ( !defined( $powerMap->{$reading} ) ) { + return; + } + + Log3 $name, 5, "powerMap: Entering powerMap_power() for $dev:$reading"; + Log3 $dev, 5, "powerMap $dev: $reading: val=$val num=$num"; + + # direct assigned power consumption (value) + if ( defined( $powerMap->{$reading}{$val} ) ) { + $power = $powerMap->{$reading}{$val}; + } + + # valueAliases mapping + elsif ( defined( $valueAliases->{ lc($val) } ) + and defined( $powerMap->{$reading}{ $valueAliases->{ lc($val) } } ) + ) + { + $power = $powerMap->{$reading}{ $valueAliases->{ lc($val) } }; + } + + # direct assigned power consumption (numeric) + elsif ( defined( $powerMap->{$reading}{$num} ) ) { + $power = $powerMap->{$reading}{$num}; + } + + # value interpolation + elsif ( looks_like_number($num) ) { + my ( $val1, $val2 ); + + foreach ( sort keys %{ $powerMap->{$reading} } ) { + next unless ( looks_like_number($_) ); + $val1 = $_ if ( $_ < $num ); + $val2 = $_ if ( $_ > $num ); + last if ( defined($val2) ); + } + + if ($val2) { + Log3 $dev, 5, + "powerMap $dev: Interpolating power value between " + . "$powerMap->{$reading}{$val1} and $powerMap->{$reading}{$val2}"; + + my $y1 = $powerMap->{$reading}{$val1}; + my $y2 = $powerMap->{$reading}{$val2}; + my $m = ( ($y2) - ($y1) ) / ( ($val2) - ($val1) ); + my $b = + ( ( ($val2) * ($y1) ) - ( ($val1) * ($y2) ) ) / + ( ($val2) - ($val1) ); + + my $powerFormat = + powerMap_AttrVal( $name, $dev, "format_P", undef ); + + if ($powerFormat) { + $power = + sprintf( $powerFormat, ( ($m) * ($num) ) + ($b) ); + } + else { + $power = ( ($m) * ($num) ) + ($b); + } + } + elsif ( defined( $powerMap->{$reading}{'*'} ) ) { + $power = $powerMap->{$reading}{'*'}; + } + else { + Log3 $dev, 3, "powerMap $dev: Power value interpolation failed"; + } + } + + elsif ( defined( $powerMap->{$reading}{'*'} ) ) { + $power = $powerMap->{$reading}{'*'}; + } + } + + return $power; +} + +sub powerMap_energy($$;$) { + my ( $name, $dev, $P1 ) = @_; + my $hash = $defs{$name}; + my $dev_hash = $defs{$dev}; + my $rname_e = powerMap_AttrVal( $name, $dev, "rname_E", "pM_energy" ); + my $rname_p = powerMap_AttrVal( $name, $dev, "rname_P", "pM_power" ); + + Log3 $name, 5, "powerMap: Entering powerMap_energy() for $dev"; + + my $E0 = ReadingsVal( $dev, $rname_e, 0 ); + my $P0 = ReadingsVal( $dev, $rname_p, 0 ); + $P0 = 0 unless ( looks_like_number($P0) ); + $P1 = $P0 unless ( defined($P1) ); + my $Dt = ReadingsAge( $dev, $rname_e, 0 ) / 3600; + my $DE = $P0 * $Dt; + my $E1 = $E0 + $DE; + + Log3( $dev, 4, + "powerMap $dev: energy calculation results:\n" + . " energyOld : $E0 Wh\n" + . " powerOld : $P0 W\n" + . " power : $P1 W\n" + . " timeframe : $Dt h\n" + . " energyDiff: $DE Wh\n" + . " energy : $E1 Wh" ); + + return ( $E1, $P1 ); +} + +sub powerMap_update($;$) { + my ( $name, $dev ) = split( "\\|", shift ); + my ($power) = @_; + my $hash = $defs{$name}; + my $dev_hash = $defs{$dev}; + my $TYPE = $hash->{TYPE}; + + RemoveInternalTimer("$name|$dev"); + delete $dev_hash->{pM_update} + if ( defined( $dev_hash->{pM_update} ) ); + delete $dev_hash->{pM_interval} + if ( defined( $dev_hash->{pM_interval} ) ); + + return + unless ( !IsDisabled($name) and defined($hash) and defined($dev_hash) ); + + Log3 $name, 5, "powerMap: Entering powerMap_update() for $dev"; + + my $rname_e = powerMap_AttrVal( $name, $dev, "rname_E", "pM_energy" ); + my $rname_p = powerMap_AttrVal( $name, $dev, "rname_P", "pM_power" ); + + readingsBeginUpdate($dev_hash); + + unless ( powerMap_AttrVal( $name, $dev, "noEnergy", 0 ) ) { + my ( $energy, $P1 ) = powerMap_energy( $name, $dev, $power ); + readingsBulkUpdate( $dev_hash, $rname_e . "_begin", time() ) + unless ( ReadingsVal( $dev, $rname_e, undef ) ); + readingsBulkUpdate( $dev_hash, $rname_e, $energy ); + + if ($P1) { + $dev_hash->{pM_interval} = + powerMap_AttrVal( $name, $dev, $TYPE . "_interval", + $hash->{INTERVAL} ); + $dev_hash->{pM_interval} = 900 + unless ( looks_like_number( $dev_hash->{pM_interval} ) ); + $dev_hash->{pM_interval} = 30 + if ( $dev_hash->{pM_interval} < 30 ); + my $next = gettimeofday() + $dev_hash->{pM_interval}; + + $dev_hash->{pM_update} = FmtDateTime($next); + + Log3 $dev, 5, + "powerMap $dev: next update in " + . $dev_hash->{pM_interval} + . " s at " + . $dev_hash->{pM_update}; + + InternalTimer( $next, "powerMap_update", "$name|$dev" ); + } + else { + Log3 $dev, 5, "powerMap $dev: no power consumption, update paused"; + } + } + + readingsBulkUpdate( $dev_hash, $rname_p, $power ) + if ( defined($power) ); + + readingsEndUpdate( $dev_hash, 1 ); + + return 1; +} + +1; + +# commandref ################################################################### + +=pod +=item helper +=item summary maps power and calculates energy (as Readings) +=item summary_DE leitet Leistung ab und berechnet Energie (als Readings) + +=begin html + + +

powerMap

+(en | de) +
+
    + powerMap will help to determine current power consumption and calculates + energy consumption either when power changes or within regular interval.
    + These new values may be used to collect energy consumption for devices w/o + power meter (e.g. fridge, lightning or FHEM server) and for further processing + using module ElectricityCalculator. +
    + + Define +
      + define <name> powerMap
      + You may only define one single instance of powerMap. +

    + + Get +
      +
    • + devices
      + Lists all devices having set an attribute named 'powerMap'. +
      • +

    + + Readings
    +
      + Device specific readings: +
        +
      • + pM_energy
        + A counter for consumed energy in Wh.
        + Hint: In order to have the calculation working, attribute + timestamp-on-change-reading may not be set for + reading pM_energy! +

        • +
      • + pM_energy_begin
        + Unix timestamp when collection started and device started to consume + energy for the very first time. +

        • +
      • + pM_power
        + Current power consumption of device in W. +
        • +

      +
    + + Attribute +
      +
    • + disable 1
      + No readings will be created or calculated by this module. +

      • +
    • + powerMap_interval <seconds>
      + Interval in seconds to calculate energy.
      + Default value is 900 seconds. +

      • +
    • + powerMap_noEnergy 1
      + No energy consumption will be calculated for that device. +

      • +
    • + powerMap_noPower 1
      + No power consumption will be determined for that device and + consequently no energy consumption at all. +

      • +
    • + powerMap_rname_E
      + Sets reading name for energy consumption.
      + Default value is 'pM_energy'. +

      • +
    • + powerMap_rname_P
      + Sets reading name for power consumption.
      + Default value is 'pM_power'. +

      • +
    • + powerMap
      +        {
+          '<reading>' => {
+            '<value>' => <power>,
+            '<value>' => <power>,
+             ...
+          },
+
+          '<reading>' {
+            '<value>' => <power>,
+            '<value>' => <power>,
+             ...
+          },
+
+          ...
+        }
      +       (device specific)
      + A Hash containing event(=reading) names and possible values of it. Each value can be assigned a + corresponding power consumption.
      + For devices with dimming capability intemediate values will be linearly interpolated. For this + to work two separate numbers will be sufficient.
      +
      + Text values will automatically get any numbers extracted from it and be used for interpolation. + (example: dim50% will automatically be interpreted as 50).
      + In addition "off" and "on" will be translated to 0 and 100 respectively.
      + If the value cannot be interpreted in any way, 0 power consumption will be assumed.
      + Explicitly set definitions in powerMap attribute always get precedence.
      +
      + Example for FS20 socket: +
        + 
        +          'state' => {
+            '0' => 0,
+            '100' => 60,
+          },
+

        +

      + Example for HUE white light bulb: +
        + 
        +          'state' => {
+            'unreachable' => 0,
+            'off' => 0.4,
+            'on' => 9.2,
+          },
+          
+          'pct' => {
+            '0' => 0.4,
+            '10' => 1.2,
+            '20' => 1.7,
+            '30' => 1.9,
+            '40' => 2.3,
+            '50' => 2.7,
+            '60' => 3.4,
+            '70' => 4.7,
+            '80' => 5.9,
+            '90' => 7.5,
+            '100' => 9.2,
+          },
+

        +
      +
      • +
    +
+
+ +=end html + +=begin html_DE + + +

powerMap

+(en | de) +
+
    + powerMap ermittelt die aktuelle Leistungsaufnahme eines Geräts und + berechnet den Energieverbrauch bei Änderung oder in einem + regelmäßigen Intervall.
    + Diese neuen Werte können genutzt werden, um den Stromverbrauch für + Geräte ohne Zähler (z.B. Kühlschrank, Beleuchtung oder + FHEM-Server) zu erfassen und mit dem Modul ElectricityCalculator weiter + zu verarbeiten.
    +
    + + Define +
      + define <name> powerMap
      + Es kann immer nur eine powerMap Instanz definiert sein. +

    + + Get +
      +
    • + devices
      + Listet alle Geräte auf, die das Attribut 'powerMap' gesetzt haben. +
      • +

    + + Readings
    +
      + Gerätespezifische Readings: +
        +
      • + pM_energy
        + Ein Zähler für die bisher bezogene Energie in Wh.
        + Hinweis: Für eine korrekte Berechnung darf das Attribut + timestamp-on-change-reading nicht für das Reading + pM_energy gesetzt sein! +

        • +
      • + pM_energy_begin
        + Unix Timestamp, an dem die Aufzeichnung begonnen wurde und das + Gerät erstmalig Energie verbraucht hat. +

        • +
      • + pM_power
        + Die aktuelle Leistungsaufnahme des Gerätes in W. +
        • +

      +
    + + Attribute +
      +
    • + disable 1
      + Es werden keine Readings mehr durch das Modul erzeugt oder berechnet. +

      • +
    • + powerMap_interval <seconds>
      + Intervall in Sekunden, in dem neue Werte für die Energie berechnet + werden.
      + Der Vorgabewert ist 900 Sekunden. +

      • +
    • + powerMap_noEnergy 1
      + Für das Gerät wird kein Energieverbrauch berechnet. +

      • +
    • + powerMap_noPower 1
      + Für das Gerät wird keine Leistungsaufnahme abgeleitet und + daher auch kein Energieverbrauch berechnet. +

      • +
    • + powerMap_rname_E
      + Definiert den Reading Namen, in dem der Zähler für die bisher + bezogene Energie gespeichert wird.
      + Der Vorgabewert ist 'pM_energy'. +

      • +
    • + powerMap_rname_P
      + Definiert den Reading Namen, in dem die aktuelle Leistungsaufnahme + des Gerätes gespeichert wird.
      + Der Vorgabewert ist 'pM_power'. +

      • +
    • + powerMap
      +        {
+          '<reading>' => {
+            '<value>' => <power>,
+            '<value>' => <power>,
+             ...
+          },
+
+          '<reading>' {
+            '<value>' => <power>,
+            '<value>' => <power>,
+             ...
+          },
+
+          ...
+        }
      +       (gerätespezifisch)
      + Ein Hash mit den Event(=Reading) Namen und seinen möglichen Werten, um diesen + die dazugehörige Leistungsaufnahme zuzuordnen.
      + Bei dimmbaren Geräten wird für die Zwischenschritte der Wert + durch eine lineare Interpolation ermittelt, so dass mindestens zwei Zahlenwerte ausreichen.
      +
      + Aus Textwerten, die eine Zahl enthalten, wird automatisch die Zahl extrahiert und + für die Interpolation verwendet (Beispiel: dim50% wird automatisch als 50 interpretiert).
      + Außerdem werden "off" und "on" automatisch als 0 respektive 100 interpretiert.
      + Nicht interpretierbare Werte führen dazu, dass eine Leistungsaufnahme von 0 angenommen wird.
      + Explizit in powerMap enthaltene Definitionen haben immer vorrang.
      +
      + Beispiel für einen FS20 Stecker: +
        + 
        +          'state' => {
+            '0' => 0,
+            '100' => 60,
+          },
+

        +

      + Beispiel für eine HUE white Glühlampe: +
        + 
        +          'state' => {
+            'unreachable' => 0,
+            'off' => 0.4,
+            'on' => 9.2,
+          },
+          
+          'pct' => {
+            '0' => 0.4,
+            '10' => 1.2,
+            '20' => 1.7,
+            '30' => 1.9,
+            '40' => 2.3,
+            '50' => 2.7,
+            '60' => 3.4,
+            '70' => 4.7,
+            '80' => 5.9,
+            '90' => 7.5,
+            '100' => 9.2,
+          },
+

        +
      +
      • +
    +
+
+ +=end html_DE +=cut diff --git a/fhem/HISTORY b/fhem/HISTORY index acd7bd1d5..ba2745c1f 100644 --- a/fhem/HISTORY +++ b/fhem/HISTORY @@ -721,3 +721,5 @@ - adding new module: 21_VBUSDEV: new locical Device to connect to different Resol and compatible VBUS Devices via VBUSIF.pm +- Mon Jan 16 2017 (loredo) + - adding new module 98_powerMap diff --git a/fhem/MAINTAINER.txt b/fhem/MAINTAINER.txt index bf820dff4..2e6f57b2c 100644 --- a/fhem/MAINTAINER.txt +++ b/fhem/MAINTAINER.txt @@ -399,6 +399,7 @@ FHEM/98_MaxScanner.pm john http://forum.fhem.de MAX FHEM/98_notice.pm mfr69bs http://forum.fhem.de Sonstiges FHEM/98_pilight.pm andreas-fey http://forum.fhem.de Unterstuetzende Dienste FHEM/98_ping mattwire http://forum.fhem.de Sonstiges +FHEM/98_powerMap loredo http://forum.fhem.de Unterstuetzende Dienste FHEM/98_rain.pm baumrasen http://forum.fhem.de Sonstiges FHEM/98_restore.pm rudolfkoenig http://forum.fhem.de Sonstiges FHEM/98_rssFeed.pm Benni http://forum.fhem.de Unterstuetzende Dienste