Skip to content

Commit 2eb08b8

Browse files
authored
Fix documentation, grammar, and spelling in bindings T (#19601)
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
1 parent 9f24593 commit 2eb08b8

45 files changed

Lines changed: 853 additions & 856 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

bundles/org.openhab.binding.tacmi/README.md

Lines changed: 58 additions & 58 deletions
Large diffs are not rendered by default.

bundles/org.openhab.binding.tacmi/src/main/resources/OH-INF/config/config.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
<config-description uri="channel-type:tacmi:schemaApiDefaults">
88
<parameter name="updatePolicy" type="integer" min="0" max="2">
99
<label>Update Policy</label>
10-
<description>Update policy for this channel. Default means "On-Change" for channels that can be modified and
11-
"On-Fetch" for read-only channels.</description>
10+
<description>Update policy for this channel. Default means "On-Fetch" for read-only channels and "On-Change" for
11+
channels that can be modified.</description>
1212
<default>0</default>
1313
<options>
1414
<option value="0">Default</option>
1515
<option value="1">On-Fetch</option>
16-
<option value="2">On-Update</option>
16+
<option value="2">On-Change</option>
1717
</options>
1818
</parameter>
1919
</config-description>

bundles/org.openhab.binding.tacmi/src/main/resources/OH-INF/i18n/tacmi.properties

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ thing-type.tacmi.cmiJSON.description = Communication via the "JSONAPI" on a "Tec
1212
thing-type.tacmi.cmiSchema.label = TA C.M.I. Schema API Connection
1313
thing-type.tacmi.cmiSchema.description = Communication to a special "API" schema page on a "Technische Alternative C.M.I. Control and Monitoring Interface"
1414
thing-type.tacmi.coe-bridge.label = TA C.M.I. CoE Bridge
15-
thing-type.tacmi.coe-bridge.description = This bridge opens the CoE-UDP Port 5441 on OpenHAB for communication with "Technische Alternative C.M.I."
15+
thing-type.tacmi.coe-bridge.description = This bridge opens the CoE-UDP Port 5441 on openHAB for communication with "Technische Alternative C.M.I."
1616

1717
# thing types config
1818

1919
thing-type.config.tacmi.cmi.host.label = C.M.I. IP Address
20-
thing-type.config.tacmi.cmi.host.description = Host name of IP address of the CMI
20+
thing-type.config.tacmi.cmi.host.description = Host name or IP address of the C.M.I.
2121
thing-type.config.tacmi.cmi.node.label = Node
2222
thing-type.config.tacmi.cmi.node.description = The CoE / CAN Node number openHAB should represent
2323
thing-type.config.tacmi.cmiJSON.host.label = C.M.I. IP Address
2424
thing-type.config.tacmi.cmiJSON.host.description = Host name or IP address of the C.M.I.
2525
thing-type.config.tacmi.cmiJSON.nodeId.label = Node Id
26-
thing-type.config.tacmi.cmiJSON.nodeId.description = The node ID of the device you want to monitor (CMI → CAN-Bus)
26+
thing-type.config.tacmi.cmiJSON.nodeId.description = The node ID of the device you want to monitor (C.M.I. → CAN-Bus)
2727
thing-type.config.tacmi.cmiJSON.params.label = API-Parameters
2828
thing-type.config.tacmi.cmiJSON.params.description = The params to query. E.g. I,O,Sg (See the <a href="https://wiki.ta.co.at/C.M.I._JSON-API">API documentation</a> for details)<br /> Possible options are: Inputs (I), Outputs (O), General (Sg), Logging Analog (La), Logging Digital (Ld)
2929
thing-type.config.tacmi.cmiJSON.password.label = Password
@@ -42,6 +42,7 @@ thing-type.config.tacmi.cmiSchema.schemaId.label = API Schema Id
4242
thing-type.config.tacmi.cmiSchema.schemaId.description = ID of the schema API page
4343
thing-type.config.tacmi.cmiSchema.username.label = Username
4444
thing-type.config.tacmi.cmiSchema.username.description = Username for authentication on the C.M.I.
45+
4546
# channel types
4647

4748
channel-type.tacmi.coe-analog-in.label = Analog Input Channel (C.M.I. -> OH)
@@ -51,7 +52,7 @@ channel-type.tacmi.coe-analog-out.description = An Analog Channel sent to the C.
5152
channel-type.tacmi.coe-digital-in.label = Digital Input (C.M.I. -> OH)
5253
channel-type.tacmi.coe-digital-in.description = A digital channel sent from C.M.I. to openHAB
5354
channel-type.tacmi.coe-digital-out.label = Digital Output (OH -> C.M.I.)
54-
channel-type.tacmi.coe-digital-out.description = A digital channel sent from OpenHAB to C.M.I.
55+
channel-type.tacmi.coe-digital-out.description = A digital channel sent from openHAB to C.M.I.
5556
channel-type.tacmi.schema-date-time-ro.label = Time Value
5657
channel-type.tacmi.schema-date-time-ro.description = A time read from C.M.I. - Only the time is supplied, the date part is set to the current day.
5758
channel-type.tacmi.schema-numeric-ro.label = Value
@@ -102,7 +103,7 @@ channel-type.config.tacmi.coe-digital-out.initialValue.description = Initial val
102103
channel-type.config.tacmi.coe-digital-out.output.label = Output
103104
channel-type.config.tacmi.coe-digital-out.output.description = Network Output
104105
channel-type.config.tacmi.schemaApiDefaults.updatePolicy.label = Update Policy
105-
channel-type.config.tacmi.schemaApiDefaults.updatePolicy.description = Update policy for this channel. Default means "On-Change" for channels that can be modified and "On-Fetch" for read-only channels.
106+
channel-type.config.tacmi.schemaApiDefaults.updatePolicy.description = Update policy for this channel. Default means "On-Fetch" for read-only channels and "On-Change" for channels that can be modified.
106107
channel-type.config.tacmi.schemaApiDefaults.updatePolicy.option.0 = Default
107108
channel-type.config.tacmi.schemaApiDefaults.updatePolicy.option.1 = On-Fetch
108-
channel-type.config.tacmi.schemaApiDefaults.updatePolicy.option.2 = On-Update
109+
channel-type.config.tacmi.schemaApiDefaults.updatePolicy.option.2 = On-Change

bundles/org.openhab.binding.tacmi/src/main/resources/OH-INF/thing/bridge.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66

77
<bridge-type id="coe-bridge">
88
<label>TA C.M.I. CoE Bridge</label>
9-
<description>This bridge opens the CoE-UDP Port 5441 on OpenHAB for communication with "Technische Alternative C.M.I."</description>
9+
<description>This bridge opens the CoE-UDP Port 5441 on openHAB for communication with "Technische Alternative C.M.I."</description>
1010
</bridge-type>
1111
</thing:thing-descriptions>

bundles/org.openhab.binding.tacmi/src/main/resources/OH-INF/thing/thing-types.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<config-description>
1717
<parameter name="host" type="text" required="true">
1818
<label>C.M.I. IP Address</label>
19-
<description>Host name of IP address of the CMI</description>
19+
<description>Host name or IP address of the C.M.I.</description>
2020
<context>network-address</context>
2121
</parameter>
2222
<parameter name="node" type="integer" min="1" max="62" required="true">
@@ -46,7 +46,7 @@
4646
<channel-type id="coe-digital-out">
4747
<item-type>Switch</item-type>
4848
<label>Digital Output (OH -> C.M.I.)</label>
49-
<description>A digital channel sent from OpenHAB to C.M.I.</description>
49+
<description>A digital channel sent from openHAB to C.M.I.</description>
5050
<tags>
5151
<tag>Switch</tag>
5252
</tags>
@@ -80,7 +80,7 @@
8080
<channel-type id="coe-analog-out">
8181
<item-type>Number</item-type>
8282
<label>Analog Output Channel (OH -> C.M.I.)</label>
83-
<description>A Analog Channel sent to the C.M.I.</description>
83+
<description>An Analog Channel sent to the C.M.I.</description>
8484
<tags>
8585
<tag>Control</tag>
8686
</tags>
@@ -227,9 +227,9 @@
227227
<description>Password for authentication on the C.M.I.</description>
228228
<context>password</context>
229229
</parameter>
230-
<parameter name="nodeId" type="integer" required="true" min="0">
230+
<parameter name="nodeId" type="integer" required="true" min="1">
231231
<label>Node Id</label>
232-
<description>The node ID of the device you want to monitor (CMI → CAN-Bus)</description>
232+
<description>The node ID of the device you want to monitor (C.M.I. → CAN-Bus)</description>
233233
</parameter>
234234
<parameter name="params" type="text">
235235
<label>API-Parameters</label>

0 commit comments

Comments
 (0)