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

[Documentation] Markdown improvements for bindings a to e (#13859)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-07 21:09:32 +01:00
committed by GitHub
parent 72efc1cfed
commit caf71f72e6
86 changed files with 1740 additions and 1822 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
bundles/org.openhab.binding.benqprojector/README.md
View File

@@ -38,39 +38,39 @@ The `projector-tcp` thing has the following configuration parameters:
Some notes:
* If using a serial port connection, the baud rate in the projector OSD menu must be set to 9600 bps.
* The _source_, _picturemode_ and _aspectratio_ channels include a dropdown with the most commonly used settings.
* Not all pre-defined dropdown options will be usable if your particular projector does support a given option.
* If your projector has an option that is not in the dropdown, the string code to access that option will be displayed by the channel when that option is selected by the remote control.
* By using the sitemap mapping or a rule to send that code back to the channel, any options that are missing in the binding can be accessed.
- If using a serial port connection, the baud rate in the projector OSD menu must be set to 9600 bps.
- The _source_, _picturemode_ and _aspectratio_ channels include a dropdown with the most commonly used settings.
- Not all pre-defined dropdown options will be usable if your particular projector does support a given option.
- If your projector has an option that is not in the dropdown, the string code to access that option will be displayed by the channel when that option is selected by the remote control.
- By using the sitemap mapping or a rule to send that code back to the channel, any options that are missing in the binding can be accessed.
* On Linux, you may get an error stating the serial port cannot be opened when the benqprojector binding tries to load.
* You can get around this by adding the `openhab` user to the `dialout` group like this: `usermod -a -G dialout openhab`.
* Also on Linux you may have issues with the USB if using two serial USB devices e.g. benqprojector and RFXcom. See the [general documentation about serial port configuration](/docs/administration/serial.html) for more on symlinking the USB ports.
* Here is an example of ser2net.conf you can use to share your serial port /dev/ttyUSB0 on IP port 4444 using [ser2net Linux tool](https://sourceforge.net/projects/ser2net/) (take care, the baud rate is specific to the BenQ projector):
- On Linux, you may get an error stating the serial port cannot be opened when the benqprojector binding tries to load.
- You can get around this by adding the `openhab` user to the `dialout` group like this: `usermod -a -G dialout openhab`.
- Also on Linux you may have issues with the USB if using two serial USB devices e.g. benqprojector and RFXcom. See the [general documentation about serial port configuration](/docs/administration/serial.html) for more on symlinking the USB ports.
- Here is an example of ser2net.conf you can use to share your serial port /dev/ttyUSB0 on IP port 4444 using [ser2net Linux tool](https://sourceforge.net/projects/ser2net/) (take care, the baud rate is specific to the BenQ projector):
```
```text
4444:raw:0:/dev/ttyUSB0:9600 8DATABITS NONE 1STOPBIT LOCAL
```
## Channels
| Channel | Item Type | Purpose | Values |
| ------------------ | --------- | --------------------------------------------------- | --------- |
| power | Switch | Powers the projector on or off. | |
| source | String | Retrieve or set the input source. | See above |
| picturemode | String | Retrieve or set the picture mode. | See above |
| aspectratio | String | Retrieve or set the aspect ratio. | See above |
| freeze | Switch | Turn the freeze image mode on or off. | |
| blank | Switch | Turn the screen blank mode on or off. | |
| directcmd | String | Send a command directly to the projector. | Send only |
| lamptime | Number | Retrieves the lamp hours. | Read only |
| Channel | Item Type | Purpose | Values |
| ------------------ | --------- | --------------------------------------------------- | --------- |
| power | Switch | Powers the projector on or off. | |
| source | String | Retrieve or set the input source. | See above |
| picturemode | String | Retrieve or set the picture mode. | See above |
| aspectratio | String | Retrieve or set the aspect ratio. | See above |
| freeze | Switch | Turn the freeze image mode on or off. | |
| blank | Switch | Turn the screen blank mode on or off. | |
| directcmd | String | Send a command directly to the projector. | Send only |
| lamptime | Number | Retrieves the lamp hours. | Read only |
## Full Example
things/benq.things:
```
```java
// serial port connection
benqprojector:projector-serial:hometheater "Projector" [ serialPort="COM5", pollingInterval=10 ]
@@ -81,7 +81,7 @@ benqprojector:projector-tcp:hometheater "Projector" [ host="192.168.0.10", port=
items/benq.items
```
```java
Switch benqPower { channel="benqprojector:projector-serial:hometheater:power" }
String benqSource "Source [%s]" { channel="benqprojector:projector-serial:hometheater:source" }
String benqPictureMode "Picture Mode [%s]" { channel="benqprojector:projector-serial:hometheater:picturemode" }
@@ -94,7 +94,7 @@ Number benqLampTime "Lamp Time [%d h]" <switch> { channel="benqprojector:p
sitemaps/benq.sitemap
```
```perl
sitemap benq label="BenQ Projector" {
Frame label="Controls" {
Switch item=benqPower label="Power"