public
/
openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[epsonprojector] Update readme configuration section (#10828) 

* 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>
This commit is contained in:
mlobstein 2021-06-12 06:16:31 -05:00 committed by GitHub
parent bce5363856
commit f7815f8eb2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
bundles/org.openhab.binding.epsonprojector/README.md
View File

@ -21,14 +21,18 @@ All settings are through thing configuration parameters.
The `projector-serial` thing has the following 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 | Parameter | Name | Description | Required |
- _pollingInterval_: Polling interval in seconds to update channel states | 5-60 seconds; default 10 seconds |-----------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| 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: The `projector-tcp` thing has the following configuration parameters:
- _host_: IP address for the projector or serial over IP device | Parameter | Name | Description | Required |
- _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 | 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: Some notes:
@ -87,12 +91,12 @@ Some notes:
things/epson.things: things/epson.things:
```java ```
// serial port connection // serial port connection
epsonprojector:projector-serial:hometheater "Projector" [ serialPort="COM5", pollingInterval=10 ] epsonprojector:projector-serial:hometheater "Projector" [ serialPort="COM5", pollingInterval=10 ]
// direct IP or serial over IP connection // 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 ]
``` ```

4
bundles/org.openhab.binding.epsonprojector/src/main/resources/OH-INF/thing/thing-types.xml
View File

@ -46,7 +46,7 @@
<description>Serial Port to Use for Connecting to the Epson Projector</description> <description>Serial Port to Use for Connecting to the Epson Projector</description>
</parameter> </parameter>
<parameter name="pollingInterval" type="integer" min="5" max="60" unit="s" required="false"> <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> <description>Configures How Often to Poll the Projector for Updates (5-60; Default 10)</description>
<default>10</default> <default>10</default>
</parameter> </parameter>
@ -104,7 +104,7 @@
<default>3629</default> <default>3629</default>
</parameter> </parameter>
<parameter name="pollingInterval" type="integer" min="5" max="60" unit="s" required="false"> <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> <description>Configures How Often to Poll the Projector for Updates (5-60; Default 10)</description>
<default>10</default> <default>10</default>
</parameter> </parameter>