Home - OpenKNX/Kaenx-Creator GitHub Wiki
Welcome to the Wiki from Kaenx-Creator
Keanx-Creator is a tool for creating Knx-Productdabases which you can import in ETS.
Structure of a KnxProd
Each KnxProd has this Files:
- knx_master.xml
- M-XXXX.signature
- M-XXXX/Catalog.xml
- M-XXXX/Hardware.xml
- M-XXXX/M-XXXX_A-XXXX-XX-XXXX.xml
knx_master.xml
This file contains all Manufacturers, DatapointTypes, MaskVersions, InterfaceObject/PropertyIndex for Properties and many more information.
M-XXXX.signature
The signature file is used by the ETS tu ensure only official and not modified KnxProds can be imported.
There are a lot of programs which can sign a folder with the files so you can import your own created KnxProds.
M-XXXX/ (Folder)
Since a KnxProd can contain multiple Manufacturer each has an own folder with its ManufacturerId.
It contains Catalog, Hardware and Application files.
M-XXXX/Catalog.xml
Here are all CatalogSections and CatalogItems.
They will be displayed in the ETS Catalog to filter Manufacturer or Categories (Sensors, Actors, Gateway, etc.).
M-XXXX/M-XXXX_A-XXXX-XX-XXXX.xml
For each Application in the KnxProd there is an xml file which contains the parameters, comobjects and oll other stuff.
The pattern for the Id is: M-[ManuId]_A-[ApplicationNumber]-[ApplicationVersion]-[ApplicationHash].
The ApplicationHash is calculated when published so don't worry about that.
Connection between all
To understand the KnxProd let us start with a diagrim which shows the relation between Catalog, Hardware, Product, Application.
graph TD
A[Catalog] ==> |1-n| B[CatalogSection]
B ==> |1-n| C[CatalogItem]
C ==> |1-1| D[Hardware2Program]
C ==> |1-1| E[Product]
D ==> |1-n| F[ApplicationProgram]
G(Hardware) --> |1-n| E
G --> |1-n| F
It starts with the Catalog. The Catalog will be displayes by teh ETS to filter Manufacturer or categories.
Each category is a CatalogSection.
A Section can contain more CatalogSections or one or more CatalogItems.
A CatalogItem will be displayed by the ETS when you want to import a Product in your Project or when you want to import a new KnxProd.
The CatalogItem points to a Hardware (in the Hardware.xml) and a specific ApplicationVersion.
Each Hardware can have multiple Products and ApplicationPrograms.
Let's get started
Since we know now what a KnxProd contains let's start with General Information.