mirror of
https://github.com/fhem/fhem-mirror.git
synced 2024-06-17 05:40:11 +00:00
b9d4f54d29
git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@21645 2b470e98-0d58-463d-a4d8-8e2adae1ed80
688 lines
22 KiB
Perl
688 lines
22 KiB
Perl
################################################################
|
|
# $Id$
|
|
#
|
|
# Release 2020-04-12
|
|
#
|
|
# Copyright notice
|
|
#
|
|
# (c) 2016 Copyright: Volker Kettenbach
|
|
# e-mail: volker at kettenbach minus it dot de
|
|
#
|
|
# Description:
|
|
# This is an FHEM-Module for the TP Link TPLinkHS110110/110
|
|
# wifi controlled power outlet.
|
|
# It support switching on and of the outlet as well as switching
|
|
# on and of the nightmode (green led off).
|
|
# It supports reading several readings as well as the
|
|
# realtime power readings of the HS110.
|
|
#
|
|
# Requirements
|
|
# Perl Module: IO::Socket::INET
|
|
# Perl Module: IO::Socket::Timeout
|
|
#
|
|
# In recent debian based distributions IO::Socket::Timeout can
|
|
# be installed by "apt-get install libio-socket-timeout-perl"
|
|
# In older distribution try "cpan IO::Socket::Timeout"
|
|
#
|
|
# Origin:
|
|
# https://gitlab.com/volkerkettenbach/FHEM-TPLink-Kasa
|
|
#
|
|
################################################################
|
|
|
|
package main;
|
|
|
|
use strict;
|
|
use warnings;
|
|
use IO::Socket::INET;
|
|
use IO::Socket::Timeout;
|
|
use JSON;
|
|
use SetExtensions;
|
|
use Data::Dumper;
|
|
|
|
|
|
#####################################
|
|
sub TPLinkHS110_Initialize($) {
|
|
my ($hash) = @_;
|
|
|
|
$hash->{DefFn} = "TPLinkHS110_Define";
|
|
$hash->{ReadFn} = "TPLinkHS110_Get";
|
|
$hash->{SetFn} = "TPLinkHS110_Set";
|
|
$hash->{UndefFn} = "TPLinkHS110_Undefine";
|
|
$hash->{DeleteFn} = "TPLinkHS110_Delete";
|
|
$hash->{AttrFn} = "TPLinkHS110_Attr";
|
|
$hash->{AttrList} = "interval " .
|
|
"disable:0,1 " .
|
|
"nightmode:on,off " .
|
|
"timeout " .
|
|
"$readingFnAttributes";
|
|
}
|
|
|
|
#####################################
|
|
sub TPLinkHS110_Define($$) {
|
|
my ($hash, $def) = @_;
|
|
my $name = $hash->{NAME};
|
|
|
|
my @a = split("[ \t][ \t]*", $def);
|
|
return "Wrong syntax: use define <name> TPLinkHS110 <hostname/ip> " if (int(@a) != 3);
|
|
|
|
$hash->{INTERVAL} = 300;
|
|
$hash->{TIMEOUT} = 1;
|
|
$hash->{HOST} = $a[2];
|
|
$attr{$name}{"disable"} = 0;
|
|
# initial request after 2 secs, there timer is set to interval for further update
|
|
InternalTimer(gettimeofday() + 2, "TPLinkHS110_Get", $hash, 0);
|
|
|
|
Log3 $hash, 3, "TPLinkHS110: $name defined.";
|
|
|
|
return undef;
|
|
}
|
|
|
|
#####################################
|
|
# sends given command and returns ($errmsg/undef,undef/$decrypteddata)
|
|
sub TPLinkHS110_SendCommand($$) {
|
|
my ($hash, $command) = @_;
|
|
my $name = $hash->{NAME};
|
|
|
|
my $remote_host = $hash->{HOST};
|
|
my $remote_port = 9999;
|
|
my $c = encrypt($command);
|
|
my $socket = IO::Socket::INET->new(PeerAddr => $remote_host,
|
|
PeerPort => $remote_port,
|
|
Proto => 'tcp',
|
|
Type => SOCK_STREAM,
|
|
Timeout => $hash->{TIMEOUT})
|
|
or return("Couldn't connect to $remote_host:$remote_port: $@\n", undef);
|
|
$socket->write($c);
|
|
IO::Socket::Timeout->enable_timeouts_on($socket);
|
|
$socket->read_timeout(2.5);
|
|
|
|
my $dlen;
|
|
my $res;
|
|
my $errmsg;
|
|
my $data;
|
|
|
|
$res = sysread($socket, $dlen, 4);
|
|
$dlen = "" if (!defined($res));
|
|
|
|
if ($res != 4) {
|
|
$errmsg = "Could not read 4 length bytes";
|
|
}
|
|
|
|
my $datalen = 0;
|
|
|
|
if (!defined($errmsg)) {
|
|
for (my $i = 0; $i < 4; $i++) {
|
|
$datalen *= 256;
|
|
$datalen += ord(substr($dlen, $i, 1));
|
|
}
|
|
|
|
Log3 $hash, 4, "TPLinkHS110: $name Get length - " . $datalen; # JV
|
|
|
|
|
|
my $datapart;
|
|
$data = "";
|
|
my $partlen = 0;
|
|
my $remainlen = $datalen;
|
|
my $ctr = 0;
|
|
|
|
while (($remainlen > 0) && (!defined($errmsg))) {
|
|
$res = sysread($socket, $datapart, $remainlen);
|
|
if (!defined($res) || $res < 0) {
|
|
$errmsg = "Data reading failed - received errcode: " . $res;
|
|
}
|
|
elsif ($res == 0) {
|
|
$ctr++;
|
|
$errmsg = "Could not read correct length - expected: " . $datalen . " received: " . $partlen if ($ctr > 2);
|
|
}
|
|
else {
|
|
$ctr = 0;
|
|
$data .= $datapart;
|
|
$remainlen -= $res;
|
|
}
|
|
}
|
|
|
|
Log3 $hash, 4, "TPLinkHS110: $name Get read data length - " . length($data); # JV
|
|
}
|
|
|
|
$socket->close();
|
|
|
|
if (!defined($errmsg)) {
|
|
$data = decrypt($data);
|
|
return(undef, $data);
|
|
}
|
|
else {
|
|
return($errmsg, undef);
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#####################################
|
|
sub TPLinkHS110_Get($$) {
|
|
my ($hash) = @_;
|
|
my $name = $hash->{NAME};
|
|
my ($success, $json, $realtimejson);
|
|
return "Device disabled in config" if ($attr{$name}{"disable"} eq "1");
|
|
RemoveInternalTimer($hash);
|
|
InternalTimer(gettimeofday() + $hash->{INTERVAL}, "TPLinkHS110_Get", $hash, 1);
|
|
$hash->{NEXTUPDATE} = localtime(gettimeofday() + $hash->{INTERVAL});
|
|
|
|
my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst) = localtime(time);
|
|
$mon++;
|
|
$year += 1900;
|
|
|
|
my $errmsg;
|
|
my $data;
|
|
|
|
my $command = '{"system":{"get_sysinfo":{}},"time":{"get_time":{}}}';
|
|
($errmsg, $data) = TPLinkHS110_SendCommand($hash, $command);
|
|
if (defined($errmsg)) {
|
|
Log3 $hash, 1, "TPLinkHS110: $name Get failed - " . $errmsg; # JV
|
|
return;
|
|
}
|
|
|
|
readingsBeginUpdate($hash);
|
|
|
|
($success, $json) = TPLinkHS110__evaljson($name, $data);
|
|
if (!$success) {
|
|
Log3 $hash, 1, "TPLinkHS110: $name Get failed"; # JV
|
|
readingsEndUpdate($hash, 1);
|
|
return;
|
|
}
|
|
|
|
Log3 $hash, 3, "TPLinkHS110: $name Get called. Relay state: $json->{'system'}->{'get_sysinfo'}->{'relay_state'}, RSSI: $json->{'system'}->{'get_sysinfo'}->{'rssi'}";
|
|
|
|
my $hw_ver = $json->{'system'}->{'get_sysinfo'}->{'hw_ver'};
|
|
my %hwMap = hwMapping();
|
|
|
|
foreach my $key (sort keys %{$json->{'system'}->{'get_sysinfo'}}) {
|
|
my $sysinfoValue = $json->{'system'}->{'get_sysinfo'}->{$key};
|
|
|
|
#adjust different hw_ver readings
|
|
if (exists($hwMap{$hw_ver}{'system'}{'get_sysinfo'}{$key})) {
|
|
if (exists($hwMap{$hw_ver}{'system'}{'get_sysinfo'}{$key}{'factor'})) {
|
|
$sysinfoValue = $sysinfoValue * $hwMap{$hw_ver}{'system'}{'get_sysinfo'}{$key}{'factor'};
|
|
}
|
|
$key = $hwMap{$hw_ver}{'system'}{'get_sysinfo'}{$key}{'name'}
|
|
}
|
|
|
|
# next_action
|
|
if ($key eq "next_action") {
|
|
if ($sysinfoValue->{'type'} eq "1" ) {
|
|
# e.g. 12:34 on
|
|
$sysinfoValue = sprintf("%02i:%02i %s",int($sysinfoValue->{'schd_sec'} / 60 / 60),int($sysinfoValue->{'schd_sec'} / 60 % 60),($sysinfoValue->{'action'} eq "1" ? ' on' : " off" ));
|
|
} else {
|
|
$sysinfoValue = "-None-";
|
|
}
|
|
}
|
|
|
|
readingsBulkUpdate($hash, $key, $sysinfoValue);
|
|
}
|
|
if ($json->{'system'}->{'get_sysinfo'}->{'relay_state'} == 0) {
|
|
readingsBulkUpdate($hash, "state", "off");
|
|
}
|
|
if ($json->{'system'}->{'get_sysinfo'}->{'relay_state'} == 1) {
|
|
readingsBulkUpdate($hash, "state", "on");
|
|
}
|
|
|
|
# Get Time
|
|
my $remotetime = $json->{'time'}->{'get_time'}->{'year'}."-";
|
|
$remotetime .= $json->{'time'}->{'get_time'}->{'month'}."-";
|
|
$remotetime .= $json->{'time'}->{'get_time'}->{'mday'}. " ";
|
|
$remotetime .= $json->{'time'}->{'get_time'}->{'hour'}.":";
|
|
$remotetime .= $json->{'time'}->{'get_time'}->{'min'}.":";
|
|
$remotetime .= $json->{'time'}->{'get_time'}->{'sec'};
|
|
|
|
readingsBulkUpdate($hash, "time", $remotetime);
|
|
|
|
# If the device is a HS110, get realtime data:
|
|
# if ( 1 == 0 ) {
|
|
if ($json->{'system'}->{'get_sysinfo'}->{'model'} eq "HS110(EU)" or $json->{'system'}->{'get_sysinfo'}->{'model'} eq "HS110(UK)") {
|
|
my $realtimejcommand = '{"emeter":{"get_realtime":{}}}';
|
|
my $rdata;
|
|
($errmsg, $rdata) = TPLinkHS110_SendCommand($hash, $realtimejcommand);
|
|
if (defined($errmsg)) {
|
|
Log3 $hash, 1, "TPLinkHS110: $name Get realtime data failed - " . $errmsg; # JV
|
|
readingsEndUpdate($hash, 1);
|
|
return;
|
|
}
|
|
|
|
if (length($rdata) == 0) {
|
|
Log3 $hash, 1, "TPLinkHS110: $name: Received zero bytes of realtime data. Cannot process realtime data";
|
|
readingsEndUpdate($hash, 1);
|
|
return;
|
|
}
|
|
|
|
($success, $realtimejson) = TPLinkHS110__evaljson($name, $rdata);
|
|
if (!$success) {
|
|
Log3 $hash, 1, "TPLinkHS110: $name: Received zero bytes of realtime data. Cannot process realtime data";
|
|
readingsEndUpdate($hash, 1);
|
|
return;
|
|
}
|
|
else {
|
|
Log3 $hash, 3, "TPLinkHS110: $name Realtime data updated";
|
|
}
|
|
|
|
my %emeterReadings = ();
|
|
|
|
foreach my $key2 (sort keys %{$realtimejson->{'emeter'}->{'get_realtime'}}) {
|
|
|
|
my $emeterValue = $realtimejson->{'emeter'}->{'get_realtime'}->{$key2};
|
|
|
|
#adjust different hw_ver readings, be sure to list all emeter readings in hwMapping
|
|
if (exists($hwMap{$hw_ver}{'emeter'}{'get_realtime'}{$key2})) {
|
|
if (exists($hwMap{$hw_ver}{'emeter'}{'get_realtime'}{$key2}{'factor'})) {
|
|
$emeterValue = $emeterValue * $hwMap{$hw_ver}{'emeter'}{'get_realtime'}{$key2}{'factor'};
|
|
}
|
|
$key2 = $hwMap{$hw_ver}{'emeter'}{'get_realtime'}{$key2}{'name'};
|
|
readingsBulkUpdate($hash, $key2, $emeterValue);
|
|
$emeterReadings{$key2} = $emeterValue;
|
|
}
|
|
else {
|
|
return "Check supported hw_ver of device: $hw_ver\n";
|
|
}
|
|
}
|
|
|
|
Log3 $hash, 3, "TPLinkHS110: $name Device is an HS110. Got extra realtime data: $emeterReadings{'power'} Watt, $emeterReadings{'voltage'} Volt, $emeterReadings{'current'} Ampere";
|
|
|
|
# Get Daily Stats
|
|
$command = '{"emeter":{"get_daystat":{"month":' . $mon . ',"year":' . $year . '}}}';
|
|
($errmsg, $data) = TPLinkHS110_SendCommand($hash, $command);
|
|
if (defined($errmsg)) {
|
|
Log3 $hash, 1, "TPLinkHS110: $name Get daily stats failed - " . $errmsg; # JV
|
|
readingsEndUpdate($hash, 1);
|
|
return;
|
|
}
|
|
|
|
Log3 $hash, 3, "TPLinkHS110: $name Updating daystat. Data: " . $data;
|
|
|
|
($success, $json) = TPLinkHS110__evaljson($name, $data);
|
|
if ($success && $json) {
|
|
|
|
my $total = 0;
|
|
foreach my $key (sort keys @{$json->{'emeter'}->{'get_daystat'}->{'day_list'}}) {
|
|
foreach my $key2 ($json->{'emeter'}->{'get_daystat'}->{'day_list'}[$key]) {
|
|
if ($hw_ver eq "1.0") {
|
|
$total = $total + $key2->{'energy'};
|
|
if ($key2->{'day'} == $mday) {
|
|
readingsBulkUpdate($hash, "daily_total", sprintf("%.3f", $key2->{'energy'}));
|
|
}
|
|
}
|
|
else {
|
|
$total = $total + $key2->{'energy_wh'};
|
|
if ($key2->{'day'} == $mday) {
|
|
readingsBulkUpdate($hash, "daily_total", sprintf("%.3f", $key2->{'energy_wh'} * 0.001));
|
|
}
|
|
}
|
|
|
|
}
|
|
}
|
|
my $count = 1;
|
|
$count = @{$json->{'emeter'}->{'get_daystat'}->{'day_list'}};
|
|
if ($hw_ver eq "1.0") {readingsBulkUpdate($hash, "monthly_total", $total);}
|
|
if ($hw_ver eq "2.0") {readingsBulkUpdate($hash, "monthly_total", $total * 0.001);}
|
|
if ($count) {readingsBulkUpdate($hash, "daily_average", $total / $count)};
|
|
Log3 $hash, 3, "TPLinkHS110: $name Daystat updated";
|
|
}
|
|
else {
|
|
Log3 $hash, 1, "TPLinkHS110: $name Error updating daystat. Success: " . $success . ", json: " . $json;
|
|
Log3 $hash, 3, "TPLinkHS110: $name Updating readings";
|
|
readingsEndUpdate($hash, 1);
|
|
Log3 $hash, 3, "TPLinkHS110: $name Get end";
|
|
return;
|
|
}
|
|
}
|
|
Log3 $hash, 3, "TPLinkHS110: $name Updating readings";
|
|
readingsEndUpdate($hash, 1);
|
|
Log3 $hash, 3, "TPLinkHS110: $name Get end";
|
|
}
|
|
|
|
|
|
#####################################
|
|
sub TPLinkHS110_Set($$) {
|
|
my ($hash, $name, $cmd, @args) = @_;
|
|
my $cmdList = "on off";
|
|
my ($success, $json, $realtimejson);
|
|
return "\"set $name\" needs at least one argument" unless (defined($cmd));
|
|
return if ($attr{$name}{"disable"} eq "1");
|
|
Log3 $hash, 3, "TPLinkHS110: $name Set <" . $cmd . "> called" if ($cmd !~ /\?/);
|
|
|
|
my $command = "";
|
|
if ($cmd eq "on") {
|
|
$command = '{"system":{"set_relay_state":{"state":1}}}';
|
|
}
|
|
elsif ($cmd eq "off") {
|
|
$command = '{"system":{"set_relay_state":{"state":0}}}';
|
|
}
|
|
else # wenn der übergebene Befehl nicht durch X_Set() verarbeitet werden kann, Weitergabe an SetExtensions
|
|
{
|
|
return SetExtensions($hash, $cmdList, $name, $cmd, @args);
|
|
}
|
|
|
|
my $errmsg;
|
|
my $data;
|
|
|
|
($errmsg, $data) = TPLinkHS110_SendCommand($hash, $command);
|
|
if (defined($errmsg)) {
|
|
Log3 $hash, 1, "TPLinkHS110: $name Set failed - " . $errmsg;
|
|
return;
|
|
}
|
|
|
|
readingsBeginUpdate($hash);
|
|
|
|
($success, $json) = TPLinkHS110__evaljson($name, $data);
|
|
if (!$success) {
|
|
Log3 $hash, 1, "TPLinkHS110: $name Set failed - parsing";
|
|
readingsEndUpdate($hash, 1);
|
|
return;
|
|
}
|
|
|
|
if ($json->{'system'}->{'set_relay_state'}->{'err_code'} eq "0") {
|
|
Log3 $hash, 3, "TPLinkHS110: $name Set OK - get status data";
|
|
TPLinkHS110_Get($hash, "");
|
|
|
|
}
|
|
else {
|
|
Log3 $hash, 1, "TPLinkHS110: $name Set failed with error code";
|
|
return "Command failed!";
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
|
|
#####################################
|
|
sub TPLinkHS110_Undefine($$) {
|
|
my ($hash, $arg) = @_;
|
|
my $name = $hash->{NAME};
|
|
RemoveInternalTimer($hash);
|
|
Log3 $hash, 3, "TPLinkHS110: $name undefined.";
|
|
return;
|
|
}
|
|
|
|
|
|
#####################################
|
|
sub TPLinkHS110_Delete {
|
|
my ($hash, $arg) = @_;
|
|
my $name = $hash->{NAME};
|
|
Log3 $hash, 3, "TPLinkHS110: $name deleted.";
|
|
return undef;
|
|
}
|
|
|
|
|
|
#####################################
|
|
sub TPLinkHS110_Attr {
|
|
my ($cmd, $name, $aName, $aVal) = @_;
|
|
my $hash = $defs{$name};
|
|
|
|
if ($aName eq "interval") {
|
|
if ($cmd eq "set") {
|
|
$hash->{INTERVAL} = $aVal;
|
|
}
|
|
else {
|
|
$hash->{INTERVAL} = 300;
|
|
}
|
|
Log3 $hash, 3, "TPLinkHS110: $name INTERVAL set to " . $hash->{INTERVAL};
|
|
}
|
|
|
|
if ($aName eq "timeout") {
|
|
if ($cmd eq "set") {
|
|
$hash->{TIMEOUT} = $aVal;
|
|
}
|
|
else {
|
|
$hash->{TIMEOUT} = 1;
|
|
}
|
|
Log3 $hash, 3, "TPLinkHS110: $name TIMEOUT set to " . $hash->{TIMEOUT};
|
|
}
|
|
|
|
if ($aName eq "nightmode") {
|
|
my $command;
|
|
if ($cmd eq "set") {
|
|
$hash->{NIGHTMODE} = $aVal;
|
|
Log3 $hash, 3, "TPLinkHS110: $name Nightmode $aVal.";
|
|
$command = '{"system":{"set_led_off":{"off":1}}}' if ($aVal eq "on");
|
|
$command = '{"system":{"set_led_off":{"off":0}}}' if ($aVal eq "off");
|
|
}
|
|
if ($cmd eq "del") {
|
|
Log3 $hash, 3, "TPLinkHS110: $name Nightmode attribute removed. Nightmode disabled.";
|
|
$command = '{"system":{"set_led_off":{"off":0}}}';
|
|
$hash->{NIGHTMODE} = "off";
|
|
}
|
|
my $remote_host = $hash->{HOST};
|
|
my $remote_port = 9999;
|
|
my $c = encrypt($command);
|
|
my $socket = IO::Socket::INET->new(PeerAddr => $remote_host,
|
|
PeerPort => $remote_port,
|
|
Proto => 'tcp',
|
|
Type => SOCK_STREAM,
|
|
Timeout => $hash->{TIMEOUT} )
|
|
or return "Couldn't connect to $remote_host:$remote_port: $@\n";
|
|
$socket->write($c);
|
|
IO::Socket::Timeout->enable_timeouts_on($socket);
|
|
$socket->read_timeout(.5);
|
|
my $data;
|
|
$data = <$socket>;
|
|
$socket->close();
|
|
$data = decrypt(substr($data, 4));
|
|
my $json;
|
|
eval {
|
|
$json = decode_json($data);
|
|
} or do {
|
|
Log3 $hash, 2, "TPLinkHS110: $name json-decoding failed. Problem decoding getting statistical data";
|
|
return;
|
|
};
|
|
}
|
|
return undef;
|
|
}
|
|
|
|
# Encryption and Decryption of TP-Link Smart Home Protocol
|
|
# XOR Autokey Cipher with starting key = 171
|
|
# Based on https://www.softscheck.com/en/reverse-engineering-tp-link-hs110/
|
|
sub encrypt {
|
|
my $key = 171;
|
|
my @string = split(//, $_[0]);
|
|
my $result = "\0\0\0" . chr(@string);
|
|
foreach (@string) {
|
|
my $a = $key ^ ord($_);
|
|
$key = $a;
|
|
$result .= chr($a);
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
sub decrypt {
|
|
my $key = 171;
|
|
my $result = "";
|
|
my @string = split(//, $_[0]);
|
|
foreach (@string) {
|
|
my $a = $key ^ ord($_);
|
|
$key = ord($_);
|
|
$result .= chr($a);
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
# mapping for different hardware versions
|
|
sub hwMapping {
|
|
my %hwMap = ();
|
|
$hwMap{'1.0'}{'system'}{'get_sysinfo'}{'longitude'}{'name'} = 'longitude';
|
|
$hwMap{'1.0'}{'system'}{'get_sysinfo'}{'longitude'}{'factor'} = 1;
|
|
$hwMap{'1.0'}{'system'}{'get_sysinfo'}{'latitude'}{'name'} = 'latitude';
|
|
$hwMap{'1.0'}{'system'}{'get_sysinfo'}{'latitude'}{'factor'} = 1;
|
|
$hwMap{'2.0'}{'system'}{'get_sysinfo'}{'longitude_i'}{'name'} = 'longitude';
|
|
$hwMap{'2.0'}{'system'}{'get_sysinfo'}{'longitude_i'}{'factor'} = 0.0001;
|
|
$hwMap{'2.0'}{'system'}{'get_sysinfo'}{'latitude_i'}{'name'} = 'latitude';
|
|
$hwMap{'2.0'}{'system'}{'get_sysinfo'}{'latitude_i'}{'factor'} = 0.0001;
|
|
|
|
$hwMap{'1.0'}{'emeter'}{'get_realtime'}{'power'}{'name'} = 'power';
|
|
$hwMap{'1.0'}{'emeter'}{'get_realtime'}{'power'}{'factor'} = 1;
|
|
$hwMap{'1.0'}{'emeter'}{'get_realtime'}{'voltage'}{'name'} = 'voltage';
|
|
$hwMap{'1.0'}{'emeter'}{'get_realtime'}{'voltage'}{'factor'} = 1;
|
|
$hwMap{'1.0'}{'emeter'}{'get_realtime'}{'current'}{'name'} = 'current';
|
|
$hwMap{'1.0'}{'emeter'}{'get_realtime'}{'current'}{'factor'} = 1;
|
|
$hwMap{'1.0'}{'emeter'}{'get_realtime'}{'total'}{'name'} = 'total';
|
|
$hwMap{'1.0'}{'emeter'}{'get_realtime'}{'total'}{'factor'} = 1;
|
|
$hwMap{'1.0'}{'emeter'}{'get_realtime'}{'err_code'}{'name'} = 'err_code';
|
|
$hwMap{'1.0'}{'emeter'}{'get_realtime'}{'err_code'}{'factor'} = 1;
|
|
|
|
$hwMap{'2.0'}{'emeter'}{'get_realtime'}{'power_mw'}{'name'} = 'power';
|
|
$hwMap{'2.0'}{'emeter'}{'get_realtime'}{'power_mw'}{'factor'} = 0.001;
|
|
$hwMap{'2.0'}{'emeter'}{'get_realtime'}{'voltage_mv'}{'name'} = 'voltage';
|
|
$hwMap{'2.0'}{'emeter'}{'get_realtime'}{'voltage_mv'}{'factor'} = 0.001;
|
|
$hwMap{'2.0'}{'emeter'}{'get_realtime'}{'current_ma'}{'name'} = 'current';
|
|
$hwMap{'2.0'}{'emeter'}{'get_realtime'}{'current_ma'}{'factor'} = 0.001;
|
|
$hwMap{'2.0'}{'emeter'}{'get_realtime'}{'total_wh'}{'name'} = 'total';
|
|
$hwMap{'2.0'}{'emeter'}{'get_realtime'}{'total_wh'}{'factor'} = 0.001;
|
|
$hwMap{'2.0'}{'emeter'}{'get_realtime'}{'err_code'}{'name'} = 'err_code';
|
|
$hwMap{'2.0'}{'emeter'}{'get_realtime'}{'err_code'}{'factor'} = 1;
|
|
|
|
$hwMap{'4.0'}{'emeter'}{'get_realtime'}{'power_mw'}{'name'} = 'power';
|
|
$hwMap{'4.0'}{'emeter'}{'get_realtime'}{'power_mw'}{'factor'} = 0.001;
|
|
$hwMap{'4.0'}{'emeter'}{'get_realtime'}{'voltage_mv'}{'name'} = 'voltage';
|
|
$hwMap{'4.0'}{'emeter'}{'get_realtime'}{'voltage_mv'}{'factor'} = 0.001;
|
|
$hwMap{'4.0'}{'emeter'}{'get_realtime'}{'current_ma'}{'name'} = 'current';
|
|
$hwMap{'4.0'}{'emeter'}{'get_realtime'}{'current_ma'}{'factor'} = 0.001;
|
|
$hwMap{'4.0'}{'emeter'}{'get_realtime'}{'total_wh'}{'name'} = 'total';
|
|
$hwMap{'4.0'}{'emeter'}{'get_realtime'}{'total_wh'}{'factor'} = 0.001;
|
|
$hwMap{'4.0'}{'emeter'}{'get_realtime'}{'err_code'}{'name'} = 'err_code';
|
|
$hwMap{'4.0'}{'emeter'}{'get_realtime'}{'err_code'}{'factor'} = 1;
|
|
|
|
return %hwMap;
|
|
}
|
|
|
|
###############################################################################
|
|
# Test ob JSON-String empfangen wurde
|
|
sub TPLinkHS110__evaljson($$) {
|
|
my ($name, $data) = @_;
|
|
my $hash = $defs{$name};
|
|
my $json;
|
|
my $success = 1;
|
|
my $jerr = "ok";
|
|
|
|
Log3 $name, 5, "$name - Data returned: " . Dumper $data;
|
|
eval {$json = decode_json($data);} or do
|
|
{
|
|
$success = 0;
|
|
};
|
|
|
|
if ($@) {
|
|
$jerr = $@;
|
|
};
|
|
|
|
readingsBulkUpdate($hash, "decode_json", $jerr);
|
|
|
|
if ($success) {
|
|
return($success, $json);
|
|
}
|
|
else {
|
|
return($success, undef);
|
|
}
|
|
}
|
|
|
|
######################################################################################
|
|
|
|
1;
|
|
|
|
|
|
|
|
=pod
|
|
=begin html
|
|
|
|
<a name="TPLinkHS110"></a>
|
|
<h3>TPLinkHS110</h3>
|
|
<ul>
|
|
<br>
|
|
|
|
<a name="TPLinkHS110"></a>
|
|
<b>Define</b>
|
|
<code>define <name> TPLinkHS110 <ip/hostname></code><br>
|
|
<br>
|
|
Defines a TP-Link HS100 or HS110 wifi-controlled switchable power outlet.<br>
|
|
The difference between HS100 and HS110 is, that the HS110 provides realtime measurments of<br>
|
|
power, current and voltage.<br>
|
|
This module automatically detects the modul defined and adapts the readings accordingly.<br>
|
|
<br><br>
|
|
This module does not implement all functions of the HS100/110.<br>
|
|
Currently, all parameters relevant for running the outlet under FHEM are processed.<br>
|
|
Writeable are only "On", "Off" and the nightmode (On/Off) (Nightmode: the LEDs of the outlet are switched off).<br>
|
|
Further programming of the outlet should be done by TPLinks app "Kasa", which funtionality is partly redundant<br>
|
|
with FHEMs core functions.
|
|
<p>
|
|
<b>Attributs</b>
|
|
<ul>
|
|
<li><b>interval</b>: The interval in seconds, after which FHEM will update the current measurements. Default: 300s</li>
|
|
An update of the measurements is done on each switch (On/Off) as well.
|
|
<p>
|
|
<li><b>timeout</b>: Timeout in seconds used while communicationg with the outlet. Default: 1s</li>
|
|
<i>Warning:</i>: the timeout of 1s is chosen fairly aggressive. It could lead to errors, if the outlet is not answerings the requests
|
|
within this timeout.<br>
|
|
Please consider, that raising the timeout could mean blocking the whole FHEM during the timeout!
|
|
<p>
|
|
<li><b>disable</b>: The execution of the module is suspended. Default: no.</li>
|
|
<i>Warning: if your outlet is not on or not connected to the wifi network, consider disabling this module
|
|
by the attribute "disable". Otherwise the cyclic update of the outlets measurments will lead to blockings in FHEM.</i>
|
|
</ul>
|
|
<p>
|
|
<b>Requirements</b>
|
|
<ul>
|
|
This module uses the follwing perl-modules:<br><br>
|
|
<li> Perl Module: IO::Socket::INET </li>
|
|
<li> Perl Module: IO::Socket::Timeout </li>
|
|
</ul>
|
|
|
|
</ul>
|
|
|
|
=end html
|
|
|
|
=begin html_DE
|
|
|
|
<a name="TPLinkHS110"></a>
|
|
<h3>TPLinkHS110</h3>
|
|
<ul>
|
|
<br>
|
|
|
|
<a name="TPLinkHS110"></a>
|
|
<b>Define</b>
|
|
<code>define <name> TPLinkHS110 <ip/hostname></code><br>
|
|
<br>
|
|
Definiert eine TP-Link HS100 oder HS110 schaltbare WLAN-Steckdose. <br>
|
|
Der Unterschied zwischen der HS100 und HS110 besteht darin, dass die HS110 eine Echtzeit-Messung von <br>
|
|
Strom, Spannung sowie Leistung durchführt.<br>
|
|
Dieses Modul erkennt automatisch, welchen Typ Sie verwenden und passt die Readings entsprechend an.
|
|
<br><br>
|
|
Das Modul implementiert nicht alle Funktionen der HS100/110.<br>
|
|
Derzeit werden alle für den sinnvollen Betrieb an FHEM benötigten Parameter ausgelesen.<br>
|
|
Geschrieben werden jedoch nur die Schaltzustände "An", "Aus" sowie der Nachtmodus An/Aus (Nachtmodus = LEDs der Steckdose ausschalten).<br>
|
|
Für eine weitergehende Programmierung der Steckdosen wird daher die TP Link App "Kasa" empfohlen, wobei deren<br>
|
|
Funktionen wie Timer etc. letztlich redundant zu Kernfunktionen von FHEM sind.
|
|
<p>
|
|
<b>Attribute</b>
|
|
<ul>
|
|
<li><b>interval</b>: Das Intervall in Sekunden, nach dem FHEM die Messwerte aktualisiert. Default: 300s</li>
|
|
Eine Aktualisierung der Messwerte findet auch bei jedem Schaltvorgang statt.
|
|
<p>
|
|
<li><b>timeout</b>: Der Timeout in Sekunden, der bei der Kommunikation mit der Steckdose verwendet wird. Default: 1s</li>
|
|
<i>Achtung</i>: der Timeout von 1s ist knapp gewählt. Ggf. kann es zu Fehlermeldungen kommen, wenn die Steckdose nicht
|
|
schnell genug antwortet.<br>
|
|
Bitte beachten Sie aber auch, dass längere Timeouts FHEM für den Zeitraum des Requests blockieren!
|
|
<p>
|
|
<li><b>disable</b>: Die Ausführung des Moduls wird gestoppt. Default: no.</li>
|
|
<i>Achtung: wenn Ihre Steckdose nicht in Betrieb oder über das WLAN erreichbar ist, sollten Sie
|
|
dieses FHEM-Modul per Attribut "disable" abschalten, da sonst beim zyklischen Abruf der Messdaten
|
|
der Steckdose Timeouts auftreten, die FHEM unnötig verlangsamen.</i>
|
|
</ul>
|
|
<p>
|
|
<b>Requirements</b>
|
|
<ul>
|
|
Das Modul benötigt die folgenden Perl-Module:<br><br>
|
|
<li> Perl Module: IO::Socket::INET </li>
|
|
<li> Perl Module: IO::Socket::Timeout </li>
|
|
</ul>
|
|
|
|
</ul>
|
|
=end html_DE
|
|
|
|
=item summary Support for TPLink HS100/100 wifi controlled power outlet
|
|
|
|
=item summary_DE Support für die TPLink HS100/110 WLAN Steckdosen
|