mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-03-06 00:26:35 +00:00
343 lines
12 KiB
Perl
Executable File
343 lines
12 KiB
Perl
Executable File
##############################################################################
|
|
# $Id$
|
|
# 74_UnifiSwitch.pm
|
|
|
|
# CHANGED
|
|
##############################################################################
|
|
# V 0.1
|
|
# - feature: 74_UnifiSwitch: initial version
|
|
# V 0.11
|
|
# - feature: 74_UnifiSwitch: state des USW wird gesetzt
|
|
# Port-Nummern < 9 mit führender 0
|
|
# Model als Internal
|
|
# port-state als reading hinzugefügt
|
|
# V 0.90
|
|
# - feature: 74_UnififSwitch: setter for poe-Mode
|
|
# added commandref
|
|
# V 0.91
|
|
# - fixed: 74_UnififSwitch: fixed wording in commandref
|
|
# added new state-mappings
|
|
# V 0.92
|
|
# - fixed: 74_UnififSwitch: fixed possible log-error in eq in line 135
|
|
#
|
|
# TODOs:
|
|
# - state des USW für weiter state-Numbers korrekt in Worte übersetzen
|
|
|
|
package main;
|
|
my $version="0.92";
|
|
# Laden evtl. abhängiger Perl- bzw. FHEM-Module
|
|
use strict;
|
|
use warnings;
|
|
use POSIX;
|
|
use JSON qw(decode_json);
|
|
|
|
### Forward declarations ####################################################{
|
|
sub UnifiSwitch_Initialize($$);
|
|
sub UnifiSwitch_Define($$);
|
|
sub UnifiSwitch_Undef($$);
|
|
sub UnifiSwitch_Attr(@);
|
|
sub UnifiSwitch_Set($@);
|
|
sub UnifiSwitch_Get($@);
|
|
sub UnifiSwitch_Parse($$);
|
|
sub UnifiSwitch_Whoami();
|
|
sub UnifiSwitch_Whowasi();
|
|
|
|
|
|
sub UnifiSwitch_Initialize($$) {
|
|
my ($hash) = @_;
|
|
$hash->{DefFn} = "UnifiSwitch_Define";
|
|
$hash->{UndefFn} = "UnifiSwitch_Undef";
|
|
$hash->{ParseFn} = "UnifiSwitch_Parse";
|
|
$hash->{AttrFn} = "UnifiSwitch_Attr";
|
|
$hash->{SetFn} = "UnifiSwitch_Set";
|
|
$hash->{GetFn} = "UnifiSwitch_Get";
|
|
$hash->{AttrList} = $readingFnAttributes;
|
|
# TODO: notwendig?
|
|
$hash->{Match} = "^UnifiSwitch";
|
|
# TODO ATTR wird nicht übernommen
|
|
$hash->{AutoCreate}={"UnifiSwitch.*" => { ATTR => "event-on-change-reading:.* event-min-interval:.*:300",
|
|
FILTER => "%NAME",
|
|
autocreateThreshold => "1:1"} };
|
|
}
|
|
|
|
sub UnifiSwitch_Define($$) {
|
|
my ( $hash, $def) = @_;
|
|
my @a = split("[ \t][ \t]*", $def);
|
|
my $name = $a[0];
|
|
Log3 $name, 3, "UnifiSwitch_Define - executed. 0 ";
|
|
# zweites Argument ist die eindeutige Geräteadresse
|
|
my $address = $a[2];
|
|
|
|
if(defined($modules{UnifiSwitch}{defptr}{$address})){
|
|
return "Switch with name $address already defined in ".($modules{UnifiSwitch}{defptr}{$address}{NAME});
|
|
}
|
|
$hash->{CODE}=$address;
|
|
$hash->{VERSION}=$version;
|
|
# Adresse rückwärts dem Hash zuordnen (für ParseFn)
|
|
$modules{UnifiSwitch}{defptr}{$address} = $hash;
|
|
|
|
Log3 $name, 3, "UnifiSwitch_Define - Adress: ".$address;
|
|
AssignIoPort($hash);
|
|
}
|
|
|
|
sub UnifiSwitch_Undef($$){
|
|
my ($hash, $name) = @_;
|
|
Log3 $name, 3, "$name (UnifiSwitch_Undef) - executed.".$hash->{CODE};
|
|
if(defined($hash->{CODE}) && defined($modules{UnifiSwitch}{defptr}{$hash->{CODE}})){
|
|
delete($modules{UnifiSwitch}{defptr}{$hash->{CODE}});
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
sub UnifiSwitch_Attr(@){
|
|
my @a = @_;
|
|
|
|
return undef;
|
|
}
|
|
|
|
|
|
sub UnifiSwitch_Set($@){
|
|
my ($hash,@a) = @_;
|
|
my ($name,$setName,$setVal,$setVal2) = @a;
|
|
Log3 $name, 5, "$name: set called with $setName " . ($setVal ? $setVal : "")." ". ($setVal2 ? $setVal2 : "") if ($setName ne "?");
|
|
|
|
# TODO: ggf. auf disabled des Unifi-devices prüfen?! Wie bekomme ich den io_hash?
|
|
#if(Unifi_CONNECTED($hash) eq 'disabled' && $setName !~ /clear/) {
|
|
# return "Unknown argument $setName, choose one of clear:all,readings";
|
|
# Log3 $name, 5, "$name: set called with $setName but device is disabled!" if($setName ne "?");
|
|
# return undef;
|
|
#}
|
|
if($setName !~ /clear|poeMode/) {
|
|
return "Unknown argument $setName, choose one of "
|
|
."clear:readings poeMode "; #TODO: PortNamen sowie die Modes als Auswahl anhängen
|
|
} else {
|
|
Log3 $name, 4, "$name: set $setName";
|
|
if ($setName eq 'poeMode') {
|
|
return "usage: $setName <port> <off|auto|passive|passthrough|restart>" if( !$setVal );
|
|
my $apRef;
|
|
my $ap = $hash->{usw};
|
|
return "switch has no poe-ports!" if( !$ap->{port_table} );
|
|
$apRef = $ap;
|
|
if( $setVal !~ m/\d+/ ) {
|
|
for my $port (@{$apRef->{port_table}}) {
|
|
next if( $port->{name} !~ $setVal );
|
|
$setVal = $port->{port_idx};
|
|
last;
|
|
}
|
|
}
|
|
return "port-ID musst be numeric" if( $setVal !~ m/\d+/ );
|
|
return "port musst be in [1..". scalar @{$apRef->{port_table}} ."] " if( $setVal < 1 || $setVal > scalar @{$apRef->{port_table}} );
|
|
return "switch '$apRef->{name}' has no port $setVal" if( !defined(@{$apRef->{port_table}}[$setVal-1] ) );
|
|
return "port $setVal of switch '$apRef->{name}' is not poe capable" if( !@{$apRef->{port_table}}[$setVal-1]->{port_poe} );
|
|
|
|
my $port_overrides = $apRef->{port_overrides};
|
|
my $idx;
|
|
my $i = 0;
|
|
for my $entry (@{$port_overrides}) {
|
|
if( defined $entry->{port_idx} && ($entry->{port_idx} eq $setVal) ) {
|
|
$idx = $i;
|
|
last;
|
|
}
|
|
++$i;
|
|
}
|
|
if( !defined($idx) ) {
|
|
push @{$port_overrides}, {port_idx => $setVal+0};
|
|
$idx = scalar @{$port_overrides};
|
|
}
|
|
|
|
if( $setVal2 eq 'off' ) {
|
|
$port_overrides->[$idx]{poe_mode} = "off";
|
|
IOWrite($hash, "Unifi_RestJson_Send", $apRef->{device_id}, $port_overrides);
|
|
|
|
} elsif( $setVal2 eq 'auto' || $setVal2 eq 'poe+' ) {
|
|
#return "port $setVal not auto poe capable" if( @{$apRef->{port_table}}[$setVal-1]->{poe_caps} & 0x03 ) ;
|
|
$port_overrides->[$idx]{poe_mode} = "auto";
|
|
IOWrite($hash, "Unifi_RestJson_Send", $apRef->{device_id}, $port_overrides );
|
|
|
|
} elsif( $setVal2 eq 'passive' ) {
|
|
#return "port $setVal not passive poe capable" if( @{$apRef->{port_table}}[$setVal-1]->{poe_caps} & 0x04 ) ;
|
|
$port_overrides->[$idx]{poe_mode} = "pasv24";
|
|
IOWrite($hash, "Unifi_RestJson_Send", $apRef->{device_id}, $port_overrides);
|
|
|
|
} elsif( $setVal2 eq 'passthrough' ) {
|
|
#return "port $setVal not passthrough poe capable" if( @{$apRef->{port_table}}[$setVal-1]->{poe_caps} & 0x08 ) ;
|
|
$port_overrides->[$idx]{poe_mode} = "passthrough";
|
|
IOWrite($hash, "Unifi_RestJson_Send", $apRef->{device_id}, $port_overrides);
|
|
|
|
} elsif( $setVal2 eq 'restart' ) {#TODO: Was wir hier gemacht? Funktioniert das noch?
|
|
IOWrite($hash, "Unifi_RestJson_Send", {cmd => 'power-cycle', mac => $apRef->{mac}, port_idx => $setVal+0});
|
|
|
|
} else {
|
|
return "unknwon poe mode $setVal2";
|
|
}
|
|
}elsif ($setName eq 'clear') {
|
|
if ($setVal eq 'readings' || $setVal eq 'all') {
|
|
for (keys %{$hash->{READINGS}}) {
|
|
delete $hash->{READINGS}->{$_} if($_ ne 'state');
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
|
|
sub UnifiSwitch_Get($@){
|
|
my @a = @_;
|
|
|
|
return undef;
|
|
}
|
|
|
|
sub UnifiSwitch_Parse($$) {
|
|
my ($io_hash, $message) = @_;
|
|
my ($name,$self) = ($io_hash->{NAME},UnifiSwitch_Whoami());
|
|
my $i1=index($message,"_")+1;
|
|
my $i2=index($message,"{")-$i1;
|
|
my $address = substr($message, $i1, $i2);
|
|
Log3 $name, 5, "$name ($self) - executed. UnifiSwitch: Adress: ".$address;
|
|
my $message_json=substr($message,$i1+$i2);
|
|
Log3 $name, 5, "$name ($self) - executed. UnifiSwitch: message_json: ".$message_json;
|
|
|
|
# wenn bereits eine Gerätedefinition existiert (via Definition Pointer aus Define-Funktion)
|
|
if(my $hash = $modules{UnifiSwitch}{defptr}{$address}){
|
|
# Nachricht für $hash verarbeiten
|
|
my $apRef = decode_json($message_json);
|
|
$hash->{usw} = $apRef;
|
|
if( $apRef->{type} eq 'usw' ){
|
|
if ($apRef->{state} eq "1"){
|
|
$hash->{STATE} = "connected";
|
|
}elsif($apRef->{state} eq "2"){
|
|
$hash->{STATE} = "managed by other";
|
|
}elsif($apRef->{state} eq "4"){
|
|
$hash->{STATE} = "upgrading";
|
|
}elsif($apRef->{state} eq "5"){
|
|
$hash->{STATE} = "provisioning";
|
|
}else{
|
|
$hash->{STATE} = "unknown: ".$apRef->{state}; # TODO: Weitere states setzen wenn state-id bekannt
|
|
}
|
|
$hash->{MODEL}=$apRef->{model};
|
|
readingsBeginUpdate($hash);
|
|
if( $apRef->{port_table} ){
|
|
for my $port (@{$apRef->{port_table}}) {
|
|
my $port_id=$port->{port_idx} > 9 ? "port_".$port->{port_idx} : "port_0".$port->{port_idx};
|
|
readingsBulkUpdate($hash,$port_id."_name",$port->{name});
|
|
if(defined $port->{speed} && looks_like_number($port->{speed})){
|
|
readingsBulkUpdate($hash,$port_id."_state",$port->{speed} > 0 ? $port->{speed}." Mbps" : "disconnected");
|
|
}else{
|
|
readingsBulkUpdate($hash,$port_id."_state","unknown");
|
|
}
|
|
if( $port->{port_poe} ){
|
|
readingsBulkUpdate($hash,$port_id."_poe_mode",$port->{poe_mode});
|
|
readingsBulkUpdate($hash,$port_id."_poe_power",$port->{poe_power});
|
|
readingsBulkUpdate($hash,$port_id."_poe_voltage",$port->{poe_voltage});
|
|
readingsBulkUpdate($hash,$port_id."_poe_current",$port->{poe_current});
|
|
}
|
|
}
|
|
}
|
|
readingsEndUpdate($hash,1);
|
|
}
|
|
Log3 $name, 5, "$name ($self) - return: ".$hash->{NAME};
|
|
return $hash->{NAME}; # Rückgabe des Gerätenamens, für welches die Nachricht bestimmt ist.
|
|
}
|
|
else{
|
|
# Keine Gerätedefinition verfügbar
|
|
# Daher Vorschlag define-Befehl: <NAME> <MODULNAME> <ADDRESSE>
|
|
Log3 $name, 3, "$name ($self) - return: UNDEFINED UnifiSwitch_".$address." UnifiSwitch $address";
|
|
return "UNDEFINED ".$address." UnifiSwitch $address";
|
|
}
|
|
}
|
|
|
|
###############################################################################
|
|
|
|
sub UnifiSwitch_Whoami() { return (split('::',(caller(1))[3]))[1] || ''; }
|
|
sub UnifiSwitch_Whowasi() { return (split('::',(caller(2))[3]))[1] || ''; }
|
|
|
|
# Eval-Rückgabewert für erfolgreiches
|
|
# Laden des Moduls
|
|
1;
|
|
|
|
|
|
# Beginn der Commandref
|
|
|
|
=pod
|
|
=item device
|
|
=item summary Show info and control UnifiSwitch (USW) (Unifi-Device required)
|
|
=item summary_DE Zeigt Infos zum UnifiSwitch (USW) an und steuert diesen.
|
|
|
|
=begin html
|
|
|
|
<a name="UnifiSwitch"></a>
|
|
<h3>UnifiSwitch</h3>
|
|
<ul>
|
|
|
|
UnifiSwitch is the FHEM module for the Ubiquiti Networks (UBNT) Switch - USW.<br>
|
|
<br>
|
|
You can use the readings or set features to control your unifi-switch.
|
|
<br>
|
|
<h4>Prerequisites</h4>
|
|
<ul>
|
|
<li>
|
|
A connected Unifi-Device as IODev.
|
|
</li>
|
|
<li>
|
|
The Perl module JSON is required. <br>
|
|
On Debian/Raspbian: <code>apt-get install libjson-perl </code><br>
|
|
Via CPAN: <code>cpan install JSON</code>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>Define</h4>
|
|
<ul>
|
|
<code>define <name> UnifiSwitch <ip> <nameOfSwitch></code>
|
|
<br>Normaly this device will be autocreated!<br>
|
|
<br>
|
|
<name>:
|
|
<ul>
|
|
<code>The FHEM device name for the device.</code><br>
|
|
</ul>
|
|
<nameOfSwitch>:
|
|
<ul>
|
|
<code>The name of the switch in unifi-controller.</code><br>
|
|
</ul>
|
|
</ul>
|
|
|
|
<h4>Set</h4>
|
|
<ul>
|
|
<li><code>set <name> clear <readings|all></code><br>
|
|
Clears the readings or all. </li>
|
|
<br>
|
|
<li><code>set <name> poeMode <port> <off|auto|passive|passthrough|restart></code><br>
|
|
Set PoE mode for <port>. </li>
|
|
</ul>
|
|
|
|
<h4>Readings</h4>
|
|
<ul>
|
|
Note: All readings generate events. You can control this with <a href="#readingFnAttributes">these global attributes</a>.
|
|
<li>Each port has the readings name and state. POE-ports have more readings.</li>
|
|
<li>name
|
|
<ul>The name of the port as defined in UnifiController.</ul>
|
|
</li>
|
|
<li>state
|
|
<ul>The connection state of the port. Can be disconnected or in Mbps/Gbps.</ul>
|
|
</li>
|
|
<li>poe_current
|
|
<ul>The current of the port.</ul>
|
|
</li>
|
|
<li>poe_mode
|
|
<ul>The poe-mode of the port.</ul>
|
|
</li>
|
|
<li>poe_power
|
|
<ul>The power of the port.</ul>
|
|
</li>
|
|
<li>poe_voltage
|
|
<ul>The voltage of the port.</ul>
|
|
</li>
|
|
</ul>
|
|
<br>
|
|
|
|
</ul>
|
|
|
|
=end html
|
|
|
|
# Ende der Commandref
|
|
=cut |