mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-02-01 13:29:26 +00:00
962 lines
34 KiB
Perl
962 lines
34 KiB
Perl
#########################################################################################################################
|
|
# $Id: $
|
|
#########################################################################################################################
|
|
# 76_SMAPortal.pm
|
|
#
|
|
# (c) 2019 by Heiko Maaz
|
|
# e-mail: Heiko dot Maaz at t-online dot de
|
|
#
|
|
# This Module can be used to operate Cameras defined in Synology Surveillance Station 7.0 or higher.
|
|
# It's based on and uses Synology Surveillance Station API.
|
|
#
|
|
# 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/>.
|
|
#
|
|
# This module is based on the modules (Thanks to all!):
|
|
# 98_SHM.pm from author Brun von der Gönne <brun at goenne dot de>
|
|
# 98_SHMForecastRelative.pm from author BerndArnold
|
|
#
|
|
# FHEM Forum: http://forum.fhem.de/index.php/topic,27667.0.html
|
|
#
|
|
#########################################################################################################################
|
|
#
|
|
# Definition: define <name> SMAPortal
|
|
#
|
|
#########################################################################################################################
|
|
|
|
package main;
|
|
use strict;
|
|
use warnings;
|
|
use POSIX;
|
|
use Data::Dumper;
|
|
use Blocking;
|
|
use Time::HiRes qw(gettimeofday);
|
|
use LWP::UserAgent;
|
|
use HTTP::Cookies;
|
|
use JSON qw(decode_json);
|
|
|
|
# Versions History intern
|
|
our %SMAPortal_vNotesIntern = (
|
|
"1.0.0" => "03.03.2019 initial "
|
|
);
|
|
|
|
###############################################################
|
|
# SMAPortal Initialize
|
|
###############################################################
|
|
sub SMAPortal_Initialize($) {
|
|
my ($hash) = @_;
|
|
|
|
$hash->{DefFn} = "SMAPortal_Define";
|
|
$hash->{UndefFn} = "SMAPortal_Undefine";
|
|
$hash->{DeleteFn} = "SMAPortal_Delete";
|
|
$hash->{AttrFn} = "SMAPortal_Attr";
|
|
$hash->{SetFn} = "SMAPortal_Set";
|
|
$hash->{GetFn} = "SMAPortal_Get";
|
|
$hash->{AttrList} = "interval ".
|
|
"showPassInLog:1,0 ".
|
|
"detailLevel:1,2,3,4 ".
|
|
"timeout ".
|
|
"userAgent ".
|
|
"cookieLocation ".
|
|
"cookielifetime ".
|
|
"disable:0,1 ".
|
|
$readingFnAttributes;
|
|
}
|
|
|
|
###############################################################
|
|
# SMAPortal Define
|
|
###############################################################
|
|
sub SMAPortal_Define($$) {
|
|
my ($hash, $def) = @_;
|
|
my @a = split(/\s+/, $def);
|
|
|
|
return "Wrong syntax: use \"define <name> SMAPortal\" " if(int(@a) < 1);
|
|
|
|
$hash->{VERSION} = (SMAPortal_sortVersion("desc",keys %SMAPortal_vNotesIntern))[0];
|
|
|
|
SMAPortal_getcredentials($hash,1); # Credentials lesen und in RAM laden ($boot=1)
|
|
SMAPortal_CallInfo($hash); # Start Daten Abrufschleife
|
|
SMAPortal_delcookiefile($hash); # Start Schleife regelmäßiges Löschen Cookiefile
|
|
|
|
return undef;
|
|
}
|
|
|
|
###############################################################
|
|
# SMAPortal Undefine
|
|
###############################################################
|
|
sub SMAPortal_Undefine($$) {
|
|
my ($hash, $arg) = @_;
|
|
|
|
RemoveInternalTimer($hash);
|
|
BlockingKill($hash->{HELPER}{RUNNING_PID}) if($hash->{HELPER}{RUNNING_PID});
|
|
|
|
return undef;
|
|
}
|
|
|
|
###############################################################
|
|
# SMAPortal Delete
|
|
###############################################################
|
|
sub SMAPortal_Delete($$) {
|
|
my ($hash, $arg) = @_;
|
|
my $index = $hash->{TYPE}."_".$hash->{NAME}."_credentials";
|
|
my $name = $hash->{NAME};
|
|
|
|
# gespeicherte Credentials löschen
|
|
setKeyValue($index, undef);
|
|
|
|
return undef;
|
|
}
|
|
|
|
###############################################################
|
|
# SMAPortal Set
|
|
###############################################################
|
|
sub SMAPortal_Set($@) {
|
|
my ($hash, @a) = @_;
|
|
return "\"set X\" needs at least an argument" if ( @a < 2 );
|
|
my $name = $a[0];
|
|
my $opt = $a[1];
|
|
my $prop = $a[2];
|
|
my $prop1 = $a[3];
|
|
my ($setlist,$success);
|
|
|
|
return if(IsDisabled($name));
|
|
|
|
if(!$hash->{CREDENTIALS}) {
|
|
# initiale setlist für neue Devices
|
|
$setlist = "Unknown argument $opt, choose one of ".
|
|
"credentials "
|
|
;
|
|
} else {
|
|
# erweiterte Setlist wenn Credentials gesetzt
|
|
$setlist = "Unknown argument $opt, choose one of ".
|
|
"credentials "
|
|
;
|
|
}
|
|
|
|
if ($opt eq "credentials") {
|
|
return "Credentials are incomplete, use username password" if (!$prop || !$prop1);
|
|
($success) = SMAPortal_setcredentials($hash,$prop,$prop1);
|
|
|
|
if($success) {
|
|
SMAPortal_CallInfo($hash);
|
|
return "Username and Password saved successfully";
|
|
} else {
|
|
return "Error while saving Username / Password - see logfile for details";
|
|
}
|
|
|
|
} else {
|
|
return "$setlist";
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
######################################################################################
|
|
# Username / Paßwort speichern
|
|
######################################################################################
|
|
sub SMAPortal_setcredentials ($@) {
|
|
my ($hash, @credentials) = @_;
|
|
my $name = $hash->{NAME};
|
|
my ($success, $credstr, $index, $retcode);
|
|
my (@key,$len,$i);
|
|
|
|
$credstr = encode_base64(join(':', @credentials));
|
|
|
|
# Beginn Scramble-Routine
|
|
@key = qw(1 3 4 5 6 3 2 1 9);
|
|
$len = scalar @key;
|
|
$i = 0;
|
|
$credstr = join "",
|
|
map { $i = ($i + 1) % $len;
|
|
chr((ord($_) + $key[$i]) % 256) } split //, $credstr;
|
|
# End Scramble-Routine
|
|
|
|
$index = $hash->{TYPE}."_".$hash->{NAME}."_credentials";
|
|
$retcode = setKeyValue($index, $credstr);
|
|
|
|
if ($retcode) {
|
|
Log3($name, 1, "$name - Error while saving the Credentials - $retcode");
|
|
$success = 0;
|
|
} else {
|
|
SMAPortal_getcredentials($hash,1); # Credentials nach Speicherung lesen und in RAM laden ($boot=1)
|
|
$success = 1;
|
|
}
|
|
|
|
return ($success);
|
|
}
|
|
|
|
######################################################################################
|
|
# Username / Paßwort abrufen
|
|
######################################################################################
|
|
sub SMAPortal_getcredentials ($$) {
|
|
my ($hash,$boot) = @_;
|
|
my $name = $hash->{NAME};
|
|
my ($success, $username, $passwd, $index, $retcode, $credstr);
|
|
my (@key,$len,$i);
|
|
|
|
if ($boot) {
|
|
# mit $boot=1 Credentials von Platte lesen und als scrambled-String in RAM legen
|
|
$index = $hash->{TYPE}."_".$hash->{NAME}."_credentials";
|
|
($retcode, $credstr) = getKeyValue($index);
|
|
|
|
if ($retcode) {
|
|
Log3($name, 2, "$name - Unable to read password from file: $retcode");
|
|
$success = 0;
|
|
}
|
|
|
|
if ($credstr) {
|
|
# beim Boot scrambled Credentials in den RAM laden
|
|
$hash->{HELPER}{CREDENTIALS} = $credstr;
|
|
|
|
# "Credentials" wird als Statusbit ausgewertet. Wenn nicht gesetzt -> Warnmeldung und keine weitere Verarbeitung
|
|
$hash->{CREDENTIALS} = "Set";
|
|
$success = 1;
|
|
}
|
|
} else {
|
|
# boot = 0 -> Credentials aus RAM lesen, decoden und zurückgeben
|
|
$credstr = $hash->{HELPER}{CREDENTIALS};
|
|
|
|
if($credstr) {
|
|
# Beginn Descramble-Routine
|
|
@key = qw(1 3 4 5 6 3 2 1 9);
|
|
$len = scalar @key;
|
|
$i = 0;
|
|
$credstr = join "",
|
|
map { $i = ($i + 1) % $len;
|
|
chr((ord($_) - $key[$i] + 256) % 256) }
|
|
split //, $credstr;
|
|
# Ende Descramble-Routine
|
|
|
|
($username, $passwd) = split(":",decode_base64($credstr));
|
|
|
|
my $logpw = AttrVal($name, "showPassInLog", "0") == 1 ? $passwd : "********";
|
|
|
|
Log3($name, 3, "$name - Credentials read from RAM: $username $logpw");
|
|
|
|
} else {
|
|
Log3($name, 1, "$name - Credentials not set in RAM !");
|
|
}
|
|
|
|
$success = (defined($passwd)) ? 1 : 0;
|
|
}
|
|
|
|
return ($success, $username, $passwd);
|
|
}
|
|
|
|
###############################################################
|
|
# SMAPortal Get
|
|
###############################################################
|
|
sub SMAPortal_Get($$) {
|
|
my ($hash, @a) = @_;
|
|
return "\"get X\" needs at least an argument" if ( @a < 2 );
|
|
my $name = shift @a;
|
|
my $opt = shift @a;
|
|
|
|
my $getlist = "Unknown argument $opt, choose one of ".
|
|
"storedCredentials:noArg ".
|
|
"data:noArg ";
|
|
|
|
return "module is disabled" if(IsDisabled($name));
|
|
|
|
if ($opt eq "data") {
|
|
SMAPortal_CallInfo($hash);
|
|
|
|
} elsif ($opt eq "storedCredentials") {
|
|
if(!$hash->{CREDENTIALS}) {return "Credentials of $name are not set - make sure you've set it with \"set $name credentials <username> <password>\"";}
|
|
# Credentials abrufen
|
|
my ($success, $username, $password) = SMAPortal_getcredentials($hash,0);
|
|
unless ($success) {return "Credentials couldn't be retrieved successfully - see logfile"};
|
|
|
|
return "Stored Credentials to access SMA Portal:\n".
|
|
"========================================\n".
|
|
"Username: $username, Password: $password\n".
|
|
"\n";
|
|
|
|
} else {
|
|
return "$getlist";
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
###############################################################
|
|
# SMAPortal Attr
|
|
###############################################################
|
|
sub SMAPortal_Attr($$$$) {
|
|
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");
|
|
|
|
if($do) {
|
|
SMAPortal_delread($hash);
|
|
delete $hash->{MODE};
|
|
RemoveInternalTimer($hash);
|
|
SMAPortal_delcookiefile($hash,1);
|
|
} else {
|
|
InternalTimer(gettimeofday()+1.0, "SMAPortal_CallInfo", $hash, 0);
|
|
InternalTimer(gettimeofday()+5.0, "SMAPortal_delcookiefile", $hash, 0);
|
|
}
|
|
|
|
readingsBeginUpdate($hash);
|
|
readingsBulkUpdate($hash, "state", $val);
|
|
readingsEndUpdate($hash, 1);
|
|
}
|
|
|
|
if ($cmd eq "set") {
|
|
if ($aName =~ m/timeout|interval/) {
|
|
unless ($aVal =~ /^\d+$/) {return " The Value for $aName is not valid. Use only figures 0-9 !";}
|
|
}
|
|
if($aName =~ m/interval/) {
|
|
InternalTimer(gettimeofday()+1.0, "SMAPortal_CallInfo", $hash, 0);
|
|
}
|
|
}
|
|
|
|
return undef;
|
|
}
|
|
|
|
################################################################
|
|
## Hauptschleife BlockingCall
|
|
################################################################
|
|
sub SMAPortal_CallInfo($) {
|
|
my ($hash) = @_;
|
|
my $name = $hash->{NAME};
|
|
my $timeout = AttrVal($name, "timeout", 30);
|
|
my $interval = AttrVal($name, "interval", 300);
|
|
my $new;
|
|
|
|
RemoveInternalTimer($hash,"SMAPortal_CallInfo");
|
|
|
|
if($init_done == 1) {
|
|
if(!$hash->{CREDENTIALS}) {
|
|
Log3($name, 1, "$name - Credentials not set. Set it with \"set $name credentials <username> <password>\"");
|
|
readingsSingleUpdate($hash, "state", "Credntials not set", 1);
|
|
return;
|
|
}
|
|
|
|
if(!$interval) {
|
|
$hash->{MODE} = "Manual";
|
|
} else {
|
|
$new = gettimeofday()+$interval;
|
|
InternalTimer($new, "SMAPortal_CallInfo", $hash, 0);
|
|
$hash->{MODE} = "Automatic - next polltime: ".FmtTime($new);
|
|
}
|
|
|
|
return if(IsDisabled($name));
|
|
|
|
if ($hash->{HELPER}{RUNNING_PID}) {
|
|
BlockingKill($hash->{HELPER}{RUNNING_PID});
|
|
delete($hash->{HELPER}{RUNNING_PID});
|
|
}
|
|
|
|
$hash->{HELPER}{RUNNING_PID} = BlockingCall("SMAPortal_GetData", $name, "SMAPortal_ParseData", $timeout, "SMAPortal_ParseAborted", $hash);
|
|
$hash->{HELPER}{RUNNING_PID}{loglevel} = 5 if($hash->{HELPER}{RUNNING_PID}); # Forum #77057
|
|
|
|
} else {
|
|
InternalTimer(gettimeofday()+5, "SMAPortal_CallInfo", $hash, 0);
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
################################################################
|
|
## Datenabruf SMA-Portal
|
|
################################################################
|
|
sub SMAPortal_GetData($) {
|
|
my ($name) = @_;
|
|
my $hash = $defs{$name};
|
|
my ($livedata_content);
|
|
my $login_state = 0;
|
|
my $forecast_content = "";
|
|
my $useragent = AttrVal($name, "userAgent", "Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; Trident/6.0)");
|
|
my $cookieLocation = AttrVal($name, "cookieLocation", "./log/mycookies.txt");
|
|
|
|
Log3 $name, 5, "$name - Start BlockingCall SMAPortal_GetData with CookieLocation: $cookieLocation and UserAgent: $useragent";
|
|
|
|
my $ua = LWP::UserAgent->new;
|
|
|
|
# Define user agent type
|
|
$ua->agent("$useragent");
|
|
|
|
# Cookies
|
|
$ua->cookie_jar(HTTP::Cookies->new( file => "$cookieLocation",
|
|
ignore_discard => 1,
|
|
autosave => 1
|
|
)
|
|
);
|
|
|
|
# Sunny Home Manager Seite abfragen
|
|
my $livedata = $ua->get('https://www.sunnyportal.com/homemanager');
|
|
|
|
if(($livedata->content =~ m/FeedIn/i) && ($livedata->content !~ m/expired/i)) {
|
|
Log3 $name, 4, "$name - Login to SMA-Portal succesful";
|
|
|
|
# JSON Live Daten
|
|
$livedata_content = $livedata->content;
|
|
$login_state = 1;
|
|
Log3 $name, 4, "$name - Getting live data now";
|
|
Log3 $name, 5, "$name - Data received:\n".Dumper decode_json($livedata_content);
|
|
|
|
# JSON Forecast Daten
|
|
my $dl = AttrVal($name, "detailLevel", 1);
|
|
if($dl > 1) {
|
|
Log3 $name, 5, "$name - Getting forecast data now";
|
|
|
|
my $forecast_page = $ua->get('https://www.sunnyportal.com/HoMan/Forecast/LoadRecommendationData');
|
|
Log3 $name, 5, "$name - Return Code: ".$forecast_page->code;
|
|
|
|
if ($forecast_page->content =~ m/ForecastChartDataPoint/i) {
|
|
$forecast_content = $forecast_page->content;
|
|
Log3 $name, 5, "$name - Forecast Data received:\n".$forecast_content;
|
|
}
|
|
}
|
|
|
|
} else {
|
|
my $usernameField = "ctl00\$ContentPlaceHolder1\$Logincontrol1\$txtUserName";
|
|
my $passwordField = "ctl00\$ContentPlaceHolder1\$Logincontrol1\$txtPassword";
|
|
my $loginField = "__EVENTTARGET";
|
|
my $loginButton = "ctl00\$ContentPlaceHolder1\$Logincontrol1\$LoginBtn";
|
|
|
|
Log3 $name, 3, "$name - not logged in. Try again ...";
|
|
|
|
# Credentials abrufen
|
|
my ($success, $username, $password) = SMAPortal_getcredentials($hash,0);
|
|
|
|
unless ($success) {
|
|
Log3($name, 1, "$name - Credentials couldn't be retrieved successfully - make sure you've set it with \"set $name credentials <username> <password>\"");
|
|
$login_state = 0;
|
|
|
|
} else {
|
|
my $loginp = $ua->post('https://www.sunnyportal.com/Templates/Start.aspx',[$usernameField => $username, $passwordField => $password, "__EVENTTARGET" => $loginButton]);
|
|
|
|
Log3 $name, 4, "$name -> ".$loginp->code;
|
|
Log3 $name, 5, "$name -> Login-Page return: ".$loginp->content;
|
|
|
|
if( $loginp->content =~ /Logincontrol1_ErrorLabel/i ) {
|
|
Log3 $name, 1, "$name - Error: login to SMA-Portal failed";
|
|
$livedata_content = "{\"Login-Status\":\"failed\"}";
|
|
} else {
|
|
Log3 $name, 3, "$name - login to SMA-Portal successful, get data with next data cycle ...";
|
|
$livedata_content = '{"Login-Status":"successful", "InfoMessages":["login to SMA-Portal successful but get data with next data cycle."]}';
|
|
$login_state = 1;
|
|
}
|
|
|
|
my $shmp = $ua->get('https://www.sunnyportal.com/FixedPages/HoManLive.aspx');
|
|
Log3 $name, 5, "$name -> ".$shmp->code;
|
|
}
|
|
}
|
|
|
|
# Daten müssen als Einzeiler zurückgegeben werden
|
|
$livedata_content = encode_base64($livedata_content,"");
|
|
$forecast_content = encode_base64($forecast_content,"") if($forecast_content);
|
|
|
|
return "$name|$livedata_content|$forecast_content|$login_state";
|
|
}
|
|
|
|
################################################################
|
|
## Verarbeitung empfangene Daten, setzen Readings
|
|
################################################################
|
|
sub SMAPortal_ParseData($) {
|
|
my ($string) = @_;
|
|
my @a = split("\\|",$string);
|
|
my $hash = $defs{$a[0]};
|
|
my $name = $hash->{NAME};
|
|
my $ld_response = decode_base64($a[1]);
|
|
my $fd_response = decode_base64($a[2]) if($a[2]);
|
|
my $login_state = $a[3];
|
|
my $livedata_content = decode_json($ld_response);
|
|
my $forecast_content = decode_json($fd_response) if($fd_response);
|
|
|
|
my $dl = AttrVal($name, "detailLevel", 1);
|
|
SMAPortal_delread($hash, $dl+1);
|
|
|
|
readingsBeginUpdate($hash);
|
|
readingsBulkUpdate($hash, "L1_FeedIn", 0);
|
|
readingsBulkUpdate($hash, "L1_GridConsumption", 0);
|
|
readingsBulkUpdate($hash, "L1_PV", 0);
|
|
readingsEndUpdate($hash, 0);
|
|
|
|
readingsBeginUpdate($hash);
|
|
|
|
for my $k (keys %$livedata_content) {
|
|
my $new_val = "";
|
|
|
|
if (defined $livedata_content->{$k}) {
|
|
Log3 $name, 4, "$name - livedata content \"$k\": ".($livedata_content->{$k});
|
|
if (($livedata_content->{$k} =~ m/ARRAY/i) || ($livedata_content->{$k} =~ m/HASH/i)) {
|
|
if($livedata_content->{$k} =~ m/ARRAY/i) {
|
|
my $hd0 = Dumper($livedata_content->{$k}[0]);
|
|
if(!$hd0) {
|
|
next;
|
|
}
|
|
chomp $hd0;
|
|
$hd0 =~ s/[;']//g;
|
|
$hd0 = ($hd0 =~ /^undef$/)?"none":$hd0;
|
|
Log3 $name, 4, "$name - livedata ARRAY content \"$k\": $hd0";
|
|
$new_val = $hd0;
|
|
}
|
|
} else {
|
|
$new_val = $livedata_content->{$k};
|
|
}
|
|
|
|
if ($new_val && $k !~ /__type/i) {
|
|
Log3 $hash->{NAME}, 4, "$name -> $k - $new_val";
|
|
readingsBulkUpdate($hash, "L1_$k", $new_val);
|
|
}
|
|
}
|
|
}
|
|
|
|
readingsEndUpdate($hash, 1);
|
|
|
|
if ($forecast_content && $forecast_content !~ m/undefined/i) {
|
|
# Auswertung der Forecast Daten
|
|
SMAPortal_extractForecastData($hash,$forecast_content);
|
|
}
|
|
|
|
my $pv = ReadingsVal($name, "L1_PV", 0);
|
|
my $fi = ReadingsVal($name, "L1_FeedIn", 0);
|
|
my $gc = ReadingsVal($name, "L1_GridConsumption", 0);
|
|
my $state = $fi-$gc;
|
|
|
|
readingsBeginUpdate($hash);
|
|
if($login_state) {
|
|
readingsBulkUpdate($hash, "state", $state);
|
|
readingsBulkUpdate($hash, "summary", $state);
|
|
}
|
|
readingsEndUpdate($hash, 1);
|
|
|
|
$hash->{HELPER}{oldlogintime} = gettimeofday() if (defined($livedata_content->{"Login-Status"}) && $livedata_content->{"Login-Status"} =~ m/successful/i);
|
|
delete($hash->{HELPER}{RUNNING_PID});
|
|
}
|
|
|
|
################################################################
|
|
## Timeout BlockingCall
|
|
################################################################
|
|
sub SMAPortal_ParseAborted($) {
|
|
my ($hash,$cause) = @_;
|
|
my $name = $hash->{NAME};
|
|
|
|
$cause = $cause?$cause:"Timeout: process terminated";
|
|
Log3 ($name, 1, "$name -> BlockingCall $hash->{HELPER}{RUNNING_PID}{fn} pid:$hash->{HELPER}{RUNNING_PID}{pid} $cause");
|
|
|
|
delete($hash->{HELPER}{RUNNING_PID});
|
|
}
|
|
|
|
################################################################
|
|
## regelmäßig Cookie-Datei löschen
|
|
################################################################
|
|
sub SMAPortal_delcookiefile ($;$) {
|
|
my ($hash,$must) = @_;
|
|
my $name = $hash->{NAME};
|
|
my ($validperiod, $cookieLocation, $oldlogintime, $delfile);
|
|
|
|
RemoveInternalTimer($hash,"SMAPortal_delcookiefile");
|
|
|
|
# Gültigkeitsdauer Cookie in Sekunden
|
|
$validperiod = AttrVal($name, "cookielifetime", 3000);
|
|
$cookieLocation = AttrVal($name, "cookieLocation", "./log/mycookies.txt");
|
|
|
|
if($must) {
|
|
# Cookie Zwangslöschung
|
|
$delfile = unlink($cookieLocation);
|
|
}
|
|
|
|
$oldlogintime = $hash->{HELPER}{oldlogintime}?$hash->{HELPER}{oldlogintime}:0;
|
|
|
|
if($init_done == 1) {
|
|
# Abfrage ob gettimeofday() größer ist als gettimeofday()+$validperiod
|
|
if (gettimeofday() > $oldlogintime+$validperiod) {
|
|
$delfile = unlink($cookieLocation);
|
|
}
|
|
}
|
|
|
|
if($delfile) {
|
|
Log3 $name, 3, "$name - cookie file deleted: $cookieLocation";
|
|
}
|
|
|
|
return if(IsDisabled($name));
|
|
|
|
InternalTimer(gettimeofday()+30, "SMAPortal_delcookiefile", $hash, 0);
|
|
|
|
return;
|
|
}
|
|
|
|
################################################################
|
|
## Auswertung Forecast Daten
|
|
################################################################
|
|
sub SMAPortal_extractForecastData($$) {
|
|
my ($hash,$forecast) = @_;
|
|
my $name = $hash->{NAME};
|
|
|
|
my $dl = AttrVal($name, "detailLevel", 1);
|
|
|
|
if($dl <= 1) {
|
|
return;
|
|
}
|
|
|
|
my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
|
|
$year += 1900;
|
|
$mon += 1;
|
|
my $today = "$year-".sprintf("%02d", $mon)."-".sprintf("%02d", $mday)."T";
|
|
|
|
my $PV_sum = 0;
|
|
my $consum_sum = 0;
|
|
my $sum = 0;
|
|
|
|
readingsBeginUpdate($hash);
|
|
|
|
my $plantOid = $forecast->{'ForecastTimeframes'}->{'PlantOid'};
|
|
|
|
# Counter for forecast objects
|
|
my $obj_nr = 0;
|
|
|
|
# The next few hours...
|
|
my %nextFewHoursSum = ("PV" => 0, "Consumption" => 0, "Total" => 0, "ConsumpRcmd" => 0);
|
|
|
|
# Rest of the day...
|
|
my %restOfDaySum = ("PV" => 0, "Consumption" => 0, "Total" => 0, "ConsumpRcmd" => 0);
|
|
|
|
# Tomorrow...
|
|
my %tomorrowSum = ("PV" => 0, "Consumption" => 0, "Total" => 0, "ConsumpRcmd" => 0);
|
|
|
|
# Get the current day (for 2016-02-26, this is 26)
|
|
my $current_day = (localtime)[3];
|
|
|
|
# Loop through all forecast objects
|
|
foreach my $fc_obj (@{$forecast->{'ForecastSeries'}}) {
|
|
|
|
# Log3 $name, 4, "$name - Forecast data: ".Dumper $fc_obj;
|
|
# Example for DateTime: 2016-02-15T23:00:00
|
|
my $fc_datetime = $fc_obj->{'TimeStamp'}->{'DateTime'};
|
|
|
|
# Calculate Unix timestamp (month begins at 0, year at 1900)
|
|
my ($fc_year, $fc_month, $fc_day, $fc_hour) = $fc_datetime =~ /^(\d\d\d\d)-(\d\d)-(\d\d)T(\d\d):00:00$/;
|
|
my $fc_uts = POSIX::mktime( 0, 0, $fc_hour, $fc_day, $fc_month - 1, $fc_year - 1900 );
|
|
my $fc_diff_seconds = $fc_uts - time + 3600; # So we go above 0 for the current hour
|
|
my $fc_diff_hours = int( $fc_diff_seconds / 3600 );
|
|
#Log3 $hash->{NAME}, 3, "Found $fc_datetime, diff $fc_diff_seconds seconds, $fc_diff_hours hours.";
|
|
|
|
# Don't use old data
|
|
next if $fc_diff_seconds < 0;
|
|
|
|
# Sum up for the next few hours (4 hours total, this is current hour plus the next 3 hours)
|
|
if ($obj_nr < 4) {
|
|
$nextFewHoursSum{'PV'} += $fc_obj->{'PvMeanPower'}->{'Amount'};
|
|
$nextFewHoursSum{'Consumption'} += $fc_obj->{'ConsumptionForecast'}->{'Amount'} / 3600;
|
|
$nextFewHoursSum{'Total'} += $fc_obj->{'PvMeanPower'}->{'Amount'} - $fc_obj->{'ConsumptionForecast'}->{'Amount'} / 3600;
|
|
$nextFewHoursSum{'ConsumpRcmd'} += $fc_obj->{'IsConsumptionRecommended'} ? 1 : 0;
|
|
}
|
|
|
|
# If data is for the rest of the current day
|
|
if ( $current_day == $fc_day ) {
|
|
$restOfDaySum{'PV'} += $fc_obj->{'PvMeanPower'}->{'Amount'};
|
|
$restOfDaySum{'Consumption'} += $fc_obj->{'ConsumptionForecast'}->{'Amount'} / 3600;
|
|
$restOfDaySum{'Total'} += $fc_obj->{'PvMeanPower'}->{'Amount'} - $fc_obj->{'ConsumptionForecast'}->{'Amount'} / 3600;
|
|
$restOfDaySum{'ConsumpRcmd'} += $fc_obj->{'IsConsumptionRecommended'} ? 1 : 0;
|
|
}
|
|
|
|
# If data is for the next day (quick and dirty: current day different from this object's day)
|
|
# Assuming only the current day and the next day are returned from Sunny Portal
|
|
if ( $current_day != $fc_day ) {
|
|
$tomorrowSum{'PV'} += $fc_obj->{'PvMeanPower'}->{'Amount'} if(exists($fc_obj->{'PvMeanPower'}->{'Amount'}));
|
|
$tomorrowSum{'Consumption'} += $fc_obj->{'ConsumptionForecast'}->{'Amount'} / 3600;
|
|
$tomorrowSum{'Total'} += $fc_obj->{'PvMeanPower'}->{'Amount'} - $fc_obj->{'ConsumptionForecast'}->{'Amount'} / 3600 if ($fc_obj->{'PvMeanPower'}->{'Amount'});
|
|
$tomorrowSum{'ConsumpRcmd'} += $fc_obj->{'IsConsumptionRecommended'} ? 1 : 0;
|
|
}
|
|
|
|
# Update values in Fhem if less than 24 hours in the future
|
|
if($dl >= 4) {
|
|
if ($obj_nr < 24) {
|
|
my $time_str = "ThisHour";
|
|
$time_str = "NextHour".sprintf("%02d", $obj_nr) if($fc_diff_hours>0);
|
|
readingsBulkUpdate( $hash, "L4_${time_str}_Time", $fc_obj->{'TimeStamp'}->{'DateTime'} );
|
|
readingsBulkUpdate( $hash, "L4_${time_str}_PvMeanPower", int( $fc_obj->{'PvMeanPower'}->{'Amount'} ) );
|
|
readingsBulkUpdate( $hash, "L4_${time_str}_Consumption", int( $fc_obj->{'ConsumptionForecast'}->{'Amount'} / 3600 ) );
|
|
readingsBulkUpdate( $hash, "L4_${time_str}_IsConsumptionRecommended", ($fc_obj->{'IsConsumptionRecommended'} ? "yes" : "no") );
|
|
readingsBulkUpdate( $hash, "L4_${time_str}", int( $fc_obj->{'PvMeanPower'}->{'Amount'} - $fc_obj->{'ConsumptionForecast'}->{'Amount'} / 3600 ) );
|
|
}
|
|
}
|
|
|
|
# Increment object counter
|
|
$obj_nr++;
|
|
}
|
|
|
|
if($dl >= 2) {
|
|
readingsBulkUpdate($hash, "L2_Next04Hours-Consumption", int( $nextFewHoursSum{'Consumption'} ) );
|
|
readingsBulkUpdate($hash, "L2_Next04Hours-PV", int( $nextFewHoursSum{'PV'} ) );
|
|
readingsBulkUpdate($hash, "L2_Next04Hours-Total", int( $nextFewHoursSum{'Total'} ) );
|
|
readingsBulkUpdate($hash, "L2_Next04Hours-IsConsumptionRecommended", int( $nextFewHoursSum{'ConsumpRcmd'} ) );
|
|
readingsBulkUpdate($hash, "next04hours_state", int( $nextFewHoursSum{'PV'} ) );
|
|
}
|
|
|
|
if($dl >= 3) {
|
|
readingsBulkUpdate($hash, "L3_RestOfDay-Consumption", int( $restOfDaySum{'Consumption'} ) );
|
|
readingsBulkUpdate($hash, "L3_RestOfDay-PV", int( $restOfDaySum{'PV'} ) );
|
|
readingsBulkUpdate($hash, "L3_RestOfDay-Total", int( $restOfDaySum{'Total'} ) );
|
|
readingsBulkUpdate($hash, "L3_RestOfDay-IsConsumptionRecommended", int( $restOfDaySum{'ConsumpRcmd'} ) );
|
|
|
|
readingsBulkUpdate($hash, "L3_Tomorrow-Consumption", int( $tomorrowSum{'Consumption'} ) );
|
|
readingsBulkUpdate($hash, "L3_Tomorrow-PV", int( $tomorrowSum{'PV'} ) );
|
|
readingsBulkUpdate($hash, "L3_Tomorrow-Total", int( $tomorrowSum{'Total'} ) );
|
|
readingsBulkUpdate($hash, "L3_Tomorrow-IsConsumptionRecommended", int( $tomorrowSum{'ConsumpRcmd'} ) );
|
|
}
|
|
|
|
if($dl >= 4) {
|
|
readingsBulkUpdate($hash,"L4_plantOid",$plantOid);
|
|
}
|
|
|
|
readingsEndUpdate($hash, 1);
|
|
|
|
return;
|
|
}
|
|
|
|
################################################################
|
|
# sortiert eine Liste von Versionsnummern x.x.x
|
|
# Schwartzian Transform and the GRT transform
|
|
# Übergabe: "asc | desc",<Liste von Versionsnummern>
|
|
################################################################
|
|
sub SMAPortal_sortVersion (@) {
|
|
my ($sseq,@versions) = @_;
|
|
|
|
my @sorted = map {$_->[0]}
|
|
sort {$a->[1] cmp $b->[1]}
|
|
map {[$_, pack "C*", split /\./]} @versions;
|
|
|
|
@sorted = map {join ".", unpack "C*", $_}
|
|
sort
|
|
map {pack "C*", split /\./} @versions;
|
|
|
|
if($sseq eq "desc") {
|
|
@sorted = reverse @sorted;
|
|
}
|
|
|
|
return @sorted;
|
|
}
|
|
|
|
################################################################
|
|
# delete Readings
|
|
# $dl = detailLevel ab dem das Reading gelöscht werden soll
|
|
################################################################
|
|
sub SMAPortal_delread($;$) {
|
|
my ($hash,$dl) = @_;
|
|
my $name = $hash->{NAME};
|
|
my @allrds = keys%{$defs{$name}{READINGS}};
|
|
|
|
if($dl) {
|
|
# Readings ab dem angegebenen Detail-Level löschen
|
|
foreach my $key(@allrds) {
|
|
$key =~ m/^L(\d)_.*$/;
|
|
if($1 && $1 >= $dl) {
|
|
delete($defs{$name}{READINGS}{$key});
|
|
}
|
|
}
|
|
return;
|
|
}
|
|
|
|
foreach my $key(@allrds) {
|
|
delete($defs{$name}{READINGS}{$key}) if($key ne "state");
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
1;
|
|
|
|
=pod
|
|
=item summary Module for communication with SMA-Portal
|
|
=item summary_DE Mdul zur Kommunikation mit dem SMA-Portal
|
|
|
|
=begin html
|
|
|
|
<a name="SMAPortal"></a>
|
|
<h3>SMAPortal</h3>
|
|
|
|
<ul>
|
|
<br>
|
|
|
|
Is coming soon ...
|
|
|
|
</ul>
|
|
|
|
|
|
=end html
|
|
=begin html_DE
|
|
|
|
<a name="SMAPortal"></a>
|
|
<h3>SMAPortal</h3>
|
|
<ul>
|
|
|
|
Mit diesem Modul können Daten aus dem <a href="https://www.sunnyportal.com">SMA-Portal</a> abgerufen werden.
|
|
Momentan sind es: <br><br>
|
|
<ul>
|
|
<ul>
|
|
<li>Live-Daten (Verbrauch und PV-Erzeugung) </li>
|
|
<li>Prognosedaten (Verbrauch und PV-Erzeugung) inklusive Verbraucherempfehlung </li>
|
|
</ul>
|
|
</ul>
|
|
<br>
|
|
|
|
<b>Vorbereitung </b> <br><br>
|
|
|
|
<ul>
|
|
Dieses Modul nutzt das Perl-Modul JSON welches üblicherweise nachinstalliert werden muss. <br>
|
|
Auf Debian-Linux basierenden Systemen kann es installiert werden mit: <br><br>
|
|
|
|
<code>sudo apt-get install libjson-perl</code> <br><br>
|
|
|
|
Überblick über die Perl-Module welche von SMAPortal genutzt werden: <br><br>
|
|
|
|
POSIX <br>
|
|
JSON <br>
|
|
Data::Dumper <br>
|
|
Time::HiRes <br>
|
|
Blocking (FHEM-Modul) <br>
|
|
LWP::UserAgent <br>
|
|
HTTP::Cookies
|
|
|
|
<br><br>
|
|
</ul>
|
|
|
|
<a name="SMAPortalDefine"></a>
|
|
<b>Definition</b>
|
|
<ul>
|
|
<br>
|
|
Ein SMAPortal-Device wird definiert mit: <br><br>
|
|
|
|
<ul>
|
|
<b><code>define <Name> SMAPortal</code></b> <br><br>
|
|
</ul>
|
|
|
|
Nach der Definition des Devices müssen noch die Zugangsparameter für das SMA-Portal gespeichert werden.
|
|
Das geschieht mit dem Befehl: <br><br>
|
|
|
|
<ul>
|
|
set <Name> credentials <Username> <Passwort>
|
|
</ul>
|
|
</ul>
|
|
<br><br>
|
|
|
|
<a name="SMAPortalSet"></a>
|
|
<b>Set </b>
|
|
<ul>
|
|
<br>
|
|
<ul>
|
|
<li><b> set <name> credentials <username> <password> </b> </li>
|
|
Setzt Username / Passwort für den Zugriff zum SMA-Portal.
|
|
</ul>
|
|
</ul>
|
|
<br><br>
|
|
|
|
<a name="SMAPortalGet"></a>
|
|
<b>Get</b>
|
|
<ul>
|
|
<br>
|
|
<ul>
|
|
<li><b> get <name> data </b> </li>
|
|
Mit diesem Befehl werden die Daten aus dem SMA-Portal manuell abgerufen.
|
|
</ul>
|
|
<br>
|
|
|
|
<ul>
|
|
<li><b> get <name> storedCredentials </b> </li>
|
|
Die gespeicherten Anmeldeinformationen (Credentials) werden in einem Popup als Klartext angezeigt.
|
|
</ul>
|
|
</ul>
|
|
<br><br>
|
|
|
|
<a name="SMAPortalAttr"></a>
|
|
<b>Attribute</b>
|
|
<ul>
|
|
<br>
|
|
<ul>
|
|
<a name="cookielifetime"></a>
|
|
<li><b>cookielifetime <Sekunden> </b><br>
|
|
Gültigkeitszeitraum für einen empfangenen Cookie (Default: 3000 Sekunden).
|
|
</li><br>
|
|
|
|
<a name="cookieLocation"></a>
|
|
<li><b>cookieLocation <Pfad/File> </b><br>
|
|
Angabe von Pfad und Datei zur Abspeicherung des empfangenen Cookies (Default: ./log/mycookies.txt).
|
|
<br><br>
|
|
|
|
<ul>
|
|
<b>Beispiel:</b><br>
|
|
attr <name> cookieLocation ./log/cookies.txt <br>
|
|
</ul>
|
|
</li><br>
|
|
|
|
<a name="detailLevel"></a>
|
|
<li><b>detailLevel </b><br>
|
|
Es wird der Umfang der zu generierenden Daten eingestellt.
|
|
<br><br>
|
|
|
|
<ul>
|
|
<table>
|
|
<colgroup> <col width=5%> <col width=95%> </colgroup>
|
|
<tr><td> <b>L1</b> </td><td>- nur Live-Daten werden generiert. </td></tr>
|
|
<tr><td> <b>L2</b> </td><td>- Live-Daten und Prognose der nächsten 4 Stunden </td></tr>
|
|
<tr><td> <b>L3</b> </td><td>- wie L2 und zusätzlich Daten des Resttages und Folgetages </td></tr>
|
|
<tr><td> <b>L4</b> </td><td>- wie L3 und zusätzlich die detaillierte Prognose der nächsten 24 Stunden </td></tr>
|
|
</table>
|
|
</ul>
|
|
<br>
|
|
</li><br>
|
|
|
|
<a name="disable"></a>
|
|
<li><b>disable</b><br>
|
|
Deaktiviert das Device. </li><br>
|
|
|
|
<a name="interval"></a>
|
|
<li><b>interval <Sekunden> </b><br>
|
|
Zeitintervall zum kontinuierlichen Datenabruf aus dem SMA-Portal (Default: 300 Sekunden). <br>
|
|
Ist "interval = 0" gesetzt, erfolgt kein automatischer Datenabruf und muss mit "get <name> data" manuell
|
|
erfolgen. </li><br>
|
|
|
|
<a name="showPassInLog"></a>
|
|
<li><b>showPassInLog</b><br>
|
|
Wenn gesetzt, wird das verwendete Passwort im Logfile angezeigt.
|
|
(default = 0) </li><br>
|
|
|
|
<a name="timeout"></a>
|
|
<li><b>timeout <Sekunden> </b><br>
|
|
Timeout-Wert für HTTP-Aufrufe zum SMA-Portal (Default: 30 Sekunden).
|
|
</li><br>
|
|
|
|
<a name="userAgent"></a>
|
|
<li><b>userAgent <Kennung> </b><br>
|
|
Es kann die User-Agent-Kennung zur Identifikation gegenüber dem Portal angegeben werden.
|
|
<br><br>
|
|
|
|
<ul>
|
|
<b>Beispiel:</b><br>
|
|
attr <name> userAgent Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:65.0) Gecko/20100101 Firefox/65.0 <br>
|
|
</ul>
|
|
</li><br>
|
|
|
|
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
</ul> |