mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-02-11 13:12:00 +00:00
758 lines
21 KiB
Perl
758 lines
21 KiB
Perl
##############################################
|
|
# $Id$
|
|
package main;
|
|
|
|
# TODO
|
|
# static routing: to and from the device
|
|
# automatic routing via neighborUpdate
|
|
# explorer frames
|
|
# check security
|
|
# multicast
|
|
|
|
use strict;
|
|
use warnings;
|
|
use Time::HiRes qw(gettimeofday);
|
|
|
|
use ZWLib;
|
|
use DevIo;
|
|
|
|
sub ZWCUL_Parse($$$$$);
|
|
sub ZWCUL_Read($@);
|
|
sub ZWCUL_ReadAnswer($$$);
|
|
sub ZWCUL_Ready($);
|
|
sub ZWCUL_Write($$$);
|
|
sub ZWCUL_ProcessSendStack($);
|
|
|
|
our %zwave_id2class;
|
|
my %ZWCUL_sentIdx;
|
|
my %ZWCUL_sentIdx2cbid;
|
|
|
|
my %sets = (
|
|
"reopen" => { cmd=>"" },
|
|
"led" => { cmd=>"l%02x", param=>{ on=>1, off=>0, blink=>2 } },
|
|
"addNode" => { cmd=>"x%x", param => { on=>1, off=>0, onSec=>2 } },
|
|
"addNodeId" => { cmd=>"x%x" },
|
|
"removeNode" => { cmd=>"x%x", param => { on=>1, off=>0 } },
|
|
"raw" => { cmd=> "%s" },
|
|
);
|
|
|
|
my %gets = (
|
|
"homeId" => { cmd=> "zi", regex => "^. [A-F0-9]{8} [A-F0-9]{2}\$" },
|
|
"version" => { cmd=> "V", regex => "^V " },
|
|
"nodeInfo" => { cmd=> "x%x" },
|
|
"raw" => { cmd=> "%s", regex => ".*" }
|
|
);
|
|
|
|
sub
|
|
ZWCUL_Initialize($)
|
|
{
|
|
my ($hash) = @_;
|
|
|
|
# Provider
|
|
$hash->{ReadFn} = "ZWCUL_Read";
|
|
$hash->{WriteFn} = "ZWCUL_Write";
|
|
$hash->{ReadyFn} = "ZWCUL_Ready";
|
|
$hash->{ReadAnswerFn} = "ZWCUL_ReadAnswer";
|
|
|
|
# Normal devices
|
|
$hash->{DefFn} = "ZWCUL_Define";
|
|
$hash->{SetFn} = "ZWCUL_Set";
|
|
$hash->{GetFn} = "ZWCUL_Get";
|
|
$hash->{AttrFn} = "ZWCUL_Attr";
|
|
$hash->{UndefFn} = "ZWCUL_Undef";
|
|
$hash->{AttrList}= "do_not_notify:1,0 dummy:1,0 model disable:0,1 ".
|
|
"networkKey intruderMode dataRate:40k,100k,9600";
|
|
}
|
|
|
|
#####################################
|
|
sub
|
|
ZWCUL_Define($$)
|
|
{
|
|
my ($hash, $def) = @_;
|
|
my @a = split("[ \t][ \t]*", $def);
|
|
|
|
return "wrong syntax: define <name> ZWCUL device homeId ctrlId" if(@a != 5);
|
|
return "wrong syntax: homeId is 8 digit hex" if($a[3] !~ m/^[0-9A-F]{8}$/i);
|
|
return "wrong syntax: ctrlId is 2 digit hex" if($a[4] !~ m/^[0-9A-F]{2}$/i);
|
|
|
|
DevIo_CloseDev($hash);
|
|
|
|
my $name = $a[0];
|
|
my $dev = $a[2];
|
|
$hash->{homeId} = lc($a[3]);
|
|
$hash->{homeIdSet} = lc($a[3]);
|
|
$hash->{nodeIdHex} = lc($a[4]);
|
|
$hash->{initString} = ($hash->{homeIdSet} =~ m/^0*$/ ? "zm4":"zr4");
|
|
$hash->{baudRate} = "40k";
|
|
$hash->{monitor} = 1 if($hash->{homeIdSet} eq "00000000");
|
|
setReadingsVal($hash, "homeId", # ZWDongle compatibility
|
|
"HomeId:$hash->{homeId} CtrlNodeIdHex:$hash->{nodeIdHex}", TimeNow());
|
|
|
|
$hash->{Clients} = ":ZWave:STACKABLE:";
|
|
my %matchList = ( "1:ZWave" => "^[0-9A-Fa-f]+\$",
|
|
"2:STACKABLE"=>"^\\*" );
|
|
$hash->{MatchList} = \%matchList;
|
|
$hash->{devioNoSTATE} = 1;
|
|
|
|
if($dev eq "none") {
|
|
Log3 $name, 1, "$name device is none, commands will be echoed only";
|
|
$attr{$name}{dummy} = 1;
|
|
readingsSingleUpdate($hash, "state", "dummy", 1);
|
|
return undef;
|
|
|
|
} elsif($dev !~ m/@/) {
|
|
$def .= "\@9600"; # default baudrate
|
|
|
|
}
|
|
|
|
$hash->{DeviceName} = $dev;
|
|
return DevIo_OpenDev($hash, 0, "ZWCUL_DoInit");
|
|
}
|
|
|
|
#####################################
|
|
sub
|
|
ZWCUL_DoInit($)
|
|
{
|
|
my $hash = shift;
|
|
my $name = $hash->{NAME};
|
|
|
|
$hash->{PARTIAL} = "";
|
|
|
|
$hash->{RA_Timeout} = 0.5; # Clear the pipe
|
|
for(;;) {
|
|
my ($err, undef) = ZWCUL_ReadAnswer($hash, "Clear", "wontmatch");
|
|
last if($err && ($err =~ m/^Timeout/ || $err =~ m/No FD/));
|
|
}
|
|
delete($hash->{RA_Timeout});
|
|
|
|
my ($err, $ver, $try) = ("", "", 0);
|
|
while($try++ < 3 && $ver !~ m/^V/) {
|
|
DevIo_SimpleWrite($hash, "V", 2, 1);
|
|
($err, $ver) = ZWCUL_ReadAnswer($hash, "Version", "^V");
|
|
return "$name: $err" if($err && ($err !~ m/Timeout/ || $try == 3));
|
|
$ver = "" if(!$ver);
|
|
}
|
|
if($ver !~ m/^V/) {
|
|
$attr{$name}{dummy} = 1;
|
|
my $msg = "Not an CUL device, got for V: $ver";
|
|
Log3 $name, 1, $msg;
|
|
return $msg;
|
|
}
|
|
$ver =~ s/[\r\n]//g;
|
|
$hash->{VERSION} = $ver;
|
|
|
|
DevIo_SimpleWrite($hash, "zi".$hash->{homeIdSet}.$hash->{nodeIdHex}, 2, 1);
|
|
DevIo_SimpleWrite($hash, $hash->{initString}, 2, 1);
|
|
|
|
readingsSingleUpdate($hash, "state", "Initialized", 1);
|
|
return undef;
|
|
}
|
|
|
|
|
|
#####################################
|
|
sub
|
|
ZWCUL_Undef($$)
|
|
{
|
|
my ($hash,$arg) = @_;
|
|
DevIo_SimpleWrite($hash, "zx", 2, 1);
|
|
DevIo_CloseDev($hash);
|
|
return undef;
|
|
}
|
|
|
|
sub
|
|
ZWCUL_tmp9600($$)
|
|
{
|
|
my ($hash, $on) = @_;
|
|
$hash->{baudRate} = ($on ? "9600" : AttrVal($hash->{NAME},"dataRate","40k"));
|
|
DevIo_SimpleWrite($hash, $on ? $on : $hash->{initString}, 2, 1);
|
|
}
|
|
|
|
#####################################
|
|
sub
|
|
ZWCUL_cmd($$@)
|
|
{
|
|
my ($type, $cmdList, $hash, @a) = @_;
|
|
my $name = shift @a;
|
|
|
|
return "\"$type $name\" needs at least one parameter" if(@a < 1);
|
|
my $cmdName = shift @a;
|
|
|
|
if(!defined($cmdList->{$cmdName})) {
|
|
my @r;
|
|
map { my $p = $cmdList->{$_}{param};
|
|
push @r,($p ? "$_:".join(",",sort keys %{$p}) : $_) }
|
|
sort keys %{$cmdList};
|
|
return "Unknown argument $cmdName, choose one of ".join(" ",@r);
|
|
}
|
|
|
|
Log3 $hash, 4, "ZWCUL $type $name $cmdName ".join(" ",@a);
|
|
if($cmdName eq "reopen") {
|
|
return if(AttrVal($name, "dummy",undef) || AttrVal($name, "disable",undef));
|
|
delete $hash->{NEXT_OPEN};
|
|
DevIo_CloseDev($hash);
|
|
sleep(1);
|
|
DevIo_OpenDev($hash, 0, "ZWCUL_DoInit");
|
|
return;
|
|
}
|
|
|
|
my $cmd = $cmdList->{$cmdName}{cmd};
|
|
my @ca = split("%", $cmd, -1);
|
|
my $nargs = int(@ca)-1;
|
|
return "$type $name $cmdName needs $nargs arguments" if($nargs != int(@a));
|
|
|
|
my $param = $cmdList->{$cmdName}{param};
|
|
if($param) {
|
|
return "invalid parameter $a[0] for $cmdName" if(!defined($param->{$a[0]}));
|
|
$a[0] = $param->{$a[0]};
|
|
}
|
|
|
|
if($cmdName =~ m/^addNode/) {
|
|
delete $hash->{removeNode};
|
|
delete $hash->{addNode};
|
|
if($cmdName eq "addNodeId") {
|
|
$hash->{addNode} = sprintf("%02x", $a[0]);
|
|
|
|
} else {
|
|
$hash->{addNode} = ZWCUL_getNextNodeId($hash) if($a[0]);
|
|
$hash->{addSecure} = 1 if($a[0] == 2);
|
|
}
|
|
Log3 $hash, 3, "ZWCUL going to assigning new node id $hash->{addNode}"
|
|
if($a[0]);
|
|
ZWCUL_tmp9600($hash, $a[0] ? "zm9" : 0); # expect random homeId
|
|
return;
|
|
}
|
|
|
|
if($cmdName eq "removeNode") {
|
|
delete $hash->{addNode};
|
|
delete $hash->{removeNode};
|
|
$hash->{removeNode} = $a[0] if($a[0]);
|
|
ZWCUL_tmp9600($hash, $a[0] ? "zr9" : 0);
|
|
return;
|
|
}
|
|
|
|
if($cmdName eq "nodeInfo") {
|
|
my $node = ZWCUL_getNode($hash, sprintf("%02x", $a[0]));
|
|
return "Node with decimal id $a[0] not found" if(!$node);
|
|
my $ni = ReadingsVal($node->{NAME}, "nodeInfo", undef);
|
|
return "No nodeInfo present" if(!$ni);
|
|
$ni = "0141${ni}041001"; # TODO: Remove fixed values
|
|
my @r = map { ord($_) } split("", pack('H*', $ni));
|
|
my $msg = zwlib_parseNodeInfo(@r);
|
|
setReadingsVal($hash, "nodeInfo_".$a[0], $msg, TimeNow());
|
|
return $msg;
|
|
}
|
|
|
|
$cmd = sprintf($cmd, @a);
|
|
DevIo_SimpleWrite($hash, $cmd, 2, 1);
|
|
|
|
return undef if($type eq "set");
|
|
|
|
my $re = $cmdList->{$cmdName}{regexp};
|
|
my ($e, $d) = ZWCUL_ReadAnswer($hash, $cmdName, $cmdList->{$cmdName}{regexp});
|
|
return $e if($e);
|
|
return $d;
|
|
}
|
|
|
|
sub ZWCUL_Set() { return ZWCUL_cmd("set", \%sets, @_); };
|
|
sub ZWCUL_Get() { return ZWCUL_cmd("get", \%gets, @_); };
|
|
|
|
#####################################
|
|
sub
|
|
ZWCUL_Write($$$)
|
|
{
|
|
my ($hash,$fn,$msg) = @_;
|
|
|
|
Log3 $hash, 5, "ZWCUL_Write $fn $msg";
|
|
if($msg =~ m/0013(..)(..)(.*)(..)(..)/) {
|
|
my ($targetId,$l,$p,$flags,$cbid) = ($1,$2,$3,$4,$5);
|
|
my ($homeId,$route) = split(",",$fn);
|
|
|
|
my $sn = $ZWCUL_sentIdx{$targetId};
|
|
$sn = (!$sn || $sn==15) ? 1 : ($sn+1);
|
|
$ZWCUL_sentIdx2cbid{"$targetId$sn"} = $cbid;
|
|
$ZWCUL_sentIdx{$targetId} = $sn;
|
|
|
|
my $s100 = ($hash->{baudRate} eq "100k");
|
|
|
|
my $rf = 0x41;
|
|
if($route) {
|
|
$rf = 0x81;
|
|
$p = sprintf("00%d0%s%s",length($route)/2, $route, $p);
|
|
}
|
|
|
|
$msg = sprintf("%s%s%02x%02x%02x%s%s",
|
|
$homeId, $hash->{nodeIdHex}, $rf, $sn,
|
|
length($p)/2+($s100 ? 11 : 10), $targetId, $p);
|
|
$msg .= ($s100 ? zwlib_checkSum_16($msg) : zwlib_checkSum_8($msg));
|
|
|
|
DevIo_SimpleWrite($hash, "zs".$msg, 2, 1);
|
|
|
|
} elsif($hash->{STACKED}) {
|
|
DevIo_SimpleWrite($hash, $msg, 2, 1);
|
|
|
|
}
|
|
}
|
|
|
|
#####################################
|
|
# called from the global loop, when the select for hash->{FD} reports data
|
|
sub
|
|
ZWCUL_Read($@)
|
|
{
|
|
my ($hash, $local, $regexp) = @_;
|
|
|
|
my $buf = (defined($local) ? $local : DevIo_SimpleRead($hash));
|
|
return "" if(!defined($buf));
|
|
my $name = $hash->{NAME};
|
|
|
|
my $culdata = $hash->{PARTIAL};
|
|
#Log3 $name, 5, "ZWCUL/RAW: $culdata/$buf";
|
|
$culdata .= $buf;
|
|
|
|
while($culdata =~ m/\n/) {
|
|
my $rmsg;
|
|
($rmsg,$culdata) = split("\n", $culdata, 2);
|
|
$rmsg =~ s/\r//;
|
|
$hash->{PARTIAL} = $culdata; # for recursive calls
|
|
return $rmsg
|
|
if(defined($local) && (!defined($regexp) || ($rmsg =~ m/$regexp/)));
|
|
ZWCUL_Parse($hash, $hash, $name, $rmsg, 0) if($rmsg);
|
|
$culdata = $hash->{PARTIAL};
|
|
}
|
|
$hash->{PARTIAL} = $culdata;
|
|
return undef;
|
|
}
|
|
|
|
sub
|
|
ZWCUL_getNode($$)
|
|
{
|
|
my ($hash, $id) = @_;
|
|
my @l = devspec2array(sprintf("TYPE=ZWave:".
|
|
"FILTER=homeId=%s:FILTER=nodeIdHex=%s", $hash->{homeId}, $id));
|
|
return undef if(!int(@l));
|
|
return $defs{$l[0]};
|
|
}
|
|
|
|
sub
|
|
ZWCUL_getNextNodeId($)
|
|
{
|
|
my ($hash) = @_;
|
|
my @l = devspec2array(sprintf(".*:FILTER=homeId=%s",$hash->{homeId}));
|
|
my %h = map { $defs{$_}{nodeIdHex} => 1 } @l;
|
|
for(my $i = 1; $i <= 232; $i++) {
|
|
my $s = sprintf("%02x", $i);
|
|
return $s if(!$h{$s});
|
|
}
|
|
Log 1, "NOTE: NO MORE nodeIDs available";
|
|
return "ff";
|
|
}
|
|
|
|
sub
|
|
ZWCUL_assignId($$$$)
|
|
{
|
|
my ($hash, $oldNodeId, $newHomeId, $newNodeId) = @_;
|
|
|
|
my $myHash;
|
|
my $key = "$hash->{homeIdSet} $oldNodeId";
|
|
if(!defined($modules{ZWave}{defptr}{$key})) {
|
|
$modules{ZWave}{defptr}{$key} = { nodeIdHex => $oldNodeId };
|
|
$myHash = 1;
|
|
}
|
|
ZWCUL_Write($hash, $hash->{homeIdSet},
|
|
sprintf("0013%s080103%s%s0000", $oldNodeId, $newNodeId, $newHomeId));
|
|
delete $modules{ZWave}{defptr}{$key} if($myHash);
|
|
}
|
|
|
|
sub
|
|
ZWCUL_Parse($$$$$)
|
|
{
|
|
my ($hash, $iohash, $name, $rmsg, $nodispatch) = @_;
|
|
|
|
if($rmsg =~ m/^\*/) { # STACKABLE
|
|
Dispatch($hash, $rmsg, undef);
|
|
return;
|
|
}
|
|
|
|
$hash->{"${name}_MSGCNT"}++;
|
|
$hash->{"${name}_TIME"} = TimeNow();
|
|
# showtime attribute
|
|
readingsSingleUpdate($hash, "state", $hash->{READINGS}{state}{VAL}, 0);
|
|
$hash->{RAWMSG} = $rmsg;
|
|
my %addvals = (RAWMSG => $rmsg);
|
|
|
|
Dispatch($hash, $rmsg, \%addvals) if($rmsg !~ m/^z/);
|
|
|
|
$rmsg = lc($rmsg);
|
|
my $me = $hash->{NAME};
|
|
my $s100 = ($hash->{baudRate} eq "100k");
|
|
|
|
if($rmsg =~ m/^za(..)$/) {
|
|
Log3 $hash, 5, "$me sent ACK to $1";
|
|
return;
|
|
}
|
|
|
|
if($rmsg =~ m/^zr(..)$/) {
|
|
Log3 $hash, 5, "$me fw-resend nr ".hex($1);
|
|
return;
|
|
}
|
|
|
|
|
|
my ($H, $S, $F, $f, $sn, $L, $T, $P, $C);
|
|
if($s100 && $rmsg =~ '^z(........)(..)(..)(.)(.)(..)(..)(.*)(....)$') {
|
|
($H,$S,$F,$f,$sn,$L,$T,$P,$C) = ($1,$2,$3,$4,$5,$6,$7,$8,$9);
|
|
|
|
} elsif(!$s100 && $rmsg =~ '^z(........)(..)(..)(.)(.)(..)(..)(.*)(..)$') {
|
|
($H,$S,$F,$f,$sn,$L,$T,$P,$C) = ($1,$2,$3,$4,$5,$6,$7,$8,$9);
|
|
|
|
} else {
|
|
Log3 $hash, 1, "ERROR: Unknown packet $rmsg";
|
|
return;
|
|
|
|
}
|
|
|
|
my ($hF,$hf, $rf,$hc,$hp,$hops,$ri,$u1) = (hex($F),hex($f),"",0,0,"","","");
|
|
# ITU G.9959, 8-4, 8-11
|
|
if($hF&0x80) { # routing
|
|
$hc = hex(substr($P,2,1));
|
|
$hp = hex(substr($P,3,1));
|
|
$ri = "R:".substr($P, 0, ($hc+2)*2)." ";
|
|
$rf = substr($P, 0, 2);
|
|
$hops = substr($P, 4, $hc*2);
|
|
$hops =~ s/(..)/$1 /g;
|
|
$P = substr($P,($hc+2)*2);
|
|
}
|
|
if($hF&4) { # Explorer?
|
|
$u1 = " E:".substr($P,0,16)." ";
|
|
$P = substr($P,16);
|
|
}
|
|
|
|
if(AttrVal($me, "verbose", 1) > 4) {
|
|
Log3 $hash,5,"$name $H S:$S F:$F f:$f SN:$sn L:$L T:$T ${ri}${u1}P:$P C:$C";
|
|
Log3 $hash,5," F:".
|
|
(($hF & 3)==1 ? " singleCast" :
|
|
($hF & 3)==2 ? " multiCast" :
|
|
($hF & 3)==3 ? " ack" : " unknownHeaderType:".($hF&0x3)).
|
|
(($hF & 4) ? " explorer" : "").
|
|
(($hF & 0x10)==0x10 ? " speedModified":"").
|
|
(($hF & 0x20)==0x20 ? " lowPower":"").
|
|
(($hF & 0x40)==0x40 ? " ackReq":"").
|
|
(($hF & 0x80)==0x80 ?
|
|
" routed, rf:$rf hopCnt:$hc hopPos:$hp hops:$hops":"").
|
|
((($hf>>1)&3)==0 ? " " :
|
|
(($hf>>1)&3)==1 ? " shortBeam" :
|
|
(($hf>>1)&3)==2 ? " longBeam" :" unknownBeam");
|
|
}
|
|
|
|
return if($hc && !$hash->{monitor} && $hc == $hp);
|
|
return if($hash->{monitor} && !AttrVal($me, "intruderMode", 0));
|
|
|
|
|
|
$hash->{homeId} = $H; # Fake homeId for monitor mode
|
|
|
|
if(length($P)) {
|
|
|
|
if($hash->{removeNode} && $T eq "ff") {
|
|
ZWCUL_assignId($hash, $S, "00000000", "00");
|
|
$hash->{removeNode} = $S;
|
|
return;
|
|
}
|
|
|
|
if($hash->{addNode} && $T eq "ff" && $S eq "00" && $P =~ m/^0101/) {
|
|
ZWCUL_assignId($hash, "00", $hash->{homeIdSet}, $hash->{addNode});
|
|
$hash->{addNodeParam} = $P;
|
|
return;
|
|
}
|
|
|
|
if($P =~ m/^0101(......)(..)..(.*)/) {
|
|
my ($nodeInfo, $type6, $classes) = ($1, $2, $3);
|
|
$rmsg = sprintf("004a0003%s0000%s00%s", $S, $2, $3);
|
|
|
|
} else {
|
|
$rmsg = sprintf("0004%s%s%02x%s", $S, $S, length($P)/2, $P);
|
|
|
|
}
|
|
|
|
} else { # ACK
|
|
if($hash->{removeNode} && $hash->{removeNode} eq $S) { #############
|
|
Log3 $hash, 3, "Node $S excluded from network";
|
|
delete $hash->{removeNode};
|
|
ZWCUL_tmp9600($hash, 0);
|
|
return;
|
|
}
|
|
|
|
if($hash->{addNode} && $S eq "00") { #############
|
|
$hash->{addNodeParam} =~ m/^0101(......)(..)..(.*)/;
|
|
my ($nodeInfo, $type6, $classes) = ($1, $2, $3);
|
|
|
|
ZWCUL_tmp9600($hash, 0);
|
|
$hash->{homeId} = $hash->{homeIdSet};
|
|
Dispatch($hash, sprintf("004a0003%s0000%s00%s",
|
|
$hash->{addNode}, $type6, $classes), \%addvals);
|
|
|
|
my $node = ZWCUL_getNode($hash, $hash->{addNode});
|
|
if($node) { # autocreated a node
|
|
readingsSingleUpdate($node, "nodeInfo", $nodeInfo, 0);
|
|
Dispatch($hash, sprintf("004a0005%s00", $hash->{addNode}), \%addvals);
|
|
}
|
|
|
|
delete $hash->{addNode};
|
|
delete $hash->{addNodeParam};
|
|
return;
|
|
}
|
|
|
|
if($hash->{addNode} && $hash->{addNode} eq $S) { # Another hack
|
|
Log3 $hash, 3,"ZWCUL node ".hex($S)." (hex $S) included into the network";
|
|
delete $hash->{addNode};
|
|
ZWCUL_tmp9600($hash, 0);
|
|
return;
|
|
}
|
|
|
|
$rmsg = sprintf("0013%s00",
|
|
$ZWCUL_sentIdx2cbid{"$S$sn"} ? $ZWCUL_sentIdx2cbid{"$S$sn"} : 00);
|
|
|
|
}
|
|
return $rmsg if($nodispatch);
|
|
Dispatch($hash, $rmsg, \%addvals);
|
|
}
|
|
|
|
#####################################
|
|
# This is a direct read for commands like get
|
|
sub
|
|
ZWCUL_ReadAnswer($$$)
|
|
{
|
|
my ($hash, $arg, $regexp) = @_;
|
|
Log3 $hash, 4, "ZWCUL_ReadAnswer arg:$arg regexp:".($regexp ? $regexp:"");
|
|
my $transform;
|
|
if($regexp && $regexp =~ m/^\^000400(..)..(..)/) {
|
|
$regexp = "^z........$1........$2";
|
|
$transform = 1;
|
|
}
|
|
return ("No FD (dummy device?)", undef)
|
|
if(!$hash || ($^O !~ /Win/ && !defined($hash->{FD})));
|
|
my $to = ($hash->{RA_Timeout} ? $hash->{RA_Timeout} : 1);
|
|
|
|
for(;;) {
|
|
|
|
my $buf;
|
|
if($^O =~ m/Win/ && $hash->{USBDev}) {
|
|
$hash->{USBDev}->read_const_time($to*1000); # set timeout (ms)
|
|
# Read anstatt input sonst funzt read_const_time nicht.
|
|
$buf = $hash->{USBDev}->read(999);
|
|
return ("Timeout reading answer for get $arg", undef)
|
|
if(length($buf) == 0);
|
|
|
|
} else {
|
|
if(!$hash->{FD}) {
|
|
Log3 $hash, 1, "ZWCUL_ReadAnswer: device lost";
|
|
return ("Device lost when reading answer for get $arg", undef);
|
|
}
|
|
|
|
my $rin = '';
|
|
vec($rin, $hash->{FD}, 1) = 1;
|
|
my $nfound = select($rin, undef, undef, $to);
|
|
if($nfound < 0) {
|
|
my $err = $!;
|
|
Log3 $hash, 5, "ZWCUL_ReadAnswer: nfound < 0 / err:$err";
|
|
next if ($err == EAGAIN() || $err == EINTR() || $err == 0);
|
|
DevIo_Disconnected($hash);
|
|
return("ZWCUL_ReadAnswer $arg: $err", undef);
|
|
}
|
|
|
|
if($nfound == 0){
|
|
Log3 $hash, 5, "ZWCUL_ReadAnswer: select timeout";
|
|
return ("Timeout reading answer for get $arg", undef);
|
|
}
|
|
|
|
$buf = DevIo_SimpleRead($hash);
|
|
if(!defined($buf)){
|
|
Log3 $hash, 1,"ZWCUL_ReadAnswer: no data read";
|
|
return ("No data", undef);
|
|
}
|
|
}
|
|
|
|
my $ret = ZWCUL_Read($hash, $buf, $regexp);
|
|
if(defined($ret)){
|
|
if($transform) {
|
|
my $name = $hash->{NAME};
|
|
$ret = ZWCUL_Parse($hash, $hash, $name, $ret, 1);
|
|
}
|
|
Log3 $hash, 4, "ZWCUL_ReadAnswer for $arg: $ret";
|
|
return (undef, $ret);
|
|
}
|
|
}
|
|
}
|
|
|
|
#####################################
|
|
sub
|
|
ZWCUL_Attr($$$$)
|
|
{
|
|
my ($cmd, $name, $attr, $value) = @_;
|
|
my $hash = $defs{$name};
|
|
|
|
if($attr eq "disable") {
|
|
if($cmd eq "set" && ($value || !defined($value))) {
|
|
DevIo_CloseDev($hash) if(!AttrVal($name,"dummy",undef));
|
|
readingsSingleUpdate($hash, "state", "disabled", 1);
|
|
|
|
} else {
|
|
if(AttrVal($name,"dummy",undef)) {
|
|
readingsSingleUpdate($hash, "state", "dummy", 1);
|
|
return;
|
|
}
|
|
DevIo_OpenDev($hash, 0, "ZWCUL_DoInit");
|
|
|
|
}
|
|
|
|
} elsif($attr eq "networkKey" && $cmd eq "set") {
|
|
if(!$value || $value !~ m/^[0-9A-F]{32}$/i) {
|
|
return "attr $name networkKey: not a hex string with a length of 32";
|
|
}
|
|
return;
|
|
|
|
} elsif($attr eq "dataRate" && $cmd eq "set") {
|
|
my $sfx = ($value eq "100k" ? "1" :
|
|
($value eq "9600" ? "9" : "4"));
|
|
$hash->{initString} = ($hash->{homeIdSet} =~ m/^0*$/ ? "zm$sfx":"zr$sfx");
|
|
$hash->{baudRate} = $value;
|
|
DevIo_SimpleWrite($hash, $hash->{initString}, 2);
|
|
|
|
}
|
|
|
|
return undef;
|
|
|
|
}
|
|
|
|
#####################################
|
|
sub
|
|
ZWCUL_Ready($)
|
|
{
|
|
my ($hash) = @_;
|
|
|
|
return undef if (IsDisabled($hash->{NAME}));
|
|
|
|
return DevIo_OpenDev($hash, 1, "ZWCUL_DoInit")
|
|
if(DevIo_getState($hash) eq "disconnected");
|
|
|
|
# This is relevant for windows/USB only
|
|
my $po = $hash->{USBDev};
|
|
if($po) {
|
|
my ($BlockingFlags, $InBytes, $OutBytes, $ErrorFlags) = $po->status;
|
|
return ($InBytes>0);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
|
|
1;
|
|
|
|
=pod
|
|
=item summary connection to a culfw Device in ZWave mode (e.g. CUL)
|
|
=item summary_DE Anbindung eines culfw Gerätes in ZWave Modus (z.Bsp. CUL)
|
|
=begin html
|
|
|
|
<a name="ZWCUL"></a>
|
|
<h3>ZWCUL</h3>
|
|
<ul>
|
|
This module serves a CUL in ZWave mode (starting from culfw version 1.66),
|
|
which is attached via USB or TCP/IP, and enables the use of ZWave devices
|
|
(see also the <a href="#ZWave">ZWave</a> module).
|
|
<br><br>
|
|
<a name="ZWCULdefine"></a>
|
|
<b>Define</b>
|
|
<ul>
|
|
<code>define <name> ZWCUL <device> <homeId>
|
|
<ctrlId></code>
|
|
<br>
|
|
<br>
|
|
Since the DevIo module is used to open the device, you can also use devices
|
|
connected via TCP/IP. See <a href="#CULdefine">this</a> paragraph on device
|
|
naming details.
|
|
<br>
|
|
Example:
|
|
<ul>
|
|
<code>define ZWCUL_1 ZWCUL /dev/cu.usbmodemfa141@9600 12345678 01</code><br>
|
|
</ul>
|
|
If the homeId is set to 00000000, then culfw will enter monitor mode, i.e. no
|
|
acks for received messages will be sent, and no homeId filtering will be done.
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="ZWCULset"></a>
|
|
<b>Set</b>
|
|
<ul>
|
|
|
|
<li>reopen<br>
|
|
First close and then open the device. Used for debugging purposes.
|
|
</li>
|
|
|
|
<li>led [on|off|blink]<br>
|
|
Set the LED on the CUL.
|
|
</li>
|
|
|
|
<li>raw<br>
|
|
send a raw string to culfw
|
|
</li>
|
|
|
|
<li>addNode [on|onSec|off]<br>
|
|
Activate (or deactivate) inclusion mode. The CUL will switch to dataRate
|
|
9600 until terminating this mode with off, or a node is included. If onSec
|
|
is specified, the ZWCUL networkKey ist set, and the device supports the
|
|
SECURITY class, then a secure inclusion is attempted. </li>
|
|
|
|
<li>addNodeId <decimalNodeId><br>
|
|
Activate inclusion mode, and assign decimalNodeId to the next node.
|
|
To deactivate this mode, use addNode off. Note: addNode won't work for a
|
|
FHEM2FHEM:RAW attached ZWCUL, use addNodeId instead</li>
|
|
|
|
<li>removeNode [onNw|on|off]<br>
|
|
Activate (or deactivate) exclusion mode. Like with addNode, the CUL will
|
|
switch temporarily to dataRate 9600, potentially missing some packets sent
|
|
on higher dataRates. Note: the corresponding fhem device have to be
|
|
deleted manually.</li>
|
|
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="ZWCULget"></a>
|
|
<b>Get</b>
|
|
<ul>
|
|
<li>homeId<br>
|
|
return the homeId and the ctrlId of the controller.</li>
|
|
<li>nodeInfo<br>
|
|
return node specific information. Needed by developers only.</li>
|
|
<li>raw<br>
|
|
Send raw data to the controller.</li>
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="ZWCULattr"></a>
|
|
<b>Attributes</b>
|
|
<ul>
|
|
<li><a name="dataRate">dataRate</a> [40k|100k|9600]<br>
|
|
specify the data rate.
|
|
</li>
|
|
<li><a href="#dummy">dummy</a></li>
|
|
<li><a href="#do_not_notify">do_not_notify</a></li>
|
|
<li><a href="#model">model</a></li>
|
|
<li><a href="#disable">disable</a></li>
|
|
<li><a href="#networkKey">networkKey</a></li>
|
|
<li><a name="intruderMode">intruderMode</a><br>
|
|
In monitor mode (see above) events are not dispatched to the ZWave module
|
|
per default. Setting this attribute will allow to get decoded messages,
|
|
and to send commands to devices not included by this controller.
|
|
</li>
|
|
<li>verbose<br>
|
|
If the verbose attribute of this device (not global!) is set to 5 or
|
|
higher, then detailed logging of the RF message will be done.
|
|
</li>
|
|
</ul>
|
|
<br>
|
|
|
|
<a name="ZWCULevents"></a>
|
|
<b>Generated events: TODO</b>
|
|
|
|
</ul>
|
|
|
|
|
|
=end html
|
|
=cut
|