############################################################################## # $Id$ package main; use strict; use warnings; use HttpUtils; use POSIX; use JSON qw(decode_json); ##############################################################################} ### Forward declarations ####################################################{ sub Unifi_Initialize($$); sub Unifi_Define($$); sub Unifi_Undef($$); sub Unifi_Notify($$); sub Unifi_Set($@); sub Unifi_Get($@); sub Unifi_Attr(@); sub Unifi_DoUpdate($@); sub Unifi_Login_Send($); sub Unifi_Login_Receive($); sub Unifi_GetClients_Send($); sub Unifi_GetClients_Receive($); sub Unifi_GetWlans_Send($); sub Unifi_GetWlans_Receive($); sub Unifi_GetHealth_Send($); sub Unifi_GetHealth_Receive($); sub Unifi_GetWlanGroups_Send($); sub Unifi_GetWlanGroups_Receive($); sub Unifi_GetUnarchivedAlerts_Send($); sub Unifi_GetUnarchivedAlerts_Receive($); sub Unifi_GetEvents_Send($); sub Unifi_GetEvents_Receive($); sub Unifi_GetAccesspoints_Send($); sub Unifi_GetAccesspoints_Receive($); sub Unifi_ProcessUpdate($); sub Unifi_SetClientReadings($); sub Unifi_SetHealthReadings($); sub Unifi_SetAccesspointReadings($); sub Unifi_DisconnectClient_Send($@); sub Unifi_DisconnectClient_Receive($); sub Unifi_ApCmd_Send($$@); sub Unifi_ApCmd_Receive($); sub Unifi_ArchiveAlerts_Send($); sub Unifi_Cmd_Receive($); sub Unifi_ClientNames($@); sub Unifi_ApNames($@); sub Unifi_NextUpdateFn($$); sub Unifi_ReceiveFailure($$); sub Unifi_CONNECTED($@); sub Unifi_Whoami(); sub Unifi_Whowasi(); ##############################################################################} sub Unifi_Initialize($$) { my ($hash) = @_; $hash->{DefFn} = "Unifi_Define"; $hash->{UndefFn} = "Unifi_Undef"; $hash->{SetFn} = "Unifi_Set"; $hash->{GetFn} = "Unifi_Get"; $hash->{AttrFn} = 'Unifi_Attr'; $hash->{NotifyFn} = "Unifi_Notify"; $hash->{AttrList} = "disable:1,0 " ."devAlias " ."httpLoglevel:1,2,3,4,5 " ."eventPeriod " .$readingFnAttributes; } ############################################################################### sub Unifi_Define($$) { my ($hash, $def) = @_; my @a = split("[ \t][ \t]*", $def); return "Wrong syntax: use define Unifi [ [ []]]" if(int(@a) < 6); return "Wrong syntax: is not a number!" if(!looks_like_number($a[3])); return "Wrong syntax: is not a number!" if($a[6] && !looks_like_number($a[6])); return "Wrong syntax: too small, must be at least 5" if($a[6] && $a[6] < 5); return "Wrong syntax: is not a valid number! Must be 3 or 4." if($a[8] && (!looks_like_number($a[8]) || $a[8] !~ /3|4/)); my $name = $a[0]; %$hash = ( %$hash, NOTIFYDEV => 'global', unifi => { CONNECTED => 0, eventPeriod => int(AttrVal($name,"eventPeriod",24)), interval => $a[6] || 30, version => $a[8] || 4, url => "https://".$a[2].(($a[3] == 443) ? '' : ':'.$a[3]).'/api/s/'.(($a[7]) ? $a[7] : 'default').'/', }, ); $hash->{httpParams} = { hash => $hash, timeout => 5, method => "POST", noshutdown => 0, ignoreredirects => 1, loglevel => AttrVal($name,"httpLoglevel",5), sslargs => { SSL_verify_mode => 'SSL_VERIFY_NONE' }, }; if($hash->{unifi}->{version} == 3) { ( $hash->{httpParams}->{loginUrl} = $hash->{unifi}->{url} ) =~ s/api\/s.+/login/; $hash->{httpParams}->{loginData} = "login=login&username=".$a[4]."&password=".$a[5]; }else { ( $hash->{httpParams}->{loginUrl} = $hash->{unifi}->{url} ) =~ s/api\/s.+/api\/login/; $hash->{httpParams}->{loginData} = '{"username":"'.$a[4].'", "password":"'.$a[5].'"}'; } Log3 $name, 5, "$name: Defined with url:$hash->{unifi}->{url}, interval:$hash->{unifi}->{interval}, version:$hash->{unifi}->{version}"; return undef; } ############################################################################### sub Unifi_Undef($$) { my ($hash,$arg) = @_; RemoveInternalTimer($hash); return undef; } ############################################################################### sub Unifi_Notify($$) { my ($hash,$dev) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); return if($dev->{NAME} ne "global"); return if(!grep(m/^DEFINED|MODIFIED|INITIALIZED|REREADCFG$/, @{$dev->{CHANGED}})); if(AttrVal($name, "disable", 0)) { Log3 $name, 5, "$name ($self) - executed. - Device '$name' is disabled, do nothing..."; Unifi_CONNECTED($hash,'disabled'); } else { Log3 $name, 5, "$name ($self) - executed. - Remove all Timers & Call DoUpdate..."; Unifi_CONNECTED($hash,'initialized'); Unifi_DoUpdate($hash); } return undef; } ############################################################################### sub Unifi_Set($@) { my ($hash,@a) = @_; return "\"set $hash->{NAME}\" needs at least an argument" if ( @a < 2 ); my ($name,$setName,$setVal) = @a; Log3 $name, 5, "$name: set called with $setName " . ($setVal ? $setVal : "") if ($setName ne "?"); if(Unifi_CONNECTED($hash) eq 'disabled' && $setName !~ /clear/) { return "Unknown argument $setName, choose one of clear:all,readings,clientData"; Log3 $name, 5, "$name: set called with $setName but device is disabled!" if($setName ne "?"); return undef; } my $clientNames = Unifi_ClientNames($hash); my $apNames = Unifi_ApNames($hash); if($setName !~ /archiveAlerts|restartAP|setLocateAP|unsetLocateAP|disconnectClient|update|clear/) { return "Unknown argument $setName, choose one of update:noArg " ." clear:all,readings,clientData " .((defined $hash->{alerts_unarchived}[0] && scalar @{$hash->{alerts_unarchived}}) ? "archiveAlerts:noArg " : "") .(($apNames && Unifi_CONNECTED($hash)) ? "restartAP:all,$apNames setLocateAP:all,$apNames unsetLocateAP:all,$apNames " : "") .(($clientNames && Unifi_CONNECTED($hash)) ? "disconnectClient:all,$clientNames" : ""); } else { Log3 $name, 4, "$name: set $setName"; if (Unifi_CONNECTED($hash)) { if ($setName eq 'disconnectClient') { if ($setVal && $setVal ne 'all') { $setVal = Unifi_ClientNames($hash,$setVal,'makeID'); if (defined $hash->{clients}->{$setVal}) { Unifi_DisconnectClient_Send($hash,$setVal); } else { return "$hash->{NAME}: Unknown client '$setVal' in command '$setName', choose one of: all,$clientNames"; } } elsif (!$setVal || $setVal eq 'all') { Unifi_DisconnectClient_Send($hash,keys(%{$hash->{clients}})); } } elsif ($setName eq 'archiveAlerts' && defined $hash->{alerts_unarchived}[0]) { Unifi_ArchiveAlerts_Send($hash); undef @{$hash->{alerts_unarchived}}; } elsif ($setName eq 'restartAP') { if ($setVal && $setVal ne 'all') { $setVal = Unifi_ApNames($hash,$setVal,'makeID'); if (defined $hash->{accespoints}->{$setVal}) { Unifi_ApCmd_Send($hash,'restart',$setVal); } else { return "$hash->{NAME}: Unknown accesspoint '$setVal' in command '$setName', choose one of: all,$apNames"; } } elsif (!$setVal || $setVal eq 'all') { Unifi_ApCmd_Send($hash,'restart',keys(%{$hash->{accespoints}})); } } elsif ($setName eq 'setLocateAP') { if ($setVal && $setVal ne 'all') { $setVal = Unifi_ApNames($hash,$setVal,'makeID'); if (defined $hash->{accespoints}->{$setVal}) { Unifi_ApCmd_Send($hash,'set-locate',$setVal); } else { return "$hash->{NAME}: Unknown accesspoint '$setVal' in command '$setName', choose one of: all,$apNames"; } } elsif (!$setVal || $setVal eq 'all') { Unifi_ApCmd_Send($hash,'set-locate',keys(%{$hash->{accespoints}})); } } elsif ($setName eq 'unsetLocateAP') { if ($setVal && $setVal ne 'all') { $setVal = Unifi_ApNames($hash,$setVal,'makeID'); if (defined $hash->{accespoints}->{$setVal}) { Unifi_ApCmd_Send($hash,'unset-locate',$setVal); } else { return "$hash->{NAME}: Unknown accesspoint '$setVal' in command '$setName', choose one of: all,$apNames"; } } elsif (!$setVal || $setVal eq 'all') { Unifi_ApCmd_Send($hash,'unset-locate',keys(%{$hash->{accespoints}})); } } } if ($setName eq 'update') { RemoveInternalTimer($hash); Unifi_DoUpdate($hash,1); } elsif ($setName eq 'clear') { if ($setVal eq 'readings' || $setVal eq 'all') { for (keys %{$hash->{READINGS}}) { delete $hash->{READINGS}->{$_} if($_ ne 'state'); } } if ($setVal eq 'clientData' || $setVal eq 'all') { %{$hash->{clients}} = (); } } } return undef; } ############################################################################### sub Unifi_Get($@) { my ($hash,@a) = @_; return "\"get $hash->{NAME}\" needs at least one argument" if ( @a < 2 ); my ($name,$getName,$getVal) = @a; my $clientNames = Unifi_ClientNames($hash); if($getName !~ /events|clientData|unarchivedAlerts/) { return "Unknown argument $getName, choose one of " .((defined $hash->{events}[0] && scalar @{$hash->{events}}) ? "events:noArg " : "") .((defined $hash->{alerts_unarchived}[0] && scalar @{$hash->{alerts_unarchived}}) ? "unarchivedAlerts:noArg " : "") .(($clientNames) ? "clientData:all,$clientNames" : ""); } elsif ($getName eq 'unarchivedAlerts' && defined $hash->{alerts_unarchived}[0] && scalar @{$hash->{alerts_unarchived}}) { my $alerts = "====================================================\n"; for my $alert (@{$hash->{alerts_unarchived}}) { for (sort keys %{$alert}) { if ($_ !~ /^(archived|_id|handled_admin_id|site_id|datetime|handled_time)$/) { $alert->{$_} = strftime "%Y-%m-%d %H:%M:%S",localtime($alert->{$_} / 1000) if($_ eq 'time'); $alerts .= "$_ = ".((defined $alert->{$_}) ? $alert->{$_} : '')."\n"; } } $alerts .= "====================================================\n"; } return $alerts; } elsif ($getName eq 'events' && defined $hash->{events}[0] && scalar @{$hash->{events}}) { my $events = "==================================================================\n"; for my $event (@{$hash->{events}}) { for (sort keys %{$event}) { if ($_ !~ /^(_id|site_id|subsystem|datetime|is_admin)$/) { $event->{$_} = strftime "%Y-%m-%d %H:%M:%S",localtime($event->{$_} / 1000) if($_ eq 'time'); $events .= "$_ = ".((defined $event->{$_}) ? $event->{$_} : '')."\n"; } } $events .= "==================================================================\n"; } return $events; } elsif ($getName eq 'clientData' && $clientNames) { my $clientData = ''; if ($getVal && $getVal ne 'all') { $getVal = Unifi_ClientNames($hash,$getVal,'makeID'); } if (!$getVal || $getVal eq 'all') { $clientData .= "======================================\n"; for my $client (sort keys %{$hash->{clients}}) { for (sort keys %{$hash->{clients}->{$client}}) { $clientData .= "$_ = ".((defined($hash->{clients}->{$client}->{$_})) ? $hash->{clients}->{$client}->{$_} : '')."\n"; } $clientData .= "======================================\n"; } return $clientData; } elsif(defined($hash->{clients}->{$getVal})) { $clientData .= "======================================\n"; for (sort keys %{$hash->{clients}->{$getVal}}) { $clientData .= "$_ = ".((defined($hash->{clients}->{$getVal}->{$_})) ? $hash->{clients}->{$getVal}->{$_} : '')."\n"; } $clientData .= "======================================\n"; return $clientData; } else { return "$hash->{NAME}: Unknown client '$getVal' in command '$getName', choose one of: all,$clientNames"; } } return undef; } ############################################################################### sub Unifi_Attr(@) { my ($cmd,$name,$attr_name,$attr_value) = @_; my $hash = $defs{$name}; if($cmd eq "set") { if($attr_name eq "disable") { if($attr_value == 1) { Unifi_CONNECTED($hash,'disabled'); } elsif($attr_value == 0 && Unifi_CONNECTED($hash) eq "disabled") { Unifi_CONNECTED($hash,'initialized'); Unifi_DoUpdate($hash); } } elsif($attr_name eq "devAlias") { if (!$attr_value) { CommandDeleteAttr(undef, $name.' '.$attr_name); return 1; } elsif ($attr_value !~ /^([\w\.\-]+:[\w\.\-]+\s?)+$/) { return "$name: Value \"$attr_value\" is not allowed for devAlias!\n" ."Must be \": :\", e.g. 123abc:MyIphone\n" ."Only these characters are allowed: [alphanumeric - _ .]"; } } elsif($attr_name eq "httpLoglevel") { $hash->{httpParams}->{loglevel} = $attr_value; } elsif($attr_name eq "eventPeriod") { if (!looks_like_number($attr_value) || int($attr_value) < 1 || int($attr_value) > 168) { return "$name: Value \"$attr_value\" is not allowed.\n" ."eventPeriod must be a number between 1 and 168." } $hash->{unifi}->{eventPeriod} = int($attr_value); } } elsif($cmd eq "del") { if($attr_name eq "disable" && Unifi_CONNECTED($hash) eq "disabled") { Unifi_CONNECTED($hash,'initialized'); Unifi_DoUpdate($hash); } elsif($attr_name eq "httpLoglevel") { $hash->{httpParams}->{loglevel} = 5; } elsif($attr_name eq "eventPeriod") { $hash->{unifi}->{eventPeriod} = 24; } } return undef; } ############################################################################### sub Unifi_DoUpdate($@) { my ($hash,$manual) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; if (Unifi_CONNECTED($hash) eq "disabled") { Log3 $name, 5, "$name ($self) - Device '$name' is disabled, End now..."; return undef; } if (Unifi_CONNECTED($hash)) { $hash->{unifi}->{updateStartTime} = time(); $hash->{updateDispatch} = { # {updateDispatch}->{callFn}[callFnRef,'receiveFn',receiveFnRef] Unifi_GetClients_Send => [\&Unifi_GetClients_Send,'Unifi_GetClients_Receive',\&Unifi_GetClients_Receive], Unifi_GetAccesspoints_Send => [\&Unifi_GetAccesspoints_Send,'Unifi_GetAccesspoints_Receive',\&Unifi_GetAccesspoints_Receive], Unifi_GetWlans_Send => [\&Unifi_GetWlans_Send,'Unifi_GetWlans_Receive',\&Unifi_GetWlans_Receive], Unifi_GetUnarchivedAlerts_Send => [\&Unifi_GetUnarchivedAlerts_Send,'Unifi_GetUnarchivedAlerts_Receive',\&Unifi_GetUnarchivedAlerts_Receive], Unifi_GetEvents_Send => [\&Unifi_GetEvents_Send,'Unifi_GetEvents_Receive',\&Unifi_GetEvents_Receive], # Unifi_GetWlanGroups_Send => [\&Unifi_GetWlanGroups_Send,'Unifi_GetWlanGroups_Receive',\&Unifi_GetWlanGroups_Receive], Unifi_GetHealth_Send => [\&Unifi_GetHealth_Send,'Unifi_GetHealth_Receive',\&Unifi_GetHealth_Receive], Unifi_ProcessUpdate => [\&Unifi_ProcessUpdate,''], }; Unifi_NextUpdateFn($hash,$self); } else { Unifi_CONNECTED($hash,'disconnected'); Unifi_Login_Send($hash) } return undef; } ############################################################################### sub Unifi_Login_Send($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{httpParams}->{loginUrl}, data => $hash->{httpParams}->{loginData}, callback => \&Unifi_Login_Receive } ); return undef; } sub Unifi_Login_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Log3 $name, 5, "$name ($self) - Error while requesting ".$param->{url}." - $err"; } elsif ($data ne "" && $hash->{unifi}->{version} == 3) { if ($data =~ /Invalid username or password/si) { Log3 $name, 1, "$name ($self) - Login Failed! Invalid username or password!"; } else { Log3 $name, 5, "$name ($self) - Login Failed! Version 3 should not deliver data on successfull login."; } } elsif ($data ne "" || $hash->{unifi}->{version} == 3) { # v3 Login is empty if login is successfully if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401 || ($hash->{unifi}->{version} == 3 && ($param->{code} == 302 || $param->{code} == 200))) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($hash->{unifi}->{version} == 3 || $data->{meta}->{rc} eq "ok") { # v3 has no rc-state Log3 $name, 5, "$name ($self) - state=ok || version=3"; $hash->{httpParams}->{header} = ''; for (split("\r\n",$param->{httpheader})) { if(/^Set-Cookie/) { s/Set-Cookie:\s(.*?);.*/Cookie: $1/; $hash->{httpParams}->{header} .= $_.'\r\n'; } } if($hash->{httpParams}->{header} ne '') { $hash->{httpParams}->{header} =~ s/\\r\\n$//; Log3 $name, 5, "$name ($self) - Login successfully! $hash->{httpParams}->{header}"; Unifi_CONNECTED($hash,'connected'); Unifi_DoUpdate($hash); return undef; } else { $hash->{httpParams}->{header} = undef; Log3 $name, 5, "$name ($self) - Something went wrong, login seems ok but no cookies received."; } } else { if (defined($data->{meta}->{msg})) { if ($data->{meta}->{msg} eq 'api.err.Invalid') { Log3 $name, 1, "$name ($self) - Login Failed! Invalid username or password!" ." - state:'$data->{meta}->{rc}' - msg:'$data->{meta}->{msg}'"; } elsif ($data->{meta}->{msg} eq 'api.err.LoginRequired') { Log3 $name, 1, "$name ($self) - Login Failed! - state:'$data->{meta}->{rc}' - msg:'$data->{meta}->{msg}' -" ." This error while login indicates that you use wrong or" ." have to define in your fhem definition."; } else { Log3 $name, 5, "$name ($self) - Login Failed! - state:'$data->{meta}->{rc}' - msg:'$data->{meta}->{msg}'"; } } else { Log3 $name, 5, "$name ($self) - Login Failed (without msg)! - state:'$data->{meta}->{rc}'"; } $hash->{httpParams}->{header} = undef; } } else { Log3 $name, 5, "$name ($self) - Failed with HTTP Code $param->{code}!"; } } else { Log3 $name, 5, "$name ($self) - Failed because no data was received!"; } Log3 $name, 5, "$name ($self) - Connect/Login to Unifi-Controller failed. Will try again after interval..."; Unifi_CONNECTED($hash,'disconnected'); InternalTimer(time()+$hash->{unifi}->{interval}, 'Unifi_Login_Send', $hash, 0); return undef; } ############################################################################### sub Unifi_GetClients_Send($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{unifi}->{url}."stat/sta", callback => $hash->{updateDispatch}->{$self}[2] } ); return undef; } sub Unifi_GetClients_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Unifi_ReceiveFailure($hash,{rc => 'Error while requesting', msg => $param->{url}." - $err"}); } elsif ($data ne "") { if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($data->{meta}->{rc} eq "ok") { Log3 $name, 5, "$name ($self) - state:'$data->{meta}->{rc}'"; $hash->{unifi}->{connectedClients} = undef; for my $h (@{$data->{data}}) { $hash->{unifi}->{connectedClients}->{$h->{user_id}} = 1; $hash->{clients}->{$h->{user_id}} = $h; } } else { Unifi_ReceiveFailure($hash,$data->{meta}); } } else { Unifi_ReceiveFailure($hash,{rc => $param->{code}, msg => "Failed with HTTP Code $param->{code}."}); } } Unifi_NextUpdateFn($hash,$self); return undef; } ############################################################################### sub Unifi_GetWlans_Send($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{unifi}->{url}."list/wlanconf", callback => $hash->{updateDispatch}->{$self}[2], } ); return undef; } sub Unifi_GetWlans_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Unifi_ReceiveFailure($hash,{rc => 'Error while requesting', msg => $param->{url}." - $err"}); } elsif ($data ne "") { if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($data->{meta}->{rc} eq "ok") { Log3 $name, 5, "$name ($self) - state:'$data->{meta}->{rc}'"; for my $h (@{$data->{data}}) { $hash->{wlans}->{$h->{_id}} = $h; $hash->{wlans}->{$h->{_id}}->{x_passphrase} = '***'; # Don't show passphrase in list } } else { Unifi_ReceiveFailure($hash,$data->{meta}); } } else { Unifi_ReceiveFailure($hash,{rc => $param->{code}, msg => "Failed with HTTP Code $param->{code}."}); } } Unifi_NextUpdateFn($hash,$self); return undef; } ############################################################################### sub Unifi_GetHealth_Send($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{unifi}->{url}."stat/health", callback => $hash->{updateDispatch}->{$self}[2], } ); return undef; } sub Unifi_GetHealth_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Unifi_ReceiveFailure($hash,{rc => 'Error while requesting', msg => $param->{url}." - $err"}); } elsif ($data ne "") { if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($data->{meta}->{rc} eq "ok") { Log3 $name, 5, "$name ($self) - state:'$data->{meta}->{rc}'"; for my $h (@{$data->{data}}) { if (defined($h->{subsystem}) && $h->{subsystem} eq 'wlan') { $hash->{wlan_health} = $h; } } } else { Unifi_ReceiveFailure($hash,$data->{meta}); } } else { Unifi_ReceiveFailure($hash,{rc => $param->{code}, msg => "Failed with HTTP Code $param->{code}."}); } } Unifi_NextUpdateFn($hash,$self); return undef; } ############################################################################### sub Unifi_GetWlanGroups_Send($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{unifi}->{url}."list/wlangroup", callback => $hash->{updateDispatch}->{$self}[2], } ); return undef; } sub Unifi_GetWlanGroups_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Unifi_ReceiveFailure($hash,{rc => 'Error while requesting', msg => $param->{url}." - $err"}); } elsif ($data ne "") { if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($data->{meta}->{rc} eq "ok") { Log3 $name, 5, "$name ($self) - state:'$data->{meta}->{rc}'"; for my $h (@{$data->{data}}) { $hash->{wlangroup}->{$h->{_id}} = $h; } } else { Unifi_ReceiveFailure($hash,$data->{meta}); } } else { Unifi_ReceiveFailure($hash,{rc => $param->{code}, msg => "Failed with HTTP Code $param->{code}."}); } } Unifi_NextUpdateFn($hash,$self); return undef; } ############################################################################### sub Unifi_GetUnarchivedAlerts_Send($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{unifi}->{url}."list/alarm", callback => $hash->{updateDispatch}->{$self}[2], data => "{'_sort': '-time', 'archived': false}", } ); return undef; } sub Unifi_GetUnarchivedAlerts_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Unifi_ReceiveFailure($hash,{rc => 'Error while requesting', msg => $param->{url}." - $err"}); } elsif ($data ne "") { if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($data->{meta}->{rc} eq "ok") { Log3 $name, 5, "$name ($self) - state:'$data->{meta}->{rc}'"; $hash->{alerts_unarchived} = $data->{data}; #array } else { Unifi_ReceiveFailure($hash,$data->{meta}); } } else { Unifi_ReceiveFailure($hash,{rc => $param->{code}, msg => "Failed with HTTP Code $param->{code}."}); } } Unifi_NextUpdateFn($hash,$self); return undef; } ############################################################################### sub Unifi_GetEvents_Send($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{unifi}->{url}."stat/event", callback => $hash->{updateDispatch}->{$self}[2], data => "{'_sort': '-time', 'within': ".$hash->{unifi}->{eventPeriod}."}", # last 24 hours } ); return undef; } sub Unifi_GetEvents_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Unifi_ReceiveFailure($hash,{rc => 'Error while requesting', msg => $param->{url}." - $err"}); } elsif ($data ne "") { if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($data->{meta}->{rc} eq "ok") { Log3 $name, 5, "$name ($self) - state:'$data->{meta}->{rc}'"; $hash->{events} = $data->{data}; #array } else { Unifi_ReceiveFailure($hash,$data->{meta}); } } else { Unifi_ReceiveFailure($hash,{rc => $param->{code}, msg => "Failed with HTTP Code $param->{code}."}); } } Unifi_NextUpdateFn($hash,$self); return undef; } ############################################################################### sub Unifi_GetAccesspoints_Send($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{unifi}->{url}."stat/device", callback => $hash->{updateDispatch}->{$self}[2], data => "{'_depth': 2, 'test': 0}", } ); return undef; } sub Unifi_GetAccesspoints_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Unifi_ReceiveFailure($hash,{rc => 'Error while requesting', msg => $param->{url}." - $err"}); } elsif ($data ne "") { if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($data->{meta}->{rc} eq "ok") { Log3 $name, 5, "$name ($self) - state:'$data->{meta}->{rc}'"; for my $h (@{$data->{data}}) { $hash->{accespoints}->{$h->{_id}} = $h; } } else { Unifi_ReceiveFailure($hash,$data->{meta}); } } else { Unifi_ReceiveFailure($hash,{rc => $param->{code}, msg => "Failed with HTTP Code $param->{code}."}); } } Unifi_NextUpdateFn($hash,$self); return undef; } ############################################################################### sub Unifi_ProcessUpdate($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed after ".sprintf('%.4f',time() - $hash->{unifi}->{updateStartTime})." seconds."; readingsBeginUpdate($hash); #'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''# Unifi_SetHealthReadings($hash); Unifi_SetClientReadings($hash); Unifi_SetAccesspointReadings($hash); ## WLANGROUPS ??? #'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''# readingsEndUpdate($hash,1); Log3 $name, 5, "$name ($self) - finished after ".sprintf('%.4f',time() - $hash->{unifi}->{updateStartTime})." seconds."; InternalTimer(time()+$hash->{unifi}->{interval}, 'Unifi_DoUpdate', $hash, 0); return undef; } ############################################################################### sub Unifi_SetClientReadings($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; my ($apName,$clientName,$apRef,$clientRef); for my $clientID (keys %{$hash->{clients}}) { $clientRef = $hash->{clients}->{$clientID}; $clientName = Unifi_ClientNames($hash,$clientID,'makeAlias'); for my $apID (keys %{$hash->{accespoints}}) { $apRef = $hash->{accespoints}->{$apID}; if ($apRef->{mac} eq $clientRef->{ap_mac}) { $apName = ($apRef->{name}) ? $apRef->{name} : $apRef->{ip}; last; } } if (defined $hash->{unifi}->{connectedClients}->{$clientID}) { readingsBulkUpdate($hash,$clientName."_hostname",(defined $clientRef->{hostname}) ? $clientRef->{hostname} : (defined $clientRef->{ip}) ? $clientRef->{ip} : 'Unknown'); readingsBulkUpdate($hash,$clientName."_last_seen",strftime "%Y-%m-%d %H:%M:%S",localtime($clientRef->{last_seen})); readingsBulkUpdate($hash,$clientName."_uptime",$clientRef->{uptime}); readingsBulkUpdate($hash,$clientName."_snr",$clientRef->{rssi}); readingsBulkUpdate($hash,$clientName."_accesspoint",$apName); readingsBulkUpdate($hash,$clientName,'connected'); } elsif (defined($hash->{READINGS}->{$clientName}) && $hash->{READINGS}->{$clientName}->{VAL} ne 'disconnected') { Log3 $name, 5, "$name ($self) - Client '$clientName' previously connected is now disconnected."; readingsBulkUpdate($hash,$clientName,'disconnected'); } } return undef; } ############################################################################### sub Unifi_SetHealthReadings($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; readingsBulkUpdate($hash,'#UC_wlan_state',$hash->{wlan_health}->{status}); readingsBulkUpdate($hash,'#UC_wlan_users',$hash->{wlan_health}->{num_user}); readingsBulkUpdate($hash,'#UC_wlan_accesspoints',$hash->{wlan_health}->{num_ap}); readingsBulkUpdate($hash,'#UC_wlan_guests',$hash->{wlan_health}->{num_guest}); readingsBulkUpdate($hash,'#UC_unarchived_alerts',scalar @{$hash->{alerts_unarchived}}); readingsBulkUpdate($hash,'#UC_events',scalar(@{$hash->{events}}).' (last '.$hash->{unifi}->{eventPeriod}.'h)'); return undef; } ############################################################################### sub Unifi_SetAccesspointReadings($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; my ($apName,$apRef,$essid); for my $apID (keys %{$hash->{accespoints}}) { $essid = ''; $apRef = $hash->{accespoints}->{$apID}; $apName = ($apRef->{name}) ? $apRef->{name} : $apRef->{ip}; if (defined $apRef->{vap_table} && scalar @{$apRef->{vap_table}}) { for my $vap (@{$apRef->{vap_table}}) { $essid .= $vap->{essid}.','; } $essid =~ s/.$//; } else { my $essid = 'none'; } readingsBulkUpdate($hash,'#AP_'.$apName.'_state',($apRef->{state} == 1) ? 'ok' : 'error'); readingsBulkUpdate($hash,'#AP_'.$apName.'_clients',$apRef->{'num_sta'}); readingsBulkUpdate($hash,'#AP_'.$apName.'_essid',$essid); # readingsBulkUpdate($hash,'#AP_'.$apName.'_guests',$apRef->{'guest-num_sta'}); # readingsBulkUpdate($hash,'#AP_'.$apName.'_users',$apRef->{'user-num_sta'}); # readingsBulkUpdate($hash,'#AP_'.$apName.'_last_seen',$apRef->{'last_seen'}); } return undef; } ############################################################################### sub Unifi_DisconnectClient_Send($@) { my ($hash,@clients) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed with count:'".scalar(@clients)."', ID:'".$clients[0]."'"; my $id = shift @clients; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{unifi}->{url}."cmd/stamgr", callback => \&Unifi_DisconnectClient_Receive, clients => [@clients], data => "{'mac': '".$hash->{clients}->{$id}->{mac}."', 'cmd': 'kick-sta'}", } ); return undef; } ############################################################################### sub Unifi_DisconnectClient_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Unifi_ReceiveFailure($hash,{rc => 'Error while requesting', msg => $param->{url}." - $err"}); } elsif ($data ne "") { if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($data->{meta}->{rc} eq "ok") { Log3 $name, 5, "$name ($self) - state:'$data->{meta}->{rc}'"; } else { Unifi_ReceiveFailure($hash,$data->{meta}); } } else { Unifi_ReceiveFailure($hash,{rc => $param->{code}, msg => "Failed with HTTP Code $param->{code}."}); } } if (scalar @{$param->{clients}}) { Unifi_DisconnectClient_Send($hash,@{$param->{clients}}); } return undef; } ############################################################################### sub Unifi_ApCmd_Send($$@) { #cmd: 'set-locate', 'unset-locate', 'restart' my ($hash,$cmd,@aps) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed with cmd:'".$cmd."', count:'".scalar(@aps)."', ID:'".$aps[0]."'"; my $id = shift @aps; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{unifi}->{url}."cmd/devmgr", callback => \&Unifi_ApCmd_Receive, aps => [@aps], cmd => $cmd, data => "{'mac': '".$hash->{accespoints}->{$id}->{mac}."', 'cmd': '".$cmd."'}", } ); return undef; } ############################################################################### sub Unifi_ApCmd_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Unifi_ReceiveFailure($hash,{rc => 'Error while requesting', msg => $param->{url}." - $err"}); } elsif ($data ne "") { if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($data->{meta}->{rc} eq "ok") { Log3 $name, 5, "$name ($self) - state:'$data->{meta}->{rc}'"; } else { Unifi_ReceiveFailure($hash,$data->{meta}); } } else { Unifi_ReceiveFailure($hash,{rc => $param->{code}, msg => "Failed with HTTP Code $param->{code}."}); } } if (scalar @{$param->{aps}}) { Unifi_ApCmd_Send($hash,$param->{cmd},@{$param->{aps}}); } return undef; } ############################################################################### sub Unifi_ArchiveAlerts_Send($) { my ($hash) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whoami()); Log3 $name, 5, "$name ($self) - executed."; HttpUtils_NonblockingGet( { %{$hash->{httpParams}}, url => $hash->{unifi}->{url}."cmd/evtmgr", callback => \&Unifi_Cmd_Receive, data => "{'cmd': 'archive-all-alarms'}", } ); return undef; } ############################################################################### sub Unifi_Cmd_Receive($) { my ($param, $err, $data) = @_; my ($name,$self,$hash) = ($param->{hash}->{NAME},Unifi_Whoami(),$param->{hash}); Log3 $name, 5, "$name ($self) - executed."; if ($err ne "") { Unifi_ReceiveFailure($hash,{rc => 'Error while requesting', msg => $param->{url}." - $err"}); } elsif ($data ne "") { if ($param->{code} == 200 || $param->{code} == 400 || $param->{code} == 401) { eval { $data = decode_json($data); 1; } or do { $data = { meta => {rc => 'error.decode_json', msg => $@} }; }; if ($data->{meta}->{rc} eq "ok") { Log3 $name, 5, "$name ($self) - state:'$data->{meta}->{rc}'"; } else { Unifi_ReceiveFailure($hash,$data->{meta}); } } else { Unifi_ReceiveFailure($hash,{rc => $param->{code}, msg => "Failed with HTTP Code $param->{code}."}); } } return undef; } ############################################################################### sub Unifi_ClientNames($@) { my ($hash,$ID,$W) = @_; my $clientRef; my $devAliases = AttrVal($hash->{NAME},"devAlias",0); if(defined $ID && defined $W && $W eq 'makeAlias') { # Return Alias from ID $clientRef = $hash->{clients}->{$ID}; if ( ($devAliases && $devAliases =~ /$ID:(.+?)(\s|$)/) || ($devAliases && defined $clientRef->{name} && $devAliases =~ /$clientRef->{name}:(.+?)(\s|$)/) || ($devAliases && defined $clientRef->{hostname} && $devAliases =~ /$clientRef->{hostname}:(.+?)(\s|$)/) || (defined $clientRef->{name} && $clientRef->{name} =~ /^([\w\.\-]+)$/) || (defined $clientRef->{hostname} && $clientRef->{hostname} =~ /^([\w\.\-]+)$/) ) { $ID = $1; } return $ID; } elsif (defined $ID && defined $W && $W eq 'makeID') { # Return ID from Alias for my $clientID (keys %{$hash->{clients}}) { $clientRef = $hash->{clients}->{$clientID}; if ( ($devAliases && $devAliases =~ /$clientID:$ID/) || ($devAliases && defined $clientRef->{name} && $devAliases =~ /$clientRef->{name}:$ID/) || ($devAliases && defined $clientRef->{hostname} && $devAliases =~ /$clientRef->{hostname}:$ID/) || (defined $clientRef->{name} && $clientRef->{name} eq $ID) || (defined $clientRef->{hostname} && $clientRef->{hostname} eq $ID) ) { $ID = $clientID; last; } } return $ID; } else { # Return all clients in a scalar my $clients = ''; for my $clientID (keys %{$hash->{clients}}) { $clients .= Unifi_ClientNames($hash,$clientID,'makeAlias').','; } $clients =~ s/.$//; return $clients; } } ############################################################################### sub Unifi_ApNames($@) { my ($hash,$ID,$W) = @_; my $clientRef; if(defined $ID && defined $W && $W eq 'makeName') { # Return Name or IP from ID $clientRef = $hash->{accespoints}->{$ID}; if ( (defined $clientRef->{name} && $clientRef->{name} =~ /^([\w\.\-]+)$/) || (defined $clientRef->{ip} && $clientRef->{ip} =~ /^([\w\.\-]+)$/) ) { $ID = $1; } return $ID; } elsif (defined $ID && defined $W && $W eq 'makeID') { # Return ID from Name or IP for (keys %{$hash->{accespoints}}) { $clientRef = $hash->{accespoints}->{$_}; if ( (defined $clientRef->{name} && $clientRef->{name} eq $ID) || (defined $clientRef->{ip} && $clientRef->{ip} eq $ID) ) { $ID = $_; last; } } return $ID; } else { # Return all aps in a scalar my $aps = ''; for my $apID (keys %{$hash->{accespoints}}) { $aps .= Unifi_ApNames($hash,$apID,'makeName').','; } $aps =~ s/.$//; return $aps; } } ############################################################################### sub Unifi_NextUpdateFn($$) { my ($hash,$fn) = @_; my $NextUpdateFn = 0; for (keys %{$hash->{updateDispatch}}) { # {updateDispatch}->{callFn}[callFnRef,'receiveFn',receiveFnRef] if($hash->{updateDispatch}->{$_}[1] && $hash->{updateDispatch}->{$_}[1] eq $fn) { delete $hash->{updateDispatch}->{$_}; } elsif(!$NextUpdateFn && $hash->{updateDispatch}->{$_}[0] && $_ ne 'Unifi_ProcessUpdate') { $NextUpdateFn = $hash->{updateDispatch}->{$_}[0]; } } if (!$NextUpdateFn && $hash->{updateDispatch}->{Unifi_ProcessUpdate}[0]) { $NextUpdateFn = $hash->{updateDispatch}->{Unifi_ProcessUpdate}[0]; delete $hash->{updateDispatch}->{Unifi_ProcessUpdate}; } $NextUpdateFn->($hash) if($NextUpdateFn); return undef; } ############################################################################### sub Unifi_ReceiveFailure($$) { my ($hash,$meta) = @_; my ($name,$self) = ($hash->{NAME},Unifi_Whowasi()); if (defined $meta->{msg}) { if ($meta->{msg} eq 'api.err.LoginRequired') { Log3 $name, 5, "$name ($self) - LoginRequired detected..."; if(Unifi_CONNECTED($hash)) { Log3 $name, 5, "$name ($self) - I am the first who detected LoginRequired. Do re-login..."; Unifi_CONNECTED($hash,'disconnected'); Unifi_DoUpdate($hash); return undef; } } elsif ($meta->{msg} eq "api.err.NoSiteContext" || ($hash->{unifi}->{version} == 3 && $meta->{msg} eq "api.err.InvalidObject")) { Log3 $name, 1, "$name ($self) - Failed! - state:'$meta->{rc}' - msg:'$meta->{msg}'" ." - This error indicates that the in your definition is wrong." ." Try to modify your definition with = default."; } else { Log3 $name, 5, "$name ($self) - Failed! - state:'$meta->{rc}' - msg:'$meta->{msg}'"; } } else { Log3 $name, 5, "$name ($self) - Failed (without message)! - state:'$meta->{rc}'"; } } ############################################################################### sub Unifi_CONNECTED($@) { my ($hash,$set) = @_; if ($set) { $hash->{unifi}->{CONNECTED} = $set; RemoveInternalTimer($hash); %{$hash->{updateDispatch}} = (); if (!defined($hash->{READINGS}->{state}->{VAL}) || $hash->{READINGS}->{state}->{VAL} ne $set) { readingsSingleUpdate($hash,"state",$set,1); } return undef; } else { if ($hash->{unifi}->{CONNECTED} eq 'disabled') { return 'disabled'; } elsif ($hash->{unifi}->{CONNECTED} eq 'connected') { return 1; } else { return 0; } } } ############################################################################### sub Unifi_Whoami() { return (split('::',(caller(1))[3]))[1] || ''; } sub Unifi_Whowasi() { return (split('::',(caller(2))[3]))[1] || ''; } ############################################################################### 1; =pod =begin html

Unifi

    Unifi is the FHEM module for the Ubiquiti Networks (UBNT) - Unifi Controller.

    e.g. you can use the 'presence' function, which will tell you if a device is connected to your WLAN (even in PowerSave Mode!).
    Immediately after connecting to your WLAN it will set the device-reading to 'connected' and about 5 minutes after leaving your WLAN it will set the reading to 'disconnected'.
    The device will be still connected, even it is in PowerSave-Mode. (In this mode the devices are not pingable, but the connection to the unifi-controller does not break off.)

    Or you can use the other readings or set and get features to control your unifi-controller, accesspoints and wlan-clients.

    Prerequisites

      The Perl module JSON is required.
      On Debian/Raspbian: apt-get install libjson-perl
      Via CPAN: cpan install JSON

    Define

      define <name> Unifi <ip> <port> <username> <password> [<interval> [<siteID> [<version>]]]


      <name>:
        The FHEM device name for the device.
      <ip>:
        The ip of your unifi-controller.
      <port>:
        The port of your unifi-controller. Normally it's 8443 or 443.
      <username>:
        The Username to log on.
      <password>:
        The password to log on.
      [<interval>]:
        (optional without <siteID> and <version>)
        Interval to fetch the information from the unifi-api.
        default: 30 seconds

      [<siteID>]:
        (optional without <version>)
        You can find the site-ID by selecting the site in the UniFi web interface.
        e.g. https://192.168.12.13:8443/manage/s/foobar the siteId you must use is: foobar.
        default: default

      [<version>]:
        (optional if you use unifi v4)
        Unifi-controller version.
        Version must be specified if version is not 4. At the moment version 3 and 4 are supported.
        default: 4


    Examples

      define my_unifi_controller Unifi 192.168.1.15 443 admin secret

      Or with optional parameters <interval>, <siteID> and <version>:
      define my_unifi_controller Unifi 192.168.1.15 443 admin secret 30 default 3

    Set

      Note: Some setters are not available if controller is not connected, or no data is available for them.

    • set <name> update
      Makes immediately a manual update.

    • set <name> clear <readings|clientData|all>
      Clears the readings, clientData or all.

    • set <name> archiveAlerts
      Archive all unarchived Alerts.

    • set <name> disconnectClient <all|user_id|controllerAlias|hostname|devAlias>
      Disconnect one ore all clients.

    • set <name> restartAP <all|_id|name|ip>
      Restart one ore all accesspoints.

    • set <name> setLocateAP <all|_id|name|ip>
      Start 'locate' on one or all accesspoints.

    • set <name> unsetLocateAP <all|_id|name|ip>
      Stop 'locate' on one or all accesspoints.

    Get

      Note: Some getters are not available if no data is available for them.

    • get <name> clientData <all|user_id|controllerAlias|hostname|devAlias>
      Show more details about clients.

    • get <name> events
      Show events in specified 'eventPeriod'.

    • get <name> unarchivedAlerts
      Show all unarchived Alerts.

    Attributes

    • attr devAlias
      Can be used to rename device names in the format <user_id|controllerAlias|hostname>:Aliasname.
      Separate using blank to rename multiple devices.
      Example (user_id): attr unifi devAlias 5537d138e4b033c1832c5c84:iPhone-Claudiu
      Example (controllerAlias): attr unifi devAlias iPhoneControllerAlias:iPhone-Claudiu
      Example (hostname): attr unifi devAlias iphone:iPhone-Claudiu

    • attr eventPeriod <1...168>
      Can be used to configure the time-period (hours) of fetched events from controller.
      default: 24

    • attr disable <1|0>
      With this attribute you can disable the whole module.
      If set to 1 the module will be stopped and no updates are performed.
      If set to 0 the automatic updating will performed.

    • attr verbose 5
      This attribute will help you if something does not work as espected.

    • attr httpLoglevel <1,2,3,4,5>
      Can be used to debug the HttpUtils-Module. Set it smaller or equal as your 'global verbose level'.
      default: 5

    • readingFnAttributes

    Readings

      Note: All readings generate events. You can control this with these global attributes.
    • Each client has 6 readings for connection-state, SNR, uptime, last_seen-time, connected-AP and hostname.
    • Each AP has 3 readings for state (can be 'ok' or 'error'), essid's and count of connected-clients.
    • The unifi-controller has 6 readings for event-count in configured 'timePeriod', unarchived-alert count, accesspoint count, overall wlan-state (can be 'ok', 'warning', or other?), connected user count and connected guest count.
    • The Unifi-device reading 'state' represents the connection-state to the unifi-controller (can be 'connected', 'disconnected', 'initialized' and 'disabled').

=end html =cut