Skip to content

Commit

Permalink
Update generated documentation for amsads and wmbus binding.
Browse files Browse the repository at this point in the history
Signed-off-by: Łukasz Dywicki <[email protected]>
  • Loading branch information
splatch committed Jul 27, 2024
1 parent 5e8b74f commit 191c9a1
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 66 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down Expand Up @@ -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.

|===


0 comments on commit 191c9a1

Please sign in to comment.