FHEM/mod-GardenaSmart
1
0
Fork 0
Code Issues 2 Pull Requests Releases 3 Wiki Activity

Code refactoring and code style

Browse Source
This commit is contained in:
Marko Oldenburg 2020-04-27 11:01:49 +02:00
parent 6d466a1bb7
commit ca21aabac8
2 changed files with 182 additions and 193 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

211
73_GardenaSmartBridge.pm
View File

@ -54,8 +54,9 @@
## ##
package FHEM::GardenaSmartBridge; package FHEM::GardenaSmartBridge;
use GPUtils qw(GP_Import) use GPUtils qw(GP_Import GP_Export);
; # wird für den Import der FHEM Funktionen aus der fhem.pl benötigt
# use Data::Dumper; #only for Debugging
use strict; use strict;
use warnings; use warnings;
@ -63,7 +64,6 @@ use POSIX;
use FHEM::Meta; use FHEM::Meta;
use HttpUtils; use HttpUtils;
our $VERSION = '2.0.0';
my $missingModul = ''; my $missingModul = '';
eval "use Encode qw(encode encode_utf8 decode_utf8);1" eval "use Encode qw(encode encode_utf8 decode_utf8);1"
@ -176,42 +176,30 @@ BEGIN {
); );
} }
# _Export - Export references to main context using a different naming schema
sub _Export {
no strict qw/refs/; ## no critic
my $pkg = caller(0);
my $main = $pkg;
$main =~ s/^(?:.+::)?([^:]+)$/main::$1\_/g;
foreach (@_) {
*{ $main . $_ } = *{ $pkg . '::' . $_ };
}
}
#-- Export to main context with different name #-- Export to main context with different name
_Export( GP_Export(
qw( qw(
Initialize Initialize
) )
); );
sub Initialize($) { sub Initialize {
my $hash = shift;
my ($hash) = @_;
# Provider # Provider
$hash->{WriteFn} = 'FHEM::GardenaSmartBridge::Write'; $hash->{WriteFn} = \&Write;
$hash->{Clients} = ':GardenaSmartDevice:'; $hash->{Clients} = ':GardenaSmartDevice:';
$hash->{MatchList} = { '1:GardenaSmartDevice' => '^{"id":".*' }; $hash->{MatchList} = { '1:GardenaSmartDevice' => '^{"id":".*' };
# Consumer # Consumer
$hash->{SetFn} = 'FHEM::GardenaSmartBridge::Set'; $hash->{SetFn} = \&Set;
$hash->{DefFn} = 'FHEM::GardenaSmartBridge::Define'; $hash->{DefFn} = \&Define;
$hash->{UndefFn} = 'FHEM::GardenaSmartBridge::Undef'; $hash->{UndefFn} = \&Undef;
$hash->{DeleteFn} = 'FHEM::GardenaSmartBridge::Delete'; $hash->{DeleteFn} = \&Delete;
$hash->{RenameFn} = 'FHEM::GardenaSmartBridge::Rename'; $hash->{RenameFn} = \&Rename;
$hash->{NotifyFn} = 'FHEM::GardenaSmartBridge::Notify'; $hash->{NotifyFn} = \&Notify;
$hash->{AttrFn} = 'FHEM::GardenaSmartBridge::Attr'; $hash->{AttrFn} = \&Attr;
$hash->{AttrList} = $hash->{AttrList} =
'debugJSON:0,1 ' 'debugJSON:0,1 '
. 'disable:1 ' . 'disable:1 '
@ -220,38 +208,33 @@ sub Initialize($) {
. 'gardenaAccountEmail ' . 'gardenaAccountEmail '
. 'gardenaBaseURL ' . 'gardenaBaseURL '
. $readingFnAttributes; . $readingFnAttributes;
$hash->{parseParams} = 1;
foreach my $d ( sort keys %{ $modules{GardenaSmartBridge}{defptr} } ) {
my $hash = $modules{GardenaSmartBridge}{defptr}{$d};
$hash->{VERSION} = $VERSION;
}
return FHEM::Meta::InitMod( __FILE__, $hash ); return FHEM::Meta::InitMod( __FILE__, $hash );
} }
sub Define($$) { sub Define {
my $hash = shift;
my ( $hash, $def ) = @_; my $a = shift;
my @a = split( '[ \t][ \t]*', $def );
return $@ unless ( FHEM::Meta::SetInternals($hash) ); return $@ unless ( FHEM::Meta::SetInternals($hash) );
use version 0.60; our $VERSION = FHEM::Meta::Get( $hash, 'version' );
return 'too few parameters: define <NAME> GardenaSmartBridge' return 'too few parameters: define <NAME> GardenaSmartBridge'
if ( @a != 2 ); if ( scalar( @{$a} ) != 2 );
return return
'Cannot define Gardena Bridge device. Perl modul ' 'Cannot define Gardena Bridge device. Perl modul '
. ${missingModul} . ${missingModul}
. ' is missing.' . ' is missing.'
if ($missingModul); if ($missingModul);
my $name = $a[0]; my $name = shift @$a;
$hash->{BRIDGE} = 1; $hash->{BRIDGE} = 1;
$hash->{URL} = $hash->{URL} =
AttrVal( $name, 'gardenaBaseURL', AttrVal( $name, 'gardenaBaseURL',
'https://sg-api.dss.husqvarnagroup.net' ) 'https://sg-api.dss.husqvarnagroup.net' )
. '/sg-1'; . '/sg-1';
$hash->{VERSION} = $VERSION; $hash->{VERSION} = version->parse($VERSION)->normal;
$hash->{INTERVAL} = 60; $hash->{INTERVAL} = 60;
$hash->{NOTIFYDEV} = "global,$name"; $hash->{NOTIFYDEV} = "global,$name";
@ -265,30 +248,29 @@ sub Define($$) {
$modules{GardenaSmartBridge}{defptr}{BRIDGE} = $hash; $modules{GardenaSmartBridge}{defptr}{BRIDGE} = $hash;
return undef; return;
} }
sub Undef($$) { sub Undef {
my $hash = shift;
my ( $hash, $name ) = @_; my $name = shift;
RemoveInternalTimer($hash); RemoveInternalTimer($hash);
delete $modules{GardenaSmartBridge}{defptr}{BRIDGE} delete $modules{GardenaSmartBridge}{defptr}{BRIDGE}
if ( defined( $modules{GardenaSmartBridge}{defptr}{BRIDGE} ) ); if ( defined( $modules{GardenaSmartBridge}{defptr}{BRIDGE} ) );
return undef; return;
} }
sub Delete($$) { sub Delete {
my $hash = shift;
my ( $hash, $name ) = @_; my $name = shift;
setKeyValue( $hash->{TYPE} . '_' . $name . '_passwd', undef ); setKeyValue( $hash->{TYPE} . '_' . $name . '_passwd', undef );
return undef; return;
} }
sub Attr(@) { sub Attr {
my ( $cmd, $name, $attrName, $attrVal ) = @_; my ( $cmd, $name, $attrName, $attrVal ) = @_;
my $hash = $defs{$name}; my $hash = $defs{$name};
@ -342,12 +324,13 @@ sub Attr(@) {
} }
} }
return undef; return;
} }
sub Notify($$) { sub Notify {
my $hash = shift;
my $dev = shift;
my ( $hash, $dev ) = @_;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
return if ( IsDisabled($name) ); return if ( IsDisabled($name) );
@ -411,9 +394,12 @@ sub Notify($$) {
return; return;
} }
sub Set($@) { sub Set {
my $hash = shift;
my $a = shift;
my ( $hash, $name, $cmd, @args ) = @_; my $name = shift @$a;
my $cmd = shift @$a // return qq{"set $name" needs at least one argument};
if ( lc $cmd eq 'getdevicesstate' ) { if ( lc $cmd eq 'getdevicesstate' ) {
getDevices($hash); getDevices($hash);
@ -423,44 +409,39 @@ sub Set($@) {
return "please set Attribut gardenaAccountEmail first" return "please set Attribut gardenaAccountEmail first"
if ( AttrVal( $name, 'gardenaAccountEmail', 'none' ) eq 'none' ); if ( AttrVal( $name, 'gardenaAccountEmail', 'none' ) eq 'none' );
return "please set gardenaAccountPassword first" return "please set gardenaAccountPassword first"
if ( not defined( ReadPassword($hash,$name) ) ); if ( not defined( ReadPassword( $hash, $name ) ) );
return "token is up to date" return "token is up to date"
if ( defined( $hash->{helper}{session_id} ) ); if ( defined( $hash->{helper}{session_id} ) );
getToken($hash); getToken($hash);
} }
elsif ( lc $cmd eq 'gardenaaccountpassword' ) { elsif ( lc $cmd eq 'gardenaaccountpassword' ) {
return "please set Attribut gardenaAccountEmail first" return "please set Attribut gardenaAccountEmail first"
if ( AttrVal( $name, 'gardenaAccountEmail', 'none' ) eq 'none' ); if ( AttrVal( $name, 'gardenaAccountEmail', 'none' ) eq 'none' );
return "usage: $cmd <password>" if ( @args != 1 ); return "usage: $cmd <password>" if ( scalar( @{$a} ) != 0 );
my $passwd = join( ' ', @args );
StorePassword( $hash, $name, $passwd );
StorePassword( $hash, $name, $a->[0] );
} }
elsif ( lc $cmd eq 'deleteaccountpassword' ) { elsif ( lc $cmd eq 'deleteaccountpassword' ) {
return "usage: $cmd <password>" if ( @args != 0 ); return "usage: $cmd <password>" if ( scalar( @{$a} ) != 0 );
DeletePassword($hash); DeletePassword($hash);
} }
else { else {
my $list = "getDevicesState:noArg getToken:noArg" my $list = "getDevicesState:noArg getToken:noArg"
if ( defined( ReadPassword($hash,$name) ) ); if ( defined( ReadPassword( $hash, $name ) ) );
$list .= " gardenaAccountPassword" $list .= " gardenaAccountPassword"
if ( not defined( ReadPassword($hash,$name) ) ); if ( not defined( ReadPassword( $hash, $name ) ) );
$list .= " deleteAccountPassword:noArg" $list .= " deleteAccountPassword:noArg"
if ( defined( ReadPassword($hash,$name) ) ); if ( defined( ReadPassword( $hash, $name ) ) );
return "Unknown argument $cmd, choose one of $list"; return "Unknown argument $cmd, choose one of $list";
} }
return undef; return;
} }
sub Write($@) { sub Write {
my ( $hash, $payload, $deviceId, $abilities ) = @_; my ( $hash, $payload, $deviceId, $abilities ) = @_;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
@ -489,11 +470,14 @@ sub Write($@) {
# Log3($name, 3, # Log3($name, 3,
# "GardenaSmartBridge ($name) - Send with URL: $hash->{URL}$uri, HEADER: $header, DATA: $payload, METHOD: $method"); # "GardenaSmartBridge ($name) - Send with URL: $hash->{URL}$uri, HEADER: $header, DATA: $payload, METHOD: $method");
return;
} }
sub ErrorHandling($$$) { sub ErrorHandling {
my $param = shift;
my ( $param, $err, $data ) = @_; my $err = shift;
my $data = shift;
my $hash = $param->{hash}; my $hash = $param->{hash};
my $name = $hash->{NAME}; my $name = $hash->{NAME};
@ -701,11 +685,13 @@ sub ErrorHandling($$$) {
if ( defined( $hash->{helper}{locations_id} ) ); if ( defined( $hash->{helper}{locations_id} ) );
ResponseProcessing( $hash, $data ) ResponseProcessing( $hash, $data )
if ( ref($decode_json) eq 'HASH' ); if ( ref($decode_json) eq 'HASH' );
return;
} }
sub ResponseProcessing($$) { sub ResponseProcessing {
my $hash = shift;
my ( $hash, $json ) = @_; my $json = shift;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
@ -809,11 +795,16 @@ sub ResponseProcessing($$) {
} }
Log3 $name, 3, "GardenaSmartBridge ($name) - no Match for processing data"; Log3 $name, 3, "GardenaSmartBridge ($name) - no Match for processing data";
return;
} }
sub WriteReadings($$) { sub WriteReadings {
my $hash = shift;
my $decode_json = shift;
# print Dumper $decode_json;
my ( $hash, $decode_json ) = @_;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
if ( defined( $decode_json->{id} ) if ( defined( $decode_json->{id} )
@ -914,15 +905,17 @@ sub WriteReadings($$) {
} }
Log3 $name, 4, "GardenaSmartBridge ($name) - readings would be written"; Log3 $name, 4, "GardenaSmartBridge ($name) - readings would be written";
return;
} }
#################################### ####################################
#################################### ####################################
#### my little helpers Sub's ####### #### my little helpers Sub's #######
sub getDevices($) { sub getDevices {
my $hash = shift; my $hash = shift;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
RemoveInternalTimer($hash); RemoveInternalTimer($hash);
@ -938,11 +931,13 @@ sub getDevices($) {
readingsSingleUpdate( $hash, 'state', 'disabled', 1 ); readingsSingleUpdate( $hash, 'state', 'disabled', 1 );
Log3 $name, 3, "GardenaSmartBridge ($name) - device is disabled"; Log3 $name, 3, "GardenaSmartBridge ($name) - device is disabled";
} }
return;
} }
sub getToken($) { sub getToken {
my $hash = shift; my $hash = shift;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
return readingsSingleUpdate( $hash, 'state', return readingsSingleUpdate( $hash, 'state',
@ -950,7 +945,7 @@ sub getToken($) {
if ( AttrVal( $name, 'gardenaAccountEmail', 'none' ) eq 'none' ); if ( AttrVal( $name, 'gardenaAccountEmail', 'none' ) eq 'none' );
return readingsSingleUpdate( $hash, 'state', return readingsSingleUpdate( $hash, 'state',
'please set gardena account password first', 1 ) 'please set gardena account password first', 1 )
if ( not defined( ReadPassword($hash,$name) ) ); if ( not defined( ReadPassword( $hash, $name ) ) );
readingsSingleUpdate( $hash, 'state', 'get token', 1 ); readingsSingleUpdate( $hash, 'state', 'get token', 1 );
delete $hash->{helper}{session_id} delete $hash->{helper}{session_id}
@ -967,18 +962,22 @@ sub getToken($) {
'"sessions": {"email": "' '"sessions": {"email": "'
. AttrVal( $name, 'gardenaAccountEmail', 'none' ) . AttrVal( $name, 'gardenaAccountEmail', 'none' )
. '","password": "' . '","password": "'
. ReadPassword($hash,$name) . '"}', . ReadPassword( $hash, $name ) . '"}',
undef, undef,
undef undef
); );
Log3 $name, 3, Log3 $name, 3,
"GardenaSmartBridge ($name) - send credentials to fetch Token and locationId"; "GardenaSmartBridge ($name) - send credentials to fetch Token and locationId";
return;
} }
sub StorePassword($@) { sub StorePassword {
my $hash = shift;
my $name = shift;
my $password = shift;
my ( $hash, $name, $password ) = @_;
my $index = $hash->{TYPE} . "_" . $name . "_passwd"; my $index = $hash->{TYPE} . "_" . $name . "_passwd";
my $key = getUniqueId() . $index; my $key = getUniqueId() . $index;
my $enc_pwd = ""; my $enc_pwd = "";
@ -1002,11 +1001,12 @@ sub StorePassword($@) {
return "password successfully saved"; return "password successfully saved";
} }
sub ReadPassword($$) { sub ReadPassword {
my $hash = shift;
my $name = shift;
my ( $hash, $name ) = @_; my $index = $hash->{TYPE} . "_" . $name . "_passwd";
my $index = $hash->{TYPE} . "_" . $name . "_passwd"; my $key = getUniqueId() . $index;
my $key = getUniqueId() . $index;
my ( $password, $err ); my ( $password, $err );
Log3 $name, 4, "GardenaSmartBridge ($name) - Read password from file"; Log3 $name, 4, "GardenaSmartBridge ($name) - Read password from file";
@ -1045,22 +1045,25 @@ sub ReadPassword($$) {
Log3 $name, 3, "GardenaSmartBridge ($name) - No password in file"; Log3 $name, 3, "GardenaSmartBridge ($name) - No password in file";
return undef; return undef;
} }
return;
} }
sub Rename(@) { sub Rename {
my $new = shift;
my $old = shift;
my ( $new, $old ) = @_;
my $hash = $defs{$new}; my $hash = $defs{$new};
StorePassword( $hash, $new, ReadPassword($hash,$old) ); StorePassword( $hash, $new, ReadPassword( $hash, $old ) );
setKeyValue( $hash->{TYPE} . "_" . $old . "_passwd", undef ); setKeyValue( $hash->{TYPE} . "_" . $old . "_passwd", undef );
return undef; return;
} }
sub ParseJSON($$) { sub ParseJSON {
my $hash = shift;
my ( $hash, $buffer ) = @_; my $buffer = shift;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
my $open = 0; my $open = 0;
@ -1111,9 +1114,9 @@ sub ParseJSON($$) {
return ( $msg, $tail ); return ( $msg, $tail );
} }
sub createHttpValueStrings($@) { sub createHttpValueStrings {
my ( $hash, $payload, $deviceId, $abilities ) = @_; my ( $hash, $payload, $deviceId, $abilities ) = @_;
my $session_id = $hash->{helper}{session_id}; my $session_id = $hash->{helper}{session_id};
my $header = "Content-Type: application/json"; my $header = "Content-Type: application/json";
my $uri = ''; my $uri = '';
@ -1126,7 +1129,7 @@ sub createHttpValueStrings($@) {
if ( $payload eq '{}' ) { if ( $payload eq '{}' ) {
$method = 'GET'; $method = 'GET';
$uri .= '/locations/?user_id=' . $hash->{helper}{user_id} $uri .= '/locations/?user_id=' . $hash->{helper}{user_id}
if ( exists($hash->{helper}{user_id}) if ( exists( $hash->{helper}{user_id} )
and not defined( $hash->{helper}{locations_id} ) ); and not defined( $hash->{helper}{locations_id} ) );
readingsSingleUpdate( $hash, 'state', 'fetch locationId', 1 ) readingsSingleUpdate( $hash, 'state', 'fetch locationId', 1 )
if ( not defined( $hash->{helper}{locations_id} ) ); if ( not defined( $hash->{helper}{locations_id} ) );
@ -1215,13 +1218,12 @@ sub createHttpValueStrings($@) {
$abilities ); $abilities );
} }
sub DeletePassword($) { sub DeletePassword {
my $hash = shift; my $hash = shift;
setKeyValue( $hash->{TYPE} . "_" . $hash->{NAME} . "_passwd", undef ); setKeyValue( $hash->{TYPE} . "_" . $hash->{NAME} . "_passwd", undef );
return undef; return;
} }
1; 1;
@ -1373,6 +1375,7 @@ sub DeletePassword($) {
], ],
"release_status": "stable", "release_status": "stable",
"license": "GPL_2", "license": "GPL_2",
"version": "v2.0.0",
"author": [ "author": [
"Marko Oldenburg <leongaultier@gmail.com>" "Marko Oldenburg <leongaultier@gmail.com>"
], ],

164
74_GardenaSmartDevice.pm
View File

@ -55,9 +55,7 @@
## unserer packagename ## unserer packagename
package FHEM::GardenaSmartDevice; package FHEM::GardenaSmartDevice;
use GPUtils qw(GP_Import GP_Export);
use GPUtils qw(GP_Import)
; # wird für den Import der FHEM Funktionen aus der fhem.pl benötigt
my $missingModul = ""; my $missingModul = "";
@ -66,7 +64,6 @@ use warnings;
use POSIX; use POSIX;
use FHEM::Meta; use FHEM::Meta;
use Time::Local; use Time::Local;
our $VERSION = '2.0.0';
# try to use JSON::MaybeXS wrapper # try to use JSON::MaybeXS wrapper
# for chance of better performance + open code # for chance of better performance + open code
@ -163,70 +160,54 @@ BEGIN {
); );
} }
# _Export - Export references to main context using a different naming schema
sub _Export {
no strict qw/refs/; ## no critic
my $pkg = caller(0);
my $main = $pkg;
$main =~ s/^(?:.+::)?([^:]+)$/main::$1\_/g;
foreach (@_) {
*{ $main . $_ } = *{ $pkg . '::' . $_ };
}
}
#-- Export to main context with different name #-- Export to main context with different name
_Export( GP_Export(
qw( qw(
Initialize Initialize
) )
); );
sub Initialize($) { sub Initialize {
my $hash = shift;
my ($hash) = @_;
$hash->{Match} = '^{"id":".*'; $hash->{Match} = '^{"id":".*';
$hash->{SetFn} = "FHEM::GardenaSmartDevice::Set"; $hash->{SetFn} = \&Set;
$hash->{DefFn} = "FHEM::GardenaSmartDevice::Define"; $hash->{DefFn} = \&Define;
$hash->{UndefFn} = "FHEM::GardenaSmartDevice::Undef"; $hash->{UndefFn} = \&Undef;
$hash->{ParseFn} = "FHEM::GardenaSmartDevice::Parse"; $hash->{ParseFn} = \&Parse;
$hash->{AttrFn} = "FHEM::GardenaSmartDevice::Attr"; $hash->{AttrFn} = \&Attr;
$hash->{AttrList} = $hash->{AttrList} =
"readingValueLanguage:de,en " "readingValueLanguage:de,en "
. "model:watering_computer,sensor,mower,ic24,power,electronic_pressure_pump " . "model:watering_computer,sensor,mower,ic24,power,electronic_pressure_pump "
. "IODev " . "IODev "
. $readingFnAttributes; . $readingFnAttributes;
$hash->{parseParams} = 1;
foreach my $d ( sort keys %{ $modules{GardenaSmartDevice}{defptr} } ) {
my $hash = $modules{GardenaSmartDevice}{defptr}{$d};
$hash->{VERSION} = $VERSION;
}
return FHEM::Meta::InitMod( __FILE__, $hash ); return FHEM::Meta::InitMod( __FILE__, $hash );
} }
sub Define($$) { sub Define {
my $hash = shift;
my ( $hash, $def ) = @_; my $a = shift;
my @a = split( "[ \t]+", $def );
return $@ unless ( FHEM::Meta::SetInternals($hash) ); return $@ unless ( FHEM::Meta::SetInternals($hash) );
use version 0.60; our $VERSION = FHEM::Meta::Get( $hash, 'version' );
return return
"too few parameters: define <NAME> GardenaSmartDevice <device_Id> <model>" "too few parameters: define <NAME> GardenaSmartDevice <device_Id> <model>"
if ( @a < 3 ); if ( scalar( @{$a} ) < 3 );
return return
"Cannot define Gardena Bridge device. Perl modul $missingModul is missing." "Cannot define Gardena Bridge device. Perl modul $missingModul is missing."
if ($missingModul); if ($missingModul);
my $name = $a[0]; my $name = $a->[0];
my $deviceId = $a[2]; my $deviceId = $a->[2];
my $category = $a[3]; my $category = $a->[3];
$hash->{DEVICEID} = $deviceId; $hash->{DEVICEID} = $deviceId;
$hash->{VERSION} = $VERSION; $hash->{VERSION} = version->parse($VERSION)->normal;
$hash->{helper}{STARTINGPOINTID} = ''; $hash->{helper}{STARTINGPOINTID} = '';
CommandAttr( undef, CommandAttr( undef,
@ -267,83 +248,75 @@ sub Define($$) {
$modules{GardenaSmartDevice}{defptr}{$deviceId} = $hash; $modules{GardenaSmartDevice}{defptr}{$deviceId} = $hash;
return undef; return;
} }
sub Undef($$) { sub Undef {
my $hash = shift;
my $arg = shift;
my ( $hash, $arg ) = @_;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
my $deviceId = $hash->{DEVICEID}; my $deviceId = $hash->{DEVICEID};
delete $modules{GardenaSmartDevice}{defptr}{$deviceId}; delete $modules{GardenaSmartDevice}{defptr}{$deviceId};
return undef; return;
} }
sub Attr(@) { sub Attr {
my ( $cmd, $name, $attrName, $attrVal ) = @_; my ( $cmd, $name, $attrName, $attrVal ) = @_;
my $hash = $defs{$name}; my $hash = $defs{$name};
return undef; return;
} }
sub Set($@) { sub Set {
my $hash = shift;
my $a = shift;
my ( $hash, $name, $cmd, @args ) = @_; my $name = shift @$a;
my $cmd = shift @$a // return qq{"set $name" needs at least one argument};
my $payload; my $payload;
my $abilities = ''; my $abilities = '';
### mower ### mower
if ( lc $cmd eq 'parkuntilfurthernotice' ) { if ( lc $cmd eq 'parkuntilfurthernotice' ) {
$payload = '"name":"park_until_further_notice"'; $payload = '"name":"park_until_further_notice"';
} }
elsif ( lc $cmd eq 'parkuntilnexttimer' ) { elsif ( lc $cmd eq 'parkuntilnexttimer' ) {
$payload = '"name":"park_until_next_timer"'; $payload = '"name":"park_until_next_timer"';
} }
elsif ( lc $cmd eq 'startresumeschedule' ) { elsif ( lc $cmd eq 'startresumeschedule' ) {
$payload = '"name":"start_resume_schedule"'; $payload = '"name":"start_resume_schedule"';
} }
elsif ( lc $cmd eq 'startoverridetimer' ) { elsif ( lc $cmd eq 'startoverridetimer' ) {
my $duration = join( " ", @args );
$payload = '"name":"start_override_timer","parameters":{"duration":' $payload = '"name":"start_override_timer","parameters":{"duration":'
. $duration * 60 . '}'; . $a->[0] * 60 . '}';
} }
elsif ( lc $cmd eq 'startpoint' ) { elsif ( lc $cmd eq 'startpoint' ) {
my $err; my $err;
( $err, $payload, $abilities ) = ( $err, $payload, $abilities ) = SetPredefinedStartPoints( $hash, @$a );
SetPredefinedStartPoints( $hash, @args );
return $err if ( defined($err) ); return $err if ( defined($err) );
} }
### electronic_pressure_pump ### electronic_pressure_pump
elsif ( lc $cmd eq 'pumptimer' ) { elsif ( lc $cmd eq 'pumptimer' ) {
my $duration = join( " ", @args );
$payload = $payload =
'"name":"pump_manual_watering_timer","parameters":{"duration":' '"name":"pump_manual_watering_timer","parameters":{"duration":'
. $duration . '}'; . $a->[0] . '}';
} }
### watering_computer ### watering_computer
elsif ( lc $cmd eq 'manualoverride' ) { elsif ( lc $cmd eq 'manualoverride' ) {
my $duration = join(' ', @args);
$payload = $payload =
'"properties":{"name":"watering_timer_1' '"properties":{"name":"watering_timer_1'
. '","value":{"state":"manual","duration":' . '","value":{"state":"manual","duration":'
. $duration * 60 . $a->[0] * 60
. ',"valve_id":1}}'; . ',"valve_id":1}}';
} }
elsif ( $cmd =~ m{\AcancelOverride}xms ) { elsif ( $cmd =~ m{\AcancelOverride}xms ) {
@ -363,15 +336,17 @@ sub Set($@) {
. $valve_id . '}}'; . $valve_id . '}}';
} }
elsif ( lc $cmd eq 'on' or lc $cmd eq 'off' or lc $cmd eq 'on-for-timer' ) { elsif ( lc $cmd eq 'on' or lc $cmd eq 'off' or lc $cmd eq 'on-for-timer' ) {
my $val = (
defined($a) and ref($a) eq 'ARRAY'
? $a->[0] * 60
: lc $cmd
);
my $val = ( defined( $args[0] ) ? join( " ", @args ) * 60 : lc $cmd );
$payload = '"properties":{"value":"' . $val . '"}'; $payload = '"properties":{"value":"' . $val . '"}';
} }
### Watering ic24 ### Watering ic24
elsif ( $cmd =~ m{\AmanualDurationValve\d\z}xms ) { elsif ( $cmd =~ m{\AmanualDurationValve\d\z}xms ) {
my $valve_id; my $valve_id;
my $duration = join( " ", @args );
if ( $cmd =~ m{\AmanualDurationValve(\d)\z}xms ) { if ( $cmd =~ m{\AmanualDurationValve(\d)\z}xms ) {
$valve_id = $1; $valve_id = $1;
@ -381,14 +356,14 @@ sub Set($@) {
'"properties":{"name":"watering_timer_' '"properties":{"name":"watering_timer_'
. $valve_id . $valve_id
. '","value":{"state":"manual","duration":' . '","value":{"state":"manual","duration":'
. $duration * 60 . $a->[0] * 60
. ',"valve_id":' . ',"valve_id":'
. $valve_id . '}}'; . $valve_id . '}}';
} }
### Sensors ### Sensors
elsif ( lc $cmd eq 'refresh' ) { elsif ( lc $cmd eq 'refresh' ) {
my $sensname = join( " ", @args ); my $sensname = $a->[0];
if ( lc $sensname eq 'temperature' ) { if ( lc $sensname eq 'temperature' ) {
$payload = '"name":"measure_ambient_temperature"'; $payload = '"name":"measure_ambient_temperature"';
$abilities = 'ambient_temperature'; $abilities = 'ambient_temperature';
@ -408,7 +383,7 @@ sub Set($@) {
else { else {
my $list = ''; my $list = '';
$list .= 'manualOverride:slider,1,1,59 cancelOverride:noArg' $list .= 'manualOverride:slider,1,1,59 cancelOverride:noArg'
if ( AttrVal( $name, 'model', 'unknown' ) eq 'watering_computer' ); if ( AttrVal( $name, 'model', 'unknown' ) eq 'watering_computer' );
@ -443,12 +418,12 @@ sub Set($@) {
Log3 $name, 4, Log3 $name, 4,
"GardenaSmartBridge ($name) - IOWrite: $payload $hash->{DEVICEID} $abilities IODevHash=$hash->{IODev}"; "GardenaSmartBridge ($name) - IOWrite: $payload $hash->{DEVICEID} $abilities IODevHash=$hash->{IODev}";
return undef; return;
} }
sub Parse($$) { sub Parse {
my $io_hash = shift;
my ( $io_hash, $json ) = @_; my $json = shift;
my $name = $io_hash->{NAME}; my $name = $io_hash->{NAME};
@ -487,11 +462,13 @@ sub Parse($$) {
. " GardenaSmartDevice $decode_json->{id} $decode_json->{category}"; . " GardenaSmartDevice $decode_json->{id} $decode_json->{category}";
} }
} }
return;
} }
sub WriteReadings($$) { sub WriteReadings {
my $hash = shift;
my ( $hash, $decode_json ) = @_; my $decode_json = shift;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
my $abilities = scalar( @{ $decode_json->{abilities} } ); my $abilities = scalar( @{ $decode_json->{abilities} } );
@ -635,8 +612,7 @@ sub WriteReadings($$) {
readingsBulkUpdate( readingsBulkUpdate(
$hash, 'state', $hash, 'state',
( (
ReadingsVal( $name, 'watering-watering_timer_1_state', 0 ) ReadingsVal( $name, 'watering-watering_timer_1_state', 0 ) eq 'idle'
eq 'idle'
? RigRadingsValue( $hash, 'closed' ) ? RigRadingsValue( $hash, 'closed' )
: RigRadingsValue( $hash, 'open' ) : RigRadingsValue( $hash, 'open' )
) )
@ -671,17 +647,19 @@ sub WriteReadings($$) {
readingsEndUpdate( $hash, 1 ); readingsEndUpdate( $hash, 1 );
Log3 $name, 4, "GardenaSmartDevice ($name) - readings was written}"; Log3 $name, 4, "GardenaSmartDevice ($name) - readings was written}";
return;
} }
################################## ##################################
################################## ##################################
#### my little helpers ########### #### my little helpers ###########
sub ReadingLangGerman($$) { sub ReadingLangGerman {
my $hash = shift;
my ( $hash, $readingValue ) = @_; my $readingValue = shift;
my $name = $hash->{NAME};
my $name = $hash->{NAME};
my %langGermanMapp = ( my %langGermanMapp = (
'ok_cutting' => 'mähen', 'ok_cutting' => 'mähen',
'paused' => 'pausiert', 'paused' => 'pausiert',
@ -794,11 +772,13 @@ sub ReadingLangGerman($$) {
else { else {
return $readingValue; return $readingValue;
} }
return;
} }
sub RigRadingsValue($$) { sub RigRadingsValue {
my $hash = shift;
my ( $hash, $readingValue ) = @_; my $readingValue = shift;
my $rigReadingValue; my $rigReadingValue;
@ -812,9 +792,9 @@ sub RigRadingsValue($$) {
return $rigReadingValue; return $rigReadingValue;
} }
sub Zulu2LocalString($) { sub Zulu2LocalString {
my $t = shift; my $t = shift;
my ( $datehour, $datemin, $rest ) = split( /:/, $t, 3 ); my ( $datehour, $datemin, $rest ) = split( /:/, $t, 3 );
my ( $year, $month, $day, $hour, $min ) = my ( $year, $month, $day, $hour, $min ) =
@ -847,11 +827,16 @@ sub Zulu2LocalString($) {
) )
); );
} }
return;
} }
sub SetPredefinedStartPoints($@) { sub SetPredefinedStartPoints {
my $hash = shift;
my $a = shift;
my ( $startpoint_state, $startpoint_num, @morestartpoints ) = @$a;
my ( $hash, $startpoint_state, $startpoint_num, @morestartpoints ) = @_;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
my $payload; my $payload;
my $abilities; my $abilities;
@ -1228,6 +1213,7 @@ sub SetPredefinedStartPoints($@) {
], ],
"release_status": "stable", "release_status": "stable",
"license": "GPL_2", "license": "GPL_2",
"version": "v2.0.0",
"author": [ "author": [
"Marko Oldenburg <leongaultier@gmail.com>" "Marko Oldenburg <leongaultier@gmail.com>"
], ],