ioBroker.knx

=================

Description

en: This adapter allows importing of knxproj Files from ETS. It generates the translation between KNX- groupaddresses and ioBroker and put the devices into rooms (esp. for MobileUI).

It connects to standard KNX/LAN Gateways.

Before beginning: Every DPT of com.Objects should be set in your ETS project. Every device should be sorted into your facility structure.

Obsolete for the moment in 1.0.19

ATTENTION for Version 1.0.18: For future releases I've changed the values for "boolean" from 1 and 0 to true false, as it should be. In fact of this, check your scripts to use "true" and "false" instead of 0 and 1

ACHTUNG für Version 1.0.18: Für zukünfige Versionen wurden die Werte für den DPT1.xxx boolean wurde von 1 bzw 0 auf true bzw false gesetzt. Deshalb sind alle Scripte auf diese Auswertung hin zu prüfen.

Features:

importing knxproj file
generating ETS-like object structure
finding and combining act-channel and state-channel (heuristic)
updating all states on start
emmiting a READ to the KNX-Bus, while writing on state-object
sorting channels to rooms

Adapter configuration

After installing this adapter, open the adapter configuration. Fill in:

KNX Gateway IP

<IP of your KNX/Lan GW> with ipv4 format

Port

this is normally port 3671

phys. EIB Adress

fill in free phys. address corresponding to your KNX-architecture, !!! BUT NOT the same like your KNX Gateway has !!!

debug-Level

extends the output Level of the adapter for debugging purposes

Upload knxproj

here you can upload your ETS Export in "knxproj" format.

After successful import a dialog shows the number of imported object. Now press "save & close" and the adapter should start. While starting the adapter reads all groupAdresses with read-Flag. This could take a while and can produce a high load on your KNX-bus. But the values in your vis are updatet after start.

Objects

Here is under knx.0 the group adress tree like in your ETS project.

Enumerations

If you have a building structure in your ETS with the corresponding devices, it will be shown here. Under "members" are the names of group addresses listed from the devices with send-Flag in this Group.

Usage

If the adapter starts successfully your datapoints will be available for everything you like to do.

Datapoint Types

All DPT's according to "System Specifications, Interworking, Datapointtypes" from KNX Association are available. That means there are 2 Types of Information you can get:

a Value or a String
comma seperated Values or array of values (for the moment I don't what's the better way to handle)

For example a DPT5.001 is encoded as unsigned Integer with 8-Bit. This gives a single Value. The DPT3.007 (Control Dimming) is encoded as 1Bit(Boolean)+3Bit(unsigned Int). This results in f.e. in value like "0,5", where "0" means "decrease" and "5" means number of intervalls.

Wie werden die Datenpunkte generiert

1) Auslesen aller Kommunikationsobjektreferenzen (im folgenden KOR)

Dabei werden den Gruppenaddressreferenz (im folgenden GAR) ID's der jeweilige DPT der KOR zugeordnet, wenn er vorhanden ist. Ausserdem bekommt der erste Eintrag die Attribute write=yes und read=no. Alle darauf folgenden GAR ID's bekommen nur den DPT zugeordnet

2) Erzeugen der Gruppenadressstruktur (im folgenden GAS)

Hier wird die GAS anhand der GAR ID's erzeugt und ebenfalls die DPT's zugeordnet, falls dies unter 1) noch nicht geschehen ist.

3) Herausfinden der Schalt- und Statusaddressen

In dem ETS Export sind die Schalt- und Statusadressen nicht hinterlegt. Somit führe ich eine Ähnlichkeitsprüfung aller Gruppenadressnamen durch mit der Auswertung auf status und state. Wird ein Pärchen gefunden, dessen Ähnlichkeit mehr als 70% beträgt, dann wird angenommen, das die GA1 die Schaltadresse und GA2 die Statusadresse ist. Dabei erhält GA1 das write=true und read=false und GA2 das write=false und read=true. Ausserdem werden die DPT abgeglichen aus der jeweilig korrespondierenden GA. Aus diesem Grund ist es schwierig, Pärchen zu finden, wenn die Gruppenadressbeschriftungen nicht konsistent sind.

4) Erzeugen der Datenpunktpärchen (im folgenden DPP)

Ein DPP wird erzeugt, wenn die GA, GAR und der DPT valid sind. Mit diesen DPP arbeitet der Adapter. Fehlen also die DPT's in einer GA, weil sie auf keiner der o. A. Wege gefunden werden konnte, so wird für diese GA kein DPP erzeugt und ist im Weiteren nicht nutzbar.

Im Idealfall werden somit für einen Schaltkanal 2 DPP erzeugt. Das erste ist das Schalten. In diesem ist die GAR ID des Status DPP hinterlegt. Das zweite ist dann das Status DPP ohne weitere Refenrenz.

Beim Start des Adapters

Alle mit dem Lesen-Flag markieren DPP werden beim Start abgefragt. Dies verursacht u.U. eine höhere Buslast und dauert einen Moment. Im Anschluss sind aber alle aktuellen Werte verfügbar.

(hidden) Features:

Durch senden eines Wertes auf eine Statusadresse werden die Kommunikationsobjekte innerhalb dieser Gruppenadresse per GroupValueRead abgefragt.

Vermeidung von Problemen

saubere ETS Programmierung und saubere ETS Programmierung und saubere ETS Programmierung

zuweisen der DPT's !!
einheitliche Beschriftung der GA-Namen (z.B "EG Wohnen Decke Licht schalten" und "EG Wohnen Decke Licht schalten status" )
Vermeidung von Sonderzeichen ",./;&%$§[]" (kann zu Problemen bei der Erzeugung der GAS führen)

Prüfen ob das KNX/LAN GW erreichbar ist. Wenn es das nicht ist, versucht der Adapter sich kontinuierlich zu verbinden.
Physikalische Adresse richtig wählen ( wichtig beim Einsatz von Linienkopplern ). !!! ACHTUNG: die hier eingetragene physikalische Adresse ist NICHT die Adresse des LAN Gateways und darf nicht auf 0 enden !!!
Der Port der LAN Schnittstelle ist i.d.R. 3671
Durch die Möglichkeit der Statusabfrage ist eines zu beachten: Es ist sicherzustellen das nicht mehr als 40 Anfragen pro Sekunde vom ioBroker generiert werden, denn diese können dann physikalisch bedingt nicht mehr durch den Adapter an das Gateway weitergereicht werden.

planed features

adding adresses to object-description (id)
selective import of knx-project
require node Version >8.9.4!

Changelog

1.0.19

reverted to true/false handling for DPT1.x

1.0.18

fixed upload issue with ETS5.6.x project files
switched values for "boolean" from 1 and 0 to true false
fixed recognition of role set for DPT1.x to switch
fixed DPT16.xxx writing to KNX-Bus with values < 14Byte

1.0.17 (2018-08-16)

Better state processing
Add configurable package rate
corrected Bug in "import only new objects"

1.0.15 (2018-07-18)

change ChID on reconnect
on Startup read wait for response of Statechannel or timeout

1.0.13 (2018-07-04)

elemination of special signs while importing
small bugfixes

1.0.12 (2018-06-19)

reduced and sorted log output
small bugfixes
NEW Feature: request State/Val of stateObject from KNX-Bus

1.0.11 (2018-05-27)

fixed DPT1 correcting value problem
fixed reconnect problem
other small optimizations and fixes

1.0.10 (2018-05-04)

closing local port in case of undefinded connection state
added advanced debug-level via adapter-config
many fixes

1.0.9 (2018-04-29)

changed to state-wise processing
fixed "disconnect-request"
changed connection handling with knxd
many small fixes

1.0.8 (2018-04-04)

modified package queue
fixed ACK if sending to KNX-Bus
many small fixes

1.0.7 (2018-03-16)

fixed Adapter-lock while uploading projects

1.0.6 (2018-03-11)

fixed connection problem
corrected package counter

1.0.5 (2018-03-01)

fixed empty objects, related to DPT1 (error message [object Object] unkown Inputvalue)
fixed path variable
fixed bug with GA's containing a "/" in the name (on proj-import)
start implementing crosswise propery update on corresponding DPT (on proj-import)

1.0.4 (2018-02-27)

schema update for room enumeration coming up with ETS 5.6

1.0.2 (2018-02-27)

kleine Fehler beseitigt

1.0.1 (2018-02-26)

fixed certifate error

1.0.0 (2018-02-25)

substitution of used KNX-stack with own from scratch build stack
implemented full scale of DPT according to "System Specifications, Interworking, Datapointtypes" from KNX Association
hardening connection handling for tunneling connections
upgrade Adapterconfiguration Interface to be ready with Admin3
removed "Delay Slider" because of the new knx-stack
many other small changes
fixed postcomma values to scale-value of DPT
implemented "add" mode for knxproject upload (existing Objects stay as they are, only new Objects where added)

0.8.6 (2017-06-17)

some small bugfixes
insert slider to set a sendDelay for slow KNX/LAN Gateways to prevent connection loss

0.8.5 (2017-06-05)

project loader rebuild, dpt13-fix

0.8.3 (2017-04-24)

added act channel update of corresponding state
fix bug in state-vis update
optimized knxproj upload

0.8.2 (2017-02-26)

implemented device-config parsing from knxproj
better choice of state/val of DP objects

0.8.1 (2017-02-06)

fixed DPT1 switch problem

0.8.0 (2017-02-xx) comming soon

0.7.3 (2016-12-22)

(chefkoch009) more DPT's are supported
faster Startup
implemented generation of room list with device dependicies

0.7.2 (2016-11-20)

(chefkoch009) added necessary dependicies

0.7.1 (2016-11-19)

(chefkoch009) Support standard KNX/LAN Gateways.

0.7.0 (2016-10-13)

(chefkoch009) Support of project export

0.6.0 (2016-07-20)

(chefkoch009) redesign

0.5.0

(vegetto) include vis widget

0.4.0

(bluefox) fix errors with grunt

0.2.0

(bluefox) initial release

License

The CC-NC-BY License (CC-NC-BY)

THE WORK IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

Read full license text in LICENSE

BlackBird77/ioBroker.knx