Add-on ReferenceThe API exposed by the controller is fairly robust, but it is specific. An Etherrain controller can control zones depending on model and can also report on the status of a rain sensor. The controller itself accepts a single command that contains an initial delay, and an on-time for each of the zone. Once this execute command is sent, the controller will, first, wait the initial delay time, then cycle through each zone and turn it on the amount of time specified. The binding exposes the rain sensor as a contact as well as the operating status of of the controller. The etherrain thing represents a physical Etherrain controller and contains all channels need to control it. There are two main categories of configuration. The first is the configuration of the communication settings IP address, timeout, etc. The second is the initial delay and on-time for each zone when an execute command is issued. To manually configure a Etherrain controller you may specify it's host name or ip "host". You can also optionally specify the unit's password "pw"port it is communicating on "port" or refresh rate "refresh". The etherrain controller exposes the rain sensor as well as several status messages. Finally, there are commands to execute and clear the commands:. Cube MAX! System Integrations. Data Persistence. Data Transformation. Overview An Etherrain controller can control zones depending on model and can also report on the status of a rain sensor. Supported Things The etherrain thing represents a physical Etherrain controller and contains all channels need to control it. Discovery The binding will automatically discover Etherrain controllers when a thing is added. Binding Configuration There are two main categories of configuration. Thing Configuration This is optional, it is recommended to let the binding discover and add Etherrain controllers. Version: latest latest 2. Caught a mistake or want to contribute to the documentation? Edit this page on GitHub.
In other words, it simulates a user which is using the web page. Unfortunately, the binding can get broken if Amazon change the web site. The binding is tested with amazon. 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. You will find the required serial number in settings of the device in the Alexa app. The binding does not have any configuration. The configuration of your Amazon account must be done in the 'Amazon Account' device. The flashbriefingprofile thing has no configuration parameters. It will be configured at runtime by using the save channel to store the current flash briefing configuration in the thing. This can be used to call Alexa API from rules. Sample for the Thing echo1 only. But it will work in the same way for the other things, only replace the thing name in the channel link. Take a look in the channel description above to know, which channels are supported by your thing type. You can also use SSML to provide a better voice experience. Not all properties need to be specified. The value for volume can be between 0 and to set the volume. A volume value smaller then 0 means that the current alexa volume should be used. No specification uses the volume from the textToSpeechVolume channel. 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 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: It is recommended to test the command send to play music command first with the voice and the real Alexa device. Thank you Alex! The technical information for the web socket connection to get live Alexa state updates cames from Ingo. Use of them does not imply any affiliation with or endorsement by them. Cube MAX!
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together. If nothing happens, download GitHub Desktop and try again. If nothing happens, download Xcode and try again. If nothing happens, download the GitHub extension for Visual Studio and try again. In this repo you can find and improve all general documentation contents. In fact that is all you can see in the 2. There are also other read-only branches, which hold external content like the add-ons and concepts documentation. We will read about them later. Correct, this is done in the original repository of the add-on. You may want to know how to find the right file in all of those repos? When your improvement has been made and merged, we will get the updated article automatically through our build mechanism. This happens mostly once a day. Afterwards your change is included in the next build of the openHAB website. The documentation is a community effort, so everyone is welcome to suggest changes, add new sections and fix bugs. This is done exactly the same way as for the code repositories, simply through pull requests against this repo. When editing a page through the "Edit this page on GitHub" link on the website, you will be given the opportunity to create a pull request directly from GitHub. Please read our contribution guidelines and try to follow them as best as you can before submitting a change for review - but don't worry if you don't understand all of them, we will help you to get it right. We use them to bring together all relevant articles or to archive versioned content. Mostly those branches will get updated automatically through our continuous integration builds. You can read a bit more below about our external ressources and how we get them. Those parts include all add-on documentation files, no matter if they are from the openhab-core repo, the openhab1-addons repo, the openhab-addons repo or any special binding repo like habminzwave or the alexa skill. We are keeping all those files at their original location, because it simply doesn't make sense to keep them here. Imagine you want to do an improvement of the zwave binding and have to update the readme file in a completely different place. That's twice the effort and also we would have to coordinate two Pull Requests. So we are saving time for everyone by keeping those files at their original location along with the code. We have set up our build server to do the magic automatically. There are several triggers mostly time basedwhich will then gather the external contents and move them to our final branch. You can find this migrated external content in the final branch under:. You can even have a look at how this works in detail. The external content is updated by the following toolchain:. Everything that gets updated in the master branch will be also merged over to the final branch automatically. Afterwards we will redeploy the website with the latest content from the final branch at regular intervals.
ZWave is a wireless home automation protocol with reliable two way communications between nodes. It supports a mesh network where mains powered nodes can route messages between nodes that could otherwise not communicate with each other. The network supports hop distances of up to four hops. A wide range of devices are supported from lights, switches and sensors to smoke alarms, window coverings and keyfobs. Z-Wave certification guarantees that certified devices will be compatible with each other and the network. The binding uses a standard Z-Wave serial stick to communicate with the Z-Wave devices. There are many sticks available, and they all support the same interface so the binding does not distinguish between them. The ZWave binding provides support for a large number of devices currently devices from manufacturers. See the full list of supported things. Before the binding can be used, a serial adapter must be added. This needs to be done manually. Select Serial ZStickand enter the serial port. Once the binding is authorized, and an adapter is added, it automatically reads all devices that are included into the network. This is read directly from the Z-Wave controller and new things are added to the Inbox. When the discovery process is started, the binding will put the controller into inclusion mode for a defined period of time to allow new devices to be discovered and added to the network. Device discovery occurs in two phases - first the device is added to the inbox as an Unknown Device to provide the user immediate feedback that the device has been discovered. Once the device type is known, the inbox entry is updated with the actual device name and manufacturer. There is no binding level configuration required for the Z-Wave binding. All configuration is performed on the devices, or the controller. This allows the system to support multiple controllers. The following section lists the controller configuration. If using manual configuration in text files, the parameter names are given in the square brackets. When Controller Is Master is true, the binding expects to be the main Z-Wave controller in the system. This is not related to the type of controller Primary or Secondarybut is related to how devices will be configured. This will instruct the binding to perform configuration of the device to send network related information such as device wakeup to the binding. Many functions in Z-Wave only allow a single node to be set, and this is normally reserved for the main system controller. While a device or service might be quite specific, Items are unified substitutions inside the openHAB world. Items can be Strings, Numbers, Switches or one of a few other basic Item types. A programmer can compare Item types with base variable data types of a programming language. An Item does not simply store information that is set by software e. But let's not get ahead of ourselves. The rest of this page contains details regarding Items and is structured as follows:. Items are basic data types and have a state which can be read from, or written to. Items can be linked to a Binding channel for interaction with the outside world. For example, an Item bound to a sensor receives updated sensor readings and an Item linked to a light's dimmer channel can set the brightness of the light bulb. Through Paper UI. Generally all 2. Note that 1. Through text. Files here must have the extension. However, each Item must be unique across all. Refer to the installation docs to determine your specific installation's folder structure. Generally 1. Assumptions for Paper UI: The examples below assume that the user is using a text editor to create a. While the way of defining an Item using the graphical, interactive Paper UI is different, the elements and the nature of an Item definition are identical using either method. Editor Recommendation: It's recommended to edit. Doing so will provide you with full IDE support including features such as syntax checking, and context assistance. The Item type defines what kind of state can be stored in that Item and which commands the Item will accept. Item types are comparable to basic variable data types in programming languages. Each Item type has been optimized for a particular kind of component in your smart home. This optimization is reflected in the data and command types. More details about all of the available Item types and their commands are available under Concepts, see: Item Types Overview. To learn about the technical internals of the individual Item types, please refer to: Javadoc on Generic Item and its subclasses. The Item name is used to uniquely identify an Item. The name must be unique across all. The only characters permitted in an Item name are letters, numbers and the underscore character. Names must not begin with numbers. Spaces and special characters are not permitted.