Skip to content

Commit

Permalink
[Binding addons starting with "C"] Correct linter errors only (openha…
Browse files Browse the repository at this point in the history 
…b#2951)

Signed-off-by: Brad Gilmer <[email protected]>
  • Loading branch information
@bgilmer77 @martinvw
bgilmer77 authored and martinvw committed Dec 14, 2017
1 parent cb82a23 commit f0f16fc
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 42 deletions.
25 changes: 13 additions & 12 deletions addons/binding/org.openhab.binding.chromecast/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# Chromecast Binding

The binding integrates Google Chromecast streaming devices.

It not only acts as a typical binding, but also registers each Chromecast device as an audio sink that can be used for playback.

In order play audio streams that are served from the runtime, the binding needs to know the url to access. This can be configured on the binding level:

| Configuration Parameter | Type | Description |
|-------------|--------|-----------------------------|
| callbackUrl | text | optional Callback URL - url to use for playing notification sounds, e.g. http://192.168.0.2:8080 |
In order play audio streams that are served from the runtime, the binding needs to know the url to access.
This can be configured on the binding level:

| Configuration Parameter | Type | Description |
|-------------------------|------|----------------------------------------------------------------------------------------------------|
| callbackUrl | text | optional Callback URL - url to use for playing notification sounds, e.g. <http://192.168.0.2:8080> |

## Supported Things

Expand All @@ -22,15 +21,17 @@ No authentication is required for accessing the devices on the network.

## Thing Configuration

Chromecast devices can also be manually added. The only configuration parameter is the `ipAddress`.
Chromecast devices can also be manually added.
The only configuration parameter is the `ipAddress`.

## Channels

| Channel Type ID | Item Type | Description |
|-------------|--------|-----------------------------|
| control | Player | Player control; currently only supports play/pause and does not correctly update, if the state changes on the device itself |
| volume | Dimmer | Control the volume, this is also updated if the volume is changed by another app |
| playuri | String | Can be used to tell the Chromecast to play media from a given url |
| Channel Type ID | Item Type | Description |
|-----------------|-----------|-----------------------------------------------------------------------------------------------------------------------------|
| control | Player | Player control; currently only supports play/pause and does not correctly update, if the state changes on the device itself |
| volume | Dimmer | Control the volume, this is also updated if the volume is changed by another app |
| playuri | String | Can be used to tell the Chromecast to play media from a given url |


## Full Example

Expand Down
57 changes: 29 additions & 28 deletions addons/binding/org.openhab.binding.cm11a/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,44 +1,45 @@
# Cm11a (X10 controller) Binding

The cm11a is a serial computer interface that allows a computer to control attached X10 modules.
The cm11a is a serial computer interface that allows a computer to control attached X10 modules.

## Hardware - cm11a

The cm11a is an older device that communicates over a serial interface.
The cm11a is an older device that communicates over a serial interface.
Most people connect it to a computer using a serial to USB adapter.
This binding has been tested with serial port and a serial to USB adapter.

X10 (and thus the cm11a) supports two types of modules.
The Switch (also called Appliance) module supports being turned on and off. The Lamp module supports on, off, dim and bright.
X10 (and thus the cm11a) supports two types of modules.
The Switch (also called Appliance) module supports being turned on and off.
The Lamp module supports on, off, dim and bright.

In addition to controlling X10 modules the cm11a listens on the powerline and reports to the computer changes made to X10 modules via other controllers.
In addition to controlling X10 modules the cm11a listens on the powerline and reports to the computer changes made to X10 modules via other controllers.

### Use of serial port

The binding opens the serial port when it starts and keeps it open until the binding is terminated.
The binding opens the serial port when it starts and keeps it open until the binding is terminated.
If the serial port is disconnected a reconnect will be attempted the next time it is needed.
Therefore, other applications should not attempt to use the port when OpneHAB is running.
However, another program could load macros into the cm11a before openHAB starts.
Therefore, other applications should not attempt to use the port when OpneHAB is running.
However, another program could load macros into the cm11a before openHAB starts.

### cm11a macros

The cm11a is also able to store a schedule and control modules based on that schedule.
That functionality in not currently supported by or used by this binding.
This binding doesn't clear macros from the cm11a so other programs could load macros before openHAB is started.
If you want to do scheduling using openHAB you should be sure there are no macros in the cm11a.
The `heyu clear` command can be used for this purpose.
The cm11a is also able to store a schedule and control modules based on that schedule.
That functionality in not currently supported by or used by this binding.
This binding doesn't clear macros from the cm11a so other programs could load macros before openHAB is started.
If you want to do scheduling using openHAB you should be sure there are no macros in the cm11a.
The `heyu clear` command can be used for this purpose.

### X10 powerline monitoring

The cm11a has the ability to capture x10 messages on the powerline.
This binding captures those messages, decodes them and updates the item state.
The cm11a has the ability to capture x10 messages on the powerline.
This binding captures those messages, decodes them and updates the item state.

## Supported things

The binding currently supports the following thing types:

* switch - which supports on and off states
* dimmer - which can be dimmed in addition to turned on or off
* switch - which supports on and off states
* dimmer - which can be dimmed in addition to turned on or off

## Discovery

Expand All @@ -58,12 +59,12 @@ Each attached thing must specify the `houseUnitCode` set in the device (i.e. A1)

## Channels

| Thing | Channel Type ID | Item Type | Description |
| ----- | --------------- | --------- | ----------- |
| switch | switchState | Switch | An On/Off switch |
| dimmer | lightDimmer | Dimmer | A dimmable device |
| Thing | Channel Type ID | Item Type | Description |
|--------|-----------------|-----------|--------------------|
| switch | switchState | Switch | An On/Off switch |
| dimmer | lightDimmer | Dimmer | A dimmable device |

## Full example
**Example**

### Things

Expand All @@ -80,13 +81,13 @@ Each attached thing must specify the `houseUnitCode` set in the device (i.e. A1)

## Known issues

1. When openHAB starts up it doesn't restore the last state of each module.
1. When openHAB starts up it doesn't restore the last state of each module.
And, the cm11a does not provide a discovery service. Therefore it assumes everything off.
2. The dimmer slider can get out of sync with the actual light because of the way X10 works.
On some switches if you turn them on they will go to full bright and some switches will return to the previous dim level.
2. The dimmer slider can get out of sync with the actual light because of the way X10 works.
On some switches if you turn them on they will go to full bright and some switches will return to the previous dim level.

## References

1. [CM11A (X10) Protocol Document](http://wanderingsamurai.net/electronics/cm11a-x10-protocol-document)
2. [Heyu - control software for the cm11a](http://www.heyu.org/)
3. cm11a Controllers are available for purchase from several sites on the internet.
1. [CM11A (X10) Protocol Document](http://wanderingsamurai.net/electronics/cm11a-x10-protocol-document)
2. [Heyu - control software for the cm11a](http://www.heyu.org/)
3. cm11a Controllers are available for purchase from several sites on the internet
4 changes: 2 additions & 2 deletions addons/binding/org.openhab.binding.coolmasternet/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ The CoolMasterNet protocol does not support automatic discovery.

## Thing Configuration

* `controller` is a openHAB "bridge", and represents a single CoolMasterNet device. A single controller supports one or more HVAC units.
* `controller` is a openHAB "bridge", and represents a single CoolMasterNet device. A single controller supports one or more HVAC units.

* `hvac` is an HVAC device connected to a controller. Each `hvac` thing is identified by a CoolMasterNet UID (refer to CoolMasterNet controller documentation).
* `hvac` is an HVAC device connected to a controller. Each `hvac` thing is identified by a CoolMasterNet UID (refer to CoolMasterNet controller documentation).

Example demo.things configuration for two HVAC devices connected to a CoolMasterNet device found at IP 192.168.0.100:

Expand Down

0 comments on commit f0f16fc

Please sign in to comment.