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 382)

pull/1131/head
openHAB Build Server 2019-10-28 10:40:39 +00:00
parent ed6e173b9f
commit 819d3878f5
138 changed files with 1129 additions and 878 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
_addons_bindings/airquality/readme.md
View File

@ -3,7 +3,7 @@ id: airquality
label: Air Quality
title: Air Quality - Bindings
type: binding
description: "This binding uses the [AQIcn.org service](http://aqicn.org) for providing air quality information for any location worldwide."
description: "This binding uses the [AQIcn.org service](https://aqicn.org) for providing air quality information for any location worldwide."
since: 2x
logo: images/addons/airquality.png
install: auto
@ -15,13 +15,14 @@ install: auto
# Air Quality Binding
This binding uses the [AQIcn.org service](http://aqicn.org) for providing air quality information for any location worldwide.
This binding uses the [AQIcn.org service](https://aqicn.org) for providing air quality information for any location worldwide.
The World Air Quality Index project is a social enterprise project started in 2007. Its mission is to promote Air Pollution awareness and provide a unified Air Quality information for the whole world.
The World Air Quality Index project is a social enterprise project started in 2007.
Its mission is to promote Air Pollution awareness and provide a unified Air Quality information for the whole world.
The project is proving a transparent Air Quality information for more than 70 countries, covering more than 9000 stations in 600 major cities, via those two websites: [aqicn.org](http://aqicn.org) and [waqi.info](http://waqi.info).
The project is proving a transparent Air Quality information for more than 70 countries, covering more than 9000 stations in 600 major cities, via those two websites: [aqicn.org](https://aqicn.org) and [waqi.info](https://waqi.info).
To use this binding, you first need to [register and get your API token](http://aqicn.org/data-platform/token/).
To use this binding, you first need to [register and get your API token](https://aqicn.org/data-platform/token/).
## Supported Things
@ -32,7 +33,7 @@ Of course, you can add multiple Things, e.g. for measuring AQI for different loc
## Discovery
Local Air Quality can be autodiscovered based on system location.
You'll have complete default configuration with your apiKey.
You will have complete default configuration with your apiKey.
## Binding Configuration

3
_addons_bindings/allplay/readme.md
View File

@ -33,7 +33,8 @@ If there is need for another architecture/platform, please open a [ticket on Git
## Supported Things
All AllPlay compatible speakers are supported by this binding.
This includes for example the [Panasonic ALL series](http://www.panasonic.com/uk/consumer/home-entertainment/wireless-speaker-systems.html). All AllPlay speakers are registered as an audio sink in the framework.
This includes for example the [Panasonic ALL series](http://www.panasonic.com/uk/consumer/home-entertainment/wireless-speaker-systems.html).
All AllPlay speakers are registered as an audio sink in the framework.
## Discovery

4
_addons_bindings/amazondashbutton/readme.md
View File

@ -34,7 +34,7 @@ You might want to keep that in mind during product selection or task assignment.
The Binding uses [Pcap4J](https://www.pcap4j.org/) in order to capture `ARP` and `BOOTP` requests send by the Amazon Dash Button.
Buttons will hence only be usable within the same network as your openHAB instance.
Start with installing libpcap (for Mac/Linux/UNIX) or WinPcap (for Windows) on your computer.
Start with installing libpcap (for Mac/Linux/Unix) or WinPcap (for Windows) on your computer.
They are native libraries that power the core functionalities of Pcap4J.
**Note:**
@ -43,7 +43,7 @@ Instructions for Debian/Ubuntu are given below.
### Installing libpcap on Debian/Ubuntu
Installing [libpcap](http://www.tcpdump.org/) should be as simple as:
Installing [libpcap](https://www.tcpdump.org/) should be as simple as:
```shell
sudo apt-get install libpcap-dev

173
_addons_bindings/amazonechocontrol/readme.md
View File

@ -49,13 +49,13 @@ Some ideas what you can do in your home by using rules and other openHAB control
- The echo starts playing radio at specified time
- Remind you with a voice message, that a window is open for a long time and it is winter
- Start a routine which welcome you, if you come home
- Start a routine which switch a smart home device connected to alexa
- Start a routine which switch a smart home device connected to Alexa
- Start your briefing if you turn on the light first time in the morning
- Have different flash briefing in the morning and evening
- Let alexa say 'welcome' to you if you open the door
- Let Alexa say 'welcome' to you if you open the door
- Implement own handling for voice commands in a rule
- Change the equalizer settings depending on the bluetooth connection
- Turn on a light on your alexa alarm time
- Turn on a light on your Alexa alarm time
## Note
@ -84,15 +84,15 @@ The binding is tested with amazon.de, amazon.fr, amazon.it, amazon.com and amazo
## Discovery
After configuration of the account thing with the login data, the echo devices registered in the amazon account, get discovered.
After configuration of the account thing with the login data, the echo devices registered in the Amazon account, get discovered.
If the device type is not known by the binding, the device will not be discovered.
But you can define any device listed in your alexa app with the best matching existing device (e.g. echo).
You will find the required serial number in settings of the device in the alexa app.
But you can define any device listed in your Alexa app with the best matching existing device (e.g. echo).
You will find the required serial number in settings of the device in the Alexa app.
## Binding Configuration
The binding does not have any configuration.
The configuration of your amazon account must be done in the 'Amazon Account' device.
The configuration of your Amazon account must be done in the 'Amazon Account' device.
## Thing Configuration
@ -104,9 +104,9 @@ All Amazon devices (echo, echospot, echoshow, wha) needs the following configura
| Configuration name | Description |
|--------------------------|----------------------------------------------------|
| serialNumber | Serial number of the amazon echo in the Alexa app |
| serialNumber | Serial number of the Amazon Echo in the Alexa app |
You will find the serial number in the alexa app or on the webpage YOUR_OPENHAB/amazonechocontrol/YOUR_ACCOUNT (e.g. http://openhab:8080/amazonechocontrol/account1).
You will find the serial number in the Alexa app or on the webpage YOUR_OPENHAB/amazonechocontrol/YOUR_ACCOUNT (e.g. http://openhab:8080/amazonechocontrol/account1).
### Flash Briefing Profile
@ -115,28 +115,28 @@ It will be configured at runtime by using the save channel to store the current
## Channels
| Channel Type ID | Item Type | Access Mode | Thing Type | Description
|-----------------------|-------------|-------------|------------|------------------------------------------------------------------------------------------
| player | Player | R/W | echo, echoshow, echospot, wha | Control the music player (Supported commands: PLAY or ON, PAUSE or OFF, NEXT, PREVIOUS, REWIND, FASTFORWARD)
| volume | Dimmer | R/W | echo, echoshow, echospot | Control the volume
| equalizerTreble | Number | R/W | echo, echoshow, echospot | Control the treble (value from -6 to 6)
| equalizerMidrange | Number | R/W | echo, echoshow, echospot | Control the midrange (value from -6 to 6)
| equalizerBass | Number | R/W | echo, echoshow, echospot | Control the bass (value from -6 to 6)
| shuffle | Switch | R/W | echo, echoshow, echospot, wha | Shuffle play if applicable, e.g. playing a playlist
| imageUrl | String | R | echo, echoshow, echospot, wha | Url of the album image or radio station logo
| title | String | R | echo, echoshow, echospot, wha | Title of the current media
| subtitle1 | String | R | echo, echoshow, echospot, wha | Subtitle of the current media
| subtitle2 | String | R | echo, echoshow, echospot, wha | Additional subtitle of the current media
| providerDisplayName | String | R | echo, echoshow, echospot, wha | Name of the music provider
| bluetoothMAC | String | R/W | echo, echoshow, echospot | Bluetooth device MAC. Used to connect to a specific device or disconnect if a empty string was provided
| Channel Type ID | Item Type | Access Mode | Thing Type | Description
|-----------------------|-------------|-------------|-------------------------------|------------------------------------------------------------------------------------------
| player | Player | R/W | echo, echoshow, echospot, wha | Control the music player (Supported commands: PLAY or ON, PAUSE or OFF, NEXT, PREVIOUS, REWIND, FASTFORWARD)
| volume | Dimmer | R/W | echo, echoshow, echospot | Control the volume
| equalizerTreble | Number | R/W | echo, echoshow, echospot | Control the treble (value from -6 to 6)
| equalizerMidrange | Number | R/W | echo, echoshow, echospot | Control the midrange (value from -6 to 6)
| equalizerBass | Number | R/W | echo, echoshow, echospot | Control the bass (value from -6 to 6)
| shuffle | Switch | R/W | echo, echoshow, echospot, wha | Shuffle play if applicable, e.g. playing a playlist
| imageUrl | String | R | echo, echoshow, echospot, wha | Url of the album image or radio station logo
| title | String | R | echo, echoshow, echospot, wha | Title of the current media
| subtitle1 | String | R | echo, echoshow, echospot, wha | Subtitle of the current media
| subtitle2 | String | R | echo, echoshow, echospot, wha | Additional subtitle of the current media
| providerDisplayName | String | R | echo, echoshow, echospot, wha | Name of the music provider
| bluetoothMAC | String | R/W | echo, echoshow, echospot | Bluetooth device MAC. Used to connect to a specific device or disconnect if an empty string was provided
| bluetooth | Switch | R/W | echo, echoshow, echospot | Connect/Disconnect to the last used bluetooth device (works after a bluetooth connection was established after the openHAB start)
| bluetoothDeviceName | String | R | echo, echoshow, echospot | User friendly name of the connected bluetooth device
| radioStationId | String | R/W | echo, echoshow, echospot, wha | Start playing of a TuneIn radio station by specifying it's id or stops playing if a empty string was provided
| radioStationId | String | R/W | echo, echoshow, echospot, wha | Start playing of a TuneIn radio station by specifying its id or stops playing if an empty string was provided
| radio | Switch | R/W | echo, echoshow, echospot, wha | Start playing of the last used TuneIn radio station (works after the radio station started after the openhab start)
| amazonMusicTrackId | String | R/W | echo, echoshow, echospot, wha | Start playing of a Amazon Music track by it's id od stops playing if a empty string was provided
| amazonMusicPlayListId | String | W | echo, echoshow, echospot, wha | Write Only! Start playing of a Amazon Music playlist by specifying it's id od stops playing if a empty string was provided. Selection will only work in PaperUI
| amazonMusicTrackId | String | R/W | echo, echoshow, echospot, wha | Start playing of an Amazon Music track by its id or stops playing if an empty string was provided
| amazonMusicPlayListId | String | W | echo, echoshow, echospot, wha | Write Only! Start playing of an Amazon Music playlist by specifying its id or stops playing if an empty string was provided. Selection will only work in PaperUI
| amazonMusic | Switch | R/W | echo, echoshow, echospot, wha | Start playing of the last used Amazon Music song (works after at least one song was started after the openhab start)
| remind | String | R/W | echo, echoshow, echospot | Write Only! Speak the reminder and sends a notification to the Alexa app (Currently the reminder is played and notified two times, this seems to be a bug in the amazon software)
| remind | String | R/W | echo, echoshow, echospot | Write Only! Speak the reminder and sends a notification to the Alexa app (Currently the reminder is played and notified two times, this seems to be a bug in the Amazon software)
| nextReminder | DateTime | R | echo, echoshow, echospot | Next reminder on the device
| playAlarmSound | String | W | echo, echoshow, echospot | Write Only! Plays ans Alarm sound
| nextAlarm | DateTime | R | echo, echoshow, echospot | Next alarm on the device
@ -144,11 +144,11 @@ It will be configured at runtime by using the save channel to store the current
| nextTimer | DateTime | R | echo, echoshow, echospot | Next timer on the device
| startRoutine | String | W | echo, echoshow, echospot | Write Only! Type in what you normally say to Alexa without the preceding "Alexa,"
| musicProviderId | String | R/W | echo, echoshow, echospot | Current Music provider
| playMusicVoiceCommand | String | W | echo, echoshow, echospot | Write Only! Voice command as text. E.g. 'Yesterday from the Beatles'
| startCommand | String | W | echo, echoshow, echospot | Write Only! Used to start anything. Available options: Weather, Traffic, GoodMorning, SingASong, TellStory, FlashBriefing and FlashBriefing.<FlahshbriefingDeviceID> (Note: The options are case sensitive)
| announcement | String | W | echo, echoshow, echospot | Write Only! Display the announcement message on the display. See in the tutorial section to learn how it’s possible to set the title and turn off the sound.
| textToSpeech | String | W | echo, echoshow, echospot | Write Only! Write some text to this channel and alexa will speak it. It is possible to use plain text or SSML: e.g. `<speak>I want to tell you a secret.<amazon:effect name="whispered">I am not a real human.</amazon:effect></speak>`
| textToSpeechVolume | Dimmer | R/W | echo, echoshow, echospot | Volume of the textToSpeech channel, if 0 the current volume will be used
| playMusicVoiceCommand | String | W | echo, echoshow, echospot | Write Only! Voice command as text. E.g. 'Yesterday from the Beatles'
| startCommand | String | W | echo, echoshow, echospot | Write Only! Used to start anything. Available options: Weather, Traffic, GoodMorning, SingASong, TellStory, FlashBriefing and FlashBriefing.<FlahshbriefingDeviceID> (Note: The options are case sensitive)
| announcement | String | W | echo, echoshow, echospot | Write Only! Display the announcement message on the display. See in the tutorial section to learn how it’s possible to set the title and turn off the sound.
| textToSpeech | String | W | echo, echoshow, echospot | Write Only! Write some text to this channel and Alexa will speak it. It is possible to use plain text or SSML: e.g. `<speak>I want to tell you a secret.<amazon:effect name="whispered">I am not a real human.</amazon:effect></speak>`
| textToSpeechVolume | Dimmer | R/W | echo, echoshow, echospot | Volume of the textToSpeech channel, if 0 the current volume will be used
| lastVoiceCommand | String | R/W | echo, echoshow, echospot | Last voice command spoken to the device. Writing to the channel starts voice output.
| mediaProgress | Dimmer | R/W | echo, echoshow, echospot | Media progress in percent
| mediaProgressTime | Number:Time | R/W | echo, echoshow, echospot | Media play time
@ -156,15 +156,16 @@ It will be configured at runtime by using the save channel to store the current
| notificationVolume | Dimmer | R | echo, echoshow, echospot | Notification volume
| ascendingAlarm | Switch | R/W | echo, echoshow, echospot | Ascending alarm up to the configured volume
| sendMessage | String | W | account | Write Only! Sends a message to the Echo devices.
| save | Switch | W | flashbriefingprofile | Write Only! Stores the current configuration of flash briefings within the thing
| active | Switch | R/W | flashbriefingprofile | Active the profile
| playOnDevice | String | W | flashbriefingprofile | Specify the echo serial number or name to start the flash briefing.
| save | Switch | W | flashbriefingprofile | Write Only! Stores the current configuration of flash briefings within the thing
| active | Switch | R/W | flashbriefingprofile | Active the profile
| playOnDevice | String | W | flashbriefingprofile | Specify the echo serial number or name to start the flash briefing.
## Advanced Feature Technically Experienced Users
The url <YOUR_OPENHAB>/amazonechocontrol/<YOUR_ACCOUNT>/PROXY/<API_URL> provides a proxy server with an authenticated connection to the amazon alexa server. This can be used to call alexa api from rules.
The url <YOUR_OPENHAB>/amazonechocontrol/<YOUR_ACCOUNT>/PROXY/<API_URL> provides a proxy server with an authenticated connection to the Amazon Alexa server.
This can be used to call Alexa API from rules.
E.g. to read out the history call from an installation on openhab:8080 with a account named account1:
E.g. to read out the history call from an installation on openhab:8080 with an account named account1:
http://openhab:8080/amazonechocontrol/account1/PROXY/api/activities?startTime=&size=50&offset=1
@ -196,69 +197,69 @@ Take a look in the channel description above to know, which channels are support
Group Alexa_Living_Room <player>
// Player control
Player Echo_Living_Room_Player "Player" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:player"}
Dimmer Echo_Living_Room_Volume "Volume [%.0f %%]" <soundvolume> (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:volume"}
Number Echo_Living_Room_Treble "Treble" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:equalizerTreble"}
Number Echo_Living_Room_Midrange "Midrange" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:equalizerMidrange"}
Number Echo_Living_Room_Bass "Bass" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:equalizerBass"}
Switch Echo_Living_Room_Shuffle "Shuffle" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:shuffle"}
Player Echo_Living_Room_Player "Player" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:player"}
Dimmer Echo_Living_Room_Volume "Volume [%.0f %%]" <soundvolume> (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:volume"}
Number Echo_Living_Room_Treble "Treble" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:equalizerTreble"}
Number Echo_Living_Room_Midrange "Midrange" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:equalizerMidrange"}
Number Echo_Living_Room_Bass "Bass" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:equalizerBass"}
Switch Echo_Living_Room_Shuffle "Shuffle" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:shuffle"}
// Media channels
Dimmer Echo_Living_Room_MediaProgress "Media progress" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:mediaProgress"}
Number:Time Echo_Living_Room_MediaProgressTime "Media progress time [%d %unit%]" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:mediaProgressTime"}
Number:Time Echo_Living_Room_MediaLength "Media length [%d %unit%]" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:mediaLength"}
Dimmer Echo_Living_Room_MediaProgress "Media progress" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:mediaProgress"}
Number:Time Echo_Living_Room_MediaProgressTime "Media progress time [%d %unit%]" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:mediaProgressTime"}
Number:Time Echo_Living_Room_MediaLength "Media length [%d %unit%]" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:mediaLength"}
// Player Information
String Echo_Living_Room_ImageUrl "Image URL" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:imageUrl"}
String Echo_Living_Room_Title "Title" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:title"}
String Echo_Living_Room_Subtitle1 "Subtitle 1" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:subtitle1"}
String Echo_Living_Room_Subtitle2 "Subtitle 2" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:subtitle2"}
String Echo_Living_Room_ProviderDisplayName "Provider" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:providerDisplayName"}
String Echo_Living_Room_ImageUrl "Image URL" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:imageUrl"}
String Echo_Living_Room_Title "Title" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:title"}
String Echo_Living_Room_Subtitle1 "Subtitle 1" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:subtitle1"}
String Echo_Living_Room_Subtitle2 "Subtitle 2" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:subtitle2"}
String Echo_Living_Room_ProviderDisplayName "Provider" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:providerDisplayName"}
// Music provider and start command
String Echo_Living_Room_MusicProviderId "Music Provider Id" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:musicProviderId"}
String Echo_Living_Room_PlayMusicCommand "Play music voice command (Write Only)" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:playMusicVoiceCommand"}
String Echo_Living_Room_StartCommand "Start Information" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:startCommand"}
String Echo_Living_Room_MusicProviderId "Music Provider Id" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:musicProviderId"}
String Echo_Living_Room_PlayMusicCommand "Play music voice command (Write Only)" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:playMusicVoiceCommand"}
String Echo_Living_Room_StartCommand "Start Information" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:startCommand"}
// TuneIn Radio
String Echo_Living_Room_RadioStationId "TuneIn Radio Station Id" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:radioStationId"}
Switch Echo_Living_Room_Radio "TuneIn Radio" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:radio"}
String Echo_Living_Room_RadioStationId "TuneIn Radio Station Id" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:radioStationId"}
Switch Echo_Living_Room_Radio "TuneIn Radio" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:radio"}
// Amazon Music
String Echo_Living_Room_AmazonMusicTrackId "Amazon Music Track Id" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:amazonMusicTrackId"}
String Echo_Living_Room_AmazonMusicPlayListId "Amazon Music Playlist Id" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:amazonMusicPlayListId"}
Switch Echo_Living_Room_AmazonMusic "Amazon Music" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:amazonMusic"}
String Echo_Living_Room_AmazonMusicTrackId "Amazon Music Track Id" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:amazonMusicTrackId"}
String Echo_Living_Room_AmazonMusicPlayListId "Amazon Music Playlist Id" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:amazonMusicPlayListId"}
Switch Echo_Living_Room_AmazonMusic "Amazon Music" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:amazonMusic"}
// Bluetooth
String Echo_Living_Room_BluetoothMAC "Bluetooth MAC Address" <bluetooth> (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:bluetoothMAC"}
Switch Echo_Living_Room_Bluetooth "Bluetooth" <bluetooth> (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:bluetooth"}
String Echo_Living_Room_BluetoothDeviceName "Bluetooth Device" <bluetooth> (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:bluetoothDeviceName"}
String Echo_Living_Room_BluetoothMAC "Bluetooth MAC Address" <bluetooth> (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:bluetoothMAC"}
Switch Echo_Living_Room_Bluetooth "Bluetooth" <bluetooth> (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:bluetooth"}
String Echo_Living_Room_BluetoothDeviceName "Bluetooth Device" <bluetooth> (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:bluetoothDeviceName"}
// Commands
String Echo_Living_Room_Announcement "Announcement" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:announcement"}
String Echo_Living_Room_TTS "Text to Speech" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:textToSpeech"}
Dimmer Echo_Living_Room_TTS_Volume "Text to Speech Volume" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:textToSpeechVolume"}
String Echo_Living_Room_Remind "Remind" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:remind"}
String Echo_Living_Room_PlayAlarmSound "Play Alarm Sound" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:playAlarmSound"}
String Echo_Living_Room_StartRoutine "Start Routine" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:startRoutine"}
Dimmer Echo_Living_Room_NotificationVolume "Notification volume" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:notificationVolume"}
Switch Echo_Living_Room_AscendingAlarm "Ascending alarm" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:ascendingAlarm"}
String Echo_Living_Room_Announcement "Announcement" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:announcement"}
String Echo_Living_Room_TTS "Text to Speech" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:textToSpeech"}
Dimmer Echo_Living_Room_TTS_Volume "Text to Speech Volume" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:textToSpeechVolume"}
String Echo_Living_Room_Remind "Remind" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:remind"}
String Echo_Living_Room_PlayAlarmSound "Play Alarm Sound" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:playAlarmSound"}
String Echo_Living_Room_StartRoutine "Start Routine" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:startRoutine"}
Dimmer Echo_Living_Room_NotificationVolume "Notification volume" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:notificationVolume"}
Switch Echo_Living_Room_AscendingAlarm "Ascending alarm" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:ascendingAlarm"}
// Feedbacks
String Echo_Living_Room_LastVoiceCommand "Last voice command" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:lastVoiceCommand"}
DateTime Echo_Living_Room_NextReminder "Next reminder" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:nextReminder"}
DateTime Echo_Living_Room_NextAlarm "Next alarm" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:nextAlarm"}
DateTime Echo_Living_Room_NextMusicAlarm "Next music alarm" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:nextMusicAlarm"}
DateTime Echo_Living_Room_NextTimer "Next timer" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:nextTimer"}
String Echo_Living_Room_LastVoiceCommand "Last voice command" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:lastVoiceCommand"}
DateTime Echo_Living_Room_NextReminder "Next reminder" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:nextReminder"}
DateTime Echo_Living_Room_NextAlarm "Next alarm" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:nextAlarm"}
DateTime Echo_Living_Room_NextMusicAlarm "Next music alarm" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:nextMusicAlarm"}
DateTime Echo_Living_Room_NextTimer "Next timer" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:nextTimer"}
// Flashbriefings
Switch FlashBriefing_Technical_Save "Save (Write only)" { channel="amazonechocontrol:flashbriefingprofile:account1:flashbriefing1:save"}
Switch FlashBriefing_Technical_Active "Active" { channel="amazonechocontrol:flashbriefingprofile:account1:flashbriefing1:active"}
Switch FlashBriefing_Technical_Active "Active" { channel="amazonechocontrol:flashbriefingprofile:account1:flashbriefing1:active"}
String FlashBriefing_Technical_Play "Play (Write only)" { channel="amazonechocontrol:flashbriefingprofile:account1:flashbriefing1:playOnDevice"}
Switch FlashBriefing_LifeStyle_Save "Save (Write only)" { channel="amazonechocontrol:flashbriefingprofile:account1:flashbriefing2:save"}
Switch FlashBriefing_LifeStyle_Active "Active" { channel="amazonechocontrol:flashbriefingprofile:account1:flashbriefing2:active"}
Switch FlashBriefing_LifeStyle_Active "Active" { channel="amazonechocontrol:flashbriefingprofile:account1:flashbriefing2:active"}
String FlashBriefing_LifeStyle_Play "Play (Write only)" { channel="amazonechocontrol:flashbriefingprofile:account1:flashbriefing2:playOnDevice"}
```
@ -300,7 +301,7 @@ sitemap amazonechocontrol label="Echo Devices"
Switch item=Echo_Living_Room_AmazonMusic
Text item=Echo_Living_Room_BluetoothMAC
// Change the <YOUR_DEVICE_MAC> Place holder with the MAC address shown, if alexa is connected to the device
// Change the <YOUR_DEVICE_MAC> Place holder with the MAC address shown, if Alexa is connected to the device
Selection item=Echo_Living_Room_BluetoothMAC mappings=[ ''='Disconnected', '<YOUR_DEVICE_MAC>'='Bluetooth Device 1', '<YOUR_DEVICE_MAC>'='Bluetooth Device 2']
// These are only view of the possible options. Enable ShowIDsInGUI in the binding configuration and look in drop-down-box of this channel in the Paper UI Control section
@ -336,7 +337,7 @@ sitemap amazonechocontrol label="Echo Devices"
## Tutorials
### Let alexa speak a text from a rule:
### Let Alexa speak a text from a rule:
1) Create a rule with a trigger of your choice
@ -384,7 +385,7 @@ You can use a json formatted string to control the title and the sound:
The combination of sound=true and speak in SSML syntax is not allowed
Note: If you turn off the sound and alexa is playing music, it will anyway turn down the volume for a moment. This behavior can not be changed.
Note: If you turn off the sound and Alexa is playing music, it will anyway turn down the volume for a moment. This behavior can not be changed.
```php
rule "Say welcome if the door opens"
@ -420,10 +421,10 @@ then
end
```
Note 1: Do not use a to short time for playing the sound, because alexa needs some time to start playing the sound.
It's not recommended to use a time below 10 seconds.
Note 1: Do not use a to short time for playing the sound, because Alexa needs some time to start playing the sound.
It is not recommended to use a time below 10 seconds.
Note 2: The rule have no effect for your default alarm sound used in the alexa app.
Note 2: The rule have no effect for your default alarm sound used in the Alexa app.
### Play a spotify playlist if a switch was changed to on:
@ -441,7 +442,7 @@ then
end
```
Note: It's recommended to test the command send to play music command first with the voice and the real alexa device. E.g. say 'Alexa, Playlist Party'
Note: It is recommended to test the command send to play music command first with the voice and the real Alexa device. E.g. say 'Alexa, Playlist Party'
### Start playing weather/traffic/etc:
@ -474,9 +475,9 @@ end
## Credits
The idea for writing this binding came from this blog: http://blog.loetzimmer.de/2017/10/amazon-alexa-hort-auf-die-shell-echo.html (German).
The idea for writing this binding came from this blog: https://blog.loetzimmer.de/2017/10/amazon-alexa-hort-auf-die-shell-echo.html (German).
Thank you Alex!
The technical information for the web socket connection to get live alexa state updates cames from Ingo. He has done the alexa iobrokern implementation https://github.com/Apollon77
The technical information for the web socket connection to get live Alexa state updates cames from Ingo. He has done the Alexa ioBroker implementation https://github.com/Apollon77
Thank you Ingo!
## Trademark Disclaimer

7
_addons_bindings/ambientweather/readme.md
View File

@ -23,8 +23,9 @@ The binding currently supports weather data from these weather stations
- WS-0900-IP,
- WS-1400-IP / WS-1401-IP,
- WS-2902A, and
- WS-8482.
- WS-2902A,
- WS-8482, and
- WS-0265.
Other stations can be added relatively easily with changes in just several places in the source code.
@ -90,6 +91,8 @@ The following channels are supported by the binding. Note that specific weather
| indoorSensor | batteryIndicator | String | Battery indicator |
| | | | |
| remoteSensor\<1-10\> | temperature | Number:Temperature | Temperature |
| remoteSensor\<1-10\> | dewPoint | Number:Temperature | Dew Point |
| remoteSensor\<1-10\> | feelingTemperature | Number:Temperature | "Real feel" temperature |
| remoteSensor\<1-10\> | humidity | Number:Dimensionless | Humidity |
| remoteSensor\<1-10\> | batteryIndicator | String | Battery indicator |
| remoteSensor\<1-10\> | co2 | Number:Dimensionless | Carbon Dioxide level |

4
_addons_bindings/astro/readme.md
View File

@ -34,7 +34,7 @@ No binding configuration required.
## Thing Configuration
All Things require the parameter `geolocation` (as `<latitude>,<longitude>,[<altitude in m>]`) for which the calculation is done.
All Things require the parameter `geolocation` (as `<latitude>,<longitude>[,<altitude in m>]`) for which the calculation is done.
The altitude segment is optional and sharpens results provided by the Radiation group.
Optionally, a refresh `interval` (in seconds) can be defined to also calculate positional data like azimuth and elevation.
@ -173,7 +173,7 @@ astro:sun:home [ geolocation="52.5200066,13.4049540,100", interval=60 ] {
}
```
or a offset and latest
or an offset and latest
```
astro:sun:home [ geolocation="52.5200066,13.4049540,100", interval=60 ] {

20
_addons_bindings/atlona/readme.md
View File

@ -3,7 +3,7 @@ id: atlona
label: Atlona
title: Atlona - Bindings
type: binding
description: "This binding integrates Atlona AT-UHD-PRO3 HdBaseT matrix switches [Atlona AT-UHD-PRO3 HdBaseT matrix switches](http://www.atlona.com) into your openHAB installation."
description: "This binding integrates Atlona AT-UHD-PRO3 HdBaseT matrix switches [Atlona AT-UHD-PRO3 HdBaseT matrix switches](https://www.atlona.com) into your openHAB installation."
since: 2x
logo: images/addons/atlona.png
install: auto
@ -15,7 +15,7 @@ install: auto
# Atlona Binding
This binding integrates Atlona AT-UHD-PRO3 HdBaseT matrix switches [Atlona AT-UHD-PRO3 HdBaseT matrix switches](http://www.atlona.com) into your openHAB installation.
This binding integrates Atlona AT-UHD-PRO3 HdBaseT matrix switches [Atlona AT-UHD-PRO3 HdBaseT matrix switches](https://www.atlona.com) into your openHAB installation.
## Supported Things
@ -178,24 +178,24 @@ The # of presets allowed depends on the firmware you are using (5 presets up to
The matrixcmd channel will take the following commands:
| Command | Description |
|-------------|---------------------------------------------------------------------------------------------------------------------------------------|
| resetmatrix | Resets the matrix back to it's default values (USE WITH CARE!). Note: some firmware upgrades require a resetmatrix after installing. |
| resetports | Resets the ports back to their default values (outputX=inputX) |
| allportsX | Sets all the output ports to the input port X |
| Command | Description |
|-------------|-------------------------------------------------------------------------------------------------------------------------------------|
| resetmatrix | Resets the matrix back to its default values (USE WITH CARE!). Note: some firmware upgrades require a resetmatrix after installing. |
| resetports | Resets the ports back to their default values (outputX=inputX) |
| allportsX | Sets all the output ports to the input port X |
Note: if X doesn't exist - nothing will occur.
The # of presets allowed depends on the firmware you are using (5 presets up to rev 13, 10 for rev 14 and above).
## Changes/Warnings
As of firmware 1.6.03 (rev 13), there are three issues on Atlona firmware (I've notified them on these issues):
As of firmware 1.6.03 (rev 13), there are three issues on Atlona firmware (I have notified them on these issues):
- clearX command does not work. The TCP/IP command "ClearX" as specified in Atlona's protocol will ALWAYS return a "Command Failed". Please avoid this channel until atlona releases a new firmware.
- There is no way to query what the current status is of: panellock, and irenable. This addon simply assumes that panellock is off and irenable is on at startup.
- There is no way to query what the current status is of: panellock, and irenable. This add-on simply assumes that panellock is off and irenable is on at startup.
- If you make a change in the switches UI that requires a reboot (mainly changing any of the settings on the "Network" tab in the switch configuration UI), this addon's connection will be inconsistently closed at different times.
- If you make a change in the switches UI that requires a reboot (mainly changing any of the settings on the "Network" tab in the switch configuration UI), this add-on's connection will be inconsistently closed at different times.
The thing will go OFFLINE and then back ONLINE when the reconnect attempt is made - and then it starts all over again. Please make sure you reboot as soon as possible when the switch UI notifies you.
- a bug in the firmware will sometimes cause memory presets to disappear after a reboot

8
_addons_bindings/autelis/readme.md
View File

@ -3,7 +3,7 @@ id: autelis
label: Autelis Pool Control
title: Autelis Pool Control - Bindings
type: binding
description: "Autelis manufactures a network enabled pool interface for many popular pool systems. See [the Autelis website](http://www.autelis.com) and the [Autelis Command Protocol](http://www.autelis.com/wiki/index.php?title=Pool_Control_(PI)_HTTP_Command_Reference) for more information."
description: "Autelis manufactures a network enabled pool interface for many popular pool systems."
since: 2x
logo: images/addons/autelis.png
install: auto
@ -15,7 +15,8 @@ install: auto
# Autelis Pool Control Binding
Autelis manufactures a network enabled pool interface for many popular pool systems. See [the Autelis website](http://www.autelis.com) and the [Autelis Command Protocol](http://www.autelis.com/wiki/index.php?title=Pool_Control_(PI)_HTTP_Command_Reference) for more information.
Autelis manufactures a network enabled pool interface for many popular pool systems.
See [the Autelis website](https://www.autelis.com) and the [Autelis Command Protocol](http://www.autelis.com/wiki/index.php?title=Pool_Control_(PI)_HTTP_Command_Reference) for more information.
This binding supports:
@ -26,7 +27,8 @@ This binding supports:
## Auto Discovery
The binding will automatically discover Autelis controllers using UPNP. If found it will try and connect with the factory default username and password.
The binding will automatically discover Autelis controllers using UPnP.
If found it will try and connect with the factory default username and password.
## Binding Configuration

6
_addons_bindings/avmfritz/readme.md
View File

@ -3,7 +3,7 @@ id: avmfritz
label: AVM FRITZ!
title: AVM FRITZ! - Bindings
type: binding
description: "The binding integrates the AHA ( [AVM Home Automation](http://avm.de/ratgeber/smart-home/) ) system."
description: "The binding integrates the AHA ( [AVM Home Automation](https://avm.de/ratgeber/smart-home/) ) system."
since: 2x
logo: images/addons/avmfritz.png
install: auto
@ -15,7 +15,7 @@ install: auto
# AVM FRITZ! Binding
The binding integrates the AHA ( [AVM Home Automation](http://avm.de/ratgeber/smart-home/) ) system.
The binding integrates the AHA ( [AVM Home Automation](https://avm.de/ratgeber/smart-home/) ) system.
## Supported Things
@ -38,7 +38,7 @@ It only supports temperature readings.
### FRITZ!Powerline 546E
This [powerline adapter](http://avm.de/produkte/fritzpowerline/fritzpowerline-546e/) can be used via the bridge or in stand-alone mode.
This [powerline adapter](https://avm.de/produkte/fritzpowerline/fritzpowerline-546e/) can be used via the bridge or in stand-alone mode.
It supports switching the outlet and reading the current power, current voltage and accumulated energy consumption.
This device does not contain a temperature sensor.
**NOTE:** The `voltage` channel will be added to the thing during runtime - if the interface supports it (FRITZ!OS 7 or higher).

6
_addons_bindings/bigassfan/readme.md
View File

@ -3,7 +3,7 @@ id: bigassfan
label: BigAssFan
title: BigAssFan - Bindings
type: binding
description: "The [BigAssFan](http://www.bigassfans.com/) binding is used to enable communication between openHAB and Big Ass Fans' Haiku family of residential fans and lights that implement the SenseME technology."
description: "The [BigAssFan](https://www.bigassfans.com/) binding is used to enable communication between openHAB and Big Ass Fans' Haiku family of residential fans and lights that implement the SenseME technology."
since: 2x
logo: images/addons/bigassfan.png
install: auto
@ -15,7 +15,7 @@ install: auto
# BigAssFan Binding
The [BigAssFan](http://www.bigassfans.com/) binding is used to enable communication between openHAB and Big Ass Fans' Haiku family of residential fans and lights that implement the SenseME technology.
The [BigAssFan](https://www.bigassfans.com/) binding is used to enable communication between openHAB and Big Ass Fans' Haiku family of residential fans and lights that implement the SenseME technology.
## Overview
@ -44,7 +44,7 @@ However, in the event that any of this information changes, the configuration mu
### Manual Thing Creation
Fans and lights can be manually created in the *PaperUI* or *HABmin*, or by placing a *.things* file in the *conf/things* directory.
Fans and lights can be manually created in the *Paper UI* or *HABmin*, or by placing a *.things* file in the *conf/things* directory.
See example below.
## Channels

6
_addons_bindings/bluetooth.blukii/readme.md
View File

@ -3,7 +3,7 @@ id: bluetooth.blukii
label: Blukii
title: Blukii - Bindings
type: binding
description: "This extension adds support for [Blukii](http://www.blukii.com/) Sensor Beacons."
description: "This extension adds support for [Blukii](https://www.blukii.com/) Sensor Beacons."
since: 2x
logo: images/addons/bluetooth.blukii.png
install: manual
@ -15,7 +15,7 @@ install: manual
# Blukii
This extension adds support for [Blukii](http://www.blukii.com/) Sensor Beacons.
This extension adds support for [Blukii](https://www.blukii.com/) Sensor Beacons.
## Supported Things
@ -65,4 +65,4 @@ Number:Illuminance luminance "Luminance [%.0f %unit%]" { channel="
Number:Angle tiltX "Tilt (X-Axis) [%.0f %unit%]" { channel="bluetooth:blukii:hci0:beacon:tiltx" }
Number:Angle tiltY "Tilt (Y-Axis) [%.0f %unit%]" { channel="bluetooth:blukii:hci0:beacon:tilty" }
Number:Angle tiltZ "Tilt (Z-Axis) [%.0f %unit%]" { channel="bluetooth:blukii:hci0:beacon:tiltz" }
```
```

4
_addons_bindings/bluetooth.ruuvitag/readme.md
View File

@ -3,7 +3,7 @@ id: bluetooth.ruuvitag
label: Ruuvi Tag
title: Ruuvi Tag - Bindings
type: binding
description: "This extension adds support for [Ruuvi Tag](http://www.ruuvitag.com/) Sensor Beacons."
description: "This extension adds support for [Ruuvi Tag](https://ruuvi.com/) Sensor Beacons."
since: 2x
install: manual
---
@ -14,7 +14,7 @@ install: manual
# Ruuvi Tag
This extension adds support for [Ruuvi Tag](http://www.ruuvitag.com/) Sensor Beacons.
This extension adds support for [Ruuvi Tag](https://ruuvi.com/) Sensor Beacons.
## Supported Things

2
_addons_bindings/buienradar/readme.md
View File

@ -33,7 +33,7 @@ No auto-discovery is currently possible.
## Configuration of the thing
The configuration can be done via the PaperUI web interface, or manually by adding a Thing to your `.things` file:
The configuration can be done via the Paper UI web interface, or manually by adding a Thing to your `.things` file:
```
Thing buienradar:rain_forecast:home [ location="52.198864211111925,5.4192629660193585" ]

4
_addons_bindings/cm11a/readme.md
View File

@ -103,6 +103,6 @@ DimmerA2 "Porch lights" <slider> (someGroup) { channel="cm11a:dimmer:MyCm11a
## 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/)
1. [CM11A (X10) Protocol Document](https://wanderingsamurai.net/electronics/cm11a-x10-protocol-document)
2. [Heyu - control software for the cm11a](https://www.heyu.org/)
3. cm11a Controllers are available for purchase from several sites on the internet

11
_addons_bindings/daikin/readme.md
View File

@ -3,7 +3,7 @@ id: daikin
label: Daikin
title: Daikin - Bindings
type: binding
description: "The Daikin binding allows you to control your Daikin air conditioning units with openHAB. In order to do so, your Daikin air conditioning unit must have a BRP072A42 or BRP15B61 WiFi adapter installed."
description: "The Daikin binding allows you to control your Daikin air conditioning units with openHAB."
since: 2x
logo: images/addons/daikin.png
install: auto
@ -15,15 +15,18 @@ install: auto
# Daikin Binding
The Daikin binding allows you to control your Daikin air conditioning units with openHAB. In order to do so, your Daikin air conditioning unit must have a BRP072A42 or BRP15B61 WiFi adapter installed.
The Daikin binding allows you to control your Daikin air conditioning units with openHAB.
In order to do so, your Daikin air conditioning unit must have a BRP072A42 or BRP15B61 WiFi adapter installed.
## Supported Things
Daikin air conditioning units with a BRP072A42 or BRP15B61 installed. This may work with the older KRP series of wired adapters, but has not been tested with them.
Daikin air conditioning units with a BRP072A42 or BRP15B61 installed.
This may work with the older KRP series of wired adapters, but has not been tested with them.
## Discovery
This addon will broadcast messages on your local network looking for Daikin air conditioning units and adding them to the queue of new items discovered. You can also manually add a new item if you know the IP address.
This add-on will broadcast messages on your local network looking for Daikin air conditioning units and adding them to the queue of new items discovered.
You can also manually add a new item if you know the IP address.
## Thing Configuration

2
_addons_bindings/deconz/readme.md
View File

@ -66,7 +66,7 @@ The Websocket port can be filled automatically by requesting it via the HTTP int
The API key is an optional value.
If a deCONZ API key is available because it has already been created manually, it can also be entered as a configuration value.
Otherwise the field can be left empty and the binding will generate the key automatically.
For this process the deCONZ bridge must be unlocked in the deCONZ software so that third party applications can register ([see deCONZ documentation](http://dresden-elektronik.github.io/deconz-rest-doc/getting_started/#unlock-the-gateway)).
For this process the deCONZ bridge must be unlocked in the deCONZ software so that third party applications can register ([see deCONZ documentation](https://dresden-elektronik.github.io/deconz-rest-doc/getting_started/#unlock-the-gateway)).
### Textual Thing Configuration - Retrieving an API Key

2
_addons_bindings/denonmarantz/readme.md
View File

@ -127,6 +127,6 @@ These resources can be useful to learn what to send using the `command`channel:
- [AVR-X2000/E400](http://www2.aerne.com/Public/dok-sw.nsf/0c6187bc750a16fcc1256e3c005a9740/96a2ba120706d10dc1257bdd0033493f/$FILE/AVRX2000_E400_PROTOCOL(10.1.0)_V04.pdf)
- [AVR-X4000](https://usa.denon.com/us/product/hometheater/receivers/avrx4000?docname=AVRX4000_PROTOCOL(10%203%200)_V03.pdf)
- [AVR-3311CI/AVR-3311/AVR-991](http://www.awe-europe.com/documents/Control%20Docs/Denon/Archive/AVR3311CI_AVR3311_991_PROTOCOL_V7.1.0.pdf)
- [AVR-3311CI/AVR-3311/AVR-991](https://www.awe-europe.com/documents/Control%20Docs/Denon/Archive/AVR3311CI_AVR3311_991_PROTOCOL_V7.1.0.pdf)
- [CEOL Piccolo DRA-N5/RCD-N8](http://www.audioproducts.com.au/downloadcenter/products/Denon/CEOLPICCOLOBK/Manuals/DRAN5_RCDN8_PROTOCOL_V.1.0.0.pdf)
- [Marantz Control Protocol (2014+)](http://m.us.marantz.com/DocumentMaster/US/Marantz%202014%20NR%20Series%20-%20SR%20Series%20RS232%20IP%20Protocol.xls)

4
_addons_bindings/digiplex/readme.md
View File

@ -113,7 +113,7 @@ Message format is as follows:
`<pin>` is your PIN as entered on a keypad.
**Note**: For security reasons please consider not storing your PIN in openhab configuration files.
**Note**: For security reasons please consider not storing your PIN in openHAB configuration files.
**Note2**: Please consult your alarm system manual how to enable `Quick Arm` feature. It is not enabled by default.
@ -121,4 +121,4 @@ For example, the following sitemap item can be used to send commands to the area
```
Switch item=areaControl label="Actions[]" mappings=[QA="Regular Quick Arm",QS="Stay Quick Arm",D1111="Disarm"] labelcolor=[Ok="green",Fail="red"]
```
```

54
_addons_bindings/digitalstrom/readme.md
View File

@ -3,7 +3,7 @@ id: digitalstrom
label: digitalSTROM
title: digitalSTROM - Bindings
type: binding
description: "This binding integrates the [digitalSTROM-System](http://www.digitalstrom.de/)."
description: "This binding integrates the [digitalSTROM-System](https://www.digitalstrom.de/)."
since: 2x
logo: images/addons/digitalstrom.png
install: auto
@ -15,7 +15,7 @@ install: auto
# digitalSTROM Binding
This binding integrates the [digitalSTROM-System](http://www.digitalstrom.de/).
This binding integrates the [digitalSTROM-System](https://www.digitalstrom.de/).
The integration happens through the digitalSTROM-Server, which acts as a gateway to connect the digitalSTROM-Devices.
The digitalSTROM-Server communicates through the digitalSTROM-Meters with the digitalSTROM-Devices, which are directly connected to the power-line.
@ -31,10 +31,13 @@ The digitalSTROM-Server is required for accessing any other digitalSTROM-Devices
### digitalSTROM-Devices
At this point almost all available **GE**, **SW**, **GR** and **BL** digitalSTROM-Devices with a set output-mode, unequal *disabled*, are supported by this binding. Furthermore sensor devices like the **dS-iSens200** and **SW-devices** with binary-inputs are supported.
At this point almost all available **GE**, **SW**, **GR** and **BL** digitalSTROM-Devices with a set output-mode, unequal *disabled*, are supported by this binding.
Furthermore sensor devices like the **dS-iSens200** and **SW-devices** with binary-inputs are supported.
Last but not least the **circuit** (dS-Meter) is supported, too. They will provide the power consumption and electric meter as channels.
For that there are identically named thing types. Only the *GR* type has a channel (shade), which cannot be changed. The other types add their channels dynamically affected by the set color-group and output-mode. They also automatically change or add the channels, if the color-group or output-mode has changed through the dSS-web-configuration or the configured sensor priorities of the thing has changed.
For that there are identically named thing types. Only the *GR* type has a channel (shade), which cannot be changed.
The other types add their channels dynamically affected by the set color-group and output-mode.
They also automatically change or add the channels, if the color-group or output-mode has changed through the dSS-web-configuration or the configured sensor priorities of the thing has changed.
- The following table shows all tested digitalSTROM-Devices with their output-modes.
@ -45,7 +48,7 @@ For that there are identically named thing types. Only the *GR* type has a chann
| GE-TKM210 | switched, dimmed | yellow |
| GE-SDM200 | switched, dimmed | yellow |
| GE-UMV200 | 1-10V dimmed | yellow |
| GR-KL200 | standard output-mode | grey |
| GR-KL200 | standard output-mode | grey |
| GR-KL210 | standard output-mode| grey |
| GR-KL220 | standard output-mode | grey |
| SW-KL200 | switch, powersave, wipe | black, yellow |
@ -72,7 +75,8 @@ The different scene thing types are listed in the following table.
### digitalSTROM-Zone-Temperature-Control
Last but not least, the digitalSTROM-Zone-Temperature-Control is also supported, if a zone-temerature-control is configured, as thing-type **zone_temperature_control**.
The difference between the digitalSTROM-heating-control-app is, that there are no operation-modes, like *comfort* or *eco*. You can directly set the target temperature, in case *pid-control* is configured, otherwise you can set the value in percent of heating valves at the zone.
The difference between the digitalSTROM-heating-control-app is, that there are no operation-modes, like *comfort* or *eco*.
You can directly set the target temperature, in case *pid-control* is configured, otherwise you can set the value in percent of heating valves at the zone.
The needed channels will be added automatically, as it is also the case for the devices.
## Discovery
@ -102,7 +106,7 @@ The digitalSTROM-Server thing has the following configuration parameter groups:
#### Connection configuration
If the digitalSTROM-Server isn’t found automatically, e.g. because the server isn’t placed at the local network or the mDNS-service is deactivated, you have to insert the network address or URL and the authentication data manually through the graphical user interface or type it into the \*.thing with textual configuration.
If you use your user name and password for authentication and there is already a token for this application, it will be automatically retrieved from the digitalSTROM-Server, otherwise a new application-token will be generated.
If you use your user name and password for authentication and there is already a token for this application, it will be automatically retrieved from the digitalSTROM-Server, otherwise a new application-token will be generated.
| Parameter Label | Parameter ID | Description | Required | Advanced
|--------------|------------|--------------------------------|----------------- |------------- |
@ -152,7 +156,7 @@ In addition to the configuration the digitalSTROM-Server has the following prope
| Serial | The digitalSTROM-Server hardware serial number. |
| Ethernet | The digitalSTROM-Server IEEE mac address. |
| MachineID | The digitalSTROM-Server unique id. |
| Kernel | The digitalSTROM-Server linux kernel release string. |
| Kernel | The digitalSTROM-Server Linux kernel release string. |
### digitalSTROM-Devices
@ -171,7 +175,7 @@ The following table shows the parameter:
#### Sensor setup
The GE, BL and SW digitalSTROM-Devices usually have sensors to capture power consumption data.
So these devices have the following parameters to read them out.
So these devices have the following parameters to read them out.
| Parameter Label | Parameter ID| Description | Required | Advanced | Default |
|-----------------|--------------------|-----------------------------|----------------- |------------- | -----------|
@ -188,12 +192,12 @@ The following table shows all informative properties:
| ------------- | ------------------------------------- |
|dSUID | The unique identifier of a digitalSTORM-device with virtual devices. |
| deviceName | he name of a digitalSTROM-Device. |
| meterDSID | Identifier of the meter to which the device is connected. |
| hwInfo | The hardware type from this digitalSTROM-Device. |
| zoneID |The digitalSTROM-Device is part of this zone. |
| groups | The digitalSTROM-Device is part of this user-defined or functional groups. |
| output mode | The current digitalSTROM-Device output mode e.g. 22 = dimmable. |
| funcColorGroup | The current digitalSTROM-Device functional color group e.g. yellow = light. |
| meterDSID | Identifier of the meter to which the device is connected. |
| hwInfo | The hardware type from this digitalSTROM-Device. |
| zoneID |The digitalSTROM-Device is part of this zone. |
| groups | The digitalSTROM-Device is part of this user-defined or functional groups. |
| output mode | The current digitalSTROM-Device output mode e.g. 22 = dimmable. |
| funcColorGroup | The current digitalSTROM-Device functional color group e.g. yellow = light. |
The device scene configurations will also be persisted in the properties. There are in the format:
@ -239,7 +243,7 @@ As configuration only the zone ID or the zone name, to identify the controlled z
### digitalSTROM-Scenes
The digitalSTROM-Scenes can be defined with following parameters.
The digitalSTROM-Scenes can be defined with following parameters.
| Parameter Label | Parameter ID| Description | Required | Advanced |
|-----------------|------------------------|----------------------------------|----------------- |------------- |
@ -284,7 +288,7 @@ Thing digitalstrom:groupScene:preset1 (digitalstrom:dssBridge:myDssBridge) [ zon
## Channels
All devices support some of the following channels:
All devices support some of the following channels:
### Output-Channels
@ -346,10 +350,10 @@ digitalSTROM-Devices which are able to set a binary-input sensor like SW-UMR200
|-------|---------|------------------------------------|----------------- |
| binary_input_presence | Switch | Will be activated, if a presence is detected. | SW |
| binary_input_brightness | Switch | Will be activated, if the brightness is higher than a setted value. | SW |
| binary_input_presence_in_darkness | Switch | Will be activated, if a presence is detected. Sensor has a integrated twilight sensor. | SW |
| binary_input_presence_in_darkness | Switch | Will be activated, if a presence is detected. Sensor has an integrated twilight sensor. | SW |
| binary_input_twilight | Switch | Will be activated by twilight. | SW |
| binary_input_motion | Switch | Will be activated, if a motion is detected. | SW |
| binary_input_motion_in_darkness | Switch | Will be activated, if a motion is detected. Sensor has a integrated twilight sensor. | SW |
| binary_input_motion_in_darkness | Switch | Will be activated, if a motion is detected. Sensor has an integrated twilight sensor. | SW |
| binary_input_smoke | Switch | Will be activated, if smoke is detected. | SW |
| binary_input_wind_strenght_above_limit | Switch | Will be activated, if wind strength is above a user adjusted limit. | SW |
| binary_input_rain | Switch | Will be activated, if rain is detected. | SW |
@ -394,7 +398,7 @@ The digitalSTROM-Server
* The digitalSTROM-Server only informs the binding about scene-commands. So if you set the output value of devices e.g. through the dSS-App, the binding will not be informed about the changes and you have to send a "refresh-command" to update the channel.
* If you press a physical switch at your digitalSTROM-installation and the called scene-value is not red out yet, it can take a bit time to read it out and change the state of the channel.
It the scene-value is red out, the state will change immediately.
See also *General-Informations/digitalSTROM-Scenes*.
See also *General-Informations/digitalSTROM-Scenes*.
*Channels with accepted command type increase and decrease:*
@ -415,10 +419,10 @@ Bridge digitalstrom:dssBridge:dSS [ dSSAddress="urlOfMyDss", userName="dssadmin
SW SW-ZWS-200 [ dSID="3504175fe0000000000651c0"]
SW SW-UMR-200 [ dSID="302ed89f43f00ec0000a1034"]
dSiSens200 dS-iSens200 [ dSID="302ed89f43f026800003543d"]
zoneTemperatureControl zoneTemperatureControl [ zoneID="livingroom"]
zoneTemperatureControl zoneTemperatureControl [ zoneID="livingroom"]
GR GR-KL220 [ dSID="3504175fe0000000000651c1" ]
namedScene Scene1 [ zoneID="5", groupID="1", sceneID="5"]
circuit circuit1 [ dSID="3504175fe0000010000004e4" ]
circuit circuit1 [ dSID="3504175fe0000010000004e4" ]
GR GR-KL200 [ dSID="3504175fe0000000000651c1" ]
}
```
@ -526,7 +530,7 @@ sitemap demo label="Main Menu"
Frame label="TV"{
Switch item=DeviceSwitch
}
}
}
}
```
@ -545,7 +549,7 @@ The current troubleshooting to read out the new scene configuration after a save
1. delete the thing to delete the persistently saved scene configuration
2. restart the server to delete the temporary saved scene configuration
3. add the thing again to read out the scene configuration again.
3. add the thing again to read out the scene configuration again.
### Initial state of digitalSTROM-Scenes and devices
@ -565,5 +569,5 @@ If you configure your system with textual configuration files, like *\*.thing*,
If you want to create a rule, which uses things of the digitalSTROM-Binding, there are also two things you have to consider.
1. If the rule contains several digitalSTROM-Devices, which can be summarized in a digitalSTROM-Scene, e.g. some lights in a zone, please use a equivalent supported scene. That will significantly reduce the communication to the digitalSTROM-Server, increases performance and does not bypass the digitalSTROM state-machine.
1. If the rule contains several digitalSTROM-Devices, which can be summarized in a digitalSTROM-Scene, e.g. some lights in a zone, please use an equivalent supported scene. That will significantly reduce the communication to the digitalSTROM-Server, increases performance and does not bypass the digitalSTROM state-machine.
2. If you implement your own temperature control algorithm for a zone/room, e.g. because you want to use other temperature sensors, and call more than one digitalSTROM-BL-KM200, please use the *zone_temperature_control* for valve value control. The *zone_temperature_control* for valve value control will call all digitalSTROM-BL-KM200 with one command and increases the performance. To get the needed channel at the *zone_temperature_control* you have to choose a control mode unequal to *pid-controlled* for the affected zone at the digitalSTROM-heating-control-app.

10
_addons_bindings/dmx/readme.md
View File

@ -48,11 +48,12 @@ Chaser things define a control channel that can be used to dynamically change th
## Discovery
Discovery is not supported at the moment. You have to add all bridges and things manually.
Discovery is not supported at the moment.
You have to add all bridges and things manually.
## Thing Configuration
Since the brightness perception of the human eye is not linear, all bridges support `applycurve`, a list of channels `applycurve` that have a CIE 1931 lightness correction (cf. [Poynton, C.A.: “Gamma” and its Disguises: The Nonlinear Mappings of Intensity in Perception, CRTs, Film and Video, SMPTE Journal Dec. 1993, pp. 1099 - 1108](http://www.poynton.com/PDFs/SMPTE93_Gamma.pdf)) applied.
Since the brightness perception of the human eye is not linear, all bridges support `applycurve`, a list of channels `applycurve` that have a CIE 1931 lightness correction (cf. [Poynton, C.A.: “Gamma” and its Disguises: The Nonlinear Mappings of Intensity in Perception, CRTs, Film and Video, SMPTE Journal Dec. 1993, pp. 1099 - 1108](https://www.poynton.com/PDFs/SMPTE93_Gamma.pdf)) applied.
This list follows the format of the thing channel definition.
This is used regardless of the thing(s) that are associated to the channel.
@ -218,7 +219,8 @@ The next `ON` command uses these values instead of the default (or configuration
|switch |chaser |Switch | turns the chaser ON or OFF |
|mute |(all bridges) |Switch | mutes the DMX output of the bridge |
*Note:* the string send to the control channel of chaser things has to be formatted like the `steps` configuration of the chaser thing. If the new string is invalid, the old configuration will be used.
*Note:* the string send to the control channel of chaser things has to be formatted like the `steps` configuration of the chaser thing.
If the new string is invalid, the old configuration will be used.
## Rule Actions
@ -241,7 +243,7 @@ Defining more than one step in `fadeString` is supported, too.
## Full Example
This example defines a sACN/E1.31 bridge in unicast mode which transmits universe 2 and three things: a three channel dimmer used to control a RGB light, which takes 1s to fade from one color to another and 10s from 0-100% on incremental dim commands, a single channel dimmer which will turn on only to 90% if it receives a ON command and does not fully switch off (to 10%) if it receives an OFF command and chaser which changes the colors like a traffic light.
This example defines a sACN/E1.31 bridge in unicast mode which transmits universe 2 and three things: a three channel dimmer used to control a RGB light, which takes 1s to fade from one color to another and 10s from 0-100% on incremental dim commands, a single channel dimmer which will turn on only to 90% if it receives an ON command and does not fully switch off (to 10%) if it receives an OFF command and chaser which changes the colors like a traffic light.
### demo.things:

2
_addons_bindings/doorbird/readme.md
View File

@ -103,7 +103,7 @@ if(actions === null) {
## Known Issues
The Doorbird uses the UDP protocol on port 6524 to broadcast events for Doorbird actions, such as doorbell pressed, motion detected, etc.
If the Doorbord is on a separate subnet or VLAN from openHAB, those UDP packets won't route by default.
If the Doorbord is on a separate subnet or VLAN from openHAB, those UDP packets will not route by default.
In that case, the Doorbird binding will not receive those events.
Either put the Doorbird and openHAB on the same subnet/VLAN, or set up your network to explicitly route those UDP packets.

4
_addons_bindings/dscalarm/readme.md
View File

@ -45,14 +45,14 @@ Most settings are through thing configuration parameters.
The DSC Alarm binding incorporates several discovery modes in order to find DSC Alarm systems.
First, there is the Envisalink bridge discovery mode which performs a network query for any Envisalink adapters and adds them to the discovery inbox.
Second, there is The IT-100 bridge discovery mode which will search serial ports for any IT-100 adapters and add them to the discovery inbox.
The bridge discovery modes are started manually through PaperUI.
The bridge discovery modes are started manually through Paper UI.
Third, after a bridge is discovered and available to openHAB, the binding will attempt to discover DSC Alarm things and add them to the discovery inbox.
The TCP Server bridge does not implement bridge discovery but will utilize thing discovery once it is online.
Note:
The Envisalink Bridge discovery does a TCP scan across your local network to find the interface.
This may create issues on the network so it is suggested that caution be used when trying this discovery.
The recommended method would be to manually add and configure the bridge through the 'dscalarm.thing' file or the PaperUI.
The recommended method would be to manually add and configure the bridge through the 'dscalarm.thing' file or the Paper UI.
And then allow the binding to discover the DSC Alarm things.
## Thing Configuration

6
_addons_bindings/dsmr/readme.md
View File

@ -22,7 +22,7 @@ This binding reads the P1-port of the Dutch Smart Meters that comply to NTA8130,
This binding reads the P1-port of the Luxembourg’s electricity meter "Smarty" that comply to V1.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/Luxembourg but do want to read a meter please have look at the [SmartMeter Binding](https://www.openhab.org/addons/bindings/smartmeter).
If you are not living in the Netherlands/Luxembourg but do want to read a meter please have look at the [SmartMeter Binding](/addons/bindings/smartmeter/).
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.
## Serial Port Configuration
@ -38,7 +38,7 @@ You always have to have a 'Dutch Smart Meter'-bridge. The bridge contains the se
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.
The physical meter might update with a high frequency per second, while it is desired to have only values per minute.
### smartyBridge (Luxembourg)
@ -302,7 +302,7 @@ Channel identifier: `dsmr:<ThingTypeID>:<bridge id>:<id>:<channel type id>`
- 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`
The following configuration must to be added to an item configuration file. E.g. `things/dsmr.items`
```
ItemType <name> "<description>" (<Group>) {channel="<Channel identifier>"}

2
_addons_bindings/exec/readme.md
View File

@ -54,7 +54,7 @@ Thing exec:command:uniquename [command="/command/to/execute here", interval=15,
```
The `command` itself can be enhanced using the well known syntax of the [Java formatter class syntax](http://docs.oracle.com/javase/7/docs/api/java/util/Formatter.html#syntax).
The `command` itself can be enhanced using the well known syntax of the [Java formatter class syntax](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html#syntax).
The following parameters are automatically added:
- the current date (as java.util.Date, example: `%1$tY-%1$tm-%1$td`)

2
_addons_bindings/feed/readme.md
View File

@ -18,7 +18,7 @@ This binding allows you to integrate feeds in the openHAB environment.
The Feed binding downloads the content, tracks for changes, and displays information like feed author, feed title and description, number of entries, last update date.
It can be used in combination with openHAB rules to trigger events on feed change.
It uses the [ROME library](http://rometools.github.io/rome/index.html) for parsing
It uses the [ROME library](https://rometools.github.io/rome/index.html) for parsing
and supports a wide range of popular feed formats - RSS 2.00, RSS 1.00, RSS 0.94, RSS 0.93, RSS 0.92, RSS 0.91 UserLand,
RSS 0.91 Netscape, RSS 0.90, Atom 1.0, Atom 0.3.

25
_addons_bindings/feican/readme.md
View File

@ -3,7 +3,7 @@ id: feican
label: Feican
title: Feican - Bindings
type: binding
description: "This binding adds support for the Feican Wi-Fi version of the smart light led Bulb, the WiFi RGBW Bulb."
description: "This binding adds support for the Feican Wi-Fi version of the smart light LED Bulb, the WiFi RGBW Bulb."
since: 2x
install: auto
---
@ -14,33 +14,34 @@ install: auto
# Feican Binding
This binding adds support for the Feican Wi-Fi version of the smart light led Bulb, the WiFi RGBW Bulb.
This binding adds support for the Feican Wi-Fi version of the smart light LED Bulb, the WiFi RGBW Bulb.
With this binding the light bulb can be switched on or off, set the color or set color based on color temperature.
Set the brightness. And it contains a set of preset programs, where for some the program speed can be set.
## Supported Things
This binding supports the Feican smart smart light led Bulb, WiFi RGBW Bulb. This bulb supports color, color temperature,
brightness. It also has a number of preset programs, with static color, jumping color(s), gradient color(s) and flashing
color(s). With the program_speed the speed of some of the programs can be set.
This binding supports the Feican smart smart light LED Bulb, WiFi RGBW Bulb.
This bulb supports color, color temperature, brightness.
It also has a number of preset programs, with static color, jumping color(s), gradient color(s) and flashing color(s).
With the program_speed the speed of some of the programs can be set.
It might be the Feican ledstrips also work as it seems they can be controlled with the same app. But this has not been tested.
Although it has not been tested, the Feican LED strips may also be supported as it seems they can be controlled using the same app.
### Limitations
It's not possible to get the state of the bulb from the bulb itself. Therefore the state visible to the user only reflects
what was set in openHAB and may not correspond with the actual state.
It is not possible to get the state of the bulb from the bulb itself.
Therefore the state visible to the user only reflects what was set in openHAB and may not correspond with the actual state.
## Prerequisites
Before using the Feican bulb with openHab the devices must be connected to the Wi-Fi network. This can be done using the
Feican Android or iPhone DreamColor app.
Before using the Feican bulb with openHAB the devices must be connected to the Wi-Fi network.
This can be done using the Feican Android or iPhone DreamColor app.
## Discovery
Devices can be auto discovered within the local network. It's possible to connect to devices in a different network,
but these must be added manually.
Devices can be auto discovered within the local network.
It is possible to connect to devices in a different network, but these must be added manually.
## Thing Configuration

8
_addons_bindings/freebox/readme.md
View File

@ -3,7 +3,7 @@ id: freebox
label: Freebox
title: Freebox - Bindings
type: binding
description: "This binding integrates the [Freebox Revolution](https://www.free.fr/freebox/freebox-revolution/) to your openHab installation."
description: "This binding integrates the [Freebox Revolution](https://www.free.fr/freebox/freebox-revolution/) to your openHAB installation."
since: 2x
logo: images/addons/freebox.png
install: auto
@ -15,7 +15,7 @@ install: auto
# Freebox Binding
This binding integrates the [Freebox Revolution](https://www.free.fr/freebox/freebox-revolution/) to your openHab installation.
This binding integrates the [Freebox Revolution](https://www.free.fr/freebox/freebox-revolution/) to your openHAB installation.
## Supported Things
@ -100,7 +100,7 @@ The *airplay* thing requires the following configuration parameters:
## Authentication
You'll have to authorize openHAB to connect to your Freebox. Here is the process described :
You will have to authorize openHAB to connect to your Freebox. Here is the process described :
**Step 1** At binding startup, if no token is recorded in the Freebox Server (bridge) configuration, the following message will be displayed in the OSGi console :
@ -116,7 +116,7 @@ You'll have to authorize openHAB to connect to your Freebox. Here is the process
**Step 3** Record the apptoken in the Freebox Server (bridge) configuration
**Optionally** you can log in your Freebox admin console to allocate needed rights to openhab
**Optionally** you can log in your Freebox admin console to allocate needed rights to openHAB
Once initialized, the thing will generate all available channels.

4
_addons_bindings/fronius/readme.md
View File

@ -3,7 +3,7 @@ id: fronius
label: Fronius
title: Fronius - Bindings
type: binding
description: "This binding uses the [Fronius Solar API V1](http://www.fronius.com/en/photovoltaics/products/all-products/system-monitoring/open-interfaces/fronius-solar-api-json-) to obtain data from a Fronius devices."
description: "This binding uses the [Fronius Solar API V1](https://www.fronius.com/en/photovoltaics/products/all-products/system-monitoring/open-interfaces/fronius-solar-api-json-) to obtain data from a Fronius devices."
since: 2x
logo: images/addons/fronius.png
install: auto
@ -15,7 +15,7 @@ install: auto
# Fronius Binding
This binding uses the [Fronius Solar API V1](http://www.fronius.com/en/photovoltaics/products/all-products/system-monitoring/open-interfaces/fronius-solar-api-json-) to obtain data from a Fronius devices.
This binding uses the [Fronius Solar API V1](https://www.fronius.com/en/photovoltaics/products/all-products/system-monitoring/open-interfaces/fronius-solar-api-json-) to obtain data from a Fronius devices.
## Supported Things

12
_addons_bindings/fsinternetradio/readme.md
View File

@ -3,7 +3,7 @@ id: fsinternetradio
label: FS Internet Radio
title: FS Internet Radio - Bindings
type: binding
description: "This binding integrates internet radios based on the [Frontier Silicon chipset](http://www.frontier-silicon.com/)."
description: "This binding integrates internet radios based on the [Frontier Silicon chipset](https://www.frontier-silicon.com/)."
since: 2x
logo: images/addons/fsinternetradio.png
install: auto
@ -15,7 +15,7 @@ install: auto
# FS Internet Radio Binding
This binding integrates internet radios based on the [Frontier Silicon chipset](http://www.frontier-silicon.com/).
This binding integrates internet radios based on the [Frontier Silicon chipset](https://www.frontier-silicon.com/).
## Supported Things
@ -23,17 +23,17 @@ Successfully tested are internet radios:
* [Hama IR100](https://de.hama.com/00054823/hama-internetradio-ir110)
* [Medion MD87180, MD86988, MD86955, MD87528](http://internetradio.medion.com/)
* [Silvercrest SMRS18A1, SMRS30A1, SMRS35A1, SIRD 14 C2](http://www.silvercrest-multiroom.de/en/products/stereo-internet-radio/)
* [Silvercrest SMRS18A1, SMRS30A1, SMRS35A1, SIRD 14 C2](https://www.silvercrest-multiroom.de/en/products/stereo-internet-radio/)
* [Roberts Stream 83i and 93i](https://www.robertsradio.com/uk/products/radio/smart-radio/)
* [Auna Connect 150, Auna KR200](https://www.auna.de/Radios/Internetradios/)
* [TechniSat DIGITRADIO 350 IR and 850](https://www.technisat.com/en_XX/DAB+-Radios-with-Internetradio/352-10996/)
* [TTMicro AS Pinell Supersound](http://www.ttmicro.no/radio)
* [TTMicro AS Pinell Supersound](https://www.ttmicro.no/radio)
* [Revo SuperConnect](https://revo.co.uk/products/)
* [Sangean WFR-28C](http://sg.sangean.com.tw/products/product_category.asp?cid=2)
* [Roku SoundBridge M1001](https://soundbridge.roku.com/soundbridge/index.php)
* [Dual IR 3a](https://www.dual.de/produkte/digitalradio/radio-station-ir-3a/)
But in principle, all internet radios based on the [Frontier Silicon chipset](http://www.frontier-silicon.com/) should be supported because they share the same API.
But in principle, all internet radios based on the [Frontier Silicon chipset](https://www.frontier-silicon.com/) should be supported because they share the same API.
So It is very likely that other internet radio models of the same manufacturers do also work.
## Community
@ -48,7 +48,7 @@ If your radio is not discovered, please try to access its API via: `http://<radi
If you get a 404 error, maybe a different port than the standard port 80 is used by your radio; try scanning the open ports of your radio.<br/>
If you get a result like `FS_OK 1902014387`, your radio is supported.
If this is the case, please [add your model to this documentation](https://github.com/eclipse/smarthome/edit/master/extensions/binding/org.openhab.binding.fsinternetradio/README.md) and/or provide discovery information in [this thread](https://community.openhab.org/t/internet-radio-i-need-your-help/2131).
If this is the case, please [add your model to this documentation](https://github.com/openhab/openhab2-addons/edit/master/bundles/org.openhab.binding.fsinternetradio/README.md) and/or provide discovery information in [this thread](https://community.openhab.org/t/internet-radio-i-need-your-help/2131).
## Binding Configuration

6
_addons_bindings/gardena/readme.md
View File

@ -3,7 +3,7 @@ id: gardena
label: Gardena
title: Gardena - Bindings
type: binding
description: "This is the binding for [Gardena Smart Home](http://www.gardena.com/de/rasenpflege/smartsystem/)."
description: "This is the binding for [Gardena Smart Home](https://www.gardena.com/de/rasenpflege/smartsystem/)."
since: 2x
logo: images/addons/gardena.png
install: auto
@ -15,7 +15,7 @@ install: auto
# Gardena Binding
This is the binding for [Gardena Smart Home](http://www.gardena.com/de/rasenpflege/smartsystem/).
This is the binding for [Gardena Smart Home](https://www.gardena.com/de/rasenpflege/smartsystem/).
This binding allows you to integrate, view and control Gardena Smart Home devices in the openHAB environment.
## Supported Things
@ -169,4 +169,4 @@ This is not a binding issue, it must be fixed by Gardena.
When the binding sends a command to a device, it communicates only with the Gardena online service.
It has not control over, whether the command is sent from the online service via your gateway to the device.
It's the same as if you send the command in the Gardena App.
It is the same as if you send the command in the Gardena App.

10
_addons_bindings/globalcache/readme.md
View File

@ -3,7 +3,7 @@ id: globalcache
label: GlobalCache
title: GlobalCache - Bindings
type: binding
description: "The [GlobalCache](http://www.globalcache.com) binding is used to enable communication"
description: "The [GlobalCache](https://www.globalcache.com) binding is used to enable communication"
since: 2x
logo: images/addons/globalcache.png
install: auto
@ -15,8 +15,8 @@ install: auto
# GlobalCache Binding
The [GlobalCache](http://www.globalcache.com) binding is used to enable communication
between openHAB and GlobalCache [GC-100](http://www.globalcache.com/products/gc-100/) and [iTach](http://www.globalcache.com/products/itach/) family of devices.
The [GlobalCache](https://www.globalcache.com) binding is used to enable communication
between openHAB and GlobalCache [GC-100](https://www.globalcache.com/products/gc-100/) and [iTach](https://www.globalcache.com/products/itach/) family of devices.
Global Cache devices enable the control and automation of infrared, serial, and contact closure devices through an IP network (wired or wireless).
## Overview
@ -77,7 +77,7 @@ However, in the event that the device's IP address is changed, the device IP add
### Manual Thing Creation
Devices can be manually created in the *PaperUI* or *HABmin*, or by placing a *.things* file in the *conf/things* directory.
Devices can be manually created in the *Paper UI* or *HABmin*, or by placing a *.things* file in the *conf/things* directory.
See example below.
### Binding Dependencies
@ -134,7 +134,7 @@ Here's an example of the hex code format:
0000 006E 0000 0024 0154 00AA 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 003F 0015 0015 0015 0015 0015 0015 0015 0015 0015 003F 0015 003F 0015 003F 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 0015 003F 0015 003F 0015 003F 0015 003F 0015 003F 0015 003F 0015 003F 0015 003F 0015 0015 0015 0015 0015 069B 0154 0055 0015 0EA9
```
The [Global Cache iConvert utility](http://www.globalcache.com/files/docs/gc_iconvert_relnotes.txt) can be used to convert between the two formats, if desired.
The [Global Cache iConvert utility](https://www.globalcache.com/files/docs/gc_iconvert_relnotes.txt) can be used to convert between the two formats, if desired.
The iConvert utility is available on the Windows platform only.
Global Cache also maintains an online [IR Control Tower database](https://irdb.globalcache.com/) of IR codes.
There are numerous other sources of IR codes, such as iRule and RemoteCentral.

8
_addons_bindings/gpstracker/readme.md
View File

@ -3,7 +3,7 @@ id: gpstracker
label: GPSTracker
title: GPSTracker - Bindings
type: binding
description: "This binding allows you to connect mobile GPS tracker applications to openHAB and process GPS location reports. Currently two applications are supported:"
description: "This binding allows you to connect mobile GPS tracker applications to openHAB and process GPS location reports."
since: 2x
logo: images/addons/gpstracker.png
install: auto
@ -15,14 +15,16 @@ install: auto
# GPSTracker Binding
This binding allows you to connect mobile GPS tracker applications to openHAB and process GPS location reports. Currently two applications are supported:
This binding allows you to connect mobile GPS tracker applications to openHAB and process GPS location reports.
Currently two applications are supported:
* [OwnTracks](https://owntracks.org/booklet/) - iOS, Android
* [GPSLogger](https://gpslogger.app/) - Android
GPS location reports are sent to openHAB using HTTP.
Please be aware that this communication uses the public network so make sure your openHAB installation is [secured](https://www.openhab.org/docs/installation/security.html#encrypted-communication) (but accessible from public internet through myopenhab.org or using a reverse proxy) and you configured HTTP**S** access in tracking applications.
The easiest way to achieve this is to use the [openHAB Cloud Connector](https://www.openhab.org/addons/integrations/openhabcloud/) in conjunction with [myopenHAB.org](http://www.myopenhab.org/).
The easiest way to achieve this is to use the [openHAB Cloud Connector](https://www.openhab.org/addons/integrations/openhabcloud/) in conjunction with [myopenHAB.org](https://www.myopenhab.org/).
The binding can process two message types received from trackers:

4
_addons_bindings/groheondus/readme.md
View File

@ -39,7 +39,7 @@ This binding does not require any configuration outside of things.
## Thing Configuration
There's only one thing and one bridge that needs to be configured together to get this binding to work, see the full example section for a self-explaining example.
There is only one thing and one bridge that needs to be configured together to get this binding to work, see the full example section for a self-explaining example.
### Account Bridge
@ -118,7 +118,7 @@ Number Humidity_Sense "Humidity [%.1f %unit%]" {channel="groheondus:sense:groheo
Actually obtaining a `refresh token` from the GROHE ONDUS Api requires some manual steps.
In order to more deeply understand what is happening during the process, you can read more information about the OAuth2/OIDC (OpenID Connect) login flow by searching for these terms in your favorite search engine.
Here's a short step-by-step guide on how to obtain a refresh token:
Here is a short step-by-step guide on how to obtain a refresh token:
1. Open a new tab in your Internet browser
2. Open the developer console of your browser (mostly possible by pressing F12)

10
_addons_bindings/harmonyhub/readme.md
View File

@ -3,7 +3,7 @@ id: harmonyhub
label: Logitech Harmony Hub
title: Logitech Harmony Hub - Bindings
type: binding
description: "The Harmony Hub binding is used to enable communication between openHAB2 and multiple Logitech Harmony Hub devices."
description: "The Harmony Hub binding is used to enable communication between openHAB and multiple Logitech Harmony Hub devices."
since: 2x
logo: images/addons/harmonyhub.png
install: auto
@ -15,12 +15,12 @@ install: auto
# Logitech Harmony Hub Binding
The Harmony Hub binding is used to enable communication between openHAB2 and multiple Logitech Harmony Hub devices.
The Harmony Hub binding is used to enable communication between openHAB and multiple Logitech Harmony Hub devices.
The API exposed by the Harmony Hub is relatively limited, but it does allow for reading the current activity as well as setting the activity and sending device commands.
## Overview
The Harmony binding represents a "Hub" as a bridge thing type and "Devices" as things connected to the bridge.
The Harmony binding represents a "Hub" as a bridge thing type and "Devices" as things connected to the bridge.
### Hub
@ -87,8 +87,8 @@ String HarmonyGreatRoomActivity "Current Activity [%s]" (gMain) {
Hubs can also send a button press to a device associated with the current activity.
A String item can be used to send any button name/label or a Player item can be used to send Play/Pause/FastForward/Rewind/SkipForward/SkipBackward.
This mimics the physical remote where buttons are mapped differently depending on which activity is running.
For example the play button may be sent to a DVD player when running a "Watch DVD" activity, or it may be sent to a AppleTV when running a "Watch Movie" activity.
This mimics the physical remote where buttons are mapped differently depending on which activity is running.
For example the play button may be sent to a DVD player when running a "Watch DVD" activity, or it may be sent to an Apple TV when running a "Watch Movie" activity.
```java

4
_addons_bindings/hdanywhere/readme.md
View File

@ -3,7 +3,7 @@ id: hdanywhere
label: HDanywhere
title: HDanywhere - Bindings
type: binding
description: "This binding integrates with [HDanywhere](http://www.hdanywhere.co.uk) HDMI matrices."
description: "This binding integrates with [HDanywhere](https://www.hdanywhere.co.uk) HDMI matrices."
since: 2x
logo: images/addons/hdanywhere.png
install: auto
@ -15,7 +15,7 @@ install: auto
# HDanywhere Binding
This binding integrates with [HDanywhere](http://www.hdanywhere.co.uk) HDMI matrices.
This binding integrates with [HDanywhere](https://www.hdanywhere.co.uk) HDMI matrices.
HDanywhere is a manufacturer of multiroom/distributed audio/video equipment.
This binding supports their V3 of the Multiroom+ HDMI matrix running firmware V1.2(20131222), as well as the newer MHUB series of matrices.

6
_addons_bindings/hdpowerview/readme.md
View File

@ -3,7 +3,7 @@ id: hdpowerview
label: Hunter Douglas PowerView
title: Hunter Douglas PowerView - Bindings
type: binding
description: "This is an openHAB binding for the [Hunter Douglas PowerView Motorized Shades](http://www.hunterdouglas.com/operating-systems/powerview-motorization/support) via the PowerView Hub."
description: "This is an openHAB binding for the [Hunter Douglas PowerView Motorized Shades](https://www.hunterdouglas.com/operating-systems/motorized/powerview-motorization/overview) via the PowerView Hub."
since: 2x
logo: images/addons/hdpowerview.png
install: auto
@ -15,7 +15,7 @@ install: auto
# Hunter Douglas PowerView Binding
This is an openHAB binding for the [Hunter Douglas PowerView Motorized Shades](http://www.hunterdouglas.com/operating-systems/powerview-motorization/support) via the PowerView Hub.
This is an openHAB binding for the [Hunter Douglas PowerView Motorized Shades](https://www.hunterdouglas.com/operating-systems/motorized/powerview-motorization/overview) via the PowerView Hub.
PowerView shades have motorization control for their vertical position, as well as vane controls on the shade's slats.
Make sure your Shades are visible in the dedicated PowerView app before attempting discovery.
@ -32,7 +32,7 @@ By using a Scene to control multiple shades at once, the shades will all begin m
## Discovery
The PowerView Hub is discovered via a NetBios query.
The PowerView Hub is discovered via a NetBIOS query.
This is the same method used by the dedicated PowerView app.
After the Hub is added, Shades and Scenes will be discovered by querying the Hub.

11
_addons_bindings/helios/readme.md
View File

@ -3,7 +3,7 @@ id: helios
label: Helios
title: Helios - Bindings
type: binding
description: "This binding integrates the Heliop door/videophone system (http://www.2n.cz)."
description: "This binding integrates the Heliop door/videophone system (https://www.2n.cz)."
since: 2x
install: auto
---
@ -14,7 +14,7 @@ install: auto
# Helios Binding
This binding integrates the Heliop door/videophone system (http://www.2n.cz).
This binding integrates the Heliop door/videophone system (https://www.2n.cz).
## Supported Things
@ -56,12 +56,13 @@ In addition, devices running the v2.13 firmware support the following channels a
| Channel Type ID | Item Type | Description |
|-----------------|-----------|-------------------------------------------------------------------------------|
| audiolooptest | Switch | Initiate a audio loop test |
| audiolooptest | Switch | Initiate an audio loop test |
| motion | Switch | Indicates if motion was detected by the videophone |
| noise | Switch | Indicates if noise was detected by the videophone |
| switchstate | Switch | Indicates the state of an internal switch in the videophone |
For most of the channels a "stamp" channel (of Type DateTime) (e.g. "keypressedstamp") is available and will be updated with the time stamp the relevant event happened on the device. For switchstate, there are as well the switchstateswitch and switchstateoriginator channels indicating the number of the switch that changed state (1 to 4, depending on the hardware configuration) and the source of the switch state change (keypad, DTMF signal,...)
For most of the channels a "stamp" channel (of Type DateTime) (e.g. "keypressedstamp") is available and will be updated with the time stamp the relevant event happened on the device.
For switchstate, there are as well the switchstateswitch and switchstateoriginator channels indicating the number of the switch that changed state (1 to 4, depending on the hardware configuration) and the source of the switch state change (keypad, DTMF signal,...)
## Full Example
@ -91,6 +92,6 @@ when
Channel "helios:ipvario221:gate:keypressed" triggered
then
var actionName = receivedEvent.getEvent()
logInfo("org.openhab","Rule trigger " + actionName)
logInfo("org.openhab","Rule trigger " + actionName)
end
```

37
_addons_bindings/homematic/readme.md
View File

@ -37,7 +37,7 @@ Also the IP of the device running openHAB has to be set to the list of "IP addre
Also under `Home page > Settings > Control panel` with the menu `Security` the option `Authentication` has to be disabled as the binding does not support the configuration of `username` and `password`for the XML-RPC API.
If this is not done the binding won't be able to connect to the CCU and the CCU Thing will stay uninitialized and sets a timeout exception:
If this is not done the binding will not be able to connect to the CCU and the CCU Thing will stay uninitialized and sets a timeout exception:
```
xxx-xx-xx xx:xx:xx.xxx [hingStatusInfoChangedEvent] - - 'homematic:bridge:xxx' changed from INITIALIZING to OFFLINE (COMMUNICATION_ERROR): java.net.SocketTimeoutException: Connect Timeout
@ -119,11 +119,15 @@ The difference is, that variables, scripts and device names are not supported, e
### Automatic install mode during discovery
Besides discovering devices that are already known by the gateway, it may be desired to connect new devices to your system - which requires your gateway to be in install mode. Starting the binding's DiscoveryService will automatically put your gateway(s) in install mode for a specified period of time (see installModeDuration).
Besides discovering devices that are already known by the gateway, it may be desired to connect new devices to your system - which requires your gateway to be in install mode.
Starting the binding's DiscoveryService will automatically put your gateway(s) in install mode for a specified period of time (see installModeDuration).
**Note:** Enabling / disabling of install mode is also available via GATEWAY-EXTRAS. You may use this if you prefer.
**Note:** Enabling / disabling of install mode is also available via GATEWAY-EXTRAS.
You may use this if you prefer.
**Exception:** If a gateway is not ONLINE, the install mode will not be set automatically. For instance during initialization of the binding its DiscoveryService is started and will discover devices that are already connected. However, the install mode is not automatically enabled in this situation because the gateway is in the status INITIALIZING.
**Exception:** If a gateway is not ONLINE, the install mode will not be set automatically.
For instance during initialization of the binding its DiscoveryService is started and will discover devices that are already connected.
However, the install mode is not automatically enabled in this situation because the gateway is in the status INITIALIZING.
## Bridge Configuration
@ -271,7 +275,7 @@ The disadvantage is of course, that all events for this channel are delayed.
}
```
The `Type` is the device type, channel number and lowercase channel name separated with a underscore.
The `Type` is the device type, channel number and lowercase channel name separated with an underscore.
Note that, for Homegear devices, in contrast to the specification of the Rhing above no `HG-` prefix is needed for the specification of the Type of the Channel.
The channel configs are optional.
@ -326,7 +330,7 @@ A virtual datapoint (Switch) to reload all values for all devices, available in
### RELOAD_RSSI
A virtual datapoint (Switch) to reload all rssi values for all devices, available in channel 0 in GATEWAY-EXTRAS
A virtual datapoint (Switch) to reload all RSSI values for all devices, available in channel 0 in GATEWAY-EXTRAS
### RSSI
@ -358,7 +362,7 @@ A virtual datapoint (Enum) to configure the device deletion with DELETE_MODE, av
### ON_TIME_AUTOMATIC
A virtual datapoint (Number) to automatically set the ON_TIME datapoint before the STATE or LEVEL datapoint is sent to the gateway, available for all devices which supports the ON_TIME datapoint.
This is usefull to automatically turn off the datapoint after the specified time.
This is useful to automatically turn off the datapoint after the specified time.
### DISPLAY_OPTIONS
@ -505,10 +509,12 @@ If you can't disable security try to use key INSTALL_TEST which gets updated to
**-1 Failure**
A device may return this failure while fetching the datapoint values.
I've tested pretty much but i did not found the reason. The HM-ES-TX-WM device for example always returns this failure, it's impossible with the current CCU2 firmware (2.17.15) to fetch the values.
I've implemented two workarounds, if a device returns the failure, workaround one is executed, if the device still returns the failure, workaround two is executed.
This always works in my tests, but you may see a OFFLINE, ONLINE cycle for the device.
Fetching values is only done at startup or if you trigger a REFRESH. I hope this will be fixed in one of the next CCU firmwares.
I have tested pretty much but I did not find the reason.
The HM-ES-TX-WM device for example always returns this failure, it is impossible with the current CCU2 firmware (2.17.15) to fetch the values.
I have implemented two workarounds, if a device returns the failure, workaround one is executed, if the device still returns the failure, workaround two is executed.
This always works in my tests, but you may see an OFFLINE, ONLINE cycle for the device.
Fetching values is only done at startup or if you trigger a REFRESH.
I hope this will be fixed in one of the next CCU firmwares.
With [Homegear](https://www.homegear.eu) everything works as expected.
**No variables and scripts in GATEWAY-EXTRAS**
@ -518,10 +524,10 @@ Use the ```gatewayType=ccu``` config to force the binding to use the CCU impleme
**Variables out of sync**
The CCU only sends a event if a datapoint of a device has changed.
There is (currently) no way to receive a event automatically when a variable has changed.
The CCU only sends an event if a datapoint of a device has changed.
There is (currently) no way to receive an event automatically when a variable has changed.
To reload all variable values, send a REFRESH command to any variable.
e.g you have a item linked to a variable with the name Var_1
e.g you have an item linked to a variable with the name Var_1
In the console:
```shell
@ -536,7 +542,8 @@ import org.eclipse.smarthome.core.types.RefreshType
Var_1.sendCommand(RefreshType.REFRESH)
```
**Note:** adding new and removing deleted variables from the GATEWAY-EXTRAS Thing is currently not supported. You have to delete the Thing, start a scan and add it again.
**Note:** adding new and removing deleted variables from the GATEWAY-EXTRAS Thing is currently not supported.
You have to delete the Thing, start a scan and add it again.
### Debugging and Tracing

4
_addons_bindings/hue/readme.md
View File

@ -3,7 +3,7 @@ id: hue
label: Philips Hue
title: Philips Hue - Bindings
type: binding
description: "This binding integrates the [Philips Hue Lighting system](http://www.meethue.com)."
description: "This binding integrates the [Philips Hue Lighting system](https://www.meethue.com)."
since: 2x
logo: images/addons/hue.png
install: auto
@ -15,7 +15,7 @@ install: auto
# Philips Hue Binding
This binding integrates the [Philips Hue Lighting system](http://www.meethue.com).
This binding integrates the [Philips Hue Lighting system](https://www.meethue.com).
The integration happens through the Hue bridge, which acts as an IP gateway to the ZigBee devices.
![Philips Hue](doc/hue.jpg)

18
_addons_bindings/iaqualink/readme.md
View File

@ -17,13 +17,13 @@ install: auto
This binding supports:
* Any iAquaLink based pool system
* Reading auxiliary, temperature, pump, chemistry and system values
* Reading auxiliary, temperature, pump, chemistry and system values
* Controlling system, auxiliary, lighting, and temperature settings
## Binding Configuration
The binding requires the iAquaLink user name and password.
If you have more then one pool system registered to an account, you may optionally specify the pool serial ID/Number to use, otherwise the first pool controller will be used.
The binding requires the iAquaLink user name and password.
If you have more then one pool system registered to an account, you may optionally specify the pool serial ID/Number to use, otherwise the first pool controller will be used.
## Manual Thing Configuration
@ -35,12 +35,14 @@ Thing iaqualink:controller:pool [ userName="user@domain.com", password="somepass
## Channels
The following is a list of supported channels.
The following is a list of supported channels.
Auxiliary and OneTouch channels will be dynamically added depending on what a system reports as being supported.
Auxiliary channels that are of a number type represent lighting modes (typically 0-15), Auxiliary channels that are dimmer types can set the light value in increments of 25 (0,25,50,750,100). The Auxiliary channel type will be dynamically assigned based on the controller configuration.
Auxiliary channels that are of a number type represent lighting modes (typically 0-15).
Auxiliary channels that are dimmer types can set the light value in increments of 25 (0,25,50,750,100).
The Auxiliary channel type will be dynamically assigned based on the controller configuration.
Heater status can be OFF (0), Enabled/ON (3), or Heating (1).
Heater status can be OFF (0), Enabled/ON (3), or Heating (1).
| Channel Type ID | Item Type |
|---------------------|----------------------------|
@ -74,11 +76,11 @@ Heater status can be OFF (0), Enabled/ON (3), or Heating (1).
### Color/Mood Auxiliary Channels
String auxiliary channels can control a variety of lighting moods/colors depending on what type of lighting system is installed.
The following is a table of aux_n channel values (String) to lighting set descriptions values.
The following is a table of aux_n channel values (String) to lighting set descriptions values.
The binding will automatically detect which color system is enabled and add the appropriate channel type with the following option labels.
Colors can be set, but only On or Off is reported back as the current state of the channel.
| String Value | jandy Color | Jandy Led Water Colors | Pentair SAm/SAL | Hayward Universal | Pentair intelliBrite |
| String Value | jandy Color | Jandy LED Water Colors | Pentair SAm/SAL | Hayward Universal | Pentair intelliBrite |
|--------------|----------------|------------------------|-----------------|-------------------|----------------------|
| "off" | Off | Off | Off | Off | Off |
| "on" | On | On | On | On | On |

4
_addons_bindings/icloud/readme.md
View File

@ -23,7 +23,7 @@ An Apple account is required.
Two factor authentication is supported.
Please note: Application specific passwords are not supported.
You'll need to provide the account password to the Binding.
You will need to provide the account password to the Binding.
## Discovery
@ -112,7 +112,7 @@ sitemap icloud label="iCloud" {
Text item=iPhone_LocationLastUpdate
Switch item=iPhone_FindMyPhone mappings=[ ON="Find!" ]
Switch item=iPhone_Refresh mappings=[ REFRESH='Refresh now' ]
// Mapview for BasicUI and Applications (Android/iOS)
// Mapview for Basic UI and Applications (Android/iOS)
Mapview item=iPhone_Location height=10
}
}

2
_addons_bindings/ihc/readme.md
View File

@ -81,7 +81,7 @@ Channel parameters:
| direction | Text | no | ReadWrite | Direction of the channel (ReadWrite, WriteOnly, ReadOnly). |
| commandToReact | String | no | | Command to react. If not defined, channel react to all commands. |
| pulseWidth | Integer | no | | Pulse width in milliseconds. If defined, binding send pulse rather than command value to IHC controller. |
| inverted | Boolean | no | false | OpenHAB state is inverted compared to IHC output/input signal. |
| inverted | Boolean | no | false | openHAB state is inverted compared to IHC output/input signal. |
| serialNumber | Integer | yes | | Serial number of RF device in decimal format. |
| longPressTime | Integer | yes | 1000 | Long press time in milliseconds. |

12
_addons_bindings/innogysmarthome/readme.md
View File

@ -3,7 +3,7 @@ id: innogysmarthome
label: innogy SmartHome
title: innogy SmartHome - Bindings
type: binding
description: "The binding integrates the [innogy SmartHome](http://innogy.com/smarthome) system into openHAB."
description: "The binding integrates the [innogy SmartHome](https://innogy.com/smarthome) system into openHAB."
since: 2x
logo: images/addons/innogysmarthome.png
install: auto
@ -15,7 +15,7 @@ install: auto
# innogy SmartHome Binding
The binding integrates the [innogy SmartHome](http://innogy.com/smarthome) system into openHAB.
The binding integrates the [innogy SmartHome](https://innogy.com/smarthome) system into openHAB.
It uses the official API as provided by innogy as cloud service.
As all status updates and commands have to go through the API, a permanent internet connection is required.
Currently there is no API for a direct communication with the innogy SmartHome Controller (SHC).
@ -242,15 +242,15 @@ end
## Resolving certificate issues
If the bridge stays offline with the following status shown in the PaperUI, the reason could be an expired certificate:
If the bridge stays offline with the following status shown in the Paper UI, the reason could be an expired certificate:
`OFFLINE - COMMUNICATION_ERROR sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target`
To solve this on a linux system, follow this steps:
To solve this on a Linux system, follow this steps:
1. Download the certificates (.cer-files) of https://home.innogy-smarthome.de and https://innogy.com including the "DigiCert Global Root G2" to your computer.
As this depends on the usen browser and operating system, please google on how to achieve this for your situation.
2. On your linux system, goto your Java Machine's certificate store, e.g. `/usr/lib/jvm/jdk-8-oracle-arm32-vfp-hflt/jre/lib/security`.
As this depends on the usen browser and operating system, please use a web search engine to find out how to achieve this for your situation.
2. On your Linux system, goto your Java Machine's certificate store, e.g. `/usr/lib/jvm/jdk-8-oracle-arm32-vfp-hflt/jre/lib/security`.
The path should include a file called `cacerts` (this is the certificate store) and may differ depending on the system used.
3. Copy the .cer-files from step 1 into this directory.
4. Import each certificate with the command: `sudo keytool –importcert –alias “innogysmarthome” –keystore cacerts –file innogy.cer`

6
_addons_bindings/irtrans/readme.md
View File

@ -45,8 +45,8 @@ The *ethernet* Thing supports the following Channel Types:
| Channel Type ID | Item Type | Description |
|-----------------|-----------|-------------------------------------------------------------------------------------|
| blaster | String | Send (filtered) infrared commands over the specified blaster led of the transceiver |
| receiver | String | Receive (filtered) infrared commands on the receiver led of the transceiver |
| blaster | String | Send (filtered) infrared commands over the specified blaster LED of the transceiver |
| receiver | String | Receive (filtered) infrared commands on the receiver LED of the transceiver |
The *blaster* Channel Type requires a *led* configuration parameter to specify on which infrared commands will be emitted, *remote* the remote or manufacturer name which's commands will be allowed, as defined in the IRtrans server database that is flashed into the transceiver (can be '*' for 'any' remote), and *command* the name of the command will be allowed, as defined in the IRtrans server database that is flashed into the transceiver (can be '*' for 'any' command).
@ -83,7 +83,7 @@ Type blaster : appletv [led="3", remote="appletv", command="*"]
}
```
In the above channel a single IRtrans transceiver has 3 output leds in use, 2 to drive 2 DTV SetTopBoxes, and a third one to drive an Apple TV device.
In the above channel a single IRtrans transceiver has 3 output LEDs in use, 2 to drive 2 DTV SetTopBoxes, and a third one to drive an Apple TV device.
demo.items:

4
_addons_bindings/keba/readme.md
View File

@ -3,7 +3,7 @@ id: keba
label: Keba
title: Keba - Bindings
type: binding
description: "This binding integrates the [Keba KeContact EV Charging Stations](http://www.keba.com)."
description: "This binding integrates the [Keba KeContact EV Charging Stations](https://www.keba.com)."
since: 2x
logo: images/addons/keba.png
install: auto
@ -15,7 +15,7 @@ install: auto
# Keba Binding
This binding integrates the [Keba KeContact EV Charging Stations](http://www.keba.com).
This binding integrates the [Keba KeContact EV Charging Stations](https://www.keba.com).
## Supported Things

16
_addons_bindings/km200/readme.md
View File

@ -17,23 +17,23 @@ install: auto
The KM200 Binding is communicating with a [Buderus Logamatic web KM200 / KM100 / KM50](https://www.buderus.de/de/produkte/catalogue/alle-produkte/7719_gateway-logamatic-web-km200-km100-km50).
It is possible to receive and send parameters like string or float values.
**Important**: If the communication is not working and you see in the logfile errors like "illegal key size" then you have to change the [Java Cryptography Extension to the Unlimited Strength Jurisdiction](http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html).
**Important**: If the communication is not working and you see in the logfile errors like "illegal key size" then you have to change the [Java Cryptography Extension to the Unlimited Strength Jurisdiction](https://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html).
## Supported Things
This binding supports 11 different things types
| Thing | Paper UI Only | Description |
| ------------------ | ------------ |----------------------------------------------------------- |
| `appliance` | | The appliance (The heater inside of this heating system). |
| `dhwCircuit` | | A hot water circuit. |
| `gateway` | | The gateway. (The connected KM200/100/50 device). |
| Thing | Paper UI Only | Description |
| ---------------- | ------------- |---------------------------------------------------------- |
| `appliance` | | The appliance (The heater inside of this heating system). |
| `dhwCircuit` | | A hot water circuit. |
| `gateway` | | The gateway. (The connected KM200/100/50 device). |
| `heatingCircuit` | | A heating circuit. |
| `heatSource` | | The heat source. |
| `holidayMode` | | The holiday modes configuration. |
| `sensor` | | The sensors. |
| `sensor` | | The sensors. |
| `solarCircuit` | | A solar circuit. |
| `system` | | The system without sensors and appliance. |
| `system` | | The system without sensors and appliance. |
| `notification` | | The notifications. |
| `switchProgram` | X | A switch program. |

46
_addons_bindings/knx/readme.md
View File

@ -3,7 +3,7 @@ id: knx
label: KNX
title: KNX - Bindings
type: binding
description: "The openHAB KNX binding allows to connect to [KNX Home Automation](http://www.knx.org/) installations. Switching lights on and off, activating your roller shutters or changing room temperatures are only some examples."
description: "The openHAB KNX binding allows to connect to [KNX Home Automation](https://www.knx.org/) installations."
since: 2x
logo: images/addons/knx.png
install: auto
@ -16,13 +16,19 @@ install: auto
# KNX Binding
The openHAB KNX binding allows to connect to [KNX Home Automation](http://www.knx.org/) installations. Switching lights on and off, activating your roller shutters or changing room temperatures are only some examples.
The openHAB KNX binding allows to connect to [KNX Home Automation](https://www.knx.org/) installations.
Switching lights on and off, activating your roller shutters or changing room temperatures are only some examples.
To access your KNX bus you either need a gateway device which is connected to the KNX bus and allows computers to access the bus communication. This can be either an Ethernet (as a Router or a Tunnel type) or a serial gateway. The KNX binding then can communicate directly with this gateway. Alternatively a PC running [KNXD](https://github.com/knxd/knxd) (free open source component sofware) can be put in between which then acts as a broker allowing multiple client to connect to the same gateway. Since the protocol is identical, the KNX binding can also communicate with it transparently.
To access your KNX bus you either need a gateway device which is connected to the KNX bus and allows computers to access the bus communication.
This can be either an Ethernet (as a Router or a Tunnel type) or a serial gateway.
The KNX binding then can communicate directly with this gateway.
Alternatively a PC running [KNXD](https://github.com/knxd/knxd) (free open source component sofware) can be put in between which then acts as a broker allowing multiple client to connect to the same gateway.
Since the protocol is identical, the KNX binding can also communicate with it transparently.
## Supported Things
The KNX binding supports two types of bridges, and one type of things to access the KNX bus. There is an *ip* bridge to connect to KNX IP Gateways, and a *serial* bridge for connection over a serial port to a host-attached gateway.
The KNX binding supports two types of bridges, and one type of things to access the KNX bus.
There is an *ip* bridge to connect to KNX IP Gateways, and a *serial* bridge for connection over a serial port to a host-attached gateway.
## Binding Configuration
@ -39,7 +45,7 @@ The IP Gateway is the most commonly used way to connect to the KNX bus. At its b
| Name | Required | Description | Default value |
|---------------------|--------------|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| type | Yes | The IP connection type for connecting to the KNX bus (`TUNNEL` or `ROUTER`) | - |
| ipAddress | for `TUNNEL` | Network address of the KNX/IP gateway. If type `ROUTER` is set, the IPv4 Multicast Address can be set. | for `TUNNEL`: \<nothing\>, for `ROUTER`: 224.0.23.12 |
| ipAddress | for `TUNNEL` | Network address of the KNX/IP gateway. If type `ROUTER` is set, the IPv4 Multicast Address can be set. | for `TUNNEL`: \<nothing\>, for `ROUTER`: 224.0.23.12 |
| portNumber | for `TUNNEL` | Port number of the KNX/IP gateway | 3671 |
| localIp | No | Network address of the local host to be used to set up the connection to the KNX/IP gateway | the system-wide configured primary interface address |
| localSourceAddr | No | The (virtual) individual address for identification of this KNX/IP gateway within the KNX bus <br/><br/>Note: Use a free adress, not the one of the interface. Or leave it at `0.0.0` and let openHAB decide which address to use. | 0.0.0 |
@ -66,7 +72,11 @@ The *serial* bridge accepts the following configuration parameters:
### *device* Things
*basic* Things are wrappers around an arbitrary group addresses on the KNX bus. They have no specific function in the KNX binding, except that if the *address* is defined the binding will actively poll the Individual Address on the KNX bus to detect that the KNX actuator is reachable. Under normal real world circumstances, either all devices on a bus are reachable, or the entire bus is down. When *fetch* is set to true, the binding will read-out the memory of the KNX actuator in order to detect configuration data and so forth. This is however an experimental feature very prone to the actual on the KNX bus.
*basic* Things are wrappers around an arbitrary group addresses on the KNX bus.
They have no specific function in the KNX binding, except that if the *address* is defined the binding will actively poll the Individual Address on the KNX bus to detect that the KNX actuator is reachable.
Under normal real world circumstances, either all devices on a bus are reachable, or the entire bus is down.
When *fetch* is set to true, the binding will read-out the memory of the KNX actuator in order to detect configuration data and so forth.
This is however an experimental feature very prone to the actual on the KNX bus.
| Name | Required | Description | Default value |
|--------------|----------|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
@ -75,11 +85,14 @@ The *serial* bridge accepts the following configuration parameters:
| pingInterval | N | Interval (in seconds) to contact the device and set the thing status based on the result (requires the address) | 600 |
| readInterval | N | Interval (in seconds) to actively request reading of values from the bus (0 if they should only be read once at startup) | 0 |
Different kinds of channels are defined and can be used to group together Group Addresses. All channel types share two configuration parameters: *read*, an optional parameter to indicate if the 'readable' group addresses of that Channel should be read at startup (default: false), and *interval*, an optional parameter that defines an interval between attempts to read the status group address on the bus, in seconds. When defined and set to 0, the interval is ignored (default: 0)
Different kinds of channels are defined and can be used to group together Group Addresses.
All channel types share two configuration parameters: *read*, an optional parameter to indicate if the 'readable' group addresses of that Channel should be read at startup (default: false), and *interval*, an optional parameter that defines an interval between attempts to read the status group address on the bus, in seconds.
When defined and set to 0, the interval is ignored (default: 0)
#### Standard Channel Types
Standard channels are used most of the time. They are used in the common case where the physical state is owned by a decive within the KNX bus, e.g. by a switch actuator who "knows" whether the light is turned on or of or by a temperature sensor which reports the room temperature regularly.
Standard channels are used most of the time.
They are used in the common case where the physical state is owned by a decive within the KNX bus, e.g. by a switch actuator who "knows" whether the light is turned on or of or by a temperature sensor which reports the room temperature regularly.
Note: After changing the DPT of already existing Channels, openHAB needs to be restarted for the changes to become effective.
@ -133,7 +146,9 @@ Note: After changing the DPT of already existing Channels, openHAB needs to be r
#### Control Channel Types
In contrast to the standard channels above, the control channel types are used for cases where the KNX bus does not own the physical state of a device. This could be the case if e.g. a lamp from another binding should be controlled by a KNX wall switch. If from the KNX bus a `GroupValueRead` telegram is sent to a *-control Channel, the bridge responds with a `GroupValueResponse` telegram to the KNX bus.
In contrast to the standard channels above, the control channel types are used for cases where the KNX bus does not own the physical state of a device.
This could be the case if e.g. a lamp from another binding should be controlled by a KNX wall switch.
If from the KNX bus a `GroupValueRead` telegram is sent to a *-control Channel, the bridge responds with a `GroupValueResponse` telegram to the KNX bus.
##### Channel Type "switch-control"
@ -200,9 +215,14 @@ The `dpt` element is optional. If ommitted, the corresponding default value will
## Examples
The following two templates are sufficient for almost all purposes. Only add parameters to the Bridge and Thing configuration if you know exactly what functionality it is needed for.
The following two templates are sufficient for almost all purposes.
Only add parameters to the Bridge and Thing configuration if you know exactly what functionality it is needed for.
### Type ROUTER mode configuration Template
knx.things:
```xtend
Bridge knx:ip:bridge [
type="ROUTER",
@ -215,8 +235,11 @@ Bridge knx:ip:bridge [
}
}
```
### Type TUNNEL mode configuration Template
knx.things:
```xtend
Bridge knx:ip:bridge [
type="TUNNEL",
@ -230,7 +253,9 @@ Bridge knx:ip:bridge [
}
}
```
### Full Example
```xtend
//TUNNEL
Bridge knx:ip:bridge [
@ -305,7 +330,6 @@ sitemap knx label="KNX Demo Sitemap" {
### Control Example
control.things:
```xtend

2
_addons_bindings/kodi/readme.md
View File

@ -41,7 +41,7 @@ To make use of the auto-discovery feature, you additionally need to enable "Allo
This binding provides only one thing type: The Kodi media center.
Create one Kodi thing per Kodi instance available in your home automation system.
All Kodi devices are registered as an audio sink in the ESH/openHAB2 framework.
All Kodi devices are registered as an audio sink in openHAB.
## Discovery

4
_addons_bindings/konnected/readme.md
View File

@ -33,7 +33,7 @@ The binding will then create things for each module discovered which can be adde
The binding attempts to discover The Konnected Alarm Panels via the UPnP service.
The auto-discovery service of the binding will detect the ip address and port of the Konnected Alarm Panel.
The binding will attempt to obtain the ip address of your openHAB server as configured in the OSGI framework.
The binding will attempt to obtain the ip address of your openHAB server as configured in the OSGi framework.
However, if it is unable to determine the ip address it will also attempt to use the network address service to obtain the ip address and port.
In addition you can also turn off discovery which when this setting is synced to the module will cause the device to no longer respond to UPnP requests as documented.
https://help.konnected.io/support/solutions/articles/32000023968-disabling-device-discovery
@ -70,7 +70,7 @@ These parameters will tell the module to pulse the actuator for certain time per
A momentary switch actuates a switch for a specified time (in milliseconds) and then reverts it back to the off state.
This is commonly used with a relay module to actuate a garage door opener, or with a door bell to send a momentary trigger to sound the door bell.
A beep/blink switch is like a momentary switch that repeats either a specified number of times or indefinitely.
This is commonly used with a a piezo buzzer to make a "beep beep" sound when a door is opened, or to make a repeating beep pattern for an alarm or audible warning.
This is commonly used with a piezo buzzer to make a "beep beep" sound when a door is opened, or to make a repeating beep pattern for an alarm or audible warning.
It can also be used to blink lights.
DSB1820 temperature probes.

4
_addons_bindings/kostalinverter/readme.md
View File

@ -170,7 +170,9 @@ All third generation inverters require to define 3 mandatory configuration param
| refreshInternalInSeconds | Defines how often the device is polled for new values | Integer | Seconds | 30 | 30 |
If you are using the hostname instead of the IP address, please make sure your DNS is configuration correctly!
The refresh interval should be chosen wisely. To small interval may led to high workload for the inverter. From my testing I recommend a interval of 30 seconds.
The refresh interval should be chosen wisely.
To small interval may led to high workload for the inverter.
It is recommended to use an interval of 30 seconds.
Full sample of thing configuration:

20
_addons_bindings/lametrictime/readme.md
View File

@ -3,7 +3,7 @@ id: lametrictime
label: LaMetric
title: LaMetric - Bindings
type: binding
description: "The LaMetric binding allows to connect openHab to LaMetric Time connected clock devices, providing following features:"
description: "The LaMetric binding allows to connect openHAB to LaMetric Time connected clock devices, providing following features:"
since: 2x
logo: images/addons/lametrictime.png
install: auto
@ -15,7 +15,7 @@ install: auto
# LaMetric Binding
The LaMetric binding allows to connect openHab to LaMetric Time connected clock devices, providing following features:
The LaMetric binding allows to connect openHAB to LaMetric Time connected clock devices, providing following features:
* Control the LaMetric Time Device
* Control Display Brightness
@ -31,13 +31,13 @@ The device acts as a bridge and is exposed as "LaMetric Time" Thing.
The "LaMetric Time" Thing is directly responsible for device operations which include the display, audio, bluetooth, and notifications.
All apps are implemented as separate things under the bridge.
| App | Thing Type | Description |
|-------------------|--------------|---------------------------------------------------------------|
| Clock | clockApp | Clock that dispays time and date |
| Timer | countdownApp | A countdown timer that counts by seconds |
| Radio | radioApp | Streaming radio player |
| Stopwatch | stopwatchApp | Stopwatch that counts up by seconds |
| Weather | weatherApp | Current weather conditions as well as a forecast |
| App | Thing Type | Description |
|-------------------|--------------|--------------------------------------------------|
| Clock | clockApp | Clock that dispays time and date |
| Timer | countdownApp | A countdown timer that counts by seconds |
| Radio | radioApp | Streaming radio player |
| Stopwatch | stopwatchApp | Stopwatch that counts up by seconds |
| Weather | weatherApp | Current weather conditions as well as a forecast |
## Discovery
@ -140,7 +140,7 @@ They exist as one-way communication only.
## How Tos
The following configuration examples assume the device was added with the thing id `lametrictime:device:demo`.
Replace the thing id in all the configurations with your real thing id which can be looked up via paper UI.
Replace the thing id in all the configurations with your real thing id which can be looked up via Paper UI.
### Notifications

2
_addons_bindings/leapmotion/readme.md
View File

@ -17,7 +17,7 @@ install: auto
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.
In fact, the binding is currently only working on macOS computers with Intel x86 processors.
## Supported Things

4
_addons_bindings/lgtvserial/readme.md
View File

@ -32,8 +32,8 @@ The serial port may be marked "Service only".
Tested and developed with :
- LG 55UF772V (with [this cable adapter](http://www.ebay.com/itm/DB9-9-Pin-Female-To-TRS-3-5mm-Male-Stereo-Serial-Data-Converter-Cable-1-8M-6Ft-/291541959764?)).
- LG 47LK520 with a [serial hat](https://www.buyapi.ca/product/serial-hat-rs232/) on a raspberry pi
- LG 55UF772V (with [this cable adapter](https://www.ebay.com/itm/DB9-9-Pin-Female-To-TRS-3-5mm-Male-Stereo-Serial-Data-Converter-Cable-1-8M-6Ft-/291541959764?)).
- LG 47LK520 with a [serial hat](https://www.buyapi.ca/product/serial-hat-rs232/) on a Raspberry Pi
## Discovery

8
_addons_bindings/lgwebos/readme.md
View File

@ -48,7 +48,7 @@ If LocalIP is not set, the binding will use openHAB's primary IP address, which
TVs are auto discovered through SSDP in the local network.
The binding broadcasts a search message via UDP on the network in order to discover and monitor availability of the TV.
Please note, that if you are running openHAB in a docker container you need to use macvlan or host networking for this binding to work.
Please note, that if you are running openHAB in a Docker container you need to use macvlan or host networking for this binding to work.
## Thing Configuration
@ -62,8 +62,8 @@ Please note that at least one channel must be bound to an item before the bindin
| power | Switch | Current power setting. TV can only be powered off, not on. | RW |
| mute | Switch | Current mute setting. | RW |
| volume | Dimmer | Current volume setting. Setting and reporting absolute percent values only works when using internal speakers. When connected to an external amp, the volume should be controlled using increase and decrease commands. | RW |
| channel | String | Current channel number. | RW |
| channelName | String | Current channel name. | R |
| channel | String | Current channel number. | RW |
| channelName | String | Current channel name. | R |
| toast | String | Displays a short message on the TV screen. See also rules section. | W |
| mediaPlayer | Player | Media control player | W |
| mediaStop | Switch | Media control stop | W |
@ -198,7 +198,7 @@ Example
### showToast(text)
Sends a toast message to a WebOS device with openHab icon.
Sends a toast message to a WebOS device with openHAB icon.
Parameters:

33
_addons_bindings/lifx/readme.md
View File

@ -3,7 +3,7 @@ id: lifx
label: LIFX
title: LIFX - Bindings
type: binding
description: "This binding integrates the [LIFX LED Lights](http://www.lifx.com/). All LIFX lights are directly connected to the WLAN and the binding communicates with them over a UDP protocol."
description: "This binding integrates the [LIFX LED Lights](https://www.lifx.com/)."
since: 2x
logo: images/addons/lifx.png
install: auto
@ -15,7 +15,8 @@ install: auto
# LIFX Binding
This binding integrates the [LIFX LED Lights](http://www.lifx.com/). All LIFX lights are directly connected to the WLAN and the binding communicates with them over a UDP protocol.
This binding integrates the [LIFX LED Lights](https://www.lifx.com/).
All LIFX lights are directly connected to the WLAN and the binding communicates with them over a UDP protocol.
![LIFX E27](doc/lifx_e27.jpg)
@ -48,7 +49,8 @@ The following table lists the thing types of the supported LIFX devices:
| LIFX Mini Day and Dusk | whitelight |
| LIFX Mini White | whitelight |
The thing type determines the capability of a device and with that the possible ways of interacting with it. The following matrix lists the capabilities (channels) for each type:
The thing type determines the capability of a device and with that the possible ways of interacting with it.
The following matrix lists the capabilities (channels) for each type:
| Thing Type | On/Off | Brightness | Color | Color Zone | Color Temperature | Color Temperature Zone | Infrared |
|--------------|:------:|:----------:|:-----:|:----------:|:-----------------:|:----------------------:|:--------:|
@ -59,13 +61,17 @@ The thing type determines the capability of a device and with that the possible
## Discovery
The binding is able to auto-discover all lights in a network over the LIFX UDP protocol. Therefore all lights must be turned on.
The binding is able to auto-discover all lights in a network over the LIFX UDP protocol.
Therefore all lights must be turned on.
*Note:* To get the binding working, all lights must be added to the WLAN network first with the help of the [LIFX smart phone applications](http://www.lifx.com/pages/go). The binding is NOT able to add or detect lights outside the network.
*Note:* To get the binding working, all lights must be added to the WLAN network first with the help of the [LIFX smart phone applications](https://www.lifx.com/pages/app).
The binding is NOT able to add or detect lights outside the network.
## Thing Configuration
Each light needs a Device ID or Host as a configuration parameter. The device ID is printed as a serial number on the light and can also be found within the native LIFX Android or iOS application. But usually the discovery works quite reliably, so that a manual configuration is not needed.
Each light needs a Device ID or Host as a configuration parameter.
The device ID is printed as a serial number on the light and can also be found within the native LIFX Android or iOS application.
But usually the discovery works quite reliably, so that a manual configuration is not needed.
However, in the thing file, a manual configuration looks e.g. like
@ -73,7 +79,8 @@ However, in the thing file, a manual configuration looks e.g. like
Thing lifx:colorlight:living [ deviceId="D073D5A1A1A1", fadetime=200 ]
```
The *fadetime* is an optional thing configuration parameter which configures the time to fade to a new color value (in ms). When the *fadetime* is not configured, the binding uses 300ms as default.
The *fadetime* is an optional thing configuration parameter which configures the time to fade to a new color value (in ms).
When the *fadetime* is not configured, the binding uses 300ms as default.
You can optionally also configure a fixed Host or IP address when lights are in a different subnet and are not discovered.
@ -95,13 +102,19 @@ All devices support some of the following channels:
| temperature | Dimmer | This channel supports adjusting the color temperature from cold (0%) to warm (100%). | colorlight, colorirlight, colormzlight, whitelight |
| temperaturezone | Dimmer | This channel supports adjusting the zone color temperature from cold (0%) to warm (100%). | colormzlight |
The *color* and *brightness* channels have a "Power on brightness" configuration option that is used to determine the brightness when a light is switched on. When it is left empty, the brightness of a light remains unchanged when a light is switched on or off.
The *color* and *brightness* channels have a "Power on brightness" configuration option that is used to determine the brightness when a light is switched on.
When it is left empty, the brightness of a light remains unchanged when a light is switched on or off.
The *color* channels have a "Power on color" configuration option that is used to determine the hue, saturation, brightness levels when a light is switched on. When it is left empty, the color of a light remains unchanged when a light is switched on or off. Configuration options contains 3 comma separated values, where first value is hue (0-360), second saturation (0-100) and third brightness (0-100). If both "Power on brightness" and "Power on color" configuration options are defined, "Power on brightness" option overrides the brightness level defined on the "Power on color" configuration option.
The *color* channels have a "Power on color" configuration option that is used to determine the hue, saturation, brightness levels when a light is switched on.
When it is left empty, the color of a light remains unchanged when a light is switched on or off.
Configuration options contains 3 comma separated values, where first value is hue (0-360), second saturation (0-100) and third brightness (0-100).
If both "Power on brightness" and "Power on color" configuration options are defined, "Power on brightness" option overrides the brightness level defined on the "Power on color" configuration option.
The *temperature* channels have a "Power on temperature" configuration option that is used to determine the color temperature when a light is switched on. When it is left empty, the color temperature of a light remains unchanged when a light is switched on or off.
MultiZone lights (*colormzlight*) have serveral channels (e.g. *colorzone0*, *temperaturezone0*, etc.) that allow for controlling specific zones of the light. Changing the *color* and *temperature* channels will update the states of all zones. The *color* and *temperature* channels of MultiZone lights always return the same state as *colorzone0*, *temperaturezone0*.
MultiZone lights (*colormzlight*) have serveral channels (e.g. *colorzone0*, *temperaturezone0*, etc.) that allow for controlling specific zones of the light.
Changing the *color* and *temperature* channels will update the states of all zones.
The *color* and *temperature* channels of MultiZone lights always return the same state as *colorzone0*, *temperaturezone0*.
## Full Example

32
_addons_bindings/logreader/readme.md
View File

@ -33,31 +33,31 @@ The `reader` Thing has the following configuration parameters:
| ------------------------------| ------- | -------- | -------------------------------- |-----------------------------------------------------------------------------------------|
| `filePath` | String | yes | `${OPENHAB_LOGDIR}/openhab.log` | Path to log file. ${OPENHAB_LOGDIR} is automatically replaced by the correct directory. |
| `refreshRate` | integer | no | `1000` | Time in milliseconds between individual log reads. |
| `errorPatterns` | String | no | `ERROR+` | Search patterns separated by \| character for error events. |
| `errorPatterns` | String | no | `ERROR+` | Search patterns separated by \| character for error events. |
| `errorBlacklistingPatterns` | String | no | | Search patterns for blacklisting unwanted error events separated by \| character. |
| `warningPatterns` | String | no | `WARN+` | Search patterns separated by \| character for warning events. |
| `warningPatterns` | String | no | `WARN+` | Search patterns separated by \| character for warning events. |
| `warningBlacklistingPatterns` | String | no | | Search patterns for blacklisting unwanted warning events separated by \| character. |
| `customPatterns` | String | no | | Search patterns separated by \| character for custom events. |
| `customPatterns` | String | no | | Search patterns separated by \| character for custom events. |
| `customBlacklistingPatterns` | String | no | | Search patterns for blacklisting unwanted custom events separated by \| character. |
Search patterns follows Java regular expression syntax. See https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html.
Search patterns follows Java regular expression syntax. See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.
## Channels
List of channels
| Channel Type ID | Item Type | Description |
| ------------------ | ------------ | -------------------------------------------------------------- |
| `lastErrorEvent` | `String` | Displays content of last [ERROR] event |
| `lastWarningEvent` | `String` | Displays content of last [WARN] event |
| `lastCustomEvent` | `String` | Displays content of last [CUSTOM] event |
| `errorEvents` | `Number` | Displays number of [ERROR] lines matched to search pattern |
| `warningEvents` | `Number` | Displays number of [WARN] lines matched to search pattern |
| `customEvents` | `Number` | Displays number of [CUSTOM] lines matched to search pattern |
| `logRotated` | `DateTime` | Last time when log rotated recognized |
| `newErrorEvent` | - | Trigger channel for last [ERROR] line |
| `newWarningEvent` | - | Trigger channel for last [WARN] line |
| `newCustomEvent` | - | Trigger channel for last [CUSTOM] line |
| Channel Type ID | Item Type | Description |
| ------------------ | ------------ | ----------------------------------------------------------- |
| `lastErrorEvent` | `String` | Displays content of last [ERROR] event |
| `lastWarningEvent` | `String` | Displays content of last [WARN] event |
| `lastCustomEvent` | `String` | Displays content of last [CUSTOM] event |
| `errorEvents` | `Number` | Displays number of [ERROR] lines matched to search pattern |
| `warningEvents` | `Number` | Displays number of [WARN] lines matched to search pattern |
| `customEvents` | `Number` | Displays number of [CUSTOM] lines matched to search pattern |
| `logRotated` | `DateTime` | Last time when log rotated recognized |
| `newErrorEvent` | - | Trigger channel for last [ERROR] line |
| `newWarningEvent` | - | Trigger channel for last [WARN] line |
| `newCustomEvent` | - | Trigger channel for last [CUSTOM] line |
## Examples

8
_addons_bindings/loxone/readme.md
View File

@ -3,7 +3,7 @@ id: loxone
label: Loxone
title: Loxone - Bindings
type: binding
description: "This binding integrates [Loxone Miniserver](https://www.loxone.com/enen/products/miniserver-extensions/) with [openHAB](http://www.openhab.org/)."
description: "This binding integrates [Loxone Miniserver](https://www.loxone.com/enen/products/miniserver-extensions/) with [openHAB](https://www.openhab.org/)."
since: 2x
logo: images/addons/loxone.png
install: auto
@ -15,7 +15,7 @@ install: auto
# Loxone Binding
This binding integrates [Loxone Miniserver](https://www.loxone.com/enen/products/miniserver-extensions/) with [openHAB](http://www.openhab.org/).
This binding integrates [Loxone Miniserver](https://www.loxone.com/enen/products/miniserver-extensions/) with [openHAB](https://www.openhab.org/).
Miniserver is represented as a [Thing](https://www.openhab.org/docs/configuration/things.html). Miniserver controls, that are visible in the Loxone [UI](https://www.loxone.com/enen/kb/user-interface-configuration/), are exposed as openHAB channels.
## Features
@ -29,7 +29,7 @@ The following features are currently supported:
* Updates of openHAB channel's state in runtime according to control's state changes on the Miniserver
* Passing channel commands to the Miniserver's controls
* Hash-based and token-based authentication methods
* Command encryption and response decryption
* Command encryption and response decryption
## Things
@ -201,7 +201,7 @@ Channels have the default tags as follows:
## Advanced Parameters
This section describes the optional advanced parameters that can be configured for a Miniserver. They can be set using UI (e.g. PaperUI) or in a .things file.
This section describes the optional advanced parameters that can be configured for a Miniserver. They can be set using UI (e.g. Paper UI) or in a .things file.
If a parameter is not explicitly defined, binding will use its default value.
To define a parameter value in a .things file, please refer to it by parameter's ID, for example:

65
_addons_bindings/lutron/readme.md
View File

@ -53,6 +53,7 @@ This binding currently supports the following thing types:
* **qsio** - HomeWorks QS IO Interface
* **cco** - Contact closure output module or VCRX CCO
* **shade** - Lutron shade or motorized drape
* **blind** - Lutron venetian blind or horizontal sheer blind [**Experimental**]
* **greenmode** - Green Mode subsystem
* **timeclock** - Scheduling subsystem
@ -173,7 +174,7 @@ You can monitor button channels for ON and OFF state changes to indicate button
Ditto for the indicator LED channels.
Note, however, that version 11.6 or higher of the RadioRA 2 software may be required in order to drive keypad LED states, and then this may only be done on unbound buttons.
Component numbering: For button and LED layouts and numbering, see the Lutron Integration Protocol Guide (rev. AA) p.104 (http://www.lutron.com/TechnicalDocumentLibrary/040249.pdf).
Component numbering: For button and LED layouts and numbering, see the Lutron Integration Protocol Guide (rev. AA) p.104 (https://www.lutron.com/TechnicalDocumentLibrary/040249.pdf).
If you are having problems determining which channels have been created for a given keypad model, click on the thing under Configuration/Things in the Paper UI, or run the command `things show <thingUID>` (e.g. `things show lutron:keypad:radiora2:entrykeypad`) from the openHAB CLI to list the channels.
Supported settings for `model` parameter: H1RLD, H2RLD, H3BSRL, H3S, H4S, H5BRL, H6BRL, HN1RLD, HN2RLD, HN3S, HN3BSRL, HN4S, HN5BRL, HN6BRL, W1RLD, W2RLD, W3BD, W3BRL, W3BSRL, W3S, W4S, W5BRL, W5BRLIR, W6BRL, W7B, Generic (default)
@ -201,7 +202,7 @@ Tabletop seeTouch keypads use the **ttkeypad** thing.
It accepts the same `integrationID`, `model`, and `autorelease` parameters and creates the same channel types as the **keypad** thing.
See the **keypad** section above for a full discussion of configuration and use.
Component numbering: For button and LED layouts and numbering, see the Lutron Integration Protocol Guide (rev. AA) p.110 (http://www.lutron.com/TechnicalDocumentLibrary/040249.pdf).
Component numbering: For button and LED layouts and numbering, see the Lutron Integration Protocol Guide (rev. AA) p.110 (https://www.lutron.com/TechnicalDocumentLibrary/040249.pdf).
If you are having problems determining which channels have been created for a given keypad model, click on the thing under Configuration/Things in the Paper UI, or run the command `things show <thingUID>` (e.g. `things show lutron:ttkeypad:radiora2:bedroomkeypad`) from the openHAB CLI to list the channels.
Supported settings for `model` parameter: T5RL, T10RL, T15RL, T5CRL, T10CRL, T15CRL, Generic (default)
@ -215,14 +216,14 @@ Thing ttkeypad bedroomkeypad [ integrationId=11, model="T10RL" autorelease=true
### International seeTouch Keypads (Homeworks QS)
International seeTouch keypads used in the Homeworks QS system use the **intlkeypad** thing.
It accepts the same `integrationID`, `model`, and `autorelease` parameters and creates the same button and led channel types as the **keypad** thing.
It accepts the same `integrationID`, `model`, and `autorelease` parameters and creates the same button and LED channel types as the **keypad** thing.
See the **keypad** section above for a full discussion of configuration and use.
To support this keypad's contact closure inputs, CCI channels named *cci1* and *cci2* are created with item type Contact and category Switch.
They are marked as Advanced, so they will not be automatically linked to items in the Paper UI's Simple Mode.
They present ON/OFF states the same as a keypad button.
Component numbering: For button and LED layouts and numbering, see the Lutron Integration Protocol Guide (rev. AA) p.107 (http://www.lutron.com/TechnicalDocumentLibrary/040249.pdf).
Component numbering: For button and LED layouts and numbering, see the Lutron Integration Protocol Guide (rev. AA) p.107 (https://www.lutron.com/TechnicalDocumentLibrary/040249.pdf).
If you are having problems determining which channels have been created for a given keypad model, click on the thing under Configuration/Things in the Paper UI, or run the command `things show <thingUID>` (e.g. `things show lutron:intlkeypad:hwprocessor:kitchenkeypad`) from the openHAB CLI to list the channels.
Supported settings for `model` parameter: 2B, 3B, 4B, 5BRL, 6BRL, 7BRL, 8BRL, 10BRL / Generic (default)
@ -240,7 +241,7 @@ It accepts the same `integrationID`, `model`, and `autorelease` parameters and c
The only difference is that no LED channels will be created, since Pico keypads have no indicator LEDs.
See the discussion above for a full discussion of configuration and use.
Component numbering: For button layouts and numbering, see the Lutron Integration Protocol Guide (rev. AA) p.113 (http://www.lutron.com/TechnicalDocumentLibrary/040249.pdf).
Component numbering: For button layouts and numbering, see the Lutron Integration Protocol Guide (rev. AA) p.113 (https://www.lutron.com/TechnicalDocumentLibrary/040249.pdf).
If you are having problems determining which channels have been created for a given keypad model, click on the thing under Configuration/Things in the Paper UI, or run the command `things show <thingUID>` (e.g. `things show lutron:pico:radiora2:hallpico`) from the openHAB CLI to list the channels.
Supported settings for `model` parameter: 2B, 2BRL, 3B, 3BRL, 4B, Generic (default)
@ -261,7 +262,9 @@ In this configuration, the integrated dimmers will appear to openHAB as separate
If your GRAFIK Eye is being used as a stand-alone device and is not integrated in to a RadioRA 2 or HomeWorks QS system, then *this is not the thing you are looking for*.
You should instead be using the **grafikeye** thing (see below).
The **grafikeyekeypad** thing accepts the same `integrationID`, `model`, and `autorelease` parameters and creates the same button, led, and cci, channel types as the other keypad things (see above). The model parameter should be set to indicate whether there are zero, one, two, or three columns of buttons on the left side of the panel. Note that this count does not include the column of 5 scene buttons always found on the right side of the panel.
The **grafikeyekeypad** thing accepts the same `integrationID`, `model`, and `autorelease` parameters and creates the same button, LED, and CCI, channel types as the other keypad things (see above).
The model parameter should be set to indicate whether there are zero, one, two, or three columns of buttons on the left side of the panel.
Note that this count does not include the column of 5 scene buttons always found on the right side of the panel.
To support the GRAFIK Eye's contact closure input, a CCI channel named *cci1* will be created with item type Contact and category Switch.
It is marked as Advanced, so it will not be automatically linked to items in the Paper UI's Simple Mode.
@ -284,7 +287,7 @@ The **virtualkeypad** thing is used to interface to the virtual buttons on the R
These are sometimes referred to in the Lutron documentation as phantom buttons or integration buttons, and are used only for integration.
There are 100 of these virtual buttons, and 100 corresponding virtual indicator LEDs.
The behavior of this binding is the same as the other keypad bindings, with the exception that the button and led channels created have the Advanced flag set.
The behavior of this binding is the same as the other keypad bindings, with the exception that the button and LED channels created have the Advanced flag set.
This means, among other things, that they will not be automatically linked to items in the Paper UI's Simple Mode.
Thing configuration file example:
@ -350,7 +353,7 @@ Each **cco** thing creates one switch channel called *switchstatus*.
For pulsed CCOs, sending an ON command will close the output for the configured pulse time.
Sending an OFF command does nothing.
Because of limitations in RadioRA 2, you cannot monitor the state of a pulsed CCO.
Therefore, the channel state will only transition OFF->ON->OFF when you send a ON command.
Therefore, the channel state will only transition OFF->ON->OFF when you send an ON command.
For maintained CCOs, sending ON and OFF commands works as expected, and the channel state updates as expected when either openHAB commands or external events change the CCO device state.
@ -383,6 +386,32 @@ Thing configuration file example:
Thing shade libraryshade [ integrationId=33]
```
### Blinds [**Experimental**]
Each Lutron Sivoia QS Venetian Blind or Horizontal Sheer Blind is controlled by a **blind** thing.
Besides `integrationId`, it requires that the parameter `type` be set to either "Venetian" for venetian blinds or "Sheer" for horizontal sheer blinds.
There is no default.
If discovery is used, the `type` parameter will set automatically when the **blind** thing is created.
Two channels, *blindliftlevel* and *blindtiltlevel*, with item type Rollershutter and category Rollershutter will be created for each **blind** thing.
They control the up/down motion and the slat tilt motions of the blinds, respectively.
Each channel accepts Percent, Up, Down, Stop and Refresh commands.
Sending a Percent command will cause the blind to immediately move so as to be open the specified percentage.
You can also read the current setting from each channel.
It is specified as a percentage, where 0% = closed and 100% = fully open. Movement delays are not currently supported.
**Note:** While a blind is moving to a specific level because of a Percent command, the Lutron system will report the target position for the blind rather than the actual current position.
While a blind is moving because of an Up or Down command, it will report the previous level until it stops moving.
**Note:** Support for Sivoia QS blinds is new and has been through very limited testing.
Please comment on your use of it in the openHAB community forum.
Thing configuration file example:
```
Thing blind officeblinds [ integrationId=76, type="Venetian"]
```
### Green Mode
Radio RA2 and HomeWorks QS systems have a "Green Mode" or "Green Button" feature which allows the system to be placed in to one or more user-defined power saving modes called "steps".
@ -467,6 +496,8 @@ The following is a summary of channels for all RadioRA 2 binding things:
| keypads(except pico)| led* | Switch | LED indicator for the associated button |
| vcrx | cci* | Contact | Contact closure input on/off status |
| shade | shadelevel | Rollershutter | Level of the shade (100% = full open) |
| blind | blindliftlevel | Rollershutter | Level of the blind (100% = full open) |
| blind | blindtiltlevel | Rollershutter | Tilt of the blind slats |
| greenmode | step | Number | Get/set active green mode step number |
| timeclock | clockmode | Number | Get/set active clock mode index number |
| timeclock | sunrise | DateTime | Get the timeclock's sunrise time |
@ -490,6 +521,8 @@ Appropriate channels will be created automatically by the keypad, ttkeypad, intl
| |led* |OnOffType |OnOffType, RefreshType |
| |cci* |OpenClosedType|(*readonly*) |
|shade |shadelevel |PercentType |PercentType, UpDownType, StopMoveType.STOP, RefreshType|
|blind |blindliftlevel |PercentType |PercentType, UpDownType, StopMoveType.STOP, RefreshType|
| |blindtiltlevel |PercentType |PercentType, UpDownType, StopMoveType.STOP, RefreshType|
|greenmode |step |DecimalType |DecimalType, OnOffType (ON=2,OFF=1), RefreshType |
|timeclock |clockmode |DecimalType |DecimalType, RefreshType |
| |sunrise |DateTimeType |RefreshType (*readonly*) |
@ -548,7 +581,7 @@ Rollershutter Lib_Shade1 "Shade 1" { channel="lutron:shade:radiora2:
This binding integrates with the legacy Lutron RadioRA (Classic) lighting system.
This binding depends on RS232 communication.
It has only been tested using the Chronos time module but the RS232 module should work as well.
It has only been tested using the Chronos time module but the RS232 module should work as well.
## Supported Things
@ -609,9 +642,10 @@ Switch Phantom_Movie "Movie Scene" { channel="lutronradiora:phantomButton:chrono
# Legacy HomeWorks RS232 (Serial) Processors
The binding supports legacy HomeWorks processors that interface with a Serial RS232 connection. To connect to such a system, you would need to use a RS232 -> USB adapter (assuming you don't have a serial port).
The binding supports legacy HomeWorks processors that interface with a Serial RS232 connection.
To connect to such a system, you would need to use a RS232 -> USB adapter (assuming you don't have a serial port).
Please see [HomeWorks RS232 Protocol Guide](http://www.lutron.com/TechnicalDocumentLibrary/HWI%20RS232%20Protocol.pdf) for information on the protocol.
Please see [HomeWorks RS232 Protocol Guide](https://www.lutron.com/TechnicalDocumentLibrary/HWI%20RS232%20Protocol.pdf) for information on the protocol.
## Supported Things
@ -625,11 +659,12 @@ Supported in future updates:
## Discovery
This binding supports active and passive discovery. It will detect dimmers as they are manually raised or lowered, or can be made to scan for configured dimmer modules.
This binding supports active and passive discovery.
It will detect dimmers as they are manually raised or lowered, or can be made to scan for configured dimmer modules.
## Thing Configuration
The bridge requires the port location (e.g., /dev/ttyUSB1 or COM1) and the baud rate. The default baud rate for HomeWorks processors is set to 9600.
The bridge requires the port location (e.g., /dev/ttyUSB1 or COM1) and the baud rate. The default baud rate for HomeWorks processors is set to 9600.
```
lutron:hwserialbridge:home [serialPort="/dev/ttyUSB1", baudRate="9600]
@ -653,7 +688,7 @@ The following channels are supported:
# Lutron Grafik Eye 3x/4x binding via GRX-PRG or GRX-CI-PRG
This lutron binding will also work with Grafik Eye 3x/4x systems in conjuction with the GRX-PRG or GRX-CI-PRG interfaces.
Please see [RS232ProtocolCommandSet](http://www.lutron.com/TechnicalDocumentLibrary/RS232ProtocolCommandSet.040196d.pdf) for more information.
Please see [RS232ProtocolCommandSet](https://www.lutron.com/TechnicalDocumentLibrary/RS232ProtocolCommandSet.040196d.pdf) for more information.
## Supported Things
@ -668,7 +703,7 @@ You will need to specify them directly.
The bridge requires the IP address/Host name of the bridge.
Optionally, you may specify the username (defaults to 'nwk') and retryPolling (in seconds) to retry connections if the connection fails (defaults to 10 seconds).
This bridge does support two way communication with the Grafik Eye units (if a scene is selected or a zone changed on the unit or via a keypad, that information is immediately available in openhab).
This bridge does support two way communication with the Grafik Eye units (if a scene is selected or a zone changed on the unit or via a keypad, that information is immediately available in openHAB).
```
lutron:prgbridge:home [ ipAddress="192.168.1.51", user="nwk", retryPolling=10 ]

43
_addons_bindings/mcp23017/readme.md
View File

@ -15,67 +15,69 @@ install: auto
# MCP23017 Binding
This binding allows you to have native access for MCP23017 I/O expander on I2C bus.
It was tested with Raspberry Pi 2 and Raspberry Pi 3, but probably should work with other devices supported by [Pi4J](http://pi4j.com/) library.
It was tested with Raspberry Pi 2 and Raspberry Pi 3, but probably should work with other devices supported by [Pi4J](https://pi4j.com/) library.
On Raspberry Pi the user on which openHAB is running (default user name is "openhab") needs to be added to groups "i2c" and "gpio".
## Dependencies
Make sure that the [wiringPi](http://wiringpi.com/) library has been installed and that the `gpio` command line tool is available to openHAB.
The shared library `libwiringPi.so` is required by the [Pi4J](http://pi4j.com/) Java library to access the GPIO ports.
The shared library `libwiringPi.so` is required by the [Pi4J](https://pi4j.com/) Java library to access the GPIO ports.
Without satisfying this dependency you will see strange `NoClassDefFoundError: Could not initialize class ...` errors in the openHAB logs.
## Supported Things
This binding supports one thing type:
mcp23017 - which is a mcp23017 chip connected to a I2C bus on specified HEX address and bus number
mcp23017 - which is a mcp23017 chip connected to an I2C bus on specified HEX address and bus number
## Thing Configuration
* Required configuration for mcp23017 thing:
| Parameter | Description | Default value |
| Parameter | Description | Default value |
|------------|-----------------------------------------------------------------------------------------------------------------------------------|---------------|
| address | MCP23017 I2C bus address. On Raspberry PI it can be checked as a result of command: "i2cdetect -y 1". Value should be set in HEX. | "20" |
| address | MCP23017 I2C bus address. On Raspberry Pi it can be checked as a result of command: "i2cdetect -y 1". Value should be set in HEX. | "20" |
| bus_number | a bus number to which mcp23017 is connected. On RPI2 and RPI3 it will be "1", on RPI1 it will be "0". | "1" |
## Channels
mcp23017 supports 16 channels in 2 groups:
| Group | Channels | Additional parameters |
| --- | --- | --- |
| input | A0, A1, A2, A3, A4, A5, A6, A7, B0, B1, B2, B3, B4, B5, B6, B7 | pull_mode (OFF, PULL_UP), default is OFF |
| output| A0, A1, A2, A3, A4, A5, A6, A7, B0, B1, B2, B3, B4, B5, B6, B7 | default_state (LOW, HIGH), default is LOW |
| Group | Channels | Additional parameters |
|--------|----------------------------------------------------------------|-------------------------------------------|
| input | A0, A1, A2, A3, A4, A5, A6, A7, B0, B1, B2, B3, B4, B5, B6, B7 | pull_mode (OFF, PULL_UP), default is OFF |
| output | A0, A1, A2, A3, A4, A5, A6, A7, B0, B1, B2, B3, B4, B5, B6, B7 | default_state (LOW, HIGH), default is LOW |
Channel determines MCP23017 PIN we want to use.
Channel determines MCP23017 PIN we want to use.
Group determines mode in which PIN shoud work.
Group determines mode in which PIN shoud work.
When PIN should work as DIGITAL_INPUT, channel from group "input" should be used.
When PIN should work as DIGITAL_INPUT, channel from group "input" should be used.
When PIN should work as DIGITAL_OUTPUT, channel from group "output" should be used.
When PIN should work as DIGITAL_OUTPUT, channel from group "output" should be used.
## Full Example
Let's imagine a setup with:
1. a wall switch connected to pin B1 on the MCP23017 chip which should turn on/off your LED light when pressed (released).
2. a relay which is connected to pin A0 on the MCP23017 chip. This relay takes care of turning on/off your light.
1. a wall switch connected to pin B1 on the MCP23017 chip which should turn on/off your LED light when pressed (released).
2. a relay which is connected to pin A0 on the MCP23017 chip. This relay takes care of turning on/off your light.
Pressing (and releasing) a wall switch should notify openHAB, and then openHAB should change state of relay to on/off the light.
Your pin B1 should work as DIGITAL_INPUT, because it READS state of a PIN (state of wall switch). Your pin A0 should work as DIGITAL_OUTPUT
because openHAB will SET state of this PIN. So your config should look like this:
Pressing (and releasing) a wall switch should notify openHAB, and then openHAB should change state of relay to on/off the light.
Your pin B1 should work as DIGITAL_INPUT, because it READS state of a PIN (state of wall switch). Your pin A0 should work as DIGITAL_OUTPUT
because openHAB will SET state of this PIN. So your config should look like this:
* Things:
Minimal configuration:
```
Thing mcp23017:mcp23017:chipA "MCP23017 chip A" [address=20,bus=1]
```
Configuration with default_state and pull_mode:
```
Thing mcp23017:mcp23017:chipA "MCP23017 chip A" [address=20,bus=1] {
Type output_pin : output#A0 [default_state="HIGH"]
@ -91,8 +93,8 @@ Thing mcp23017:mcp23017:chipA "MCP23017 chip A" [address=20,bus=1] {
* Items:
```
Switch living_room_led_switch "Living room led switch" {channel="mcp23017:mcp23017:chipA:output#A0"}
Contact living_room_led_contact "Living room led contact" {channel="mcp23017:mcp23017:chipA:input#B1"}
Switch living_room_led_switch "Living room LED switch" {channel="mcp23017:mcp23017:chipA:output#A0"}
Contact living_room_led_contact "Living room LED contact" {channel="mcp23017:mcp23017:chipA:input#B1"}
```
* Rules:
@ -104,5 +106,4 @@ when
then
living_room_led_switch.sendCommand(living_room_led_switch.state != ON ? ON : OFF)
end
```

6
_addons_bindings/meteostick/readme.md
View File

@ -3,7 +3,7 @@ id: meteostick
label: Meteostick
title: Meteostick - Bindings
type: binding
description: "This is the binding for the [Meteostick](http://www.smartbedded.com/wiki/index.php/Meteostick) weather receiver dongle."
description: "This is the binding for the [Meteostick](https://www.smartbedded.com/wiki/index.php/Meteostick) weather receiver dongle."
since: 2x
install: auto
---
@ -14,7 +14,7 @@ install: auto
# Meteostick Binding
This is the binding for the [Meteostick](http://www.smartbedded.com/wiki/index.php/Meteostick) weather receiver dongle.
This is the binding for the [Meteostick](https://www.smartbedded.com/wiki/index.php/Meteostick) weather receiver dongle.
This is an RF receiver that can receive data directly from Davis weather devices (and others).
## Supported Things
@ -100,7 +100,7 @@ This example uploads weather data to for your personal weather station at Weathe
Steps:
1. Install the [MeteoStick](http://www.smartbedded.com/wiki/index.php/Meteostick) binding for use with your [Davis Vantage Vue Integrated Sensor Suite (ISS)](https://www.davisnet.com/solution/vantage-vue/).
1. Install the [MeteoStick](https://www.smartbedded.com/wiki/index.php/Meteostick) binding for use with your [Davis Vantage Vue Integrated Sensor Suite (ISS)](https://www.davisnet.com/solution/vantage-vue/).
1. [Register](https://www.wunderground.com/personal-weather-station/signup.asp) your personal weather station with Weather Underground and make note of the station ID and password issued.
1. Add the following files to your openHAB configuration:

2
_addons_bindings/miele/readme.md
View File

@ -17,7 +17,7 @@ install: auto
This binding integrates Miele@home appliances.
Miele@home is a Zigbee based network to interconnect and control Miele appliances that are equipped with special modules.
See [www.miele.de](http://www.miele.de) for the list of available appliances.
See [www.miele.de](https://www.miele.de) for the list of available appliances.
## Supported Things

48
_addons_bindings/mihome/readme.md
View File

@ -18,7 +18,8 @@ install: auto
This binding allows your openHAB to communicate with the Xiaomi Smart Home Suite.
It consists of devices communicating over a ZigBee network with a ZigBee - WiFi gateway.
The devices are very affordable and you can get them from your favourite chinese marktes like [AliExpress](https://www.aliexpress.com/) or [GearBest](https://www.gearbest.com). The sensors run on a coincell battery for over a year.
The devices are very affordable and you can get them from your favourite chinese marktes like [AliExpress](https://www.aliexpress.com/) or [GearBest](https://www.gearbest.com).
The sensors run on a coincell battery for over a year.
After setup, you can disconnect the gateway from the internet to keep your sensor information private.
@ -82,27 +83,29 @@ There are three ways of connecting supported devices to the gateway:
1. Click 3 times on the Gateway's button
2. Gateway will flash in blue and you will hear female voice in Chinese, you have 30 seconds to include your new device
3. Place the needle into the sensor and hold it for at least 3 seconds
4. You'll hear confirmation message in Chinese
4. You will hear confirmation message in Chinese
5. The device appears in openHAB thing Inbox
* With the binding
1. after adding the gateway make sure you have entered the right developer key
2. in PaperUI, go to your Inbox and trigger a discovery for the binding
3. the gateway flashes in blue and you hear a female voice in Chinese, you have 30 seconds to include your new device
4. follow the instructions for your device to pair it to the gateway
5. you'll hear a confirmation message in Chinese
1. After adding the gateway make sure you have entered the right developer key
2. In Paper UI, go to your Inbox and trigger a discovery for the binding
3. The gateway flashes in blue and you hear a female voice in Chinese, you have 30 seconds to include your new device
4. Follow the instructions for your device to pair it to the gateway
5. You will hear a confirmation message in Chinese
6. The device appears in openHAB thing Inbox
__Hints:__
* If you don't want to hear the Chinese voice every time, you can disable it by setting the volume to minimum in the MiHome App (same for the blinking light)
* The devices don't need an Internet connection to be working after you have set up the developer mode BUT you won't be able to connect to them via App anymore - easiest way is to block their outgoing Internet connection in your router and enable it later, when you want to check for updates etc. This will ensure that your smart home data stays only with you!
* The devices don't need an Internet connection to be working after you have set up the developer mode BUT you will not be able to connect to them via App anymore - easiest way is to block their outgoing Internet connection in your router and enable it later, when you want to check for updates etc. This will ensure that your smart home data stays only with you!
## Removing devices from the gateway
If you remove a Thing in PapaerUI it will also trigger the gateway to unpair the device. It will only reappear in your Inbox, if you connect it to the gateway again. Just follow the instructions in ["Connecting devices to the gateway"](#connecting-devices-to-the-gateway).
If you remove a Thing in PapaerUI it will also trigger the gateway to unpair the device.
It will only reappear in your Inbox, if you connect it to the gateway again.
Just follow the instructions in ["Connecting devices to the gateway"](#connecting-devices-to-the-gateway).
## Network configuration
@ -429,14 +432,17 @@ sitemap xiaomi label="Xiaomi" {
## Handling unsupported devices
The Xiaomi ecosystem grows at a steady rate. So there is a good chance that in the future even more devices get added to the suite. This section describes, how to get the necessary information to support new device types. While a device is not supported yet, it is still possible to access it's informations.
The Xiaomi ecosystem grows at a steady rate.
So there is a good chance that in the future even more devices get added to the suite.
This section describes, how to get the necessary information to support new device types.
While a device is not supported yet, it is still possible to access its information.
Make sure you have connected your gateway to openHAB and the communication is working.
### Connect the new device
- Go through the normal procedure to add a device to the gateway
- The device will show up in your inbox as a new unsupported device and it's model name
- The device will show up in your inbox as a new unsupported device and its model name
- Add the device as a new thing of type "basic device", now you have different channels to receive and send messages from/to the device
- raw messages from the device
- the data from the four different type of messages (see their details in the next chapter)
@ -455,7 +461,7 @@ You have to capture as many of them as possible, so that the device is fully sup
### Open a new issue or get your hands dirty
Every little help is welcome, be part of the community!
Post an issue in the Github repository with as much information as possible about the new device:
Post an issue in the GitHub repository with as much information as possible about the new device:
- brand and link to device description
- model name
- content of all the different message types
@ -464,7 +470,8 @@ Or implement the support by youself and submit a pull request.
### Handle the message contents of a basic device thing with items
You can access the whole message contents of the basic device thing with String items. That way you can make use of your device, even if it is not supported yet!
You can access the whole message contents of the basic device thing with String items.
That way you can make use of your device, even if it is not supported yet!
The following examples are a demonstration, where a basic device thing for the gateway was manually added.
```
@ -515,7 +522,8 @@ Make sure to write numbers without quotes and strings with quotes. Also, quotes
## Debugging
If you experience any unexpected behaviour or just want to know what is going on behind the scenes, you can enable debug logging. This makes possible following the communication between the binding and the gateway.
If you experience any unexpected behaviour or just want to know what is going on behind the scenes, you can enable debug logging.
This makes possible following the communication between the binding and the gateway.
### Enable debug logging for the binding
@ -528,12 +536,13 @@ If you experience any unexpected behaviour or just want to know what is going on
## Troubleshooting
For the binding to function properly it is very important, that your network config allows the machine running openHAB to receive multicast traffic. In case you want to check if the communication between the machine and the gateway is working, you can find some hints here.
For the binding to function properly it is very important, that your network config allows the machine running openHAB to receive multicast traffic.
In case you want to check if the communication between the machine and the gateway is working, you can find some hints here.
- Set up the developer communication as described in the Setup section
### Check if your linux machine receives multicast traffic
### Check if your Linux machine receives multicast traffic
- Login to the linux console
- Login to the Linux console
- make sure you have __netcat__ installed
- Enter ```netcat -ukl 9898```
- At least every 10 seconds you should see a message coming in from the gateway which looks like
@ -564,4 +573,7 @@ __I have connected my gateway to the network but it doesn't show up in openHAB:_
- Contact Xiaomi support - get your gateway replaced
__Nothing works, I'm frustrated and have thrown my gateway into the bin. Now I don't know what to do with all the sensors:__
Check out the Zigbee2Mqtt project on Github. It allows you to use the sensors without the gateway and get their values through MQTT. You will need some hardware to act as a gateway which is not expensive. You can find more information and a list of supported Xiaomi devices in the Github repository.
Check out the Zigbee2Mqtt project on GitHub.
It allows you to use the sensors without the gateway and get their values through MQTT.
You will need some hardware to act as a gateway which is not expensive.
You can find more information and a list of supported Xiaomi devices in the GitHub repository.

90
_addons_bindings/miio/readme.md
View File

@ -143,7 +143,7 @@ The following things types are available:
The binding has 2 methods for discovering devices. Depending on your network setup and the device model, your device may be discovered by one or both methods. If both methods discover your device, 2 discovery results may be in your inbox for the same device.
The MDNS discovery method will discover your device type, but won't discover a (required) token.
The mDNS discovery method will discover your device type, but will not discover a (required) token.
The basic discovery will not discovery the type, but will discover a token for models that support it.
Accept only one of the 2 discovery results, the alternate one can further be ignored.
@ -242,7 +242,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| setHumidity | Number | Humidity Set |
| aqi | Number | Air Quality Index |
| translevel | Number | Trans_level |
| bright | Number | Led Brightness |
| bright | Number | LED Brightness |
| buzzer | Switch | Buzzer Status |
| depth | Number | Depth |
| dry | Switch | Dry |
@ -261,7 +261,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| setHumidity | Number | Humidity Set |
| aqi | Number | Air Quality Index |
| translevel | Number | Trans_level |
| bright | Number | Led Brightness |
| bright | Number | LED Brightness |
| buzzer | Switch | Buzzer Status |
| depth | Number | Depth |
| dry | Switch | Dry |
@ -279,7 +279,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -300,7 +300,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -321,7 +321,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -342,7 +342,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -363,8 +363,8 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| bright | Number | Led Brightness |
| led | Switch | LED Status |
| bright | Number | LED Brightness |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
| usedhours | Number | Run Time |
@ -384,8 +384,8 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| bright | Number | Led Brightness |
| led | Switch | LED Status |
| bright | Number | LED Brightness |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
| usedhours | Number | Run Time |
@ -405,7 +405,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -426,7 +426,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -447,7 +447,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -468,8 +468,8 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| bright | Number | Led Brightness |
| led | Switch | LED Status |
| bright | Number | LED Brightness |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
| usedhours | Number | Run Time |
@ -489,7 +489,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -510,7 +510,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -531,7 +531,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -552,7 +552,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| humidity | Number | Humidity |
| aqi | Number | Air Quality Index |
| averageaqi | Number | Average Air Quality Index |
| led | Switch | Led Status |
| led | Switch | LED Status |
| buzzer | Switch | Buzzer Status |
| filtermaxlife | Number | Filter Max Life |
| filterhours | Number | Filter Hours used |
@ -574,7 +574,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| angle | Number | Angle |
| poweroffTime | Number | Timer |
| buzzer | Switch | Buzzer |
| led_b | Number | Led |
| led_b | Number | LED |
| child_lock | Switch | Child Lock |
| speedLevel | Number | Speed Level |
| speed | Number | Speed |
@ -596,7 +596,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| angle | Number | Angle |
| poweroffTime | Number | Timer |
| buzzer | Switch | Buzzer |
| led_b | Number | Led |
| led_b | Number | LED |
| child_lock | Switch | Child Lock |
| speedLevel | Number | Speed Level |
| speed | Number | Speed |
@ -618,7 +618,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| angle | Number | Angle |
| poweroffTime | Number | Timer |
| buzzer | Switch | Buzzer |
| led_b | Number | Led |
| led_b | Number | LED |
| child_lock | Switch | Child Lock |
| speedLevel | Number | Speed Level |
| speed | Number | Speed |
@ -640,7 +640,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| angle | Number | Angle |
| poweroffTime | Number | Timer |
| buzzer | Switch | Buzzer |
| led_b | Number | Led |
| led_b | Number | LED |
| child_lock | Switch | Child Lock |
| speedLevel | Number | Speed Level |
| speed | Number | Speed |
@ -658,7 +658,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| angle | Number | Angle |
| poweroffTime | Number | Timer |
| buzzer | Switch | Buzzer |
| led_b | Number | Led |
| led_b | Number | LED |
| child_lock | Switch | Child Lock |
| speedLevel | Number | Speed Level |
| speed | Number | Speed |
@ -676,7 +676,7 @@ e.g. `smarthome:send actionCommand 'upd_timer["1498595904821", "on"]'` would ena
| setHumidity | Number | Humidity Set |
| aqi | Number | Air Quality Index |
| translevel | Number | Trans_level |
| bright | Number | Led Brightness |
| bright | Number | LED Brightness |
| buzzer | Switch | Buzzer Status |
| depth | Number | Depth |
| dry | Switch | Dry |
@ -1356,7 +1356,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1379,7 +1379,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1402,7 +1402,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1425,7 +1425,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1448,7 +1448,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Number bright "Led Brightness" (G_airpurifier) {channel="miio:basic:airpurifier:bright"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1471,7 +1471,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Number bright "Led Brightness" (G_airpurifier) {channel="miio:basic:airpurifier:bright"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1494,7 +1494,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1517,7 +1517,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1540,7 +1540,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1563,7 +1563,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Number bright "Led Brightness" (G_airpurifier) {channel="miio:basic:airpurifier:bright"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1586,7 +1586,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1609,7 +1609,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1632,7 +1632,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1655,7 +1655,7 @@ String mode "Mode" (G_airpurifier) {channel="miio:basic:airpurifier:mode"}
Number humidity "Humidity" (G_airpurifier) {channel="miio:basic:airpurifier:humidity"}
Number aqi "Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:aqi"}
Number averageaqi "Average Air Quality Index" (G_airpurifier) {channel="miio:basic:airpurifier:averageaqi"}
Switch led "Led Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch led "LED Status" (G_airpurifier) {channel="miio:basic:airpurifier:led"}
Switch buzzer "Buzzer Status" (G_airpurifier) {channel="miio:basic:airpurifier:buzzer"}
Number filtermaxlife "Filter Max Life" (G_airpurifier) {channel="miio:basic:airpurifier:filtermaxlife"}
Number filterhours "Filter Hours used" (G_airpurifier) {channel="miio:basic:airpurifier:filterhours"}
@ -1679,7 +1679,7 @@ Number usedhours "Run Time" (G_fan) {channel="miio:basic:fan:usedhours"}
Number angle "Angle" (G_fan) {channel="miio:basic:fan:angle"}
Number poweroffTime "Timer" (G_fan) {channel="miio:basic:fan:poweroffTime"}
Switch buzzer "Buzzer" (G_fan) {channel="miio:basic:fan:buzzer"}
Number led_b "Led" (G_fan) {channel="miio:basic:fan:led_b"}
Number led_b "LED" (G_fan) {channel="miio:basic:fan:led_b"}
Switch child_lock "Child Lock" (G_fan) {channel="miio:basic:fan:child_lock"}
Number speedLevel "Speed Level" (G_fan) {channel="miio:basic:fan:speedLevel"}
Number speed "Speed" (G_fan) {channel="miio:basic:fan:speed"}
@ -1703,7 +1703,7 @@ Number usedhours "Run Time" (G_fan) {channel="miio:basic:fan:usedhours"}
Number angle "Angle" (G_fan) {channel="miio:basic:fan:angle"}
Number poweroffTime "Timer" (G_fan) {channel="miio:basic:fan:poweroffTime"}
Switch buzzer "Buzzer" (G_fan) {channel="miio:basic:fan:buzzer"}
Number led_b "Led" (G_fan) {channel="miio:basic:fan:led_b"}
Number led_b "LED" (G_fan) {channel="miio:basic:fan:led_b"}
Switch child_lock "Child Lock" (G_fan) {channel="miio:basic:fan:child_lock"}
Number speedLevel "Speed Level" (G_fan) {channel="miio:basic:fan:speedLevel"}
Number speed "Speed" (G_fan) {channel="miio:basic:fan:speed"}
@ -1727,7 +1727,7 @@ Number usedhours "Run Time" (G_fan) {channel="miio:basic:fan:usedhours"}
Number angle "Angle" (G_fan) {channel="miio:basic:fan:angle"}
Number poweroffTime "Timer" (G_fan) {channel="miio:basic:fan:poweroffTime"}
Switch buzzer "Buzzer" (G_fan) {channel="miio:basic:fan:buzzer"}
Number led_b "Led" (G_fan) {channel="miio:basic:fan:led_b"}
Number led_b "LED" (G_fan) {channel="miio:basic:fan:led_b"}
Switch child_lock "Child Lock" (G_fan) {channel="miio:basic:fan:child_lock"}
Number speedLevel "Speed Level" (G_fan) {channel="miio:basic:fan:speedLevel"}
Number speed "Speed" (G_fan) {channel="miio:basic:fan:speed"}
@ -1751,7 +1751,7 @@ Number usedhours "Run Time" (G_fan) {channel="miio:basic:fan:usedhours"}
Number angle "Angle" (G_fan) {channel="miio:basic:fan:angle"}
Number poweroffTime "Timer" (G_fan) {channel="miio:basic:fan:poweroffTime"}
Switch buzzer "Buzzer" (G_fan) {channel="miio:basic:fan:buzzer"}
Number led_b "Led" (G_fan) {channel="miio:basic:fan:led_b"}
Number led_b "LED" (G_fan) {channel="miio:basic:fan:led_b"}
Switch child_lock "Child Lock" (G_fan) {channel="miio:basic:fan:child_lock"}
Number speedLevel "Speed Level" (G_fan) {channel="miio:basic:fan:speedLevel"}
Number speed "Speed" (G_fan) {channel="miio:basic:fan:speed"}
@ -1771,7 +1771,7 @@ Number usedhours "Run Time" (G_fan) {channel="miio:basic:fan:usedhours"}
Number angle "Angle" (G_fan) {channel="miio:basic:fan:angle"}
Number poweroffTime "Timer" (G_fan) {channel="miio:basic:fan:poweroffTime"}
Switch buzzer "Buzzer" (G_fan) {channel="miio:basic:fan:buzzer"}
Number led_b "Led" (G_fan) {channel="miio:basic:fan:led_b"}
Number led_b "LED" (G_fan) {channel="miio:basic:fan:led_b"}
Switch child_lock "Child Lock" (G_fan) {channel="miio:basic:fan:child_lock"}
Number speedLevel "Speed Level" (G_fan) {channel="miio:basic:fan:speedLevel"}
Number speed "Speed" (G_fan) {channel="miio:basic:fan:speed"}

4
_addons_bindings/milight/readme.md
View File

@ -47,7 +47,7 @@ Read the device manual for more information about how to connect your device to
## Thing Configuration
Besides adding bridges through Paper-UI, you can also add them manually in your Thing
Besides adding bridges through Paper UI, you can also add them manually in your Thing
configuration file.
iBox and iBox2 have the version 6, older milight bridges have the version 3.
The ID is the MAC address of the bridge in hexadecimal digits.
@ -144,7 +144,7 @@ Dimmer Light_LivingroomC {channel="milight:whiteLed:ACCF23A6C0B4:1:ledtemperatur
Dimmer RGBW_LivingroomB {channel="milight:rgbwLed:ACCF23A6C0B4:2:ledbrightness"} # Dimmer changing brightness for RGBW bulb in zone 2
Color Light_Party {channel="milight:rgbwLed:ACCF23A6C0B4:1:ledcolor"}# Colorpicker for rgb bulbs
# You have to link the items to the channels of your prefered group e.g. in paperui after you've saved
# You have to link the items to the channels of your prefered group e.g. in Paper UI after you have saved
# your items file.
# The command types nightMode and whiteMode are stateless and should be configured as pushbuttons as they only support a trigger action:

33
_addons_bindings/modbus/readme.md
View File

@ -48,12 +48,12 @@ Reader of the documentation should understand the basics of Modbus protocol.
Good sources for further information:
* [Wikipedia article](https://en.wikipedia.org/wiki/Modbus): good read on modbus basics and addressing.
* [Simplymodbus.ca](http://www.simplymodbus.ca/): good reference as well as excellent tutorial like explanation of the protocol
* [Simplymodbus.ca](https://www.simplymodbus.ca/): good reference as well as excellent tutorial like explanation of the protocol
Useful tools
* [binaryconvert.com](http://www.binaryconvert.com/): tool to convert numbers between different binary presentations
* [rapidscada.net Modbus parser](http://modbus.rapidscada.net/): tool to parse Modbus requests and responses. Useful for debugging purposes when you want to understand the message sent / received.
* [binaryconvert.com](https://www.binaryconvert.com/): tool to convert numbers between different binary presentations
* [rapidscada.net Modbus parser](https://modbus.rapidscada.net/): tool to parse Modbus requests and responses. Useful for debugging purposes when you want to understand the message sent / received.
* [JSFiddle tool](https://jsfiddle.net/rgypuuxq/) to test JavaScript (JS) transformations interactively
## Supported Things
@ -129,7 +129,8 @@ Advanced parameters
**Note:** Advanced parameters must be equal for all `tcp` things sharing the same `host` and `port`.
The advanced parameters have conservative defaults, meaning that they should work for most users.
In some cases when extreme performance is required (e.g. poll period below 10 ms), one might want to decrease the delay parameters, especially `timeBetweenTransactionsMillis`. Similarly, with some slower devices on might need to increase the values.
In some cases when extreme performance is required (e.g. poll period below 10 ms), one might want to decrease the delay parameters, especially `timeBetweenTransactionsMillis`.
Similarly, with some slower devices on might need to increase the values.
### `serial` Thing
@ -140,7 +141,7 @@ Basic parameters
| Parameter | Type | Required | Default if omitted | Description | |
| --------- | ------- | -------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| port | text | ✓ | | Serial port to use, for example `"/dev/ttyS0"` or `"COM1"` | |
| id | integer | | `1` | Slave id. Also known as station address or unit identifier. See [Wikipedia](https://en.wikipedia.org/wiki/Modbus) and [simplymodbus](http://www.simplymodbus.ca/index.html) articles for more information | |
| id | integer | | `1` | Slave id. Also known as station address or unit identifier. See [Wikipedia](https://en.wikipedia.org/wiki/Modbus) and [simplymodbus](https://www.simplymodbus.ca/index.html) articles for more information | |
| baud | integer | ✓ | | Baud of the connection. Valid values are: `75`, `110`, `300`, `1200`, `2400`, `4800`, `9600`, `19200`, `38400`, `57600`, `115200`. | |
| stopBits | text | ✓ | | Stop bits. Valid values are: `"1.0"`, `"1.5"`, `"2.0"`. | |
| parity | text | ✓ | | Parity. Valid values are: `"none"`, `"even"`, `"odd"`. | |
@ -550,7 +551,7 @@ There are three different format to specify the configuration:
1. `"SERVICENAME(ARG)"` for calling a transformation service. The transformation receives the extracted number as input. This is useful for example scaling (divide by x) the polled data before it is used in openHAB. See examples for more details.
1. Any other value is interpreted as static text, in which case the actual content of the polled value is ignored. Transformation result is always the same. The transformation output is converted to best-effort-basis to the states accepted by the item.
Consult [background documentation on items](http://docs.openhab.org/concepts/items.html) to understand accepted data types (state) by each item.
Consult [background documentation on items](https://www.openhab.org/docs/concepts/items.html) to understand accepted data types (state) by each item.
#### Transform On Write
@ -559,8 +560,8 @@ Consult [background documentation on items](http://docs.openhab.org/concepts/ite
There are three different format to specify the configuration:
1. String `"default"`, in which case the default transformation is used. The default is to do no conversion to the command.
2. `"SERVICENAME(ARG)"` for calling a transformation service. The transformation receives the command as input. This is useful for example scaling ("multiply by x") commands before the data is written to Modbus. See examples for more details.
3. Any other value is interpreted as static text, in which case the actual command is ignored. Transformation result is always the same.
1. `"SERVICENAME(ARG)"` for calling a transformation service. The transformation receives the command as input. This is useful for example scaling ("multiply by x") commands before the data is written to Modbus. See examples for more details.
1. Any other value is interpreted as static text, in which case the actual command is ignored. Transformation result is always the same.
#### Transformation Example: Scaling
@ -571,7 +572,7 @@ The data in Modbus slaves is quite commonly encoded as integers, and thus scalin
```javascript
// Wrap everything in a function (no global variable pollution)
// variable "input" contains data passed by openhab
// variable "input" contains data passed by openHAB
(function(inputData) {
// on read: the polled number as string
// on write: openHAB command as string
@ -584,7 +585,7 @@ The data in Modbus slaves is quite commonly encoded as integers, and thus scalin
```javascript
// Wrap everything in a function (no global variable pollution)
// variable "input" contains data passed by openhab
// variable "input" contains data passed by openHAB
(function(inputData) {
// on read: the polled number as string
// on write: openHAB command as string
@ -602,7 +603,7 @@ In this case, boolean input is considered to be either number `0`/`1`, `ON`/`OFF
```javascript
// function to invert Modbus binary states
// variable "input" contains data passed by OpenHAB binding
// variable "input" contains data passed by openHAB
(function(inputData) {
var out = inputData ; // allow UNDEF to pass through
if (inputData == '1' || inputData == 'ON' || inputData == 'OPEN') {
@ -995,8 +996,8 @@ Please be aware that `REFRESH` commands are "throttled" (to be exact, responses
## Changes From Modbus 1.x Binding
The older Modbus binding is quite different to the new binding.
Major difference is the thing structure introduced in new openHAB2 binding which allows configuration uisng the PaperUI.
The openHAB 1 Modbus binding is quite different from the openHAB 2 binding.
The biggest difference is that the openHAB 2 binding uses things which can be configured using Paper UI.
Unfortunately there is no conversion tool to convert old configurations to new thing structure.
@ -1048,7 +1049,7 @@ The new binding supports 32 and 64 bit values types when writing.
### How to manually migrate
Here is a step by step example for a migration from a 1.x configuration to a equivalent 2.x configuration.
Here is a step by step example for a migration from a 1.x configuration to an equivalent 2.x configuration.
It does not cover all features the 1.x configuration offers, but it should serve as an example on how to get it done.
Please note that although you can do all this stuff also using PaperUI, the file based approach is strongly recommended if you need to migrate more than only a handful of Items.
@ -1084,7 +1085,7 @@ The 1.x modbus configuration to be updated defined 4 slaves:
tcp.slave4.updateunchangeditems=false
```
As you can see, all the slaves poll the same modbus device (actually a Wago 750-841 controller).
As you can see, all the slaves poll the same modbus device (actually a Wago 750-841 controller).
We now have to create `Things` for this slaves.
The 2.x modbus binding uses a three-level definition.
@ -1248,7 +1249,7 @@ Enable `DEBUG` or `TRACE` (even more verbose) logging for the loggers named:
* `org.openhab.io.transport.modbus`
* `net.wimpi.modbus`
Consult [openHAB2 logging documentation](http://docs.openhab.org/administration/logging.html#defining-what-to-log) for more information.
Consult [openHAB logging documentation](https://www.openhab.org/docs/administration/logging.html#defining-what-to-log) for more information.
## For Developers

16
_addons_bindings/mqtt.generic/readme.md
View File

@ -56,7 +56,7 @@ binding can unfortunately not provide any auto-discovery means.
If you use an open source IoT device, the chances are high,
that it has the MQTT convention Homie or HomeAssistant implemented. Those conventions specify the topic
topology and allow auto discovery. Please have a look at the specific openHAB bindings.
topology and allow auto discovery. Please have a look at the specific openHAB bindings.
## Supported Things
@ -74,8 +74,8 @@ You can add the following channels:
* **string**: This channel can show the received text on the given topic and can send text to a given topic.
* **number**: This channel can show the received number on the given topic and can send a number to a given topic. It can have a min, max and step values.
* **dimmer**: This channel handles numeric values as percentages. It can have min, max and step values.
* **contact**: This channel represents a open/close state of a given topic.
* **switch**: This channel represents a on/off state of a given topic and can send an on/off value to a given topic.
* **contact**: This channel represents an open/close state of a given topic.
* **switch**: This channel represents an on/off state of a given topic and can send an on/off value to a given topic.
* **colorRGB**: This channel handles color values in RGB format.
* **colorHSB**: This channel handles color values in HSB format.
* **location**: This channel handles a location.
@ -115,8 +115,8 @@ You can connect this channel to a Number item.
### Channel Type "dimmer"
* __on__: A optional string (like "ON"/"Open") that is recognized as minimum.
* __off__: A optional string (like "OFF"/"Close") that is recognized as maximum.
* __on__: An optional string (like "ON"/"Open") that is recognized as minimum.
* __off__: An optional string (like "OFF"/"Close") that is recognized as maximum.
* __min__: A required minimum value.
* __max__: A required maximum value.
* __step__: For decrease, increase commands the step needs to be known
@ -129,8 +129,8 @@ You can connect this channel to a Rollershutter or Dimmer item.
### Channel Type "contact", "switch"
* __on__: A optional number (like 1, 10) or a string (like "ON"/"Open") that is recognized as on/open state.
* __off__: A optional number (like 0, -10) or a string (like "OFF"/"Close") that is recognized as off/closed state.
* __on__: An optional number (like 1, 10) or a string (like "ON"/"Open") that is recognized as on/open state.
* __off__: An optional number (like 0, -10) or a string (like "OFF"/"Close") that is recognized as off/closed state.
The contact channel by default recognizes `"OPEN"` and `"CLOSED"`. You can connect this channel to a Contact item.
The switch channel by default recognizes `"ON"` and `"OFF"`. You can connect this channel to a Switch item.
@ -239,7 +239,7 @@ Please prefer formatting as described in the next section whenever possible.
This feature is quite powerful in transforming an item state before it is published to the MQTT broker.
It has the syntax: `%[flags][width]conversion`.
Find the full documentation on the [Java](https://docs.oracle.com/javase/7/docs/api/java/util/Formatter.html) web page.
Find the full documentation on the [Java](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html) web page.
The default is "%s" which means: Output the item state as string.

2
_addons_bindings/mqtt/readme.md
View File

@ -22,7 +22,7 @@ MQTT is a server/client architecture.
A server, also called broker is not provided within this binding.
You can use any of the freely available MQTT Brokers like [Mosquitto](https://mosquitto.org/)
or [Moquette](https://moquette-io.github.io/moquette/) or install the [included Moquette broker](https://www.openhab.org/addons/integrations/mqttembeddedbroker/) as addon.
or [Moquette](https://moquette-io.github.io/moquette/) or install the [included Moquette broker](https://www.openhab.org/addons/integrations/mqttembeddedbroker/) as add-on.
This particular binding allows to configure connections to brokers via openHAB Things.
This binding does NOT allow you to link Channels to MQTT topics or perform auto-discovery of available

2
_addons_bindings/nanoleaf/readme.md
View File

@ -20,7 +20,7 @@ This binding integrates the [Nanoleaf Light Panels](https://nanoleaf.me/en/consu
![Image](doc/Nanoleaf.jpg)
It enables you to authenticate, control, and obtain information of a Light Panels device.
The binding uses the [Nanoleaf OpenAPI](http://forum.nanoleaf.me/docs/openapi), which requires firmware version [1.5.0](https://helpdesk.nanoleaf.me/hc/en-us/articles/214006129-Light-Panels-Firmware-Release-Notes) or higher.
The binding uses the [Nanoleaf OpenAPI](https://forum.nanoleaf.me/docs/openapi), which requires firmware version [1.5.0](https://helpdesk.nanoleaf.me/hc/en-us/articles/214006129-Light-Panels-Firmware-Release-Notes) or higher.
![Image](doc/LightPanels2.jpg)

26
_addons_bindings/neeo/readme.md
View File

@ -33,9 +33,9 @@ Likewise, starting a Recipe/Scenario in openHAB will change the status on the Br
This binding has been designed to compliment the NEEO Transport (which will expose openHAB Devices to the Brain[s] and expose each Brains Device to the other Brains).
The Room/Scenario/Recipe/Device information is read at startup time.
If you make changes to any Room/Scenario/Recipe/Device, you'll need to delete the item in question and re-discover the item (see discovery section below).
If you make changes to any Room/Scenario/Recipe/Device, you will need to delete the item in question and re-discover the item (see discovery section below).
Since this binding allows you to trigger actions on NEEO Devices, this allows you to use the NEEO Brain as a IR solution to openHAB.
Since this binding allows you to trigger actions on NEEO Devices, this allows you to use the NEEO Brain as an IR solution to openHAB.
In other words, if the NEEO Brain supports a Device over IR - then openHAB can use the NEEO Brain to control that Device regardless if there is an openHAB binding for it or not.
## openHAB Primary Address
@ -75,7 +75,7 @@ Represents a Device within the NEEO Room.
## Discover
NEEO Brains will be automatically discovered if MDNS/bonjour/zeroconf is installed on the local machine:
NEEO Brains will be automatically discovered if mDNS/bonjour/zeroconf is installed on the local machine:
1. On Windows - installing iTunes will install bonjour.
2. On Linux - please install zeroconf (see vendor documentation on how to do that).
@ -86,20 +86,20 @@ When you add a Room, all Devices should be auto discovered and placed in the inb
If you remove any discovered thing either from the inbox or from the added things, simply re-trigger a NEEO binding scan to rediscover it.
If you have the Brain both wired and wireless, the Brain will NOT be discovered twice (only once) and which interface is discovered depends on the timing of the beacon discover message (first one wins).
If you discovered the wired first but want to use the wireless (or in the reverse), add the Brain and then modify it's configuration to the IP address you want to use.
If you discovered the wired first but want to use the wireless (or in the reverse), add the Brain and then modify its configuration to the IP address you want to use.
If the Brain is not discovered, here is list of the most common issues:
1. You can generally trigger discovery by starting up the NEEO APP on your mobile device, press MENU->NEEO Brain->Change Brain.
This will generally send out the necessary MDNS broadcast messages to discovery the Brain.
2. You didn't wait long enough.
I've noticed that it will take up to 5 minutes for the discovery to find the Brain.
3. Local firewall is blocking the MDNS broadcast messages.
Modify the firewall to allow MDNS packets - typically port 5353 and/or IP address 224.0.0.251
This will generally send out the necessary mDNS broadcast messages to discovery the Brain.
2. You did not wait long enough.
I have noticed that it will take up to 5 minutes for the discovery to find the Brain.
3. Local firewall is blocking the mDNS broadcast messages.
Modify the firewall to allow mDNS packets - typically port 5353 and/or IP address 224.0.0.251
4. The Brain is on a different subnet.
Unless you have special routing rules, having the Brain on a different subnet than the openHAB instance will prevent discovery.
Either add routing rules or move one of them to the same subnet.
5. Bug in the MDNS library.
5. Bug in the mDNS library.
Occasionally a broadcast will be missed and a simple openHAB restart will fix the issue.
6. Brain isn't reachable.
@ -108,8 +108,8 @@ Ping the Brain's address from the openHAB machine and see if it responds.
If none of the above work, there are a few more things you can try:
1. Use your local dns-sd command to see if you find the instance ("dns-sd -B _neeo._tcp").
2. Manually configure the Brain and specify it's IP address.
3. Look in the issues forum on the NEEO SDK Github - specifically the [Brain Discovery not working](https://github.com/NEEOInc/neeo-sdk/issues/36).
2. Manually configure the Brain and specify its IP address.
3. Look in the issues forum on the NEEO SDK GitHub - specifically the [Brain Discovery not working](https://github.com/NEEOInc/neeo-sdk/issues/36).
## Forward Actions
@ -206,7 +206,7 @@ The following properties are available at the time of this writing:
|---------------|---------------------------------------------------------------------------------------------------------------------|
| AirKey | Unknown (hints at a future airplay feature) |
| Version | The software (not firmware) version of the NEEO Brain |
| Is Configured | Whether the Brain has gone through it's initial setup (true) or not (false) |
| Is Configured | Whether the Brain has gone through its initial setup (true) or not (false) |
| Label | Internal label assigned to the Brain |
| Last Change | The time (in milliseconds) that the Brain was last updated (Recipe/Devices/etc change - again not firmware) |
| Key | The unique identifier of the Brain |

4
_addons_bindings/nest/readme.md
View File

@ -35,7 +35,7 @@ The table below lists the Nest binding thing types:
## Authorization
The Nest API uses OAuth for authorization.
Therefor the binding needs some authorization parameters before it can access your Nest account via the Nest API.
Therefore the binding needs some authorization parameters before it can access your Nest account via the Nest API.
To get these authorization parameters you first need to sign up as a [Nest Developer](https://developer.nest.com) and [register a new Product](https://developer.nest.com/products/new) (free and instant).
@ -132,7 +132,7 @@ Information about the last camera event (requires Nest Aware subscription).
| rush_hour_rewards_enrollment | Switch | If rush hour rewards system is enabled or not | R |
| security_state | String | Security state of the structure (OK, DETER) | R |
| smoke_alarm_state | String | Smoke alarm state (OK, EMERGENCY, WARNING) | R |
| time_zone | String | The time zone for the structure ([IANA time zone format](http://www.iana.org/time-zones)) | R |
| time_zone | String | The time zone for the structure ([IANA time zone format](https://www.iana.org/time-zones)) | R |
### Thermostat Channels

12
_addons_bindings/netatmo/readme.md
View File

@ -26,14 +26,14 @@ See http://www.netatmo.com/ for details on their product.
## Binding Configuration
The binding has no configuration options itself, all configuration is done at 'Things' level but before, you'll have to grant openHAB to access Netatmo API.
The binding has no configuration options itself, all configuration is done at 'Things' level but before, you will have to grant openHAB to access Netatmo API.
Here is the procedure:
### 1. Application Creation
Create an application at https://dev.netatmo.com/dev/createapp
The variables you'll need to get to setup the binding are:
The variables you will need to get to setup the binding are:
* `<CLIENT_ID>` Your client ID taken from your App at https://dev.netatmo.com/dev/listapps
* `<CLIENT_SECRET>` A token provided along with the `<CLIENT_ID>`.
@ -43,7 +43,7 @@ The variables you'll need to get to setup the binding are:
### 2. Bridge and Things Configuration
Once you'll get needed informations from the Netatmo API, you'll be able to configure bridge and things.
Once you will get needed informations from the Netatmo API, you will be able to configure bridge and things.
E.g.
@ -66,7 +66,7 @@ Bridge netatmo:netatmoapi:home [ clientId="<CLIENT_ID>", clientSecret="<CLIENT_S
For Welcome or Presence Camera, Netatmo servers can send push notifications to the Netatmo Binding by using a callback URL.
The webhook URL is setup at bridge level using "Webhook Address" parameter.
You'll define here public way to access your OH2 server:
You will define here public way to access your openHAB server:
```
http(s)://xx.yy.zz.ww:8080
@ -114,7 +114,7 @@ For example your serial number "h00bcdc" should end up as "02:00:00:00:bc:dc".
## Discovery
If you don't manually create things in the *.things file, the Netatmo Binding is able to discover automatically all depending modules and devices from Netatmo website.
If you did not manually create things in the *.things file, the Netatmo Binding is able to discover automatically all depending modules and devices from Netatmo website.
## Channels
@ -553,7 +553,7 @@ After you set the environment variable, try:
ls -l $JAVA_HOME/jre/lib/security/cacerts
```
If it's set correctly then you should see something similar to:
If it is set correctly then you should see something similar to:
```
-rw-r--r-- 1 root root 101992 Nov 4 10:54 /usr/lib/jvm/java-8-oracle/jre/lib/security/cacerts

4
_addons_bindings/network/readme.md
View File

@ -144,11 +144,11 @@ Linux has three different tools:
* arping by Thomas Habets (Ubuntu/Debian: `apt-get install arping`)
* arp-ping by Eli Fulkerson (Windows: https://www.elifulkerson.com/projects/arp-ping.php)
arping by Thomas Habets runs on Windows and MacOS as well.
arping by Thomas Habets runs on Windows and macOS as well.
Make sure the tool is available in the PATH, or in the same path as the openHAB executable.
On Linux and MacOS elevated access permissions may be needed, for instance by making the executable a suid executable (`chmod u+s /usr/sbin/arping`).
On Linux and macOS elevated access permissions may be needed, for instance by making the executable a suid executable (`chmod u+s /usr/sbin/arping`).
Just test the executable on the command line; if `sudo` is required, grant elevated permissions.
### DHCP Listen

6
_addons_bindings/networkupstools/readme.md
View File

@ -3,7 +3,7 @@ id: networkupstools
label: Network UPS Tools
title: Network UPS Tools - Bindings
type: binding
description: "The primary goal of the [Network UPS Tools](http://www.networkupstools.org/) (NUT) project is to provide support for power devices, such as uninterruptible power supplies (UPS), Power Distribution Units and Solar Controllers."
description: "The primary goal of the [Network UPS Tools](https://networkupstools.org/) (NUT) project is to provide support for power devices, such as uninterruptible power supplies (UPS), Power Distribution Units and Solar Controllers."
since: 2x
install: auto
---
@ -14,7 +14,7 @@ install: auto
# Network UPS Tools Binding
The primary goal of the [Network UPS Tools](http://www.networkupstools.org/) (NUT) project is to provide support for power devices, such as uninterruptible power supplies (UPS), Power Distribution Units and Solar Controllers.
The primary goal of the [Network UPS Tools](https://networkupstools.org/) (NUT) project is to provide support for power devices, such as uninterruptible power supplies (UPS), Power Distribution Units and Solar Controllers.
Network UPS Tools (NUT) provides many control and monitoring features, with a uniform control and management interface.
More than 100 different manufacturers, and several thousands of models are compatible.
@ -136,6 +136,4 @@ String test_result "Test Result" {channel="networkupstools:ups:ups2:testResult"}
Number:Frequency ups_out_freq "Output Frequency" {channel="networkupstools:ups:ups2:upsOutFreq"}
Number:ElectricPotential ups_low_voltage "Low Voltage [%.1f V]" {channel="networkupstools:ups:ups2:upsLowVoltage"}
Number:ElectricCurrent ups_low_current "Input Current [%d A]" {channel="networkupstools:ups:ups2:upsLowCurrent"}
```

2
_addons_bindings/nibeheatpump/contrib/utils/README.md
View File

@ -1,4 +1,4 @@
# Usefull commands to create files used by the binding from Nibe ModbusManager CSV files
# Useful commands to create files used by the binding from Nibe ModbusManager CSV files
Command to convert Nibe CSV file character set to UTF-8:
```iconv -f iso-8859-1 -t utf-8 F1X45.csv > F1X45_utf8.csv```

66
_addons_bindings/nibeheatpump/readme.md
View File

@ -3,7 +3,7 @@ id: nibeheatpump
label: Nibe Heatpump
title: Nibe Heatpump - Bindings
type: binding
description: "The Nibe Heatpump binding is used to get live data from from Nibe heat pumps without using expensive MODBUS40 adapter."
description: "The Nibe Heatpump binding is used to get live data from Nibe heat pumps without using an expensive MODBUS40 adapter."
since: 2x
logo: images/addons/nibeheatpump.png
install: auto
@ -15,15 +15,17 @@ install: auto
# Nibe Heatpump Binding
The Nibe Heatpump binding is used to get live data from from Nibe heat pumps without using expensive MODBUS40 adapter.
This binding should be compatible at least the F750, F1145, F1245, F1155, F1255 and F470 heat pump models.
The Nibe Heatpump binding is used to get live data from Nibe heat pumps without using an expensive MODBUS40 adapter.
This binding is compatible with the F750, F1145, F1245, F1155, F1255 and F470 heat pump models.
The binding support data telegrams (contains max 20 registers) from the heat pump, but binding can also read other registers from the pump.
It's recommend to add most changed variables to telegram, binding will then read all other registers automatically from the pump when channels are linked to item.
Register reading need to be enabled from the thing configuration.
Binding have also experimental support for register writing.
This can be used to configure heat pump.
Write mode need to enabled from thing configuration and for safety reason all register identifiers need to explicitly defined.
The binding supports data telegrams (containing a maximum of 20 registers) from the heat pump.
The binding can also read other registers from the pump.
It is recommended to add the most often updated variables to a telegram.
The binding will then read all other registers automatically from the pump when channels are linked to an item.
Register reading needs to be enabled in the thing configuration.
The binding also has experimental support for writing registers.
This can be used to configure the heat pump.
Write mode needs to be enabled in the thing configuration and for safety reasons all register identifiers need to be explicitly defined.
## Supported Things
@ -46,46 +48,49 @@ This binding supports direct serial port connection (RS-485 adapter needed) to h
## Discovery
Discovery is not supported, therefore binding and things need to be configured via Paper UI or thing files.
Discovery is not supported, therefore the binding and things need to be configured via Paper UI or thing files.
## Prerequisites
When Modbus adapter support is enabled from the heat pump UI, the heat pump will start to send telegrams every now and then. A telegram contains a maximum of 20 registers.
When Modbus adapter support is enabled from the heat pump UI, the heat pump will start to send telegrams every now and then.
A telegram contains a maximum of 20 registers.
Those 20 registers can be configured via the Nibe ModbusManager application.
Unfortunately Nibe has made this tricky: telegram from heat pump should be acknowledged, otherwise heat pump will raise an alarm and go in alarm state.
Acknowledge (ACK or NAK) should be sent accurately.
Binding support also direct serial port connections to heat pump, but heat pump will raise an alarm when openHAB binding not running e.g. during openHAB updates.
Unfortunately Nibe has made this tricky.
A telegram from the heat pump must be acknowledged, otherwise the heat pump will raise an alarm and go into the alarm state.
Acknowledgement (ACK or NAK) responses should be sent correctly.
The binding also supports direct serial port connections to the heat pump, but the heat pump will raise an alarm when the openHAB binding is not running e.g. during openHAB updates.
This problem can be resolved by using the `nibegw` program, which can be run on Unix/Linux (such as a Raspberry Pi) or Arduino-based boards.
If you are running openHAB on Raspberry Pi `nibegw` program can run also on the same machine, then when openHAB is not running `nibegw` will still acknowledge packets to heat pump.
Obviously, this doesn't solve the problem when whole Raspberry Pi is down, therefore Arduino based solution is recommended.
If you are running openHAB on a Raspberry Pi, the `nibegw` program can also run on the same machine.
Then when openHAB is not running , `nibegw` will acknowledge packets from the heat pump.
Obviously, this doesn't solve the problem when the Raspberry Pi is down, therefore an Arduino based solution is recommended.
`nibegw` is an application that read telegrams from a serial port (which requires an RS-485 adapter), sends ACK/NAK to the heat pump and relays untouched telegrams to openHAB via UDP packets.
`nibegw` is an application that reads telegrams from a serial port (which requires an RS-485 adapter), sends ACK/NAK to the heat pump and relays untouched telegrams to openHAB via UDP packets.
The Nibe Heat Pump binding will listen to a UDP port and parse register data from UDP telegrams.
### Arduino
Arduino-based solution is tested with Arduino uno + RS485 and Ethernet shields.
Also [ProDiNo](https://www.kmpelectronics.eu/en-us/products/prodinoethernet.aspx) NetBoards are supported.
ProDiNo have both Ethernet and RS-485 ports on the board.
An Arduino-based solution has been tested with Arduino uno + RS485 and Ethernet shields.
The [ProDiNo](https://www.kmpelectronics.eu/en-us/products/prodinoethernet.aspx) NetBoards are also supported.
A ProDiNo has an Ethernet and RS-485 port on the board.
Arduino code is available [here](https://github.com/openhab/openhab2-addons/tree/master/addons/binding/org.openhab.binding.nibeheatpump/NibeGW/Arduino/)
Arduino code is available [here](https://github.com/openhab/openhab2-addons/tree/master/bundles/org.openhab.binding.nibeheatpump/contrib/NibeGW/Arduino/NibeGW).
Arduino code can be builded via Arduino IDE. See more details from [www.arduino.cc](https://www.arduino.cc/en/Main/Software).
NibeGW configuration(such IP addresses, ports, etc) can be adapted directly editing the code files.
Arduino code can be build via Arduino IDE.
For more details see [www.arduino.cc](https://www.arduino.cc/en/Main/Software).
NibeGW configuration (such IP addresses, ports, etc) can be adapted directly by editing the code files.
### Raspberry Pi (or other Linux/Unix based boards)
C code is available on [here](https://github.com/openhab/openhab2-addons/tree/master/addons/binding/org.openhab.binding.nibeheatpump/NibeGW/RasPi/)
C code is available [here](https://github.com/openhab/openhab2-addons/tree/master/bundles/org.openhab.binding.nibeheatpump/contrib/NibeGW/RasPi).
build C code:
To build the C code use:
```shell
gcc -std=gnu99 -o nibegw nibegw.c
```
help:
For getting all command options execute the command using the help switch:
```shell
nibegw -h
@ -109,7 +114,7 @@ nibegw -h
```
run example:
Usage example:
```shell
nibegw -v -d /dev/ttyUSB0 -a 192.168.1.10
@ -121,7 +126,8 @@ No binding configuration required.
## Thing Configuration
Things can be fully configured via Paper Ui, but following information is usefull if you want to configure things via thing configuration files.
Things can be fully configured via Paper UI.
The following information is useful when configuring things via thing configuration files.
### UDP connection
@ -1894,4 +1900,4 @@ This binding currently supports following channels for F1x55 pump models:
| 49379 | Switch | 0 | 1 | Setting | External ERS 4 accessory bypass at heat | |
| 49380 | Switch | 0 | 1 | Setting | External ERS 3 accessory bypass at heat | |
| 49381 | Switch | 0 | 1 | Setting | External ERS 2 accessory bypass at heat | |
| 49430 | Number | 0 | 255 | Setting | AUX ERS Fire Place Guard | |
| 49430 | Number | 0 | 255 | Setting | AUX ERS Fire Place Guard | |

20
_addons_bindings/nibeuplink/readme.md
View File

@ -38,23 +38,23 @@ Auto-Discovery is not supported, as credentials are necessary to login into Nibe
The syntax for a heat pump thing is:
```
nibeuplink:<MODEL>:<NAME>
nibeuplink:<THING TYPE>:<NAME>
```
- **nibeuplink** the binding id, fixed
- **model** the heatpump model (Binding Model)
- **thing type** the heatpump thing type
- **name** the name of the heatpump (choose any name)
Following models (indoor / main units) are currently supported:
| Nibe Model(s) | Openhab Model | Description |
|-------------------|-------------------|-------------------------------------------------------|
| VVM310 / 500 | vvm310 | reduced set of channels based on NibeUplink website |
| VVM320 / 325 | vvm320 | reduced set of channels based on NibeUplink website |
| F730 | f730 | reduced set of channels based on NibeUplink website |
| F750 | f750 | reduced set of channels based on NibeUplink website |
| F1145 / 1245 | f1145 | reduced set of channels based on NibeUplink website |
| F1155 / 1255 | f1155 | reduced set of channels based on NibeUplink website |
| Nibe Model(s) | Thing Type | Description |
|-------------------|------------|-----------------------------------------------------|
| VVM310 / 500 | vvm310 | reduced set of channels based on NibeUplink website |
| VVM320 / 325 | vvm320 | reduced set of channels based on NibeUplink website |
| F730 | f730 | reduced set of channels based on NibeUplink website |
| F750 | f750 | reduced set of channels based on NibeUplink website |
| F1145 / 1245 | f1145 | reduced set of channels based on NibeUplink website |
| F1155 / 1255 | f1155 | reduced set of channels based on NibeUplink website |
The following configuration parameters are available for this thing:

4
_addons_bindings/nikobus/readme.md
View File

@ -16,7 +16,7 @@ install: auto
This binding allows openHAB to interact with the Nikobus home automation system.
[![Demo Video Nikobus](https://img.youtube.com/vi/QiNb-8QxXpo/0.jpg)](http://www.youtube.com/watch?v=QiNb-8QxXpo)
[![Demo Video Nikobus](https://img.youtube.com/vi/QiNb-8QxXpo/0.jpg)](https://www.youtube.com/watch?v=QiNb-8QxXpo)
More specifically, it allows openHAB to:
@ -188,4 +188,4 @@ In addition to the status requests triggered by button presses, there is also a
## Full Example
t.b.d.
t.b.d.

12
_addons_bindings/nikohomecontrol/readme.md
View File

@ -3,7 +3,7 @@ id: nikohomecontrol
label: Niko Home Control
title: Niko Home Control - Bindings
type: binding
description: "The Niko Home Control binding integrates with a [Niko Home Control](http://www.nikohomecontrol.be/) system through a Niko Home Control IP-interface or Niko Home Control Connected Controller."
description: "The Niko Home Control binding integrates with a [Niko Home Control](https://www.niko.eu/) system through a Niko Home Control IP-interface or Niko Home Control Connected Controller."
since: 2x
logo: images/addons/nikohomecontrol.png
install: auto
@ -15,7 +15,7 @@ install: auto
# Niko Home Control Binding
The Niko Home Control binding integrates with a [Niko Home Control](http://www.nikohomecontrol.be/) system through a Niko Home Control IP-interface or Niko Home Control Connected Controller.
The Niko Home Control binding integrates with a [Niko Home Control](https://www.niko.eu/) system through a Niko Home Control IP-interface or Niko Home Control Connected Controller.
The binding supports both Niko Home Control I and Niko Home Control II.
@ -74,12 +74,12 @@ It is possible to trigger a manual scan for things on the Niko Home Control brid
Note that Niko Home Control II will require the touch profile and password parameters to be set on the bridge before the scan for actions can succeed.
The bridge will remain offline as long as these parameters are not set.
If the Niko Home Control system has locations configured, these will be copied to thing locations and grouped as such in PaperUI.
Locations can subsequently be changed through the thing location parameter in PaperUI.
If the Niko Home Control system has locations configured, these will be copied to thing locations and grouped as such in Paper UI.
Locations can subsequently be changed through the thing location parameter in Paper UI.
## Thing Configuration
Besides using PaperUI to manually configure things or adding automatically discovered things through PaperUI, you can add thing definitions in the things file.
Besides using Paper UI to manually configure things or adding automatically discovered things through Paper UI, you can add thing definitions in the things file.
The Thing configuration for the **bridge** uses the following syntax:
@ -145,7 +145,7 @@ Discovery will identify All Off actions and map them to `pushButton` things.
For Niko Home Control I, the `actionId` parameter is the unique IP Interface Object ID (`ipInterfaceObjectId`) as automatically assigned in the Niko Home Control Controller when programming the Niko Home Control system using the Niko Home Control I programming software.
It is not directly visible in the Niko Home Control programming or user software, but will be detected and automatically set by openHAB discovery.
For textual configuration, you can manually retrieve it from the content of the .nhcp configuration file created by the programming software.
Open the file with an unzip tool to read it's content.
Open the file with an unzip tool to read its content.
For Niko Home Control II, the `actionId` parameter is a unique ID for the action in the controller. It can only be auto-discovered.
If you want to define the action through textual configuration, the easiest way is to first do discovery on the bridge to get the correct `actionId` to use in the textual configuration.

50
_addons_bindings/oceanic/readme.md
View File

@ -25,7 +25,7 @@ The binding supports the Limex IQ and Limex Pro water softeners and require the
## Thing Configuration
The **serial** Thing configuration requires the name of the serial port that is used to connect the ESH host with the Oceanic unit, and the interval period in seconds to poll the Oceanic unit
The **serial** Thing configuration requires the name of the serial port that is used to connect openHAB with the Oceanic unit, and the interval period in seconds to poll the Oceanic unit
The **network** Thing configuration requires the hostname or ip address of the proxy, the TCP port number to connect to, and the interval period in seconds to poll the Oceanic unit
@ -33,30 +33,30 @@ The **network** Thing configuration requires the hostname or ip address of the p
All things support the following channels (non-exhaustive):
| Channel Type ID | Item Type | Description | | |
|--------------------------------------|-----------|-----------------------------------------------------------------|---|---|
| alarm | String | Current alarm description, if any | | |
| alert | String | Current alert description, if any, to notify a shortage of salt | | |
| totalflow | Number | Current flow in l/min | | |
| maxflow | Number | Maximum flow recorded, in l/min | | |
| reserve | Number | Water reserve in l before regeneration has to start | | |
| cycle | String | Indicates the stage of the regeneration cycle | | |
| endofcycle | String | Indicates the time to the end of the current cycle | | |
| endofgeneration | String | Indicates the time to the end of the current generation | | |
| inlethardness | Number | Water hardness at the inlet | | |
| outlethardness | Number | Water hardness at the outlet | | |
| salt | String | Volume of salt remaining, in kg | | |
| consumption(today)(currentweek)(...) | String | Water consumption, in l, for that period | | |
| regeneratenow | Switch | Start an immediate regeneration | | |
| regeneratelater | Switch | Start a delayed regeneration | | |
| lastgeneration | DateTime | Date and Time of the last regeneration cycle | | |
| pressure | Number | Water pressure, in bar | | |
| minpressure | Number | Minimum water pressure recorded, in bar | | |
| maxpressure | Number | Maximum water pressure recorded, in bar | | |
| normalregenerations | Number | Number of regenerations completed | | |
| serviceregenerations | Number | Number of service regenerations completed | | |
| incompleteregenerations | Number | Number of incomplete regenerations | | |
| allregenerations | Number | Number of all regenerations | | |
| Channel Type ID | Item Type | Description |
|--------------------------------------|-----------|-----------------------------------------------------------------|
| alarm | String | Current alarm description, if any |
| alert | String | Current alert description, if any, to notify a shortage of salt |
| totalflow | Number | Current flow in l/min |
| maxflow | Number | Maximum flow recorded, in l/min |
| reserve | Number | Water reserve in l before regeneration has to start |
| cycle | String | Indicates the stage of the regeneration cycle |
| endofcycle | String | Indicates the time to the end of the current cycle |
| endofgeneration | String | Indicates the time to the end of the current generation |
| inlethardness | Number | Water hardness at the inlet |
| outlethardness | Number | Water hardness at the outlet |
| salt | String | Volume of salt remaining, in kg |
| consumption(today)(currentweek)(...) | String | Water consumption, in l, for that period |
| regeneratenow | Switch | Start an immediate regeneration |
| regeneratelater | Switch | Start a delayed regeneration |
| lastgeneration | DateTime | Date and Time of the last regeneration cycle |
| pressure | Number | Water pressure, in bar |
| minpressure | Number | Minimum water pressure recorded, in bar |
| maxpressure | Number | Maximum water pressure recorded, in bar |
| normalregenerations | Number | Number of regenerations completed |
| serviceregenerations | Number | Number of service regenerations completed |
| incompleteregenerations | Number | Number of incomplete regenerations |
| allregenerations | Number | Number of all regenerations |
## Full Example

8
_addons_bindings/onebusaway/readme.md
View File

@ -19,8 +19,8 @@ install: auto
## Preparation
You'll need to obtain an API key from the transit provider you want to load data from.
Different providers of the service have different policies, so you'll have to figure this part out for each [deployment](https://github.com/OneBusAway/onebusaway/wiki/OneBusAway-Deployments).
You will need to obtain an API key from the transit provider you want to load data from.
Different providers of the service have different policies, so you will have to figure this part out for each [deployment](https://github.com/OneBusAway/onebusaway/wiki/OneBusAway-Deployments).
## Supported Things
@ -60,7 +60,7 @@ The Route Thing supports the following state channels:
|------------------|--------------|-----------|----------------------------------------------------------------------------------------------------------|
| arrival | state | DateTime | The arrival time of a Route at a Stop. |
| departure | state | DateTime | The departure time of a Route at a Stop. |
| update | state | DateTime | The last time this data was updated (per the data provider, not the last time OpenHAB updated the data). |
| update | state | DateTime | The last time this data was updated (per the data provider, not the last time openHAB updated the data). |
| arrivalDeparture | trigger | DateTime | Triggered when a Route arrives or departs a Stop. |
@ -70,7 +70,7 @@ The `arrival`, `departure`, and `arrivalDeparture` channels can be configured wi
## Full Example
Here's an example of a configuration for a bus stop in Seattle, WA, USA that has three routes configured.
Here is an example of a configuration for a bus stop in Seattle, WA, USA that has three routes configured.
`demo.things`:

5
_addons_bindings/onewire/readme.md
View File

@ -20,7 +20,7 @@ It provides cheap sensors for temperature, humidity, digital I/O and more.
## Getting Started
The OneWire File System (OWFS, http://owfs.org) provides an abstraction layer between the OneWire bus and this binding.
The OneWire File System (OWFS, https://owfs.org) provides an abstraction layer between the OneWire bus and this binding.
It is assumed that you already have a working OWFS installation.
Besides your sensors, you need a busmaster device (e.g. DS9490R).
@ -220,6 +220,7 @@ Some sensors (e.g. DS18x20) report 85 °C as Power-On-Reset value.
In some installations this leads to errorneous temperature readings.
If the `ignorepor` parameter is set to `true` 85 °C values will be filtered.
The default is `false` as correct reading of 85 °C will otherwise be filtered, too.
Please note that the parameter value must not be set in quotation marks (see example below).
A channel of type `temperature-por-res` has one parameter: `resolution`.
OneWire temperature sensors are capable of different resolutions: `9`, `10`, `11` and `12` bits.
@ -275,6 +276,7 @@ Bridge onewire:owserver:mybridge [
] {
Channels:
Type temperature-por-res : temperature [
ignorepor=true,
resolution="11"
]
}
@ -287,6 +289,7 @@ Bridge onewire:owserver:mybridge [
] {
Channels:
Type temperature-por-res : temperature [
ignorepor=false,
resolution="9"
]
}

8
_addons_bindings/onewiregpio/readme.md
View File

@ -3,7 +3,7 @@ id: onewiregpio
label: OneWire GPIO
title: OneWire GPIO - Bindings
type: binding
description: "This binding reads temperature values from OneWire bus sensors connected to the GPIO bus on Raspberry PI."
description: "This binding reads temperature values from OneWire bus sensors connected to the GPIO bus on Raspberry Pi."
since: 2x
install: auto
---
@ -14,18 +14,18 @@ install: auto
# OneWire GPIO Binding
This binding reads temperature values from OneWire bus sensors connected to the GPIO bus on Raspberry PI.
This binding reads temperature values from OneWire bus sensors connected to the GPIO bus on Raspberry Pi.
## Supported Things
Temperature sensors.
Tested successfully with DS18B20 sensor on Raspberry PI 3.
Tested successfully with DS18B20 sensor on Raspberry Pi 3.
## Binding Configuration
The binding requires OneWire sensor to be properly connected to Raspberry PI GPIO bus,
The binding requires OneWire sensor to be properly connected to Raspberry Pi GPIO bus,
"w1_gpio" and "wire" kernel modules should be loaded.
Configuration is proper when /sys/bus/w1/devices folder is present, and contains sensor's data.

2
_addons_bindings/onkyo/readme.md
View File

@ -80,7 +80,7 @@ The binding has the following configuration options, which can be set for "bindi
When an Onkyo receiver is used as an audio sink, the receiver connects to openHAB to get the audio stream.
By default, the binding sends the URL for getting the audio stream based on the Primary Address (Network Settings configuration) and the openHAB HTTP port.
Sometimes it's necessary to use the Callback URL to override the default, such as when using a reverse proxy or with some docker implementations.
Sometimes it is necessary to use the Callback URL to override the default, such as when using a reverse proxy or with some Docker implementations.
## Thing Configuration

34
_addons_bindings/opensprinkler/readme.md
View File

@ -3,7 +3,7 @@ id: opensprinkler
label: OpenSprinkler
title: OpenSprinkler - Bindings
type: binding
description: "This binding allows allows basic control of the OpenSprinkler and OpenSprinkler PI (Plus) devices."
description: "This binding allows allows basic control of the OpenSprinkler devices."
since: 2x
logo: images/addons/opensprinkler.png
install: auto
@ -15,13 +15,12 @@ install: auto
# OpenSprinkler Binding
This binding allows allows basic control of the OpenSprinkler and OpenSprinkler PI (Plus) devices.
This binding allows allows basic control of the OpenSprinkler devices.
Stations can be controlled to be turned on or off and rain sensor state can be read.
## Supported Bridges
* HTTP (`http`) - The http bridge allows to communicate with an OpenSprinkler device through the network
* Pi (`pi`) - With the pi bridge, openHAB can communicate with an OpenSprinkler device which is installed on the same Pi as the openHAB system.
## Supported Things
@ -50,37 +49,24 @@ Bridge opensprinkler:http:http [hostname="127.0.0.1", port=80, pasword="opendoor
- basicUsername: (optional) Only needed when the OpenSprinkler device is behind a basic auth enforcing reverse proxy.
- basicPassword: (optional) Only needed when the OpenSprinkler device is behind a basic auth enforcing reverse proxy.
OpenSprinkler using the Pi interface
```
Bridge opensprinkler:pi:pi [stations=8, refresh=60] {
Thing station 01 [stationIndex=1]
}
```
- stations: Number of stations to control.
- refresh: Number of seconds in between refreshing the Thing state with the API.
### Station Thing Configuration
The `station` thing can be used with both bridge and has the following configuration properties:
- stationIndex: The index of the station to communicate with, starting with 0 for the first station
Be aware, that not all features of a station may be supported by the Pi interface bridge.
## Channels
The following channel is supported by the `station` thing.
| Channel Type ID | Item Type | | Description |
|--------------------|-------------|----|---------------------------------------------------------|
| stationState | Switch | RW | This channel indicates whether station 01 is on or off. |
| remainingWaterTime | Number:Time | R | The time the station remains to be open. |
| nextDuration | Number:Time | RW | A configuration item, which time, if linked, will be |
| | | | used as the time the station will be kept open when |
| | | | switched on. It's advised to add persistence for items |
| | | | linked to this channel, the binding does not persist |
| Channel Type ID | Item Type | | Description |
|--------------------|-------------|----|----------------------------------------------------------|
| stationState | Switch | RW | This channel indicates whether station 01 is on or off. |
| remainingWaterTime | Number:Time | R | The time the station remains to be open. |
| nextDuration | Number:Time | RW | A configuration item, which time, if linked, will be |
| | | | used as the time the station will be kept open when |
| | | | switched on. It is advised to add persistence for items |
| | | | linked to this channel, the binding does not persist |
| | | | values of it.
When using the `nextDuration` channel, it is advised to setup persistence (e.g. MapDB) in order to persist the value through restarts.

4
_addons_bindings/paradoxalarm/readme.md
View File

@ -16,7 +16,7 @@ install: auto
This binding is intended to provide basic support for Paradox Alarm system.
With the power of OpenHAB this binding can be used for complex decision rules combining motion/magnetic sensor or whole partitions states with different scenarios.
With the power of openHAB this binding can be used for complex decision rules combining motion/magnetic sensor or whole partitions states with different scenarios.
Examples:
@ -149,4 +149,4 @@ Currently binding supports the following panels: EVO192, EVO48(not tested), EVO9
Group item=PIRSensors
}
}
```
```

54
_addons_bindings/pentair/readme.md
View File

@ -3,7 +3,7 @@ id: pentair
label: Pentair Pool
title: Pentair Pool - Bindings
type: binding
description: "This is an openHAB binding for a Pentair Pool System. It is based on combined efforts of many on the internet in reverse-engineering the proprietary Pentair protocol (see References section). The binding was developed and tested on a system with a Pentair EasyTouch controller, but should operate with other Pentair systems."
description: "This is an openHAB binding for a Pentair Pool System."
since: 2x
install: auto
---
@ -14,31 +14,45 @@ install: auto
# Pentair Pool
This is an openHAB binding for a Pentair Pool System. It is based on combined efforts of many on the internet in reverse-engineering the proprietary Pentair protocol (see References section). The binding was developed and tested on a system with a Pentair EasyTouch controller, but should operate with other Pentair systems.
This is an openHAB binding for a Pentair Pool System.
It is based on combined efforts of many on the internet in reverse-engineering the proprietary Pentair protocol (see References section).
The binding was developed and tested on a system with a Pentair EasyTouch controller, but should operate with other Pentair systems.
## Hardware Setup
> REQUISITE DISCLAIMER: CONNECTING 3RD PARTY DEVICES TO THE PENTAIR SYSTEM BUS COULD CAUSE SERIOUS DAMAGE TO THE SYSTEM SHOULD SOMETHING MALFUNCTION. IT IS NOT ENDORSED BY PENTAIR AND COULD VOID WARRENTY. IF YOU DECIDE TO USE THIS BINDING TO INTERFACE TO A PENTAIR CONTROLLER, THE AUTHOR(S) CAN NOT BE HELD RESPONSIBLE.
This binding requires an adapter to interface to the Pentair system bus. This bus/wire runs between the Pentair control system, indoor control panels, IntelliFlo pumps, etc. It is a standard RS-485 bus running at 9600,8N1 so any RS-485 adapter should work and you should be able to buy one for under $30. Pentair does not publish any information on the protocol so this binding was developed using the great reverse-engineering efforts of others made available on the internet. I have cited sevearl of those in the References section below.
This binding requires an adapter to interface to the Pentair system bus.
This bus/wire runs between the Pentair control system, indoor control panels, IntelliFlo pumps, etc.
It is a standard RS-485 bus running at 9600,8N1 so any RS-485 adapter should work and you should be able to buy one for under $30.
Pentair does not publish any information on the protocol so this binding was developed using the great reverse-engineering efforts of others made available on the internet.
I have cited sevearl of those in the References section below.
### Connecting adapter to your system
A usb or serial RS-485 interface or IP based interface can be used to interface to the Pentair system bus. The binding includes 2 different bridge Things depending on which type of interface you use, serial_bridge or ip_bridge.
A USB or serial RS-485 interface or IP based interface can be used to interface to the Pentair system bus.
The binding includes 2 different bridge Things depending on which type of interface you use, serial_bridge or ip_bridge.
If your openHAB system is physically located far from your Pentair equipment or indoor control panel, you can use a Raspberry Pi or other computer to redirect USB/serial port traffic over the internet using a program called ser2sock (see Reference section). An example setup would run the following command: "ser2sock -p 10000 -s /dev/ttyUSB1 -b 9600 -d". Note: This is the setup utlized for the majority of my testing of this binding.
If your openHAB system is physically located far from your Pentair equipment or indoor control panel, you can use a Raspberry Pi or other computer to redirect USB/serial port traffic over the internet using a program called ser2sock (see Reference section).
An example setup would run the following command: "ser2sock -p 10000 -s /dev/ttyUSB1 -b 9600 -d".
Note: This is the setup utlized for the majority of my testing of this binding.
Note: if you are on a linux system, the framework may not see a symbolically linked device (i.e. /dev/ttyRS485). To use a symbolically linked device, add the following line to /etc/default/openhab2, `EXTRA_JAVA_OPTS="-Dgnu.io.rxtx.SerialPorts=/dev/ttyRS485"`
Note: If you are on a Linux system, the framework may not see a symbolically linked device (i.e. /dev/ttyRS485).
To use a symbolically linked device, add the following line to /etc/default/openhab2, `EXTRA_JAVA_OPTS="-Dgnu.io.rxtx.SerialPorts=/dev/ttyRS485"`
Once you have the interface connected to your system, it is best to test basic connectivity. Note the protocol is a binary protocol (not ASCII text based) and in order to view the communication packets, one must use a program capable of a binary/HEX mode. If connected properly, you will see a periodic traffic with packets staring with FF00FFA5. This is the preamble for Pentairs communication packet. After you see this traffic, you can proceed to configuring the Pentair binding in openHAB.
Once you have the interface connected to your system, it is best to test basic connectivity.
Note the protocol is a binary protocol (not ASCII text based) and in order to view the communication packets, one must use a program capable of a binary/HEX mode.
If connected properly, you will see a periodic traffic with packets staring with FF00FFA5.
This is the preamble for Pentairs communication packet.
After you see this traffic, you can proceed to configuring the Pentair binding in openHAB.
#### USB/Serial interface
For a USB/Serial interface, you can use most terminal emulators. For linux, you can use minicom with the following options: `minicom -H -D /dev/ttyUSB1 -b 9600`
For a USB/Serial interface, you can use most terminal emulators. For Linux, you can use minicom with the following options: `minicom -H -D /dev/ttyUSB1 -b 9600`
#### IP interface
For an IP based interface (or utilizing ser2sock) on a linux system, you can use nc command with the following options: `nc localhost 10000 | xxd`
For an IP based interface (or utilizing ser2sock) on a Linux system, you can use nc command with the following options: `nc localhost 10000 | xxd`
### Pentair Controller panel configuration
@ -63,7 +77,8 @@ There are no overall binding configurations that need to be set up as all config
## Thing Configuration
Pentair things can be configured either through the online Paper UI configuration, or manually through a 'pentair.thing' configuration file. The following table shows the available configuration parameters for each thing.
Pentair things can be configured either through the online Paper UI configuration, or manually through a 'pentair.thing' configuration file.
The following table shows the available configuration parameters for each thing.
| Thing | Configuration Parameters |
| ------------- | ------------------------------------------------------------ |
@ -75,13 +90,16 @@ Pentair things can be configured either through the online Paper UI configuratio
| | pollPeriod - Period of time in minutes between the poll command being sent to the IT-100 bridge - Not Required - default=1. |
| | id - ID to use when communciating on Pentair control bus - default = 34. |
Currently automatic discovery is not supported and the binding requires configuration via the PaperUI or a file in the conf/things folder. Here is an example of a thing configuration file called 'pentair.thing':
Currently automatic discovery is not supported and the binding requires configuration via the Paper UI or a file in the conf/things folder.
Here is an example of a thing configuration file called 'pentair.thing':
Bridge pentair:ip_bridge:1 [ address="192.168.1.202", port=10001 ] {
easytouch main [ id=16 ]
intelliflo pump1 [ id=96 ]
intellichlor ic40
}
```
Bridge pentair:ip_bridge:1 [ address="192.168.1.202", port=10001 ] {
easytouch main [ id=16 ]
intelliflo pump1 [ id=96 ]
intellichlor ic40
}
```
## Channels
@ -190,8 +208,8 @@ Frame label="Pool" {
## References
Setting up RS485 and basic protocol - http://www.sdyoung.com/home/decoding-the-pentair-easytouch-rs-485-protocol/
ser2sock Github - https://github.com/nutechsoftware/ser2sock
Setting up RS485 and basic protocol - https://www.sdyoung.com/home/decoding-the-pentair-easytouch-rs-485-protocol/
ser2sock GitHub - https://github.com/nutechsoftware/ser2sock
## Future Enhancements

2
_addons_bindings/pjlinkdevice/readme.md
View File

@ -26,7 +26,7 @@ This binding supports devices which implement the PJLink protocol (Class 1).
Limitations at this point:
- only IPv4 connections are supported
- only PJLink Class 1 commands are supported. Class 2 devices should work fine nevertheless, it's just the Class 2 features that will not work.
- only PJLink Class 1 commands are supported. Class 2 devices should work fine nevertheless, it is just the Class 2 features that will not work.
The binding is tested with the PJLink device test tool (PJLinkTEST4CNT) and an Acer VL7680.

51
_addons_bindings/powermax/readme.md
View File

@ -3,7 +3,7 @@ id: powermax
label: Powermax
title: Powermax - Bindings
type: binding
description: "Visonic produces the Powermax alarm panel series (PowerMax, PowerMax+, PowerMaxExpress, PowerMaxPro and PowerMaxComplete) and the Powermaster alarm series (PowerMaster 10 and PowerMaster 30). This binding allows you to control the alarm panel (arm/disarm) and allows you to use the Visonic sensors (movement, door contact, ...) within openHAB."
description: "Visonic produces the Powermax alarm panel series (PowerMax, PowerMax+, PowerMaxExpress, PowerMaxPro and PowerMaxComplete) and the Powermaster alarm series (PowerMaster 10 and PowerMaster 30)."
since: 2x
install: auto
---
@ -14,19 +14,25 @@ install: auto
# Powermax Binding
Visonic produces the Powermax alarm panel series (PowerMax, PowerMax+, PowerMaxExpress, PowerMaxPro and PowerMaxComplete) and the Powermaster alarm series (PowerMaster 10 and PowerMaster 30). This binding allows you to control the alarm panel (arm/disarm) and allows you to use the Visonic sensors (movement, door contact, ...) within openHAB.
Visonic produces the Powermax alarm panel series (PowerMax, PowerMax+, PowerMaxExpress, PowerMaxPro and PowerMaxComplete) and the Powermaster alarm series (PowerMaster 10 and PowerMaster 30).
This binding allows you to control the alarm panel (arm/disarm) and allows you to use the Visonic sensors (movement, door contact, ...) within openHAB.
The PowerMax provides support for a serial interface. This serial interface is not installed by default but can be ordered from any PowerMax vendor (called the Visonic RS-232 Adaptor Kit).
The PowerMax provides support for a serial interface.
This serial interface is not installed by default but can be ordered from any PowerMax vendor (called the Visonic RS-232 Adaptor Kit).
In case your alarm panel is directly connected to a serial port of your openHAB server (or to an USB port through a serial to USB converter), you must setup a serial connection thing type in openHAB.
But you even don't need to have your alarm panel directly connected to your openHAB server. You can connect it for example to a Raspberry PI and use [ser2net Linux tool](https://sourceforge.net/projects/ser2net/) to make the serial connection available on LAN (serial over IP). In this case, you must setup an IP connection thing type in openHAB. Here is an example of ser2net.conf you can use to share your serial port /dev/ttyUSB0 on IP port 4444:
But you even don't need to have your alarm panel directly connected to your openHAB server.
You can connect it for example to a Raspberry Pi and use [ser2net Linux tool](https://sourceforge.net/projects/ser2net/) to make the serial connection available on LAN (serial over IP).
In this case, you must setup an IP connection thing type in openHAB.
Here is an example of ser2net.conf you can use to share your serial port /dev/ttyUSB0 on IP port 4444:
```
4444:raw:0:/dev/ttyUSB0:9600 8DATABITS NONE 1STOPBIT
```
Visonic does not provide a specification of the RS232 protocol and, thus, the binding uses the available protocol specification given at the [​domoticaforum](http://www.domoticaforum.eu/viewtopic.php?f=68&t=6581).
Visonic does not provide a specification of the RS232 protocol and, thus, the binding uses the available protocol specification given at the [​domoticaforum](https://www.domoticaforum.eu/viewtopic.php?f=68&t=6581).
The binding implemntation of this protocol is largely inspired by the [Vera plugin](http://code.mios.com/trac/mios_visonic-powermax).
@ -43,11 +49,14 @@ This binding supports the following thing types:
## Discovery
The alarm system is not discovered automatically. First you have to create manually a bridge thing, either of type ip or serial depending on how your openHAB server is connected to the alarm system. Then the binding will automatically discover all zones and X10 devices that are setup in your alarm system.
The alarm system is not discovered automatically.
First you have to create manually a bridge thing, either of type ip or serial depending on how your openHAB server is connected to the alarm system.
Then the binding will automatically discover all zones and X10 devices that are setup in your alarm system.
## Binding configuration
There are no overall binding configuration settings that need to be set. All settings are through thing configuration parameters.
There are no overall binding configuration settings that need to be set.
All settings are through thing configuration parameters.
## Thing Configuration
@ -84,8 +93,10 @@ The serial bridge thing requires the following configuration parameters:
Some notes:
* On Linux, you may get an error stating the serial port cannot be opened when the Powermax 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. Powermax and RFXcom. See the wiki page for more on symlinking the USB ports [](https://github.com/openhab/openhab1-addons/wiki/symlinks).
- On Linux, you may get an error stating the serial port cannot be opened when the Powermax 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. Powermax and RFXcom.
See the [general documentation about serial port configuration](/docs/administration/serial.html) for more on symlinking the USB ports.
### X10 device
@ -131,7 +142,8 @@ The following channels are available:
## Console Commands
The binding provides few specific commands you can use in the console. Enter the command `smarthome:powermax` to get the usage of each available command.
The binding provides few specific commands you can use in the console.
Enter the command `smarthome:powermax` to get the usage of each available command.
```
openhab> smarthome:powermax
@ -139,17 +151,24 @@ Usage: smarthome:powermax <bridgeUID> info_setup - information on setup
Usage: smarthome:powermax <bridgeUID> download_setup - download setup
```
The command `info_setup` displays in the console informations about your current panel setup. The command `download_setup` will trigger a new download of the panel setup.
The command `info_setup` displays in the console informations about your current panel setup.
The command `download_setup` will trigger a new download of the panel setup.
Here is an example of command you can run: `smarthome:powermax powermax:serial:home info_setup`.
## Notes & Limitations
* For Powerlink mode to work, the enrollment procedure has to be followed. If you don't enroll the Powerlink on the PowerMax the binding will operate in Standard mode, and if enrolled in Powerlink mode. On the newer software versions of the PowerMax the Powerlink enrollment is automatic, and the binding should only operate in 'Powerlink' mode (if enrollment is successful).
* In Powerlink mode, the binding is downloading the panel setup at startup. When openHAB is starting, unfortunately this download is often failing on a RPI for an unclear reason (maybe too many things running at the same time). A retry mechanism is implemented in the binding to retry until 3 times with a delay of 1 minute between each try. My experience is that the download finally succeeds. In case it fails after all the retries, you still have the option to later trigger the download either by using the channel `download_setup` or the appropriate console command.
* Visonic does not provide a specification of the RS232 protocol and, thus, use this binding at your own risk.
* The binding is not able to arm/disarm a particular partition.
* The compatibility of the binding with the Powermaster alarm panel series is probably only partial.
- For Powerlink mode to work, the enrollment procedure has to be followed.
If you don't enroll the Powerlink on the PowerMax the binding will operate in Standard mode, and if enrolled in Powerlink mode.
On the newer software versions of the PowerMax the Powerlink enrollment is automatic, and the binding should only operate in 'Powerlink' mode (if enrollment is successful).
- In Powerlink mode, the binding is downloading the panel setup at startup.
When openHAB is starting, unfortunately this download is often failing on a Raspberry Pi for an unclear reason (maybe too many things running at the same time).
A retry mechanism is implemented in the binding to retry until 3 times with a delay of 1 minute between each try.
My experience is that the download finally succeeds.
In case it fails after all the retries, you still have the option to later trigger the download either by using the channel `download_setup` or the appropriate console command.
- Visonic does not provide a specification of the RS232 protocol and, thus, use this binding at your own risk.
- The binding is not able to arm/disarm a particular partition.
- The compatibility of the binding with the Powermaster alarm panel series is probably only partial.
## Full Example

4
_addons_bindings/regoheatpump/readme.md
View File

@ -43,7 +43,7 @@ Two connection types are supported:
#### TCP/IP connection
A transparent bridge between the serial interface of the heat pump and network (i.e. wifi) is used.
This way no additional wires are required between heat pump and computer, running openhab.
This way no additional wires are required between heat pump and computer, running openHAB.
There are many existing project providing such functionality, i.e. [ser2net](http://ser2net.sourceforge.net/).
@ -155,7 +155,7 @@ Access: R = read only; RW = read write
## The Husdata interface
The [Husdata](http://www.husdata.se/) interface bridges the often complex communication methods with a heat pump controller and provides access through a simple standard interface over RS-232.
The [Husdata](https://www.husdata.se/) interface bridges the often complex communication methods with a heat pump controller and provides access through a simple standard interface over RS-232.
Supported heat pump models

78
_addons_bindings/rfxcom/readme.md
View File

@ -80,7 +80,7 @@ and then you will be able to use /dev/rfxtrx0 as the serial device regardless of
If you have any problems with JD2XX or you don't want to disable FTDI driver on OS X or Linux, you can also configure RFXCOM transceivers/receivers manually.
To do that via the PaperUI, manually add the generic RFXCOM device named `RFXCOM USB Transceiver`, with the description "This is universal RFXCOM transceiver bridge for manual configuration purposes".
To do that via the Paper UI, manually add the generic RFXCOM device named `RFXCOM USB Transceiver`, with the description "This is universal RFXCOM transceiver bridge for manual configuration purposes".
You will need to specify at least the serial port which has been assigned to the RFXCOM (see notes above).
To configure the serial port within openHAB see the [general documentation about serial port configuration](/docs/administration/serial.html).
@ -101,7 +101,7 @@ To start a TCP server for an RFXCOM device, you can use socat:
socat tcp-listen:10001,fork,reuseaddr file:/dev/ttyUSB0,raw
```
A TCP bridge, for use with socat on a remote host, can only be configured manually either through the PaperUI by adding an "RFXCOM USB Transceiver over TCP/IP" device or in a thing file like this:
A TCP bridge, for use with socat on a remote host, can only be configured manually either through the Paper UI by adding an "RFXCOM USB Transceiver over TCP/IP" device or in a thing file like this:
```
Bridge rfxcom:tcpbridge:sunflower [ host="sunflower", port=10001 ] {
@ -175,6 +175,7 @@ This binding currently supports following channel types:
| datetime | DateTime | DateTime channel. |
| dimminglevel | Dimmer | Dimming level channel. |
| fanspeedstring | String | Set the speed of the device, values could be device specific |
| fanspeedcontrol | Rollershutter | Set the speed of the device, values could be device specific |
| fanlight | Switch | Enable light of Fan |
| forecast | String | Weather forecast from device: NO\_INFO\_AVAILABLE/SUNNY/PARTLY\_CLOUDY/CLOUDY/RAIN |
| tempcontrol | Rollershutter | Global control for temperature also setting ON, OFF, UP, DOWN |
@ -213,7 +214,7 @@ The binding uses the following system channels:
### Thing files
Sensors/actuators are easy to configure through the PaperUI.
Sensors/actuators are easy to configure through the Paper UI.
However, if you used a thing file for your RFXCOM you can also configure them manually there as well, for example:
```
@ -224,7 +225,7 @@ Bridge rfxcom:bridge:usb0 [ serialPort="/dev/<device>" ] {
### Item files
Items may be created through PaperUI or add using item files in which you add a channel parameter specifying the bridge's name, the thing ID and channel that the item should be linked to, for example:
Items may be created through Paper UI or add using item files in which you add a channel parameter specifying the bridge's name, the thing ID and channel that the item should be linked to, for example:
```
Switch Switch {channel="rfxcom:lighting2:usb0:100001_1:command"}
@ -480,6 +481,71 @@ Switch item=FanLightSwitch label="Light" mappings=[ON="On"]
Switch item=FanSpeedSwitch label="Speed" mappings=[LOW=Low, MED=Medium, HI=High]
```
#### Falmec fan
A Falmec Fan device
##### Channels
| Name | Channel Type | Item Type | Remarks |
|--------------|-------------------------------------|-----------|------------------------------|
| command | [command](#channels) | Switch | |
| fanSpeed | [fanspeed](#channels) | Number | Options: 1,2,3,4,5,6 |
| fanLight | [fanlight](#channels) | Switch | |
| signalLevel | [system.signal-strength](#channels) | Number | |
##### Configuration Options
* deviceId - Device Id
* Device id, example 47360
* subType - Sub Type
* Specifies device sub type.
* FALMEC - Falmec
#### Lucci Air DC fan
A Lucci Air DC fan device
##### Channels
| Name | Channel Type | Item Type | Remarks |
|--------------|-------------------------------------|---------------|---------------------------------------------------------------|
| commandString| [commandString](#channels) | String | Options: POWER, UP, DOWN, LIGHT, REVERSE, NATURAL_FLOW, PAIR |
| fanSpeed | [fanspeedcontrol](#channels) | RollerShutter | Options: UP / DOWN |
| fanLight | [fanlight](#channels) | Switch | |
| signalLevel | [system.signal-strength](#channels) | Number | |
##### Configuration Options
* deviceId - Device Id
* Device id, example 47360
* subType - Sub Type
* Specifies device sub type.
* LUCCI_AIR_DC - Lucci Air DC
#### Lucci Air DC II fan
A Lucci Air DC II fan device
##### Channels
| Name | Channel Type | Item Type | Remarks |
|--------------|-------------------------------------|-----------|--------------------------------------|
| command | [command](#channels) | Switch | |
| commandString| [commandString](#channels) | String | Options: POWER_OFF, LIGHT, REVERSE |
| fanSpeed | [fanspeed](#channels) | Number | Options: 1,2,3,4,5,6 |
| fanLight | [fanlight](#channels) | Switch | |
| signalLevel | [system.signal-strength](#channels) | Number | |
##### Configuration Options
* deviceId - Device Id
* Device id, example 47360
* subType - Sub Type
* Specifies device sub type.
* LUCCI_AIR_DC_II - Lucci Air DC II
### energy - RFXCOM Energy Sensor
An Energy device
@ -677,10 +743,10 @@ A Lighting4 device
The support for lighting 4 in RFXCOM is less complete because a lot of different devices use the same chips and can not easily be distinguished.
So some extra configuration can be used for fine tuning the behavior of your Lighting4 devices.
For configuration via the PaperUI three extra fields are available, being the the pulse length and a commmand id for on and off commands.
For configuration via the Paper UI three extra fields are available, being the the pulse length and a commmand id for on and off commands.
If your item is auto-discovered normally the on or off command should be recognized properly.
For a usb attached RFXCOM on Windows the configuration could look like this (note that the `onCommandId`, `offCommandId` and `pulse` are all optional):
For a USB attached RFXCOM on Windows the configuration could look like this (note that the `onCommandId`, `offCommandId` and `pulse` are all optional):
```
Bridge rfxcom:bridge:238adf67 [ serialPort="COM4" ] {

2
_addons_bindings/robonect/readme.md
View File

@ -16,7 +16,7 @@ install: auto
Robonect is a piece of hardware which has to be put into your Husqvarna, Gardena and other branded automower and makes
it accessible in your internal network.
More details about the Robonect module can be found at [robonect.de](http://www.robonect.de)
More details about the Robonect module can be found at [robonect.de](https://forum.robonect.de/)
This binding integrates mowers having the robonect module installed as a thing into the home automation solution, allowing to
control the mower and react on mower status changes in rules.

4
_addons_bindings/rotel/readme.md
View File

@ -31,7 +31,7 @@ The binding supports all kinds of Rotel protocols:
For users without serial connector on server side, of course you can add a serial to USB adapter.
You don't need to have your Rotel device directly connected to your openHAB server.
You can connect it for example to a Raspberry PI and use [ser2net Linux tool](https://sourceforge.net/projects/ser2net/) to make the serial connection available on LAN (serial over IP).
You can connect it for example to a Raspberry Pi and use [ser2net Linux tool](https://sourceforge.net/projects/ser2net/) to make the serial connection available on LAN (serial over IP).
Recent devices provide a network interface (RJ45 connector).
So you can use the device IP to connect to the device, keeping 9590 as default port.
@ -146,7 +146,7 @@ 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 wiki page for more on symlinking the USB ports [](https://github.com/openhab/openhab1-addons/wiki/symlinks).
* 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):
```

39
_addons_bindings/russound/readme.md
View File

@ -37,7 +37,7 @@ Although it seems to work a majority of the times, there have been instances whe
## Device Discovery
The Russound binding does support devices discovery via the paperUI.
The Russound binding does support devices discovery via the Paper UI.
When you start device discovery, the system will scan all network interfaces and **all IP Addresses in the subnet on each interface** looking for a Russound system device.
If found, the device will be added to the inbox.
Adding the device will then start a scan of the device to discover all the controllers, sources, and zones attached defined on the device.
@ -45,7 +45,7 @@ As these are found, they will be added to the inbox.
## HABPANEL or other UI
All media management functions are supported to allow building of a dynamic UI for the various streaming sources.
All media management functions are supported to allow building of a dynamic UI for the various streaming sources.
All media management channels begin with "mm".
An example HABPanel implementation can be found in the HABPanel forum.
@ -159,7 +159,7 @@ The controller channel will contain up to 6 controllers and the sources will con
| source | RW | Number | The (physical) number for the current source |
| bass | RW | Number | The bass setting (-10 to 10) |
| treble | RW | Number | The treble setting (-10 to 10) |
| balance | RW | Number | The balance setting (-10 &lsqb;full left&rsqb; to 10 &lsqb;full right&rsqb;) |
| balance | RW | Number | The balance setting (-10 &lsqb;full left&rsqb; to 10 &lsqb;full right&rsqb;) |
| loudness | RW | Switch | Set's the loudness on/off |
| turnonvolume | RW | Dimmer | The initial volume when turned on (0 to 100) |
| donotdisturb | RW | String | The do not disturb setting (on/off/slave) |
@ -191,17 +191,20 @@ The controller channel will contain up to 6 controllers and the sources will con
1. As of the time of this document, rating ON (like) produced an error in the firmware from the related command. This has been reported to Russound.
2. keypress/keyrelease/keyhold/keycode/event are advanced commands that will pass the related event string to Russound (i.e. `EVENT C[x].Z[y]!KeyPress [stringtype]`). Please see the "RIO Protocol for 3rd Party Integrators.pdf" (found at the Russound Portal) for proper string forms.
3. If you send a OnOffType to the volume will have the same affect as turning the zone on/off (ie sending OnOffType to "status")
3. If you send an OnOffType to the volume will have the same affect as turning the zone on/off (ie sending OnOffType to "status")
4. The volume PercentType will be scaled to Russound's volume of 0-50 (ie 50% = volume of 25, 100% = volume of 50)
5. Initialize a media management session by sending ON to the channel. The related source thing will then start sending out media management information in the MM channels. To close the session - simply send OFF to the channel. Sending OFF to the channel when a session has not been initialized does nothing. Likewise if the related source is a tuner, this command does nothing.
##### System Favorites
The JSON will look like `[{"id":xxx,"valid":true,"name":"yyyy"},...]` and will have a representation for each VALID favorite on the system (ie where "valid" is true). You will have up to 32 system favorites in the JSON array (the ID field will be between 1 and 32). System favorites will be the same on ALL zones (because they are system level). This channel appears on the zone because when you send a system favorite representation to zone channel, it sets the system favorite to what is playing in the zone.
The JSON will look like `[{"id":xxx,"valid":true,"name":"yyyy"},...]` and will have a representation for each VALID favorite on the system (ie where "valid" is true).
You will have up to 32 system favorites in the JSON array (the ID field will be between 1 and 32).
System favorites will be the same on ALL zones (because they are system level).
This channel appears on the zone because when you send a system favorite representation to zone channel, it sets the system favorite to what is playing in the zone.
There are three different ways to use this channel:
1. Save a system favorite. Send a representation with "valid" set to true. Example: to set system favorite 3 to what is playing in the zone: `[{"id":3,"valid":true,"name":"80s Rock"}]`. If system favorite 3 was invalid, this would save what is currently playing and make it valid. If system favorite 3 was already valid, this would overlay the favorite with what is currently playing and change it's name.
1. Save a system favorite. Send a representation with "valid" set to true. Example: to set system favorite 3 to what is playing in the zone: `[{"id":3,"valid":true,"name":"80s Rock"}]`. If system favorite 3 was invalid, this would save what is currently playing and make it valid. If system favorite 3 was already valid, this would overlay the favorite with what is currently playing and change its name.
2. Update the name of a system favorite. Send a representation of an existing ID with "valid" set to true and the new name. Example: we could update system favorite 3 (after the above statement) by sending: `[{"id":3,"valid":true,"name":"80s Rock Even More"}]`. Note this will ONLY change the name (this will NOT save what is currently playing to the system favorite).
3. Delete a system favorite. Send a representation with "valid" as false. Example: deleting system favorite 3 (after the above statements) by sending: `[{"id":3","valid":false"}]`
@ -213,7 +216,7 @@ The JSON will look like `[{"id":xxx,"valid":true,"name":"yyyy"},...]` and will h
There are two different ways to use this channel:
1. Save a zone favorite. Send a representation with "valid" set to true. Example: to set zone favorite 2 to what is playing in the zone: `[{"id":2,"valid":true,"name":"80s Rock"}]`.
1. Save a zone favorite. Send a representation with "valid" set to true. Example: to set zone favorite 2 to what is playing in the zone: `[{"id":2,"valid":true,"name":"80s Rock"}]`.
2. Delete a zone favorite. Send a representation with "valid" as false. Example: deleting zone favorite 2 (after the above statement) by sending: `[{"id":2","valid":false"}] `
There is no ability to change JUST the name. Sending a new name will save the new name AND set the favorite to what is currently playing.
@ -222,23 +225,29 @@ The channel will be refreshed with the new representation after processing. If
##### Zone Presets
The JSON will look like `[{"id":xxx,"valid":true,"name":"yyyy", "bank": xxx, "bankPreset":yyyy},...]` and will have a representation for each VALID preset in the zone (ie where "valid" is true). Please note that this channel is only valid if the related source is a tuner. If not a tuner, an empty json array will be returned. You will have up to 36 presets to choose from (ID from 1 to 36). The "bank" and "bankPreset" are readonly (will be ignored if sent) and are informational only (i.e. specify the bank and the preset within the bank for convenience).
The JSON will look like `[{"id":xxx,"valid":true,"name":"yyyy", "bank": xxx, "bankPreset":yyyy},...]` and will have a representation for each VALID preset in the zone (ie where "valid" is true).
Please note that this channel is only valid if the related source is a tuner.
If not a tuner, an empty json array will be returned.
You will have up to 36 presets to choose from (ID from 1 to 36).
The "bank" and "bankPreset" are readonly (will be ignored if sent) and are informational only (i.e. specify the bank and the preset within the bank for convenience).
There are two different ways to use this channel:
1. Save a preset. Send a representation to an ID that is invalid with "valid" set to true. Example: to set a zone pret 2 to what is playing in the zone: `[{"id":2,"valid":true,"name":"103.7 FM"}]`.
2. Save a preset with default name. Send a representation to an ID that is invalid with "valid" set to true. Example: to set a zone pret 2 to what is playing in the zone: `[{"id":2,"valid":true,"name":"103.7 FM"}]`.
1. Save a preset. Send a representation to an ID that is invalid with "valid" set to true. Example: to set a zone pret 2 to what is playing in the zone: `[{"id":2,"valid":true,"name":"103.7 FM"}]`.
2. Save a preset with default name. Send a representation to an ID that is invalid with "valid" set to true. Example: to set a zone pret 2 to what is playing in the zone: `[{"id":2,"valid":true,"name":"103.7 FM"}]`.
3. Delete a zone favorite. Send a representation with "valid" as false. Example: deleting zone favorite 2 (after the above statement) by sending: `[{"id":2","valid":false"}]`
There is no ability to change JUST the name. Sending a new name will save the new name AND set the favorite to what is currently playing.
There is no ability to change JUST the name.
Sending a new name will save the new name AND set the favorite to what is currently playing.
The channel will be refreshed with the new representation after processing. If the refreshed representation doesn't include the changes, the russound system rejected them for some reason (generally length of the name).
The channel will be refreshed with the new representation after processing.
If the refreshed representation doesn't include the changes, the russound system rejected them for some reason (generally length of the name).
### Source channel support cross reference
| Channel Type ID | Sirius | XM | SMS3 | DMS 3.1 Media | DMS 3.1 AM/FM | iBridge | Internal AM/FM | Arcam T32 | Others |
| Channel Type ID | Sirius | XM | SMS3 | DMS 3.1 Media | DMS 3.1 AM/FM | iBridge | Internal AM/FM | Arcam T32 | Others |
|--------------------|--------|----|------|---------------|---------------|---------|----------------|-----------|--------|
| name | X | X | X | X | X | X | X | X | X |
| name | X | X | X | X | X | X | X | X | X |
| type | X | X | X | X | X | X | X | X | X |
| ipaddress | | | X | X | X | | | | |
| composername | X | | | | | | | | |
@ -387,7 +396,7 @@ Frame label="Russound" {
Text item= Rio_Src_RadioText2
Text item= Rio_Src_RadioText3
Text item= Rio_Src_RadioText4
}
}
}
}
}

10
_addons_bindings/samsungtv/readme.md
View File

@ -3,7 +3,7 @@ id: samsungtv
label: Samsung TV
title: Samsung TV - Bindings
type: binding
description: "This binding integrates the [Samsung TV's](http://www.samsung.com)."
description: "This binding integrates the [Samsung TV's](https://www.samsung.com)."
since: 2x
logo: images/addons/samsungtv.png
install: auto
@ -15,11 +15,12 @@ install: auto
# Samsung TV Binding
This binding integrates the [Samsung TV's](http://www.samsung.com).
This binding integrates the [Samsung TV's](https://www.samsung.com).
## Supported Things
Samsung TV C (2010), D (2011), E (2012) and F (2013) models should be supported. Also support added for TVs using websocket remote interface (2016+ models)
Samsung TV C (2010), D (2011), E (2012) and F (2013) models should be supported.
Also support added for TVs using websocket remote interface (2016+ models)
Because Samsung does not publish any documentation about the TV's UPnP interface, there could be differences between different TV models, which could lead to mismatch problems.
Tested TV models:
@ -46,7 +47,8 @@ The binding does not require any special configuration.
## Thing Configuration
The Samsung TV Thing requires the host name and port address as a configuration value in order for the binding to know how to access it. Samsung TV publish several UPnP devices and hostname is used to recognize those UPnP devices.
The Samsung TV Thing requires the host name and port address as a configuration value in order for the binding to know how to access it.
Samsung TV publish several UPnP devices and hostname is used to recognize those UPnP devices.
Port address is used for remote control emulation protocol.
Additionally, a refresh interval can be configured in milliseconds to specify how often TV resources are polled.

39
_addons_bindings/satel/readme.md
View File

@ -3,7 +3,7 @@ id: satel
label: Satel Integra Alarm System
title: Satel Integra Alarm System - Bindings
type: binding
description: "The Satel Integra Alarm System allows openHAB to connect to your alarm system via TCP/IP network with ETHM-1/ETHM-1 Plus module installed, or via RS-232 serial port with INT-RS/INT-RS Plus module installed. For ETHM-1 the binding uses integration protocol, so it must be enabled and properly configured."
description: "The Satel Integra Alarm System allows openHAB to connect to your alarm system via TCP/IP network with ETHM-1/ETHM-1 Plus module installed, or via RS-232 serial port with INT-RS/INT-RS Plus module installed."
since: 2x
install: auto
---
@ -14,10 +14,15 @@ install: auto
# Satel Integra Alarm System Binding
The Satel Integra Alarm System allows openHAB to connect to your alarm system via TCP/IP network with ETHM-1/ETHM-1 Plus module installed, or via RS-232 serial port with INT-RS/INT-RS Plus module installed. For ETHM-1 the binding uses integration protocol, so it must be enabled and properly configured.
Also it is always a good idea to update module/mainboard firmware to the latest version. For ETHM-1 and INT-RS modules it is a must. For "Plus" modules however it is not required.
The Satel Integra Alarm System allows openHAB to connect to your alarm system via TCP/IP network with ETHM-1/ETHM-1 Plus module installed, or via RS-232 serial port with INT-RS/INT-RS Plus module installed.
For ETHM-1 the binding uses integration protocol, so it must be enabled and properly configured.
Also it is always a good idea to update module/mainboard firmware to the latest version.
For ETHM-1 and INT-RS modules it is a must.
For "Plus" modules however it is not required.
In order to use encryption with ETHM-1/ETHM-1 Plus, Java Runtime Environment must support 192 bit AES keys. Oracle Java by default supports only 128 bit keys, therefore ["Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files"](http://www.oracle.com/technetwork/java/javase/downloads/index.html) must be installed. OpenJDK supports unlimited AES keys by default (but OpenJDK is sometimes discouraged for openHAB).
In order to use encryption with ETHM-1/ETHM-1 Plus, Java Runtime Environment must support 192 bit AES keys.
Oracle Java by default supports only 128 bit keys, therefore ["Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files"](https://www.oracle.com/technetwork/java/javase/downloads/index.html) must be installed.
OpenJDK supports unlimited AES keys by default (but OpenJDK is sometimes discouraged for openHAB).
More details and all documentation about Integra system you can find on their site: [satel.pl](https://www.satel.pl/pl/cat/2#cat15)
@ -244,7 +249,7 @@ Thing atd-100 KitchenTemp [ id=10, refresh=30 ]
| Name | Type | Description |
|-----------------|----------|------------------------------------------------------------------------------------------------------------------------------------|
| date_time | DateTime | Date and time on the alarm system |
| troubles | Switch | Active when the system has troubles (trouble led is blinking on a panel) |
| troubles | Switch | Active when the system has troubles (trouble LED is blinking on a panel) |
| troubles_memory | Switch | Memorized state of system troubles |
| service_mode | Switch | Active when the system is in service mode |
| acu100_present | Switch | Active when there is an ACU-100 module installed in the system |
@ -411,10 +416,10 @@ then
// prevent initiating reading when index item is restored during OH startup
EVENT_LOG_IDX.postUpdate(NULL)
} else {
eventLogMsgBody += "\n" + (EVENT_LOG_TIME.state as DateTimeType).format("%1$tF %1$tR") + ": " + EVENT_LOG_DESCR.state
if (EVENT_LOG_DET.state != NULL && EVENT_LOG_DET.state != "") {
eventLogMsgBody += " - " + EVENT_LOG_DET.state
}
eventLogMsgBody += "\n" + (EVENT_LOG_TIME.state as DateTimeType).format("%1$tF %1$tR") + ": " + EVENT_LOG_DESCR.state
if (EVENT_LOG_DET.state != NULL && EVENT_LOG_DET.state != "") {
eventLogMsgBody += " - " + EVENT_LOG_DET.state
}
eventLogCounter += 1
EVENT_LOG_IDX.sendCommand(EVENT_LOG_PREV.state)
}
@ -425,13 +430,14 @@ end
### binary items
In OH2.x all channels have strict types, which means you cannot use other type then designated for a channel.
In openHAB all channels have strict types, which means you cannot use other type then designated for a channel.
In Satel binding all binary items are now of 'Switch' type. Using other item types, like 'Contact' is not possible in this version of the binding.
For this reason, when migrating 1.x item files, besides changing binding configuration for each item, you must replace all 'Contact' items to 'Switch' type.
For this reason, when migrating 1.x item files, besides changing binding configuration for each item, you must replace all 'Contact' items to 'Switch' type.
### 'module' channels
In version 2.x of the binding all 'module' channels have been removed. You can easily replace them with the following configuration:
In version 2.x of the binding all 'module' channels have been removed.
You can easily replace them with the following configuration:
#### satel.items
@ -472,11 +478,16 @@ end
### User for openHAB integration
To control Integra partitions and outputs, you need to provide security code of a user in behalf of all those operations will be executed. It is highly recommended to use a separate user for openHAB integration with only required access rights set in Integra configuration, like access to certain partitions, etc. This allows you to distinguish actions made by openHAB and a user using Integra panel, also it will block unwanted operations in case someone breaks into your local network.
To control Integra partitions and outputs, you need to provide security code of a user in behalf of all those operations will be executed.
It is highly recommended to use a separate user for openHAB integration with only required access rights set in Integra configuration, like access to certain partitions, etc.
This allows you to distinguish actions made by openHAB and a user using Integra panel, also it will block unwanted operations in case someone breaks into your local network.
### Disarming and clearing alarms
Although this binding allows you to configure disarming a partition and clearing alarms for a partition, this should be used only in cases when security is not the priority. Don't forget both these operations can be executed in openHAB without specifying a user code, which is required to disarm or clear alarms using Integra panel. Consider adding a keypad in your sitemap to temporarily change user code to execute sensitive operations. You can find such keypad in the [Full Example](#full-example) section.
Although this binding allows you to configure disarming a partition and clearing alarms for a partition, this should be used only in cases when security is not the priority.
Don't forget both these operations can be executed in openHAB without specifying a user code, which is required to disarm or clear alarms using Integra panel.
Consider adding a keypad in your sitemap to temporarily change user code to execute sensitive operations.
You can find such keypad in the [Full Example](#full-example) section.
## Media

6
_addons_bindings/siemensrds/readme.md
View File

@ -34,7 +34,7 @@ If the Configuration Parameters are all valid, then the Climatix IC Account Thin
If the sign on succeeds, the Thing will indicate its status as Online, otherwise it will show an error status.
Once the Thing of the type Climatix IC Account has been created and successfully signed on to the cloud server, it will automatically interrogate the server to discover all the respective RDS Smart Thermostat Things associated with that account.
After a short while, all discovered RDS Smart Thermostat Things will be displayed in the PaperUI Inbox.
After a short while, all discovered RDS Smart Thermostat Things will be displayed in the Paper UI Inbox.
If in future you add new RDS Smart Thermostat devices to your Siemens account (e.g. via the Siemens App) then these new devices will also appear in the Inbox.
## Thing Configuration for "Climatix IC Account"
@ -55,7 +55,7 @@ Note: You must create ONLY ONE Thing of the type Climatix IC Account; duplicate
## Thing Configuration for "RDS Smart Thermostat"
Each RDS Smart Thermostat Thing is identified in the Climatix IC Account by means of a unique Plant Id code.
The PaperUI automatic discovery process determines the Plant Id codes of all connected thermostats automatically.
The Paper UI automatic discovery process determines the Plant Id codes of all connected thermostats automatically.
| Configuration Parameter | Description |
|-------------------------|-------------------------------------------------------------------------------------------------------------|
@ -89,7 +89,7 @@ Bridge siemensrds:climatixic:mybridgename "Climatix IC Account" [ userEmail="ema
```
To manually configure an RDS Smart Thermostat Thing requires knowledge of the "Plant Id" which is a unique code used to identify a specific thermostat device in the Siemens Climatix IC cloud server account.
The PaperUI automatic Discovery service (see above) discovers the "Plant Id" codes during the discovery process.
The Paper UI automatic Discovery service (see above) discovers the "Plant Id" codes during the discovery process.
```
Bridge siemensrds:climatixic:mybridgename "Climatix IC Account" [ userEmail="email@example.com", userPassword="secret", apiKey="32-character-code-provided-by-siemens", pollingInterval=60 ] {

12
_addons_bindings/silvercrestwifisocket/readme.md
View File

@ -19,21 +19,25 @@ This binding integrates the Silvercrest Wifi Socket SWS-A1 sold by Lidl and the
## Supported Things
- Silvercrest Wifi Socket SWS-A1 - [(Owner Manual)](http://www.lidl-service.com/static/118127777/103043_FI.pdf) -- Tested with firmware version: 1.41, 1.60, 1.70
- Silvercrest Wifi Socket SWS-A1 - [(Owner Manual)](https://www.lidl-service.com/static/118127777/103043_FI.pdf) -- Tested with firmware version: 1.41, 1.60, 1.70
- EasyHome Wifi Socket DIS-124 <https://www.aldi-sued.de/de/infos/aldi-sued-a-bis-z/s/serviceportal/ergebnisliste/sis/si/wifi-steckdose/>
## Discovery
The Discovery of Wifi Sockets is always running in the background. If a command is sent to wifi socket using the Android/iOS app or if the physical button in the device is pressed, the device will be recognized and will be placed in the Inbox.
The Discovery of Wifi Sockets is always running in the background.
If a command is sent to wifi socket using the Android/iOS app or if the physical button in the device is pressed, the device will be recognized and will be placed in the Inbox.
## Binding Configuration
The binding does not require any special configuration. The Wifi Socket should be connected to the same wifi network.
The binding does not require any special configuration.
The Wifi Socket should be connected to the same wifi network.
## Thing Configuration
To configure a Wifi Socket manually the mac address and the vendor is required. You can check the Wifi Socket mac address in your router or using some mobile app. Supported vendors are either Silvercrest (Lidl) or EasyHome (Aldi).
To configure a Wifi Socket manually the mac address and the vendor is required.
You can check the Wifi Socket mac address in your router or using some mobile app.
Supported vendors are either Silvercrest (Lidl) or EasyHome (Aldi).
Wifi Socket thing parameters:

2
_addons_bindings/sleepiq/readme.md
View File

@ -21,7 +21,7 @@ This binding integrates with the SleepIQ system from Select Comfort for Sleep Nu
SleepIQ is a service provided by Select Comfort and sold as an option for Sleep Number beds.
The system collects data about the bed (including individual air chamber data for dual chamber beds).
This information includes whether or not a sleeper is in bed, the current sleep number setting, the pressure of the air chamber, and it's link status.
This information includes whether or not a sleeper is in bed, the current sleep number setting, the pressure of the air chamber, and its link status.
This data can then be analyzed for any number of purposes, including improving sleep.
## Supported Things

2
_addons_bindings/solaredge/readme.md
View File

@ -30,7 +30,7 @@ While on the one hand the S0 meter is the cheaper solution the solaredge meter o
For more details please see here:
- [SolarEdge meter](https://www.solaredge.com/products/pv-monitoring/accessories/css-wattnode-modbus-meter)
- [Avoiding Feed-In limitations with consumption meters](https://www.solaredge.com/solutions/feed-in-limitation-and-metering-solution#)
- [Detailed description of meter setup](http://solaredge.com/sites/default/files/feed-in_limitation_application_note.pdf)
- [Detailed description of meter setup](https://solaredge.com/sites/default/files/feed-in_limitation_application_note.pdf)
## Discovery

4
_addons_bindings/solarlog/readme.md
View File

@ -3,7 +3,7 @@ id: solarlog
label: Solar-Log
title: Solar-Log - Bindings
type: binding
description: "The [Solar-Log Family](http://www.solar-log.com/en/home.html) of monitoring devices for PV installations provide a MODBUS (TCP) and JSON-based API to access a number of internal data related to power generation and consumption. This binding implements access to the data via the JSON API."
description: "The [Solar-Log Family](https://www.solar-log.com/en/) of monitoring devices for PV installations provide a MODBUS (TCP) and JSON-based API to access a number of internal data related to power generation and consumption. This binding implements access to the data via the JSON API."
since: 2x
logo: images/addons/solarlog.png
install: auto
@ -15,7 +15,7 @@ install: auto
# Solar-Log Binding
The [Solar-Log Family](http://www.solar-log.com/en/home.html) of monitoring devices for PV installations provide a MODBUS (TCP) and JSON-based API to access a number of internal data related to power generation and consumption. This binding implements access to the data via the JSON API.
The [Solar-Log Family](https://www.solar-log.com/en/) of monitoring devices for PV installations provide a MODBUS (TCP) and JSON-based API to access a number of internal data related to power generation and consumption. This binding implements access to the data via the JSON API.
## Use of the binding

Some files were not shown because too many files have changed in this diff Show More