This article covers the following topics:
Background information
This app allows more in-depth diagnostics at the device level. The read out data can be also be saved, however to be able to interpret this data, one shall have deep KNX system knowledge.
The following, basic functions are offered in this ETS App:
- Open device data (from a file or the device).
- Save device data to a file.
Activation
Follow these instructions in order to activate the app:
- Purchase a Device Reader license from MyKNX.
- Download and install the app as explained here.
- License it as explained here.
Use of the Device Reader app in ETS
- Invoke the App within a project (How to start an ETS App)
- In the ETS App window, it is possible to toggle between the 'Properties' and 'Memory' view on a tab.
Properties view
The 'Properties' tab deals with device properties and allows to read device properties.
The App panel is divided into two parts. The objects (including the object number) are displayed in the left-hand part (1) and the associated properties are displayed in the right-hand part (2).
| Column | Property | ID | Type | Value |
|---|---|---|---|---|
| Description | Contains the plain text name of the property. | Contains the numerical property ID. | Indicates the property type. | Property Value |
Additional properties are also stored in the Properties container.
| Item | Description |
|---|---|
| Index | The consecutive index of the properties relative to the selected object (0...n). |
| Type ID | The ID of the property type according to KNX specifications or a custom definition using a type file (see below) for the Device Editor |
| Name... | The actual (more intelligible) name of the Type ID (in the Sidebar) or Type (in the Panel) |
| Type Text | The name in text form (default PID--xyz/xyz). A custom name can be assigned in the Device Editor using Definition and a type file (see below) |
| Identifier | Name; identical to Property in the Panel |
| Access | Defines the minimum read and write access rights ("access level") required for a property. Depending on the device type (mask version), there can be up to 16 (0 = highest ...15 = lowest) different levels which can be enabled using an Access Key. The precondition for this is that the manufacturer has even defined levels in this manner for the device using a key for a corresponding level. This means that a display of 3/2 requires Level 3 for reading and Level 2 for writing. In other words, to write data, at least Level 2 must be established either by the default key or with a manufacturer-specific key. The Read/Write function can be used to input a key. |
Editing
- Properties can be edited directly in the associated field (in-place editing), either by double clicking on the respective cell (or using F2) or in the Sidebar (Properties Container).
- If the properties are not writable, editing is not possible and a double-click on the cell will have no effect.
- Entire arrays can be edited in a separate dialog, which can be opened by double clicking on the property.
- If an invalid value is entered, the entry is ignored and the original value is again displayed.
Functions
Open from a device
The dialog for reading out device properties allows the following input:
- Device/ Physical Address; predefined using the address of the device last selected in ETS (or the address of the device to which the last element selected belongs).
- Device/Access Key (also called Access Key in KNX); for procedure, see Note
- Reading mode; complete/partial indicates whether the properties are to be read completely (time factor) or only little by little when the object is selected in the left window.
While the properties are being read from the device, a modular "Please wait" dialog appears. The operation which is running can be canceled using this dialog. In this case, all of the data loaded up to this point are discarded. None of the data loaded up to now is displayed.
Note
Array-Properties with a size in excess of 64 bytes are only loaded "on demand" during editing (see above) of the property (increases the speed of the display).
Open from file
If properties are to be read from a file, an "Open File" dialog appears first which only allows *.knxprop files to be selected. When a file is opened, all previously displayed data is discarded.
Write to a file
As is the case for reading from a file, the "Open File" dialog only allows *.knxprop files to be selected. If the file selected already exists, there will be a confirmation prompt about overwriting the file.
If you are dealing with an Array- Property, which is larger than 64 bytes and has not yet been loaded "on demand", the property is saved as a blank field. There will be no subsequent loading of as yet unread fields.
When the properties of a device are read out, information about the type or the number of elements of the property are determined for each property online for the device. It may occur that this information does not coincide with the description of the property in the KNX master data .
For example, the master data may indicate that a property is a single value of the type INTEGER, while the online information indicates that it is an INTEGER with nine (9) values, i.e. an array. Or that a property is writeable according to the KNX master data while the "online" information claims the opposite.
- In these cases, the information from the KNX master data always takes priority.
- This sort on contradiction is indicated by the type being displayed orange.
| Field | Description |
|---|---|
| Index | The consecutive index of the properties relative to the selected object (0...n). |
| Type ID | The ID of the property type according to KNX specifications or a custom definition using a type file (see below) for the Device Editor |
| Name | The actual (more intelligible) name of the Type ID (in the Sidebar) or Type (in the Panel) |
| Type Text | The name in text form (default PID--xyz/ xyz). A custom name can be assigned in the Device Editor using Definition and a type file (see below) |
| Identifier | Name; identical to Property in the Panel |
| Access | Defines the minimum read and write access rights ("access level") required for a property. Depending on the device type (mask version), there can be up to 16 (0 = highest ...15 = lowest) different levels which can be enabled using an Access Key. The precondition for this is that the manufacturer has even defined levels in this manner for the device using a key for a corresponding level. This means that a display of 3/2 requires Level 3 for reading and Level 2 for writing. In other words, to write data, at least Level 2 must be established either by the default key or with a manufacturer-specific key. The Read/Write function can be used to input a key. |
Memory view
This view allows the editing of a memory area of a device; the structure is similar to that of common hex editors.
Display
The width of the display is fixed at 16 bytes and is not variable. The base addresses (hexadecimal form) are listed in the left column; to the right in the header are the 16 different memory locations (hexadecimal form).
Editing
Modified bytes are displayed in red while read-only bytes are grayed out. Input is made in hexadecimal form.
Open from a device
The dialog for reading out the device memory allows the following input:
- Device/ Physical Address; predefined using the address of the device last selected in ETS (or the address of the device to which the last element selected belongs).
- Device/Access Key (also called Access Key in KNX); for procedure, see note at the bottom of the article.
- Range; from ... to; default = 0x0100.. 0x010F
- Address space; default = Standard Memory, others are User Memory, Line Coupler Slave, Line Coupler Routing Table)
Open from file
In the dialog for opening *.sxx files, the formats *.s19; *.s28 and *.s37 may be selected.
After selection of a file, the entire contents of the file is displayed in the editor. If the format of the file is faulty or the file cannot be read out completely, a corresponding message appears and the process is ended.
Write to a file
Writing to *.sxx files can only be done in the file formats mentioned above. If the target file already exists, there will be a confirmation prompt whether the file should be overwritten. If memory is read from a file, edited and written back to the file, any loading procedures which may exist in this file are not lost in the process.
- The Access Key is predefined using a key of the ETS project that may already exist; otherwise, the default key (0xFFFFFFFF) is used. ETS attempts to use the "highest value" level on the basis of these two keys.
- Project key exists; Level from the winner project key <> default key; If the first query with the default key immediately achieves the maximum level (= 0), the second query can be omitted.
- There is no project key; The level from the default key is used.