]> git.basschouten.com Git - openhab-addons.git/commitdiff
[epsonprojector] Update readme configuration section (#10828)
authormlobstein <michael.lobstein@gmail.com>
Sat, 12 Jun 2021 11:16:31 +0000 (06:16 -0500)
committerGitHub <noreply@github.com>
Sat, 12 Jun 2021 11:16:31 +0000 (13:16 +0200)
* update Epson readme per standards

Signed-off-by: Michael Lobstein <michael.lobstein@gmail.com>
* capitalize label

Signed-off-by: Michael Lobstein <michael.lobstein@gmail.com>
bundles/org.openhab.binding.epsonprojector/README.md
bundles/org.openhab.binding.epsonprojector/src/main/resources/OH-INF/thing/thing-types.xml

index 4f80e33217317256cfe18963c74fe581732ffe33..267218070792e910d76cfb466fedde4a6cb394e1 100644 (file)
@@ -21,14 +21,18 @@ All settings are through thing configuration parameters.
 
 The `projector-serial` thing has the following configuration parameters:
 
-- _serialPort_: Serial port device name that is connected to the Epson projector to control, e.g. COM1 on Windows, /dev/ttyS0 on Linux or /dev/tty.PL2303-0000103D on Mac
-- _pollingInterval_: Polling interval in seconds to update channel states | 5-60 seconds; default 10 seconds
+| Parameter       | Name             | Description                                                                                                                                                | Required |
+|-----------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
+| serialPort      | Serial Port      | Serial port device name that is connected to the Epson projector to control, e.g. COM1 on Windows, /dev/ttyS0 on Linux or /dev/tty.PL2303-0000103D on Mac. | yes      |
+| pollingInterval | Polling Interval | Polling interval in seconds to update channel states, range 5-60 seconds; default 10 seconds.                                                              | no       |
 
 The `projector-tcp` thing has the following configuration parameters:
 
-- _host_: IP address for the projector or serial over IP device
-- _port_: Port for the projector or serial over IP device; default 3629 for projectors with built-in ethernet connector or Wi-Fi
-- _pollingInterval_: Polling interval in seconds to update channel states | 5-60 seconds; default 10 seconds
+| Parameter       | Name             | Description                                                                                                             | Required |
+|-----------------|------------------|-------------------------------------------------------------------------------------------------------------------------|----------|
+| host            | Host Name        | Host Name or IP address for the projector or serial over IP device.                                                     | yes      |
+| port            | Port             | Port for the projector or serial over IP device; default 3629 for projectors with built-in ethernet connector or Wi-Fi. | yes      |
+| pollingInterval | Polling Interval | Polling interval in seconds to update channel states, range 5-60 seconds; default 10 seconds.                           | no       |
 
 Some notes:
 
@@ -87,12 +91,12 @@ Some notes:
 
 things/epson.things:
 
-```java
+```
 // serial port connection
 epsonprojector:projector-serial:hometheater "Projector" [ serialPort="COM5", pollingInterval=10 ]
 
 // direct IP or serial over IP connection
-epsonprojector:projector-tcp:hometheater "Projector"  [ host="192.168.0.10", port=3629, pollingInterval=10 ]
+epsonprojector:projector-tcp:hometheater "Projector" [ host="192.168.0.10", port=3629, pollingInterval=10 ]
 
 ```
 
index 611c9368e392eb84e7a2761a5e478f360cab1e64..6fb3e30778b52e9014074fcf39bce0378dcc74d2 100644 (file)
@@ -46,7 +46,7 @@
                                <description>Serial Port to Use for Connecting to the Epson Projector</description>
                        </parameter>
                        <parameter name="pollingInterval" type="integer" min="5" max="60" unit="s" required="false">
-                               <label>Polling interval</label>
+                               <label>Polling Interval</label>
                                <description>Configures How Often to Poll the Projector for Updates (5-60; Default 10)</description>
                                <default>10</default>
                        </parameter>
                                <default>3629</default>
                        </parameter>
                        <parameter name="pollingInterval" type="integer" min="5" max="60" unit="s" required="false">
-                               <label>Polling interval</label>
+                               <label>Polling Interval</label>
                                <description>Configures How Often to Poll the Projector for Updates (5-60; Default 10)</description>
                                <default>10</default>
                        </parameter>