Compare commits
No commits in common. "master" and "2.0" have entirely different histories.
170
98_TadoAPI.pm
170
98_TadoAPI.pm
@ -1,5 +1,5 @@
|
||||
#===============================================================================
|
||||
# $Id: 98_TadoAPI.pm 107 2025-04-07 06:15:20Z psycho160 $
|
||||
# $Id: 98_TadoAPI.pm 107 2025-03-10 06:15:20Z psycho160 $
|
||||
#
|
||||
# FILE: 98_TadoAPI.pm
|
||||
# - for oauth2 (2025)
|
||||
@ -58,17 +58,17 @@ my %gets = (
|
||||
"getZoneDevices" => "noArg",
|
||||
"getZoneInfo" => "noArg",
|
||||
"getGeo" => "",
|
||||
|
||||
"getDeviceCode" => "noArg",
|
||||
"getMobileDevices" => "noArg"
|
||||
);
|
||||
|
||||
sub TadoAPI_Initialize {
|
||||
my $hash = shift;
|
||||
my $TYPE = "TadoAPI";
|
||||
|
||||
$hash->{DefFn} = \&TadoAPI_Define;
|
||||
$hash->{InitFn} = \&TadoAPI_Init;
|
||||
$hash->{UndefFn} = \&TadoAPI_Undefine;
|
||||
$hash->{DeleteFn} = \&TadoAPI_Delete;
|
||||
$hash->{SetFn} = \&TadoAPI_Set;
|
||||
$hash->{GetFn} = \&TadoAPI_Get;
|
||||
$hash->{AttrList} = ""
|
||||
@ -87,8 +87,9 @@ sub TadoAPI_Init {
|
||||
my $def = shift;
|
||||
|
||||
my @args = split( "[ \t][ \t]*", $def );
|
||||
|
||||
my $u = "wrong syntax: define <name> TadoAPI <device_code>";
|
||||
|
||||
my $u =
|
||||
"wrong syntax: define <name> TadoAPI <username>";
|
||||
return $u if ( int(@args) < 2 );
|
||||
return;
|
||||
}
|
||||
@ -102,19 +103,17 @@ sub TadoAPI_Define {
|
||||
my $type = shift @a;
|
||||
my $tokenFileName = $tokenFile . "_" . $name;
|
||||
|
||||
my ( $dev_code ) = @a;
|
||||
my ( $user, $homeID ) = @a;
|
||||
Log3 $name, 3, "TadoAPI_Define $name: called ";
|
||||
|
||||
my $u = "wrong define syntax: define <name> TadoAPI";
|
||||
return $u if ( int(@a) > 1 );
|
||||
|
||||
defined $dev_code ? ($hash->{STATE} = "defined") : ($hash->{DEF} = "no_device_code_set");
|
||||
$hash->{STATE} = "defined";
|
||||
|
||||
# Initialize the device
|
||||
return $@ unless ( FHEM::Meta::SetInternals($hash) );
|
||||
|
||||
$hash->{TOKEN_FILE} = $tokenFileName;
|
||||
$hash->{TADO_DEV_CODE} = $dev_code;
|
||||
$hash->{TADO_USER} = $user;
|
||||
|
||||
my @args = ($homeID);
|
||||
|
||||
if ($main::init_done) {
|
||||
|
||||
@ -122,22 +121,26 @@ sub TadoAPI_Define {
|
||||
return TadoAPI_Catch($@) if $@;
|
||||
}
|
||||
|
||||
if ( defined($dev_code) && $dev_code ne "no_device_code_set" ) {
|
||||
if ( defined($user) ) {
|
||||
TadoAPI_CheckStatus($hash);
|
||||
TadoAPI_NewTokenRequest($hash);
|
||||
TadoAPI_LoadToken($hash);
|
||||
|
||||
# start the status update timer
|
||||
RemoveInternalTimer($hash);
|
||||
InternalTimer( gettimeofday() + 15, "TadoAPI_Update", $hash, 0 );
|
||||
|
||||
my $id = TadoAPI_GetHomeId($hash);
|
||||
if ( defined($id) && $id ne "" ) {
|
||||
$attr{$name}{homeID} = $id;
|
||||
if ( defined($homeID) && $homeID ne "" ) {
|
||||
$attr{$name}{homeID} = $homeID;
|
||||
}
|
||||
else {
|
||||
my $id = TadoAPI_GetHomeId($hash);
|
||||
if ( defined($id) && $id ne "" ) {
|
||||
$attr{$name}{homeID} = $id;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
else {
|
||||
$hash->{STATE} = "no_device_code_set";
|
||||
$hash->{STATE} = "no device_code set";
|
||||
}
|
||||
return;
|
||||
|
||||
@ -314,6 +317,16 @@ sub TadoAPI_Get {
|
||||
last;
|
||||
};
|
||||
|
||||
# only for testing
|
||||
$cmd eq "getXTest" and do {
|
||||
Log3 $name, 5, "TadoAPI $name" . ": " . "processing ($cmd)";
|
||||
my $zoneName = TadoAPI_GetZoneNameById( $hash, $value );
|
||||
$zoneName = "wrong Zone ID" unless $zoneName;
|
||||
$message = "Name: " . $zoneName;
|
||||
Log3 $name, 3, "TadoAPI $name" . ": " . "$cmd finished\n";
|
||||
last;
|
||||
};
|
||||
|
||||
$cmd eq "getZoneDevices" and do {
|
||||
Log3 $name, 3, "TadoAPI $name" . ": " . "processing ($cmd)";
|
||||
my @devArr = TadoAPI_GetTadoDevices($hash);
|
||||
@ -386,19 +399,13 @@ sub TadoAPI_Catch {
|
||||
sub TadoAPI_Undefine {
|
||||
my $hash = shift;
|
||||
my $name = shift;
|
||||
|
||||
RemoveInternalTimer($hash);
|
||||
|
||||
#todo remove tokenfile
|
||||
return;
|
||||
}
|
||||
|
||||
sub TadoAPI_Delete {
|
||||
my ( $hash, $name ) = @_;
|
||||
RemoveInternalTimer($hash);
|
||||
# Löschen von Token-File
|
||||
unlink($tokenFile . "_" . $name);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
sub TadoAPI_CheckStatus {
|
||||
my $hash = shift;
|
||||
my $name = $hash->{NAME};
|
||||
@ -461,8 +468,8 @@ sub TadoAPI_LoadToken {
|
||||
sub TadoAPI_RegisterNewDevice {
|
||||
my $hash = shift;
|
||||
my $name = $hash->{NAME};
|
||||
my $device_code = $hash->{TADO_USER};
|
||||
my $tokenFileName = $tokenFile . "_" . $name;
|
||||
|
||||
|
||||
my $data = {
|
||||
client_id => $client_id,
|
||||
@ -490,19 +497,18 @@ sub TadoAPI_RegisterNewDevice {
|
||||
. " - $err";
|
||||
}
|
||||
elsif ( $returnData ne "" ) {
|
||||
Log3 $name, 5, "Device registration URL: " . $param->{url} . " - returned: $returnData";
|
||||
Log3 $name, 5, "url " . $param->{url} . " - returned: $returnData";
|
||||
my $decoded_data = eval { decode_json($returnData) };
|
||||
if ($@) {
|
||||
Log3 $name, 3, "TadoAPI $name" . ": "
|
||||
. "RegisterNewDevice: decode_json failed, invalid json. error: $@ ";
|
||||
}
|
||||
else {
|
||||
Log3 $name, 3,
|
||||
Log3 $name, 5,
|
||||
"TadoAPI $name" . ": "
|
||||
. "New Device - Please go to URL: "
|
||||
. "New Device - Please go to "
|
||||
. $decoded_data->{'verification_uri_complete'};
|
||||
|
||||
$hash->{STATE} = "OK";
|
||||
$hash->{STATE} = "reachable";
|
||||
|
||||
return ($decoded_data->{'verification_uri_complete'}, $decoded_data->{'device_code'});
|
||||
}
|
||||
@ -510,94 +516,6 @@ sub TadoAPI_RegisterNewDevice {
|
||||
return;
|
||||
}
|
||||
|
||||
sub TadoAPI_NewTokenRequest {
|
||||
my $hash = shift;
|
||||
my $name = $hash->{NAME};
|
||||
my $device_code = $hash->{TADO_DEV_CODE};
|
||||
my $tokenFileName = $tokenFile . "_" . $name;
|
||||
my $Token = undef;
|
||||
|
||||
Log3 $name, 5, "TadoAPI $name" . ": " . "calling NewTokenRequest()";
|
||||
|
||||
# Check if 'refresh_token' exists or a new token is needed
|
||||
my $TOKENFILE;
|
||||
eval {
|
||||
open( $TOKENFILE, q{<}, $tokenFileName ) or do {
|
||||
return;
|
||||
};
|
||||
$Token = decode_json(<$TOKENFILE>) };
|
||||
close($TOKENFILE);
|
||||
|
||||
if (exists $Token->{'refresh_token'}) {
|
||||
Log3 $name, 3, "TadoAPI $name" . ": " . "Refresh token exists - OK\n";
|
||||
return;
|
||||
} else {
|
||||
Log3 $name, 3, "TadoAPI $name" . ": " . "No Refresh token - NewTokenRequest start\n";
|
||||
}
|
||||
|
||||
|
||||
my $data = {
|
||||
client_id => $client_id,
|
||||
device_code => $device_code,
|
||||
grant_type => 'urn:ietf:params:oauth:grant-type:device_code'
|
||||
};
|
||||
|
||||
my $param = {
|
||||
url => $AuthURL,
|
||||
method => 'POST',
|
||||
timeout => 5,
|
||||
hash => $hash,
|
||||
data => $data
|
||||
};
|
||||
|
||||
#Log3 $name, 5, 'Blocking GET: ' . Dumper($param);
|
||||
Log3 $name, $reqDebug, "TadoAPI $name" . ": " . "Request NEW Token from: $AuthURL";
|
||||
my ( $err, $returnData ) = HttpUtils_BlockingGet($param);
|
||||
|
||||
if ( $err ne "" ) {
|
||||
Log3 $name, 3,
|
||||
"TadoAPI $name" . ": "
|
||||
. "NewTokenRequest: Error while requesting "
|
||||
. $param->{url}
|
||||
. " - $err";
|
||||
}
|
||||
elsif ( $returnData ne "" ) {
|
||||
Log3 $name, 5, "url " . $param->{url} . " returned: $returnData";
|
||||
my $decoded_data = eval { decode_json($returnData) };
|
||||
if ($@) {
|
||||
Log3 $name, 3, "TadoAPI $name" . ": "
|
||||
. "NewTokenRequest: decode_json failed, invalid json. error: $@ ";
|
||||
}
|
||||
else {
|
||||
#write token data in file
|
||||
open( my $TOKENFILE, q{>}, $tokenFileName ) or do {
|
||||
$apiStatus = 0;
|
||||
$hash->{STATE} = "Token error";
|
||||
return;
|
||||
};
|
||||
print $TOKENFILE $returnData . "\n";
|
||||
close($TOKENFILE);
|
||||
|
||||
# token lifetime management
|
||||
if ( defined($decoded_data->{'expires_in'}) ){
|
||||
$hash->{TOKEN_LIFETIME} = gettimeofday() + $decoded_data->{'expires_in'};
|
||||
}
|
||||
$hash->{TOKEN_LIFETIME_HR} = localtime( $hash->{TOKEN_LIFETIME} );
|
||||
Log3 $name, 5,
|
||||
"TadoAPI $name" . ": "
|
||||
. "Retrived new authentication token successfully. Valid until "
|
||||
. localtime( $hash->{TOKEN_LIFETIME} );
|
||||
$hash->{STATE} = "reachable";
|
||||
# refresh FHEM device
|
||||
TadoAPI_UpdateFn($hash);
|
||||
return $decoded_data;
|
||||
}
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
sub TadoAPI_TokenRefresh {
|
||||
my $hash = shift;
|
||||
@ -616,8 +534,6 @@ sub TadoAPI_TokenRefresh {
|
||||
$Token = decode_json(<$TOKENFILE>) };
|
||||
close($TOKENFILE);
|
||||
|
||||
|
||||
|
||||
my $data = {
|
||||
client_id => $client_id,
|
||||
scope => $scope,
|
||||
@ -663,9 +579,9 @@ sub TadoAPI_TokenRefresh {
|
||||
return;
|
||||
} else {
|
||||
#write token data in file
|
||||
open( $TOKENFILE, q{>}, $tokenFileName ) or do {
|
||||
open( my $TOKENFILE, q{>}, $tokenFileName ) or do {
|
||||
$apiStatus = 0;
|
||||
$hash->{STATE} = "Token open error";
|
||||
$hash->{STATE} = "Token error";
|
||||
return;
|
||||
};
|
||||
print $TOKENFILE $returnData . "\n";
|
||||
@ -955,7 +871,7 @@ sub TadoAPI_callback {
|
||||
|
||||
my $hash = $param->{hash};
|
||||
my $name = $hash->{NAME};
|
||||
|
||||
print Dumper($param);
|
||||
$param->{code} = 0 unless defined $param->{code};
|
||||
|
||||
if ( $param->{code} == 405 || $param->{code} == 400 ) {
|
||||
|
||||
@ -40,10 +40,13 @@ Für Fragen / Anliegen bin ich im FHEM-Forum (https://forum.fhem.de/index.php/to
|
||||
|
||||
In FHEM wird das Modul mit folgenden Schritten definiert:
|
||||
|
||||
Wenn man noch keinen `device_code` hat (Standard)
|
||||
Wenn man noch keinen `device_code` hat
|
||||
|
||||
* `define <name> TadoAPI`
|
||||
|
||||
sonst kann man ihn gleich mitgeben mit:
|
||||
|
||||
`define <name> TadoAPI [<device_code>] [<homeID>]`
|
||||
|
||||
### Wichtig: Device einrichten
|
||||
|
||||
@ -54,9 +57,6 @@ Danach muss man das FHEM Device bei tado registrieren. ->
|
||||
* `device_code` beim DEF in FHEM einfügen
|
||||
* Fertig
|
||||
|
||||
Optional: Wenn man schon einen Device Code hat, kann man ihn gleich mitgeben mit:
|
||||
|
||||
`define <name> TadoAPI <device_code>`
|
||||
|
||||
<img src="https://git.wolfmajer.at/Public/FHEM-Tado/raw/branch/master/doc/define.png" width="500" />
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user