OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated external content (Jenkins build 18)

pull/788/head
CloudBees DEV@Cloud 2018-08-29 12:38:36 +02:00
parent 35d9961ef4
commit e1ec3c349d
12 changed files with 655 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

307
_addons_bindings/dsmr/readme.md Normal file
View File

@ -0,0 +1,307 @@
---
id: dsmr
label: DSMR
title: DSMR - Bindings
type: binding
description: "The DSMR-binding is targeted towards Dutch users having a smart meter (Dutch: 'Slimme meter')."
since: 2x
install: auto
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# DSMR Binding
The DSMR-binding is targeted towards Dutch users having a smart meter (Dutch: 'Slimme meter').
Data of Dutch smart meters can be obtained via the P1-port.
When connecting this port from a serial port the data can be read out.
This binding reads the P1-port of the Dutch Smart Meters that comply to NTA8130, DSMR v2.1, DSMR v2.2, DSMR v3.0, DSMR v4.0, DSMR v4.04, and DSMR 5.0.
Although DSMR v4.2 is not an official specification, the binding has support for this version.
If you are not living in the Netherlands but do want to read a meter please have look at the [IEC-62056-21 Meter Binding](https://github.com/openhab/openhab1-addons/wiki/IEC-62056---21-Meter-Binding).
Because the Dutch Meter standard is based on the IEC-62056-21 standard it might be desirable to build support for other country metering systems based on that standard in this binding.
## Supported Things
`dsmrBridge`: This is the device that communicated between the binding (serial) and its internal meters.
You always have to have a 'Dutch Smart Meter'-bridge. The bridge contains the serial port configuration.
Specific meters are bound via the bridge to the smart meter. A smart meter consists typically out of minimal 2 meters.
A generic meter and the electricity meter. Each meter is bound to the DSMR protocol the physical meter supports.
For each meter it is possible to set a refresh rate at which the status is updated.
The physical meter might update with a high frequency per second, while it's desired to have only values per minute.
### Discovery
Both bridges and meters can be discovered via the discovery process.
If a bridge is manually configured it is possible to auto detect available meters.
#### Configuration
The configuration for the Bridge consists of the following parameters:
| Parameter | Description |
|---------------------|-------------------------------------------------------------------------------------------------------------|
| serialPort | The serial port where the P1-port is connected to (e.g. Linux: `/dev/ttyUSB1`, Windows: `COM2`) (mandatory) |
| receivedTimeout | The time out period in which messages are expected to arrive, default is 120 seconds. |
| baudrate | Baudrate when no auto detect. valid values: 4800, 9600, 19200, 38400, 57600, 115200 |
| databits | Data bits when no auto detect. valid values: 5, 6, 7, 8 |
| parity | Parity when no auto detect. valid values: E(ven), N(one), O(dd) |
| stopbits | Stop bits when no auto detect. valid values: 1, 1.5, 2 |
**Note:** *The manual configuration is only needed if the DSMR-device requires non DSMR-standard Serial Port parameters (i.e. something different then `115200 8N1` or `9600 7E1`)*
### Meters
The information in this paragraph in necessary if you choose to configure the meters manually in a `.things` file.
Supported meters:
| Meter Thing | Thing type ID | M-Bus channel | Refresh rate |
|-------------------------------------------------|------------------------------|---------------|--------------|
| DSMR V2 / V3 Device | `device_v2_v3` | -1 | 10 seconds |
| DSMR V4 Device | `device_v4` | -1 | 10 seconds |
| DSMR V5 Device | `device_v5` | -1 | 10 seconds |
| ACE4000 GTMM Mk3 Electricity meter | `electricity_ace4000` | 0 | 10 seconds |
| DSMR V2.1 Electricity meter | `electricity_v2_1` | 0 | 10 seconds |
| DSMR V2.2 Electricity meter | `electricity_v2_2` | 0 | 10 seconds |
| DSMR V3 Electricity meter | `electricity_v3_0` | 0 | 10 seconds |
| DSMR V4.0 Electricity meter | `electricity_v4_0` | 0 | 10 seconds |
| DSMR V4.0.4 Electricity meter | `electricity_v4_0_4` | 0 | 10 seconds |
| DSMR V4.2 Electricity meter | `electricity_v4_2` | 0 | 10 seconds |
| DSMR V5 Electricity meter | `electricity_v5_0` | 0 | 10 seconds |
| ACE4000 GTMM Mk3 Gas meter | `gas_ace4000` | 3 | 1 hour |
| DSMR V2.1 Gas meter | `gas_v2_1` | 0 | 24 hours |
| DSMR V2.2 Gas meter | `gas_v2_2` | 0 | 24 hours |
| DSMR V3.0 Gas meter | `gas_v3_0` | *note 1* | 1 hour |
| ACE4000 GTMM Mk3 Cooling meter | `cooling_ace4000` | 6 | 1 hour |
| DSMR V2.2 Cooling meter | `cooling_v2_2` | 0 | 1 hour |
| ACE4000 GTMM Mk3 Heating meter | `heating_ace4000` | 4 | 1 hour |
| DSMR V2.2 Heating meter | `heating_v2_2` | 0 | 1 hour |
| ACE4000 GTMM Mk3 Water meter | `water_ace4000` | 5 | 1 hour |
| DSMR V2.2 Water meter | `water_v2_2` | 0 | 1 hour |
| DSMR V3.0 Water meter | `water_v3_0` | *note 1* | 1 hour |
| ACE4000 GTMM Mk3 1st Slave Electricity meter | `slave_electricity1_ace4000` | 1 | 1 hour |
| ACE4000 GTMM Mk3 2nd Slave Electricity meter | `slave_electricity2_ace4000` | 2 | 1 hour |
| DSMR V4.x Slave Electricity meter | `slave_electricity_v4` | *note 1* | 1 hour |
| DSMR V5 Slave Electricity meter | `slave_electricity_v5` | *note 1* | 5 minutes |
| DSMR V3.0 Generic meter | `generic_v3_0` | *note 1* | 1 hour |
| DSMR V3.0 Giga Joule meter (heating or cooling) | `gj_v3_0` | *note 1* | 1 hour |
| DSMR V4.x Giga Joule meter (heating or cooling) | `gj_v4` | *note 1* | 1 hour |
| DSMR V5 Giga Joule meter (heating or cooling) | `gj_v5_0` | *note 1* | 5 minutes |
| DSMR V4.x m3 meter (gas or water) | `m3_v4` | *note 1* | 1 hour |
| DSMR V5 m3 meter (gas or water) | `m3_v5_0` | *note 1* | 5 minutes |
*note 1*. The channel of these meters is dependent on the physical installation and corresponds to the M-Bus channel.
You can ask your supplier / installer for this information or you can retrieve it from the logfiles (see *Determine M-Bus channel*).
#### Configuration
The configuration for the meters consists of the following parameters:
| Parameter | Description |
|---------------------|--------------------------------------------------------------------------------------|
| refresh | Time in seconds with which the state of the device is updated. Default is 60 seconds |
| channel | M-Bus channel. See the table above |
**Examples**
```
Bridge dsmr:dsmrBridge:myDSMRDevice [serialPort="/dev/ttyUSB0"] {
Things:
device_v5 dsmrDeviceV5 [channel=-1]
electricity_v5_0 electricityV5 [channel=0]
}
```
### Channels
#### Item configuration
Paper UI. Item configuration can be done in the regular way.
Manual configuration:
The following channels are supported:
- Y channel is supported
- \- channel is not supported
- O channel is supported only if the device has this functionality
| Channel Type ID | Item Type | Description | Ace4000 | DSMR V2.1 | DSMR V2.2 | DSMR V3.0 | DSMR V4.0 | DSMR V4.0.4 | DSMR V4.2 | DSMR V5 |
|--------------------------------------------------|-----------|------------------------------------------------------------------------|---------|-----------|-----------|-----------|-----------|-------------|-----------|---------|
| | | **Channels for the generic device** | | | | | | | | |
| `p1_text_code` | String | Text code from the device | - | Y | Y | Y | Y | Y | Y | - |
| `p1_text_string` | String | Text string from the device | - | Y | Y | Y | Y | Y | Y | Y |
| `p1_version_output` | String | Version information (most times this refers to the DSMR specification) | - | - | - | - | Y | Y | Y | Y |
| `p1_timestamp` | DateTime | Timestamp of the last device reading | - | - | - | - | Y | Y | Y | Y |
| | | **Channels for the cooling meter** | | | | | | | | |
| `cmeter_value_v2` | Number | The total amount of cooling used in the past period (GJ) | Y | - | Y | - | - | - | - | - |
| `cmeter_value_v2_timestamp` | DateTime | Timestamp of the last meter reading | Y | - | Y | - | - | - | - | - |
| `cmeter_equipment_identifier_v2_2` | String | Equipment identifier | - | - | Y | - | - | - | - | - |
| | | **Channels for the main electricity meter** | | | | | | | | |
| `emeter_equipment_identifier_v2_x` | String | Electricity Equipment identifier | - | Y | Y | - | - | - | - | - |
| `emeter_equipment_identifier` | String | Electricity Equipment identifier | - | - | - | Y | Y | Y | Y | Y |
| `emeter_delivery_tariff0` | Number | Total amount of electricity used for tariff 0 (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_delivery_tariff1` | Number | Total amount of electricity used for tariff 1 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y |
| `emeter_delivery_tariff2` | Number | Total amount of electricity used for tariff 2 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y |
| `emeter_production_tariff0` | Number | Total amount of electricity produced for tariff 0 (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_production_tariff1` | Number | Total amount of electricity produced for tariff 1 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y |
| `emeter_production_tariff2` | Number | Total amount of electricity produced for tariff 2 (kWh) | Y | Y | Y | Y | Y | Y | Y | Y |
| `emeter_delivery_tariff0_antifraud` | Number | Total amount of electricity used for tariff 2 [antifraud] (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_delivery_tariff1_antifraud` | Number | Total amount of electricity used for tariff 1 [antifraud] (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_delivery_tariff2_antifraud` | Number | Total amount of electricity used for tariff 2 [antifraud] (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_tariff_indicator` | String | Current tariff indicator | Y | Y | Y | Y | Y | Y | Y | Y |
| `emeter_treshold_a_v2_1` | Number | Actual treshold (A) | - | Y | - | - | - | - | - | - |
| `emeter_treshold_a` | Number | Actual treshold (A) | Y | - | Y | Y | - | - | - | - |
| `emeter_treshold_kwh` | Number | Actual treshold (kW) | - | - | - | - | Y | Y | - | - |
| `emeter_switch_position_v2_1` | Number | Switch position | - | Y | - | - | - | - | - | - |
| `emeter_switch_position` | Number | Switch position | Y | - | Y | Y | Y | Y | - | - |
| `emeter_active_import_power` | Number | Aggregate active import power (W) | Y | - | - | - | - | - | - | - |
| `emeter_actual_delivery` | Number | Current power delivery (kW) | - | Y | Y | Y | Y | Y | Y | Y |
| `emeter_actual_production` | Number | Current power production (kW) | - | - | - | Y | Y | Y | Y | Y |
| `emeter_power_failures` | Number | Number of power failures | - | - | - | - | Y | Y | Y | Y |
| `emeter_long_power_failures` | Number | Number of long power failures | - | - | - | - | Y | Y | Y | Y |
| `emeter_power_failure_log_entries` | Number | Number of entries in the power failure log | - | - | - | - | Y | Y | Y | Y |
| `emeter_power_failure_log_timestamp[x]` *note 2* | Number | Number of entries in the power failure log | - | - | - | - | Y | Y | Y | Y |
| `emeter_power_failure_log_duration[x]` *note 2* | Number | Number of entries in the power failure log | - | - | - | - | Y | Y | Y | Y |
| `emeter_voltage_sags_l1` | Number | Number of voltage sags L1 | - | - | - | - | Y | Y | Y | Y |
| `emeter_voltage_sags_l2` | Number | Number of voltage sags L2 | - | - | - | - | O | O | O | O |
| `emeter_voltage_sags_l3` | Number | Number of voltage sags L3 | - | - | - | - | O | O | O | O |
| `emeter_voltage_swells_l1` | Number | Number of voltage swells L1 | - | - | - | - | Y | Y | Y | Y |
| `emeter_voltage_swells_l2` | Number | Number of voltage swells L2 | - | - | - | - | O | O | O | O |
| `emeter_voltage_swells_l3` | Number | Number of voltage swells L3 | - | - | - | - | O | O | O | O |
| `emeter_instant_current_l1` | Number | Instant Current L1 (A) | - | - | - | - | Y | Y | Y | Y |
| `emeter_instant_current_l2` | Number | Instant Current L2 (A) | - | - | - | - | O | O | O | O |
| `emeter_instant_current_l3` | Number | Instant Current L3 (A) | - | - | - | - | O | O | O | O |
| `emeter_instant_power_delivery_l1` | Number | Instant Power Delivery L1 (kW) | - | - | - | - | Y | Y | Y | Y |
| `emeter_instant_power_delivery_l2` | Number | Instant Power Delivery L2 (kW) | - | - | - | - | O | O | O | O |
| `emeter_instant_power_delivery_l3` | Number | Instant Power Delivery L3 (kW) | - | - | - | - | O | O | O | O |
| `emeter_instant_power_production_l1` | Number | Instant Power Production L1 (kW) | - | - | - | - | Y | Y | Y | Y |
| `emeter_instant_power_production_l2` | Number | Instant Power Production L2 (kW) | - | - | - | - | O | O | O | O |
| `emeter_instant_power_production_l3` | Number | Instant Power Production L3 (kW) | - | - | - | - | O | O | O | O |
| `emeter_instant_voltage_l1` | Number | Instant Voltage L1 (V) | - | - | - | - | - | - | - | Y |
| `emeter_instant_voltage_l2` | Number | Instant Voltage L2 (V) | - | - | - | - | - | - | - | O |
| `emeter_instant_voltage_l3` | Number | Instant Voltage L3 (V) | - | - | - | - | - | - | - | O |
| | | **Channels for the slave electricity meter** | | | | | | | | |
| `meter_device_type` | String | Slave Electricity Meter Device Type | - | - | - | - | Y | Y | Y | Y |
| `meter_equipment_identifier` | String | Slave Electricity Meter ID | - | - | - | - | Y | Y | Y | Y |
| `emeter_delivery_tariff0` | Number | Total amount of slave electricity used for tariff 0 (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_delivery_tariff1` | Number | Total amount of slave electricity used for tariff 1 (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_delivery_tariff2` | Number | Total amount of slave electricity used for tariff 2 (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_production_tariff0` | Number | Total amount of slave electricity produced for tariff 0 (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_production_tariff1` | Number | Total amount of slave electricity produced for tariff 1 (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_production_tariff2` | Number | Total amount of slave electricity produced for tariff 2 (kWh) | Y | - | - | - | - | - | - | - |
| `emeter_tariff_indicator` | String | Current slave tariff indicator | Y | - | - | - | - | - | - | - |
| `emeter_treshold_a` | Number | Actual slave treshold (A) | Y | - | - | - | - | - | - | - |
| `meter_switch_position` | Number | Slave electricity switch position | Y | - | - | Y | Y | Y | - | - |
| `emeter_active_import_power` | Number | Slave aggregate active import power (W) | Y | - | - | - | - | - | - | - |
| `emeter_value` | Number | Slave electricity usage (kWh) in the past period | - | - | - | - | Y | Y | Y | Y |
| `emeter_value_timestamp` | DateTime | Timestamp of the last reading | - | - | - | - | Y | Y | Y | Y |
| `meter_device_type` | String | Gas Meter Device Type | - | - | - | Y | - | - | - | - |
| `meter_equipment_identifier` | String | Gas Meter ID | Y | - | - | Y | - | - | - | - |
| | | **Channels for the gas meter** | | | | | | | | |
| `gmeter_equipment_identifier_v2` | String | Gas Meter ID | - | Y | Y | - | - | - | - | - |
| `gmeter_24h_delivery_v2` | Number | Gas Delivery past 24 hours | Y | Y | Y | - | - | - | - | - |
| `gmeter_24h_delivery_v2_timestamp` | DateTime | Timestamp of the last reading | Y | Y | Y | - | - | - | - | - |
| `gmeter_24h_delivery_compensated_v2` | Number | Gas Delivery past 24 hours (compensated) | - | Y | Y | - | - | - | - | - |
| `gmeter_24h_delivery_compensated_v2_timestamp` | DateTime | Timestamp of the last reading | - | Y | Y | - | - | - | - | - |
| `gmeter_value_v3` | Number | Gas Delivery past period | - | - | - | Y | - | - | - | - |
| `gmeter_value_v3_timestamp` | DateTime | Timestamp of the last reading | - | - | - | Y | - | - | - | - |
| `gmeter_valve_position_v2_1` | Number | Gas Valve position | - | Y | - | - | - | - | - | - |
| `gmeter_valve_position_v2_2` | Number | Gas Valve position | Y | - | Y | - | - | - | - | - |
| | | **Channels for the generic meter** | | | | | | | | |
| `meter_valve_switch_position` | Number | Gas Valve position | - | - | - | Y | - | - | - | - |
| `meter_device_type` | String | Generic Meter Device Type | - | - | - | Y | - | - | - | - |
| `gmeter_equipment_identifier` | String | Generic Meter ID | - | - | - | Y | - | - | - | - |
| `genmeter_value_v3` | Number | Delivery past period | - | - | - | Y | - | - | - | - |
| `meter_valve_switch_position` | Number | Generic Meter Valve/Switch position | - | - | - | Y | - | - | - | - |
| | | **Channels for the GJ meter (Heating or Cooling)** | | | | | | | | |
| `meter_device_type` | String | GJ Meter Device Type | - | - | - | Y | Y | Y | Y | Y |
| `meter_equipment_identifier` | Number | GJ Meter ID | - | - | - | Y | Y | Y | Y | Y |
| `gjmeter_value_v3` | Number | GJ Delivery past period | - | - | - | Y | - | - | - | - |
| `gjmeter_value_v3_timestamp` | DateTime | Timestamp of the last reading | - | - | - | Y | - | - | - | - |
| `gjmeter_value_v4` | Number | GJ Delivery past period | - | - | - | - | Y | Y | Y | Y |
| `gjmeter_value_v4_timestamp` | DateTime | Timestamp of the last reading | - | - | - | - | Y | Y | Y | Y |
| | | **Channels for the heating meter** | | | | | | | | |
| `meter_valve_switch_position` | Number | GJ Meter Valve position | - | - | - | Y | Y | Y | Y | - |
| `meter_equipment_identifier` | String | Heating Meter ID | Y | - | - | - | - | - | - | - |
| `hmeter_equipment_identifier_v2_2` | String | Heating Meter ID | - | - | Y | - | - | - | - | - |
| `hmeter_value_v2` | Number | Heating Delivery past period | Y | - | Y | - | - | - | - | - |
| `hmeter_value_v2_timestamp` | DateTime | Timestamp of the last reading | Y | - | Y | - | - | - | - | - |
| | | **Channels for the m3 meter (Gas or Water)** | | | | | | | | |
| `meter_device_type` | String | m3 Meter Device Type | - | - | - | - | Y | Y | Y | Y |
| `meter_equipment_identifier` | String | m3 Meter ID | - | - | - | - | Y | Y | Y | Y |
| `m3meter_value` | Number | m3 Delivery past period | - | - | - | - | Y | Y | Y | Y |
| `meter_valve_switch_position` | Number | m3 Meter Valve position | - | - | - | - | Y | Y | Y | - |
| | | **Channels for the water meter** | | | | | | | | |
| `meter_device_type` | String | Water Meter Device Type | - | - | - | Y | - | - | - | - |
| `meter_equipment_identifier` | String | Water Meter ID | Y | - | - | Y | - | - | - | - |
| `wmeter_equipment_identifier_v2_2` | String | Water Meter ID | - | - | Y | - | - | - | - | - |
| `wmeter_value_v2` | Number | Water Delivery past period | Y | - | Y | - | - | - | - | - |
| `wmeter_value_v2_timestamp` | DateTime | Timestamp of the last reading | Y | - | Y | - | - | - | - | - |
| `wmeter_value_v3` | Number | Water Delivery past period | - | - | - | Y | - | - | - | - |
| `meter_valve_switch_position` | Number | Water Meter Valve position | - | - | - | Y | - | - | - | - |
*note 2*. The power failure log has a dynamic number of entries starting at `0`.
So `emeter_power_failure_log_timestamp0`, `emeter_power_failure_log_duration0` refers to the first entry,
`emeter_power_failure_log_timestamp1`, `emeter_power_failure_log_duration1` refers to the second entry, etc.
Channel identifier: `dsmr:<ThingTypeID>:<bridge id>:<id>:<channel type id>`
- ThingTypeID. See table with supported meters
- BridgeID. The configured id for the bridge
- id. The configured id for the ThingType you want to address
- channel type id. The channel type id
The following configuration must to be added to a item configuration file. E.g. `things/dsmr.items`
```
ItemType <name> "<description>" (<Group>) {channel="<Channel identifier>"}
```
**Examples**
```
Number MeterDeliveryTariff0 "Total electricity delivered to the resident during low tariff period [%.3f kWh]" {channel="dsmr:electricity_v5_0:mysmartmeter:electricityV5:emeter_delivery_tariff1}
```
## Full configuration example
`things/dsmr.things`
```
Bridge dsmr:dsmrBridge:mysmartmeter [serialPort="/dev/ttyUSB0"] {
Things:
device_v5 dsmrV5Device [channel=-1]
electricity_v5_0 electricityV5 [channel=0]
}
```
`things/dsmr.items`
```
String P1Version "P1 Version output" {channel="dsmr:device_v5:mysmartmeter:dsmrV5Device:p1_version_output"}
Number MeterDeliveryTariff0 "Total electricity delivered to the resident during low tariff period [%.3f kWh]" {channel="dsmr:device_v5:mysmartmeter:electricityV5:emeter_delivery_tariff1}
Number MeterDeliveryTariff1 "Total electricity delivered to the resident during high tariff period [%.3f kWh]" {channel="dsmr:device_v5:mysmartmeter:electricityV5:emeter_delivery_tariff2}
```
## Determine M-Bus channel
By manually trigger the discovery process, e.g. via PaperUI, you can use the logging to find out a M-Bus channel. Look for the following logfile line:
`<Timestamp> [INFO ] [<class>] - New compatible meter: [Meter type: M3_V5_0, channel: 1, Meter type: ELECTRICITY_V5, channel: 0]`
Here you find the ThingTypeID (it is stated only in capitals) and the M-Bus channel. The above example would lead to the following Thing definition
```
Bridge definition {
Things:
m3_v5_0 mygasmeter [channel=1]
electricity_v5 [channel=0]
}
```

21
_addons_bindings/epsonprojector1/readme.md
View File

@ -35,6 +35,27 @@ hometheater.serialPort=/dev/tty.usbserial
office.serialPort=/dev/ttyS0
```
### Using tcp instead of serialPort
Alternatively you can connect to your projector via tcp/telnet if you are using some kind of serial2IP converter.
Like: https://community.openhab.org/t/benq-beamer-binding-rs232-over-wifi-ir-receiver/26138/4
In that case the configuration looks like this:
| Property | Default | Required | Description |
|----------|---------|:--------:|-------------|
| `<device-id>`.host | | Yes | IP address of your converter |
| `<device-id>`.port | | Yes | Port the device is listening on. e.g. `23` |
Examples:
```
hometheater.host=192.168.1.234
hometheater.port=23
```
If you are switching from serial to TCP you might need to delete the cache (`/var/lib/openhab2/config/org/openhab/epsonprojector.config`).
## Item Configuration
The syntax is:

2
_addons_bindings/homematic/readme.md
View File

@ -16,7 +16,7 @@ install: auto
# Homematic Binding
This is the binding for the [eQ-3 Homematic Solution](http://www.eq-3.de/).
This binding allows you to integrate, view, control and configure all Homematic devices in Eclipse Smarthome.
This binding allows you to integrate, view, control and configure all Homematic devices in Eclipse SmartHome.
## Supported Bridges

46
_addons_bindings/jeelink/readme.md
View File

@ -103,31 +103,31 @@ The available init commands depend on the sketch that is running on the USB stic
#### LaCrosse temperature sensors
| Channel Type ID | Item Type | Description |
|-----------------|-----------|---------------------------------------------------|
| temperature | Number | Temperature reading |
| humidity | Number | Humidity reading |
| batteryNew | Contact | Whether the battery is new (CLOSED) or not (OPEN) |
| batteryLow | Contact | Whether the battery is low (CLOSED) or not (OPEN) |
| Channel Type ID | Item Type | Description |
|-----------------|-----------------------|---------------------------------------------------|
| temperature | Number:Temperature | Temperature reading |
| humidity | Number:Dimensionless | Humidity reading |
| batteryNew | Contact | Whether the battery is new (CLOSED) or not (OPEN) |
| batteryLow | Contact | Whether the battery is low (CLOSED) or not (OPEN) |
#### EC3000 power monitors
| Channel Type ID | Item Type | Description |
|------------------|-----------|----------------------------------------------------|
| currentWatt | Number | Instantaneous power in Watt |
| maxWatt | Number | Maximum load power in Watt |
| consumptionTotal | Number | Total energy consumption |
| applianceTime | Number | Total electrical appliance operating time in hours |
| sensorTime | Number | Total turn on time of power monitor in hours |
| resets | Number | Number of resets |
| Channel Type ID | Item Type | Description |
|------------------|---------------|-------------------------------------------|
| currentPower | Number:Power | Current power draw |
| maxPower | Number:Power | Maximum power draw |
| consumptionTotal | Number:Energy | Total energy consumption |
| applianceTime | Number:Time | Total electrical appliance operating time |
| sensorTime | Number:Time | Total turn on time of power monitor |
| resets | Number | Number of resets |
#### PCA301 power monitoring wireless sockets
| Channel Type ID | Item Type | Description |
|-------------------------|--------------|------------------------------------------------------|
| switchingState | Switch | Whether the sockets are currently switched on or off |
| currentWatt | Number | Instantaneous power in Watt |
| consumptionTotal | Number | Total energy consumption |
| Channel Type ID | Item Type | Description |
|-------------------------|---------------|------------------------------------------------------|
| switchingState | Switch | Whether the sockets are currently switched on or off |
| currentPower | Number:Power | Current power draw |
| consumptionTotal | Number:Energy | Total energy consumption |
## Commands
@ -165,8 +165,8 @@ Thing jeelink:lacrosse:sensor2 "Jeelink lacrosse 2" (jeelink:jeelinkUsb:lacrosse
A typical item configuration for a LaCrosse temperature sensor looks like this:
```
Number Humidty_LR "Living Room" <humidity> {channel="jeelink:lacrosse:42:humidity"}
Number Temperature_LR "Living Room" <temperature> {channel="jeelink:lacrosse:42:temperature"}
Number:Dimensionless Humidty_LR "Living Room [%.1f %unit%]" <humidity> {channel="jeelink:lacrosse:42:humidity"}
Number:Temperature Temperature_LR "Living Room [%.1f %unit%]" <temperature> {channel="jeelink:lacrosse:42:temperature"}
Contact Battery_Low_LR "Battery Low Living Room" {channel="jeelink:lacrosse:42:batteryLow"}
Contact Battery_New_LR "Battery New Living Room" {channel="jeelink:lacrosse:42:batteryLow"}
```
@ -175,6 +175,6 @@ A typical item configuration for a PCA301 power monitoring wireless sockets look
```
Switch SocketSwitch {channel="jeelink:pca301:1-160-236:switchingState"}
Number SocketWattage {channel="jeelink:pca301:1-160-236:currentWatt"}
Number SocketConsumption {channel="jeelink:pca301:1-160-236:consumptionTotal"}
Number:Power SocketWattage {channel="jeelink:pca301:1-160-236:currentPower"}
Number:Energy SocketConsumption {channel="jeelink:pca301:1-160-236:consumptionTotal"}
```

2
_addons_bindings/knx/readme.md
View File

@ -184,7 +184,7 @@ In contrast to the standard channels above, the control channel types are used f
#### Group Address Notation
```
<config>="[<][<dpt>:]<mainGA>[[+[<]<listeningGA>]+[<]<listeningGA>..]]"
<config>="[<dpt>:][<]<mainGA>[[+[<]<listeningGA>]+[<]<listeningGA>..]]"
```
where parts in brackets `[]` denote optional information.

70
_addons_bindings/leapmotion/readme.md Normal file
View File

@ -0,0 +1,70 @@
---
id: leapmotion
label: Leap Motion
title: Leap Motion - Bindings
type: binding
description: "The [Leap Motion](https://www.leapmotion.com/) controller is a gesture sensoring device that uses stereoscopic cameras and is connected through USB."
since: 2x
install: auto
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Leap Motion Binding
The [Leap Motion](https://www.leapmotion.com/) controller is a gesture sensoring device that uses stereoscopic cameras and is connected through USB.
As all processing is done in software, it requires quite some powerful computer, such that it unfortunately does not work on single-board computers such as the Raspberry Pi.
In fact, the binding is currently only working on MacOS computers with Intel x86 processors.
## Supported Things
There is a single thing of type `controller` defined and only one can be connected to the computer at a time.
## Discovery
The controller is automatically discovered if plugged into a USB port.
## Thing Configuration
The controller does not have any kind of configuration parameters.
## Channels
The controller has a single trigger channel `gesture`.
It generates the following events with a frequency of at most 200ms:
| Event | Description |
|---------------|----------------------------------------------------------------------------|
| nohand | No hand can be seen |
| tap | A tap with a single finger |
| clockwise | Rotating a finger clockwise |
| anticlockwise | Rotating a finger anticlockwise |
| fingersX_YYY | Hand showing X fingers in a height of YYY mm (where YYY can be 1-3 digits) |
## Profiles
This binding specifies 3 profiles for the `gesture` channel to make it easy to link to existing items:
| Profile | Description |
|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| leapmotion:switch | Simulates a toggle switch using the "tap" gesture |
| leapmotion:dimmer | Sends percentage values and supports two modes (configuration parameter `mode=fingers|height`): - fingers: 20% for every shown finger, i.e. 0=0%, 1=20%, 2=40%, 3=60%, 4=80%, 5=100% - height: If hand shows all 5 fingers, its height above the controller determines the value. Higher is brighter. |
| leapmotion:color | Controls a color item by - using taps for switching on and off - height of hand (with 5 fingers shown) to dim - rotating a finger to loop through the colors |
## Full Example
demo.things:
```
Thing leapmotion:controller:1 MyLeapMotion
```
demo.items:
```
Switch DemoSwitch "Switch" { channel="leapmotion:controller:1:gesture" }
Color RGBLight "RGB Light" { channel="leapmotion:controller:1:gesture" }
Dimmer DimmedLight "Dimmer [%d %%]" { channel="leapmotion:controller:1:gesture"[profile="leapmotion:dimmer", mode="fingers"] }
```

49
_addons_bindings/max/readme.md
View File

@ -64,17 +64,17 @@ These properties can be found in the `Device Settings` section of parameters.
Depending on the thing it supports different Channels
| Channel Type ID | Item Type | Description | Available on thing |
|-----------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|
| mode | String | This channel indicates the mode of a thermostat (AUTOMATIC/MANUAL/BOOST/VACATION). | thermostat, thermostatplus, wallthermostat |
| battery_low | Switch | This channel indicates if the device battery is low (ON/OFF). | thermostat, thermostatplus, wallthermostat, ecoswitch, shuttercontact |
| set_temp | Number | This channel indicates the sets temperature (in °C) of a thermostat. | thermostat, thermostatplus, wallthermostat |
| actual_temp | Number | This channel indicates the measured temperature (in °C) of a thermostat (see below for more details). | thermostat, thermostatplus, wallthermostat |
| valve | Number | This channel indicates the valve opening in %. Note this is an advanced setting, normally not visible. | thermostat, thermostatplus, wallthermostat |
| locked | Contact | This channel indicates if the thermostat is locked for adjustments (OPEN/CLOSED). Note this is an advanced setting, normally not visible. | thermostat, thermostatplus, wallthermostat |
| contact_state | Contact | This channel indicates the contact state for a shutterswitch (OPEN/CLOSED). | shuttercontact |
| free_mem | Number | This channel indicates the free available memory on the cube to hold send commands. Note this is an advanced setting, normally not visible. | bridge |
| duty_cycle | Number | This channel indicates the duty cycle (due to regulatory compliance reasons the cube is allowed only to send for a limited time. Duty cycle indicates how much of the available time is consumed) Note this is an advanced setting, normally not visible. | bridge |
| Channel Type ID | Item Type | Description | Available on thing |
|-----------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|
| mode | String | This channel indicates the mode of a thermostat (AUTOMATIC/MANUAL/BOOST/VACATION). | thermostat, thermostatplus, wallthermostat |
| battery_low | Switch | This channel indicates if the device battery is low (ON/OFF). | thermostat, thermostatplus, wallthermostat, ecoswitch, shuttercontact |
| set_temp | Number:Temperature | This channel indicates the sets temperature of a thermostat. | thermostat, thermostatplus, wallthermostat |
| actual_temp | Number:Temperature | This channel indicates the measured temperature of a thermostat (see below for more details). | thermostat, thermostatplus, wallthermostat |
| valve | Number | This channel indicates the valve opening in %. Note this is an advanced setting, normally not visible. | thermostat, thermostatplus, wallthermostat |
| locked | Contact | This channel indicates if the thermostat is locked for adjustments (OPEN/CLOSED). Note this is an advanced setting, normally not visible. | thermostat, thermostatplus, wallthermostat |
| contact_state | Contact | This channel indicates the contact state for a shutterswitch (OPEN/CLOSED). | shuttercontact |
| free_mem | Number | This channel indicates the free available memory on the cube to hold send commands. Note this is an advanced setting, normally not visible. | bridge |
| duty_cycle | Number | This channel indicates the duty cycle (due to regulatory compliance reasons the cube is allowed only to send for a limited time. Duty cycle indicates how much of the available time is consumed) Note this is an advanced setting, normally not visible. | bridge |
## Full Example
@ -84,7 +84,7 @@ Only in exceptional cases you would need to define the thermostats etc.
max.things:
```
```java
Bridge max:bridge:KEQ0565026 [ ipAddress="192.168.3.9", serialNumber="KEQ0565026" ] {
Thing thermostat KEQ0565123 [ serialNumber="KEQ0565123", refreshActualRate=60 ]
Thing shuttercontact NEQ1150510 [ serialNumber="NEQ1150510" ]
@ -93,28 +93,27 @@ Bridge max:bridge:KEQ0565026 [ ipAddress="192.168.3.9", serialNumber="KEQ0565026
max.items:
```
```java
Group gMAX "MAX Heating" <temperature> [ "home-group" ]
Switch maxBattery "Battery Low" (gMAX) {channel="max:thermostat:KEQ0565026:KEQ0648949:battery_low"}
String maxMode "Thermostat Mode Setting" (gMAX) {channel="max:thermostat:KEQ0565026:KEQ0648949:mode"}
Number maxActual "Actual measured room temperature [%.1f °C]" (gMAX) {channel="max:thermostat:KEQ0565026:KEQ0648949:actual_temp"}
Number maxSetTemp "Thermostat temperature setpoint [%.1f °C]" (gMAX) {channel="max:thermostat:KEQ0565026:KEQ0648949:set_temp"}
String maxMode "Thermostat Mode Setting" (gMAX) {channel="max:thermostat:KEQ0565026:KEQ0648949:mode"}
Number:Temperature maxActual "Actual measured room temperature [%.1f %unit%]" (gMAX) {channel="max:thermostat:KEQ0565026:KEQ0648949:actual_temp"}
Number:Temperature maxSetTemp "Thermostat temperature setpoint [%.1f %unit%]" (gMAX) {channel="max:thermostat:KEQ0565026:KEQ0648949:set_temp"}
Contact maxShuttercontactState "Contact State" (gMAX) {channel="max:shuttercontact:KEQ0565026:NEQ1150510:contact_state"}
Switch maxShuttercontactBattery "Contact Battery Low" <battery> (gMAX) {channel="max:shuttercontact:KEQ0565026:NEQ1150510:battery_low"}
```
demo.sitemap:
```
sitemap demo label="Main Menu"
{
Frame label="MAX Heating System" {
Switch item=maxMode icon="climate" mappings=[AUTOMATIC=AUTOMATIC, MANUAL=MANUAL, BOOST=BOOST]
Setpoint item=maxSetTemp minValue=4.5 maxValue=32 step=0.5 icon="temperature"
Text item=maxActual icon="temperature"
Switch item=maxBattery
}
```perl
sitemap demo label="Main Menu" {
Frame label="MAX Heating System" {
Switch item=maxMode icon="climate" mappings=[AUTOMATIC=AUTOMATIC, MANUAL=MANUAL, BOOST=BOOST]
Setpoint item=maxSetTemp minValue=4.5 maxValue=32 step=0.5 icon="temperature"
Text item=maxActual icon="temperature"
Switch item=maxBattery
}
}
```

191
_addons_bindings/onewire/readme.md Normal file
View File

@ -0,0 +1,191 @@
---
id: onewire
label: OneWire
title: OneWire - Bindings
type: binding
description: "The OneWire binding integrates OneWire (also spelled 1-Wire) devices."
since: 2x
install: auto
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# OneWire Binding
The OneWire binding integrates OneWire (also spelled 1-Wire) devices.
OneWire is a serial bus developed by Dallas Semiconductor.
It provides cheap sensors for temperature, humidity, digital I/O and more.
## Supported Things
### Bridges
Currently only one bridge is supported.
The OneWire File System (OWFS, http://owfs.org) provides an abstraction layer between the OneWire bus and this binding.
The `owserver` is the bridge that connects to an existing OWFS installation.
### Things
There are three types of things: the generic ones (`digitalio`, `digitalio2`, `digitalio8`, `ibutton`, `temperature`), multisensors built around the DS2438 chip (`ms-th`, `ms-tv`) and more advanced sensors from Elaborated Networks (www.wiregate.de) (`ams`, `bms`).
## Discovery
Discovery is supported for things. You have to add the bridges manually.
## Thing Configuration
It is strongly recommended to use discovery and Paper UI for thing configuration.
Please note that:
* All things need a bridge.
* The sensor id parameter supports only the dotted format, including the family id (e.g. `28.7AA256050000`).
* Refresh time is the minimum time in seconds between two checks of that thing.
It defaults to 300s for analog channels and 10s for digital channels.
* Some thing channels need additional configuration, please see below in the channels section.
### OWFS Bridge (`owserver`)
There are no configuration options for the owserver besides the network address.
It consists of two parts: `address` and `port`.
The `address` parameter is used to denote the location of the owserver instance.
It supports both, a hostname or an IP address.
The `port` parameter is used to adjust non-standard OWFS installations.
It defaults to `4304`, which is the default of each OWFS installation.
### Digital I/O (`digitalio`, `digitalio2`, `digitalio8`)
The digital I/O things support the DS2405, DS2406, DS2408 and DS2413 chips.
Depending on the chip, one (DS2405), two (DS2406/DS2413) or eight (DS2408) `digitalX` channels are supported.
It has two parameters: sensor id `id` and refresh time `refresh`.
### iButton (`ibutton`)
The iButton thing supports only the DS2401 chips.
It is used for presence detection and therefore only supports the `present` channel.
It's value is `ON` if the device is detected on the bus and `OFF` otherwise.
It has two parameters: sensor id `id` and refresh time `refresh`.
### Multisensor with Humidity (`ms-th`)
The multisensor with humidity is build around the DS2438 chipset.
It provides a `temperature`, a `humidity` and a `supplyvoltage` channel.
The voltage input of the DS2438 is connected to a humidity sensor, several common types are supported (see below).
It has two parameters: sensor id `id` and refresh time `refresh`.
### Multisensor with Voltage (`ms-tv`)
The multisensor with voltage is build around the DS2438 chipset.
It provides a `temperature`, a `voltage` and a `supplyvoltage` channel.
It has two parameters: sensor id `id` and refresh time `refresh`.
### Temperature sensor (`temperature`)
The temperature thing supports DS18S20 and DS18B20 sensors.
It provides only the `temperature` channel.
It has two parameters: sensor id `id` and refresh time `refresh`.
### Elaborated Networks Multisensors (`ams`, `bms`)
These things are complex devices from Elaborated networks.
They consist of a DS2438 and a DS18B20 with additional circuitry on one PCB.
The AMS additionally has a second DS242438 and a DS2413 for digital I/O on-board.
Analog light sensors can optionally be attached to both sensors.
These sensors provide `temperature`, `humidity` and `supplyvoltage` channels.
If the light sensor is attached and configured, a `light` channel is provided, otherwise a `current` channel.
The AMS has an additional `voltage`and two `digitalX` channels.
It has two (`bms`) or four (`ams`) sensor ids (`id0` to `id3`).
The first id is always the main DS2438, the second id the DS18B20 temperature sensor.
In the case of the AMS, the third sensor id has to be the second DS2438 and the fourth the DS2413.
Additionally the refresh time `refresh` can be configured.
The AMS supports a `digitalrefresh` parameter for the refresh time of the digital channels.
Since both multisensors have two temperature sensors on-board, the `temperaturesensor` parameter allows to select `DS18B20` or `DS2438` to be used for temperature measurement.
This parameter has a default of `DS18B20` as this is considered more accurate.
The last parameter is the `lightsensor` option to configure if an ambient light sensor is attached.
It defaults to `false`.
In that mode, a `current` channel is provided.
If set to `true`, a `light` channel is added to the thing.
The correct formula for the ambient light is automatically determined from the sensor version.
## Channels
| Type-ID | Thing | Item | readonly | Description |
|-----------------|-----------------------------|----------------------|----------------------------------------------------|
| current | multisensors | Number | yes | current (if light option not installed) |
| digital | digitalX, AMS | Switch | no | digital, can be configured as input or output |
| humidity | multisensors (except ms-tv) | Number | yes | relative humidity |
| light | ams, bms | Number | yes | lightness (if installed) |
| present | all | Switch | yes | sensor found on bus |
| supplyvoltage | multisensors | Number | yes | sensor supplyvoltage |
| temperature | not digitalX, ibutton | Number | yes | environmental temperature |
| voltage | ms-tv, ams | Number | yes | voltage input |
### Digital I/O (`digitalX`)
The `digitalX` channels each have two parameters: `mode` and `logic`.
The `mode` parameter is used to configure this channels as `input` or `output`.
The `logic` parameter can be used to invert the channel.
In `normal` mode the channel is considered `ON` for logic high, and `OFF` for logic low.
In `inverted` mode `ON` is logic low and `OFF` is logic high.
### Humidity (`humidity`)
Depending on the sensor, the `humidity` channel may have the `humiditytype` parameter.
This is only needed for the `ms-th` sensors.
`ams` and `bms` sensors select the correct sensor type automatically.
Possible options are `/humidity` for HIH-3610 sensors, `/HIH4000/humidity` for HIH-4000 sensors, `/HTM1735/humidity` for HTM-1735 sensors and `/DATANAB/humidity` for sensors from Datanab.
### Temperature (`temperature`)
The `temperature` channel has one parameter: `resolution`.
OneWire temperature sensors are capable of different resolutions: `9`, `10`, `11` and `12` bits.
This corresponds to 0.5 °C, 0.25 °C, 0.125 °C, 0.0625 °C respectively.
The conversion time is inverse to that and ranges from 95 ms to 750 ms.
For best performance it is recommended to set the resolution only as high as needed.
## Full Example
This is the configuration for a OneWire network consisting of an owserver and a temperature sensor.
### demo.things:
```
Bridge onewire:owserver:mybridge [ network-address="192.168.0.51" ] {
temperature mysensor [id="28.505AF0020000" ]
}
```
### demo.items:
```
Number:Temperature MySensor "MySensor [%.1f %unit%]" { channel="onewire:mybridge:mysensor:temperature" }
```
### demo.sitemap:
```
sitemap demo label="Main Menu"
{
Frame {
Text item=MySensor
}
}
```

7
_addons_bindings/serial1/readme.md
View File

@ -3,7 +3,7 @@ id: serial
label: Serial
title: Serial - Bindings
type: binding
description: "The Serial binding allows openHAB to communicate in ASCII over serial ports attached to the openHAB server."
description: "The Serial binding allows openHAB to communicate over serial ports attached to the openHAB server."
source: https://github.com/openhab/openhab1-addons/blob/master/bundles/binding/org.openhab.binding.serial/README.md
since: 1x
install: auto
@ -15,7 +15,7 @@ install: auto
# Serial Binding
The Serial binding allows openHAB to communicate in ASCII over serial ports attached to the openHAB server.
The Serial binding allows openHAB to communicate over serial ports attached to the openHAB server.
| Item Type | Function |
|-----------|----------|
@ -79,9 +79,10 @@ where:
* `<port>` is the identification of the serial port on the host system, e.g. `COM1` on Windows, `/dev/ttyS0` on Linux or `/dev/tty.PL2303-0000103D` on Mac. The same `<port>` can be bound to multiple items.
* `<baudrate>` is the baud rate of the port. If no baud rate is specified, the binding defaults to 9600 baud.
* `REGEX(<regular expression>)` allows parsing for special strings or numbers in the serial stream. A capture group (e.g. REGEX(Position:([0-9.]*)) can be used to capture "12" in `Position:12` or substitution (e.g. REGEX(s/Position:100/ON/) or REGEX(s/Position:100/ON/g)) to replace (FIRST or ALL) "Position:100" strings in response with "ON". This is based on the [RegEx Service](https://github.com/openhab/openhab1-addons/wiki/Transformations#regex-transformation-service) and [ESH RegExTransformationService](https://github.com/eclipse/smarthome/tree/master/extensions/transform/org.eclipse.smarthome.transform.regex). This is optional.
* `BASE64` enables the Base64 mode. With this mode all data received on the serial port is saved in Base64 format. All data that is sent to the serial port also has to be Base64 encoded. (This was implemented because some serial devices are using bytes that are not supported by the REST interface).
* `BASE64()` enables the Base64 mode. With this mode all data received on the serial port is saved in Base64 format. All data that is sent to the serial port also has to be Base64 encoded. (This was implemented because some serial devices are using bytes that are not supported by the REST interface).
* `ON(<On string>),OFF(<Off string>)` used in conjunction with a Switch, this mapping will send specific commands to serial port and also match a serial command to specific ON/OFF state. This makes it unnecessary to use a rule to send a command to serial.
* `UP(<Up string>),DOWN(<Down string>),STOP(<Stop string>)` used in conjunction with a Rollershutter, this mapping will send specific commands to serial port. Use REGEX to parse Rollershutter postion (0-100%) coming as feedback over serial link.
* `CHARSET(<charset>)` set's the charset to be used for converting to a String and back to bytes when writing. (e.g. UTF-8, ISO-8859-1, etc.)
Base64 can be decoded in the rules by importing `javax.xml.bind.DatatypeConverter` and then decoding the value like this:

57
_addons_bindings/weatherunderground/readme.md
View File

@ -31,7 +31,7 @@ To use this binding, you first need to [register and get your API key](https://w
## Supported Things
There is exactly two supported things type. The first one is the weather thing, which represents the weather information for an observation location. It has the id `weather`. The second one is the bridge thing, which allows one to add an API key only one time which all sub-sequents weather things will use. It has the id `bridge
There are exactly two supported thing types. The first one is the bridge thing, which represents the connection to the Weather Underground service through the API key. It has the id `bridge`. The second one is the weather thing, which represents the weather information for an observed location. It has the id `weather`. Each `weather` thing uses a `bridge` thing ; it cannot be set online if no `bridge` thing is defined.
## Discovery
@ -39,7 +39,7 @@ If a system location is set, "Local Weather" will be automatically discovered fo
If the system location is changed, the background discovery updates the configuration of "Local Weather" automatically.
After adding this discovered thing, you will have to set the correct API key.
If a bridge is correctly configured, the discovered thing will automatically go online.
## Binding Configuration
@ -47,6 +47,12 @@ The binding has no configuration options, all configuration is done at Thing and
## Thing Configuration
The bridge only has one configuration parameter:
| Parameter | Description |
|-----------|------------------------------------------------------------------------- |
| apikey | API key to access the Weather Underground service. Mandatory. |
The thing has a few configuration parameters:
| Parameter | Description |
@ -121,54 +127,11 @@ The weather information that is retrieved is available as these channels:
demo.things:
```
Thing weatherunderground:weather:CDG "Météo Paris CDG" [ apikey="XXXXXXXXXXXX", location="CDG", language="FR", refresh=15 ] {
Channels:
Type temperature : current#temperature
Type windSpeed : current#windSpeed
Type windGust : current#windGust
Type pressure : current#pressure
Type dewPoint : current#dewPoint
Type heatIndex : current#heatIndex
Type windChill : current#windChill
Type feelingTemperature : current#feelingTemperature
Type visibility : current#visibility
Type rainDay : current#precipitationDay
Type rainHour : current#precipitationHour
Type minTemperature : forecastToday#minTemperature
Type maxTemperature : forecastToday#maxTemperature
Type rainDay : forecastToday#precipitationDay
Type snow : forecastToday#snow
Type maxWindSpeed : forecastToday#maxWindSpeed
Type averageWindSpeed : forecastToday#averageWindSpeed
}
```
Using the bridge (demo.items remains identical):
```
Bridge weatherunderground:bridge:myAPI "myAPI" [ apikey="XXXXXXXXXXXX" ] {
Thing weatherunderground:weather:paris "Météo Paris" [ location="France/Paris", language="FR", refresh=15 ] {
Channels:
Type temperature : current#temperature
Type windSpeed : current#windSpeed
Type windGust : current#windGust
Type pressure : current#pressure
Type dewPoint : current#dewPoint
Type heatIndex : current#heatIndex
Type windChill : current#windChill
Type feelingTemperature : current#feelingTemperature
Type visibility : current#visibility
Type rainDay : current#precipitationDay
Type rainHour : current#precipitationHour
Type minTemperature : forecastToday#minTemperature
Type maxTemperature : forecastToday#maxTemperature
Type rainDay : forecastToday#precipitationDay
Type snow : forecastToday#snow
Type maxWindSpeed : forecastToday#maxWindSpeed
Type averageWindSpeed : forecastToday#averageWindSpeed
}
Thing weatherunderground:weather:paris "Météo Paris" [ location="France/Paris", language="FR", refresh=15 ]
}
``
```
demo.items:

1
_addons_bindings/zigbee/readme.md
View File

@ -138,6 +138,7 @@ The following channels are supported -:
| ias_motionintrusion | ```IAS_ZONE``` (0x0500) | Switch | |
| ias_motionpresence | ```IAS_ZONE``` (0x0500) | Switch | |
| ias_standard_system | ```IAS_ZONE``` (0x0500) | Switch | |
| ias_water | ```IAS_ZONE``` (0x0500) | Switch | |
| measurement_illuminance | ```ILLUMINANCE_MEASUREMENT``` (0x0400) | Number | |
| measurement_pressure | ```PRESSURE_MEASUREMENT``` (0x0403) | Number | |
| measurement_relativehumidity | ```RELATIVE_HUMIDITY_MEASUREMENT``` (0x0405) | Number | |

4
_addons_voices/googletts/readme.md
View File

@ -54,7 +54,7 @@ Before you can integrate this service with your Google Cloud Text-to-Speech, you
## Service Configuration
Using your favourite configuration UI (e.g. PaperUI) edit **services/voice/Google Cloud TTS Service** settings and set
Using your favourite configuration UI (e.g. PaperUI) edit **Services/Voice/Google Cloud Text-to-Speech** settings and set
* **Service Account Key** - Copy-paste the content of the downloaded key file.
* **Pitch** - The pitch of selected voice, up to 20 semitones
@ -67,5 +67,5 @@ Using your favourite configuration UI
* Edit **System** settings
* Edit **Voice** settings
* Set **Google Cloud TTS Service** as **Default Text-to-Speech**
* Set **Google Cloud** as **Default Text-to-Speech**
* Choose default voice for the setup.