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

[Documentation] Markdown improvements n to s (#13948)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-14 16:52:43 +01:00
committed by GitHub
parent d73218d882
commit 1ca9baf157
106 changed files with 4506 additions and 4729 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
bundles/org.openhab.binding.rotel/README.md
View File

@@ -4,15 +4,15 @@ This binding can be used to control a Rotel audio device like a surround process
The binding supports different kinds of connections:
* serial connection,
* serial over IP connection,
* IP connection (for models providing a network interface).
- serial connection,
- serial over IP connection,
- IP connection (for models providing a network interface).
The binding supports all kinds of Rotel protocols:
* HEX protocol,
* Old ASCII protocol (named v1 in the binding),
* Recent ASCII protocol (named v2 in the binding).
- HEX protocol,
- Old ASCII protocol (named v1 in the binding),
- Recent ASCII protocol (named v2 in the binding).
For users without serial connector on server side, of course you can add a serial to USB adapter.
@@ -138,15 +138,14 @@ Some have additional parameters listed in the next table:
Some notes:
* On Linux, you may get an error stating the serial port cannot be opened when the Rotel 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. Rotel 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 Rotel device specific):
- On Linux, you may get an error stating the serial port cannot be opened when the Rotel 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. Rotel 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 Rotel device specific):
```
```text
4444:raw:0:/dev/ttyUSB0:19200 8DATABITS NONE 1STOPBIT
```
## Channels
The following channels are available:
@@ -278,7 +277,7 @@ Here are the available commands for the otherCommand channel depending on the th
example.things using serial connection:
```
```java
Thing rotel:rsp1066:preamp "RSP-1066" [ serialPort="COM1", inputLabelVideo1="VID 1", inputLabelVideo2="VID 2", inputLabelVideo3="VID 3", inputLabelVideo4="VID 4", inputLabelVideo5="VID 5" ]
Thing rotel:rsp1570:preamp "RSP-1570" [ serialPort="COM2" ]
@@ -292,7 +291,7 @@ Thing rotel:a14:amp "A14" [ serialPort="/dev/ttyUSB0" ]
example.things using serial over IP connection:
```
```java
Thing rotel:rsp1066:preamp "RSP-1066" [ host="192.168.0.200", port=3000, inputLabelVideo1="VID 1", inputLabelVideo2="VID 2", inputLabelVideo3="VID 3", inputLabelVideo4="VID 4", inputLabelVideo5="VID 5" ]
Thing rotel:rsp1570:preamp "RSP-1570" [ host="192.168.0.201", port=3000, inputLabelCd="CD", inputLabelTuner="TUNER", inputLabelTape="TAPE", inputLabelVideo1="VIDEO 1", inputLabelVideo2="VIDEO 2", inputLabelVideo3="VIDEO 3", inputLabelVideo4="VIDEO 4", inputLabelVideo5="VIDEO 5", inputLabelMulti="MULTI" ]
@@ -304,7 +303,7 @@ Thing rotel:cd14:cd "CD14" [ host="192.168.0.203", port=3000 ]
example.items:
```
```java
Switch preamp_power "Power" { channel="rotel:rsp1066:preamp:mainZone#power" }
String preamp_source "Source Input [%s]" { channel="rotel:rsp1066:preamp:mainZone#source" }
String preamp_rec "Record Source [%s]" { channel="rotel:rsp1066:preamp:mainZone#recordSource" }
@@ -362,7 +361,7 @@ Dimmer cd_brightness "Display brightness" { channel="rotel:cd14:cd:brightness" }
example.sitemap:
```
```perl
Switch item=preamp_power
Selection item=preamp_source
Selection item=preamp_rec