FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-03-06 12:46:57 +00:00
Code Issues Releases Wiki Activity
fhem-mirror/fhem/FHEM/10_ZWave.pm
rudolfkoenig 5ae40d3618 00_ZWDongle.pm: replace , with space in nodeList/neighborList (Forum #43413) 
git-svn-id: https://svn.fhem.de/fhem/trunk@9825 2b470e98-0d58-463d-a4d8-8e2adae1ed80
2015-11-08 14:24:48 +00:00

3923 lines
126 KiB
Perl
Executable File
Raw Blame History

##############################################
# $Id$
# See ZWDongle.pm for inspiration
package main;
use strict;
use warnings;
use SetExtensions;
use Compress::Zlib;
use Time::HiRes qw( gettimeofday );
use HttpUtils;
sub ZWave_Cmd($$@);
sub ZWave_Get($@);
sub ZWave_Parse($$@);
sub ZWave_Set($@);
sub ZWave_SetClasses($$$$);
sub ZWave_addToSendStack($$);
sub ZWave_secStart($);
sub ZWave_secEnd($);
use vars qw(%zw_func_id);
use vars qw(%zw_type6);
use vars qw($FW_ME $FW_tp $FW_ss);
my %zwave_id2class;
my %zwave_class = (
NO_OPERATION => { id => '00' },
BASIC => { id => '20',
set => { basicValue => "01%02x",
basicSet => "01%02x" }, # Alias, Forum #38200
get => { basicStatus => "02", },
parse => { "..2001(.*)"=> '"basicSet:$1"', # Forum #36980
"..2002" => "basicGet:request", # sent by the remote
"..2003(.*)"=> '"basicReport:$1"' }},
CONTROLLER_REPLICATION => { id => '21' },
APPLICATION_STATUS => { id => '22' },
ZIP_SERVICES => { id => '23' },
ZIP_SERVER => { id => '24' },
SWITCH_BINARY => { id => '25',
set => { off => "0100",
on => "01FF" },
get => { swbStatus => "02", },
parse => { "03250300" => "state:off",
"032503ff" => "state:on",
"03250100" => "state:setOff",
"032501ff" => "state:setOn" } } ,
SWITCH_MULTILEVEL => { id => '26',
set => { off => "0100",
on => "01FF",
dim => "01%02x",
stop => "05" },
get => { swmStatus => "02", },
parse => { "032603(.*)"=> '($1 eq "00" ? "state:off" :
($1 eq "ff" ? "state:on" :
"state:dim ".hex($1)))',
"..260420" => "state:swmBeginUp",
"..260460" => "state:swmBeginDown",
"..2605" => "state:swmEnd" } },
SWITCH_ALL => { id => '27',
set => { swaIncludeNone => "0100",
swaIncludeOff => "0101",
swaIncludeOn => "0102",
swaIncludeOnOff => "01ff",
swaOn => "04",
swaOff => "05" },
get => { swaInclude => "02" },
parse => { "03270300" => "swa:none",
"03270301" => "swa:off",
"03270302" => "swa:on",
"032703ff" => "swa:on off" } },
SWITCH_TOGGLE_BINARY => { id => '28' },
SWITCH_TOGGLE_MULTILEVEL => { id => '29' },
CHIMNEY_FAN => { id => '2a' },
SCENE_ACTIVATION => { id => '2b',
set => { sceneActivate => "01%02x%02x" },
parse => { "042b01(..)(..)" => '"scene_$1:$2"',
"042b01(..)ff" => 'ZWave_sceneParse($1)'} },
SCENE_ACTUATOR_CONF => { id => '2c',
set => { sceneConfig => "01%02x%02x80%02x" },
get => { sceneConfig => "02%02x", },
parse => { "052c03(..)(..)(..)" => '"scene_$1:level $2 duration $3"' } },
SCENE_CONTROLLER_CONF => { id => '2d',
set => { sceneConfig => "01%02x%02x%02x" },
get => { sceneConfig => "02%02x", },
parse => { "052d03(..)(..)(..)" => '"group_$1:scene $2 duration $3"' } },
ZIP_CLIENT => { id => '2e' },
ZIP_ADV_SERVICES => { id => '2f' },
SENSOR_BINARY => { id => '30',
get => { sbStatus => "02", },
parse => { "03300300" => "state:closed",
"033003ff" => "state:open",
"043003(..)(..)"=> 'ZWave_sensorbinaryV2Parse($1,$2)' } },
SENSOR_MULTILEVEL => { id => '31',
get => { smStatus => "04" },
parse => { "..3105(..)(..)(.*)" => 'ZWave_multilevelParse($1,$2,$3)'} },
METER => { id => '32',
set => { meterReset => "05" },
get => { meter => 'Zwave_meterGet("%s")',
meterSupported => "03" },
parse => { "..3202(.*)" => 'ZWave_meterParse($hash, $1)',
"..3204(.*)" => 'ZWave_meterSupportedParse($hash, $1)' } },
COLOR_CONTROL => { id => '33',
get => { ccCapability=> '01', # no more args
ccStatus => '03%02x',
},
set => { # Forum #36050
rgb => '05050000010002%02x03%02x04%02x',
wcrgb => '050500%02x01%02x02%02x03%02x04%02x' },
parse => { "043302(.*)"=> '"ccCapability:$1"',
"043304(..)(.*)"=> '"ccStatus_$1:$2"' } },
ZIP_ADV_CLIENT => { id => '34' },
METER_PULSE => { id => '35' },
BASIC_TARIFF_INFO => { id => '36' },
HRV_STATUS => { id => '37',
get => { hrvStatus => "01%02x",
hrvStatusSupported => "03" },
parse => { "0637020042(....)" =>
'sprintf("outdoorTemperature: %0.1f C", s2Hex($1)/100)',
"0637020142(....)" =>
'sprintf("supplyAirTemperature: %0.1f C", s2Hex($1)/100)',
"0637020242(....)" =>
'sprintf("exhaustAirTemperature: %0.1f C", s2Hex($1)/100)',
"0637020342(....)" =>
'sprintf("dischargeAirTemperature: %0.1f C",s2Hex($1)/100)',
"0637020442(....)" =>
'sprintf("indoorTemperature: %0.1f C", s2Hex($1)/100)',
"0537020501(..)" =>
'sprintf("indoorHumidity: %s %%", hex($1))',
"0537020601(..)" =>
'sprintf("remainingFilterLife: %s %%", hex($1))',
"033704(..)" =>
'sprintf("supportedStatus: %s", ZWave_HrvStatus($1))',
} },
THERMOSTAT_HEATING => { id => '38' },
HRV_CONTROL => { id => '39',
set => { bypassOff => "0400",
bypassOn => "04FF",
ventilationRate => "07%02x" },
get => { bypass => "05",
ventilationRate => "08" },
parse => { "033906(..)"=> '($1 eq "00" ? "bypass:off" : '.
'($1 eq "ff" ? "bypass:on" : '.
'"bypass:dim ".hex($1)))',
"033909(..)"=> 'sprintf("ventilationRate: %s",hex($1))' } },
DCP_CONFIG => { id => '3a' },
DCP_MONITOR => { id => '3b' },
METER_TBL_CONFIG => { id => '3c' },
METER_TBL_MONITOR => { id => '3d' },
METER_TBL_PUSH => { id => '3e' },
PREPAYMENT => { id => '3f' },
THERMOSTAT_MODE => { id => '40',
set => { tmOff => "0100",
tmHeating => "0101",
tmCooling => "010b",
tmManual => "011f" },
get => { thermostatMode => "02" },
parse => { "03400300" => "state:off",
"0340030b" => "state:cooling",
"03400301" => "state:heating",
"0340031f" => "state:manual",
"03400100" => "state:setTmOff",
"03400101" => "state:setTmHeating",
"0340010b" => "state:setTmCooling",
"0340011f" => "state:setTmManual",
} } ,
PREPAYMENT_ENCAPSULATION => { id => '41' },
THERMOSTAT_OPERATING_STATE=>{ id => '42' },
THERMOSTAT_SETPOINT => { id => '43',
set => { setpointHeating => "010101%02x",
setpointCooling => "010201%02x"},
get => { setpoint => "02" },
parse => { "064303(..)(..)(....)" => 'sprintf("setpointTemp:%0.1f %s %s", '.
'hex($3)/(10**int(hex($2)/32)), '.
'hex($2)&8 ? "F":"C", hex($1)==1 ? "heating":"cooling")' } },
THERMOSTAT_FAN_MODE => { id => '44' },
THERMOSTAT_FAN_STATE => { id => '45' },
CLIMATE_CONTROL_SCHEDULE => { id => '46',
set => { ccs => 'ZWave_ccsSet("%s")' },
get => { ccs => 'ZWave_ccsGet("%s")',
ccsChanged => "04",
ccsOverride => "07" },
parse => { "..46(..)(.*)" => 'ZWave_ccsParse($1,$2)' }},
THERMOSTAT_SETBACK => { id => '47' },
RATE_TBL_CONFIG => { id => '48' },
RATE_TBL_MONITOR => { id => '49' },
TARIFF_CONFIG => { id => '4a' },
TARIFF_TBL_MONITOR => { id => '4b' },
DOOR_LOCK_LOGGING => { id => '4c' },
NETWORK_MANAGEMANT_BASIC => { id => '4d' },
SCHEDULE_ENTRY_LOCK => { id => '4e' },
ZI_6LOWPAN => { id => '4f' },
BASIC_WINDOW_COVERING => { id => '50',
set => { coveringClose => "0140",
coveringOpen => "0100",
coveringStop => "02" },
parse => { "03500140" => "covering:close",
"03500100" => "covering:open",
"03500200" => "covering:stop",
"03500240" => "covering:stop" } },
MTP_WINDOW_COVERING => { id => '51' },
NETWORK_MANAGEMENT_PROXY => { id => '52' },
NETWORK_SCHEDULE => { id => '53' },
NETWORK_MANAGEMENT_PRIMARY=>{ id => '54' },
TRANSPORT_SERVICE => { id => '55' },
CRC_16_ENCAP => { id => '56' }, # Parse is handled in the code
APPLICATION_CAPABILITY => { id => '57' },
ZIP_ND => { id => '58' },
ASSOCIATION_GRP_INFO => { id => '59',
get => { associationGroupName => "01%02x",
associationGroupCmdList => "0500%02x" },
parse => { "..5902(..)(.*)"=> '"assocGroupName_$1:".pack("H*", $2)',
"..5906(..)..(.*)"=> '"assocGroupCmdList_$1:".$2' } },
DEVICE_RESET_LOCALLY => { id => '5a',
parse => { "025a01" => "deviceResetLocally:yes" } },
CENTRAL_SCENE => { id => '5b',
parse => { "055b03..00(..)" => '"cSceneSet:".hex($1)',
"055b03..01(..)" => '"cSceneDimEnd:".hex($1)',
"055b03..02(..)" => '"cSceneDim:".hex($1)',
"055b03..03(..)" => '"cSceneDouble:".hex($1)'} },
IP_ASSOCIATION => { id => '5c' },
ANTITHEFT => { id => '5d' },
ZWAVEPLUS_INFO => { id => '5e',
get => { zwavePlusInfo=>"01"},
parse => { "095e02(..)(..)(..)(....)(....)"
=> 'ZWave_plusInfoParse($1,$2,$3,$4,$5)'} },
ZIP_GATEWAY => { id => '5f' },
MULTI_CHANNEL => { id => '60', # Version 2, aka MULTI_INSTANCE
get => { mcEndpoints => "07",
mcCapability=> "09%02x"},
parse => { "^046008(..)(..)" => '"mcEndpoints:total ".hex($2).'.
'(hex($1)&0x80 ? ", dynamic":"").'.
'(hex($1)&0x40 ? ", identical":", different")',
"^..600a(.*)"=> 'ZWave_mcCapability($hash, $1)' } },
ZIP_PORTAL => { id => '61' },
DOOR_LOCK => { id => '62',
get => { doorLockOperation => '02',
doorLockConfiguration => '05'},
parse => { "..6203(.*)" => 'ZWave_DoorLockOperationReport($hash, $1)',
"..6206(.*)" => 'ZWave_DoorLockConfigReport($hash, $1)'} },
USER_CODE => { id => '63',
set => { userCode => 'ZWave_userCodeSet("%s")' },
get => { userCode => "02%02x" },
parse => { "^..6303(..)(..)(.*)" =>
'sprintf("userCode:id %d status %d code %s", $1, $2, $3)' }
},
APPLIANCE => { id => '64' },
DMX => { id => '65' },
BARRIER_OPERATOR => { id => '66' },
CONFIGURATION => { id => '70',
set => { configDefault=>"04%02x80",
configByte => "04%02x01%02x",
configWord => "04%02x02%04x",
configLong => "04%02x04%08x",
configRequestAll => 'ZWave_configRequestAll($hash)' },
get => { config => "05%02x" },
parse => { "^..70..(..)(..)(.*)" => 'ZWave_configParse($hash,$1,$2,$3)'} },
ALARM => { id => '71',
get => { alarm => "04%02x" },
parse => { "..7105(..)(..)(.*)" => 'ZWave_alarmParse($1,$2,$3)'} },
MANUFACTURER_SPECIFIC => { id => '72',
get => { model => "04" },
parse => { "087205(....)(....)(....)" =>'ZWave_mfsParse($hash,$1,$2,$3,0)',
"087205(....)(....)(.{4})" =>'ZWave_mfsParse($hash,$1,$2,$3,1)',
"087205(....)(.{4})(.{4})" =>'ZWave_mfsParse($hash,$1,$2,$3,2)'},
init => { ORDER=>49, CMD => '"get $NAME model"' } },
POWERLEVEL => { id => '73',
set => { powerlevel => "01%02x%02x",
powerlevelTest => "04%02x%02x%04x" },
get => { powerlevel => "02",
powerlevelTest => "05" },
parse => { "047303(..)(..)" =>
'"powerlvl:current ".hex($1)." remain ".hex($2)',
"067306(..)(..)(....)" =>
'"powerlvlTest:node ".hex($1)." status ".hex($2).
" frameAck ".hex($3)',} },
PROTECTION => { id => '75',
set => { protectionOff => "0100",
protectionSeq => "0101",
protectionOn => "0102",
protectionBytes => "01%02x%02x" },
get => { protection => "02" },
parse => { "03750300" => "protection:off",
"03750301" => "protection:seq",
"03750302" => "protection:on",
"047503(..)(..)" => 'ZWave_protectionParse($1, $2)'} },
LOCK => { id => '76' },
NODE_NAMING => { id => '77',
set => { name => '(undef, "0100".unpack("H*", "%s"))',
location => '(undef, "0400".unpack("H*", "%s"))' },
get => { name => '02',
location => '05' },
parse => { '..770300(.*)' => '"name:".pack("H*", $1)',
'..770600(.*)' => '"location:".pack("H*", $1)' } },
FIRMWARE_UPDATE_MD => { id => '7a' },
GROUPING_NAME => { id => '7b' },
REMOTE_ASSOCIATION_ACTIVATE=>{id => '7c' },
REMOTE_ASSOCIATION => { id => '7d' },
BATTERY => { id => '80',
get => { battery => "02" },
parse => { "038003(..)"=> '"battery:".($1 eq "ff" ? "low":hex($1)." %")'} },
CLOCK => { id => '81',
get => { clock => "05" },
set => { clock => 'ZWave_clockSet()' },
parse => { "028105" => "clock:get",
"048106(..)(..)"=> 'ZWave_clockParse($1,$2)' }},
HAIL => { id => '82',
parse => { "028201" => "hail:01"}},
WAKE_UP => { id => '84',
set => { wakeupInterval => "04%06x%02x",
wakeupNoMoreInformation => "08" },
get => { wakeupInterval => "05",
wakeupIntervalCapabilities => "09" },
parse => { "028407" => 'wakeup:notification',
"..8406(......)(..)" =>
'"wakeupReport:interval ".hex($1)." target ".hex($2)',
"..840a(......)(......)(......)(......)" =>
'"wakeupIntervalCapabilitiesReport:min ".hex($1).'.
'" max ".hex($2)." default ".hex($3)." step ".hex($4)'
} },
ASSOCIATION => { id => '85',
set => { associationAdd => "01%02x%02x*",
associationDel => "04%02x%02x*",
associationRequest => "02%02x",
associationRequestAll => 'ZWave_associationRequest($hash,"")' },
get => { association => "02%02x",
associationGroups => "05" },
parse => { "..8503(..)(..)..(.*)" =>
'sprintf("assocGroup_%d:Max %d Nodes %d", hex($1), hex($2), hex($3))',
"..8506(..)" => '"assocGroups:".hex($1)' },
init => { ORDER=>10, CMD=> '"set $NAME associationAdd 1 $CTRLID"' } },
VERSION => { id => '86',
set => { versionClassRequest => 'ZWave_versionClassRequest($hash,"%s")'},
get => { version => "11",
versionClass => 'ZWave_versionClassGet("%s")' },
parse => { "078612(..........)" => 'sprintf("version:Lib %d Prot '.
'%d.%d App %d.%d", unpack("C*",pack("H*","$1")))',
"098612(..............)" => 'sprintf("version:Lib %d Prot '.
'%d.%d App %d.%d HW %d FWCounter %d",'.
'unpack("C*",pack("H*","$1")))',
"0b8612(..................)" => 'sprintf("version:Lib %d Prot '.
'%d.%d App %d.%d HW %d FWCounter %d FW %d.%d",'.
'unpack("C*",pack("H*","$1")))',
"048614(..)(..)" => '"versionClass_$1:$2"' } },
INDICATOR => { id => '87',
set => { indicatorOff => "0100",
indicatorOn => "01FF",
indicatorDim => "01%02x" },
get => { indicatorStatus => "02", },
parse => { "038703(..)" => '($1 eq "00" ? "indState:off" :
($1 eq "ff" ? "indState:on" :
"indState:dim ".hex($1)))'} },
PROPRIETARY => { id => '88' },
LANGUAGE => { id => '89' },
TIME => { id => '8a' },
TIME_PARAMETERS => { id => '8b' },
GEOGRAPHIC_LOCATION => { id => '8c' },
COMPOSITE => { id => '8d' },
MULTI_CHANNEL_ASSOCIATION=> { id => '8e', # aka MULTI_INSTANCE_ASSOCIATION
set => { mcaAdd => "01%02x%02x*",
mcaDel => "04%02x*" },
get => { mca => "02%02x",
mcaGroupings=> "05" },
parse => { "..8e03(..)(..)(.*)"
=> '"mca_$1:max:$2 param:$3"',
"..8e06(.*)"=> '"mcaSupportedGroupings:".hex($1)' } },
MULTI_CMD => { id => '8f' }, # Handled in Parse
ENERGY_PRODUCTION => { id => '90' },
MANUFACTURER_PROPRIETARY => { id => '91' }, # see also zwave_deviceSpecial
SCREEN_MD => { id => '92' },
SCREEN_ATTRIBUTES => { id => '93' },
SIMPLE_AV_CONTROL => { id => '94' },
AV_CONTENT_DIRECTORY_MD => { id => '95' },
AV_RENDERER_STATUS => { id => '96' },
AV_CONTENT_SEARCH_MD => { id => '97' },
SECURITY => { id => '98',
set => { "secScheme" => 'ZWave_sec($hash, "0400")',
"sendNonce" => 'ZWave_secCreateNonce($hash)',
"secEncap" => 'ZWave_sec($hash, "%s")' },
get => { "secSupported" => 'ZWave_sec($hash, "02")' ,
"secNonce" => 'ZWave_sec($hash, "40")'},
parse => { "..9803(.*)" => 'ZWave_secSupported($hash, $1)',
"..9805(.*)" => 'ZWave_secInit($hash, $1)', # secScheme
"..9807" => 'ZWave_secNetWorkKeyVerify($hash)',
"..9840" => 'ZWave_secNonceRequestReceived($hash)',
"..9880(.*)" => 'ZWave_secNonceReceived($hash, $1)',
"..9881(.*)" => 'ZWave_secDecrypt($hash, $1, 0)',
"..98c1(.*)" => 'ZWave_secDecrypt($hash, $1, 1)' } },
AV_TAGGING_MD => { id => '99' },
IP_CONFIGURATION => { id => '9a' },
ASSOCIATION_COMMAND_CONFIGURATION
=> { id => '9b' },
SENSOR_ALARM => { id => '9c',
get => { alarm => "01%02x" },
parse => { "..9c02(..)(..)(..)(....)" =>
'"alarm_type_$2:level $3 node $1 seconds ".hex($4)'} },
SILENCE_ALARM => { id => '9d' },
SENSOR_CONFIGURATION => { id => '9e' },
MARK => { id => 'ef' },
NON_INTEROPERABLE => { id => 'f0' },
);
my %zwave_quietCmds = (
secScheme=>1,
sendNonce=>1,
secEncap=>1,
secNonce=>1
);
my %zwave_cmdArgs = (
set => {
dim => "slider,0,1,99",
indicatorDim => "slider,0,1,99",
rgb => "colorpicker,RGB",
},
get => {
},
parse => {
}
);
my %zwave_parseHook; # nodeId:regexp => fn, used by assocRequest
my %zwave_modelConfig;
my %zwave_modelIdAlias = ( "010f-0301-1001" => "Fibaro_FGRM222",
"0115-0100-0102" => "ZME_KFOB" );
# Patching certain devices.
use vars qw(%zwave_deviceSpecial);
%zwave_deviceSpecial = (
Fibaro_FGRM222 => {
MANUFACTURER_PROPRIETARY => {
set => { positionSlat=>"010f26010100%02x",
positionBlinds=>"010f260102%02x00"},
get => { position=>"010f2602020000", },
parse => { "0891010f260303(..)(..)" =>
'sprintf("position:Blind %d Slat %d",hex($1),hex($2))',
"0891010f260302(..)00" =>'"position:".hex($1)' } } },
ZME_KFOB => {
ZWAVEPLUS_INFO => {
# Example only. ORDER must be >= 50
init => { ORDER=>50, CMD => '"get $NAME zwavePlusInfo"' } } }
);
my $zwave_cryptRijndael = 0;
my $zwave_lastHashSent;
my %zwave_pepperLink;
my %zwave_pepperImg;
sub
ZWave_Initialize($)
{
my ($hash) = @_;
$hash->{Match} = ".*";
$hash->{SetFn} = "ZWave_Set";
$hash->{GetFn} = "ZWave_Get";
$hash->{DefFn} = "ZWave_Define";
$hash->{UndefFn} = "ZWave_Undef";
$hash->{ParseFn} = "ZWave_Parse";
$hash->{AttrList} = "IODev do_not_notify:1,0 noExplorerFrames:1,0 ".
"ignore:1,0 dummy:1,0 showtime:1,0 classes vclasses ".
"secure_classes WNMI_delay $readingFnAttributes";
map { $zwave_id2class{lc($zwave_class{$_}{id})} = $_ } keys %zwave_class;
$hash->{FW_detailFn} = "ZWave_fhemwebFn";
eval { require Crypt::Rijndael; };
if($@) {
Log 3, "ZWave: cannot load Crypt::Rijndael, SECURITY class disabled";
} else {
$zwave_cryptRijndael = 1;
}
################
# Read in the pepper translation table
my $fn = $attr{global}{modpath}."/FHEM/lib/zwave_pepperlinks.csv.gz";
my $gz = gzopen($fn, "rb");
if($gz) {
my $line;
while($gz->gzreadline($line)) {
chomp($line);
my @a = split(",",$line);
$zwave_pepperLink{$a[0]} = $a[1];
$zwave_pepperImg{$a[0]} = $a[2];
}
$gz->gzclose();
} else {
Log 3, "Can't open $fn: $!";
}
# Create cache directory
$fn = $attr{global}{modpath}."/www/deviceimages";
if(! -d $fn) { mkdir($fn) || Log 3, "Can't create $fn"; }
$fn .= "/zwave";
if(! -d $fn) { mkdir($fn) || Log 3, "Can't create $fn"; }
}
#############################
sub
ZWave_Define($$)
{
my ($hash, $def) = @_;
my @a = split("[ \t][ \t]*", $def);
my $name = shift @a;
my $type = shift(@a); # always ZWave
my $u = "wrong syntax for $name: define <name> ZWave homeId id [classes]";
return $u if(int(@a) < 2 || int(@a) > 3);
my $homeId = lc(shift @a);
my $id = shift @a;
return "define $name: wrong homeId ($homeId): need an 8 digit hex value"
if( ($homeId !~ m/^[a-f0-9]{8}$/i) );
return "define $name: wrong id ($id): need a number"
if( ($id !~ m/^\d+$/i) );
$id = sprintf("%0*x", ($id > 255 ? 4 : 2), $id);
$hash->{homeId} = $homeId;
$hash->{nodeIdHex} = $id;
$modules{ZWave}{defptr}{"$homeId $id"} = $hash;
my $proposed;
if($init_done) { # Use the right device while inclusion is running
for my $p (devspec2array("TYPE=ZWDongle|FHEM2FHEM")) {
$proposed = $p if($defs{$p}{homeId} && $defs{$p}{homeId} eq $homeId);
}
}
AssignIoPort($hash, $proposed);
if(@a) { # Autocreate: set the classes, execute the init calls
ZWave_SetClasses($homeId, $id, undef, $a[0]);
}
return undef;
}
sub
ZWave_initFromModelfile($$)
{
my ($name, $ctrlId) = @_;
my @res;
my $cfg = ReadingsVal($name, "modelConfig", "");
return @res if(!$cfg);
ZWave_configParseModel($cfg) if(!$zwave_modelConfig{$cfg});
my $mc = $zwave_modelConfig{$cfg};
return @res if(!$mc);
for my $grp (keys %{$mc->{group}}) {
next if($grp eq '1');
next if($mc->{group}{$grp} !~ m/auto="true"/);
push @res, "set $name associationAdd $grp $ctrlId";
}
return @res;
}
sub
ZWave_doExecInits($)
{
my ($param) = @_;
my $cmdArr = $param->{cmdArr};
my $cmd = shift @{$cmdArr};
my $ret = AnalyzeCommand(undef, $cmd);
Log 1, "ZWAVE INIT: $cmd: $ret" if ($ret);
push(@{$cmdArr}, ZWave_initFromModelfile($1, $param->{ctrlId}))
if($cmd =~ m/^get (.*) model$/);
InternalTimer(gettimeofday()+0.5, "ZWave_doExecInits", $param, 0)
if(@{$cmdArr});
}
sub
ZWave_execInits($$)
{
my ($hash, $min) = @_; # min = 50 for model-specific stuff
my @clList = split(" ", $attr{$hash->{NAME}}{classes});
my (@initList, %seen);
foreach my $cl (@clList) {
next if($seen{$cl});
$seen{$cl} = 1;
my $ptr = ZWave_getHash($hash, $cl, "init");
push @initList, $ptr if($ptr && $ptr->{ORDER} >= $min);
}
my $NAME = $hash->{NAME};
my $iodev = $hash->{IODev};
my $homeReading = ReadingsVal($iodev->{NAME}, "homeId", "") if($iodev);
my $CTRLID = $1 if($homeReading && $homeReading =~ m/CtrlNodeId:(..)/);
my @cmd;
foreach my $i (sort { $a->{ORDER}<=>$b->{ORDER} } @initList) {
push @cmd, eval $i->{CMD};
}
InternalTimer(gettimeofday()+0.5, "ZWave_doExecInits",
{ cmdArr=>\@cmd, ctrlId=>$CTRLID }, 0) if(@cmd);
}
###################################
sub
ZWave_Cmd($$@)
{
my ($type, $hash, @a) = @_;
return "no $type argument specified" if(int(@a) < 2);
my $name = shift(@a);
my $cmd = shift(@a);
# Collect the commands from the distinct classes
my %cmdList;
my $classes = AttrVal($name, "classes", "");
my $cfgReq = ($type eq "set" && $cmd =~ m/^config/ && @a && $a[0] eq "request");
shift(@a) if($cfgReq);
foreach my $cl (split(" ", $classes)) {
my $ptr = ZWave_getHash($hash, $cl, $cfgReq ? "get" : $type);
next if(!$ptr);
foreach my $k (keys %{$ptr}) {
if(!$cmdList{$k}) {
$cmdList{$k}{fmt} = $ptr->{$k};
$cmdList{$k}{id} = $zwave_class{$cl}{id};
}
}
}
if ($cfgReq) {
$type="get";
}
my $id = $hash->{nodeIdHex};
my $isMc = ($id =~ m/(....)/);
if(!$isMc) {
if($type eq "set") {
$cmdList{neighborUpdate}{fmt} = "48$id";
$cmdList{neighborUpdate}{id} = "";
}
if($type eq "get") {
# GET_ROUTING_TABLE_LINE, include dead links, non-routing neigbors
$cmdList{neighborList}{fmt} = "80${id}0101";
$cmdList{neighborList}{id} = "";
$cmdList{neighborList}{regexp} = "^0180";
}
}
if($type eq "set" && $cmd eq "rgb") {
if($a[0] && $a[0] =~ m/^[0-9A-F]+$/i && $a[0] =~ /^(..)(..)(..)$/) {
@a = (hex($1), hex($2), hex($3));
} else {
return "set rgb: a 6-digit hex number is required";
}
}
if(!$cmdList{$cmd}) {
my @list;
foreach my $lcmd (sort keys %cmdList) {
if($zwave_cmdArgs{$type}{$lcmd}) {
push @list, "$lcmd:$zwave_cmdArgs{$type}{$lcmd}";
} elsif($cmdList{$lcmd}{fmt} !~ m/%/) {
push @list, "$lcmd:noArg";
} else {
push @list, $lcmd;
}
}
my $list = join(" ",@list);
if($type eq "set") {
unshift @a, $name, $cmd;
return SetExtensions($hash, $list, @a);
} else {
return "Unknown argument $cmd, choose one of $list";
}
}
################################
# ZW_SEND_DATA,nodeId,CMD,ACK|AUTO_ROUTE
my $cmdFmt = $cmdList{$cmd}{fmt};
my $cmdId = $cmdList{$cmd}{id};
# 0x05=AUTO_ROUTE+ACK, 0x20: ExplorerFrames
my $nArg = 0;
if($cmdFmt =~ m/%/) {
my @ca = split("%", $cmdFmt);
$nArg = int(@ca)-1;
}
my $parTxt = ($nArg == 0 ? "no parameter" :
($nArg == 1 ? "one parameter" :
"$nArg parameters"));
if($cmdFmt =~ m/^(.*)\*$/) {
$cmdFmt = $1;
return "$type $cmd needs at least $parTxt" if($nArg > int(@a));
$cmdFmt .= ("%02x" x (int(@a)-$nArg));
} elsif($cmdFmt =~ m/%s/) { # vararg for functions
$nArg = 0 if(!@a);
@a = (join(" ", @a));
} else {
return "$type $cmd needs $parTxt" if($nArg != int(@a));
}
if($cmdFmt !~ m/%s/ && $cmd !~ m/^config/) {
for(my $i1 = 0; $i1<int(@a); $i1++) {
return "Error: $a[$i1] is not a decimal number"
if($a[$i1] !~ m/^[-\d]+$/);
}
}
if($cmd =~ m/^config/ && $cmd ne "configRequestAll") {
my ($err, $lcmd) =
ZWave_configCheckParam($hash, $cfgReq, $type, $cmd, $cmdFmt, @a);
return $err if($err);
$cmdFmt = $lcmd;
} else {
$cmdFmt = sprintf($cmdFmt, @a) if($nArg);
my ($err, $ncmd) = eval($cmdFmt) if($cmdFmt !~ m/^\d/);
return $err if($err);
$cmdFmt = $ncmd if(defined($ncmd));
return "" if($ncmd && $ncmd eq "EMPTY"); # e.g. configRequestAll
}
Log3 $name, $zwave_quietCmds{$cmd} ? 4 : 2,
"ZWave $type $name $cmd ".join(" ", @a);
my ($baseClasses, $baseHash) = ($classes, $hash);
if($id =~ m/(..)(..)/) { # Multi-Channel, encapsulate
my ($baseId,$ch) = ($1, $2);
$id = $baseId;
$cmdFmt = "0d01$ch$cmdId$cmdFmt";
$cmdId = "60"; # MULTI_CHANNEL
$baseHash = $modules{ZWave}{defptr}{"$hash->{homeId} $baseId"};
$baseClasses = AttrVal($baseHash->{NAME}, "classes", "");
}
my $data;
if($cmd eq "neighborUpdate" ||
$cmd eq "neighborList") {
$data = $cmdFmt;
} else {
my $len = sprintf("%02x", length($cmdFmt)/2+1);
my $cmdEf = (AttrVal($name, "noExplorerFrames", 0) == 0 ? "25" : "05");
$data = "13$id$len$cmdId${cmdFmt}$cmdEf"; # 13==SEND_DATA
$data .= $id; # callback=>id
}
if ($data =~ m/(......)(....)(.*)(....)/) {
my $cc_cmd=$2;
my $payload=$3;
#check message here for needed encryption (SECURITY)
if(ZWave_secIsSecureClass($hash, $cc_cmd)) {
ZWave_secStart($hash);
# message stored in reading, will be processed when nonce arrives
my $cmd2 = "$type $name $cmd ".join(" ", @a);
ZWave_secPutMsg($hash, $cc_cmd . $payload, $cmd2);
return ZWave_Cmd("get", $hash, $name, "secNonce");
}
}
my $r = ZWave_addToSendStack($baseHash, $data);
if($r) {
return (AttrVal($name,"verbose",3) > 2 ? $r : undef);
}
my $val;
if($type eq "get") {
no strict "refs";
my $iohash = $hash->{IODev};
my $fn = $modules{$iohash->{TYPE}}{ReadAnswerFn};
my $re = $cmdList{$cmd}{regexp};
my ($err, $data) = &{$fn}($iohash, $cmd, $re ? $re : "^000400${id}..$cmdId")
if($fn);
use strict "refs";
return $err if($err);
$data = "$cmd $id $data" if($re);
$val = ($data ? ZWave_Parse($iohash, $data, $type) : "no data returned");
ZWave_processSendStack($hash) if($data && $cmd eq "neighborList");
} else {
if(!$zwave_quietCmds{$cmd}) {
$cmd .= " ".join(" ", @a) if(@a);
readingsSingleUpdate($hash, "state", $cmd, 1);
}
}
return $val;
}
sub
ZWave_SCmd($$@)
{
my ($type, $hash, @a) = @_;
if($hash->{secInProgress} && !(@a < 2 || $a[1] eq "?")) {
my %h = ( T => $type, A => \@a );
push @{$hash->{secStack}}, \%h;
return ($type eq "get" ?
"Secure operation in progress, executing in background" : "");
}
return ZWave_Cmd($type, $hash, @a);
}
sub ZWave_Set($@) { return ZWave_SCmd("set", shift, @_); }
sub ZWave_Get($@) { return ZWave_SCmd("get", shift, @_); }
# returns supported Parameters by hrvStatus
sub
ZWave_HrvStatus($)
{
my ($p) = @_;
$p = hex($p);
my @hrv_status = ( "outdoorTemperature", "supplyAirTemperature",
"exhaustAirTemperature", "dischargeAirTemperature",
"indoorTemperature", "indoorHumidity",
"remainingFilterLife" );
my @l;
for(my $i=0; $i < 7; $i++) {
push @l, "$i = $hrv_status[$i]" if($p & (1<<$i));
}
return join("\n", @l);
}
my %zwm_unit = (
energy=> ["kWh", "kVAh", "W", "pulseCount", "V", "A", "PowerFactor"],
gas => ["m3", "feet3", "undef", "pulseCount"],
water => ["m3", "feet3", "USgallons", "pulseCount"]
);
sub
ZWave_meterParse($$)
{
my ($hash,$val) = @_;
return if($val !~ m/^(..)(..)(.*)$/);
my ($v1, $v2, $v3) = (hex($1), hex($2), $3);
my $name = $hash->{NAME};
# rate_type currently not used / not reported
my $rate_type = ($v1 >> 5) & 0x3;
my @rate_type_text =("undef","consumed", "produced");
my $rate_type_text = ($rate_type > $#rate_type_text ?
"undef" : $rate_type_text[$rate_type]);
my $meter_type = ($v1 & 0x1f);
my @meter_type_text =("undef", "energy", "gas", "water", "undef");
my $meter_type_text = ($meter_type > $#meter_type_text ?
"undef" : $meter_type_text[$meter_type]);
my $precision = ($v2 >>5) & 0x7;
# no definition for text or numbers, used as -> (10 ** hex($precision))
# V3 use 3 bit, in V2 there are only 2 bit available
# V3 use bit 7 of first byte as bit 3 of scale
my $scale = ($v2 >> 3) & 0x3;
$scale |= (($v1 & 0x80) >> 5);
my $unit_text = ($meter_type_text eq "undef" ?
"undef" : $zwm_unit{$meter_type_text}[$scale]);
my $size = $v2 & 0x7;
$meter_type_text = "power" if ($unit_text eq "W");
$meter_type_text = "voltage" if ($unit_text eq "V");
$meter_type_text = "current" if ($unit_text eq "A");
my $mv = hex(substr($v3, 0, 2*$size));
$mv = $mv / (10 ** $precision);
$mv -= (2 ** ($size*8)) if $mv >= (2 ** ($size*8-1));
$v3 = substr($v3, 2*$size, length($v3)-(2*$size));
if (length($v3) < 4) { # V1 report
return "$meter_type_text: $mv $unit_text";
} else { # V2 or greater report
my $delta_time = hex(substr($v3, 0, 4));
$v3 = substr($v3, 4, length($v3)-4);
if ($delta_time == 0) { # no previous meter value
return "$meter_type_text: $mv $unit_text";
} else { # previous meter value present
my $pmv = hex(substr($v3, 0, 2*$size));
$pmv = $pmv / (10 ** $precision);
$pmv -= (2 ** ($size*8)) if $pmv >= (2 ** ($size*8-1));
if ($delta_time == 65535) {
$delta_time = "unknown";
} else {
$delta_time .= " s";
};
return "$meter_type_text: $mv $unit_text previous: $pmv delta_time: ".
"$delta_time"; # V2 report
};
};
}
sub
Zwave_meterGet($)
{
my ($scale) = @_;
if ($scale eq "%s") { # no parameter specified, use V1 get without scale
return("", "01");
};
if (($scale < 0) || ($scale > 6)) {
return("argument must be one of: 0 to 6","");
} else {
$scale = $scale << 3;
return("",sprintf('01%02x', $scale));
};
}
sub
ZWave_meterSupportedParse($$)
{
my ($hash,$val) = @_;
return if($val !~ m/^(..)(..)$/);
my ($v1, $v2) = (hex($1), hex($2));
my $name = $hash->{NAME};
my $meter_reset = $v1 & 0x80;
my $meter_reset_text = $meter_reset ? "yes" : "no";
my $meter_type = ($v1 & 0x1f);
my @meter_type_text =("undef", "energy", "gas", "water", "undef");
my $meter_type_text = ($meter_type > $#meter_type_text ?
"undef" : $meter_type_text[$meter_type]);
my $scale = $v2 & 0x7f;
my $unit_text="";
for (my $i=0; $i <= 6; $i++) {
if ($scale & 2**$i) {
$unit_text .= ", " if (length($unit_text)>0);
$unit_text .= $i.":".$zwm_unit{$meter_type_text}[$i];
};
};
return "meterSupported: type: $meter_type_text scales: $unit_text resetable:".
" $meter_reset_text";
}
sub
ZWave_versionClassRequest($$)
{
my ($hash, $answer) = @_;
my $name = $hash->{NAME};
if($answer =~ m/^048614(..)(..)$/i) { # Parse part
my $v = $hash->{versionhash};
$v->{$zwave_id2class{lc($1)}} = $2;
foreach my $class (keys %{$v}) {
next if($v->{$class} ne "");
my $r = ZWave_Set($hash, $name, "versionClassRequest", $class);
return;
}
$attr{$hash->{NAME}}{vclasses} =
join(" ", map { "$_:$v->{$_}" } sort keys %{$v});
delete($hash->{versionhash});
}
if($answer ne "%s" && $hash->{versionhash}) { # get next
return("", sprintf('13%02x', hex($zwave_class{$answer}{id})))
if($zwave_class{$answer});
return("versionClassRequest needs no parameter", "");
}
return("versionClassRequest needs no parameter", "")
if($answer ne "%s" && !$hash->{versionhash});
return("another versionClassRequest is already running", "")
if(defined($hash->{versionhash}));
# User part: called with no parameters
my %h = map { $_ => "" }
grep { $_ !~ m/^MARK$/ && $_ !~ m/^UNKNOWN/ }
split(" ", AttrVal($name, "classes", ""));
$hash->{versionhash} = \%h;
foreach my $class (keys %h) {
next if($h{$class} ne "");
return("", sprintf('13%02x', hex($zwave_class{$class}{id})));
}
return("Should not happen", "");
}
sub
ZWave_versionClassGet($)
{
my ($class) = @_;
return("", sprintf('13%02x', $class))
if($class =~ m/\d+/);
return("", sprintf('13%02x', hex($zwave_class{$class}{id})))
if($zwave_class{$class});
return ("versionClass needs a class as parameter", "") if($class eq "%s");
return ("Unknown class $class", "");
}
sub
ZWave_multilevelParse($$$)
{
my ($type,$fl,$arg) = @_;
my %ml_tbl = (
'01' => { n => 'temperature', st => ['C', 'F'] },
'02' => { n => 'generalPurpose', st => ['%', ''] },
'03' => { n => 'luminance', st => ['%', 'Lux'] },
'04' => { n => 'power', st => ['W', 'Btu/h'] },
'05' => { n => 'humidity', st => ['%'] },
'06' => { n => 'velocity', st => ['m/s', 'mph'] },
'07' => { n => 'direction', st => [] },
'08' => { n => 'atmosphericPressure', st => ['kPa', 'inchHg'] },
'09' => { n => 'barometricPressure', st => ['kPa', 'inchHg'] },
'0a' => { n => 'solarRadiation', st => ['W/m2'] },
'0b' => { n => 'dewpoint', st => ['C', 'F'] },
'0c' => { n => 'rain', st => ['mm/h', 'in/h'] },
'0d' => { n => 'tideLevel', st => ['m', 'feet'] },
'0e' => { n => 'weight', st => ['kg', 'pound'] },
'0f' => { n => 'voltage', st => ['V', 'mV'] },
'10' => { n => 'current', st => ['A', 'mA'] },
'11' => { n => 'CO2-level', st => ['ppm']},
'12' => { n => 'airFlow', st => ['m3/h', 'cfm'] },
'13' => { n => 'tankCapacity', st => ['l', 'cbm', 'usgal'] },
'14' => { n => 'distance', st => ['m', 'cm', 'feet'] },
'15' => { n => 'anglePosition', st => ['%', 'relN', 'relS'] },
'16' => { n => 'rotation', st => ['rpm', 'Hz'] },
'17' => { n => 'waterTemperature', st => ['C', 'F'] },
'18' => { n => 'soilTemperature', st => ['C', 'F'] },
'19' => { n => 'seismicIntensity', st => ['mercalli', 'EU macroseismic',
'liedu', 'shindo'] },
'1a' => { n => 'seismicMagnitude', st => ['local', 'moment',
'surface wave', 'body wave'] },
'1b' => { n => 'ultraviolet', st => ['UV'] },
'1c' => { n => 'electricalResistivity',st => ['ohm'] },
'1d' => { n => 'electricalConductivity',st => ['siemens/m'] },
'1e' => { n => 'loudness', st => ['dB', 'dBA'] },
'1f' => { n => 'moisture', st => ['%', 'content', 'k ohms',
'water activity'] },
'20' => { n => 'frequency', st => ['Hz', 'kHz'] },
'21' => { n => 'time', st => ['seconds'] },
'22' => { n => 'targetTemperature', st => ['C', 'F'] },
'23' => { n => 'particulateMatter', st => ['mol/m3', 'micro-g/m3'] },
'24' => { n => 'formaldehydeLevel', st => ['mol/m3'] },
'25' => { n => 'radonConcentration', st => ['bq/m3', 'pCi/L'] },
'26' => { n => 'methaneDensity', st => ['mol/m3'] },
'27' => { n => 'volatileOrganicCompound',st => ['mol/m3'] },
'28' => { n => 'carbonMonoxide', st => ['mol/m3'] },
'29' => { n => 'soilHumidity', st => ['%'] },
'2a' => { n => 'soilReactivity', st => ['pH'] },
'2b' => { n => 'soilSalinity', st => ['mol/m3'] },
'2c' => { n => 'heartRate', st => ['Bpm'] },
'2d' => { n => 'bloodPressure', st => ['Systolic mmHg',
'Diastolic mmHg'] },
'2e' => { n => 'muscleMass', st => ['Kg'] },
'2f' => { n => 'fatMass', st => ['Kg'] },
'30' => { n => 'boneMass', st => ['Kg'] },
'31' => { n => 'totalBodyWater', st => ['Kg'] },
'32' => { n => 'basicMetabolicRate', st => ['J'] },
'33' => { n => 'bodyMassIndex', st => ['BMI'] },
);
my $pr = (hex($fl)>>5)&0x07; # precision
my $sc = (hex($fl)>>3)&0x03; # scale
my $bc = (hex($fl)>>0)&0x07; # bytecount
$arg = substr($arg, 0, 2*$bc);
my $msb = (hex($arg)>>8*$bc-1); # most significant bit ( 0 = pos, 1 = neg )
my $val = $msb ? -( 2 ** (8 * $bc) - hex($arg) ) : hex($arg); # 2's complement
my $ml = $ml_tbl{$type};
return "UNKNOWN multilevel type: $type fl: $fl arg: $arg" if(!$ml);
return sprintf("%s:%.*f %s", $ml->{n}, $pr, $val/(10**$pr),
int(@{$ml->{st}}) > $sc ? $ml->{st}->[$sc] : "");
}
sub
ZWave_DoorLockOperationReport($$)
{
my ($hash, $arg) = @_;
my $name = $hash->{NAME};
Log3 $name, 0, "$name: DoorLockOperationReport received: $arg";
if ($arg !~ m/(..)(..)(..)(..)(..)/) {
Log3 $name, 0, "$name: DoorLockOperationReport wrong format received";
}
my $DoorLockMode = $1;
my $DoorLockHandleModes = hex($2);
my $DoorCondition = hex($3);
my $DoorLockTimeoutMinutes = hex($4);
my $DoorLockTimeoutSeconds = hex($5);
my $dlm ="Door is ";
if ($DoorLockMode eq '00') {
$dlm .= "unsecured";
} elsif ($DoorLockMode eq '01') {
$dlm .= "unsecured with timeout";
} elsif ($DoorLockMode eq '10') {
$dlm .= "unsecured for inside door handles";
} elsif ($DoorLockMode eq '11') {
$dlm .= "unsecured for inside door handles with timeout";
} elsif ($DoorLockMode eq '20') {
$dlm .= "unsecured for outside door handles";
} elsif ($DoorLockMode eq '21') {
$dlm .= "unsecured for outside door handles with timeout";
} elsif ($DoorLockMode eq 'ff') {
$dlm .= "secured";
}
Log3 $name, 0, "$name: DoorLockOperationReport DoorLockMode = $dlm";
my $odlhm = sprintf ("%04b", ($DoorLockHandleModes & 0xf0)>>4);
my $idlhm = sprintf ("%04b", ($DoorLockHandleModes & 0x0f));
Log3 $name, 0, "$name: DoorLockOperationReport OutsideDoorHandles: $odlhm,".
" InsideDoorHandles: $idlhm";
my $dc_door = 'Door ' . ($DoorCondition & 0x01) ? 'open' : 'closed';
my $dc_bolt = 'Bolt ' . ($DoorCondition & 0x02) ? 'locked' : 'unlocked';
my $dc_latch = 'Latch ' . ($DoorCondition & 0x04) ? 'open' : 'closed';
Log3 $name, 0, "$name: DoorLockOperationReport Door Conditions: $dc_door ".
"$dc_bolt $dc_latch";
if ($DoorLockTimeoutMinutes == 254) {
$DoorLockTimeoutMinutes = 'not_supported';
}
if ($DoorLockTimeoutSeconds == 254) {
$DoorLockTimeoutSeconds = 'not_supported';
}
my $to = 'Timeout ' . ' min=' . $DoorLockTimeoutMinutes . ' sec=' .
$DoorLockTimeoutSeconds;
Log3 $name, 0, "$name: DoorLockOperationReport $to";
return "DoorLockOperation: $arg $dlm outsidehandles $odlhm insidehandles ".
"$idlhm $dc_door $dc_bolt $dc_latch $to";
}
sub
ZWave_DoorLockConfigReport($$)
{
my ($hash, $arg) = @_;
my $name = $hash->{NAME};
Log3 $name, 5, "$name: DoorLockConfigurationReport received: $arg";
if ($arg !~ m/(..)(..)(..)(..)/) {
Log3 $name, 0, "$name: DoorLockOperationReport wrong format received";
}
my $OperationMode = $1;
my $DoorLockHandleStates = hex($2);
my $DoorLockTimeoutMinutes = hex($3);
my $DoorLockTimeoutSeconds = hex($4);
my $ot ='';
if ($OperationMode eq '01') {
$ot = "Constant ";
} elsif ($OperationMode eq '02') {
$ot = "Timed";
}
$ot .= ' operation';
Log3 $name, 0, "$name: DoorLockConfigurationReport $ot";
my $odlhs = sprintf ("%04b", ($DoorLockHandleStates & 0xf0)>>4);
my $idlhs = sprintf ("%04b", ($DoorLockHandleStates & 0x0f));
Log3 $name, 0, "$name: DoorLockOperationReport OutsideDoorHandles: $odlhs, ".
"InsideDoorHandles: $idlhs";
if ($DoorLockTimeoutMinutes == 254) {
$DoorLockTimeoutMinutes = 'not_supported';
}
if ($DoorLockTimeoutSeconds == 254) {
$DoorLockTimeoutSeconds = 'not_supported';
}
my $to = 'Timeout ' . ' min=' . $DoorLockTimeoutMinutes . ' sec=' .
$DoorLockTimeoutSeconds;
Log3 $name, 0, "$name: DoorLockOperationReport $to";
return "DoorLockConfiguration: $arg $ot outsidehandles $odlhs ".
"insidehandles $idlhs $to";
}
sub
ZWave_SetClasses($$$$)
{
my ($homeId, $id, $type6, $classes) = @_;
my $def = $modules{ZWave}{defptr}{"$homeId $id"};
if(!$def) {
$type6 = $zw_type6{$type6} if($type6 && $zw_type6{$type6});
$id = hex($id);
return "UNDEFINED ZWave_${type6}_$id ZWave $homeId $id $classes"
}
my @classes;
for my $classId (grep /../, split(/(..)/, lc($classes))) {
push @classes, $zwave_id2class{lc($classId)} ?
$zwave_id2class{lc($classId)} : "UNKNOWN_".lc($classId);
}
my $name = $def->{NAME};
$attr{$name}{classes} = join(" ", @classes)
if(@classes && !$attr{$name}{classes});
$def->{DEF} = "$homeId ".hex($id);
return "";
}
sub
ZWave_sceneParse($)
{
my ($p)=@_;
my @arg = ("unknown", "on", "off",
"dim up start", "dim down start", "dim up end", "dim down end");
return sprintf("sceneEvent%s:%s", int(hex($p)/10), $arg[hex($p)%10]);
}
sub
ZWave_mcCapability($$)
{
my ($hash, $caps) = @_;
#Caps:= channelId,genericDeviceClass,specificDeviceClass,Class1,Class2,...
my $name = $hash->{NAME};
my $iodev = $hash->{IODev};
return "Missing IODev for $name" if(!$iodev);
my $homeId = $iodev->{homeId};
my @l = grep /../, split(/(..)/, lc($caps));
my $chid = shift(@l);
my $id = $hash->{nodeIdHex};
my @classes;
shift(@l); shift(@l); # Skip generic and specific class
for my $classId (@l) {
push @classes, $zwave_id2class{lc($classId)} ?
$zwave_id2class{lc($classId)} : "UNKNOWN_".uc($classId);
}
return "mcCapability_$chid:no classes" if(!@classes);
if(!$modules{ZWave}{defptr}{"$homeId $id$chid"}) {
my $lid = hex("$id$chid");
my $lcaps = substr($caps, 6);
$id = hex($id);
DoTrigger("global",
"UNDEFINED ZWave_$classes[0]_$id.$chid ZWave $homeId $lid $lcaps",
1);
}
return "mcCapability_$chid:".join(" ", @classes);
}
sub
ZWave_mfsAddClasses($$)
{
my ($hash, $cfgFile) = @_;
my $name = $hash->{NAME};
my $attr = $attr{$name}{classes};
return if(!$cfgFile || !$attr);
my $changed;
ZWave_configParseModel($cfgFile);
my $ci = $zwave_modelConfig{$cfgFile}{classInfo};
foreach my $id (keys %{$ci}) {
my $v = $ci->{$id};
if($v =~ m/setasreport="true"/ || $v =~ m/action="add"/) {
$id = sprintf("%02x", $id);
my $cn = $zwave_id2class{$id};
next if($attr =~ m/$cn/);
$attr .= " $cn";
$changed = 1;
}
}
return if(!$changed);
addStructChange("attr", $name, "$name classes $attr");
$attr{$name}{classes} = $attr;
}
sub
ZWave_mfsParse($$$$$)
{
my ($hash, $mf, $prod, $id, $config) = @_;
if($config == 2) {
setReadingsVal($hash, "modelId", "$mf-$prod-$id", TimeNow());
ZWave_execInits($hash, 50);
return "modelId:$mf-$prod-$id";
}
my $xml = $attr{global}{modpath}.
"/FHEM/lib/openzwave_manufacturer_specific.xml";
($mf, $prod, $id) = (lc($mf), lc($prod), lc($id)); # Just to make it sure
if(open(FH, $xml)) {
my ($lastMf, $mName, $ret) = ("","");
while(my $l = <FH>) {
if($l =~ m/<Manufacturer.*id="([^"]*)".*name="([^"]*)"/) {
$lastMf = lc($1);
$mName = $2;
next;
}
if($l =~ m/<Product type\s*=\s*"([^"]*)".*id\s*=\s*"([^"]*)".*name\s*=\s*"([^"]*)"/) {
if($mf eq $lastMf && $prod eq lc($1) && $id eq lc($2)) {
if($config) {
$ret = "modelConfig:".
(($l =~ m/config\s*=\s*"([^"]*)"/) ? $1 : "unknown");
ZWave_mfsAddClasses($hash, $1);
return $ret;
} else {
$ret = "model:$mName $3";
}
last;
}
}
}
close(FH);
return $ret if($ret);
} else {
Log 1, "can't open $xml: $!";
}
return sprintf("model:0x%s 0x%s 0x%s", $mf, $prod, $id);
}
my @zwave_wd = ("none","mon","tue","wed","thu","fri","sat","sun");
sub
ZWave_ccsSet($)
{
my ($spec) = @_;
my @arg = split(/[ ,]/, $spec);
my $usage = "wrong arg, need: <weekday> HH:MM relTemp HH:MM relTemp ...";
return ($usage,"") if(@arg < 3 || int(@arg) > 19 || (int(@arg)-1)%2 != 0);
my $wds = shift(@arg);
my $ret;
map { $ret=sprintf("%02x",$_) if($zwave_wd[$_] eq $wds) }(1..int($#zwave_wd));
return ("Unknown weekday $wds, use one of ".join(" ", @zwave_wd), "")
if(!defined($ret));
for(my $i=0; $i<@arg; $i+=2) {
return ($usage, "") if($arg[$i] !~ m/^(\d+):(\d\d)$/);
$ret .= sprintf("%02x%02x", $1, $2);
return ($usage, "") if($arg[$i+1] !~ m/^([-.\d]+)$/ || $1 < -12 || $1 > 12);
$ret .= sprintf("%02x", $1 < 0 ? (255+$1*10) : ($1*10));
}
for(my $i=@arg; $i<18; $i+=2) {
$ret .= "00007f";
}
return ("", "01$ret");
}
sub
ZWave_ccsGet($)
{
my ($wds, $wdn) = @_;
$wds = "" if($wds eq "%s"); # No parameter specified
map { $wdn = $_ if($zwave_wd[$_] eq $wds) } (1..int($#zwave_wd));
return ("Unknown weekday $wds, use one of ".join(" ", @zwave_wd), "")
if(!$wdn);
return ("", sprintf("02%02x", $wdn));
}
sub
ZWave_ccsParse($$)
{
my ($t, $p) = @_;
return "ccsChanged:$p" if($t == "05");
if($t == "08" && $p =~ m/^(..)(..)$/) {
my $ret = ($1 eq "00" ? "no" : ($1 eq "01" ? "temporary" : "permanent"));
$ret .= ", ". ($2 eq "79" ? "frost protection" :
($2 eq "7a" ? "energy saving" : "unused"));
return "ccsOverride:$ret";
}
if($t == "03") {
$p =~ /^(..)(.*$)/;
my $n = "ccs_".$zwave_wd[hex($1)];
$p = $2;
my @v;
while($p =~ m/^(..)(..)(..)(.*)$/) {
last if($3 eq "7f"); # unused
$p = $4;
my $t = hex($3);
$t = ($t == 0x7a ? "energySave" : $t >= 0x80 ? -(255-$t)/10 : $t/10);
push @v, sprintf("%02d:%02d %0.1f", hex($1), hex($2), $t);
}
return "$n:".(@v ? join(" ",@v) : "N/A");
}
return "ccs: UNKNOWN $t$p";
}
sub
ZWave_userCodeSet($)
{
my ($spec) = @_;
my @arg = split(" ", $spec);
return ("wrong arg, need: id status usercode","")
if(@arg != 3 || $spec !~ m/^[A-F0-9 ]*$/i);
return ("", sprintf("01%02x%02x%s", $arg[0],$arg[1],$arg[2]));
}
sub
ZWave_clockAdjust($$)
{
my ($hash, $d) = @_;
return $d if($d !~ m/^13(..)048104....$/);
my ($err, $nd) = ZWave_clockSet();
my $cmdEf = (AttrVal($hash->{NAME},"noExplorerFrames",0) == 0 ? "25" : "05");
return "13${1}0481${nd}${cmdEf}${1}";
}
sub
ZWave_clockSet()
{
my @l = localtime();
return ("", sprintf("04%02x%02x", ($l[6]<<5)|$l[2], $l[1]));
}
sub
ZWave_clockParse($$)
{
my ($p1,$p2) = @_;
$p1 = hex($p1); $p2 = hex($p2);
return sprintf("clock:%s %02d:%02d", $zwave_wd[$p1>>5], $p1 & 0x1f, $p2);
}
sub
ZWave_cleanString($$)
{
my ($c, $postfix) = @_;
my $shortened = 0;
$c =~ s/^[0-9.]+ //g;
$c =~ s/Don.t/Dont/g; # Bugfix
if($c =~ m/^(.+)\.(.+)$/ && $2 !~ m/^[ \d]+$/) { # delete second sentence
$c = $1; $shortened++;
}
$c =~ s/[^A-Z0-9]+/ /ig;
$c =~ s/ *$//g;
$c =~ s/ (.)/uc($1)/gei;
while(length($c) > 32 && $shortened < 999) {
$c =~ s/[A-Z][^A-Z]*$//;
$shortened++;
}
$c .= $postfix if($shortened);
return ($c, $shortened);;
}
###################################
# Poor mans XML-Parser
sub
ZWave_configParseModel($)
{
my ($cfg) = @_;
Log 3, "ZWave reading config for $cfg";
my $fn = $attr{global}{modpath}."/FHEM/lib/openzwave_deviceconfig.xml.gz";
my $gz = gzopen($fn, "rb");
if(!$gz) {
Log 3, "Can't open $fn: $!";
return;
}
my ($line, $class, %hash, $cmdName, %classInfo, %group);
while($gz->gzreadline($line)) { # Search the "file" entry
last if($line =~ m/^\s*<Product.*sourceFile="$cfg"/);
}
while($gz->gzreadline($line)) {
last if($line =~ m+^\s*</Product>+);
if($line =~ m/^\s*<CommandClass.*id="([^"]*)"(.*)$/) {
$class = $1;
$classInfo{$class} = $2;
}
$group{$1} = $line if($line =~ m/^\s*<Group.*index="([^"]*)".*$/);
next if(!$class || $class ne "112");
if($line =~ m/^\s*<Value /) {
my %h;
$h{type} = $1 if($line =~ m/type="([^"]*)"/i);
$h{size} = $1 if($line =~ m/size="([^"]*)"/i);
$h{genre} = $1 if($line =~ m/genre="([^"]*)"/i); # config, user
$h{label} = $1 if($line =~ m/label="([^"]*)"/i);
$h{min} = $1 if($line =~ m/min="([^"]*)"/i);
$h{max} = $1 if($line =~ m/max="([^"]*)"/i);
$h{value} = $1 if($line =~ m/value="([^"]*)"/i);
$h{index} = $1 if($line =~ m/index="([^"]*)"/i); # 1, 2, etc
$h{read_only} = $1 if($line =~ m/read_only="([^"]*)"/i); # true,false
$h{write_only} = $1 if($line =~ m/write_only="([^"]*)"/i); # true,false
my ($cmd,$shortened) = ZWave_cleanString($h{label}, $h{index});
$cmdName = "config$cmd";
$h{Help} = "";
$h{Help} .= "Full text for $cmdName is $h{label}<br>" if($shortened);
$hash{$cmdName} = \%h;
}
$hash{$cmdName}{Help} .= "$1<br>" if($line =~ m+^\s*<Help>(.*)</Help>$+);
if($line =~ m/^\s*<Item/) {
my $label = $1 if($line =~ m/label="([^"]*)"/i);
my $value = $1 if($line =~ m/value="([^"]*)"/i);
my ($item, $shortened) = ZWave_cleanString($label, $value);
$hash{$cmdName}{Item}{$item} = $value;
$hash{$cmdName}{type} = "list"; # Forum #42604
$hash{$cmdName}{Help} .= "Full text for $item is $label<br>"
if($shortened);
}
}
$gz->gzclose();
my %mc = (set=>{}, get=>{}, config=>{},classInfo=>\%classInfo,group=>\%group);
foreach my $cmd (keys %hash) {
my $h = $hash{$cmd};
my $arg = ($h->{type} eq "button" ? "a" : "a%b");
$mc{set}{$cmd} = $arg if(!$h->{read_only} || $h->{read_only} ne "true");
$mc{get}{$cmd} ="noArg" if(!$h->{write_only} || $h->{write_only} ne "true");
$mc{config}{$cmd} = $h;
$zwave_cmdArgs{set}{$cmd} = join(",", keys %{$h->{Item}}) if($h->{Item});
$zwave_cmdArgs{set}{$cmd} = "noArg" if($h->{type} eq "button");
$zwave_cmdArgs{get}{$cmd} = "noArg";
}
$zwave_modelConfig{$cfg} = \%mc;
}
###################################
sub
ZWave_configGetHash($)
{
my ($hash) = @_;
return undef if(!$hash);
my $mc = ReadingsVal($hash->{NAME}, "modelConfig", "");
ZWave_configParseModel($mc) if($mc && !$zwave_modelConfig{$mc});
return $zwave_modelConfig{$mc};
}
sub
ZWave_configCheckParam($$$$$@)
{
my ($hash, $cfgReq, $type, $cmd, $fmt, @arg) = @_;
my $mc = ZWave_configGetHash($hash);
return ("", sprintf($fmt, @arg)) if(!$mc);
my $h = $mc->{config}{$cmd};
return ("", sprintf($fmt, @arg)) if(!$h);
# Support "set XX configYY request" for configRequestAll
return ("", sprintf("05%02x", $h->{index})) if($type eq "get" || $cfgReq);
my $t = $h->{type};
if($t eq "list") {
my $v = $h->{Item}{$arg[0]};
return ("Unknown parameter $arg[0] for $cmd, use one of ".
join(",", keys %{$h->{Item}}), "") if(!defined($v));
my $len = ($v > 65535 ? 8 : ($v > 255 ? 4 : 2));
return ("", sprintf("04%02x%02d%0*x", $h->{index}, $len/2, $len, $v));
}
if($t eq "button") {
return ("", sprintf("04%02x01%02x", $h->{index}, $h->{value}));
}
return ("Parameter is not decimal", "") if($arg[0] !~ m/^-?[0-9]+$/);
if($h->{size}) { # override type by size
$t = ($h->{size} eq "1" ? "byte" : ($h->{size} eq "2" ? "short" : "int"));
}
my $len = ($t eq "int" ? 8 : ($t eq "short" ? 4 : 2));
$arg[0] += 2**($len==8 ? 32 : ($len==4 ? 16 : 8)) if($arg[0] < 0); #F:41709
return ("", sprintf("04%02x%02x%0*x", $h->{index}, $len/2, $len, $arg[0]));
}
my %zwave_alarmType = (
"01"=>"Smoke",
"02"=>"CO",
"03"=>"CO2",
"04"=>"Heat",
"05"=>"Water",
"06"=>"AccessControl",
"07"=>"HomeSecurity",
"08"=>"PowerManagement",
"09"=>"System",
"0a"=>"Emergency",
"0b"=>"Clock",
"0c"=>"Appliance",
"0d"=>"HomeHealth"
);
my %zwave_alarmEvent = (
"0101"=>"detected",
"0102"=>"detected, Unknown Location",
"0103"=>"Alarm Test",
"0201"=>"detected",
"0202"=>"detected, Unknown Location",
"0301"=>"detected",
"0302"=>"detected, Unknown Location",
"0401"=>"Overheat detected",
"0402"=>"Overheat detected, Unknown Location",
"0403"=>"Rapid Temperature Rise",
"0404"=>"Rapid Temperature Rise, Unknown Location",
"0405"=>"Underheat detected",
"0406"=>"Underheat detected, Unknown Location",
"0501"=>"Leak detected",
"0502"=>"Leak detected, Unknown Location",
"0503"=>"Level Dropped",
"0504"=>"Level Dropped, Unknown Location",
"0505"=>"Replace Filter",
"0601"=>"Manual Lock Operation",
"0602"=>"Manual Unlock Operation",
"0603"=>"RF Lock Operation",
"0604"=>"RF Unlock Operation",
"0605"=>"Keypad Lock Operation",
"0606"=>"Keypad Unlock Operation",
"0607"=>"Manual Not Fully Locked Operation",
"0608"=>"RF Not Fully Locked Operation",
"0609"=>"Auto Lock Locked Operation",
"060a"=>"Auto Lock Not Fully Operation",
"060b"=>"Lock Jammed",
"060c"=>"All user codes deleted",
"060d"=>"Single user code deleted",
"060e"=>"New user code added",
"060f"=>"New user code not added due to duplicate code",
"0610"=>"Keypad temporary disabled",
"0611"=>"Keypad busy",
"0612"=>"New Program code Entered - Unique code for lock configuration",
"0613"=>"Manually Enter user Access code exceeds code limit",
"0614"=>"Unlock By RF with invalid user code",
"0615"=>"Locked by RF with invalid user codes",
"0616"=>"Window/Door is open",
"0617"=>"Window/Door is closed",
"0640"=>"Barrier performing Initialization process",
"0641"=>"Barrier operation (Open / Close) force has been exceeded.",
"0642"=>"Barrier motor has exceeded manufacturer's operational time limit",
"0643"=>"Barrier operation has exceeded physical mechanical limits.",
"0644"=>"Barrier unable to perform requested operation due to UL requirements.",
"0645"=>"Barrier Unattended operation has been disabled per UL requirements.",
"0646"=>"Barrier failed to perform Requested operation, device malfunction",
"0647"=>"Barrier Vacation Mode",
"0648"=>"Barrier Safety Beam Obstacle",
"0649"=>"Barrier Sensor Not Detected / Supervisory Error",
"064a"=>"Barrier Sensor Low Battery Warning",
"064b"=>"Barrier detected short in Wall Station wires",
"064c"=>"Barrier associated with non-Z-wave remote control.",
"0700"=>"Previous Events cleared",
"0701"=>"Intrusion",
"0702"=>"Intrusion, Unknown Location",
"0703"=>"Tampering, product covering removed",
"0704"=>"Tampering, Invalid Code",
"0705"=>"Glass Breakage",
"0706"=>"Glass Breakage, Unknown Location",
"0707"=>"Motion Detection",
"0708"=>"Motion Detection, Unknown Location",
"0800"=>"Previous Events cleared",
"0801"=>"Power has been applied",
"0802"=>"AC mains disconnected",
"0803"=>"AC mains re-connected",
"0804"=>"Surge Detection",
"0805"=>"Voltage Drop/Drift",
"0806"=>"Over-current detected",
"0807"=>"Over-voltage detected",
"0808"=>"Over-load detected",
"0809"=>"Load error",
"080a"=>"Replace battery soon",
"080b"=>"Replace battery now",
"080c"=>"Battery is charging",
"080d"=>"Battery is fully charged",
"080e"=>"Charge battery soon",
"080f"=>"Charge battery now!",
"0901"=>"hardware failure",
"0902"=>"software failure",
"0903"=>"hardware failure with OEM proprietary failure code",
"0904"=>"software failure with OEM proprietary failure code",
"0a01"=>"Contact Police",
"0a02"=>"Contact Fire Service",
"0a03"=>"Contact Medical Service",
"0b01"=>"Wake Up Alert",
"0b02"=>"Timer Ended",
"0b03"=>"Time remaining",
"0c01"=>"Program started",
"0c02"=>"Program in progress",
"0c03"=>"Program completed",
"0c04"=>"Replace main filter",
"0c05"=>"Failure to set target temperature",
"0c06"=>"Supplying water",
"0c07"=>"Water supply failure",
"0c08"=>"Boiling",
"0c09"=>"Boiling failure",
"0c0a"=>"Washing",
"0c0b"=>"Washing failure",
"0c0c"=>"Rinsing",
"0c0d"=>"Rinsing failure",
"0c0e"=>"Draining",
"0c0f"=>"Draining failure",
"0c10"=>"Spinning",
"0c11"=>"Spinning failure",
"0c12"=>"Drying",
"0c13"=>"Drying failure",
"0c14"=>"Fan failure",
"0c15"=>"Compressor failure",
"0d00"=>"Previous Events cleared",
"0d01"=>"Leaving Bed",
"0d02"=>"Sitting on bed",
"0d03"=>"Lying on bed",
"0d04"=>"Posture changed",
"0d05"=>"Sitting on edge of bed",
"0d06"=>"Volatile Organic Compound level"
);
sub
ZWave_alarmParse($$$)
{
my ($t,$l,$r) = @_;
if($t=="00" && $r && $r =~ m/^..(..)(..)/) { # Forum #35178
$l = $1; $t = $2;
}
if(!$r || $r !~ m/......(..)(.*)/ || !$zwave_alarmType{$t}) { # V1 or unknown
return "alarm_type_$t:level $l";
}
my ($e, $v4, $s) = ($1, $2, "alarm:$zwave_alarmType{$t}: ");
if($l eq "00") {
$s .= "Event cleared: ";
$e = $1 if($v4 && $v4 =~ m/..(..)../);
}
$s .= ($zwave_alarmEvent{"$t$e"} ?
$zwave_alarmEvent{"$t$e"} : "unknown event $e");
$s .= ", arg $v4" if($v4 && $l ne "00");
return $s;
}
sub
ZWave_protectionParse($$)
{
my ($lp, $rp) = @_;
my $lpt = "Local: ". ($lp eq "00" ? "unprotected" :
($lp eq "01" ? "by sequence" : "No operation possible"));
my $rpt = "RF: ". ($rp eq "00" ? "unprotected" :
($rp eq "01" ? "No control" : "No response"));
return "protection:$lpt $rpt";
}
sub
ZWave_configParse($$$$)
{
my ($hash, $cmdId, $size, $val) = @_;
$val = substr($val, 0, 2*$size);
$val = hex($val);
$cmdId = hex($cmdId);
my $mc = ZWave_configGetHash($hash);
return "config_$cmdId:$val" if(!$mc);
my $h = $mc->{config};
foreach my $cmd (keys %{$h}) {
if($h->{$cmd}{index} == $cmdId) {
my $hi = $h->{$cmd}{Item};
if($hi) {
foreach my $item (keys %{$hi}) {
return "$cmd:$item" if($hi->{$item} == $val);
}
}
return "$cmd:$val";
}
}
return "config_$cmdId:$val";
}
sub
ZWave_configRequestAll($)
{
my ($hash) = @_;
my $mc = ZWave_configGetHash($hash);
return ("configRequestAll: no model specific configs found", undef)
if(!$mc || !$mc->{config});
#use Data::Dumper;
#Log 1, Dumper $mc;
foreach my $c (sort keys %{$mc->{get}}) {
my $r = ZWave_Set($hash, $hash->{NAME}, $c, "request");
Log 1, "$c: $r" if($r);
}
return ("","EMPTY");
}
sub
ZWave_associationRequest($$)
{
my ($hash, $data) = @_;
if(!$data) { # called by the user
$zwave_parseHook{"$hash->{nodeIdHex}:..85"} = \&ZWave_associationRequest;
return("", "05");
}
my $nGrp = ($data =~ m/..8506(..)/ ? $1 :
ReadingsVal($hash->{NAME}, "assocGroups", 0));
my $grp = 0;
$grp = $1 if($data =~ m/..8503(..)/);
return if($grp >= $nGrp);
$zwave_parseHook{"$hash->{nodeIdHex}:..85"} = \&ZWave_associationRequest;
ZWave_Set($hash, $hash->{NAME}, "associationRequest", $grp+1);
}
my %zwave_roleType = (
"00"=>"CentralStaticController",
"01"=>"SubStaticController",
"02"=>"PortableController",
"03"=>"PortableReportingController",
"04"=>"PortableSlave",
"05"=>"AlwaysOnSlave",
"06"=>"SleepingReportingSlave",
"07"=>"SleepingListeningSlave"
);
my %zwave_nodeType = (
"00"=>"Z-Wave+Node",
"01"=>"Z-Wave+IpRouter",
"02"=>"Z-Wave+IpGateway",
"03"=>"Z-Wave+IpClientAndIpNode",
"04"=>"Z-Wave+IpClientAndZwaveNode"
);
sub
ZWave_plusInfoParse($$$$$)
{
my ($version, $roleType, $nodeType, $installerIconType, $userIconType) = @_;
return "zwavePlusInfo: " .
"version:" . $version .
" role:" .
($zwave_roleType{"$roleType"} ? $zwave_roleType{"$roleType"} :"unknown") .
" node:" .
($zwave_nodeType{"$nodeType"} ? $zwave_nodeType{"$nodeType"} :"unknown") .
" installerIcon:". $installerIconType .
" userIcon:". $userIconType;
}
my %zwave_sensorBinaryTypeV2 = (
"00"=>"unknown",
"01"=>"generalPurpose",
"02"=>"smoke",
"03"=>"CO",
"04"=>"CO2",
"05"=>"heat",
"06"=>"water",
"07"=>"freeze",
"08"=>"tamper",
"09"=>"aux",
"0a"=>"doorWindow",
"0b"=>"tilt",
"0c"=>"motion",
"0d"=>"glassBreak"
);
sub
ZWave_sensorbinaryV2Parse($$)
{
my ($value, $sensorType) = @_;
return ($zwave_sensorBinaryTypeV2{"$sensorType"} ?
$zwave_sensorBinaryTypeV2{"$sensorType"} :"unknown") .
":".$value;
}
##############################################
# SECURITY (start)
##############################################
sub
ZWave_secInit(@)
{
my ($hash, $param) = @_;
my $iodev = $hash->{IODev};
my $name = $hash->{NAME};
if (!ZWave_secIsEnabled($hash)) {
return;
}
$hash->{secStatus} = 0 if(!$hash->{secStatus});
my $status = ++$hash->{secStatus};
my @stTxt = ( "secScheme", "secNonceRequest");
my $stTxt = ($status > int(@stTxt) ? "ERR" : $stTxt[$status-1]);
if($status == 1) {
ZWave_Cmd("set", $hash, $name, "secScheme");
return ""; # not evaluated
} elsif($status == 2) {
ZWave_Cmd("get", $hash, $name, "secNonce");
return undef;
} else {
Log3 $name, 5, "$name: secureInit called with invalid status";
return undef;
}
}
sub
ZWave_secStart($)
{
my ($hash) = @_;
return if($hash->{secInProgress});
$hash->{secInProgress} = 1;
my @empty;
$hash->{secStack} = \@empty;
}
sub
ZWave_secEnd($)
{
my ($hash) = @_;
return if(!$hash->{secInProgress});
my $secStack = $hash->{secStack};
delete $hash->{secInProgress};
delete $hash->{secStack};
foreach my $cmd (@{$secStack}) {
ZWave_SCmd($cmd->{T}, $hash, @{$cmd->{A}});
}
}
sub
ZWave_secIsSecureClass($$)
{
my ($hash, $cc_cmd) = @_;
my $name = $hash->{NAME};
if ($cc_cmd =~m/(..)(..)/) {
my ($cc, $cmd) = ($1, $2);
my $cc_name = $zwave_id2class{lc($cc)};
my $sec_classes = AttrVal($name, "secure_classes", "");
if (($sec_classes =~ m/$cc_name/) && ($cc_name ne 'SECURITY')){
Log3 $name, 5, "$name: $cc_name is a secured class!";
return 1;
}
# some SECURITY commands need to be encrypted allways
if ($cc eq '98') {
if ($cmd eq '02' || # SupportedGet
$cmd eq '06' || # NetworkKeySet
$cmd eq '08' ){ # SchemeInherit
Log3 $name, 5, "$name: Security commands will be encrypted!";
return 1;
}
}
# these SECURITY commands should not be encrypted
# SchemeGet = 0x04, NonceGet = 0x40, NonceReport = 0x80
# MessageEncap = 0x81 is already encrypted
# MessageEncapNonceGet = 0xc1 is already encrypted
}
return 0;
}
sub
ZWave_secSupported($$)
{
my ($hash, $arg) = @_;
my $name = $hash->{NAME};
my $iodev = $hash->{IODev};
my $id = $hash->{nodeIdHex};
if (!ZWave_secIsEnabled($hash)) {
return;
};
Log3 $name, 5, "$name: Secured Classes Supported: $arg";
if ($arg =~ m/(..)(.*)/) {
if ($1 ne '00') {
Log3 $name, 1, "$name: Multi part message report for secure classes ".
"can not be handled!";
}
my @sec_classes;
my $sec_classes = $2;
for my $sec_classId (grep /../, split(/(..)/, lc($sec_classes))) {
push @sec_classes, $zwave_id2class{lc($sec_classId)} ?
$zwave_id2class{lc($sec_classId)} : "UNKNOWN_".lc($sec_classId);
}
$attr{$name}{secure_classes} = join(" ", @sec_classes)
if (@sec_classes);
}
# Add new secure_classes to classes if not already present
# Needed for classes that are only supported with SECURITY
if ($attr{$name}{secure_classes} && $attr{$name}{classes}) {
my $classes = $attr{$name}{classes};
my $secure_classes = $attr{$name}{secure_classes};
my $c1;
my $c2;
my $s1;
my $s2;
my $classname;
if ($classes =~ m/(.*)(MARK)(.*)/) {
($c1, $c2) = ($1, $2 . $3);
} else {
($c1, $c2) = ($classes, "");
}
if ($secure_classes =~ m/(.*)(MARK)(.*)/) {
($s1, $s2) = ($1, $2 . $3);
} else {
($s1, $s2) = ($secure_classes, "");
}
foreach $classname (split(" ", $s1)) {
if ($c1 !~ m/$classname/) {
$c1 = join (" ", $c1, $classname);
}
}
foreach $classname (split(" ", $s2)) {
if ($c2 !~ m/$classname/) {
$c2 = join (" ", $c2, $classname);
}
}
$classes = join (" ", $c1, $c2);
$classes =~ s/ +/ /gs;
$attr{$name}{classes} = $classes;
}
if ($iodev->{secInitName} && $hash->{secStatus}) {
# Secure inclusion is finished, remove readings and execute "normal" init
delete $iodev->{secInitName};
delete $hash->{secStatus};
return ZWave_execInits($hash, 0);
}
}
sub
ZWave_secNonceReceived($$)
{
my ($hash, $r_nonce_hex) = @_;
my $iodev = $hash->{IODev};
my $name = $hash->{NAME};
if (!ZWave_secIsEnabled($hash))
{
return;
}
# If a nonce is received during secure_Include, send the networkkey...
if ($hash->{secStatus} && ($hash->{secStatus} == 2)) {
my $key_hex = AttrVal($iodev->{NAME}, "networkKey", "");
my $mynonce_hex = substr (ZWave_secCreateNonce($hash), 2, 16);
my $cryptedNetworkKeyMsg = ZWave_secNetworkkeySet($r_nonce_hex,
$mynonce_hex, $key_hex, $hash->{nodeIdHex});
ZWave_Cmd("set", $hash, $name, ("secEncap", $cryptedNetworkKeyMsg));
$hash->{secStatus}++;
readingsSingleUpdate($hash, "SECURITY", 'INITIALIZING (Networkkey sent)',0);
Log3 $name, 5, "$name: SECURITY initializing, networkkey sent";
# start timer here to check state if networkkey was not verified
InternalTimer(gettimeofday()+25, "ZWave_secTestNetworkkeyVerify", $hash, 0);
return undef;
}
# if nonce is received, we should have stored a message for encryption
my $getSecMsg = ZWave_secGetMsg($hash);
my @secArr = split / /, $getSecMsg, 4;
my $secMsg = $secArr[0];
my $type = $secArr[1];
my $cmd = $secArr[3];
if (!$secMsg) {
Log3 $name, 1, "$name: Error, nonce reveived but no stored command for ".
"encryption found";
return undef;
}
my $enc = ZWave_secEncrypt($hash, $r_nonce_hex, $secMsg);
ZWave_Cmd("set", $hash, $name, ("secEncap", $enc));
if ($type eq "set" && $cmd && $cmd !~ m/^config.*request$/) {
readingsSingleUpdate($hash, "state", $cmd, 1);
Log3 $name, 5, "$name: type=$type, cmd=$cmd ($getSecMsg)";
ZWave_secEnd($hash) if ($type eq "set");
}
return undef;
}
sub
ZWave_secPutMsg ($$$)
{
my ($hash, $s, $cmd) = @_;
my $name = $hash->{NAME};
if (!$hash->{secMsg}) {
my @arr = ();
$hash->{secMsg} = \@arr;
}
push @{$hash->{secMsg}}, $s . " ". $cmd;
Log3 $name, 5, "$name SECURITY: $s stored for encryption";
}
sub
ZWave_secGetMsg ($)
{
my ($hash) = @_;
my $name = $hash->{NAME};
my $secMsg = $hash->{secMsg};
if ($secMsg && @{$secMsg}) {
my $ret = shift(@{$secMsg});
if ($ret) {
Log3 $name, 5, "$name SECURITY: $ret retrieved for encryption";
return $ret;
}
}
Log3 $name, 1, "$name: no stored commands in Internal secMsg found";
return undef;
}
sub
ZWave_secNonceRequestReceived ($)
{
my ($hash) = @_;
if (!ZWave_secIsEnabled($hash)) {
return;
}
ZWave_secStart($hash);
return ZWave_Cmd("set", $hash, $hash->{NAME}, "sendNonce");
}
sub
ZWave_secIsEnabled ($)
{
my ($hash) = @_;
my $secStatus = ReadingsVal($hash->{NAME}, "SECURITY", "DISABLED");
if ($secStatus =~ m/DISABLED/) {
Log3 $hash->{NAME}, 1, "$hash->{NAME} SECURITY $secStatus (command dropped)";
return (0);
}
return (1);
}
sub
ZWave_sec ($$)
{
my ($hash, $arg) = @_;
return (ZWave_secIsEnabled($hash) ? ("", $arg) : ("",'00'));
}
sub
ZWave_secCreateNonce($)
{
my ($hash) = @_;
if (ZWave_secIsEnabled($hash)) {
my $nonce = ZWave_secGetNonce();
setReadingsVal($hash, "send_nonce", $nonce, TimeNow());
return ("",'80'.$nonce);
} else {
return ("", '00');
}
}
sub
ZWave_secGetNonce()
{
my $nonce='';
for (my $i = 0; $i <8; $i++) {
$nonce .= sprintf "%02x",int(rand(256));
}
return $nonce;
}
sub
ZWave_secNetWorkKeyVerify ($)
{
my($hash) = @_;
my $name = $hash->{NAME};
my $iodev = $hash->{IODev};
if (!ZWave_secIsEnabled($hash)) {
return;
}
#Log3 $iodev, 4, "$name: NetworkKeyVerify received, SECURITY is enabled";
readingsSingleUpdate($hash, "SECURITY", 'ENABLED', 0);
Log3 $name, 3, "$name: SECURITY enabled, networkkey was verified";
ZWave_Cmd("get", $hash, $name, ("secSupported"));
}
sub
ZWave_secTestNetworkkeyVerify ($)
{
my($hash) = @_;
my $name = $hash->{NAME};
my $sec_status = ReadingsVal($name, "SECURITY", undef);
if ($sec_status !~ m/ENABLED/) {
readingsSingleUpdate($hash, "SECURITY",
'DISABLED (networkkey not verified and timer expired)', 0);
Log3 $name, 1, "$name: SECURITY disabled, networkkey was not verified ".
"and timer expired";
}
}
sub
ZWave_secEncrypt($$$)
{
my ($hash, $r_nonce_hex, $plain) = @_;
my $name = $hash->{NAME};
my $iodev = $hash->{IODev};
my $id = $hash->{nodeIdHex};
my $init_enc_key = pack 'H*', 'a' x 32;
my $init_auth_key = pack 'H*', '5' x 32;
my $s_nonce_hex = ZWave_secGetNonce();
my $iv = pack 'H*', $s_nonce_hex . $r_nonce_hex;
my $key = pack 'H*', AttrVal($iodev->{NAME}, "networkKey", "");
my $enc_key = ZWave_secEncryptECB($key, $init_enc_key);
my $auth_key = ZWave_secEncryptECB($key, $init_auth_key);
my $seq = '00'; # Sequencebyte -> need to be calculated for longer messages
my $msg_hex = $seq . $plain;
my $out_hex = ZWave_secEncryptOFB ($enc_key, $iv, $msg_hex);
my $auth_msg_hex = '8101';
$auth_msg_hex .= sprintf "%02x", hex($hash->{nodeIdHex});
$auth_msg_hex .= sprintf "%02x", (length ($out_hex))/2;
$auth_msg_hex .= $out_hex;
Log3 $name, 5, "$name: secEncrypt plain:$msg_hex enc:$out_hex";
my $auth_code_hex = ZWave_secGenerateAuth($auth_key, $iv, $auth_msg_hex);
my $enc_msg_hex = '81' . $s_nonce_hex . $out_hex . substr($r_nonce_hex, 0, 2)
. $auth_code_hex;
return $enc_msg_hex;
}
sub
ZWave_secDecrypt($$$)
{
my ($hash, $data, $newnonce) = @_;
my $name = $hash->{NAME};
my $iodev = $hash->{IODev};
if (!ZWave_secIsEnabled($hash)) {
return;
}
my $init_enc_key = pack 'H*', 'a' x 32;
my $init_auth_key = pack 'H*', '5' x 32;
my $key = pack 'H*', AttrVal($iodev->{NAME}, "networkKey", "");
my $enc_key = ZWave_secEncryptECB($key, $init_enc_key);
my $auth_key = ZWave_secEncryptECB($key, $init_auth_key);
my $s_nonce_hex = ReadingsVal($name, "send_nonce", undef);
if (!$s_nonce_hex) {
Log3 $name, 1, "$name: Error, no send_nonce to decrypt message available";
ZWave_secEnd($hash);
return "";
}
delete $hash->{READINGS}{send_nonce};
# encrypted message format:
# data= bcb328fe5d924a402b2901fc2699cc3bcacd30e0
# bcb328fe5d924a40 = 8 byte r_nonce
# 2b2901 = encrypted message, variable length
# fc = s_nonce-Id (= first byte of s_nonce)
# 2699cc3bcacd30e0 = 8 byte authentification code
if ($data !~ m/^(................)(.*)(..)(................)$/) {
Log3 $name, 1, "$name: Error, wrong format of encrypted msg";
ZWave_secEnd($hash);
return "";
}
my ($r_nonce_hex, $msg_hex, $s_nonce_id_hex, $auth_code_hex) = ($1, $2, $3, $4);
my $iv = pack 'H*', $r_nonce_hex . $s_nonce_hex;
my $out_hex = ZWave_secEncryptOFB ($enc_key, $iv, $msg_hex);
Log3 $name, 5, "$name: secDecrypt: decrypted cmd $out_hex";
# decoding sequence information
# bit 76 reseved
# bit 5 second frame (0x20)
# bit 4 sequenced (0x10)
# bit 3210 sequenceCounter (0x0f)
my $seq = hex(substr ($out_hex, 0,2));
my $sequenced = (($seq & 0x10) ? 1 : 0);
my $secondFrame = (($seq & 0x20) ? 1 : 0);
my $sequenceCounter = sprintf "%02x", ($seq & 0x0f);
Log3 $name, 5, "$name: secDecrypt: Sequencebyte $seq, sequenced ".
"$sequenced, secondFrame $secondFrame, sequenceCounter $sequenceCounter";
# Rebuild message for authentification check
# 81280103 '81' . <from-id> . <to-id> . <len> . <encrMsg>
my $my_msg_hex = ($newnonce ? 'c1' : '81');
$my_msg_hex .= sprintf "%02x", hex($hash->{nodeIdHex});
$my_msg_hex .= '01';
$my_msg_hex .= sprintf "%02x", (length ($msg_hex))/2;
$my_msg_hex .= $msg_hex;
my $my_auth_code_hex = ZWave_secGenerateAuth($auth_key, $iv, $my_msg_hex);
Log3 $name, 5, "$name: secDecrypt: calculated Authentication code ".
"$my_auth_code_hex";
$out_hex = substr($out_hex, 2,length($out_hex)-2);
if ($auth_code_hex eq $my_auth_code_hex) {
if ($sequenced && !$secondFrame){ # first frame of sequence message
ZWave_secStoreFirstFrame($hash, $sequenceCounter, $out_hex);
} else { # not first frame or not sequenced
if ($sequenced && $secondFrame){
my $firstFrame = ZWave_secRetrieveFirstFrame ($hash, $sequenceCounter);
if ($firstFrame) {
$out_hex = $firstFrame . $out_hex;
} else {
Log3 $name, 1, "$name: secDecrypt: first frame of message (sequence ".
"$sequenceCounter) for decryption not found!";
}
}
my $decryptedCmd = '000400';
$decryptedCmd .= sprintf "%02x", hex($hash->{nodeIdHex});
$decryptedCmd .= sprintf "%02x", (length ($out_hex))/2;
$decryptedCmd .= $out_hex;
Log3 $name, 5, "$name: secDecrypt: parsing $decryptedCmd";
ZWave_Parse($iodev, $decryptedCmd, undef);
ZWave_secEnd($hash);
}
} else {
Log3 $name, 1, "$name: secDecrypt: Authentification code not verified, "
."command $out_hex will be dropped!";
if ($sequenced && $secondFrame){
ZWave_secRetrieveFirstFrame ($hash, $sequenceCounter);
}
}
if ($newnonce == 1) {
ZWave_Cmd("set", $hash, $hash->{NAME}, "sendNonce");
}
return "";
}
sub
ZWave_secStoreFirstFrame ($$$) {
my ($hash, $seqcnt, $framedata) = @_;
my $framename = "Frame_$seqcnt";
$hash->{$framename} = $framedata;
}
sub
ZWave_secRetrieveFirstFrame ($$) {
my ($hash, $seqcnt) = @_;
my $framename = "Frame_$seqcnt";
if ($hash->{$framename}) {
my $ret = $hash->{$framename};
if ($ret) {
$hash->{$framename} = undef;
return $ret;
}
}
Log3 $hash->{NAME}, 1, "$hash->{NAME}: first frame of message (sequence ".
"$seqcnt) for decryption not found!";
return undef;
}
sub
ZWave_secEncryptECB ($$)
{
my ($key, $iv) = @_;
# $key and $iv as 'packed' hex-strings
my $cipher_ecb = Crypt::Rijndael->new ($key, Crypt::Rijndael::MODE_ECB() );
return $cipher_ecb->encrypt($iv);
}
sub
ZWave_secEncryptOFB ($$$)
{
my ($key, $iv, $in_hex) = @_;
# $key and $iv as 'packed' hex-strings, $in_hex as hex-string
my $cipher_ofb = Crypt::Rijndael->new($key,
Crypt::Rijndael::MODE_OFB() );
$cipher_ofb->set_iv($iv);
# make sure that the blocksize is 16 bytes / 32 characters
my $in_len = length($in_hex);
if ($in_len % 32) {
$in_hex .= '0' x (32 - ($in_len % 32));
}
my $out_hex = unpack 'H*', $cipher_ofb->encrypt(pack 'H*', $in_hex);
return (substr ($out_hex, 0, $in_len));
}
sub
ZWave_secGenerateAuth ($$$)
{
my ($key, $iv, $msg_hex) = @_;
my $cipher_ecb = Crypt::Rijndael->new ($key, Crypt::Rijndael::MODE_ECB() );
my $enc_iv = ZWave_secEncryptECB($key, $iv);
# make sure that the blocksize is 16 bytes / 32 characters
my $msg_len = length($msg_hex);
if ($msg_len % 32) {
$msg_hex .= '0' x (32 - ($msg_len % 32));
}
my $temp=0;
my $buff=0;
my $buff_hex="";
# xOR first block with encrypted iv
# encrypt the result, repeat for all blocks using encrypted output
# as input for xOR of next block
for (my $i = 0; $i < (length($msg_hex)/32); $i++) {
$buff_hex = substr($msg_hex, $i*32, 32);
$buff = pack 'H*', $buff_hex;
$temp = $buff ^ $enc_iv;
$enc_iv = $cipher_ecb->encrypt($temp);
};
# only 8 byte used for message authentification code
return unpack 'H16', $enc_iv;
}
sub
ZWave_secNetworkkeySet ($$$$)
{
my ($nonce_hex, $mynonce_hex, $key_plain_hex, $id_hex) = @_;
my $name ="ZWave_secNetworkkeySet";
# The NetworkKeySet command message will be encrcpted and authentificated
# with temporary keys that are created with the networkkey and default
# keys for encryption and authentification as given below.
my $init_enc_key = pack 'H*', 'a' x 32;
my $init_auth_key = pack 'H*', '5' x 32;
my $key_zero = pack 'H*', '0' x 32;
my $nonce = pack 'H*', $nonce_hex;
my $mynonce = pack 'H*', $mynonce_hex;
my $enc_key = ZWave_secEncryptECB($key_zero, $init_enc_key);
my $auth_key = ZWave_secEncryptECB($key_zero, $init_auth_key);
my $iv = pack 'H*', $mynonce_hex . $nonce_hex;
# build 'plain-text' message to be encrypted
# 0x00 = sequence byte -> only one frame
# 0x98 = Security Class
# 0x06 = NetworkKeySet
$key_plain_hex = '009806'.$key_plain_hex;
my $out_hex = ZWave_secEncryptOFB($enc_key, $iv, $key_plain_hex);
############ MAC generation ############################
# build message for encryption
# command, source-id, target-id
# 0x81="Security_Message_Encapsulation" 0x01=Souce-ID (Controller = 0x01)
my $in_hex = '8101' . $id_hex;
$in_hex .= sprintf "%02x", length($out_hex)/2; # length of command
$in_hex .= $out_hex; # encrypted network key
my $auth_hex = ZWave_secGenerateAuth ($auth_key, $iv, $in_hex);
# build encrypted message
# Command Class will be added during sending -> do not prepend
# 0x81 = Security_Message_Encapsulation
$out_hex = '81' . $mynonce_hex . $out_hex . substr($nonce_hex, 0, 2) .
$auth_hex;
return $out_hex;
}
##############################################
#AH: SECURITY (end)
##############################################
sub
ZWave_getHash($$$)
{
my ($hash, $cl, $type) = @_;
my $ptr; # must be standalone, as there is a $ptr in the calling fn.
$ptr = $zwave_class{$cl}{$type}
if($zwave_class{$cl} && $zwave_class{$cl}{$type});
if($cl eq "CONFIGURATION" && $type ne "parse") {
my $mc = ZWave_configGetHash($hash);
if($mc) {
my $mcp = $mc->{$type};
if($mcp) {
my %nptr = ();
map({$nptr{$_} = $ptr->{$_}} keys %{$ptr});
map({$nptr{$_} = $mcp->{$_}} keys %{$mcp});
$ptr = \%nptr;
}
}
}
my $modelId = ReadingsVal($hash->{NAME}, "modelId", "");
$modelId = $zwave_modelIdAlias{$modelId} if($zwave_modelIdAlias{$modelId});
my $p = $zwave_deviceSpecial{$modelId};
if($p && $p->{$cl}) {
$ptr = $p->{$cl}{$type} if($p->{$cl}{$type});
my $add = $p->{$cl}{$type."_ADD"};
$ptr = {} if($add && !$ptr);
map { $ptr->{$_} = $add->{$_} } keys %{$add} if($add);
}
return $ptr;
}
sub
ZWave_wakeupTimer($$)
{
my ($hash, $direct) = @_;
my $now = gettimeofday();
my $wnmi_delay = AttrVal($hash->{NAME}, "WNMI_delay", 2);
if(!$hash->{wakeupAlive}) {
$hash->{wakeupAlive} = 1;
$hash->{lastMsgSent} = $now;
InternalTimer($now+0.1, "ZWave_wakeupTimer", $hash, 0);
} elsif(!$direct && $now - $hash->{lastMsgSent} > $wnmi_delay) {
if(!$hash->{SendStack}) {
my $nodeId = $hash->{nodeIdHex};
my $cmdEf = (AttrVal($hash->{NAME},"noExplorerFrames",0)==0 ? "25":"05");
# wakeupNoMoreInformation
IOWrite($hash, "00", "13${nodeId}028408${cmdEf}$nodeId");
}
delete $hash->{wakeupAlive};
} else {
return if($direct);
InternalTimer($now+0.1, "ZWave_wakeupTimer", $hash, 0);
}
}
sub
ZWave_isWakeUp($)
{
my ($h) = @_;
$h->{isWakeUp} = (index(AttrVal($h->{NAME}, "classes", ""), "WAKE_UP") >= 0)
if(!defined($h->{isWakeUp}));
return $h->{isWakeUp};
}
sub
ZWave_processSendStack($)
{
my ($hash) = @_;
my $ss = $hash->{SendStack};
return if(!$ss);
if(index($ss->[0],"sent") == 0) {
shift @{$ss};
RemoveInternalTimer($hash) if(!ZWave_isWakeUp($hash));
}
if(@{$ss} == 0) {
delete $hash->{SendStack};
return;
}
IOWrite($hash, "00", $ss->[0]);
$ss->[0] = "sent:".$ss->[0];
$hash->{lastMsgSent} = gettimeofday();
$zwave_lastHashSent = $hash;
if(!ZWave_isWakeUp($hash)) {
InternalTimer($hash->{lastMsgSent}+10, sub {
Log 2, "ZWave: No ACK from $hash->{NAME} after 10s for $ss->[0]";
ZWave_processSendStack($hash);
}, $hash, 0);
}
}
sub
ZWave_addToSendStack($$)
{
my ($hash, $cmd) = @_;
if(!$hash->{SendStack}) {
my @empty;
$hash->{SendStack} = \@empty;
}
my $ss = $hash->{SendStack};
push @{$ss}, $cmd;
if(ZWave_isWakeUp($hash)) {
# SECURITY XXX and neighborList
if ($cmd =~ m/^......988[01].*/ || $cmd =~ m/^80..0101$/) {
Log3 $hash->{NAME}, 5, "$hash->{NAME}: Sendstack bypassed for $cmd";
} else {
return "Scheduled for sending after WAKEUP" if(!$hash->{wakeupAlive});
}
} else { # clear commands without 0113 and 0013
my $now = gettimeofday();
if(@{$ss} > 1 && $now-$hash->{lastMsgSent} > 10) {
Log3 $hash, 2,
"ERROR: $hash->{NAME}: cleaning commands without ack after 10s";
delete $hash->{SendStack};
return ZWave_addToSendStack($hash, $cmd);
}
}
ZWave_processSendStack($hash) if(@{$ss} == 1);
return undef;
}
###################################
# 0004000a03250300 (sensor binary off for id 11)
# { ZWave_Parse($defs{zd}, "0004000c028407", "") }
sub
ZWave_Parse($$@)
{
my ($iodev, $msg, $srcCmd) = @_;
my $homeId = $iodev->{homeId};
my $ioName = $iodev->{NAME};
if(!$homeId) {
Log3 $ioName, 1, "ERROR: $ioName homeId is not set!"
if(!$iodev->{errReported});
$iodev->{errReported} = 1;
return "";
}
if($msg =~ m/^neighborList (..) 0180(.*)$/) {
my ($id, $data) = ($1, $2);
my $hash = $modules{ZWave}{defptr}{"$homeId $id"};
my $name = ($hash ? $hash->{NAME} : "unknown");
my @r = map { ord($_) } split("", pack('H*', $data));
return "Bogus answer: $msg" if(int(@r) != 29);
my @list;
my $ioId = ReadingsVal($ioName, "homeId", "");
$ioId = $1 if($ioId =~ m/CtrlNodeId:(..)/);
for my $byte (0..28) {
my $bits = $r[$byte];
for my $bit (0..7) {
if($bits & (1<<$bit)) {
my $dec = $byte*8+$bit+1;
my $hex = sprintf("%02x", $dec);
my $h = $modules{ZWave}{defptr}{"$homeId $hex"};
push @list, ($hex eq $ioId ? $ioName :
($h ? $h->{NAME} : "UNKNOWN_$dec"));
}
}
}
$msg = @list ? join(" ", @list) : "empty";
readingsSingleUpdate($hash, "neighborList", $msg, 1) if($hash);
return $msg if($srcCmd);
return "";
}
if($msg =~ m/^01(..)(..*)/) { # 01==ANSWER from the ZWDongle
my ($cmd, $arg) = ($1, $2);
$cmd = $zw_func_id{$cmd} if($zw_func_id{$cmd});
if($cmd eq "ZW_SEND_DATA") { # 011301: data was sent.
if($arg != 1) {
if($zwave_lastHashSent) {
my $hash = $zwave_lastHashSent;
readingsSingleUpdate($hash, "SEND_DATA", "failed:$arg", 1);
Log3 $ioName, 2, "ERROR: cannot SEND_DATA to $hash->{NAME}: $arg";
ZWave_processSendStack($hash);
} else {
Log3 $ioName, 2, "ERROR: cannot SEND_DATA: $arg (unknown device)";
}
}
return "";
}
if($cmd eq "SERIAL_API_SET_TIMEOUTS" && $arg =~ m/(..)(..)/) {
Log3 $ioName, 2, "SERIAL_API_SET_TIMEOUTS: ACK:$1 BYTES:$2";
return "";
}
if($cmd eq "ZW_REMOVE_FAILED_NODE_ID" ||
$cmd eq "ZW_REPLACE_FAILED_NODE") {
my $retval;
if($arg eq "00") { $retval = 'failedNodeRemoveStarted';
} elsif($arg eq "02") { $retval = 'notPrimaryController';
} elsif($arg eq "04") { $retval = 'noCallbackFunction';
} elsif($arg eq "08") { $retval = 'failedNodeNotFound';
} elsif($arg eq "10") { $retval = 'failedNodeRemoveProcessBusy';
} elsif($arg eq "20") { $retval = 'failedNodeRemoveFail';
} else { $retval = 'unknown_'.$arg; # should never happen
}
DoTrigger($ioName, "$cmd $retval");
return "";
}
Log3 $ioName, 4, "$ioName unhandled ANSWER: $cmd $arg";
return "";
}
if($msg !~ m/^00(..)(..)(..)(.*)/) { # 00=REQUEST
Log3 $ioName, 4, "$ioName: UNKNOWN msg $msg";
return "";
}
my ($cmd, $callbackid, $id, $arg) = ($1, $2, $3, $4);
$cmd = $zw_func_id{$cmd} if($zw_func_id{$cmd});
#####################################
# Controller commands
my $evt;
Log3 $ioName, 4, "$ioName CMD:$cmd ID:$id ARG:$arg";
if($cmd eq 'ZW_ADD_NODE_TO_NETWORK' ||
$cmd eq 'ZW_REMOVE_NODE_FROM_NETWORK') {
my @vals = ("learnReady", "nodeFound", "slave",
"controller", "protocolDone", "done", "failed");
$evt = ($id eq "00" || hex($id)>@vals+1) ? "unknownArg" : $vals[hex($id)-1];
if($evt eq "slave" &&
$arg =~ m/(..)....(..)..(.*)$/) {
my ($id,$type6,$classes) = ($1, $2, $3);
return ZWave_SetClasses($homeId, $id, $type6, $classes)
if($cmd eq 'ZW_ADD_NODE_TO_NETWORK');
}
if($evt eq "protocolDone" && $arg =~ m/(..)../) {# done comes at addNode off
my $dh = $modules{ZWave}{defptr}{"$homeId $1"};
return "" if(!$dh);
ZWave_wakeupTimer($dh, 1) if(ZWave_isWakeUp($dh));
if($iodev->{addSecure}) {
readingsSingleUpdate($dh, "SECURITY",
"INITIALIZING (starting secure inclusion)", 0);
my $classes = AttrVal($dh->{NAME}, "classes", "");
if($classes =~ m/SECURITY/) {
if ($zwave_cryptRijndael == 1) {
my $key = AttrVal($ioName, "networkKey", "");
if($key) {
$iodev->{secInitName} = $dh->{NAME};
Log3 $ioName, 2, "ZWAVE Starting secure init";
return ZWave_secInit($dh);
} else {
Log3 $ioName,1,"No secure inclusion as $ioName has no networkKey";
readingsSingleUpdate($dh, "SECURITY",
'DISABLED (Networkkey not found)', 0);
Log3 $dh->{NAME}, 1, "$dh->{NAME}: SECURITY disabled, ".
"networkkey not found";
}
} else {
readingsSingleUpdate($dh, "SECURITY",
'DISABLED (Module Crypt::Rijndael not found)', 0);
Log3 $dh->{NAME}, 1, "$dh->{NAME}: SECURITY disabled, module ".
"Crypt::Rijndael not found";
}
} else {
readingsSingleUpdate($dh, "SECURITY",
'DISABLED (SECURITY not supported by device)', 0);
Log3 $dh->{NAME}, 1, "$dh->{NAME}: secure inclusion failed, ".
"SECURITY disabled, device does not support SECURITY command class";
}
}
return ZWave_execInits($dh, 0);
}
} elsif($cmd eq "ZW_APPLICATION_UPDATE" && $arg =~ m/....(..)..(.*)$/) {
my ($type6,$classes) = ($1, $2);
my $ret = ZWave_SetClasses($homeId, $id, $type6, $classes);
my $hash = $modules{ZWave}{defptr}{"$homeId $id"};
if($hash) {
if(ZWave_isWakeUp($hash)) {
ZWave_wakeupTimer($hash, 1);
ZWave_processSendStack($hash);
}
if(!$ret) {
readingsSingleUpdate($hash, "CMD", $cmd, 1); # forum:20884
return $hash->{NAME};
}
}
return $ret;
} elsif($cmd eq "ZW_SEND_DATA") { # 0013cb00....
my $hash = $modules{ZWave}{defptr}{"$homeId $callbackid"};
my %msg = ('00'=>'OK', '01'=>'NO_ACK', '02'=>'FAIL',
'03'=>'NOT_IDLE', '04'=>'NOROUTE' );
my $lmsg = ($msg{$id} ? $msg{$id} : "UNKNOWN_ERROR");
if($id eq "00") {
Log3 $ioName, 4, "$ioName transmit $lmsg for $callbackid";
if($hash) {
readingsSingleUpdate($hash, "transmit", $lmsg, 0);
ZWave_processSendStack($hash);
}
return "";
} else {
Log3 $ioName, 2, "$ioName transmit $lmsg for $callbackid";
return "" if(!$hash);
readingsSingleUpdate($hash, "state", "TRANSMIT_$lmsg", 1);
readingsSingleUpdate($hash, "transmit", $lmsg, 1);
return $hash->{NAME};
}
} elsif($cmd eq "ZW_REQUEST_NODE_NEIGHBOR_UPDATE") {
if($id eq "21") { $evt = 'started';
} elsif($id eq "22") { $evt = 'done';
} elsif($id eq "23") { $evt = 'failed';
} else { $evt = 'unknown'; # should never happen
}
} elsif($cmd eq "ZW_REMOVE_FAILED_NODE_ID") {
if($id eq "00") { $evt = 'nodeOk';
} elsif($id eq "01") { $evt = 'failedNodeRemoved';
} elsif($id eq "02") { $evt = 'failedNodeNotRemoved';
} else { $evt = 'unknown_'.$id; # should never happen
}
} elsif($cmd eq "ZW_REPLACE_FAILED_NODE") {
if($id eq "00") { $evt = 'nodeOk';
} elsif($id eq "03") { $evt = 'failedNodeReplace';
} elsif($id eq "04") { $evt = 'failedNodeReplaceDone';
} elsif($id eq "05") { $evt = 'failedNodeRemoveFailed';
} else { $evt = 'unknown_'.$id; # should never happen
}
}
if($evt) {
return "$cmd $evt" if($srcCmd);
DoTrigger($ioName, "$cmd $evt");
Log3 $ioName, 4, "$ioName $cmd $evt";
return "";
}
######################################
# device messages
if($cmd ne "APPLICATION_COMMAND_HANDLER") {
Log3 $ioName, 4, "$ioName unhandled command $cmd";
return ""
}
if($arg =~ m/^(..)(..)(.*)/ && $2 eq "c6") { # Danfoss Living Strangeness
Log3 $ioName, 4, "Class mod for Danfoss ($2)";
$arg = sprintf("%s%02x%s", $1, hex($2) & 0x7f, $3);
}
if($arg =~ /^..5601(.*)..../) { # CRC_16_ENCAP: Unwrap encapsulated command
#Log3 $ioName, 4, "CRC FIX, MSG: ($1)"; # see Forum #23494
$arg = sprintf("%02x$1", length($1)/2);
}
my ($baseHash, $baseId, $ep) = ("",$id,"");
if($arg =~ /^..6006(..)(.*)/) { # MULTI_CHANNEL CMD_ENCAP, V1, Forum #36126
$ep = $1;
$baseHash = $modules{ZWave}{defptr}{"$homeId $id"};
$id = "$id$ep";
$arg = sprintf("%02x$2", length($2)/2);
}
if($arg =~ /^..600d(..)(..)(.*)/) { # MULTI_CHANNEL CMD_ENCAP, V2
$ep = ($1 ne "00" ? $1 : $2);
$baseHash = $modules{ZWave}{defptr}{"$homeId $id"};
$id = "$id$ep";
$arg = sprintf("%02x$3", length($3)/2);
}
my $hash = $modules{ZWave}{defptr}{"$homeId $id"};
$baseHash = $hash if(!$baseHash);
if(!$hash) {
if(!$baseHash) {
Log3 $ioName, 1, "ZWave: unknown message $msg, please report";
return;
}
# autocreate the device when pressing the remote button (Forum #43261)
$id=hex($id); $baseId=hex($baseId); $ep=hex($ep);
my $nn = "ZWave_Node_$baseId".($ep eq "0" ? "" : ".$ep");
my $ret = "UNDEFINED $nn ZWave $homeId $id";
Log3 $ioName, 3, "$ret, please define it";
DoTrigger("global", $ret);
return "";
}
my $name = $hash->{NAME};
my @event;
my @args = ($arg); # MULTI_CMD handling
while(@args) {
$arg = shift(@args);
return if($arg !~ m/^..(..)/);
my $class = $1;
my $className = $zwave_id2class{lc($class)} ?
$zwave_id2class{lc($class)} : "UNKNOWN_".uc($class);
if($className eq "MULTI_CMD") {
my ($ncmd, $off) = (0, 4);
while(length($arg) > $off*2) {
my $l = hex(substr($arg, $off*2, 2))+1;
push @args, substr($arg, $off*2, $l*2);
$off += $l;
}
next;
}
if($className eq "VERSION" && defined($hash->{versionhash})) {
ZWave_versionClassRequest($hash, $arg);
return "";
}
my $ptr = ZWave_getHash($hash, $className, "parse");
if(!$ptr) {
push @event, "UNPARSED:$className $arg";
next;
}
my $matched = 0;
foreach my $k (keys %{$ptr}) {
if($arg =~ m/^$k/) {
my $val = $ptr->{$k};
$val = eval $val if(index($val, '$') >= 0);
push @event, $val if(defined($val));
$matched++;
}
}
foreach my $h (keys %zwave_parseHook) {
if("$id:$arg" =~ m/$h/) {
my $fn = $zwave_parseHook{$h};
delete $zwave_parseHook{$h};
$fn->($hash, $arg);
}
}
push @event, "UNPARSED:$className $arg" if(!$matched);
}
if($arg =~ m/^028407/) { # wakeup:notification
ZWave_wakeupTimer($hash, 1);
ZWave_processSendStack($hash);
}
return "" if(!@event);
readingsBeginUpdate($hash);
for(my $i = 0; $i < int(@event); $i++) {
next if($event[$i] eq "");
my ($vn, $vv) = split(":", $event[$i], 2);
readingsBulkUpdate($hash, $vn, $vv);
readingsBulkUpdate($hash, "reportedState", $vv)
if($vn eq "state"); # different from set
}
readingsEndUpdate($hash, 1);
return join("\n", @event) if($srcCmd);
return $name;
}
#####################################
sub
ZWave_Undef($$)
{
my ($hash, $arg) = @_;
my $homeId = $hash->{homeId};
my $id = $hash->{nodeIdHex};
delete $modules{ZWave}{defptr}{"$homeId $id"};
return undef;
}
#####################################
# Show the help from the device.xml, if the correct entry is selected
sub
ZWave_helpFn($$)
{
my ($d,$cmd) = @_;
my $mc = ZWave_configGetHash($defs{$d});
return "" if(!$mc);
my $h = $mc->{config}{$cmd};
return "" if(!$h || !$h->{Help});
return "Help for $cmd:<br>".$h->{Help};
}
sub
ZWave_fhemwebFn($$$$)
{
my ($FW_wname, $d, $room, $pageHash) = @_; # pageHash is set for summaryFn.
my $pl = ""; # Pepper link and image
my $model = ReadingsVal($d, "modelId", "");
if($model) {
my $link = $zwave_pepperLink{$model};
$pl .= "<div class='detLink ZWPepper'>";
$pl .= "<a target='_blank' href='http://www.pepper1.net/zwavedb/device/".
"$link'>Details in pepper1.net</a>" if($link);
$pl .= "</div>";
my $img = $zwave_pepperImg{$model};
if($img && !$FW_ss) {
$pl .= "<div class='img ZWPepper'".($FW_tp?"":" style='float:right'").">";
$pl .= "<img style='max-width:96;max-height:96px;' ".
"src='$FW_ME/deviceimages/zwave/$img'>";
$pl .= "</div>";
my $fn = $attr{global}{modpath}."/www/deviceimages/zwave/$img";
if(!-f $fn) { # Cache the picture
my $data = GetFileFromURL("http://fhem.de/deviceimages/zwave/$img");
if($data && open(FH,">$fn")) {
print FH $data;
close(FH)
}
}
}
}
return
"<div id='ZWHelp' class='makeTable help'></div>$pl".
'<script type="text/javascript">'.
"var d='$d', FW_tp='$FW_tp';" . <<'JSEND'
$(document).ready(function() {
$("div#ZWHelp").insertBefore("div.makeTable.wide:first"); // Move
$("div.detLink.ZWPepper").insertAfter("div.detLink.devSpecHelp");
if(FW_tp) $("div.img.ZWPepper").appendTo("div#menu");
$("select.set,select.get").each(function(){
$(this).get(0).setValueFn = function(val) {
$("div#ZWHelp").html(val);
}
$(this).change(function(){
FW_queryValue('{ZWave_helpFn("'+d+'","'+$(this).val()+'")}',
$(this).get(0));
});
});
});
</script>
JSEND
}
#####################################
# 2-byte signed hex
sub
s2Hex($)
{
my ($p) = @_;
$p = hex($p);
return ($p > 32767 ? -(65536-$p) : $p);
}
1;
=pod
=begin html
<a name="ZWave"></a>
<h3>ZWave</h3>
<ul>
This module is used to control ZWave devices via FHEM, see <a
href="http://www.z-wave.com">www.z-wave.com</a> on details for this device family.
This module is a client of the <a href="#ZWDongle">ZWDongle</a> module, which
is directly attached to the controller via USB or TCP/IP.
To use the SECURITY features, the Crypt-Rijndael perl module is needed.
<br><br>
<a name="ZWavedefine"></a>
<b>Define</b>
<ul>
<code>define &lt;name&gt; ZWave &lt;homeId&gt; &lt;id&gt; [classes]</code>
<br>
<br>
&lt;homeId&gt; is the homeId of the controller node, and id is the id of the
slave node in the network of this controller.<br>
classes is a hex-list of ZWave device classes. This argument is usually
specified by autocreate when creating a device. If you wish to manually
create a device, use the classes attribute instead, see below for details.
Defining a ZWave device the first time is usually done by autocreate.
<br>
Example:
<ul>
<code>define lamp ZWave 00ce2074 9</code><br>
<code>attr lamp classes SWITCH_BINARY BASIC MANUFACTURER_SPECIFIC VERSION
SWITCH_ALL ASSOCIATION METER CONFIGURATION ALARM</code><br>
</ul>
</ul>
<br>
Note: the sets/gets/generated events of a gven node depend on the classes
supported by this node. If a node supports 3 classes, then the union of
these sets/gets/events will be available for this node.<br>
Commands for battery operated nodes will be queues internally, and sent when
the node sends a message. Answer to get commands appear then as events, the
corresponding readings will be updated.
<br><br>
<a name="ZWaveset"></a>
<b>Set</b>
<ul>
<br>
<b>Note</b>: devices with on/off functionality support the <a
href="#setExtensions"> set extensions</a>.
<br><br><b>All</b>
<li>neighborUpdate<br>
Requests controller to update his routing table which is based on
slave's neighbor list. The update may take significant time to complete.
With the event "done" or "failed" ZWDongle will notify the end of the
update process. To read node's neighbor list see neighborList get
below.</li>
<br><br><b>Class ASSOCIATION</b>
<li>associationAdd groupId nodeId ...<br>
Add the specified list of nodeIds to the assotion group groupId.<br> Note:
upon creating a fhem-device for the first time fhem will automatically add
the controller to the first association group of the node corresponding to
the fhem device, i.e it issues a "set name associationAdd 1
controllerNodeId"</li>
<li>associationDel groupId nodeId ...<br>
Remove the specified list of nodeIds from the assotion group groupId.</li>
<li>associationRequest groupId<br>
corresponds to "get association", used by associationRequestAll</li>
<li>associationRequestAll<br>
request association info for all possibe groups.</li>
<br><br><b>Class BASIC</b>
<li>basicValue value<br>
Send value (0-255) to this device. The interpretation is device dependent,
e.g. for a SWITCH_BINARY device 0 is off and anything else is on.</li>
<li>basicValue value<br>
Alias for basicValue, to make mapping from the incoming events easier.
</li><br>
<br><br><b>Class BASIC_WINDOW_COVERING</b>
<li>coveringClose<br>
Starts closing the window cover. Moving stops if blinds are fully closed or
a coveringStop command was issued.
</li>
<li>coveringOpen<br>
Starts opening the window cover. Moving stops if blinds are fully open or
a coveringStop command was issued.
</li>
<li>coveringStop<br>
Stop moving the window cover. Blinds are partially open (closed).
</li>
<br><br><b>Class CLIMATE_CONTROL_SCHEDULE</b>
<li>ccs [mon|tue|wed|thu|fri|sat|sun] HH:MM tempDiff HH:MM tempDiff ...<br>
set the climate control schedule for the given day.<br>
Up to 9 pairs of HH:MM tempDiff may be specified.<br>
HH:MM must occur in increasing order.
tempDiff is relative to the setpoint temperature, and may be between -12
and 12, with one decimal point, measured in Kelvin (or Centigrade).
</li>
<br><br><b>Class CLOCK</b>
<li>clock<br>
set the clock to the current date/time (no argument required)
</li>
<br><br><b>Class COLOR_CONTROL</b>
<li>rgb<br>
Set the color of the device as a 6 digit RGB Value (RRGGBB), each color is
specified with a value from 00 to ff.</li>
<li>wcrgb<br>
Used for sending warm white, cold white, red, green and blue values
to device. Values must be decimal (0 - 255) and separated by blanks.
<ul>
set &lt;name&gt; wcrgb 0 255 0 0 0 (setting full cold white)<br>
</ul>
</li>
<br><br><b>Class CONFIGURATION</b>
<li>configByte cfgAddress 8bitValue<br>
configWord cfgAddress 16bitValue<br>
configLong cfgAddress 32bitValue<br>
Send a configuration value for the parameter cfgAddress. cfgAddress and
value is node specific.<br>
Note: if the model is set (see MANUFACTURER_SPECIFIC get), then more
specific config commands are available.</li>
<li>configDefault cfgAddress<br>
Reset the configuration parameter for the cfgAddress parameter to its
default value. See the device documentation to determine this value.</li>
<li>configRequestAll<br>
If the model of a device is set, and configuration descriptions are
available from the database for this device, then request the value of all
known configuration parameters.</li>
<br><br><b>Class INDICATOR</b>
<li>indicatorOn<br>
switch the indicator on</li>
<li>indicatorOff<br>
switch the indicator off</li>
<li>indicatorDim value<br>
takes values from 1 to 99.
If the indicator does not support dimming. It is interpreted as on.</li>
<br><br><b>Class MANUFACTURER_PROPRIETARY</b>
<li>positionBlinds<br>
Fibaro FGRM-222 only: drive blinds to position %</li>
<li>positionSlat<br>
Fibaro FGRM-222 only: drive slat to position %</li>
<br><br><b>Class METER</b>
<li>meterReset<br>
Reset all accumulated meter values.<br>
Note: see meterSupported command and its output to detect if resetting the
value is supported by the device.<br>
The command will reset ALL accumulated values, it is not possible to
choose a single value.</li>
<br><br><b>Class MULTI_CHANNEL_ASSOCIATION</b>
<li>mcaAdd groupId node1 node2 ... 0 node1 endPoint1 node2 endPoint2 ...<br>
Add a list of node or node:endpoint associations. The latter can be used to
create channels on remotes. E.g. to configure the button 1,2,... on the
zwave.me remote, use:
<ul>
set remote mcaAdd 2 0 1 2<br>
set remote mcaAdd 3 0 1 3<br>
....
</ul>
For each button a separate FHEM device will be generated.
</li>
<li>mcaDel groupId node1 node2 ... 0 node1 endPoint1 node2 endPoint2 ...<br>
delete node or node:endpoint associations.
Special cases: just specifying the groupId will delete everything for this
groupId. Specifying 0 for groupid will delete all associations.
</li>
<br><br><b>Class NODE_NAMING</b>
<li>name NAME<br>
Store NAME in the EEPROM. Note: only ASCII is supported.</li>
<li>location LOCATION<br>
Store LOCATION in the EEPROM. Note: only ASCII is supported.</li>
<br><br><b>Class POWERLEVEL</b>
<li>Class is only used in an installation or test situation</li>
<li>powerlevel level timeout/s<br>
set powerlevel to level [0-9] for timeout/s [1-255].<br>
level 0=normal, level 1=-1dBm, .., level 9=-9dBm.</li>
<li>powerlevelTest nodeId level frames <br>
send number of frames [1-65535] to nodeId with level [0-9].</li>
<br><br><b>Class PROTECTION</b>
<li>protectionOff<br>
device is unprotected</li>
<li>protectionOn<br>
device is protected</li>
<li>protectionSeq<br>
device can be operated, if a certain sequence is keyed.</li>
<li>protectionBytes LocalProtectionByte RFProtectionByte<br>
for commandclass PROTECTION V2 - see devicemanual for supported protectionmodes</li>
<br><br><b>Class SCENE_ACTIVATION</b>
<li>sceneConfig<br>
activate settings for a specific scene.
Parameters are: sceneId, dimmingDuration (00..ff)
</li>
<br><br><b>Class SCENE_ACTUATOR_CONF</b>
<li>sceneConfig<br>
set configuration for a specific scene.
Parameters are: sceneId, dimmingDuration, finalValue (00..ff)
</li>
<br><br><b>Class SCENE_CONTROLLER_CONF</b>
<li>groupConfig<br>
set configuration for a specific scene.
Parameters are: groupId, sceneId, dimmingDuration.
</li>
<br><br><b>Class SECURITY</b>
<li>secScheme<br>
(internaly used to) set the security scheme '00'
</li>
<li>sendNonce<br>
(internaly used to) send a security NONCE to the device
</li>
<li>secEncap<br>
(internaly used to) send an encrypted message to the device
</li>
<li>Notes:<br>
This class needs the installation of the perl module Crypt::Rijndael
and a defined networkkey in the attributes of the ZWDongle device<br>
Currently a secure inclusion can only be started from the command input
with "set &lt;ZWDongle_device_name&gt; addNode &lt;On|nwOn&gt; sec"<br>
These commands are only described here for completeness of the
documentation, but are not intended for manual usage. These commands
will be removed from the interface in future version.</li>
<br><br><b>Class SWITCH_ALL</b>
<li>swaIncludeNone<br>
the device does not react to swaOn and swaOff commands</li>
<li>swaIncludeOff<br>
the device reacts to the swaOff command
but does not react to the swaOn command</li>
<li>swaIncludeOn<br>
the device reacts to the swaOn command
but does not react to the swaOff command</li>
<li>swaIncludeOnOff<br>
the device reacts to the swaOn and swaOff commands</li>
<li>swaOn<br>
sends the all on command to the device</li>
<li>swaOff<br>
sends the all off command to the device.</li>
<br><br><b>Class SWITCH_BINARY</b>
<li>on<br>
switch the device on</li>
<li>off<br>
switch the device off</li>
<br><br><b>Class SWITCH_MULTILEVEL</b>
<li>on, off<br>
the same as for SWITCH_BINARY.</li>
<li>dim value<br>
dim/jump to the requested value (0..100)</li>
<li>stop<br>
stop dimming/operation</li>
<br><br><b>Class THERMOSTAT_MODE</b>
<li>tmOff</li>
<li>tmCooling</li>
<li>tmHeating</li>
<li>tmManual<br>
set the thermostat mode to off, cooling, heating or manual.
</li>
<br><br><b>Class THERMOSTAT_SETPOINT</b>
<li>setpointHeating value<br>
set the thermostat to heat to the given value.
The value is a whole number and read as celsius.
</li>
<li>setpointCooling value<br>
set the thermostat to heat to the given value.
The value is a whole number and read as celsius.
</li>
<br><br><b>Class USER_CODE</b>
<li>userCode id status code</br>
set code and status for the id n. n ist starting at 1, status is 0 for
available (deleted) and 1 for set (occupied). code is a hexadecimal string.
</li>
<br><br><b>Class VERSION</b>
<li>versionClassRequest<br>
executes "get devicename versionClass class" for each class from the
classes attribute in the background without generating events, and sets the
vclasses attribute at the end.
</li>
<br><br><b>Class WAKE_UP</b>
<li>wakeupInterval value nodeId<br>
Set the wakeup interval of battery operated devices to the given value in
seconds. Upon wakeup the device sends a wakeup notification to nodeId.</li>
<li>wakeupNoMoreInformation<br>
put a battery driven device into sleep mode. </li>
</ul>
<br>
<a name="ZWaveget"></a>
<b>Get</b>
<ul>
<br><br><b>All</b>
<li>neighborList<br>
returns the list of neighbors. Provides insights to actual network
topology. List includes dead links and non-routing neighbors.
Since this information is stored in the dongle, the information will be
returned directly even for WAKE_UP devices.</li>
<br><br><b>Class ALARM</b>
<li>alarm alarmId<br>
return the value for alarmId. The value is device specific.
</li>
<br><br><b>Class ASSOCIATION</b>
<li>association groupId<br>
return the list of nodeIds in the association group groupId in the form:<br>
assocGroup_X:Max Y, Nodes id,id...
</li>
<li>associationGroups<br>
return the number of association groups<br>
</li>
<br><br><b>Class ASSOCIATION_GRP_INFO</b>
<li>associationGroupName groupId<br>
return the name of association groups
</li>
<li>associationGroupCmdList groupId<br>
return Command Classes and Commands that will be sent to associated
devices in this group<br>
</li>
<br><b>Class BASIC</b>
<li>basicStatus<br>
return the status of the node as basicReport:XY. The value (XY) depends on
the node, e.g a SWITCH_BINARY device report 00 for off and FF (255) for on.
</li>
<br><br><b>Class BATTERY</b>
<li>battery<br>
return the charge of the battery in %, as battery:value % or battery:low
</li>
<br><br><b>Class CLIMATE_CONTROL_SCHEDULE</b>
<li>ccsOverride<br>
request the climate control schedule override report
</li>
<li>ccs [mon|tue|wed|thu|fri|sat|sun]<br>
request the climate control schedule for the given day.
</li>
<br><br><b>Class CLOCK</b>
<li>clock<br>
request the clock data
</li>
<br><br><b>Class COLOR_CONTROL</b>
<li>ccCapability<br>
return capabilities.</li>
<li>ccStatus channelId<br>
return status of channel ChannelId.
</li>
<br><br><b>Class CONFIGURATION</b>
<li>config cfgAddress<br>
return the value of the configuration parameter cfgAddress. The value is
device specific.<br>
Note: if the model is set (see MANUFACTURER_SPECIFIC get), then more
specific config commands are available.
</li>
<br><br><b>Class DOOR_LOCK</b>
<li>doorLockConfiguration cfgAddress<br>
return the configuration of the door lock.<br>
</li>
<br><br><b>Class HRV_STATUS</b>
<li>hrvStatus<br>
report the current status (temperature, etc)
</li>
<li>hrvStatusSupported<br>
report the supported status fields as a bitfield.
</li>
<br><br><b>Class INDICATOR</b>
<li>indicatorStatus<br>
return the indicator status of the node, as indState:on, indState:off or
indState:dim value.
</li>
<br><br><b>Class MANUFACTURER_PROPRIETARY</b>
<li>position<br>
Fibaro FGRM-222 only: return the blinds position and slat angle.
</li>
<br><br><b>Class MANUFACTURER_SPECIFIC</b>
<li>model<br>
return the manufacturer specific id (16bit),
the product type (16bit)
and the product specific id (16bit).<br>
Note: if the openzwave xml files are installed, then return the name of the
manufacturer and of the product. This call is also necessary to decode more
model specific configuration commands and parameters.
</li>
<br><br><b>Class METER</b>
<li>meter scale<br>
return the meter report for the requested scale.<br>
Note: protocol V1 does not support the scale parameter, the parameter will
be ignored and the default scale will be returned.<br>
For protocol V2 and higher, scale is supported and depends on the type of
the meter (energy, gas or water).<br>
The device may not support all scales, see the meterSupported command and
its output. If the scale parameter is omitted, the default unit will be
reported.<br>
Example: For an electric meter, meter 0 will report energy in kWh,
meter 2 will report power in W and meter 6 will report current in A
(if these scales are supported).<br>
</li>
<li>meterSupported<br>
request the type of the meter, the supported scales and the capability to
reset the accumulated value.<br>
Note: The output contains the decimal numbers of the supported scales that
can be used as parameter for the meter command.
</li>
<br><br><b>Class MULTI_CHANNEL</b>
<li>mcEndpoints<br>
return the list of endpoints available, e.g.:<br>
mcEndpoints: total 2, identical
</li>
<li>mcCapability chid<br>
return the classes supported by the endpoint/channel chid. If the channel
does not exists, create a FHEM node for it. Example:<br>
mcCapability_02:SWITCH_BINARY<br>
<b>Note:</b> This is the best way to create the secondary nodes of a
MULTI_CHANNEL device. The device is only created for channel 2 or greater.
</li>
<br><br><b>Class MULTI_CHANNEL_ASSOCIATION</b>
<li>mca groupid<br>
return the associations for the groupid. for the syntax of the returned
data see the mcaAdd command above.
</li>
<br><br><b>Class NODE_NAMING</b>
<li>name<br>
Get the name from the EEPROM. Note: only ASCII is supported.</li>
<li>location<br>
Get the location from the EEPROM. Note: only ASCII is supported.</li>
<br><br><b>Class POWERLEVEL</b>
<li>powerlevel<br>
Get the current powerlevel and remaining time in this level.</li>
<li>powerlevelTest<br>
Get the result of last powerlevelTest.</li>
<br><br><b>Class PROTECTION</b>
<li>protection<br>
returns the protection state. It can be on, off or seq.</li>
<br><br><b>Class SCENE_ACTUATOR_CONF</b>
<li>sceneConfig<br>
returns the settings for a given scene. Parameter is sceneId
</li>
<br><br><b>Class SCENE_CONTROLLER_CONF</b>
<li>groupConfig<br>
returns the settings for a given group. Parameter is groupId
</li>
<br><br><b>Class SECURITY</b>
<li>secSupported<br>
(internaly used to) request the command classes that are supported
with SECURITY
</li>
<li>secNonce<br>
(internaly used to) request a security NONCE from the device
</li>
<li>secEncap<br>
(internaly used to) send an encrypted message to the device
</li>
<li>Notes:<br>
This class needs the installation of the perl module Crypt::Rijndael and
a defined networkkey in the attributes of the ZWDongle device<br>
Currently a secure inclusion can only be started from the command input
with "set &lt;ZWDongle_device_name&gt; addNode &lt;On|nwOn&gt; sec"<br>
These commands are only described here for completeness of the
documentation, but are not intended for manual usage. These commands
will be removed from the interface in future version.</li>
<br><br><b>Class SENSOR_ALARM</b>
<li>alarm alarmType<br>
return the nodes alarm status of the requested alarmType. 00 = GENERIC,
01 = SMOKE, 02 = CO, 03 = CO2, 04 = HEAT, 05 = WATER, ff = returns the
nodes first supported alarm type.
</li>
<br><br><b>Class SENSOR_BINARY</b>
<li>sbStatus<br>
return the status of the node.
</li>
<br><br><b>Class SENSOR_MULTILEVEL</b>
<li>smStatus<br>
request data from the node (temperature/humidity/etc)
</li>
<br><br><b>Class SWITCH_ALL</b>
<li>swaInclude<br>
return the switch-all mode of the node.
</li>
<br><br><b>Class SWITCH_BINARY</b>
<li>swbStatus<br>
return the status of the node, as state:on or state:off.
</li>
<br><br><b>Class SWITCH_MULTILEVEL</b>
<li>swmStatus<br>
return the status of the node, as state:on, state:off or state:dim value.
</li>
<br><br><b>Class THERMOSTAT_MODE</b>
<li>thermostatMode<br>
request the mode
</li>
<br><br><b>Class THERMOSTAT_SETPOINT</b>
<li>setpoint<br>
request the setpoint
</li>
<br><br><b>Class USER_CODE</b>
<li>userCode n</br>
request status and code for the id n
</li>
<br><br><b>Class VERSION</b>
<li>version<br>
return the version information of this node in the form:<br>
Lib A Prot x.y App a.b
</li>
<li>versionClass classId or className<br>
return the supported command version for the requested class
</li>
<br><br><b>Class WAKE_UP</b>
<li>wakeupInterval<br>
return the wakeup interval in seconds, in the form<br>
wakeupReport:interval seconds target id
</li>
<li>wakeupIntervalCapabilities (V2 only)<br>
return the wake up interval capabilities in seconds, in the form<br>
wakeupIntervalCapabilitiesReport:min seconds max seconds default seconds
step seconds
</li>
<br><br><b>Class ZWAVEPLUS_INFO</b>
<li>zwavePlusInfo<br>
request the zwavePlusInfo
</li>
</ul>
<br>
<a name="ZWaveattr"></a>
<b>Attributes</b>
<ul>
<li><a href="#IODev">IODev</a></li>
<li><a name="WNMI_delay">WNMI_delay</a>
This attribute set the time delay between the last message sent to an
WakeUp device and the sending of the WNMI Message
(WakeUpNoMoreInformation) that will set the device to sleep mode. Value
is in seconds, subseconds my be specified. Values outside of 0.2-5.0 are
probably harmful.
</li>
<li><a href="#do_not_notify">do_not_notify</a></li>
<li><a href="#ignore">ignore</a></li>
<li><a href="#dummy">dummy</a></li>
<li><a href="#showtime">showtime</a></li>
<li><a href="#readingFnAttributes">readingFnAttributes</a></li>
<li><a href="#classes">classes</a>
This attribute is needed by the ZWave module, as the list of the possible
set/get commands depends on it. It contains a space separated list of
class names (capital letters).
</li>
<li><a href="#secure_classes">secure_classes</a>
This attribute is the result of the "get DEVICE secSupported" command. It
contains a space seperated list of the the command classes that
supported with SECURITY.
</li>
<li><a href="#vclasses">vclasses</a>
This is the result of the "set DEVICE versionClassRequest" command, and
contains the version information for each of the supported classes.
</li>
<li><a href="#noExplorerFrames">noExplorerFrames</a>
turn off the use of Explorer Frames
</li>
</ul>
<br>
<a name="ZWaveevents"></a>
<b>Generated events:</b>
<ul>
<br><b>Class ALARM</b>
<li>Devices with class version 1 support: alarm_type_X:level Y</li>
<li>For higher class versions more detailed events with 100+ different
strings in the form alarm:<string> are generated.</li>
<br><br><b>Class ASSOCIATION</b>
<li>assocGroup_X:Max Y Nodes A,B,...</li>
<li>assocGroups:X</li>
<br><br><b>Class ASSOCIATION_GRP_INFO</b>
<li>assocGroupName_X:name</li>
<li>assocGroupCmdList_X:AABBCCDD...</li>
<br><br><b>Class BASIC</b>
<li>basicReport:XY</li>
<li>state:basicGet</li>
<li>state:basicSet XY</li>
<br><br><b>Class BASIC_WINDOW_COVERING</b>
<li>covering:[open:close:stop]</li>
<br><br><b>Class BATTERY</b>
<li>battery:chargelevel %</li>
<br><br><b>Class CENTRAL_SCENE</b>
<li>cSceneSet:X</li>
<li>cSceneDim:X</li>
<li>cSceneDimEnd:X</li>
<li>cSceneDouble:X</li>
<br><br><b>Class CLIMATE_CONTROL_SCHEDULE</b>
<li>ccsOverride:[no|temporary|permanent],
[frost protection|energy saving|unused]</li>
<li>ccsChanged:<number></li>
<li>ccs_[mon|tue|wed|thu|fri|sat|sun]:HH:MM temp HH:MM temp...</li>
<br><br><b>Class CLOCK</b>
<li>clock:get</li>
<li>clock:[mon|tue|wed|thu|fri|sat|sun] HH:MM</li>
<br><br><b>Class COLOR_CONTROL</b>
<li>ccCapability:XY</li>
<li>ccStatus_X:Y</li>
<br><br><b>Class CONFIGURATION</b>
<li>config_X:Y<br>
Note: if the model is set (see MANUFACTURER_SPECIFIC get), then more
specific config messages are available.</li>
<br><br><b>Class DEVICE_RESET_LOCALLY</b>
<li>deviceResetLocally:yes<br></li>
<br><br><b>Class HAIL</b>
<li>hail:01<br></li>
<br><br><b>Class HRV_STATUS</b>
<li>outdoorTemperature: %0.1f C</li>
<li>supplyAirTemperature: %0.1f C</li>
<li>exhaustAirTemperature: %0.1f C</li>
<li>dischargeAirTemperature: %0.1f C</li>
<li>indoorTemperature: %0.1f C</li>
<li>indoorHumidity: %s %</li>
<li>remainingFilterLife: %s %</li>
<li>supportedStatus: <list of supported stati></li>
<br><br><b>Class INDICATOR</b>
<li>indState:[on|off|dim value]</li>
<br><br><b>Class MANUFACTURER_PROPRIETARY</b>
<li>Fibaro FGRM-222 with ReportsType Fibar CC only:</li>
<li>position:Blind [%] Slat [%]<br>
(VenetianBlindMode)</li>
<li>position:[%]<br>
(RollerBlindMode)</li>
<br><br><b>Class MANUFACTURER_SPECIFIC</b>
<li>modelId:hexValue hexValue hexValue</li>
<li>model:manufacturerName productName</li>
<li>modelConfig:configLocation</li>
<br><br><b>Class METER</b>
<li>energy:val [kWh|kVAh|pulseCount|powerFactor]</li>
<li>gas:val [m3|feet3|pulseCount]</li>
<li>water:val [m3|feet3|USgallons|pulseCount]</li>
<li>power:val W</li>
<li>voltage:val V</li>
<li>current:val A</li>
<li>meterSupported:type:[meter_type] scales:[list of supported scales]
resetable:[yes|no]</li>
<br><br><b>Class MULTI_CHANNEL</b>
<li>endpoints:total X $dynamic $identical</li>
<li>mcCapability_X:class1 class2 ...</li>
<br><br><b>Class NODE_NAMING</b>
<li>name:NAME</li>
<li>location:LOCATION</li>
<br><br><b>Class POWERLEVEL</b>
<li>powerlvl:current x remain y<br>
NOTE: "current 0 remain 0" means normal mode without timeout</li>
<li>powerlvlTest:node x status y frameAck z<br>
NOTE: status 0=failed, 1=success (at least one ACK), 2=in progress</li>
<br><br><b>Class PROTECTION</b>
<li>protection:[on|off|seq]</li>
<br><br><b>Class SCENE_ACTIVATION</b>
<li>scene_Id:level finalValue</li>
<br><br><b>Class SCENE_ACTUATOR_CONF</b>
<li>scene_Id:level dimmingDuration finalValue</li>
<br><br><b>Class SCENE_CONTROLLER_CONF</b>
<li>group_Id:scene dimmingDuration</li>
<br><br><b>Class SECURITY</b>
<li>none<br>
Note: the class security should work transparent to the sytem and is not
intended to generate event</li>
<br><br><b>Class SENSOR_ALARM</b>
<li>alarm_type_X:level Y node $nodeID seconds $seconds</li>
<br><br><b>Class SENSOR_BINARY</b>
<li>SENSORY_BINARY V1:</li>
<li>state:open</li>
<li>state:closed</li>
<li>SENSORY_BINARY V2:</li>
<li>unknown:[00|ff]</li>
<li>generalPurpose:[00|ff]</li>
<li>smoke:[00|ff]</li>
<li>CO:[00|ff]</li>
<li>CO2:[00|ff]</li>
<li>heat:[00|ff]</li>
<li>water:[00|ff]</li>
<li>freeze:[00|ff]</li>
<li>tamper:[00|ff]</li>
<li>aux:[00|ff]</li>
<li>doorWindow:[00|ff]</li>
<li>tilt:[00|ff]</li>
<li>motion:[00|ff]</li>
<li>glassBreak:[00|ff]</li>
<br><br><b>Class SENSOR_MULTILEVEL</b>
<li>temperature $val [C|F]</li>
<li>generalPurpose $val %</li>
<li>luminance $val [%|Lux]</li>
<li>power $val [W|Btu/h]</li>
<li>humidity $val %</li>
<li>velocity $val [m/s|mph]</li>
<li>direction $val</li>
<li>atmosphericPressure $val [kPa|inchHg]</li>
<li>barometricPressure $val [kPa|inchHg]</li>
<li>solarRadiation $val W/m2</li>
<li>dewpoint $val [C|F]</li>
<li>rain $val [mm/h|in/h]</li>
<li>tideLevel $val [m|feet]</li>
<li>weight $val [kg|pound]</li>
<li>voltage $val [V|mV]</li>
<li>current $val [A|mA]</li>
<li>CO2-level $val ppm</li>
<li>airFlow $val [m3/h|cfm]</li>
<li>tankCapacity $val [l|cbm|usgal]</li>
<li>distance $val [m|cm|feet]</li>
<li>anglePosition $val [%|relN|relS]</li>
<li>rotation $val [rpm|Hz]</li>
<li>waterTemperature $val [C|F]</li>
<li>soilTemperature $val [C|F]</li>
<li>seismicIntensity $val [mercalli|EU macroseismic|liedu|shindo]</li>
<li>seismicMagnitude $val [local|moment|surface wave|body wave]</li>
<li>ultraviolet $val [UV]</li>
<li>electricalResistivity $val [ohm]</li>
<li>electricalConductivity $val [siemens/m]</li>
<li>loudness $val [dB|dBA]</li>
<li>moisture $val [%|content|k ohms|water activity]</li>
<li>frequency $val [Hz|kHz]</li>
<li>time $val [seconds]</li>
<li>targetTemperature $val [C|F]</li>
<li>particulateMatter $val [mol/m3|micro-g/m3]</li>
<li>formaldehydeLevel $val [mol/m3]</li>
<li>radonConcentration $val [bq/m3|pCi/L]</li>
<li>methaneDensity $val [mol/m3]</li>
<li>volatileOrganicCompound $val [mol/m3]</li>
<li>carbonMonoxide $val [mol/m3]</li>
<li>soilHumidity $val [%]</li>
<li>soilReactivity $val [pH]</li>
<li>soilSalinity $val [mol/m3]</li>
<li>heartRate $val [Bpm]</li>
<li>bloodPressure $val [Systolic mmHg|Diastolic mmHg]</li>
<li>muscleMass $val [Kg]</li>
<li>fatMass $val [Kg]</li>
<li>boneMass $val [Kg]</li>
<li>totalBodyWater $val [Kg]</li>
<li>basicMetabolicRate $val [J]</li>
<li>bodyMassIndex $val [BMI]</li>
<br><br><b>Class SWITCH_ALL</b>
<li>swa:[none|on|off|on off]</li>
<br><br><b>Class SWITCH_BINARY</b>
<li>state:on</li>
<li>state:off</li>
<li>state:setOn</li>
<li>state:setOff</li>
<br><br><b>Class SWITCH_MULTILEVEL</b>
<li>state:on</li>
<li>state:off</li>
<li>state:dim value</li>
<li>state:swmBeginUp</li>
<li>state:swmBeginDown</li>
<li>state:swmEnd</li>
<br><br><b>Class THERMOSTAT_MODE</b>
<li>off</li>
<li>cooling</li>
<li>heating</li>
<li>manual</li>
<li>setTmOff</li>
<li>setTmHeating</li>
<li>setTmCooling</li>
<li>setTmManual</li>
<br><br><b>Class THERMOSTAT_SETPOINT</b>
<li>setpointTemp:$temp [C|F] [heating|cooling]</li>
<br><br><b>Class USER_CODE</b>
<li>userCode:id x status y code z</li>
<br><br><b>Class VERSION</b>
<li>V1:</li>
<li>version:Lib A Prot x.y App a.b</li>
<li>V2:</li>
<li>version:Lib A Prot x.y App a.b HW B FWCounter C FW c.d</li>
<li>V1 and V2:</li>
<li>versionClass_$classId:$version</li>
<br><br><b>Class WAKE_UP</b>
<li>wakeup:notification</li>
<li>wakeupReport:interval:X target:Y</li>
<li>wakeupIntervalCapabilitiesReport:min W max X default Y step Z</li>
<br><br><b>Class ZWAVEPLUS_INFO</b>
<li>zwavePlusInfo:version: V role: W node: X installerIcon: Y userIcon: Z</li>
</ul>
</ul>
=end html
=cut
Reference in New Issue View Git Blame Copy Permalink