From 191c9a14d0de0daf0a1c0a0150973a7465b5652d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Dywicki?= Date: Sat, 27 Jul 2024 11:33:53 +0200 Subject: [PATCH] Update generated documentation for amsads and wmbus binding. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Łukasz Dywicki --- .../descriptors/config-descriptions.adoc | 56 +++++++------- .../descriptors/config-descriptions.adoc | 76 +++++++++---------- 2 files changed, 66 insertions(+), 66 deletions(-) diff --git a/bundles/org.connectorio.addons.binding.amsads/docs/amsads/descriptors/config-descriptions.adoc b/bundles/org.connectorio.addons.binding.amsads/docs/amsads/descriptors/config-descriptions.adoc index 4b2cdac1..2765c5ce 100644 --- a/bundles/org.connectorio.addons.binding.amsads/docs/amsads/descriptors/config-descriptions.adoc +++ b/bundles/org.connectorio.addons.binding.amsads/docs/amsads/descriptors/config-descriptions.adoc @@ -198,9 +198,9 @@ |=== -[[thing-type:co7io-amsads:number-symbol-tag]] -== Config `thing-type:co7io-amsads:number-symbol-tag` -[width="100%",caption="thing-type:co7io-amsads:number-symbol-tag configuration",cols="1,1,1,2"] +[[thing-type:co7io-amsads:switch-symbol-tag]] +== Config `thing-type:co7io-amsads:switch-symbol-tag` +[width="100%",caption="thing-type:co7io-amsads:switch-symbol-tag configuration",cols="1,1,1,2"] |=== |Name | Type | Label ^|Description @@ -212,7 +212,12 @@ | type | TEXT | Value encoding -| Encoding of the field. Value in brackets indicate length of type in bytes. +| Encoding of the field. Value in brackets indicate length of type in bytes. Value FALSE or its numeric representation 0 is interpreted as OFF. Any other value is assumed to represent ON. + +| inverse +| BOOLEAN +| Inverse conversion logic +| Inverse logical representation of FALSE/TRUE values. | refreshInterval | INTEGER @@ -221,31 +226,21 @@ |=== -[[thing-type:co7io-amsads:contact-direct-hex-tag]] -== Config `thing-type:co7io-amsads:contact-direct-hex-tag` -[width="100%",caption="thing-type:co7io-amsads:contact-direct-hex-tag configuration",cols="1,1,1,2"] +[[thing-type:co7io-amsads:number-symbol-tag]] +== Config `thing-type:co7io-amsads:number-symbol-tag` +[width="100%",caption="thing-type:co7io-amsads:number-symbol-tag configuration",cols="1,1,1,2"] |=== |Name | Type | Label ^|Description -| indexGroup -| TEXT -| Index Group (hex) -| Index group in hex format (with or without 0x prefix). For example F00F, 0xF00F. - -| indexOffset +| symbol | TEXT -| Index Offset (hex) -| Offset in given group in hex format (with or without 0x prefix). For example 01, 0x01. +| Field symbol +| Name of field be read from device. For TwinCAT 2 use names such .symbol, for TwinCAT 3 use Task.Name. | type | TEXT | Value encoding -| Encoding of the field. Value in brackets indicate length of type in bytes. Value FALSE or its numeric representation 0 is interpreted as OPEN. Any other value is assumed to represent CLOSED. - -| inverse -| BOOLEAN -| Inverse conversion logic -| Inverse logical representation of FALSE/TRUE values. +| Encoding of the field. Value in brackets indicate length of type in bytes. | refreshInterval | INTEGER @@ -254,21 +249,26 @@ |=== -[[thing-type:co7io-amsads:switch-symbol-tag]] -== Config `thing-type:co7io-amsads:switch-symbol-tag` -[width="100%",caption="thing-type:co7io-amsads:switch-symbol-tag configuration",cols="1,1,1,2"] +[[thing-type:co7io-amsads:contact-direct-hex-tag]] +== Config `thing-type:co7io-amsads:contact-direct-hex-tag` +[width="100%",caption="thing-type:co7io-amsads:contact-direct-hex-tag configuration",cols="1,1,1,2"] |=== |Name | Type | Label ^|Description -| symbol +| indexGroup | TEXT -| Field symbol -| Name of field be read from device. For TwinCAT 2 use names such .symbol, for TwinCAT 3 use Task.Name. +| Index Group (hex) +| Index group in hex format (with or without 0x prefix). For example F00F, 0xF00F. + +| indexOffset +| TEXT +| Index Offset (hex) +| Offset in given group in hex format (with or without 0x prefix). For example 01, 0x01. | type | TEXT | Value encoding -| Encoding of the field. Value in brackets indicate length of type in bytes. Value FALSE or its numeric representation 0 is interpreted as OFF. Any other value is assumed to represent ON. +| Encoding of the field. Value in brackets indicate length of type in bytes. Value FALSE or its numeric representation 0 is interpreted as OPEN. Any other value is assumed to represent CLOSED. | inverse | BOOLEAN diff --git a/bundles/org.connectorio.addons.binding.wmbus/docs/wmbus/descriptors/config-descriptions.adoc b/bundles/org.connectorio.addons.binding.wmbus/docs/wmbus/descriptors/config-descriptions.adoc index af9c246b..94fa12ca 100644 --- a/bundles/org.connectorio.addons.binding.wmbus/docs/wmbus/descriptors/config-descriptions.adoc +++ b/bundles/org.connectorio.addons.binding.wmbus/docs/wmbus/descriptors/config-descriptions.adoc @@ -101,6 +101,44 @@ |=== +[[thing-type:co7io-wmbus:device]] +== Config `thing-type:co7io-wmbus:device` +[width="100%",caption="thing-type:co7io-wmbus:device configuration",cols="1,1,1,2"] +|=== +|Name | Type | Label ^|Description + +| discoverChannels +| BOOLEAN +| Discover channels +| Enable automatic creation of channels based on received WM-Bus messages. Some device may use various messages (telegrams) to reports their reading, hence it is advised to keep this option enabled for at least a day. + +| serialNumber +| INTEGER +| Serial number +| + +| manufacturerId +| TEXT +| Manufacturer identifier +| Three character identifier of manufacturer, for example 'KAM' for Kamstrup. + +| version +| INTEGER +| Version +| + +| deviceType +| TEXT +| Device type +| Type of device according to standard. + +| encryptionKey +| TEXT +| Encryption key +| Secret key used to decrypt device payloads. In hex form. + +|=== + [[thing-type:co7io-wmbus:serial-jrxtx]] == Config `thing-type:co7io-wmbus:serial-jrxtx` [width="100%",caption="thing-type:co7io-wmbus:serial-jrxtx configuration",cols="1,1,1,2"] @@ -149,42 +187,4 @@ |=== -[[thing-type:co7io-wmbus:device]] -== Config `thing-type:co7io-wmbus:device` -[width="100%",caption="thing-type:co7io-wmbus:device configuration",cols="1,1,1,2"] -|=== -|Name | Type | Label ^|Description - -| discoverChannels -| BOOLEAN -| Discover channels -| Enable automatic creation of channels based on received WM-Bus messages. Some device may use various messages (telegrams) to reports their reading, hence it is advised to keep this option enabled for at least a day. - -| serialNumber -| INTEGER -| Serial number -| - -| manufacturerId -| TEXT -| Manufacturer identifier -| Three character identifier of manufacturer, for example 'KAM' for Kamstrup. - -| version -| INTEGER -| Version -| - -| deviceType -| TEXT -| Device type -| Type of device according to standard. - -| encryptionKey -| TEXT -| Encryption key -| Secret key used to decrypt device payloads. In hex form. - -|=== -