mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-01-31 12:49:34 +00:00
429 lines
13 KiB
Perl
429 lines
13 KiB
Perl
#!/usr/bin/perl -w
|
|
|
|
##########################################################################
|
|
# This file is part of the smarthomatic module for FHEM.
|
|
#
|
|
# Copyright (c) 2014, 2015, 2019 Uwe Freese
|
|
#
|
|
# You can find smarthomatic at www.smarthomatic.org.
|
|
# You can find FHEM at www.fhem.de.
|
|
#
|
|
# This file is free software: you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by the
|
|
# Free Software Foundation, either version 3 of the License, or (at your
|
|
# option) any later version.
|
|
#
|
|
# This file is distributed in the hope that it will be useful, but
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
|
|
# Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License along
|
|
# with smarthomatic. If not, see <http://www.gnu.org/licenses/>.
|
|
##########################################################################
|
|
# Usage:
|
|
#
|
|
# Init parser:
|
|
# ------------
|
|
# my $parser = new SHC_parser();
|
|
#
|
|
# Receiving packets:
|
|
# ------------------
|
|
# 1.) Receive string from base station (over UART).
|
|
# 2.) Check CRC (last 8 characters, optional).
|
|
# 3.) Parse received string:
|
|
# $parser->parse("PKT:SID=22;...");
|
|
# 4.) Get MessageGroupName: my $grp = $parser->getMessageGroupName();
|
|
# 5.) Get MessageName: my $msg = $parser->getMessageName();
|
|
# 6.) Get data fields depending on MessageGroupName and MessageName, e.g.
|
|
# $val = $parser->getField("Temperature");
|
|
#
|
|
# Sending packets:
|
|
# ----------------
|
|
# 1.) Init packet:
|
|
# $parser->initPacket("PowerSwitch", "SwitchState", "Set");
|
|
# 2.) Set fields:
|
|
# $parser->setField("PowerSwitch", "SwitchState", "TimeoutSec", 8);
|
|
# 3.) Get send string: $str = $parser->getSendString($receiverID);
|
|
# It includes a CRC32 as last 8 characters.
|
|
# 4.) Send string to base station (over UART).
|
|
##########################################################################
|
|
# $Id$
|
|
|
|
package SHC_parser;
|
|
|
|
use strict;
|
|
use feature qw(switch);
|
|
use XML::LibXML;
|
|
use SHC_datafields;
|
|
use Digest::CRC qw(crc32); # linux packet libdigest-crc-perl
|
|
|
|
# Hash for data field definitions.
|
|
my %dataFields = ();
|
|
|
|
# Hashes used to translate between names and IDs.
|
|
my %messageTypeID2messageTypeName = ();
|
|
my %messageTypeName2messageTypeID = ();
|
|
|
|
my %messageGroupID2messageGroupName = ();
|
|
my %messageGroupName2messageGroupID = ();
|
|
|
|
my %messageID2messageName = ();
|
|
my %messageName2messageID = ();
|
|
|
|
my %messageID2bits = ();
|
|
|
|
# byte array to store data to send
|
|
my @msgData = ();
|
|
my $sendMode = 0;
|
|
|
|
my $offset = 0;
|
|
|
|
sub new
|
|
{
|
|
my $class = shift;
|
|
init_datafield_positions();
|
|
my $self = {
|
|
_senderID => 0,
|
|
_packetCounter => 0,
|
|
_messageTypeID => 0,
|
|
_messageGroupID => 0,
|
|
_messageGroupName => "",
|
|
_messageID => 0,
|
|
_messageName => "",
|
|
_messageData => "",
|
|
};
|
|
bless $self, $class;
|
|
return $self;
|
|
}
|
|
|
|
sub init_datafield_positions_noarray($$$$$)
|
|
{
|
|
my ($messageGroupID, $messageID, $field, $arrayLength, $arrayElementBits) = @_;
|
|
|
|
if ($field->nodeName eq "UIntValue") {
|
|
my $id = ($field->findnodes("ID"))[0]->textContent;
|
|
my $bits = ($field->findnodes("Bits"))[0]->textContent;
|
|
|
|
# print "Data field " . $id . " starts at " . $offset . " with " . $bits . " bits.\n";
|
|
|
|
$dataFields{$messageGroupID . "-" . $messageID . "-" . $id} =
|
|
new UIntValue($id, $offset, $bits, $arrayLength, $arrayElementBits);
|
|
|
|
$offset += $bits;
|
|
} elsif ($field->nodeName eq "IntValue") {
|
|
my $id = ($field->findnodes("ID"))[0]->textContent;
|
|
my $bits = ($field->findnodes("Bits"))[0]->textContent;
|
|
|
|
# print "Data field " . $id . " starts at " . $offset . " with " . $bits . " bits.\n";
|
|
|
|
$dataFields{$messageGroupID . "-" . $messageID . "-" . $id} =
|
|
new IntValue($id, $offset, $bits, $arrayLength, $arrayElementBits);
|
|
|
|
$offset += $bits;
|
|
} elsif ($field->nodeName eq "FloatValue") {
|
|
my $id = ($field->findnodes("ID"))[0]->textContent;
|
|
my $bits = 32;
|
|
|
|
# print "Data field " . $id . " starts at " . $offset . " with " . $bits . " bits.\n";
|
|
|
|
$dataFields{$messageGroupID . "-" . $messageID . "-" . $id} =
|
|
new FloatValue($id, $offset, $arrayLength, $arrayElementBits);
|
|
|
|
$offset += $bits;
|
|
} elsif ($field->nodeName eq "BoolValue") {
|
|
my $id = ($field->findnodes("ID"))[0]->textContent;
|
|
my $bits = 1;
|
|
|
|
# print "Data field " . $id . " starts at " . $offset . " with " . $bits . " bits.\n";
|
|
|
|
$dataFields{$messageGroupID . "-" . $messageID . "-" . $id} =
|
|
new BoolValue($id, $offset, $arrayLength, $arrayElementBits);
|
|
|
|
$offset += $bits;
|
|
} elsif ($field->nodeName eq "EnumValue") {
|
|
my $id = ($field->findnodes("ID"))[0]->textContent;
|
|
my $bits = ($field->findnodes("Bits"))[0]->textContent;
|
|
|
|
# print "Data field " . $id . " starts at " . $offset . " with " . $bits . " bits.\n";
|
|
|
|
my $object = new EnumValue($id, $offset, $bits, $arrayLength, $arrayElementBits);
|
|
$dataFields{$messageGroupID . "-" . $messageID . "-" . $id} = $object;
|
|
|
|
for my $element ($field->findnodes("Element")) {
|
|
my $value = ($element->findnodes("Value"))[0]->textContent;
|
|
my $name = ($element->findnodes("Name"))[0]->textContent;
|
|
|
|
$object->addValue($name, $value);
|
|
|
|
# print "Enum value " . $value . " -> " . $name . "\n";
|
|
}
|
|
|
|
$offset += $bits;
|
|
} elsif ($field->nodeName eq "ByteArray") {
|
|
my $id = ($field->findnodes("ID"))[0]->textContent;
|
|
my $bytes = ($field->findnodes("Bytes"))[0]->textContent;
|
|
|
|
# print "Data field " . $id . " starts at " . $offset . " with " . $bytes . " bytes.\n";
|
|
|
|
$dataFields{$messageGroupID . "-" . $messageID . "-" . $id} =
|
|
new ByteArray($id, $offset, $bytes, $arrayLength, $arrayElementBits);
|
|
|
|
$offset += $bytes * 8;
|
|
}
|
|
}
|
|
|
|
sub init_datafield_positions_array($$$)
|
|
{
|
|
my ($messageGroupID, $messageID, $field) = @_;
|
|
my $offsetStartArray = $offset;
|
|
|
|
my $arrayLength = int(($field->findnodes("Length"))[0]->textContent);
|
|
|
|
my $arrayElementBits =
|
|
calc_array_bits_ovr($field); # number of bits for one struct ("set of sub-elements") in a structured array
|
|
# print "Next field is an array with " . $arrayLength . " elements (" . $arrayElementBits . " ovr bits per array element)!\n";
|
|
|
|
for my $subfield ($field->findnodes("UIntValue|IntValue|FloatValue|BoolValue|EnumValue|ByteArray")) {
|
|
my $bits =
|
|
init_datafield_positions_noarray($messageGroupID, $messageID, $subfield, $arrayLength, $arrayElementBits);
|
|
}
|
|
|
|
$offset = $offsetStartArray + $arrayLength * $arrayElementBits;
|
|
}
|
|
|
|
# Calculate the overall bits for one struct in a structured array
|
|
sub calc_array_bits_ovr($)
|
|
{
|
|
my ($field) = @_;
|
|
my $bits = 0;
|
|
|
|
for my $subfield ($field->findnodes("BoolValue")) {
|
|
$bits += 1;
|
|
}
|
|
|
|
for my $subfield ($field->findnodes("UIntValue|IntValue|EnumValue")) {
|
|
$bits += ($subfield->findnodes("Bits"))[0]->textContent;
|
|
}
|
|
|
|
for my $subfield ($field->findnodes("FloatValue")) {
|
|
$bits += 32;
|
|
}
|
|
|
|
for my $subfield ($field->findnodes("ByteArray")) {
|
|
$bits += ($subfield->findnodes("Bytes"))[0]->textContent * 8;
|
|
}
|
|
|
|
return $bits;
|
|
}
|
|
|
|
# Read packet layout from XML file and remember the defined MessageGroups,
|
|
# Messages and data fields (incl. positions, length).
|
|
sub init_datafield_positions()
|
|
{
|
|
my $x = XML::LibXML->new() or die "new on XML::LibXML failed";
|
|
my $d = $x->parse_file("FHEM/lib/SHC_packet_layout.xml") or die "parsing XML file failed";
|
|
|
|
for my $element ($d->findnodes("/Packet/Header/EnumValue[ID='MessageType']/Element")) {
|
|
my $value = ($element->findnodes("Value"))[0]->textContent;
|
|
my $name = ($element->findnodes("Name"))[0]->textContent;
|
|
|
|
$messageTypeID2messageTypeName{$value} = $name;
|
|
$messageTypeName2messageTypeID{$name} = $value;
|
|
}
|
|
|
|
for my $messageGroup ($d->findnodes("/Packet/MessageGroup")) {
|
|
my $messageGroupName = ($messageGroup->findnodes("Name"))[0]->textContent;
|
|
my $messageGroupID = ($messageGroup->findnodes("MessageGroupID"))[0]->textContent;
|
|
|
|
$messageGroupID2messageGroupName{$messageGroupID} = $messageGroupName;
|
|
$messageGroupName2messageGroupID{$messageGroupName} = $messageGroupID;
|
|
|
|
for my $message ($messageGroup->findnodes("Message")) {
|
|
my $messageName = ($message->findnodes("Name"))[0]->textContent;
|
|
my $messageID = ($message->findnodes("MessageID"))[0]->textContent;
|
|
|
|
$messageID2messageName{$messageGroupID . "-" . $messageID} = $messageName;
|
|
$messageName2messageID{$messageGroupName . "-" . $messageName} = $messageID;
|
|
|
|
$offset = 0;
|
|
|
|
for my $field ($message->findnodes("Array|UIntValue|IntValue|FloatValue|BoolValue|EnumValue|ByteArray")) {
|
|
|
|
# When an array is detected, remember the array length and change the current field node
|
|
# to the inner node for further processing.
|
|
if ($field->nodeName eq 'Array') {
|
|
init_datafield_positions_array($messageGroupID, $messageID, $field);
|
|
} else {
|
|
init_datafield_positions_noarray($messageGroupID, $messageID, $field, 1, 0);
|
|
}
|
|
}
|
|
|
|
# DEBUG print "Remember packet length " . $offset . " bits for MessageGroupID " . $messageGroupID . ", MessageID " . $messageID . "\n";
|
|
|
|
$messageID2bits{$messageGroupID . "-" . $messageID} = $offset;
|
|
}
|
|
}
|
|
}
|
|
|
|
sub parse
|
|
{
|
|
my ($self, $msg) = @_;
|
|
|
|
$sendMode = 0;
|
|
|
|
# PKT:SID=56;PC=1816;MT=3;RID=0;MGID=45;MID=1;MD=010105;efc28d5e
|
|
if (
|
|
(
|
|
$msg =~
|
|
/^PKT:SID=(\d+);PC=(\d+);MT=(\d+);MGID=(\d+);MID=(\d+);MD=([^;]+);.*/
|
|
)
|
|
|| ($msg =~
|
|
/^PKT:SID=(\d+);PC=(\d+);MT=(3);RID=0;MGID=(\d+);MID=(\d+);MD=([^;]+);.*/
|
|
)
|
|
|| ($msg =~
|
|
/^PKT:SID=(\d+);PC=(\d+);MT=(\d+);ASID=\d+;APC=\d+;E=\d+;MGID=(\d+);MID=(\d+);MD=([^;]+);.*/
|
|
)
|
|
)
|
|
{
|
|
$self->{_senderID} = $1;
|
|
$self->{_packetCounter} = $2;
|
|
$self->{_messageTypeID} = $3;
|
|
$self->{_messageGroupID} = $4;
|
|
$self->{_messageID} = $5;
|
|
$self->{_messageData} = $6;
|
|
}
|
|
|
|
else {
|
|
return undef;
|
|
}
|
|
}
|
|
|
|
sub getSenderID
|
|
{
|
|
my ($self) = @_;
|
|
return $self->{_senderID};
|
|
}
|
|
|
|
sub getPacketCounter
|
|
{
|
|
my ($self) = @_;
|
|
return $self->{_packetCounter};
|
|
}
|
|
|
|
sub getMessageTypeName
|
|
{
|
|
my ($self) = @_;
|
|
return $messageTypeID2messageTypeName{$self->{_messageTypeID}};
|
|
}
|
|
|
|
sub getMessageGroupName
|
|
{
|
|
my ($self) = @_;
|
|
return $messageGroupID2messageGroupName{$self->{_messageGroupID}};
|
|
}
|
|
|
|
sub getMessageName
|
|
{
|
|
my ($self) = @_;
|
|
return $messageID2messageName{$self->{_messageGroupID} . "-" . $self->{_messageID}};
|
|
}
|
|
|
|
sub getMessageData
|
|
{
|
|
my ($self) = @_;
|
|
|
|
if ($sendMode) {
|
|
my $res = "";
|
|
|
|
foreach (@msgData) {
|
|
$res .= sprintf("%02X", $_);
|
|
}
|
|
|
|
# strip trailing zeros (pairwise)
|
|
$res =~ s/(00)+$//;
|
|
|
|
return $res;
|
|
} else {
|
|
return $self->{_messageData};
|
|
}
|
|
}
|
|
|
|
sub getField
|
|
{
|
|
my ($self, $fieldName, $index) = @_;
|
|
|
|
if (!defined $index) {
|
|
$index = 0;
|
|
}
|
|
|
|
my $obj = $dataFields{$self->{_messageGroupID} . "-" . $self->{_messageID} . "-" . $fieldName};
|
|
|
|
# add 256 "empty" bytes to have enough data in the array because the message may be truncated
|
|
my @tmpArray = map hex("0x$_"), ($self->{_messageData} . ("00" x 256)) =~ /(..)/g;
|
|
|
|
return $obj->getValue(\@tmpArray, $index);
|
|
}
|
|
|
|
sub initPacket
|
|
{
|
|
my ($self, $messageGroupName, $messageName, $messageTypeName) = @_;
|
|
|
|
$self->{_senderID} = 0; # base station SenderID
|
|
$self->{_messageTypeID} = $messageTypeName2messageTypeID{$messageTypeName};
|
|
$self->{_messageGroupID} = $messageGroupName2messageGroupID{$messageGroupName};
|
|
$self->{_messageID} = $messageName2messageID{$messageGroupName . "-" . $messageName};
|
|
|
|
my $lenBytes = int(($messageID2bits{$self->{_messageGroupID} . "-" . $self->{_messageID}} + 7) / 8);
|
|
|
|
@msgData = (0) x $lenBytes;
|
|
|
|
$sendMode = 1;
|
|
}
|
|
|
|
sub setField
|
|
{
|
|
my ($self, $messageGroupName, $messageName, $fieldName, $value, $index) = @_;
|
|
|
|
if (!defined $index) {
|
|
$index = 0;
|
|
}
|
|
|
|
my $gID = $messageGroupName2messageGroupID{$messageGroupName};
|
|
my $mID = $messageName2messageID{$messageGroupName . "-" . $messageName};
|
|
|
|
my $obj = $dataFields{$gID . "-" . $mID . "-" . $fieldName};
|
|
|
|
$obj->setValue(\@msgData, $value, $index);
|
|
}
|
|
|
|
# cKK01RRRRGGMMDD{CRC32}
|
|
# c0001003D3C0164 = SET Dimmer Switch Brightness 50%
|
|
sub getSendString
|
|
{
|
|
my ($self, $receiverID, $aesKeyNr) = @_;
|
|
|
|
# Right now the only way to set the AES key is by defining in in fhem.cfg
|
|
# "define SHC_Dev_xx SHC_Dev xx aa" where xx = deviceID, aa = AES key
|
|
#
|
|
# TODO: Where to enter the AES key number? This is by device.
|
|
# Add lookup table device -> AES key?
|
|
# Automatically gather used AES key after reception from device?
|
|
|
|
if (!defined $aesKeyNr) {
|
|
$aesKeyNr = 0;
|
|
}
|
|
|
|
my $s = "c"
|
|
. sprintf("%02X", $aesKeyNr)
|
|
. sprintf("%02X", $self->{_messageTypeID})
|
|
. sprintf("%04X", $receiverID)
|
|
. sprintf("%02X", $self->{_messageGroupID})
|
|
. sprintf("%02X", $self->{_messageID})
|
|
. getMessageData();
|
|
|
|
return $s . sprintf("%08x", crc32($s));
|
|
}
|
|
|
|
1;
|