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

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

@@ -1,10 +1,10 @@
# EchonetLite Binding
This binding supports devices that make use of the Echonet Lite specification (https://echonet.jp/spec_v113_lite_en/).
This binding supports devices that make use of the [Echonet Lite specification](https://echonet.jp/spec_v113_lite_en/).
## Supported Things
* Mitsubishi Electric MAC-568IF-E Wi-Fi interface (common on most Mitsubishi Heat Pumps).
- Mitsubishi Electric MAC-568IF-E Wi-Fi interface (common on most Mitsubishi Heat Pumps).
## Discovery
@@ -19,22 +19,22 @@ It is unlikely that this configuration will require changing.
The bridge configuration defaults should be applicable in most scenarios.
If device discovery is not working, this is most likely caused by the inability to receive multicast traffic from the device nodes.
* __port__: Port used for messaging both to and from device nodes, defaults to 3610.
* __multicastAddress__: Multicast address used to discover device nodes and to receive asynchronous notifications from devices.
- **port**: Port used for messaging both to and from device nodes, defaults to 3610.
- **multicastAddress**: Multicast address used to discover device nodes and to receive asynchronous notifications from devices.
## Thing Configuration
* __hostname__: Hostname or IP address of the device node.
* __port__: Port used to communicate with the device.
* __groupCode__: Group code as specified in "APPENDIX Detailed Requirements for ECHONET Device objects" (https://echonet.jp/spec_object_rp1_en/).
- **hostname**: Hostname or IP address of the device node.
- **port**: Port used to communicate with the device.
- **groupCode**: Group code as specified in "APPENDIX Detailed Requirements for ECHONET Device objects" (<https://echonet.jp/spec_object_rp1_en/>).
For Air Conditioners the value is '1'.
* __classCode__: Class code for the device, see __groupCode__ for reference information.
- **classCode**: Class code for the device, see **groupCode** for reference information.
The value for Home Air Conditioners is '48' (0x30).
* __instance__: Instance identifier if multiple instances are running on the same IP address.
- **instance**: Instance identifier if multiple instances are running on the same IP address.
Typically, this value will be '1'.
* __pollIntervalMs__: Interval between polls of the device for its current status.
- **pollIntervalMs**: Interval between polls of the device for its current status.
If multicast is not working this will determine the latency at which changes made directly on the device will be propagated back to openHAB, default is 30 000ms.
* __retryTimeoutMs__: Length of time the bridge will wait before resubmitting a request, default is 2 000ms.
- **retryTimeoutMs**: Length of time the bridge will wait before resubmitting a request, default is 2 000ms.
Because the binding uses UDP, packets can be lost on the network, so retries are necessary.
Testing has shown that 2 000ms is a reasonable default that allows for timely retries without rejecting slow, but legitimate responses.
@@ -42,7 +42,7 @@ Testing has shown that 2 000ms is a reasonable default that allows for timely re
## Channels
Channels are derived from the Echonet Lite specification and vary from device to device depending on capabilities.
The full set of potential channels is available from "APPENDIX Detailed Requirements for ECHONET Device objects" (https://echonet.jp/spec_object_rp1_en/)
The full set of potential channels is available from "APPENDIX Detailed Requirements for ECHONET Device objects" (<https://echonet.jp/spec_object_rp1_en/>)
The channels currently implemented are:
@@ -71,10 +71,9 @@ The channels currently implemented are:
## Full Example
### Things
```
```java
Bridge echonetlite:bridge:1 [port="3610", multicastAddress="224.0.23.0"] {
Thing device HeatPump_Bedroom1 "HeatPump Bedroom 1" @ "Bedroom 1" [hostname="192.168.0.55", port="3610", groupCode="1", classCode="48", instance="1", pollIntervalMs="30000", retryTimeoutMs="2000"]
}
@@ -82,6 +81,6 @@ Bridge echonetlite:bridge:1 [port="3610", multicastAddress="224.0.23.0"] {
### Items
```
```java
Switch HeatPumpBedroom1_OperationStatus "HeatPump Bedroom1 Operation Status" {channel="echonetlite:device:1:HeatPump_Bedroom1:operationStatus"}
```