fhem-mirror/FHEM/66_EseraMulti.pm
pizmus 7787d8be1a EseraDimmer: new module for Esera 11221 and 11222 dimmer
SolarEdgeAPI: daily readings at 23:59 instead of 22:00



git-svn-id: https://svn.fhem.de/fhem/trunk/fhem@22085 2b470e98-0d58-463d-a4d8-8e2adae1ed80
2020-05-31 14:06:53 +00:00

356 lines
9.3 KiB
Perl

################################################################################
#
# $Id$
#
# 66_EseraMulti.pm
#
# Copyright (C) 2018 pizmus
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#
################################################################################
#
# This FHEM module supports an Esera multi sensor connected via
# an Esera 1-wire Controller and the 66_EseraOneWire module.
#
################################################################################
package main;
use strict;
use warnings;
use SetExtensions;
sub
EseraMulti_Initialize($)
{
my ($hash) = @_;
$hash->{Match} = "DS2438";
$hash->{DefFn} = "EseraMulti_Define";
$hash->{UndefFn} = "EseraMulti_Undef";
$hash->{ParseFn} = "EseraMulti_Parse";
$hash->{SetFn} = "EseraMulti_Set";
$hash->{GetFn} = "EseraMulti_Get";
$hash->{AttrFn} = "EseraMulti_Attr";
$hash->{AttrList} = "$readingFnAttributes";
}
sub
EseraMulti_Define($$)
{
my ($hash, $def) = @_;
my @a = split( "[ \t][ \t]*", $def);
return "Usage: define <name> EseraMulti <physicalDevice> <1-wire-ID> <deviceType>" if(@a < 5);
my $devName = $a[0];
my $type = $a[1];
my $physicalDevice = $a[2];
my $oneWireId = $a[3];
my $deviceType = uc($a[4]);
$hash->{STATE} = 'Initialized';
$hash->{NAME} = $devName;
$hash->{TYPE} = $type;
$hash->{ONEWIREID} = $oneWireId;
$hash->{ESERAID} = undef; # We will get this from the first reading.
$hash->{DEVICE_TYPE} = $deviceType;
$modules{EseraMulti}{defptr}{$oneWireId} = $hash;
AssignIoPort($hash, $physicalDevice);
if (defined($hash->{IODev}->{NAME}))
{
Log3 $devName, 4, "$devName: I/O device is " . $hash->{IODev}->{NAME};
}
else
{
Log3 $devName, 1, "$devName: no I/O device";
}
# program the the device type into the controller via the physical module
if ($deviceType =~ m/^DS([0-9A-F]+)/)
{
# for the DS* devices types the "DS" has to be omitted
IOWrite($hash, "assign;$oneWireId;$1");
}
else
{
IOWrite($hash, "assign;$oneWireId;$deviceType");
}
return undef;
}
sub
EseraMulti_Undef($$)
{
my ($hash, $arg) = @_;
my $oneWireId = $hash->{ONEWIREID};
RemoveInternalTimer($hash);
delete( $modules{EseraMulti}{defptr}{$oneWireId} );
return undef;
}
sub
EseraMulti_Get($@)
{
return undef;
}
sub
EseraMulti_Set($$)
{
return undef;
}
sub
EseraMulti_Parse($$)
{
my ($ioHash, $msg) = @_;
my $ioName = $ioHash->{NAME};
my $buffer = $msg;
# expected message format: $deviceType."_".$oneWireId."_".$eseraId."_".$readingId."_".$value
my @fields = split(/_/, $buffer);
if (scalar(@fields) != 5)
{
return undef;
}
my $deviceType = uc($fields[0]);
my $oneWireId = $fields[1];
my $eseraId = $fields[2];
my $readingId = $fields[3];
my $value = $fields[4];
# search for logical device
my $rhash = undef;
foreach my $d (keys %defs) {
my $h = $defs{$d};
my $type = $h->{TYPE};
if($type eq "EseraMulti")
{
if (defined($h->{IODev}->{NAME}))
{
my $ioDev = $h->{IODev}->{NAME};
my $def = $h->{DEF};
# $def has the whole definition, extract the oneWireId (which is expected as 2nd parameter)
my @parts = split(/ /, $def);
my $oneWireIdFromDef = $parts[1];
if (($ioDev eq $ioName) && ($oneWireIdFromDef eq $oneWireId))
{
$rhash = $h;
last;
}
}
}
}
if($rhash) {
my $rname = $rhash->{NAME};
Log3 $rname, 4, "EseraMulti ($rname) - parse - device found: ".$rname;
# capture the Esera ID for later use
$rhash->{ESERAID} = $eseraId;
# consistency check of device type
if (!($rhash->{DEVICE_TYPE} eq uc($deviceType)))
{
Log3 $rname, 1, "EseraMulti ($rname) - unexpected device type ".$deviceType;
# program the the device type into the controller via the physical module
if ($rhash->{DEVICE_TYPE} =~ m/^DS([0-9A-F]+)/)
{
# for the DS* devices types the "DS" has to be omitted
IOWrite($rhash, "assign;$oneWireId;$1");
}
else
{
IOWrite($rhash, "assign;$oneWireId;".$rhash->{DEVICE_TYPE});
}
}
if ($readingId eq "ERROR")
{
Log3 $rname, 1, "EseraMulti ($rname) - error message from physical device: ".$value;
}
elsif ($readingId eq "STATISTIC")
{
Log3 $rname, 1, "EseraMulti ($rname) - statistics message not supported yet: ".$value;
}
else
{
my $nameOfReading;
if ($deviceType eq "DS2438")
{
if ($readingId == 1)
{
$nameOfReading = "temperature";
readingsSingleUpdate($rhash, $nameOfReading, $value / 100.0, 1);
}
elsif ($readingId == 2)
{
$nameOfReading = "VCC";
readingsSingleUpdate($rhash, $nameOfReading, $value / 100.0, 1);
}
elsif ($readingId == 3)
{
$nameOfReading = "VAD";
readingsSingleUpdate($rhash, $nameOfReading, $value / 100.0, 1);
}
elsif ($readingId == 4)
{
$nameOfReading = "VSense";
readingsSingleUpdate($rhash, $nameOfReading, $value / 100000.0, 1);
}
}
elsif (($deviceType eq "11121") || ($deviceType eq "11132") || ($deviceType eq "11133") || ($deviceType eq "11134") || ($deviceType eq "11135"))
{
if ($readingId == 1)
{
$nameOfReading = "temperature";
readingsSingleUpdate($rhash, $nameOfReading, $value / 100.0, 1);
}
elsif ($readingId == 2)
{
$nameOfReading = "voltage";
readingsSingleUpdate($rhash, $nameOfReading, $value / 100.0, 1);
}
elsif ($readingId == 3)
{
$nameOfReading = "humidity";
if ($value != 10000) # Esera 11133 sporadically reports 100% by mistake
{
readingsSingleUpdate($rhash, $nameOfReading, $value / 100.0, 1);
}
}
elsif ($readingId == 4)
{
$nameOfReading = "dewpoint";
readingsSingleUpdate($rhash, $nameOfReading, $value / 100.0, 1);
}
elsif ($readingId == 5)
{
$nameOfReading = "brightness";
readingsSingleUpdate($rhash, $nameOfReading, $value / 100.0, 1);
}
}
}
my @list;
push(@list, $rname);
return @list;
}
elsif (($deviceType eq "DS2438") || ($deviceType eq "11121") || ($deviceType eq "11132") || ($deviceType eq "11133") || ($deviceType eq "11134") || ($deviceType eq "11135"))
{
return "UNDEFINED EseraMulti_".$ioName."_".$oneWireId." EseraMulti ".$ioName." ".$oneWireId." ".$deviceType;
}
return undef;
}
sub
EseraMulti_Attr(@)
{
}
1;
=pod
=item summary Represents an Esera 1-wire multi sensor.
=item summary_DE Repraesentiert einen Esera 1-wire Multi-Sensor.
=begin html
<a name="EseraMulti"></a>
<h3>EseraMulti</h3>
<ul>
This module supports an Esera 1-wire multi sensor or a DS2438 1-wire IC.<br>
It uses 66_EseraOneWire as I/O device.<br>
<br>
<a name="EseraMulti_Define"></a>
<b>Define</b>
<ul>
<code>define &lt;name&gt; EseraMulti &lt;ioDevice&gt; &lt;oneWireId&gt; &lt;deviceType&gt;</code><br>
&lt;oneWireId&gt; specifies the 1-wire ID of the sensor. Use the "get devices" <br>
query of EseraOneWire to get a list of 1-wire IDs, or simply rely on autocreate. <br>
Supported values for deviceType:
<ul>
<li>DS2438</li>
<li>11121 (Esera product number)</li>
<li>11132 (Esera product number, multi sensor Unterputz)</li>
<li>11133 (Esera product number, multi sensor Unterputz)</li>
<li>11134 (Esera product number, multi sensor Aufputz)</li>
<li>11135 (Esera product number, multi sensor Outdoor)</li>
</ul>
With deviceType DS2438 this device generates readings with un-interpreted data<br>
from DS2438. This can be used with any DS2438 device, independent of an Esera <br>
product. With deviceType 11121/11132/11133/11134/11135 this module provides interpreted<br>
readings like humidity or dew point.<br>
</ul>
<a name="EseraMulti_Set"></a>
<b>Set</b>
<ul>
<li>no get functionality</li>
</ul>
<br>
<a name="EseraMulti_Get"></a>
<b>Get</b>
<ul>
<li>no get functionality</li>
</ul>
<br>
<a name="EseraMulti_Attr"></a>
<b>Attributes</b>
<ul>
<li>no attributes</li>
</ul>
<br>
<a name="EseraMulti_Readings"></a>
<b>Readings</b>
<ul>
readings for DS2438:<br>
<ul>
<li>VAD</li>
<li>VCC</li>
<li>VSense</li>
<li>temperature</li>
</ul>
readings for Esera 11121/11132/11133/11134/11135:<br>
<ul>
<li>temperature</li>
<li>humidity</li>
<li>dewpoint</li>
<li>brightness</li>
<li>voltage</li>
</ul>
</ul>
<br>
</ul>
=end html
=cut