docs: add changelog file

change modul versions

CHANGED

@@ -0,0 +1 @@
+    spellcheck + corrections

FHEM/73_GardenaSmartBridge.pm

@@ -1,8 +1,8 @@
 ###############################################################################
 #
-# Developed with Kate
+# Developed with VSCodium and richterger perl plugin.
 #
-#  (c) 2017-2021 Copyright: Marko Oldenburg (fhemdevelopment at cooltux dot net)
+#  (c) 2017-2022 Copyright: Marko Oldenburg (fhemdevelopment at cooltux dot net)
 #  All rights reserved
 #
 #   Special thanks goes to comitters:
@@ -57,7 +57,6 @@
 package FHEM::GardenaSmartBridge;
 use GPUtils qw(GP_Import GP_Export);
 
-
 use strict;
 use warnings;
 use POSIX;
@@ -66,11 +65,12 @@ use FHEM::Meta;
 use HttpUtils;
 
 my $missingModul = '';
-eval "use Encode qw(encode encode_utf8 decode_utf8);1"
+eval { use Encode qw /encode_utf8 decode_utf8/; 1 }
   or $missingModul .= "Encode ";
 
 # eval "use JSON;1" || $missingModul .= 'JSON ';
-eval "use IO::Socket::SSL;1" or $missingModul .= 'IO::Socket::SSL ';
+eval { use IO::Socket::SSL; 1 }
+  or $missingModul .= 'IO::Socket::SSL ';
 
 # try to use JSON::MaybeXS wrapper
 #   for chance of better performance + open code
@@ -78,15 +78,11 @@ eval {
     require JSON::MaybeXS;
     import JSON::MaybeXS qw( decode_json encode_json );
     1;
-};
-
-if ($@) {
-    $@ = undef;
+} or do {
 
     # try to use JSON wrapper
     #   for chance of better performance
     eval {
-
         # JSON preference order
         local $ENV{PERL_JSON_BACKEND} =
           'Cpanel::JSON::XS,JSON::XS,JSON::PP,JSON::backportPP'
@@ -95,10 +91,7 @@ if ($@) {
         require JSON;
         import JSON qw( decode_json encode_json );
         1;
-    };
-
-    if ($@) {
-        $@ = undef;
+    } or do {
 
         # In rare cases, Cpanel::JSON::XS may
         #   be installed but JSON|JSON::MaybeXS not ...
@@ -106,10 +99,7 @@ if ($@) {
             require Cpanel::JSON::XS;
             import Cpanel::JSON::XS qw(decode_json encode_json);
             1;
-        };
-
-        if ($@) {
-            $@ = undef;
+        } or do {
 
             # In rare cases, JSON::XS may
             #   be installed but JSON not ...
@@ -117,10 +107,7 @@ if ($@) {
                 require JSON::XS;
                 import JSON::XS qw(decode_json encode_json);
                 1;
-            };
-
-            if ($@) {
-                $@ = undef;
+            } or do {
 
                 # Fallback to built-in JSON which SHOULD
                 #   be available since 5.014 ...
@@ -128,20 +115,17 @@ if ($@) {
                     require JSON::PP;
                     import JSON::PP qw(decode_json encode_json);
                     1;
-                };
-
-                if ($@) {
-                    $@ = undef;
+                } or do {
 
                     # Fallback to JSON::backportPP in really rare cases
                     require JSON::backportPP;
                     import JSON::backportPP qw(decode_json encode_json);
                     1;
-                }
-            }
-        }
-    }
-}
+                };
+            };
+        };
+    };
+};
 
 ## Import der FHEM Funktionen
 #-- Run before package compilation
@@ -205,6 +189,7 @@ sub Initialize {
     $hash->{AttrFn} = \&Attr;
     $hash->{AttrList} =
         'debugJSON:0,1 '
+      . 'debugDEVICE:0,1 '
       . 'disable:1 '
       . 'interval '
       . 'disabledForIntervals '
@@ -234,9 +219,7 @@ sub Define {
     my $name = shift @$aArg;
     $hash->{BRIDGE} = 1;
     $hash->{URL} =
-      AttrVal( $name, 'gardenaBaseURL',
-        'https://smart.gardena.com' )
-      . '/v1';
+      AttrVal( $name, 'gardenaBaseURL', 'https://smart.gardena.com' ) . '/v1';
     $hash->{VERSION}   = version->parse($VERSION)->normal;
     $hash->{INTERVAL}  = 60;
     $hash->{NOTIFYDEV} = "global,$name";
@@ -258,7 +241,7 @@ sub Undef {
     my $hash = shift;
     my $name = shift;
 
-    RemoveInternalTimer($hash);
+    RemoveInternalTimer( $hash, "FHEM::GardenaSmartBridge::getDevices" );
     delete $modules{GardenaSmartBridge}{defptr}{BRIDGE}
       if ( defined( $modules{GardenaSmartBridge}{defptr}{BRIDGE} ) );
 
@@ -279,7 +262,8 @@ sub Attr {
 
     if ( $attrName eq 'disable' ) {
         if ( $cmd eq 'set' && $attrVal eq '1' ) {
-            RemoveInternalTimer($hash);
+            RemoveInternalTimer( $hash,
+                "FHEM::GardenaSmartBridge::getDevices" );
             readingsSingleUpdate( $hash, 'state', 'inactive', 1 );
             Log3 $name, 3, "GardenaSmartBridge ($name) - disabled";
         }
@@ -304,13 +288,15 @@ sub Attr {
         if ( $cmd eq 'set' ) {
             return 'Interval must be greater than 0'
               if ( $attrVal == 0 );
-            RemoveInternalTimer($hash);
+            RemoveInternalTimer( $hash,
+                "FHEM::GardenaSmartBridge::getDevices" );
             $hash->{INTERVAL} = $attrVal;
             Log3 $name, 3,
               "GardenaSmartBridge ($name) - set interval: $attrVal";
         }
         elsif ( $cmd eq 'del' ) {
-            RemoveInternalTimer($hash);
+            RemoveInternalTimer( $hash,
+                "FHEM::GardenaSmartBridge::getDevices" );
             $hash->{INTERVAL} = 60;
             Log3 $name, 3,
 "GardenaSmartBridge ($name) - delete User interval and set default: 60";
@@ -352,25 +338,21 @@ sub Notify {
                 @{$events} or grep /^DEFINED.$name$/,
                 @{$events} or grep /^MODIFIED.$name$/,
                 @{$events} or grep /^ATTR.$name.gardenaAccountEmail.+/,
+                @{$events} or grep /^DELETEATTR.$name.disable$/,
                 @{$events}
             )
         )
 
-        || (
-            $devtype eq 'GardenaSmartBridge'
-            && (
-                grep /^gardenaAccountPassword.+/,
-                @{$events}
-            )
-        )
+        || ( $devtype eq 'GardenaSmartBridge'
+            && ( grep /^gardenaAccountPassword.+/, @{$events} ) )
+        && $init_done
       );
 
     getDevices($hash)
       if (
         $devtype eq 'Global'
         && (
-            grep /^DELETEATTR.$name.disable$/,
-            @{$events} or grep /^ATTR.$name.disable.0$/,
+            grep /^ATTR.$name.disable.0$/,
             @{$events} or grep /^DELETEATTR.$name.interval$/,
             @{$events} or grep /^ATTR.$name.interval.[0-9]+/,
             @{$events}
@@ -387,7 +369,6 @@ sub Notify {
         )
       )
     {
-
         InternalTimer( gettimeofday() + $hash->{INTERVAL},
             "FHEM::GardenaSmartBridge::getDevices", $hash );
         Log3 $name, 4,
@@ -396,6 +377,7 @@ sub Notify {
 
     return;
 }
+
 sub Get {
     my $hash = shift // return;
     my $aArg = shift // return;
@@ -407,14 +389,15 @@ sub Get {
     if ( lc $cmd eq 'debug_devices_list' ) {
         my $device = shift @$aArg;
         $hash->{helper}{debug_device} = $device;
-        Write($hash, undef, undef, undef, undef); 
-        return undef;
-    } else {
+        Write( $hash, undef, undef, undef, undef );
+        return;
+    }
+    else {
         my $list = "";
-        $list .= " debug_devices_list:"
-          .join( ',', @{ $hash->{helper}{deviceList} }) 
-          if ( AttrVal( $name, "debugJSON", "none") ne "none" 
-           && exists($hash->{helper}{deviceList}) );
+        $list .=
+          " debug_devices_list:" . join( ',', @{ $hash->{helper}{deviceList} } )
+          if ( AttrVal( $name, "debugDEVICE", "none" ) ne "none"
+            && exists( $hash->{helper}{deviceList} ) );
         return "Unknown argument $cmd,choose one of $list";
     }
 }
@@ -424,13 +407,13 @@ sub Set {
     my $aArg = shift // return;
 
     my $name = shift @$aArg // return;
-    my $cmd  = shift @$aArg // return qq{"set $name" needs at least one argument};
+    my $cmd  = shift @$aArg
+      // return qq{"set $name" needs at least one argument};
 
 #     Das Argument für das Passwort, also das Passwort an sich darf keine = enthalten!!!
 
     if ( lc $cmd eq 'getdevicesstate' ) {
         getDevices($hash);
-
     }
     elsif ( lc $cmd eq 'gettoken' ) {
         return "please set Attribut gardenaAccountEmail first"
@@ -454,6 +437,15 @@ sub Set {
 
         DeletePassword($hash);
     }
+    elsif ( lc $cmd eq 'debughelper' ) {
+        return "usage: $cmd" if ( scalar( @{$aArg} ) != 2 );
+        my $new_helper       = $aArg->[0];
+        my $new_helper_value = $aArg->[1];
+        Log3( $name, 5,
+"[DEBUG] - GardenaSmartBridge ($name) - override helper $new_helper with $new_helper_value"
+        );
+        $hash->{helper}{$new_helper} = $new_helper_value;
+    }
     else {
 
         my $list = "getDevicesState:noArg getToken:noArg"
@@ -475,12 +467,14 @@ sub Write {
     my ( $session_id, $header, $uri, $method );
 
     ( $payload, $session_id, $header, $uri, $method, $deviceId, $service_id ) =
-      createHttpValueStrings( $hash, $payload, $deviceId, $abilities, $service_id );
+      createHttpValueStrings( $hash, $payload, $deviceId, $abilities,
+        $service_id );
 
     HttpUtils_NonblockingGet(
         {
             url                => $hash->{URL} . $uri,
             timeout            => 15,
+            incrementalTimeout => 1,
             hash               => $hash,
             device_id          => $deviceId,
             data               => $payload,
@@ -496,8 +490,8 @@ sub Write {
 "GardenaSmartBridge ($name) - Send with URL: $hash->{URL}$uri, HEADER: secret!, DATA: secret!, METHOD: $method"
     );
 
-    #  Log3($name, 3,
-    #      "GardenaSmartBridge ($name) - Send with URL: $hash->{URL}$uri, HEADER: $header, DATA: $payload, METHOD: $method");
+# Log3($name, 3,
+#     "GardenaSmartBridge ($name) - Send with URL: $hash->{URL}$uri, HEADER: $header, DATA: $payload, METHOD: $method");
 
     return;
 }
@@ -518,7 +512,7 @@ sub ErrorHandling {
 
     Log3 $name, 4, "GardenaSmartBridge ($name) - Request: $data";
 
-    my $decode_json = eval { decode_json($data) };
+    my $decode_json = eval { decode_json($data) } if ( length($data) > 0 );
     if ($@) {
         Log3 $name, 3, "GardenaSmartBridge ($name) - JSON error while request";
     }
@@ -534,7 +528,6 @@ sub ErrorHandling {
                 1 );
 
             if ( $err =~ /timed out/ ) {
-
                 Log3 $dname, 5,
 "GardenaSmartBridge ($dname) - RequestERROR: connect to gardena cloud is timed out. check network";
             }
@@ -620,7 +613,7 @@ sub ErrorHandling {
     }
 
     if (
-        $data =~ /Error/
+        $data =~ /Error/ && $data !~ /lastLonaErrorCode/
         || (   defined($decode_json)
             && ref($decode_json) eq 'HASH'
             && defined( $decode_json->{errors} ) )
@@ -698,6 +691,11 @@ sub ErrorHandling {
               . $param->{code};
         }
 
+        if ( !defined( $hash->{helper}{session_id} ) ) {
+            readingsSingleUpdate( $hash, 'token', 'none', 1 );
+            InternalTimer( gettimeofday() + 5,
+                "FHEM::GardenaSmartBridge::getToken", $hash );
+        }
         readingsEndUpdate( $dhash, 1 );
 
         Log3 $dname, 5,
@@ -710,29 +708,58 @@ sub ErrorHandling {
 
         return;
     }
- if (defined($hash->{helper}{debug_device})){
-      Log3 $name, 5, "GardenaSmartBridge DEBUG Device";
-      my @device_spec = ("name", "id", "category");
-      my $devJson=$decode_json->{devices};
-      my $output = '.:{ DEBUG OUTPUT for '.$devJson->{name}.' }:. \n';
+    elsif ( defined( $decode_json->{message} )
+        && $decode_json->{message} eq 'Unauthorized' )
+    {
+        Log3 $name, 3,
+          "GardenaSmartBridge ($name) - Unauthorized -> fetch new token ";
+
+        getToken($hash);
+
+        return;
+    }
+
+    if ( defined( $hash->{helper}{debug_device} )
+        && $hash->{helper}{debug_device} ne 'none' )
+    {
+        Log3 $name, 4, "GardenaSmartBridge DEBUG Device";
+        delete $hash->{helper}{debug_device};
+
+        my @device_spec = ( "name", "id", "category" );
+        my $devJson     = $decode_json->{devices};
+        my $output = '.:{ DEBUG OUTPUT for ' . $devJson->{name} . ' }:. \n';
+
         for my $spec (@device_spec) {
             $output .= "$spec : $devJson->{$spec} \n";
         }
+
         #settings
         $output .= '\n=== Settings \n';
         my $i = 0;
-      for my $dev_settings ( @ { $devJson->{settings} } ) {
-        $output .= "[".$i++."]id: $dev_settings->{id} \n";
-        $output .= "name: $dev_settings->{name} ";
-        if (ref ($dev_settings->{value}) eq 'ARRAY' 
-          || ref ($dev_settings->{value}) eq 'HASH'){
+        for my $dev_settings ( @{ $devJson->{settings} } ) {
+            $output .= "[" . $i++ . "]id: $dev_settings->{id} \n";
+            $output .= "name: $dev_settings->{name} \n";
+            if (   ref( $dev_settings->{value} ) eq 'ARRAY'
+                || ref( $dev_settings->{value} ) eq 'HASH' )
+            {
                 $output .= 'N/A \n';
-        } else {
+            }
+            else {
                 $output .= "value: $dev_settings->{value} \n";
             }
         }
+
+        $output .= '\n=== Abilities \n';
+        $i = 0;
+
+        for my $dev_settings ( @{ $devJson->{abilities} } ) {
+            $output .= "[" . $i++ . "]id: $dev_settings->{id} \n";
+            $output .= "name: $dev_settings->{name} \n";
+        }
+
         $hash->{helper}{debug_device_output} = $output;
-      asyncOutput($param->{cl},  $hash->{helper}{debug_device_output});
+        asyncOutput( $param->{cl}, $hash->{helper}{debug_device_output} );
+
         return;
     }
     readingsSingleUpdate( $hash, 'state', 'Connected', 1 )
@@ -762,15 +789,21 @@ sub ResponseProcessing {
         }
     }
 
-    # print Dumper $decode_json;
-
-    if ( defined( $decode_json->{data} ) && $decode_json->{data} 
-        && ref($decode_json->{data}) eq 'HASH'
-        && !defined( $hash->{helper}->{user_id})) {
+    if (   defined( $decode_json->{data} )
+        && $decode_json->{data}
+        && ref( $decode_json->{data} ) eq 'HASH'
+        && !defined( $hash->{helper}->{user_id} ) )
+    {
 
         $hash->{helper}{session_id} = $decode_json->{data}{id};
         $hash->{helper}{user_id} = $decode_json->{data}{attributes}->{user_id};
-        $hash->{helper}{refresh_token}  = $decode_json->{data}{attributes}->{refresh_token};
+        $hash->{helper}{refresh_token} =
+          $decode_json->{data}{attributes}->{refresh_token};
+        $hash->{helper}{token_expired} =
+          gettimeofday() + $decode_json->{data}{attributes}->{expires_in};
+
+        InternalTimer( $hash->{helper}{token_expired},
+            "FHEM::GardenaSmartBridge::getToken", $hash );
 
         Write( $hash, undef, undef, undef );
         Log3 $name, 3, "GardenaSmartBridge ($name) - fetch locations id";
@@ -802,50 +835,35 @@ sub ResponseProcessing {
         && ref( $decode_json->{devices} ) eq 'ARRAY'
         && scalar( @{ $decode_json->{devices} } ) > 0 )
     {
-
         my @buffer = split( '"devices":\[', $json );
 
-        my ( $json, $tail ) = ParseJSON( $hash, $buffer[1] );
+        require SubProcess;
 
-        while ($json) {
+        my $subprocess =
+          SubProcess->new( { onRun => \&ResponseSubprocessing } );
+        $subprocess->{buffer} = $buffer[1];
 
-            Log3 $name, 5,
-                "GardenaSmartBridge ($name) - Decoding JSON message. Length: "
-              . length($json)
-              . " Content: "
-              . $json;
-            Log3 $name, 5,
-                "GardenaSmartBridge ($name) - Vor Sub: Laenge JSON: "
-              . length($json)
-              . " Content: "
-              . $json
-              . " Tail: "
-              . $tail;
+        my $pid = $subprocess->run();
 
-            if ( defined($tail) and $tail ) {
-                $decode_json = eval { decode_json($json) };
-                if ($@) {
-                    Log3 $name, 5,
-"GardenaSmartBridge ($name) - JSON error while request: $@";
+        if ( !defined($pid) ) {
+            Log3( $name, 1,
+qq{GardenaSmartBridge ($name) - Cannot execute parse json asynchronously}
+            );
+
+            CleanSubprocess($hash);
+            readingsSingleUpdate( $hash, 'state',
+                'Cannot execute parse json asynchronously', 1 );
+            return;
         }
 
-                Dispatch( $hash, $json, undef )
-                  if ( $decode_json->{category} ne 'gateway' );
-                WriteReadings( $hash, $decode_json )
-                  if ( defined( $decode_json->{category} )
-                    && $decode_json->{category} eq 'gateway' );
-            }
+        Log3( $name, 4,
+qq{GardenaSmartBridge ($name) - execute parse json asynchronously (PID="$pid")}
+        );
 
-            ( $json, $tail ) = ParseJSON( $hash, $tail );
+        $hash->{".fhem"}{subprocess} = $subprocess;
 
-            Log3 $name, 5,
-                "GardenaSmartBridge ($name) - Nach Sub: Laenge JSON: "
-              . length($json)
-              . " Content: "
-              . $json
-              . " Tail: "
-              . $tail;
-        }
+        InternalTimer( gettimeofday() + 1,
+            "FHEM::GardenaSmartBridge::PollChild", $hash );
 
         return;
     }
@@ -855,12 +873,148 @@ sub ResponseProcessing {
     return;
 }
 
+sub ResponseProcessingFinalFromSubProcessing {
+    my $hash     = shift;
+    my $response = shift;
+
+    my $name = $hash->{NAME};
+
+    my @response = split '\|,', $response;
+
+    Log3( $name, 4,
+        qq{GardenaSmartBridge ($name) - got result from asynchronous parsing} );
+
+    my $decode_json;
+
+    Log3( $name, 4, qq{GardenaSmartBridge ($name) - asynchronous finished.} );
+
+    if ( scalar(@response) > 0 ) {
+        for my $json (@response) {
+
+            #################
+            $decode_json = eval { decode_json($json) };
+            if ($@) {
+                Log3 $name, 5,
+                  "GardenaSmartBridge ($name) - JSON error while request: $@";
+            }
+
+            Dispatch( $hash, $json, undef )
+              if ( $decode_json->{category} ne 'gateway' );
+            WriteReadings( $hash, $decode_json )
+              if ( defined( $decode_json->{category} )
+                && $decode_json->{category} eq 'gateway' );
+        }
+    }
+
+    return;
+}
+
+sub PollChild {
+    my $hash = shift;
+
+    my $name = $hash->{NAME};
+
+    if ( defined( $hash->{".fhem"}{subprocess} ) ) {
+        my $subprocess = $hash->{".fhem"}{subprocess};
+        my $response   = $subprocess->readFromChild();
+
+        if ( defined($response) ) {
+            ResponseProcessingFinalFromSubProcessing( $hash, $response );
+            $subprocess->wait();
+            CleanSubprocess($hash);
+        }
+
+        Log3( $name, 4,
+qq{GardenaSmartBridge ($name) - still waiting ($subprocess->{lasterror}).}
+        );
+
+        InternalTimer( gettimeofday() + 1,
+            "FHEM::GardenaSmartBridge::PollChild", $hash );
+        return;
+    }
+
+    return;
+}
+
+# ResponseSubprocessin muss in eine async ausgelagert werden
+######################################
+# Begin Childprozess
+######################################
+sub ResponseSubprocessing {
+    my $subprocess = shift;
+    my $buffer     = $subprocess->{buffer};
+    my @response   = ();
+
+    my ( $json, $tail ) = ParseJSON($buffer);
+
+    while ($json) {
+        if ( defined($tail) and $tail ) {
+            push @response, $json;
+        }
+
+        ( $json, $tail ) = ParseJSON($tail);
+    }
+
+    $subprocess->writeToParent( join '|', @response );
+
+    return;
+}
+
+sub ParseJSON {
+    my $buffer = shift;
+
+    my $open  = 0;
+    my $close = 0;
+    my $msg   = '';
+    my $tail  = '';
+
+    if ($buffer) {
+        for my $c ( split //, $buffer ) {
+            if ( $open == $close && $open > 0 ) {
+                $tail .= $c;
+            }
+            else {
+
+                if ( $c eq '{' ) {
+
+                    $open++;
+
+                }
+                elsif ( $c eq '}' ) {
+
+                    $close++;
+                }
+
+                $msg .= $c;
+            }
+        }
+
+        if ( $open != $close ) {
+
+            $tail = $msg;
+            $msg  = '';
+        }
+    }
+
+    return ( $msg, $tail );
+}
+######################################
+# End Childprozess
+######################################
+
+sub CleanSubprocess {
+    my $hash = shift;
+
+    my $name = $hash->{NAME};
+
+    delete( $hash->{".fhem"}{subprocess} );
+    Log3( $name, 4, qq{GardenaSmartBridge ($name) - clean Subprocess} );
+}
+
 sub WriteReadings {
     my $hash        = shift;
     my $decode_json = shift;
 
-    #     print Dumper $decode_json;
-
     my $name = $hash->{NAME};
 
     if (   defined( $decode_json->{id} )
@@ -905,7 +1059,8 @@ sub WriteReadings {
                           {name} . '-' . $t,
                         $v
                       )
-                      if ($decode_json->{abilities}[0]{properties}[$properties]{name} !~ /ethernet_status|wifi_status/ );
+                      if ( $decode_json->{abilities}[0]{properties}[$properties]
+                        {name} !~ /ethernet_status|wifi_status/ );
                     if (
                         (
                             $decode_json->{abilities}[0]{properties}
@@ -931,10 +1086,9 @@ sub WriteReadings {
                         elsif ( $decode_json->{abilities}[0]{properties}
                             [$properties]{name} eq 'wifi_status' )
                         {
-                            #TODO: read valies if bridge connected to wifi
                             readingsBulkUpdateIfChanged( $hash,
                                 'wifi_status-ssid', $v->{ssid} )
-                              if (ref($v->{ssid}) ne 'HASH');
+                              if ( ref( $v->{ssid} ) ne 'HASH' );
                             readingsBulkUpdateIfChanged( $hash,
                                 'wifi_status-mac', $v->{mac} );
                             readingsBulkUpdateIfChanged( $hash,
@@ -967,23 +1121,25 @@ sub getDevices {
     my $hash = shift;
 
     my $name = $hash->{NAME};
-
-    RemoveInternalTimer($hash);
+    RemoveInternalTimer( $hash, "FHEM::GardenaSmartBridge::getDevices" );
 
     if ( not IsDisabled($name) ) {
 
         delete $hash->{helper}{deviceList};
         my @list;
         @list = devspec2array('TYPE=GardenaSmartDevice');
-        for my $gardenaDev (@list){
+        for my $gardenaDev (@list) {
             push( @{ $hash->{helper}{deviceList} }, $gardenaDev );
         }
+        if ( AttrVal( $name, 'gardenaAccountEmail', 'none' ) ne 'none'
+            && ( defined( ReadPassword( $hash, $name ) ) ) )
+        {
             Write( $hash, undef, undef, undef );
             Log3 $name, 4,
-          "GardenaSmartBridge ($name) - fetch device list and device states";
+"GardenaSmartBridge ($name) - fetch device list and device states";
+        }    # fi gardenaAccountEmail
     }
     else {
-
         readingsSingleUpdate( $hash, 'state', 'disabled', 1 );
         Log3 $name, 3, "GardenaSmartBridge ($name) - device is disabled";
     }
@@ -1005,36 +1161,29 @@ sub getToken {
     readingsSingleUpdate( $hash, 'state', 'get token', 1 );
 
     delete $hash->{helper}{session_id}
-      if ( defined( $hash->{helper}{session_id} )
-        && $hash->{helper}{session_id} );
+      if ( exists( $hash->{helper}{session_id} ) );
     delete $hash->{helper}{user_id}
-      if ( defined( $hash->{helper}{user_id} ) && $hash->{helper}{user_id} );
+      if ( exists( $hash->{helper}{user_id} ) );
     delete $hash->{helper}{locations_id}
-      if ( defined( $hash->{helper}{locations_id} )
-        && $hash->{helper}{locations_id} );
-
-    # Write(
-    #     $hash,
-    #     '"sessions": {"email": "'
-    #       . AttrVal( $name, 'gardenaAccountEmail', 'none' )
-    #       . '","password": "'
-    #       . ReadPassword( $hash, $name ) . '"}',
-    #     undef,
-    #     undef
-    # );
+      if ( exists( $hash->{helper}{locations_id} ) );
 
     Write(
         $hash,
         '"data": {"type":"token", "attributes":{"username": "'
           . AttrVal( $name, 'gardenaAccountEmail', 'none' )
           . '","password": "'
-            . ReadPassword( $hash, $name ) . '", "client_id":"smartgarden-jwt-client"}}',
+          . ReadPassword( $hash, $name )
+          . '", "client_id":"smartgarden-jwt-client"}}',
         undef,
         undef
     );
 
-Log3 $name, 4, '"data": {"type":"token", "attributes":{"username": "'      . AttrVal( $name, 'gardenaAccountEmail', 'none' )      . '","password": "'
-          . ReadPassword( $hash, $name ) . '", "client_id":"smartgarden-jwt-client"}}';
+    Log3 $name, 4,
+        '"data": {"type":"token", "attributes":{"username": "'
+      . AttrVal( $name, 'gardenaAccountEmail', 'none' )
+      . '","password": "'
+      . ReadPassword( $hash, $name )
+      . '", "client_id":"smartgarden-jwt-client"}}';
     Log3 $name, 3,
 "GardenaSmartBridge ($name) - send credentials to fetch Token and locationId";
 
@@ -1085,7 +1234,7 @@ sub ReadPassword {
 
         Log3 $name, 3,
 "GardenaSmartBridge ($name) - unable to read password from file: $err";
-        return undef;
+        return;
 
     }
 
@@ -1111,7 +1260,7 @@ sub ReadPassword {
     else {
 
         Log3 $name, 3, "GardenaSmartBridge ($name) - No password in file";
-        return undef;
+        return;
     }
 
     return;
@@ -1129,59 +1278,6 @@ sub Rename {
     return;
 }
 
-sub ParseJSON {
-    my $hash   = shift;
-    my $buffer = shift;
-
-    my $name  = $hash->{NAME};
-    my $open  = 0;
-    my $close = 0;
-    my $msg   = '';
-    my $tail  = '';
-
-    if ($buffer) {
-        for my $c ( split //, $buffer ) {
-            if ( $open == $close && $open > 0 ) {
-                $tail .= $c;
-                Log3 $name, 5,
-                  "GardenaSmartBridge ($name) - $open == $close and $open > 0";
-
-            }
-            elsif ( ( $open == $close ) && ( $c ne '{' ) ) {
-
-                Log3 $name, 5,
-"GardenaSmartBridge ($name) - Garbage character before message: "
-                  . $c;
-
-            }
-            else {
-
-                if ( $c eq '{' ) {
-
-                    $open++;
-
-                }
-                elsif ( $c eq '}' ) {
-
-                    $close++;
-                }
-
-                $msg .= $c;
-            }
-        }
-
-        if ( $open != $close ) {
-
-            $tail = $msg;
-            $msg  = '';
-        }
-    }
-
-    Log3 $name, 5,
-      "GardenaSmartBridge ($name) - return msg: $msg and tail: $tail";
-    return ( $msg, $tail );
-}
-
 sub createHttpValueStrings {
     my ( $hash, $payload, $deviceId, $abilities, $service_id ) = @_;
 
@@ -1190,9 +1286,9 @@ sub createHttpValueStrings {
     my $uri        = '';
     my $method     = 'POST';
     $header .= "\r\nAuthorization: Bearer $session_id"
-      if ( defined($hash->{helper}{session_id}) );
+      if ( defined( $hash->{helper}{session_id} ) );
     $header .= "\r\nAuthorization-Provider: husqvarna"
-      if ( defined($hash->{helper}{session_id}) );
+      if ( defined( $hash->{helper}{session_id} ) );
 
     #  $header .= "\r\nx-api-key: $session_id"
     #    if ( defined( $hash->{helper}{session_id} ) );
@@ -1200,20 +1296,23 @@ sub createHttpValueStrings {
     $payload = '{}'                 if ( !defined($payload) );
 
     if ( $payload eq '{}' ) {
-        $method = 'GET';
+        $method  = 'GET' if ( defined( $hash->{helper}{session_id} ) );
         $payload = '';
         $uri .= '/locations?locatioId=null&user_id=' . $hash->{helper}{user_id}
           if ( exists( $hash->{helper}{user_id} )
             && !defined( $hash->{helper}{locations_id} ) );
         readingsSingleUpdate( $hash, 'state', 'fetch locationId', 1 )
-          if ( !defined( $hash->{helper}{locations_id} ) );
-        $uri .= '/auth/token' if ( !defined( $hash->{helper}{session_id} ) );
+          if ( exists( $hash->{helper}{user_id} )
+            && !defined( $hash->{helper}{locations_id} ) );
         $uri .= '/devices'
           if (!defined($abilities)
             && defined( $hash->{helper}{locations_id} ) );
     }
 
-    $uri = '/devices/'.InternalVal($hash->{helper}{debug_device}, 'DEVICEID', 0 ) if ( exists ($hash->{helper}{debug_device}));
+    $uri =
+      '/devices/' . InternalVal( $hash->{helper}{debug_device}, 'DEVICEID', 0 )
+      if ( defined( $hash->{helper}{debug_device} )
+        && defined( $hash->{helper}{locations_id} ) );
     $uri = '/auth/token' if ( !defined( $hash->{helper}{session_id} ) );
 
     if ( defined( $hash->{helper}{locations_id} ) ) {
@@ -1222,11 +1321,7 @@ sub createHttpValueStrings {
             $method = 'PUT';
             my $dhash = $modules{GardenaSmartDevice}{defptr}{$deviceId};
 
-            $uri .=
-                '/devices/'
-              . $deviceId
-              . '/settings/'
-              . $service_id
+            $uri .= '/devices/' . $deviceId . '/settings/' . $service_id
               if ( defined($abilities)
                 && defined($payload)
                 && $abilities =~ /.*_settings/ );
@@ -1262,7 +1357,11 @@ sub createHttpValueStrings {
               . $deviceId
               . '/abilities/'
               . $abilities
-              . ( defined($valve_id) ? '/properties/watering_timer_'. $valve_id : '/command')
+              . (
+                defined($valve_id)
+                ? '/properties/watering_timer_' . $valve_id
+                : '/command'
+              );
 
         }
         elsif (defined($abilities)
@@ -1279,6 +1378,19 @@ sub createHttpValueStrings {
               . $abilities
               . '/properties/manual_watering_timer';
 
+        }
+        elsif (defined($abilities)
+            && defined($payload)
+            && $abilities eq 'watering_button_config' )
+        {
+            $method = 'PUT';
+
+            $uri .=
+                '/devices/'
+              . $deviceId
+              . '/abilities/watering'
+              . '/properties/button_config_time';
+
         }
         elsif (defined($abilities)
             && defined($payload)
@@ -1463,9 +1575,9 @@ sub DeletePassword {
   ],
   "release_status": "stable",
   "license": "GPL_2",
-  "version": "v2.4.0",
+  "version": "v2.6.0",
   "author": [
-    "Marko Oldenburg <leongaultier@gmail.com>"
+    "Marko Oldenburg <fhemdevelopment@cooltux.net>"
   ],
   "x_fhem_maintainer": [
     "CoolTux"

controls_GardenaSmartDevice.txt

@@ -1,2 +1,2 @@
-UPD 2021-05-22_04:53:56 46135 FHEM/73_GardenaSmartBridge.pm
-UPD 2021-05-22_04:54:14 51644 FHEM/74_GardenaSmartDevice.pm
+UPD 2023-01-10_09:49:28 49646 FHEM/73_GardenaSmartBridge.pm
+UPD 2023-01-10_09:49:45 126305 FHEM/74_GardenaSmartDevice.pm

hooks/commit-msg

@@ -0,0 +1,36 @@
+#!/bin/sh
+#
+# An example hook script to check the commit log message.
+# Called by "git commit" with one argument, the name of the file
+# that has the commit message.  The hook should exit with non-zero
+# status after issuing an appropriate message if it wants to stop the
+# commit.  The hook is allowed to edit the commit message file.
+#
+# To enable this hook, rename this file to "commit-msg".
+
+# Uncomment the below to add a Signed-off-by line to the message.
+# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
+# hook is more suited to it.
+#
+# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
+# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+# This example catches duplicate Signed-off-by lines.
+
+commit_msg=$(cat "${1:?Missing commit message file}")
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}
+
+if ! echo "$commit_msg" | grep -Eq "^(build|chore|ci|docs|feat|feat!|fix|perf|refactor|revert|style|test)(\(.+\))?: .*$" ; then 
+
+  echo "Invalid commit message" 
+
+    exit 1 
+
+fi 
+
+echo "Commit message is valid!"

hooks/post-commit

@@ -0,0 +1,18 @@
+#!/bin/bash
+set -eu
+
+# destination of the final changelog file
+OUTPUT_FILE=CHANGELOG.md
+
+# generate the changelog
+git --no-pager log --no-merges --format="### %s%d%n>%aD%n%n>Author: %aN (%aE)%n%n>Commiter: %cN (%cE)%n%n%b%n%N%n" > $OUTPUT_FILE
+
+# prevent recursion!
+# since a 'commit --amend' will trigger the post-commit script again
+# we have to check if the changelog file has changed or not
+res=$(git status --porcelain | grep -c ".\$OUTPUT_FILE$")
+if [ "$res" -gt 0 ]; then
+  git add $OUTPUT_FILE
+  git commit --amend
+  echo "Populated Changelog in $OUTPUT_FILE"
+fi