KONNEKTING XML Device Description - Revision history

Konnekting at 13:49, 29 March 2022

2022-03-29T13:49:17Z

Konnekting at 13:47, 29 March 2022

2022-03-29T13:47:59Z

Konnekting: fixed equation

2019-03-23T19:46:56Z

fixed equation

Konnekting at 06:08, 3 August 2018

2018-08-03T06:08:14Z

Konnekting at 06:07, 3 August 2018

2018-08-03T06:07:37Z

Konnekting at 10:17, 7 March 2018

2018-03-07T10:17:35Z

Konnekting at 09:42, 7 March 2018

2018-03-07T09:42:05Z

Konnekting at 14:02, 15 February 2018

2018-02-15T14:02:59Z

Konnekting: Created page with "== KONNEKTING XML Device Description == After writing your arduino KONNEKTING Device sketch, you should have a list of communication objects and parameters your device will u..."

2018-02-15T14:01:19Z

Created page with "== KONNEKTING XML Device Description == After writing your arduino KONNEKTING Device sketch, you should have a list of communication objects and parameters your device will u..."

New page

== KONNEKTING XML Device Description ==

After writing your arduino KONNEKTING Device sketch, you should have a list of communication objects and parameters your device will use or provide. To be able to program the device via the KNX bus, you have to provide a XML file which describes your device. This XML file can then be used by the [KONNEKTING Suite](konnekting_suite.md), which provides a comfortable way of device programming.

Eithe you use a standard text editor (on windows we can recommend [Notepad++](https://notepad-plus-plus.org/)), or you use an XML editor of your choice. In case of an XML Editor that can handle XML Schema Definition files (.xsd), you can use this one:

https://github.com/KONNEKTING/KonnektingXmlSchema/blob/master/src/main/xsd/KonnektingDeviceV0.xsd

=== Preparation ===

If you haven't registered a manufacturer-id yet, NOW would be the best time for it. [REGISTER FOR FREE](konnekting_manufacturers.md)

=== XML Format explained (Beta4 Format!) ===

<syntaxhighlight lang=XML line>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<KonnektingDevice xmlns="http://konnekting.de/xml/KonnektingDevice/v0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://konnekting.de/xml/KonnektingDevice/v0 http://konnekting.de/xml/KonnektingDevice/KonnektingDeviceV0.xsd">


<Device ManufacturerId="12345" DeviceId="123" Revision="123">

<ManufacturerName>You Manufacturer Name</ManufacturerName>
<DeviceName>Your Device Name</DeviceName>


<Parameters>


<ParameterGroup Name="A Parameter Group" Id="0">


<Parameter Id="0" IdName="aParameter">


<Description>A Parameter</Description>


<Value Type="uint8" Default="01" Options="" Min="00" Max="0A"/>

</Parameter>

<Parameter Id="1" IdName="anotherParameter">
<Description>Another Parameter</Description>
<Value Type="int16" Default="0001" Options=""/>
</Parameter>

<Parameter Id="2" IdName="yetAnotherParameter">
<Description>Yet Another Parameter</Description>
<Value Type="uint8" Default="00" Options="00=10ms|01=30ms|02=60ms|04=120ms|FF=no delay"/>
</Parameter>

<Parameter Id="3" IdName="activate1">
<Description>Activate 'Another Parameter'</Description>
<Value Type="uint8" Default="01" Options="00=disabled|01=enabled"/>
</Parameter>

<Parameter Id="4" IdName="activate2">
<Description>Activate 'Another Parameter Group'</Description>
<Value Type="uint8" Default="01" Options="00=disabled|01=enabled"/>
</Parameter>

<Parameter Id="5" IdName="activate3">
<Description>Activate 'My Second Com Object'</Description>
<Value Type="uint8" Default="01" Options="00=disabled|01=enabled"/>
</Parameter>
</ParameterGroup>

<ParameterGroup Id="1" Name="Another Parameter Group">
<Parameter Id="6">
<Description>Another parameter in another parametergroup</Description>
<Value Type="uint8" Default="02" Options="00=Aus|01=An|02=letzter Wert|04=Helligkeitswert"/>
</Parameter>
</ParameterGroup>

</Parameters>

<CommObjects>

<CommObject Id="0">

<Name>My First Com Object</Name>

<Function>Test-Function #1</Function>

<DataPointType>1.001</DataPointType>


<Flags>52</Flags>
</CommObject>

<CommObject Id="1">
<Name>My Second Com Object</Name>
<Function>Test-Function #2</Function>
<DataPointType>1.001</DataPointType>
<Flags>42</Flags>
</CommObject>
</CommObjects>


<Dependencies>
<ParameterDependency ParamId="1" Test="eq" TestParamId="3" TestValue="01"/>
<ParameterGroupDependency ParamGroupId="1" Test="eq" TestParamId="4" TestValue="01"/>
<CommObjectDependency CommObjId="1" Test="eq" TestParamId="5" TestValue="01"/>
</Dependencies>
</Device>
</KonnektingDevice>
</syntaxhighlight>

@@ Line 3: / Line 3: @@
 After writing your arduino KONNEKTING Device sketch, you should have a list of communication objects and parameters your device will use or provide. To be able to program the device via the KNX bus, you have to provide a XML file which describes your device. This XML file can then be used by the [[ KONNEKTING_Suite | KONNEKTING Suite]], which provides a comfortable way of device programming.
-Eithe you use a standard text editor (on windows we can recommend [https://notepad-plus-plus.org/ Notepad++]), or you use an XML editor of your choice. In case of an XML Editor that can handle XML Schema Definition files (.xsd), you can use this one:
+Either you use a standard text editor (on windows we can recommend [https://notepad-plus-plus.org/ Notepad++]), or you use an XML editor of your choice. In case of an XML Editor that can handle XML Schema Definition files (.xsd), you can use this one:
 https://github.com/KONNEKTING/KonnektingXmlSchema/blob/master/src/main/xsd/KonnektingDeviceV0.xsd

← Older revision		Revision as of 06:07, 3 August 2018
Line 1:		Line 1:
−	== KONNEKTING XML Device Description ==	+	== KONNEKTING XML Device Description (.kdevice.xml) ==

	After writing your arduino KONNEKTING Device sketch, you should have a list of communication objects and parameters your device will use or provide. To be able to program the device via the KNX bus, you have to provide a XML file which describes your device. This XML file can then be used by the [[ KONNEKTING_Suite \| KONNEKTING Suite]], which provides a comfortable way of device programming.		After writing your arduino KONNEKTING Device sketch, you should have a list of communication objects and parameters your device will use or provide. To be able to program the device via the KNX bus, you have to provide a XML file which describes your device. This XML file can then be used by the [[ KONNEKTING_Suite \| KONNEKTING Suite]], which provides a comfortable way of device programming.

@@ Line 1: / Line 1: @@
 == KONNEKTING XML Device Description ==
-After writing your arduino KONNEKTING Device sketch, you should have a list of communication objects and parameters your device will use or provide. To be able to program the device via the KNX bus, you have to provide a XML file which describes your device. This XML file can then be used by the [KONNEKTING Suite](konnekting_suite.md), which provides a comfortable way of device programming.
+After writing your arduino KONNEKTING Device sketch, you should have a list of communication objects and parameters your device will use or provide. To be able to program the device via the KNX bus, you have to provide a XML file which describes your device. This XML file can then be used by the [[ KONNEKTING_Suite | KONNEKTING Suite]], which provides a comfortable way of device programming.
 Eithe you use a standard text editor (on windows we can recommend [https://notepad-plus-plus.org/ Notepad++]), or you use an XML editor of your choice. In case of an XML Editor that can handle XML Schema Definition files (.xsd), you can use this one:

@@ Line 9: / Line 9: @@
 === Preparation ===
-If you haven't registered a manufacturer-id yet, NOW would be the best time for it. [https://github.com/KONNEKTING/KonnektingDocumentation/blob/master/konnekting_manufacturers.md REGISTER FOR FREE]
+If you haven't registered a manufacturer-id yet, NOW would be the best time for it. [[ KONNEKTING_Manufacturers | REGISTER FOR FREE]]
 === XML Format explained (Beta4 Format!) ===

@@ Line 34: / Line 34: @@
 for first release and
 ...255 of every change which breaks compatibility.
      -->
-     <Device ManufacturerId="12345" DeviceId="123" Revision="123">
+     <Device ManufacturerId="12345" DeviceId="123" Revision="123" SystemType="1">
          <!--
              Providing a manufacturer name and device name is optional.

@@ Line 11: / Line 11: @@
 If you haven't registered a manufacturer-id yet, NOW would be the best time for it. [[ KONNEKTING_Manufacturers | REGISTER FOR FREE]]
-=== XML Format explained (Beta4 Format!) ===
+=== XML Format explained (1.0.0-RC1 Format!) ===
@@ Line 271: / Line 271: @@
                      ge = greater or equals than
                      le = less or equals than
                  * TestParamId: the parameter which's value is been tested for setting visibility
-                 * TestValue: the value the parameter is tested for
+                 * TestValue: the value the parameter is tested for (used when not testing with IN/NOTIN/BETWEEN/NOTBETWEEN)
              There's one limitation: The parameters that is used as a dependency (=referenced by TestParamId) needs
@@ Line 278: / Line 280: @@
          -->
          <Dependencies>
-             <ParameterDependency ParamId="1" Test="eq" TestParamId="3" TestValue="01"/>
+             <ParameterDependency ParamId="1" Test="eq" TestParamId="3" TestValue="01" TestList=""/>
-             <ParameterGroupDependency ParamGroupId="1" Test="eq" TestParamId="4" TestValue="01"/>
+            <ParameterDependency ParamId="2" Test="in" TestParamId="3" TestValue="01" TestList="02|03"/>
-             <CommObjectDependency CommObjId="1" Test="eq" TestParamId="5" TestValue="01"/>
+             <ParameterGroupDependency ParamGroupId="1" Test="eq" TestParamId="4" TestValue="01" TestList=""/>
          </Dependencies>
      </Device>
 </KonnektingDevice>
 </syntaxhighlight>

@@ Line 232: / Line 232: @@
                      Common flag-combinations:
-                         * "Sensor Profile" -> C+R+T -> 32+16+8 = 52 (integer value)
+                         * "Sensor Profile" -> C+R+T -> 32+16+4 = 52 (integer value)
                          * "Logical Input Profile" -> C+W+U -> 32+8+2 = 42 (integer value)
                  -->