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

41
bundles/org.openhab.binding.smartmeter/README.md
View File

@@ -2,7 +2,6 @@
This binding retrieves and reads SML messages (PUSH) and supports IEC 62056-21 modes A,B,C (PULL) and D (PUSH).
## Supported Things
This binding supports only one Thing: `meter`
@@ -11,18 +10,17 @@ This binding supports only one Thing: `meter`
Discovery is not available, as the binding only reads from serial ports.
## Thing Configuration
The smartmeter thing requires the serial port where the meter device is connected and optionally a refresh interval.
| Parameter | Name | Description | Required | Default |
|-----------|------|-------------|----------|---------|
| `port` | The serial port to connect to| URL to use for playing notification sounds, e.g. `/dev/ttyUSB0` | yes | |
| `refresh` | The refresh interval in seconds | Defines at which interval the values of the meter device shall be read | no | 20 |
| `mode` | The protocol mode to use | Can be `SML` (PUSH mode), `ABC` (PULL) or `D` (PUSH) | no | `SML` |
| `baudrateChangeDelay` | Delay of baudrate change in ms | USB to serial converters often require a delay of up to 250ms after the ACK before changing baudrate (only relevant for 'C' mode) | no | 0 |
| `baudrate` | (initial) Baudrate | The baudrate of the serial port. If set to `AUTO`, it will be negotiated with the meter. The default is `300` baud for modes A, B, and C and `2400` baud for mode D, and `9600` baud for SML. | no | `AUTO` |
| Parameter | Name | Description | Required | Default |
| --------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
| `port` | The serial port to connect to | URL to use for playing notification sounds, e.g. `/dev/ttyUSB0` | yes | |
| `refresh` | The refresh interval in seconds | Defines at which interval the values of the meter device shall be read | no | 20 |
| `mode` | The protocol mode to use | Can be `SML` (PUSH mode), `ABC` (PULL) or `D` (PUSH) | no | `SML` |
| `baudrateChangeDelay` | Delay of baudrate change in ms | USB to serial converters often require a delay of up to 250ms after the ACK before changing baudrate (only relevant for 'C' mode) | no | 0 |
| `baudrate` | (initial) Baudrate | The baudrate of the serial port. If set to `AUTO`, it will be negotiated with the meter. The default is `300` baud for modes A, B, and C and `2400` baud for mode D, and `9600` baud for SML. | no | `AUTO` |
## Channels
@@ -34,22 +32,21 @@ Following conversion from OBIS codes to channel ID is done:
e.g.
| OBIS code | Channel ID |
|-------------|------------|
|`1-0:1.8.1` | `1-0_1-8-1` |
|`1.8.0*00` | `1-8-0_00` |
| OBIS code | Channel ID |
| ----------- | ----------- |
| `1-0:1.8.1` | `1-0_1-8-1` |
| `1.8.0*00` | `1-8-0_00` |
### Channel Configuration
**negate:** Energy meters often provide absolute values and provide information about the *energy direction* in a separate bit.
**negate:** Energy meters often provide absolute values and provide information about the _energy direction_ in a separate bit.
With this config you can specify the channel where this bit is located, the bit position and the bits value which shall be set.
`<negate> ::= <CHANNEL_ID>:<BIT_POSITION>:<BIT_VALUE>[:status]`
e.g.:
```
```text
"1-0_1-8-0:5:1:status" // negate if status(1-0_1-8-0) and 2^5 = 1
"1-0_96-5-5:5:1" // negate if 1-0#96-5-5 and 2^5 = 1
```
@@ -58,13 +55,13 @@ e.g.:
Please use the [Units Of Measurement](https://www.openhab.org/docs/concepts/units-of-measurement.html) concept of openHAB for unit conversion which is fully supported by this binding.
Please see the item example on how to use it.
*NOTE:* your meter device needs to provide correct unit information to work properly.
_NOTE:_ your meter device needs to provide correct unit information to work properly.
## Full Example
Things:
```
```java
smartmeter:meter:heating [ port="COM1", refresh=10 ]
smartmeter:meter:house [ port="rfc2217://xxx.xxx.xxx.xxx:3002" ]
@@ -80,7 +77,7 @@ smartmeter:meter:BinderPower [port="/dev/ttyUSB0", refresh=5] {
Items:
```
```java
Number:Energy HeatingTarif1 "Heating high price tariff [%.2f kWh]" { channel="smartmeter:meter:heating:1-0_1-8-1" }
Number:Energy HeatingTarif2 "Heating low price tariff [%.2f kWh]" { channel="smartmeter:meter:heating:1-0_1-8-2" }
@@ -93,11 +90,9 @@ Number:Power HouseActualUsage "Current usage [%.2f %unit%]" {
## Known Limitations
- Octet encoding for OBIS Codes
- '129-129:199.130.5'
- '129-129:199.130.5'
- '1-0:0.0.9'
doesn't work properly.
doesn't work properly.
Any help/contribution is appreciated!