Download KNX XML Project Schema v17 Description PDF

TitleKNX XML Project Schema v17 Description
File Size1.2 MB
Total Pages42
Document Text Contents
Page 2

1.7 01.06.2016

 2016 KNX Association. All rights reserved. Page 2/42

Contents
1 Overview .................................................................................................................................................................................................................................................................. 4

1.1 Document Purpose .......................................................................................................................................................................................................................................... 4

1.2 Extended Import Restrictions ........................................................................................................................................................................................................................... 4
1.3 Extended Import Checks .................................................................................................................................................................................................................................. 4
1.4 Validity .............................................................................................................................................................................................................................................................. 4

1.5 Namespaces .................................................................................................................................................................................................................................................... 4
2 XSD Schema File & KNX Master Data File ............................................................................................................................................................................................................. 5
3 Elements, Types and Attributes ............................................................................................................................................................................................................................... 6

3.1 General ............................................................................................................................................................................................................................................................ 6
3.1.1 Element KNX ........................................................................................................................................................................................................................................................................................................ 6
3.1.2 Enumerations ....................................................................................................................................................................................................................................................................................................... 6
3.1.3 Other simpleTypes .............................................................................................................................................................................................................................................................................................. 12

3.2 Project Data ................................................................................................................................................................................................................................................... 15
3.2.1 element KNX/Project .......................................................................................................................................................................................................................................................................................... 15
3.2.2 complexType Project_t ....................................................................................................................................................................................................................................................................................... 16
3.2.3 General............................................................................................................................................................................................................................................................................................................... 16
3.2.4 Topology ............................................................................................................................................................................................................................................................................................................. 20
3.2.5 Device Data ........................................................................................................................................................................................................................................................................................................ 22
3.2.6 Building Structure ............................................................................................................................................................................................................................................................................................... 29
3.2.7 Group Addresses ................................................................................................................................................................................................................................................................................................ 32
3.2.8 SplitInfos ............................................................................................................................................................................................................................................................................................................. 34

4 IDs and relations .................................................................................................................................................................................................................................................... 35
4.1 ID naming schema ......................................................................................................................................................................................................................................... 35

4.1.1 MasterData ......................................................................................................................................................................................................................................................................................................... 35
4.1.2 Manufacturer Data .............................................................................................................................................................................................................................................................................................. 35
4.1.3 Project Data ........................................................................................................................................................................................................................................................................................................ 36

4.2 Reference Summary ...................................................................................................................................................................................................................................... 37
4.2.1 Manufacturer Data  Manufacturer Data ........................................................................................................................................................................................................................................................... 37
4.2.2 Project Data  Master Data ............................................................................................................................................................................................................................................................................... 37
4.2.3 Project Data  Manufacturer Data ..................................................................................................................................................................................................................................................................... 37
4.2.4 Project Data  Project Data ............................................................................................................................................................................................................................................................................... 37

5 Transfer files .......................................................................................................................................................................................................................................................... 38
5.1 File extensions ............................................................................................................................................................................................................................................... 38
5.2 Content ........................................................................................................................................................................................................................................................... 38

5.2.1 Non-XML files ..................................................................................................................................................................................................................................................................................................... 38
5.2.2 Distribution to partial XML files ............................................................................................................................................................................................................................................................................ 38
5.2.3 Naming convention ............................................................................................................................................................................................................................................................................................. 39
5.2.4 Password protection ........................................................................................................................................................................................................................................................................................... 39

Page 21

1.7 01.06.2016

 2016 KNX Association. All rights reserved. Page 21/42

number Unique number of the area within the project. This does not reflect the area address! For converted projects, this corresponds to
Area.UniqueNumber in the database schema.

Name knx:String255_t required Name of the area

Address xs:int required Area address [0…15]

Comment xs:string optional User comment

CompletionStatus knx:CompletionStatus_t optional Completion status

Description xs:string optional Description of the area

Puid xs:int required The project wide unique identifier. After deletion of the element, no other element will receive the same Puid.


3.2.4.4 element Topology_t/Area/Line

Description Description of a KNX line

Children Name Description

DeviceInstance List of devices assigned to the line.

AdditionalGroupAddresses List of additional group addresses that should be included in the filter table of this line's line coupler.

BusAccess Contains the bus access information for the line


Attributes Name Type Use Default Description

Id xs:ID required Unique ID.
On export or conversion, this will be constructed as
parid_L-number, where:

parid ID of the parent Project and InstallationID sepearted with ‘-‘

number Unique number of the line within the project. This does not reflect the line address! For converted projects, this corresponds to
Line.UniqueNumber in the database schema.

Name knx:String255_t required Name of the line

Address xs:int required Line address [0…15]

MediumTypeRefId knx:IDREF required Medium type of the line, a reference to MediumType.

Comment xs:string optional User comment

DomainAddress xs:unsignedLong optional For open media (PL, RF), the domain address

CompletionStatus knx:CompletionStatus_t optional Completion status

Description xs:string optional Description of the line

Puid xs:string required The project wide unique identifier. After deletion of the element, no other element will receive the same Puid.


3.2.4.5 element Topology_t/Area/Line/DeviceInstance

Description Represents a device in the project.

Type knx:DeviceInstance_t

Page 22

1.7 01.06.2016

 2016 KNX Association. All rights reserved. Page 22/42

3.2.4.6 element Topology_t/Area/Line/AdditionalGroupAddresses

Description List of additional group addresses that should be included in the filter table of this line's line coupler.

Children Name Description

GroupAddress GroupAddress that is not necessarily contained in the project


3.2.4.7 element Topology_t/Area/Line/AdditionalGroupAddresses/GroupAddress

Description

Attributes Name Type Use Default Description

Address xs:unsignedShort required The address of the GroupAddress


3.2.4.8 element Topology_t/UnassignedDevices

Description List of devices not assigned to a line

Children Name Description

DeviceInstance List of devices assigned to no line.


3.2.4.9 element Topology_t/UnassignedDevices/DeviceInstance

Description Represents a device in the project.

Type knx:DeviceInstance_t

3.2.5 Device Data

3.2.5.1 complexType DeviceInstance_t

Description Represents a device in the project.

Children Name Description

ParameterInstanceRefs List of parameter instances with non-default values

ComObjectInstanceRefs List of group communication object instances

ChannelInstances List of channel instances. ChannelInstances are
used

AdditionalAddresses Additional individual addresses of the device

BinaryData For use by plugins

IPConfig The IP configuration of the device

Security The security configuration of the device

BusInterface The bus interface of the device

Page 41

1.7 01.06.2016

 2016 KNX Association. All rights reserved. Page 41/42

5.3.2 ETS Project Structure

ETS uses for project the extension *.knxprod ; the container contains the following files:

 For every used manufacturer in project (means its devices) the ETS Product Structure section as described above

 For the project folder (e.g. P-3D5F),

o The project folder hashed/ signed by ETS4 on export in an external signature file named <FolderName>.signature. This signature file is located in the root of the zip container.

o The <FolderName>\Project.xml contains project organizational data (under the Project ID)
 ProjectInformation
 HistoryEntries
 ProjectTraces
 UserFiles

o The <FolderName>\0.xml contains the project topology (under the Project ID)

 <number>.xml  0…16 is the preparation for “installations” with up to 16 projects, currently not used

Example of folder and file structure for a *.knxproj container:

---\knx_master.xml
---\M-0001.signature
---\M-0002.signature
---\P-3D5F.certificate
---\P-3D5F.signature
:
:
---\P-3D5F\Project.xml
---\P-3D5F\0.xml
---\P-3D5F\UserFiles\887190.txt

Page 42

1.7 01.06.2016

 2016 KNX Association. All rights reserved. Page 42/42

5.3.3 Password protected projects

ETS5, like ETS3/4, allows password protection for ETS project data. Due to the new format of persisted data, the mechanism for password protection in ETS4/5 differs from
ETS3.

Password-protected projects in older ETS versions

In older ETS versions (ETS1, ETS2, ETS3), password-protection of project data was merely an internal property, and did not affect the format of exported file data (*.prx, *.pr1,
*.pr2, *.pr3, *.pr4, *.pr5). This was not necessary, as the file format was cryptic anyway.

The password became relevant only when a user wanted to open a project inside the UI. On password protection, the ETS UI then asked for the password before letting the user
view or edit the data of the project in question.

Password-protected projects in ETS4/5

ETS4/5 however uses a completely different persistence format. Project data are persisted as *.knxproj files. Each *.knxproj file is an ordinary unprotected ZIP archive, which
may contain various XML files, subfolders, and possibly additional baggage files. In particular, project data in the narrower sense normally reside in a separate subfolders named
"P-*".

For password-protected projects, the files normally contained in the "P-*" subfolder are put in an extra, password-protected ZIP-file named "P-*.zip", which then replaces the
subfolder "P-*" of this project.

Example

The following example illustrates schematically the difference between the contents of a *.knxproj file with and without password protection, respectively.

Without password With password Comment

knx_master.xml knx_master.xml KNX master data

M-000B\Hardware.xml
M-000B\M-000B_A-1151-10-12C6.xml

M-000B\Hardware.xml
M-000B\M-000B_A-1151-10-12C6.xml

Manufacturer-specific data

P-01A0\0.xml
P-01A0\project.xml

P-01A0.zip (password-protected) Project-specific data

Export

When exporting a password-protected project, the proj_*.xml file may optionally be ZIP encoded with the project password.

Note that there is no way to recover or reset a lost ZIP password!

Similer Documents