FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-02-01 07:19:24 +00:00
Code Issues Releases Wiki Activity
57e0443ad6
fhem-mirror/fhem/FHEM/47_OBIS.pm

940 lines
36 KiB
Perl
Raw Blame History

###############################################
#
# 47_OBIS.pm
#
# Thanks to matzefizi for letting me merge this with 70_SMLUSB.pm and for testing
# Tanks to immi for testing and supporting help and tips
#
# $Id$
package main;
use strict;
use warnings;
use Time::HiRes qw(gettimeofday usleep);
use Scalar::Util qw(looks_like_number);
use POSIX qw{strftime};
my %OBIS_channels = ( "21" =>"power_L1",
"41" =>"power_L2",
"61" =>"power_L3",
"12" =>"voltage_avg",
"32" =>"voltage_L1",
"52" =>"voltage_L2",
"72" =>"voltage_L3",
"11" =>"current_sum",
"31" =>"current_L1",
"51" =>"current_L2",
"71" =>"current_L3",
"1.8" =>"total_consumption",
"2.8" =>"total_feed",
"2" =>"feed_L1",
"4" =>"feed_L2",
"6" =>"feed_L3",
"1" =>"power",
"15" =>"power",
"16" =>"power",
"24" =>"Gas",
);
my %OBIS_codes = ( "Serial" => qr{^0-0:96.1.255(?:.\d+)?\((.*?)\).*},
"Serial" => qr{^(?:1-0:)?0\.0\.[1-9]+(?:.\d+)?\((.*?)\).*},
"Owner" => qr{^1.0.0.0.0(?:.\d+)?\((.*?)\).*}x,
"Status" => qr{^1.0.96.5.5(?:.\d+)?\((.*?)\).*}x,
"Powerdrops" => qr{^0.0.96.7.\d(?:.\d+)?\((.*?)\).*},
"Time_param" => qr{^0.0.96.2.1(?:.\d+)?\((.*?)\).*},
"Time_current" => qr{^0.0.1.0.0(?:.\d+)?\((.*?)\).*},
"Channel_sum" => qr{^(?:1.0.)?(\d+).1.7(?:.0|.255)?(?:\(.*?\))?\((<|>)?([-+]?\d+\.?\d*)\*?(.*)\).*},
"Channels" => qr{^(?:\d.0.)?(\d+).7\.\d+(?:.0|.255)?(?:\(.*?\))?\((<|>)?([-+]?\d+\.?\d*)\*?(.*)\).*},
"Channels2" => qr{^(?:0.1.)?(\d+).2\.\d+(?:.0|.255)?(?:\(.*?\))?\((<|>)?(-?\d+\.?\d*)\*?(.*)\).*},
"Counter" => qr{^(?:1.\d.)?(\d).(8)\.(\d)(?:.\d+)?(?:\(.*?\))?\((<|>)?(-?\d+\.?\d*)\*?(.*)\).*},
"ManufID" => qr{^129-129:199\.130\.3(?:.\d+)?\((.*?)\).*},
"PublicKey" => qr{^129-129:199\.130\.5(?:.\d+)?\((.*?)\).*},
);
my %SML_specialities = ("TIME" => [qr{0.0.96.2.1
|0.0.1.0.0 }x, sub{return strftime("%d-%m-%Y %H:%M:%S", localtime(unpack("i", pack("I", hex(@_)))))}],
"HEX2" => [qr{1-0:0\.0\.[0-9] }x, sub{my $a=shift;
if ( $a =~ /^[0-9a-fA-F]+$/ ) {$a=~s/(..)/$1-/g;$a=~s/-$//};
return $a;}],
"HEX4" => [qr{1.0.96.5.5
|0.0.96.240.\d+
|129.129.199.130.5}x, sub{my $a=shift;
if ( $a =~ /^[0-9a-fA-F]+$/ ) {$a=~s/(....)/$1-/g;$a=~s/-$//};
return $a;}],
"INFO" => [qr{1-0:0\.0\.[0-9]
|129.129.199.130.3}x, ""],
);
#####################################
sub OBIS_Initialize($)
{
my ($hash) = @_;
require "$attr{global}{modpath}/FHEM/DevIo.pm";
$hash->{Match} = "^\/(?s:.*)\!\$";
$hash->{ReadFn} = "OBIS_Read";
$hash->{ReadyFn} = "OBIS_Ready";
$hash->{DefFn} = "OBIS_Define";
$hash->{ParseFn} = "OBIS_Parse";
# $hash->{SetFn} = "OBIS_Set";
$hash->{GetFn} = "OBIS_Get";
$hash->{UndefFn} = "OBIS_Undef";
$hash->{AttrFn} = "OBIS_Attr";
$hash->{AttrList}= "do_not_notify:1,0 interval offset_feed offset_energy IODev channels directions alignTime pollingMode:on,off unitReadings:on,off ignoreUnknown:on,off valueBracket:first,second,both ".
$readingFnAttributes;
}
#1B1B1B1B010101017605002605426200620072630101760107FFFFFFFFFFFF05000CAC6C0B0A01454D4800005A561C726201640DF29B620163676F0076050026054362006200726307017707FFFFFFFFFFFF0B0A01454D4800005A561C070100620AFFFF726201640DF29B7577070100603201010101010104454D480177070100600100FF010101010B0A01454D4800005A561C0177070100010800FF641C0104726201640DF29B621E52FF6404AB760177070100020800FF01726201640DF29B621E52FF6324910177070100100700FF0101621B52005301360101016373F100760500260544620062007263020171016326A3000000001B1B1B1B1A03CDC9
#1B1B1B1B010101017605002605456200620072630101760107FFFFFFFFFFFF05000CAC6D0B0A01454D4800005A561C726201640DF29C62016343D30076050026054662006200726307017707FFFFFFFFFFFF0B0A01454D4800005A561C070100620AFFFF726201640DF29C7577070100603201010101010104454D480177070100600100FF010101010B0A01454D4800005A561C0177070100010800FF641C0104726201640DF29C621E52FF6404AB770177070100020800FF01726201640DF29C621E52FF6324910177070100100700FF0101621B520053012C0101016319F6007605002605476200620072630201710163955D000000001B1B1B1B1A0310B4
#####################################
sub OBIS_Define($$)
{
my ($hash, $def) = @_;
my @a = split("[ \t][ \t]*", $def);
return 'wrong syntax: define <name> OBIS devicename@baudrate[,databits,parity,stopbits]|none [MeterType]'
if(@a < 3);
DevIo_CloseDev($hash);
RemoveInternalTimer($hash);
my $name = $a[0];
my $dev = $a[2];
my $type = $a[3]//"Unknown";
$hash->{DeviceName} = $dev;
$hash->{MeterType}=$type if (defined($type));
my $device_name = "OBIS_".$name;
$modules{OBIS}{defptr}{$device_name} = $hash;
# If device="none", prepeare for an external IO-Module
if($dev=~/none|ext/) {
if (@a == 4){
my $device_name = "OBIS.".$a[4];
$hash->{CODE} = $a[4];
$modules{OBIS}{defptr}{$device_name} = $hash;
}
AssignIoPort($hash);
Log3 ($hash,1, "OBIS ($name) - OBIS device is none, commands will be echoed only");
return undef;
}
my $baudrate;
my $devi;
($devi, $baudrate) = split("@", $dev);
$hash->{helper}{SPEED}="0";
if (defined($baudrate)) { ## added for ser2net connection
if($baudrate =~ m/(\d+)(,([78])(,([NEO])(,([012]))?)?)?/) {
$baudrate = $1 if(defined($1));
}
my %bd=("300"=>"0","600"=>"1","1200"=>"2","2400"=>"3","4800"=>"4","9600"=>"5","18200"=>"6","36400"=>"7","57600"=>"8","115200"=>"9");
$hash->{helper}{SPEED}=$bd{$baudrate};
$hash->{helper}{SPEED2}=$bd{$a[4]//$baudrate};
}
else {$baudrate=9600; $hash->{helper}{SPEED}="5";}
my %devs= (
# Name, Init-String, interval, 2ndInit
"none" => ["", -1, ""],
"Unknown" => ["", -1, ""],
"SML" => ["", -1, ""],
"Ext" => ["", -1, ""],
"Standard" => ["", -1, ""],
"VSM102" => ["/?!".chr(13).chr(10), 600, chr(6)."0".$hash->{helper}{SPEED}."0".chr(13).chr(10)],
"E110" => ["/?!".chr(13).chr(10), 600, chr(6)."0".$hash->{helper}{SPEED}."0".chr(13).chr(10)],
"E350USB" => ["/?!".chr(13).chr(10), 600, chr(6)."0".$hash->{helper}{SPEED}."0".chr(13).chr(10)],
);
if (!$devs{$type}) {return 'unknown meterType. Must be one of <nothing>, SML, Standard, VSM102, E110'};
$devs{$type}[1] = $hash->{helper}{DEVICES}[1] // $devs{$type}[1];
$hash->{helper}{DEVICES} =$devs{$type};
$hash->{helper}{TRIGGERTIME}=gettimeofday();
# if( !$init_done ) {
# $attr{$name}{"event-on-change-reading"} = ".*";
# }
my $t=OBIS_adjustAlign($hash,AttrVal($name,"alignTime",undef),$hash->{helper}{DEVICES}[1]);
Log3 ($hash,5,"OBIS ($name) - Internal timer set to ".FmtDateTime($t)) if ($hash->{helper}{DEVICES}[1]>0);
InternalTimer($t, "GetUpdate", $hash, 0) if ($hash->{helper}{DEVICES}[1]>0);
$hash->{helper}{EoM}=-1;
Log3 $hash,5,"OBIS ($name) - Opening device...";
return DevIo_OpenDev($hash, 0, "OBIS_Init");
}
sub OBIS_Get($@)
{
my ($hash, @a) = @_;
my $name = shift @a;
my $opt = shift @a;
if ($opt eq "update") {
GetUpdate($hash);
} else
{return "Unknown argument $opt, choose one of update";}
}
sub OBIS_Set($@)
{
my ( $hash, @a ) = @_;
my $name = shift @a;
my $opt = shift @a;
my $value = join("", @a);
my $teststr="";
my %bd=("300"=>"0","600"=>"1","1200"=>"2","2400"=>"3","4800"=>"4","9600"=>"5","18200"=>"6","36400"=>"7","57600"=>"8","115200"=>"9");
if ($opt eq "setSpeed") {
if ($bd{$value} ne $hash->{helper}{SPEED}) {
$hash->{helper}{BUFFER}="";
$hash->{helper}{SPEED}=$bd{$value};
print "old Helper: $hash->{helper}{DEVICES}[2] \r\n";
$hash->{helper}{DEVICES}[2]=$hash->{helper}{DEVICES}[2] eq "" ? "" : chr(6)."0".$hash->{helper}{SPEED}."0".chr(13).chr(10);
print "new Helper: $hash->{helper}{DEVICES}[2] \r\n";
$hash->{helper}{SpeedChange}=$value;
DevIo_SimpleWrite($hash,$hash->{helper}{DEVICES}[0],undef) ;
print "Wrote $hash->{helper}{DEVICES}[0]\r\n";
}
}
return;
}
# Update-Routine
sub GetUpdate($)
{
my ($hash) = @_;
my $name = $hash->{NAME};
my $type= $hash->{MeterType};
RemoveInternalTimer($hash);
$hash->{helper}{EoM}=-1;
if ($hash->{helper}{DEVICES}[1] eq "") {return undef;}
if( $init_done ) {
DevIo_SimpleWrite($hash,$hash->{helper}{DEVICES}[0],undef) ;
Log3 $hash,4,"Wrote $hash->{helper}{DEVICES}[0]";
}
my $t=OBIS_adjustAlign($hash,AttrVal($name,"alignTime",undef),$hash->{helper}{DEVICES}[1]);
Log3 ($hash,5,"OBIS ($name) - Internal timer set to ".FmtDateTime($t)) if ($hash->{helper}{DEVICES}[1]>0);
InternalTimer($t, "GetUpdate", $hash, 1) if ($hash->{helper}{DEVICES}[1]>0);
}
sub OBIS_Init($)
{
Log 3,"Init done";
return undef;
}
#####################################
sub OBIS_Undef($$)
{
my ($hash, $arg) = @_;
RemoveInternalTimer($hash);
DevIo_CloseDev($hash) if $hash->{DeviceName} ne "none";
return undef;
}
#####################################
sub OBIS_Read($)
{
my ($hash) = @_;
if( $init_done ) {
my $name = $hash->{NAME};
my $buf = DevIo_SimpleRead($hash);
my $b=$buf;
$b =~ s/(.)/sprintf("%X",ord($1))/eg;
if ( !defined($hash->{helper}{SpeedChange}) || ($hash->{helper}{SpeedChange} eq ""))
{
OBIS_Parse($hash,$buf) if ($hash->{helper}{EoM}!=1);
} else
{
# if ($hash->{helper}{SpeedChange2} eq "")
# {
# Log3 $hash,4,"Part 1";
## $hash->{helper}{SPEED}=$bd{$value};
# DevIo_SimpleWrite($hash,$hash->{helper}{DEVICES}[2],undef) ;
# Log3 $hash,4,"Writing ".$hash->{helper}{DEVICES}[2];
# $hash->{helper}{SpeedChange2}="1";
# } elsif ($hash->{helper}{SpeedChange2} eq "1")
# {
# if ($buf ne hex(15)) {
# Log3 $hash,4,"Part 2";
# my $sp=$hash->{helper}{SPEED};
# my $d=$hash->{DeviceName};
# my $repl=$sp;
# Log3 $hash,4,"Old Dev: $d";
# $d=~/(.*@)(\d*)(.*)/;
# my $d2=$1.$hash->{helper}{SpeedChange}.$3;
# # $d=~s/(.*@)(\d*)(.*)/$repl$2/ee;
#
# Log3 $hash,4, "Replaced dev: $d2";
# RemoveInternalTimer($hash);
# DevIo_CloseDev($hash) if $hash->{DeviceName} ne "none";
# $hash->{DeviceName} = $d2;
# $hash->{helper}{EoM}=-1;
# Log3 $hash,5,"OBIS ($name) - Opening device...";
# my $t=OBIS_adjustAlign($hash,AttrVal($name,"alignTime",undef),$hash->{helper}{DEVICES}[1]);
# Log3 ($hash,5,"OBIS ($name) - Internal timer set to ".FmtDateTime($t)) if ($hash->{helper}{DEVICES}[1]>0);
# InternalTimer($t, "GetUpdate", $hash, 0) if ($hash->{helper}{DEVICES}[1]>0);
# DevIo_OpenDev($hash, 1, "OBIS_Init");
# } else
# {
# Log3 $hash,4,"Recieved NAK from Meter";
# }
# $hash->{helper}{SpeedChange2}="";
# $hash->{helper}{SpeedChange}="";
# Log3 $hash,4, "Cleared helper\r\n";
# }
}
}
return(undef);
}
sub OBIS_trySMLdecode($$)
{
my ( $hash, $remainingSML ) = @_;
my $t=$remainingSML;
if ($remainingSML=~m/SML\((.*)\)/g) {$remainingSML=$1};
if($remainingSML!~/[\x00-\x09|\x10-\x1F]/g) {return $remainingSML} else {$hash->{MeterType}="SML"};
$remainingSML=uc(unpack('H*',$remainingSML));
$hash->{MeterType}="SML";
my $newMsg="";
while ($remainingSML=~/(1B1B1B1B010101.*?1B1B1B1B1A[0-9A-F]{6})/mip) {
my $msg=$1;
Log3 $hash,5,"SML-Parse $1";
$remainingSML=${^POSTMATCH};
if (OBIS_CRC16($hash,pack('H*',$msg)) == 1) {
$remainingSML=""; #reset possible further messages if actual CRC ok; if someone misses some messages, we remove it.
my $OBISmsg="";
my $initstr="/";
my $OBISid=$msg=~m/7701([0-9A-F]*?)01/g;
Log3 $hash,5,"OBIS: Full message-> $msg";
(undef,undef,$OBISid,undef)=OBIS_decodeTL($1);
# Log3 $hash,5,"OBIS: ObisID-> $1";
while ($msg =~ m/(7707)([0-9A-F]*)/g) {
# my $telegramm = $&;
my @list=$&=~/(7707)([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]{2})([0-9A-F]*)/g;
Log3 $hash, 5,"OBIS: Telegram=$msg";
# Log 3,Dumper(@list);
if (!@list) {Log3 $hash,3,"OBIS - Empty datagram: .$msg"};
my $line=hex($list[1])."-".hex($list[2]).":".hex($list[3]).".".hex($list[4]).".".hex($list[5])."*255(";
if ($line eq '255-255:255.255.255*255(') {
$list[7]=~/(7707.*)/;
$msg=$1;
} else
{
# Log3 $hash,5,"Line: $line";
# Log3 $hash,5,"Before decoding: $list[7]";
my ($status,$statusL,$statusT,$valTime,$valTimeL,$valTimeT,$unit,$unitL,$unitT,$scaler,$scalerL,$scalerT,$data,$dataL,$dataT,$other);
($statusL,$statusT,$status,$other)=OBIS_decodeTL($list[7]);
# Log3 $hash,5,"After status: $other";
($valTimeL,$valTimeT,$valTime,$other)=OBIS_decodeTL($other);
# Log3 $hash,5,"After Time: $other";
($unitL,$unitT,$unit,$other)=OBIS_decodeTL($other);
# Log3 $hash,5,"After Unit: $other";
($scalerL,$scalerT,$scaler,$other)=OBIS_decodeTL($other);
# Log3 $hash,5,"After Scaler: $other";
($dataL,$dataT,$data,$msg)=OBIS_decodeTL($other);
# Log3 $hash,5,"After Data: $msg";
# Type String
my $line2="";
if ($dataT ==0 ) {
$line2=$data;
if($line=~$SML_specialities{"HEX4"}[0]) {
#
# $line2=$SML_specialities{"HEX4"}[1]->($data)
} elsif($line=~$SML_specialities{"HEX2"}[0]) {
# $line2=$SML_specialities{"HEX2"}[1]->($data)
} else {
$data=~s/([A-F0-9]{2})/chr(hex($1))/eg;
$line2="$data";
}
# Type signed (=80) and unsigned (=96) Integer
} elsif ($dataT & 0b01010000|$dataT & 0b01100000) {
$unit= $unit eq "1E" ? "Wh" :
$unit eq "1B" ? "W" :
$unit eq "21" ? "A" :
$unit eq "23" ? "V" :
$unit eq "2C" ? "Hz" :
$unit eq "01" ? "" :
$unit eq "1D" ? "varh" :
$unit eq "" ? "" : "var";
$scaler=$scaler ne "" ? 10**unpack("c", pack("C", hex($scaler))) : 1;
if ($scaler==0) {$scaler=1}; # just to make sure
$line2.="<" if ($status=~/[aA]2$/);
$line2.=">" if ($status=~/82$/);
my $val=0;
# signed Values
my $tmp="";
if ($dataT & 0b00010000) {
if ($data =~ /^[89a-f]/i) {$val = hex($data) - hex(sprintf ("FF" x $dataL)) -1;}
else {$val = hex($data)} #positive value
}
if ($dataT & 0b00100000 || $val>=0) {
$val=hex($data);
}
# $line2.=($val*$scaler).($unit eq "" ? "" : "*$unit") if($dataT ==80);
$line2.=($val*$scaler).($unit eq "" ? "" : "*$unit"); # if($dataT ==96);
} elsif ($dataT & 0b01000000) { # Type Boolean - no Idea, where this is used
$line2=OBIS_hex2int($data); # 0=false, everything else is true
} elsif ($dataT & 0b01110000) { # Type List of.... - Time is sometimes delivered as structure
# my @a_Length;
# my @a_Type;
# my @a_Data;
# for (my $b=0;$b<$dataL;$b++) {
# my ($l_length,$l_type,$l_data);
# }
}
$initstr.="$line2\\" if ($line=~$SML_specialities{"INFO"}[0]);
$newMsg.=$line.$line2.")\r\n";
# Log 3,"$line$line2)";
###### TypeLength-Test ends here
}
}
$initstr=~s/\\$//;
$newMsg=$initstr.chr(13).chr(10).$newMsg;
$newMsg.="!".chr(13).chr(10);
Log3 $hash,4,"MSG IS: \r\n$newMsg";
} else {
# Log 3,"Illegal CRC";
$hash->{CRC_Errors}+=1;
}
}
return ($newMsg,pack('H*',$remainingSML));
}
sub OBIS_Parse($$)
{
my ($hash, $buf) = @_;
my $buf2=uc(unpack('H*',$buf));
if($hash->{MeterType}!~/SML|Unknown/ && $buf2=~m/7701([0-9A-F]*?)01/g) {
Log 3,"OBIS_Ext called";
my (undef,undef,$OBISid,undef)=OBIS_decodeTL($1);
my $device_name = "OBIS.".$OBISid;
Log3 $hash,5,"New Devicename: $device_name";
my $def = $modules{OBIS}{defptr}{"$device_name"};
if(!$def) {
Log3 $hash, 3, "OBIS: Unknown device $device_name, please define it";
return "UNDEFINED $device_name OBIS none Ext $OBISid";
}
}
$hash->{helper}{BUFFER} .= $buf;
if (length($hash->{helper}{BUFFER}) >10000) { #longer than 3 messages, this is a traffic jam
$hash->{helper}{BUFFER} =substr( $hash->{helper}{BUFFER} , -10000);
}
my %dir=("<"=>"out",">"=>"in");
my $buffer=$hash->{helper}{BUFFER};
my $remainingSML;
($buffer,$remainingSML) = OBIS_trySMLdecode($hash,$buffer) if ($hash->{MeterType}=~/SML|Ext|Unknown/);
my $type= $hash->{MeterType};
my $name = $hash->{NAME};
if(index($buffer,chr(13).chr(10)) ne -1){
readingsBeginUpdate($hash);
while(index($buffer,chr(13).chr(10)) ne -1)
{
my $rmsg="";
$rmsg = substr($buffer, 0, index($buffer,chr(13).chr(10)));
Log3 $hash,5,"OBIS ($name) - Msg-Parse: $rmsg";
my $channel=" ";
if($rmsg=~/\/.*|^((?:\d{1,3}-\d{1,3}:)?(?:\d{1,3}|[CF]).\d{1,3}(?:.\d{1,3})?(?:\*\d{1,3})?)(?:\(.*?\))?\(.*?\)|!/) { # old regex: \/.*|\d-\d{1,3}:\d{1,3}.\d{1,3}.\d{1,3}\*\d{1,3}\(.*?\)|!
if (length $1) {
$channel=$1;
# $channel=~s/[\:\-*]/\./;
$channel=~s/:/\./;
$channel=~s/-/\./;
$channel=~s/\*/\./;
}
if ($hash->{MeterType} eq "Unknown") {$hash->{MeterType}="Standard"}
# if($rmsg=~/^([23456789]+)-.*/) {
# Log3 $hash,3,"OBIS ($name) - Unknown OBIS-Device, please report: $rmsg".chr(13).chr(10)."Please report to User icinger at forum.fhem.de";
# }
# End of Message
if ($rmsg=~/!.*/) {
$hash->{helper}{EoM}+=1 if ($hash->{helper}{DEVICES}[1]>0);
}
#Version
elsif ($rmsg=~ /.*\/(.*)/) {
DevIo_SimpleWrite($hash,$hash->{helper}{DEVICES}[2],undef) if (!$hash->{helper}{DEVICES}[2] eq "");
if (ReadingsVal($name,"Version","") ne $1) {readingsBulkUpdate($hash, "Version" ,$1); }
$hash->{helper}{EoM}=0;
}
elsif ($hash->{helper}{EoM}!=1) {
my @patterns=values %OBIS_codes;
if (!$rmsg~~@patterns) {
Log3 $hash,3,"OBIS ($name) - Unknown Message: $rmsg".chr(13).chr(10)."Please report to User icinger at forum.fhem.de"
} else {
my $found=0;
if (!($hash->{helper}{Channels}{$channel} //$hash->{helper}{Channels}{$1})) {
for my $code (keys %OBIS_codes) {
if ($rmsg =~ $OBIS_codes{$code}) {
Log3 $hash,5,"Msg $rmsg is of type $code";
if ($code=~/Channel_sum.*/) {
$rmsg =~ $OBIS_codes{$code};
my $L= $hash->{helper}{Channels}{$channel} //$hash->{helper}{Channels}{$1} // "sum_$OBIS_channels{$1}" //$channel;
if (AttrVal($name,"ignoreUnknown","off") eq "off" || $L ne $channel) {
readingsBulkUpdate($hash, $L,(looks_like_number($3) ? $3+0 : $3).(AttrVal($name,"unitReadings","off") eq "off"?"":" $4"));
readingsBulkUpdate($hash, "dir_$L",$hash->{helper}{directions}{$2} // $dir{$2}) if (length $2);
}
}
elsif ($code=~/Channels.*/) {
$rmsg =~ $OBIS_codes{$code};
my $L=$hash->{helper}{Channels}{$channel} //$hash->{helper}{Channels}{$1} // $OBIS_channels{$1} //$channel;
if (AttrVal($name,"ignoreUnknown","off") eq "off" || $L ne $channel) {
readingsBulkUpdate($hash, "$L",(looks_like_number($3) ? $3+0 : $3).(AttrVal($name,"unitReadings","off") eq "off"?"":" $4"));
readingsBulkUpdate($hash, "dir_$L",$hash->{helper}{directions}{$2} // $dir{$2}) if (length $2);
}
}
elsif ($code=~/Counter.*/) {
$rmsg =~ $OBIS_codes{$code};
my $L=$hash->{helper}{Channels}{$channel} //$hash->{helper}{Channels}{$1.".".$2} // $OBIS_channels{$1.".".$2} // $channel;
my $chan=$3+0 > 0 ? "_Ch$3" : "";
if (AttrVal($name,"ignoreUnknown","off") eq "off" || $L ne $channel) {
if($1==1) {
Log3($hash,4,"Set ".$L.$chan." to ".((looks_like_number($3) ? $5+0 : $5) +AttrVal($name,"offset_energy",0)));
readingsBulkUpdate($hash, $L.$chan ,(looks_like_number($3) ? $5+0 : $5) +AttrVal($name,"offset_energy",0).(AttrVal($name,"unitReadings","off") eq "off"?"":" $6"));
} elsif ($1==2) {
readingsBulkUpdate($hash, $L.$chan ,(looks_like_number($3) ? $5+0 : $5) +AttrVal($name,"offset_feed",0).(AttrVal($name,"unitReadings","off") eq "off"?"":" $6"));
}
readingsBulkUpdate($hash, "dir_$L",$hash->{helper}{directions}{$4} // $dir{$4}) if (length $4);
}
} else
{
$rmsg =~ $OBIS_codes{$code};
my $data=$1;
if($rmsg=~$SML_specialities{"HEX4"}[0]) {
$data=$SML_specialities{"HEX4"}[1]->($data)
} elsif($rmsg=~$SML_specialities{"HEX2"}[0]) {
$data=$SML_specialities{"HEX2"}[1]->($data)
} elsif($rmsg=~$SML_specialities{"TIME"}[0]) {
$data=~/(\d+)/;
$data=$SML_specialities{"TIME"}[1]->($1)
}
my $chan=$code//$OBIS_channels{$channel} //$channel;
if ($#+ > 0) {
$chan=$hash->{helper}{Channels}{$channel} // $hash->{helper}{Channels}{$1} // $OBIS_channels{$1} //$channel;
} else {
$chan=$hash->{helper}{Channels}{$channel} //$channel;
}
if (AttrVal($name,"ignoreUnknown","off") eq "off" || $chan ne $channel) {
readingsBulkUpdate($hash, $chan ,$data); }
}
$found=1;
last;
}
}
}
if ($found==0) {
$rmsg=~/^((?:\d{1,3}-\d{1,3}:)?(?:\d{1,3}|[CF]).\d{1,3}(?:.\d{1,3})?(?:\*\d{1,3})?)(?:\((.*?)\))?\((.*?)\)/;
my $chan=$hash->{helper}{Channels}{$channel} //$hash->{helper}{Channels}{$1} // $OBIS_channels{$1} //$channel;
my $chan1=$chan;
my $chan2=$chan."_2";
# Log 3,"Setting $chan";
my $v1=$3;
my $v2;
if (AttrVal($name,"valueBracket","second") eq "first") {
$v1=length $2 ? $2 : $3;
}
if (AttrVal($name,"valueBracket","second") eq "both") {
$v2=$2;
($v1,$v2)=($v2,$v1);
if (!length $v1 and length $v2) {$v1=$v2;$v2=""}
$chan1.="_1" if length $2;
}
if (AttrVal($name,"unitReadings","off") eq "off") {
$v1=~s/(.*)\*.*/$1/;
if ($v2) {$v2=~s/(.*)\*.*/$1/};
}
$v1+=0 if (looks_like_number($v1));
$v2+=0 if (looks_like_number($v2));
if (AttrVal($name,"ignoreUnknown","off") eq "off" || $chan ne $channel) {
readingsBulkUpdate($hash, $chan1 ,$v1) if length $v1;
readingsBulkUpdate($hash, $chan2 ,$v2) if length $v2;}
}
}
}
if ($hash->{helper}{EoM}==1) {last;}
}
$buffer = substr($buffer, index($buffer,chr(13).chr(10))+2);;
}
readingsEndUpdate($hash,1);
}
if (defined($remainingSML)) {$hash->{helper}{BUFFER}=$remainingSML}
else{$hash->{helper}{BUFFER}=$buffer;}
if($hash->{helper}{EoM}==1) { $hash->{helper}{BUFFER}="";}
return $name;
}
#####################################
sub OBIS_Ready($)
{
my ($hash) = @_;
return DevIo_OpenDev($hash, 1, "OBIS_Init")
if($hash->{STATE} eq "disconnected");
my $name = $hash->{NAME};
my $dev=$hash->{DeviceName};
# This is relevant for windows/USB only
my $po = $hash->{USBDev};
my ($BlockingFlags, $InBytes, $OutBytes, $ErrorFlags);
return if (!$po);
($BlockingFlags, $InBytes, $OutBytes, $ErrorFlags) = $po->status;
return ($InBytes>0);
}
sub OBIS_Attr(@)
{
my ($cmd,$name,$aName,$aVal) = @_;
# $cmd can be "del" or "set"
# $name is device name
# aName and aVal are Attribute name and value
my $hash = $defs{$name};
my $dev=$hash->{DeviceName};
#{$hash->{"test"}->{SetFn} = "OBIS_Set"}
if ($cmd eq "del") {
if ($aName eq "channels") { $hash->{helper}{Channels}=undef;}
if ($aName eq "interval") {
RemoveInternalTimer($hash);
$hash->{helper}{DEVICES}[1]=0;
}
if ($aName eq "pollingMode") {
delete($readyfnlist{"$name.$dev"});
$selectlist{"$name.$dev"} = $hash;
DevIo_CloseDev($hash);
DevIo_OpenDev($hash, 0, "OBIS_Init");
}
}
if ($cmd eq "set") {
if ($aName eq "channels") {
$hash->{helper}{Channels}=eval $aVal;
if ($@) {
Log3 $name, 3, "OBIS ($name) - X: Invalid regex in attr $name $aName $aVal: $@";
$hash->{helper}{Channels}=undef;
}
}
if ($aName eq "directions") {
$hash->{helper}{directions}=eval $aVal;
if ($@) {
Log3 $name, 3, "OBIS ($name) - X: Invalid regex in attr $name $aName $aVal: $@";
$hash->{helper}{directions}=undef;
}
}
if ($aName eq "interval") {
if ($aVal=~/^[1-9][0-9]*$/) {
$hash->{helper}{TRIGGERTIME}=gettimeofday();
RemoveInternalTimer($hash);
$hash->{helper}{DEVICES}[1]=$aVal;
my $t=OBIS_adjustAlign($hash,AttrVal($name,"alignTime",undef),$hash->{helper}{DEVICES}[1]);
Log3 ($hash,5,"OBIS ($name) - Internal timer set to ".FmtDateTime($t)) if ($hash->{helper}{DEVICES}[1]>0);
InternalTimer($t, "GetUpdate", $hash, 0) if ($hash->{helper}{DEVICES}[1]>0);
} else {
return "OBIS ($name) - $name: attr interval must be a number -> $aVal";
}
}
if ($aName eq "alignTime") {
if ($hash->{helper}{DEVICES}[1]>0) {
if ($aVal=~/\d+/) {
RemoveInternalTimer($hash);
$hash->{helper}{TRIGGERTIME}=gettimeofday();
my $t=OBIS_adjustAlign($hash,$aVal,$hash->{helper}{DEVICES}[1]);
Log3 ($hash,5,"OBIS ($name) - Internal timer set to ".FmtDateTime($t));
InternalTimer($t, "GetUpdate", $hash, 0);
} else {return "OBIS ($name): attr alignTime must be a Value >0"}
} else {
return "OBIS ($name): attr alignTime is useless, if no interval is specified";
}
}
if ($aName eq "pollingMode")
{
if ($aVal eq "on") {
delete $hash->{FD};
delete($selectlist{"$name.$dev"});
$readyfnlist{"$name.$dev"} = $hash;
} elsif ($aVal eq "off") {
delete($readyfnlist{"$name.$dev"});
$selectlist{"$name.$dev"} = $hash;
DevIo_CloseDev($hash);
DevIo_OpenDev($hash, 0, "OBIS_Init");
}
}
}
return undef;
}
sub OBIS_adjustAlign($$$)
{
my($hash, $attrVal, $interval) = @_;
if (!$attrVal) {return gettimeofday()+$interval;}
my ($alErr, $alHr, $alMin, $alSec, undef) = GetTimeSpec($attrVal);
return "$hash->{NAME} alignTime: $alErr" if($alErr);
my $tspec=strftime("\%H:\%M:\%S", gmtime($interval));
# Obis_adjustAlignTimetest2($hash,AttrVal($hash->{NAME},"alignTime",undef),$hash->{helper}{DEVICES}[1]);
my (undef, $hr, $min, $sec, undef) = GetTimeSpec($tspec);
my $now = time();
my $step = ($hr*60+$min)*60+$sec;
my $alTime = ($alHr*60+$alMin)*60+$alSec;#-fhemTzOffset($now);
my $ttime = int($hash->{helper}{TRIGGERTIME});
my $off = ($ttime % 86400) - 86400;
if ($off >= $alTime) {
$ttime = gettimeofday();#-86400;
$off -= 86400;
}
my $off2=$off;
while($off < $alTime) {
$off += $step;
}
$ttime += ($alTime-$off);
$ttime += $step if($ttime <= $now);
$hash->{NEXT} = FmtDateTime($ttime);
$hash->{helper}{TRIGGERTIME} = ($off2<=$alTime) ? $ttime : (gettimeofday());
return $hash->{helper}{TRIGGERTIME};
}
sub OBIS_hex2int {
my ($hexstr) = @_;
return 0
if $hexstr !~ /^[0-9A-Fa-f]{1,35}$/;
my $num = hex($hexstr);
return $num >> 31 ? $num - 2 ** 32 : $num;
}
sub OBIS_CRC16($$) {
my ($hash,$buff)=@_;
my @crc16 = ( 0x0000, 0x1189, 0x2312, 0x329b, 0x4624, 0x57ad, 0x6536, 0x74bf, 0x8c48,
0x9dc1, 0xaf5a, 0xbed3, 0xca6c, 0xdbe5, 0xe97e, 0xf8f7, 0x1081, 0x0108, 0x3393, 0x221a, 0x56a5, 0x472c,
0x75b7, 0x643e, 0x9cc9, 0x8d40, 0xbfdb, 0xae52, 0xdaed, 0xcb64, 0xf9ff, 0xe876, 0x2102, 0x308b, 0x0210,
0x1399, 0x6726, 0x76af, 0x4434, 0x55bd, 0xad4a, 0xbcc3, 0x8e58, 0x9fd1, 0xeb6e, 0xfae7, 0xc87c, 0xd9f5,
0x3183, 0x200a, 0x1291, 0x0318, 0x77a7, 0x662e, 0x54b5, 0x453c, 0xbdcb, 0xac42, 0x9ed9, 0x8f50, 0xfbef,
0xea66, 0xd8fd, 0xc974, 0x4204, 0x538d, 0x6116, 0x709f, 0x0420, 0x15a9, 0x2732, 0x36bb, 0xce4c, 0xdfc5,
0xed5e, 0xfcd7, 0x8868, 0x99e1, 0xab7a, 0xbaf3, 0x5285, 0x430c, 0x7197, 0x601e, 0x14a1, 0x0528, 0x37b3,
0x263a, 0xdecd, 0xcf44, 0xfddf, 0xec56, 0x98e9, 0x8960, 0xbbfb, 0xaa72, 0x6306, 0x728f, 0x4014, 0x519d,
0x2522, 0x34ab, 0x0630, 0x17b9, 0xef4e, 0xfec7, 0xcc5c, 0xddd5, 0xa96a, 0xb8e3, 0x8a78, 0x9bf1, 0x7387,
0x620e, 0x5095, 0x411c, 0x35a3, 0x242a, 0x16b1, 0x0738, 0xffcf, 0xee46, 0xdcdd, 0xcd54, 0xb9eb, 0xa862,
0x9af9, 0x8b70, 0x8408, 0x9581, 0xa71a, 0xb693, 0xc22c, 0xd3a5, 0xe13e, 0xf0b7, 0x0840, 0x19c9, 0x2b52,
0x3adb, 0x4e64, 0x5fed, 0x6d76, 0x7cff, 0x9489, 0x8500, 0xb79b, 0xa612, 0xd2ad, 0xc324, 0xf1bf, 0xe036,
0x18c1, 0x0948, 0x3bd3, 0x2a5a, 0x5ee5, 0x4f6c, 0x7df7, 0x6c7e, 0xa50a, 0xb483, 0x8618, 0x9791, 0xe32e,
0xf2a7, 0xc03c, 0xd1b5, 0x2942, 0x38cb, 0x0a50, 0x1bd9, 0x6f66, 0x7eef, 0x4c74, 0x5dfd, 0xb58b, 0xa402,
0x9699, 0x8710, 0xf3af, 0xe226, 0xd0bd, 0xc134, 0x39c3, 0x284a, 0x1ad1, 0x0b58, 0x7fe7, 0x6e6e, 0x5cf5,
0x4d7c, 0xc60c, 0xd785, 0xe51e, 0xf497, 0x8028, 0x91a1, 0xa33a, 0xb2b3, 0x4a44, 0x5bcd, 0x6956, 0x78df,
0x0c60, 0x1de9, 0x2f72, 0x3efb, 0xd68d, 0xc704, 0xf59f, 0xe416, 0x90a9, 0x8120, 0xb3bb, 0xa232, 0x5ac5,
0x4b4c, 0x79d7, 0x685e, 0x1ce1, 0x0d68, 0x3ff3, 0x2e7a, 0xe70e, 0xf687, 0xc41c, 0xd595, 0xa12a, 0xb0a3,
0x8238, 0x93b1, 0x6b46, 0x7acf, 0x4854, 0x59dd, 0x2d62, 0x3ceb, 0x0e70, 0x1ff9, 0xf78f, 0xe606, 0xd49d,
0xc514, 0xb1ab, 0xa022, 0x92b9, 0x8330, 0x7bc7, 0x6a4e, 0x58d5, 0x495c, 0x3de3, 0x2c6a, 0x1ef1, 0x0f78);
my $crc=0xFFFF;
my $a=substr($buff,0,-2);
my $b=substr($buff,-2);
my $crc2=OBIS_hex2int(uc(unpack('H*',$b)));
foreach (split //, $a) {
$crc = ($crc >> 8) ^ $crc16[($crc ^ ord($_)) & 0xff];
}
$crc ^= 0xffff;
$crc = (($crc & 0xff) << 8) | (($crc & 0xff00) >> 8);
return $crc2==$crc ? 1 : 0;
}
###############################################
# Input: Whole Datastream, inkl. TL-Byte #
# Output: Length, Type, Value, remaining Data #
###############################################
sub OBIS_decodeTL($){
my ($msg)=@_;
my $msgLength=0;
my $msgType=0;
my $lt="";
my $tmp="";
# Log 3,"In: $msg";
if ($msg) {
$msgType =hex(substr($msg,0,2)) & 0b01110000;
do {
$lt=hex(substr($msg,0,2));
$msg=substr($msg,2);
$msgLength=($msgLength*16) + ($lt & 0b00001111);
} while ($lt & 0b10000000);
# Log 3,"Calculated length: $msgLength";
if ($msgType == 0b01110000) {
for (my $i=0;$i<$msgLength;$i++) {
my $tmp2="";
# Log 3,"--> $msg";
(undef,undef,undef,$msg,$tmp2)=OBIS_decodeTL($msg);
# Log 3,"<-- $tmp2 $msg";
$tmp.=$tmp2;
}
$msgLength-=1;
}
$msgLength-=1;
my $valu;
if (length($msg)>$msgLength*2) {
$valu=substr($msg,0,$msgLength*2);
$tmp.=$valu;
$msg=substr($msg,$msgLength*2);
}
# Log 3," Split Msg: $tmp $msg";
return $msgLength,$msgType,$valu,$msg,$tmp;
};
}
"Cogito, ergo sum.";
=pod
=item device
=item summary Collects data from Smartmeters that report in OBIS-Standard
=item summary_DE Wertet Smartmeter aus, welche ihre Daten im OBIS-Standard senden
=begin html
<a name="OBIS"></a>
<h3>OBIS</h3>
This module is for SmartMeters, that report their data in OBIS-Standard. It dosen't matter, wether the data comes as PlainText or SML-encoded.
<br>
<b>Define</b>
<code>define &lt;name&gt; OBIS device|none [MeterType] </code><br>
<br>
&lt;device&gt; specifies the serial port to communicate with the smartmeter.
Normally on Linux the device will be named /dev/ttyUSBx, where x is a number.
For example /dev/ttyUSB0. You may specify the baudrate used after the @ char.<br>
<br><br>
Optional:MeterType can be of
<ul><li>VSM102 -&gt; Voltcraft VSM102</li>
<li>E110 -&gt; Landis&&;Gyr E110</li>
<li>E350USB -&gt; Landis&&;Gyr E350 USB-Version</li>
<li>Standard -&gt; Data comes as plainText</li>
<li>SML -&gt; Smart Message Language</li></ul>
<br>
Example: <br>
<code>define myPowerMeter OBIS /dev/ttyPlugwise@@9600,7,E,1 VSM102</code>
<br>
<br>
<b>Attributes</b>
<ul><li>
<code>offset_feed <br>offset_energy</code><br>
If your smartmeter is BEHIND the meter of your powersupplier, then you can hereby adjust
the total-reading of your SM to that of your official one.
<br><br>
</li>
<li>
<code>channels</code><br>
With this, you can rename the reported channels.
<code>attr myOBIS channels {"1.0.96.5.5.255"=>"Status","1.0.0.0.0.255"=>"Info","16.7"=>"Verbrauch"}></code>
<br><br></li>
<li><code>directions</code><br>
Some Meters report feeding/comnsuming of power in a statusword.
If this is set, you get an extra reading dir_total_consumption which defaults to "in" and "out"
Here, you can change this text with:
<code>attr myOBIS directions {">" => "pwr consuming", "<"=>"pwr feeding"}</code>
</li>
<li>
<code>interval</code><br>
The polling-interval in seconds. (Only useful in Polling-Mode)
</li>
<li>
<code>alignTime</code><br>
Aligns the intervals to a given time. Each interval is repeatedly calculated.
So if alignTime=00:00 and interval=600 aligns the interval to xx:00:00, xx:10:00, xx:20:00 etc....
<code>pollingMode</code><br>
Changes from direct-read to polling-mode.
Useful with meters, that send a continous datastream.
Reduces CPU-load.
<code>unitReadings</code><br>
Adds the units to the readings like w, wH, A etc.
<code>valueBracket</code><br>
Sets, weather to use the value from the first or the second bracket, if applicable.
Standard is "second"
</li>
<br>
</ul>
=end html
=begin html_DE
<a name="OBIS"></a>
<h3>OBIS</h3>
Modul für Smartmeter, die ihre Daten im OBIS-Standard senden. Hierbei ist es egal, ob die Daten als reiner Text oder aber SML-kodiert kommen.
<br>
<b>Define</b>
<code>define &lt;name&gt; OBIS device|none [MeterType] </code><br>
<br>
&lt;device&gt; gibt den seriellen Port an.
<br><br>
Optional:MeterType kann sein:
<ul><li>VSM102 -&gt; Voltcraft VSM102</li>
<li>E110 -&gt; Landis&&;Gyr E110</li>
<li>E350USB -&gt; Landis&&;Gyr E350 USB-Version</li>
<li>Standard -&gt; Daten kommen als plainText</li>
<li>SML -&gt; Smart Message Language</li></ul>
<br>
Beispiel: <br>
<code>define myPowerMeter OBIS /dev/ttyPlugwise@@9600,7,E,1 VSM102</code>
<br>
<br>
<b>Attribute</b>
<ul><li>
<code>offset_feed <br>offset_energy</code><br>
Wenn das Smartmeter hinter einem Zähler des EVU's sitzt, kann hiermit der Zähler des
Smartmeters an den des EVU's angepasst werden.
<br><br>
</li>
<li>
<code>channels</code><br>
Hiermit können die einzelnen Kanal-Readings mittels RegExes umbenannt werden.
Beispiel:
<code>attr myOBIS channels {"1.0.96.5.5.255"=>"Status","1.0.0.0.0.255"=>"Info","16.7"=>"Verbrauch"}></code>
<br><br>
</li>
<li><code>directions</code><br>
Manche SmartMeter senden im Statusbyte die Stromrichtung.
In diesem Fall gibt es ein extra Reading "dir_total_consumption" welches standardmäßig "in" and "out" beinhaltet
Hiermit kann dieser Text geändert werden:
<code>attr myOBIS directions {">" => "pwr consuming", "<"=>"pwr feeding"}</code>
</li><li>
<code>interval</code><br>
Abrufinterval der Daten. (Bringt nur im Polling-Mode was)
</li><li>
<code>algignTime</code><br>
Richtet den Zeitpunkt von <interval> nach einer bestimmten Uhrzeit aus.
</li><li>
<code>pollingMode</code><br>
Hiermit wird von Direktbenachrichtigung auf Polling umgestellt.
Bei Smartmetern, welche von selbst im Sekundentakt senden,
kann das zu einer spürbaren Senkung der Prozessorleistung führen.
<code>unitReadings</code><br>
Hängt bei den Readings auch die Einheiten an, zB w, wH, A usw.
<code>valueBracket</code><br>
Legt fest, ob der Wert aus dem ersten oder zweiten Klammernpaar genommen wird.
Standard ist "second"
</li>
<br>
</ul>
=end html_DE
=cut
Reference in New Issue View Git Blame Copy Permalink