################################################################################################ # $Id: 77_SMAEM.pm 19460 2019-05-24 20:19:41Z DS_Starter $ # # Copyright notice # # (c) 2016 Copyright: Volker Kettenbach # e-mail: volker at kettenbach minus it dot de # # Credits: # - DS_Starter (Heiko) for persistent readings # and various improvements # # Description: # This is an FHEM-Module for the SMA Energy Meter, # a bidirectional energy meter/counter used in photovoltaics # # Requirements: # This module requires: # - Perl Module: IO::Socket::Multicast # On a Debian (based) system, these requirements can be fullfilled by: # - apt-get install install libio-socket-multicast-perl # # Origin: # https://gitlab.com/volkerkettenbach/FHEM-SMA-Speedwire # ################################################################################################# package main; use strict; use warnings; use bignum; use IO::Socket::Multicast; use Blocking; eval "use FHEM::Meta;1" or my $modMetaAbsent = 1; # Versions History done by DS_Starter our %SMAEM_vNotesIntern = ( "3.5.0" => "12.12.2019 support of SMA Homemanager 2.0 >= 2.03.4.R, attributes \"firmwareVersion\", \"serialNumber\" ", "3.4.0" => "22.05.2019 support of Installer.pm/Meta.pm added, new version maintenance, commandref revised ", "3.3.0" => "21.05.2019 set reset to delete and reinitialize cacheFile, support of DelayedShutdownFn ", "3.2.0" => "26.07.2018 log entry enhanced if diff overflow ", "3.1.0" => "12.02.2018 extend error handling in define ", "3.0.1" => "26.11.2017 use abort cause of BlockingCall ", "3.0.0" => "29.09.2017 make SMAEM ready for multimeter usage ", "2.9.1" => "29.05.2017 DbLog_splitFn added, some function names adapted ", "2.9.0" => "25.05.2017 own SMAEM_setCacheValue, SMAEM_getCacheValue, new internal VERSION ", "2.8.2" => "03.12.2016 Prefix SMAEMserialnumber for Reading \"state\" removed, commandref adapted ", "2.8.1" => "02.12.2016 encode / decode \$data ", "2.8.0" => "02.12.2016 plausibility check of measured differences, attr diffAccept, timeout ". "validation checks, improvement of failure prevention ", "2.7.0" => "01.12.2016 logging of discarded cycles ", "2.6.0" => "01.12.2016 some improvements, better logging possibility ", "2.5.0" => "30.11.2016 some improvements ", "2.4.0" => "30.11.2016 some improvements, attributes disable, timeout for BlockingCall added ", "2.3.0" => "30.11.2016 SMAEM_getsum, SMAEM_setsum changed ", "2.2.0" => "29.11.2016 check error while writing values to file -> set state with error ", "2.1.0" => "29.11.2016 move \$hash->{GRIDin_SUM}, \$hash->{GRIDOUT_SUM} calc to smaread_ParseDone, ". "some little improvements to logging process", "2.0.0" => "28.11.2016 switch to nonblocking " ); ############################################################### # SMAEM Initialize ############################################################### sub SMAEM_Initialize ($) { my ($hash) = @_; $hash->{ReadFn} = "SMAEM_Read"; $hash->{SetFn} = "SMAEM_Set"; $hash->{DefFn} = "SMAEM_Define"; $hash->{UndefFn} = "SMAEM_Undef"; $hash->{DeleteFn} = "SMAEM_Delete"; $hash->{DbLog_splitFn} = "SMAEM_DbLog_splitFn"; $hash->{DelayedShutdownFn} = "SMAEM_DelayedShutdown"; $hash->{AttrFn} = "SMAEM_Attr"; $hash->{AttrList} = "interval ". "disable:1,0 ". "diffAccept ". "disableSernoInReading:1,0 ". "feedinPrice ". # "firmwareVersion:>=#2.03.4.R ". "powerCost ". "serialNumber ". "timeout ". "$readingFnAttributes"; eval { FHEM::Meta::InitMod( __FILE__, $hash ) }; # für Meta.pm (https://forum.fhem.de/index.php/topic,97589.0.html) return; } ############################################################### # SMAEM Define ############################################################### sub SMAEM_Define ($$) { my ($hash, $def) = @_; my $name= $hash->{NAME}; my ($success, $gridin_sum, $gridout_sum); my $socket; $hash->{INTERVAL} = 60; $hash->{HELPER}{FAULTEDCYCLES} = 0; $hash->{HELPER}{STARTTIME} = time(); Log3 $hash, 3, "SMAEM $name - Opening multicast socket..."; eval { $socket = IO::Socket::Multicast->new( Proto => 'udp', LocalPort => '9522', ReuseAddr => '1', ReusePort => defined(&ReusePort) ? 1 : 0, ); }; if($@) { Log3 $hash, 1, "SMAEM $name - Can't bind: $@"; return; } Log3 $hash, 3, "SMAEM $name - Multicast socket opened"; $socket->mcast_add('239.12.255.254'); $hash->{TCPDev} = $socket; $hash->{FD} = $socket->fileno(); delete($readyfnlist{"$name"}); $selectlist{"$name"} = $hash; $hash->{HELPER}{MODMETAABSENT} = 1 if($modMetaAbsent); # Modul Meta.pm nicht vorhanden # Versionsinformationen setzen SMAEM_setVersionInfo($hash); # gespeicherte Serialnummern lesen und extrahieren my $retcode = SMAEM_getserials($hash); $hash->{HELPER}{READFILEERROR} = $retcode if($retcode); if($hash->{HELPER}{ALLSERIALS}) { my @allserials = split(/_/,$hash->{HELPER}{ALLSERIALS}); foreach(@allserials) { my $smaserial = $_; # gespeicherte Energiezählerwerte von File einlesen my $retcode = SMAEM_getsum($hash,$smaserial); $hash->{HELPER}{READFILEERROR} = $retcode if($retcode); } } return undef; } ############################################################### # SMAEM Undefine ############################################################### sub SMAEM_Undef ($$) { my ($hash, $arg) = @_; my $name= $hash->{NAME}; my $socket= $hash->{TCPDev}; BlockingKill($hash->{HELPER}{RUNNING_PID}) if(defined($hash->{HELPER}{RUNNING_PID})); Log3 $hash, 3, "SMAEM $name - Closing multicast socket..."; $socket->mcast_drop('239.12.255.254'); my $ret = close($hash->{TCPDev}); Log3 $hash, 4, "SMAEM $name - Close-ret: $ret"; delete($hash->{TCPDev}); delete($selectlist{"$name"}); delete($hash->{FD}); return; } ############################################################### # SMAEM Delete ############################################################### sub SMAEM_Delete ($$) { my ($hash, $arg) = @_; my $index = $hash->{TYPE}."_".$hash->{NAME}."_energysum"; # gespeicherte Energiezählerwerte löschen setKeyValue($index, undef); return undef; } ####################################################################################################### # Mit der X_DelayedShutdown Funktion kann eine Definition das Stoppen von FHEM verzögern um asynchron # hinter sich aufzuräumen. # Je nach Rückgabewert $delay_needed wird der Stopp von FHEM verzögert (0|1). # Sobald alle nötigen Maßnahmen erledigt sind, muss der Abschluss mit CancelDelayedShutdown($name) an # FHEM zurückgemeldet werden. ####################################################################################################### sub SMAEM_DelayedShutdown ($) { my ($hash) = @_; my $name = $hash->{NAME}; if($hash->{HELPER}{RUNNING_PID}) { Log3($name, 2, "$name - Quit background process due to shutdown ..."); return 1; } return 0; } ############################################################### # SMAEM Set ############################################################### sub SMAEM_Set ($@) { my ($hash, @a) = @_; return "\"set X\" needs at least an argument" if ( @a < 2 ); my $name = $a[0]; my $opt = $a[1]; my $setlist = "Unknown argument $opt, choose one of ". "reset:noArg " ; if ($opt eq "reset") { delete $hash->{HELPER}{ALLSERIALS}; #delete $hash->{'GRIDIN_SUM_'.$smaserial}; #delete $hash->{'GRIDOUT_SUM_'.$smaserial}; BlockingKill($hash->{HELPER}{RUNNING_PID}) if(defined($hash->{HELPER}{RUNNING_PID})); my $result = unlink $attr{global}{modpath}."/FHEM/FhemUtils/cacheSMAEM"; if ($result) { $result = "Cachefile ".$attr{global}{modpath}."/FHEM/FhemUtils/cacheSMAEM deleted. It will be initialized immediately."; } else { $result = "Error while deleting Cachefile ".$attr{global}{modpath}."/FHEM/FhemUtils/cacheSMAEM: $!"; } Log3 ($name, 3, "SMAEM $name - $result"); return $result; } else { return "$setlist"; } return; } ############################################################### # SMAEM Attr ############################################################### sub SMAEM_Attr ($$$$) { my ($cmd,$name,$aName,$aVal) = @_; my $hash = $defs{$name}; my $do; # $cmd can be "del" or "set" # $name is device name # aName and aVal are Attribute name and value if ($aName eq "interval") { if($cmd eq "set") { $hash->{INTERVAL} = $aVal; } else { $hash->{INTERVAL} = "60"; } } if ($aName eq "disableSernoInReading") { delete $defs{$name}{READINGS}; readingsSingleUpdate($hash, "state", "initialized", 1); } if ($aName eq "timeout" || $aName eq "diffAccept") { unless ($aVal =~ /^[0-9]+$/) { return " The Value of $aName is not valid. Use only figures 0-9 without decimal places !";} } if ($aName eq "disable") { if($cmd eq "set") { $do = ($aVal) ? 1 : 0; } $do = 0 if($cmd eq "del"); my $val = ($do == 1 ? "disabled" : "initialized"); readingsSingleUpdate($hash, "state", $val, 1); } return undef; } ############################################################### # SMAEM Read (Hauptschleife) ############################################################### # called from the global loop, when the select for hash->{FD} reports data sub SMAEM_Read ($) { my ($hash) = @_; my $name = $hash->{NAME}; my $socket = $hash->{TCPDev}; my $timeout = AttrVal($name, "timeout", 60); # my $fw = AttrVal($name, "firmwareVersion", "1.02.04.R"); my $refsn = AttrVal($name, "serialNumber", ""); my $data; return if(IsDisabled($name)); # if($fw eq "1.02.04.R") { # return unless $socket->recv($data, 600); # Each SMAEM packet is 600 bytes of packed payload # } elsif ($fw eq ">= 2.03.4.R") { # return unless $socket->recv($data, 608); # Each packet of HM with FW >= 2.03.4.R is 608 bytes of packed payload # } $socket->recv($data, 608); my $dl = length($data); if($dl == 600) { $hash->{FIRMWARE} = "1.02.04.R"; } elsif($dl == 608) { $hash->{FIRMWARE} = ">= 2.03.4.R"; } else { Log3 ($name, 1, "SMAEM $name - Buffer length ".$dl." is invalid. Don't parse it."); return; } return if (time() <= $hash->{HELPER}{STARTTIME}+30); # decode serial number of dataset received my $hex = unpack('H*', $data); my $smaserial = hex(substr($hex,40,8)); return if(!$smaserial); return if($refsn && $refsn ne $smaserial); # nur selektiv eine EM mit angegebener Serial lesen (default: alle) # alle Serialnummern in HELPER sammeln und ggf. speichern if(!defined($hash->{HELPER}{ALLSERIALS}) || $hash->{HELPER}{ALLSERIALS} !~ /$smaserial/) { my $sep = $hash->{HELPER}{ALLSERIALS}?"_":undef; if($sep) { $hash->{HELPER}{ALLSERIALS} = $hash->{HELPER}{ALLSERIALS}.$sep.$smaserial; } else { $hash->{HELPER}{ALLSERIALS} = $smaserial; } SMAEM_setserials($hash); } if ( !$hash->{HELPER}{'LASTUPDATE_'.$smaserial} || time() >= ($hash->{HELPER}{'LASTUPDATE_'.$smaserial}+$hash->{INTERVAL}) ) { Log3 ($name, 4, "SMAEM $name - ###############################################################"); Log3 ($name, 4, "SMAEM $name - ### Begin of new SMA Energymeter $smaserial get data cycle ###"); Log3 ($name, 4, "SMAEM $name - ###############################################################"); Log3 ($name, 4, "SMAEM $name - discarded cycles since module start: $hash->{HELPER}{FAULTEDCYCLES}"); if($hash->{HELPER}{RUNNING_PID}) { Log3 ($name, 3, "SMAEM $name - WARNING - old process $hash->{HELPER}{RUNNING_PID}{pid} has been killed to start a new BlockingCall"); BlockingKill($hash->{HELPER}{RUNNING_PID}); delete($hash->{HELPER}{RUNNING_PID}); } # update time SMAEM_setlastupdate($hash,$smaserial); my $dataenc = encode_base64($data,""); $hash->{HELPER}{RUNNING_PID} = BlockingCall("SMAEM_DoParse", "$name|$dataenc|$smaserial", "SMAEM_ParseDone", $timeout, "SMAEM_ParseAborted", $hash); Log3 ($name, 4, "SMAEM $name - Blocking process with PID: $hash->{HELPER}{RUNNING_PID}{pid} started"); } else { Log3 $hash, 5, "SMAEM $name: - received " . length($data) . " bytes but interval $hash->{INTERVAL}s isn't expired."; } return undef; } ############################################################### # non-blocking Inverter Datenabruf ############################################################### sub SMAEM_DoParse ($) { my ($string) = @_; my ($name,$dataenc,$smaserial) = split("\\|", $string); my $hash = $defs{$name}; my $data = decode_base64($dataenc); my $discycles = $hash->{HELPER}{FAULTEDCYCLES}; my $diffaccept = AttrVal($name, "diffAccept", 10); my $fw = $hash->{FIRMWARE}; my ($error,@row_array,@array); Log3 ($name, 4, "SMAEM $name -> Start BlockingCall SMAEM_DoParse"); my $gridinsum = $hash->{'GRIDIN_SUM_'.$smaserial} ?sprintf("%.4f",$hash->{'GRIDIN_SUM_'.$smaserial}):''; my $gridoutsum = $hash->{'GRIDOUT_SUM_'.$smaserial}?sprintf("%.4f",$hash->{'GRIDOUT_SUM_'.$smaserial}):''; # check if cacheSMAEM-file has been opened at module start and try again if not if($hash->{HELPER}{READFILEERROR}) { my $retcode = SMAEM_getsum($hash,$smaserial); if ($retcode) { $error = encode_base64($retcode,""); Log3 ($name, 4, "SMAEM $name -> BlockingCall SMAEM_DoParse finished"); $discycles++; return "$name|''|''|''|$error|$discycles|''"; } else { delete($hash->{HELPER}{READFILEERROR}) } } # Format of the udp packets of the SMAEM: # http://www.sma.de/fileadmin/content/global/Partner/Documents/SMA_Labs/EMETER-Protokoll-TI-de-10.pdf # http://www.eb-systeme.de/?page_id=1240 # Conversion like in this python code: # http://www.unifox.at/sma_energy_meter/ # https://github.com/datenschuft/SMA-EM # unpack big-endian to 2-digit hex (bin2hex) my $hex = unpack('H*', $data); ################ Aufbau Ergebnis-Array #################### # Extract datasets from hex: # Generic: my $susyid = hex(substr($hex,36,4)); my $milliseconds = hex(substr($hex,48,8)); # Prestring with SMAEM and SERIALNO or not my $ps = (!AttrVal($name, "disableSernoInReading", undef)) ? "SMAEM".$smaserial."_" : ""; # Entscheidung ob EM/HM2.0 mit Firmware >= 2.03.4.R my $offset = 0; if ($fw eq ">= 2.03.4.R") { $offset = 16; } # Counter Divisor: [Hex-Value]=Ws => Ws/1000*3600=kWh => divide by 3600000 # Sum L1-3 my $bezug_wirk = hex(substr($hex,64,8))/10; my $bezug_wirk_count = hex(substr($hex,80,16))/3600000; my $einspeisung_wirk = hex(substr($hex,104,8))/10; my $einspeisung_wirk_count = hex(substr($hex,120,16))/3600000; # calculation of GRID-hashes and persist to file Log3 ($name, 4, "SMAEM $name - old GRIDIN_SUM_$smaserial got from RAM: $gridinsum"); Log3 ($name, 4, "SMAEM $name - old GRIDOUT_SUM_$smaserial got from RAM: $gridoutsum"); my $plausibility_out = 0; if( !$gridoutsum || ($bezug_wirk_count && $bezug_wirk_count < $gridoutsum) ) { $gridoutsum = $bezug_wirk_count; Log3 ($name, 4, "SMAEM $name - gridoutsum_$smaserial new set: $gridoutsum"); } else { if ($gridoutsum && $bezug_wirk_count >= $gridoutsum) { if(($bezug_wirk_count - $gridoutsum) <= $diffaccept) { # Plausibilitätscheck ob Differenz kleiner als erlaubter Wert -> Fehlerprävention my $diffb = ($bezug_wirk_count - $gridoutsum)>0 ? sprintf("%.4f",$bezug_wirk_count - $gridoutsum) : 0; Log3 ($name, 4, "SMAEM $name - bezug_wirk_count: $bezug_wirk_count"); Log3 ($name, 4, "SMAEM $name - gridoutsum_$smaserial: $gridoutsum"); Log3 ($name, 4, "SMAEM $name - diffb: $diffb"); $gridoutsum = $bezug_wirk_count; push(@row_array, $ps."Bezug_WirkP_Zaehler_Diff ".$diffb."\n"); push(@row_array, $ps."Bezug_WirkP_Kosten_Diff ".sprintf("%.4f", $diffb*AttrVal($name, "powerCost", 0))."\n"); $plausibility_out = 1; } else { # Zyklus verwerfen wenn Plausibilität nicht erfüllt my $d = $bezug_wirk_count - $gridoutsum; my $errtxt = "Cycle discarded due to allowed diff \"$d\" GRIDOUT exceeding. \n". "Try to set attribute \"diffAccept > $d\" temporary or execute \"reset\"."; $error = encode_base64($errtxt,""); Log3 ($name, 1, "SMAEM $name - $errtxt"); Log3 ($name, 4, "SMAEM $name -> BlockingCall SMAEM_DoParse finished"); $gridinsum = $einspeisung_wirk_count; $gridoutsum = $bezug_wirk_count; $discycles++; return "$name|''|$gridinsum|$gridoutsum|$error|$discycles|''"; } } } my $plausibility_in = 0; if( !$gridinsum || ($einspeisung_wirk_count && $einspeisung_wirk_count < $gridinsum) ) { $gridinsum = $einspeisung_wirk_count; Log3 ($name, 4, "SMAEM $name - gridinsum_$smaserial new set: $gridinsum"); } else { if ($gridinsum && $einspeisung_wirk_count >= $gridinsum) { if(($einspeisung_wirk_count - $gridinsum) <= $diffaccept) { # Plausibilitätscheck ob Differenz kleiner als erlaubter Wert -> Fehlerprävention my $diffe = ($einspeisung_wirk_count - $gridinsum)>0 ? sprintf("%.4f",$einspeisung_wirk_count - $gridinsum) : 0; Log3 ($name, 4, "SMAEM $name - einspeisung_wirk_count: $einspeisung_wirk_count"); Log3 ($name, 4, "SMAEM $name - gridinsum_$smaserial: $gridinsum"); Log3 ($name, 4, "SMAEM $name - diffe: $diffe"); $gridinsum = $einspeisung_wirk_count; push(@row_array, $ps."Einspeisung_WirkP_Zaehler_Diff ".$diffe."\n"); push(@row_array, $ps."Einspeisung_WirkP_Verguet_Diff ".sprintf("%.4f", $diffe*AttrVal($name, "feedinPrice", 0))."\n"); $plausibility_in = 1; } else { # Zyklus verwerfen wenn Plausibilität nicht erfüllt my $d = $einspeisung_wirk_count - $gridinsum; my $errtxt = "Cycle discarded due to allowed diff \"$d\" GRIDIN exceeding. \n". "Try to set attribute \"diffAccept > $d\" temporary or execute \"reset\"."; $error = encode_base64($errtxt,""); Log3 ($name, 1, "SMAEM $name - $errtxt"); Log3 ($name, 4, "SMAEM $name -> BlockingCall SMAEM_DoParse finished"); $gridinsum = $einspeisung_wirk_count; $gridoutsum = $bezug_wirk_count; $discycles++; return "$name|''|$gridinsum|$gridoutsum|$error|$discycles|''"; } } } # write GRIDIN_SUM and GRIDOUT_SUM to file if plausibility check ok Log3 ($name, 4, "SMAEM $name - plausibility check done: GRIDIN -> $plausibility_in, GRIDOUT -> $plausibility_out"); my $retcode = SMAEM_setsum($hash,$smaserial,$gridinsum,$gridoutsum) if($plausibility_in && $plausibility_out); # error while writing values to file if ($retcode) { $error = encode_base64($retcode,""); Log3 ($name, 4, "SMAEM $name -> BlockingCall SMAEM_DoParse finished"); $discycles++; return "$name|''|''|''|$error|$discycles|''"; } push(@row_array, "state ".sprintf("%.1f", $einspeisung_wirk-$bezug_wirk)."\n"); push(@row_array, $ps."Saldo_Wirkleistung ".sprintf("%.1f",$einspeisung_wirk-$bezug_wirk)."\n"); push(@row_array, $ps."Saldo_Wirkleistung_Zaehler ".sprintf("%.1f",$einspeisung_wirk_count-$bezug_wirk_count)."\n"); push(@row_array, $ps."Bezug_Wirkleistung ".sprintf("%.1f",$bezug_wirk)."\n"); push(@row_array, $ps."Bezug_Wirkleistung_Zaehler ".sprintf("%.4f",$bezug_wirk_count)."\n"); push(@row_array, $ps."Einspeisung_Wirkleistung ".sprintf("%.1f",$einspeisung_wirk)."\n"); push(@row_array, $ps."Einspeisung_Wirkleistung_Zaehler ".sprintf("%.4f",$einspeisung_wirk_count)."\n"); my $bezug_blind=hex(substr($hex,144,8))/10; my $bezug_blind_count=hex(substr($hex,160,16))/3600000; my $einspeisung_blind=hex(substr($hex,184,8))/10; my $einspeisung_blind_count=hex(substr($hex,200,16))/3600000; push(@row_array, $ps."Bezug_Blindleistung ".sprintf("%.1f",$bezug_blind)."\n"); push(@row_array, $ps."Bezug_Blindleistung_Zaehler ".sprintf("%.1f",$bezug_blind_count)."\n"); push(@row_array, $ps."Einspeisung_Blindleistung ".sprintf("%.1f",$einspeisung_blind)."\n"); push(@row_array, $ps."Einspeisung_Blindleistung_Zaehler ".sprintf("%.1f",$einspeisung_blind_count)."\n"); my $bezug_schein=hex(substr($hex,224,8))/10; my $bezug_schein_count=hex(substr($hex,240,16))/3600000; my $einspeisung_schein=hex(substr($hex,264,8))/10; my $einspeisung_schein_count=hex(substr($hex,280,16))/3600000; push(@row_array, $ps."Bezug_Scheinleistung ".sprintf("%.1f",$bezug_schein)."\n"); push(@row_array, $ps."Bezug_Scheinleistung_Zaehler ".sprintf("%.1f",$bezug_schein_count)."\n"); push(@row_array, $ps."Einspeisung_Scheinleistung ".sprintf("%.1f",$einspeisung_schein)."\n"); push(@row_array, $ps."Einspeisung_Scheinleistung_Zaehler ".sprintf("%.1f",$einspeisung_schein_count)."\n"); my $cosphi=hex(substr($hex,304,8))/1000; push(@row_array, $ps."CosPhi ".sprintf("%.3f",$cosphi)."\n"); # L1 my $l1_bezug_wirk = hex(substr($hex,320+$offset,8))/10; my $l1_bezug_wirk_count = hex(substr($hex,336+$offset,16))/3600000; my $l1_einspeisung_wirk = hex(substr($hex,360+$offset,8))/10; my $l1_einspeisung_wirk_count = hex(substr($hex,376+$offset,16))/3600000; push(@row_array, $ps."L1_Saldo_Wirkleistung ".sprintf("%.1f",$l1_einspeisung_wirk-$l1_bezug_wirk)."\n"); push(@row_array, $ps."L1_Saldo_Wirkleistung_Zaehler ".sprintf("%.1f",$l1_einspeisung_wirk_count-$l1_bezug_wirk_count)."\n"); push(@row_array, $ps."L1_Bezug_Wirkleistung ".sprintf("%.1f",$l1_bezug_wirk)."\n"); push(@row_array, $ps."L1_Bezug_Wirkleistung_Zaehler ".sprintf("%.1f",$l1_bezug_wirk_count)."\n"); push(@row_array, $ps."L1_Einspeisung_Wirkleistung ".sprintf("%.1f",$l1_einspeisung_wirk)."\n"); push(@row_array, $ps."L1_Einspeisung_Wirkleistung_Zaehler ".sprintf("%.1f",$l1_einspeisung_wirk_count)."\n"); my $l1_bezug_blind = hex(substr($hex,400+$offset,8))/10; my $l1_bezug_blind_count = hex(substr($hex,416+$offset,16))/3600000; my $l1_einspeisung_blind = hex(substr($hex,440+$offset,8))/10; my $l1_einspeisung_blind_count = hex(substr($hex,456+$offset,16))/3600000; push(@row_array, $ps."L1_Bezug_Blindleistung ".sprintf("%.1f",$l1_bezug_blind)."\n"); push(@row_array, $ps."L1_Bezug_Blindleistung_Zaehler ".sprintf("%.1f",$l1_bezug_blind_count)."\n"); push(@row_array, $ps."L1_Einspeisung_Blindleistung ".sprintf("%.1f",$l1_einspeisung_blind)."\n"); push(@row_array, $ps."L1_Einspeisung_Blindleistung_Zaehler ".sprintf("%.1f",$l1_einspeisung_blind_count)."\n"); my $l1_bezug_schein = hex(substr($hex,480+$offset,8))/10; my $l1_bezug_schein_count = hex(substr($hex,496+$offset,16))/3600000; my $l1_einspeisung_schein = hex(substr($hex,520+$offset,8))/10; my $l1_einspeisung_schein_count = hex(substr($hex,536+$offset,16))/3600000; push(@row_array, $ps."L1_Bezug_Scheinleistung ".sprintf("%.1f",$l1_bezug_schein)."\n"); push(@row_array, $ps."L1_Bezug_Scheinleistung_Zaehler ".sprintf("%.1f",$l1_bezug_schein_count)."\n"); push(@row_array, $ps."L1_Einspeisung_Scheinleistung ".sprintf("%.1f",$l1_einspeisung_schein)."\n"); push(@row_array, $ps."L1_Einspeisung_Scheinleistung_Zaehler ".sprintf("%.1f",$l1_einspeisung_schein_count)."\n"); my $l1_thd = hex(substr($hex,560+$offset,8))/1000; my $l1_v = hex(substr($hex,576+$offset,8))/1000; my $l1_cosphi = hex(substr($hex,592+$offset,8))/1000; push(@row_array, $ps."L1_THD ".sprintf("%.2f",$l1_thd)."\n"); push(@row_array, $ps."L1_Spannung ".sprintf("%.1f",$l1_v)."\n"); push(@row_array, $ps."L1_CosPhi ".sprintf("%.3f",$l1_cosphi)."\n"); # L2 my $l2_bezug_wirk = hex(substr($hex,608+$offset,8))/10; my $l2_bezug_wirk_count = hex(substr($hex,624+$offset,16))/3600000; my $l2_einspeisung_wirk = hex(substr($hex,648+$offset,8))/10; my $l2_einspeisung_wirk_count = hex(substr($hex,664+$offset,16))/3600000; push(@row_array, $ps."L2_Saldo_Wirkleistung ".sprintf("%.1f",$l2_einspeisung_wirk-$l2_bezug_wirk)."\n"); push(@row_array, $ps."L2_Saldo_Wirkleistung_Zaehler ".sprintf("%.1f",$l2_einspeisung_wirk_count-$l2_bezug_wirk_count)."\n"); push(@row_array, $ps."L2_Bezug_Wirkleistung ".sprintf("%.1f",$l2_bezug_wirk)."\n"); push(@row_array, $ps."L2_Bezug_Wirkleistung_Zaehler ".sprintf("%.1f",$l2_bezug_wirk_count)."\n"); push(@row_array, $ps."L2_Einspeisung_Wirkleistung ".sprintf("%.1f",$l2_einspeisung_wirk)."\n"); push(@row_array, $ps."L2_Einspeisung_Wirkleistung_Zaehler ".sprintf("%.1f",$l2_einspeisung_wirk_count)."\n"); my $l2_bezug_blind = hex(substr($hex,688+$offset,8))/10; my $l2_bezug_blind_count = hex(substr($hex,704+$offset,16))/3600000; my $l2_einspeisung_blind = hex(substr($hex,728+$offset,8))/10; my $l2_einspeisung_blind_count = hex(substr($hex,744+$offset,16))/3600000; push(@row_array, $ps."L2_Bezug_Blindleistung ".sprintf("%.1f",$l2_bezug_blind)."\n"); push(@row_array, $ps."L2_Bezug_Blindleistung_Zaehler ".sprintf("%.1f",$l2_bezug_blind_count)."\n"); push(@row_array, $ps."L2_Einspeisung_Blindleistung ".sprintf("%.1f",$l2_einspeisung_blind)."\n"); push(@row_array, $ps."L2_Einspeisung_Blindleistung_Zaehler ".sprintf("%.1f",$l2_einspeisung_blind_count)."\n"); my $l2_bezug_schein = hex(substr($hex,768+$offset,8))/10; my $l2_bezug_schein_count = hex(substr($hex,784+$offset,16))/3600000; my $l2_einspeisung_schein = hex(substr($hex,808+$offset,8))/10; my $l2_einspeisung_schein_count = hex(substr($hex,824+$offset,16))/3600000; push(@row_array, $ps."L2_Bezug_Scheinleistung ".sprintf("%.1f",$l2_bezug_schein)."\n"); push(@row_array, $ps."L2_Bezug_Scheinleistung_Zaehler ".sprintf("%.1f",$l2_bezug_schein_count)."\n"); push(@row_array, $ps."L2_Einspeisung_Scheinleistung ".sprintf("%.1f",$l2_einspeisung_schein)."\n"); push(@row_array, $ps."L2_Einspeisung_Scheinleistung_Zaehler ".sprintf("%.1f",$l2_einspeisung_schein_count)."\n"); my $l2_thd = hex(substr($hex,848+$offset,8))/1000; my $l2_v = hex(substr($hex,864+$offset,8))/1000; my $l2_cosphi = hex(substr($hex,880+$offset,8))/1000; push(@row_array, $ps."L2_THD ".sprintf("%.2f",$l2_thd)."\n"); push(@row_array, $ps."L2_Spannung ".sprintf("%.1f",$l2_v)."\n"); push(@row_array, $ps."L2_CosPhi ".sprintf("%.3f",$l2_cosphi)."\n"); # L3 my $l3_bezug_wirk = hex(substr($hex,896+$offset,8))/10; my $l3_bezug_wirk_count = hex(substr($hex,912+$offset,16))/3600000; my $l3_einspeisung_wirk = hex(substr($hex,936+$offset,8))/10; my $l3_einspeisung_wirk_count = hex(substr($hex,952+$offset,16))/3600000; push(@row_array, $ps."L3_Saldo_Wirkleistung ".sprintf("%.1f",$l3_einspeisung_wirk-$l3_bezug_wirk)."\n"); push(@row_array, $ps."L3_Saldo_Wirkleistung_Zaehler ".sprintf("%.1f",$l3_einspeisung_wirk_count-$l3_bezug_wirk_count)."\n"); push(@row_array, $ps."L3_Bezug_Wirkleistung ".sprintf("%.1f",$l3_bezug_wirk)."\n"); push(@row_array, $ps."L3_Bezug_Wirkleistung_Zaehler ".sprintf("%.1f",$l3_bezug_wirk_count)."\n"); push(@row_array, $ps."L3_Einspeisung_Wirkleistung ".sprintf("%.1f",$l3_einspeisung_wirk)."\n"); push(@row_array, $ps."L3_Einspeisung_Wirkleistung_Zaehler ".sprintf("%.1f",$l3_einspeisung_wirk_count)."\n"); my $l3_bezug_blind = hex(substr($hex,976+$offset,8))/10; my $l3_bezug_blind_count = hex(substr($hex,992+$offset,16))/3600000; my $l3_einspeisung_blind = hex(substr($hex,1016+$offset,8))/10; my $l3_einspeisung_blind_count = hex(substr($hex,1032+$offset,16))/3600000; push(@row_array, $ps."L3_Bezug_Blindleistung ".sprintf("%.1f",$l3_bezug_blind)."\n"); push(@row_array, $ps."L3_Bezug_Blindleistung_Zaehler ".sprintf("%.1f",$l3_bezug_blind_count)."\n"); push(@row_array, $ps."L3_Einspeisung_Blindleistung ".sprintf("%.1f",$l3_einspeisung_blind)."\n"); push(@row_array, $ps."L3_Einspeisung_Blindleistung_Zaehler ".sprintf("%.1f",$l3_einspeisung_blind_count)."\n"); my $l3_bezug_schein = hex(substr($hex,1056+$offset,8))/10; my $l3_bezug_schein_count = hex(substr($hex,1072+$offset,16))/3600000; my $l3_einspeisung_schein = hex(substr($hex,1096+$offset,8))/10; my $l3_einspeisung_schein_count = hex(substr($hex,1112+$offset,16))/3600000; push(@row_array, $ps."L3_Bezug_Scheinleistung ".sprintf("%.1f",$l3_bezug_schein)."\n"); push(@row_array, $ps."L3_Bezug_Scheinleistung_Zaehler ".sprintf("%.1f",$l3_bezug_schein_count)."\n"); push(@row_array, $ps."L3_Einspeisung_Scheinleistung ".sprintf("%.1f",$l3_einspeisung_schein)."\n"); push(@row_array, $ps."L3_Einspeisung_Scheinleistung_Zaehler ".sprintf("%.1f",$l3_einspeisung_schein_count)."\n"); my $l3_thd = hex(substr($hex,1136+$offset,8))/1000; my $l3_v = hex(substr($hex,1152+$offset,8))/1000; my $l3_cosphi = hex(substr($hex,1168+$offset,8))/1000; push(@row_array, $ps."L3_THD ".sprintf("%.2f",$l3_thd)."\n"); push(@row_array, $ps."L3_Spannung ".sprintf("%.1f",$l3_v)."\n"); push(@row_array, $ps."L3_CosPhi ".sprintf("%.3f",$l3_cosphi)."\n"); Log3 ($name, 5, "$name - row_array before encoding:"); foreach my $row (@row_array) { chomp $row; Log3 ($name, 5, "SMAEM $name - $row"); } # encoding result my $rowlist = join('_ESC_', @row_array); $rowlist = encode_base64($rowlist,""); Log3 ($name, 4, "SMAEM $name -> BlockingCall SMAEM_DoParse finished"); return "$name|$rowlist|$gridinsum|$gridoutsum|''|$discycles|$smaserial"; } ############################################################### # Auswertung non-blocking Inverter Datenabruf ############################################################### sub SMAEM_ParseDone ($) { my ($string) = @_; my @a = split("\\|",$string); my $name = $a[0]; my $hash = $defs{$name}; my $rowlist = decode_base64($a[1]); my $gridinsum = $a[2]; my $gridoutsum = $a[3]; my $error = decode_base64($a[4]) if($a[4]); my $discycles = $a[5]; my $smaserial = $a[6]; Log3 ($name, 4, "SMAEM $name -> Start BlockingCall SMAEM_ParseDone"); $hash->{HELPER}{FAULTEDCYCLES} = $discycles; # update time SMAEM_setlastupdate($hash,$smaserial); if ($error) { readingsSingleUpdate($hash, "state", $error, 1); Log3 ($name, 4, "SMAEM $name -> BlockingCall SMAEM_ParseDone finished"); delete($hash->{HELPER}{RUNNING_PID}); return; } $hash->{'GRIDIN_SUM_'.$smaserial} = $gridinsum; $hash->{'GRIDOUT_SUM_'.$smaserial} = $gridoutsum; Log3($name, 4, "SMAEM $name - wrote new energy values to INTERNALS - GRIDIN_SUM_$smaserial: $gridinsum, GRIDOUT_SUM_$smaserial: $gridoutsum"); my @row_array = split("_ESC_", $rowlist); Log3 ($name, 5, "SMAEM $name - row_array after decoding:"); foreach my $row (@row_array) { chomp $row; Log3 ($name, 5, "SMAEM $name - $row"); } readingsBeginUpdate($hash); foreach my $row (@row_array) { chomp $row; my @a = split(" ", $row, 2); readingsBulkUpdate($hash, $a[0], $a[1]); } readingsEndUpdate($hash, 1); delete($hash->{HELPER}{RUNNING_PID}); Log3 ($name, 4, "SMAEM $name -> BlockingCall SMAEM_ParseDone finished"); CancelDelayedShutdown($name); return; } ############################################################### # Abbruchroutine Timeout Inverter Abfrage ############################################################### sub SMAEM_ParseAborted ($) { my ($hash,$cause) = @_; my $name = $hash->{NAME}; my $discycles = $hash->{HELPER}{FAULTEDCYCLES}; $cause = $cause?$cause:"Timeout: process terminated"; $discycles++; $hash->{HELPER}{FAULTEDCYCLES} = $discycles; Log3 ($name, 1, "SMAEM $name -> BlockingCall $hash->{HELPER}{RUNNING_PID}{fn} $cause"); readingsSingleUpdate($hash, "state", $cause, 1); delete($hash->{HELPER}{RUNNING_PID}); CancelDelayedShutdown($name); return; } ############################################################### # DbLog_splitFn ############################################################### sub SMAEM_DbLog_splitFn ($) { my ($event,$device) = @_; my ($reading, $value, $unit) = ""; my @parts = split(/ /,$event,3); $reading = $parts[0]; $reading =~ tr/://d; $value = $parts[1]; if($reading =~ m/.*leistung$/) { $unit = 'W'; } elsif($reading =~ m/.*Spannung/) { $unit = 'V'; } elsif($reading =~ m/.*leistung_Zaehler$/) { $unit = 'kWh'; } elsif($reading =~ m/.*THD$/) { $unit = '%'; } else { if(!defined($parts[1])) { $reading = "state"; $value = $event; $unit = 'W'; } else { $value = $parts[1]; $value = $value." ".$parts[2] if(defined($parts[2])); } } Log3 ($device, 5, "SMAEM $device - splitFn returns Reading: ".$reading.", Value: ". defined($value)?$value:''.", Unit: ".defined($unit)?$unit:''); return ($reading, $value, $unit); } ############################################################### # Hilfsroutinen ############################################################### ############################################################### ### alle Serial-Nummern in cacheSMAEM speichern sub SMAEM_setserials ($) { my ($hash) = @_; my $name = $hash->{NAME}; my $modpath = $attr{global}{modpath}; my ($index,$retcode,$as); $as = $hash->{HELPER}{ALLSERIALS}; $index = $hash->{TYPE}."_".$hash->{NAME}."_allserials"; $retcode = SMAEM_setCacheValue($hash,$index,$as); if ($retcode) { Log3($name, 1, "SMAEM $name - ERROR while saving all serial numbers - $retcode"); } else { Log3($name, 4, "SMAEM $name - all serial numbers were saved to $modpath/FHEM/FhemUtils/cacheSMAEM"); } return ($retcode); } ############################################################### ### Summenwerte für GridIn, GridOut speichern sub SMAEM_setsum ($$$$) { my ($hash,$smaserial,$gridinsum,$gridoutsum) = @_; my $name = $hash->{NAME}; my $modpath = $attr{global}{modpath}; my ($index,$retcode,$sumstr); $sumstr = $gridinsum."_".$gridoutsum; $index = $hash->{TYPE}."_".$hash->{NAME}."_".$smaserial; $retcode = SMAEM_setCacheValue($hash,$index,$sumstr); if ($retcode) { Log3($name, 1, "SMAEM $name - ERROR while saving summary of energy values - $retcode"); } else { Log3($name, 4, "SMAEM $name - new energy values saved to $modpath/FHEM/FhemUtils/cacheSMAEM"); Log3($name, 4, "SMAEM $name - GRIDIN_SUM_$smaserial: $gridinsum, GRIDOUT_SUM_$smaserial: $gridoutsum"); } return ($retcode); } ############################################################### ### Schreibroutine in eigenes Keyvalue-File sub SMAEM_setCacheValue ($$$) { my ($hash,$key,$value) = @_; my $fName = $attr{global}{modpath}."/FHEM/FhemUtils/cacheSMAEM"; my $param = { FileName => $fName, ForceType => "file", }; my ($err, @old) = FileRead($param); SMAEM_createCacheFile($hash) if($err); my @new; my $fnd; foreach my $l (@old) { if($l =~ m/^$key:/) { $fnd = 1; push @new, "$key:$value" if(defined($value)); } else { push @new, $l; } } push @new, "$key:$value" if(!$fnd && defined($value)); return FileWrite($param, @new); } ############################################################### ### gespeicherte Serial-Nummern auslesen sub SMAEM_getserials ($) { my ($hash) = @_; my $name = $hash->{NAME}; my $modpath = $attr{global}{modpath}; my ($index,$retcode,$serials); $index = $hash->{TYPE}."_".$hash->{NAME}."_allserials"; ($retcode, $serials) = SMAEM_getCacheValue($index); if ($retcode) { Log3($name, 1, "SMAEM $name - $retcode") if ($retcode); Log3($name, 3, "SMAEM $name - Create new cacheFile $modpath/FHEM/FhemUtils/cacheSMAEM"); $retcode = SMAEM_createCacheFile($hash); } else { if ($serials) { $hash->{HELPER}{ALLSERIALS} = $serials; Log3 ($name, 3, "SMAEM $name - read saved serial numbers from $modpath/FHEM/FhemUtils/cacheSMAEM"); } } return ($retcode); } ############################################################### ### Summenwerte für GridIn, GridOut auslesen sub SMAEM_getsum ($$) { my ($hash,$smaserial) = @_; my $name = $hash->{NAME}; my $modpath = $attr{global}{modpath}; my ($index,$retcode,$sumstr); $index = $hash->{TYPE}."_".$hash->{NAME}."_".$smaserial; ($retcode, $sumstr) = SMAEM_getCacheValue($index); if ($retcode) { Log3($name, 1, "SMAEM $name - $retcode") if ($retcode); } else { if ($sumstr) { ($hash->{'GRIDIN_SUM_'.$smaserial}, $hash->{'GRIDOUT_SUM_'.$smaserial}) = split(/_/, $sumstr); Log3 ($name, 3, "SMAEM $name - read saved energy values from $modpath/FHEM/FhemUtils/cacheSMAEM"); Log3 ($name, 3, "SMAEM $name - GRIDIN_SUM_$smaserial: $hash->{'GRIDIN_SUM_'.$smaserial}, GRIDOUT_SUM_$smaserial: $hash->{'GRIDOUT_SUM_'.$smaserial}"); } } return ($retcode); } ############################################################### ### Leseroutine aus eigenem Keyvalue-File sub SMAEM_getCacheValue ($) { my ($key) = @_; my $fName = $attr{global}{modpath}."/FHEM/FhemUtils/cacheSMAEM"; my $param = { FileName => $fName, ForceType => "file", }; my ($err, @l) = FileRead($param); return ($err, undef) if($err); for my $l (@l) { return (undef, $1) if($l =~ m/^$key:(.*)/); } return (undef, undef); } ############################################################### ### Anlegen eigenes Keyvalue-File wenn nicht vorhanden sub SMAEM_createCacheFile ($) { my $fName = $attr{global}{modpath}."/FHEM/FhemUtils/cacheSMAEM"; my $param = { FileName => $fName, ForceType => "file", }; my @new; push(@new, "# This file is auto generated from 77_SMAEM.", "# Please do not modify, move or delete it.", ""); return FileWrite($param, @new); } ############################################################### ### $update time of last update sub SMAEM_setlastupdate ($$) { my ($hash,$smaserial) = @_; my $name = $hash->{NAME}; return if(!$smaserial); # Abbruch wenn keine Seriennummer extrahiert $hash->{HELPER}{'LASTUPDATE_'.$smaserial} = time(); my ($sec,$min,$hour,$mday,$mon,$year,undef,undef,undef) = localtime(); $hash->{'LASTUPDATE_'.$smaserial} = sprintf "%02d.%02d.%04d / %02d:%02d:%02d" , $mday , $mon+=1 ,$year+=1900 , $hour , $min , $sec ; Log3 ($name, 4, "SMAEM $name - last update time set to: $hash->{'LASTUPDATE_'.$smaserial}"); return; } ############################################################################################# # Versionierungen des Moduls setzen # Die Verwendung von Meta.pm und Packages wird berücksichtigt ############################################################################################# sub SMAEM_setVersionInfo($) { my ($hash) = @_; my $name = $hash->{NAME}; my $v = (sortTopicNum("desc",keys %SMAEM_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: 77_SMAEM.pm 19460 2019-05-24 20:19:41Z 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: 77_SMAEM.pm 19460 2019-05-24 20:19:41Z DS_Starter $ im Kopf komplett! vorhanden ) if(__PACKAGE__ eq "FHEM::$type" || __PACKAGE__ eq $type) { # es wird mit Packages gearbeitet -> Perl übliche Modulversion setzen # mit {->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; } 1; =pod =item summary Integration of SMA Energy Meters =item summary_DE Integration von SMA Energy Meter =begin html

SMAEM


Define

Set Attribute
Readings

The created readings of SMAEM mostly are self-explanatory. However there are readings what maybe need some explanation.

=end html =begin html_DE

SMAEM


Define
Set Attribute
Readings

Die meisten erzeugten Readings von SMAEM sind selbsterklärend. Es gibt allerdings Readings die einer Erläuterung bedürfen.

=end html_DE =for :application/json;q=META.json 77_SMAEM.pm { "abstract": "Integration of one or more SMA Energy Meters.", "x_lang": { "de": { "abstract": "Integration von einem oder mehreren SMA Energy Metern." } }, "keywords": [ "SMA", "Photovoltaik", "SMA Energy Meter" ], "version": "v1.1.1", "release_status": "stable", "author": [ "Volker Kettenbach ", "Heiko Maaz ", null, null ], "x_fhem_maintainer": [ "Volker Kettenbach", "DS_Starter", null, null ], "x_fhem_maintainer_github": [ "Volker Kettenbach", "nasseeder1", null, null ], "prereqs": { "runtime": { "requires": { "FHEM": 5.00918799, "perl": 5.014, "bignum": 0, "IO::Socket::Multicast": 0, "Blocking": 0 }, "recommends": { "FHEM::Meta": 0 }, "suggests": { } } }, "resources": { "repository": { "x_dev": { "type": "git", "url": "https://gitlab.com/volkerkettenbach/FHEM-SMA-Speedwire", "web": "https://gitlab.com/volkerkettenbach/FHEM-SMA-Speedwire/blob/master/77_SMAEM.pm", "x_branch": "dev", "x_raw": "https://gitlab.com/volkerkettenbach/FHEM-SMA-Speedwire/raw/master/77_SMAEM.pm" } } }, "x_support_status": "supported" } =end :application/json;q=META.json =cut